Class CryptoClient<T>

Type Parameters

T extends JwtExtend = JwtExtend

Hierarchy (View Summary)

CoreCryptoClient
- CryptoClient

Implements

ICClient<T>

Constructors

constructor

new CryptoClient<T extends JwtExtend = JwtExtend>(
key: string,
kernel: IKernel,
): CryptoClient<T>
Type Parameters
- T extends JwtExtend = JwtExtend
Parameters
- key: string
- kernel: IKernel
Returns CryptoClient<T>
Overrides CoreCryptoClient.constructor
- Defined in src/modules/crypto/CryptoClient.ts:18

Properties

`Protected`AesIV

AesIV: string

`Protected`AesKey

AesKey: string

`Protected`authProvider

authProvider: null | IAuthProvider<T>

`Protected`expiresIn

expiresIn: StringValue

`Protected`kernel

kernel: IKernel

Methods

apiTokenValidation

apiTokenValidation(
    username: string,
    token: string,
    requestType: string,
): Promise<{ userId: null | string; valid: boolean }>
Parameters
- username: string
- token: string
- requestType: string
Returns Promise<{ userId: null | string; valid: boolean }>
Implementation of ICClient.apiTokenValidation
- Defined in src/modules/crypto/CryptoClient.ts:70

bearerTokenValidation

bearerTokenValidation(req: XRequest): Promise<number | JwtToken<T>>
Parameters
- req: XRequest
Returns Promise<number | JwtToken<T>>
Implementation of ICClient.bearerTokenValidation
- Defined in src/modules/crypto/CryptoClient.ts:108

decrypt

decrypt(enc: string, iv: Buffer, authTag: Buffer): string
Parameters
- enc: string
- iv: Buffer
- authTag: Buffer
Returns string
Implementation of ICClient.decrypt
Inherited from CoreCryptoClient.decrypt
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:14

encrypt

encrypt(message: string): { auth: Buffer; enc: string; iv: Buffer }
Parameters
- message: string
Returns { auth: Buffer; enc: string; iv: Buffer }
Implementation of ICClient.encrypt
Inherited from CoreCryptoClient.encrypt
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:9

generateSecureToken

generateSecureToken(length: number): Promise<string>
Parameters
- length: number
Returns Promise<string>
Implementation of ICClient.generateSecureToken
Inherited from CoreCryptoClient.generateSecureToken
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:8

getHash

getHash(seed: string, val: string): string
Parameters
- seed: string
- val: string
Returns string
Implementation of ICClient.getHash
Inherited from CoreCryptoClient.getHash
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:16

getUUID

getUUID(): string
Returns string
Implementation of ICClient.getUUID
Inherited from CoreCryptoClient.getUUID
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:17

isValid

isValid(): boolean
Returns boolean
Implementation of ICClient.isValid
Inherited from CoreCryptoClient.isValid
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:15

jwtDecodeAccessToken

jwtDecodeAccessToken(token: string): null | JwtToken<T>
Parameters
- token: string
Returns null | JwtToken<T>
Implementation of ICClient.jwtDecodeAccessToken
- Defined in src/modules/crypto/CryptoClient.ts:48

jwtGenerateAccessToken

jwtGenerateAccessToken(
    data: JwtToken<T>,
    extend?: Record<string, any>,
    expire?: number | StringValue,
): Promise<string>
Parameters
- data: JwtToken<T>
- Optionalextend: Record<string, any>
- Optionalexpire: number | StringValue
Returns Promise<string>
Implementation of ICClient.jwtGenerateAccessToken
- Defined in src/modules/crypto/CryptoClient.ts:54

jwtVerifyAccessToken

jwtVerifyAccessToken(token: string): Promise<number | JwtToken<T>>
Parameters
- token: string
Returns Promise<number | JwtToken<T>>
Implementation of ICClient.jwtVerifyAccessToken
- Defined in src/modules/crypto/CryptoClient.ts:34

keyStoreLoad

keyStoreLoad(e_id: string): Promise<null | string>
Parameters
- e_id: string
Returns Promise<null | string>
Implementation of ICClient.keyStoreLoad
Inherited from CoreCryptoClient.keyStoreLoad
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:19

keyStoreSave

keyStoreSave(data: string): Promise<string>
Parameters
- data: string
Returns Promise<string>
Implementation of ICClient.keyStoreSave
Inherited from CoreCryptoClient.keyStoreSave
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:18

permissionValidation

permissionValidation(token: JwtToken<T>, requestType: string): Promise<boolean>
Parameters
- token: JwtToken<T>
- requestType: string
Returns Promise<boolean>
Implementation of ICClient.permissionValidation
- Defined in src/modules/crypto/CryptoClient.ts:98

setAuthProvider

setAuthProvider(provider: IAuthProvider<T>): boolean
Parameters
- provider: IAuthProvider<T>
Returns boolean
Implementation of ICClient.setAuthProvider
- Defined in src/modules/crypto/CryptoClient.ts:26

timeSavePWValidation

timeSavePWValidation(content: string, validator: string): boolean
Parameters
- content: string
- validator: string
Returns boolean
Implementation of ICClient.timeSavePWValidation
Inherited from CoreCryptoClient.timeSavePWValidation
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:20

`Static`fromPW

fromPW(pw: string): string
Parameters
- pw: string
Returns string
Inherited from CoreCryptoClient.fromPW
- Defined in node_modules/@grandlinex/core/dist/mjs/modules/crypto/CoreCryptoClient.d.ts:7