Documentation
¶
Overview ¶
Package certgen provides utilities for generating X.509 certificates for RadSec (RADIUS over TLS).
This package simplifies TLS certificate generation for:
- CA (Certificate Authority) creation for internal PKI
- Server certificates for RadSec listeners (RFC 6614)
- Client certificates for mutual TLS authentication
All certificates support Subject Alternative Names (SAN) for DNS and IP addresses, which is required by modern TLS clients.
Example usage:
// 1. Generate CA certificate
caConfig := certgen.CAConfig{
CertConfig: certgen.DefaultCertConfig(),
OutputDir: "/etc/toughradius/certs",
}
caConfig.CommonName = "ToughRADIUS CA"
certgen.GenerateCA(caConfig)
// 2. Generate server certificate with SAN
serverConfig := certgen.ServerConfig{
CertConfig: certgen.DefaultCertConfig(),
CAKeyPath: "/etc/toughradius/certs/ca.key",
CACertPath: "/etc/toughradius/certs/ca.crt",
OutputDir: "/etc/toughradius/certs",
}
serverConfig.CommonName = "radius.example.com"
serverConfig.DNSNames = []string{"radius.example.com", "*.radius.example.com"}
serverConfig.IPAddresses = []net.IP{net.ParseIP("192.168.1.10")}
certgen.GenerateServerCert(serverConfig)
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateCA ¶
GenerateCA creates a self-signed Certificate Authority (CA) for internal PKI. The CA is used to sign server and client certificates, establishing a trust chain.
This generates:
- RSA private key (PKCS#8 format)
- Self-signed X.509 certificate with CA:TRUE constraint
- Certificate supports both server and client authentication
Parameters:
- config: CA configuration (must set CommonName)
Returns:
- error: File I/O, crypto generation, or encoding errors
Output files:
- {OutputDir}/ca.crt: CA certificate (PEM, mode 0644)
- {OutputDir}/ca.key: CA private key (PEM, mode 0600 - protect carefully!)
Side effects:
- Creates OutputDir if it doesn't exist (mode 0750)
- Prints file paths to stdout on success
Example:
caConfig := certgen.CAConfig{
CertConfig: certgen.DefaultCertConfig(),
OutputDir: "/etc/toughradius/certs",
}
caConfig.CommonName = "ToughRADIUS Internal CA"
if err := certgen.GenerateCA(caConfig); err != nil {
log.Fatalf("CA generation failed: %v", err)
}
func GenerateClientCert ¶
func GenerateClientCert(config ClientConfig) error
GenerateClientCert creates a client certificate signed by the CA. This certificate enables mutual TLS authentication for RadSec clients.
The CommonName typically identifies the client (e.g., NAS hostname or identifier). SAN support allows multiple identities in a single certificate.
Parameters:
- config: Client configuration (must set CommonName, CAKeyPath, CACertPath)
Returns:
- error: File I/O, CA loading, crypto generation, or encoding errors
Output files:
- {OutputDir}/client.crt: Client certificate (PEM, mode 0644)
- {OutputDir}/client.key: Client private key (PEM, mode 0600)
Side effects:
- Creates OutputDir if it doesn't exist and applies mode 0750
- Prints file paths and SAN info to stdout on success
Example:
clientConfig := certgen.ClientConfig{
CertConfig: certgen.DefaultCertConfig(),
CAKeyPath: "/etc/toughradius/certs/ca.key",
CACertPath: "/etc/toughradius/certs/ca.crt",
OutputDir: "/etc/toughradius/clients",
}
clientConfig.CommonName = "nas-device-001"
if err := certgen.GenerateClientCert(clientConfig); err != nil {
log.Fatalf("Client cert generation failed: %v", err)
}
func GenerateServerCert ¶
func GenerateServerCert(config ServerConfig) error
GenerateServerCert creates a server certificate signed by the CA. This certificate is used by RadSec servers for TLS encryption (RFC 6614).
Supports Subject Alternative Names (SAN):
- DNSNames: Multiple hostnames (wildcards supported)
- IPAddresses: Direct IP-based TLS connections
Parameters:
- config: Server configuration (must set CommonName, CAKeyPath, CACertPath)
Returns:
- error: File I/O, CA loading, crypto generation, or encoding errors
Output files:
- {OutputDir}/server.crt: Server certificate (PEM, mode 0644)
- {OutputDir}/server.key: Server private key (PEM, mode 0600)
Side effects:
- Creates OutputDir if it doesn't exist and applies mode 0750
- Prints file paths and SAN info to stdout on success
Example:
serverConfig := certgen.ServerConfig{
CertConfig: certgen.DefaultCertConfig(),
CAKeyPath: "/etc/toughradius/certs/ca.key",
CACertPath: "/etc/toughradius/certs/ca.crt",
OutputDir: "/etc/toughradius/certs",
}
serverConfig.CommonName = "radius.example.com"
serverConfig.DNSNames = []string{"radius.example.com", "*.radius.example.com"}
serverConfig.IPAddresses = []net.IP{net.ParseIP("192.168.1.10")}
if err := certgen.GenerateServerCert(serverConfig); err != nil {
log.Fatalf("Server cert generation failed: %v", err)
}
Types ¶
type CAConfig ¶
type CAConfig struct {
CertConfig
OutputDir string // Output directory
}
CAConfig extends CertConfig for Certificate Authority generation. The CA is used to sign server and client certificates.
Fields:
- CertConfig: Embedded base configuration
- OutputDir: Directory where ca.crt and ca.key will be saved
Output files:
- ca.crt: PEM-encoded CA certificate (public, distribute to clients)
- ca.key: PEM-encoded CA private key (secret, protect carefully)
type CertConfig ¶
type CertConfig struct {
CommonName string
Organization []string
OrganizationalUnit []string
Country []string
Province []string
Locality []string
DNSNames []string // SAN DNS names
IPAddresses []net.IP // SAN IP addresses
ValidDays int // Valid days
KeySize int // RSA Key size
}
CertConfig holds common X.509 certificate configuration shared across CA, server, and client certificates. It defines the certificate's subject (identity), validity period, and cryptographic parameters.
Subject fields follow X.509 Distinguished Name (DN) structure:
- CommonName: Primary identifier (e.g., hostname for server certs, username for client certs)
- Organization: Organization name(s)
- OrganizationalUnit: Department or division
- Country: Two-letter country code (e.g., "CN", "US")
- Province: State or province
- Locality: City or locality
SAN (Subject Alternative Names) support:
- DNSNames: Additional DNS names (wildcards supported: "*.example.com")
- IPAddresses: IP addresses for IP-based TLS connections
Security parameters:
- ValidDays: Certificate validity period (default 3650 = 10 years)
- KeySize: RSA key size in bits (2048 or 4096 recommended)
func DefaultCertConfig ¶
func DefaultCertConfig() CertConfig
DefaultCertConfig returns a pre-configured CertConfig with sensible defaults. Use this as a starting point and override specific fields as needed.
Default values:
- Organization: "ToughRADIUS"
- OrganizationalUnit: "IT"
- Country: "CN"
- Province: "Shanghai"
- Locality: "Shanghai"
- ValidDays: 3650 (10 years)
- KeySize: 2048 bits (RSA)
Returns:
- CertConfig: Configuration with default values
Example:
config := certgen.DefaultCertConfig() config.CommonName = "radius.example.com" config.ValidDays = 365 // Override to 1 year
type ClientConfig ¶
type ClientConfig struct {
CertConfig
CAKeyPath string // CA private key path
CACertPath string // CA certificate path
OutputDir string // Output directory
}
ClientConfig extends CertConfig for client certificate generation. Client certificates enable mutual TLS authentication for RadSec clients.
Fields:
- CertConfig: Embedded base configuration (CommonName = client identifier)
- CAKeyPath: Path to CA private key (ca.key) for signing
- CACertPath: Path to CA certificate (ca.crt) for chain validation
- OutputDir: Directory where client.crt and client.key will be saved
Output files:
- client.crt: PEM-encoded client certificate (signed by CA)
- client.key: PEM-encoded client private key (protect with 0600 permissions)
type ServerConfig ¶
type ServerConfig struct {
CertConfig
CAKeyPath string // CA private key path
CACertPath string // CA certificate path
OutputDir string // Output directory
}
ServerConfig extends CertConfig for server certificate generation. Server certificates are used by RadSec listeners for TLS encryption.
Fields:
- CertConfig: Embedded base configuration (set DNSNames for SAN support)
- CAKeyPath: Path to CA private key (ca.key) for signing
- CACertPath: Path to CA certificate (ca.crt) for chain validation
- OutputDir: Directory where server.crt and server.key will be saved
Output files:
- server.crt: PEM-encoded server certificate (signed by CA)
- server.key: PEM-encoded server private key (protect with 0600 permissions)