Enum KeyProvider 

pub enum KeyProvider {
    Age,
    Pgp,
    AwsKms,
    GcpKms,
    HuaweiKms,
    AzureKeyVault,
    HcVault,
}

A key provider that can wrap the data key.

Present as a closed enum even for the providers we do not yet implement, because ★★ MODULARIZE, DON’T DELETE cuts both ways: a provider we cannot serve should be a named refusal, not an unparseable file. A sops file carrying KMS keys must round-trip through us intact even when we cannot unwrap it, or aliasing us over sops would corrupt files on write.

Variants

Age

X25519 age recipients. Implemented.

Pgp

PGP fingerprints, via gpg. Declared, not implemented.

AwsKms

AWS KMS ARNs. Declared, not implemented.

GcpKms

GCP KMS resource IDs. Declared, not implemented.

HuaweiKms

HuaweiCloud KMS key IDs. Declared, not implemented.

AzureKeyVault

Azure Key Vault URLs. Declared, not implemented.

HcVault

HashiCorp Vault transit URIs. Declared, not implemented.

Implementations

impl KeyProvider

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

The sops.<field> name this provider’s keys live under.

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

The --decryption-order token for this provider.

pub fn is_implemented(self) -> bool

Whether this build can actually unwrap a data key for this provider.

A typed false rather than a missing variant: the file still parses, the key still round-trips, and the refusal is nameable at the point a caller needs a data key. That is the difference between “we do not support KMS” and “we corrupt KMS files”.

Trait Implementations

impl Clone for KeyProvider

fn clone(&self) -> KeyProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyProvider

impl Debug for KeyProvider

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

Formats the value using the given formatter.

impl Eq for KeyProvider

impl Hash for KeyProvider

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 Ord for KeyProvider

fn cmp(&self, other: &KeyProvider) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for KeyProvider

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for KeyProvider

fn partial_cmp(&self, other: &KeyProvider) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for KeyProvider