PKCS11js

https://peculiarventures.github.io/pkcs11js/
Admin
PKCS11js is a Node.js package for direct interaction with the PKCS#11 API, enabling cryptographic...
Tokens:56,525
Snippets:485
Trust Score:9.7
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install pkcs11js Package

Source: https://peculiarventures.github.io/pkcs11js

Install the pkcs11js package using npm.

```bash
$ npm install pkcs11js
Copy

```

--------------------------------

### Detect Slot Event

Source: https://peculiarventures.github.io/pkcs11js

Waits for a slot event, such as a token insertion or removal. This example uses `CKF_DONT_BLOCK` to poll for events without blocking the thread.

```javascript
var pkcs11js = require("pkcs11js");
var pkcs11 = new pkcs11js.PKCS11();
// Need a compliant Cryptoki Version 2.01 or later
pkcs11.load("/usr/local/lib/softhsm/libsofthsm2.so");

pkcs11.C_Initialize();

try {
    const slotId = pkcs11.C_WaitForSlotEvent(pkcs11js.CKF_DONT_BLOCK);
    if (slotId) {
        console.log(`Slot ${slotId} has been inserted`);
    } else {
        console.log(`No slot event`);
    }
} catch (e) {
    console.error(e);
} finally {
    pkcs11.C_Finalize();
}
```

--------------------------------

### C_Initialize

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes the Cryptoki library.

```APIDOC
## C_Initialize

### Description
Initializes the Cryptoki library.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **options** (InitializationOptions) - Optional - Initialization options. Supports implementation of standard `CK_C_INITIALIZE_ARGS` and extended NSS format.
  - If `options` is null or empty, it calls native `C_Initialize` with `NULL`.
  - If `options` doesn't have `libraryParameters`, it uses `CK_C_INITIALIZE_ARGS` structure.
  - If `options` has `libraryParameters`, it uses extended NSS structure.

### Request Example
```javascript
// Example usage:
// pkcs11.C_Initialize(); // Initialize with default options
// pkcs11.C_Initialize({ flags: 1 }); // Initialize with specific options
```

### Response
#### Success Response (200)
- **void**

#### Response Example
```json
null
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### C_GetObjectSize

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Gets the size of an object in bytes.

```APIDOC
## C_GetObjectSize

### Description
Gets the size of an object in bytes.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **session** (Buffer) - Required - The session's handle
- **object** (Buffer) - Required - The object's handle

### Request Example
```javascript
// Example usage:
// const objectSize = pkcs11.C_GetObjectSize(sessionHandle, objectHandle);
```

### Response
#### Success Response (200)
- **number** (number) - Size of an object in bytes

#### Response Example
```json
1024
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### Initialize PKCS11 Module and Perform Operations

Source: https://peculiarventures.github.io/pkcs11js

Initializes the PKCS11 module, retrieves information about the module, slots, tokens, and mechanisms, then opens a session, logs in, and performs operations before logging out and closing the session. Ensure the correct path to the PKCS11 library is provided.

```javascript
var pkcs11js = require("pkcs11js");  
  
var pkcs11 = new pkcs11js.PKCS11();  
pkcs11.load("/usr/local/lib/softhsm/libsofthsm2.so");  
  
pkcs11.C_Initialize();  
  
try {  
    // Getting info about PKCS11 Module  
    var module_info = pkcs11.C_GetInfo();  
  
    // Getting list of slots  
    var slots = pkcs11.C_GetSlotList(true);  
    var slot = slots[0];  
  
    // Getting info about slot  
    var slot_info = pkcs11.C_GetSlotInfo(slot);  
    // Getting info about token  
    var token_info = pkcs11.C_GetTokenInfo(slot);  
  
    // Getting info about Mechanism  
    var mechs = pkcs11.C_GetMechanismList(slot);  
    var mech_info = pkcs11.C_GetMechanismInfo(slot, mechs[0]);  
  
    var session = pkcs11.C_OpenSession(slot, pkcs11js.CKF_RW_SESSION | pkcs11js.CKF_SERIAL_SESSION);  
  
    // Getting info about Session  
    var info = pkcs11.C_GetSessionInfo(session);  
    pkcs11.C_Login(session, 1, "password");  
  
    /**  
     * Your app code here  
     */  
      
    pkcs11.C_Logout(session);  
    pkcs11.C_CloseSession(session);  
}  
catch(e){  
    console.error(e);  
}  
finally {  
    pkcs11.C_Finalize();  
}
```

--------------------------------

