vault/sdk/helper/ocsp/client.go

// Copyright (c) 2017-2022 Snowflake Computing Inc. All rights reserved.

package ocsp

import (
	"bytes"
	"context"
	"crypto"
	"crypto/tls"
	"crypto/x509"
	"crypto/x509/pkix"
	"encoding/asn1"
	"encoding/base64"
	"errors"
	"fmt"
	"io"
	"math/big"
	"net"
	"net/http"
	"net/url"
	"strconv"
	"strings"
	"sync"
	"time"

	"github.com/hashicorp/go-hclog"
	"github.com/hashicorp/go-multierror"
	"github.com/hashicorp/go-retryablehttp"
	lru "github.com/hashicorp/golang-lru"
	"github.com/hashicorp/vault/sdk/helper/certutil"
	"golang.org/x/crypto/ocsp"
)

//go:generate enumer -type=FailOpenMode -trimprefix=FailOpen

// FailOpenMode is OCSP fail open mode. FailOpenTrue by default and may
// set to ocspModeFailClosed for fail closed mode
type FailOpenMode uint32

type requestFunc func(method, urlStr string, body interface{}) (*retryablehttp.Request, error)

type clientInterface interface {
	Do(req *retryablehttp.Request) (*http.Response, error)
}

const (
	httpHeaderContentType   = "Content-Type"
	httpHeaderAccept        = "accept"
	httpHeaderContentLength = "Content-Length"
	httpHeaderHost          = "Host"
	ocspRequestContentType  = "application/ocsp-request"
	ocspResponseContentType = "application/ocsp-response"
)

const (
	ocspFailOpenNotSet FailOpenMode = iota
	// FailOpenTrue represents OCSP fail open mode.
	FailOpenTrue
	// FailOpenFalse represents OCSP fail closed mode.
	FailOpenFalse
)

const (
	ocspModeFailOpen   = "FAIL_OPEN"
	ocspModeFailClosed = "FAIL_CLOSED"
	ocspModeInsecure   = "INSECURE"
)

const ocspCacheKey = "ocsp_cache"

const (
	// defaultOCSPResponderTimeout is the total timeout for OCSP responder.
	defaultOCSPResponderTimeout = 10 * time.Second
)

const (
	// cacheExpire specifies cache data expiration time in seconds.
	cacheExpire = float64(24 * 60 * 60)
)

// ErrOcspIssuerVerification indicates an error verifying the identity of an OCSP response occurred
type ErrOcspIssuerVerification struct {
	Err error
}

func (e *ErrOcspIssuerVerification) Error() string {
	return fmt.Sprintf("ocsp response verification error: %v", e.Err)
}

type ocspCachedResponse struct {
	time       float64
	producedAt float64
	thisUpdate float64
	nextUpdate float64
	status     ocspStatusCode
}

type Client struct {
	// caRoot includes the CA certificates.
	caRoot map[string]*x509.Certificate
	// certPool includes the CA certificates.
	certPool              *x509.CertPool
	ocspResponseCache     *lru.TwoQueueCache
	ocspResponseCacheLock sync.RWMutex
	// cacheUpdated is true if the memory cache is updated
	cacheUpdated bool
	logFactory   func() hclog.Logger
}

type ocspStatusCode int

type ocspStatus struct {
	code ocspStatusCode
	err  error
}

const (
	ocspSuccess                ocspStatusCode = 0
	ocspStatusGood             ocspStatusCode = -1
	ocspStatusRevoked          ocspStatusCode = -2
	ocspStatusUnknown          ocspStatusCode = -3
	ocspStatusOthers           ocspStatusCode = -4
	ocspFailedDecomposeRequest ocspStatusCode = -5
	ocspInvalidValidity        ocspStatusCode = -6
	ocspMissedCache            ocspStatusCode = -7
	ocspCacheExpired           ocspStatusCode = -8
)

// copied from crypto/ocsp.go
type certID struct {
	HashAlgorithm pkix.AlgorithmIdentifier
	NameHash      []byte
	IssuerKeyHash []byte
	SerialNumber  *big.Int
}

// cache key
type certIDKey struct {
	NameHash      string
	IssuerKeyHash string
	SerialNumber  string
}

// copied from crypto/ocsp
var hashOIDs = map[crypto.Hash]asn1.ObjectIdentifier{
	crypto.SHA1:   asn1.ObjectIdentifier([]int{1, 3, 14, 3, 2, 26}),
	crypto.SHA256: asn1.ObjectIdentifier([]int{2, 16, 840, 1, 101, 3, 4, 2, 1}),
	crypto.SHA384: asn1.ObjectIdentifier([]int{2, 16, 840, 1, 101, 3, 4, 2, 2}),
	crypto.SHA512: asn1.ObjectIdentifier([]int{2, 16, 840, 1, 101, 3, 4, 2, 3}),
}

// copied from crypto/ocsp
func getOIDFromHashAlgorithm(target crypto.Hash) (asn1.ObjectIdentifier, error) {
	for hash, oid := range hashOIDs {
		if hash == target {
			return oid, nil
		}
	}
	return nil, fmt.Errorf("no valid OID is found for the hash algorithm: %v", target)
}

