Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

CipherCCMTypes

CipherCCMTypes: "aes-128-ccm" | "aes-192-ccm" | "aes-256-ccm"

CipherGCMTypes

CipherGCMTypes: "aes-128-gcm" | "aes-192-gcm" | "aes-256-gcm"

ECDHKeyFormat

ECDHKeyFormat: "compressed" | "uncompressed" | "hybrid"

HexBase64BinaryEncoding

HexBase64BinaryEncoding: "binary" | "base64" | "hex"

HexBase64Latin1Encoding

HexBase64Latin1Encoding: "latin1" | "hex" | "base64"

KeyFormat

KeyFormat: "pem" | "der"

KeyType

KeyType: "rsa" | "dsa" | "ec"

Utf8AsciiBinaryEncoding

Utf8AsciiBinaryEncoding: "utf8" | "ascii" | "binary"

Utf8AsciiLatin1Encoding

Utf8AsciiLatin1Encoding: "utf8" | "ascii" | "latin1"

Variables

Const DEFAULT_ENCODING

DEFAULT_ENCODING: string
deprecated

since v10.0.0

Const fips

fips: boolean
deprecated

since v10.0.0

Functions

createCipher

  • deprecated

    since v10.0.0 use createCipheriv()

    Parameters

    Returns CipherCCM

  • deprecated

    since v10.0.0 use createCipheriv()

    Parameters

    Returns CipherGCM

  • deprecated

    since v10.0.0 use createCipheriv()

    Parameters

    • algorithm: string
    • password: string | Buffer | TypedArray | DataView
    • Optional options: stream.TransformOptions

    Returns Cipher

createCipheriv

createCredentials

createDecipher

  • deprecated

    since v10.0.0 use createCipheriv()

    Parameters

    Returns DecipherCCM

  • deprecated

    since v10.0.0 use createCipheriv()

    Parameters

    Returns DecipherGCM

  • deprecated

    since v10.0.0 use createCipheriv()

    Parameters

    • algorithm: string
    • password: string | Buffer | TypedArray | DataView
    • Optional options: stream.TransformOptions

    Returns Decipher

createDecipheriv

createDiffieHellman

createECDH

  • createECDH(curve_name: string): ECDH
  • Parameters

    • curve_name: string

    Returns ECDH

createHash

  • createHash(algorithm: string, options?: stream.TransformOptions): Hash
  • Parameters

    • algorithm: string
    • Optional options: stream.TransformOptions

    Returns Hash

createHmac

  • createHmac(algorithm: string, key: string | Buffer | TypedArray | DataView, options?: stream.TransformOptions): Hmac
  • Parameters

    • algorithm: string
    • key: string | Buffer | TypedArray | DataView
    • Optional options: stream.TransformOptions

    Returns Hmac

createSign

  • createSign(algorithm: string, options?: stream.WritableOptions): Signer
  • Parameters

    • algorithm: string
    • Optional options: stream.WritableOptions

    Returns Signer

createVerify

  • createVerify(algorith: string, options?: stream.WritableOptions): Verify
  • Parameters

    • algorith: string
    • Optional options: stream.WritableOptions

    Returns Verify

generateKeyPairSync

getCiphers

  • getCiphers(): string[]
  • Returns string[]

getCurves

  • getCurves(): string[]
  • Returns string[]

getDiffieHellman

  • Parameters

    • group_name: string

    Returns DiffieHellman

getHashes

  • getHashes(): string[]
  • Returns string[]

pbkdf2

  • pbkdf2(password: string | Buffer | TypedArray | DataView, salt: string | Buffer | TypedArray | DataView, iterations: number, keylen: number, digest: string, callback: function): void
  • Parameters

    • password: string | Buffer | TypedArray | DataView
    • salt: string | Buffer | TypedArray | DataView
    • iterations: number
    • keylen: number
    • digest: string
    • callback: function
        • (err: Error | null, derivedKey: Buffer): any
        • Parameters

          • err: Error | null
          • derivedKey: Buffer

          Returns any

    Returns void

pbkdf2Sync

  • Parameters

    Returns Buffer

privateDecrypt

privateEncrypt

pseudoRandomBytes

  • pseudoRandomBytes(size: number): Buffer
  • pseudoRandomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error | null, buf: Buffer): void
        • Parameters

          • err: Error | null
          • buf: Buffer

          Returns void

    Returns void

publicDecrypt

publicEncrypt

randomBytes

  • randomBytes(size: number): Buffer
  • randomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error | null, buf: Buffer): void
        • Parameters

          • err: Error | null
          • buf: Buffer

          Returns void

    Returns void

randomFill

  • randomFill<T>(buffer: T, callback: function): void
  • randomFill<T>(buffer: T, offset: number, callback: function): void
  • randomFill<T>(buffer: T, offset: number, size: number, callback: function): void
  • Type parameters

    Parameters

    • buffer: T
    • callback: function
        • (err: Error | null, buf: T): void
        • Parameters

          • err: Error | null
          • buf: T

          Returns void

    Returns void

  • Type parameters

    Parameters

    • buffer: T
    • offset: number
    • callback: function
        • (err: Error | null, buf: T): void
        • Parameters

          • err: Error | null
          • buf: T

          Returns void

    Returns void

  • Type parameters

    Parameters

    • buffer: T
    • offset: number
    • size: number
    • callback: function
        • (err: Error | null, buf: T): void
        • Parameters

          • err: Error | null
          • buf: T

          Returns void

    Returns void

randomFillSync

  • randomFillSync<T>(buffer: T, offset?: undefined | number, size?: undefined | number): T
  • Type parameters

    Parameters

    • buffer: T
    • Optional offset: undefined | number
    • Optional size: undefined | number

    Returns T

scrypt

  • Parameters

    • password: string | Buffer | TypedArray | DataView
    • salt: string | Buffer | TypedArray | DataView
    • keylen: number
    • callback: function
        • (err: Error | null, derivedKey: Buffer): void
        • Parameters

          • err: Error | null
          • derivedKey: Buffer

          Returns void

    Returns void

  • Parameters

    Returns void

scryptSync

timingSafeEqual

Generated using TypeDoc