### C_Initialize

Source: https://peculiarventures.github.io/pkcs11js

Initializes the Cryptoki library with optional NSS parameters.

```APIDOC
## C_Initialize

### Description
Initializes the Cryptoki library. Supports standard CK_C_INITIALIZE_ARGS and extended NSS library parameters.

### Method
POST

### Endpoint
C_Initialize(options)

### Parameters
#### Request Body
- **options** (InitializationOptions) - Optional - Configuration object containing libraryParameters (string) or flags (number).
```

--------------------------------

### Interface InitializationOptions

Source: https://peculiarventures.github.io/pkcs11js/interfaces/InitializationOptions.html

Defines the configuration options for the PKCS11 initialization process.

```APIDOC
## InitializationOptions

### Description
Interface representing the configuration options for PKCS11 initialization.

### Properties
- **flags** (number) - Optional - Bit flags specifying options for PKCS11.C_Initialize. Supported flags include CKF_LIBRARY_CANT_CREATE_OS_THREADS and CKF_OS_LOCKING_OK.
- **libraryParameters** (string) - Optional - NSS library parameters.
```

--------------------------------

### Manage PKCS#11 Objects

Source: https://peculiarventures.github.io/pkcs11js

Demonstrates creating, updating, retrieving, copying, and destroying objects within a PKCS#11 session.

```javascript
var nObject = pkcs11.C_CreateObject(session, [  
    { type: pkcs11js.CKA_CLASS, value: pkcs11js.CKO_DATA },  
    { type: pkcs11js.CKA_TOKEN, value: false },  
    { type: pkcs11js.CKA_PRIVATE, value: false },  
    { type: pkcs11js.CKA_LABEL, value: "My custom data" },  
]);  
  
// Updating label of Object  
pkcs11.C_SetAttributeValue(session, nObject, [{ type: pkcs11js.CKA_LABEL, value: "My custom data!!!" }]);  
  
// Getting attribute value  
var label = pkcs11.C_GetAttributeValue(session, nObject, [  
    { type: pkcs11js.CKA_LABEL },  
    { type: pkcs11js.CKA_TOKEN }  
]);  
console.log(label[0].value.toString()); // My custom data!!!  
console.log(!!label[1].value[0]); // false  
  
// Copying Object  
var cObject = pkcs11.C_CopyObject(session, nObject, [  
    { type: pkcs11js.CKA_CLASS},  
    { type: pkcs11js.CKA_TOKEN},  
    { type: pkcs11js.CKA_PRIVATE},  
    { type: pkcs11js.CKA_LABEL},  
]);  
  
// Removing Object  
pkcs11.C_DestroyObject(session, cObject);
```

--------------------------------

### C_SignInit API

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a signature operation using a private key.

```APIDOC
## C_SignInit

### Description
Initializes a signature (private key encryption) operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.

### Method
`C_SignInit`

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "session": "Buffer",
  "mechanism": "Mechanism",
  "key": "Buffer"
}
```

### Response
#### Success Response (200)
- **void**

#### Response Example
```json
{
  "status": "success"
}
```

### Throws
- **NativeError** if native error occurs
- **Pkcs11Error** if Cryptoki error occurs
```

--------------------------------

### C_InitPIN

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes the normal user's PIN.

```APIDOC
## C_InitPIN

### Description
Initializes the normal user's PIN.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **session** (Buffer) - Required - The session's handle
- **pin** (string) - Optional - The normal user's PIN

### Request Example
```javascript
// Example usage:
// pkcs11.C_InitPIN(sessionHandle, "123456");
```

### Response
#### Success Response (200)
- **void**

#### Response Example
```json
null
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### PKCS11 Methods - Token Management

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Methods for initializing PINs, logging in/out, and managing tokens.

```APIDOC
## C_InitPIN

### Description
Initializes the PIN of a token.

### Method
C_InitPIN

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **pin** (Buffer) - Required - The new PIN

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_InitToken

### Description
Initializes a token.

### Method
C_InitToken

### Endpoint
N/A (Method Call)

### Parameters
- **slot** (Buffer) - Required - The slot handle
- **pin** (Buffer) - Required - The new PIN
- **label** (Buffer) - Required - The token label

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_Login

### Description
Logs a user into a token.

### Method
C_Login

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **userType** (number) - Required - The user type
- **pin** (Buffer) - Required - The user's PIN

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_Logout

### Description
Logs a user out of a token.

### Method
C_Logout

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### Initialize NSS Crypto Library

