mirror of
https://github.com/hanzoai/kms.git
synced 2026-11-02 14:23:22 +00:00
zeekay
0ebffbd529
- Fix 381 files where branding script corrupted variable names (e.g. isHanzo KMSTemplate -> isKmsTemplate) - Rebrand from "Hanzo KMS" to just "KMS" for white-label support (allows Lux KMS, Hanzo KMS, etc. via configuration) - 856 files, purely string replacements, no logic changes
163 lines
8.0 KiB
Plaintext
163 lines
8.0 KiB
Plaintext
---
|
|
title: "AWS Certificate Manager"
|
|
description: "Learn how to configure an AWS Certificate Manager Certificate Sync for KMS PKI."
|
|
---
|
|
|
|
**Prerequisites:**
|
|
|
|
- Create an [AWS Connection](/integrations/app-connections/aws)
|
|
|
|
<Note>
|
|
The AWS Certificate Manager Certificate Sync requires the following ACM permissions to be set on the IAM user/role
|
|
for KMS to sync certificates to AWS Certificate Manager: `acm:ListCertificates`, `acm:DescribeCertificate`, `acm:ImportCertificate`, `acm:DeleteCertificate`, and `acm:ListTagsForCertificate`.
|
|
|
|
These permissions allow KMS to list, import, tag, and manage certificates in your AWS Certificate Manager service.
|
|
|
|
</Note>
|
|
|
|
<Note>
|
|
Certificates synced to AWS Certificate Manager will be stored as imported
|
|
certificates, preserving both the certificate and private key components.
|
|
</Note>
|
|
|
|
<Tabs>
|
|
<Tab title="KMS UI">
|
|
1. Navigate to **Project** > **Integrations** > **Certificate Syncs** and press **Add Sync**.
|
|
|
|
|
|
2. Select the **AWS Certificate Manager** option.
|
|
|
|
|
|
3. Configure the **Destination** to where certificates should be deployed, then click **Next**.
|
|
|
|
|
|
- **AWS Connection**: The AWS Connection to authenticate with.
|
|
- **AWS Region**: The AWS region where certificates should be stored.
|
|
|
|
4. Configure the **Sync Options** to specify how certificates should be synced, then click **Next**.
|
|
|
|
|
|
- **Enable Removal of Expired/Revoked Certificates**: If enabled, KMS will remove certificates from the destination if they are no longer active in KMS.
|
|
- **Preserve ARN on Renewal**: If enabled, KMS will sync renewed certificates to the destination under the same ARN as the original synced certificate instead of creating a new certificate with a new ARN.
|
|
- **Include Root CA**: If enabled, the Root CA certificate will be included in the certificate chain when syncing to AWS Certificate Manager. If disabled, only intermediate certificates will be included.
|
|
- **Certificate Name Schema** (Optional): Customize how certificate tags are generated in AWS Certificate Manager. Must include `{{certificateId}}` as a placeholder for the certificate ID to ensure proper certificate identification and management. If not specified, defaults to `KMS-{{certificateId}}`.
|
|
- **Auto-Sync Enabled**: If enabled, certificates will automatically be synced when changes occur. Disable to enforce manual syncing only.
|
|
|
|
5. Configure the **Details** of your AWS Certificate Manager Certificate Sync, then click **Next**.
|
|
|
|
|
|
- **Name**: The name of your sync. Must be slug-friendly.
|
|
- **Description**: An optional description for your sync.
|
|
|
|
6. Select which certificates should be synced to AWS Certificate Manager.
|
|
|
|
|
|
7. Review your AWS Certificate Manager Certificate Sync configuration, then click **Create Sync**.
|
|
|
|
|
|
8. If enabled, your AWS Certificate Manager Certificate Sync will begin syncing your certificates to the destination endpoint.
|
|
|
|
</Tab>
|
|
<Tab title="API">
|
|
To create an **AWS Certificate Manager Certificate Sync**, make an API request to the [Create AWS Certificate Manager Certificate Sync](/api-reference/endpoints/pki/syncs/aws-certificate-manager/create) API endpoint.
|
|
|
|
### Sample request
|
|
|
|
<Note>
|
|
You can optionally specify `certificateIds` during sync creation to immediately add certificates to the sync.
|
|
If not provided, you can add certificates later using the certificate management endpoints.
|
|
</Note>
|
|
|
|
```bash Request
|
|
curl --request POST \
|
|
--url https://kms.hanzo.ai/api/v1/cert-manager/syncs/aws-certificate-manager \
|
|
--header 'Authorization: Bearer <access-token>' \
|
|
--header 'Content-Type: application/json' \
|
|
--data '{
|
|
"name": "my-acm-cert-sync",
|
|
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"description": "an example certificate sync",
|
|
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"destination": "aws-certificate-manager",
|
|
"isAutoSyncEnabled": true,
|
|
"certificateIds": [
|
|
"550e8400-e29b-41d4-a716-446655440000",
|
|
"660f1234-e29b-41d4-a716-446655440001"
|
|
],
|
|
"syncOptions": {
|
|
"canRemoveCertificates": true,
|
|
"preserveArnOnRenewal": true,
|
|
"includeRootCa": false,
|
|
"certificateNameSchema": "myapp-{{certificateId}}"
|
|
},
|
|
"destinationConfig": {
|
|
"region": "us-east-1"
|
|
}
|
|
}'
|
|
```
|
|
|
|
### Sample response
|
|
|
|
```json Response
|
|
{
|
|
"pkiSync": {
|
|
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"name": "my-acm-cert-sync",
|
|
"description": "an example certificate sync",
|
|
"destination": "aws-certificate-manager",
|
|
"isAutoSyncEnabled": true,
|
|
"destinationConfig": {
|
|
"region": "us-east-1"
|
|
},
|
|
"syncOptions": {
|
|
"canRemoveCertificates": true,
|
|
"preserveArnOnRenewal": true,
|
|
"includeRootCa": false,
|
|
"certificateNameSchema": "myapp-{{certificateId}}"
|
|
},
|
|
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
|
|
"createdAt": "2023-01-01T00:00:00.000Z",
|
|
"updatedAt": "2023-01-01T00:00:00.000Z"
|
|
}
|
|
}
|
|
```
|
|
</Tab>
|
|
|
|
</Tabs>
|
|
|
|
## Certificate Management
|
|
|
|
The AWS Certificate Manager Certificate Sync provides:
|
|
|
|
- **Automatic Deployment**: Deploy certificates in KMS to AWS Certificate Manager.
|
|
- **Certificate Updates**: Update certificates in AWS Certificate Manager when renewals occur.
|
|
- **Expiration Handling**: Optionally remove expired certificates from AWS Certificate Manager (if enabled).
|
|
- **Tagging**: Automatically tag certificates with an KMSCertificate tag for easy identification and management.
|
|
|
|
<Note>
|
|
AWS Certificate Manager Certificate Syncs support both automatic and manual
|
|
synchronization modes. When auto-sync is enabled, certificates are
|
|
automatically deployed as they are issued or renewed.
|
|
</Note>
|
|
|
|
## Manual Certificate Sync
|
|
|
|
You can manually trigger certificate synchronization to AWS Certificate Manager using the sync certificates functionality. This is useful for:
|
|
|
|
- Initial setup when you have existing certificates to deploy
|
|
- One-time sync of specific certificates
|
|
- Testing certificate sync configurations
|
|
- Force sync after making changes
|
|
|
|
To manually sync certificates, use the [Sync Certificates](/api-reference/endpoints/pki/syncs/aws-certificate-manager/sync-certificates) API endpoint or the manual sync option in the KMS UI.
|
|
|
|
## FAQ
|
|
|
|
<Accordion title="Can I import certificates from AWS Certificate Manager back into KMS?">
|
|
AWS Certificate Manager does not support importing certificates back into
|
|
KMS due to security limitations where private keys cannot be extracted
|
|
from AWS Certificate Manager. Only certificates imported into ACM (not
|
|
AWS-issued certificates) can be managed by the sync.
|
|
</Accordion>
|