Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PubSecKeyOptions

Options describing Key stored in PEM format.

Hierarchy

  • PubSecKeyOptions

Index

Constructors

Methods

Constructors

constructor

Methods

getAlgorithm

  • getAlgorithm(): string

  • Returns string

getBuffer

  • getBuffer(): Buffer

  • The PEM or Secret key buffer. When working with secret materials, the material is expected to be encoded in UTF-8. PEM files are expected to be US_ASCII as the format uses a base64 encoding for the payload.

    Returns Buffer

getId

  • getId(): string

  • Returns string

getPublicKey

  • getPublicKey(): string

  • Returns string

getSecretKey

  • getSecretKey(): string

  • Returns string

isCertificate

  • isCertificate(): boolean

  • Returns boolean

isSymmetric

  • isSymmetric(): boolean

  • Returns boolean

setAlgorithm

  • Parameters

    • algorithm: string

    Returns PubSecKeyOptions

setBuffer

  • The PEM or Secret key buffer. When working with secret materials, the material is expected to be encoded in UTF-8. PEM files are expected to be US_ASCII as the format uses a base64 encoding for the payload.

    Parameters

    • buffer: Buffer

    Returns PubSecKeyOptions

setCertificate

  • Parameters

    • certificate: boolean

    Returns PubSecKeyOptions

setId

  • Parameters

    • id: string

    Returns PubSecKeyOptions

setPublicKey

  • Parameters

    • publicKey: string

    Returns PubSecKeyOptions

setSecretKey

  • Parameters

    • secretKey: string

    Returns PubSecKeyOptions

setSymmetric

  • Parameters

    • symmetric: boolean

    Returns PubSecKeyOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc