Class Data

Data objects (object class CKO_DATA) hold information defined by an application. Other than providing access to it, Cryptoki does not attach any special meaning to a data object

Hierarchy (view full)

Storage
- Data

Index

Constructors

constructor

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

Properties

application

application: string

Description of the application that manages the object (default empty)

class

class: ObjectClass

Object class (type)

handle

handle: Buffer

ID of PKCS#11 object

label

label: string

Description of the object (default empty)

lib

lib: PKCS11

PKCS#11 module

modifiable

modifiable: boolean

true if object can be modified. Default is false

objectId

objectId: Buffer

DER-encoding of the object identifier indicating the data object type (default empty)

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

token

token: boolean

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

value

value: Buffer

Value of the object (default empty)

Accessors

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 Data

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Data

Parameters

Returns Data

Properties

application

class

handle

label

lib

modifiable

objectId

private

session

token

value

Accessors

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