PublicKeyCrypto Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SecureBlackbox.Publickeycrypto

Remarks

PublicKeyCrypto allows you to encrypt, decrypt, sign and verify uninterpreted data. It implements low-level, or "raw" cryptographic primitives, such as RSA-PKCS1. The cryptographic primitives are typically used internally in higher-level protocols, such as CMS or PGP.

Cryptographic primitives work on small quantities of data (up to a few kilobytes). If you are looking to encrypt or sign large blobs of data, it is very likely that you need to use higher-level classes, such as MessageEncryptor, CAdESSigner, or PGPWriter.

A code snippet below illustrates the use of PublicKeyCrypto to encrypt (and decrypt) a data piece with OpenSSL-generated RSA keypair. procedure TForm1.HandleKeyPasswordNeeded(Sender: TObject; const NeededFor: String; var Password: String; var Cancel: Boolean); begin Password := 'key-password'; end; procedure TForm1.btnRSAEncryptClick(Sender: TObject); var Crypto : TsbxPublicKeyCrypto; KeyMgr : TsbxCryptoKeyManager; Plaintext, Ciphertext, Decrypted : TBytes; begin // prep Plaintext := TEncoding.UTF8.GetBytes('Hello, World!'); // encryption KeyMgr := TsbxCryptoKeyManager.Create(nil); try KeyMgr.ImportFromFile('public.pem', kffPEM, '', '', '', ktPublic); Crypto := TsbxPublicKeyCrypto.Create(nil); try Crypto.Key := KeyMgr.Key; Ciphertext := Crypto.Encrypt(Plaintext); finally FreeAndNil(Crypto); end; finally FreeAndNil(KeyMgr); end; // decryption KeyMgr := TsbxCryptoKeyManager.Create(nil); try KeyMgr.OnPasswordNeeded := HandleKeyPasswordNeeded; KeyMgr.ImportFromFile('private.pem', kffPEM, '', '', '', ktSecret); Crypto := TsbxPublicKeyCrypto.Create(nil); try Crypto.Key := KeyMgr.Key; Decrypted := Crypto.Decrypt(Ciphertext); finally FreeAndNil(Crypto); end; finally FreeAndNil(KeyMgr); end; ShowMessage(TEncoding.UTF8.GetString(Decrypted)); end;

Property List

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

Method List

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

Event List

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

Config Settings

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

CanEncrypt Property (PublicKeyCrypto Module)

Returns true if the crypto object can be used for encryption.

Syntax

• Swift
• Objective-C

public var canEncrypt: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=canEncrypt) BOOL canEncrypt;

- (BOOL)canEncrypt;

Default Value

False

Remarks

This property returns true if the crypto object can be used for encryption and decryption. This capability depends on the cryptographic algorithm.

This property is read-only.

CanSign Property (PublicKeyCrypto Module)

Returns true if the crypto object is capable of data signing.

Syntax

• Swift
• Objective-C

public var canSign: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=canSign) BOOL canSign;

- (BOOL)canSign;

Default Value

False

Remarks

This property returns true if the crypto object can be used for signing data and validating signatures. This capability depends on the cryptographic algorithm.

This property is read-only.

FIPSMode Property (PublicKeyCrypto Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

HashAlgorithm Property (PublicKeyCrypto Module)

The hash algorithm to be used during the crypto operation.

Syntax

• Swift
• Objective-C

public var hashAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=hashAlgorithm,setter=setHashAlgorithm:) NSString* hashAlgorithm;

- (NSString*)hashAlgorithm;
- (void)setHashAlgorithm :(NSString*)newHashAlgorithm;

Default Value

"SHA256"

Remarks

Use this property to adjust the hash to be used during the cryptographic operation. This typically applies to signing and verification, but can also apply to more complex encryption primitives, such as RSA-OEAP.

InputEncoding Property (PublicKeyCrypto Module)

The encoding to apply to the input data.

Syntax

• Swift
• Objective-C

public var inputEncoding: PublickeycryptoInputEncodings {
  get {...}
  set {...}
}

public enum PublickeycryptoInputEncodings: Int32 {
  case cetDefault = 0
  case cetBinary = 1
  case cetBase64 = 2
  case cetCompact = 3
  case cetJSON = 4
}

@property (nonatomic,readwrite,assign,getter=inputEncoding,setter=setInputEncoding:) int inputEncoding;

