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
|
// Copyright 2024 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 cache defines the IssuanceChainCache type, which allows different cache implementation with Get and Set operations.
package cache
import (
"context"
"errors"
"time"
"github.com/google/certificate-transparency-go/trillian/ctfe/cache/lru"
"github.com/google/certificate-transparency-go/trillian/ctfe/cache/noop"
)
// Type represents the cache type.
type Type string
// Type constants for the cache type.
const (
Unknown Type = ""
NOOP Type = "noop"
LRU Type = "lru"
)
// Option represents the cache option, which includes the cache size and time-to-live.
type Option struct {
Size int
TTL time.Duration
}
// IssuanceChainCache is an interface which allows CTFE binaries to use different cache implementations for issuance chains.
type IssuanceChainCache interface {
// Get returns the issuance chain associated with the provided hash.
Get(ctx context.Context, key []byte) ([]byte, error)
// Set inserts the key-value pair of issuance chain.
Set(ctx context.Context, key []byte, chain []byte) error
}
// NewIssuanceChainCache returns noop.IssuanceChainCache for noop type or lru.IssuanceChainCache for lru cache type.
func NewIssuanceChainCache(_ context.Context, cacheType Type, option Option) (IssuanceChainCache, error) {
switch cacheType {
case Unknown, NOOP:
return &noop.IssuanceChainCache{}, nil
case LRU:
if option.Size < 0 {
return nil, errors.New("invalid cache_size flag")
}
if option.TTL < 0*time.Second {
return nil, errors.New("invalid cache_ttl flag")
}
return lru.NewIssuanceChainCache(lru.CacheOption{Size: option.Size, TTL: option.TTL}), nil
}
return nil, errors.New("invalid cache_type flag")
}
|