Options
All
  • Public
  • Public/Protected
  • All
Menu

Module decryptorUtils

Index

Type Aliases

Functions

Type Aliases

AssumeRoleSpec

AssumeRoleSpec: { RoleArn: string; RoleSessionName: string }

Specifies the Assume Role object used by the getCredentials method

Type declaration

  • RoleArn: string
    property

    The ARN of the role to assume

  • RoleSessionName: string
    property

    The name that the session will use

STSParams

STSParams: { accessKeyId: string; region: string; secretAccessKey: string }

Specifies an object with AWS access credentials needed for STS.

Type declaration

  • accessKeyId: string
    property

    The user's access key id

  • region: string
    property

    The region to log the user in

  • secretAccessKey: string
    property

    The user's access key secret

Functions

decrypt

  • decrypt(buffer: Buffer, credentials?: Credentials): Promise<string | undefined>

  • Decrypts a string using the AWS KMS service.

    Parameters

    • buffer: Buffer

      type of [[Buffer]]

    • Optional credentials: Credentials

      type of [[AWS.STS.Credentials]]

    Returns Promise<string | undefined>

    Promise type of [[String]]

decryptAssumingRole

  • decryptAssumingRole(buffer: Buffer, stsParams: STSParams, assumeRoleSpec: AssumeRoleSpec): Promise<string | undefined>

getCredentials

  • Obtains access credentials assuming an elegible KMS role, given valid AWS user credentials and the spec of the role to assume.

    Parameters

    Returns Promise<AWS.STS.Credentials | undefined>

    Promise type of [[AWS.STS.Credentials]]

Generated using TypeDoc