23 Commits

Author SHA1 Message Date
b0f0467346 Added helper scripts that will lock and unlock changes to version.go. 2025-08-02 13:50:39 +02:00
028788f357 Updated build.sh to embed version information to the binary using changes to the version.go file. 2025-08-02 13:45:45 +02:00
090fb4b423 Moved Version variable to a separate file. 2025-08-02 13:42:25 +02:00
eb5c5c0e43 Updated tea repository name. 2025-07-30 09:01:00 +02:00
8181ac8287 Added missing go mod tidy. 2025-07-30 08:58:58 +02:00
3fe908226d Fixed unchange placeholder names. 2025-07-30 08:56:17 +02:00
8a36588c62 Added manual trigger. 2025-07-30 08:49:49 +02:00
90ce7edd28 Fixed incorrect workflow directory name. 2025-07-30 08:47:09 +02:00
11bed9c8b1 Added release workflow. 2025-07-30 08:37:21 +02:00
2fe228858f Update build process and version embedding. 2025-07-30 08:17:15 +02:00
e9d2634819 Updated documentation. 2025-07-28 21:27:05 +02:00
9d226df44f Fixes for bugs related to rendering certificate templates from defaults and variables. 2025-07-28 21:26:52 +02:00
71412ace5e Added example client,email certificate. 2025-07-28 21:25:23 +02:00
2350e3cbc1 Added a script that prints certificates. 2025-07-28 21:25:03 +02:00
d045938ff8 Updated test script 2025-07-28 21:24:46 +02:00
72424379e0 Moved test CA test location to 'ca' subdirectory. 2025-07-28 21:24:32 +02:00
54296f7526 Updated tests. 2025-07-28 19:15:51 +02:00
6682be6eb1 Added list command and ability to combine certificate usages. 2025-07-28 18:58:37 +02:00
9b7b995e97 Added function that can look for a certificate in the database. 2025-07-28 18:57:57 +02:00
b387a016be Added state file location defintion to the CA configuration. Added more certificate properties to certificate database. 2025-07-28 17:41:41 +02:00
e4469fde96 More renames. 2025-07-28 15:53:17 +02:00
bea0285007 Refactoring 2025-07-28 15:36:45 +02:00
a8308e0f4f Moved global flag variables to the global scope. Refactored some functions interfaces and removed passing global flags. 2025-07-28 13:48:38 +02:00
14 changed files with 536 additions and 189 deletions

View File

@@ -0,0 +1,54 @@
name: Release
on:
workflow_dispatch:
push:
tags:
- 'v*.*.*'
jobs:
release:
runs-on: ubuntu-latest
steps:
# 1. Checkout source code
- name: Checkout
uses: actions/checkout@v4
# 2. Setup Go environment
- name: Setup Go
uses: actions/setup-go@v5
with:
go-version: '1.24.5'
# 3. Build binary with Version injected
- name: Build binary
run: |
VERSION=${GITEA_REF_NAME}
echo "Building version $VERSION"
go mod tidy
go build -ldflags "-s -w -X main.Version=$VERSION" -o lab-ca .
# 4. Install the tea CLI
- name: Install tea CLI
run: go install code.gitea.io/tea@latest
# 5. Authenticate tea CLI
- name: Login to Gitea
run: |
tea login add --name ci --url $GITEA_URL --token $GITEA_TOKEN
env:
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
GITEA_URL: ${{ secrets.GITEA_URL }}
# 6. Create or update release
- name: Create or update release
run: |
tea release create $GITEA_REF_NAME \
--title "$GITEA_REF_NAME" \
--note "Automated release for $GITEA_REF_NAME" || \
echo "Release already exists, skipping create."
# 7. Upload binary to the release
- name: Upload binary
run: tea release upload $GITEA_REF_NAME lab-ca

6
.gitignore vendored
View File

@@ -2,6 +2,7 @@
**/go.sum
# Ignore the binary output
lab-ca*
build
# Ignore any certificate files
*.pem
# Ignore CA configuration and certificate definitions.
@@ -13,5 +14,6 @@ lab-ca*
# Exclude MacOS Finder metadata files
.DS_Store
# Exclude default certificate and private key files directories
/certs/
/private/
/ca
# Don't share VS Code files
.vscode/

200
README.md
View File