func (c *Client) ClearCache() {
	c.ocspResponseCache.Purge()
}

func (c *Client) getHashAlgorithmFromOID(target pkix.AlgorithmIdentifier) crypto.Hash {
	for hash, oid := range hashOIDs {
		if oid.Equal(target.Algorithm) {
			return hash
		}
	}
	// no valid hash algorithm is found for the oid. Falling back to SHA1
	return crypto.SHA1
}

// isInValidityRange checks the validity times of the OCSP response making sure
// that thisUpdate and nextUpdate values are bounded within currTime
func isInValidityRange(currTime time.Time, ocspRes *ocsp.Response) bool {
	thisUpdate := ocspRes.ThisUpdate

	// If the thisUpdate value in the OCSP response wasn't set or greater than current time fail this check
	if thisUpdate.IsZero() || thisUpdate.After(currTime) {
		return false
	}

	nextUpdate := ocspRes.NextUpdate
	if nextUpdate.IsZero() {
		// We don't have a nextUpdate field set, assume we are okay.
		return true
	}

	if currTime.After(nextUpdate) || thisUpdate.After(nextUpdate) {
		return false
	}

	return true
}

func extractCertIDKeyFromRequest(ocspReq []byte) (*certIDKey, *ocspStatus) {
	r, err := ocsp.ParseRequest(ocspReq)
	if err != nil {
		return nil, &ocspStatus{
			code: ocspFailedDecomposeRequest,
			err:  err,
		}
	}

	// encode CertID, used as a key in the cache
	encodedCertID := &certIDKey{
		base64.StdEncoding.EncodeToString(r.IssuerNameHash),
		base64.StdEncoding.EncodeToString(r.IssuerKeyHash),
		r.SerialNumber.String(),
	}
	return encodedCertID, &ocspStatus{
		code: ocspSuccess,
	}
}

func (c *Client) encodeCertIDKey(certIDKeyBase64 string) (*certIDKey, error) {
	r, err := base64.StdEncoding.DecodeString(certIDKeyBase64)
	if err != nil {
		return nil, err
	}
	var cid certID
	rest, err := asn1.Unmarshal(r, &cid)
	if err != nil {
		// error in parsing
		return nil, err
	}
	if len(rest) > 0 {
		// extra bytes to the end
		return nil, err
	}
	return &certIDKey{
		base64.StdEncoding.EncodeToString(cid.NameHash),
		base64.StdEncoding.EncodeToString(cid.IssuerKeyHash),
		cid.SerialNumber.String(),
	}, nil
}

func (c *Client) checkOCSPResponseCache(encodedCertID *certIDKey, subject, issuer *x509.Certificate, config *VerifyConfig) (*ocspStatus, error) {
	c.ocspResponseCacheLock.RLock()
	var cacheValue *ocspCachedResponse
	v, ok := c.ocspResponseCache.Get(*encodedCertID)
	if ok {
		cacheValue = v.(*ocspCachedResponse)
	}
	c.ocspResponseCacheLock.RUnlock()

	status, err := c.extractOCSPCacheResponseValue(cacheValue, subject, issuer, config)
	if err != nil {
		return nil, err
	}
	if !isValidOCSPStatus(status.code) {
		c.deleteOCSPCache(encodedCertID)
	}
	return status, err
}

func (c *Client) deleteOCSPCache(encodedCertID *certIDKey) {
	c.ocspResponseCacheLock.Lock()
	c.ocspResponseCache.Remove(*encodedCertID)
	c.cacheUpdated = true
	c.ocspResponseCacheLock.Unlock()
}

func validateOCSP(conf *VerifyConfig, ocspRes *ocsp.Response) (*ocspStatus, error) {
	curTime := time.Now()

	if ocspRes == nil {
		return nil, errors.New("OCSP Response is nil")
	}
	if !isInValidityRange(curTime, ocspRes) {
		return &ocspStatus{
			code: ocspInvalidValidity,
			err:  fmt.Errorf("invalid validity: producedAt: %v, thisUpdate: %v, nextUpdate: %v", ocspRes.ProducedAt, ocspRes.ThisUpdate, ocspRes.NextUpdate),
		}, nil
	}

	if conf.OcspThisUpdateMaxAge > 0 && curTime.Sub(ocspRes.ThisUpdate) > conf.OcspThisUpdateMaxAge {
		return &ocspStatus{
			code: ocspInvalidValidity,
			err:  fmt.Errorf("invalid validity: thisUpdate: %v is greater than max age: %s", ocspRes.ThisUpdate, conf.OcspThisUpdateMaxAge),
		}, nil
	}
	return returnOCSPStatus(ocspRes), nil
}

