Class TokenBundle

Kliento token bundle.

Index

Methods

serialise verify deserialise deserialiseFromAuthHeader sign

Methods

serialise

serialise(): ArrayBuffer
Serialise the token bundle.

Returns ArrayBuffer
The serialised token bundle.
- Defined in src/lib/TokenBundle.ts:108

verify

verify(
audience: string,
options?: Partial<TokenBundleVerificationOptions>,
): Promise<TokenBundleVerification>
Verify the token bundle.
Parameters
- audience: string
  The required audience of the token.
- options: Partial<TokenBundleVerificationOptions> = {}
  Verification options.
  - date
    The date at which to verify the token bundle.
  - trustAnchors
    The trust anchors with which to verify the token bundle.
Returns Promise<TokenBundleVerification>
The token claims.
- Defined in src/lib/TokenBundle.ts:120

`Static`deserialise

deserialise(serialisation: ArrayBuffer): TokenBundle
Deserialise a token bundle.
Parameters
- serialisation: ArrayBuffer
  The serialisation of the token bundle.
Returns TokenBundle
A new token bundle.
- Defined in src/lib/TokenBundle.ts:30

`Static`deserialiseFromAuthHeader

deserialiseFromAuthHeader(header: string): TokenBundle
Deserialise a token bundle from an authorization header.
Parameters
- header: string
  The authorization header.
Returns TokenBundle
The token bundle.

Throws
An error if the authorization scheme is not "Kliento" or the token bundle is malformed.

This value requires the scheme "Kliento" and the token bundle to be base64-encoded.
- Defined in src/lib/TokenBundle.ts:56

`Static`sign

sign(
    token: Token,
    privateKey: CryptoKey,
    chain: Chain,
    expiry: Date,
    options?: Partial<TokenBundleOptions>,
): Promise<TokenBundle>
Sign a token.
Parameters
- token: Token
  The token to sign.
- privateKey: CryptoKey
  The private key to sign the token with.
- chain: Chain
  The chain to sign the token with.
- expiry: Date
  The expiry date of the token.
- options: Partial<TokenBundleOptions> = {}
  The options for the token bundle.
Returns Promise<TokenBundle>
A new token bundle.
- Defined in src/lib/TokenBundle.ts:82