Type alias Pkcs11Options

Pkcs11Options: {
    pkcs11_lib: Pkcs11Lib;
    user_pin: null | string;
    slot_id?: number;
    token_label?: string;
    private_key_object_label?: string;
    cert_file_path?: string;
    cert_file_contents?: string;
}

Options for TLS using a PKCS#11 library for private key operations.

Unix only. nodejs only.

Type declaration

  • pkcs11_lib: Pkcs11Lib

    Use this PKCS#11 library.

  • user_pin: null | string

    Use this PIN to log the user into the PKCS#11 token. Pass null to log into a token with a "protected authentication path".

  • Optional slot_id?: number

    Specify the slot ID containing a PKCS#11 token. If not specified, the token will be chosen based on other criteria (such as [[token_label]]).

  • Optional token_label?: string

    Specify the label of the PKCS#11 token to use. If not specified, the token will be chosen based on other criteria (such as [[slot_id]]).

  • Optional private_key_object_label?: string

    Specify the label of the private key object on the PKCS#11 token. If not specified, the key will be chosen based on other criteria (such as being the only available private key on the token).

  • Optional cert_file_path?: string

    Use this X.509 certificate (file on disk). The certificate must be PEM-formatted. The certificate may be specified by other means instead (ex: [[cert_file_contents]])

  • Optional cert_file_contents?: string

    Use this X.509 certificate (contents in memory). The certificate must be PEM-formatted. The certificate may be specified by other means instead (ex: [[cert_file_path]])

See

[[TlsContextOptions.create_client_with_mtls_pkcs11]]

Settings

Member Visibility

Theme

Generated using TypeDoc