Source: https://peculiarventures.github.io/pkcs11js

Initializes the PKCS#11 library with specific NSS options. The `libraryParameters` string allows for detailed configuration of the NSS environment.

```javascript
const mod = new pkcs11.PKCS11();
mod.load("/usr/local/opt/nss/lib/libsoftokn3.dylib");

mod.C_Initialize({
    libraryParameters: "configdir='' certPrefix='' keyPrefix='' secmod='' flags=readOnly,noCertDB,noModDB,forceOpen,optimizeSpace",
});

// Your code here

mod.C_Finalize();
```

--------------------------------

### C_InitToken

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a token.

```APIDOC
## C_InitToken

### Description
Initializes a token.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **slot** (Buffer) - Required - ID of the token's slot
- **pin** (string) - Optional - The SO's initial PIN
- **label** (string) - Optional - Token label

### Request Example
```javascript
// Example usage:
// pkcs11.C_InitToken(slotHandle, "soPIN", "MyNewToken");
```

### Response
#### Success Response (200)
- **string** - 32-byte token label (blank padded)

#### Response Example
```json
"MyNewToken                  "
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### load

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Loads the dynamic library with the PKCS#11 interface from a specified path.

```APIDOC
## load

### Description
Loads dynamic library with PKCS#11 interface.

### Method
load

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
- **path** (string) - Required - The path to PKCS#11 library

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- None

#### Response Example
```json
{
  "example": "response body"
}
```

#### Throws
- NativeError if native error occurs
- Pkcs11Error if Cryptoki error occurs
```

--------------------------------

### Sign and Verify Data

Source: https://peculiarventures.github.io/pkcs11js

Demonstrates multi-part signing and verification using RSA PKCS mechanisms.

```javascript
pkcs11.C_SignInit(session, { mechanism: pkcs11js.CKM_SHA256_RSA_PKCS }, keys.privateKey);  
  
pkcs11.C_SignUpdate(session, new Buffer("Incoming message 1"));  
pkcs11.C_SignUpdate(session, new Buffer("Incoming message N"));  
  
var signature = pkcs11.C_SignFinal(session, Buffer(256));
```

```javascript
pkcs11.C_VerifyInit(session, { mechanism: pkcs11js.CKM_SHA256_RSA_PKCS }, keys.publicKey);  
  
pkcs11.C_VerifyUpdate(session, new Buffer("Incoming message 1"));  
pkcs11.C_VerifyUpdate(session, new Buffer("Incoming message N"));  
  
var verify = pkcs11.C_VerifyFinal(session, signature);
```

--------------------------------

### PKCS11 Class Constructor

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a new instance of the PKCS11 class, optionally specifying the path to the PKCS#11 library.

```APIDOC
## PKCS11 constructor

### Description
Creates an instance of PKCS11.

### Method
constructor

### Parameters
- **libPath** (string) - Optional - The path to PKCS#11 library

### Returns
- **PKCS11** - An instance of the PKCS11 class.
```

--------------------------------

### PKCS11 Methods - Initialization and Finalization

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Methods for initializing and finalizing the PKCS#11 module.

```APIDOC
## C_Initialize

### Description
Initializes the PKCS#11 module.

### Method
C_Initialize

### Endpoint
N/A (Method Call)

### Parameters
- **options** (object) - Optional - Initialization options

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_Finalize

### Description
Finalizes the PKCS#11 module.

### Method
C_Finalize

### Endpoint
N/A (Method Call)

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### Constructor Pkcs11Error

Source: https://peculiarventures.github.io/pkcs11js/classes/Pkcs11Error.html

Initializes a new instance of the Pkcs11Error class to represent a PKCS#11 error.

```APIDOC
## Constructor Pkcs11Error

### Description
Initializes a new instance of Pkcs11Error.

### Parameters
- **message** (string) - Optional - Error message
- **code** (number) - Optional - PKCS#11 result value
- **method** (string) - Optional - The name of PKCS#11 method

### Returns
- **Pkcs11Error** - A new instance of the error class.
```

--------------------------------

### C_GetSlotList

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Obtains a list of slots in the system.

```APIDOC
## C_GetSlotList

### Description
Obtains a list of slots in the system.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **tokenPresent** (boolean) - Optional - Only slots with tokens?

### Request Example
```javascript
// Example usage:
// const slotList = pkcs11.C_GetSlotList(true); // Get slots with tokens
// const allSlotList = pkcs11.C_GetSlotList(); // Get all slots
```