func returnOCSPStatus(ocspRes *ocsp.Response) *ocspStatus {
	switch ocspRes.Status {
	case ocsp.Good:
		return &ocspStatus{
			code: ocspStatusGood,
			err:  nil,
		}
	case ocsp.Revoked:
		return &ocspStatus{
			code: ocspStatusRevoked,
		}
	case ocsp.Unknown:
		return &ocspStatus{
			code: ocspStatusUnknown,
			err:  errors.New("OCSP status unknown."),
		}
	default:
		return &ocspStatus{
			code: ocspStatusOthers,
			err:  fmt.Errorf("OCSP others. %v", ocspRes.Status),
		}
	}
}

// retryOCSP is the second level of retry method if the returned contents are corrupted. It often happens with OCSP
// serer and retry helps.
func (c *Client) retryOCSP(
	ctx context.Context,
	client clientInterface,
	req requestFunc,
	ocspHost *url.URL,
	headers map[string]string,
	reqBody []byte,
	subject,
	issuer *x509.Certificate,
	extraCas []*x509.Certificate,
) (ocspRes *ocsp.Response, ocspResBytes []byte, ocspS *ocspStatus, retErr error) {
	doRequest := func(request *retryablehttp.Request) (*http.Response, error) {
		if request != nil {
			request = request.WithContext(ctx)
			for k, v := range headers {
				request.Header[k] = append(request.Header[k], v)
			}
		}
		res, err := client.Do(request)
		if err != nil {
			return nil, err
		}
		c.Logger().Debug("StatusCode from OCSP Server:", "statusCode", res.StatusCode)
		return res, err
	}

	for _, method := range []string{"GET", "POST"} {
		reqUrl := *ocspHost
		var body []byte

		switch method {
		case "GET":
			reqUrl.Path = reqUrl.Path + "/" + base64.StdEncoding.EncodeToString(reqBody)
		case "POST":
			body = reqBody
		default:
			// Programming error; all request/systems errors are multierror
			// and appended.
			return nil, nil, nil, fmt.Errorf("unknown request method: %v", method)
		}

		var res *http.Response
		request, err := req(method, reqUrl.String(), bytes.NewBuffer(body))
		if err != nil {
			err = fmt.Errorf("error creating %v request: %w", method, err)
			retErr = multierror.Append(retErr, err)
			continue
		}
		if res, err = doRequest(request); err != nil {
			err = fmt.Errorf("error doing %v request: %w", method, err)
			retErr = multierror.Append(retErr, err)
			continue
		} else {
			defer res.Body.Close()
		}

		if res.StatusCode != http.StatusOK {
			err = fmt.Errorf("HTTP code is not OK on %v request. %v: %v", method, res.StatusCode, res.Status)
			retErr = multierror.Append(retErr, err)
			continue
		}

		ocspResBytes, err = io.ReadAll(res.Body)
		if err != nil {
			err = fmt.Errorf("error reading %v request body: %w", method, err)
			retErr = multierror.Append(retErr, err)
			continue
		}

		// Reading an OCSP response shouldn't be fatal. A misconfigured
		// endpoint might return invalid results for e.g., GET but return
		// valid results for POST on retry. This could happen if e.g., the
		// server responds with JSON.
		ocspRes, err = ocsp.ParseResponse(ocspResBytes /*issuer = */, nil /* !!unsafe!! */)
		if err != nil {
			err = fmt.Errorf("error parsing %v OCSP response: %w", method, err)
			retErr = multierror.Append(retErr, err)
			continue
		}

		if err := validateOCSPParsedResponse(ocspRes, subject, issuer, extraCas); err != nil {
			err = fmt.Errorf("error validating %v OCSP response: %w", method, err)

			if IsOcspVerificationError(err) {
				// We want to immediately give up on a verification error to a response
				// and inform the user something isn't correct
				return nil, nil, nil, err
			}

			retErr = multierror.Append(retErr, err)
			// Clear the response out as we can't trust it.
			ocspRes = nil
			continue
		}

		// While we haven't validated the signature on the OCSP response, we
		// got what we presume is a definitive answer and simply changing
		// methods will likely not help us in that regard. Use this status
		// to return without retrying another method, when it looks definitive.
		//
		// We don't accept ocsp.Unknown here: presumably, we could've hit a CDN
		// with static mapping of request->responses, with a default "unknown"
		// handler for everything else. By retrying here, we use POST, which
		// could hit a live OCSP server with fresher data than the cached CDN.
		if ocspRes.Status == ocsp.Good || ocspRes.Status == ocsp.Revoked {
			break
		}

		// Here, we didn't have a valid response. Even though we didn't get an
		// error, we should inform the user that this (valid-looking) response
		// wasn't utilized.
		err = fmt.Errorf("fetched %v OCSP response of status %v; wanted either good (%v) or revoked (%v)", method, ocspRes.Status, ocsp.Good, ocsp.Revoked)
		retErr = multierror.Append(retErr, err)
	}

	if ocspRes != nil && ocspResBytes != nil {
		// Clear retErr, because we have one parseable-but-maybe-not-quite-correct
		// OCSP response.
		retErr = nil
		ocspS = &ocspStatus{
			code: ocspSuccess,
		}
	}

	return
}

