File: submit.go

package info (click to toggle)
sigsum-go 0.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,076 kB
  • sloc: sh: 809; makefile: 93
file content (278 lines) | stat: -rw-r--r-- 8,685 bytes parent folder | download | duplicates (6)
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
// package submit acts as a sigsum submit client It submits a leaf to a log, and
// collects a sigsum proof.
package submit

import (
	"context"
	"fmt"
	"net/http"
	"time"

	"sigsum.org/sigsum-go/pkg/api"
	"sigsum.org/sigsum-go/pkg/client"
	"sigsum.org/sigsum-go/pkg/crypto"
	"sigsum.org/sigsum-go/pkg/log"
	"sigsum.org/sigsum-go/pkg/policy"
	"sigsum.org/sigsum-go/pkg/proof"
	"sigsum.org/sigsum-go/pkg/requests"
	token "sigsum.org/sigsum-go/pkg/submit-token"
	"sigsum.org/sigsum-go/pkg/types"
)

const (
	DefaultTimeout = 10 * time.Minute

	defaultPollDelay      = 2 * time.Second
	defaultRequestTimeout = 30 * time.Second
	defaultUserAgent      = "sigsum-go submit"
)

type Config struct {
	// Domain and signer to use for rate limit sigsum-token: header.
	Domain          string
	RateLimitSigner crypto.Signer

	// Timeout is the time before giving up on all submissions.  Zero implies a
	// default timeout is used.
	Timeout time.Duration

	// RequestTimeout is the time before giving up on a particular request,
	// e.g., adding a leaf or collecting its proof.  Zero implies a default
	// timeout is used.
	RequestTimeout time.Duration

	// Delay when repeating add-leaf requests to the log, as well as for polling
	// for a cosigned tree head and inclusion proof.
	PollDelay time.Duration

	UserAgent string

	// The policy specifies the logs and witnesses to use.
	Policy *policy.Policy

	// HTTPClient specifies the HTTP client to use when making requests to the
	// log.  If nil, a default client is created.
	HTTPClient *http.Client
}

func (c *Config) getPollDelay() time.Duration {
	if c.PollDelay <= 0 {
		return defaultPollDelay
	}
	return c.PollDelay
}

func (c *Config) getGlobalTimeout() time.Duration {
	if c.Timeout <= 0 {
		return DefaultTimeout
	}
	return c.Timeout
}

func (c *Config) getRequestTimeout() time.Duration {
	if c.RequestTimeout <= 0 {
		return defaultRequestTimeout
	}
	return c.RequestTimeout
}

func (c *Config) getUserAgent() string {
	if len(c.UserAgent) == 0 {
		return defaultUserAgent
	}
	return c.UserAgent
}

// Sleep for the given delay, but fail early if the context is cancelled.
func sleepWithContext(ctx context.Context, d time.Duration) error {
	timer := time.NewTimer(d)
	defer timer.Stop()

	select {
	case <-timer.C:
		return nil
	case <-ctx.Done():
		return ctx.Err()
	}
}

func (c *Config) sleep(ctx context.Context) error {
	return sleepWithContext(ctx, c.getPollDelay())
}

func SubmitMessage(ctx context.Context, config *Config, signer crypto.Signer, message *crypto.Hash) (proof.SigsumProof, error) {
	signature, err := types.SignLeafMessage(signer, message[:])
	if err != nil {
		return proof.SigsumProof{}, err
	}
	proofs, err := SubmitLeafRequests(ctx, config, []requests.Leaf{requests.Leaf{
		Message:   *message,
		Signature: signature,
		PublicKey: signer.Public(),
	}})
	if err != nil {
		return proof.SigsumProof{}, err
	}
	return proofs[0], nil
}

// SubmitLeafRequests ensures that the given requests are logged in any log with
// sufficient amounts of witnessing (based on config.Policy).  The collected
// proofs of logging are returned in the same order as the input requests.
func SubmitLeafRequests(ctx context.Context, config *Config, reqs []requests.Leaf) ([]proof.SigsumProof, error) {
	logs, err := logClientsFromConfig(config)
	if err != nil {
		return nil, err
	}
	sctx, cancel := context.WithTimeout(ctx, config.getGlobalTimeout())
	defer cancel()
	submissions, err := submitLeaves(sctx, config.getRequestTimeout(), logs, reqs)
	if err != nil {
		return nil, err
	}
	return collectProofs(sctx, config.getRequestTimeout(), config.sleep, config.Policy, submissions)
}

type pendingSubmission struct {
	log       *logClient      // which log
	request   requests.Leaf   // which request
	leafHash  crypto.Hash     // expected leaf hash
	shortLeaf proof.ShortLeaf // leaf without checksum
}

type logClient struct {
	entity policy.Entity
	client api.Log
	header *token.SubmitHeader
}

