awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
x032205
2025-07-31 00:29:02 -04:00
parent 93e7723b48
commit c80fd55a74
4 changed files with 112 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
docs/documentation/platform/pki/acme-ca.mdx
View File

@@ -14,7 +14,7 @@ ACME is a protocol that automates the process of certificate issuance and renewa
```mermaid
graph TD
A[ACME CA Provider<br>e.g., Let's Encrypt] <-->|ACME v2 Protocol| B[Infisical]
B -->|Creates TXT Records<br>via Route53| C[DNS Validation]
B -->|Creates TXT Records<br>via Route53/Cloudflare| C[DNS Validation]
B -->|Manages Certificates| D[Subscribers]
```
@@ -28,8 +28,8 @@ We recommend reading about [ACME protocol](https://tools.ietf.org/html/rfc8555)
A typical workflow for using Infisical with ACME Certificate Authorities consists of the following steps:
1. Setting up AWS Route53 credentials with appropriate DNS permissions.
2. Creating an AWS connection in Infisical to store the Route53 credentials.
1. Setting up AWS Route53 or Cloudflare credentials with appropriate DNS permissions.
2. Creating an AWS connection in Infisical to store the Route53/Cloudflare credentials.
3. Registering an ACME Certificate Authority (like Let's Encrypt) with Infisical.
4. Creating subscribers that use the ACME CA as their issuing authority.
5. Managing certificate lifecycle events such as issuance, renewal, and revocation through Infisical.
@@ -55,59 +55,75 @@ This automated process eliminates the need for manual intervention in domain val
In the following steps, we explore how to set up ACME Certificate Authority integration with Infisical using Let's Encrypt as an example.
<Steps>
<Step title="Set Up AWS Connection with Required Permissions">
Before proceeding with the ACME CA registration, you need to set up an AWS connection with the appropriate permissions for DNS validation:
<Step title="Create App Connection with Required Permissions">
Before proceeding with the ACME CA registration, you need to set up an App Connection with the appropriate permissions for DNS validation:
1. Navigate to your Organization Settings > App Connections and create a new AWS connection.
<Tabs>
<Tab title="Route53">
1. Navigate to your Organization Settings > App Connections and create a new AWS connection.
2. Ensure your AWS connection has the following minimum permissions for Route53 DNS validation:
2. Ensure your AWS connection has the following minimum permissions for Route53 DNS validation:
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "route53:GetChange",
"Resource": "arn:aws:route53:::change/*"
},
{
"Effect": "Allow",
"Action": "route53:ListHostedZonesByName",
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"route53:ListResourceRecordSets"
],
"Resource": [
"arn:aws:route53:::hostedzone/YOUR_HOSTED_ZONE_ID"
]
},
{
"Effect": "Allow",
"Action": [
"route53:ChangeResourceRecordSets"
],
"Resource": [
"arn:aws:route53:::hostedzone/YOUR_HOSTED_ZONE_ID"
],
"Condition": {
"ForAllValues:StringEquals": {
"route53:ChangeResourceRecordSetsRecordTypes": [
"TXT"
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": "route53:GetChange",
"Resource": "arn:aws:route53:::change/*"
},
{
"Effect": "Allow",
"Action": "route53:ListHostedZonesByName",
"Resource": "*"
},
{
"Effect": "Allow",
"Action": [
"route53:ListResourceRecordSets"
],
"Resource": [
"arn:aws:route53:::hostedzone/YOUR_HOSTED_ZONE_ID"
]
},
{
"Effect": "Allow",
"Action": [
"route53:ChangeResourceRecordSets"
],
"Resource": [
"arn:aws:route53:::hostedzone/YOUR_HOSTED_ZONE_ID"
],
"Condition": {
"ForAllValues:StringEquals": {
"route53:ChangeResourceRecordSetsRecordTypes": [
"TXT"
]
}
}
}
]
}
}
}
]
}
```
```
Replace `YOUR_HOSTED_ZONE_ID` with your actual Route53 hosted zone ID.
Replace `YOUR_HOSTED_ZONE_ID` with your actual Route53 hosted zone ID.
For detailed instructions on setting up an AWS connection, see the [AWS Connection](/integrations/app-connections/aws) documentation.
For detailed instructions on setting up an AWS connection, see the [AWS Connection](/integrations/app-connections/aws) documentation.
</Tab>
<Tab title="Cloudflare">
1. Navigate to your Organization Settings > App Connections and create a new Cloudflare connection.
2. Ensure your Cloudflare token has the following minimum permissions for DNS validation:
```
Account:Account Settings:Read
Zone:DNS:Edit
```
For detailed instructions on setting up a Cloudflare connection, see the [Cloudflare Connection](/integrations/app-connections/cloudflare) documentation.
</Tab>
</Tabs>
</Step>
<Step title="Register ACME Certificate Authority">
<Tabs>
@@ -127,7 +143,7 @@ In the following steps, we explore how to set up ACME Certificate Authority inte
- **Type**: Select "ACME" as the External CA type.
- **Name**: Enter a name for the ACME CA (e.g., "lets-encrypt-production").
- **DNS App Connection**: Select from available DNS app connections or configure a new one. This connection provides Infisical with the credentials needed to create and remove DNS records for ACME validation.
- **Hosted Zone ID**: Enter your Route53 hosted zone ID (e.g., Z04044I124N1GOOMCOYX1) for the domain(s) you'll be requesting certificates for.
- **Zone ID**: Enter your Route53 hosted zone ID (e.g., Z04044I124N1GOOMCOYX1) or select your Cloudflare Zone for the domain(s) you'll be requesting certificates for.
- **Directory URL**: Enter the ACME v2 directory URL for your chosen CA provider (e.g., `https://acme-v02.api.letsencrypt.org/directory` for Let's Encrypt).
- **Account Email**: Email address to associate with your ACME account. This email will receive important notifications about your certificates.
- **Enable Direct Issuance**: Toggle on to allow direct certificate issuance without requiring subscribers.
@@ -140,7 +156,7 @@ In the following steps, we explore how to set up ACME Certificate Authority inte
![pki external ca list](/images/platform/pki/ca/external-ca/external-ca-list.png)
From here, you can:
- View the status of the ACME CA registration
- Edit the configuration settings
- Disable or re-enable the ACME CA
@@ -152,9 +168,9 @@ In the following steps, we explore how to set up ACME Certificate Authority inte
</Tab>
<Tab title="API">
To register an ACME CA with Infisical using the API, make a request to the Create External CA endpoint:
### Sample request
```bash Request
curl 'https://app.infisical.com/api/v1/pki/ca/acme' \
-H 'Authorization: Bearer <your-access-token>' \
@@ -180,9 +196,9 @@ In the following steps, we explore how to set up ACME Certificate Authority inte
}
}'
```
### Sample response
```bash Response
{
"id": "c48b701e-a20c-4a9a-8119-68f54e5fbb05",
@@ -226,7 +242,7 @@ In the following steps, we explore how to set up ACME Certificate Authority inte
1. Infisical generates a key pair for the certificate
2. Sends a Certificate Signing Request (CSR) to the ACME CA
3. Receives a DNS-01 challenge from the ACME provider
4. Creates a TXT record in Route53 to satisfy the challenge
4. Creates a TXT record in Route53/Cloudflare to satisfy the challenge
5. Notifies the ACME provider that the challenge is ready for validation
6. Once validated, the ACME provider issues the certificate
7. Infisical stores and manages the certificate for your subscriber
@@ -235,7 +251,7 @@ In the following steps, we explore how to set up ACME Certificate Authority inte
</Step>
<Step title="Use Certificate in Your Applications">
The issued certificate and private key are now available through Infisical and can be:
- Downloaded directly from the Infisical UI
- Retrieved via the Infisical API for programmatic access using the [latest certificate bundle endpoint](/api-reference/endpoints/pki/subscribers/get-latest-cert-bundle)
</Step>
@@ -265,35 +281,35 @@ Let's Encrypt is a free, automated, and open Certificate Authority that provides
<AccordionGroup>
<Accordion title="What DNS validation methods are supported?">
Currently, Infisical supports DNS-01 validation through AWS Route53. The DNS-01 challenge method is preferred for ACME integrations because it:
Currently, Infisical supports DNS-01 validation through AWS Route53 or Cloudflare. The DNS-01 challenge method is preferred for ACME integrations because it:
- Works with wildcard certificates
- Doesn't require your servers to be publicly accessible
- Can be fully automated without manual intervention
Support for additional DNS providers is planned for future releases.
</Accordion>
<Accordion title="Can I use wildcard certificates with ACME CAs?">
Yes! ACME CAs like Let's Encrypt support wildcard certificates (e.g., `*.example.com`) when using DNS-01 validation. Simply specify the wildcard domain in your subscriber configuration.
Note that wildcard certificates still require DNS-01 validation - HTTP-01 validation cannot be used for wildcard certificates.
</Accordion>
<Accordion title="How long are ACME certificates valid?">
Most ACME providers issue certificates with 90-day validity periods. This shorter validity period is designed to:
- Encourage automation of certificate management
- Reduce the impact of compromised certificates
- Ensure systems stay up-to-date with certificate management practices
When configured, Infisical automatically handles certificate renewal for subscribers.
</Accordion>
<Accordion title="Can I use multiple ACME providers?">
Yes! You can register multiple ACME CAs in the same project:
- Different providers for different domains or use cases
- Staging and production environments for the same provider
- Backup providers for redundancy
Each subscriber can be configured to use a specific ACME CA based on your requirements.
</Accordion>
</AccordionGroup>
</AccordionGroup>

38
docs/documentation/platform/pki/external-ca.mdx
View File

@@ -13,11 +13,11 @@ In addition to creating a Private CA hierarchy, Infisical allows you to integrat
```mermaid
graph TD
B[Infisical] -->|Manages Certificates| D[Subscribers]
A1[Public CAs<br>Let's Encrypt, ZeroSSL] -->|ACME Protocol| B
A2[Enterprise CAs<br>Vault PKI, Step CA] -->|ACME Protocol| B
A3[Cloud CAs<br>ACME-compatible services] -->|ACME Protocol| B
A4[Future: Enterprise CAs] -.->|EST/SCEP Protocols| B
A5[Future: Cloud CAs] -.->|REST APIs| B
```
@@ -54,7 +54,7 @@ ACME (Automatic Certificate Management Environment) is a widely adopted protocol
**Public Certificate Authorities:**
- Let's Encrypt - Free, automated SSL/TLS certificates
- ZeroSSL - Free and premium SSL certificates
- ZeroSSL - Free and premium SSL certificates
- Buypass - Norwegian CA with free ACME certificates
**Enterprise Certificate Authorities:**
@@ -73,7 +73,7 @@ External CA integration is ideal for various scenarios:
### Public-Facing Services
Use publicly trusted CAs for websites and services that need browser compatibility:
- Web applications and APIs
- Load balancers and CDNs
- Load balancers and CDNs
- Public-facing microservices
### Compliance Requirements
@@ -137,18 +137,18 @@ Get started with External CA integration:
<AccordionGroup>
<Accordion title="Which External CAs does Infisical currently support?">
Currently, Infisical supports any Certificate Authority that implements the ACME protocol, including:
- **Public CAs**: Let's Encrypt, ZeroSSL, Buypass
- **Enterprise CAs**: HashiCorp Vault PKI, Step CA
- **Enterprise CAs**: HashiCorp Vault PKI, Step CA
- **Cloud CAs**: ACME-compatible managed services
Integration uses DNS-01 validation through Route53. Learn more about [supported DNS validation methods](/documentation/platform/pki/acme-ca#what-dns-validation-methods-are-supported).
Integration uses DNS-01 validation through Route53 or Cloudflare. Learn more about [supported DNS validation methods](/documentation/platform/pki/acme-ca#what-dns-validation-methods-are-supported).
Support for additional integration protocols (EST, SCEP, direct APIs) is planned for future releases.
</Accordion>
<Accordion title="Can I use both Private CAs and External CAs in the same project?">
Yes. You can have both Private CAs (root and intermediate) and External CAs in the same project, allowing you flexibility in how you issue certificates for different use cases. This hybrid approach enables you to:
- Use Private CAs for internal services and applications
- Use External CAs for public-facing services
- Apply consistent management practices across all certificate types
@@ -156,37 +156,37 @@ Get started with External CA integration:
</Accordion>
<Accordion title="What types of certificates can I issue through External CAs?">
The types of certificates you can issue depend on the External CA provider and type:
- **Public CAs**: Typically support Domain Validation (DV) certificates, with some offering Organization Validation (OV)
- **Enterprise CAs**: Support internal certificates, device certificates, and custom certificate types
- **Cloud CAs**: Support various certificate types depending on the service
Certificate capabilities vary by provider and integration method.
</Accordion>
<Accordion title="How does certificate renewal work with External CAs?">
Certificate reissuance is handled automatically by Infisical based on the CA type:
- **Public CAs**: Automatic reissuance using ACME protocol with the same certificate extensions before expiration
- **Other CA types**: Certificate management methods depend on the specific integration (when available)
All certificate lifecycle events are tracked and managed through Infisical's unified interface, ensuring continuous certificate validity.
</Accordion>
<Accordion title="What authentication methods are supported for External CAs?">
Authentication methods vary by CA type:
- **Public CAs**: ACME account registration with email and account keys
- **Enterprise CAs**: Client certificates, username/password, or domain authentication (when available)
- **Cloud CAs**: API keys, OAuth tokens, or service account authentication (when available)
Infisical securely stores and manages all authentication credentials.
</Accordion>
<Accordion title="Can I enforce policies on certificates from External CAs?">
Yes, Infisical provides policy enforcement capabilities:
- Certificate template constraints
- Monitoring and alerting policies
- Access controls for certificate operations
These policies ensure consistent governance across both internal and external certificate sources.
</Accordion>
</AccordionGroup>
</AccordionGroup>