1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
|
// Copyright 2016 Google LLC. All Rights Reserved.
//
// 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 ctfe
import (
"crypto"
"errors"
"fmt"
"os"
"strings"
"time"
"github.com/go-sql-driver/mysql"
ct "github.com/google/certificate-transparency-go"
"github.com/google/certificate-transparency-go/trillian/ctfe/configpb"
"github.com/google/certificate-transparency-go/x509"
"github.com/jackc/pgx/v5/pgconn"
"google.golang.org/protobuf/encoding/prototext"
"google.golang.org/protobuf/proto"
"k8s.io/klog/v2"
)
// ValidatedLogConfig represents the LogConfig with the information that has
// been successfully parsed as a result of validating it.
type ValidatedLogConfig struct {
Config *configpb.LogConfig
PubKey crypto.PublicKey
PrivKey proto.Message
KeyUsages []x509.ExtKeyUsage
NotAfterStart *time.Time
NotAfterLimit *time.Time
FrozenSTH *ct.SignedTreeHead
CTFEStorageConnectionString string
ExtraDataIssuanceChainStorageBackend configpb.LogConfig_IssuanceChainStorageBackend
}
// LogConfigFromFile creates a slice of LogConfig options from the given
// filename, which should contain text or binary-encoded protobuf configuration
// data.
func LogConfigFromFile(filename string) ([]*configpb.LogConfig, error) {
cfgBytes, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
var cfg configpb.LogConfigSet
if txtErr := prototext.Unmarshal(cfgBytes, &cfg); txtErr != nil {
if binErr := proto.Unmarshal(cfgBytes, &cfg); binErr != nil {
return nil, fmt.Errorf("failed to parse LogConfigSet from %q as text protobuf (%v) or binary protobuf (%v)", filename, txtErr, binErr)
}
}
if len(cfg.Config) == 0 {
return nil, errors.New("empty log config found")
}
return cfg.Config, nil
}
// ToMultiLogConfig creates a multi backend config proto from the data
// loaded from a single-backend configuration file. All the log configs
// reference a default backend spec as provided.
func ToMultiLogConfig(cfg []*configpb.LogConfig, beSpec string) *configpb.LogMultiConfig {
defaultBackend := &configpb.LogBackend{Name: "default", BackendSpec: beSpec}
for _, c := range cfg {
c.LogBackendName = defaultBackend.Name
}
return &configpb.LogMultiConfig{
LogConfigs: &configpb.LogConfigSet{Config: cfg},
Backends: &configpb.LogBackendSet{Backend: []*configpb.LogBackend{defaultBackend}},
}
}
// MultiLogConfigFromFile creates a LogMultiConfig proto from the given
// filename, which should contain text or binary-encoded protobuf configuration data.
// Does not do full validation of the config but checks that it is non empty.
func MultiLogConfigFromFile(filename string) (*configpb.LogMultiConfig, error) {
cfgBytes, err := os.ReadFile(filename)
if err != nil {
return nil, err
}
var cfg configpb.LogMultiConfig
if txtErr := prototext.Unmarshal(cfgBytes, &cfg); txtErr != nil {
if binErr := proto.Unmarshal(cfgBytes, &cfg); binErr != nil {
return nil, fmt.Errorf("failed to parse LogMultiConfig from %q as text protobuf (%v) or binary protobuf (%v)", filename, txtErr, binErr)
}
}
if len(cfg.LogConfigs.GetConfig()) == 0 || len(cfg.Backends.GetBackend()) == 0 {
return nil, errors.New("config is missing backends and/or log configs")
}
return &cfg, nil
}
// ValidateLogConfig checks that a single log config is valid. In particular:
// - A mirror log has a valid public key and no private key.
// - A non-mirror log has a private, and optionally a public key (both valid).
// - Each of NotBeforeStart and NotBeforeLimit, if set, is a valid timestamp
// proto. If both are set then NotBeforeStart <= NotBeforeLimit.
// - Merge delays (if present) are correct.
// - Frozen STH (if present) is correct and signed by the provided public key.
//
// Returns the validated structures (useful to avoid double validation).
func ValidateLogConfig(cfg *configpb.LogConfig) (*ValidatedLogConfig, error) {
if cfg.LogId == 0 {
return nil, errors.New("empty log ID")
}
vCfg := ValidatedLogConfig{Config: cfg}
// Validate the public key.
if pubKey := cfg.PublicKey; pubKey != nil {
var err error
if vCfg.PubKey, err = x509.ParsePKIXPublicKey(pubKey.Der); err != nil {
return nil, fmt.Errorf("x509.ParsePKIXPublicKey: %w", err)
}
} else if cfg.IsMirror {
return nil, errors.New("empty public key for mirror")
} else if cfg.FrozenSth != nil {
return nil, errors.New("empty public key for frozen STH")
}
// Validate the private key.
if !cfg.IsMirror {
if cfg.PrivateKey == nil {
return nil, errors.New("empty private key")
}
privKey, err := cfg.PrivateKey.UnmarshalNew()
if err != nil {
return nil, fmt.Errorf("invalid private key: %v", err)
}
vCfg.PrivKey = privKey
} else if cfg.PrivateKey != nil {
return nil, errors.New("unnecessary private key for mirror")
}
if cfg.RejectExpired && cfg.RejectUnexpired {
return nil, errors.New("rejecting all certificates")
}
// Validate the extended key usages list.
if len(cfg.ExtKeyUsages) > 0 {
for _, kuStr := range cfg.ExtKeyUsages {
if ku, ok := stringToKeyUsage[kuStr]; ok {
// If "Any" is specified, then we can ignore the entire list and
// just disable EKU checking.
if ku == x509.ExtKeyUsageAny {
klog.Infof("%s: Found ExtKeyUsageAny, allowing all EKUs", cfg.Prefix)
vCfg.KeyUsages = nil
break
}
vCfg.KeyUsages = append(vCfg.KeyUsages, ku)
} else {
return nil, fmt.Errorf("unknown extended key usage: %s", kuStr)
}
}
}
// Validate the time interval.
start, limit := cfg.NotAfterStart, cfg.NotAfterLimit
if start != nil {
vCfg.NotAfterStart = &time.Time{}
if err := start.CheckValid(); err != nil {
return nil, fmt.Errorf("invalid start timestamp: %v", err)
}
*vCfg.NotAfterStart = start.AsTime()
}
if limit != nil {
vCfg.NotAfterLimit = &time.Time{}
if err := limit.CheckValid(); err != nil {
return nil, fmt.Errorf("invalid limit timestamp: %v", err)
}
*vCfg.NotAfterLimit = limit.AsTime()
}
if start != nil && limit != nil && (*vCfg.NotAfterLimit).Before(*vCfg.NotAfterStart) {
return nil, errors.New("limit before start")
}
switch {
case cfg.MaxMergeDelaySec < 0:
return nil, errors.New("negative maximum merge delay")
case cfg.ExpectedMergeDelaySec < 0:
return nil, errors.New("negative expected merge delay")
case cfg.ExpectedMergeDelaySec > cfg.MaxMergeDelaySec:
return nil, errors.New("expected merge delay exceeds MMD")
}
if sth := cfg.FrozenSth; sth != nil {
verifier, err := ct.NewSignatureVerifier(vCfg.PubKey)
if err != nil {
return nil, fmt.Errorf("failed to create signature verifier: %v", err)
}
if vCfg.FrozenSTH, err = (&ct.GetSTHResponse{
TreeSize: uint64(sth.TreeSize),
Timestamp: uint64(sth.Timestamp),
SHA256RootHash: sth.Sha256RootHash,
TreeHeadSignature: sth.TreeHeadSignature,
}).ToSignedTreeHead(); err != nil {
return nil, fmt.Errorf("invalid frozen STH: %v", err)
}
if err := verifier.VerifySTHSignature(*vCfg.FrozenSTH); err != nil {
return nil, fmt.Errorf("signature verification failed: %v", err)
}
}
switch cfg.ExtraDataIssuanceChainStorageBackend {
case configpb.LogConfig_ISSUANCE_CHAIN_STORAGE_BACKEND_CTFE:
// Validate the combination of CtfeStorageConnectionString and ExtraDataIssuanceChainStorageBackend
if len(cfg.CtfeStorageConnectionString) == 0 {
return nil, errors.New("missing ctfe_storage_connection_string when issuance chain storage backend is CTFE")
}
// Validate CTFEStorageConnectionString
if strings.HasPrefix(cfg.CtfeStorageConnectionString, "mysql") {
if _, err := mysql.ParseDSN(strings.Split(cfg.CtfeStorageConnectionString, "://")[1]); err != nil {
return nil, errors.New("failed to parse ctfe_storage_connection_string for mysql driver")
}
} else if strings.HasPrefix(cfg.CtfeStorageConnectionString, "postgres") {
if _, err := pgconn.ParseConfig(cfg.CtfeStorageConnectionString); err != nil {
return nil, errors.New("failed to parse ctfe_storage_connection_string for postgresql pgx driver")
}
} else {
return nil, errors.New("unsupported driver in ctfe_storage_connection_string")
}
vCfg.CTFEStorageConnectionString = cfg.CtfeStorageConnectionString
case configpb.LogConfig_ISSUANCE_CHAIN_STORAGE_BACKEND_TRILLIAN_GRPC:
// Nothing to validate for Trillian gRPC
}
vCfg.ExtraDataIssuanceChainStorageBackend = cfg.ExtraDataIssuanceChainStorageBackend
return &vCfg, nil
}
// LogBackendMap is a map from log backend names to LogBackend objects.
type LogBackendMap = map[string]*configpb.LogBackend
// BuildLogBackendMap returns a map from log backend names to the corresponding
// LogBackend objects. It returns an error unless all backends have unique
// non-empty names and specifications.
func BuildLogBackendMap(lbs *configpb.LogBackendSet) (LogBackendMap, error) {
lbm := make(LogBackendMap)
specs := make(map[string]bool)
for _, be := range lbs.Backend {
if len(be.Name) == 0 {
return nil, fmt.Errorf("empty backend name: %v", be)
}
if len(be.BackendSpec) == 0 {
return nil, fmt.Errorf("empty backend spec: %v", be)
}
if _, ok := lbm[be.Name]; ok {
return nil, fmt.Errorf("duplicate backend name: %v", be)
}
if ok := specs[be.BackendSpec]; ok {
return nil, fmt.Errorf("duplicate backend spec: %v", be)
}
lbm[be.Name] = be
specs[be.BackendSpec] = true
}
return lbm, nil
}
func validateConfigs(cfg []*configpb.LogConfig) error {
// Check that logs have no duplicate or empty prefixes. Apply other LogConfig
// specific checks.
logNameMap := make(map[string]bool)
for _, logCfg := range cfg {
if _, err := ValidateLogConfig(logCfg); err != nil {
return fmt.Errorf("log config: %v: %v", err, logCfg)
}
if len(logCfg.Prefix) == 0 {
return fmt.Errorf("log config: empty prefix: %v", logCfg)
}
if logNameMap[logCfg.Prefix] {
return fmt.Errorf("log config: duplicate prefix: %s: %v", logCfg.Prefix, logCfg)
}
logNameMap[logCfg.Prefix] = true
}
return nil
}
// ValidateLogConfigs checks that a config is valid for use with a single log
// server. The rules applied are:
//
// 1. All log configs must be valid (see ValidateLogConfig).
// 2. The prefixes of configured logs must all be distinct and must not be
// empty.
// 3. The set of tree IDs must be distinct.
func ValidateLogConfigs(cfg []*configpb.LogConfig) error {
if err := validateConfigs(cfg); err != nil {
return err
}
// Check that logs have no duplicate tree IDs.
treeIDs := make(map[int64]bool)
for _, logCfg := range cfg {
if treeIDs[logCfg.LogId] {
return fmt.Errorf("log config: dup tree id: %d for: %v", logCfg.LogId, logCfg)
}
treeIDs[logCfg.LogId] = true
}
return nil
}
// ValidateLogMultiConfig checks that a config is valid for use with multiple
// backend log servers. The rules applied are the same as ValidateLogConfigs, as
// well as these additional rules:
//
// 1. The backend set must define a set of log backends with distinct
// (non empty) names and non empty backend specs.
// 2. The backend specs must all be distinct.
// 3. The log configs must all specify a log backend and each must be one of
// those defined in the backend set.
//
// Also, another difference is that the tree IDs need only to be distinct per
// backend.
//
// TODO(pavelkalinnikov): Replace the returned map with a fully fledged
// ValidatedLogMultiConfig that contains a ValidatedLogConfig for each log.
func ValidateLogMultiConfig(cfg *configpb.LogMultiConfig) (LogBackendMap, error) {
backendMap, err := BuildLogBackendMap(cfg.Backends)
if err != nil {
return nil, err
}
if err := validateConfigs(cfg.GetLogConfigs().GetConfig()); err != nil {
return nil, err
}
// Check that logs all reference a defined backend.
logIDMap := make(map[string]bool)
for _, logCfg := range cfg.LogConfigs.Config {
if _, ok := backendMap[logCfg.LogBackendName]; !ok {
return nil, fmt.Errorf("log config: references undefined backend: %s: %v", logCfg.LogBackendName, logCfg)
}
logIDKey := fmt.Sprintf("%s-%d", logCfg.LogBackendName, logCfg.LogId)
if ok := logIDMap[logIDKey]; ok {
return nil, fmt.Errorf("log config: dup tree id: %d for: %v", logCfg.LogId, logCfg)
}
logIDMap[logIDKey] = true
}
return backendMap, nil
}
var stringToKeyUsage = map[string]x509.ExtKeyUsage{
"Any": x509.ExtKeyUsageAny,
"ServerAuth": x509.ExtKeyUsageServerAuth,
"ClientAuth": x509.ExtKeyUsageClientAuth,
"CodeSigning": x509.ExtKeyUsageCodeSigning,
"EmailProtection": x509.ExtKeyUsageEmailProtection,
"IPSECEndSystem": x509.ExtKeyUsageIPSECEndSystem,
"IPSECTunnel": x509.ExtKeyUsageIPSECTunnel,
"IPSECUser": x509.ExtKeyUsageIPSECUser,
"TimeStamping": x509.ExtKeyUsageTimeStamping,
"OCSPSigning": x509.ExtKeyUsageOCSPSigning,
"MicrosoftServerGatedCrypto": x509.ExtKeyUsageMicrosoftServerGatedCrypto,
"NetscapeServerGatedCrypto": x509.ExtKeyUsageNetscapeServerGatedCrypto,
}
|