Cisco Unified Communications Operating System Administration Guide, Release 9.1(1)
Security certificate management
Downloads: This chapterpdf (PDF - 1.3MB) The complete bookPDF (PDF - 3.24MB) | Feedback

Security certificate management

Security certificate management

The operating system security options enable you to manage security certificates in these two ways:

  • Certificate Management—Manages certificates, Certificate Trust Lists (CTL), and Certificate Signing Requests (CSR). You can display, upload, download, delete, and regenerate certificates.
  • Certificate Monitor—Allows you to monitor the expiration dates of the certificates on the node.

Certificates and certificate trust list management

View certificates

Before You Begin

To access the Security menu items, you must sign in again to Cisco Unified IM and Presence Operating System Administration using your Administrator password.

Procedure
    Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
    Step 2   Select Security > Certificate Management.
    Step 3   Perform one of the following actions:

    If you want to:

    Action

    Filter the certificate list

    Enter your search criteria, and use the Find controls as follows:
    • To filter or search records, perform one of the following actions:
      • From the first list box, select a search parameter.
      • From the second list box, select a search pattern.
      • Specify the appropriate search text, if applicable.
    • Select Find.

    View details of a certificate or trust store

    Select the .PEM or .DER file name of the certificate.

    Return to the Certificate List window

    • Select Back To Find/List in the Related Links list.
    • Select Go.

    Download certificate or certificate trust list

    Before You Begin

    To access the Security menu items, you must sign in again to Cisco Unified IM and Presence Operating System Administration using your Administrator password.

    Procedure
      Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
      Step 2   Select Security > Certificate Management.
      Step 3   If required, use the Find controls to filter the certificate list as follows:
      1. To filter or search records, perform one of the following actions:
        • From the first list box, select a search parameter.
        • From the second list box, select a search pattern.
        • Specify the appropriate search text, if applicable.
      2. Select Find.
      Step 4   Select the file name of the certificate or CTL.
      Step 5   Select Download.

      Delete certificate

      A trusted certificate is the only type of certificate that you can delete. You can not delete a self-signed certificate that is generated by the system.


      Caution


      Deleting a certificate can affect your system operations. If there is an existing CSR for the certificate you select from the Certificate list, it is deleted from the system and you must generate a new CSR.


      Before You Begin

      To access the Security menu items, you must sign in again to Cisco Unified IM and Presence Operating System Administration using your Administrator password.

      Procedure
        Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
        Step 2   Select Security > Certificate Management.
        Step 3   If required, use the Find controls to filter the certificate list as follows:
        1. To filter or search records, perform one of the following actions:
          • From the first list box, select a search parameter.
          • From the second list box, select a search pattern.
          • Specify the appropriate search text, if applicable.
        2. Select Find.
        Step 4   Select the file name of the certificate or CTL.
        Step 5   Select Delete.

        Regenerate certificate

        A certificate of type "cert" is the only type of certificate that you can regenerate.


        Caution


        Regenerating a certificate can affect your system operations.


        Before You Begin

        To access the Security menu items, you must sign in again to Cisco Unified IM and Presence Operating System Administration using your Administrator password.

        Procedure
          Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
          Step 2   Select Security > Certificate Management.
          Step 3   Select Generate New.
          Step 4   Select a certificate name from the Certificate Name list.
          Table 1 Certificate Names and Descriptions

          Name

          Description

          tomcat

          This self-signed root certificate is generated during the installation of the IM and Presence Service node for the Cisco Tomcat service.

          Note   

          If you upload or regenerate a Tomcat certificate in an IM and Presence Service cluster, you must restart the Cisco Tomcat service using the OS Administration CLI command:

          utils service restart Cisco Tomcat

          ipsec

          This self-signed root certificate is generated during the installation of the IM and Presence Service node and is required for secure IPsec server connections.

          cup

          This self-signed root certificate is generated during the installation of the IM and Presence node.

          Note   

          If this security certificate is regenerated restart the following services:

          • Cisco SIP Proxy service
          • Cisco Presence Engine service

          cup-xmpp

          This self-signed root certificate is generated during the installation of the IM and Presence node.

          Note   

          If this security certificate is regenerated restart the Cisco XCP Router service.

          cup-xmpp-s2s

          This self-signed root certificate is generated during the installation of the IM and Presence node.

          Note   

          The trust certificates for cup-xmpp-s2s are stored in cup-xmpp-trust along with the general XMPP trust certificates.

          Note   

          If this security certificate is regenerated restart the Cisco XCP Router service.

          Step 5   Select Generate CSR .

          Upload certificate or certificate trust list


          Caution


          Uploading a new certificate or certificate trust list (CTL) file can affect your system operations.


          Before You Begin
          • The system does not automatically distribute non-trust single server certificates such as tomcat, cup, cup-xmpp, cup-xmpp-s2s, and ipsec to other nodes on the cluster. Multi-Server SAN based certificates, including their signing certificates, are automatically distributed to other nodes on the cluster and only need to be uploaded to one IM and Presence Service node per cluster.
          • The Cisco Intercluster Sync Agent service automatically distributes trust certificates such as tomcat-trust, cup-trust, cup-xmpp-trust, and ipsec-trust to other nodes on the cluster and to any configured IM and Presence Service Intercluster peers. This process can take up to 30 minutes to complete. A manual upload of trust certificates to other nodes can be performed if required.
          • To access the Security menu items, you must sign out and sign back in to Cisco Unified IM and Presence Operating System Administration using your Administrator password.
          Procedure
            Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
            Step 2   Select Security > Certificate Management.
            Step 3   Select Upload Certificate .
            Step 4   Select the name of the certificate or CTL from the Certificate Name drop-down list.
            Step 5   Select the file to upload by completing the following actions:
            1. Enter the path to the file in the Upload File text box.
            2. Select Browse and navigate to the file.
            3. Select Open.
            Step 6   Select Upload File to upload the file to the node.
            Step 7   Restart the services that are affected by the new certificate.

            Configure Certificate Revocation

            You can use the OCSP to obtain the revocation status of the certificate. To configure OCSP, follow this procedure.

            Before You Begin

            You must upload the Online Certificate Status Protocol (OCSP) Responder certificate to tomcat-trust before enabling OCSP.

            Procedure
              Step 1   Navigate to Security > Certificate Revocation

              The Certificate Revocation window displays.

              Step 2   Check the Enable OCSP check box in the Online Certificate Status Protocol Configuration area.
              Step 3   Choose one of the following options:
              Option Description
              Use OCSP URI from Certificate

              Choose this option if the certificate is configured with OCSP URI and is to be used to contact OCSP Responder.

              To verify that there is an OCSP URI in the certificate, complete the following steps:

              1. Select Security > Certificate Management.
              2. Search for the certificate using the Find filters.
              3. Select the .PEM file or .DER file link for the certificate.
              4. In the Certificate Configuration window, ensure that there is an entry for Extension:AuthorityInfoAccessSyntax and that it has an accessLocation URL.
              Use configured OCSP URI

              Choose this option if external or configured URI is used to contact OCSP Responder. Enter the URI of the OCSP Responder, where certificate revocation status is verified, in the OCSP Configured URI field.

              Step 4   Select Save.

              The certificate revocation status check is performed only during upload of a certificate or certificate chain. The appropriate alarm will be raised if a certificate is revoked.


              Third Party CA certificates

              Cisco Unified Operating System supports certificates that a third-party Certificate Authority (CA) issues with PKCS # 10 Certificate Signing Request (CSR).

              To use an application certificate that a third-party CA issues, you must obtain both the signed application certificate and the CA root certificate from the CA. Get information about obtaining these certificates from your CA. The process varies among CAs.

              IM and Presence Service Certificate Signing Requests (CSRs) include extensions that you must include in your request for an application certificate from the CA. If your CA does not support the ExtensionRequest mechanism, you must enable the X.509 extensions that are listed in the generated CSR file. For information on how to view the extensions in the generated CSR file, see View Certificates.

              Cisco verified third-party certificates that were obtained from Microsoft, Keon, and Verisign CAs. Certificates from other CAs might work but have not been verified.

              Cisco Unified Operating System generates certificates in DER and PEM encoding formats and generates CSRs in PEM encoding format. It accepts certificates in PEM and DER encoding formats.

              Public Certificate Authorities (CA) typically require Certificate Signing Requests (CSRs) to conform to specific formats. For example, a public CA might only accept CSRs that:

              • Are Base64-encoded
              • Do not contain certain characters, such as @&!, in the Organization, OU, or other fields.
              • Use specific bit lengths in the server's public key

              Likewise, if you submit CSRs from multiple nodes, public CAs might require that the information is consistent in all CSRs.

              To prevent issues with your CSRs, you should review the format requirements from the public CA to which you plan to submit the CSRs. You should then ensure that the information you enter when configuring your server conforms to the format that the public CA requires.

              Third-party certificate process management

              This procedure provides an overview of the third-party certificate process, with references to each step in sequence:

               

              Task

              For More Information

              Step 1

              Generate a CSR on the node.

              See Generate certificate signing request.

              Step 2

              Download the CSR to your PC.

              See Download certificate signing request.

              Step 3

              Use the CSR to obtain an application certificate from a CA.

              Get information about obtaining application certificates from your CA.

              Step 4

              Obtain the CA root certificate.

              Get information about obtaining a root certificate from your CA.

              Step 5

              Upload the CA root certificate to the node.

              See Upload certificate or certificate trust list.

              Step 6

              Upload the application certificate to the node.

              See Upload certificate or certificate trust list.

              Step 7

              Restart the services that are affected by the new certificate.

              For all certificate types, restart the corresponding service (for example, restart the Cisco Tomcat service if you updated the Tomcat certificate).

              For information about restarting services, see the Cisco Unified Serviceability Administration Guide.

              Configuration and Administration of IM and Presence Service on Cisco Unified Communications Manager describes in detail how to upload the following types of CA signed certificates to an IM and Presence Service deployment:

              • tomcat certificate
              • cup-xmpp certificate
              • cup-xmpp-s2s certificate

              Generate certificate signing request

              Before You Begin
              • To access the Security menu items, you must sign in again to Cisco Unified IM and Presence Operating System Administration using your Administrator password.
              • For the current release of the Cisco Unified IM and Presence Operating System, the Directory option is no longer available in the list of Certificate Names. However, you can still upload a Directory Trust certificate from a previous release, which is required for the DirSync service to work in Secure mode.
              Procedure
                Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
                Step 2   Select Security > Certificate Management.
                Step 3   Select Generate CSR.
                Step 4   Select the certificate name from the Certificate Name list.
                Step 5   Select Generate CSR .

                Download certificate signing request

                Before You Begin

                To access the Security menu items, you must sign in again to Cisco Unified IM and Presence Operating System Administration using your Administrator password.

                Procedure
                  Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
                  Step 2   Select Security > Certificate Management.
                  Step 3   Select Download CSR.
                  Step 4   Select the certificate name from the Certificate Name list.
                  Step 5   Select Download CSR.

                  Monitor certificate expiration dates

                  The system can automatically send you an email when a certificate is close to its expiration date.

                  Procedure
                    Step 1   Sign in to Cisco Unified IM and Presence Operating System Administration.
                    Step 2   Select Security > Certificate Monitor to view the current Certificate Expiration Monitor configuration.
                    Step 3   In the Notification Start Time field, enter the number of days before the certificate expires that you want to be notified.
                    Step 4   In the Notification Frequency field, enter the frequency for notification, either in hours or days.
                    Step 5   Check the Enable E-mail Notification check box to enable email notification.
                    Step 6   In the E-mail IDs field, enter the email address to which you want notifications sent.
                    Note   

                    For the system to send notifications, you must configure an SMTP host.

                    Step 7   Select Save.