validateJWT

Documentation

Index

• Constants
• Variables

Constants

const KeyAdministrator = "administrator"

const KeyPermissions = "permissions"

const KeySubject = "subject"

const KeyTokenValidated = "validated-token"

const ScopeAdministrator = "*:*"

Variables

var ErrJWTExpired = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 401,
	Title:  "JSON Web Token Expired",
	Detail: "The JSON Web Token used to access this resource has expired. Access has been denied",
}

ErrJWTExpired is returned if the JWT in the request is already expired

var ErrJWTInvalidIssuer = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 401,
	Title:  "JSON Web Token Issuer Wrong",
	Detail: "The JSON Web Token used to access this resource has not been issued by the correct issuer. Please check your authentication provider.",
}

ErrJWTInvalidIssuer is returned if the JWTs issuer field indicates that it has not been issued by the API Gateway

var ErrJWTInvalidScopeType = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-15.5.1",
	Status: 400,
	Title:  "No Scopes Set",
	Detail: "The JSON Web Token used to access this resource does not contain a scope to identify the permissions of the token",
}

ErrJWTInvalidScopeType is returned if the JWT did not contain the group claim and therefore is not usable for the service

var ErrJWTMalformed = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-15.5.1",
	Status: 400,
	Title:  "JSON Web Token Malformed",
	Detail: "The JSON Web Token presented as Bearer Token is not correctly formatted",
}

ErrJWTMalformed is returned if the request did contain a JWT but is malformed

var ErrJWTNoScopeSet = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-15.5.1",
	Status: 400,
	Title:  "No Scopes Set",
	Detail: "The JSON Web Token used to access this resource does not contain a scope to identify the permissions of the token",
}

ErrJWTNoScopeSet is returned if the JWT did not contain the group claim and therefore is not usable for the service

var ErrJWTNotCreatedYet = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 401,
	Title:  "JSON Web Token Used Before Creation",
	Detail: "The JSON Web Token used to access this resource been created in the future, therefore it is invalid and the access has been denied. Please check your authentication provider.",
}

ErrJWTNotCreatedYet is returned if the JWTs iat field indicating at which the token has been issued is in the future

var ErrJWTNotYetValid = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 401,
	Title:  "JSON Web Token Used Before Validity",
	Detail: "The JSON Web Token used to access this resource has been used before it is permitted to be used. Access has been denied",
}

ErrJWTNotYetValid is returned if the field indicating a time before the jwt is not valid contains a time in the future

var ErrMissingAuthorizationHeader = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 401,
	Title:  "Missing Authorization Header",
	Detail: "The request did not contain the 'Authorization' header. Please check your request.",
}

ErrMissingAuthorizationHeader is returned if the request did not contain the `Authorization` header

var ErrSingleAuthorizationHeaderOnly = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 400,
	Title:  "Multiple Credentials supplied",
	Detail: "The request contained multiple credentials. Due to security reasons, this is not supported and the request has been rejected",
}

ErrSingleAuthorizationHeaderOnly is returned if the request contained multiple credentials

var ErrUnsupportedTokenScheme = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc6750.html#section-3.1",
	Status: 400,
	Title:  "Unsupported Token Scheme used",
	Detail: "The token scheme used in this request is not supported by the service. Please check your request.",
}

ErrUnsupportedTokenScheme is returned if the request did not utilize the Bearer token scheme as documented in RFC 6750.

var Forbidden = types.ServiceError{
	Type:   "https://www.rfc-editor.org/rfc/rfc9110#section-15.5.4",
	Status: 403,
	Title:  "Forbidden",
	Detail: "Access to this resource is not allowed for your user. Please check that you have been assigned to the required scope: %s",
}

Forbidden is returned if the user is authenticated but not authorized to access the resource