Class OPCUACertificateManager

Hierarchy

CertificateManager
- OPCUACertificateManager

Implements

ICertificateManager

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new OPCUACertificateManager(options: OPCUACertificateManagerOptions): OPCUACertificateManager

Overrides CertificateManager.__constructor
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:67
Parameters
- options: OPCUACertificateManagerOptions
Returns OPCUACertificateManager

Properties

automaticallyAcceptUnknownCertificate

automaticallyAcceptUnknownCertificate: boolean

folderPoolingInterval

folderPoolingInterval: number

initialized

initialized: boolean

untrustUnknownCertificate

untrustUnknownCertificate: boolean

Accessors

configFile

get configFile(): string

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

crlFolder

get crlFolder(): string

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

issuersCertFolder

get issuersCertFolder(): string

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

issuersCrlFolder

get issuersCrlFolder(): string

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

privateKey

get privateKey(): string

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

randomFile

get randomFile(): string

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

rejectedFolder

get rejectedFolder(): string

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

rootDir

get rootDir(): string

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

trustedFolder

get trustedFolder(): string

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

Methods

_innerVerifyCertificateAsync

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

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

addIssuer

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

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

addRevocationList

addRevocationList(crl: CertificateRevocationList): Promise<VerificationStatus>

Inherited from OPCUACertificateManager.addRevocationList
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:106
Parameters
- crl: CertificateRevocationList
Returns Promise<VerificationStatus>

checkCertificate

checkCertificate(certificate: Certificate): Promise<StatusCode>
checkCertificate(certificate: Certificate, callback: StatusCodeCallback): void

Implementation of ICertificateManager.checkCertificate
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:86
Parameters
- certificate: Certificate
Returns Promise<StatusCode>
Implementation of ICertificateManager.checkCertificate
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:87
Parameters
- certificate: Certificate
- callback: StatusCodeCallback
Returns void

createCertificateRequest

createCertificateRequest(params: CreateSelfSignCertificateParam): Promise<Filename>
createCertificateRequest(params: CreateSelfSignCertificateParam, callback: function): void

Inherited from OPCUACertificateManager.createCertificateRequest
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:103
Parameters
- params: CreateSelfSignCertificateParam
Returns Promise<Filename>
Inherited from OPCUACertificateManager.createCertificateRequest
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:104
Parameters
- params: CreateSelfSignCertificateParam
- callback: function
  - - (err: Error | null, certificateSigningRequestFilename?: string): void
    - Parameters
      - err: Error | null
      - Optional certificateSigningRequestFilename: string
      Returns void
Returns void

createSelfSignedCertificate

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

Inherited from OPCUACertificateManager.createSelfSignedCertificate
- 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>
Inherited from OPCUACertificateManager.createSelfSignedCertificate
- 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>

Inherited from OPCUACertificateManager.dispose
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:95
Returns Promise<void>

findIssuerCertificate

findIssuerCertificate(certificate: Certificate): Promise<Certificate | null>

Inherited from OPCUACertificateManager.findIssuerCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:107
Parameters
- certificate: Certificate
Returns Promise<Certificate | null>

getCertificateStatus

getCertificateStatus(certificate: Buffer): Promise<CertificateStatus>
getCertificateStatus(certificate: Buffer, callback: function): void

Inherited from OPCUACertificateManager.getCertificateStatus
- 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>
Inherited from OPCUACertificateManager.getCertificateStatus
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:72
Parameters
- certificate: Buffer
- callback: function
  - - (err: Error | null, status?: CertificateStatus): void
    - Parameters
      - err: Error | null
      - Optional status: CertificateStatus
      Returns void
Returns void

getTrustStatus

getTrustStatus(certificate: Certificate): Promise<StatusCode>
getTrustStatus(certificate: Certificate, callback: StatusCodeCallback): void

Implementation of ICertificateManager.getTrustStatus
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:116
Parameters
- certificate: Certificate
Returns Promise<StatusCode>
Implementation of ICertificateManager.getTrustStatus
- Defined in packages/node-opcua-certificate-manager/source/certificate_manager.ts:117
Parameters
- certificate: Certificate
- callback: StatusCodeCallback
Returns void

