Crypt2 Lianja Reference Documentation
Crypt2
Current Version: 11.0.0
Chilkat encryption component.
Object Creation
loObject = createobject("CkCrypt2")
Properties
AbortCurrent
When set to .T., causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to .F. when the next method is called. When the abort occurs, this property is reset to .F.. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)
BCryptWorkFactor
The BCrypt work factor to be used for the BCryptHash and BCryptVerify. This is the log2 of the number of rounds of hashing to apply. For example, if the work (cost) factor is 12, then 2^12 rounds of hashing are applied. The purpose of this cost factor is to make the BCrypt computation expensive enought to prevent brute-force attacks. (Any complaints about BCrypt not being fast enough will be ignored.)
This property must have a value ranging from 4 to 31 inclusive.
The default value is 10.
topBlockSize
The block-size (in bytes) of the selected encryption algorithm. For example, if the CryptAlgorithm property is set to aes, the BlockSize property is automatically set to 16. The block-size for the ARC4 streaming encryption algorithm is 1.
CadesEnabled
Applies to all methods that create PKCS7 signatures. To create a CAdES-BES signature, set this property equal to .T.. The default value of this property is .F..
CadesSigPolicyHash
This is the base64 hash of the policy document located at the CadesSigPolicyUri. You can use either the SHA256 or SHA1 hash. You may use this online tool to compute the base64 hash: http://tools.chilkat.io/hashFileAtUrl.cshtml>Compute Base64 Hash for CaDES Signature Policy URL
Note: This property applies to all methods that create PKCS7 signatures. To create a CAdES-EPES signature, set the CadesEnabled property = .T., and also provide values for each of the following properties: CadesSigPolicyHash, CadesSigPolicyId, and CadesSigPolicyUri. For example (in pseudo-code):
cryptObj.CadesSigPolicyId = <code>2.16.76.1.7.1.1.1</code> cryptObj.CadesSigPolicyUri = <code>http://politicas.icpbrasil.gov.br/PA_AD_RB.der</code> cryptObj.CadesSigPolicyHash = <code>rySugyKaMhiMR8Y/o5yuU2A2bF0=</code>Note: Do NOT use the values above. They are only provided as an example to show valid values. For example, the Policy ID is an OID. The Policy URI is a typically a URL to a DER encoded policy file, and the Policy Hash is a base64 encoded hash. top
CadesSigPolicyId
See the description for the CadesSigPolicyHash property above.
topCadesSigPolicyUri
See the description for the CadesSigPolicyHash property above.
topCharset
This property specifies the character encoding used to represent text as bytes for encryption and hashing. By default, it uses the computer's ANSI charset, such as Windows-1252 for locales like the United States, United Kingdom, Western Europe, Australia, and New Zealand.
Most applications are advised to set this property to UTF-8. Chilkat plans to change its default to UTF-8 in a future major version to align with current standards. The current default of ANSI stems from a time when UTF-8 was not widely adopted.
CipherMode
Sets the cipher mode for block encryption algorithms (AES, Blowfish,TwoFish, DES, 3DES, RC2). Possible values are CBC (the default) , ECB, CTR, OFB, GCM, and CFB. These acronyms have the following meanings:
CBC: Cipher Block Chaining,ECB: Electronic CookBookCTR: Counter ModeCFB: Cipher FeedbackOFB: Output FeedbackGCM: Galois/Counter ModeXTS: AES-XTS (starting in Chilkat v9.5.0.91, only works with AES encryption)
Prior to Chilkat v9.5.0.55, the CFB mode is only implemented for AES, Blowfish, and DES/3DES, and the CTR mode is only implemented for AES.
Starting in v9.5.0.55 CFB and OFB modes are useable with all encryption algorithms, and GCM (Galois/Counter Mode) is available with any cipher having a 16-byte block size, such as AES and Twofish. CFB, OFB, CTR, and GCM modes convert block ciphers into stream ciphers. In these modes of operation, the PaddingScheme property is unused because no padding occurs.
Starting in v9.5.0.91 Chilkat supports AES-XTS mode. XTS mode additionally uses a tweak key and tweak value, which are set via the XtsSetEncodedTweakKey, XtsSetEncodedTweakValue, and XtsSetDataUnitNumber. (The latter two functions provide alternative means of setting the tweak value.) Note: Chilkat fully supports AES-XTS mode with ciphertext-stealing, which means it will correctly encrypt/decrypt data with size not divisible by the block size (i.e. divisible by 16 bytes).
CmsOptions
A JSON string for controlling extra CMS (PKCS7) signature and validation options.
CryptAlgorithm
Selects the encryption algorithm for encrypting and decrypting. Possible values are: chacha20, pki, aes, blowfish2, des, 3des, rc2, arc4, twofish, pbes1 and pbes2. The pki encryption algorithm isn't a specific algorithm, but instead tells the component to encrypt/decrypt using public-key encryption (PKCS7/CMS) with digital certificates. The other choices are symmetric encryption algorithms that do not involve digital certificates and public/private keys.
The default value is aes
The original Chilkat implementation of Blowfish (in 2004) has a 4321 byte-swapping issue (the results are 4321 byte-swapped). The newer implementation (in 2006 and named blowfish2) does not byte swap. This should be used for compatibility with other Blowfish software. If an application needs to decrypt something encrypted with the old 4321 byte-swapped blowfish, set the property to blowfish_old.
Password-based encryption (PBE) is selected by setting this property to pbes1 or pbes2. Password-based encryption is defined in the PKCS5 Password-Based Cryptography Standard at https://tools.ietf.org/html/rfc2898. If PBE is used, the underlying encryption algorithm is specified by the PbesAlgorithm property. The underlying encryption (PbesAlgorithm) for PBES1 is limited to 56-bit DES or 64-bit RC2.
Note:The chacha20 algorithm is introduced in Chilkat v9.5.0.55.
DebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
EncodingMode
Controls the encoding of binary data to a printable string for many methods. The valid modes are Base64, modBase64, base64url, Base32, Base58, UU, QP (for quoted-printable), URL (for url-encoding), Hex, Q, B, url_oauth, url_rfc1738, url_rfc2396, url_rfc3986, fingerprint, or decimal.
The default value is base64
The fingerprint anddecimal encodings are introduced in Chilkat v9.5.0.55.
The fingerprint encoding is a lowercase hex encoding where each hex digit is separated by a colon character. For example: 6a:de:e0:af:56:f8:0c:04:11:5b:ef:4d:49:ad:09:23
The decimal encoding is for converting large decimal integers to/from a big-endian binary representation. For example, the decimal string 72623859790382856 converts to the bytes 0x01 0x02 0x03 0x04 0x05 0x06 0x07 0x08.
FirstChunk
Using the FirstChunk and LastChunk properties is the way to do streaming encryption or decryption with Chilkat.
By default, both FirstChunk and LastChunk are set to .T., indicating that the data passed to the encryption or decryption method is the full amount. To process data in multiple chunks, adjust these settings as follows:
1. For the first chunk, set FirstChunk = .T. and LastChunk = .F..
2. For intermediate chunks, set both FirstChunk = .F. and LastChunk = .F..
3. For the final chunk, set FirstChunk = .F. and LastChunk = .T..
You can feed data chunks of any size, regardless of the encryption algorithm's block size (e.g., 16 bytes for AES). Chilkat will handle buffering and, upon receiving the final chunk, pad the output to the appropriate block size according to the selected PaddingScheme.
HashAlgorithm
Selects the hash algorithm used by methods that create hashes. The valid choices are sha1, sha256, sha384, sha512, sha3-224, sha3-256, sha3-384, sha3-512, md2, md5, haval, ripemd128, ripemd160,ripemd256, or ripemd320.
Note: SHA-2 designates a set of cryptographic hash functions that includes SHA-256, SHA-384, and SHA-512. Chilkat by definition supports SHA-2 because it supports these algorithms.
The default value is sha256.
Note: The HAVAL hash algorithm is affected by two other properties: HavalRounds and KeyLength.
- The HavalRounds may have values of 3, 4, or 5.
- The KeyLength may have values of 128, 160, 192, 224, or 256.
Note: The sha3-224, sha3-256, sha3-384, sha3-512 algorithms are added in Chilkat v9.5.0.83.
HavalRounds
Applies to the HAVAL hash algorithm only and must be set to the integer value 3, 4, or 5. The default value is 3.
topIncludeCertChain
Only applies when creating digital signatures. If .T. (the default), then additional certificates (if any) in the chain of authentication are included in the PKCS7 digital signature.
InitialCount
The initial counter for the ChaCha20 encryption algorithm. The default value is 0.
topIterationCount
Iteration count to be used with password-based encryption (PBE). Password-based encryption is defined in the PKCS5 Password-Based Cryptography Standard at http://www.rsa.com/rsalabs/node.asp?id=2127
The purpose of the iteration count is to increase the computation required to encrypt and decrypt. A larger iteration count makes cracking via exhaustive search more difficult. The default value is 1024.
topKeyLength
The key length in bits for symmetric encryption algorithms. The default value is 256.
topLastChunk
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: .T. means success, .F. means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
MacAlgorithm
Selects the MAC algorithm to be used for any of the Mac methods, such as MacStringENC, MacBytes, etc. The default value is hmac. Possible values are hmac and poly1305.
NumSignerCerts
This property is set when a digital signature is verified. It contains the number of signer certificates. Each signing certificate can be retrieved by calling the GetSignerCert method, passing an index from 0 to NumSignerCerts-1.
OaepHash
Selects the hash algorithm for use within OAEP padding when encrypting using pki with RSAES-OAEP. The valid choices are sha1, sha256, sha384, sha512,
The default value is sha256
OaepMgfHash
Selects the MGF hash algorithm for use within OAEP padding when encrypting using pki with RSAES-OAEP. The valid choices are sha1, sha256, sha384, sha512, The default is sha256.
OaepPadding
Selects the RSA encryption scheme when encrypting using pki (with a certificate and private key). The default value is .F., which selects RSAES_PKCS1-V1_5. If set to .T., then RSAES_OAEP is used.
PaddingScheme
The padding scheme used by block encryption algorithms such as AES (Rijndael), Blowfish, Twofish, RC2, DES, 3DES, etc. Block encryption algorithms pad encrypted data to a multiple of algorithm's block size. The default value of this property is 0.
Possible values are:
0 = RFC 1423 padding scheme: Each padding byte is set to the number of padding bytes. If the data is already a multiple of algorithm's block size bytes, an extra block is appended each having a value equal to the block size. (for example, if the algorithm's block size is 16, then 16 bytes having the value 0x10 are added.). (This is also known as PKCS5 padding: PKCS #5 padding string consists of a sequence of bytes, each of which is equal to the total number of padding bytes added. )
1 = FIPS81 (Federal Information Processing Standards 81) where the last byte contains the number of padding bytes, including itself, and the other padding bytes are set to random values.
2 = Each padding byte is set to a random value. The decryptor must know how many bytes are in the original unencrypted data.
3 = Pad with NULLs. (If already a multiple of the algorithm's block size, no padding is added).
4 = Pad with SPACE chars(0x20). (If already a multiple of algorithm's block size, no padding is added).
PbesAlgorithm
If the CryptAlgorithm property is set to pbes1 or pbes2, this property specifies the underlying encryption algorithm to be used with password-based encryption (PBE). Password-based encryption is defined in the PKCS5 Password-Based Cryptography Standard at http://www.rsa.com/rsalabs/node.asp?id=2127
PbesPassword
The password to be used with password-based encryption (PBE). Password-based encryption is defined in the PKCS5 Password-Based Cryptography Standard at http://www.rsa.com/rsalabs/node.asp?id=2127
topPkcs7CryptAlg
When the CryptAlgorithm property is PKI to select PKCS7 public-key encryption, this selects the underlying symmetric encryption algorithm. Possible values are: aes, des, 3des, and rc2. The default value is aes.
Rc2EffectiveKeyLength
The effective key length (in bits) for the RC2 encryption algorithm. When RC2 is used, both the KeyLength and Rc2EffectiveKeyLength properties should be set. For RC2, both should be between 8 and 1024 (inclusive).
The default value is 128
topSigningAlg
This property selects the signature algorithm for the OpaqueSign*, Sign*, and CreateDetachedSignature, CreateP7M, and CreateP7S methods. The default value is PKCS1-v1_5. This can be set to RSASSA-PSS (or simply pss) to use the RSASSA-PSS signature scheme.
Note: This property only applies when the private key is an RSA private key. It does not apply for ECC or DSA private keys.
SigningAttributes
Contains JSON to specify the authenticated (signed) attributes or unauthenticated (unsigned) attributes that are to be included in CMS signatures. The default value is:
{
<code>contentType</code>: 1,
<code>signingTime</code>: 1,
<code>messageDigest</code>: 1
}
Other possible values that can be added are:
- signingCertificateV2
- signingCertificate
- sMIMECapabilities
- microsoftRecipientInfo
- encrypKeyPref
- cmsAlgorithmProtection
UncommonOptions
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
Can be set to a list of the following comma separated keywords:
UseConstructedOctets- Introduced in v9.5.0.83. When creating opaque CMS signatures (signatures that embed the data being signed), will use theconstructed octetsform of the ASN.1 that holds the data. This is to satify some validators that are brittle/fragile/picky and require a particular format, such as for the ICP-Brazil Digital Signature Standard.
UuFilename
When UU encoding, this is the filename to be embedded in UU encoded output. The default is file.dat. When UU decoding, this is the filename found in the UU encoded input.
UuMode
When UU encoding, this is the file permissions mode to be embedded in UU encoded output. The default is 644. When UU decoding, this property is set to the mode found in the UU encoded input.
VerboseLogging
If set to .T., then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is .F.. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AddEncryptCert
Adds a certificate for public-key encryption. To enable public-key encryption with digital certificates, set the CryptAlgorithm property to pki. Call AddEncryptCert separately for each certificate you wish to use for encryption.
Any of the Encrypt* methods will do RSA public-key encryption when the CryptAlgorithm is set to the keyword pki. The output is a PKCS#7 enveloped-data secure container.
AddPfxSourceBd
Adds a PFX file to the object's list of sources for locating certificates and private keys during public-key decryption or signing. To add multiple PFX sources, call this method multiple times. bd should contain the bytes of a PFX file (also known as PKCS12 or .p12).
Note: Information about the certificate(s) needed for public-key decryption are included in the PKCS#7 enveloped-data. Chilkat will automatically find a usable certificate and private key from sources like Windows certificate stores, the Apple keychain, or other sources provided by the application.
Returns .T. for success, .F. for failure.
AddPfxSourceFile
Adds a PFX file to the object's list of sources for locating certificates and private keys during public-key decryption or signing. To add multiple PFX sources, call this method multiple times.
Note: Information about the certificate(s) needed for public-key decryption are included in the PKCS#7 enveloped-data. Chilkat will automatically find a usable certificate and private key from sources like Windows certificate stores, the Apple keychain, or other sources provided by the application.
Returns .T. for success, .F. for failure.
AddSigningCert
Call this method once per certificate to add multiple certificates for signing. If signing with a single certificate, then the SetSigningCert or SetSigningCert2 methods can be used instead.
Returns .T. for success, .F. for failure.
AesKeyUnwrap
Implements the AES Key Wrap Algorithm (RFC 3394) for unwrapping. The kek is the Key Encryption Key (the AES key used to unwrap the wrappedKeyData). The arguments and return value are binary encoded strings using the encoding specified by encoding (which can be base64, hex, base64url, etc.) The full list of supported encodings is available at the link below.
The kek should be an AES key of 16 bytes, 24 bytes, or 32 bytes (i.e. 128-bits, 192- bits, or 256-bits). For example, if passed as a hex string, then the kek should be 32 chars in length, 48 chars, or 64 chars (because each byte is represented as 2 chars in hex).
The wrappedKeyData contains the data to be unwrapped. The result, if decoded, is 8 bytes less than the wrapped key data. For example, if a 256-bit AES key (32 bytes) is wrapped, the size of the wrapped key data is 40 bytes. Unwrapping restores it to the original 32 bytes.
Returns .F. on failure
AesKeyUnwrapWithPadding
Implements the AES Key Wrap with Padding Algorithm (RFC 5649) for unwrapping. The kek is the Key Encryption Key (the AES key used to unwrap the wrappedKeyData). The arguments and return value are binary encoded strings using the encoding specified by encoding (which can be base64, hex, base64url, etc.)
The kek should be an AES key of 16 bytes, 24 bytes, or 32 bytes (i.e. 128-bits, 192- bits, or 256-bits). For example, if passed as a hex string, then the kek should be 32 chars in length, 48 chars, or 64 chars (because each byte is represented as 2 chars in hex).
The wrappedKeyData contains the data to be unwrapped.
The unwrapped key is returned as an encoded string (using the encoding specified in encoding).
Returns .F. on failure
AesKeyWrap
Implements the AES Key Wrap Algorithm (RFC 3394). The kek is the Key Encryption Key (the AES key used to encrypt the keyData). The arguments and return value are binary encoded strings using the encoding specified by encoding (which can be base64, hex, base64url, etc.) The full list of supported encodings is available at the link below.
The kek should be an AES key of 16 bytes, 24 bytes, or 32 bytes (i.e. 128-bits, 192- bits, or 256-bits). For example, if passed as a hex string, then the kek should be 32 chars in length, 48 chars, or 64 chars (because each byte is represented as 2 chars in hex).
The keyData contains the data to be key wrapped. It must be a multiple of 64-bits in length. In other words, if the keyData is decoded to binary, it should be a number of bytes that is a multiple of 8.
The return string, if decoded to binary bytes, is equal to the size of the key data + 8 additional bytes.
Returns .F. on failure
AesKeyWrapWithPadding
Implements the AES Key Wrap with Padding Algorithm (RFC 5649). The kek is the Key Encryption Key (the AES key used to encrypt the keyData). The arguments and return value are binary encoded strings using the encoding specified by encoding (which can be base64, hex, base64url, etc.)
The kek should be an AES key of 16 bytes, 24 bytes, or 32 bytes (i.e. 128-bits, 192- bits, or 256-bits). For example, if passed as a hex string, then the kek should be 32 chars in length, 48 chars, or 64 chars (because each byte is represented as 2 chars in hex).
The keyData contains the data to be key wrapped.
Returns the wrapped key using the encoding specified in encoding.
Returns .F. on failure
BCryptHash
Computes and returns a bcrypt hash of the password. The number of rounds of hashing is determined by the BCryptWorkFactor property.
Starting in v9.5.0.76, if the password is prefixed with $2b$ then the output will use the $2b version of bcrypt. For example, to create a $2b$ bcrypt has for the password secret, pass in the string $2b$secret for password.
Returns .F. on failure
BCryptVerify
Verifies the password against a previously computed BCrypt hash. Returns .T. if the password matches the bcryptHash. Returns .F. if the password does not match.
Returns .T. for success, .F. for failure.
CkDecryptFile
File-to-file decryption that supports files of any size by using internal streaming mode.
Returns .T. for success, .F. for failure.
CkDecryptFileAsync (1)
Creates an asynchronous task to call the CkDecryptFile method with the arguments provided.
Returns .F. on failure
CkEncryptFile
File-to-file encryption that operates in streaming mode, allowing it to encrypt files of any size.
Returns .T. for success, .F. for failure.
CkEncryptFileAsync (1)
Creates an asynchronous task to call the CkEncryptFile method with the arguments provided.
Returns .F. on failure
ClearEncryptCerts
Clears the internal list of digital certificates to be used for public-key encryption.
ClearSigningCerts
Clears the set of certificates to be used in signing.
Returns .T. for success, .F. for failure.
CoSign
Co-sign's an existing CMS signature. bdIn contains the existing CMS signature. If successful, cert is the output co-signed CMS signature.
Returns .T. for success, .F. for failure.
CrcBd
Computes a CRC for data contained in crcAlg, which can be either crc-32 used in the Zip file format, or crc8 for the CRC8 algorithm.
CrcFile
Calculates the CRC for a file's contents using the CRC algorithm specified by crcAlg. Possible algorithms are:
crc-32- This is the CRC used in the Zip file format.crc8
CrcFileAsync (1)
Creates an asynchronous task to call the CrcFile method with the arguments provided.
Returns .F. on failure
CreateP7M
Signs the contents of inFilename and writes the enveloping (i.e. opaque) PKCS7 signature (.p7m) to p7mPath.
In a PKCS#7/CMS signature, the signer computes a cryptographic hash (e.g. SHA-256) of the data, then uses their private key to sign that hash.
The signature = Sign( Hash(data) )
This signed hash is what gets stored in the signature file. For enveloping/opaque signatures, the signed data is also stored in the signature file.
Set the HashAlgorithm property to specify the hash algorithmg. The valid options are sha256, sha1, sha384, and sha512.
Returns .T. for success, .F. for failure.
CreateP7MAsync (1)
Creates an asynchronous task to call the CreateP7M method with the arguments provided.
Returns .F. on failure
CreateP7S
Signs the contents of inFilename and writes the detached PKCS7 signature (.p7s) to p7sPath.
In a PKCS#7/CMS detached signature, the signer computes a cryptographic hash (e.g. SHA-256) of the data, then uses their private key to sign that hash.
The signature = Sign( Hash(data) )
This signed hash is what gets stored in the signature file.
Set the HashAlgorithm property to specify the hash algorithmg. The valid options are sha256, sha1, sha384, and sha512.
Returns .T. for success, .F. for failure.
CreateP7SAsync (1)
Creates an asynchronous task to call the CreateP7S method with the arguments provided.
Returns .F. on failure
DecodeString
Decodes from an encoding back to the original string. The encoding can be set to any of the following strings: base64, hex, quoted-printable, url, base32, Q, B, url_rc1738, url_rfc2396, url_rfc3986, url_oauth, uu, modBase64, or html (for HTML entity encoding).
Returns .F. on failure
DecryptBd
Decrypts the contents of bd. This method can do either symmetric key decryption or CMS public key decryption (e.g., PKCS#7 EnvelopedData).
Before calling this method for symmetric key decryption (e.g., AES, ChaCha20, Blowfish, etc.), ensure the following setup:
- Define the encryption algorithm using the
CryptAlgorithmproperty. - Specify the encryption key length with the
KeyLengthproperty. - Establish the cipher mode through the
CipherModeproperty. - Use the
SetEncodedIVmethod to set the IV, if needed by the cipher mode. - Set the encryption key with the
SetEncodedKeymethod. - Ensure the
PaddingSchemeproperty matches the encryptor's value.
When calling this method for public key decryption (i.e. decrypting a PKCS7 CMS message), the following setup is required:
- The
CryptAlgorithmproperty should be set to the string"pki". - Optionally specify the certificate to be used for decryption by calling
SetDecryptCert. If SetDecryptCert is not called, then Chilkat will automatically search certificate sources (Windows certificate stores,Apple keychain, etc.) for the required certificate.
Returns .T. for success, .F. for failure.
DecryptEncoded
Decrypts encoded encrypted data, and returns the decrypted data as a binary encoded string. For example:
EncodingMode → Decrypt → Encode EncodingMode → Output
The encoding (e.g. base64, hex, etc.) is determined by the EncodingMode property.
This method supports symmetric key and public key decryption. For more information on properties that affect decryption, such as CryptAlgorithm, CipherMode, etc., refer to the DecryptBd method documentation.
Returns .F. on failure
DecryptSb
This function is intended for use when the expected decrypted output is text. It decrypts the contents of bdIn and appends the resulting string to sbOut. Ensure that the Charset property, such as utf-8, matches the one used during encryption to interpret the decrypted bytes correctly as characters.
Charset → Append to StringBuilder
This method supports symmetric key and public key decryption. For more information on properties that affect decryption, such as CryptAlgorithm, CipherMode, etc., refer to the DecryptBd method documentation.
Returns .T. for success, .F. for failure.
DecryptSecureENC
This function is intended for use when the expected decrypted output is text. It decrypts binary encoded encrypted bytes passed in cipherText and appends the resulting string to secureStr. Ensure that the Charset property, such as utf-8, matches the one used during encryption to interpret the decrypted bytes correctly as characters.
EncodingMode → Decrypt → Interpret Bytes according to Charset → Append to Secure String
The encoding (e.g. base64, hex, etc.) is determined by the EncodingMode property.
This method supports symmetric key and public key decryption. For more information on properties that affect decryption, such as CryptAlgorithm, CipherMode, etc., refer to the DecryptBd method documentation.
Returns .T. for success, .F. for failure.
DecryptStringENC
This function is intended for use when the expected decrypted output is text. It decrypts binary encoded encrypted bytes passed in str and appends the resulting string to ARG2. Ensure that the Charset property, such as utf-8, matches the one used during encryption to interpret the decrypted bytes correctly as characters.
EncodingMode → Decrypt → Interpret Bytes according to Charset → Output
The encoding (e.g. base64, hex, etc.) is determined by the EncodingMode property.
This method supports symmetric key and public key decryption. For more information on properties that affect decryption, such as CryptAlgorithm, CipherMode, etc., refer to the DecryptBd method documentation.
Returns .F. on failure
EncodeInt
Encodes an integer to N bytes and returns in the specified encoding. If littleEndian is .T., then little-endian byte ordering is used. Otherwise big-endian byte order is used.
Returns .F. on failure
EncodeString
Encodes a string. The toEncodingName can be set to any of the following strings: base64, hex, quoted-printable, url, base32, Q, B, url_rc1738, url_rfc2396, url_rfc3986, url_oauth, uu, modBase64, or html (for HTML entity encoding). The charsetName is important, and usually you'll want to specify ansi. For example, if the string ABC is to be encoded to hex using ANSI, the result will be 414243. However, if unicode is used, the result is 410042004300.
Returns .F. on failure
EncryptBd
Encrypts the contents of bd. This method can do either symmetric key encryption or CMS public key encryption (e.g., PKCS#7 EnvelopedData).
Before calling this method for symmetric key encryption (e.g., AES, ChaCha20, Blowfish, etc.), ensure the following setup:
- Define the encryption algorithm using the
CryptAlgorithmproperty. - Specify the encryption key length with the
KeyLengthproperty. - Establish the cipher mode through the
CipherModeproperty. - Use the
SetEncodedIVmethod to set the IV, if needed by the cipher mode. - Set the encryption key with the
SetEncodedKeymethod. - Set the
PaddingSchemeproperty if needing something different than the default.
When calling this method for public key encryption (i.e. creating a PKCS7 CMS message), the following setup is required:
- The
CryptAlgorithmproperty should be set to the string"pki". - To specify the encryption certificate, use
SetEncryptCert. For multiple certificates, callAddEncryptCertfor each one.
Returns .T. for success, .F. for failure.
EncryptEncoded
Encrypts binary-encoded data and returns it as a binary-encoded string. For example:
EncodingMode → Encrypt → Encode EncodingMode → Output
The encoding (e.g. base64, hex, etc.) is determined by the EncodingMode property.
This method supports symmetric key and public key decryption. For more information on properties that affect decryption, such as CryptAlgorithm, CipherMode, etc., refer to the method documentation.
Returns .F. on failure
EncryptSb
Encrypts text and appends the encrypted bytes in bdOut.
The Charset property, such as utf-8, determines the actual bytes that are encrypted.
StringBuilder → Get bytes according to Charset → Encrypt → Append to BinData
This method supports symmetric key and public key encryption. For more information on properties that affect encryption, such as CryptAlgorithm, CipherMode, etc., refer to the EncryptBd method documentation.
Returns .T. for success, .F. for failure.
EncryptSecureENC
Identical to EncryptStringENC, except the clear-text contained within the secureStr is encrypted and returned.
Returns .F. on failure
EncryptStringENC
Encrypts a string and returns the encrypted bytes as a binary encoded string. The EncodingMode property determines the binary encoding, such as base64, hex, hex_lower, base64url, base58, etc. The Charset property determines the actual bytes that are encrypted.
Returns .F. on failure
GenEncodedSecretKey
Important: In the v9.5.0.49 release, a bug involving this method was introduced: The encoding is ignored and instead the encoding used is the current value of the EncodingMode property. The workaround is to make sure the EncodingMode property is set to the value of the desired output encoding. This problem will be fixed in v9.5.0.50.
Identical to the GenerateSecretKey method, except it returns the binary secret key as a string encoded according to encoding, which may be base64, hex, url, etc. Please see the documentation for GenerateSecretKey for more information.
Returns .F. on failure
GenerateUuid
Generates a random UUID string having standard UUID format, such as de305d54-75b4-431b-adb2-eb6b9e546014.
Note: This generates a version 4 UUID using random byte values. See RFC 4122.
Returns .F. on failure
GenRandomBytesENC
Generates numBytes random bytes and returns them as an encoded string. The encoding, such as base64, hex, etc. is controlled by the EncodingMode property.
Returns .F. on failure
GetEncodedAad
Returns the authenticated additional data as an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, or url.
The Aad is used when the CipherMode is gcm (Galois/Counter Mode), which is a mode valid for symmetric ciphers that have a block size of 16 bytes, such as AES or Twofish.
Returns .F. on failure
GetEncodedAuthTag
Returns the authentication tag as an encoded string. The encoding argument may be set to any of the following strings: base64, hex, quoted-printable, or url. The authentication tag is an output of authenticated encryption modes such as GCM when encrypting. When GCM mode decrypting, the authenticate tag is set by the application and is the expected result.
The authenticated tag plays a role when the CipherMode is gcm (Galois/Counter Mode), which is a mode valid for symmetric block ciphers that have a block size of 16 bytes, such as AES or Twofish.
Returns .F. on failure
GetEncodedIV
Returns the initialization vector as an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, or url.
Returns .F. on failure
GetEncodedKey
Returns the secret key as an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, or url.
Returns .F. on failure
GetEncodedSalt
Returns the password-based encryption (PBE) salt bytes as an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, or url.
Returns .F. on failure
GetLastJsonData
Provides information about what transpired in the last method called. For many methods, there is no information. For some methods, details about what transpired can be obtained via LastJsonData. For example, after calling a method to verify a signature, the LastJsonData will return JSON with details about the algorithms used for signature verification.
topGetSignatureSigningTimeStr
This method retrieves the signing time of the Nth certificate used in a digital signature, after verification. The first certificate's signing time is at index index 0. The NumSignerCerts property indicates the total number of signing certificates (typically, only one is used).
Note: Before retrieving the signing time for a certificate, use the HasSignatureSigningTime method to check its availability. Skip indices without a signing time.
The signing time is returned in RFC822 string format.
Returns .F. on failure
GetSignedAttributes
Extracts the signed (authenticated) attributes for the Nth signer. In most cases, a signature has only one signer, and the signerIndex should equal 0 to specify the 1st (and only) signer.
The binary PKCS7 is passed in pkcs7Der. On success, the sbJson will contain the signed attributes in JSON format.
Sample JSON output:
{
<code>signedAttributes</code>: [
{
<code>oid</code>: <code>1.2.840.113549.1.9.3</code>,
<code>name</code>: <code>Content Type</code>
},
{
<code>oid</code>: <code>1.2.840.113549.1.9.5</code>,
<code>name</code>: <code>Signing Time</code>
},
{
<code>oid</code>: <code>1.2.840.113549.1.9.4</code>,
<code>name</code>: <code>Message Digest</code>
},
{
<code>oid</code>: <code>1.2.840.113549.1.9.16.2.47</code>,
<code>name</code>: <code>Signing Certificate V2</code>
}
]
}
Returns .T. for success, .F. for failure.
topHashBdENC
Hashes the bytes in bd and returns the hash as a binary-encoded string. The hash algorithm is determined by the HashAlgorithm property, while the encoding is specified by the EncodingMode property. Encoding options include base64, hex, base64url, or others listed at the link below.
Returns .F. on failure
HashBeginString
To hash a large amount of text, start by processing the first chunk using this method. For subsequent chunks, use the HashMoreString method as needed. Conclude by calling HashFinal (or HashFinalENC) to obtain the final result. The hash algorithm is determined by the HashAlgorithm property setting.
Returns .T. for success, .F. for failure.
HashChunkBd
Start or continue hashing data in chunks. Set firstChunk to .T. for the first chunk, and .F. for subsequent chunks. Finish by calling HashFinalENC to obtain the result. The hash algorithm used is determined by the HashAlgorithm property.
Returns .T. for success, .F. for failure.
topHashFileENC
Hashes a file and returns the hash as an encoded string.
The hash algorithm is specified by the HashAlgorithm property, The encoding is controlled by the EncodingMode property, which can be set to base64, hex, base64url, or any of the encodings listed at the link below.
Any size file is supported because the file is hashed internally in streaming mode (keeping memory usage low and constant).
Returns .F. on failure
HashFileENCAsync (1)
Creates an asynchronous task to call the HashFileENC method with the arguments provided.
Returns .F. on failure
HashFinalENC
Finalizes a multi-step hash computation and returns the hash bytes encoded according to the EncodingMode property setting.
Returns .F. on failure
HashMoreString
Adds more text to the hash currently under computation. (See HashBeginString)
Returns .T. for success, .F. for failure.
topHashStringENC
Hashes a string and returns the hash bytes as an encoded string.
The hash algorithm is specified by the HashAlgorithm property, The encoding is controlled by the EncodingMode property, which can be set to base64, hex, base64url, or any of the encodings listed at the link below.
The Charset property controls the character encoding of the string that is hashed. Languages such as VB.NET, C#, and Visual Basic work with Unicode strings. If it is desired to hash Unicode directly (2 bytes/char) then set the Charset property to Unicode. To implicitly convert to another charset before hashing, set the Charset property to the desired charset. For example, if Charset is set to iso-8859-1, the input string is first implicitly converted to iso-8859-1 (1 byte per character) before hashing. The full list of supported charsets is listed in the EncryptString method description.
Returns .F. on failure
HasSignatureSigningTime
This method can be called after a digital signature has been verified by one of the Verify* methods. Returns .T. if a signing time for the Nth certificate is available and can be retrieved by either the GetSignatureSigningTime or GetSignatureSigningTimeStr methods.
Hotp
Implements RFC 4226: HOTP: An HMAC-Based One-Time Password Algorithm. The arguments to this method are:
- secret: The shared secret in an enocded representation such as base64, hex, ascii, etc.
- secretEnc: The encoding of the shared secret, such as
base64 - counterHex: The 8-byte counter in hexidecimal format.
- numDigits: The number of decimal digits to return.
- truncOffset: Normally set this to -1 for dynamic truncation. Otherwise can be set in the range 0..15.
- hashAlg: Normally set to
sha1. Can be set to other hash algorithms such assha256,sha512, etc.
Returns .F. on failure
LastDecryptCert
Returns in cert the last certificate used for public-key decryption.
Returns .T. for success, .F. for failure.
topLastSignerCert
Returns the Nth certificate used for signing in cert. This method can be called after verifying a digital signature to get the signer certs. The 1st certificate is at index 0. The NumSignerCerts property contains the total number of signing certificates. (Typically, a single certificate is used in creating a digital signature.)
Returns .T. for success, .F. for failure.
topLoadTaskCaller
MacBdENC
Computes a Message Authentication Code (MAC) for the bytes in bd using the algorithm defined in the MacAlgorithm property. The result is then encoded to a string using the format specified by the EncodingMode property (e.g., base64, hex). The HashAlgorithm property setting determines the hash algorithm used internally. (A MAC algorithm like HMAC uses a hash function such as SHA-256 internally, along with a secret key, to create a secure and verifiable digest.)
Returns .F. on failure
MacStringENC
Computes a Message Authentication Code using the MAC algorithm specified in the MacAlgorithm property. The result is encoded to a string using the encoding (base64, hex, etc.) specified by the EncodingMode property.
Returns .F. on failure
MySqlAesDecrypt
Matches MySQL's AES_DECRYPT function. strEncryptedHex is a hex-encoded string of the AES encrypted data. The return value is the original unencrypted string.
Returns .F. on failure
MySqlAesEncrypt
Matches MySQL's AES_ENCRYPT function. The return value is a hex-encoded string of the encrypted data. The equivalent call in MySQL would look like this: HEX(AES_ENCRYPT('The quick brown fox jumps over the lazy dog','password'))
Returns .F. on failure
OpaqueSignBd
Digitally signs the contents of bd. If successful, the contents of bd are replaced with the PKCS#7 signed-data, which embeds the original data within the signature. Ensure a certificate is set using SetSigningCert before invoking this method. The HashAlgorithm property specifies the hash algorithm for creating the data's hash during signing.
Returns .T. for success, .F. for failure.
OpaqueSignBdAsync (1)
Creates an asynchronous task to call the OpaqueSignBd method with the arguments provided.
Returns .F. on failure
OpaqueSignStringENC
Digitally signs a string and returns PKCS#7 signed-data as a binary encoded string. The EncodingMode property determines the binary encoding, such as base64, hex, hex_lower, base64_mime, etc. The Charset property determines the actual bytes that are hashed and signed. The HashAlgorithm property specifies the hash algorithm for creating the data's hash during signing.
Returns .F. on failure
OpaqueSignStringENCAsync (1)
Creates an asynchronous task to call the OpaqueSignStringENC method with the arguments provided.
Returns .F. on failure
OpaqueVerifyBd
The method performs in-place verification of the PKCS#7 signed-data content of bd. If the signature is successfully verified, the content of bd is replaced with the original data, and the method returns .T.. If verification fails, bd remains unchanged, and the method returns .F.. Afterwards, you can retrieve signer certificates by using the NumSignerCerts property and the GetSignerCert method.
Returns .T. for success, .F. for failure.
OpaqueVerifyStringENC
This function verifies a PKCS#7 signed-data binary-encoded signature and returns the original text data. The EncodingMode property determines how p7m is decoded to bytes. If the signature does not verify successfully, it returns an empty string. The Charset property specifies how the original data bytes are converted to characters. You can obtain signer certificates using the NumSignerCerts property and the GetSignerCert method.
Returns .F. on failure
Pbkdf1
Implements the PBKDF1 algorithm (Password Based Key Derivation Function #1). The password is converted to the character encoding represented by charset before being passed (internally) to the key derivation function. The hashAlg may be md5, sha1, md2, etc. The salt should be random data at least 8 bytes (64 bits) in length. (The GenRandomBytesENC method is good for generating a random salt value.) The iterationCount should be no less than 1000. The length (in bits) of the derived key output by this method is controlled by outputKeyBitLen. The encoding argument may be base64, hex, etc. It controls the encoding of the output, and the expected encoding of the salt. The derived key is returned.
Note: Starting in version 9.5.0.47, if the charset is set to one of the keywords hex or base64, then the password will be considered binary data that is hex or base64 encoded. The bytes will be decoded and used directly as a binary password.
Returns .F. on failure
Pbkdf2
Implements the PBKDF2 algorithm as follows:
- Convert password to the character encoding specified by charset before using it in the key derivation function.
- hashAlg specifies the hash algorithm. Options include
sha256,sha384,sha512,md5,sha1,md2, or any algorithm listed in the HashAlgorithm property. - Provide a random salt value that is at least 8 bytes (64 bits) long. Use methods like GenRandomBytesENC to generate this salt value.
- Ensure iterationCount is 1000 or greater.
- Control the length of the derived key output using outputKeyBitLen.
- Set encoding to specify the encoding format for the output and the expected encoding for salt. Options include
base64andhex.
The derived key is the output of this process. Internally, PBKDF2 uses a pseudorandom function (PRF), specifically a keyed HMAC. The hash algorithm chosen with hashAlg dictates this PRF; for example, SHA256 uses HMAC-SHA256, while SHA1 uses HMAC-SHA1.
Note: If charset is hex or base64, password is treated as binary data. It will be decoded and used directly as a binary password.
SHA256 uses HMAC-SHA256, while SHA1 uses HMAC-SHA1.
PBKDF1 and PBKDF2 are both key derivation functions used to strengthen passwords for cryptographic purposes, but PBKDF2 is the improved version.
- PBKDF1: Older and limited—it can only generate small keys (up to the hash function’s output size), making it less flexible and secure.
- PBKDF2: More advanced—it can generate longer keys, is more resistant to attacks, and is widely recommended for modern security needs.
In short, PBKDF2 is stronger and more versatile than PBKDF1.
Returns .F. on failure
RandomizeIV
Sets the initialization vector to a random value.
topRandomizeKey
Sets the secret key to a random value.
topReEncode
This tool allows for conversion between different encodings, such as from base64 to hex. It's particularly useful in programming environments where handling byte arrays is cumbersome. The encodings that can be specified for fromEncoding and toEncoding include: Base64, base64Url, modBase64, Base32, Base58, UU, QP (quoted-printable), URL (URL-encoding), Hex, Q, B, url_oauth, url_rfc1738, url_rfc2396, and url_rfc3986. Note that these encodings are case-insensitive.
Returns .F. on failure
SetDecryptCert
Sets the digital certificate to be used for decryption when the CryptAlgorithm property is set to PKI. A private key is required for decryption. Because this method only specifies the certificate, a prerequisite is that the certificate w/ private key must have been pre-installed on the computer. Private keys are stored in the Windows Protected Store (either a user account specific store, or the system-wide store). The Chilkat component will automatically locate and find the certificate's corresponding private key from the protected store when decrypting.
Returns .T. for success, .F. for failure.
topSetDecryptCert2
Sets the digital certificate to be used for decryption when the CryptAlgorithm property is set to PKI. The private key is supplied in the 2nd argument to this method, so there is no requirement that the certificate be pre-installed on a computer before decrypting (if this method is called).
Returns .T. for success, .F. for failure.
topSetEncodedAad
Sets the authenticated additional data from an encoded string. The authenticated additional data (AAD), if any, is used in authenticated encryption modes such as GCM. The aadStr argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url.
The Aad is used when the CipherMode is gcm (Galois/Counter Mode), which is a mode valid for symmetric ciphers that have a block size of 16 bytes, such as AES or Twofish.
Returns .T. for success, .F. for failure.
SetEncodedAuthTag
Sets the expected authenticated tag from an encoded string. The authenticated tag is used in authenticated encryption modes such as GCM. An application would set the expected authenticated tag prior to decrypting. The authTagStr argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url.
The authenticated tag plays a role when the CipherMode is gcm (Galois/Counter Mode), which is a mode valid for symmetric block ciphers that have a block size of 16 bytes, such as AES or Twofish.
Note: You can set the authenticated tag to the special value FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF (16 0xFF bytes) to prevent Chilkat from checking the auth tag after decrypting.
Returns .T. for success, .F. for failure.
SetEncodedIV
Sets the initialization vector from an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url.
SetEncodedKey
Sets the secret key from an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url.
SetEncodedSalt
Sets the password-based encryption (PBE) salt bytes from an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url.
SetEncryptCert
Tells the encryption library to use a specific digital certificate for public-key encryption. To encrypt with multiple certificates, call AddEncryptCert once for each certificate. (Calling this method is the equivalent of calling ClearEncryptCerts followed by AddEncryptCert.)
Returns .T. for success, .F. for failure.
SetMacKeyEncoded
Sets the MAC key to be used for one of the Mac methods. The encoding can be set to any of the following strings: base64, hex, quoted-printable, or url.
Returns .T. for success, .F. for failure.
SetMacKeyString
Sets the MAC key to be used for one of the Mac methods.
Returns .T. for success, .F. for failure.
SetSecretKeyViaPassword
Accepts a password string and (internally) generates a binary secret key of the appropriate bit length and sets the SecretKey property. This method should only be used if you are using Chilkat for both encryption and decryption because the password-to-secret-key algorithm would need to be identical for the decryption to match the encryption.
There is no minimum or maximum password length. The password string is transformed to a binary secret key by computing the MD5 digest (of the utf-8 password) to obtain 16 bytes. If the KeyLength is greater than 16 bytes, then the MD5 digest of the Base64 encoding of the utf-8 password is added. A max of 32 bytes of key material is generated, and this is truncated to the actual KeyLength required. The example below shows how to manually duplicate the computation.
SetSigningCert
Specifies a certificate to be used when creating PKCS7 digital signatures. Signing requires both a certificate and private key. In this case, the private key is implicitly specified if the certificate originated from a PFX that contains the corresponding private key, or if on a Windows-based computer where the certificate and corresponding private key are pre-installed. (If a PFX file is used, it is provided via the AddPfxSourceFile or AddPfxSourceData methods.)
Returns .T. for success, .F. for failure.
SetSigningCert2
Specifies a digital certificate and private key to be used for creating PKCS7 digital signatures.
Returns .T. for success, .F. for failure.
SetTsaHttpObj
Sets the timestamp authority (TSA) options for cases where a CAdES-T signature is to be created. The http is used to send the requests, and it allows for connection related settings and timeouts to be set. For example, if HTTP or SOCKS proxies are required, these features can be specified on the http.
topSetVerifyCert
Sets the digital certificate to be used in verifying a signature. In virtually all cases, a PKCS7 (CMS) signature already embeds the signing certificate information, and it is not necessary to explicitly call this method to specify the verification certificate. It is only needed in rare cases.
Returns .T. for success, .F. for failure.
SignBdENC
Digitally signs the content in dataToSign and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string. The EncodingMode property determines the binary-encoding. Possible encodings include base64, base64_mime, hex, and hex_lower. The HashAlgorithm property specifies the hash algorithm for creating the data's hash during signing.
Returns .F. on failure
SignBdENCAsync (1)
Creates an asynchronous task to call the SignBdENC method with the arguments provided.
Returns .F. on failure
SignHashENC
Digitally signs a pre-computed hash and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string. The EncodingMode property determines the binary-encoding. Possible encodings include base64, base64_mime, hex, and hex_lower
encodedHash is a binary-encoded hash to be signed, with its encoding format specified by hashEncoding (e.g., base64, hex). hashAlg specifies the hash algorithm (e.g., sha256, sha1, sha512) used for encodedHash.
Returns .F. on failure
SignHashENCAsync (1)
Creates an asynchronous task to call the SignHashENC method with the arguments provided.
Returns .F. on failure
SignSbENC
Digitally signs the text contained in sb and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string. The EncodingMode property determines the binary-encoding. Possible encodings include base64, base64_mime, hex, and hex_lower. The HashAlgorithm property specifies the hash algorithm for creating the data's hash during signing. The Charset property determines the actual bytes that are hashed and signed.
Returns .F. on failure
SignSbENCAsync (1)
Creates an asynchronous task to call the SignSbENC method with the arguments provided.
Returns .F. on failure
SignStringENC
Digitally signs a string and returns a detached signature (PKCS#7 signed-data) as a binary-encoded string. The EncodingMode property determines the binary-encoding. Possible encodings include base64, base64_mime, hex, and hex_lower. The HashAlgorithm property specifies the hash algorithm for creating the data's hash during signing. The Charset property determines the actual bytes that are hashed and signed.
Returns .F. on failure
SignStringENCAsync (1)
Creates an asynchronous task to call the SignStringENC method with the arguments provided.
Returns .F. on failure
Totp
Implements RFC 6238: TOTP: Time-Based One-Time Password Algorithm. The arguments to this method are:
- secret: The shared secret in an enocded representation such as base64, hex, ascii, etc.
- secretEnc: The encoding of the shared secret, such as
base64 - t0: The Unix time to start counting time steps. It is a number in decimal string form. A Unix time is the number of seconds elapsed since midnight UTC of January 1, 1970.
0is a typical value used for this argument. - tNow: The current Unix time in decimal string form. To use the current system date/time, pass an empty string for this argument.
- tStep: The time step in seconds. A typical value is 30. Note: Both client and server must pre-agree on the secret, the t0, and the tStep.
- numDigits: The number of decimal digits to return.
- truncOffset: Normally set this to -1 for dynamic truncation. Otherwise can be set in the range 0..15.
- hashAlg: Normally set to
sha1. Can be set to other hash algorithms such assha256,sha512, etc.
Returns .F. on failure
UseCertVault
Adds an XML certificate vault to the object's internal list of sources to be searched for certificates and private keys when encrypting/decrypting or signing/verifying. Unlike the AddPfxSourceData and AddPfxSourceFile methods, only a single XML certificate vault can be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.
Returns .T. for success, .F. for failure.
topVerifyBdENC
Verifies a detached digital signature against the original data contained in data. Returns .T. if the signature is verified. The encodedSig holds a binary-encoded PKCS#7 signed-data detached signature. The type of binary encoding, such as base64, hex, or base64_mime, is determined by the EncodingMode property.
Afterwards, you can retrieve signer certificates by using the NumSignerCerts property and the GetSignerCert method.
Returns .T. for success, .F. for failure.
VerifyP7M
Verifies an opaque digital signature contained in a .p7m file and extracts the original data to destPath. Returns .T. if the .p7m is validated and the original data was extracted. Otherwise returns .F..
Afterwards, you can retrieve signer certificates by using the NumSignerCerts property and the GetSignerCert method.
Returns .T. for success, .F. for failure.
VerifyP7S
Verifies a detached digital signature contained in a .p7s file against the original data contained in originalDataPath. Returns .T. if the signature is verified.
Afterwards, you can retrieve signer certificates by using the NumSignerCerts property and the GetSignerCert method.
Returns .T. for success, .F. for failure.
VerifySbENC
Verifies a detached digital signature against the original text contained in sb. Returns .T. if the signature is verified. The encodedSig holds a binary-encoded PKCS#7 signed-data detached signature. The type of binary encoding, such as base64, hex, or base64_mime, is determined by the EncodingMode property. The Charset property determines how the text in sb is converted to bytes for signature validation.
Afterwards, you can retrieve signer certificates by using the NumSignerCerts property and the GetSignerCert method.
Returns .T. for success, .F. for failure.
VerifyStringENC
Verifies a detached digital signature against the original text in str. Returns .T. if the signature is verified. The encodedSig holds a binary-encoded PKCS#7 signed-data detached signature. The type of binary encoding, such as base64, hex, or base64_mime, is determined by the EncodingMode property. The Charset property determines how the text in str is converted to bytes for signature validation.
Afterwards, you can retrieve signer certificates by using the NumSignerCerts property and the GetSignerCert method.
Returns .T. for success, .F. for failure.
XtsSetDataUnitNumber
Sets the XTS-AES mode data unit number. The data unit number is a 64-bit unsigned integer. It is passed in as two 32-bit unsigned integers representing the high and low 32-bits.
Setting the data unit number is one way of setting the tweak value. The tweak value is 16 bytes in length and can alternatively be set by calling XtsSetEncodedTweakValue.
This method sets the tweak value such that the first 8 bytes are composed of the little-endian 64-bit data unit number, followed by 8 zero bytes.
(Unfortunately, Chilkat cannot use 64-bit integers in method arguments because many older programming environments, such as ActiveX, do not support it. Chilkat must present an identical and uniform API across all programming languages.)
XtsSetEncodedTweakKey
Sets the XTS-AES mode tweak key from an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url. The tweak key should be equal in size to the encryption key. For example, to do 256-bit AES-XTS, the encryption key is 256-bits, and the tweak key is also 256-bits.
XtsSetEncodedTweakValue
Sets the XTS-AES mode tweak value from an encoded string. The encoding argument can be set to any of the following strings: base64, hex, quoted-printable, ascii, or url.
The tweak value must be 16 bytes in length. An application can set the initial tweak value by calling this method, or by calling XtsSetDataUnitNumber (but not both).
Deprecated
DecryptStream
This method is deprecated. Applications should implement streaming decryption by using the FirstChunk and LastChunk properties.
Returns .T. for success, .F. for failure.
DecryptStreamAsync (1)
Creates an asynchronous task to call the DecryptStream method with the arguments provided.
Returns .F. on failure
EncryptStream
This method is deprecated. Applications should implement streaming encryption or decryption by using the FirstChunk and LastChunk properties.
Returns .T. for success, .F. for failure.
EncryptStreamAsync (1)
Creates an asynchronous task to call the EncryptStream method with the arguments provided.
Returns .F. on failure
GetDecryptCert
This method is deprecated. Application should instead call LastDecryptCert
Returns the last certificate used for public-key decryption.
Returns .F. on failure
GetSignerCert
This method is deprecated. Application should instead call LastSignerCert
Gets the Nth certificate used for signing. This method can be called after verifying a digital signature to get the signer certs. The 1st certificate is at index 0. The NumSignerCerts property contains the total number of signing certificates. (Typically, a single certificate is used in creating a digital signature.)
Returns .F. on failure
GetSignerCertChain
This method is deprecated. Applications can get the cert chain by calling LastSignerCert to get the certificate object, and then get the certificate chain from the certificate object.
Returns the full certificate chain for the Nth certificate used to for signing. Indexing begins at 0.
Returns .F. on failure
LastJsonData
This method is deprecated. Please use GetLastJsonData instead.
GetLastJsonData provides details about the most recently executed method. While many methods don't provide additional information, some do, such as after verifying a signature. In such cases, LastJsonData will return JSON with details like the algorithms used in the verification process.
Returns .F. on failure
VerifyDetachedSignature
This method is the same as VerifyP7S. Applications should instead call VerifyP7S.