func IsOcspVerificationError(err error) bool {
	errOcspIssuer := &ErrOcspIssuerVerification{}
	return errors.As(err, &errOcspIssuer)
}

func validateOCSPParsedResponse(ocspRes *ocsp.Response, subject, issuer *x509.Certificate, extraCas []*x509.Certificate) error {
	// Above, we use the unsafe issuer=nil parameter to ocsp.ParseResponse
	// because Go's library does the wrong thing.
	//
	// Here, we lack a full chain, but we know we trust the parent issuer,
	// so if the Go library incorrectly discards useful certificates, we
	// likely cannot verify this without passing through the full chain
	// back to the root.
	//
	// Instead, take one of two paths: 1. if there is no certificate in
	// the ocspRes, verify the OCSP response directly with our trusted
	// issuer certificate, or 2. if there is a certificate, either verify
	// it directly matches our trusted issuer certificate, or verify it
	// is signed by our trusted issuer certificate.
	//
	// See also: https://github.com/golang/go/issues/59641
	//
	// This addresses the !!unsafe!! behavior above.
	if ocspRes.Certificate == nil {
		// With no certificate, we need to validate that the response is signed by the issuer or an extra CA
		if err := ocspRes.CheckSignatureFrom(issuer); err != nil {
			if len(extraCas) > 0 {
				// Perhaps it was signed by one of the extra configured OCSP CAs
				matchedCA, overallErr := verifySignature(ocspRes, extraCas)

				if overallErr != nil {
					return &ErrOcspIssuerVerification{fmt.Errorf("error checking chain of trust %v failed: %w", issuer.Subject.String(), overallErr)}
				}

				err := validateSigner(matchedCA)
				if err != nil {
					return err
				}
			} else {
				return &ErrOcspIssuerVerification{fmt.Errorf("error directly verifying signature: %w", err)}
			}
		}
	} else {
		// Because we have at least one certificate here, we know that
		// Go's ocsp library verified the signature from this certificate
		// onto the response and it was valid. Now we need to know we trust
		// this certificate. There are three ways we can do this:
		//
		// 1. Via confirming issuer == ocspRes.Certificate, or
		// 2. Via confirming ocspRes.Certificate.CheckSignatureFrom(issuer).
		// 3. Trusting extra configured OCSP CAs
		if !bytes.Equal(issuer.Raw, ocspRes.Raw) {
			var overallErr error
			var matchedCA *x509.Certificate

			// Assumption 1 failed, try 2
			if sigFromIssuerErr := ocspRes.Certificate.CheckSignatureFrom(issuer); sigFromIssuerErr != nil {
				if len(extraCas) > 0 {
					// Assumption 2 failed, try 3
					m, err := verifySignature(ocspRes, extraCas)
					if err != nil {
						overallErr = multierror.Append(overallErr, sigFromIssuerErr)
						overallErr = multierror.Append(overallErr, err)
					} else {
						overallErr = nil
						matchedCA = m
					}
				} else {
					overallErr = multierror.Append(overallErr, sigFromIssuerErr)
				}
			} else {
				matchedCA = ocspRes.Certificate
			}

			if overallErr != nil {
				return &ErrOcspIssuerVerification{fmt.Errorf("error checking chain of trust %v failed: %w", issuer.Subject.String(), overallErr)}
			}

			err := validateSigner(matchedCA)
			if err != nil {
				return err
			}
		}
	}

	// Verify the response was for our original subject
	if ocspRes.SerialNumber == nil || subject.SerialNumber == nil {
		return &ErrOcspIssuerVerification{fmt.Errorf("OCSP response or cert did not contain a serial number")}
	}
	if ocspRes.SerialNumber.Cmp(subject.SerialNumber) != 0 {
		return &ErrOcspIssuerVerification{fmt.Errorf(
			"OCSP response serial number %s did not match the leaf certificate serial number %s",
			certutil.GetHexFormatted(ocspRes.SerialNumber.Bytes(), ":"),
			certutil.GetHexFormatted(subject.SerialNumber.Bytes(), ":"))}
	}

	return nil
}

func verifySignature(res *ocsp.Response, extraCas []*x509.Certificate) (*x509.Certificate, error) {
	var overallErr error
	var matchedCA *x509.Certificate
	for _, ca := range extraCas {
		if err := res.CheckSignatureFrom(ca); err != nil {
			overallErr = multierror.Append(overallErr, err)
		} else {
			matchedCA = ca
			overallErr = nil
			break
		}
	}
	return matchedCA, overallErr
}

func validateSigner(matchedCA *x509.Certificate) error {
	// Verify the OCSP responder certificate is still valid and
	// contains the required EKU since it is a delegated OCSP
	// responder certificate.
	if matchedCA.NotAfter.Before(time.Now()) {
		return &ErrOcspIssuerVerification{fmt.Errorf("error checking delegated OCSP responder OCSP response: certificate has expired")}
	}
	haveEKU := false
	for _, ku := range matchedCA.ExtKeyUsage {
		if ku == x509.ExtKeyUsageOCSPSigning {
			haveEKU = true
			break
		}
	}
	if !haveEKU {
		return &ErrOcspIssuerVerification{fmt.Errorf("error checking delegated OCSP responder: certificate lacks the OCSP Signing EKU")}
	}
	return nil
}

