Class AWSKMSService

class: AWSKMSService

shared Key Management Service to encrypt/decrypt message.

Hierarchy

AWSKMSService

Implements

CoreKmsService

Index

Constructors

Properties

_instance _keyId _options DEF_KMS_TARGET ENV_KMS_KEY_ID

Methods

decrypt encrypt getPublicKey hello instance keyId name sample sign verify

Constructors

constructor

new AWSKMSService(keyId?: string, options?: AWSKMSSignOption): AWSKMSService
Parameters
- Optional keyId: string
- Optional options: AWSKMSSignOption
Returns AWSKMSService
- Defined in src/cores/aws/aws-kms-service.ts:70

Properties

`Protected` _instance

_instance: KMS

`Private` _keyId

_keyId: string

`Private` _options

_options: AWSKMSSignOption

`Static` DEF_KMS_TARGET

DEF_KMS_TARGET: string = ...

`Static` ENV_KMS_KEY_ID

ENV_KMS_KEY_ID: string = 'KMS_KEY_ID'

environ name of KMS KEY

Methods

decrypt

decrypt(encryptedSecret: string): Promise<string>
Decrypt message
Parameters
- encryptedSecret: string
Returns Promise<string>
Implementation of CoreKmsService.decrypt
- Defined in src/cores/aws/aws-kms-service.ts:129

encrypt

encrypt(message: string): Promise<string>
Encrypt message
Parameters
- message: string
Returns Promise<string>
Implementation of CoreKmsService.encrypt
- Defined in src/cores/aws/aws-kms-service.ts:109

getPublicKey

getPublicKey(encoding?: BufferEncoding): Promise<string>
retrieve public-key for asymetric verification.
- used to verify signature with JWT library w/o making request to AWS KMS.
- in general, cache this public-key to verify locally.
Parameters
- encoding: BufferEncoding = 'base64'
  
  (optional) encoding type
Returns Promise<string>
- Defined in src/cores/aws/aws-kms-service.ts:202

hello

hello(): string
hello

Returns string
Implementation of CoreKmsService.hello
- Defined in src/cores/aws/aws-kms-service.ts:84

instance

instance(): KMS
get KMS instance in stock

Returns KMS
- Defined in src/cores/aws/aws-kms-service.ts:99

keyId

keyId(): string
get key-id to encrypt.

Returns string
- Defined in src/cores/aws/aws-kms-service.ts:89

name

name(): string
get name of this

Returns string
- Defined in src/cores/aws/aws-kms-service.ts:79

sample

sample(): Promise<{ KMS_KEY_ID: string; decrypted: string; encrypted: string; keyId: string; message: string }>
it should be 'hello lemon'

Example
```
# encrypt text
$ aws kms encrypt --profile <profile> --key-id <kms-key-id> --plaintext "hello lemon" --query CiphertextBlob --output text
```
Returns Promise<{ KMS_KEY_ID: string; decrypted: string; encrypted: string; keyId: string; message: string }>
- Defined in src/cores/aws/aws-kms-service.ts:221

sign

sign(message: string, forJwtSignature?: boolean): Promise<string>
make signature by message
Parameters
- message: string
  
  any string
- forJwtSignature: boolean = true
  
  (option) flag to get JWT signature format.
Returns Promise<string>
- Defined in src/cores/aws/aws-kms-service.ts:150

verify

verify(message: string, signature: string | Buffer): Promise<boolean>
verify signature in asymetric way
- it tooks around 30ms
Parameters
- message: string
  
  any string
- signature: string | Buffer
  
  signature of Buffer or string(in base64)
Returns Promise<boolean>
- Defined in src/cores/aws/aws-kms-service.ts:173

Generated using TypeDoc