Create a Certificate and Key Ring in
Top Secret

Configure the key ring and generate certificates in
Top Secret
to enable the TLS connection between the product and the client browser.
Required roles: security administrator
This article provides instructions for
Top Secret
that enable you to generate a key ring and store a certificate in the key ring. This certificate is required to enable TLS encryption between the
Alert Insights
and the Zowe API Mediation Layer. You can Use a Self-signed Certificate that you generate yourself, or you can Use a Certificate Authority to sign a certificate that you generate using
Top Secret

Prerequisites

  • This article requires that the user is familiar with
    Top Secret
    . For more information about available
    Top Secret
    commands, see the
    Top Secret
    documentation at https://techdocs.broadcom.com/topsecret.
  • The user ID that runs the STC for the
    Alert Insights
    . The examples in this article use the CAACPROC user ID.
  • The user ID of the Zowe API ML. The examples in this article use the ZAPIUSER user ID.
  • The name of the Zowe API ML key ring. The examples in this article use the ZAPIRING key ring.
  • The authorization to add certificates to the Zowe API ML keyring.
  • The authorization to add certificates to CERTAUTH ACID.
  • Administrative authority to set up the key ring and certificates:
    • MISC4(ALL) - All the certificate operations.
    • MISC4(CERTUSER) - Maintain user certificates.
    • MISC4(CERTAUTH) - Maintain CERTAUTH certificates.
    • MISC4(CERTSITE) - Maintain CERTSITE certificates.
    • MISC4(CERTLIST) - List the certificate information.
    • MISC4(CERTGEN) - Generate the certificate.
    • MISC4(CERTCHEK) - Display information about certificates.
    • MISC4(CERTEXPO) - Export digital certificates.
  • (Optional) The knowledge and ability to generate a self-signed certificate.

Use a Self-signed Certificate