// GetRevocationStatus checks the certificate revocation status for subject using issuer certificate.
func (c *Client) GetRevocationStatus(ctx context.Context, subject, issuer *x509.Certificate, conf *VerifyConfig) (*ocspStatus, error) {
	status, ocspReq, encodedCertID, err := c.validateWithCache(subject, issuer, conf)
	if err != nil {
		return nil, err
	}
	if isValidOCSPStatus(status.code) {
		return status, nil
	}
	if ocspReq == nil || encodedCertID == nil {
		return status, nil
	}
	c.Logger().Debug("cache missed", "server", subject.OCSPServer)
	if len(subject.OCSPServer) == 0 && len(conf.OcspServersOverride) == 0 {
		return nil, fmt.Errorf("no OCSP responder URL: subject: %v", subject.Subject)
	}
	ocspHosts := subject.OCSPServer
	if len(conf.OcspServersOverride) > 0 {
		ocspHosts = conf.OcspServersOverride
	}

	var wg sync.WaitGroup

	ocspStatuses := make([]*ocspStatus, len(ocspHosts))
	ocspResponses := make([]*ocsp.Response, len(ocspHosts))
	errors := make([]error, len(ocspHosts))

	for i, ocspHost := range ocspHosts {
		u, err := url.Parse(ocspHost)
		if err != nil {
			return nil, err
		}

		hostname := u.Hostname()

		headers := make(map[string]string)
		headers[httpHeaderContentType] = ocspRequestContentType
		headers[httpHeaderAccept] = ocspResponseContentType
		headers[httpHeaderContentLength] = strconv.Itoa(len(ocspReq))
		headers[httpHeaderHost] = hostname
		timeout := defaultOCSPResponderTimeout

		ocspClient := retryablehttp.NewClient()
		ocspClient.Logger = c.Logger()
		ocspClient.RetryMax = conf.OcspMaxRetries
		ocspClient.HTTPClient.Timeout = timeout
		ocspClient.HTTPClient.Transport = newInsecureOcspTransport(conf.ExtraCas)

		doRequest := func(i int) error {
			if conf.QueryAllServers {
				defer wg.Done()
			}
			ocspRes, _, ocspS, err := c.retryOCSP(
				ctx, ocspClient, retryablehttp.NewRequest, u, headers, ocspReq, subject, issuer, conf.ExtraCas)
			ocspResponses[i] = ocspRes
			if err != nil {
				errors[i] = err
				return err
			}
			if ocspS.code != ocspSuccess {
				ocspStatuses[i] = ocspS
				return nil
			}

			ret, err := validateOCSP(conf, ocspRes)
			if err != nil {
				errors[i] = err
				return err
			}
			if isValidOCSPStatus(ret.code) {
				ocspStatuses[i] = ret
			} else if ret.err != nil {
				// This check needs to occur after the isValidOCSPStatus as the unknown
				// status also sets an err value within ret.
				errors[i] = ret.err
				return ret.err
			}
			return nil
		}
		if conf.QueryAllServers {
			wg.Add(1)
			go doRequest(i)
		} else {
			err = doRequest(i)
			if err == nil {
				break
			}
		}
	}
	if conf.QueryAllServers {
		wg.Wait()
	}
	// Good by default
	var ret *ocspStatus
	ocspRes := ocspResponses[0]
	var firstError error
	for i := range ocspHosts {
		if errors[i] != nil {
			if IsOcspVerificationError(errors[i]) {
				return nil, errors[i]
			}
			if firstError == nil {
				firstError = errors[i]
			}
		} else if ocspStatuses[i] != nil {
			switch ocspStatuses[i].code {
			case ocspStatusRevoked:
				ret = ocspStatuses[i]
				ocspRes = ocspResponses[i]
				break
			case ocspStatusGood:
				// Use this response only if we don't have a status already, or if what we have was unknown
				if ret == nil || ret.code == ocspStatusUnknown {
					ret = ocspStatuses[i]
					ocspRes = ocspResponses[i]
				}
			case ocspStatusUnknown:
				if ret == nil {
					// We may want to use this as the overall result
					ret = ocspStatuses[i]
					ocspRes = ocspResponses[i]
				}
			}
		}
	}

	// If querying all servers is enabled, and we have an error from a host, we can't trust
	// a good status from the other as we can't confirm the other server would have returned the
	// same response, we do allow revoke responses through
	if conf.QueryAllServers && firstError != nil && (ret != nil && ret.code == ocspStatusGood) {
		return nil, fmt.Errorf("encountered an error on a server, "+
			"ignoring good response status as ocsp_query_all_servers is set to true: %w", firstError)
	}

	// If no server reported the cert revoked, but we did have an error, report it
	if (ret == nil || ret.code == ocspStatusUnknown) && firstError != nil {
		return nil, firstError
	}
	// An extra safety in case ret and firstError are both nil
	if ret == nil {
		return nil, fmt.Errorf("failed to extract a known response code or error from the OCSP server")
	}

	// otherwise ret should contain a response for the overall request
	if !isValidOCSPStatus(ret.code) {
		return ret, nil
	}

	if ocspRes.NextUpdate.IsZero() {
		// We should not cache values with no NextUpdate values
		return ret, nil
	}

	v := ocspCachedResponse{
		status:     ret.code,
		time:       float64(time.Now().UTC().Unix()),
		producedAt: float64(ocspRes.ProducedAt.UTC().Unix()),
		thisUpdate: float64(ocspRes.ThisUpdate.UTC().Unix()),
		nextUpdate: float64(ocspRes.NextUpdate.UTC().Unix()),
	}

	c.ocspResponseCacheLock.Lock()
	c.ocspResponseCache.Add(*encodedCertID, &v)
	c.cacheUpdated = true
	c.ocspResponseCacheLock.Unlock()
	return ret, nil
}

