z/OS Cryptographic Services ICSF Application Programmer's Guide
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


Parameters

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

return_code
Direction: OutputType: 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: OutputType: 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: IgnoredType: Integer

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

exit_data
Direction: IgnoredType: String

This field is ignored.

handle
Direction: Input/OutputType: String
On input, the 44-byte name of the z/OS PKCS #11 token to be initialized, or the token handle of the object to be created or copied. For the create or re-create functions, the first 32 bytes of the handle are meaningful on input. The remaining 12 bytes are filled in by the token record create service. For the copy function, all 44 bytes of the handle are significant on input.

On output, the 44-byte handle of the z/OS PKCS #11 token or object created.

See Handles for the format of a handle.

rule_array_count
Direction: InputType: Integer
The number of keywords supplied in the rule_arrray parameter. The value must be 1 or 2.
rule_array
Direction: InputType: String
Keywords that provide control information to the callable service. Each keyword is left-justisfied in 8-byte fields and padded on the right with blanks. All keywords must be in contiguous storage.
KeywordMeaning
One of these two keywords must be specified:
TOKENSpecifies that a token is to be initialized. If the token exists in the token data set, the RECREATE keyword must be specified.
OBJECTSpecifies that an object (token object or session object) is to be created. If the object is to be a copy of an existing object, the COPY keyword must be specified.
This keyword is optional, and valid only with TOKEN:
RECREATESpecifies that the token exists and is to be re-initialized. All objects of the existing token will be deleted.
This keyword is optional, and valid only with OBJECT:
COPYSpecifies that the object specified by the handle is to be copied into a new object.
attribute_list_length
Direction: InputType: Integer
Length of the attribute_list parameter in bytes.

The maximum size in bytes is 32752.

attribute_list
Direction: InputType: String
List of token or object attributes.

When creating or re-creating a token, the attribute_list parameter has this format:

BytesDescription
0 - 31Manufacturer ID
32 - 47Model
48 - 63Serial number
64 - 67Reserved for IBM's use. Must be hexadecimal zeros.
Note:
The strings supplied for Manufacturer ID, Model, and Serial number are assumed to be from code page IBM1047.

For objects, see Attribute List for the format of an attribute_list.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014