| 1 | Signature | Input | Char(*) |
| 2 | Length of signature | Input | Binary(4) |
| 3 | Input data | Input | Char(*) |
| 4 | Length of input data | Input | Binary(4) |
| 5 | Input data format name | Input | Char(8) |
| 6 | Algorithm description | Input | Char(*) |
| 7 | Algorithm description format name | Input | Char(8) |
| 8 | Key description | Input | Char(*) |
| 9 | Key description format name | Input | Char(8) |
| 10 | Cryptographic service provider | Input | Char(1) |
| 11 | Cryptographic device name | Input | Char(10) |
| 12 | Error code | I/O | Char(*) |
The Verify Signature (OPM, QC3VFYSG; ILE, Qc3VerifySignature) API verifies a digital signature is correctly related to the input data. If the verification fails with a CPF9DEF, the input data has been corrupted. A digital signature is created by hashing data and encrypting the hash value using a public key algorithm (PKA). A digital signature can be created by using the Calculate Signature (OPM, QC3CALSG; ILE, Qc3CalculateSignature) API.
Information on cryptographic standards can be found in Create Algorithm Context (OPM, QC3CRTAX; ILE, Qc3CreateAlgorithmContext) API.
The digital signature to verify.
The length of signature should be equal to the key size (size of the modulus), but expressed in bytes.
The data to verify.
The format of the input data is specified in the input data format name parameter.
For input data format DATA0100, this is the length of the data to verify.
For input data format DATA0200, this is the number of entries in the array.
The format of the input data parameter.
The possible format names follow.
The algorithm and associated parameters for verifying the data.
The format of the algorithm description is specified in the algorithm description format name parameter.
The format of the algorithm description.
The possible format names follow.
See Algorithm Description Formats for a description of these formats.
The key and associated parameters for verifying the data.
The format of the key description is specified in the key description format name parameter.
If the verify operation extends over multiple calls (see ALGD0100 description above), only the key description from the first call will be used. Therefore, on subsequent calls, you may set the pointer to this parameter to NULL.
The format of the key description.
If the pointer to the key description parameter is NULL, this parameter will be ignored.
The possible format names follow.
See Key Description Formats for a description of these formats.
The cryptographic service provider (CSP) that will perform the verify signature operation.
| 0 | Any CSP. The system will choose an appropriate CSP to perform the verify signature operation. |
| 1 | Software CSP. The system will perform the verify signature operation using software. If the requested algorithm is not available in software, an error is returned. |
| 2 | Hardware CSP. The system will perform the verify signature operation using cryptographic hardware. If the requested algorithm is not available in hardware, an error is returned. A specific cryptographic device can be specified using the cryptographic device name parameter. If the cryptographic device is not specified, the system will choose an appropriate one. |
The name of a cryptographic device description.
This parameter is valid when the cryptographic service provider parameter specifies 2 (hardware CSP). Otherwise, this parameter must be blanks or the pointer to this parameter set to NULL.
The structure in which to return error information.
For the format of the structure, see Error code parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| These fields repeat. | PTR(SPP) | Input data pointer | |
| BINARY(4) | Input data length | ||
| CHAR(12) | Reserved | ||
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(8) | Algorithm context token |
| 8 | 8 | CHAR(1) | Final operation flag |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Public key cipher algorithm |
| 4 | 4 | CHAR(1) | PKA block format |
| 5 | 5 | CHAR(3) | Reserved |
| 8 | 8 | BINARY(4) | Signing hash algorithm |
| 0 | Continue. The system will not perform final processing and the algorithm context will maintain the state of the operation. The algorithm context can be used on future calls to this API to continue the verify signature operation. The result of the signature verification will not be returned until the final operation flag is set on. The pointer to the signature parameter may be set to NULL because the signature is not used until the final operation flag is set on. |
| 1 | Final. The system will perform final processing. The signature will be verified and the algorithm context will reset to its initial state. The algorithm context can then be used to begin a new cryptographic operation. When performing a final operation, the pointer to the input data parameter may be set to NULL. |
| 0 | PKCS #1 block type 00 |
| 1 | PKCS #1 block type 01 |
| 3 | ISO 9796-1 |
| 5 | ANSI X9.31 This format is only valid with signing hash algorithm 2 (SHA-1). |
| 50 | RSA |
| 1 | MD5 |
| 2 | SHA-1 |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(8) | Key context token |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Key type |
| 4 | 4 | BINARY(4) | Key string length |
| 8 | 8 | CHAR(1) | Key format |
| 9 | 9 | CHAR(3) | Reserved |
| 12 | C | CHAR(*) | Key string |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(20) | Qualified keystore file name |
| 20 | 14 | CHAR(32) | Record label |
| 52 | 34 | CHAR(4) | Reserved |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | PEM certificate length |
| 4 | 4 | CHAR(4) | Reserved |
| 8 | 8 | CHAR(*) | PEM certificate |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Certificate label length |
| 4 | 4 | CHAR(4) | Reserved |
| 8 | 8 | CHAR(*) | Certificate label |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Distinguished name length |
| 4 | 4 | CHAR(4) | Reserved |
| 8 | 8 | CHAR(*) | Distinguished name |
| 1 | BER string The key is specified in BER encoded X.509 Certificate or SubjectPublicKeyInfo format. For specifications of this format, refer to RFC 3280. |
| 50 | RSA public |
| *CURLIB | The job's current library is used to locate the keystore file. If no library is specified as the current library for the job, the QGPL library is used. |
| *LIBL | The job's library list is searched for the first occurence of the specified file name. |
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPF9D99 E | Error openning certificate store. |
| CPF9D9F E | Not authorized to keystore file. |
| CPF9DA0 E | Error occured opening keystore file. |
| CPF9DA1 E | Key record not found. |
| CPF9DA2 E | Option 34 is not installed. |
| CPF9DA3 E | Not authorized to use APPIDs. |
| CPF9DA4 E | RSA key identifier was not found in system certificate store. |
| CPF9DA5 E | Keystore file not found. |
| CPF9DA6 E | The keystore file is not available. |
| CPF9DA7 E | File is corrupt or not a valid keystore file. |
| CPF9DA9 D | The PEM certificate contains invalid formatting. |
| CPF9DAA D | A key requires translation. |
| CPF9DAB E | A key can not be decrypted. |
| CPF9DB3 E | Qualified keystore file name not valid. |
| CPF9DB6 E | Record label not valid. |
| CPF9DB8 E | Error occured retrieving key from keystore. |
| CPF9DBE E | PEM certificate length not valid. |
| CPF9DBF E | Certificate label length not valid. |
| CPF9DC0 E | Distinguished name length not valid. |
| CPF9DC2 E | Key-encrypting algorithm context not compatible with key-encrypting key context. |
| CPF9DC6 E | Algorithm not valid for encrypting or decrypting a key. |
| CPF9DC8 E | The input data parameter specifies a NULL pointer. |
| CPF9DC9 E | The total length of data in the input data array is not valid. |
| CPF9DCC E | The length of area provided for signature is not valid. |
| CPF9DCE E | A data length is not valid. |
| CPF9DCF E | A data pointer is not valid. |
| CPF9DD0 E | Clear data format name not valid. |
| CPF9DD2 E | Algorithm description format name not valid. |
| CPF9DD3 E | Key description format name not valid. |
| CPF9DD5 E | Length of input data not valid. |
| CPF9DD6 E | Length of area provided for output data is too small. |
| CPF9DD7 E | The key-encrypting key context for the specified key is not valid or was previously destroyed. |
| CPF9DD8 E | The key-encrypting algorithm context for the specified key is not valid or was previously destroyed. |
| CPF9DDA E | Unexpected return code &1. |
| CPF9DDB E | The key string or Diffie-Hellman parameter string is not valid. |
| CPF9DDD E | The key string length is not valid. |
| CPF9DE0 E | Hash algorithm not valid. |
| CPF9DE3 E | Mode not valid. |
| CPF9DE5 E | PKA (public key algorithm) block format not valid. |
| CPF9DE6 E | Public key algorithm not valid. |
| CPF9DE7 E | Key type not valid. |
| CPF9DE9 E | Key format not valid. |
| CPF9DEC E | Cryptographic service provider not valid. |
| CPF9DED E | Final operation flag not valid. |
| CPF9DEE E | Reserved field not null. |
| CPF9DEF E | The signature verification failed. |
| CPF9DF0 E | Operation, algorithm, or mode not available on the requested CSP (cryptographic service provider). |
| CPF9DF1 E | The algorithm context token does not reference a valid algorithm context. |
| CPF9DF2 E | The algorithm context is not found or was previously destroyed. |
| CPF9DF3 E | Algorithm in algorithm context not valid for requested operation. |
| CPF9DF4 E | The key context token does not reference a valid key context. |
| CPF9DF5 E | The key context is not found or was previously destroyed. |
| CPF9DF7 E | Algorithm context not compatible with key context. |
| CPF9DF8 E | Cryptographic device name not valid. |
| CPF9DF9 E | Cryptographic device not found. |
| CPF9DFB E | Cryptographic service provider (CSP) conflicts with the key context CSP. |
| CPF9DFD E | Not authorized to device. |
| CPF9DFE E | Cryptographic device not available. |
[ Back to top | Cryptographic Services APIs | APIs by category ]