|
|
|
|
|
- Validity of certificate (syntax 1)
CertificateSignString (Function) In french: CertificatSigneChaîne Creates the signature of a character string. Syntax
Signing a string via a numeric signature Hide the details
<Result> = CertificateSignString(<String to Sign> , <Certificate file> , <Password> , <Option>)
<Result>: Buffer Signature of string (in requested format). This buffer can be used later by CertificateCheckString to check the correspondence between the signature and the string. <String to Sign>: Ansi or Unicode character string or Buffer Character string to sign. <Certificate file>: Character string or Buffer - Full path to a PKCS12 file (.p12/.pfx) containing the private key and the certificates. This file can be included in the application library (WDL file).
- Buffer containing the private key and certificates.
If the certSignatureOnly constant is used, this buffer can contain only the private key.
<Password>: Character string or Secret string Password that will be used to decrypt the certificate file if this one is password-protected.
New in version 2025Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "Ansi or Unicode string". To learn more about secret strings and how to use the vault, see Secret string vault. <Option>: Integer constant (or combination of constants) Allows you to specify: - the hashing algorithm used (optional for a signature in PKCS7 format):
| | certMD5 | MD5 algorithm. Not recommended because unreliable. This type of algorithm is not allowed with the "elliptic curve" signatures. | certSHA160 | SHA1 algorithm. | certSHA256 | SHA2 algorithm. A 256-bit result is produced. | certSHA384 | SHA-384 algorithm. A 384-bit result is produced. This type of algorithm is not supported by the "DSA" signatures. | certSHA512 | SHA-512 algorithm. A 512-bit result is produced. This type of algorithm is not supported by the "DSA" signatures. |
- the signature format:
| | certPKCS7Enveloped | Container in PKCS7 format (DER) containing the signature, the string of certificates and the signed data. Note: if this constant is used, the hash algorithm is optional. If it is not specified, an appropriate algorithm will be automatically chosen. | certPKCS7Enveloped + certPKCS7PEM | Container in PKCS7 format (PEM) containing the signature, the string of certificates and the signed data. Note: if this constant is used, the hash algorithm is optional. If it is not specified, an appropriate algorithm will be automatically chosen. | certPKCS7WithCertificate | Container in PKCS7 format (DER) containing the signature and the string of certificates. Note: if this constant is used, the hash algorithm is optional. If it is not specified, an appropriate algorithm will be automatically chosen. | certPKCS7WithCertificate + certPKCS7PEM | Container in PKCS7 format (PEM) containing the signature and the string of certificates. Note: if this constant is used, the hash algorithm is optional. If it is not specified, an appropriate algorithm will be automatically chosen. | certPKCS7WithoutCertificate | Container in PKCS7 format (DER) containing the signature. Note: if this constant is used, the hash algorithm is optional. If it is not specified, an appropriate algorithm will be automatically chosen. | certPKCS7WithoutCertificate + certPKCS7PEM | Container in PKCS7 format (PEM) containing the signature. Note: if this constant is used, the hash algorithm is optional. If it is not specified, an appropriate algorithm will be automatically chosen. | certSignatureOnly | The output contains only the raw signature, without any container. This options is required for the compliance of accountancy software (NF525 standard). With this option, only the key section of PFX file will be used (the certificate section containing the date will not be used). Caution: if this constant is used, the hash algorithm must be specified. |
Note: The signature algorithm is determined by the private key (RSA, DSA, Elliptic curve).. Remarks Validity of certificate (syntax 1) Before signing a string, it is recommended to check the validity of the certificate ( ValidForSignature property of the Certificate variable). This property is used to find out whether the certificate owns a private key as well as all the characteristics required to perform a signature. CertificateSignString returns an error if this property is set to False. Business / UI classification: Business Logic
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|