### Response
#### Success Response (200)
- **Buffer[]** (Array) - Array of slot IDs

#### Response Example
```json
[
  "<slot_handle_buffer_1>",
  "<slot_handle_buffer_2>"
]
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### C_DigestInit

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a message-digesting operation.

```APIDOC
## C_DigestInit

### Description
Initializes a message-digesting operation.

### Parameters
#### Path Parameters
- **session** (Buffer) - Required - The session's handle
- **mechanism** (Mechanism) - Required - Digesting mechanism

### Response
#### Success Response (200)
- **void** - Returns void

### Errors
- **NativeError** - If native error occurs
- **Pkcs11Error** - If Cryptoki error occurs
```

--------------------------------

### C_GetInfo

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Obtains general information about the Cryptoki module.

```APIDOC
## C_GetInfo

### Description
Obtains general information about the Cryptoki module.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
None

### Request Example
```javascript
// Example usage:
// const moduleInfo = pkcs11.C_GetInfo();
```

### Response
#### Success Response (200)
- **ModuleInfo** (Object) - Information about Cryptoki

#### Response Example
```json
{
  "cryptokiVersion": {
    "major": 2,
    "minor": 20
  },
  "manufacturerID": "Some Manufacturer",
  "flags": 0,
  "libraryDescription": "PKCS#11 Library",
  "libraryVersion": {
    "major": 1,
    "minor": 0
  }
}
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### C_Login

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Logs a user into a token.

```APIDOC
## C_Login

### Description
Logs a user into a token.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **session** (Buffer) - Required - The session's handle
- **userType** (number) - Required - The user type (e.g., 0 for CKU_USER, 1 for CKU_SO)
- **pin** (string) - Optional - The user's PIN

### Request Example
```javascript
// Example usage:
// pkcs11.C_Login(sessionHandle, 0, "userPIN"); // Login as normal user
// pkcs11.C_Login(sessionHandle, 1); // Login as Security Officer (if no PIN required)
```

### Response
#### Success Response (200)
- **void**

#### Response Example
```json
null
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### CKA_OTP_USER_FRIENDLY_MODE Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKA_OTP_USER_FRIENDLY_MODE.html

Documentation for the CKA_OTP_USER_FRIENDLY_MODE constant.

```APIDOC
## CKA_OTP_USER_FRIENDLY_MODE

### Description
A constant representing the CKA_OTP_USER_FRIENDLY_MODE attribute in the pkcs11js library.

### Type
number
```

--------------------------------

### C_SignRecoverInit API

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a signature operation where data can be recovered from the signature.

```APIDOC
## C_SignRecoverInit

### Description
Initializes a signature operation, where the data can be recovered from the signature.

### Method
`C_SignRecoverInit`

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "session": "Buffer",
  "mechanism": "Mechanism",
  "key": "Buffer"
}
```

### Response
#### Success Response (200)
- **void**

#### Response Example
```json
{
  "status": "success"
}
```

### Throws
- **NativeError** if native error occurs
- **Pkcs11Error** if Cryptoki error occurs
```

--------------------------------

### C_FindObjectsInit

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a search for token and session objects that match a template.

```APIDOC
## C_FindObjectsInit

### Description
Initializes a search for token and session objects that match a template.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **void**

#### Response Example
N/A

### Error Handling
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### C_OpenSession

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Opens a session between an application and a token.

```APIDOC
## C_OpenSession

### Description
Opens a session between an application and a token.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **slot** (Buffer) - Required - The slot's ID
- **flags** (number) - Required - From CK_SESSION_INFO (e.g., CKF_SERIAL_SESSION)

### Request Example
```javascript
// Example usage:
// const sessionHandle = pkcs11.C_OpenSession(slotHandle, 1); // CKF_SERIAL_SESSION = 1
```

### Response
#### Success Response (200)
- **Buffer** - The session's handle

#### Response Example
```json
"<session_handle_buffer>"
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### RsaOAEP Interface

Source: https://peculiarventures.github.io/pkcs11js/interfaces/RsaOAEP.html

Detailed documentation for the RsaOAEP interface, including its properties and inheritance.

```APIDOC
## Interface RsaOAEP

A base structure of a parameter

### Properties
- **hashAlg** (number) - The hash algorithm used.
- **mgf** (number) - The mask generation function.
- **source** (number) - The source of the data.
- **sourceData** (Buffer) - Optional. The data buffer.
- **type** (number) - Type of crypto param. Uses constants CK_PARAMS_*.

