From 3fe89e398e6eb5600cdb0bf19f4b48dccaff0f5d Mon Sep 17 00:00:00 2001 From: microshine Date: Thu, 13 Jun 2024 13:12:02 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20Peculiar?= =?UTF-8?q?Ventures/pkcs11js@c578fc77c92568bb3c1ba2d7fc6192b6627c2d81=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/NativeError.html | 6 +- classes/PKCS11.html | 212 +++++++++++----------- classes/Pkcs11Error.html | 8 +- interfaces/AesCBC.html | 2 +- interfaces/AesCCM.html | 2 +- interfaces/AesGCM.html | 2 +- interfaces/Attribute.html | 4 +- interfaces/AttributeResult.html | 2 +- interfaces/CcmParams.html | 2 +- interfaces/DesCbcEncryptDataParams.html | 2 +- interfaces/ECDH1.html | 8 +- interfaces/Ecdh2Derive.html | 2 +- interfaces/EcmqvDerive.html | 2 +- interfaces/GcmParams.html | 2 +- interfaces/GostR3410DeriveParams.html | 4 +- interfaces/GostR3410KeyWrapParams.html | 4 +- interfaces/IParams.html | 2 +- interfaces/InitializationOptions.html | 4 +- interfaces/KeyPair.html | 2 +- interfaces/KeyWrapSetOaepParams.html | 4 +- interfaces/Mechanism.html | 4 +- interfaces/MechanismInfo.html | 6 +- interfaces/ModuleInfo.html | 10 +- interfaces/PbeParams.html | 2 +- interfaces/RC2CBCParams.html | 2 +- interfaces/RC2MACGeneralParams.html | 2 +- interfaces/RC5CBCParams.html | 4 +- interfaces/RC5MACGeneralParams.html | 4 +- interfaces/RC5Params.html | 4 +- interfaces/RsaOAEP.html | 2 +- interfaces/RsaPSS.html | 2 +- interfaces/SessionInfo.html | 8 +- interfaces/SkipjackPrivateWrapParams.html | 2 +- interfaces/SkipjackRelayXParams.html | 2 +- interfaces/SlotInfo.html | 10 +- interfaces/TokenInfo.html | 36 ++-- interfaces/Version.html | 4 +- interfaces/X942DH1Derive.html | 2 +- interfaces/X942DH2Derive.html | 2 +- interfaces/X942MQvDeriveParams.html | 2 +- modules.html | 4 +- 41 files changed, 195 insertions(+), 195 deletions(-) diff --git a/classes/NativeError.html b/classes/NativeError.html index 2ad6441..8fa5958 100644 --- a/classes/NativeError.html +++ b/classes/NativeError.html @@ -1,12 +1,12 @@ NativeError | pkcs11js
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NativeError

Exception from native module

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new NativeError(message?: string, method?: string): NativeError

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new NativeError(message?: string, method?: string): NativeError

  • Initialize new instance of NativeError

    Parameters

    • Optional message: string

      Error message

      -
    • Optional method: string

    Returns NativeError

Properties

message

message: string

Readonly method

