@types/pem

Functions

• config()
• createCertificate()
• createCSR()
• createDhparam()
• createPkcs12()
• createPrivateKey()
• getDhparamInfo()
• getFingerprint()
• getModulus()
• getPublicKey()
• readCertificateInfo()
• readPkcs12()
• verifySigningChain()

Interfaces

• CertificateCreationOptions

  • clientKeyPassword
  • config
  • csr
  • days
  • extFile
  • selfSigned
  • serial
  • serviceCertificate
  • serviceKey
  • serviceKeyPassword
• CertificateCreationResult

  • certificate
  • clientKey
  • csr
  • serviceKey
• CertificateSubjectReadResult

  • commonName
  • country
  • emailAddress
  • locality
  • organization
  • organizationUnit
  • state
• CSRCreationOptions

  • altNames
  • clientKey
  • clientKeyPassword
  • commonName
  • country
  • csrConfigFile
  • emailAddress
  • hash
  • keyBitsize
  • locality
  • organization
  • organizationUnit
  • state
• ModuleConfiguration

  • pathOpenSSL
• Pkcs12CreationOptions

  • certFiles
  • cipher
  • clientKeyPassword
• Pkcs12ReadOptions

  • clientKeyPassword
  • p12Password
• Pkcs12ReadResult

  • ca
  • cert
  • key
• PrivateKeyCreationOptions

  • cipher
  • password

Type Aliases

• Callback
• HashFunction
• PrivateKeyCipher

function config

config: (options: ModuleConfiguration) => void;

• config the pem module

function createCertificate

createCertificate: {
    (
        options: CertificateCreationOptions,
        callback: Callback<CertificateCreationResult>
    ): void;
    (callback: Callback<CertificateCreationResult>): void;
};

• Creates a certificate based on a CSR. If CSR is not defined, a new one will be generated automatically. For CSR generation all the options values can be used as with createCSR.

  Parameter CertificateCreationOptions

  Optional options object

  Parameter callback

  Callback function with an error object and {certificate, csr, clientKey, serviceKey}

function createCSR

createCSR: {
    (
        options: CSRCreationOptions,
        callback: Callback<{ csr: string; clientKey: string }>
    ): void;
    (callback: Callback<{ csr: string; clientKey: string }>): void;
};

• Creates a Certificate Signing Request

  If options.clientKey is undefined, a new key is created automatically. The used key is included in the callback return as clientKey

  Parameter options

  Optional options object

  Parameter callback

  Callback function with an error object and {csr, clientKey}

function createDhparam

createDhparam: {
    (keyBitsize: number, callback: Callback<{ dhparam: any }>): void;
    (callback: Callback<{ dhparam: any }>): void;
};

• Creates a dhparam key

  Parameter keyBitsize

  Size of the key, defaults to 512bit

  Parameter callback

  Callback function with an error object and {dhparam}

function createPkcs12

createPkcs12: {
    (
        key: string,
        certificate: string,
        password: string,
        options: Pkcs12CreationOptions,
        callback: Callback<{ pkcs12: any }>
    ): void;
    (
        key: string,
        certificate: string,
        password: string,
        callback: Callback<{ pkcs12: any }>
    ): void;
};

• Exports private key and certificate to a PKCS12 keystore

  Parameter key

  PEM encoded private key

  Parameter certificate

  PEM encoded certificate

  Parameter password

  Password of the result PKCS12 file

  Parameter options

  object of cipher and optional client key password {cipher:'aes128', clientKeyPassword: 'xxx'}

  Parameter callback

  Callback function with an error object and {pkcs12}

function createPrivateKey

createPrivateKey: {
    (
        keyBitsize: number,
        options: PrivateKeyCreationOptions,
        callback: Callback<{ key: string }>
    ): void;
    (
        optionsOrKeyBitsize: number | PrivateKeyCreationOptions,
        callback: Callback<{ key: string }>
    ): void;
    (callback: Callback<{ key: string }>): void;
};

• Creates a private key

  Parameter keyBitsize

  Size of the key, defaults to 2048bit (can also be a function)

  Parameter options

  private key encryption settings, defaults to empty object (no enryption)

  Parameter callback

  Callback function with an error object and {key}

function getDhparamInfo

getDhparamInfo: (
    dh: string,
    callback: Callback<{ size: any; prime: any }>
) => void;

• Gets the size and prime of DH parameters

  Parameter dh

  DH parameters PEM encoded

  Parameter callback

  Callback function with an error object and {size, prime}

function getFingerprint

getFingerprint: {
    (
        certificate: string,
        hash: HashFunction,
        callback: Callback<{ fingerprint: string }>
    ): void;
    (certificate: string, callback: Callback<{ fingerprint: string }>): void;
    (callback: Callback<{ fingerprint: string }>): void;
};

• Gets the fingerprint for a certificate

  Parameter certificate

  PEM encoded certificate

  Parameter hash

  Hash function to use (either md5 sha1 or sha256, defaults to sha256)

  Parameter callback

  Callback function with an error object and {fingerprint}

function getModulus

getModulus: {
    (
        certificate: string,
        password: string,
        callback: Callback<{ modulus: any }>
    ): void;
    (certificate: string, callback: Callback<{ modulus: any }>): void;
};

• Gets the modulus from a certificate, a CSR or a private key

  Parameter certificate

  PEM encoded, CSR PEM encoded, or private key

  Parameter password

  password for the certificate

  Parameter callback

  Callback function with an error object and {modulus}

function getPublicKey

getPublicKey: {
    (certificate: string, callback: Callback<{ publicKey: string }>): void;
    (callback: Callback<{ publicKey: string }>): void;
};

• Exports a public key from a private key, CSR or certificate

  Parameter certificate

  PEM encoded private key, CSR or certificate

  Parameter callback

  Callback function with an error object and {publicKey}

function readCertificateInfo

readCertificateInfo: {
    (certificate: string, callback: Callback<CertificateSubjectReadResult>): void;
    (callback: Callback<CertificateSubjectReadResult>): void;
};

• Reads subject data from a certificate or a CSR

  Parameter certificate

  PEM encoded CSR or certificate

  Parameter callback

  Callback function with an error object and {country, state, locality, organization, organizationUnit, commonName, emailAddress}

function readPkcs12

readPkcs12: {
    (
        bufferOrPath: Buffer | string,
        options: Pkcs12ReadOptions,
        callback: Callback<Pkcs12ReadResult>
    ): any;
    (bufferOrPath: any, callback: Callback<Pkcs12ReadResult>): any;
};

• Reads private key and certificate from a PKCS12 keystore

  Parameter callback

  Callback function with an error object and {pkcs12}

  Returns

  the result of the callback

function verifySigningChain

verifySigningChain: (
    certificate: string,
    ca: string[],
    callback: Callback<boolean>
) => void;

• Verifies the signing chain of the passed certificate

  Parameter certificate

  PEM encoded certificate

  Parameter ca

  List of CA certificates

  Parameter callback

  Callback function with an error object and a boolean valid

type Callback

type Callback<T> = (error: any, result: T) => any;

type HashFunction

type HashFunction = 'md5' | 'sha1' | 'sha256' | string;

type PrivateKeyCipher

type PrivateKeyCipher =
    | 'aes128'
    | 'aes192'
    | 'aes256'
    | 'camellia128'
    | 'camellia192'
    | 'camellia256'
    | 'des'
    | 'des3'
    | 'idea'
    | string;