### Hierarchy
- IParams
  - RsaOAEP
```

--------------------------------

### CKR_CRYPTOKI_NOT_INITIALIZED Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKR_CRYPTOKI_NOT_INITIALIZED.html

Documentation for the CKR_CRYPTOKI_NOT_INITIALIZED constant.

```APIDOC
## CKR_CRYPTOKI_NOT_INITIALIZED

### Description
Represents the PKCS#11 error code indicating that the Cryptoki library has not been initialized.

### Type
number
```

--------------------------------

### C_DecryptInit

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Initializes a decryption operation.

```APIDOC
## C_DecryptInit

### Description
Initializes a decryption operation.

### Parameters
#### Path Parameters
- **session** (Buffer) - Required - The session's handle
- **mechanism** (Mechanism) - Required - The decryption mechanism
- **key** (Buffer) - Required - Handle of decryption key

### Response
#### Success Response (void)
- Returns void
```

--------------------------------

### CKR_NEXT_OTP Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKR_NEXT_OTP.html

Documentation for the CKR_NEXT_OTP constant.

```APIDOC
## CKR_NEXT_OTP

### Description
A constant representing the CKR_NEXT_OTP value in the pkcs11js library.

### Type
number
```

--------------------------------

### C_GenerateKeyPairAsync

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Generates a public-key/private-key pair asynchronously, creating new key objects.

```APIDOC
## C_GenerateKeyPairAsync

### Description
Generates a public-key/private-key pair asynchronously, creating new key objects.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Promise<KeyPair>** - Handles for private and public keys

#### Response Example
N/A

### Error Handling
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### pkcs11js - Core Components

Source: https://peculiarventures.github.io/pkcs11js/modules.html

Overview of the main classes, interfaces, and type aliases available in the pkcs11js library.

```APIDOC
## pkcs11js API Overview

### Classes
- `NativeError`
- `PKCS11`
- `Pkcs11Error`

### Interfaces
- `AesCBC`
- `AesCCM`
- `AesGCM`
- `Attribute`
- `AttributeResult`
- `CcmParams`
- `DesCbcEncryptDataParams`
- `ECDH1`
- `Ecdh2Derive`
- `EcmqvDerive`
- `GcmParams`
- `GostR3410DeriveParams`
- `GostR3410KeyWrapParams`
- `IParams`
- `InitializationOptions`
- `KeyPair`
- `KeyWrapSetOaepParams`
- `Mechanism`
- `MechanismInfo`
- `ModuleInfo`
- `PbeParams`
- `RC2CBCParams`
- `RC2MACGeneralParams`
- `RC5CBCParams`
- `RC5MACGeneralParams`
- `RC5Params`
- `RsaOAEP`
- `RsaPSS`
- `SessionInfo`
- `SkipjackPrivateWrapParams`
- `SkipjackRelayXParams`
- `SlotInfo`
- `TokenInfo`
- `Version`
- `X942DH1Derive`
- `X942DH2Derive`
- `X942MQvDeriveParams`

### Type Aliases
- `Handle`
- `Template`
- `TemplateResult`
```

--------------------------------

### CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE.html

Definition of the CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE constant.

```APIDOC
## CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE

### Description
A constant representing the CKM_WTLS_SERVER_KEY_AND_MAC_DERIVE mechanism identifier.

### Type
number
```

--------------------------------

### C_WrapKey

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Wraps (i.e., encrypts) a key.

```APIDOC
## C_WrapKey

### Description
Wraps (i.e., encrypts) a key.

### Parameters
#### Path Parameters
- **session** (Buffer) - Required - The session's handle
- **mechanism** (Mechanism) - Required - Wrapping mechanism
- **wrappingKey** (Buffer) - Required - Wrapping key
- **key** (Buffer) - Required - Key to be wrapped
- **wrappedKey** (Buffer) - Required - Init buffer for wrapped key

### Response
#### Success Response (200)
- **wrappedKey** (Buffer) - Sliced wrapped key
```

--------------------------------

### C_WrapKeyAsync

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Asynchronously wraps (encrypts) a key.

```APIDOC
## C_WrapKeyAsync

### Description
Wraps (i.e., encrypts) a key asynchronously.

### Method
C_WrapKeyAsync

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
- **session** (Buffer) - Required - The session's handle
- **mechanism** (Mechanism) - Required - Wrapping mechanism
- **wrappingKey** (Buffer) - Required - Wrapping key
- **key** (Buffer) - Required - Key to be wrapped
- **wrappedKey** (Buffer) - Required - Init buffer for wrapped key

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **wrappedKey** (Buffer) - Sliced wrapped key

#### Response Example
```json
{
  "example": "response body"
}
```

#### Throws
- NativeError if native error occurs
- Pkcs11Error if Cryptoki error occurs
```

