fides

type Anchor struct {
	Anchored bool `json:"anchored"`
	// HeadMatches is false when the chain has moved on since it was anchored,
	// or when it was rewritten under the anchor.
	HeadMatches bool      `json:"head_matches"`
	TSAURL      string    `json:"tsa_url,omitempty"`
	AnchoredAt  time.Time `json:"anchored_at,omitempty"`
}

type Approval struct {
	// By is the human the approval belongs to. Required.
	//
	// Sent as `on_behalf_of`, because Hecate authenticates to Fides with a
	// service token: without it every approval Hecate records would carry the
	// service account's identity, every identity would be equal, and
	// segregation of duties would evaluate one person having done everything.
	// Fides honours the delegation only when it is configured to and the email
	// is a known user in the organisation — so this can be refused, and a
	// refusal is a real answer rather than a transport failure.
	By string
	// Role is RoleApprover or RoleDeployer.
	Role string
	// Reason is free text stored with the approval.
	Reason string
}

type Artifact struct {
	// SHA256 identifies it. The `sha256:` prefix is stripped before sending —
	// Fides keys artifacts on lowercase hex.
	SHA256 string
	// Trail links the artifact to the evidence recorded against it.
	Trail string
	// Name is human-readable, e.g. the image repository.
	Name string
	// Type is what kind of thing it is, e.g. container-image.
	Type string
	// Tags are arbitrary labels.
	Tags map[string]string
}

type Attestation struct {
	// Name is what this evidence is, e.g. "promotion".
	Name string
	// Type is the attestation type an environment policy asks for by name, so
	// `policy check` can require it. Getting this wrong means a policy that
	// requires "deployment" never sees one.
	Type string
	// ArtifactSHA256 ties the evidence to what was deployed.
	ArtifactSHA256 string
	// Payload is the evidence body, stored and hashed into the chain.
	Payload any
	// SignedBy is who or what produced it.
	SignedBy string
}

type Chain struct {
	// Valid is false when the chain has been tampered with, reordered, or had
	// an entry deleted.
	Valid bool `json:"valid"`
	// Count is how many attestations are on the trail.
	Count int `json:"count"`
	// BrokenAt is the index of the first bad entry, or -1 when valid.
	BrokenAt int `json:"broken_at"`
	// Reason says what was wrong, when something was.
	Reason string `json:"reason,omitempty"`
	// ExternalAnchor reports whether the chain head was timestamped by an
	// external authority. A valid chain that only we vouch for is a weaker
	// claim than one an RFC3161 authority saw at a point in time.
	ExternalAnchor *Anchor `json:"external_anchor,omitempty"`
}

type ChangeRequest struct {
	// Number is the CHG record, e.g. CHG0033184.
	Number string `json:"number"`
	// State is the readable label — new, assess, authorize, scheduled,
	// implement, review, closed — normalised by Fides from ServiceNow's codes.
	State string `json:"state"`
	// Approval is ServiceNow's own word: "approved", "requested",
	// "not requested", "rejected".
	Approval string `json:"approval"`
	// Risk is ServiceNow's risk as a string, because that is what it sends.
	Risk string `json:"risk"`
	// OnHold is why a change that looks approved still is not actionable.
	OnHold bool `json:"on_hold"`
	// ShortDescription is the ticket's own title.
	ShortDescription string `json:"short_description"`
	// Found is false when ServiceNow had no such change. Kept because "the
	// change does not exist" and "the change is not approved" are different
	// answers with different fixes.
	Found bool `json:"found"`

	// Compliant is whether the attestation satisfied the type's rules — Fides'
	// judgement, not a field of the change itself.
	Compliant bool `json:"-"`
	// At is when it was attested, so a reader can tell a fresh check from one
	// made a fortnight ago.
	At string `json:"-"`
}

