jwt package

Represents a JWT header

Field Name Data Type Description Default Value
alg string
typ string
cty string
kid string
customClaims map []
  • <Header> Header.<init>()

public struct JWTIssuerConfig

Represents JWT issuer configurations

Field Name Data Type Description Default Value
certificateAlias string
keyPassword string
  • <JWTIssuerConfig> JWTIssuerConfig.<init>()

public struct JWTValidatorConfig

Represents JWT validator configurations

Field Name Data Type Description Default Value
issuer string
audience string
certificateAlias string
  • <JWTValidatorConfig> JWTValidatorConfig.<init>()

public struct Payload

Represents a JWT payload

Field Name Data Type Description Default Value
iss string
sub string
aud string[] []
jti string
exp int
nbf int
iat int
customClaims map []
  • <Payload> Payload.<init>()

public function issue(Header header, Payload payload, JWTIssuerConfig config) returns (string | error)

Issue a JWT token

Parameter Name Data Type Description
header Header Header object
payload Payload Payload object
config JWTIssuerConfig JWTIssuerConfig object

Return Variable Data Type Description
string | error string: JWT token string

public function validate(string jwtToken, JWTValidatorConfig config) returns (Payload | boolean | error)

Validity given JWT token

Parameter Name Data Type Description
jwtToken string JWT token that need to validate
config JWTValidatorConfig JWTValidatorConfig object

Return Variable Data Type Description
Payload | boolean | error boolean: If JWT token is valied true , else false