--------------------------------

### CKR_CRYPTOKI_ALREADY_INITIALIZED Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKR_CRYPTOKI_ALREADY_INITIALIZED.html

Documentation for the CKR_CRYPTOKI_ALREADY_INITIALIZED constant used in pkcs11js.

```APIDOC
## CKR_CRYPTOKI_ALREADY_INITIALIZED

### Description
Represents the PKCS#11 error code indicating that the Cryptoki library has already been initialized.

### Type
number
```

--------------------------------

### C_Finalize

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Indicates that an application is done with the Cryptoki library.

```APIDOC
## C_Finalize

### Description
Indicates that an application is done with the Cryptoki library.

### Response
#### Success Response (200)
- **void** - Returns void

### Errors
- **NativeError** - If native error occurs
- **Pkcs11Error** - If Cryptoki error occurs
```

--------------------------------

### CKF_TOKEN_INITIALIZED Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKF_TOKEN_INITIALIZED.html

Documentation for the CKF_TOKEN_INITIALIZED constant used in pkcs11js.

```APIDOC
## CKF_TOKEN_INITIALIZED

### Description
A constant representing the token initialization flag in the PKCS#11 interface.

### Type
number
```

--------------------------------

### CKM_PBE_SHA1_RC2_40_CBC Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKM_PBE_SHA1_RC2_40_CBC.html

Documentation for the CKM_PBE_SHA1_RC2_40_CBC constant definition.

```APIDOC
## CKM_PBE_SHA1_RC2_40_CBC

### Description
Represents the PKCS#11 mechanism constant for PBE with SHA-1 and RC2-40 CBC.

### Type
Number
```

--------------------------------

### PKCS11 Methods - Token and Slot Information

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Methods for retrieving information about slots and tokens.

```APIDOC
## C_GetInfo

### Description
Gets general information about the Cryptoki module.

### Method
C_GetInfo

### Endpoint
N/A (Method Call)

### Returns
- **Info** - General information about the module

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_GetSlotList

### Description
Gets a list of available slots.

### Method
C_GetSlotList

### Endpoint
N/A (Method Call)

### Parameters
- **tokenPresent** (boolean) - Optional - If true, returns only slots with tokens

### Returns
- **Array<Buffer>** - An array of slot handles

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_GetSlotInfo

### Description
Gets information about a specific slot.

### Method
C_GetSlotInfo

### Endpoint
N/A (Method Call)

### Parameters
- **slot** (Buffer) - Required - The slot handle

### Returns
- **SlotInfo** - Information about the slot

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_GetTokenInfo

### Description
Gets information about a token in a specific slot.

### Method
C_GetTokenInfo

### Endpoint
N/A (Method Call)

### Parameters
- **slot** (Buffer) - Required - The slot handle

### Returns
- **TokenInfo** - Information about the token

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### CK_PARAM_GOSTR3410_KEY_WRAP Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CK_PARAM_GOSTR3410_KEY_WRAP.html

Documentation for the CK_PARAM_GOSTR3410_KEY_WRAP constant used in PKCS#11 operations.

```APIDOC
## CK_PARAM_GOSTR3410_KEY_WRAP

### Description
A constant representing the parameter type for GOST R 34.10 key wrapping in PKCS#11.

### Type
number
```

--------------------------------

### Constructor: new NativeError()

Source: https://peculiarventures.github.io/pkcs11js/classes/NativeError.html

Initializes a new instance of the NativeError class.

```APIDOC
## Constructor: new NativeError()

### Description
Initializes a new instance of the NativeError class.

### Parameters
- **message** (string) - Optional - Error message
- **method** (string) - Optional - Native function name

### Returns
- **NativeError** - A new instance of NativeError
```

--------------------------------

### CKM_JUNIPER_COUNTER Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKM_JUNIPER_COUNTER.html

Documentation for the CKM_JUNIPER_COUNTER constant.

```APIDOC
## CKM_JUNIPER_COUNTER

### Description
A constant representing the CKM_JUNIPER_COUNTER value in the pkcs11js library.

### Type
number
```

--------------------------------

### PKCS11 Methods - Object Management

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Details methods for managing cryptographic objects on a token.

```APIDOC
## C_CopyObject

