Crypt2 Excel Class Module Reference Documentation

Crypt2

Current Version: 9.5.0.78

Chilkat encryption component.

Object Creation

Dim oCrypt2 As Chilkat.Crypt2
Set oCrypt2 = Chilkat.NewCrypt2

Properties

AbortCurrent
AbortCurrent As Long
Introduced in version 9.5.0.58

When set to True, 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 False when the next method is called. When the abort occurs, this property is reset to False. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
BCryptWorkFactor
BCryptWorkFactor As Long
Introduced in version 9.5.0.65

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.

top
BlockSize
BlockSize As Long (read only)

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.

top
CadesEnabled
CadesEnabled As Long

Applies to all methods that create PKCS7 signatures. To create a CAdES-BES signature, set this property equal to True. The default value of this property is False.

top
CadesSigPolicyHash
CadesSigPolicyHash As String

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: 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 = True, and also provide values for each of the following properties: CadesSigPolicyHash, CadesSigPolicyId, and CadesSigPolicyUri. For example (in pseudo-code):

cryptObj.CadesSigPolicyId = "2.16.76.1.7.1.1.1"
cryptObj.CadesSigPolicyUri = "http://politicas.icpbrasil.gov.br/PA_AD_RB.der"
cryptObj.CadesSigPolicyHash = "rySugyKaMhiMR8Y/o5yuU2A2bF0="
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
CadesSigPolicyId As String

See the description for the CadesSigPolicyHash property above.

top
CadesSigPolicyUri
CadesSigPolicyUri As String

See the description for the CadesSigPolicyHash property above.

top
Charset
Charset As String

Controls the character encoding of the text encrypted, signed, hashed or compressed. This property is relevant wherever strings are used as inputs or outputs.

This property defaults to the ANSI charset of the computer. For example, the default ANSI code page on Windows computers in the USA and Western Europe would be "windows-1252".

When working with strings, it is important to know the exact bytes that are being encrypted/hashed/signed/compressed. This is critical when interoperating with other systems. If your application is sending an encrypted string to another system that will decrypt it, you will need to know the encoding of the string that is expected on the receiving end (after decryption). If you pass Unicode data (2 byte per character) to the encryptor, subsequent decryption will reproduce the original Unicode. However, it may be that your program works with Unicode strings, but the recipient of the encrypted data works with iso-8859-1 strings. In such a case, setting the Charset property to "iso-8859-1" causes the character data to be automatically converted to the Charset before being encrypted (or compressed, or hashed, or signed). The set of valid charsets is listed below:

<font size="2" face="MS Sans Serif">
hex
base64
    * "hex" and "base64" are special values that allow for binary (non-text) encoded data to be passed to any method where the input data is a string.
       Rather than converting to an actual charset (such as utf-8, iso-8859-1), the binary data is decoded, and the decoded bytes are passed
        to the underlying encryptor, hashing, signing, etc.
ANSI
us-ascii
unicode
unicodefffe
iso-8859-1
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
windows-874
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
utf-7
utf-8
utf-32
utf-32be
shift_jis
gb2312
ks_c_5601-1987
big5
iso-2022-jp
iso-2022-kr
euc-jp
euc-kr
macintosh
x-mac-japanese
x-mac-chinesetrad
x-mac-korean
x-mac-arabic
x-mac-hebrew
x-mac-greek
x-mac-cyrillic
x-mac-chinesesimp
x-mac-romanian
x-mac-ukrainian
x-mac-thai
x-mac-ce
x-mac-icelandic
x-mac-turkish
x-mac-croatian
asmo-708
dos-720
dos-862
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u

top
CipherMode
CipherMode As String

Controls 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 CookBook
  • CTR: Counter Mode
  • CFB: Cipher Feedback
  • OFB: Output Feedback
  • GCM: Galois/Counter Mode

(see http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation )

Note: 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.

top
CmsOptions
CmsOptions As String
Introduced in version 9.5.0.78

A JSON string for controlling extra CMS (PKCS7) signature and validation options.

top
CryptAlgorithm
CryptAlgorithm As String

Selects the encryption algorithm for encrypting and decrypting. Possible values are: "chacha20", "pki", "aes", "blowfish", "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 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 has a 4321 byte-swapping issue (the results are 4321 byte-swapped). The new implementation ("blowfish2") does not byte swap. This should be used for compatibility with other Blowfish software.

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.

