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
|
// Copyright 2019 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 submission
import (
"context"
"fmt"
"sync"
"time"
"github.com/google/certificate-transparency-go/schedule"
"github.com/google/trillian/monitoring"
)
var (
logRefOnce sync.Once
logListLastRefresh monitoring.Gauge // Unix time
)
// logRefInitMetrics initializes all the exported metrics.
func logRefInitMetrics(ctx context.Context, mf monitoring.MetricFactory) {
logListLastRefresh = mf.NewGauge("log_list_last_refresh", "Unix timestamp for last successful Log-list refresh")
}
// LogListManager runs loglist updates and keeps two latest versions of Log
// list.
type LogListManager struct {
Errors chan error
LLUpdates chan LogListData
llRefreshInterval time.Duration
llr LogListRefresher
latestLL *LogListData
previousLL *LogListData
mu sync.Mutex // guards latestLL and previousLL
mtf monitoring.MetricFactory
}
// NewLogListManager creates and inits a LogListManager instance.
func NewLogListManager(llr LogListRefresher, mf monitoring.MetricFactory) *LogListManager {
if mf == nil {
mf = monitoring.InertMetricFactory{}
}
return &LogListManager{
Errors: make(chan error, 1),
LLUpdates: make(chan LogListData, 1),
llr: llr,
mtf: mf,
}
}
// Run starts regular LogList checks and associated versions archiving.
// Emits errors and Loglist-updates into its corresponding channels, expected
// to have readers listening.
func (llm *LogListManager) Run(ctx context.Context, llRefresh time.Duration) {
llm.llRefreshInterval = llRefresh
logRefOnce.Do(func() { logRefInitMetrics(ctx, llm.mtf) })
go schedule.Every(ctx, llm.llRefreshInterval, llm.refreshLogListAndNotify)
}
// refreshLogListAndNotify runs single Log-list refresh and propagates data and
// errors to corresponding channels
func (llm *LogListManager) refreshLogListAndNotify(ctx context.Context) {
if lld, err := llm.RefreshLogList(ctx); err != nil {
llm.Errors <- err
} else if lld != nil {
llm.LLUpdates <- llm.ProduceClientLogList()
}
}
// GetTwoLatestLogLists returns last version of Log list and a previous one.
func (llm *LogListManager) GetTwoLatestLogLists() (*LogListData, *LogListData) {
llm.mu.Lock()
defer llm.mu.Unlock()
return llm.latestLL, llm.previousLL
}
// RefreshLogList reads Log List one time and runs updates if necessary.
func (llm *LogListManager) RefreshLogList(ctx context.Context) (*LogListData, error) {
if llm.llr == nil {
return nil, fmt.Errorf("the LogListManager has no LogListRefresher")
}
ll, err := llm.llr.Refresh()
if err != nil {
return nil, err
}
logListLastRefresh.Set(float64(time.Now().Unix()))
if ll == nil {
// No updates
return nil, nil
}
llm.mu.Lock()
defer llm.mu.Unlock()
llm.previousLL = llm.latestLL
llm.latestLL = ll
return llm.latestLL, nil
}
// ProduceClientLogList applies client filtration on Log list.
func (llm *LogListManager) ProduceClientLogList() LogListData {
// TODO(Mercurrent): Add filtration
clientLL := *(llm.latestLL)
return clientLL
}
// Source exposes internal Log list path.
func (llm *LogListManager) Source() string {
return llm.llr.Source()
}
// LastJSON returns last version of Log list in JSON.
func (llm *LogListManager) LastJSON() []byte {
return llm.llr.LastJSON()
}
|