Class SessionObject

Represents a PKCS#11 session object

Hierarchy (view full)

HandleObject
- SessionObject
  - Storage

Index

Constructors

Properties

class handle lib session

Accessors

Methods

copy destroy get getAttribute getInfo set setAttribute toType

Constructors

constructor

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

Properties

class

class: ObjectClass

Object class (type)

handle

handle: Buffer

ID of PKCS#11 object

lib

lib: PKCS11

PKCS#11 module

session

session: Session

PKCS#11 session

Accessors

size

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

Returns number
- 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
- Defined in object.ts:139

destroy

destroy(): void
Destroys an object

Returns void
- Defined in object.ts:150

get

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

getAttribute

getAttribute(type): Buffer
Returns attribute value
Parameters
- type: number
  Attribute type
Returns Buffer
Attribute value in Buffer format
- 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
- 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
- Defined in object.ts:171

`Protected`getInfo

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

Returns void
Overrides HandleObject.getInfo
- Defined in object.ts:256

set

set(type, value): void
Alias for setAttribute
Parameters
- type: number
- value:
      | string
      | number
      | boolean
      | Buffer
Returns void
- Defined in object.ts:240
set(name, value): void
Parameters
- name: string
- value: any
Returns void
- 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
- 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
- Defined in object.ts:206
setAttribute(attrs): void
Sets attributes from the list of attributes
Parameters
- attrs: ITemplate
  The list of attributes
Returns void
- Defined in object.ts:211

toType

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