Class Key

Definition for the base key object class

defines the object class CKO_PUBLIC_KEY, CKO_PRIVATE_KEY and CKO_SECRET_KEY for type CK_OBJECT_CLASS as used in the CKA_CLASS attribute of objects

Hierarchy (view full)

Storage
- Key

Index

Constructors

constructor

new Key(object): Key
Creates an instance of SessionObject
Parameters
- object: SessionObject
Returns Key
Inherited from Storage.constructor
- Defined in object.ts:111
new Key(handle, session, lib): Key
Creates an instance of SessionObject
Parameters
- handle: Buffer
  ID of session object
- session: Session
  PKCS#11 session
- lib: PKCS11
  PKCS#11 module
Returns Key
Inherited from Storage.constructor
- Defined in object.ts:119

Properties

class

class: ObjectClass

Object class (type)

derive

derive: boolean

CK_TRUE if key supports key derivation (i.e., if other keys can be derived from this one (default CK_FALSE)

May be modified after object is created with a C_SetAttributeValue call, or in the process of copying object with a C_CopyObject call. However, it is possible that a particular token may not permit modification of the attribute during the course of a C_CopyObject call.

Returns

boolean

endDate

endDate: Date

End date for the key (default empty)

May be modified after object is created with a C_SetAttributeValue call, or in the process of copying object with a C_CopyObject call. However, it is possible that a particular token may not permit modification of the attribute during the course of a C_CopyObject call.

handle

handle: Buffer

ID of PKCS#11 object

id

id: Buffer

Key identifier for key (default empty)

May be modified after object is created with a C_SetAttributeValue call, or in the process of copying object with a C_CopyObject call. However, it is possible that a particular token may not permit modification of the attribute during the course of a C_CopyObject call.

label

label: string

Description of the object (default empty)

lib

lib: PKCS11

PKCS#11 module

local

local: boolean

CK_TRUE only if key was either * generated locally (i.e., on the token) with a C_GenerateKey or C_GenerateKeyPair call * created with a C_CopyObject call as a copy of a key which had its CKA_LOCAL attribute set to CK_TRUE

Must not be specified when object is created with C_CreateObject.
Must not be specified when object is generated with C_GenerateKey or C_GenerateKeyPair.
Must not be specified when object is unwrapped with C_UnwrapKey.

mechanism

mechanism: KeyGenMechanism

Identifier of the mechanism used to generate the key material.

Must not be specified when object is created with C_CreateObject.
Must not be specified when object is generated with C_GenerateKey or C_GenerateKeyPair.
Must not be specified when object is unwrapped with C_UnwrapKey.

modifiable

modifiable: boolean

true if object can be modified. Default is false

private

private: boolean

true if object is a private object and false if object is a public object. Default value is token-specific, and may depend on the values of other attributes of the object.

session

session: Session

PKCS#11 session

startDate

startDate: Date

Start date for the key (default empty)

May be modified after object is created with a C_SetAttributeValue call, or in the process of copying object with a C_CopyObject call. However, it is possible that a particular token may not permit modification of the attribute during the course of a C_CopyObject call.

token

token: boolean

true if object is a token object and false if object is a session object. Default is false.

type

type: KeyType

Type of key

Must be specified when object is created with C_CreateObject
Must be specified when object is unwrapped with C_UnwrapKey

Accessors

allowedMechanisms

get allowedMechanisms(): void
Returns void
- Defined in objects/keys/key.ts:158
set allowedMechanisms(v): void
Parameters
- v: void
Returns void
- Defined in objects/keys/key.ts:162

size

get size(): number
Gets the size of an object in bytes

Returns number
Inherited from Storage.size
- Defined in object.ts:104

Methods

copy

copy(template): SessionObject
Copies an object, creating a new object for the copy
Parameters
- template: ITemplate
  Template for the new object
Returns SessionObject
The new instance of SessionObject
Inherited from Storage.copy
- Defined in object.ts:139

destroy

destroy(): void
Destroys an object

Returns void
Inherited from Storage.destroy
- Defined in object.ts:150

get

get(type): Buffer
Alias for getAttribute
Parameters
- type: number
Returns Buffer
Inherited from Storage.get
- Defined in object.ts:231
get(name): any
Parameters
- name: string
Returns any
Inherited from Storage.get
- Defined in object.ts:232

getAttribute

getAttribute(type): Buffer
Returns attribute value
Parameters
- type: number
  Attribute type
Returns Buffer
Attribute value in Buffer format
Inherited from Storage.getAttribute
- Defined in object.ts:159
getAttribute(name): any
Returns attribute value
Parameters
- name: string
  Attribute name. See ITemplate
Returns any
Attribute value. Depends on the attribute name
Inherited from Storage.getAttribute
- Defined in object.ts:165
getAttribute(attrs): ITemplate
Returns a list of attributes
Parameters
- attrs: ITemplate
  The list of attributes for receiving
Returns ITemplate
The list of attributes
Inherited from Storage.getAttribute
- Defined in object.ts:171

`Protected`getInfo

getInfo(): void
Retrieves information about PKCS#11 object and fills fields

Returns void
Inherited from Storage.getInfo
- Defined in object.ts:256

set

set(type, value): void
Alias for setAttribute
Parameters
- type: number
- value:
      | string
      | number
      | boolean
      | Buffer
Returns void
Inherited from Storage.set
- Defined in object.ts:240
set(name, value): void
Parameters
- name: string
- value: any
Returns void
Inherited from Storage.set
- Defined in object.ts:241

setAttribute

setAttribute(type, value): void
Sets attribute value
Parameters
- type: number
  Attribute type
- value:
      | string
      | number
      | boolean
      | Buffer
  Attribute value
Returns void
Inherited from Storage.setAttribute
- Defined in object.ts:200
setAttribute(name, value): void
Sets attribute value
Parameters
- name: string
  Attribute name. See ITemplate
- value: any
  Attribute value. Depends on attribute name
Returns void
Inherited from Storage.setAttribute
- Defined in object.ts:206
setAttribute(attrs): void
Sets attributes from the list of attributes
Parameters
- attrs: ITemplate
  The list of attributes
Returns void
Inherited from Storage.setAttribute
- Defined in object.ts:211

toType

toType<T>(): T
Type Parameters
- T extends SessionObject
Returns T
Inherited from Storage.toType
- Defined in object.ts:252

Class Key

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Key

Parameters

Returns Key

Properties

class

derive

Returns

endDate

handle

id

label

lib

local

mechanism

modifiable

private

session

startDate

token

type

Accessors

allowedMechanisms

Returns void

Parameters

Returns void

size

Returns number

Methods

copy

Parameters

Returns SessionObject

destroy

Returns void

get

Parameters

Returns Buffer

Parameters

Returns any

getAttribute

Parameters

Returns Buffer

Parameters

Returns any

Parameters

Returns ITemplate

ProtectedgetInfo

Returns void

set

Parameters

Returns void

Parameters

Returns void

setAttribute

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

toType

Type Parameters

Returns T

Settings

On This Page

`Protected`getInfo