attest
Everything exported by guardlink/attest, from the .d.ts files published in guardlink@2.5.0. See the entry points for the other subpaths, and use guardlink as a library for worked examples.
Interfaces
Section titled “Interfaces”AttestationRow
Section titled “AttestationRow”Properties
Section titled “Properties”| Property | Type |
|---|---|
after? |
string |
basis? |
"available" | "called" |
before? |
string |
claim_keys |
string[] |
coverage |
object |
coverage.available |
"complete" | "partial" | "unknown" | "not_collected" |
coverage.called |
"complete" | "partial" | "unknown" | "not_collected" |
coverage.reason? |
string |
coverage.truncated |
boolean |
identity |
ObservedIdentity |
name |
string |
observation |
number |
reason? |
string |
source |
"static" | "introspection" | "remote" | "otel" | "probe" |
window |
{ from: string; to: string; } | null | undefined |
ReachAttestation
Section titled “ReachAttestation”Properties
Section titled “Properties”| Property | Type |
|---|---|
declared_not_observed |
AttestationRow[] |
observed_not_declared |
AttestationRow[] |
pin_changed |
AttestationRow[] |
summary |
object |
summary.matched_tools |
number |
summary.observations |
number |
summary.unpinned_tools |
number |
unknown |
AttestationRow[] |
version |
1 |
Variables
Section titled “Variables”identityKey
Section titled “identityKey”
constidentityKey: (i) =>string
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
i |
ObservedIdentity |
Returns
Section titled “Returns”string
Functions
Section titled “Functions”buildReachAttestation()
Section titled “buildReachAttestation()”buildReachAttestation(
model,doc,pins?):ReachAttestation
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
model |
ThreatModel |
doc |
ObservedReach |
pins? |
ToolPins |
Returns
Section titled “Returns”parseObservedReach()
Section titled “parseObservedReach()”parseObservedReach(
value):ObservedReach
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
unknown |
Returns
Section titled “Returns”parseToolPins()
Section titled “parseToolPins()”parseToolPins(
value):ToolPins
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value |
unknown |
Returns
Section titled “Returns”readObservedState()
Section titled “readObservedState()”readObservedState(
root):object
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
root |
string |
Returns
Section titled “Returns”object
observed?
Section titled “observed?”
optionalobserved?:ObservedReach
optionalpins?:ToolPins
storeObservedReach()
Section titled “storeObservedReach()”storeObservedReach(
root,input):ObservedReach
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
root |
string |
input |
string |
Returns
Section titled “Returns”References
Section titled “References”Observation
Section titled “Observation”Re-exports Observation
ObservedIdentity
Section titled “ObservedIdentity”Re-exports ObservedIdentity
ObservedReach
Section titled “ObservedReach”Re-exports ObservedReach
ObservedTool
Section titled “ObservedTool”Re-exports ObservedTool
ToolPins
Section titled “ToolPins”Re-exports ToolPins