Parameters

z/OS Cryptographic Services ICSF Application Programmer's Guide

Parameters

z/OS Cryptographic Services ICSF Application Programmer's Guide
SA22-7522-16

return_code

Direction: Output

Type: Integer

The return code specifies the general result of the callable service. Appendix A. ICSF and TSS Return and Reason Codes lists the return codes.

reason_code

Direction: Output

Type: Integer

The reason code specifies the result of the callable service that is returned to the application program. Each return code has different reason codes assigned to it that indicate specific processing problems. Appendix A. ICSF and TSS Return and Reason Codes lists the reason codes.

exit_data_length

Direction: Ignored

Type: Integer

This field is ignored. It is recommended to specify 0 for this parameter.

exit_data

Direction: Ignored

Type: String

This field is ignored.

rule_array_count

Direction: Input

Type: Integer

The number of keywords you are supplying in rule_array. Value must be 0 or 1.

rule_array

Direction: Input

Type: String

Keywords that provide control information to the callable service. The keywords must be 8 bytes of contiguous storage with the keyword left-justified in its 8-byte location and padded on the right with blanks.

Table 261. Keywords for ICSF Query Algorithm
Keyword	Meaning
ALGORITHM (optional)
AES	Advanced Encryption Standard - symmetric key algorithm
DES	Data Encryption Standard - single length symmetric key algorithm
DSS	Data Signature Standard - public key cryptography algorithm
ECC	Elliptic Curve Cryptography. All curve types.
ECC-PRIM	Elliptic Curve Cryptography using NIST approved PRIME curves
ECC-BP	Elliptic Curve Cryptography using Brain Pool Curves
HMAC	FIPS-198 keyed-hash message authentication code algorithm.
RSA	Rivest-Shamir-Adleman - public key cryptography algorithm, all usage types
RSA-SIG	Rivest-Shamir-Adleman - public key cryptography algorithm, signature usage.
RSA-KM	Rivest-Shamir-Adleman - public key cryptography algorithm, key management usage.
RSA-GEN	Rivest-Shamir-Adleman - public key cryptography algorithm, key generation.
SHA-1	Secure Hash Algorithm 1 - A one way hash algorithm
SHA-2	Secure Hash Algorithm 2 - A one way hash algorithm
MDC-2	Modification Detection Code 2 - MDC-2 specifies two encipherments per 8 bytes of input text
MDC-4	Modification Detection Code 4 - MDC-4 specifies four encipherments per 8 bytes of input text
MD5	Message Digest 5 - A one way hash algorithm
RPMD-160	RIPE MD-160 - A one way hash algorithm
RNGL	Random number generate long callable service
TDES	Data Encryption Standard - double and triple length symmetric key algorithm

returned_data_length

Direction: Input/Output

Type: Integer

The length of the returned_data parameter. Currently, the value must be large enough to handle the request. Allow additional space for future enhancements. On output, this field will contain the actual length of the data returned.

returned_data

Direction: Output

Type: String

This field will contain the table output from the service. Depending on the contents of rule_array, multiple rows may be returned. One row in the table contains:

Table 262. Output for ICSF Query Algorithm
Offset (hex)	Name	Description
0 (X'0')	Algorithm	An 8-byte EBCDIC character string containing the name of the cryptographic algorithm. The character string is padded on the right with blanks. Possible values are: AES DES (single length DES) DSS ECC-PRIM ECC-BP (Brain Pool) HMAC MDC-2 MDC-4 MD5 RNGL RPMD-160 RSA-GEN RSA-KM RSA-SIG SHA-1 SHA-2 TDES (double and triple length DES)
8 (X'8')	Size	An 8-byte EBCDIC string representing the maximum key, modulus, p value, or hash size. The string is padded with blanks on the right. The size is in bits. This is true for all algorithms except RNGL. For RNGL, the size is in bytes.
16 (X'10')	Key Security	An 8-byte EBCDIC character string containing the string CLEAR SECURE NA The string is padded on the right with blanks.
24(X'18')	Implementation	An 8-byte EBCDIC character string containing how the algorithm is implemented. The string is padded on the right with blanks. Possible choices are: ACC - Cryptographic Accelerator CCF - CCF COP - Cryptographic Coprocessor CPU - CPACF SW - Software

The rows are sorted in the following order:

Algorithm name - alphabetically A to Z
Algorithm size - numerically highest to least
Key security - alphabetically A to Z
Implementation - alphabetically A to Z

reserved_data_length

Direction: Input

Type: Integer

The length of the reserved_data parameter. Currently, the value must be 0.

reserved_data

Direction: Ignored

Type: String

This field is currently not used.

Notices | Terms of use | Support | Contact z/OS | zFavorites