- (int)inputEncoding;
- (void)setInputEncoding :(int)newInputEncoding;

Default Value

0

Remarks

Use this property to specify the encoding to apply to the input data.

InputIsHash Property (PublicKeyCrypto Module)

Indicates whether the input data contains the hash or the actual data.

Syntax

• Swift
• Objective-C

public var inputIsHash: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputIsHash,setter=setInputIsHash:) BOOL inputIsHash;

- (BOOL)inputIsHash;
- (void)setInputIsHash :(BOOL)newInputIsHash;

Default Value

False

Remarks

Set this property to true to tell the class that the data you are passing to it is the hash of the data, rather than the actual (unhashed) data. If this property is set to false, class will hash the provided data internally if it is assumed by the algorithm.

JsonDetails Property (PublicKeyCrypto Module)

Provides a container for JSON settings.

Syntax

• Swift
• Objective-C

public var jsonDetails: JWSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=jsonKeyHeaderParams,setter=setJsonKeyHeaderParams:) NSString* jsonKeyHeaderParams;

- (NSString*)jsonKeyHeaderParams;
- (void)setJsonKeyHeaderParams :(NSString*)newJsonKeyHeaderParams;

@property (nonatomic,readwrite,assign,getter=jsonProtectedHeader,setter=setJsonProtectedHeader:) NSString* jsonProtectedHeader;

- (NSString*)jsonProtectedHeader;
- (void)setJsonProtectedHeader :(NSString*)newJsonProtectedHeader;

@property (nonatomic,readwrite,assign,getter=jsonUnprotectedHeader,setter=setJsonUnprotectedHeader:) NSString* jsonUnprotectedHeader;

- (NSString*)jsonUnprotectedHeader;
- (void)setJsonUnprotectedHeader :(NSString*)newJsonUnprotectedHeader;

@property (nonatomic,readwrite,assign,getter=jsonUnprotectedHeaderParams,setter=setJsonUnprotectedHeaderParams:) NSString* jsonUnprotectedHeaderParams;

- (NSString*)jsonUnprotectedHeaderParams;
- (void)setJsonUnprotectedHeaderParams :(NSString*)newJsonUnprotectedHeaderParams;

 

Default Value

0

Remarks

Use this property when using JSON Web Encryption/Signature to tune up the JSON parameters.

This property is read-only.

Key Property (PublicKeyCrypto Module)

The key to employ for the crypto operation.

Syntax

• Swift
• Objective-C

public var key: CryptoKey {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=keyAlgorithm,setter=setKeyAlgorithm:) NSString* keyAlgorithm;

- (NSString*)keyAlgorithm;
- (void)setKeyAlgorithm :(NSString*)newKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=keyBits) int keyBits;

- (int)keyBits;

@property (nonatomic,readwrite,assign,getter=keyCurve,setter=setKeyCurve:) NSString* keyCurve;

- (NSString*)keyCurve;
- (void)setKeyCurve :(NSString*)newKeyCurve;

@property (nonatomic,readonly,assign,getter=keyExportable) BOOL keyExportable;

- (BOOL)keyExportable;

@property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle;

- (long long)keyHandle;
- (void)setKeyHandle :(long long)newKeyHandle;

@property (nonatomic,readwrite,assign,getter=keyID,setter=setKeyID:) NSData* keyID;

- (NSData*)keyID;
- (void)setKeyID :(NSData*)newKeyID;

@property (nonatomic,readwrite,assign,getter=keyIV,setter=setKeyIV:) NSData* keyIV;

- (NSData*)keyIV;
- (void)setKeyIV :(NSData*)newKeyIV;

@property (nonatomic,readonly,assign,getter=keyKey) NSData* keyKey;

- (NSData*)keyKey;

@property (nonatomic,readwrite,assign,getter=keyNonce,setter=setKeyNonce:) NSData* keyNonce;

- (NSData*)keyNonce;
- (void)setKeyNonce :(NSData*)newKeyNonce;

@property (nonatomic,readonly,assign,getter=keyPrivate) BOOL keyPrivate;

- (BOOL)keyPrivate;

@property (nonatomic,readonly,assign,getter=keyPublic) BOOL keyPublic;

- (BOOL)keyPublic;

