Update build process and version embedding.

.gitignore

@@ -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/

README.md

@@ -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,72 +53,178 @@ 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"
+    subject = "{{ .Name }}.example.org"
+    type = "server,client"
     validity = "1y"
-    san      = ["DNS:{{ .Name }}.example.org"]
+    san = ["DNS:{{ .Name }}.example.org"]
 }
 
 variables = {
-    Domain  = "example.net"
+    Domain = "example.net"
     Country = "EX"
 }
 
 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.
+
+---
+
+## 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

build.sh

@@ -6,4 +6,17 @@ if [ $? -eq 0 ]; then
 else
   VERSION="dev"
 fi
-go build -ldflags "-X main.Version=$VERSION" -o lab-ca
+
+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

ca.go

@@ -412,8 +412,9 @@ func InitCA() error {
 		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 != "" {
@@ -512,11 +513,13 @@ func issueSingleCertificate(def CertificateDefinition) error {
 	expires := dateIssued.Add(validityDur)
 
 	certTmpl := x509.Certificate{
-		SerialNumber: serialNumber,
-		Subject:      subjectPKIX,
-		NotBefore:    dateIssued,
-		NotAfter:     expires,
-		KeyUsage:     x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment,
+		SerialNumber:          serialNumber,
+		Subject:               subjectPKIX,
+		NotBefore:             dateIssued,
+		NotAfter:              expires,
+		KeyUsage:              x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment,
+		IsCA:                  false,
+		BasicConstraintsValid: true,
 	}
 
 	for _, s := range def.SAN {
@@ -571,11 +574,11 @@ func issueSingleCertificate(def CertificateDefinition) error {
 	if verbose {
 		fmt.Printf(`
 Certificate:
-  Name:     %s
-  Subject:  %s
-  Type:     %s
-  Validity: %s
-  SAN:      %v
+    Name:     %s
+    Subject:  %s
+    Type:     %s
+    Validity: %s
+    SAN:      %v
 `,
 			def.Name,
 			def.Subject,
@@ -584,6 +587,7 @@ Certificate:
 			def.SAN,
 		)
 	}
+
 	caState.UpdateCAStateAfterIssue(
 		caConfig.SerialType,
 		def.Name,
@@ -624,26 +628,26 @@ func ProvisionCertificates(filePath string, overwrite bool, dryRun bool, verbose
 
 	// Loop through all certificate definitions
 	// to render templates and fill missing fields from defaults
-	for _, def := range certDefs.Certificates {
+	for i := range certDefs.Certificates {
 		// Fill missing fields from defaults, if provided
-		def.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
 		if variables == nil {
 			variables = make(map[string]string)
 		}
-		variables["Name"] = def.Name
-		err = def.RenderTemplates(variables)
+		variables["Name"] = certDefs.Certificates[i].Name
+		err = certDefs.Certificates[i].RenderTemplates(variables)
 		if err != nil {
-			return fmt.Errorf("failed to render templates for certificate %s: %v", def.Name, err)
+			return fmt.Errorf("failed to render templates for certificate %s: %v", certDefs.Certificates[i].Name, err)
 		}
 	}
 
 	n := len(certDefs.Certificates)
 	// No errors so far, now we can issue certificates
-	for i, def := range certDefs.Certificates {
-		fmt.Printf("[%d/%d] Issuing %s... ", i+1, n, def.Name)
+	for i := range certDefs.Certificates {
+		fmt.Printf("[%d/%d] Issuing %s... ", i+1, n, certDefs.Certificates[i].Name)
 
 		if dryRun {
 			fmt.Printf("(dry run)\n")
@@ -651,7 +655,7 @@ func ProvisionCertificates(filePath string, overwrite bool, dryRun bool, verbose
 			continue
 		}
 
-		err = issueSingleCertificate(def)
+		err = issueSingleCertificate(certDefs.Certificates[i])
 		if err != nil {
 			fmt.Printf("error: %v\n", err)
 			errors++

examples/example-certificates.hcl

@@ -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"]
+}

main.go

@@ -7,7 +7,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var Version = "dev"
+var Version = ""
 
 // Global flags available to all commands
 var overwrite bool
@@ -225,7 +225,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)
@@ -235,15 +235,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")

print-certificates.sh

@@ -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

run-test.sh

@@ -1,8 +1,8 @@
 #!/bin/bash
 GREEN='\033[0;32m'
 NC='\033[0m' # No Color
-LAB_CA="./lab-ca"
-
+LAB_CA="build/lab-ca"
+PROVISION_CONFIG="examples/example-certificates.hcl"
 # Build and install
 # Build script for lab-ca with version injection from git tag
 git describe --tags --always --dirty > /dev/null 2>&1
@@ -18,7 +18,7 @@ if [ $? -ne 0 ]; then
 fi
 echo -e "${GREEN}Build successful! Version: $VERSION${NC}"
 
-rm -rf certs private *.json crl*.pem
+rm -rf ca
 
 echo -e "\n${GREEN}Initializing CA...${NC}"
 $LAB_CA initca || exit 1
@@ -36,7 +36,7 @@ echo -e "\n${GREEN}Issuing single certificate..${NC}"
 $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
@@ -53,4 +53,7 @@ $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}"