Class X509Certificate

X.509 certificate objects (certificate type CKC_X_509) hold X.509 public key certificates

Hierarchy (view full)

Certificate
- X509Certificate

Index

Constructors

Constructors

constructor

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

Properties

authorityKeyIdentifier

authorityKeyIdentifier: Buffer

SHA-1 hash of the issuer public key (default empty)

Can only be empty if CKA_URL is empty.

checkValue

checkValue: Buffer

Checksum

class

class: ObjectClass

Object class (type)

endDate

endDate: Date

End date for the certificate (default empty)

handle

handle: Buffer

ID of PKCS#11 object

id

id: Buffer

Key identifier for public/private key pair (default empty)

issuer

issuer: Buffer

DER-encoding of the certificate issuer name (default empty)

java

java: JavaMIDP

Java MIDP security domain

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

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 certificate (default empty)

subject

subject: Buffer

DER-encoding of the certificate subject name

Must be specified when the object is created.
Must be non-empty if CKA_URL is empty.

subjectKeyIdentifier

subjectKeyIdentifier: Buffer

SHA-1 hash of the subject public key (default empty)

Can only be empty if CKA_URL is empty.

token

token: boolean

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

trusted

trusted: boolean

The certificate can be trusted for the application that it was created.

type

type: CertificateType

Type of certificate

url

url: string

If not empty this attribute gives the URL where the complete certificate can be obtained (default empty)

Must be non-empty if CKA_VALUE is empty

value

value: Buffer

BER-encoding of the certificate

Must be specified when the object is created.
Must be non-empty if CKA_URL is empty.

Accessors

serialNumber

get serialNumber(): string
HEX-encoding of the certificate serial number (default empty)

Returns string
- Defined in objects/certs/x509.ts:42
set serialNumber(v): void
HEX-encoding of the certificate serial number (default empty)
Parameters
- v: string
Returns void
- Defined in objects/certs/x509.ts:49

size

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

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

destroy

destroy(): void
Destroys an object

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

get

get(type): Buffer
Alias for getAttribute
Parameters
- type: number
Returns Buffer
Inherited from Certificate.get
- Defined in object.ts:231
get(name): any
Parameters
- name: string
Returns any
Inherited from Certificate.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 Certificate.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 Certificate.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 Certificate.getAttribute
- Defined in object.ts:171

`Protected`getInfo

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

Returns void
Inherited from Certificate.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 Certificate.set
- Defined in object.ts:240
set(name, value): void
Parameters
- name: string
- value: any
Returns void
Inherited from Certificate.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 Certificate.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 Certificate.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 Certificate.setAttribute
- Defined in object.ts:211

toType

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

Class X509Certificate

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns X509Certificate

Parameters

Returns X509Certificate

Properties

authorityKeyIdentifier

category

checkValue

class

endDate

handle

id

issuer

java

label

lib

modifiable

private

session

startDate

subject

subjectKeyIdentifier

token

trusted

type

url

value

Accessors

serialNumber

Returns string

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