func isValidOCSPStatus(status ocspStatusCode) bool {
	return status == ocspStatusGood || status == ocspStatusRevoked || status == ocspStatusUnknown
}

type VerifyConfig struct {
	OcspEnabled          bool
	ExtraCas             []*x509.Certificate
	OcspServersOverride  []string
	OcspFailureMode      FailOpenMode
	QueryAllServers      bool
	OcspThisUpdateMaxAge time.Duration
	OcspMaxRetries       int
}

// VerifyLeafCertificate verifies just the subject against it's direct issuer
func (c *Client) VerifyLeafCertificate(ctx context.Context, subject, issuer *x509.Certificate, conf *VerifyConfig) error {
	results, err := c.GetRevocationStatus(ctx, subject, issuer, conf)
	if err != nil {
		return err
	}
	if results.code == ocspStatusGood {
		return nil
	} else {
		serial := subject.SerialNumber
		serialHex := strings.TrimSpace(certutil.GetHexFormatted(serial.Bytes(), ":"))
		if results.code == ocspStatusRevoked {
			return fmt.Errorf("certificate with serial number %s has been revoked", serialHex)
		} else if conf.OcspFailureMode == FailOpenFalse {
			return fmt.Errorf("unknown OCSP status for cert with serial number %s", serialHex)
		} else {
			c.Logger().Warn("could not validate OCSP status for cert, but continuing in fail open mode", "serial", serialHex)
		}
	}
	return nil
}

// VerifyPeerCertificate verifies all of certificate revocation status
func (c *Client) VerifyPeerCertificate(ctx context.Context, verifiedChains [][]*x509.Certificate, conf *VerifyConfig) error {
	for i := 0; i < len(verifiedChains); i++ {
		// Certificate signed by Root CA. This should be one before the last in the Certificate Chain
		numberOfNoneRootCerts := len(verifiedChains[i]) - 1
		if !verifiedChains[i][numberOfNoneRootCerts].IsCA || string(verifiedChains[i][numberOfNoneRootCerts].RawIssuer) != string(verifiedChains[i][numberOfNoneRootCerts].RawSubject) {
			// Check if the last Non Root Cert is also a CA or is self signed.
			// if the last certificate is not, add it to the list
			rca := c.caRoot[string(verifiedChains[i][numberOfNoneRootCerts].RawIssuer)]
			if rca == nil {
				return fmt.Errorf("failed to find root CA. pkix.name: %v", verifiedChains[i][numberOfNoneRootCerts].Issuer)
			}
			verifiedChains[i] = append(verifiedChains[i], rca)
			numberOfNoneRootCerts++
		}
		results, err := c.GetAllRevocationStatus(ctx, verifiedChains[i], conf)
		if err != nil {
			return err
		}
		if r := c.canEarlyExitForOCSP(results, numberOfNoneRootCerts, conf); r != nil {
			return r.err
		}
	}

	return nil
}

func (c *Client) canEarlyExitForOCSP(results []*ocspStatus, chainSize int, conf *VerifyConfig) *ocspStatus {
	msg := ""
	if conf.OcspFailureMode == FailOpenFalse {
		// Fail closed. any error is returned to stop connection
		for _, r := range results {
			if r.err != nil {
				return r
			}
		}
	} else {
		// Fail open and all results are valid.
		allValid := len(results) == chainSize
		for _, r := range results {
			if !isValidOCSPStatus(r.code) {
				allValid = false
				break
			}
		}
		for _, r := range results {
			if allValid && r.code == ocspStatusRevoked {
				return r
			}
			if r != nil && r.code != ocspStatusGood && r.err != nil {
				msg += "" + r.err.Error()
			}
		}
	}
	if len(msg) > 0 {
		c.Logger().Warn(
			"OCSP is set to fail-open, and could not retrieve OCSP based revocation checking but proceeding.", "detail", msg)
	}
	return nil
}