@@ -2,22 +2,23 @@
This repository contains a simple CLI tool for managing a Certificate Authority (CA).
It has been designed to be as easy to use as possible and provides a basic set of CA features:
It is designed to be easy to use and provides a basic set of CA features:
- Create a CA and a self-signed CA certificate
- Create and sign a few most common types of certificates:
- Create and sign common types of certificates:
- Server certificate
- Client certificate
- Code signing certificate
- Email certificate
- Sign a CSR to create a certificate
- Revoke a certificate
- List issued certificates
- Create a CRL (Certificate Revocation List)
> **NOTE:** Certificate types can be combined (e.g. `server,client`).
## Usage
The tool is designed to be used from the command line. It has a simple command structure:
The tool is used from the command line. It has a simple command structure:
```bash
lab-ca <command> [options]
@@ -25,23 +26,26 @@ lab-ca <command> [options]
The main commands available are:
- `initca` — Initialize a new CA and create a self-signed CA certificate.
- `issue` — Issue a new certificate signed by the CA.
- `initca` — Initialize a new CA and create a self-signed CA certificate and key.
- `issue` — Issue a new certificate signed by the CA (single certificate, command-line options).
- `provision` — Provision multiple certificates from a batch file (HCL) in one go.
- `revoke` — Revoke a certificate by name or serial number.
- `crl` — Generate a Certificate Revocation List (CRL) from revoked certificates.
- `list` — List issued certificates (optionally including revoked).
- `version` — Show version information for the tool.
Run the command with `-h` or `--help` or without any arguments to see the usage information. Each command has its own set of options, arguments, and a help message.
Run the command with `-h` or `--help` or without any arguments to see usage information. Each command has its own set of options, arguments, and a help message.
---
### CA Initialization
Create a new CA configuration file:
Create a new CA configuration file (HCL):
```
```hcl
ca "example_ca" {
name = "Example CA"
country = "PL"
country = "US"
organization = "ACME Corp"
key_size = 4096
validity = "10y"
@@ -49,41 +53,67 @@ ca "example_ca" {
paths {
certificates = "certs"
private_keys = "private"
state_file = "ca_state.json"
}
}
```
> **NOTE:** `lab-ca` uses HCL (HashiCorp Configuration Language) for configuration files. You can find more information about HCL [here](https://github.com/hashicorp/hcl).
- The `ca` block's label is used as a logical name for the CA and for the default state file name.
- The `paths` block defines where certificates, private keys, and the CA state file are stored.
- On Linux/macOS, the private keys directory is created with `0700` permissions.
- The command does not encrypt private keys. Do not use in production.
The `ca` block's label has no function, but may be used to identify the CA in the future.
---
The following attributes are available:
### Listing Certificates
- `name` - the name of the CA
- `country` - the country of the CA
- `organization` - the organization of the CA
- `organizational_unit` - the organizational unit of the CA (optional)
- `locality` - the locality of the CA (optional)
- `province` - the province of the CA (optional)
- `email` - the email address of the CA (optional)
- `key_size` - the size of the CA key in bits (default: 4096)
- `validity` - the validity period of the CA certificate (default: 10 years)
- `paths` - paths to store certificates and private keys
List all issued (non-revoked) certificates:
The `paths` block defines where the command will store the generated certificates and private keys. On Linux and macOS, the directory specified for private keys will be created with `0700` permissions. However, the command does not check if the directory has correct permissions, so you should ensure that the directory is not accessible by other users. On Windows, both directories will be created with the default ACL for the current user. You have to secure the private keys directory yourself.
```bash
lab-ca list
```
> **NOTE:** The command does not encrypt private keys. It is not designed to be used in a production environment.
To include revoked certificates:
## Certificate Issuance and Provisioning
```bash
lab-ca list --revoked
```
To issue a new certificate, you can use the `issue` command and specify the certificate definition on the command line, or use the `provision` command to provide a file with multiple certificate definitions for batch processing.
---
The definition file also uses HCL syntax. Here is an example of a certificate definition file:
### Issuing a Certificate
Issue a new certificate from the command line:
```bash
lab-ca issue --name <name> [--subject <subject>] [--type <type>] [--validity <period>] [--san <SAN> ...] [--overwrite] [--dry-run] [--verbose]
```
- `--name` (required): Name for the certificate and key files (used as subject if `--subject` is omitted)
- `--subject`: Subject Common Name or full DN (optional, defaults to `--name`)
- `--type`: Certificate type: `client`, `server`, `code-signing`, `email` (comma-separated for multiple usages; default: `server`)
- `--validity`: Validity period (e.g. `2y`, `6m`, `30d`; default: `1y`)
- `--san`: Subject Alternative Name (repeatable; e.g. `dns:example.com`, `ip:1.2.3.4`, `email:user@example.com`)
- `--overwrite`: Allow overwriting existing files
- `--dry-run`: Validate and show what would be created, but do not write files
- `--verbose`: Print detailed information
---
### Provisioning Certificates (Batch)
Provision multiple certificates from a batch file (HCL):
```bash
lab-ca provision --file <certificates.hcl> [--overwrite] [--verbose]
```
#### Example HCL Provisioning File
```hcl
defaults {
subject = "{{ .Name }}.example.org"
type = "server"
type = "server,client"
validity = "1y"
san = ["DNS:{{ .Name }}.example.org"]
}
@@ -95,26 +125,116 @@ variables = {
certificate "service1" {
# from default: subject = "{{ .Name }}.example.org"
# from default: type = "server"
# from default: type = "server,client"
# from default: validity = "1y"
# from default: san = ["DNS:{{ .Name }}.example.org"]
# from default: san = ["DNS:service1.example.org"]
}
certificate "service2" {
subject = "{{ .Name }}.example.net"
# from default: type = "server"
# from default: validity = "1y"
san = ["DNS:{{ .Name }}.example.net"]
subject = "{{ .Name }}.{{ .Domain }}" # result: service2.example.net
san = ["DNS:{{ .Name }}.{{ .Domain }}"] # result: [ "DNS:service2.example.net" ]
}
certificate "service3" {}
certificate "service4" {
subject = "{{ .Name }}.{{ .Domain }}"
san = ["DNS:{{ .Name }}.{{ .Domain }}"]
certificate "user1" {
subject = "CN=User One,emailAddress=user1@example.org,O=Example,C=US"
type = "client,email"
validity = "1y"
san = ["email:user1@example.net"]
}
```
Values specified in the `defaults` block will be used for all certificates unless overridden in individual certificate definitions. Go-style template syntax is also supported, so you can use `{{ .Name }}` to refer to the certificate name, and variables from the `variables` map can be used in templates as well.
- The `defaults` block provides default values for all certificates unless overridden.
- The `variables` map can be used in Go template expressions in any field.
- Each `certificate` block defines a certificate to be issued. The block label is available as `{{ .Name }}` in templates.
- Fields:
- `subject`: Subject string (can be a template)
- `type`: Comma-separated usages (server, client, code-signing, email)
- `validity`: Validity period (e.g. `1y`, `6m`, `30d`)
- `san`: List of SANs (e.g. `DNS:...`, `IP:...`, `email:...`)
You can use DNS or IP SANs for server certificates (`server` and `server-only`), and email SANs for email certificates (`email`). The command will check if the SAN is valid based on the type of certificate.
---
### Revoking a Certificate
Revoke a certificate by name or serial number:
```bash
lab-ca revoke --name <name> [--reason <reason>]
lab-ca revoke --serial <serial> [--reason <reason>]
```
- `--reason` can be one of: `unspecified`, `keyCompromise`, `caCompromise`, `affiliationChanged`, `superseded`, `cessationOfOperation`, `certificateHold`, `removeFromCRL` (default: `cessationOfOperation`)
---
### Generating a CRL
Generate a Certificate Revocation List (CRL) from revoked certificates:
```bash
lab-ca crl [--crl-file <path>] [--validity-days <days>]
```
- `--crl-file`: Output path for CRL file (default: `crl.pem`)
- `--validity-days`: CRL validity in days (default: 30)
---
### Version
Show version information:
```bash
lab-ca version
```
---
## Configuration and Templates
- All configuration and provisioning files use HCL (HashiCorp Configuration Language).
- Go template syntax is supported in `subject`, `san`, and other string fields. The following variables are available:
- `.Name`: The certificate name (from the block label)
- Any key from the `variables` map
Example:
```hcl
subject = "{{ .Name }}.{{ .Domain }}"
san = ["DNS:{{ .Name }}.{{ .Domain }}"]
```
## Certificate Types and SANs
- `server`: For server certificates. SANs should be DNS or IP.
- `client`: For client certificates. SANs can be email or DNS.
- `email`: For S/MIME/email certificates. SANs should be email.
- `code-signing`: For code signing certificates.
The tool checks that SANs are valid for the selected certificate type(s). Certificate usage can be combined (e.g. `server,client`).
---
## Example: Real-World Provisioning File
See `examples/example-certificates.hcl` for a more advanced provisioning file with templates and variables.
## Building the Tool
The repository includes a `build.sh` script to build the CLI tool. It updates the version in `version.go` and builds the binary.
To ignore changes made to `version.go` in Git, you can run:
```bash
git update-index --assume-unchanged version.go
```
---
## Notes
- The tool does not encrypt private keys. Protect your private keys directory.
- Not intended for production use.
- For more information about HCL, see: https://github.com/hashicorp/hcl

View File

@@ -6,4 +6,21 @@ if [ $? -eq 0 ]; then
else
VERSION="dev"
fi
go build -ldflags "-X main.Version=$VERSION" -o lab-ca
# Hardcode the version into main.go
sed -i '' "s/^var Version = .*/var Version = \"$VERSION\"/" version.go
if echo $VERSION | grep -q 'dirty$'; then
echo "Building in development mode, output directory is set to 'build'."
OUTPUT_DIR=build
# Make sure the output directory exists, create it if it is not
mkdir -p $OUTPUT_DIR
else
echo "Building with version: $VERSION"
OUTPUT_DIR=$GOHOME/bin
fi
# Build the Lab CA binary with version information
# go build -ldflags "-X main.Version=$VERSION" -o $OUTPUT_DIR/lab-ca
go build -o $OUTPUT_DIR/lab-ca

177
ca.go
View File

@@ -24,9 +24,10 @@ import (
type Paths struct {
Certificates string `hcl:"certificates"`
PrivateKeys string `hcl:"private_keys"`
StatePath string `hcl:"state_file"`
}
type _CAConfig struct {
type CAConfig struct {
Label string `hcl:",label"`
Name string `hcl:"name"`
Country string `hcl:"country"`
@@ -41,12 +42,12 @@ type _CAConfig struct {
Paths Paths `hcl:"paths,block"`
}
func (c *_CAConfig) StateName() string {
func (c *CAConfig) GetStateFileName() string {
return c.Label + "_state.json"
}
type Configuration struct {
Current _CAConfig `hcl:"ca,block"`
CA CAConfig `hcl:"ca,block"`
}
type CertificateDefinition struct {
@@ -57,7 +58,7 @@ type CertificateDefinition struct {
SAN []string `hcl:"san,optional"`
}
func (def *CertificateDefinition) fillDefaultValues(defaults *CertificateDefaults) {
func (def *CertificateDefinition) FillDefaultValues(defaults *CertificateDefaults) {
if defaults == nil {
return
}
@@ -142,17 +143,27 @@ func (c *Certificates) LoadFromFile(path string) error {
}
// Global CA configuration and state variables
var CAConfigPath string
var CAState *_CAState
var CAConfig *_CAConfig
var CAKey *rsa.PrivateKey
var CACert *x509.Certificate
var caConfigPath string
var caConfig *CAConfig
var caStatePath string
var caState *CAState
var caKey *rsa.PrivateKey
var caCert *x509.Certificate
// LoadCAConfig parses and validates the CA config from the given path and stores it in the CAConfig global variable
func LoadCAConfig() error {
fmt.Printf("Loading CA config from %s\n", CAConfigPath)
if verbose {
cwd, err := os.Getwd()
if err != nil {
return err
}
fmt.Printf("The current working dirctory: \"%s\"\n", cwd)
fmt.Printf("Loading CA config from \"%s\"... ", caConfigPath)
}
parser := hclparse.NewParser()
file, diags := parser.ParseHCLFile(CAConfigPath)
file, diags := parser.ParseHCLFile(caConfigPath)
if diags.HasErrors() {
return fmt.Errorf("failed to parse HCL: %s", diags.Error())
}
@@ -161,16 +172,24 @@ func LoadCAConfig() error {
if diags.HasErrors() {
return fmt.Errorf("failed to decode HCL: %s", diags.Error())
}
if (_CAConfig{}) == config.Current {
if (CAConfig{}) == config.CA {
return fmt.Errorf("no 'ca' block found in config file")
}
if config.Current.Label == "" {
if config.CA.Label == "" {
return fmt.Errorf("the 'ca' block must have a label (e.g., ca \"mylabel\" {...})")
}
if err := config.Current.Validate(); err != nil {
if err := config.CA.Validate(); err != nil {
return err
}
CAConfig = &config.Current
// If the state file is specified as an absolute path, use it directly.
if filepath.IsAbs(config.CA.Paths.StatePath) {
caStatePath = config.CA.Paths.StatePath
} else {
caStatePath = filepath.Join(filepath.Dir(caConfigPath), config.CA.Paths.StatePath)
}
caConfig = &config.CA
return nil
}
@@ -184,8 +203,8 @@ func LoadCA() error {
}
// Load CA key and certificate
caCertPath := filepath.Join(CAConfig.Paths.Certificates, "ca_cert.pem")
caKeyPath := filepath.Join(CAConfig.Paths.PrivateKeys, "ca_key.pem")
caCertPath := filepath.Join(caConfig.Paths.Certificates, "ca_cert.pem")
caKeyPath := filepath.Join(caConfig.Paths.PrivateKeys, "ca_key.pem")
caCertPEM, err := os.ReadFile(caCertPath)
if err != nil {
@@ -200,7 +219,7 @@ func LoadCA() error {
if caCertBlock == nil {
return fmt.Errorf("failed to parse CA certificate PEM")
}
CACert, err = x509.ParseCertificate(caCertBlock.Bytes)
caCert, err = x509.ParseCertificate(caCertBlock.Bytes)
if err != nil {
return fmt.Errorf("failed to parse CA certificate: %v", err)
}
@@ -208,7 +227,7 @@ func LoadCA() error {
if caKeyBlock == nil {
return fmt.Errorf("failed to parse CA key PEM")
}
CAKey, err = x509.ParsePKCS1PrivateKey(caKeyBlock.Bytes)
caKey, err = x509.ParsePKCS1PrivateKey(caKeyBlock.Bytes)
if err != nil {
return fmt.Errorf("failed to parse CA private key: %v", err)
}
@@ -271,7 +290,7 @@ func parseValidity(validity string) (time.Duration, error) {
}
}
func SavePEM(filename string, data []byte, secure bool, overwrite bool) error {
func SavePEM(filename string, data []byte, secure bool) error {
if !overwrite {
if _, err := os.Stat(filename); err == nil {
return fmt.Errorf("file %s already exists (overwrite not allowed)", filename)
@@ -297,7 +316,7 @@ func (p *Paths) Validate() error {
return nil
}
func (c *_CAConfig) Validate() error {
func (c *CAConfig) Validate() error {
if c.Name == "" {
return fmt.Errorf("CA 'name' is required")
}
@@ -321,38 +340,39 @@ func (c *_CAConfig) Validate() error {
return nil
}
func InitCA(overwrite bool) error {
func InitCA() error {
var err error
err = LoadCAConfig()
if err != nil {
fmt.Printf("ERROR: %v\n", err)
return err
}
// Create certificates directory with 0755, private keys with 0700
if CAConfig.Paths.Certificates != "" {
if err := os.MkdirAll(CAConfig.Paths.Certificates, 0755); err != nil {
fmt.Printf("Error creating certificates directory '%s': %v\n", CAConfig.Paths.Certificates, err)
if caConfig.Paths.Certificates != "" {
if err := os.MkdirAll(caConfig.Paths.Certificates, 0755); err != nil {
fmt.Printf("Error creating certificates directory '%s': %v\n", caConfig.Paths.Certificates, err)
return err
}
}
if CAConfig.Paths.PrivateKeys != "" {
if err := os.MkdirAll(CAConfig.Paths.PrivateKeys, 0700); err != nil {
fmt.Printf("Error creating private keys directory '%s': %v\n", CAConfig.Paths.PrivateKeys, err)
if caConfig.Paths.PrivateKeys != "" {
if err := os.MkdirAll(caConfig.Paths.PrivateKeys, 0700); err != nil {
fmt.Printf("Error creating private keys directory '%s': %v\n", caConfig.Paths.PrivateKeys, err)
return err
}
}
// Initialize CAState empty state with serial starting from 1
CAState = &_CAState{
caState = &CAState{
Serial: 1, // Start serial from 1
CreatedAt: time.Now().UTC().Format(time.RFC3339),
UpdatedAt: time.Now().UTC().Format(time.RFC3339),
Certificates: []CertificateRecord{},
}
keySize := CAConfig.KeySize
keySize := caConfig.KeySize
if keySize == 0 {
keySize = 4096
}
@@ -366,40 +386,41 @@ func InitCA(overwrite bool) error {
return fmt.Errorf("failed to generate serial number: %v", err)
}
if CAConfig.Validity == "" {
CAConfig.Validity = "5y" // Use default validity of 5 years
if caConfig.Validity == "" {
caConfig.Validity = "5y" // Use default validity of 5 years
}
validity, err := parseValidity(CAConfig.Validity)
validity, err := parseValidity(caConfig.Validity)
if err != nil {
return err
}
now := time.Now()
// Store CA certificate creation time
CAState.CreatedAt = now.UTC().Format(time.RFC3339)
caState.CreatedAt = now.UTC().Format(time.RFC3339)
tmpl := x509.Certificate{
SerialNumber: serialNumber,
Subject: pkix.Name{
Country: []string{CAConfig.Country},
Organization: []string{CAConfig.Organization},
OrganizationalUnit: optionalSlice(CAConfig.OrganizationalUnit),
Locality: optionalSlice(CAConfig.Locality),
Province: optionalSlice(CAConfig.Province),
CommonName: CAConfig.Name,
Country: []string{caConfig.Country},
Organization: []string{caConfig.Organization},
OrganizationalUnit: optionalSlice(caConfig.OrganizationalUnit),
Locality: optionalSlice(caConfig.Locality),
Province: optionalSlice(caConfig.Province),
CommonName: caConfig.Name,
},
NotBefore: now,
NotAfter: now.Add(validity),
KeyUsage: x509.KeyUsageCertSign | x509.KeyUsageCRLSign,
BasicConstraintsValid: true,
IsCA: true,
BasicConstraintsValid: true, // This is a CA certificate
IsCA: true, // This is a CA certificate
MaxPathLenZero: true, // Allow issuing end-entity certificates
}
// Add email if present
if CAConfig.Email != "" {
if caConfig.Email != "" {
tmpl.Subject.ExtraNames = append(tmpl.Subject.ExtraNames, pkix.AttributeTypeAndValue{
Type: []int{1, 2, 840, 113549, 1, 9, 1}, // emailAddress OID
Value: CAConfig.Email,
Value: caConfig.Email,
})
}
certDER, err := x509.CreateCertificate(rand.Reader, &tmpl, &tmpl, &priv.PublicKey, priv)
@@ -409,17 +430,17 @@ func InitCA(overwrite bool) error {
certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(priv)})
if err := SavePEM(filepath.Join(CAConfig.Paths.Certificates, "ca_cert.pem"), certPEM, false, overwrite); err != nil {
if err := SavePEM(filepath.Join(caConfig.Paths.Certificates, "ca_cert.pem"), certPEM, false); err != nil {
fmt.Println("Error saving CA certificate:", err)
return err
}
if err := SavePEM(filepath.Join(CAConfig.Paths.PrivateKeys, "ca_key.pem"), keyPEM, true, overwrite); err != nil {
if err := SavePEM(filepath.Join(caConfig.Paths.PrivateKeys, "ca_key.pem"), keyPEM, true); err != nil {
fmt.Println("Error saving CA key:", err)
return err
}
// set last updated time in the CAState
CAState.UpdatedAt = time.Now().UTC().Format(time.RFC3339)
caState.UpdatedAt = time.Now().UTC().Format(time.RFC3339)
// Save the state
err = SaveCAState()
@@ -433,7 +454,7 @@ func InitCA(overwrite bool) error {
}
// Helper: issue a single certificate and key, save to files, return error if any
func issueSingleCertificate(def CertificateDefinition, overwrite, verbose bool) error {
func issueSingleCertificate(def CertificateDefinition) error {
// Validate Name
isValidName, err := regexp.MatchString(`^[A-Za-z0-9_-]+$`, def.Name)
@@ -445,6 +466,11 @@ func issueSingleCertificate(def CertificateDefinition, overwrite, verbose bool)
return fmt.Errorf("certificate name must be specified and contain only letters, numbers, dash, or underscore")
}
// Check if the certificate is in database, fail if it is.
if caState.FindByName(def.Name, false) != nil {
return fmt.Errorf("certificate %s already exists and is valid.", def.Name)
}
// Initialize Subject if not specified
if def.Subject == "" {
def.Subject = def.Name
@@ -492,6 +518,8 @@ func issueSingleCertificate(def CertificateDefinition, overwrite, verbose bool)
NotBefore: dateIssued,
NotAfter: expires,
KeyUsage: x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment,
IsCA: false,
BasicConstraintsValid: true,
}
for _, s := range def.SAN {
@@ -508,38 +536,39 @@ func issueSingleCertificate(def CertificateDefinition, overwrite, verbose bool)
}
}
switch def.Type {
// Split usage types by comma
types := strings.SplitSeq(def.Type, ",")
certTmpl.ExtKeyUsage = []x509.ExtKeyUsage{}
// Collect selected usage types
for certType := range types {
switch certType {
case "client":
certTmpl.ExtKeyUsage = []x509.ExtKeyUsage{x509.ExtKeyUsageClientAuth}
certTmpl.ExtKeyUsage = append(certTmpl.ExtKeyUsage, x509.ExtKeyUsageClientAuth)
case "server":
certTmpl.ExtKeyUsage = []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth, x509.ExtKeyUsageClientAuth}
case "server-only":
certTmpl.ExtKeyUsage = []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth}
certTmpl.ExtKeyUsage = append(certTmpl.ExtKeyUsage, x509.ExtKeyUsageServerAuth)
case "code-signing":
certTmpl.ExtKeyUsage = []x509.ExtKeyUsage{x509.ExtKeyUsageCodeSigning}
certTmpl.ExtKeyUsage = append(certTmpl.ExtKeyUsage, x509.ExtKeyUsageCodeSigning)
case "email":
certTmpl.ExtKeyUsage = []x509.ExtKeyUsage{x509.ExtKeyUsageEmailProtection}
certTmpl.ExtKeyUsage = append(certTmpl.ExtKeyUsage, x509.ExtKeyUsageEmailProtection)
default:
return fmt.Errorf("unknown certificate type. Use one of: client, server, server-only, code-signing, email")
return fmt.Errorf("unknown certificate type. Use one of: client, server, code-signing, email")
}
}
certDER, err := x509.CreateCertificate(rand.Reader, &certTmpl, CACert, &priv.PublicKey, CAKey)
certDER, err := x509.CreateCertificate(rand.Reader, &certTmpl, caCert, &priv.PublicKey, caKey)
if err != nil {
return fmt.Errorf("failed to create certificate: %v", err)
}
certPEM := pem.EncodeToMemory(&pem.Block{Type: "CERTIFICATE", Bytes: certDER})
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(priv)})
basename := def.Name
if basename == "" {
basename = def.Subject
}
certFile := filepath.Join(CAConfig.Paths.Certificates, basename+".crt.pem")
keyFile := filepath.Join(CAConfig.Paths.PrivateKeys, basename+".key.pem")
if err := SavePEM(certFile, certPEM, false, overwrite); err != nil {
certFile := filepath.Join(caConfig.Paths.Certificates, def.Name+".crt.pem")
keyFile := filepath.Join(caConfig.Paths.PrivateKeys, def.Name+".key.pem")
if err := SavePEM(certFile, certPEM, false); err != nil {
return fmt.Errorf("error saving certificate: %v", err)
}
if err := SavePEM(keyFile, keyPEM, true, overwrite); err != nil {
if err := SavePEM(keyFile, keyPEM, true); err != nil {
return fmt.Errorf("error saving key: %v", err)
}
if verbose {
@@ -558,9 +587,12 @@ Certificate:
def.SAN,
)
}
CAState.UpdateCAStateAfterIssue(
CAConfig.SerialType,
basename,
caState.UpdateCAStateAfterIssue(
caConfig.SerialType,
def.Name,
def.Subject,
def.Type,
serialNumber,
validityDur,
)
@@ -598,7 +630,7 @@ func ProvisionCertificates(filePath string, overwrite bool, dryRun bool, verbose
// to render templates and fill missing fields from defaults
for i := range certDefs.Certificates {
// Fill missing fields from defaults, if provided
certDefs.Certificates[i].fillDefaultValues(certDefs.Defaults)
certDefs.Certificates[i].FillDefaultValues(certDefs.Defaults)
// Render templates in the definition using the variables map
// with added definition name.
variables := certDefs.Variables
@@ -612,9 +644,10 @@ func ProvisionCertificates(filePath string, overwrite bool, dryRun bool, verbose
}
}
n := len(certDefs.Certificates)
// No errors so far, now we can issue certificates
for i := range certDefs.Certificates {
fmt.Printf("[%d/%d] Issuing %s... ", i+1, len(certDefs.Certificates), certDefs.Certificates[i].Name)
fmt.Printf("[%d/%d] Issuing %s... ", i+1, n, certDefs.Certificates[i].Name)
if dryRun {
fmt.Printf("(dry run)\n")
@@ -622,7 +655,7 @@ func ProvisionCertificates(filePath string, overwrite bool, dryRun bool, verbose
continue
}
err = issueSingleCertificate(certDefs.Certificates[i], overwrite, verbose)
err = issueSingleCertificate(certDefs.Certificates[i])
if err != nil {
fmt.Printf("error: %v\n", err)
errors++
@@ -664,7 +697,7 @@ func IssueCertificate(certDef CertificateDefinition, overwrite bool, dryRun bool
return nil
}
err = issueSingleCertificate(certDef, overwrite, verbose)
err = issueSingleCertificate(certDef)
if err != nil {
return err

View File

@@ -10,12 +10,11 @@ import (
"fmt"
"math/big"
"os"
"path/filepath"
"time"
)
// _CAState represents the persisted CA state in JSON
type _CAState struct {
// CAState represents the persisted CA state in JSON
type CAState struct {
CreatedAt string `json:"createdAt"`
UpdatedAt string `json:"updatedAt"`
Serial int `json:"serial,omitempty"`
@@ -26,6 +25,8 @@ type _CAState struct {
// CertificateRecord represents a single certificate record in the CA state
type CertificateRecord struct {
Name string `json:"name"`
Subject string `json:"subject"`
Type string `json:"type"`
Issued string `json:"issued"`
Expires string `json:"expires"`
Serial string `json:"serial"`
@@ -33,21 +34,48 @@ type CertificateRecord struct {
RevokeReason int `json:"revokeReason,omitempty"`
}
func caStatePath() string {
return filepath.Join(filepath.Dir(CAConfigPath), CAConfig.StateName())
// Look for a certifcate by its name
func (c *CAState) FindByName(name string, all bool) *CertificateRecord {
for _, cert := range c.Certificates {
if cert.RevokedAt != "" && !all {
continue
}
if cert.Name == name {
return &cert
}
}
return nil
}
// Look for a certificate by its serial
func (c *CAState) FindBySerial(serial string, all bool) *CertificateRecord {
for _, cert := range c.Certificates {
if cert.RevokedAt != "" && !all {
continue
}
if cert.Serial == serial {
return &cert
}
}
return nil
}
// func caStatePath() string {
// return filepath.Join(filepath.Dir(caConfigPath), caConfig.GetStateFileName())
// }
// LoadCAState loads the CA state from a JSON file
func LoadCAState() error {
path := caStatePath()
fmt.Printf("Loading CA state from %s\n", path)
f, err := os.Open(path)
fmt.Printf("Loading CA state from %s\n", caStatePath)
f, err := os.Open(caStatePath)
if err != nil {
return err
}
defer f.Close()
CAState = &_CAState{}
if err := json.NewDecoder(f).Decode(CAState); err != nil {
caState = &CAState{}
if err := json.NewDecoder(f).Decode(caState); err != nil {
return err
}
return nil
@@ -55,19 +83,19 @@ func LoadCAState() error {
// SaveCAState saves the CA state to a JSON file
func SaveCAState() error {
CAState.UpdatedAt = time.Now().UTC().Format(time.RFC3339)
f, err := os.Create(caStatePath())
caState.UpdatedAt = time.Now().UTC().Format(time.RFC3339)
f, err := os.Create(caStatePath)
if err != nil {
return err
}
defer f.Close()
enc := json.NewEncoder(f)
enc.SetIndent("", " ")
return enc.Encode(CAState)
return enc.Encode(caState)
}
// UpdateCAStateAfterIssue updates the CA state JSON after issuing a certificate
func (s *_CAState) UpdateCAStateAfterIssue(serialType, basename string, serialNumber any, validity time.Duration) error {
func (s *CAState) UpdateCAStateAfterIssue(serialType, name string, subject string, certType string, serialNumber any, validity time.Duration) error {
if s == nil {
fmt.Fprintf(os.Stderr, "FATAL: CAState is nil in UpdateCAStateAfterIssue. This indicates a programming error.\n")
os.Exit(1)
@@ -77,24 +105,26 @@ func (s *_CAState) UpdateCAStateAfterIssue(serialType, basename string, serialNu
serialStr := ""
switch serialType {
case "sequential":
serialStr = fmt.Sprintf("%d", CAState.Serial)
CAState.Serial++
serialStr = fmt.Sprintf("%d", caState.Serial)
caState.Serial++
case "random":
serialStr = fmt.Sprintf("%x", serialNumber)
default:
serialStr = fmt.Sprintf("%v", serialNumber)
}
s.AddCertificate(basename, issued, expires, serialStr)
s.AddCertificate(name, subject, certType, issued, expires, serialStr)
return nil
}
func (s *_CAState) AddCertificate(name, issued, expires, serial string) {
func (s *CAState) AddCertificate(name, subject, certType, issued, expires, serial string) {
if s == nil {
fmt.Fprintf(os.Stderr, "FATAL: CAState is nil in AddCertificate. This indicates a programming error.\n")
os.Exit(1)
}
rec := CertificateRecord{
Name: name,
Subject: subject,
Type: certType,
Issued: issued,
Expires: expires,
Serial: serial,
@@ -103,7 +133,7 @@ func (s *_CAState) AddCertificate(name, issued, expires, serial string) {
}
// RevokeCertificate revokes a certificate by serial number and reason code, updates state, and saves to disk
func (s *_CAState) RevokeCertificate(serial string, reason int) error {
func (s *CAState) RevokeCertificate(serial string, reason int) error {
if s == nil {
fmt.Fprintf(os.Stderr, "FATAL: CAState is nil in RevokeCertificate. This indicates a programming error.\n")
os.Exit(1)
@@ -129,11 +159,11 @@ func (s *_CAState) RevokeCertificate(serial string, reason int) error {
// GenerateCRL generates a CRL file from revoked certificates and writes it to the given path
// validityDays defines the number of days for which the CRL is valid (NextUpdate - ThisUpdate)
func (s *_CAState) GenerateCRL(crlPath string, validityDays int) error {
func (s *CAState) GenerateCRL(crlPath string, validityDays int) error {
if s == nil {
return fmt.Errorf("CAState is nil in GenerateCRL")
}
if CACert == nil || CAKey == nil {
if caCert == nil || caKey == nil {
return fmt.Errorf("CA certificate or key not loaded")
}
var revokedCerts []pkix.RevokedCertificate
@@ -162,14 +192,14 @@ func (s *_CAState) GenerateCRL(crlPath string, validityDays int) error {
now := time.Now().UTC()
nextUpdate := now.Add(time.Duration(validityDays) * 24 * time.Hour) // validityDays * 24 * 60 * 60 * 1000 milliseconds
template := &x509.RevocationList{
SignatureAlgorithm: CACert.SignatureAlgorithm,
SignatureAlgorithm: caCert.SignatureAlgorithm,
RevokedCertificates: revokedCerts,
Number: big.NewInt(int64(s.CRLNumber + 1)),
ThisUpdate: now,
NextUpdate: nextUpdate,
Issuer: CACert.Subject,
Issuer: caCert.Subject,
}
crlBytes, err := x509.CreateRevocationList(nil, template, CACert, CAKey)
crlBytes, err := x509.CreateRevocationList(nil, template, caCert, caKey)
if err != nil {
return fmt.Errorf("failed to create CRL: %v", err)
}

View File

@@ -9,5 +9,6 @@ ca "example_ca" {
paths {
certificates = "certs"
private_keys = "private"
state_file = "ca_state.json"
}
}

View File

@@ -1,6 +1,6 @@
defaults {
subject = "{{ .Name }}.koszewscy.waw.pl"
type = "server"
type = "server,client"
validity = "1y"
san = ["DNS:{{ .Name }}.koszewscy.waw.pl"]
}
@@ -30,3 +30,10 @@ certificate "prometheus" {
subject = "{{ .Name }}.{{ .Domain }}" # result: prometheus.koszewscy.email
san = ["DNS:{{ .Name }}.{{ .Domain }}"] # result: [ "DNS:prometheus.koszewscy.email" ]
}
certificate "slawek" {
subject = "CN=Slawomir Koszewski,emailAddress=slawek@koszewscy.waw.pl,O=Koszewscy,C=PL"
type = "client,email"
validity = "1y"
san = ["email:slawek@koszewscy.email"]
}

View File

@@ -0,0 +1,3 @@
#!/bin/bash
git update-index --assume-unchanged version.go

70
main.go
View File

@@ -7,24 +7,34 @@ import (
"github.com/spf13/cobra"
)
var Version = "dev"
// Global flags available to all commands
var overwrite bool
var dryRun bool
var verbose bool
func main() {
var overwrite bool
// list command flags
var listRevoked bool
// issue command flags
var name string
var subject string
var certType string
var validity string
var san []string
var name string
var dryRun bool
var verbose bool
// provision command flags
var provisionFile string
// crl command flags
var crlFile string
var crlValidityDays int
// revoke command flags
var revokeName string
var revokeSerial string
var revokeReasonStr string
var provisionFile string
var rootCmd = &cobra.Command{
Use: "lab-ca",
@@ -39,18 +49,41 @@ func main() {
rootCmd.PersistentFlags().BoolVar(&overwrite, "overwrite", false, "Allow overwriting existing files")
rootCmd.PersistentFlags().BoolVar(&verbose, "verbose", false, "Print detailed information about each processed certificate")
rootCmd.PersistentFlags().BoolVar(&dryRun, "dry-run", false, "Validate and show what would be created, but do not write files (batch mode)")
rootCmd.PersistentFlags().StringVar(&CAConfigPath, "config-path", "ca_config.hcl", "Path to CA configuration file")
rootCmd.PersistentFlags().StringVar(&caConfigPath, "config", "ca_config.hcl", "Path to CA configuration file")
// lab-ca initca command
var initCmd = &cobra.Command{
Use: "initca",
Short: "Generate a new CA certificate and key",
Run: func(cmd *cobra.Command, args []string) {
InitCA(overwrite)
InitCA()
},
}
rootCmd.AddCommand(initCmd)
// lab-ca list command
var listCmd = &cobra.Command{
Use: "list",
Short: "List issued certificates",
Run: func(cmd *cobra.Command, args []string) {
err := LoadCA()
if err != nil {
fmt.Fprintf(os.Stderr, "ERROR: %v\n", err)
os.Exit(1)
}
for _, certDef := range caState.Certificates {
if certDef.RevokedAt != "" {
continue
}
fmt.Printf("Certificate %s\n", certDef.Name)
fmt.Printf("\tSubject: %s\n\tType: %s\n\tIssued at: %s\n",
certDef.Subject, certDef.Type, certDef.Issued)
}
},
}
listCmd.Flags().BoolVar(&listRevoked, "revoked", false, "List all certificates, including revoked ones")
rootCmd.AddCommand(listCmd)
// lab-ca issue command
var issueCmd = &cobra.Command{
Use: "issue",
@@ -73,7 +106,8 @@ func main() {
issueCmd.Flags().StringVar(&name, "name", "", "Name for the certificate and key files (used as subject if --subject is omitted)")
issueCmd.Flags().StringVar(&subject, "subject", "", "Subject Common Name for the certificate (optional, defaults to --name)")
issueCmd.Flags().StringVar(&certType, "type", "server", "Certificate type: client, server, server-only, code-signing, email")
issueCmd.Flags().StringVar(&certType, "type", "server",
"Certificate type: client, server, code-signing, email.\nCombine by specifying more than one separated by comma.")
issueCmd.Flags().StringArrayVar(&san, "san", nil,
"Subject Alternative Name (SAN). Use multiple times for multiple values.\nFormat: dns:example.com, ip:1.2.3.4, email:user@example.com")
issueCmd.Flags().StringVar(&validity, "validity", "1y", "Certificate validity (e.g. 2y, 6m, 30d). Overrides config file for this certificate.")
@@ -115,7 +149,7 @@ func main() {
serial := ""
if revokeName != "" {
found := false
for _, rec := range CAState.Certificates {
for _, rec := range caState.Certificates {
if rec.Name == revokeName {
serial = rec.Serial
found = true
@@ -148,7 +182,7 @@ func main() {
fmt.Println()
os.Exit(1)
}
if err := CAState.RevokeCertificate(serial, reasonCode); err != nil {
if err := caState.RevokeCertificate(serial, reasonCode); err != nil {
fmt.Printf("ERROR: %v\n", err)
os.Exit(1)
}
@@ -172,7 +206,7 @@ func main() {
if crlValidityDays <= 0 {
crlValidityDays = 30 // default to 30 days
}
err := CAState.GenerateCRL(crlFile, crlValidityDays)
err := caState.GenerateCRL(crlFile, crlValidityDays)
if err != nil {
fmt.Printf("ERROR generating CRL: %v\n", err)
os.Exit(1)
@@ -189,7 +223,7 @@ func main() {
Use: "version",
Short: "Show version information",
Run: func(cmd *cobra.Command, args []string) {
fmt.Printf("lab-ca version: %s\n", Version)
fmt.Printf("lab-ca version: %s\n", getVersionDescription())
},
}
rootCmd.AddCommand(versionCmd)
@@ -199,15 +233,23 @@ func main() {
}
}
func getVersionDescription() string {
if Version == "" {
return "no version information was compiled in"
}
return Version
}
func printMainHelp() {
fmt.Printf("lab-ca - Certificate Authority Utility\n")
fmt.Printf("Version: %s\n", Version)
fmt.Printf("Version: %s\n", getVersionDescription())
fmt.Println()
fmt.Println("Usage:")
fmt.Println(" lab-ca <command> [options]")
fmt.Println()
fmt.Println("Available commands:")
fmt.Println(" initca Generate a new CA certificate and key")
fmt.Println(" list List issued certificates")
fmt.Println(" issue Issue a new certificate")
fmt.Println(" provision Provision certificates from a batch file (HCL)")
fmt.Println(" revoke Revoke a certificate by name or serial number")

11
print-certificates.sh Executable file
View File

@@ -0,0 +1,11 @@
#!/bin/bash
GREEN='\033[0;32m'
NC='\033[0m' # No Color
for cert in ca/certs/*.pem
do
echo -e "${GREEN}----- Certificate: $(basename $cert)${NC}"
openssl x509 -in "$cert" -noout -text
echo -e "${GREEN}----- End of Certificate -----${NC}\n"
done

View File

@@ -1,16 +1,30 @@
#!/bin/bash
GREEN='\033[0;32m'
NC='\033[0m' # No Color
LAB_CA="build/lab-ca"
PROVISION_CONFIG="examples/example-certificates.hcl"
# Build and install
go install
rm -rf certs private *.json crl*.pem
# Build script for lab-ca with version injection from git tag
git describe --tags --always --dirty > /dev/null 2>&1
if [ $? -eq 0 ]; then
VERSION=$(git describe --tags --always --dirty)
else
VERSION="dev"
fi
go build -ldflags "-X main.Version=$VERSION" -o $LAB_CA
if [ $? -ne 0 ]; then
echo -e "${GREEN}Build failed!${NC}"
exit 1
fi
echo -e "${GREEN}Build successful! Version: $VERSION${NC}"
rm -rf ca
echo -e "\n${GREEN}Initializing CA...${NC}"
lab-ca initca || exit 1
$LAB_CA initca || exit 1
echo -e "\n${GREEN}Issuing single certificate with incorrect argument..${NC}"
lab-ca issue --name "blackpanther2.koszewscy.waw.pl"
$LAB_CA issue --name "blackpanther2.koszewscy.waw.pl"
if [ $? -ne 0 ]; then
echo -e "${GREEN}Failed to issue certificate.${NC} - that's fine it was intended."
else
@@ -19,24 +33,27 @@ else
fi
echo -e "\n${GREEN}Issuing single certificate..${NC}"
lab-ca issue --name "blackpanther2" --subject "blackpanther2.koszewscy.waw.pl" || exit 1
$LAB_CA issue --name "blackpanther2" --subject "blackpanther2.koszewscy.waw.pl" || exit 1
echo -e "\n${GREEN}Issuing multiple certificates from file...${NC}"
lab-ca provision --file examples/example-certificates.hcl --verbose || exit 1
$LAB_CA provision --file $PROVISION_CONFIG --verbose || exit 1
echo -e "\n${GREEN}Revoking a certificate by name...${NC}"
lab-ca revoke --name "loki" || exit 1
$LAB_CA revoke --name "loki" || exit 1
echo -e "\n${GREEN}Generating CRL...${NC}"
lab-ca crl --validity-days 7 --crl-file crl-1.pem || exit 1
$LAB_CA crl --validity-days 7 --crl-file crl-1.pem || exit 1
openssl crl -noout -text -in crl-1.pem
echo -e "\n${GREEN}Revoking a second certificate by name...${NC}"
lab-ca revoke --name "alloy" || exit 1
$LAB_CA revoke --name "alloy" || exit 1
echo -e "\n${GREEN}Generating a second CRL...${NC}"
lab-ca crl --validity-days 7 --crl-file crl-2.pem || exit 1
$LAB_CA crl --validity-days 7 --crl-file crl-2.pem || exit 1
openssl crl -noout -text -in crl-2.pem
echo -e "\n${GREEN}Dumping CA state...${NC}"
jq '.' example_ca_state.json
jq '.' ca/ca_state.json
# Finished
echo -e "\n${GREEN}All operations completed successfully!${NC}"

7
set-version.sh Executable file
View File

@@ -0,0 +1,7 @@
#!/bin/bash
VERSION=$(git describe --tags --always --dirty 2>/dev/null || echo "dev")
# Allow git to track changes to version.go
git update-index --no-assume-unchanged version.go
# Hardcode the version into main.go
sed -i '' "s/^var Version = .*/var Version = \"$VERSION\"/" version.go

3
version.go Normal file
View File

@@ -0,0 +1,3 @@
package main
var Version = "dev"