mirror of
				https://github.com/caddyserver/caddy.git
				synced 2025-11-03 19:17:29 -05:00 
			
		
		
		
	
		
			
				
	
	
		
			118 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			118 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2015 Matthew Holt and The Caddy Authors
 | 
						|
//
 | 
						|
// Licensed under the Apache License, Version 2.0 (the "License");
 | 
						|
// you may not use this file except in compliance with the License.
 | 
						|
// You may obtain a copy of the License at
 | 
						|
//
 | 
						|
//     http://www.apache.org/licenses/LICENSE-2.0
 | 
						|
//
 | 
						|
// Unless required by applicable law or agreed to in writing, software
 | 
						|
// distributed under the License is distributed on an "AS IS" BASIS,
 | 
						|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 | 
						|
// See the License for the specific language governing permissions and
 | 
						|
// limitations under the License.
 | 
						|
 | 
						|
package caddypki
 | 
						|
 | 
						|
import (
 | 
						|
	"fmt"
 | 
						|
 | 
						|
	"github.com/caddyserver/caddy/v2"
 | 
						|
	"github.com/smallstep/truststore"
 | 
						|
	"go.uber.org/zap"
 | 
						|
)
 | 
						|
 | 
						|
func init() {
 | 
						|
	caddy.RegisterModule(PKI{})
 | 
						|
}
 | 
						|
 | 
						|
// PKI provides Public Key Infrastructure facilities for Caddy.
 | 
						|
type PKI struct {
 | 
						|
	// The CAs to manage. Each CA is keyed by an ID that is used
 | 
						|
	// to uniquely identify it from other CAs. The default CA ID
 | 
						|
	// is "local".
 | 
						|
	CAs map[string]*CA `json:"certificate_authorities,omitempty"`
 | 
						|
 | 
						|
	ctx caddy.Context
 | 
						|
	log *zap.Logger
 | 
						|
}
 | 
						|
 | 
						|
// CaddyModule returns the Caddy module information.
 | 
						|
func (PKI) CaddyModule() caddy.ModuleInfo {
 | 
						|
	return caddy.ModuleInfo{
 | 
						|
		ID:  "pki",
 | 
						|
		New: func() caddy.Module { return new(PKI) },
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
// Provision sets up the configuration for the PKI app.
 | 
						|
func (p *PKI) Provision(ctx caddy.Context) error {
 | 
						|
	p.ctx = ctx
 | 
						|
	p.log = ctx.Logger(p)
 | 
						|
 | 
						|
	// if this app is initialized at all, ensure there's
 | 
						|
	// at least a default CA that can be used
 | 
						|
	if len(p.CAs) == 0 {
 | 
						|
		p.CAs = map[string]*CA{defaultCAID: new(CA)}
 | 
						|
	}
 | 
						|
 | 
						|
	for caID, ca := range p.CAs {
 | 
						|
		err := ca.Provision(ctx, caID, p.log)
 | 
						|
		if err != nil {
 | 
						|
			return fmt.Errorf("provisioning CA '%s': %v", caID, err)
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	return nil
 | 
						|
}
 | 
						|
 | 
						|
// Start starts the PKI app.
 | 
						|
func (p *PKI) Start() error {
 | 
						|
	// install roots to trust store, if not disabled
 | 
						|
	for _, ca := range p.CAs {
 | 
						|
		if ca.InstallTrust != nil && !*ca.InstallTrust {
 | 
						|
			ca.log.Warn("root certificate trust store installation disabled; local clients may show warnings",
 | 
						|
				zap.String("path", ca.rootCertPath))
 | 
						|
			continue
 | 
						|
		}
 | 
						|
 | 
						|
		// avoid password prompt if already trusted
 | 
						|
		if trusted(ca.root) {
 | 
						|
			ca.log.Info("root certificate is already trusted by system",
 | 
						|
				zap.String("path", ca.rootCertPath))
 | 
						|
			continue
 | 
						|
		}
 | 
						|
 | 
						|
		ca.log.Warn("trusting root certificate (you might be prompted for password)",
 | 
						|
			zap.String("path", ca.rootCertPath))
 | 
						|
 | 
						|
		err := truststore.Install(ca.root,
 | 
						|
			truststore.WithDebug(),
 | 
						|
			truststore.WithFirefox(),
 | 
						|
			truststore.WithJava(),
 | 
						|
		)
 | 
						|
		if err != nil {
 | 
						|
			return fmt.Errorf("adding root certificate to trust store: %v", err)
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	// see if root/intermediates need renewal...
 | 
						|
	p.renewCerts()
 | 
						|
 | 
						|
	// ...and keep them renewed
 | 
						|
	go p.maintenance()
 | 
						|
 | 
						|
	return nil
 | 
						|
}
 | 
						|
 | 
						|
// Stop stops the PKI app.
 | 
						|
func (p *PKI) Stop() error {
 | 
						|
	return nil
 | 
						|
}
 | 
						|
 | 
						|
// Interface guards
 | 
						|
var (
 | 
						|
	_ caddy.Provisioner = (*PKI)(nil)
 | 
						|
	_ caddy.App         = (*PKI)(nil)
 | 
						|
)
 |