In this procedure, you generate a self-signed certificate and a key ring, then connect the certificate to the key ring and your user ID.
  1. Generate the self-signed certificate. This step assumes that you have the knowledge and ability to generate a self-signed certificate.
  2. Generate the key ring.
    Example:
    TSS ADD(CAACPROC) KEYRING(ACCRING)
    The key ring is generated.
  3. Allocate a data set to store your keystore with your self-signed certificate and its private key using the following format:
    RECFM=VB LRECL=84
    .
    Example:
    CAACPROC.KEYSTORE
    The data set that stores your keystore with your self-signed certificate and its private key.
  4. Upload the keystore file to the data set that you allocated in the previous step.
    You have obtained and stored your self-signed certificate.
  5. Add your self-signed certificate to your user ID. Specify the data set that stores your keystore.
    Example:
    TSS ADD(CAACPROC) DIGICERT(ACCCERT) LABLCERT(ACCCERT) DCDSN('CAACPROC.KEYSTORE') TRUST PKCSPASS('
    password
    ')
    The certificate is connected to your user ID and paired with a private key.
  6. Add your signed certificate to the key ring that you generated in step 2.
    Example:
    In this example, the first reference to the CAACPROC user ID specifies the owner of the key ring. The second reference specifies the owner of the signed certificate.
    TSS ADD(CAACPROC) KEYRING(ACCRING) RINGDATA(CAACPROC,ACCCERT) USAGE(PERSONAL) DEFAULT
    The signed certificate is connected to your key ring.
  7. (Conditional) If Zowe API ML is not configured to use key ring, skip this step. Add the self-signed certificate to the Zowe API ML key ring.
    Example:
    TSS ADD(ZAPIUSER) KEYRING(ZAPIRING) RINGDATA(CERTAUTH,ROOTCERT) USAGE(CERTAUTH)
    The self-signed certificate is connected to the Zowe API ML key ring.
You successfully stored the self-signed certificate in your key ring and the Zowe API ML keyring and connected it to your user ID.

Use a Certificate Authority

In this procedure, you generate a key ring and an unsigned certificate. You also sign the certificate using a Certification Authority of your choice and connect it to the key ring and your user ID.
Follow these steps:
  1. Generate the key ring.
    Example:
    TSS ADD(CAACPROC) KEYRING(ACCRING)
    The key ring is generated.
  2. Generate the certificate. You specify the common name of the certificate using the CN keyword. You use this common name later to create the required
    Alert Insights
    service account.
    Example:
    TSS GENCERT(CAACPROC) DIGICERT(ACCCERTU) SUBJECTN('CN="ACCUser" OU="Mainframe Dept" O="Example Inc." L="Pittsburgh" ST="PA" C="US"') KEYSIZE(2048) KEYUSAGE(HANDSHAKE) LABLCERT('ACC Certificate unsigned') ALTNAME('DOMAIN=acc.example.com')
    The certificate is generated.
  3. Generate a certificate signing request (CSR) for your certificate.
    Example:
    TSS GENREQ(CAACPROC) DIGICERT(ACCCERTU) DCDSN('CAACPROC.CERTU')
    The certificate signing request is generated and stored in the dataset that you specified in the DCDSN parameter.
  4. Download the CSR from the data set generated in step 3 and send it to a Certificate Authority (CA). The CA signs your request, encrypts it with a private key, and sends you a validated certificate. The CA also sends you a root CA certificate and, sometimes, one or more intermediate certificates.
    You must request that the certificate be signed specifically with extended key usage for ‘Client Authentication’ (OID ‘1.3.6.1.5.5.7.3.2’). Otherwise
    Alert Insights
    will not accept the certificate.
  5. Allocate two datasets to store your signed certificate and the root certificate. Use the same format as the output data set in step 2 (CAACPROC.CERTU):
    RECFM=VB LRECL=84
    .
    If the Certificate Authority provides also the intermediate certificates, allocate extra data sets to store the intermediate certificates.
    Example:
    CAACPROC.CERT
    The data set that stores your signed certificate
    CAACPROC.ROOTCERT
    The data set that stores the root certificate
    (Conditional) CAACPROC.INTCERT
    The data set that stores the intermediate certificate
  6. Upload the signed certificate files to the data sets allocated in the previous step.
    You have obtained and stored your signed certificate and a root certificate.
  7. Add your signed certificate to your user ID. Specify the data set that stores your signed certificate.
    Example:
    TSS ADD(CAACPROC) DIGICERT(ACCCERT) LABLCERT(ACCCERT) DCDSN('CAACPROC.CERT') TRUST
    The certificate is connected to your user ID and paired with a private key.
  8. Add your signed certificate to the key ring that you generated in step 1.
    Example:
    In this example, the first reference to the CAACPROC user ID specifies the owner of the key ring. The second reference specifies the owner of the signed certificate.
    TSS ADD(CAACPROC) KEYRING(ACCRING) RINGDATA(CAACPROC,ACCCERT) USAGE(PERSONAL) DEFAULT
    The signed certificate is connected to your key ring.
  9. Connect the root CA certificate to the CERTAUTH ACID.
    If the root certificate is already connected to CERTAUTH ACID, you can skip this step.
    Example:
    TSS ADD(CERTAUTH) DIGICERT(ROOTCERT) LABLCERT('DigiCert Global Root CA') DCDSN('CAACPROC.ROOTCERT') TRUST
    The root CA certificate is connected to the CERTAUTH ACID.
  10. Add the root CA certificate to your key ring.
    Example:
    TSS ADD(CAACPROC) KEYRING(ACCRING) RINGDATA(CERTAUTH,ROOTCERT) USAGE(CERTAUTH)
    The root CA certificate is connected to your key ring.
  11. (Conditional) If Zowe API ML is not configured to use key ring, skip this step. Add the root CA certificate to the Zowe API ML key ring.
    Example:
    TSS ADD(ZAPIUSER) KEYRING(ZAPIRING) RINGDATA(CERTAUTH,ROOTCERT) USAGE(CERTAUTH)
    The root CA certificate is connected to the Zowe API ML key ring.
  12. (Conditional) If you received intermediate certificates, repeat steps 3, 4 and 5 to add the intermediate certificates to the CERTAUTH ACID, your key ring and the Zowe API ML keyring. Specify the appropriate data sets that contain the intermediate certificates.
You successfully stored the certificates in your key ring and the Zowe API ML keyring and connected them to your user ID and to the CERTAUTH ACID.

List the Key Ring Content

To list the certificates owned by a user ID, use the following
Top Secret
command:
Example:
TSS LIST(CAACPROC) DIGICERT(ALL)
A list of certificates assigned to the user CAACPROC appears.
DIGICERT = ACCCERT ACCESSORID = CAACPROC ADMIN BY= BY(MASTER ) SMFID(M10H) ON(05/07/2021) AT(11:01:13) LABEL = ACCCERT STATUS = TRUST SERIAL# = 000A00A000A00A000A00A000A00A0 ISSUER DISTINGUISHED NAME: .CN=company.OU=www.company.com.O=company In - c.C=US SUBJECT DISTINGUISHED NAME: CN=*.company.net.O=Company Inc.L=city.ST=state. - C=US DOMAIN NAME: *.company.net KEYUSAGE: HANDSHAKE PRIVATE KEY SIZE = 2048 PRIVATE KEY TYPE = RSA ALGORITHM = sha256WithRSAEncryption NOT BEFORE = 2021/05/07 00:00:00 UTC NOT AFTER = 2022/05/12 23:59:59 UTC CERTIFICATE WAS SIGNED BY: ACID(CERTAUTH) DIGICERT(DCCACERT) CERTIFICATE IS CONNECTED TO THE FOLLOWING KEYRINGS: ACID(CACCPROC) KEYRING(ACCRING)