func (c *Client) validateWithCacheForAllCertificates(verifiedChains []*x509.Certificate, config *VerifyConfig) (bool, error) {
	n := len(verifiedChains) - 1
	for j := 0; j < n; j++ {
		subject := verifiedChains[j]
		issuer := verifiedChains[j+1]
		status, _, _, err := c.validateWithCache(subject, issuer, config)
		if err != nil {
			return false, err
		}
		if !isValidOCSPStatus(status.code) {
			return false, nil
		}
	}
	return true, nil
}

func (c *Client) validateWithCache(subject, issuer *x509.Certificate, config *VerifyConfig) (*ocspStatus, []byte, *certIDKey, error) {
	ocspReq, err := ocsp.CreateRequest(subject, issuer, &ocsp.RequestOptions{})
	if err != nil {
		return nil, nil, nil, fmt.Errorf("failed to create OCSP request from the certificates: %v", err)
	}
	encodedCertID, ocspS := extractCertIDKeyFromRequest(ocspReq)
	if ocspS.code != ocspSuccess {
		return nil, nil, nil, fmt.Errorf("failed to extract CertID from OCSP Request: %v", err)
	}
	status, err := c.checkOCSPResponseCache(encodedCertID, subject, issuer, config)
	if err != nil {
		return nil, nil, nil, err
	}
	return status, ocspReq, encodedCertID, nil
}

func (c *Client) GetAllRevocationStatus(ctx context.Context, verifiedChains []*x509.Certificate, conf *VerifyConfig) ([]*ocspStatus, error) {
	_, err := c.validateWithCacheForAllCertificates(verifiedChains, conf)
	if err != nil {
		return nil, err
	}
	n := len(verifiedChains) - 1
	results := make([]*ocspStatus, n)
	for j := 0; j < n; j++ {
		results[j], err = c.GetRevocationStatus(ctx, verifiedChains[j], verifiedChains[j+1], conf)
		if err != nil {
			return nil, err
		}
		if !isValidOCSPStatus(results[j].code) {
			return results, nil
		}
	}
	return results, nil
}

// verifyPeerCertificateSerial verifies the certificate revocation status in serial.
func (c *Client) verifyPeerCertificateSerial(conf *VerifyConfig) func(_ [][]byte, verifiedChains [][]*x509.Certificate) (err error) {
	return func(_ [][]byte, verifiedChains [][]*x509.Certificate) error {
		return c.VerifyPeerCertificate(context.TODO(), verifiedChains, conf)
	}
}

func (c *Client) extractOCSPCacheResponseValueWithoutSubject(cacheValue ocspCachedResponse, conf *VerifyConfig) (*ocspStatus, error) {
	return c.extractOCSPCacheResponseValue(&cacheValue, nil, nil, conf)
}

func (c *Client) extractOCSPCacheResponseValue(cacheValue *ocspCachedResponse, subject, issuer *x509.Certificate, conf *VerifyConfig) (*ocspStatus, error) {
	subjectName := "Unknown"
	if subject != nil {
		subjectName = subject.Subject.CommonName
	}

	curTime := time.Now()
	if cacheValue == nil {
		return &ocspStatus{
			code: ocspMissedCache,
			err:  fmt.Errorf("miss cache data. subject: %v", subjectName),
		}, nil
	}
	currentTime := float64(curTime.UTC().Unix())
	if currentTime-cacheValue.time >= cacheExpire {
		return &ocspStatus{
			code: ocspCacheExpired,
			err: fmt.Errorf("cache expired. current: %v, cache: %v",
				time.Unix(int64(currentTime), 0).UTC(), time.Unix(int64(cacheValue.time), 0).UTC()),
		}, nil
	}

	sdkOcspStatus := internalStatusCodeToSDK(cacheValue.status)

	return validateOCSP(conf, &ocsp.Response{
		ProducedAt: time.Unix(int64(cacheValue.producedAt), 0).UTC(),
		ThisUpdate: time.Unix(int64(cacheValue.thisUpdate), 0).UTC(),
		NextUpdate: time.Unix(int64(cacheValue.nextUpdate), 0).UTC(),
		Status:     sdkOcspStatus,
	})
}

func internalStatusCodeToSDK(internalStatusCode ocspStatusCode) int {
	switch internalStatusCode {
	case ocspStatusGood:
		return ocsp.Good
	case ocspStatusRevoked:
		return ocsp.Revoked
	case ocspStatusUnknown:
		return ocsp.Unknown
	default:
		return int(internalStatusCode)
	}
}

