aboutsummaryrefslogtreecommitdiff
path: root/instance_test.go
blob: 0ceedb8ab3b44c539a6bea52c78f42839dbd133c (plain)
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
package stfe

import (
	"bytes"
	"testing"
	"time"

	"crypto"
	"crypto/ed25519"

	"github.com/system-transparency/stfe/namespace"
	"github.com/system-transparency/stfe/namespace/testdata"
)

var (
	testLogId          = append([]byte{0x00, 0x01, 0x20}, testdata.Ed25519Vk3...)
	testTreeId         = int64(0)
	testMaxRange       = int64(3)
	testPrefix         = "test"
	testHashType       = crypto.SHA256
	testSignature      = make([]byte, 32)
	testNodeHash       = make([]byte, 32)
	testMessage        = []byte("test message")
	testPackage        = []byte("foobar")
	testChecksum       = make([]byte, 32)
	testTreeSize       = uint64(128)
	testTreeSizeLarger = uint64(256)
	testTimestamp      = uint64(0)
	testProof          = [][]byte{
		testNodeHash,
		testNodeHash,
	}
	testIndex    = uint64(0)
	testHashLen  = 31
	testDeadline = time.Second * 5
	testInterval = time.Second * 10
)

// TestNewLogParamters checks that invalid ones are rejected and that a valid
// set of parameters are accepted.
func TestNewLogParameters(t *testing.T) {
	testLogId := mustNewNamespaceEd25519V1(t, testdata.Ed25519Vk3)
	namespaces := mustNewNamespacePool(t, []*namespace.Namespace{
		mustNewNamespaceEd25519V1(t, testdata.Ed25519Vk),
	})
	witnesses := mustNewNamespacePool(t, []*namespace.Namespace{})
	signer := ed25519.PrivateKey(testdata.Ed25519Sk)
	for _, table := range []struct {
		description string
		logId       *namespace.Namespace
		maxRange    int64
		signer      crypto.Signer
		wantErr     bool
	}{
		{
			description: "invalid signer: nil",
			logId:       testLogId,
			maxRange:    testMaxRange,
			signer:      nil,
			wantErr:     true,
		},
		{
			description: "invalid max range",
			logId:       testLogId,
			maxRange:    0,
			signer:      signer,
			wantErr:     true,
		},
		{
			description: "invalid log identifier",
			logId: &namespace.Namespace{
				Format: namespace.NamespaceFormatEd25519V1,
				NamespaceEd25519V1: &namespace.NamespaceEd25519V1{
					Namespace: make([]byte, 31), // too short
				},
			},
			maxRange: testMaxRange,
			signer:   signer,
			wantErr:  true,
		},
		{
			description: "valid log parameters",
			logId:       testLogId,
			maxRange:    testMaxRange,
			signer:      signer,
		},
	} {
		lp, err := NewLogParameters(table.signer, table.logId, testTreeId, testPrefix, namespaces, witnesses, table.maxRange, testInterval, testDeadline)
		if got, want := err != nil, table.wantErr; got != want {
			t.Errorf("got error=%v but wanted %v in test %q: %v", got, want, table.description, err)
		}
		if err != nil {
			continue
		}
		lid, err := table.logId.Marshal()
		if err != nil {
			t.Fatalf("must marshal log id: %v", err)
		}

		if got, want := lp.LogId, lid; !bytes.Equal(got, want) {
			t.Errorf("got log id %X but wanted %X in test %q", got, want, table.description)
		}
		if got, want := lp.TreeId, testTreeId; got != want {
			t.Errorf("got tree id %d but wanted %d in test %q", got, want, table.description)
		}
		if got, want := lp.Prefix, testPrefix; got != want {
			t.Errorf("got prefix %s but wanted %s in test %q", got, want, table.description)
		}
		if got, want := lp.MaxRange, testMaxRange; got != want {
			t.Errorf("got max range %d but wanted %d in test %q", got, want, table.description)
		}
		if got, want := len(lp.Submitters.List()), len(namespaces.List()); got != want {
			t.Errorf("got %d anchors but wanted %d in test %q", got, want, table.description)
		}
		if got, want := len(lp.Witnesses.List()), len(witnesses.List()); got != want {
			t.Errorf("got %d anchors but wanted %d in test %q", got, want, table.description)
		}
	}
}