initialize

initialize(): Promise<void>
initialize(callback: function): void

Inherited from OPCUACertificateManager.initialize
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:93
Returns Promise<void>
Inherited from OPCUACertificateManager.initialize
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:94
Parameters
- callback: function
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

isCertificateRevoked

isCertificateRevoked(certificate: Certificate, issuerCertificate?: Certificate | null): Promise<VerificationStatus>

Inherited from OPCUACertificateManager.isCertificateRevoked
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:118
Parameters
- certificate: Certificate
- Optional issuerCertificate: Certificate | null
Returns Promise<VerificationStatus>

isCertificateTrusted

isCertificateTrusted(certificate: Certificate, callback: function): void
isCertificateTrusted(certificate: Certificate): Promise<string>

Inherited from OPCUACertificateManager.isCertificateTrusted
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:82
Parameters
- certificate: Certificate
- callback: function
  - - (err: Error | null, trustedStatus: string): void
    - Parameters
      - err: Error | null
      - trustedStatus: string
      Returns void
Returns void
Inherited from OPCUACertificateManager.isCertificateTrusted
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:83
Parameters
- certificate: Certificate
Returns Promise<string>

rejectCertificate

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

Implementation of ICertificateManager.rejectCertificate

Inherited from OPCUACertificateManager.rejectCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:73
Parameters
- certificate: Certificate
Returns Promise<void>
Inherited from OPCUACertificateManager.rejectCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:74
Parameters
- certificate: Certificate
- callback: ErrorCallback
Returns void

trustCertificate

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

Implementation of ICertificateManager.trustCertificate

Inherited from OPCUACertificateManager.trustCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:75
Parameters
- certificate: Certificate
Returns Promise<void>
Inherited from OPCUACertificateManager.trustCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:76
Parameters
- certificate: Certificate
- callback: ErrorCallback
Returns void

verifyCertificate

verifyCertificate(certificate: Certificate): Promise<VerificationStatus>
verifyCertificate(certificate: Certificate, callback: function): void

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

method

verifyCertificate

Parameters
- certificate: Certificate
Returns Promise<VerificationStatus>
Inherited from OPCUACertificateManager.verifyCertificate
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:92
Parameters
- certificate: Certificate
- callback: function
  - - (err: Error | null, status?: VerificationStatus): void
    - Parameters
      - err: Error | null
      - Optional status: VerificationStatus
      Returns void
Returns void

verifyCertificateAsync

verifyCertificateAsync(certificate: Certificate): Promise<VerificationStatus>

Inherited from OPCUACertificateManager.verifyCertificateAsync
- Defined in node_modules/node-opcua-pki/dist/pki/certificate_manager.d.ts:85
Parameters
- certificate: Certificate
Returns Promise<VerificationStatus>

Class OPCUACertificateManager

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: OPCUACertificateManagerOptions

Returns OPCUACertificateManager

Properties

automaticallyAcceptUnknownCertificate

folderPoolingInterval

initialized

untrustUnknownCertificate

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: Certificate

isIssuer: boolean

level: number

Returns Promise<VerificationStatus>

addIssuer

Parameters

certificate: DER

Optional validate: boolean

Optional addInTrustList: boolean

Returns Promise<VerificationStatus>

addRevocationList

Parameters

crl: CertificateRevocationList

Returns Promise<VerificationStatus>

checkCertificate

Parameters

certificate: Certificate

Returns Promise<StatusCode>

Parameters

certificate: Certificate

callback: StatusCodeCallback

Returns void

createCertificateRequest

Parameters

params: CreateSelfSignCertificateParam

Returns Promise<Filename>

Parameters

params: CreateSelfSignCertificateParam

callback: function

Parameters

err: Error | null

Optional certificateSigningRequestFilename: string

Returns void

Returns void

createSelfSignedCertificate

Parameters

params: CreateSelfSignCertificateParam1

Returns Promise<void>

Parameters

params: CreateSelfSignCertificateParam1

callback: ErrorCallback