/*
// writeOCSPCache writes a OCSP Response cache
func (c *Client) writeOCSPCache(ctx context.Context, storage logical.Storage) error {
	c.Logger().Debug("writing OCSP Response cache")
	t := time.Now()
	m := make(map[string][]interface{})
	keys := c.ocspResponseCache.Keys()
	if len(keys) > persistedCacheSize {
		keys = keys[:persistedCacheSize]
	}
	for _, k := range keys {
		e, ok := c.ocspResponseCache.Get(k)
		if ok {
			entry := e.(*ocspCachedResponse)
			// Don't store if expired
			if isInValidityRange(t, time.Unix(int64(entry.thisUpdate), 0), time.Unix(int64(entry.nextUpdate), 0)) {
				key := k.(certIDKey)
				cacheKeyInBase64, err := decodeCertIDKey(&key)
				if err != nil {
					return err
				}
				m[cacheKeyInBase64] = []interface{}{entry.status, entry.time, entry.producedAt, entry.thisUpdate, entry.nextUpdate}
			}
		}
	}

	v, err := jsonutil.EncodeJSONAndCompress(m, nil)
	if err != nil {
		return err
	}
	entry := logical.StorageEntry{
		Key:   ocspCacheKey,
		Value: v,
	}
	return storage.Put(ctx, &entry)
}

// readOCSPCache reads a OCSP Response cache from storage
func (c *Client) readOCSPCache(ctx context.Context, storage logical.Storage) error {
	c.Logger().Debug("reading OCSP Response cache")

	entry, err := storage.Get(ctx, ocspCacheKey)
	if err != nil {
		return err
	}
	if entry == nil {
		return nil
	}
	var untypedCache map[string][]interface{}

	err = jsonutil.DecodeJSON(entry.Value, &untypedCache)
	if err != nil {
		return errors.New("failed to unmarshal OCSP cache")
	}

	for k, v := range untypedCache {
		key, err := c.encodeCertIDKey(k)
		if err != nil {
			return err
		}
		var times [4]float64
		for i, t := range v[1:] {
			if jn, ok := t.(json.Number); ok {
				times[i], err = jn.Float64()
				if err != nil {
					return err
				}
			} else {
				times[i] = t.(float64)
			}
		}
		var status int
		if jn, ok := v[0].(json.Number); ok {
			s, err := jn.Int64()
			if err != nil {
				return err
			}
			status = int(s)
		} else {
			status = v[0].(int)
		}

		c.ocspResponseCache.Add(*key, &ocspCachedResponse{
			status:     ocspStatusCode(status),
			time:       times[0],
			producedAt: times[1],
			thisUpdate: times[2],
			nextUpdate: times[3],
		})
	}

	return nil
}
*/

func New(logFactory func() hclog.Logger, cacheSize int) *Client {
	if cacheSize < 100 {
		cacheSize = 100
	}
	cache, _ := lru.New2Q(cacheSize)
	c := Client{
		caRoot:            make(map[string]*x509.Certificate),
		ocspResponseCache: cache,
		logFactory:        logFactory,
	}

	return &c
}

func (c *Client) Logger() hclog.Logger {
	return c.logFactory()
}

// insecureOcspTransport is the transport object that doesn't do certificate revocation check.
func newInsecureOcspTransport(extraCas []*x509.Certificate) *http.Transport {
	// Get the SystemCertPool, continue with an empty pool on error
	rootCAs, _ := x509.SystemCertPool()
	if rootCAs == nil {
		rootCAs = x509.NewCertPool()
	}
	for _, c := range extraCas {
		rootCAs.AddCert(c)
	}
	config := &tls.Config{
		RootCAs: rootCAs,
	}
	return &http.Transport{
		MaxIdleConns:    10,
		IdleConnTimeout: 30 * time.Minute,
		Proxy:           http.ProxyFromEnvironment,
		DialContext: (&net.Dialer{
			Timeout:   30 * time.Second,
			KeepAlive: 30 * time.Second,
		}).DialContext,
		TLSClientConfig: config,
	}
}

// NewTransport includes the certificate revocation check with OCSP in sequential.
func (c *Client) NewTransport(conf *VerifyConfig) *http.Transport {
	rootCAs := c.certPool
	if rootCAs == nil {
		rootCAs, _ = x509.SystemCertPool()
	}
	if rootCAs == nil {
		rootCAs = x509.NewCertPool()
	}
	for _, c := range conf.ExtraCas {
		rootCAs.AddCert(c)
	}
	return &http.Transport{
		TLSClientConfig: &tls.Config{
			RootCAs:               rootCAs,
			VerifyPeerCertificate: c.verifyPeerCertificateSerial(conf),
		},
		MaxIdleConns:    10,
		IdleConnTimeout: 30 * time.Minute,
		Proxy:           http.ProxyFromEnvironment,
		DialContext: (&net.Dialer{
			Timeout:   30 * time.Second,
			KeepAlive: 30 * time.Second,
		}).DialContext,
	}
}

/*
func (c *Client) WriteCache(ctx context.Context, storage logical.Storage) error {
	c.ocspResponseCacheLock.Lock()
	defer c.ocspResponseCacheLock.Unlock()
	if c.cacheUpdated {
		err := c.writeOCSPCache(ctx, storage)
		if err == nil {
			c.cacheUpdated = false
		}
		return err
	}
	return nil
}

func (c *Client) ReadCache(ctx context.Context, storage logical.Storage) error {
	c.ocspResponseCacheLock.Lock()
	defer c.ocspResponseCacheLock.Unlock()
	return c.readOCSPCache(ctx, storage)
}
*/
/*
                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "{}"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright (c) 2017-2022 Snowflake Computing Inc. 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.
*/