1 | Encrypted data | Input | Char(*) |
2 | Length of encrypted data | Input | Binary(4) |
3 | Associated data | Input | Char(*) |
4 | Length of associated data | Input | Binary(4) |
5 | Algorithm description | Input | Char(*) |
6 | Algorithm description format name | Input | Char(8) |
7 | Key description | Input | Char(*) |
8 | Key description format name | Input | Char(8) |
9 | Cryptographic service provider | Input | Char(1) |
10 | Cryptographic device name | Input | Char(10) |
11 | Clear data | Output | Char(*) |
12 | Length of area provided for clear data | Input | Binary(4) |
13 | Length of clear data returned | Output | Binary(4) |
14 | Error code | I/O | Char(*) |
The Decrypt With MAC (OPM, QC3DECWM; ILE, Qc3DecryptWithMAC) API decrypts and verifies data that was encrypted and authenticated with the Encrypt With MAC (OPM, QC3ENCWM; ILE, Qc3EncryptWithMAC) API.
The data to decrypt and verify.
The length of the encrypted data parameter.
The additional data that will be used to verify the clear data.
After decrypting the encrypted data, the associated data is placed ahead of the decrypted data and a MAC (message authentication code) is produced for the entire string. This MAC is compared with the MAC that was at the end of the encrypted data.
The length of the associated data parameter.
The algorithm and associated parameters for decrypting and 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 decrypting and verifying the data.
The format of the key description is specified in the key description format
name parameter.
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 operation.
1 | Software CSP. The system will perform the decrypt with MAC operation using software. If the requested algorithm is not available in software, an error is returned. |
This parameter must be set to blanks or the pointer to this parameter set to NULL.
The area to store the decrypted and verified data.
To ensure sufficient space, specify an area at least as large as the length of encrypted data. If the length of area provided for clear data is too small, an error will be generated and no data will be returned in the clear data parameter.
The length of the clear data parameter.
The length of clear data returned in the clear data parameter.
The structure in which to return error information.
For the format of the structure, see Error code parameter.
For detailed descriptions of the table fields, see Algorithm Description Formats Field Descriptions. For algorithm standards and resources, see Create Algorithm Context (OPM, QC3CRTAX; ILE, Qc3CreateAlgorithmContext) API.
Offset | Type | Field | |
---|---|---|---|
Dec | Hex | ||
0 | 0 | BINARY(4) | Block cipher algorithm |
4 | 4 | BINARY(4) | Block length |
8 | 8 | CHAR(1) | Mode |
9 | 9 | CHAR(3) | Reserved |
12 | C | BINARY(4) | MAC length |
16 | 10 | BINARY(4) | Nonce length |
20 | 14 | CHAR(32) | Nonce |
22 | AES Documented in FIPS 197. |
8 | CCM |
CCM (Counter with CBC-MAC) is a mode of operation for a 128-bit block
cipher algorithm, such as AES. CCM is used to provide data confidentiality
and authentication by combining the techniques of Counter (CTR) mode and
Cipher Block Chaining (CBC) mode of message authentication code (MAC)
generation. CCM is defined in RFC3610 and NIST Special Publication 800-38C.
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) | Key type |
4 | 4 | BINARY(4) | Derived key length |
8 | 8 | BINARY(4) | Iteration count |
12 | C | BINARY(4) | Salt length |
16 | 10 | CHAR(16) | Salt |
32 | 20 | BINARY(4) | Passphrase CCSID |
36 | 24 | BINARY(4) | Passphrase length |
40 | 28 | CHAR(*) | Passphrase |
0 | Binary string. The key is specified as a binary value. |
22 | AES |
The CCSID of the passphrase. The passphrase will be converted from the specified CCSID to Unicode before calling the PKCS5 algorithm.
0 | The CCSID of the job is used to determine the CCSID of the data to be converted. If the job CCSID is 65535, the CCSID from the default CCSID (DFTCCSID) job attribute is used. |
1-65533 | A valid CCSID in this range is used. For a list of valid CCSIDs, see the i5/OS globalization topic collection. |
*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. |
CPF9D94 E | A pending value exists for a master key. |
CPF9D95 E | Verification failed. |
CPF9D9A E | Key is protected by a cryptographic coprocessor. |
CPF9D9C E | Function is disallowed with specified key context. |
CPF9D9F E | Not authorized to keystore file. |
CPF9DA0 E | Error occured opening keystore file. |
CPF9DA1 E | Key record not found. |
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. |
CPF9DAA D | A key requires translation. |
CPF9DAB E | A key can not be decrypted. |
CPF9DB1 E | The CCSID is not valid. |
CPF9DB3 E | Qualified keystore file name not valid. |
CPF9DB6 E | Record label not valid. |
CPF9DB8 E | Error occured retrieving key record from keystore. |
CPF9DBA E | Derived key length not valid. |
CPF9DBB E | Iteration count not valid. |
CPF9DBC E | Salt length not valid. |
CPF9DBD E | Passphrase length not valid. |
CPF9DC2 E | Key-encrypting algorithm context not compatible with key-encrypting key context. |
CPF9DC3 E | Unable to decrypt data or key. |
CPF9DC6 E | Algorithm not valid for encrypting or decrypting a key. |
CPF9DC8 E | The input data parameter specifies a NULL pointer. |
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. |
CPF9DDD E | The key string length is not valid. |
CPF9DDE E | Cipher algorithm not valid. |
CPF9DDF E | Block length not valid. |
CPF9DE2 E | MAC (message authentication code) length not valid. |
CPF9DE3 E | Mode 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. |
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. |
CPF9DFB E | Cryptographic service provider (CSP) conflicts with the key context CSP. |
[ Back to top | Cryptographic Services APIs | APIs by category ]