Struct ipworksencrypt::ECC
Properties Methods Events Config Settings Errors
The ECC (Elliptic Curve Cryptography) struct implements ECDSA, EdDSA, ECDH, and ECIES operations.
Syntax
ipworksencrypt::ECC
Remarks
The ECC (Elliptic Curve Cryptography) struct implements ECDSA (Elliptic Curve Digital Signature Algorithm), EdDSA (Edwards-curve Digital Signature Algorithm), ECDH (Elliptic Curve Diffie Hellman), and ECIES (Elliptic Curve Integrated Encryption Scheme) operations. The struct supports the following common operations:
- create_key allows key creation using algorithms such as secp256r1, secp384r1, secp521r1, X25519, X448, Ed25519, Ed448, and more.
- compute_secret computes a shared secret between two parties using a public and private key (ECDH).
- sign and verify_signature provides a way to digitally sign data and verify signatures (ECDSA and EdDSA).
- encrypt and decrypt encrypt and decrypt data using a public and private key (ECIES).
The struct is very flexible and offers many properties and configuration settings to configure it. The sections below detail the use of the struct for each of the major operations listed above.
Key Creation and Management
create_key creates a new public and private key.
When this method is called, key is populated with the generated key. The key_public_key and key_private_key properties hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.
The KeyAlgorithm parameter specifies the algorithm for which the key is intended to be used. Possible values are:
NIST, Koblitz, and Brainpool Curve Notes
Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters.
The public key consists of the following parameters:
The private key consists of one value:
Curve25519 and Curve448 Notes
Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.
key_xpk holds the public key.
key_xsk holds the private key.
Create Key Example (secp256r1 - PEM)
//Create a key using secp256r1
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (secp256r1 - Raw Key Params)
//Create a key using secp256r1 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
byte[] K = ecc.Key.KB; //Private key param
byte[] Rx = ecc.Key.RxB; //Public key param
byte[] Ry = ecc.Key.RyB; //Public key param
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaSecp256r1; //This MUST be set manually when using key params directly
ecc.Key.KB = K;
ecc.Key.RxB = Rx;
ecc.Key.RyB = Ry;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (Ed25519 - PEM)
//Create a key using Ed25519
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Create Key Example (Ed25519 - Raw Key Params)
//Create a key using Ed25519 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
byte[] XPk = ecc.Key.XPkB; //Public key data
byte[] XSk = ecc.Key.XSkB; //Secret key data
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaEd25519; //This MUST be set manually when using key params directly
ecc.Key.XPkB = XPk;
ecc.Key.XSkB = XSk;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Compute Secret (ECDH)
This method computes a shared secret using Elliptic Curve Diffie Hellman (ECDH).
When this method is called, the struct will use the public key specified by recipient_key_public_key and the private key specified by key to compute a shared secret, or secret agreement. The compute_secret_kdf property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by shared_secret. The following properties are applicable when calling this method:
- key (required)
- recipient_key_public_key (required)
- compute_secret_kdf (optional)
See compute_secret_kdf for details on advanced settings that may be applicable for the chosen algorithm.
Keys created with the Ed25519 and Ed448 algorithms are not supported when calling this method.
Compute Secret Example
//Create a key for Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("X25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Create a key for Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("X25519");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Note: the public keys must be exchanged between parties by some mechanism
//Create the shared secret on Party 1
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv; //Private key of this party
ecc1.RecipientKey.PublicKey = ecc2_pub; //Public key of other party
ecc1.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc1.ComputeSecret();
Console.WriteLine(ecc1.SharedSecret);
//Create the shared secret on Party 2
ecc2.Reset();
ecc2.Key.PrivateKey = ecc2_priv; //Private key of this party
ecc2.RecipientKey.PublicKey = ecc1_pub; //Public key of other party
ecc2.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc2.ComputeSecret();
Console.WriteLine(ecc2.SharedSecret); //This will match the shared secret created by ecc1.
Signing (ECDSA and EdDSA)
sign will create a hash signature using ECDSA or EdDSA. The struct will use the key specified by key to hash the input data and sign the resulting hash.
key must contain a private key created with a valid ECDSA or EdDSA algorithm. key_algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for signing are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
- Ed25519 and Ed448
See create_key for details about key creation and algorithms.
When this method is called, data will be read from the input_file or input_message.
The hash to be signed will be computed using the specified hash_algorithm. The computed hash is stored in the hash_value property. The signed hash is stored in the hash_signature property.
To sign a hash without first computing it, set hash_value to a previously computed hash for the input data. Note: hash_value is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448.
The on_progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.
After calling sign, the public key must be sent to the recipient along with hash_signature and the original input data so the other party may perform signature verification.
The following properties are applicable when calling this method:
- key (required)
- hash_algorithm (applicable to ECDSA only)
- hash_ed_dsa (applicable to EdDSA only)
- hash_value (not applicable to PureEdDSA)
- use_hex
The following properties are populated after calling this method:
When the key_algorithm is Ed25519 or Ed448, the following additional parameters are applicable:
EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the hash_ed_dsa property. By default, the struct uses the PureEdDSA algorithm.
The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, hash_value is not applicable.
When using a HashEdDSA algorithm, the input is pre-hashed and supports a single pass over the data during the signing operation. To enable HashEdDSA, set hash_ed_dsa to True.
To specify context data when using Ed25519 or Ed448, set EdDSAContext.
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - PureEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - HashEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.HashEdDSA = true; //Use "ed25519ph"
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.HashEdDSA = true;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Verifying (ECDSA and EdDSA)
verify_signature will verify a hash signature and return True if successful or False otherwise.
Before calling this method, specify the input file by setting input_file or input_message.
A public key and the hash signature are required to perform the signature verification. Specify the public key in signer_key. Specify the hash signature in hash_signature.
When this method is called, the struct will compute the hash for the specified file and populate hash_value. It will verify the signature using the specified signer_key and hash_signature.
To verify the hash signature without first computing the hash, simply specify hash_value before calling this method. Note: hash_value is not applicable when the message was signed with a PureEdDSA algorithm such as Ed25519 or Ed448.
The on_progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.
The following properties are applicable when calling this method:
- hash_signature (required)
- signer_key (required)
- EdDSAContext (applicable to EdDSA only)
- hash_algorithm (applicable to ECDSA only)
- hash_ed_dsa (applicable to EdDSA only)
- hash_value (not applicable to PureEdDSA)
- use_hex
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - PureEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - HashEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.HashEdDSA = true; //Use "ed25519ph"
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.HashEdDSA = true;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Encrypting (ECIES)
encrypt encrypts the specified data with the ECDSA public key specified in recipient_key.
Encryption is performed using ECIES which requires an ECDSA key. recipient_key must contain an ECDSA key. key_algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See create_key for details about key creation and algorithms.
When this method is called, the struct will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output, set use_hex to True.
The following properties are applicable when calling this method:
- encryption_algorithm
- hmac_algorithm
- HMACOptionalInfo
- HMACKeySize
- iv
- kdf
- kdf_hash_algorithm
- KDFOptionalInfo
- use_hex
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Decrypting (ECIES)
decrypt decrypts the specified data with the ECDSA private key specified in key.
Decryption is performed using ECIES which requires an ECDSA key. key must contain an ECDSA key. key_algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See create_key for details about key creation and algorithms.
When this method is called, the struct will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set use_hex to True.
The following properties are applicable when calling this method:
- encryption_algorithm
- hmac_algorithm
- HMACOptionalInfo
- HMACKeySize
- iv
- kdf
- kdf_hash_algorithm
- KDFOptionalInfo
- use_hex
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Object Lifetime
The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the ECC struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of ECC when you have finished using the instance.
Property List
The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.
| cert_effective_date | The date on which this certificate becomes valid. |
| cert_expiration_date | The date on which the certificate expires. |
| cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| cert_issuer | The issuer of the certificate. |
| cert_private_key | The private key of the certificate (if available). |
| cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| cert_public_key | The public key of the certificate. |
| cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| cert_public_key_length | The length of the certificate's public key (in bits). |
| cert_serial_number | The serial number of the certificate encoded as a string. |
| cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| cert_store | The name of the certificate store for the client certificate. |
| cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| cert_store_type | The type of certificate store for this certificate. |
| cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| cert_thumbprint_md5 | The MD5 hash of the certificate. |
| cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| cert_usage | The text description of UsageFlags . |
| cert_usage_flags | The flags that show intended use for the certificate. |
| cert_version | The certificate's version number. |
| cert_subject | The subject of the certificate used for client authentication. |
| cert_encoded | The certificate (PEM/Base64 encoded). |
| compute_secret_kdf | The key derivation function. |
| encryption_algorithm | The encryption algorithm to use. |
| hash_algorithm | The hash algorithm used for hash computation. |
| hash_ed_dsa | Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key. |
| hash_signature | The hash signature. |
| hash_value | The hash value of the data. |
| hmac_algorithm | The HMAC algorithm to use during encryption. |
| input_file | The file to process. |
| input_message | The message to process. |
| iv | The initialization vector (IV) used when encrypting. |
| kdf | The key derivation function used during encryption and decryption. |
| kdf_hash_algorithm | The KDF hash algorithm to use when encrypting and decrypting. |
| key_algorithm | This property holds the algorithm associated with the key. |
| key_k | Represents the private key (K) parameter. |
| key_private_key | This property is a PEM formatted private key. |
| key_public_key | This property is a PEM formatted public key. |
| key_rx | Represents the public key's Rx parameter. |
| key_ry | Represents the public key's Ry parameter. |
| key_xpk | Holds the public key data. |
| key_xsk | Holds the private key data. |
| output_file | The output file when encrypting or decrypting. |
| output_message | The output message when encrypting or decrypting. |
| overwrite | Indicates whether or not the struct should overwrite files. |
| recipient_cert_effective_date | The date on which this certificate becomes valid. |
| recipient_cert_expiration_date | The date on which the certificate expires. |
| recipient_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| recipient_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| recipient_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| recipient_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| recipient_cert_issuer | The issuer of the certificate. |
| recipient_cert_private_key | The private key of the certificate (if available). |
| recipient_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| recipient_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| recipient_cert_public_key | The public key of the certificate. |
| recipient_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| recipient_cert_public_key_length | The length of the certificate's public key (in bits). |
| recipient_cert_serial_number | The serial number of the certificate encoded as a string. |
| recipient_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| recipient_cert_store | The name of the certificate store for the client certificate. |
| recipient_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| recipient_cert_store_type | The type of certificate store for this certificate. |
| recipient_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| recipient_cert_thumbprint_md5 | The MD5 hash of the certificate. |
| recipient_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| recipient_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| recipient_cert_usage | The text description of UsageFlags . |
| recipient_cert_usage_flags | The flags that show intended use for the certificate. |
| recipient_cert_version | The certificate's version number. |
| recipient_cert_subject | The subject of the certificate used for client authentication. |
| recipient_cert_encoded | The certificate (PEM/Base64 encoded). |
| recipient_key_algorithm | This property holds the algorithm associated with the key. |
| recipient_key_public_key | This property is a PEM formatted public key. |
| recipient_key_rx | Represents the public key's Rx parameter. |
| recipient_key_ry | Represents the public key's Ry parameter. |
| recipient_key_xpk | Holds the public key data. |
| shared_secret | The computed shared secret. |
| signer_cert_effective_date | The date on which this certificate becomes valid. |
| signer_cert_expiration_date | The date on which the certificate expires. |
| signer_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
| signer_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| signer_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| signer_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| signer_cert_issuer | The issuer of the certificate. |
| signer_cert_private_key | The private key of the certificate (if available). |
| signer_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
| signer_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
| signer_cert_public_key | The public key of the certificate. |
| signer_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
| signer_cert_public_key_length | The length of the certificate's public key (in bits). |
| signer_cert_serial_number | The serial number of the certificate encoded as a string. |
| signer_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
| signer_cert_store | The name of the certificate store for the client certificate. |
| signer_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| signer_cert_store_type | The type of certificate store for this certificate. |
| signer_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
| signer_cert_thumbprint_md5 | The MD5 hash of the certificate. |
| signer_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
| signer_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
| signer_cert_usage | The text description of UsageFlags . |
| signer_cert_usage_flags | The flags that show intended use for the certificate. |
| signer_cert_version | The certificate's version number. |
| signer_cert_subject | The subject of the certificate used for client authentication. |
| signer_cert_encoded | The certificate (PEM/Base64 encoded). |
| signer_key_algorithm | This property holds the algorithm associated with the key. |
| signer_key_public_key | This property is a PEM formatted public key. |
| signer_key_rx | Represents the public key's Rx parameter. |
| signer_key_ry | Represents the public key's Ry parameter. |
| signer_key_xpk | Holds the public key data. |
| use_hex | Whether binary values are hex encoded. |
Method List
The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.
| compute_secret | Computes a shared secret. |
| config | Sets or retrieves a configuration setting. |
| create_key | Creates a new key. |
| decrypt | Decrypted the specified data. |
| encrypt | Encrypts the specified data. |
| reset | Resets the struct. |
| sign | Creates a hash signature using ECDSA or EdDSA. |
| verify_signature | Verifies the signature for the specified data. |
Event List
The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.
| on_error | Fired when information is available about errors during data delivery. |
| on_progress | Fired as progress is made. |
Config Settings
The following is a list of config settings for the struct with short descriptions. Click on the links for further details.
| AppendSecret | An optional string to append to the secret agreement. |
| CNGECDHKey | The CNG ECDH key. |
| CNGECDSAKey | The CNG ECDSA key. |
| ConcatAlgorithmId | The AlgorithmId subfield of the OtherInfo field. |
| ConcatHashAlgorithm | The hash algorithm to use when ComputeSecretKDF is Concat. |
| ConcatPartyUInfo | The PartyUInfo subfield of the OtherInfo field. |
| ConcatPartyVInfo | The PartyVInfo subfield of the OtherInfo field. |
| ConcatSuppPrivInfo | The SuppPrivInfo subfield of the OtherInfo field. |
| ConcatSuppPubInfo | The SuppPubInfo subfield of the OtherInfo field. |
| ECDSASignatureFormat | The format of the HashSignature when using ECDSA keys. |
| EdDSAContext | A hex encoded string holding the bytes of the context when signing or verifying with Ed25519ctx. |
| EncryptionKeySize | The encryption key size. |
| HMACKey | A key to use when generating a Hash-based Message Authentication Code (HMAC). |
| HMACKeySize | The HMAC key size to be used during encryption. |
| HMACOptionalInfo | Optional data to be used during encryption and decryption during the HMAC step. |
| KDFOptionalInfo | Optional data to be used during encryption and decryption during the key derivation step. |
| PrependSecret | An optional string to prepend to the secret agreement. |
| RawY | The raw Y coordinate value. |
| StrictKeyValidation | Whether to validate provided public keys based on private keys. |
| TLSLabel | The TLS PRF label. |
| TLSSeed | The TLS PRF Seed. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
cert_effective_date property (ECC Struct)
The date on which this certificate becomes valid.
Syntax
fn cert_effective_date(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
cert_expiration_date property (ECC Struct)
The date on which the certificate expires.
Syntax
fn cert_expiration_date(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
cert_extended_key_usage property (ECC Struct)
A comma-delimited list of extended key usage identifiers.
Syntax
fn cert_extended_key_usage(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
cert_fingerprint property (ECC Struct)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
fn cert_fingerprint(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
cert_fingerprint_sha1 property (ECC Struct)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
fn cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
cert_fingerprint_sha256 property (ECC Struct)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
fn cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
cert_issuer property (ECC Struct)
The issuer of the certificate.
Syntax
fn cert_issuer(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
cert_private_key property (ECC Struct)
The private key of the certificate (if available).
Syntax
fn cert_private_key(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The cert_private_key may be available but not exportable. In this case, cert_private_key returns an empty string.
This property is read-only.
Data Type
String
cert_private_key_available property (ECC Struct)
Whether a PrivateKey is available for the selected certificate.
Syntax
fn cert_private_key_available(&self ) -> Result<bool, IPWorksEncryptError>
Default Value
false
Remarks
Whether a cert_private_key is available for the selected certificate. If cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
cert_private_key_container property (ECC Struct)
The name of the PrivateKey container for the certificate (if available).
Syntax
fn cert_private_key_container(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The name of the cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
cert_public_key property (ECC Struct)
The public key of the certificate.
Syntax
fn cert_public_key(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
cert_public_key_algorithm property (ECC Struct)
The textual description of the certificate's public key algorithm.
Syntax
fn cert_public_key_algorithm(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
cert_public_key_length property (ECC Struct)
The length of the certificate's public key (in bits).
Syntax
fn cert_public_key_length(&self ) -> Result<i32, IPWorksEncryptError>
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
i32
cert_serial_number property (ECC Struct)
The serial number of the certificate encoded as a string.
Syntax
fn cert_serial_number(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
cert_signature_algorithm property (ECC Struct)
The text description of the certificate's signature algorithm.
Syntax
fn cert_signature_algorithm(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
cert_store property (ECC Struct)
The name of the certificate store for the client certificate.
Syntax
fn cert_store(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_cert_store(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_cert_store_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password-protected, specify the password in cert_store_password.
cert_store is used in conjunction with the cert_subject property to specify client certificates. If cert_store has a value, and cert_subject or cert_encoded is set, a search for a certificate is initiated. Please see the cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Vec
cert_store_password property (ECC Struct)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
fn cert_store_password(&self ) -> Result<String, IPWorksEncryptError>
fn set_cert_store_password(&self, value : &str) -> Option<IPWorksEncryptError> fn set_cert_store_password_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
cert_store_type property (ECC Struct)
The type of certificate store for this certificate.
Syntax
fn cert_store_type(&self ) -> Result<i32, IPWorksEncryptError>
fn set_cert_store_type(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the cert_store_type, the full path of the PKCS#11 DLL as the cert_store, and the PIN as the cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
i32
cert_subject_alt_names property (ECC Struct)
Comma-separated lists of alternative subject names for the certificate.
Syntax
fn cert_subject_alt_names(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
cert_thumbprint_md5 property (ECC Struct)
The MD5 hash of the certificate.
Syntax
fn cert_thumbprint_md5(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
cert_thumbprint_sha1 property (ECC Struct)
The SHA-1 hash of the certificate.
Syntax
fn cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
cert_thumbprint_sha256 property (ECC Struct)
The SHA-256 hash of the certificate.
Syntax
fn cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
cert_usage property (ECC Struct)
The text description of UsageFlags .
Syntax
fn cert_usage(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The text description of cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
cert_usage_flags property (ECC Struct)
The flags that show intended use for the certificate.
Syntax
fn cert_usage_flags(&self ) -> Result<i32, IPWorksEncryptError>
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of cert_usage_flags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the cert_usage property for a text representation of cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
i32
cert_version property (ECC Struct)
The certificate's version number.
Syntax
fn cert_version(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
cert_subject property (ECC Struct)
The subject of the certificate used for client authentication.
Syntax
fn cert_subject(&self ) -> Result<String, IPWorksEncryptError>
fn set_cert_subject(&self, value : &str) -> Option<IPWorksEncryptError> fn set_cert_subject_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
cert_encoded property (ECC Struct)
The certificate (PEM/Base64 encoded).
Syntax
fn cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_cert_encoded(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_cert_encoded_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The cert_store and cert_subject properties also may be used to specify a certificate.
When cert_encoded is set, a search is initiated in the current cert_store for the private key of the certificate. If the key is found, cert_subject is updated to reflect the full subject of the selected certificate; otherwise, cert_subject is set to an empty string.
Data Type
Vec
compute_secret_kdf property (ECC Struct)
The key derivation function.
Syntax
fn compute_secret_kdf(&self ) -> Result<i32, IPWorksEncryptError>
fn set_compute_secret_kdf(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // SHA1
1 // SHA256
2 // SHA384
3 // SHA512
4 // MD2
5 // MD4
6 // MD5
7 // HMACSHA1
8 // HMACSHA256
9 // HMACSHA384
10 // HMACSHA512
11 // HMACMD5
12 // TLS
13 // Concat
99 // Raw
Default Value
1
Remarks
This property specifies the key derivation function (KDF) and algorithm to use when calling compute_secret.
Possible values are:
| 0 (ekdSHA1) | SHA-1 |
| 1 (ekdSHA256 - default) | SHA-256 |
| 2 (ekdSHA384) | SHA-384 |
| 3 (ekdSHA512) | SHA-512 |
| 4 (ekdMD2) | MD2 |
| 5 (ekdMD4) | MD4 |
| 6 (ekdMD5) | MD5 |
| 7 (ekdHMACSHA1) | HMAC-SHA1 |
| 8 (ekdHMACSHA256) | HMAC-SHA256 |
| 9 (ekdHMACSHA384) | HMAC-SHA384 |
| 10 (ekdHMACSHA512) | HMAC-SHA512 |
| 11 (ekdHMACMD5) | HMAC-MD5 |
| 12 (ekdTLS) | TLS |
| 13 (ekdConcat) | Concat |
| 99 (ekdRaw) | Raw |
HMAC Notes
If an HMAC algorithm is selected, HMACKey may optionally be set to specify the key.
TLS Notes
When set to TLS, TLSSeed and TLSLabel are required. In addition, PrependSecret and AppendSecret are not applicable.
Concat Notes
If Concat is selected, the following configuration settings are applicable:
- ConcatAlgorithmId (required)
- ConcatPartyUInfo (required)
- ConcatPartyVInfo (required)
- ConcatSuppPubInfo
- ConcatSuppPrivInfo
- ConcatHashAlgorithm
Raw Mode
If Raw is selected, no secure key derivation function is applied to the value returned in shared_secret. This mode is intended for advanced use cases where access to the raw coordinates of the shared secret is required. In Raw mode:
- The X-coordinate is returned through the shared_secret property.
- The corresponding Y-coordinate is made available via the RawY configuration setting.
This option should be used with caution, as bypassing key derivation may introduce security risks if not handled properly.
Data Type
i32
encryption_algorithm property (ECC Struct)
The encryption algorithm to use.
Syntax
fn encryption_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_encryption_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // AES
1 // TripleDES
2 // XOR
Default Value
0
Remarks
This setting specifies the encryption algorithm to use when encrypt is called. This must also be set before calling decrypt to match the algorithm used during the initial encryption.
Possible values are:
- 0 (iesAES - default)
- 1 (iesTripleDES)
- 2 (iesXOR)
AES Notes
When encryption_algorithm is set to iesAES, AES CBC with a default key size of 256 bits is used. To specify a different key size, set EncryptionKeySize.Data Type
i32
hash_algorithm property (ECC Struct)
The hash algorithm used for hash computation.
Syntax
fn hash_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_hash_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // SHA1
1 // SHA224
2 // SHA256
3 // SHA384
4 // SHA512
5 // MD2
6 // MD4
7 // MD5
8 // MD5SHA1
9 // RIPEMD160
Default Value
2
Remarks
This property specifies the hash algorithm used for hash computation. This is only applicable when calling sign or verify_signature and key_algorithm specifies a ECDSA key (NIST, Koblitz, or Brainpool curve). Possible values are:
| 0 (ehaSHA1) | SHA-1 |
| 1 (ehaSHA224) | SHA-224 |
| 2 (ehaSHA256 - default) | SHA-256 |
| 3 (ehaSHA384) | SHA-384 |
| 4 (ehaSHA512) | SHA-512 |
| 5 (ehaMD2) | MD2 |
| 6 (ehaMD4) | MD4 |
| 7 (ehaMD5) | MD5 |
| 8 (ehaMD5SHA1) | MD5SHA-1 |
| 9 (ehaRIPEMD160) | RIPEMD-160 |
When key_algorithm specifies an EdDSA key, this setting is not applicable as the hash algorithm is defined by the specification as SHA-512 for Ed25519 and SHAKE-256 for Ed448.
Data Type
i32
hash_ed_dsa property (ECC Struct)
Whether to use HashEdDSA when signing with an Ed25519 or Ed448 key.
Syntax
fn hash_ed_dsa(&self ) -> Result<bool, IPWorksEncryptError>
fn set_hash_ed_dsa(&self, value : bool) -> Option<IPWorksEncryptError>
Default Value
false
Remarks
This setting specifies whether to use the HashEdDSA algorithm when signing and verifying with Ed25519 or Ed448 keys.
If set to True, the struct will use the HashEdDSA algorithm (Ed25519ph or Ed448ph) when signing and verifying. When using a HashEdDSA algorithm, the input is pre-hashed and supports a single pass over the data during the signing operation.
If set to False (default), the struct will use the PureEdDSA algorithm (Ed25519 or Ed448) when signing. The PureEdDSA requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure.
This property is only applicable when calling sign and key_algorithm is set to Ed25519 or Ed448.
If this property is set before calling sign, it must be set before calling verify_signature.
Data Type
bool
hash_signature property (ECC Struct)
The hash signature.
Syntax
fn hash_signature(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_hash_signature(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_hash_signature_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property holds the computed hash signature. This is populated after calling sign. This must be set before calling verify_signature.
Data Type
Vec
hash_value property (ECC Struct)
The hash value of the data.
Syntax
fn hash_value(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_hash_value(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_hash_value_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property holds the computed hash value for the specified data. This is populated when calling sign or verify_signature when an input file is specified by setting input_file or input_message.
Pre-existing hash values may be set to this property before calling sign or verify_signature. If you know the hash value prior to using the struct, you may specify the pre-computed hash value here.
This setting is not applicable to PureEdDSA algorithms. If key_algorithm is Ed25519 or Ed448 and hash_ed_dsa is False (default), the PureEdDSA algorithm is used and hash_value is not applicable.
Hash Notes
The struct will determine whether or not to recompute the hash based on the properties that are set. If a file is specified by input_file or input_message, the hash will be recomputed when calling sign or verify_signature. If the hash_value property is set, the struct will only sign the hash or verify the hash signature. Setting input_file or input_message clears the hash_value property. Setting the hash_value property clears the input file selection.
Data Type
Vec
hmac_algorithm property (ECC Struct)
The HMAC algorithm to use during encryption.
Syntax
fn hmac_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_hmac_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // HMACSHA1
1 // HMACSHA224
2 // HMACSHA256
3 // HMACSHA384
4 // HMACSHA512
5 // HMACRIPEMD160
Default Value
2
Remarks
This property specifies the HMAC algorithm to use when encrypting. The HMAC algorithm is used when encrypt and decrypt are called to protect and verify data. Possible values are:
- 0 (iesHMACSHA1)
- 1 (iesHMACSHA224)
- 2 (iesHMACSHA256 - Default)
- 3 (iesHMACSHA384)
- 4 (iesHMACSHA512)
- 5 (iesHMACRIPEMD160)
This property is only applicable when calling encrypt or decrypt.
Data Type
i32
input_file property (ECC Struct)
The file to process.
Syntax
fn input_file(&self ) -> Result<String, IPWorksEncryptError>
fn set_input_file(&self, value : &str) -> Option<IPWorksEncryptError> fn set_input_file_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- input_file
- input_message
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Data Type
String
input_message property (ECC Struct)
The message to process.
Syntax
fn input_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_input_message(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_input_message_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property specifies the message to be processed.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- input_file
- input_message
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Data Type
Vec
iv property (ECC Struct)
The initialization vector (IV) used when encrypting.
Syntax
fn iv(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_iv(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_iv_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property optionally specifies an IV to be used when calling encrypt or decrypt. If specified, the iv is used by encryption_algorithm during encryption.
If not specified, the struct will create an IV filled with null bytes (zeros). Since the encryption key is only used once, the use of null bytes in the IV is considered acceptable and is a standard practice.
The length of the IV should be as follows:
| encryption_algorithm | IV Length (in bytes) |
| AES | 16 |
| 3DES | 8 |
This setting is not applicable when encryption_algorithm is set to XOR.
Data Type
Vec
kdf property (ECC Struct)
The key derivation function used during encryption and decryption.
Syntax
fn kdf(&self ) -> Result<String, IPWorksEncryptError>
fn set_kdf(&self, value : &str) -> Option<IPWorksEncryptError> fn set_kdf_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
"KDF2"
Remarks
This property specifies the key derivation function (KDF) to use when encrypting and decrypting. Possible values are:
- "KDF1"
- "KDF2" (default)
This property is only applicable when calling encrypt or decrypt.
Data Type
String
kdf_hash_algorithm property (ECC Struct)
The KDF hash algorithm to use when encrypting and decrypting.
Syntax
fn kdf_hash_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_kdf_hash_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // SHA1
1 // SHA224
2 // SHA256
3 // SHA384
4 // SHA512
Default Value
2
Remarks
This property specifies the hash algorithm to use when deriving a key using the specified kdf. Possible values are:
- 0 (iesSHA1)
- 1 (iesSHA224)
- 2 (iesSHA256)
- 3 (iesSHA384)
- 4 (iesSHA512)
This property is only applicable when calling encrypt or decrypt.
Data Type
i32
key_algorithm property (ECC Struct)
This property holds the algorithm associated with the key.
Syntax
fn key_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_key_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // Secp256r1
1 // Secp384r1
2 // Secp521r1
3 // Ed25519
4 // Ed448
5 // X25519
6 // X448
7 // Secp160k1
8 // Secp192k1
9 // Secp224k1
10 // Secp256k1
11 // BrainpoolP160r1
12 // BrainpoolP192r1
13 // BrainpoolP224r1
14 // BrainpoolP256r1
15 // BrainpoolP320r1
16 // BrainpoolP384r1
17 // BrainpoolP512r1
18 // BrainpoolP160t1
19 // BrainpoolP192t1
20 // BrainpoolP224t1
21 // BrainpoolP256t1
22 // BrainpoolP320t1
23 // BrainpoolP384t1
24 // BrainpoolP512t1
Default Value
0
Remarks
This property holds the algorithm associated with the key. Possible values are:
- 0 (eaSecp256r1)
- 1 (eaSecp384r1)
- 2 (eaSecp521r1)
- 3 (eaEd25519)
- 4 (eaEd448)
- 5 (eaX25519)
- 6 (eaX448)
- 7 (eaSecp160k1)
- 8 (eaSecp192k1)
- 9 (eaSecp224k1)
- 10 (eaSecp256k1)
- 11 (eaBrainpoolP160r1)
- 12 (eaBrainpoolP192r1)
- 13 (eaBrainpoolP224r1)
- 14 (eaBrainpoolP256r1)
- 15 (eaBrainpoolP320r1)
- 16 (eaBrainpoolP384r1)
- 17 (eaBrainpoolP512r1)
- 18 (eaBrainpoolP160t1)
- 19 (eaBrainpoolP192t1)
- 20 (eaBrainpoolP224t1)
- 21 (eaBrainpoolP256t1)
- 22 (eaBrainpoolP320t1)
- 23 (eaBrainpoolP384t1)
- 24 (eaBrainpoolP512t1)
When assigning a key using the PEM formatted key_private_key and key_public_key, the key_algorithm property will be automatically updated with the key algorithm.
When assigning a key using the raw key parameters (key_k, key_rx, and key_ry for NIST or key_xpk, and key_xsk for Curve25519/Curve448), the key_algorithm property must be set manually to the key algorithm.
The following table summarizes the supported operations for keys created with each algorithm:
Data Type
i32
key_k property (ECC Struct)
Represents the private key (K) parameter.
Syntax
fn key_k(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_key_k(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_key_k_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the private key (K) parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
key_private_key property (ECC Struct)
This property is a PEM formatted private key.
Syntax
fn key_private_key(&self ) -> Result<String, IPWorksEncryptError>
fn set_key_private_key(&self, value : &str) -> Option<IPWorksEncryptError> fn set_key_private_key_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property is a PEM formatted private key. The purpose of this property is to allow easier management of the private key parameters by using only a single value.
Data Type
String
key_public_key property (ECC Struct)
This property is a PEM formatted public key.
Syntax
fn key_public_key(&self ) -> Result<String, IPWorksEncryptError>
fn set_key_public_key(&self, value : &str) -> Option<IPWorksEncryptError> fn set_key_public_key_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
key_rx property (ECC Struct)
Represents the public key's Rx parameter.
Syntax
fn key_rx(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_key_rx(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_key_rx_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the public key's Rx parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
key_ry property (ECC Struct)
Represents the public key's Ry parameter.
Syntax
fn key_ry(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_key_ry(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_key_ry_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the public key's Ry parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
key_xpk property (ECC Struct)
Holds the public key data.
Syntax
fn key_xpk(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_key_xpk(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_key_xpk_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Holds the public key data.
Note: This value is only applicable when using Curve25519 or Curve448.
Data Type
Vec
key_xsk property (ECC Struct)
Holds the private key data.
Syntax
fn key_xsk(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_key_xsk(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_key_xsk_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Holds the private key data.
Note: This value is only applicable when using Curve25519 or Curve448.
Data Type
Vec
output_file property (ECC Struct)
The output file when encrypting or decrypting.
Syntax
fn output_file(&self ) -> Result<String, IPWorksEncryptError>
fn set_output_file(&self, value : &str) -> Option<IPWorksEncryptError> fn set_output_file_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property specifies the file to which the output will be written when encrypt or decrypt is called. This may be set to an absolute or relative path.
This property is only applicable to encrypt and decrypt.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Data Type
String
output_message property (ECC Struct)
The output message when encrypting or decrypting.
Syntax
fn output_message(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
Default Value
""
Remarks
This property will be populated with the output after calling encrypt or decrypt if output_file is not set.
This property is only applicable to encrypt and decrypt.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
This property is read-only.
Data Type
Vec
overwrite property (ECC Struct)
Indicates whether or not the struct should overwrite files.
Syntax
fn overwrite(&self ) -> Result<bool, IPWorksEncryptError>
fn set_overwrite(&self, value : bool) -> Option<IPWorksEncryptError>
Default Value
false
Remarks
This property indicates whether or not the struct will overwrite output_file. If overwrite is False, an error will be thrown whenever output_file exists before an operation. The default value is False.
Data Type
bool
recipient_cert_effective_date property (ECC Struct)
The date on which this certificate becomes valid.
Syntax
fn recipient_cert_effective_date(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
recipient_cert_expiration_date property (ECC Struct)
The date on which the certificate expires.
Syntax
fn recipient_cert_expiration_date(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
recipient_cert_extended_key_usage property (ECC Struct)
A comma-delimited list of extended key usage identifiers.
Syntax
fn recipient_cert_extended_key_usage(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
recipient_cert_fingerprint property (ECC Struct)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
fn recipient_cert_fingerprint(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
recipient_cert_fingerprint_sha1 property (ECC Struct)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
fn recipient_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
recipient_cert_fingerprint_sha256 property (ECC Struct)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
fn recipient_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
recipient_cert_issuer property (ECC Struct)
The issuer of the certificate.
Syntax
fn recipient_cert_issuer(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
recipient_cert_private_key property (ECC Struct)
The private key of the certificate (if available).
Syntax
fn recipient_cert_private_key(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The recipient_cert_private_key may be available but not exportable. In this case, recipient_cert_private_key returns an empty string.
This property is read-only.
Data Type
String
recipient_cert_private_key_available property (ECC Struct)
Whether a PrivateKey is available for the selected certificate.
Syntax
fn recipient_cert_private_key_available(&self ) -> Result<bool, IPWorksEncryptError>
Default Value
false
Remarks
Whether a recipient_cert_private_key is available for the selected certificate. If recipient_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
recipient_cert_private_key_container property (ECC Struct)
The name of the PrivateKey container for the certificate (if available).
Syntax
fn recipient_cert_private_key_container(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The name of the recipient_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
recipient_cert_public_key property (ECC Struct)
The public key of the certificate.
Syntax
fn recipient_cert_public_key(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
recipient_cert_public_key_algorithm property (ECC Struct)
The textual description of the certificate's public key algorithm.
Syntax
fn recipient_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
recipient_cert_public_key_length property (ECC Struct)
The length of the certificate's public key (in bits).
Syntax
fn recipient_cert_public_key_length(&self ) -> Result<i32, IPWorksEncryptError>
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
i32
recipient_cert_serial_number property (ECC Struct)
The serial number of the certificate encoded as a string.
Syntax
fn recipient_cert_serial_number(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
recipient_cert_signature_algorithm property (ECC Struct)
The text description of the certificate's signature algorithm.
Syntax
fn recipient_cert_signature_algorithm(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
recipient_cert_store property (ECC Struct)
The name of the certificate store for the client certificate.
Syntax
fn recipient_cert_store(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_recipient_cert_store(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_recipient_cert_store_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The recipient_cert_store_type property denotes the type of the certificate store specified by recipient_cert_store. If the store is password-protected, specify the password in recipient_cert_store_password.
recipient_cert_store is used in conjunction with the recipient_cert_subject property to specify client certificates. If recipient_cert_store has a value, and recipient_cert_subject or recipient_cert_encoded is set, a search for a certificate is initiated. Please see the recipient_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Vec
recipient_cert_store_password property (ECC Struct)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
fn recipient_cert_store_password(&self ) -> Result<String, IPWorksEncryptError>
fn set_recipient_cert_store_password(&self, value : &str) -> Option<IPWorksEncryptError> fn set_recipient_cert_store_password_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
recipient_cert_store_type property (ECC Struct)
The type of certificate store for this certificate.
Syntax
fn recipient_cert_store_type(&self ) -> Result<i32, IPWorksEncryptError>
fn set_recipient_cert_store_type(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the recipient_cert_store_type, the full path of the PKCS#11 DLL as the recipient_cert_store, and the PIN as the recipient_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the recipient_cert_store and set recipient_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
i32
recipient_cert_subject_alt_names property (ECC Struct)
Comma-separated lists of alternative subject names for the certificate.
Syntax
fn recipient_cert_subject_alt_names(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
recipient_cert_thumbprint_md5 property (ECC Struct)
The MD5 hash of the certificate.
Syntax
fn recipient_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
recipient_cert_thumbprint_sha1 property (ECC Struct)
The SHA-1 hash of the certificate.
Syntax
fn recipient_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
recipient_cert_thumbprint_sha256 property (ECC Struct)
The SHA-256 hash of the certificate.
Syntax
fn recipient_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
recipient_cert_usage property (ECC Struct)
The text description of UsageFlags .
Syntax
fn recipient_cert_usage(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The text description of recipient_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
recipient_cert_usage_flags property (ECC Struct)
The flags that show intended use for the certificate.
Syntax
fn recipient_cert_usage_flags(&self ) -> Result<i32, IPWorksEncryptError>
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of recipient_cert_usage_flags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the recipient_cert_usage property for a text representation of recipient_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
i32
recipient_cert_version property (ECC Struct)
The certificate's version number.
Syntax
fn recipient_cert_version(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
recipient_cert_subject property (ECC Struct)
The subject of the certificate used for client authentication.
Syntax
fn recipient_cert_subject(&self ) -> Result<String, IPWorksEncryptError>
fn set_recipient_cert_subject(&self, value : &str) -> Option<IPWorksEncryptError> fn set_recipient_cert_subject_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
recipient_cert_encoded property (ECC Struct)
The certificate (PEM/Base64 encoded).
Syntax
fn recipient_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_recipient_cert_encoded(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_recipient_cert_encoded_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The recipient_cert_store and recipient_cert_subject properties also may be used to specify a certificate.
When recipient_cert_encoded is set, a search is initiated in the current recipient_cert_store for the private key of the certificate. If the key is found, recipient_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, recipient_cert_subject is set to an empty string.
Data Type
Vec
recipient_key_algorithm property (ECC Struct)
This property holds the algorithm associated with the key.
Syntax
fn recipient_key_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_recipient_key_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // Secp256r1
1 // Secp384r1
2 // Secp521r1
3 // Ed25519
4 // Ed448
5 // X25519
6 // X448
7 // Secp160k1
8 // Secp192k1
9 // Secp224k1
10 // Secp256k1
11 // BrainpoolP160r1
12 // BrainpoolP192r1
13 // BrainpoolP224r1
14 // BrainpoolP256r1
15 // BrainpoolP320r1
16 // BrainpoolP384r1
17 // BrainpoolP512r1
18 // BrainpoolP160t1
19 // BrainpoolP192t1
20 // BrainpoolP224t1
21 // BrainpoolP256t1
22 // BrainpoolP320t1
23 // BrainpoolP384t1
24 // BrainpoolP512t1
Default Value
0
Remarks
This property holds the algorithm associated with the key. Possible values are:
- 0 (eaSecp256r1)
- 1 (eaSecp384r1)
- 2 (eaSecp521r1)
- 3 (eaEd25519)
- 4 (eaEd448)
- 5 (eaX25519)
- 6 (eaX448)
- 7 (eaSecp160k1)
- 8 (eaSecp192k1)
- 9 (eaSecp224k1)
- 10 (eaSecp256k1)
- 11 (eaBrainpoolP160r1)
- 12 (eaBrainpoolP192r1)
- 13 (eaBrainpoolP224r1)
- 14 (eaBrainpoolP256r1)
- 15 (eaBrainpoolP320r1)
- 16 (eaBrainpoolP384r1)
- 17 (eaBrainpoolP512r1)
- 18 (eaBrainpoolP160t1)
- 19 (eaBrainpoolP192t1)
- 20 (eaBrainpoolP224t1)
- 21 (eaBrainpoolP256t1)
- 22 (eaBrainpoolP320t1)
- 23 (eaBrainpoolP384t1)
- 24 (eaBrainpoolP512t1)
When assigning a key using the PEM formatted recipient_key_private_key and recipient_key_public_key, the recipient_key_algorithm property will be automatically updated with the key algorithm.
When assigning a key using the raw key parameters (recipient_key_k, recipient_key_rx, and recipient_key_ry for NIST or recipient_key_xpk, and recipient_key_xsk for Curve25519/Curve448), the recipient_key_algorithm property must be set manually to the key algorithm.
The following table summarizes the supported operations for keys created with each algorithm:
Data Type
i32
recipient_key_public_key property (ECC Struct)
This property is a PEM formatted public key.
Syntax
fn recipient_key_public_key(&self ) -> Result<String, IPWorksEncryptError>
fn set_recipient_key_public_key(&self, value : &str) -> Option<IPWorksEncryptError> fn set_recipient_key_public_key_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
recipient_key_rx property (ECC Struct)
Represents the public key's Rx parameter.
Syntax
fn recipient_key_rx(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_recipient_key_rx(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_recipient_key_rx_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the public key's Rx parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
recipient_key_ry property (ECC Struct)
Represents the public key's Ry parameter.
Syntax
fn recipient_key_ry(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_recipient_key_ry(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_recipient_key_ry_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the public key's Ry parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
recipient_key_xpk property (ECC Struct)
Holds the public key data.
Syntax
fn recipient_key_xpk(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_recipient_key_xpk(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_recipient_key_xpk_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Holds the public key data.
Note: This value is only applicable when using Curve25519 or Curve448.
Data Type
Vec
shared_secret property (ECC Struct)
The computed shared secret.
Syntax
fn shared_secret(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
Default Value
""
Remarks
This property holds the shared secret computed by compute_secret.
This property is read-only.
Data Type
Vec
signer_cert_effective_date property (ECC Struct)
The date on which this certificate becomes valid.
Syntax
fn signer_cert_effective_date(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
signer_cert_expiration_date property (ECC Struct)
The date on which the certificate expires.
Syntax
fn signer_cert_expiration_date(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
signer_cert_extended_key_usage property (ECC Struct)
A comma-delimited list of extended key usage identifiers.
Syntax
fn signer_cert_extended_key_usage(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
signer_cert_fingerprint property (ECC Struct)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
fn signer_cert_fingerprint(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
signer_cert_fingerprint_sha1 property (ECC Struct)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
fn signer_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
signer_cert_fingerprint_sha256 property (ECC Struct)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
fn signer_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
signer_cert_issuer property (ECC Struct)
The issuer of the certificate.
Syntax
fn signer_cert_issuer(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
signer_cert_private_key property (ECC Struct)
The private key of the certificate (if available).
Syntax
fn signer_cert_private_key(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The signer_cert_private_key may be available but not exportable. In this case, signer_cert_private_key returns an empty string.
This property is read-only.
Data Type
String
signer_cert_private_key_available property (ECC Struct)
Whether a PrivateKey is available for the selected certificate.
Syntax
fn signer_cert_private_key_available(&self ) -> Result<bool, IPWorksEncryptError>
Default Value
false
Remarks
Whether a signer_cert_private_key is available for the selected certificate. If signer_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
signer_cert_private_key_container property (ECC Struct)
The name of the PrivateKey container for the certificate (if available).
Syntax
fn signer_cert_private_key_container(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The name of the signer_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
signer_cert_public_key property (ECC Struct)
The public key of the certificate.
Syntax
fn signer_cert_public_key(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
signer_cert_public_key_algorithm property (ECC Struct)
The textual description of the certificate's public key algorithm.
Syntax
fn signer_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
signer_cert_public_key_length property (ECC Struct)
The length of the certificate's public key (in bits).
Syntax
fn signer_cert_public_key_length(&self ) -> Result<i32, IPWorksEncryptError>
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
i32
signer_cert_serial_number property (ECC Struct)
The serial number of the certificate encoded as a string.
Syntax
fn signer_cert_serial_number(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
signer_cert_signature_algorithm property (ECC Struct)
The text description of the certificate's signature algorithm.
Syntax
fn signer_cert_signature_algorithm(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
signer_cert_store property (ECC Struct)
The name of the certificate store for the client certificate.
Syntax
fn signer_cert_store(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_signer_cert_store(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_signer_cert_store_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The signer_cert_store_type property denotes the type of the certificate store specified by signer_cert_store. If the store is password-protected, specify the password in signer_cert_store_password.
signer_cert_store is used in conjunction with the signer_cert_subject property to specify client certificates. If signer_cert_store has a value, and signer_cert_subject or signer_cert_encoded is set, a search for a certificate is initiated. Please see the signer_cert_subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Vec
signer_cert_store_password property (ECC Struct)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
fn signer_cert_store_password(&self ) -> Result<String, IPWorksEncryptError>
fn set_signer_cert_store_password(&self, value : &str) -> Option<IPWorksEncryptError> fn set_signer_cert_store_password_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
signer_cert_store_type property (ECC Struct)
The type of certificate store for this certificate.
Syntax
fn signer_cert_store_type(&self ) -> Result<i32, IPWorksEncryptError>
fn set_signer_cert_store_type(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the signer_cert_store_type, the full path of the PKCS#11 DLL as the signer_cert_store, and the PIN as the signer_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the signer_cert_store and set signer_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
i32
signer_cert_subject_alt_names property (ECC Struct)
Comma-separated lists of alternative subject names for the certificate.
Syntax
fn signer_cert_subject_alt_names(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
signer_cert_thumbprint_md5 property (ECC Struct)
The MD5 hash of the certificate.
Syntax
fn signer_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
signer_cert_thumbprint_sha1 property (ECC Struct)
The SHA-1 hash of the certificate.
Syntax
fn signer_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
signer_cert_thumbprint_sha256 property (ECC Struct)
The SHA-256 hash of the certificate.
Syntax
fn signer_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
signer_cert_usage property (ECC Struct)
The text description of UsageFlags .
Syntax
fn signer_cert_usage(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The text description of signer_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
signer_cert_usage_flags property (ECC Struct)
The flags that show intended use for the certificate.
Syntax
fn signer_cert_usage_flags(&self ) -> Result<i32, IPWorksEncryptError>
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of signer_cert_usage_flags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the signer_cert_usage property for a text representation of signer_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
i32
signer_cert_version property (ECC Struct)
The certificate's version number.
Syntax
fn signer_cert_version(&self ) -> Result<String, IPWorksEncryptError>
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
signer_cert_subject property (ECC Struct)
The subject of the certificate used for client authentication.
Syntax
fn signer_cert_subject(&self ) -> Result<String, IPWorksEncryptError>
fn set_signer_cert_subject(&self, value : &str) -> Option<IPWorksEncryptError> fn set_signer_cert_subject_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
signer_cert_encoded property (ECC Struct)
The certificate (PEM/Base64 encoded).
Syntax
fn signer_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_signer_cert_encoded(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_signer_cert_encoded_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The signer_cert_store and signer_cert_subject properties also may be used to specify a certificate.
When signer_cert_encoded is set, a search is initiated in the current signer_cert_store for the private key of the certificate. If the key is found, signer_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, signer_cert_subject is set to an empty string.
Data Type
Vec
signer_key_algorithm property (ECC Struct)
This property holds the algorithm associated with the key.
Syntax
fn signer_key_algorithm(&self ) -> Result<i32, IPWorksEncryptError>
fn set_signer_key_algorithm(&self, value : i32) -> Option<IPWorksEncryptError>
Possible Values
0 // Secp256r1
1 // Secp384r1
2 // Secp521r1
3 // Ed25519
4 // Ed448
5 // X25519
6 // X448
7 // Secp160k1
8 // Secp192k1
9 // Secp224k1
10 // Secp256k1
11 // BrainpoolP160r1
12 // BrainpoolP192r1
13 // BrainpoolP224r1
14 // BrainpoolP256r1
15 // BrainpoolP320r1
16 // BrainpoolP384r1
17 // BrainpoolP512r1
18 // BrainpoolP160t1
19 // BrainpoolP192t1
20 // BrainpoolP224t1
21 // BrainpoolP256t1
22 // BrainpoolP320t1
23 // BrainpoolP384t1
24 // BrainpoolP512t1
Default Value
0
Remarks
This property holds the algorithm associated with the key. Possible values are:
- 0 (eaSecp256r1)
- 1 (eaSecp384r1)
- 2 (eaSecp521r1)
- 3 (eaEd25519)
- 4 (eaEd448)
- 5 (eaX25519)
- 6 (eaX448)
- 7 (eaSecp160k1)
- 8 (eaSecp192k1)
- 9 (eaSecp224k1)
- 10 (eaSecp256k1)
- 11 (eaBrainpoolP160r1)
- 12 (eaBrainpoolP192r1)
- 13 (eaBrainpoolP224r1)
- 14 (eaBrainpoolP256r1)
- 15 (eaBrainpoolP320r1)
- 16 (eaBrainpoolP384r1)
- 17 (eaBrainpoolP512r1)
- 18 (eaBrainpoolP160t1)
- 19 (eaBrainpoolP192t1)
- 20 (eaBrainpoolP224t1)
- 21 (eaBrainpoolP256t1)
- 22 (eaBrainpoolP320t1)
- 23 (eaBrainpoolP384t1)
- 24 (eaBrainpoolP512t1)
When assigning a key using the PEM formatted signer_key_private_key and signer_key_public_key, the signer_key_algorithm property will be automatically updated with the key algorithm.
When assigning a key using the raw key parameters (signer_key_k, signer_key_rx, and signer_key_ry for NIST or signer_key_xpk, and signer_key_xsk for Curve25519/Curve448), the signer_key_algorithm property must be set manually to the key algorithm.
The following table summarizes the supported operations for keys created with each algorithm:
Data Type
i32
signer_key_public_key property (ECC Struct)
This property is a PEM formatted public key.
Syntax
fn signer_key_public_key(&self ) -> Result<String, IPWorksEncryptError>
fn set_signer_key_public_key(&self, value : &str) -> Option<IPWorksEncryptError> fn set_signer_key_public_key_ref(&self, value : &String) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
This property is a PEM formatted public key. The purpose of this property is to allow easier management of the public key parameters by using only a single value.
Data Type
String
signer_key_rx property (ECC Struct)
Represents the public key's Rx parameter.
Syntax
fn signer_key_rx(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_signer_key_rx(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_signer_key_rx_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the public key's Rx parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
signer_key_ry property (ECC Struct)
Represents the public key's Ry parameter.
Syntax
fn signer_key_ry(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_signer_key_ry(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_signer_key_ry_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Represents the public key's Ry parameter.
Note: This value is only applicable when using a NIST, Koblitz, or Brainpool curve.
Data Type
Vec
signer_key_xpk property (ECC Struct)
Holds the public key data.
Syntax
fn signer_key_xpk(&self ) -> Result<Vec<u8>, IPWorksEncryptError>
fn set_signer_key_xpk(&self, value : Vec<u8>) -> Option<IPWorksEncryptError> fn set_signer_key_xpk_ref(&self, value : &[u8]) -> Option<IPWorksEncryptError>
Default Value
""
Remarks
Holds the public key data.
Note: This value is only applicable when using Curve25519 or Curve448.
Data Type
Vec
use_hex property (ECC Struct)
Whether binary values are hex encoded.
Syntax
fn use_hex(&self ) -> Result<bool, IPWorksEncryptError>
fn set_use_hex(&self, value : bool) -> Option<IPWorksEncryptError>
Default Value
false
Remarks
This setting specifies whether various calculated values are hex encoded. If set to False (default), all data is provided as-is with no encoding.
If set to True, certain properties are hex encoded when populated for ease of display, transport, and storage.
Compute Secret Notes
This property specifies whether shared_secret is hex encoded when compute_secret is called.
Sign and Verify Notes
This property specifies whether hash_value and hash_signature are hex encoded.
If set to True, when sign is called the struct will compute the hash for the specified file and populate hash_value with the hex encoded hash value. It will then create the hash signature and populate hash_signature with the hex encoded hash signature value. If hash_value is specified directly, it must be a hex encoded value.
If set to True, when verify_signature is called the struct will compute the hash value for the specified file and populate hash_value with the hex encoded hash value. It will then hex decode hash_signature and verify the signature. hash_signature must hold a hex encoded value. If hash_value is specified directly, it must be a hex encoded value.
Encrypt and Decrypt Notes
If set to True, when encrypt is called the struct will perform the encryption as normal and then hex encode the output. output_message or output_file will hold hex encoded data.
If set to True, when decrypt is called the struct will expect input_message or input_file to hold hex encoded data. The struct will then hex decode the data and perform decryption as normal.
Data Type
bool
compute_secret method (ECC Struct)
Computes a shared secret.
Syntax
fn compute_secret(&self) -> Result<(), IPWorksEncryptError>
Remarks
This method computes a shared secret using Elliptic Curve Diffie Hellman (ECDH).
When this method is called, the struct will use the public key specified by recipient_key_public_key and the private key specified by key to compute a shared secret, or secret agreement. The compute_secret_kdf property specifies the Hash or HMAC algorithm that is applied to the raw secret. The resulting value is held by shared_secret. The following properties are applicable when calling this method:
- key (required)
- recipient_key_public_key (required)
- compute_secret_kdf (optional)
See compute_secret_kdf for details on advanced settings that may be applicable for the chosen algorithm.
Keys created with the Ed25519 and Ed448 algorithms are not supported when calling this method.
Compute Secret Example
//Create a key for Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("X25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Create a key for Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("X25519");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Note: the public keys must be exchanged between parties by some mechanism
//Create the shared secret on Party 1
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv; //Private key of this party
ecc1.RecipientKey.PublicKey = ecc2_pub; //Public key of other party
ecc1.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc1.ComputeSecret();
Console.WriteLine(ecc1.SharedSecret);
//Create the shared secret on Party 2
ecc2.Reset();
ecc2.Key.PrivateKey = ecc2_priv; //Private key of this party
ecc2.RecipientKey.PublicKey = ecc1_pub; //Public key of other party
ecc2.UseHex = true; //Hex encodes the shared secret bytes for easier display/storage
ecc2.ComputeSecret();
Console.WriteLine(ecc2.SharedSecret); //This will match the shared secret created by ecc1.
config method (ECC Struct)
Sets or retrieves a configuration setting.
Syntax
fn config(&self, configuration_string : &str) -> Result<String, IPWorksEncryptError>
Remarks
config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.
create_key method (ECC Struct)
Creates a new key.
Syntax
fn create_key(&self, key_algorithm : &str) -> Result<(), IPWorksEncryptError>
Remarks
create_key creates a new public and private key.
When this method is called, key is populated with the generated key. The key_public_key and key_private_key properties hold the PEM formatted public and private key for ease of use. This is helpful for storing or transporting keys more easily.
The KeyAlgorithm parameter specifies the algorithm for which the key is intended to be used. Possible values are:
NIST, Koblitz, and Brainpool Curve Notes
Keys for use with NIST curves (secp256r1, secp384r1, secp521r1), Koblitz curves (secp160k1, secp192k1, secp224k1, secp256k1), and Brainpool curves are made up of a number of individual parameters.
The public key consists of the following parameters:
The private key consists of one value:
Curve25519 and Curve448 Notes
Keys for use with Curve25519 or Curve448 are made up of a private key and public key field.
key_xpk holds the public key.
key_xsk holds the private key.
Create Key Example (secp256r1 - PEM)
//Create a key using secp256r1
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (secp256r1 - Raw Key Params)
//Create a key using secp256r1 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("secp256r1");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
byte[] K = ecc.Key.KB; //Private key param
byte[] Rx = ecc.Key.RxB; //Public key param
byte[] Ry = ecc.Key.RyB; //Public key param
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaSecp256r1; //This MUST be set manually when using key params directly
ecc.Key.KB = K;
ecc.Key.RxB = Rx;
ecc.Key.RyB = Ry;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaSecp256r1"
Create Key Example (Ed25519 - PEM)
//Create a key using Ed25519
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
string privKey = ecc.Key.PrivateKey; //PEM formatted key
string pubKey = ecc.Key.PublicKey; //PEM formatted key
//Load the saved key
ecc.Reset();
ecc.Key.PublicKey = pubKey;
ecc.Key.PrivateKey = privKey;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
Create Key Example (Ed25519 - Raw Key Params)
//Create a key using Ed25519 and store/load the key using the individual params
Ecc ecc = new Ecc();
ecc.CreateKey("Ed25519");
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
byte[] XPk = ecc.Key.XPkB; //Public key data
byte[] XSk = ecc.Key.XSkB; //Secret key data
//Load the saved key
ecc.Reset();
ecc.Key.Algorithm = ECAlgorithms.eaEd25519; //This MUST be set manually when using key params directly
ecc.Key.XPkB = XPk;
ecc.Key.XSkB = XSk;
Console.WriteLine(ecc.Key.Algorithm); //outputs enum value "eaEd25519"
decrypt method (ECC Struct)
Decrypted the specified data.
Syntax
fn decrypt(&self) -> Result<(), IPWorksEncryptError>
Remarks
decrypt decrypts the specified data with the ECDSA private key specified in key.
Decryption is performed using ECIES which requires an ECDSA key. key must contain an ECDSA key. key_algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See create_key for details about key creation and algorithms.
When this method is called, the struct will decrypt the specified data using ECIES and the decrypted data will be output. If the input data was originally hex encoded, set use_hex to True.
The following properties are applicable when calling this method:
- encryption_algorithm
- hmac_algorithm
- HMACOptionalInfo
- HMACKeySize
- iv
- kdf
- kdf_hash_algorithm
- KDFOptionalInfo
- use_hex
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
encrypt method (ECC Struct)
Encrypts the specified data.
Syntax
fn encrypt(&self) -> Result<(), IPWorksEncryptError>
Remarks
encrypt encrypts the specified data with the ECDSA public key specified in recipient_key.
Encryption is performed using ECIES which requires an ECDSA key. recipient_key must contain an ECDSA key. key_algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for encryption are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
See create_key for details about key creation and algorithms.
When this method is called, the struct will encrypt the specified data using ECIES and the encrypted data will be output. To hex encode the output, set use_hex to True.
The following properties are applicable when calling this method:
- encryption_algorithm
- hmac_algorithm
- HMACOptionalInfo
- HMACKeySize
- iv
- kdf
- kdf_hash_algorithm
- KDFOptionalInfo
- use_hex
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- output_file
- output_message: The output data is written to this property if no other destination is specified.
Encrypt and Decrypt Example
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (AES with IV)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
//Use an IV (16 bytes for AES) - In a real environment this should be random
byte[] IV = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F };
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc1.IVB = IV;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message and the IV to Party 2
//Decrypt the message using the private key for Party 2 and the IV
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesAES;
ecc2.IVB = IV;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (XOR Encryption Algorithm)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.EncryptionAlgorithm = EccEncryptionAlgorithms.iesXOR;
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
Encrypt and Decrypt Example (KDF Options)
//Create an ECDSA key on Party 2
Ecc ecc2 = new Ecc();
ecc2.CreateKey("secp256r1");
string ecc2_priv = ecc2.Key.PrivateKey;
string ecc2_pub = ecc2.Key.PublicKey;
//Transmit public key to Party 1
//Encrypt the message on Party 1 using public key from Party 2
Ecc ecc1 = new Ecc();
ecc1.KDF = "KDF1"; //Use KDF1
ecc1.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc1.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f"); //Hex encoded string
ecc1.InputMessage = "hello ecc";
ecc1.RecipientKey.PublicKey = ecc2_pub;
ecc1.UseHex = true;
ecc1.Encrypt();
string encryptedMessage = ecc1.OutputMessage;
//Transmit the encrypted message to Party 2
//Decrypt the message using the private key for Party 2
ecc2.KDF = "KDF1";
ecc2.KDFHashAlgorithm = EccKDFHashAlgorithms.iesSHA1;
ecc2.Config("KDFOptionalInfo=202122232425262728292a2b2c2d2e2f");
ecc2.Key.PrivateKey = ecc2_priv;
ecc2.InputMessage = encryptedMessage;
ecc2.UseHex = true;
ecc2.Decrypt();
Console.WriteLine(ecc2.OutputMessage);
reset method (ECC Struct)
Resets the struct.
Syntax
fn reset(&self) -> Result<(), IPWorksEncryptError>
Remarks
When called, the struct will reset all of its properties to their default values.
sign method (ECC Struct)
Creates a hash signature using ECDSA or EdDSA.
Syntax
fn sign(&self) -> Result<(), IPWorksEncryptError>
Remarks
sign will create a hash signature using ECDSA or EdDSA. The struct will use the key specified by key to hash the input data and sign the resulting hash.
key must contain a private key created with a valid ECDSA or EdDSA algorithm. key_algorithm is used to determine the eligibility of the key for this operation. Supported algorithms for signing are:
- NIST Curves (secp256r1, secp384r1, secp521r1)
- Koblitz Curves (secp160k1, secp192k1, secp224k1, secp256k1)
- Brainpool Curves
- Ed25519 and Ed448
See create_key for details about key creation and algorithms.
When this method is called, data will be read from the input_file or input_message.
The hash to be signed will be computed using the specified hash_algorithm. The computed hash is stored in the hash_value property. The signed hash is stored in the hash_signature property.
To sign a hash without first computing it, set hash_value to a previously computed hash for the input data. Note: hash_value is not applicable when signing with a PureEdDSA algorithm such as Ed25519 or Ed448.
The on_progress event will fire with updates for the hash computation progress only. The hash signature creation process is quick and does not require progress updates.
After calling sign, the public key must be sent to the recipient along with hash_signature and the original input data so the other party may perform signature verification.
The following properties are applicable when calling this method:
- key (required)
- hash_algorithm (applicable to ECDSA only)
- hash_ed_dsa (applicable to EdDSA only)
- hash_value (not applicable to PureEdDSA)
- use_hex
The following properties are populated after calling this method:
When the key_algorithm is Ed25519 or Ed448, the following additional parameters are applicable:
EdDSA keys can be used with a PureEdDSA algorithm (Ed25519/Ed448) or a HashEdDSA (Ed25519ph, Ed448ph) algorithm. This is controlled by the hash_ed_dsa property. By default, the struct uses the PureEdDSA algorithm.
The PureEdDSA algorithm requires two passes over the input data but provides collision resilience. The collision resilience of PureEdDSA means that even if it is feasible to compute collisions for the hash function, the algorithm is still secure. When using PureEdDSA, hash_value is not applicable.
When using a HashEdDSA algorithm, the input is pre-hashed and supports a single pass over the data during the signing operation. To enable HashEdDSA, set hash_ed_dsa to True.
To specify context data when using Ed25519 or Ed448, set EdDSAContext.
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - PureEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - HashEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.HashEdDSA = true; //Use "ed25519ph"
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.HashEdDSA = true;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
verify_signature method (ECC Struct)
Verifies the signature for the specified data.
Syntax
fn verify_signature(&self) -> Result<bool, IPWorksEncryptError>
Remarks
verify_signature will verify a hash signature and return True if successful or False otherwise.
Before calling this method, specify the input file by setting input_file or input_message.
A public key and the hash signature are required to perform the signature verification. Specify the public key in signer_key. Specify the hash signature in hash_signature.
When this method is called, the struct will compute the hash for the specified file and populate hash_value. It will verify the signature using the specified signer_key and hash_signature.
To verify the hash signature without first computing the hash, simply specify hash_value before calling this method. Note: hash_value is not applicable when the message was signed with a PureEdDSA algorithm such as Ed25519 or Ed448.
The on_progress event will fire with updates for the hash computation progress only. The hash signature verification process is quick and does not require progress updates.
The following properties are applicable when calling this method:
- hash_signature (required)
- signer_key (required)
- EdDSAContext (applicable to EdDSA only)
- hash_algorithm (applicable to ECDSA only)
- hash_ed_dsa (applicable to EdDSA only)
- hash_value (not applicable to PureEdDSA)
- use_hex
Sign And Verify Example (ECDSA)
//Create an ECDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("secp256r1");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - PureEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
Sign And Verify Example (EdDSA - HashEdDSA)
//Create an EdDSA key on Party 1
Ecc ecc1 = new Ecc();
ecc1.CreateKey("ed25519");
string ecc1_priv = ecc1.Key.PrivateKey;
string ecc1_pub = ecc1.Key.PublicKey;
//Sign the data on Party 1
string originalData = "hello ecc";
ecc1.Reset();
ecc1.Key.PrivateKey = ecc1_priv;
ecc1.InputMessage = originalData;
ecc1.UseHex = true; //Hex encode the hash signature for ease of use.
ecc1.HashEdDSA = true; //Use "ed25519ph"
ecc1.Sign();
string hashSignature = ecc1.HashSignature;
//Transmit the hash signature, public key, and original data to Party 2
//Verify the data on Party 2
Ecc ecc2 = new Ecc();
ecc2.SignerKey.PublicKey = ecc1_pub;
ecc2.InputMessage = originalData;
ecc2.HashSignature = hashSignature;
ecc2.HashEdDSA = true;
ecc2.UseHex = true; //Decode the hex encoded hash signature
bool isVerified = ecc2.VerifySignature();
on_error event (ECC Struct)
Fired when information is available about errors during data delivery.
Syntax
// ECCErrorEventArgs carries the ECC Error event's parameters.
pub struct ECCErrorEventArgs {
fn error_code(&self) -> i32
fn description(&self) -> &String
}
// ECCErrorEvent defines the signature of the ECC Error event's handler function.
pub trait ECCErrorEvent {
fn on_error(&self, sender : ECC, e : &mut ECCErrorEventArgs);
}
impl <'a> ECC<'a> {
pub fn on_error(&self) -> &'a dyn ECCErrorEvent;
pub fn set_on_error(&mut self, value : &'a dyn ECCErrorEvent);
...
}
Remarks
The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.
The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
on_progress event (ECC Struct)
Fired as progress is made.
Syntax
// ECCProgressEventArgs carries the ECC Progress event's parameters.
pub struct ECCProgressEventArgs {
fn bytes_processed(&self) -> i64
fn percent_processed(&self) -> i32
}
// ECCProgressEvent defines the signature of the ECC Progress event's handler function.
pub trait ECCProgressEvent {
fn on_progress(&self, sender : ECC, e : &mut ECCProgressEventArgs);
}
impl <'a> ECC<'a> {
pub fn on_progress(&self) -> &'a dyn ECCProgressEvent;
pub fn set_on_progress(&mut self, value : &'a dyn ECCProgressEvent);
...
}
Remarks
This event is fired automatically as data is processed by the struct.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
Config Settings (ECC Struct)
The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.ECC Config Settings
Note: This is not applicable when compute_secret_kdf is set to 12 (ekdTLS).
This setting is required when compute_secret_kdf is set to ekdConcat. This setting is only applicable when calling compute_secret.
- SHA1
- SHA224
- SHA256 (default)
- SHA384
- SHA512
- RIPEMD160
This setting is required when compute_secret_kdf is set to ekdConcat. This setting is only applicable when calling compute_secret.
This setting is required when compute_secret_kdf is set to ekdConcat. This setting is only applicable when calling compute_secret.
This setting is optional when compute_secret_kdf is set to ekdConcat. This setting is only applicable when calling compute_secret.
This setting is optional when compute_secret_kdf is set to ekdConcat. This setting is only applicable when calling compute_secret.
- 0 (Concatenated - default)
- 1 (ASN)
Note: This setting is only applicable when key_algorithm is set to a NIST, Koblitz, or Brainpool curve.
This setting is only applicable when key_algorithm is set to Ed25519 or Ed448. When this setting is specified, the key_algorithm is Ed25519, and hash_ed_dsa is False, the struct will automatically use Ed25519ctx.
If this value is specified before calling sign, it must also be set prior to calling verify_signature.
- 128
- 192
- 256 (default)
This is only applicable when calling compute_secret.
This setting is only applicable when calling encrypt or decrypt.
The value specified in this setting must a hex string.
If specified, this must be set before calling both encrypt and decrypt.
The value specified in this setting must a hex string.
If specified, this must be set before calling both encrypt and decrypt.
Note: This is not applicable when compute_secret_kdf is set to 12 (ekdTLS).
When using keys with the algorithm Ed25519, Ed448, X25519, or X448, the struct will calculate the public key based on the provided private key and compare it to the provided public key to ensure they match.
When using keys with a NIST, Koblitz, or Brainpool curve, the struct will perform calculations to verify that the public key is a point on the curve. The struct will also calculate the public key based on the provided private key and compare it to the provided public key to ensure they match.
The default value is False and the struct will use the public and private keys as provided without any additional checks.
Base Config Settings
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
Setting this configuration setting to true tells the struct to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (ECC Struct)
ECC Errors
| 102 | No Key specified. |
| 104 | Cannot read or write file. |
| 111 | OutputFile already exists and Overwrite is False. |
| 120 | Invalid curve. |
| 124 | HashSignature must be specified. |
| 304 | Cannot write file. |
| 305 | Cannot read file. |
| 306 | Cannot create file. |
| 1401 | Specified ECC parameters are invalid. |
| 1402 | Missing hash value. |
| 1403 | Public key must be specified. |
| 1404 | Key must be specified. |
| 1405 | HashSignature must be specified. |
| 1406 | Invalid key size. |
| 1407 | Invalid TLS seed. TLSSeed must be 64 bytes long. |
| 1408 | Invalid TLS label. |
| 1409 | Unsupported key format. |
| 1410 | Unsupported curve. |