Knowledge Base

Generating a CSR on Zimbra

Zimbra mail server allows generating a certificate signing request (CSR) in two different ways:

  • zimbra administration console (web interface)
  • zimbra certificate manager (command line interface).
  • CSR generation via Zimbra Administration Console

    To enter the administration console for CSR generation, use the following URL pattern: https: //server.domain.com:7071

    In this link, server.domain.com is the current Zimbra server name or IP address; default port is 7071.

    1. Put in the complete administrator address, such as admin@domain.com and then enter the password. Click “Sign In”:
    2. csrzim1

    3. Click on “Configure” in the left list of the main menu.
    4. csrzim2

    5. In the next window, click on “Certificates” and pick the option “Install Certificate”:
    6. csrzim3

    7. You will see the separate window where you need to choose the required mail server. Click “Next” afterwards:
    8. csrzim4

    9. Pick the “Generate the CSR” option to start the generation process:
    10. csrzim5

    11. Fill in all necessary information:
    12. - Common Name is a fully qualified domain name for which the SSL will be activated. For SSL Wildcard certificates, an asterisk should be placed in front of the domain name (e.g., *.example.com).
      - Country Name is a two capital letter (ISO 3166-1 compliant) code of the country where the company or applicant is located (e.g., US).
      - State/Province is a state, county or region where the company or applicant is located (e.g., California).
      - City is a city or town, village where the company or applicant is located. (e.g., Los Angeles).
      - Organization name is the officially registered name of the organization that applies for a certificate. If you do not have any, put NA here.
      - Organizational Unit is the name of the department or division within your organization. If you do not have any, put NA here.

      If you are going to activate a single domain SSL certificate, click on the “Remove” button to delete the Subject Alternative Name. Once done, click “Next” to proceed:

      csrzim6

    13. Download the CSR file, open it with any text editor and copy the whole CSR code including the “Begin Certificate” and “End Certificate” lines for further SSL certificate activation.
    14. csrzim7

      CSR generation via Zimbra Certificate Manager (command line interface)

      A Zimbra package has the “zmcertmgr” tool to manage SSL certificates.
      For versions 8.6 or lower, this tool must be run as root. Run this command in the terminal to get root privileges:


      sudo su

      Starting from version 8.7 this tool should be run as a zimbra user. Run these commands to switch from the default user to the zimbra user:


      sudo su
      su zimbra

      Run the following command to generate a new CSR code for a single domain SSL certificate:


      /opt/zimbra/bin/zmcertmgr createcsr comm -new -subject "/C=HK/ST=HK/L=Hong Kong/O=ZTABOX/OU=NA/CN=server.domain.com" -noDefaultSubjectAltName

      Where C - Country
      ST - State (region)
      L - Locality (city, town, etc.)
      O - Organization name
      OU - Organization Unit
      CN - Common Name (primary server hostname)

      (All this information should be your own contact information)

      To generate a CSR for a Wildcard certificate, put the server hostname in this format: *.domain.com

      If you would like to generate a CSR for multiple domain names, run this command:


      /opt/zimbra/bin/zmcertmgr createcsr comm -new -subject "/C=HK/ST=HK/L=Hong Kong/O=ZTABOX/OU=NA/CN=first.domain.com" -subjectAltNames “second.domain.com,third.domain.com”

      Where CN - primary server hostname and subjectAltNames “second.domain.com,third.domain.com” - additional hostnames separated by a comma.

      Once the CSR file is generated, open it with this command:


      cat /opt/zimbra/ssl/zimbra/commercial/commercial.csr

      The CSR code should look like:

      csrzim8

      Copy the full output including the header -----BEGIN CERTIFICATE REQUEST----- and footer -----END CERTIFICATE REQUEST----- for further SSL activation.

      Note: The corresponding private key will be saved in this file /opt/zimbra/ssl/zimbra/commercial/commercial.key

      It will be required for SSL certificate installation on this or other server.