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 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
|
// Copyright 2022 Google LLC
//
// 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 trust defines core trust types and values for attestation verification.
package trust
import (
"context"
"crypto/x509"
_ "embed"
"encoding/pem"
"fmt"
"io"
"net/http"
"os"
"strings"
"sync"
"time"
"github.com/google/go-sev-guest/abi"
"github.com/google/go-sev-guest/kds"
"github.com/google/logger"
"go.uber.org/multierr"
)
var (
// DefaultRootCerts holds AMD's SEV API certificate format for ASK and ARK keys as published here
// https://download.amd.com/developer/eula/sev/ask_ark_milan.cert
DefaultRootCerts map[string]*AMDRootCerts
// AskArkMilanVcekBytes is a CA bundle for Milan.
// source: https://kdsintf.amd.com/vcek/v1/Milan/cert_chain
//go:embed ask_ark_milan.pem
AskArkMilanVcekBytes []byte
// AskArkMilanVlekBytes is a CA bundle for VLEK certs on Milan.
// source: https://kdsintf.amd.com/vlek/v1/Milan/cert_chain
//go:embed ask_ark_milan_vlek.pem
AskArkMilanVlekBytes []byte
// AskArkGenoaVcekBytes is a CA bundle for Genoa.
// source: https://kdsintf.amd.com/vcek/v1/Genoa/cert_chain
//go:embed ask_ark_genoa.pem
AskArkGenoaVcekBytes []byte
// AskArkGenoaVlekBytes is a CA bundle for VLEK certs on Genoa.
// source: https://kdsintf.amd.com/vlek/v1/Genoa/cert_chain
//go:embed ask_ark_genoa_vlek.pem
AskArkGenoaVlekBytes []byte
// AskArkTurinVcekBytes is a CA bundle for VCEK certs on Turin.
// source: https://kdsintf.amd.com/vcek/v1/Turin/cert_chain
//go:embed ask_ark_turin_vcek.pem
AskArkTurinVcekBytes []byte
// AskArkTurinVlekBytes is a CA bundle for VLEK certs on Turin.
// source: https://kdsintf.amd.com/vcek/v1/Turin/cert_chain
//go:embed ask_ark_turin_vlek.pem
AskArkTurinVlekBytes []byte
// A cache of product certificate KDS results per product.
prodCacheMu sync.Mutex
productLineCertCache map[string]*ProductCerts
)
// Communication with AMD suggests repeat requests of the same arguments will
// be throttled to once per 10 seconds.
const initialDelay = 10 * time.Second
// ProductCerts contains the root key and signing key devoted to a given product line.
type ProductCerts struct {
Ask *x509.Certificate
Asvk *x509.Certificate
Ark *x509.Certificate
}
// AMDRootCerts encapsulates the certificates that represent root of trust in AMD.
type AMDRootCerts struct {
// Product is the expected CPU product line, e.g., Milan, Turin, Genoa.
//
// Deprecated: Use ProductLine.
Product string
// Product is the expected CPU product line, e.g., Milan, Turin, Genoa.
ProductLine string
// ProductCerts contains the root key and signing key devoted to a given product line.
ProductCerts *ProductCerts
// AskSev is the AMD certificate representation of the AMD signing key that certifies
// versioned chip endoresement keys. If present, the information must match AskX509.
AskSev *abi.AskCert
// ArkSev is the AMD certificate representation of the self-signed AMD root key that
// certifies the AMD signing key. If present, the information must match ArkX509.
ArkSev *abi.AskCert
// Mu protects concurrent accesses to CRL.
Mu sync.Mutex
// CRL is the certificate revocation list for this AMD product. Populated once, only when a
// revocation is checked.
CRL *x509.RevocationList
}
// GetProductLine returns the product line the certificate chain is associated with.
func (r *AMDRootCerts) GetProductLine() string {
if r.ProductLine != "" {
return r.ProductLine
}
return r.Product
}
// AMDRootCertsProduct returns a new *AMDRootCerts for a given product line.
func AMDRootCertsProduct(productLine string) *AMDRootCerts {
return &AMDRootCerts{
Product: productLine, // TODO(Issue#114): Remove,
ProductLine: productLine,
}
}
// HTTPSGetter represents the ability to fetch data from the internet from an HTTP URL.
// Used particularly for fetching certificates.
type HTTPSGetter interface {
Get(url string) ([]byte, error)
}
// AttestationRecreationErr represents a problem with fetching or interpreting associated
// certificates for a given attestation report. This is typically due to network unreliability.
type AttestationRecreationErr struct {
Msg string
}
func (e *AttestationRecreationErr) Error() string {
return e.Msg
}
// SimpleHTTPSGetter implements the HTTPSGetter interface with http.Get.
type SimpleHTTPSGetter struct{}
// Get uses http.Get to return the HTTPS response body as a byte array.
func (n *SimpleHTTPSGetter) Get(url string) ([]byte, error) {
resp, err := http.Get(url)
if err != nil {
return nil, err
} else if resp.StatusCode >= 300 {
return nil, fmt.Errorf("failed to retrieve '%s' status %d", url, resp.StatusCode)
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
resp.Body.Close()
return body, nil
}
// RetryHTTPSGetter is a meta-HTTPS getter that will retry on failure a given number of times.
type RetryHTTPSGetter struct {
// Timeout is how long to retry before failure.
Timeout time.Duration
// MaxRetryDelay is the maximum amount of time to wait between retries.
MaxRetryDelay time.Duration
// Getter is the non-retrying way of getting a URL.
Getter HTTPSGetter
}
// Get fetches the body of the URL, retrying a given amount of times on failure.
func (n *RetryHTTPSGetter) Get(url string) ([]byte, error) {
delay := initialDelay
ctx, cancel := context.WithTimeout(context.Background(), n.Timeout)
var returnedError error
for {
body, err := n.Getter.Get(url)
if err == nil {
cancel()
return body, nil
}
returnedError = multierr.Append(returnedError, err)
delay = delay + delay
if delay > n.MaxRetryDelay {
delay = n.MaxRetryDelay
}
select {
case <-ctx.Done():
cancel()
return nil, multierr.Append(returnedError, fmt.Errorf("timeout")) // context cancelled
case <-time.After(delay): // wait to retry
}
}
}
// DefaultHTTPSGetter returns the library's default getter implementation. It will
// retry slowly due to the AMD KDS's rate limiting.
func DefaultHTTPSGetter() HTTPSGetter {
return &RetryHTTPSGetter{
Timeout: 2 * time.Minute,
MaxRetryDelay: 30 * time.Second,
Getter: &SimpleHTTPSGetter{},
}
}
// Unmarshal populates ASK and ARK certificates from AMD SEV format certificates in data.
func (r *AMDRootCerts) Unmarshal(data []byte) error {
ask, index, err := abi.ParseAskCert(data)
if err != nil {
return fmt.Errorf("could not parse intermediate ASK certificate in SEV certificate format: %v", err)
}
r.AskSev = ask
ark, _, err := abi.ParseAskCert(data[index:])
if err != nil {
return fmt.Errorf("could not parse ARK certificate in SEV certificate format: %v", err)
}
r.ArkSev = ark
return nil
}
// ParseCert returns an X.509 Certificate type for a PEM[CERTIFICATE]- or DER-encoded cert.
func ParseCert(cert []byte) (*x509.Certificate, error) {
raw := cert
b, rest := pem.Decode(cert)
if b != nil {
if len(rest) > 0 || b.Type != "CERTIFICATE" {
return nil, fmt.Errorf("bad type %q or trailing bytes (%d). Expected a single certificate when in PEM format",
b.Type, len(rest))
}
raw = b.Bytes
}
return x509.ParseCertificate(raw)
}
// Decode populates the ProductCerts from DER-formatted certificates for both the AS[V]K and the ARK.
func (r *ProductCerts) Decode(ask []byte, ark []byte) error {
ica, err := ParseCert(ask)
if err != nil {
return fmt.Errorf("could not parse intermediate certificate: %v", err)
}
if strings.HasPrefix(ica.Subject.CommonName, "SEV-VLEK") {
r.Asvk = ica
} else {
r.Ask = ica
}
arkCert, err := ParseCert(ark)
if err != nil {
logger.Errorf("could not parse ARK certificate: %v", err)
}
r.Ark = arkCert
return nil
}
// FromKDSCertBytes populates r's AskX509 and ArkX509 certificates from the two PEM-encoded
// certificates in data. This is the format the Key Distribution Service (KDS) uses, e.g.,
// https://kdsintf.amd.com/vcek/v1/Milan/cert_chain
func (r *ProductCerts) FromKDSCertBytes(data []byte) error {
ask, ark, err := kds.ParseProductCertChain(data)
if err != nil {
return err
}
return r.Decode(ask, ark)
}
// FromKDSCert populates r's AskX509 and ArkX509 certificates from the certificate format AMD's Key
// Distribution Service (KDS) uses, e.g., https://kdsintf.amd.com/vcek/v1/Milan/cert_chain
func (r *ProductCerts) FromKDSCert(path string) error {
certBytes, err := os.ReadFile(path)
if err != nil {
return err
}
return r.FromKDSCertBytes(certBytes)
}
// X509Options returns the AS[V]K and ARK as the only intermediate and root certificates of an x509
// verification options object, or nil if either key's x509 certificate is not present in r.
// The choice between ASK and ASVK is determined bey key.
func (r *ProductCerts) X509Options(now time.Time, key abi.ReportSigner) *x509.VerifyOptions {
if r.Ark == nil {
return nil
}
roots := x509.NewCertPool()
roots.AddCert(r.Ark)
intermediates := x509.NewCertPool()
switch key {
case abi.VcekReportSigner:
if r.Ask == nil {
return nil
}
intermediates.AddCert(r.Ask)
case abi.VlekReportSigner:
if r.Asvk == nil {
return nil
}
intermediates.AddCert(r.Asvk)
}
return &x509.VerifyOptions{Roots: roots, Intermediates: intermediates, CurrentTime: now}
}
// ClearProductCertCache clears the product certificate cache. This is useful for testing with
// multiple roots of trust.
func ClearProductCertCache() {
prodCacheMu.Lock()
productLineCertCache = nil
prodCacheMu.Unlock()
}
// GetProductChain returns the ASK and ARK certificates of the given product line, either from getter
// or from a cache of the results from the last successful call.
func GetProductChain(productLine string, s abi.ReportSigner, getter HTTPSGetter) (*ProductCerts, error) {
if productLineCertCache == nil {
prodCacheMu.Lock()
productLineCertCache = make(map[string]*ProductCerts)
prodCacheMu.Unlock()
}
result, ok := productLineCertCache[productLine]
if !ok {
askark, err := getter.Get(kds.ProductCertChainURL(s, productLine))
if err != nil {
return nil, &AttestationRecreationErr{
Msg: fmt.Sprintf("could not download ASK and ARK certificates: %v", err),
}
}
ask, ark, err := kds.ParseProductCertChain(askark)
if err != nil {
// Treat a bad parse as a network error since it's likely due to an incomplete transfer.
return nil, &AttestationRecreationErr{Msg: fmt.Sprintf("could not parse root cert_chain: %v", err)}
}
askCert, err := x509.ParseCertificate(ask)
if err != nil {
return nil, &AttestationRecreationErr{Msg: fmt.Sprintf("could not parse ASK cert: %v", err)}
}
arkCert, err := x509.ParseCertificate(ark)
if err != nil {
return nil, &AttestationRecreationErr{Msg: fmt.Sprintf("could not parse ARK cert: %v", err)}
}
result = &ProductCerts{Ask: askCert, Ark: arkCert}
prodCacheMu.Lock()
productLineCertCache[productLine] = result
prodCacheMu.Unlock()
}
return result, nil
}
// Forward all the ProductCerts operations from the AMDRootCerts struct to follow the
// Law of Demeter.
// Decode populates the AMDRootCerts from DER-formatted certificates for both the ASK and the ARK.
func (r *AMDRootCerts) Decode(ask []byte, ark []byte) error {
r.ProductCerts = &ProductCerts{}
return r.ProductCerts.Decode(ask, ark)
}
// FromKDSCertBytes populates r's AskX509 and ArkX509 certificates from the two PEM-encoded
// certificates in data. This is the format the Key Distribution Service (KDS) uses, e.g.,
// https://kdsintf.amd.com/vcek/v1/Milan/cert_chain
func (r *AMDRootCerts) FromKDSCertBytes(data []byte) error {
r.ProductCerts = &ProductCerts{}
return r.ProductCerts.FromKDSCertBytes(data)
}
// FromKDSCert populates r's AskX509 and ArkX509 certificates from the certificate format AMD's Key
// Distribution Service (KDS) uses, e.g., https://kdsintf.amd.com/vcek/v1/Milan/cert_chain
func (r *AMDRootCerts) FromKDSCert(path string) error {
r.ProductCerts = &ProductCerts{}
return r.ProductCerts.FromKDSCert(path)
}
// X509Options returns the AS[V]K and ARK as the only intermediate and root certificates of an x509
// verification options object, or nil if either key's x509 certificate is not present in r.
// Choice between ASK and ASVK is determined by key.
func (r *AMDRootCerts) X509Options(now time.Time, key abi.ReportSigner) *x509.VerifyOptions {
if r.ProductCerts == nil {
return nil
}
return r.ProductCerts.X509Options(now, key)
}
// Parse ASK, ARK certificates from the embedded AMD certificate file.
func init() {
milanCerts := new(AMDRootCerts)
milanCerts.FromKDSCertBytes(AskArkMilanVcekBytes)
milanCerts.ProductLine = "Milan"
genoaCerts := new(AMDRootCerts)
genoaCerts.FromKDSCertBytes(AskArkGenoaVcekBytes)
genoaCerts.ProductLine = "Genoa"
turinCerts := new(AMDRootCerts)
turinCerts.ProductLine = "Turin"
turinCerts.FromKDSCertBytes(AskArkTurinVcekBytes)
DefaultRootCerts = map[string]*AMDRootCerts{
"Milan": milanCerts,
"Genoa": genoaCerts,
"Turin": turinCerts,
}
}
|