method: string
+
  • Optional method: string

    • Returns NativeError

    Properties

    message

    message: string

    Readonly method

    method: string

    Native function name. Default is empty string

    -

    name

    name: string

    Readonly nativeStack

    nativeStack: string
    +

    name

    name: string

    Readonly nativeStack

    nativeStack: string

    Native library call stack. Default is empty string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration

    Properties

    libPath

    libPath: string

    Library path

    -

    Methods

    C_CloseAllSessions

    • C_CloseAllSessions(slot: Buffer): void

    Methods

    C_CloseAllSessions

    • C_CloseAllSessions(slot: Buffer): void

    • Closes all sessions with a token

      throws

      NativeError if native error occurs

      throws

      Pkcs11Error if Cryptoki error occurs

      Parameters

      • slot: Buffer

        The token's slot

        -

      Returns void

    C_CloseSession

    • C_CloseSession(session: Buffer): void

    Returns void

    C_CloseSession

    • C_CloseSession(session: Buffer): void

    • Closes a session between an application and a token

      throws

      NativeError if native error occurs

      throws

      Pkcs11Error if Cryptoki error occurs

      Parameters

      • session: Buffer

        The session's handle

        -

      Returns void

    C_CopyObject

    • C_CopyObject(session: Buffer, object: Buffer, template: Template): Buffer

    Returns void

    C_CopyObject

    • C_CopyObject(session: Buffer, object: Buffer, template: Template): Buffer

    • Copies an object, creating a new object for the copy

      throws

      NativeError if native error occurs

      throws

      Pkcs11Error if Cryptoki error occurs

      @@ -29,7 +29,7 @@
  • template: Template

    Template for new object

    • Returns Buffer

    A handle of copy

    -

    C_CreateObject

    • C_CreateObject(session: Buffer, template: Template): Buffer

    C_CreateObject

    • C_CreateObject(session: Buffer, template: Template): Buffer
  • template: Template

    The object's template

    • Returns Buffer

    A new object's handle

    -

    C_Decrypt

    • C_Decrypt(session: Buffer, inData: Buffer, outData: Buffer): Buffer
    • C_Decrypt(session: Buffer, inData: Buffer, outData: Buffer, cb: (error: Error, data: Buffer) => void): void

    C_Decrypt

    • C_Decrypt(session: Buffer, inData: Buffer, outData: Buffer): Buffer
    • C_Decrypt(session: Buffer, inData: Buffer, outData: Buffer, cb: (error: Error, data: Buffer) => void): void
  • outData: Buffer

    Output data

    • Returns Buffer

    Sliced output data with decrypted message

    -
  • +

  • Decrypts encrypted data in a single part

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -61,7 +61,7 @@

    Output data

  • cb: (error: Error, data: Buffer) => void

    Async callback with sliced output data

    -

    • Returns void

    C_DecryptAsync

    Returns void

    C_DecryptAsync

    Returns Promise<Buffer>

    Sliced output data with decrypted message

    -

    C_DecryptDigestUpdate

    C_DecryptDigestUpdate

    C_DecryptDigestUpdateAsync

    Returns void

    C_DecryptDigestUpdateAsync

    C_DecryptFinal

    C_DecryptFinal

    Returns Buffer

    Sliced output data with decrypted final block

    -
  • +

  • Finishes a multiple-part decryption operation

    Parameters

    • session: Buffer

      The session's handle

      @@ -120,14 +120,14 @@

      Last part of output data

    • cb: (error: Error, data: Buffer) => void

      Async callback with sliced output data with decrypted final block

      -
        • (error: Error, data: Buffer): void

        • Parameters

          • error: Error
          • data: Buffer

          Returns void

    Returns void

    • C_DecryptFinalAsync

    Returns void

    C_DecryptFinalAsync

    C_DecryptInit

    C_DecryptInit

    Returns void

    C_DecryptUpdate

    Returns void

    C_DecryptUpdate

    Returns Buffer

    Sliced output data with decrypted block

    -

    C_DecryptVerifyUpdate

    C_DecryptVerifyUpdate

    C_DecryptVerifyUpdateAsync

    Returns void

    C_DecryptVerifyUpdateAsync

    C_DeriveKey

    C_DeriveKey

    Returns Buffer

    The derived key handle

    -
  • +

  • Derives a key from a base key, creating a new key object

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -206,7 +206,7 @@

    The template for the new key

  • cb: (error: Error, hKey: Buffer) => void

    Async callback with the derived key handle

    -
      • (error: Error, hKey: Buffer): void

      • Parameters

        • error: Error
        • hKey: Buffer

        Returns void

    • Returns void

    C_DeriveKeyAsync

    Returns void

    C_DeriveKeyAsync

    Returns Promise<Buffer>

    The derived key handle

    -

    C_DestroyObject

    C_DestroyObject

    Returns void

    C_Digest

    Returns void

    C_Digest

    Returns Buffer

    Sliced output data

    -
  • +

  • Digests data in a single part

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -250,7 +250,7 @@

    Output data

  • cb: (error: Error, data: Buffer) => void

    Async callback with sliced output data

    -
      • (error: Error, data: Buffer): void

      • Parameters

        • error: Error
        • data: Buffer

        Returns void

    • Returns void

    C_DigestAsync

    Returns void

    C_DigestAsync

    Returns Promise<Buffer>

    Sliced output data

    -

    C_DigestEncryptUpdate

    C_DigestEncryptUpdate

    Returns Buffer

    Sliced encrypted data

    -
  • +

  • Continues a multiple-part digest and encryption operation (digesting and encrypting)

    Parameters

    • session: Buffer
      @@ -284,7 +284,7 @@

      Encrypted data

    • cb: (error: Error, data: Buffer) => void

      Async callback with sliced encrypted data

      -
        • (error: Error, data: Buffer): void

        • Parameters

          • error: Error
          • data: Buffer

          Returns void

    Returns void

    • C_DigestEncryptUpdateAsync

    Returns void

    C_DigestEncryptUpdateAsync

    C_DigestFinal

    C_DigestFinal

    Returns Buffer

    Sliced output data

    -
  • +

  • Finishes a multiple-part message-digesting operation

    Parameters

    • session: Buffer

      The session's handle

      @@ -311,14 +311,14 @@

      Output data

    • cb: (error: Error, data: Buffer) => void

      Async callback with sliced output data

      -
        • (error: Error, data: Buffer): void

        • Parameters

          • error: Error
          • data: Buffer

          Returns void

    Returns void

    • C_DigestFinalAsync

    Returns void

    C_DigestFinalAsync

    C_DigestInit

    C_DigestInit

    Returns void

    C_DigestKey

    Returns void

    C_DigestKey

    Returns void

    C_DigestUpdate

    Returns void

    C_DigestUpdate

    Returns void

    C_Encrypt

    Returns void

    C_Encrypt

    Returns Buffer

    Sliced output data with encrypted message

    -
  • +

  • Encrypts single-part data

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -367,7 +367,7 @@

    Output data

  • cb: (error: Error, data: Buffer) => void

    Async callback with sliced output data

    -
      • (error: Error, data: Buffer): void

      • Parameters

        • error: Error
        • data: Buffer

        Returns void

    • Returns void

    C_EncryptAsync

    Returns void

    C_EncryptAsync

    Returns Promise<Buffer>

    Sliced output data with encrypted message

    -

    C_EncryptFinal

    C_EncryptFinal

    Returns Buffer

    Sliced output data

    -
  • +

  • Finishes a multiple-part encryption operation

    Parameters

    • session: Buffer

      The session's handle

      @@ -395,14 +395,14 @@

      Last output data

    • cb: (error: Error, data: Buffer) => void

      Async callback with sliced output data

      -
        • (error: Error, data: Buffer): void

        • Parameters

          • error: Error
          • data: Buffer

          Returns void

    Returns void

    • C_EncryptFinalAsync

    Returns void

    C_EncryptFinalAsync

    C_EncryptInit

    C_EncryptInit

    Returns void

    C_EncryptUpdate

    Returns void

    C_EncryptUpdate

    Returns Buffer

    Sliced output data

    -

    C_Finalize

    C_Finalize

    C_FindObjects

    C_FindObjects

    Returns Buffer[]

    List of handles

    -
  • +

  • Continues a search for token and session objects that match a template, obtaining additional object handles

    @@ -448,13 +448,13 @@

    The session's handle

    • Returns null | Buffer

    Object's handle. If object is not found the result is null

    -

    C_FindObjectsFinal

    C_FindObjectsFinal

    C_FindObjectsInit

    Returns void

    C_FindObjectsInit

    Returns void

    C_GenerateKey

    Returns void

    C_GenerateKey

    Returns Buffer

    The handle of the new key

    -
  • +

  • Generates a secret key, creating a new key object

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -485,7 +485,7 @@

    Template for new key

  • cb: (error: Error, key: Buffer) => void

    Async callback with handle of new key

    -
      • (error: Error, key: Buffer): void

      • Parameters

        • error: Error
        • key: Buffer

        Returns void

    • Returns void

    C_GenerateKeyAsync

    Returns void

    C_GenerateKeyAsync

    Returns Promise<Buffer>

    The handle of the new key

    -

    C_GenerateKeyPair

    C_GenerateKeyPair

    Returns KeyPair

    The pair of handles for private and public keys

    -
  • +

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

    throws

    NativeError if native error occurs

    @@ -525,7 +525,7 @@

    Template for private key

  • cb: (error: Error, keys: KeyPair) => void

    Async callback with handles for private and public keys

    -
      • (error: Error, keys: KeyPair): void

      • Parameters

        Returns void

    • Returns void

    C_GenerateKeyPairAsync

    Returns void

    C_GenerateKeyPairAsync

    Returns Promise<KeyPair>

    Handles for private and public keys

    -

    C_GenerateRandom

    C_GenerateRandom

    Returns Buffer

    The random data

    -

    C_GetAttributeValue

    C_GetAttributeValue

    Returns TemplateResult

    List of Attributes with values

    -

    C_GetInfo

    C_GetInfo

    C_GetMechanismInfo

    C_GetMechanismInfo

    Returns MechanismInfo

    Information about mechanism

    -

    C_GetMechanismList

    C_GetMechanismList

    C_GetObjectSize

    C_GetObjectSize

    Returns number

    Size of an object in bytes

    -

    C_GetSessionInfo

    C_GetSessionInfo

    C_GetSlotInfo

    C_GetSlotInfo

    C_GetSlotList

    C_GetSlotList

    C_GetTokenInfo

    C_GetTokenInfo

    C_InitPIN

    C_InitPIN

    Returns void

    C_InitToken

    Returns void

    C_InitToken

    C_Initialize

    C_Initialize

    -

    Returns void

    C_Login

    Returns void

    C_Login

    Returns void

    C_Logout

    Returns void

    C_Logout

    C_OpenSession

    Returns void

    C_OpenSession

    Returns Buffer

    Session handle

    -

    C_SeedRandom

    C_SeedRandom

    Returns void

    C_SetAttributeValue

    Returns void

    C_SetAttributeValue

    Returns void

    C_SetPIN

    Returns void

    C_SetPIN

    Returns void

    C_Sign

    Returns void

    C_Sign

    Returns Buffer

    Sliced output data

    -
  • +

  • Signs (encrypts with private key) data in a single part, where the signature is (will be) an appendix to the data, and plaintext cannot be recovered from the signature

    @@ -720,7 +720,7 @@

    Output data

  • cb: (error: Error, data: Buffer) => void

    Async callback with sliced output data

    -
      • (error: Error, data: Buffer): void

      • Parameters

        • error: Error
        • data: Buffer

        Returns void

    • Returns void

    C_SignAsync

    Returns void

    C_SignAsync

    Returns Promise<Buffer>

    Sliced output data

    -

    C_SignEncryptUpdate

    C_SignEncryptUpdate

    Returns Buffer

    Sliced encrypted data

    -
  • +

  • Continues a multiple-part signing and encryption operation (signing and encrypting)

    Parameters

    • session: Buffer
      @@ -756,7 +756,7 @@

      Encrypted data

    • cb: (error: Error, data: Buffer) => void

      Async callback with sliced encrypted data

      -
        • (error: Error, data: Buffer): void

        • Parameters

          • error: Error
          • data: Buffer

          Returns void

    Returns void

    • C_SignEncryptUpdateAsync

    Returns void

    C_SignEncryptUpdateAsync

    C_SignFinal

    C_SignFinal

    Returns Buffer

    Sliced output data

    -
  • +

  • Finishes a multiple-part signature operation, returning the signature

    Parameters

    • session: Buffer
      @@ -785,7 +785,7 @@

      Output data

    • cb: (error: Error, data: Buffer) => void

      Async callback with sliced output data

      -
        • (error: Error, data: Buffer): void

        • Parameters

          • error: Error
          • data: Buffer

          Returns void

    Returns void

    • C_SignFinalAsync

    Returns void

    C_SignFinalAsync

    C_SignInit

    C_SignInit

    Returns void

    C_SignRecover

    Returns void

    C_SignRecover

    Returns Buffer

    Sliced output data

    -

    C_SignRecoverInit

    C_SignRecoverInit

    Returns void

    C_SignUpdate

    Returns void

    C_SignUpdate

    Returns void

    C_UnwrapKey

    Returns void

    C_UnwrapKey

    Returns Buffer

    The unwrapped key handle

    -
  • +

  • Unwraps (decrypts) a wrapped key, creating a new key object

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -866,7 +866,7 @@

    New key template

  • cb: (error: Error, key: Buffer) => void

    Async callback with new key handle

    -
      • (error: Error, key: Buffer): void

      • Parameters

        • error: Error
        • key: Buffer

        Returns void

    • Returns void

    C_UnwrapKeyAsync

    Returns void

    C_UnwrapKeyAsync

    Returns Promise<Buffer>

    The unwrapped key handle

    -

    C_Verify

    C_Verify

    Returns boolean

    Verification result

    -
  • +

  • Verifies a signature in a single-part operation, where the signature is an appendix to the data, and plaintext cannot be recovered from the signature

    @@ -908,7 +908,7 @@

    Signature to verify

  • cb: (error: Error, verify: boolean) => void

    Async callback with verification result

    -
      • (error: Error, verify: boolean): void

      • Parameters

        • error: Error
        • verify: boolean

        Returns void

    • Returns void

    C_VerifyAsync

    Returns void

    C_VerifyAsync

    Returns Promise<boolean>

    Verification result

    -

    C_VerifyFinal

    C_VerifyFinal

    Returns boolean

  • +

    • Returns boolean

  • Finishes a multiple-part verification operation, checking the signature

    Parameters

    • session: Buffer
      @@ -939,7 +939,7 @@

      Signature to verify

    • cb: (error: Error, verify: boolean) => void

      Async callback with verification result

      -
        • (error: Error, verify: boolean): void

        • Parameters

          • error: Error
          • verify: boolean

          Returns void

    Returns void

    • C_VerifyFinalAsync

    Returns void

    C_VerifyFinalAsync

    C_VerifyInit

    C_VerifyInit

    Returns void

    C_VerifyRecover

    Returns void

    C_VerifyRecover

    Returns Buffer

    The sliced output data with recovered data

    -

    C_VerifyRecoverInit

    C_VerifyRecoverInit

    Returns void

    C_VerifyUpdate

    Returns void

    C_VerifyUpdate

    Returns void

    C_WaitForSlotEvent

    Returns void

    C_WaitForSlotEvent

    C_WrapKey

    C_WrapKey

    Returns Buffer

    Sliced wrapped key

    -
  • +

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

    throws

    NativeError if native error occurs

    throws

    Pkcs11Error if Cryptoki error occurs

    @@ -1028,7 +1028,7 @@

    Init buffer for wrapped key

  • cb: (error: Error, wrappedKey: Buffer) => void

    Async callback with sliced wrapped key

    -
      • (error: Error, wrappedKey: Buffer): void

      • Parameters

        • error: Error
        • wrappedKey: Buffer

        Returns void

    • Returns void

    C_WrapKeyAsync

    Returns void

    C_WrapKeyAsync

    Returns Promise<Buffer>

    Sliced wrapped key

    -

    close

    close

    load

    load

    Returns Pkcs11Error

    Properties

    Readonly code

    code: number

    PKCS#11 result value. Default is 0

    -

    message

    message: string

    Readonly method

    method: string
    +

    message

    message: string

    Readonly method

    method: string

    Native function name. Default is empty string

    -

    name

    name: string

    Readonly nativeStack

    nativeStack: string
    +

    name

    name: string

    Readonly nativeStack

    nativeStack: string

    Native library call stack. Default is empty string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

    Type declaration