Importing SSL/TLS certificates

Importing certificates in the UI

You can import an existing certificate by using the Secrets Manager UI.

1. In the console, click the Menu icon > Resource List.

2. From the list of services, select your instance of Secrets Manager.

3. In the Secrets table, click Add.

4. From the list of secret types, click the Import certificate tile.

5. Click Next.

6. Add a name and description to easily identify your certificate.

7. Select the secret groupThe environment and constraints that contained secrets in an instance must adhere to. A user can be associated with a secret group to enable access and collaboration. that you want to assign to the secret.

   Don't have a secret group? In the Secret group field, you can click Create to provide a name and a description for a new group. Your secret is added to the new group automatically. For more information about secret groups, check out Organizing your secrets.

8. Optional: Add labels to help you to search for similar secrets in your instance.

9. Optional: Add metadata to your secret or to a specific version of your secret.

   1. Upload a file or enter the metadata and the version metadata in JSON format.

10. Click Next.

11. Select a certificate file or enter its value.

    You can store unexpired X.509 certificate files that are in PEM format. If you're working with certificates that are in a different format, you can use command-line utilities to convert your certificates to .pem. For more information, see Why can't I import my certificate?

12. Optional: Select a private key file or enter its value.

    If you choose to store a private key, ensure that it matches to your certificate. The private key must be unencrypted before you can import it to the service.

13. Optional: Select an intermediate certificate file or enter its value.

14. Click Next.

15. Review the details of your certificate.

16. Click Add.

Importing certificates from the CLI

Before you begin, follow the CLI docs to set your API endpoint.

To import a certificate by using the Secrets Manager CLI plug-in, run the ibmcloud secrets-manager secret-create command. For example, the following command imports a certificate along with its private key and intermediate certificate.

You can import certificate files that are in the .pem format. Be sure to convert your PEM files to single-line format so that they can be parsed correctly by the Secrets Manager CLI.

certificate=$(awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' cert.pem)
private_key=$(awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' key.pem)

ibmcloud secrets-manager secret-create 
    --secret-prototype="{
    "certificate": "${certificate}", 
    "private_key": "${private_key}", 
    "description": "Description of my imported certificate.", 
    "labels": [
        "dev","us-south"
        ], 
    "name": "example-imported-certificate", 
    "secret_group_id": "default", 
    "secret_type": "imported_cert", 
    }

The command outputs the ID value of the secret, along with other metadata. For more information about the command options, see ibmcloud secrets-manager secret-create.

Importing certificates with the API

You can import certificates programmatically by calling the Secrets Manager API.

The following example shows a query that you can use to import an existing certificate. When you call the API, replace the ID variables and IAM token with the values that are specific to your Secrets Manager instance.

You can store metadata that are relevant to the needs of your organization with the custom_metadata and version_custom_metadata request parameters. Values of the version_custom_metadata are returned only for the versions of a secret. The custom metadata of your secret is stored as all other metadata, for up to 50 versions, and you must not include confidential data.

You can import certificate files that are in the .pem format. Be sure to convert your PEM files to single-line format so that they can be parsed correctly by the Secrets Manager API.

curl -X POST  
    -H "Authorization: Bearer {iam_token}" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -d '{ 
            "name": "example-imported-certificate",
            "description": "description of my imported certificate.",
            "secret_type": "imported_cert",
            "secret_group_id": "67d025e1-0248-418f-83ba-deb0ebfb9b4a",
            "labels": [
                "dev",
                "us-south"
            ],
            "certificate": "-----BEGIN CERTIFICATE-----\nMIIE3jCCBGSgAwIBAgIUZfTbf3adn87l5J2Q2Aw+6Vk/qhowCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----",
            "intermediate": "-----BEGIN CERTIFICATE-----\nMIIE3DCCBGKgAwIBAgIUKncnp6BdSUKAFGBcP4YVp/gTb7gwCgYIKoZIzj0EAwIw\n-----END CERTIFICATE-----",
            "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAqcRbzV1wp0nVrPtEpMtnWMO6Js1q3rhREZluKZfu0Q8SY4H3\n-----END RSA PRIVATE KEY-----",
            "custom_metadata": {
                "metadata_custom_key": "metadata_custom_value"
            },
            "version_custom_metadata": {
                "custom_version_key": "custom_version_value"
            }
        }' \ 
    "https://{instance_ID}.{region}.secrets-manager.appdomain.cloud/api/v2/secrets"

A successful response returns the ID value of the secret, along with other metadata. For more information about the required and optional request parameters, see Create a secret.

Importing certificates with Terraform

You can import certificates programmatically by using Terraform for Secrets Manager.

The following example shows a query that you can use to import an existing certificate.

    resource "ibm_sm_imported_certificate" "sm_imported_certificate" {
        instance_id = local.instance_id
        region = local.region
        name = "test-imported-certificate"
        secret_group_id = "default"
        certificate  = file("path_to_certificate_file")
        intermediate = file("path_to_intermediate_certificate_file")
        private_key  = file("path_to_private_key_file")
    }