@property (nonatomic,readwrite,assign,getter=keySubject,setter=setKeySubject:) NSData* keySubject;

- (NSData*)keySubject;
- (void)setKeySubject :(NSData*)newKeySubject;

@property (nonatomic,readonly,assign,getter=keySymmetric) BOOL keySymmetric;

- (BOOL)keySymmetric;

@property (nonatomic,readonly,assign,getter=keyValid) BOOL keyValid;

- (BOOL)keyValid;

 

Default Value

0

Remarks

Use this property to specify the key to perform the crypto operation with.

Please note that the key assigned should be of a proper type (a public key, not a symmetric key), have a proper set of capabilities (signing and/or encryption), and include its private part for signing and decryption operations.

This property is read-only.

OutputEncoding Property (PublicKeyCrypto Module)

The encoding type to apply to the output data.

Syntax

• Swift
• Objective-C

public var outputEncoding: PublickeycryptoOutputEncodings {
  get {...}
  set {...}
}

public enum PublickeycryptoOutputEncodings: Int32 {
  case cetDefault = 0
  case cetBinary = 1
  case cetBase64 = 2
  case cetCompact = 3
  case cetJSON = 4
}

@property (nonatomic,readwrite,assign,getter=outputEncoding,setter=setOutputEncoding:) int outputEncoding;

- (int)outputEncoding;
- (void)setOutputEncoding :(int)newOutputEncoding;

Default Value

0

Remarks

Use this property to specify the encoding type to apply to the protected data.

Scheme Property (PublicKeyCrypto Module)

The algorithm scheme to use.

Syntax

• Swift
• Objective-C

public var scheme: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=scheme,setter=setScheme:) NSString* scheme;

- (NSString*)scheme;
- (void)setScheme :(NSString*)newScheme;

Default Value

""

Remarks

Certain asymmetric algorithms are often accompanied with a specific algorithm scheme. Two typical examples are RSA's own OAEP and PSS schemes. Use this property to tune up the scheme to use. Leave it empty to proceed with the standard scheme (such as PKCS#1-v1.5 for RSA). Supported schemes:

RSA: PKCS#1, PSS, OAEP, SSL3

ECDSA: ed25519, ed448, ed25519ph, ed448ph

SchemeParams Property (PublicKeyCrypto Module)

The algorithm scheme parameters to employ.

Syntax

• Swift
• Objective-C

public var schemeParams: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=schemeParams,setter=setSchemeParams:) NSString* schemeParams;

- (NSString*)schemeParams;
- (void)setSchemeParams :(NSString*)newSchemeParams;

Default Value

""

Remarks

Use this property to specify the parameters of the algorithm scheme if needed.

SignatureValidationResult Property (PublicKeyCrypto Module)

The signature validation result.

Syntax

• Swift
• Objective-C

public var signatureValidationResult: PublickeycryptoSignatureValidationResults {
  get {...}
}

public enum PublickeycryptoSignatureValidationResults: Int32 {
  case svtValid = 0
  case svtUnknown = 1
  case svtCorrupted = 2
  case svtSignerNotFound = 3
  case svtFailure = 4
}

@property (nonatomic,readonly,assign,getter=signatureValidationResult) int signatureValidationResult;

- (int)signatureValidationResult;

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

This property is read-only.

