PublicKeyCrypto Class
Properties Methods Events Configuration Settings Errors
The PublicKeyCrypto class supports encrypting, decrypting, signing and verifying messages.
Syntax
SecureBlackboxLitePublicKeyCrypto
SecureBlackboxLitePublicKeyCryptoSwift
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.
- canEncrypt | Returns true if the crypto object can be used for encryption. |
- canSign | Returns true if the crypto object is capable of data signing. |
- hashAlgorithm | The hash algorithm to be used during the crypto operation. |
- inputEncoding | The encoding to apply to the input data. |
- inputIsHash | Indicates whether the input data contains the hash or the actual data. |
- jsonKeyHeaderParams | Contains key header parameters. |
- jsonProtectedHeader | Provides access to the header being protected. |
- jsonUnprotectedHeader | Provides access to the unprotected part of the header. |
- jsonUnprotectedHeaderParams | Contains unprotected header parameters. |
- keyAlgorithm | The algorithm of the cryptographic key. |
- keyBits | The length of the key in bits. |
- keyExportable | Returns True if the key is exportable (can be serialized into an array of bytes), and False otherwise. |
- keyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
- keyID | Provides access to a storage-specific key identifier. |
- keyIV | The initialization vector (IV) of a symmetric key. |
- keyKey | The byte array representation of the key. |
- keyNonce | A nonce value associated with a key. |
- keyPrivate | Returns True if the object hosts a private key, and False otherwise. |
- keyPublic | Returns True if the object hosts a public key, and False otherwise. |
- keySubject | Returns the key subject. |
- keySymmetric | Returns True if the object contains a symmetric key, and False otherwise. |
- keyValid | Returns True if this key is valid. |
- outputEncoding | The encoding type to apply to the output data. |
- scheme | The algorithm scheme to use. |
- schemeParams | The algorithm scheme parameters to employ. |
- signatureValidationResult | 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. |
- decryptFile | Decrypts a file. |
- encrypt | Encrypts a buffer. |
- encryptFile | Encrypts a file. |
- sign | Signs a buffer. |
- signFile | Signs a file. |
- verify | Verifies an enveloped or enveloping signature contained in a buffer. |
- verifyDetached | Verifies a detached signature. |
- verifyDetachedFile | Verifies a detached signature. |
- verifyFile | 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.
- onError | Reports error information during a crypto operation. |
- onNotification | 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. |