type ChangeVerdict struct {
	// Recommendation is "approve" or "hold".
	Recommendation string `json:"recommendation"`
	// Approved is Fides' own boolean, true only when every control is satisfied
	// and a human has signed off.
	Approved bool `json:"approved"`
	// RiskScore is 0-100, higher being worse.
	RiskScore int `json:"risk_score"`
	// RiskLevel is "low", "medium" or "high".
	RiskLevel string `json:"risk_level"`
	// Passed names the controls that were satisfied, by key alone — Fides sends
	// strings here and objects for the two below, and that asymmetry is real.
	Passed []string `json:"passed,omitempty"`
	// Failed and MissingEvidence name the controls that stopped it, so a held
	// crossing can say what would unblock it.
	Failed          []Control `json:"failed,omitempty"`
	MissingEvidence []Control `json:"missing_evidence,omitempty"`
	// Waived are the controls a human has excused, with who excused them and
	// until when. A waiver is a governed exception rather than a pass, so it is
	// reported separately: an auditor's first question about a green gate is
	// which of it was waived.
	Waived []Control `json:"waived,omitempty"`
	// Attestations counts the evidence on the trail.
	Attestations struct {
		Total        int `json:"total"`
		NonCompliant int `json:"non_compliant"`
	} `json:"attestations"`
	// Approvals is who signed off, and whether that satisfied four-eyes.
	Approvals struct {
		Count          int      `json:"count"`
		HumanApprovers int      `json:"human_approvers"`
		FourEyes       bool     `json:"four_eyes"`
		Approvers      []string `json:"approvers,omitempty"`
		Deployers      []string `json:"deployers,omitempty"`
	} `json:"approvals"`
	// SoD is Fides' segregation-of-duties finding: committer, approver and
	// deployer must be three distinct people.
	SoD *SegregationOfDuties `json:"segregation_of_duties,omitempty"`
	// Summary is Fides' own sentence about the verdict.
	Summary string `json:"summary,omitempty"`
}

type Client struct {
	// contains filtered or unexported fields
}

type Compliance struct {
	Compliant  bool     `json:"compliant"`
	Violations []string `json:"violations,omitempty"`
}

type Config struct {
	// BaseURL is the server root, e.g. https://fides.acme.io. Required: there
	// is no public Fides to default to.
	BaseURL string
	// Token is a Fides API key, sent as a bearer token.
	Token string
	// Timeout bounds a single call. Zero uses 30s.
	Timeout time.Duration
}

type Control struct {
	Key  string `json:"control"`
	Name string `json:"name"`
	// Reasons are Fides' own phrasings, e.g. "missing sbom".
	Reasons []string `json:"reasons,omitempty"`
	// WaivedReasons is what the waiver excused, present only on Waived.
	WaivedReasons []string `json:"waived_reasons,omitempty"`
	Reason        string   `json:"reason,omitempty"`
	ApprovedBy    string   `json:"approved_by,omitempty"`
	ExpiresAt     string   `json:"expires_at,omitempty"`
}

type Error struct {
	Status int
	Method string
	Path   string
	Body   string
}

type PolicyResult struct {
	Policy string `json:"policy"`
	// Applies is false when the policy is conditional on a flow tag the trail
	// does not carry. A policy that did not apply is not a policy that passed.
	Applies bool `json:"applies"`
	// Missing lists the attestation types the policy required and the trail
	// does not have a compliant one of.
	Missing []string `json:"missing,omitempty"`
}

type PolicyVerdict struct {
	Compliant bool           `json:"compliant"`
	TrailID   string         `json:"trail_id,omitempty"`
	Results   []PolicyResult `json:"results,omitempty"`
}

type SegregationOfDuties struct {
	Committer  string   `json:"committer,omitempty"`
	Approvers  []string `json:"approvers,omitempty"`
	Deployers  []string `json:"deployers,omitempty"`
	Compliant  bool     `json:"compliant"`
	Violations []string `json:"violations,omitempty"`
}

type UncountedError struct {
	// Kind is what Fides stored, e.g. "service". Anything but "session" is
	// uncounted.
	Kind string
	// By is the identity the approval was meant to be attributed to.
	By string
	// Role is the role that was recorded.
	Role string
}