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
|
// Copyright The Notary Project 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 crl
import (
"context"
"errors"
"fmt"
"os"
"sync"
corecrl "github.com/notaryproject/notation-core-go/revocation/crl"
"github.com/notaryproject/notation-go/log"
)
// CacheWithLog implements corecrl.Cache with logging
type CacheWithLog struct {
corecrl.Cache
//DiscardCacheError is set to true to enable logging the discard cache error
//warning
DiscardCacheError bool
// logDiscardCrlCacheErrorOnce guarantees the discard cache error
// warning is logged only once
logDiscardCrlCacheErrorOnce sync.Once
}
// Get retrieves the CRL bundle with the given url
func (c *CacheWithLog) Get(ctx context.Context, url string) (*corecrl.Bundle, error) {
if c.Cache == nil {
return nil, errors.New("cache cannot be nil")
}
logger := log.GetLogger(ctx)
bundle, err := c.Cache.Get(ctx, url)
if err != nil && !errors.Is(err, corecrl.ErrCacheMiss) {
if c.DiscardCacheError {
c.logDiscardCrlCacheErrorOnce.Do(c.logDiscardCrlCacheError)
}
logger.Debug(err.Error())
return nil, err
}
return bundle, err
}
// Set stores the CRL bundle with the given url
func (c *CacheWithLog) Set(ctx context.Context, url string, bundle *corecrl.Bundle) error {
if c.Cache == nil {
return errors.New("cache cannot be nil")
}
logger := log.GetLogger(ctx)
err := c.Cache.Set(ctx, url, bundle)
if err != nil {
if c.DiscardCacheError {
c.logDiscardCrlCacheErrorOnce.Do(c.logDiscardCrlCacheError)
}
logger.Debug(err.Error())
return err
}
return nil
}
// logDiscardCrlCacheError logs the warning when CRL cache error is
// discarded
func (c *CacheWithLog) logDiscardCrlCacheError() {
fmt.Fprintln(os.Stderr, "Warning: CRL cache error discarded. Enable debug log through '-d' for error details.")
}
|