Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by becoming a sponsor.
The UnsecuredJWT class is a utility for dealing with { "alg": "none" } Unsecured JWTs.
Example
Encoding
const unsecuredJwt = new jose.UnsecuredJWT({ 'urn:example:claim': true })
.setIssuedAt()
.setIssuer('urn:example:issuer')
.setAudience('urn:example:audience')
.setExpirationTime('2h')
.encode()
console.log(unsecuredJwt)Example
Decoding
const payload = jose.UnsecuredJWT.decode(jwt, {
issuer: 'urn:example:issuer',
audience: 'urn:example:audience',
})
console.log(payload)• new UnsecuredJWT(payload?)
| Name | Type | Description |
|---|---|---|
payload |
JWTPayload |
The JWT Claims Set object. Defaults to an empty object. |
▸ Static decode<PayloadType>(jwt, options?): UnsecuredResult<PayloadType>
Decodes an unsecured JWT.
| Name | Type |
|---|---|
PayloadType |
JWTPayload |
| Name | Type | Description |
|---|---|---|
jwt |
string |
Unsecured JWT to decode the payload of. |
options? |
JWTClaimVerificationOptions |
JWT Claims Set validation options. |
UnsecuredResult<PayloadType>
▸ encode(): string
Encodes the Unsecured JWT.
string
▸ setAudience(audience): UnsecuredJWT
Set the "aud" (Audience) Claim.
| Name | Type | Description |
|---|---|---|
audience |
string | string[] |
"aud" (Audience) Claim value to set on the JWT Claims Set. |
▸ setExpirationTime(input): UnsecuredJWT
Set the "exp" (Expiration Time) Claim.
| Name | Type | Description |
|---|---|---|
input |
string | number | Date |
"exp" (Expiration Time) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
▸ setIssuedAt(input?): UnsecuredJWT
Set the "iat" (Issued At) Claim.
| Name | Type | Description |
|---|---|---|
input? |
number | Date |
"iat" (Issued At) Claim value to set on the JWT Claims Set. Default is current timestamp. |
▸ setIssuer(issuer): UnsecuredJWT
Set the "iss" (Issuer) Claim.
| Name | Type | Description |
|---|---|---|
issuer |
string |
"Issuer" Claim value to set on the JWT Claims Set. |
▸ setJti(jwtId): UnsecuredJWT
Set the "jti" (JWT ID) Claim.
| Name | Type | Description |
|---|---|---|
jwtId |
string |
"jti" (JWT ID) Claim value to set on the JWT Claims Set. |
▸ setNotBefore(input): UnsecuredJWT
Set the "nbf" (Not Before) Claim.
| Name | Type | Description |
|---|---|---|
input |
string | number | Date |
"nbf" (Not Before) Claim value to set on the JWT Claims Set. When number is passed that is used as a value, when string is passed it is resolved to a time span and added to the current timestamp. |
▸ setSubject(subject): UnsecuredJWT
Set the "sub" (Subject) Claim.
| Name | Type | Description |
|---|---|---|
subject |
string |
"sub" (Subject) Claim value to set on the JWT Claims Set. |