Class Session

constructor

• new Session(handle, slot, lib): Session

• Creates a new instance of Session

  Parameters

  • handle: Buffer

    ID of slot's session
  • slot: Slot

    PKCS#11 slot
  • lib: PKCS11

    PKCS#11 module

  Returns Session

deviceError

flags

slot

state

clear

• clear(): number

• Removes all session objects

  Returns number

  The number of destroyed objects

close

• close(): void

• Closes a session between an application and a token

  Returns void

copy

• copy(object, template): SessionObject

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

  Parameters

  • object: SessionObject

    the copied object
  • template: ITemplate

    template for new object

  Returns SessionObject

  The new instance of SessionObject

create

• create(template): SessionObject

• creates a new object

  • Only session objects can be created during a read-only session.
  • Only public objects can be created unless the normal user is logged in.

  Parameters

  • template: ITemplate

    the object's template

  Returns SessionObject

  The new instance of SessionObject

createCipher

• createCipher(alg, key): Cipher

• Creates the encryption operation

  Parameters

  • alg: MechanismType

    The encryption mechanism
  • key: Key

    The encryption key

  Returns Cipher

  The encryption operation

createDecipher

• createDecipher(alg, key, blockSize?): Decipher

• Creates the decryption operation

  Parameters

  • alg: MechanismType

    The decryption mechanism
  • key: Key

    The decryption key
  • OptionalblockSize: number

    Block size in bytes

  Returns Decipher

  The decryption operation

createDigest

• createDigest(alg): Digest

• Creates the digest operation

  Parameters

  • alg: MechanismType

    The digest mechanism

  Returns Digest

  The digest operation

createSign

• createSign(alg, key): Sign

• Creates the signing operation

  Parameters

  • alg: MechanismType

    The signing mechanism
  • key: Key

    The signing key

  Returns Sign

  Signing operation

createVerify

• createVerify(alg, key): Verify

• Creates the verifying operation

  Parameters

  • alg: MechanismType

    The verifying mechanism
  • key: Key

    The verifying key

  Returns Verify

deriveKey

• deriveKey(alg, baseKey, template): SecretKey

• Derives a key from a base key

  Parameters

  • alg: MechanismType

    Key derivation mech
  • baseKey: Key

    Base key
  • template: ITemplate

    New key template

  Returns SecretKey

  Derived key
• deriveKey(alg, baseKey, template, callback): void

• Derives a key from a base key

  Parameters

  • alg: MechanismType

    Key derivation mech
  • baseKey: Key

    Base key
  • template: ITemplate

    New key template
  • callback: Callback<Error, Key>

    Async callback function with derived key

  Returns void

destroy

• destroy(template): number

• Removes all session objects matched to template

  Parameters

  • template: ITemplate

    The list of attributes

  Returns number

  The number of destroyed objects
• destroy(object): number

• Removes the specified session object

  Parameters

  • object: SessionObject

    Object for destroying

  Returns number

  The number of destroyed objects
• destroy(): number

• Removes all session objects

  Returns number

  The number of destroyed objects

find

• find(): SessionObjectCollection

• Returns a collection of session objects matched to template

  Returns SessionObjectCollection

  Th collection of session objects
• find(callback): SessionObjectCollection

• Parameters

  • callback: SessionFindCallback

  Returns SessionObjectCollection

• find(template?, callback?): SessionObjectCollection

• Parameters

  • Optionaltemplate: null | ITemplate
  • Optionalcallback: SessionFindCallback

  Returns SessionObjectCollection

generateKey

• generateKey(mechanism, template?): SecretKey

• Generates a secret key or set of domain parameters, creating a new object.

  Parameters

  • mechanism: MechanismType

    Generation mechanism
  • Optionaltemplate: ITemplate

    Template for the new key or set of domain parameters

  Returns SecretKey

  The secret key
• generateKey(mechanism, template, callback): void

• Generates a secret key or set of domain parameters, creating a new object.

  Parameters

  • mechanism: MechanismType

    Generation mechanism
  • template: ITemplate

    Template for the new key or set of domain parameters
  • callback: Callback<Error, SecretKey>

    Async callback with generated key

  Returns void

