Skip to main content

PolicyError

Enum PolicyError 

Source
#[non_exhaustive]
pub enum PolicyError { InvalidConfiguration(String), MissingIdentityClaim { claim: &'static str, }, MalformedIdentityClaim { claim: &'static str, reason: String, }, IssuerMismatch { expected: String, found: String, }, SourceRepositoryMismatch { expected: String, found: String, }, SourceOwnerIdMismatch { expected: String, found: String, }, SourceRepositoryIdMismatch { expected: String, found: String, }, SourceRefMismatch { expected: String, found: String, }, SourceCommitMismatch { expected: String, found: String, }, SignerRepositoryMismatch { expected: String, found: String, }, SignerWorkflowPathMismatch { expected: String, found: String, }, SignerRevisionMismatch { expected: String, found: String, }, }
Expand description

The caller-supplied identity policy was not satisfied.

Matching (crate::policy_match) never infers what a mismatch might mean; every variant below names exactly which comparison failed, and (where applicable) carries the expected policy value alongside the found authenticated certificate value (DESIGN.md “Core decisions” item 8).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

InvalidConfiguration(String)

A policy builder was given an empty or malformed value.

§

MissingIdentityClaim

A Fulcio identity claim needed to evaluate the policy was absent from the certificate (its extension was not present).

Fields

§claim: &'static str

The name of the missing claim (e.g. "source_repository_uri").

§

MalformedIdentityClaim

A Fulcio identity claim was present but not in the shape this crate requires to evaluate policy (e.g. the source repository URI or the SAN URI did not match the expected https://github.com/... shape).

Fields

§claim: &'static str

The name of the malformed claim.

§reason: String

Human-readable reason the claim was rejected.

§

IssuerMismatch

The certificate’s authenticated OIDC issuer did not match the pinned GitHub Actions issuer.

Fields

§expected: String

The pinned issuer this crate requires.

§found: String

The issuer found in the certificate.

§

SourceRepositoryMismatch

The certificate’s authenticated source repository (owner/name) did not match the policy’s required source repository.

Fields

§expected: String

The owner/name the policy requires.

§found: String

The owner/name found in the certificate.

§

SourceOwnerIdMismatch

The certificate’s authenticated source repository owner id did not match the policy’s pinned owner id.

Fields

§expected: String

The decimal owner id the policy requires.

§found: String

The decimal owner id found in the certificate.

§

SourceRepositoryIdMismatch

The certificate’s authenticated source repository id did not match the policy’s pinned repository id.

Fields

§expected: String

The decimal repository id the policy requires.

§found: String

The decimal repository id found in the certificate.

§

SourceRefMismatch

The certificate’s authenticated source ref did not satisfy the policy’s ref requirement (Exact or Glob).

Fields

§expected: String

The policy’s required ref or ref-glob pattern.

§found: String

The ref found in the certificate.

§

SourceCommitMismatch

The certificate’s authenticated source commit did not match the policy’s required commit.

Fields

§expected: String

The commit sha (lowercase hex) the policy requires.

§found: String

The commit sha found in the certificate.

§

SignerRepositoryMismatch

The certificate’s authenticated signer-workflow repository (owner/name) did not match the policy’s required repository.

Fields

§expected: String

The owner/name the policy requires.

§found: String

The owner/name found in the certificate’s SAN.

§

SignerWorkflowPathMismatch

The certificate’s authenticated signer-workflow path did not match the policy’s required path.

Fields

§expected: String

The workflow path the policy requires.

§found: String

The workflow path found in the certificate’s SAN.

§

SignerRevisionMismatch

The certificate’s authenticated signer-workflow revision did not satisfy the policy’s revision requirement (Ref or Sha).

Fields

§expected: String

The ref or commit sha the policy requires.

§found: String

The ref or digest found in the certificate.

Trait Implementations§

Source§

impl Debug for PolicyError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for PolicyError

Source§

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for PolicyError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<PolicyError> for Error

Source§

fn from(source: PolicyError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.