Class BaseCryptoClientAbstract

constructor

• new BaseCryptoClient(key: string, kernel: IKernel): BaseCryptoClient

  Parameters

  • key: string
  • kernel: IKernel

  Returns BaseCryptoClient

ReadonlyexpiresIn

ReadonlyexpiresInRefresh

AbstractapiTokenValidation

• apiTokenValidation(
      request: TokAuthValidationRequest,
  ): Promise<{ userId: string | null; valid: boolean }>

  Validates an API token for a specified user and request type.

  Parameters

  • request: TokAuthValidationRequest

  Returns Promise<{ userId: string | null; valid: boolean }>

  A promise that resolves to an object containing a boolean indicating whether the token is valid and the user ID if validation succeeds; otherwise, null is returned for the user ID.

AbstractbearerTokenValidation

• bearerTokenValidation(req: XRequest): Promise<number | JwtToken>

  Validates the bearer token present in the provided request.

  Parameters

  • req: XRequest

    The HTTP request containing the Authorization header.

  Returns Promise<number | JwtToken>

  A promise that resolves to the decoded JWT payload if the token is valid, or a numeric status code (e.g., 401) if validation fails.

AbstractgenerateRefreshToken

• generateRefreshToken(token: JwtToken): Promise<TokenData | null>

  Generates a refresh token for the provided JWT token.

  Parameters

  • token: JwtToken

    The JWT token for which a refresh token should be generated.

  Returns Promise<TokenData | null>

  A promise that resolves to the new TokenData object or {@code null} if the token cannot be refreshed.

AbstractgenerateToken

• generateToken(
      userID: string,
      userName: string,
      refresh: boolean,
      jti?: string,
  ): Promise<TokenData>

  Generates a token for the specified user.

  Parameters

  • userID: string

    The unique identifier of the user.

  • userName: string

    The display name of the user.

  • refresh: boolean

    Indicates whether a refresh token should be issued.

  • Optionaljti: string

    Optional JWT ID to correlate tokens.

  Returns Promise<TokenData>

  A promise that resolves with the generated token and, if requested, a refresh token.

jwtDecodeAccessToken

• jwtDecodeAccessToken(token: string): JwtToken | null

  Decodes a JWT access token and returns its payload.

  Parameters

  • token: string

    The JWT access token to decode.

  Returns JwtToken | null

  The decoded payload if the token is valid, otherwise null.

jwtGenerateAccessToken

• jwtGenerateAccessToken(
      data: JwtToken,
      expire?: number | "default" | "refresh" | StringValue,
  ): Promise<string>

  Generates a signed JWT access token.

  Parameters

  • data: JwtToken

    The payload data for the token.

  • expire: number | "default" | "refresh" | StringValue = 'default'

    Optional expiration time for the token, expressed in seconds or as an ISO 8601 duration string.

  Returns Promise<string>

  A promise that resolves to the generated JWT token string.

jwtVerifyAccessToken

• jwtVerifyAccessToken(token: string): Promise<number | JwtToken>

  Verifies a JWT access token and returns the decoded payload or an error code.

  Parameters

  • token: string

    The JWT access token string to verify.

  Returns Promise<number | JwtToken>

  A promise that resolves to the decoded token payload of type if verification succeeds, or a numeric error code if verification fails.

AbstractpermissionValidation

• permissionValidation(request: ValidationRequest): Promise<boolean>

  Validates user permissions according to the supplied validation request.

  Parameters

  • request: ValidationRequest

    The request object containing the necessary data for permission evaluation, such as user identity, requested action, and contextual parameters.

  Returns Promise<boolean>

  A promise that resolves to true if the permissions are valid for the specified request, otherwise resolves to false.

AbstractsetCookie

• setCookie(req: XResponse, data: TokenData): Promise<void>

  Sets an authentication cookie on the given response using the provided token data.

  Parameters

  • req: XResponse

    The XResponse object on which the cookie will be set.

  • data: TokenData

    The TokenData containing the information to store in the cookie.

  Returns Promise<void>

  A promise that resolves when the cookie has been set successfully.

AbstracttokenExtractor

• tokenExtractor(req: XRequest): string | undefined

  Extracts an authentication token from the provided request.

  Parameters

  • req: XRequest

    The incoming request object from which to extract the token.

  Returns string | undefined

  The extracted token if present; otherwise, undefined.