generateKeyPair

• generateKeyPair(mechanism, publicTemplate, privateTemplate): IKeyPair

• Generates an asymmetric key pair

  Parameters

  • mechanism: MechanismType

    Generation mechanism
  • publicTemplate: ITemplate

    The public key template
  • privateTemplate: ITemplate

    The private key template

  Returns IKeyPair

  The generated key pair
• generateKeyPair(mechanism, publicTemplate, privateTemplate, callback): void

• Generates an asymmetric key pair

  Parameters

  • mechanism: MechanismType

    Generation mechanism
  • publicTemplate: ITemplate

    The public key template
  • privateTemplate: ITemplate

    The private key template
  • callback: Callback<Error, IKeyPair>

    Async callback with generated key pair

  Returns void

generateRandom

• generateRandom(size): Buffer

• Generates random data

  Parameters

  • size: number

    Amount of bytes to generate

  Returns Buffer

  New byte array

getObject

• getObject<T>(handle): null | T

• Returns object from session by handle

  Type Parameters

  • T extends SessionObject

  Parameters

  • handle: Buffer

    handle of object

  Returns null | T

  The session object or null

getOperationState

• getOperationState(): Buffer

• Obtains a copy of the cryptographic operations state of a session, encoded as a string of bytes

  Returns Buffer

initPin

• initPin(pin): void

• Initializes the normal user's PIN

  Parameters

  • pin: string

    the normal user's PIN

  Returns void

login

• login(pin, userType?): void

• Logs a user into a token

  Parameters

  • pin: string

    the user's PIN.

    • This standard allows PIN values to contain any valid UTF8 character, but the token may impose subset restrictions
  • userType: UserType = UserType.USER

    the user type. Default is UserType.USER

  Returns void

logout

• logout(): void

• logs a user out from a token

  Returns void

setOperationState

• setOperationState(state, encryptionKey?, authenticationKey?): void

• Restores the cryptographic operations state of a session from a string of bytes obtained with getOperationState

  Parameters

  • state: Buffer

    the saved state
  • encryptionKey: number = 0

    holds key which will be used for an ongoing encryption or decryption operation in the restored session (or 0 if no encryption or decryption key is needed, either because no such operation is ongoing in the stored session or because all the necessary key information is present in the saved state)
  • authenticationKey: number = 0

    holds a handle to the key which will be used for an ongoing signature, MACing, or verification operation in the restored session (or 0 if no such key is needed, either because no such operation is ongoing in the stored session or because all the necessary key information is present in the saved state)

  Returns void

setPin

• setPin(oldPin, newPin): void

• modifies the PIN of the user who is logged in

  Parameters

  • oldPin: string

    The old PIN
  • newPin: string

    The new PIN

  Returns void

unwrapKey

• unwrapKey(alg, unwrappingKey, wrappedKey, template): Key

• Unwraps (decrypts) a wrapped key

  Parameters

  • alg: MechanismType

    Unwrapping mechanism
  • unwrappingKey: Key

    Unwrapping key
  • wrappedKey: Buffer

    Wrapped key
  • template: ITemplate

    New key template

  Returns Key

  Unwrapped key
• unwrapKey(alg, unwrappingKey, wrappedKey, template, callback): void

• Parameters

  • alg: MechanismType
  • unwrappingKey: Key
  • wrappedKey: Buffer
  • template: ITemplate
  • callback: Callback<Error, Key>

  Returns void

wrapKey

• wrapKey(alg, wrappingKey, key): Buffer

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

  Parameters

  • alg: MechanismType

    Wrapping mechanism
  • wrappingKey: Key

    Wrapping key
  • key: Key

    Key to be wrapped

  Returns Buffer

  Wrapped key
• wrapKey(alg, wrappingKey, key, callback): void

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

  Parameters

  • alg: MechanismType

    Wrapping mechanism
  • wrappingKey: Key

    Wrapping key
  • key: Key

    Key to be wrapped
  • callback: Callback<Error, Buffer>

    Async callback function with wrapped key

  Returns void