// TestHandlers checks that we configured all endpoints and that there are no
// unexpected ones.
func TestHandlers(t *testing.T) {
	endpoints := map[Endpoint]bool{
		EndpointAddEntry:            false,
		EndpointGetEntries:          false,
		EndpointGetLatestSth:        false,
		EndpointGetProofByHash:      false,
		EndpointGetConsistencyProof: false,
		EndpointGetAnchors:          false,
		EndpointGetStableSth:        false,
		EndpointGetCosignedSth:      false,
		EndpointAddCosignature:      false,
	}
	i := NewInstance(makeTestLogParameters(t, nil), nil, nil)
	for _, handler := range i.Handlers() {
		if _, ok := endpoints[handler.endpoint]; !ok {
			t.Errorf("got unexpected endpoint: %s", handler.endpoint)
		}
		endpoints[handler.endpoint] = true
	}
	for endpoint, ok := range endpoints {
		if !ok {
			t.Errorf("endpoint %s is not configured", endpoint)
		}
	}
}

// TestEndpointPath checks that the endpoint path builder works as expected
func TestEndpointPath(t *testing.T) {
	base, prefix := "http://example.com", "test"
	for _, table := range []struct {
		endpoint Endpoint
		want     string
	}{
		{
			endpoint: EndpointAddEntry,
			want:     "http://example.com/test/add-entry",
		},
		{
			endpoint: EndpointGetEntries,
			want:     "http://example.com/test/get-entries",
		},
		{
			endpoint: EndpointGetProofByHash,
			want:     "http://example.com/test/get-proof-by-hash",
		},
		{
			endpoint: EndpointGetConsistencyProof,
			want:     "http://example.com/test/get-consistency-proof",
		},
		{
			endpoint: EndpointGetLatestSth,
			want:     "http://example.com/test/get-latest-sth",
		},
		{
			endpoint: EndpointGetAnchors,
			want:     "http://example.com/test/get-anchors",
		},
		{
			endpoint: EndpointGetStableSth,
			want:     "http://example.com/test/get-stable-sth",
		},
		{
			endpoint: EndpointGetCosignedSth,
			want:     "http://example.com/test/get-cosigned-sth",
		},
		{
			endpoint: EndpointAddCosignature,
			want:     "http://example.com/test/add-cosignature",
		},
	} {
		if got, want := table.endpoint.Path(base, prefix), table.want; got != want {
			t.Errorf("got %s but wanted %s with multiple components", got, want)
		}
		if got, want := table.endpoint.Path(base+"/"+prefix), table.want; got != want {
			t.Errorf("got %s but wanted %s with one component", got, want)
		}
	}
}

func mustNewLogId(t *testing.T, namespace *namespace.Namespace) []byte {
	b, err := namespace.Marshal()
	if err != nil {
		t.Fatalf("must marshal log id: %v", err)
	}
	return b
}

func mustNewNamespaceEd25519V1(t *testing.T, vk []byte) *namespace.Namespace {
	namespace, err := namespace.NewNamespaceEd25519V1(vk)
	if err != nil {
		t.Fatalf("must make ed25519 namespace: %v", err)
	}
	return namespace
}

func mustNewNamespacePool(t *testing.T, anchors []*namespace.Namespace) *namespace.NamespacePool {
	namespaces, err := namespace.NewNamespacePool(anchors)
	if err != nil {
		t.Fatalf("must make namespaces: %v", err)
	}
	return namespaces
}

// makeTestLogParameters makes a collection of test log parameters.
//
// The log's identity is based on testdata.Ed25519{Vk3,Sk3}.  The log's accepted
// submitters are based on testdata.Ed25519Vk.  The log's accepted witnesses are
// based on testdata.Ed25519Vk.  The remaining log parameters are based on the
// global test* variables in this file.
//
// For convenience the passed signer is optional (i.e., it may be nil).
func makeTestLogParameters(t *testing.T, signer crypto.Signer) *LogParameters {
	return &LogParameters{
		LogId:    mustNewLogId(t, mustNewNamespaceEd25519V1(t, testdata.Ed25519Vk3)),
		TreeId:   testTreeId,
		Prefix:   testPrefix,
		MaxRange: testMaxRange,
		Submitters: mustNewNamespacePool(t, []*namespace.Namespace{
			mustNewNamespaceEd25519V1(t, testdata.Ed25519Vk),
		}),
		Witnesses: mustNewNamespacePool(t, []*namespace.Namespace{
			mustNewNamespaceEd25519V1(t, testdata.Ed25519Vk),
		}),
		Signer:   signer,
		HashType: testHashType,
	}
}