Enum Kind 

#[non_exhaustive]
pub enum Kind {
    OpenAiApiKey,
    AnthropicApiKey,
    GoogleApiKey,
    AwsAccessKey,
    GitHubToken,
    GitLabToken,
    SlackToken,
    StripeKey,
    HuggingFaceToken,
    JsonWebToken,
    PrivateKey,
    Assigned,
}

What kind of secret a SecretMatch is.

Variants (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.

OpenAiApiKey

An OpenAI API key: sk-, sk-proj- or sk-svcacct-.

AnthropicApiKey

An Anthropic API key: sk-ant-.

GoogleApiKey

A Google API key: AIza.

AwsAccessKey

An AWS access key id: AKIA or ASIA.

GitHubToken

A GitHub token: ghp_, gho_, ghu_, ghs_, ghr_ or github_pat_.

GitLabToken

A GitLab personal access token: glpat-.

SlackToken

A Slack token: xoxa-, xoxb-, xoxp-, xoxr- or xoxs-.

StripeKey

A Stripe secret or restricted key: sk_live_, sk_test_, rk_live_ or rk_test_.

HuggingFaceToken

A Hugging Face access token: hf_.

JsonWebToken

A JSON Web Token, such as an OAuth access or id token: a base64url header and payload, each a JSON object (eyJ…), and a signature, joined by .; the signature may be empty.

PrivateKey

A PEM private key block, -----BEGIN … PRIVATE KEY----- through its end line, or through the end of the text when it has none.

Assigned

A value assigned to a name that says it is secret, NAME=value or NAME: value: the name in upper snake case and, or ending in, SECRET, TOKEN, PASSWORD, PASSWD, API_KEY, ACCESS_KEY, SECRET_KEY or PRIVATE_KEY (so AWS_SECRET_ACCESS_KEY and GITHUB_TOKEN, not MAX_TOKENS or TOKEN_COUNT). The value runs to its closing quote when quoted, else to whitespace, a quote, ,, ; or & (the next assignment of a query string); one of at most 7 characters, all digits, starting with $ (a reference such as $GITHUB_TOKEN), with characters other than printable ASCII (a placeholder such as ‹SECRET_1›), or REDACTED is not a secret. Only the value is the secret.

Implementations

impl Kind

pub fn name(self) -> &'static str

The kind’s name, such as OpenAI API key.

Trait Implementations

impl Clone for Kind

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Kind

impl Debug for Kind

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

Formats the value using the given formatter.

impl Display for Kind

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

Formats the value using the given formatter.

impl Eq for Kind

impl Hash for Kind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Kind

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Kind