### Description
Copies an object, creating a new object for the copy.

### Method
C_CopyObject

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **object** (Buffer) - Required - The object's handle
- **template** (Template) - Required - Template for new object

### Returns
- **Buffer** - A handle of copy

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_CreateObject

### Description
Creates a new object.

### Method
C_CreateObject

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **template** (Template) - Required - The object's template

### Returns
- **Buffer** - A new object's handle

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_DestroyObject

### Description
Destroys an object.

### Method
C_DestroyObject

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **object** (Buffer) - Required - The object's handle

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_GetObjectSize

### Description
Gets the size of an object.

### Method
C_GetObjectSize

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **object** (Buffer) - Required - The object's handle

### Returns
- **number** - The size of the object

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_GetAttributeValue

### Description
Gets the value of attributes of an object.

### Method
C_GetAttributeValue

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **object** (Buffer) - Required - The object's handle
- **template** (Template) - Required - The template of attributes to get

### Returns
- **Template** - The template with attribute values

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_SetAttributeValue

### Description
Sets the value of attributes of an object.

### Method
C_SetAttributeValue

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle
- **object** (Buffer) - Required - The object's handle
- **template** (Template) - Required - The template of attributes to set

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### PKCS11 Methods - Session Management

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Provides documentation for methods related to managing sessions with cryptographic tokens.

```APIDOC
## C_CloseAllSessions

### Description
Closes all sessions with a token.

### Method
C_CloseAllSessions

### Endpoint
N/A (Method Call)

### Parameters
- **slot** (Buffer) - Required - The token's slot

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_CloseSession

### Description
Closes a session between an application and a token.

### Method
C_CloseSession

### Endpoint
N/A (Method Call)

### Parameters
- **session** (Buffer) - Required - The session's handle

### Returns
- **void**

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs

## C_OpenSession

### Description
Opens a session between an application and a token.

### Method
C_OpenSession

### Endpoint
N/A (Method Call)

### Parameters
- **slot** (Buffer) - Required - The token's slot
- **flags** (number) - Required - Session flags
- **application** (any) - Optional - Application defined callback
- **notify** (any) - Optional - Callback for asynchronous notification

### Returns
- **Buffer** - A handle of the session

### Throws
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### CKF_PROTECTED_AUTHENTICATION_PATH Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKF_PROTECTED_AUTHENTICATION_PATH.html

Documentation for the CKF_PROTECTED_AUTHENTICATION_PATH constant.

```APIDOC
## CKF_PROTECTED_AUTHENTICATION_PATH

### Description
A constant representing the CKF_PROTECTED_AUTHENTICATION_PATH flag in the pkcs11js library.

### Type
number
```

--------------------------------

### CKM_MD5_KEY_DERIVATION Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKM_MD5_KEY_DERIVATION.html

Information about the CKM_MD5_KEY_DERIVATION constant.

```APIDOC
## Variable CKM_MD5_KEY_DERIVATION

### Description
Represents the MD5 key derivation mechanism.

### Type
`number`

### Value
This is a constant value representing a specific mechanism. The exact numerical value is implementation-dependent but is used to identify this particular key derivation function.
```

--------------------------------

### CKF_VERIFY Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKF_VERIFY.html

Documentation for the CKF_VERIFY constant used in pkcs11js.

```APIDOC
## CKF_VERIFY

### Description
Represents the CKF_VERIFY constant used in PKCS#11 operations.

### Type
number
```

--------------------------------

### C_GetSlotInfo

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Obtains information about a particular slot in the system.

```APIDOC
## C_GetSlotInfo

### Description
Obtains information about a particular slot in the system.

### Method
Not specified (likely a function call in JS)

