XSCT gate, INQUIRE_CERTIFICATE function
The INQUIRE_CERTIFICATE function extracts data fields out of an X-509 certificate.
Input Parameters
- CERTIFICATE
- Optional Parameter
- On input, contains a full DER-encoded X-509 certificate. Alternatively, CERTIFICATE_LABEL can be used to identify a certificate in the keyring. If neither is specified, the default certificate in the key ring is used. On output, contains the certificate from which the data is extracted.
- CERTIFICATE_LABEL
- Optional Parameter
- Identifies a certificate in the keyring
- COMMON_NAME
- Optional Parameter
- A buffer in which the common name contained within the certificate is returned.
- DISTINGUISHED_NAME
- Optional Parameter
- A buffer in which the BER-encoded distinguished name from the certificate is returned.
- EMAIL_ADDRESS
- Optional Parameter
- A buffer in which the e-mail address contained within the certificate is returned.
- FOR
- Optional Parameter
- Specifies from which of the distinguished names in the certificate the data is to be extracted.
- Values for the parameter are:
- ISSUER
- SUBJECT
- LOCALITY
- Optional Parameter
- A buffer in which the locality contained within the certificate is returned.
- ORGANIZATION
- Optional Parameter
- A buffer in which the organization contained within the certificate is returned.
- ORGANIZATIONAL_UNIT
- Optional Parameter
- A buffer in which the organizational unit contained within the certificate is returned.
- SERIAL_NUMBER
- Optional Parameter
- A buffer in which the serial number of the certificate is returned.
- STATE_OR_PROVINCE
- Optional Parameter
- A buffer in which the state or province unit contained within the certificate is returned.
- TITLE
- Optional Parameter
- A buffer in which the title contained within the certificate is returned.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOOP
- SEVERE_ERROR
- The following values are returned when RESPONSE is EXCEPTION:
- CERTIFICATE_INVALID
- CERTIFICATE_NOT_FOUND
- ESM_INACTIVE
- GETMAIN_FAILED
- KEYRING_NOT_FOUND
- NOTAUTH
- REVOCATION_LIST_INVALID
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- ESM_RESPONSE
- Optional Parameter
- The external security manager's response to the call.
- SAF_RESPONSE
- Optional Parameter
- The system authorization facility's response to the call.
- STATUS
- Optional Parameter
- The status of the certificate.
- Values for the parameter are:
- EXPIRED
- NOT_OWNER
- NOT_YET_CURRENT
- TRUSTED
- UNREGISTERED
- UNTRUSTED
- USAGE
- Optional Parameter
- The intended usage of the certificate, as recorded by the External Security Manager.
- Values for the parameter are:
- CERTAUTH
- PERSONAL
- SITE
- USERID
- Optional Parameter
- The user ID of the certificate's owner.
- USERID_LENGTH
- Optional Parameter
- The length of the user ID field.
- VALID_FROM_ABSTIME
- Optional Parameter
- The date and time from when the certificate is valid (in CICS ABSTIME format).
- VALID_UNTIL_ABSTIME
- Optional Parameter
- The date and time until when the certificate is valid (in CICS ABSTIME format).