Config Method (PublicKeyCrypto Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (PublicKeyCrypto Module)

Decrypts a buffer.

Syntax

• Swift
• Objective-C

public func decrypt(buffer: Data) throws -> Data

- (NSData*)decrypt:(NSData*)buffer;

Remarks

Use this method to decrypt a byte array and get the encrypted message in another byte array.

Specify the decryption key in Key property before calling this method.

DecryptFile Method (PublicKeyCrypto Module)

Decrypts a file.

Syntax

• Swift
• Objective-C

public func decryptFile(sourceFile: String, destFile: String) throws -> Void

- (void)decryptFile:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to decrypt an encrypted file and save the decrypted data to another file.

Specify the decryption key in Key property before calling this method.

DoAction Method (PublicKeyCrypto Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Encrypt Method (PublicKeyCrypto Module)

Encrypts a buffer.

Syntax

• Swift
• Objective-C

public func encrypt(buffer: Data) throws -> Data

- (NSData*)encrypt:(NSData*)buffer;

Remarks

Use this method to encrypt a byte array and get the protected message in another byte array.

Specify the encryption key in the Key property before commencing encryption.

EncryptFile Method (PublicKeyCrypto Module)

Encrypts a file.

Syntax

• Swift
• Objective-C

public func encryptFile(sourceFile: String, destFile: String) throws -> Void

- (void)encryptFile:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to encrypt a file and save the protected message to another file.

Specify the encryption key in Key property before commencing encryption.

Sign Method (PublicKeyCrypto Module)

Signs a buffer.

Syntax

• Swift
• Objective-C

public func sign(buffer: Data, detached: Bool) throws -> Data

- (NSData*)sign:(NSData*)buffer :(BOOL)detached;

Remarks

Use this method to sign a byte array and get the protected message in another byte array. Set the Detached parameter to false to create an enveloped/enveloping, rather than detached signature. Please note that certain signature algorithms/kinds only support detached signing.

Specify the signing key in Key property before commencing the signing.

Please note that the key assigned must have a private key part.

SignFile Method (PublicKeyCrypto Module)

Signs a file.

Syntax

• Swift
• Objective-C

public func signFile(sourceFile: String, destFile: String, detached: Bool) throws -> Void

- (void)signFile:(NSString*)sourceFile :(NSString*)destFile :(BOOL)detached;

Remarks

Use this method to sign a file and save the protected message to another file.

Specify the signing key in Key property before the signing. Please make sure the assigned key has a private key associated with it.

Set Detached parameter to false to create an enveloped/enveloping signature. This may not be supported by certain algorithms or encryption modes.

Verify Method (PublicKeyCrypto Module)

Verifies an enveloped or enveloping signature contained in a buffer.

Syntax

• Swift
• Objective-C

public func verify(buffer: Data) throws -> Data

- (NSData*)verify:(NSData*)buffer;

Remarks

Use this method to verify an enveloped or enveloping signature contained in a byte array. The method verifies the signature and extracts the original signed content into another byte array.

The validation result is stored in SignatureValidationResult property.

Use VerifyDetached to verify detached signatures.

Specify the verification key in the Key property before commencing verification.

VerifyDetached Method (PublicKeyCrypto Module)

Verifies a detached signature.

Syntax

• Swift
• Objective-C

public func verifyDetached(signedData: Data, signature: Data) throws -> Void

- (void)verifyDetached:(NSData*)signedData :(NSData*)signature;

Remarks

Use this method to verify a detached signature. Pass the original message via the SignedData parameter, and the signature via the Signature parameter.

The validation result is stored in SignatureValidationResult property.

Provide the verification key in Key property before commencing verification.

VerifyDetachedFile Method (PublicKeyCrypto Module)

Verifies a detached signature.

Syntax

• Swift
• Objective-C

public func verifyDetachedFile(signedDataFile: String, signatureFile: String) throws -> Void

- (void)verifyDetachedFile:(NSString*)signedDataFile :(NSString*)signatureFile;

Remarks

Use this method to verify a detached signature. Pass the original data via the SignedDataFile parameter, and the signature via the SignatureFile parameter.

The validation result is stored in SignatureValidationResult property.

Provide the verification key in Key property.

VerifyFile Method (PublicKeyCrypto Module)

Verifies an enveloped or enveloping signature contained in a file.

Syntax

• Swift
• Objective-C

public func verifyFile(sourceFile: String, destFile: String) throws -> Void

- (void)verifyFile:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to verify an enveloped or enveloping signature and extract the original signed message to another file.

The validation result is stored in SignatureValidationResult property.

Specify the public verification key in Key property before commencing the validation.

Error Event (PublicKeyCrypto Module)

Reports error information during a crypto operation.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

Class fires this event if an error is encountered during a cryptographic operation.

ErrorCode contains an error code and Description contains a textual description of the error that happened.

Notification Event (PublicKeyCrypto Module)

This event notifies the application about an underlying control flow event.

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

public init()

Creates an empty crypto key object.

JWSettings Type

This container represents JSON web security settings.

Remarks

This type contains properties specific to JSON Web Security.

Fields

Constructors

public init()

Creates an json settings object.

Config Settings (PublicKeyCrypto Module)

PublicKeyCrypto Config Settings

Base Config Settings

Trappable Errors (PublicKeyCrypto Module)

PublicKeyCrypto Errors