OPCUACertificateManager | NodeOPCUA reference documentation

Hierarchy

CertificateManager
- OPCUACertificateManager

Implements

ICertificateManager

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new OPCUACertificateManager(options: OPCUACertificateManagerOptions): OPCUACertificateManager

- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:78
Parameters
- options: OPCUACertificateManagerOptions
Returns OPCUACertificateManager

Properties

automaticallyAcceptUnknownCertificate

automaticallyAcceptUnknownCertificate: boolean

folderPoolingInterval

folderPoolingInterval: number

initialized

initialized: boolean

referenceCounter

referenceCounter: number

untrustUnknownCertificate

untrustUnknownCertificate: boolean

Static defaultCertificateSubject

defaultCertificateSubject: string = "/O=Sterfive/L=Orleans/C=FR"

Static registry

registry: ObjectRegistry = ...

Accessors

configFile

get configFile(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:63
Returns string

crlFolder

get crlFolder(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:79
Returns string

issuersCertFolder

get issuersCertFolder(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:80
Returns string

issuersCrlFolder

get issuersCrlFolder(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:81
Returns string

privateKey

get privateKey(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:65
Returns string

randomFile

get randomFile(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:66
Returns string

rejectedFolder

get rejectedFolder(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:77
Returns string

rootDir

get rootDir(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:64
Returns string

trustedFolder

get trustedFolder(): string

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:78
Returns string

Methods

_innerVerifyCertificateAsync

_innerVerifyCertificateAsync(certificate: Buffer, isIssuer: boolean, level: number): Promise<VerificationStatus>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:84
Parameters
- certificate: Buffer
- isIssuer: boolean
- level: number
Returns Promise<VerificationStatus>

addIssuer

addIssuer(certificate: Buffer, validate?: boolean, addInTrustList?: boolean): Promise<VerificationStatus>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:105
Parameters
- certificate: Buffer
- Optional validate: boolean
- Optional addInTrustList: boolean
Returns Promise<VerificationStatus>

addRevocationList

addRevocationList(crl: Buffer): Promise<VerificationStatus>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:106
Parameters
- crl: Buffer
Returns Promise<VerificationStatus>

checkCertificate

checkCertificate(certificateChain: Buffer): Promise<StatusCode>
checkCertificate(certificateChain: Buffer, callback: CallbackT<StatusCode>): void

Implementation of ICertificateManager.checkCertificate
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:122
Parameters
- certificateChain: Buffer
Returns Promise<StatusCode>
Implementation of ICertificateManager.checkCertificate
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:123
Parameters
- certificateChain: Buffer
- callback: CallbackT<StatusCode>
Returns void

createCertificateRequest

createCertificateRequest(params: CreateSelfSignCertificateParam): Promise<string>
createCertificateRequest(params: CreateSelfSignCertificateParam, callback: (err: Error, certificateSigningRequestFilename?: string) => void): void

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:103
Parameters
- params: CreateSelfSignCertificateParam
Returns Promise<string>
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:104
Parameters
- params: CreateSelfSignCertificateParam
- callback: (err: Error, certificateSigningRequestFilename?: string) => void
  - - (err: Error, certificateSigningRequestFilename?: string): void
    - Parameters
      - err: Error
      - Optional certificateSigningRequestFilename: string
      Returns void
Returns void

createSelfSignedCertificate

createSelfSignedCertificate(params: CreateSelfSignCertificateParam1): Promise<void>
createSelfSignedCertificate(params: CreateSelfSignCertificateParam1, callback: ErrorCallback): void

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:101
create a self-signed certificate for the CertificateManager private key

Parameters
- params: CreateSelfSignCertificateParam1
Returns Promise<void>
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:102
Parameters
- params: CreateSelfSignCertificateParam1
- callback: ErrorCallback
Returns void

dispose

dispose(): Promise<void>

- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:110
Returns Promise<void>

findIssuerCertificate

findIssuerCertificate(certificate: Buffer): Promise<Buffer>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:107
Parameters
- certificate: Buffer
Returns Promise<Buffer>

getCertificateStatus

getCertificateStatus(certificate: Buffer): Promise<CertificateStatus>
getCertificateStatus(certificate: Buffer, callback: (err: Error, status?: CertificateStatus) => void): void

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:71
returns the certificate status trusted/rejected

Parameters
- certificate: Buffer
Returns Promise<CertificateStatus>
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:72
Parameters
- certificate: Buffer
- callback: (err: Error, status?: CertificateStatus) => void
  - - (err: Error, status?: CertificateStatus): void
    - Parameters
      - err: Error
      - Optional status: CertificateStatus
      Returns void
Returns void

getTrustStatus

getTrustStatus(certificate: Buffer): Promise<StatusCode>
getTrustStatus(certificate: Buffer, callback: CallbackT<StatusCode>): void

Implementation of ICertificateManager.getTrustStatus
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:154
Parameters
- certificate: Buffer
Returns Promise<StatusCode>
Implementation of ICertificateManager.getTrustStatus
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:155
Parameters
- certificate: Buffer
- callback: CallbackT<StatusCode>
Returns void

initialize

initialize(): Promise<void>
initialize(callback: (err?: Error) => void): void

- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:99
Returns Promise<void>
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:100
Parameters
- callback: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

isCertificateRevoked

isCertificateRevoked(certificate: Buffer, issuerCertificate?: Buffer): Promise<VerificationStatus>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:118
Parameters
- certificate: Buffer
- Optional issuerCertificate: Buffer
Returns Promise<VerificationStatus>

isCertificateTrusted

isCertificateTrusted(certificate: Buffer, callback: (err: Error, trustedStatus: string) => void): void
isCertificateTrusted(certificate: Buffer): Promise<string>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:82
Parameters
- certificate: Buffer
- callback: (err: Error, trustedStatus: string) => void
  - - (err: Error, trustedStatus: string): void
    - Parameters
      - err: Error
      - trustedStatus: string
      Returns void
Returns void
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:83
Parameters
- certificate: Buffer
Returns Promise<string>

rejectCertificate

rejectCertificate(certificate: Buffer): Promise<void>
rejectCertificate(certificate: Buffer, callback: ErrorCallback): void

Implementation of ICertificateManager.rejectCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:73
Parameters
- certificate: Buffer
Returns Promise<void>
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:74
Parameters
- certificate: Buffer
- callback: ErrorCallback
Returns void

trustCertificate

trustCertificate(certificate: Buffer): Promise<void>
trustCertificate(certificate: Buffer, callback: ErrorCallback): void

Implementation of ICertificateManager.trustCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:75
Parameters
- certificate: Buffer
Returns Promise<void>
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:76
Parameters
- certificate: Buffer
- callback: ErrorCallback
Returns void

verifyCertificate

verifyCertificate(certificate: Buffer): Promise<VerificationStatus>
verifyCertificate(certificate: Buffer, callback: (err: Error, status?: VerificationStatus) => void): void

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:91
Verify certificate validity

method

verifyCertificate

Parameters
- certificate: Buffer
Returns Promise<VerificationStatus>
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:92
Parameters
- certificate: Buffer
- callback: (err: Error, status?: VerificationStatus) => void
  - - (err: Error, status?: VerificationStatus): void
    - Parameters
      - err: Error
      - Optional status: VerificationStatus
      Returns void
Returns void

verifyCertificateAsync

verifyCertificateAsync(certificate: Buffer): Promise<VerificationStatus>

- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:85
Parameters
- certificate: Buffer
Returns Promise<VerificationStatus>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: OPCUACertificateManagerOptions

Returns OPCUACertificateManager

Properties

automaticallyAcceptUnknownCertificate

folderPoolingInterval

initialized

referenceCounter

untrustUnknownCertificate

Static defaultCertificateSubject

Static registry

Accessors

configFile

Returns string

crlFolder

Returns string

issuersCertFolder

Returns string

issuersCrlFolder

Returns string

privateKey

Returns string

randomFile

Returns string

rejectedFolder

Returns string

rootDir

Returns string

trustedFolder

Returns string

Methods

_innerVerifyCertificateAsync

Parameters

certificate: Buffer

isIssuer: boolean

level: number

Returns Promise<VerificationStatus>

addIssuer

Parameters

certificate: Buffer

Optional validate: boolean

Optional addInTrustList: boolean

Returns Promise<VerificationStatus>

addRevocationList

Parameters

crl: Buffer

Returns Promise<VerificationStatus>

checkCertificate

Parameters

certificateChain: Buffer

Returns Promise<StatusCode>

Parameters

certificateChain: Buffer

callback: CallbackT<StatusCode>

Returns void

createCertificateRequest

Parameters

params: CreateSelfSignCertificateParam

Returns Promise<string>

Parameters

params: CreateSelfSignCertificateParam

callback: (err: Error, certificateSigningRequestFilename?: string) => void

Parameters

err: Error

Optional certificateSigningRequestFilename: string

Returns void

Returns void

createSelfSignedCertificate

Parameters

params: CreateSelfSignCertificateParam1