func logClientsFromConfig(config *Config) ([]logClient, error) {
	var logs []logClient
	for _, entity := range config.Policy.GetLogsWithUrl() {
		var header *token.SubmitHeader
		if config.RateLimitSigner != nil && len(config.Domain) > 0 {
			signature, err := token.MakeToken(config.RateLimitSigner, &entity.PublicKey)
			if err != nil {
				return nil, fmt.Errorf("creating submit token failed: %v", err)
			}
			header = &token.SubmitHeader{Domain: config.Domain, Token: signature}
		}
		client := client.New(client.Config{
			UserAgent:  config.getUserAgent(),
			URL:        entity.URL,
			HTTPClient: config.HTTPClient,
		})
		logs = append(logs, logClient{entity, client, header})
	}
	if len(logs) == 0 {
		return nil, fmt.Errorf("no logs defined in policy")
	}
	return logs, nil
}

// submitLeaves ensures we get HTTP status 2XX for each of the signed checksums.
// Use collectProofs() to ensure these 2XX responses transition into 200 OK with
// appropriate proofs of logging.
//
// Note: by ensuring that some log says it will take each signed checksum and
// then collecting the proofs, we don't wait as much for tree heads to rotate.
func submitLeaves(ctx context.Context, timeout time.Duration, logs []logClient, reqs []requests.Leaf) ([]pendingSubmission, error) {
	var submissions []pendingSubmission
	for i, req := range reqs {
		leaf, err := req.Verify()
		if err != nil {
			return nil, fmt.Errorf("verifying leaf request failed: %v", err)
		}

		for _, lc := range logs {
			if err = ctx.Err(); err != nil {
				return nil, err
			}

			log.Info("Attempting to submit checksum#%d to log: %s", i+1, lc.entity.URL)
			if err = submitLeaf(ctx, timeout, lc, req); err != nil {
				log.Error("Submitting to log %q failed: %v", lc.entity.URL, err)
				continue
			}

			submissions = append(submissions, pendingSubmission{
				log:       &lc,
				request:   req,
				leafHash:  leaf.ToHash(),
				shortLeaf: proof.NewShortLeaf(&leaf),
			})
			break
		}
		if err != nil {
			return nil, fmt.Errorf("all logs failed, giving up")
		}
	}
	return submissions, nil
}

func submitLeaf(ctx context.Context, timeout time.Duration, lc logClient, req requests.Leaf) error {
	sctx, cancel := context.WithTimeout(ctx, timeout)
	defer cancel()
	_, err := lc.client.AddLeaf(sctx, req, lc.header)
	return err // nil on HTTP status 2XX responses
}

// collectProofs ensures the pending submissions transition from HTTP status 2XX
// to HTTP status 200 OK in the respective logs. Proofs are then collected.
func collectProofs(ctx context.Context, timeout time.Duration, sleep func(ctx context.Context) error, policy *policy.Policy, submissions []pendingSubmission) ([]proof.SigsumProof, error) {
	var proofs []proof.SigsumProof
	for i, submission := range submissions {
		for {
			log.Info("Attempting to retrieve proof for checksum#%d", i+1)
			pr, err := collectProof(ctx, timeout, policy, submission)
			if err != nil {
				return nil, err
			}
			if pr != nil {
				proofs = append(proofs, *pr)
				break
			}
			if errInner := sleep(ctx); errInner != nil {
				return nil, errInner
			}
		}
	}
	return proofs, nil
}

// collectProof returns (non-nil, nil) when a proof was collected successfully.
// Returns an error if it seems unlikely that trying again will help.
func collectProof(ctx context.Context, timeout time.Duration, policy *policy.Policy, submission pendingSubmission) (*proof.SigsumProof, error) {
	sctx, cancel := context.WithTimeout(ctx, timeout)
	defer cancel()
	pr := proof.SigsumProof{
		LogKeyHash: crypto.HashBytes(submission.log.entity.PublicKey[:]),
		Leaf:       submission.shortLeaf,
	}
	persisted, err := submission.log.client.AddLeaf(sctx, submission.request, submission.log.header)
	if err != nil {
		log.Debug("Checking that checksum was accepted: %v", err)
		return nil, nil // continue trying
	}
	if !persisted {
		log.Debug("Checking that checksum was sequenced: not yet")
		return nil, nil // continue trying
	}
	if pr.TreeHead, err = submission.log.client.GetTreeHead(sctx); err != nil {
		log.Debug("Getting latest tree head: %v", err)
		return nil, nil // continue trying
	}
	if err := policy.VerifyCosignedTreeHead(&pr.LogKeyHash, &pr.TreeHead); err != nil {
		log.Info("Verifying latest tree head: %v", err)
		return nil, nil // continue trying
	}
	req := requests.InclusionProof{Size: pr.TreeHead.Size, LeafHash: submission.leafHash}
	if pr.Inclusion, err = submission.log.client.GetInclusionProof(sctx, req); err != nil {
		log.Debug("Getting inclusion proof: %v", err)
		return nil, nil // continue trying
	}
	if err = pr.Inclusion.Verify(&submission.leafHash, &pr.TreeHead.TreeHead); err != nil {
		return nil, fmt.Errorf("Inclusion proof invalid: %v", err)
	}
	return &pr, nil
}