Class Token

Token represents a single token with methods to sign and verify. This token is derived from a strict subset of the JWS specification. The token payload must abide by the registered claims of JWS, additional properties that do not conflict are allowed. For public key signatures, it only supports EdDSA algorithm. For MAC signatures, it only supports BLAKE2b algorithm. Multiple signatures are allowed, including 0 signatures. During signing, additional properties can be part of the protected header. The encoded format is compatible with the General JWS JSON format.

Type Parameters

P extends TokenPayload = TokenPayload

Hierarchy

Token

Index

Constructors

constructor

new Token(payload, payloadEncoded, signatures?, signaturesEncoded?): Token
Type Parameters
- P extends TokenPayload = TokenPayload
Parameters
- payload: P
- payloadEncoded: TokenPayloadEncoded
- signatures: TokenHeaderSignature[] = []
- signaturesEncoded: TokenHeaderSignatureEncoded[] = []
Returns Token
- Defined in src/tokens/Token.ts:82

Properties

`Protected` _signatures

_signatures: TokenHeaderSignature[] = []

`Protected` _signaturesEncoded

_signaturesEncoded: TokenHeaderSignatureEncoded[] = []

`Readonly` payload

payload: Readonly

`Readonly` payloadEncoded

payloadEncoded: TokenPayloadEncoded

`Protected` signatureSet

signatureSet: Set<TokenSignatureEncoded> = ...

Accessors

signatures

get signatures(): readonly Readonly<TokenHeaderSignature>[]
Returns readonly Readonly<TokenHeaderSignature>[]
- Defined in src/tokens/Token.ts:97

signaturesEncoded

get signaturesEncoded(): readonly Readonly<TokenHeaderSignatureEncoded>[]
Returns readonly Readonly<TokenHeaderSignatureEncoded>[]
- Defined in src/tokens/Token.ts:101

Methods

signWithKey

signWithKey(key, additionalProtectedHeader?, force?): void
Parameters
- key: Key
- Optional additionalProtectedHeader: POJO
- force: boolean = false
Returns void
- Defined in src/tokens/Token.ts:107

signWithPrivateKey

signWithPrivateKey(privateKeyOrKeyPair, additionalProtectedHeader?, force?): void
Parameters
- privateKeyOrKeyPair: PrivateKey | Readonly<{
 privateKey: PrivateKey;
 publicKey: PublicKey;
 secretKey: SecretKey;
 }>
- Optional additionalProtectedHeader: POJO
- force: boolean = false
Returns void
- Defined in src/tokens/Token.ts:138

toEncoded

toEncoded(): SignedTokenEncoded
Exports this Token into SignedTokenEncoded

Returns SignedTokenEncoded
- Defined in src/tokens/Token.ts:247

toJSON

toJSON(): SignedTokenEncoded
The JSON representation of this Token is SignedTokenEncoded

Returns SignedTokenEncoded
- Defined in src/tokens/Token.ts:257

toSigned

toSigned(): SignedToken
Exports this Token into SignedToken

Returns SignedToken
- Defined in src/tokens/Token.ts:232

verifyWithKey

verifyWithKey(key): boolean
Iterates over the signatures and attempts MAC verification
Parameters
- key: Key
Returns boolean
- Defined in src/tokens/Token.ts:186

verifyWithPublicKey

verifyWithPublicKey(publicKey): boolean
Iterates over the signatures and attempts digital signature verification
Parameters
- publicKey: PublicKey
Returns boolean
- Defined in src/tokens/Token.ts:207

`Static` fromEncoded

fromEncoded(signedTokenEncoded): Token
Construct from encoded payload. It is up the caller to decide what the payload type should be.
Type Parameters
- P extends TokenPayload = TokenPayload
Parameters
- signedTokenEncoded: SignedTokenEncoded
Returns Token
- Defined in src/tokens/Token.ts:61

`Static` fromPayload

fromPayload(payload): Token
Type Parameters
- P extends TokenPayload = TokenPayload
Parameters
- payload: P
Returns Token
- Defined in src/tokens/Token.ts:38

`Static` fromSigned

fromSigned(tokenSigned): Token
Type Parameters
- P extends TokenPayload = TokenPayload
Parameters
- tokenSigned: SignedToken
Returns Token
- Defined in src/tokens/Token.ts:45

Class Token<P>

Type Parameters

P extends TokenPayload = TokenPayload

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

P extends TokenPayload = TokenPayload

Parameters

payload: P

payloadEncoded: TokenPayloadEncoded

signatures: TokenHeaderSignature[] = []

signaturesEncoded: TokenHeaderSignatureEncoded[] = []

Returns Token<P>

Properties

Protected _signatures

Protected _signaturesEncoded

Readonly payload

Readonly payloadEncoded

Protected signatureSet

Accessors

signatures

Returns readonly Readonly<TokenHeaderSignature>[]

signaturesEncoded

Returns readonly Readonly<TokenHeaderSignatureEncoded>[]

Methods

signWithKey

Parameters

key: Key

Optional additionalProtectedHeader: POJO

force: boolean = false

Returns void

signWithPrivateKey

Parameters

privateKeyOrKeyPair: PrivateKey | Readonly<{ privateKey: PrivateKey; publicKey: PublicKey; secretKey: SecretKey; }>

Optional additionalProtectedHeader: POJO

force: boolean = false

Returns void

toEncoded

Returns SignedTokenEncoded

toJSON

Returns SignedTokenEncoded

toSigned

Returns SignedToken<P>

verifyWithKey

Parameters

key: Key

Returns boolean

verifyWithPublicKey

Parameters

publicKey: PublicKey

Returns boolean

Static fromEncoded

Type Parameters

P extends TokenPayload = TokenPayload

Parameters

signedTokenEncoded: SignedTokenEncoded

Returns Token<P>

Static fromPayload

Type Parameters

P extends TokenPayload = TokenPayload

Parameters

payload: P

Returns Token<P>

Static fromSigned

Type Parameters

P extends TokenPayload = TokenPayload

Parameters

tokenSigned: SignedToken<P>

Returns Token<P>

Settings

Member Visibility

Theme

On This Page

`Protected` _signatures

`Protected` _signaturesEncoded

`Readonly` payload

`Readonly` payloadEncoded

`Protected` signatureSet

`Optional` additionalProtectedHeader: POJO

privateKeyOrKeyPair: PrivateKey | Readonly<{
privateKey: PrivateKey;
publicKey: PublicKey;
secretKey: SecretKey;
}>

`Optional` additionalProtectedHeader: POJO

`Static` fromEncoded

`Static` fromPayload

`Static` fromSigned