More Information and Examples
top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EncodingMode
EncodingMode As String

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" and"decimal" 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.

More Information and Examples
top
FirstChunk
FirstChunk As Long

Chilkat Crypt2 provides the ability to feed the encryption/decryption methods with chunks of data. This allows a large amount of data, or a data stream, to be fed piecemeal for encrypting or decrypting. It applies to all symmetric algorithms currently supported (AES, Blowfish, Twofish, 3DES, RC2, DES, ARC4), and all algorithms supported in the future.

The default value for both FirstChunk and LastChunk is True. This means when an Encrypt* or Decrypt* method is called, it is both the first and last chunk (i.e. it's the entire amount of data to be encrypted or decrypted).

If you wish to feed the data piecemeal, do this:

  1. Set FirstChunk = True, LastChunk = False for the first chunk of data.
  2. For all "middle" chunks (i.e. all chunks except for the final chunk) set FirstChunk = False and LastChunk = False.
  3. For the final chunk, set FirstChunk = False and LastChunk = True

There is no need to worry about feeding data according to the block size of the encryption algorithm. For example, AES has a block size of 16 bytes. Data may be fed in chunks of any size. The Chilkat Crypt2 component will buffer the data. When the final chunk is passed, the output is padded to the algorithm's block size according to the PaddingScheme.

top
HashAlgorithm
HashAlgorithm As String

Selects the hash algorithm used by methods that create hashes. The valid choices are "sha1", "sha256", "sha384", "sha512", "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 "sha1".

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.

top
HavalRounds
HavalRounds As Long

Applies to the HAVAL hash algorithm only and must be set to the integer value 3, 4, or 5. The default value is 3.

top
IncludeCertChain
IncludeCertChain As Long

Only applies when creating digital signatures. If True (the default), then additional certificates (if any) in the chain of authentication are included in the PKCS7 digital signature.

top
InitialCount
InitialCount As Long
Introduced in version 9.5.0.55

The initial counter for the ChaCha20 encryption algorithm. The default value is 0.

top
IterationCount
IterationCount As Long

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.

top
KeyLength
KeyLength As Long

The key length in bits for symmetric encryption algorithms. The default value is 256.

top
LastChunk
LastChunk As Long

(See the description for the FirstChunk property.)

top
LastErrorHtml
LastErrorHtml As String (read only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
MacAlgorithm
MacAlgorithm As String
Introduced in version 9.5.0.55

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

More Information and Examples
top
NumSignerCerts
NumSignerCerts As Long (read only)

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.

top
OaepHash
OaepHash As String
Introduced in version 9.5.0.67

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"

top
OaepMgfHash
OaepMgfHash As String
Introduced in version 9.5.0.71

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 "sha1".

top
OaepPadding
OaepPadding As Long
Introduced in version 9.5.0.67

Selects the RSA encryption scheme when encrypting using "pki" (with a certificate and private key). The default value is False, which selects RSAES_PKCS1-V1_5. If set to True, then RSAES_OAEP is used.

top
PaddingScheme
PaddingScheme As Long

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

top
PbesAlgorithm
PbesAlgorithm As String

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

top
PbesPassword
PbesPassword As String

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

top
Pkcs7CryptAlg
Pkcs7CryptAlg As String

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

top
Rc2EffectiveKeyLength
Rc2EffectiveKeyLength As Long

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

top
SigningAlg
SigningAlg As String
Introduced in version 9.5.0.67

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.

top
SigningAttributes
SigningAttributes As String
Introduced in version 9.5.0.75

Contains JSON to specify the authenticated (signed) attributes or unauthenticated (unsigned) attributes that are to be included in CMS signatures. The default value is:

{
    "contentType": 1,
    "signingTime": 1,
    "messageDigest": 1
}

Other possible values that can be added are:

  • signingCertificateV2
  • signingCertificate
  • sMIMECapabilities
  • microsoftRecipientInfo
  • encrypKeyPref
Contact Chilkat (support@chilkatsoft.com) about other signed/unsigned attributes that may be needed for CAdES signatures.

More Information and Examples
top
UuFilename
UuFilename As String

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.

More Information and Examples
top
UuMode
UuMode As String

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.

top
VerboseLogging
VerboseLogging As Long

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read only)

Version of the component/library, such as "9.5.0.63"

top

Methods

AddEncryptCert
AddEncryptCert(cert As Cert)

Adds a certificate to be used for public-key encryption. (To use public-key encryption with digital certificates, set the CryptAlgorithm property = "pki".) To encrypt with more than one certificate , call AddEncryptCert once per certificate.

top
AddPfxSourceFile
AddPfxSourceFile(pfxFilePath As String, pfxPassword As String) As Long

Adds a PFX file to the object's internal list of sources to be searched for certificates and private keys when decrypting. Multiple PFX files can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)

The pfxFilePath contains the bytes of a PFX file (also known as PKCS12 or .p12).

Returns True for success, False for failure.

top
AesKeyUnwrap
AesKeyUnwrap(kek As String, wrappedKeyData As String, encoding As String) As String
Introduced in version 9.5.0.66

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 Nothing on failure

More Information and Examples
top
AesKeyWrap
AesKeyWrap(kek As String, keyData As String, encoding As String) As String
Introduced in version 9.5.0.66

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 Nothing on failure

More Information and Examples
top
BCryptHash
BCryptHash(password As String) As String
Introduced in version 9.5.0.65

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 Nothing on failure

More Information and Examples
top
BCryptVerify
BCryptVerify(password As String, bcryptHash As String) As Long
Introduced in version 9.5.0.65

Verifies the password against a previously computed BCrypt hash. Returns True if the password matches the bcryptHash. Returns False if the password does not match.

Returns True for success, False for failure.

top
CkDecryptFile
CkDecryptFile(srcFile As String, destFile As String) As Long

File-to-file decryption. There is no limit to the size of the file that can be decrypted because the component will operate in streaming mode internally.

Returns True for success, False for failure.

More Information and Examples
top
CkEncryptFile
CkEncryptFile(srcFile As String, destFile As String) As Long

File-to-file encryption. There is no limit to the size of the file that can be encrypted because the component will operate in streaming mode internally.

Returns True for success, False for failure.

top
ClearEncryptCerts
ClearEncryptCerts()

Clears the internal list of digital certificates to be used for public-key encryption.

top
CompressStringENC
CompressStringENC(str As String) As String

Compresses a string and returns the encoded compressed bytes. Prior to compressing, the string is converted to a byte representation such as utf-8, utf-16, etc. as determined by the Charset property. The output encoding is specified by the EncodingMode property. Otherwise, this method is the same as the CompressBytes method.

Returns Nothing on failure

top
CrcFile
CrcFile(crcAlg As String, path As String) As Long
Introduced in version 9.5.0.38

Calculates a CRC for the contents of a file. To compute the CRC used in the Zip file format, pass "CRC-32" for the crcAlg. (The crcAlg argument provides the flexibility to add additional CRC algorithms on an as-needed basis in the future.) A value of 0 is returned if the file is unable to be read. Given that there is a 1 in 4 billion chance of having an actual CRC of 0, an application might choose to react to a 0 return value by testing to see if the file can be opened and read.

top
CreateDetachedSignature
CreateDetachedSignature(inFilePath As String, sigFilePath As String) As Long

Digitally signs a file and writes the digital signature to a separate output file (a PKCS#7 signature file). The input file (inFilePath) is unmodified. A certificate for signing must be specified by calling SetSigningCert or SetSigningCert2 prior to calling this method.

This method is equivalent to CreateP7S. The CreateP7S method was added to clarify the format of the signature file that is created.

Returns True for success, False for failure.

top
CreateP7M
CreateP7M(inFilename As String, p7mPath As String) As Long

Digitally signs a file and creates a .p7m (PKCS #7 Message) file that contains both the signature and original file content. The input file (inFilename) is unmodified. A certificate for signing must be specified by calling SetSigningCert or SetSigningCert2 prior to calling this method.

To sign with a particular hash algorithm, set the HashAlgorithm property. Valid hash algorithms for signing are "sha256", "sha1", "sha384", "sha512", "md5", and "md2".

Note: The CreateP7M method creates an opaque signature. To do the same thing entirely in memory, your application would call any of the OpaqueSign* methods, such as OpaqueSignBd, OpaqueSignString, OpaqueSignStringENC, etc.

Returns True for success, False for failure.

top
CreateP7S
CreateP7S(inFilename As String, p7sPath As String) As Long

Digitally signs a file and creates a .p7s (PKCS #7 Signature) signature file. The input file (inFilename) is unmodified. The output file (p7sPath) contains only the signature and not the original data. A certificate for signing must be specified by calling SetSigningCert or SetSigningCert2 prior to calling this method.

To sign with a particular hash algorithm, set the HashAlgorithm property. Valid hash algorithms for signing are "sha256", "sha1", "sha384", "sha512", "md5", and "md2".

Note: The CreateP7S method creates a detached signature. To do the same thing entirely in memory, your application would call any of the Sign* methods, such as SignBdENC, SignString, SignStringENC, SignSbENC, etc.

Returns True for success, False for failure.

More Information and Examples
top
DecodeString
DecodeString(inStrArg As String, charset As String, encoding As String) As String

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 Nothing on failure

More Information and Examples
top
DecryptBd
DecryptBd(bd As BinData) As Long
Introduced in version 9.5.0.67

In-place decrypts the contents of bd. The minimal set of properties that should be set before decrypting are: CryptAlgorithm, SecretKey. Other properties that control encryption are: CipherMode, PaddingScheme, KeyLength, IV.

Returns True for success, False for failure.

top
DecryptEncoded
DecryptEncoded(encodedEncryptedData As String) As String

Encrypted data is passed to this method as an encoded string (base64, hex, etc.). This method first decodes the input data according to the EncodingMode property setting. It then decrypts and re-encodes using the EncodingMode setting, and returns the decrypted data in encoded string form.

Returns Nothing on failure

More Information and Examples
top
DecryptSb
DecryptSb(bdIn As BinData, sbOut As StringBuilder) As Long
Introduced in version 9.5.0.67

Decrypts the contents of bdIn to sbOut. The decrypted string is appended to sbOut. The minimal set of properties that should be set before ecrypting are: CryptAlgorithm, SecretKey. Other properties that control encryption are: CipherMode, PaddingScheme, KeyLength, IV.

Returns True for success, False for failure.

More Information and Examples
top
DecryptSecureENC
DecryptSecureENC(cipherText As String, secureStr As SecureString) As Long
Introduced in version 9.5.0.71

Identical to DecryptStringENC, except the decrypts the cipherText and appends the decrypted string to the secureStr.

Returns True for success, False for failure.

More Information and Examples
top
DecryptStream
DecryptStream(strm As Stream) As Long
Introduced in version 9.5.0.56

Decrypts a stream. Internally, the strm's source is read, decrypted, and the decrypted data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be decrypted with stable ungrowing memory usage.

Returns True for success, False for failure.

More Information and Examples
top
DecryptStringENC
DecryptStringENC(str As String) As String

The reverse of EncryptStringENC.

Decrypts string-encoded encrypted data and returns the original string. The property settings used when encrypting the string must match the settings when decrypting. Specifically, the Charset, EncodingMode, CryptAlgorithm, CipherMode, PaddingScheme, KeyLength, IV, and SecretKey properties must match.

Returns Nothing on failure

top
EncodeInt
EncodeInt(value As Long, numBytes As Long, littleEndian As Boolean, encoding As String) As String
Introduced in version 9.5.0.77

Encodes an integer to N bytes and returns in the specified encoding. If littleEndian is True, then little endian byte ordering is used. Otherwise big-endian byte order is used.

Returns Nothing on failure

More Information and Examples
top
EncodeString
EncodeString(strToEncode As String, charsetName As String, toEncodingName As String) As String

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 Nothing on failure

More Information and Examples
top
EncryptBd
EncryptBd(bd As BinData) As Long
Introduced in version 9.5.0.67

In-place encrypts the contents of bd. The minimal set of properties that should be set before encrypting are: CryptAlgorithm, SecretKey. Other properties that control encryption are: CipherMode, PaddingScheme, KeyLength, IV. When decrypting, all property settings must match otherwise the result is garbled data.

Returns True for success, False for failure.

top
EncryptEncoded
EncryptEncoded(str As String) As String

The input string is first decoded according to the encoding algorithm specified by the EncodingMode property (such as base64, hex, etc.) It is then encrypted according to the encryption algorithm specified by CryptAlgorithm. The resulting encrypted data is encoded (using EncodingMode) and returned.

Returns Nothing on failure

More Information and Examples
top
EncryptSb
EncryptSb(sbIn As StringBuilder, bdOut As BinData) As Long
Introduced in version 9.5.0.67

Encrypts the contents of sbIn to bdOut. The minimal set of properties that should be set before ecrypting are: CryptAlgorithm, SecretKey. Other properties that control encryption are: CipherMode, PaddingScheme, KeyLength, IV.

Returns True for success, False for failure.

More Information and Examples
top
EncryptSecureENC
EncryptSecureENC(secureStr As SecureString) As String
Introduced in version 9.5.0.71

Identical to EncryptStringENC, except the clear-text contained within the secureStr is encrypted and returned.

Returns Nothing on failure

More Information and Examples
top
EncryptStream
EncryptStream(strm As Stream) As Long
Introduced in version 9.5.0.56

Encrypts a stream. Internally, the strm's source is read, encrypted, and the encrypted data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be encrypted with stable ungrowing memory usage.

Returns True for success, False for failure.

More Information and Examples
top
EncryptStringENC
EncryptStringENC(str As String) As String

Encrypts a string and returns the encrypted data as an encoded (printable) string. The minimal set of properties that should be set before encrypting are: CryptAlgorithm, SecretKey, Charset, and EncodingMode. Other properties that control encryption are: CipherMode, PaddingScheme, KeyLength, IV. When decrypting (with DecryptStringENC), all property settings must match otherwise garbled data is returned. The Charset property controls the exact bytes that get encrypted. Languages such as VB.NET, C#, and Visual Basic work with Unicode strings, thus the input string is Unicode. If Unicode is to be encrypted (i.e. 2 bytes per character) then set the Charset property to "Unicode". To implicitly convert the string to another charset before the encryption is applied, set the Charset property to something else, such as "iso-8859-1", "Shift_JIS", "big5", "windows-1252", etc. (Refer to EncryptString for the complete list of charsets.)

The EncodingMode property controls the encoding of the string that is returned. It can be set to "Base64", "QP", or "Hex".

Returns Nothing on failure

top
GenEncodedSecretKey
GenEncodedSecretKey(password As String, encoding As String) As String

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 Nothing on failure

top
GenerateUuid
GenerateUuid() As String
Introduced in version 9.5.0.55

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 Nothing on failure

More Information and Examples
top
GenRandomBytesENC
GenRandomBytesENC(numBytes As Long) As String

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 Nothing on failure

More Information and Examples
top
GetDecryptCert
GetDecryptCert() As Cert
Introduced in version 9.5.0.46

Returns the last certificate used for public-key decryption.

Returns Nothing on failure

top
GetEncodedAad
GetEncodedAad(encoding As String) As String
Introduced in version 9.5.0.55

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 Nothing on failure

More Information and Examples
top
GetEncodedAuthTag
GetEncodedAuthTag(encoding As String) As String
Introduced in version 9.5.0.55

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 Nothing on failure

More Information and Examples
top
GetEncodedIV
GetEncodedIV(encoding As String) As String

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 Nothing on failure

top
GetEncodedKey
GetEncodedKey(encoding As String) As String

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 Nothing on failure

top
GetEncodedSalt
GetEncodedSalt(encoding As String) As String

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 Nothing on failure

top
GetLastCert
GetLastCert() As Cert

Returns the last certificate used when verifying a signature. This method is deprecated. Applications should instead call GetSignerCert with an index of 0.

Returns Nothing on failure

top
GetSignatureSigningTimeStr
GetSignatureSigningTimeStr(index As Long) As String

The same as GetSignatureSigningTime, except the date/time is returned in RFC822 string format.

Returns Nothing on failure

top
GetSignedAttributes
GetSignedAttributes(signerIndex As Long, pkcs7Der As BinData, sbJson As StringBuilder) As Long
Introduced in version 9.5.0.75

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:

{
  "signedAttributes": [
    {
      "oid": "1.2.840.113549.1.9.3",
      "name": "Content Type"
    },
    {
      "oid": "1.2.840.113549.1.9.5",
      "name": "Signing Time"
    },
    {
      "oid": "1.2.840.113549.1.9.4",
      "name": "Message Digest"
    },
    {
      "oid": "1.2.840.113549.1.9.16.2.47",
      "name": "Signing Certificate V2"
    }
  ]
}

Returns True for success, False for failure.

top
GetSignerCert
GetSignerCert(index As Long) As Cert

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 Nothing on failure

top
GetSignerCertChain
GetSignerCertChain(index As Long) As CertChain
Introduced in version 9.5.0.40

Returns the full certificate chain for the Nth certificate used to for signing. Indexing begins at 0.

Returns Nothing on failure

top
HashBdENC
HashBdENC(bd As BinData) As String
Introduced in version 9.5.0.66

Hashes the the bytes contained in bd 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.

Returns Nothing on failure

top
HashBeginString
HashBeginString(strData As String) As Long

Begin hashing a text stream. Call this method to hash the 1st chunk. Additional chunks are hashed by calling HashMoreString 0 or more times followed by a final call to HashFinal (or HashFinalENC) to retrieve the result. The hash algorithm is selected by the HashAlgorithm property setting.

Returns True for success, False for failure.

top
HashFileENC
HashFileENC(path As String) As String

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 Nothing on failure

top
HashFinalENC
HashFinalENC() As String

Finalizes a multi-step hash computation and returns the hash bytes encoded according to the EncodingMode property setting.

Returns Nothing on failure

More Information and Examples
top
HashMoreString
HashMoreString(strData As String) As Long

Adds more text to the hash currently under computation. (See HashBeginString)

Returns True for success, False for failure.

top
HashStringENC
HashStringENC(str As String) As String

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 Nothing on failure

More Information and Examples
top
HasSignatureSigningTime
HasSignatureSigningTime(index As Long) As Long

This method can be called after a digital signature has been verified by one of the Verify* methods. Returns True if a signing time for the Nth certificate is available and can be retrieved by either the GetSignatureSigningTime or GetSignatureSigningTimeStr methods.

top
Hotp
Hotp(secret As String, secretEnc As String, counterHex As String, numDigits As Long, truncOffset As Long, hashAlg As String) As String
Introduced in version 9.5.0.77

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 as "sha256", "sha512", etc.

Returns Nothing on failure

top
InflateStringENC
InflateStringENC(str As String) As String

The opposite of CompressStringENC. The Charset, EncodingMode, and CompressionAlgorithm properties should match what was used when compressing.

Returns Nothing on failure

More Information and Examples
top
IsUnlocked
IsUnlocked() As Long

Returns true if the component is unlocked.

top
LastJsonData
LastJsonData() As JsonObject
Introduced in version 9.5.0.70

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.

Returns Nothing on failure

More Information and Examples
top
MacBdENC
MacBdENC(bd As BinData) As String
Introduced in version 9.5.0.66

Computes a Message Authentication Code on the bytes contained in bd, 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 Nothing on failure

More Information and Examples
top
MacStringENC
MacStringENC(inText As String) As String
Introduced in version 9.5.0.55

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 Nothing on failure

More Information and Examples
top
MySqlAesDecrypt
MySqlAesDecrypt(strEncryptedHex As String, strPassword As String) As String

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 Nothing on failure

top
MySqlAesEncrypt
MySqlAesEncrypt(strData As String, strPassword As String) As String

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 Nothing on failure

More Information and Examples
top
OpaqueSignBd
OpaqueSignBd(bd As BinData) As Long
Introduced in version 9.5.0.67

In-place signs the contents of bd. The contents of bd is replaced with the PKCS7/CMS format signature that embeds the data that was signed.

Returns True for success, False for failure.

top
OpaqueSignStringENC
OpaqueSignStringENC(str As String) As String

Digitally signs a string and returns a PKCS7/CMS format signature in encoded string format (such as base64 or hex). This is a signature that contains both the original data as well as the signature. A certificate must be set by calling SetSigningCert prior to calling this method. The Charset property controls the character encoding of the string that is signed. (Languages such as VB.NET, C#, and Visual Basic work with Unicode strings.) To sign Unicode data (2 bytes per char), set the Charset property to "Unicode". To implicitly convert the string to a mutlibyte charset such as "iso-8859-1", "Shift_JIS", "utf-8", or something else, then set the Charset property to the name of the charset before signing. The complete list of charsets is listed in the EncryptString method description.

The EncodingMode property controls the output encoding, which can be "Base64", "QP","Hex", etc. (See the EncodingMode property.)

Returns Nothing on failure

top
OpaqueVerifyBd
OpaqueVerifyBd(bd As BinData) As Long
Introduced in version 9.5.0.67

In-place verifies and unwraps the PKCS7/CMS contents of bd. If the signature is verified, the contents of bd will be replaced with the original data, and the method returns True. If the signature is not verified, then the contents of bd remain unchanged and the method returns False.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

Returns True for success, False for failure.

top
OpaqueVerifyStringENC
OpaqueVerifyStringENC(p7s As String) As String

Verifies an opaque signature (encoded in string form) and returns the original data string. If the signature verification fails, the returned string will be 0 characters in length.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

Returns Nothing on failure

top
Pbkdf1
Pbkdf1(password As String, charset As String, hashAlg As String, salt As String, iterationCount As Long, outputKeyBitLen As Long, encoding As String) As String

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 Nothing on failure

More Information and Examples
top
Pbkdf2
Pbkdf2(password As String, charset As String, hashAlg As String, salt As String, iterationCount As Long, outputKeyBitLen As Long, encoding As String) As String

Implements the PBKDF2 algorithm (Password Based Key Derivation Function #2). The password is converted to the character encoding represented by charset before being passed (internally) to the key derivation function. The hashAlg may be "sha256", "sha384", "sha512", "md5", "sha1", "md2", or any hash algorithm listed in the HashAlgorithm property. 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: The PBKDF2 function (internally) utilizes a PRF that is a pseudorandom function that is a keyed HMAC. The hash algorithm specified by hashAlg determines this PRF. If hashAlg is "SHA256", then HMAC-SHA256 is used for the PRF. Likewise, if the hash function is "SHA1", then HMAC-SHA1 is used. HMAC can be used with any hash algorithm.

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 Nothing on failure

top
RandomizeIV
RandomizeIV()

Sets the initialization vector to a random value.

top
RandomizeKey
RandomizeKey()

Sets the secret key to a random value.

top
ReEncode
ReEncode(encodedData As String, fromEncoding As String, toEncoding As String) As String

Provides a means for converting from one encoding to another (such as base64 to hex). This is helpful for programming environments where byte arrays are a real pain-in-the-***. The fromEncoding and toEncoding may be (case-insensitive) "Base64", "modBase64", "Base32", "Base58", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oauth", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns Nothing on failure

top
SetDecryptCert
SetDecryptCert(cert As Cert) As Long

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 True for success, False for failure.

top
SetDecryptCert2
SetDecryptCert2(cert As Cert, key As PrivateKey) As Long

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 True for success, False for failure.

top
SetEncodedAad
SetEncodedAad(aadStr As String, encoding As String) As Long
Introduced in version 9.5.0.55

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 True for success, False for failure.

More Information and Examples
top
SetEncodedAuthTag
SetEncodedAuthTag(authTagStr As String, encoding As String) As Long
Introduced in version 9.5.0.55

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.

Returns True for success, False for failure.

More Information and Examples
top
SetEncodedIV
SetEncodedIV(ivStr As String, encoding As String)

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

top
SetEncodedKey
SetEncodedKey(keyStr As String, encoding As String)

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

More Information and Examples
top
SetEncodedSalt
SetEncodedSalt(saltStr As String, encoding As String)

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

top
SetEncryptCert
SetEncryptCert(cert As Cert) As Long

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 True for success, False for failure.

top
SetMacKeyEncoded
SetMacKeyEncoded(key As String, encoding As String) As Long
Introduced in version 9.5.0.55

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 True for success, False for failure.

More Information and Examples
top
SetMacKeyString
SetMacKeyString(key As String) As Long
Introduced in version 9.5.0.55

Sets the MAC key to be used for one of the Mac methods.

Returns True for success, False for failure.

More Information and Examples
top
SetSecretKeyViaPassword
SetSecretKeyViaPassword(password As String)

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.

top
SetSigningCert
SetSigningCert(cert As Cert) As Long

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 True for success, False for failure.

top
SetSigningCert2
SetSigningCert2(cert As Cert, privateKey As PrivateKey) As Long

Specifies a digital certificate and private key to be used for creating PKCS7 digital signatures.

Returns True for success, False for failure.

top
SetTsaHttpObj
SetTsaHttpObj(http As Http)

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.

top
SetVerifyCert
SetVerifyCert(cert As Cert) As Long

Sets the digital certificate to be used in verifying a signature.

Returns True for success, False for failure.

top
SignBdENC
SignBdENC(dataToSign As BinData) As String
Introduced in version 9.5.0.67

Digitally signs the contents of dataToSign and returns the detached digital signature in an encoded string (according to the EncodingMode property setting).

Returns Nothing on failure

More Information and Examples
top
SignSbENC
SignSbENC(sb As StringBuilder) As String
Introduced in version 9.5.0.67

Digitally signs a the contents of sb and returns the PKCS7 detached digital signature as an encoded string according to the EncodingMode property setting.

Returns Nothing on failure

More Information and Examples
top
SignStringENC
SignStringENC(str As String) As String

Digitally signs a string and returns the PKCS7 detached digital signature as an encoded string. A certificate must be set by calling SetSigningCert prior to calling this method. The Charset property controls the character encoding of the string that is signed. (Languages such as VB.NET, C#, and Visual Basic work with Unicode strings.) To sign Unicode data (2 bytes per char), set the Charset property to "Unicode". To implicitly convert the string to a mutlibyte charset such as "iso-8859-1", "Shift_JIS", "utf-8", or something else, then set the Charset property to the name of the charset before signing. The complete list of charsets is listed in the EncryptString method description.

The encoding of the output string is controlled by the EncodingMode property, which can be set to "Base64", "QP", or "Hex".

Returns Nothing on failure

top
Totp
Totp(secret As String, secretEnc As String, t0 As String, tNow As String, tStep As Long, numDigits As Long, truncOffset As Long, hashAlg As String) As String
Introduced in version 9.5.0.77

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. "0" is 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 as "sha256", "sha512", etc.

Returns Nothing on failure

top
TrimEndingWith
TrimEndingWith(inStrArg As String, ending As String) As String

Trim a string ending with a specific substring until the string no longer ends with that substring.

Returns Nothing on failure

top
UnlockComponent
UnlockComponent(unlockCode As String) As Long

Unlocks the component. This must be called once prior to calling any other method.

Returns True for success, False for failure.

top
UseCertVault
UseCertVault(vault As XmlCertVault) As Long
Introduced in version 9.5.0.40

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 True for success, False for failure.

top
VerifyBdENC
VerifyBdENC(data As BinData, encodedSig As String) As Long
Introduced in version 9.5.0.67

Verifies a digital signature against the original data contained in data. Returns True if the signature is verified.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

Returns True for success, False for failure.

More Information and Examples
top
VerifyDetachedSignature
VerifyDetachedSignature(inFilename As String, p7sFilename As String) As Long

Verifies a .p7s (PKCS #7 Signature) against the original file (or exact copy of it). If the inFilename has not been modified, the return value is True, otherwise it is False. This method is equivalent to VerifyP7S.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

top
VerifyP7M
VerifyP7M(p7mPath As String, destPath As String) As Long

Verifies a .p7m file and extracts the original file from the .p7m. Returns True if the signature is valid and the contents are unchanged. Otherwise returns False.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

top
VerifyP7S
VerifyP7S(inFilename As String, p7sFilename As String) As Long

Verifies a .p7s (PKCS #7 Signature) against the original file (or exact copy of it). If the inFilename has not been modified, the return value is True, otherwise it is False.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

More Information and Examples
top
VerifySbENC
VerifySbENC(sb As StringBuilder, encodedSig As String) As Long
Introduced in version 9.5.0.67

Verifies a digital signature against the original data contained in sb. Returns True if the signature is verified.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

Returns True for success, False for failure.

More Information and Examples
top
VerifyStringENC
VerifyStringENC(str As String, encodedSig As String) As Long

Verifies a string against a string-encoded digital signature and returns true if the string is unaltered. This method can be used to verify a signature produced by SignStringENC. The Charset and EncodingMode properties must be set to the same values that were used when creating the signature.

Note: The signer certificates can be retrieved after any Verify* method call by using the NumSignerCerts property and the GetSignerCert method.

top