PublicKeyCrypto Class

Properties Methods Events Configuration Settings Errors

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

Syntax

class 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.


can_encrypt	Returns true if the crypto object can be used for encryption.
can_sign	Returns true if the crypto object is capable of data signing.
hash_algorithm	The hash algorithm to be used during the crypto operation.
input_encoding	The encoding to apply to the input data.
input_is_hash	Indicates whether the input data contains the hash or the actual data.
json_key_header_params	Contains key header parameters.
json_protected_header	Provides access to the header being protected.
json_unprotected_header	Provides access to the unprotected part of the header.
json_unprotected_header_params	Contains unprotected header parameters.
key_algorithm	The algorithm of the cryptographic key.
key_bits	The length of the key in bits.
key_exportable	Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise.
key_handle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
key_id	Provides access to a storage-specific key identifier.
key_iv	The initialization vector (IV) of a symmetric key.
key_key	The byte array representation of the key.
key_nonce	A nonce value associated with a key.
key_private	Returns True if the object hosts a private key, and False otherwise.
key_public	Returns True if the object hosts a public key, and False otherwise.
key_subject	Returns the key subject.
key_symmetric	Returns True if the object contains a symmetric key, and False otherwise.
key_valid	Returns True if this key is valid.
output_encoding	The encoding type to apply to the output data.
scheme	The algorithm scheme to use.
scheme_params	The algorithm scheme parameters to employ.
signature_validation_result	The 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.


config	Sets or retrieves a configuration setting.
decrypt	Decrypts a buffer.
decrypt_file	Decrypts a file.
encrypt	Encrypts a buffer.
encrypt_file	Encrypts a file.
sign	Signs a buffer.
sign_file	Signs a file.
verify	Verifies an enveloped or enveloping signature contained in a buffer.
verify_detached	Verifies a detached signature.
verify_detached_file	Verifies a detached signature.
verify_file	Verifies 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.


on_error	Reports error information during a crypto operation.
on_notification	This 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.


TempPath	Path for storing temporary files.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.