SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

PublicKeyCrypto Class

Properties   Methods   Events   Configuration Settings   Errors  

The PublicKeyCrypto class supports encrypting, decrypting, signing and verifying messages.

Syntax

secureblackbox.publickeycrypto()

Remarks

PublicKeyCrypto allows you to encrypt, decrypt, sign and verify messages.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

CanEncryptReturns true if the crypto object can be used for encryption.
CanSignReturns true if the crypto object is capable of data signing.
HashAlgorithmThe hash algorithm to be used during the crypto operation.
InputEncodingThe encoding to apply to the input data.
InputIsHashIndicates whether the input data contains the hash or the actual data.
JsonKeyHeaderParamsContains key header parameters.
JsonProtectedHeaderProvides access to the header being protected.
JsonUnprotectedHeaderProvides access to the unprotected part of the header.
JsonUnprotectedHeaderParamsContains unprotected header parameters.
KeyAlgorithmThe algorithm of the cryptographic key.
KeyBitsThe length of the key in bits.
KeyExportableReturns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
KeyHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KeyIDProvides access to a storage-specific key identifier.
KeyIVThe initialization vector (IV) of a symmetric key.
KeyKeyThe byte array representation of the key.
KeyNonceA nonce value associated with a key.
KeyPrivateReturns True if the object hosts a private key, and False otherwise.
KeyPublicReturns True if the object hosts a public key, and False otherwise.
KeySubjectReturns the key subject.
KeySymmetricReturns True if the object contains a symmetric key, and False otherwise.
KeyValidReturns True if this key is valid.
OutputEncodingThe encoding type to apply to the output data.
SchemeThe algorithm scheme to use.
SchemeParamsThe algorithm scheme parameters to employ.
SignatureValidationResultThe signature validation result.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
DecryptDecrypts a buffer.
DecryptFileDecrypts a file.
EncryptEncrypts a buffer.
EncryptFileEncrypts a file.
SignSigns a buffer.
SignFileSigns a file.
VerifyVerifies an enveloped or enveloping signature contained in a buffer.
VerifyDetachedVerifies a detached signature.
VerifyDetachedFileVerifies a detached signature.
VerifyFileVerifies an enveloped or enveloping signature contained in a file.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorReports error information during a crypto operation.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Node.js Edition - Version 20.0 [Build 8165]