-
Notifications
You must be signed in to change notification settings - Fork 20
/
index.ts
118 lines (102 loc) · 3.31 KB
/
index.ts
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
/*
Copyright 2022 The Sigstore 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.
*/
import { InternalError } from '../error';
import { HTTPError, Rekor } from '../external';
import { SignatureMaterial } from '../types/signature';
import * as sigstore from '../types/sigstore';
import { toProposedHashedRekordEntry, toProposedIntotoEntry } from './format';
import type { Entry, ProposedEntry } from '../external/rekor';
import type { FetchOptions } from '../types/fetch';
interface CreateEntryOptions {
fetchOnConflict?: boolean;
}
export interface TLog {
createMessageSignatureEntry: (
digest: Buffer,
sigMaterial: SignatureMaterial
) => Promise<Entry>;
createDSSEEntry: (
envelope: sigstore.Envelope,
sigMaterial: SignatureMaterial,
options?: CreateEntryOptions
) => Promise<Entry>;
}
export type TLogClientOptions = {
rekorBaseURL: string;
} & FetchOptions;
export class TLogClient implements TLog {
private rekor: Rekor;
constructor(options: TLogClientOptions) {
this.rekor = new Rekor({
baseURL: options.rekorBaseURL,
retry: options.retry,
timeout: options.timeout,
});
}
async createMessageSignatureEntry(
digest: Buffer,
sigMaterial: SignatureMaterial,
options: CreateEntryOptions = {}
): Promise<Entry> {
const proposedEntry = toProposedHashedRekordEntry(digest, sigMaterial);
return this.createEntry(proposedEntry, options.fetchOnConflict);
}
async createDSSEEntry(
envelope: sigstore.Envelope,
sigMaterial: SignatureMaterial,
options: CreateEntryOptions = {}
): Promise<Entry> {
const proposedEntry = toProposedIntotoEntry(envelope, sigMaterial);
return this.createEntry(proposedEntry, options.fetchOnConflict);
}
private async createEntry(
proposedEntry: ProposedEntry,
fetchOnConflict = false
): Promise<Entry> {
let entry: Entry;
try {
entry = await this.rekor.createEntry(proposedEntry);
} catch (err) {
// If the entry already exists, fetch it (if enabled)
if (entryExistsError(err) && fetchOnConflict) {
// Grab the UUID of the existing entry from the location header
const uuid = err.location.split('/').pop() || '';
try {
entry = await this.rekor.getEntry(uuid);
} catch (err) {
throw new InternalError({
code: 'TLOG_FETCH_ENTRY_ERROR',
message: 'error fetching tlog entry',
cause: err,
});
}
} else {
throw new InternalError({
code: 'TLOG_CREATE_ENTRY_ERROR',
message: 'error creating tlog entry',
cause: err,
});
}
}
return entry;
}
}
function entryExistsError(
value: unknown
): value is HTTPError & { location: string } {
return (
value instanceof HTTPError &&
value.statusCode === 409 &&
value.location !== undefined
);
}