envelope

NUC envelope.

class DecodedNucToken(raw_header: str, raw_payload: str, signature: bytes, token: NucToken)

Bases: object

A decoded NUC token.

raw_header: str

raw_payload: str

signature: bytes

token: NucToken

static parse(data: str) → DecodedNucToken

Parse a token from its serialized JWT form.

Note that this only parses the token and ensures it is structurally correct. This does not perform any form of signature validation.

Note

Users should use NucTokenEnvelope to parse tokens.

serialize() → str

Serialize this token as a JWT.

validate_signature() → None

Validate the signature in this token.

compute_hash() → bytes

Compute the hash for this token.

__eq__(other)

Return self==value.

__repr__()

Return repr(self).

class NucTokenEnvelope(token: DecodedNucToken, proofs: List[DecodedNucToken])

Bases: object

A NUC token envelope, containing a parsed token along with all its proofs

static parse(data: str) → NucTokenEnvelope

Parse a NUC token envelope from its serialized JWT form.

Note that this only parses the envelope and ensures it is structurally correct. This does not perform any form of signature validation.

Example

from nuc.envelope import NucTokenEnvelope

raw_token = "....."

token = NucTokenEnvelope.parse(raw_token)

validate_signatures() → None

Validate the signature in this envelope.

This will raise an exception is the token or any of its proofs is not signed by its issuer.

serialize() → str

Serialize this envelope as a JWT-like string.

exception MalformedNucJwtException

Bases: Exception

An exception thrown when a malformed NUC JWT is parsed.

exception InvalidSignatureException

Bases: Exception

An exception thrown when signature verification fails.

urlsafe_base64_decode(data: str) → bytes

Encode an input as URL safe base64.

urlsafe_base64_encode(data: bytes) → str

Encode URL safe base64.