### Endpoint
Not applicable (this is a library function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **slot** (Buffer) - Required - The ID of the slot

### Request Example
```javascript
// Example usage:
// const slotInfo = pkcs11.C_GetSlotInfo(slotHandle);
```

### Response
#### Success Response (200)
- **SlotInfo** (Object) - Information about a slot

#### Response Example
```json
{
  "slotDescription": "PKCS#11 Slot 0",
  "manufacturerID": "Some Manufacturer",
  "flags": 1,
  "ulHardwareVersion": {
    "major": 1,
    "minor": 0
  },
  "ulFirmwareVersion": {
    "major": 1,
    "minor": 0
  }
}
```

#### Error Handling
- **NativeError**: If a native error occurs.
- **Pkcs11Error**: If a Cryptoki error occurs.
```

--------------------------------

### CKF_SO_PIN_FINAL_TRY Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKF_SO_PIN_FINAL_TRY.html

Documentation for the CKF_SO_PIN_FINAL_TRY constant used in PKCS#11 operations.

```APIDOC
## CKF_SO_PIN_FINAL_TRY

### Description
A constant representing the PKCS#11 flag indicating that the Security Officer (SO) PIN is on its final attempt.

### Type
number
```

--------------------------------

### C_SignUpdate API

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Continues a multiple-part signature operation.

```APIDOC
## C_SignUpdate

### Description
Continues a multiple-part signature operation, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature.

### Method
`C_SignUpdate`

### Endpoint
N/A (Function Call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "session": "Buffer",
  "inData": "Buffer"
}
```

### Response
#### Success Response (200)
- **void**

#### Response Example
```json
{
  "status": "success"
}
```

### Throws
- **NativeError** if native error occurs
- **Pkcs11Error** if Cryptoki error occurs
```

--------------------------------

### CKM_JUNIPER_SHUFFLE Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKM_JUNIPER_SHUFFLE.html

Information about the CKM_JUNIPER_SHUFFLE constant.

```APIDOC
## Variable CKM_JUNIPER_SHUFFLE

### Description
Represents a cryptographic mechanism related to Juniper shuffling.

### Type
`number`

### Value
This is a constant value representing a specific mechanism.
```

--------------------------------

### ModuleInfo Interface

Source: https://peculiarventures.github.io/pkcs11js/interfaces/ModuleInfo.html

The ModuleInfo interface provides general information about the Cryptoki library.

```APIDOC
## Interface ModuleInfo

Provides general information about Cryptoki

### Properties
- **cryptokiVersion** (Version) - Cryptoki interface version number, for compatibility with future revisions of this interface.
- **flags** (number) - Bit flags reserved for future versions. Must be zero for this version.
- **libraryDescription** (string) - Character-string description of the library. Must be padded with the blank character (' ').
- **libraryVersion** (Version) - Cryptoki library version number.
- **manufacturerID** (string) - ID of the Cryptoki library manufacturer. Must be padded with the blank character (' ').

### Example Response Body
```json
{
  "cryptokiVersion": {
    "major": 2,
    "minor": 20
  },
  "flags": 0,
  "libraryDescription": "My PKCS#11 Library   ",
  "libraryVersion": {
    "major": 1,
    "minor": 0
  },
  "manufacturerID": "VENDOR       "
}
```
```

--------------------------------

### CKR_USER_ALREADY_LOGGED_IN Constant

Source: https://peculiarventures.github.io/pkcs11js/variables/CKR_USER_ALREADY_LOGGED_IN.html

Documentation for the CKR_USER_ALREADY_LOGGED_IN error constant.

```APIDOC
## CKR_USER_ALREADY_LOGGED_IN

### Description
Represents the PKCS#11 error code indicating that the user is already logged into the session.

### Type
number
```

--------------------------------

### C_GenerateKeyPair

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Generates a public-key/private-key pair, creating new key objects.

```APIDOC
## C_GenerateKeyPair

### Description
Generates a public-key/private-key pair, creating new key objects.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **KeyPair** - The pair of handles for private and public keys

#### Response Example
N/A

### Error Handling
- **NativeError** - if native error occurs
- **Pkcs11Error** - if Cryptoki error occurs
```

--------------------------------

### C_WrapKey

Source: https://peculiarventures.github.io/pkcs11js/classes/PKCS11.html

Wraps (encrypts) a key using a specified session, mechanism, and wrapping key.

```APIDOC
## C_WrapKey

### Description
Wraps (i.e., encrypts) a key.

### Method
C_WrapKey

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
- **session** (Buffer) - Required - The session's handle
- **mechanism** (Mechanism) - Required - Wrapping mechanism
- **wrappingKey** (Buffer) - Required - Wrapping key
- **key** (Buffer) - Required - Key to be wrapped
- **wrappedKey** (Buffer) - Required - Init buffer for wrapped key
- **cb** ((error: Error, wrappedKey: Buffer) => void) - Required - Async callback with sliced wrapped key
  - **error** (Error) - Required - 
  - **wrappedKey** (Buffer) - Required - 

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **wrappedKey** (Buffer) - Sliced wrapped key

#### Response Example
```json
{
  "example": "response body"
}
```

#### Throws
- NativeError if native error occurs
- Pkcs11Error if Cryptoki error occurs
```
Tokens:
Raw