@intellectual-frontiers/ergonex 0.2.5 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/desired.d.ts +27 -0
- package/dist/diff.d.ts +12 -0
- package/dist/doctor.d.ts +79 -0
- package/dist/findings.d.ts +85 -0
- package/dist/layout.d.ts +83 -0
- package/dist/manifest.d.ts +84 -0
- package/dist/mod.d.ts +29 -0
- package/dist/mod.js +4219 -0
- package/dist/modules/external.d.ts +31 -0
- package/dist/modules/mod.d.ts +10 -0
- package/dist/modules/name.d.ts +32 -0
- package/dist/modules/registry.d.ts +51 -0
- package/dist/modules/types.d.ts +178 -0
- package/dist/places.d.ts +35 -0
- package/dist/plan.d.ts +176 -0
- package/dist/platform/k-args.d.ts +28 -0
- package/dist/policy.d.ts +39 -0
- package/dist/portable.d.ts +111 -0
- package/dist/render.d.ts +95 -0
- package/dist/setup/evidence.d.ts +58 -0
- package/dist/shell/block.d.ts +45 -0
- package/dist/shell/mod.d.ts +8 -0
- package/dist/shell/snippet.d.ts +43 -0
- package/dist/state-record.d.ts +59 -0
- package/dist/state.d.ts +64 -0
- package/dist/templates/data.d.ts +25 -0
- package/dist/templates/hooks.d.ts +13 -0
- package/dist/templates/mod.d.ts +16 -0
- package/dist/tools/catalog.d.ts +70 -0
- package/dist/types.d.ts +51 -0
- package/dist/vendor/ts/githost/capabilities.d.ts +18 -0
- package/dist/vendor/ts/githost/git.d.ts +16 -0
- package/dist/vendor/ts/githost/github.d.ts +15 -0
- package/dist/vendor/ts/githost/gitlab.d.ts +15 -0
- package/dist/vendor/ts/githost/mod.d.ts +29 -0
- package/dist/vendor/ts/githost/remote.d.ts +59 -0
- package/dist/vendor/ts/githost/types.d.ts +101 -0
- package/dist/vendor/ts/kernel/archive.d.ts +147 -0
- package/dist/vendor/ts/kernel/args.d.ts +240 -0
- package/dist/vendor/ts/kernel/assess.d.ts +247 -0
- package/dist/vendor/ts/kernel/attest.d.ts +164 -0
- package/dist/vendor/ts/kernel/base64.d.ts +24 -0
- package/dist/vendor/ts/kernel/cbor.d.ts +39 -0
- package/dist/vendor/ts/kernel/cms.d.ts +106 -0
- package/dist/vendor/ts/kernel/commands.d.ts +103 -0
- package/dist/vendor/ts/kernel/cose.d.ts +34 -0
- package/dist/vendor/ts/kernel/crypt.d.ts +30 -0
- package/dist/vendor/ts/kernel/csv.d.ts +38 -0
- package/dist/vendor/ts/kernel/der.d.ts +67 -0
- package/dist/vendor/ts/kernel/documentation.d.ts +118 -0
- package/dist/vendor/ts/kernel/dsse.d.ts +137 -0
- package/dist/vendor/ts/kernel/evidence.d.ts +212 -0
- package/dist/vendor/ts/kernel/glob.d.ts +64 -0
- package/dist/vendor/ts/kernel/grc.d.ts +356 -0
- package/dist/vendor/ts/kernel/http.d.ts +46 -0
- package/dist/vendor/ts/kernel/json5.d.ts +46 -0
- package/dist/vendor/ts/kernel/layers.d.ts +35 -0
- package/dist/vendor/ts/kernel/md5.d.ts +19 -0
- package/dist/vendor/ts/kernel/media-types.d.ts +28 -0
- package/dist/vendor/ts/kernel/mod.d.ts +95 -0
- package/dist/vendor/ts/kernel/ocsf-types.auto.d.ts +4374 -0
- package/dist/vendor/ts/kernel/ocsf.d.ts +160 -0
- package/dist/vendor/ts/kernel/oscal.d.ts +356 -0
- package/dist/vendor/ts/kernel/otel.d.ts +365 -0
- package/dist/vendor/ts/kernel/otlp.d.ts +83 -0
- package/dist/vendor/ts/kernel/palette.d.ts +44 -0
- package/dist/vendor/ts/kernel/png.d.ts +124 -0
- package/dist/vendor/ts/kernel/rdf-schema.d.ts +190 -0
- package/dist/vendor/ts/kernel/rdf-term.d.ts +162 -0
- package/dist/vendor/ts/kernel/rdf-vocabularies.d.ts +148 -0
- package/dist/vendor/ts/kernel/rdf-write.d.ts +25 -0
- package/dist/vendor/ts/kernel/rdf.d.ts +35 -0
- package/dist/vendor/ts/kernel/render.d.ts +111 -0
- package/dist/vendor/ts/kernel/schedule.d.ts +207 -0
- package/dist/vendor/ts/kernel/semver.d.ts +94 -0
- package/dist/vendor/ts/kernel/sha256.d.ts +29 -0
- package/dist/vendor/ts/kernel/signals.d.ts +371 -0
- package/dist/vendor/ts/kernel/sigv4.d.ts +67 -0
- package/dist/vendor/ts/kernel/test-record.d.ts +222 -0
- package/dist/vendor/ts/kernel/test-report.d.ts +294 -0
- package/dist/vendor/ts/kernel/toml.d.ts +51 -0
- package/dist/vendor/ts/kernel/trace.d.ts +169 -0
- package/dist/vendor/ts/kernel/ts-literal.d.ts +62 -0
- package/dist/vendor/ts/kernel/uuid.d.ts +53 -0
- package/dist/vendor/ts/kernel/vt.d.ts +78 -0
- package/dist/vendor/ts/kernel/webauthn.d.ts +212 -0
- package/dist/vendor/ts/kernel/width.d.ts +63 -0
- package/dist/vendor/ts/kernel/xml.d.ts +73 -0
- package/dist/vendor/ts/kernel/yaml.d.ts +44 -0
- package/dist/vendor/ts/runtime/http-client.d.ts +149 -0
- package/ergonex.mjs +140 -140
- package/package.json +17 -5
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A typed command-line parser (commons 0005-typescript-runtime FR-047): a command's options are declared once as data (`flag`, `value`,
|
|
3
|
+
* `many`), the type of what `parseArgs` gives is inferred from that declaration, and a command line that does not fit is a `UsageError`,
|
|
4
|
+
* a union told apart by `kind` that `formatUsageError` says in one sentence; `helpText` writes the help from the same declaration. It
|
|
5
|
+
* unifies the parsers of two harnesses: erga's `@erga/agent` `args.ts` (declared options, an undeclared option refused with a "did you mean", help that
|
|
6
|
+
* wins over everything and runs nothing: erga 247-ergactl FR-006 and FR-007) and Stolos's `parseArgs` (short letters, required options, defaults, repeatable options). It is pure: the
|
|
7
|
+
* caller passes the words, `proc.args` from `runtime/proc.ts`.
|
|
8
|
+
*
|
|
9
|
+
* The grammar: `--name VALUE` and `--name=VALUE`; `-x VALUE`; bundled short flags `-abc`, whose last letter may take the next word as its
|
|
10
|
+
* value; `--no-name` for a flag declared `negatable`; `--` ends the options, and the words after it are kept apart as `rest`; `-` and a
|
|
11
|
+
* word such as `-5` are arguments, since no option is a digit. A short option's value is never attached (`-ofile`, `-o=file`), which other
|
|
12
|
+
* parsers read differently. A value-taking option takes the next word whatever it is, as getopt does. Every option is given at most once
|
|
13
|
+
* (a `many` option as often as wanted): a second value would otherwise silently replace the first. `--help`, or a short word with the
|
|
14
|
+
* letter `h`, anywhere before `--` asks for help, which wins over every other word and every error, so `-h` and the name `help` are
|
|
15
|
+
* reserved.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* import { flag, integerText, many, parseArgs, value } from "./args.js";
|
|
20
|
+
* const spec = {
|
|
21
|
+
* verbose: flag({ short: "v", help: "Say more." }),
|
|
22
|
+
* out: value({ short: "o", help: "Where to write.", valueName: "FILE" }),
|
|
23
|
+
* tag: many({ help: "A tag." }),
|
|
24
|
+
* jobs: value({ help: "How many at once.", parse: integerText, default: 4 }),
|
|
25
|
+
* };
|
|
26
|
+
* parseArgs(["-v", "--tag", "a", "--tag=b", "--jobs", "8", "--", "x"], spec);
|
|
27
|
+
* // { kind: "ok", value: { kind: "args", options: { verbose: true, out: undefined, tag: ["a", "b"], jobs: 8 }, positionals: [], rest: ["x"] } }
|
|
28
|
+
* ```
|
|
29
|
+
*
|
|
30
|
+
* @module
|
|
31
|
+
*/
|
|
32
|
+
import { type Result } from "@intellectual-frontiers/core";
|
|
33
|
+
import type { DecodeError } from "@intellectual-frontiers/core";
|
|
34
|
+
/** A short option's letter: any ASCII letter but `h`, which is help's. */
|
|
35
|
+
export type ShortName = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z";
|
|
36
|
+
/** What turns an option's text into its value: a function of the text, or any of the kernel's decoders (`./decode.ts`), which take it as `unknown`. */
|
|
37
|
+
export type Parser<T> = (text: string) => Result<T, string | DecodeError>;
|
|
38
|
+
/** What an option is when the command line does not give it: nothing (`undefined`), a usage error, or a default. */
|
|
39
|
+
export type Presence = "none" | "required" | "default";
|
|
40
|
+
/** The fallback of an option of presence `P`: the default's value is kept with it. */
|
|
41
|
+
export type Fallback<T, P extends Presence> = P extends "none" ? {
|
|
42
|
+
readonly kind: "none";
|
|
43
|
+
} : P extends "required" ? {
|
|
44
|
+
readonly kind: "required";
|
|
45
|
+
} : {
|
|
46
|
+
readonly kind: "default";
|
|
47
|
+
readonly value: T;
|
|
48
|
+
};
|
|
49
|
+
/** A switch that takes no value: `true` when given, `false` with `--no-name` where it is negatable, else its fallback. */
|
|
50
|
+
export type FlagOption<P extends "none" | "default" = "none" | "default", L extends ShortName = ShortName> = {
|
|
51
|
+
readonly kind: "flag";
|
|
52
|
+
readonly short: L | undefined;
|
|
53
|
+
readonly help: string;
|
|
54
|
+
readonly negatable: boolean;
|
|
55
|
+
readonly fallback: Fallback<boolean, P>;
|
|
56
|
+
};
|
|
57
|
+
/** An option given at most once with one value, parsed into a `T`. */
|
|
58
|
+
export type ValueOption<T, P extends Presence = Presence, L extends ShortName = ShortName> = {
|
|
59
|
+
readonly kind: "value";
|
|
60
|
+
readonly short: L | undefined;
|
|
61
|
+
readonly help: string;
|
|
62
|
+
readonly valueName: string;
|
|
63
|
+
readonly parse: Parser<T>;
|
|
64
|
+
readonly fallback: Fallback<T, P>;
|
|
65
|
+
};
|
|
66
|
+
/** An option given any number of times, each value parsed into a `T`, kept in the order given. */
|
|
67
|
+
export type ManyOption<T, L extends ShortName = ShortName> = {
|
|
68
|
+
readonly kind: "many";
|
|
69
|
+
readonly short: L | undefined;
|
|
70
|
+
readonly help: string;
|
|
71
|
+
readonly valueName: string;
|
|
72
|
+
readonly parse: Parser<T>;
|
|
73
|
+
};
|
|
74
|
+
/** One declared option. */
|
|
75
|
+
export type Option = FlagOption | ValueOption<unknown> | ManyOption<unknown>;
|
|
76
|
+
/** A command's options, by name: the key `dryRun` is the option `--dry-run`. */
|
|
77
|
+
export type Spec = {
|
|
78
|
+
readonly [name: string]: Option;
|
|
79
|
+
};
|
|
80
|
+
/** The value an option gives, as its declaration says. */
|
|
81
|
+
export type OptionValue<O> = O extends {
|
|
82
|
+
readonly kind: "flag";
|
|
83
|
+
readonly fallback: infer F;
|
|
84
|
+
} ? [F] extends [{
|
|
85
|
+
readonly kind: "none";
|
|
86
|
+
}] ? boolean | undefined : boolean : O extends {
|
|
87
|
+
readonly kind: "many";
|
|
88
|
+
readonly parse: Parser<infer T>;
|
|
89
|
+
} ? readonly T[] : O extends {
|
|
90
|
+
readonly kind: "value";
|
|
91
|
+
readonly parse: Parser<infer T>;
|
|
92
|
+
readonly fallback: infer F;
|
|
93
|
+
} ? [F] extends [{
|
|
94
|
+
readonly kind: "none";
|
|
95
|
+
}] ? T | undefined : T : never;
|
|
96
|
+
/** The values of a spec's options, by the same names. */
|
|
97
|
+
export type OptionValues<S extends Spec> = {
|
|
98
|
+
readonly [K in keyof S]: OptionValue<S[K]>;
|
|
99
|
+
};
|
|
100
|
+
/** The short letter an option declares, if any. */
|
|
101
|
+
type ShortOf<O> = O extends {
|
|
102
|
+
readonly short: infer L;
|
|
103
|
+
} ? Exclude<L, undefined> : never;
|
|
104
|
+
/** The short letters that two options of a spec declare. */
|
|
105
|
+
type RepeatedShorts<S> = {
|
|
106
|
+
[K in keyof S]: ShortOf<S[K]> & ShortOf<S[Exclude<keyof S, K>]>;
|
|
107
|
+
}[keyof S];
|
|
108
|
+
/**
|
|
109
|
+
* `unknown` where a spec is well formed, else a type naming what is wrong, which the spec then does not satisfy: a short letter declared
|
|
110
|
+
* twice, a name written with a dash (names are camelCase keys), or the name `help`, which is reserved.
|
|
111
|
+
*/
|
|
112
|
+
export type SpecCheck<S> = [RepeatedShorts<S>] extends [never] ? [Extract<keyof S, `${string}-${string}`>] extends [never] ? ["help"] extends [keyof S] ? {
|
|
113
|
+
readonly "help is reserved": never;
|
|
114
|
+
} : unknown : {
|
|
115
|
+
readonly "option names are camelCase keys": Extract<keyof S, `${string}-${string}`>;
|
|
116
|
+
} : {
|
|
117
|
+
readonly "a short letter is declared twice": RepeatedShorts<S>;
|
|
118
|
+
};
|
|
119
|
+
/** A word, or words, that a command takes after its options: exactly one, at most one, or any number. */
|
|
120
|
+
export type Operand = {
|
|
121
|
+
readonly name: string;
|
|
122
|
+
readonly help: string;
|
|
123
|
+
readonly arity: "one" | "optional" | "many";
|
|
124
|
+
};
|
|
125
|
+
/** A command line that fits its spec: the options' values, the arguments, and the words after `--`. */
|
|
126
|
+
export type Args<S extends Spec> = {
|
|
127
|
+
readonly kind: "args";
|
|
128
|
+
readonly options: OptionValues<S>;
|
|
129
|
+
readonly positionals: readonly string[];
|
|
130
|
+
readonly rest: readonly string[];
|
|
131
|
+
};
|
|
132
|
+
/** What a command line asks: help, which runs nothing else (erga 247-ergactl FR-006), or the command with its arguments. */
|
|
133
|
+
export type Parsed<S extends Spec> = {
|
|
134
|
+
readonly kind: "help";
|
|
135
|
+
} | Args<S>;
|
|
136
|
+
/** Why a command line does not fit its spec. `option` is the option as it was written, or its long name where it was given twice or not at all. */
|
|
137
|
+
export type UsageError = {
|
|
138
|
+
readonly kind: "unknown-option";
|
|
139
|
+
readonly option: string;
|
|
140
|
+
readonly suggestion: string | undefined;
|
|
141
|
+
} | {
|
|
142
|
+
readonly kind: "missing-value";
|
|
143
|
+
readonly option: string;
|
|
144
|
+
} | {
|
|
145
|
+
readonly kind: "unexpected-value";
|
|
146
|
+
readonly option: string;
|
|
147
|
+
readonly value: string;
|
|
148
|
+
} | {
|
|
149
|
+
readonly kind: "attached-value";
|
|
150
|
+
readonly option: string;
|
|
151
|
+
readonly word: string;
|
|
152
|
+
} | {
|
|
153
|
+
readonly kind: "invalid-value";
|
|
154
|
+
readonly option: string;
|
|
155
|
+
readonly value: string;
|
|
156
|
+
readonly reason: string;
|
|
157
|
+
} | {
|
|
158
|
+
readonly kind: "repeated-option";
|
|
159
|
+
readonly option: string;
|
|
160
|
+
} | {
|
|
161
|
+
readonly kind: "missing-option";
|
|
162
|
+
readonly option: string;
|
|
163
|
+
} | {
|
|
164
|
+
readonly kind: "missing-argument";
|
|
165
|
+
readonly argument: string;
|
|
166
|
+
} | {
|
|
167
|
+
readonly kind: "unexpected-argument";
|
|
168
|
+
readonly argument: string;
|
|
169
|
+
readonly takes: readonly string[];
|
|
170
|
+
};
|
|
171
|
+
/** The fields every option declares. */
|
|
172
|
+
type Common<L extends ShortName> = {
|
|
173
|
+
readonly short?: L;
|
|
174
|
+
readonly help: string;
|
|
175
|
+
};
|
|
176
|
+
/** The fields an option with a value declares: the name of its value in the help, `VALUE` by default. */
|
|
177
|
+
type Valued<L extends ShortName> = Common<L> & {
|
|
178
|
+
readonly valueName?: string;
|
|
179
|
+
};
|
|
180
|
+
/** A flag: `false` when not given; with `negatable`, `--no-name` gives `false` and an absent flag gives `undefined`, or the `default`. */
|
|
181
|
+
export declare function flag<L extends ShortName = never>(o: Common<L> & {
|
|
182
|
+
readonly negatable: true;
|
|
183
|
+
readonly default: boolean;
|
|
184
|
+
}): FlagOption<"default", L>;
|
|
185
|
+
/** A negatable flag with no default. */
|
|
186
|
+
export declare function flag<L extends ShortName = never>(o: Common<L> & {
|
|
187
|
+
readonly negatable: true;
|
|
188
|
+
}): FlagOption<"none", L>;
|
|
189
|
+
/** A flag that cannot be negated. */
|
|
190
|
+
export declare function flag<L extends ShortName = never>(o: Common<L>): FlagOption<"default", L>;
|
|
191
|
+
/** An option with one value, parsed by `parse`, that must be given. */
|
|
192
|
+
export declare function value<T, L extends ShortName = never>(o: Valued<L> & {
|
|
193
|
+
readonly parse: Parser<T>;
|
|
194
|
+
readonly required: true;
|
|
195
|
+
}): ValueOption<T, "required", L>;
|
|
196
|
+
/** An option with one value, parsed by `parse`, and a default. */
|
|
197
|
+
export declare function value<T, L extends ShortName = never>(o: Valued<L> & {
|
|
198
|
+
readonly parse: Parser<T>;
|
|
199
|
+
readonly default: NoInfer<T>;
|
|
200
|
+
}): ValueOption<T, "default", L>;
|
|
201
|
+
/** An option with one value, parsed by `parse`, `undefined` when not given. */
|
|
202
|
+
export declare function value<T, L extends ShortName = never>(o: Valued<L> & {
|
|
203
|
+
readonly parse: Parser<T>;
|
|
204
|
+
}): ValueOption<T, "none", L>;
|
|
205
|
+
/** An option with one text value that must be given. */
|
|
206
|
+
export declare function value<L extends ShortName = never>(o: Valued<L> & {
|
|
207
|
+
readonly required: true;
|
|
208
|
+
}): ValueOption<string, "required", L>;
|
|
209
|
+
/** An option with one text value and a default. */
|
|
210
|
+
export declare function value<L extends ShortName = never>(o: Valued<L> & {
|
|
211
|
+
readonly default: string;
|
|
212
|
+
}): ValueOption<string, "default", L>;
|
|
213
|
+
/** An option with one text value, `undefined` when not given. */
|
|
214
|
+
export declare function value<L extends ShortName = never>(o: Valued<L>): ValueOption<string, "none", L>;
|
|
215
|
+
/** An option given any number of times, each value parsed by `parse`. */
|
|
216
|
+
export declare function many<T, L extends ShortName = never>(o: Valued<L> & {
|
|
217
|
+
readonly parse: Parser<T>;
|
|
218
|
+
}): ManyOption<T, L>;
|
|
219
|
+
/** An option given any number of times, each value its text. */
|
|
220
|
+
export declare function many<L extends ShortName = never>(o: Valued<L>): ManyOption<string, L>;
|
|
221
|
+
/** A parser of an integer written in decimal, with an optional `-`, within the safe integers. */
|
|
222
|
+
export declare function integerText(t: string): Result<number, string>;
|
|
223
|
+
/** The long option of a spec's key: `dryRun` is `--dry-run`. */
|
|
224
|
+
export declare function longName(key: string): string;
|
|
225
|
+
/** The number of insertions, deletions and substitutions that turn `a` into `b` (Levenshtein). */
|
|
226
|
+
export declare function editDistance(a: string, b: string): number;
|
|
227
|
+
/** The candidate nearest `word` by edit distance, the first of equals, if it is within two edits or half the word's length; else nothing. */
|
|
228
|
+
export declare function suggest(word: string, candidates: readonly string[]): string | undefined;
|
|
229
|
+
/**
|
|
230
|
+
* Parses `argv` against `spec`, and the arguments against `operands` (none by default): help where it is asked for, else every option's
|
|
231
|
+
* value with the arguments and the words after `--`, or the first thing that does not fit.
|
|
232
|
+
*/
|
|
233
|
+
export declare function parseArgs<S extends Spec>(argv: readonly string[], spec: S & SpecCheck<S>, operands?: readonly Operand[]): Result<Parsed<S>, UsageError>;
|
|
234
|
+
/** A usage error as one sentence; `command` names the command (`ergactl toolchain list`), "this command" by default. */
|
|
235
|
+
export declare function formatUsageError(e: UsageError, command?: string): string;
|
|
236
|
+
/** The help of a command: its summary, its usage, its options aligned with their defaults, and its arguments. */
|
|
237
|
+
export declare function helpText<S extends Spec>(program: string, summary: string, spec: S & SpecCheck<S>, operands?: readonly Operand[]): string;
|
|
238
|
+
/** The help of a command whose spec was checked where it was declared (a verb of `./commands.ts`), as `helpText` gives it. */
|
|
239
|
+
export declare function helpOf(program: string, summary: string, spec: Spec, operands?: readonly Operand[]): string;
|
|
240
|
+
export {};
|
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Assessment: what findings, evidence and declarations add up to (commons 0007-grc FR-010 to FR-015). Every function is pure and takes the
|
|
3
|
+
* instant it judges at as a value.
|
|
4
|
+
*
|
|
5
|
+
* - **Coverage** rolls each catalog control (a requirement) or control up as `gap`, `untested`, `partial`, `addressed` or `covered` (FR-010).
|
|
6
|
+
* - **Freshness** holds the newest evidence to a cadence (an ISO 8601 duration): `fresh`, `due` within the last tenth of the cadence, or
|
|
7
|
+
* `stale`, with the instant it falls due (FR-011).
|
|
8
|
+
* - **Drift** compares a declared and an observed view of keyed records: added, removed and changed, each change with its field's path
|
|
9
|
+
* and both values, in key order (FR-012).
|
|
10
|
+
* - The **change-impact gate** reads declarations of paths (globs) to controls and judges a change `allowed` or `blocked`, with every
|
|
11
|
+
* reason (FR-013).
|
|
12
|
+
* - The **risk register** levels each risk by NIST SP 800-30 Rev. 1's Table I-2 and reports those past their review (FR-014).
|
|
13
|
+
* - The **trace** relates each requirement to the mechanisms that enforce it and the evidence they gave, and names those with none (FR-015).
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```ts
|
|
17
|
+
* import { riskLevel } from "./assess.js";
|
|
18
|
+
* riskLevel("moderate", "very-high"); // "high"
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* @module
|
|
22
|
+
*/
|
|
23
|
+
import { type Decoder } from "@intellectual-frontiers/core";
|
|
24
|
+
import { type Catalog, type CatalogControl, type ControlRef, type Duration, type Finding, type Instant, type Outcome, type Role } from "./grc.js";
|
|
25
|
+
import type { Json } from "./json5.js";
|
|
26
|
+
import type { Sha256 } from "./sha256.js";
|
|
27
|
+
/** The findings of the newest assessment of each control and subject: for each, those with the latest `at`. */
|
|
28
|
+
export declare function newestFindings(findings: readonly Finding[]): readonly Finding[];
|
|
29
|
+
/** How well a requirement or control is met, from the worst to the best. */
|
|
30
|
+
export type CoverageStatus = "gap" | "untested" | "partial" | "addressed" | "covered";
|
|
31
|
+
/**
|
|
32
|
+
* The coverage that subjects' outcomes give, `not-applicable` ones left out: `untested` where none is left, `partial` where one is
|
|
33
|
+
* neither passing nor accepted, `addressed` where every one passes or is accepted and at least one is accepted, `covered` where every one
|
|
34
|
+
* passes.
|
|
35
|
+
*/
|
|
36
|
+
export declare function coverageOf(outcomes: readonly Outcome[]): Exclude<CoverageStatus, "gap">;
|
|
37
|
+
/** A control's coverage from the newest findings of it. */
|
|
38
|
+
export type ControlCoverage = {
|
|
39
|
+
readonly control: string;
|
|
40
|
+
readonly status: Exclude<CoverageStatus, "gap">;
|
|
41
|
+
readonly outcome: Outcome;
|
|
42
|
+
};
|
|
43
|
+
/** Each control's coverage, in the order given, from the newest findings of each control and subject. */
|
|
44
|
+
export declare function controlCoverage(controls: readonly {
|
|
45
|
+
readonly id: string;
|
|
46
|
+
}[], findings: readonly Finding[]): readonly ControlCoverage[];
|
|
47
|
+
/** A requirement's coverage: the catalog control, the controls that implement it, and how well they meet it. */
|
|
48
|
+
export type RequirementCoverage<C extends string = string, I extends string = string> = {
|
|
49
|
+
readonly requirement: ControlRef<C, I>;
|
|
50
|
+
readonly status: CoverageStatus;
|
|
51
|
+
readonly outcome: Outcome;
|
|
52
|
+
readonly controls: readonly string[];
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* Every control of a catalog as a requirement, in the catalog's order: `gap` where no control implements it, else the coverage of the
|
|
56
|
+
* newest findings of every control that does (`untested` where there are none).
|
|
57
|
+
*/
|
|
58
|
+
export declare function requirementCoverage<C extends string, E extends CatalogControl>(catalog: Catalog<C, E>, controls: readonly {
|
|
59
|
+
readonly id: string;
|
|
60
|
+
readonly implements: readonly ControlRef[];
|
|
61
|
+
}[], findings: readonly Finding[]): readonly RequirementCoverage<C, E["id"]>[];
|
|
62
|
+
/** Whether evidence is recent enough for its cadence. */
|
|
63
|
+
export type FreshnessStatus = "fresh" | "due" | "stale";
|
|
64
|
+
/** How fresh evidence is: its status, the newest evidence, when it falls due (`null` past the year 9999) and when the `due` window opens. */
|
|
65
|
+
export type Freshness = {
|
|
66
|
+
readonly status: FreshnessStatus;
|
|
67
|
+
readonly cadence: string;
|
|
68
|
+
readonly newest: Instant | null;
|
|
69
|
+
readonly dueAt: Instant | null;
|
|
70
|
+
readonly dueFrom: Instant | null;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
* The freshness at `at` of evidence observed at the given instants, held to a cadence: it falls due one cadence after the newest; it is
|
|
74
|
+
* `stale` after that instant, `due` in the last tenth of the cadence up to and at it, `fresh` before. No evidence at all is `stale`, due at `at`.
|
|
75
|
+
*/
|
|
76
|
+
export declare function freshness(cadence: Duration, evidence: readonly Instant[], at: Instant): Freshness;
|
|
77
|
+
/** The freshness of each control's newest finding, held to the control's cadence, in the order given. */
|
|
78
|
+
export declare function controlFreshness(controls: readonly {
|
|
79
|
+
readonly id: string;
|
|
80
|
+
readonly cadence: Duration;
|
|
81
|
+
}[], findings: readonly Finding[], at: Instant): readonly {
|
|
82
|
+
readonly control: string;
|
|
83
|
+
readonly freshness: Freshness;
|
|
84
|
+
}[];
|
|
85
|
+
/** One step of a field's path: a member name or an array index. */
|
|
86
|
+
export type PathStep = string | number;
|
|
87
|
+
/** A field that differs: its path inside the record, and its value on each side (absent where that side does not have it). */
|
|
88
|
+
export type FieldChange = {
|
|
89
|
+
readonly path: readonly PathStep[];
|
|
90
|
+
readonly field: string;
|
|
91
|
+
readonly declared?: Json;
|
|
92
|
+
readonly observed?: Json;
|
|
93
|
+
};
|
|
94
|
+
/** What differs between a declared and an observed view of keyed records, each list in key order. */
|
|
95
|
+
export type Drift = {
|
|
96
|
+
readonly added: readonly {
|
|
97
|
+
readonly key: string;
|
|
98
|
+
readonly value: Json;
|
|
99
|
+
}[];
|
|
100
|
+
readonly removed: readonly {
|
|
101
|
+
readonly key: string;
|
|
102
|
+
readonly value: Json;
|
|
103
|
+
}[];
|
|
104
|
+
readonly changed: readonly {
|
|
105
|
+
readonly key: string;
|
|
106
|
+
readonly changes: readonly FieldChange[];
|
|
107
|
+
}[];
|
|
108
|
+
};
|
|
109
|
+
/** Keyed records: a map, or an object whose members are the records. */
|
|
110
|
+
export type KeyedView = ReadonlyMap<string, Json> | {
|
|
111
|
+
readonly [key: string]: Json;
|
|
112
|
+
};
|
|
113
|
+
/** A field's path as text, `$` for the record itself: `$.ports[0]`, `$["a b"]`. */
|
|
114
|
+
export declare function formatFieldPath(path: readonly PathStep[]): string;
|
|
115
|
+
/** The field changes between two values: objects compared member by member in key order, arrays index by index, anything else whole. */
|
|
116
|
+
export declare function fieldChanges(declared: Json, observed: Json): readonly FieldChange[];
|
|
117
|
+
/** The drift from what is declared to what is observed: records only observed are added, only declared removed, in both but different changed. */
|
|
118
|
+
export declare function drift(declared: KeyedView, observed: KeyedView): Drift;
|
|
119
|
+
/** Paths (globs) and the controls a change to them bears on. */
|
|
120
|
+
export type ImpactDeclaration = {
|
|
121
|
+
readonly paths: readonly string[];
|
|
122
|
+
readonly controls: readonly string[];
|
|
123
|
+
};
|
|
124
|
+
/** A change: the paths it touches, the reviews it says it needs (by role) and the reviews given. */
|
|
125
|
+
export type Change = {
|
|
126
|
+
readonly paths: readonly string[];
|
|
127
|
+
readonly needsReview?: readonly Role[];
|
|
128
|
+
readonly reviewedBy?: readonly Role[];
|
|
129
|
+
};
|
|
130
|
+
/** The outcomes that block a change to the paths of a control. */
|
|
131
|
+
export type BlockingOutcome = "fail" | "error" | "gap";
|
|
132
|
+
/** Why a change is blocked. */
|
|
133
|
+
export type GateReason = {
|
|
134
|
+
readonly kind: "control";
|
|
135
|
+
readonly control: string;
|
|
136
|
+
readonly outcome: BlockingOutcome;
|
|
137
|
+
readonly paths: readonly string[];
|
|
138
|
+
} | {
|
|
139
|
+
readonly kind: "review";
|
|
140
|
+
readonly role: Role;
|
|
141
|
+
};
|
|
142
|
+
/** A control a change bears on, and the touched paths declared for it. */
|
|
143
|
+
export type Touched = {
|
|
144
|
+
readonly control: string;
|
|
145
|
+
readonly paths: readonly string[];
|
|
146
|
+
};
|
|
147
|
+
/** The gate's judgement of a change, with every control it touches; where blocked, every reason. */
|
|
148
|
+
export type GateDecision = {
|
|
149
|
+
readonly kind: "allowed";
|
|
150
|
+
readonly touched: readonly Touched[];
|
|
151
|
+
} | {
|
|
152
|
+
readonly kind: "blocked";
|
|
153
|
+
readonly touched: readonly Touched[];
|
|
154
|
+
readonly reasons: readonly [GateReason, ...GateReason[]];
|
|
155
|
+
};
|
|
156
|
+
/** A gate reason as one sentence. */
|
|
157
|
+
export declare function formatGateReason(r: GateReason): string;
|
|
158
|
+
/** Each control's newest outcome: the join of its newest findings' outcomes. */
|
|
159
|
+
export declare function newestOutcomes(findings: readonly Finding[]): ReadonlyMap<string, Outcome>;
|
|
160
|
+
/**
|
|
161
|
+
* A change judged against the declarations and each control's newest outcome: `blocked` where a touched path is declared for a control
|
|
162
|
+
* whose outcome is `fail`, `error` or `gap` (a control with no outcome does not block), or where a review the change needs was not given;
|
|
163
|
+
* else `allowed`. Reasons: controls in id order, then reviews in role order.
|
|
164
|
+
*/
|
|
165
|
+
export declare function gate(declarations: readonly ImpactDeclaration[], change: Change, outcomes: ReadonlyMap<string, Outcome>): GateDecision;
|
|
166
|
+
/** An impact declaration as a file holds it. */
|
|
167
|
+
export declare const impactDeclarationDecoder: Decoder<ImpactDeclaration>;
|
|
168
|
+
/** NIST SP 800-30's five qualitative levels, from the least to the greatest. */
|
|
169
|
+
export declare const RISK_LEVELS: readonly ["very-low", "low", "moderate", "high", "very-high"];
|
|
170
|
+
/** A qualitative level of likelihood, impact or risk (NIST SP 800-30 Rev. 1, Appendices G to I). */
|
|
171
|
+
export type RiskLevel = (typeof RISK_LEVELS)[number];
|
|
172
|
+
/**
|
|
173
|
+
* NIST SP 800-30 Rev. 1, Table I-2, "Assessment scale – level of risk (combination of likelihood and impact)": the level of risk for a
|
|
174
|
+
* likelihood (the row) and an impact (the column).
|
|
175
|
+
*/
|
|
176
|
+
export declare const RISK_MATRIX: Readonly<Record<RiskLevel, Readonly<Record<RiskLevel, RiskLevel>>>>;
|
|
177
|
+
/** The level of risk of a likelihood and an impact, by Table I-2. */
|
|
178
|
+
export declare function riskLevel(likelihood: RiskLevel, impact: RiskLevel): RiskLevel;
|
|
179
|
+
/** What is done about a risk. */
|
|
180
|
+
export type Treatment = "accept" | "mitigate" | "transfer" | "avoid";
|
|
181
|
+
/** A risk as it is written: the level is computed. */
|
|
182
|
+
export type RiskInput = {
|
|
183
|
+
readonly id: string;
|
|
184
|
+
readonly title: string;
|
|
185
|
+
readonly description?: string;
|
|
186
|
+
readonly likelihood: RiskLevel;
|
|
187
|
+
readonly impact: RiskLevel;
|
|
188
|
+
readonly treatment: Treatment;
|
|
189
|
+
readonly owner: Role;
|
|
190
|
+
readonly reviewBy: Instant;
|
|
191
|
+
readonly controls?: readonly string[];
|
|
192
|
+
};
|
|
193
|
+
/** A risk with its level. */
|
|
194
|
+
export type Risk = RiskInput & {
|
|
195
|
+
readonly level: RiskLevel;
|
|
196
|
+
};
|
|
197
|
+
/** A risk past its review date at the instant the register was taken. */
|
|
198
|
+
export type OverdueReview = {
|
|
199
|
+
readonly risk: string;
|
|
200
|
+
readonly owner: Role;
|
|
201
|
+
readonly reviewBy: Instant;
|
|
202
|
+
};
|
|
203
|
+
/** A register: its risks from the greatest level to the least (then by id), and those past their review. */
|
|
204
|
+
export type RiskRegister = {
|
|
205
|
+
readonly at: Instant;
|
|
206
|
+
readonly risks: readonly Risk[];
|
|
207
|
+
readonly overdue: readonly OverdueReview[];
|
|
208
|
+
};
|
|
209
|
+
/** A risk with its level computed. */
|
|
210
|
+
export declare function defineRisk(r: RiskInput): Risk;
|
|
211
|
+
/** The register of some risks at an instant: each levelled, and each whose review date is before the instant reported overdue. */
|
|
212
|
+
export declare function riskRegister(risks: readonly RiskInput[], at: Instant): RiskRegister;
|
|
213
|
+
/** A risk as a file holds it. */
|
|
214
|
+
export declare const riskDecoder: Decoder<RiskInput>;
|
|
215
|
+
/** What enforces requirements: a control, a policy, a process, named by its id. */
|
|
216
|
+
export type Mechanism<R extends string = string> = {
|
|
217
|
+
readonly id: string;
|
|
218
|
+
readonly enforces: readonly R[];
|
|
219
|
+
};
|
|
220
|
+
/** A piece of evidence a mechanism gave. */
|
|
221
|
+
export type EvidenceLink = {
|
|
222
|
+
readonly mechanism: string;
|
|
223
|
+
readonly digest: Sha256;
|
|
224
|
+
};
|
|
225
|
+
/** Why a requirement is unproven: no mechanism enforces it, or none that does gave evidence. */
|
|
226
|
+
export type Unproven = "unenforced" | "unevidenced";
|
|
227
|
+
/** One requirement's trace: each mechanism that enforces it with the evidence it gave (digests in order, once each). */
|
|
228
|
+
export type RequirementTrace<R extends string = string> = {
|
|
229
|
+
readonly requirement: R;
|
|
230
|
+
readonly status: "proven" | Unproven;
|
|
231
|
+
readonly mechanisms: readonly {
|
|
232
|
+
readonly id: string;
|
|
233
|
+
readonly evidence: readonly Sha256[];
|
|
234
|
+
}[];
|
|
235
|
+
};
|
|
236
|
+
/** Every requirement's trace in the order given, and those unproven. */
|
|
237
|
+
export type Trace<R extends string = string> = {
|
|
238
|
+
readonly requirements: readonly RequirementTrace<R>[];
|
|
239
|
+
readonly unproven: readonly {
|
|
240
|
+
readonly requirement: R;
|
|
241
|
+
readonly reason: Unproven;
|
|
242
|
+
}[];
|
|
243
|
+
};
|
|
244
|
+
/** The trace of requirements to mechanisms to evidence; a requirement is proven where a mechanism that enforces it gave evidence. */
|
|
245
|
+
export declare function trace<const R extends string>(requirements: readonly R[], mechanisms: readonly Mechanism<NoInfer<R>>[], evidence: readonly EvidenceLink[]): Trace<R>;
|
|
246
|
+
/** The evidence that findings carry, as links from their controls (the mechanisms) to the digests. */
|
|
247
|
+
export declare function evidenceOfFindings(findings: readonly Finding[]): readonly EvidenceLink[];
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import { type ResourceDescriptor, type Statement } from "./dsse.js";
|
|
2
|
+
import { type Assessment, type Instant } from "./grc.js";
|
|
3
|
+
import { type Sha256 } from "./sha256.js";
|
|
4
|
+
import { type Uuid } from "./uuid.js";
|
|
5
|
+
/** A CycloneDX 1.6 component type. */
|
|
6
|
+
export type CdxComponentType = "application" | "framework" | "library" | "container" | "platform" | "operating-system" | "device" | "device-driver" | "firmware" | "file" | "machine-learning-model" | "data" | "cryptographic-asset";
|
|
7
|
+
/** A requirement of a standard. */
|
|
8
|
+
export type CdxRequirement = {
|
|
9
|
+
readonly "bom-ref": string;
|
|
10
|
+
readonly identifier: string;
|
|
11
|
+
readonly title?: string;
|
|
12
|
+
readonly text?: string;
|
|
13
|
+
};
|
|
14
|
+
/** A standard (`definitions.standards`): its requirements, and what is known of it. */
|
|
15
|
+
export type CdxStandard = {
|
|
16
|
+
readonly "bom-ref": string;
|
|
17
|
+
readonly name: string;
|
|
18
|
+
readonly version?: string;
|
|
19
|
+
readonly description?: string;
|
|
20
|
+
readonly owner?: string;
|
|
21
|
+
readonly requirements: readonly CdxRequirement[];
|
|
22
|
+
};
|
|
23
|
+
/** An assessor. */
|
|
24
|
+
export type CdxAssessor = {
|
|
25
|
+
readonly "bom-ref": string;
|
|
26
|
+
readonly thirdParty: boolean;
|
|
27
|
+
readonly organization: {
|
|
28
|
+
readonly name: string;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/** How far a requirement is met: a score from 0 to 1 and why. */
|
|
32
|
+
export type CdxConformance = {
|
|
33
|
+
readonly score: number;
|
|
34
|
+
readonly rationale: string;
|
|
35
|
+
};
|
|
36
|
+
/** One requirement of an attestation, with the claims and counter-claims that bear on it. */
|
|
37
|
+
export type CdxAttestationMapItem = {
|
|
38
|
+
readonly requirement: string;
|
|
39
|
+
readonly claims: readonly string[];
|
|
40
|
+
readonly counterClaims?: readonly string[];
|
|
41
|
+
readonly conformance: CdxConformance;
|
|
42
|
+
};
|
|
43
|
+
/** An attestation: an assessor's map of requirements to claims. */
|
|
44
|
+
export type CdxAttestation = {
|
|
45
|
+
readonly summary: string;
|
|
46
|
+
readonly assessor: string;
|
|
47
|
+
readonly map: readonly CdxAttestationMapItem[];
|
|
48
|
+
};
|
|
49
|
+
/** A claim about a target, with the evidence for it and against it. */
|
|
50
|
+
export type CdxClaim = {
|
|
51
|
+
readonly "bom-ref": string;
|
|
52
|
+
readonly target: string;
|
|
53
|
+
readonly predicate: string;
|
|
54
|
+
readonly reasoning: string;
|
|
55
|
+
readonly evidence?: readonly string[];
|
|
56
|
+
readonly counterEvidence?: readonly string[];
|
|
57
|
+
};
|
|
58
|
+
/** A piece of evidence: what it is, when it was made, and where its data is. */
|
|
59
|
+
export type CdxEvidence = {
|
|
60
|
+
readonly "bom-ref": string;
|
|
61
|
+
readonly description: string;
|
|
62
|
+
readonly data?: readonly {
|
|
63
|
+
readonly name: string;
|
|
64
|
+
readonly contents: {
|
|
65
|
+
readonly url: string;
|
|
66
|
+
};
|
|
67
|
+
}[];
|
|
68
|
+
readonly created: Instant;
|
|
69
|
+
};
|
|
70
|
+
/** A component claims are about. */
|
|
71
|
+
export type CdxTargetComponent = {
|
|
72
|
+
readonly "bom-ref": string;
|
|
73
|
+
readonly type: CdxComponentType;
|
|
74
|
+
readonly name: string;
|
|
75
|
+
readonly version?: string;
|
|
76
|
+
};
|
|
77
|
+
/** CycloneDX 1.6 declarations. */
|
|
78
|
+
export type CdxDeclarations = {
|
|
79
|
+
readonly assessors: readonly CdxAssessor[];
|
|
80
|
+
readonly attestations: readonly CdxAttestation[];
|
|
81
|
+
readonly claims: readonly CdxClaim[];
|
|
82
|
+
readonly evidence: readonly CdxEvidence[];
|
|
83
|
+
readonly targets: {
|
|
84
|
+
readonly components: readonly CdxTargetComponent[];
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
/** A tool that made a BOM. */
|
|
88
|
+
export type CdxTool = {
|
|
89
|
+
readonly type: "application";
|
|
90
|
+
readonly name: string;
|
|
91
|
+
readonly version: string;
|
|
92
|
+
};
|
|
93
|
+
/** A minimal CycloneDX 1.6 BOM that carries declarations. */
|
|
94
|
+
export type CdxBom = {
|
|
95
|
+
readonly bomFormat: "CycloneDX";
|
|
96
|
+
readonly specVersion: "1.6";
|
|
97
|
+
readonly serialNumber: `urn:uuid:${string}`;
|
|
98
|
+
readonly version: 1;
|
|
99
|
+
readonly metadata: {
|
|
100
|
+
readonly timestamp: Instant;
|
|
101
|
+
readonly tools?: {
|
|
102
|
+
readonly components: readonly CdxTool[];
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
readonly definitions: {
|
|
106
|
+
readonly standards: readonly CdxStandard[];
|
|
107
|
+
};
|
|
108
|
+
readonly declarations: CdxDeclarations;
|
|
109
|
+
};
|
|
110
|
+
/** What an attestation needs beyond the assessment. */
|
|
111
|
+
export type AttestOptions = {
|
|
112
|
+
/** The namespace of the BOM's serial number and of its evidence's UUIDs. */
|
|
113
|
+
readonly namespace: Uuid;
|
|
114
|
+
readonly assessor: {
|
|
115
|
+
readonly name: string;
|
|
116
|
+
readonly thirdParty: boolean;
|
|
117
|
+
};
|
|
118
|
+
/** What the claims are about. */
|
|
119
|
+
readonly target: {
|
|
120
|
+
readonly name: string;
|
|
121
|
+
readonly type?: CdxComponentType;
|
|
122
|
+
readonly version?: string;
|
|
123
|
+
};
|
|
124
|
+
readonly tool?: {
|
|
125
|
+
readonly name: string;
|
|
126
|
+
readonly version: string;
|
|
127
|
+
};
|
|
128
|
+
/** What is known of each catalog, by its id. */
|
|
129
|
+
readonly standards?: Readonly<Record<string, {
|
|
130
|
+
readonly name?: string;
|
|
131
|
+
readonly version?: string;
|
|
132
|
+
readonly owner?: string;
|
|
133
|
+
readonly description?: string;
|
|
134
|
+
}>>;
|
|
135
|
+
readonly summary?: string;
|
|
136
|
+
};
|
|
137
|
+
/** An RFC 6920 Named Information URI of a SHA-256: `ni:///sha-256;` and the digest in base64url without padding. */
|
|
138
|
+
export declare function niUri(digest: Sha256): string;
|
|
139
|
+
/** An assessment's declarations, and the standards their requirements are of. */
|
|
140
|
+
export declare function declarations(a: Assessment, o: AttestOptions): Promise<{
|
|
141
|
+
readonly standards: readonly CdxStandard[];
|
|
142
|
+
readonly declarations: CdxDeclarations;
|
|
143
|
+
}>;
|
|
144
|
+
/** An assessment as a CycloneDX 1.6 BOM of its declarations: the serial number a version 5 UUID of the pack and time in the namespace. */
|
|
145
|
+
export declare function cyclonedxBom(a: Assessment, o: AttestOptions): Promise<CdxBom>;
|
|
146
|
+
/** The in-toto predicate type of a CycloneDX BOM. */
|
|
147
|
+
export declare const CYCLONEDX_PREDICATE_TYPE = "https://cyclonedx.org/bom";
|
|
148
|
+
/** A statement's subject named by its SHA-256. */
|
|
149
|
+
export type DigestSubject = ResourceDescriptor & {
|
|
150
|
+
readonly digest: {
|
|
151
|
+
readonly sha256: Sha256;
|
|
152
|
+
};
|
|
153
|
+
};
|
|
154
|
+
/** An in-toto Statement v1 whose predicate type is `T` and predicate `P`, its subjects named by their SHA-256: a `Statement<P>` for DSSE. */
|
|
155
|
+
export type TypedStatement<T extends string, P> = Statement<P> & {
|
|
156
|
+
readonly predicateType: T;
|
|
157
|
+
readonly subject: readonly DigestSubject[];
|
|
158
|
+
};
|
|
159
|
+
/** A subject: the name and the SHA-256 of the bytes. */
|
|
160
|
+
export declare function digestSubject(name: string, bytes: Uint8Array): Promise<DigestSubject>;
|
|
161
|
+
/** An in-toto Statement v1 of a predicate of the type named about the subjects. */
|
|
162
|
+
export declare function intotoStatement<const T extends string, P>(subjects: readonly DigestSubject[], predicateType: T, predicate: P): TypedStatement<T, P>;
|
|
163
|
+
/** A CycloneDX BOM as the predicate of an in-toto statement about the subjects. */
|
|
164
|
+
export declare function bomStatement(bom: CdxBom, subjects: readonly DigestSubject[]): TypedStatement<typeof CYCLONEDX_PREDICATE_TYPE, CdxBom>;
|