Skip to main content

VaultSecret

Enum VaultSecret 

Source
pub enum VaultSecret {
    Password {
        username: Option<String>,
        password: String,
        totp: Option<TotpSeed>,
        login_config: Option<PasswordLoginConfig>,
        secure_notes: Option<String>,
        custom_fields: Vec<CustomField>,
    },
    Passkey {
        credential_id: String,
        private_key: String,
        algorithm: Option<String>,
        rp_id: String,
        user_handle: Option<String>,
        secure_notes: Option<String>,
    },
    OauthTokens {
        provider: String,
        refresh_token: String,
        access_token: Option<String>,
        access_token_expires_at: Option<String>,
        scopes: Vec<String>,
        secure_notes: Option<String>,
    },
    DidSelfIssued {
        did: String,
        signing_key_id: String,
        secure_notes: Option<String>,
    },
    DidcommPeer {
        peer_did: String,
        signing_key_id: String,
        secure_notes: Option<String>,
    },
    BearerToken {
        token: String,
        header_name: Option<String>,
        header_prefix: Option<String>,
        secure_notes: Option<String>,
    },
    SshKey {
        private_key: String,
        public_key: Option<String>,
        comment: Option<String>,
        passphrase: Option<String>,
        secure_notes: Option<String>,
    },
    Custom {
        fields: Vec<CustomField>,
        secure_notes: Option<String>,
    },
}
Expand description

Cleartext secret material. Field-for-field mirror of vault/_shared/0.2/vault-secret#/$defs/VaultSecret. Discriminated by kind. This secret rides inside the opaque authcrypt JWE (vault/upsert’s sealedSecret), so the vault/*/0.2 edge transform cannot reach it — the discriminator is parsed verbatim here. To accept both a 0.1 producer (kebab did-self-issued) and a spec-0.2 producer (camelCase didSelfIssued) without a breaking wire change, each multi-word variant carries a camelCase alias; the emitted form stays kebab for backwards compatibility (Postel’s law). This is the fix for the half-completed migration in issue #517 — the variant fields were camelCased in 76287a5, the discriminator was not.

Sensitive fields (password, private_key, refresh_token, secure_notes, token, etc.) MUST be zeroised by handlers as soon as their use is complete; this enum derives Debug for diagnostic convenience but production logs MUST NOT format VaultSecret via {:?} — the strings would leak straight in.

Variants§

§

Password

Fields

§username: Option<String>
§password: String
§login_config: Option<PasswordLoginConfig>

Optional driver config for vault/proxy-login/0.1 against this entry. When present, the maintainer performs an HTTP POST against loginConfig.loginUrl with the entry’s credentials. When absent, proxy-login returns not_proxyable and the consumer falls back to vault/release for browser-fill. See vault/_shared/0.1/vault-secret#/$defs/PasswordLoginConfig.

§secure_notes: Option<String>
§custom_fields: Vec<CustomField>
§

Passkey

Fields

§credential_id: String
§private_key: String
§algorithm: Option<String>
§rp_id: String
§user_handle: Option<String>
§secure_notes: Option<String>
§

OauthTokens

Fields

§provider: String
§refresh_token: String
§access_token: Option<String>
§access_token_expires_at: Option<String>
§scopes: Vec<String>
§secure_notes: Option<String>
§

DidSelfIssued

Fields

§signing_key_id: String
§secure_notes: Option<String>
§

DidcommPeer

Fields

§peer_did: String
§signing_key_id: String
§secure_notes: Option<String>
§

BearerToken

Fields

§token: String
§header_name: Option<String>
§header_prefix: Option<String>
§secure_notes: Option<String>
§

SshKey

Fields

§private_key: String
§public_key: Option<String>
§comment: Option<String>
§passphrase: Option<String>
§secure_notes: Option<String>
§

Custom

Fields

§secure_notes: Option<String>

Implementations§

Source§

impl VaultSecret

Source

pub fn kind(&self) -> SecretKind

Returns the SecretKind that matches this variant. The metadata view’s secret_kind field MUST equal this on every persisted StoredVaultEntry; an inconsistency is a programming error and callers can use VaultSecret::matches_kind to assert at the upsert / release boundary.

Source

pub fn matches_kind(&self, expected: SecretKind) -> bool

Convenience: assert that this secret’s variant matches expected. Used by handler code to fail loudly when the metadata view’s secret_kind disagrees with the unsealed secret’s discriminator.

Trait Implementations§

Source§

impl Clone for VaultSecret

Source§

fn clone(&self) -> VaultSecret

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VaultSecret

Source§

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

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

impl<'de> Deserialize<'de> for VaultSecret

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for VaultSecret

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

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> At for T

Source§

fn at<M>(self, metadata: M) -> Meta<T, M>

Wraps self inside a Meta<Self, M> using the given metadata. 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> BorrowStripped for T

Source§

fn stripped(&self) -> &Stripped<T>

Source§

impl<T> BorrowUnordered for T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<'de, T, C> DeserializeTyped<'de, C> for T
where T: Deserialize<'de>,

Source§

fn deserialize_typed<S>( _: &C, deserializer: S, ) -> Result<T, <S as Deserializer<'de>>::Error>
where S: Deserializer<'de>,

Source§

impl<T, U> DeserializeTypedOwned<T> for U
where U: for<'de> DeserializeTyped<'de, T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T, C> FromWithContext<T, C> for T

Source§

fn from_with(value: T, _context: &C) -> T

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U, C> IntoWithContext<U, C> for T
where U: FromWithContext<T, C>,

Source§

fn into_with(self, context: &C) -> U

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ResourceProvider<()> for T

Source§

fn get_resource(&self) -> &()

Returns a reference to the resource of type T.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToOwned for T

Source§

type Owned = T

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U, C> TryFromWithContext<U, C> for T
where U: IntoWithContext<T, C>,

Source§

type Error = Infallible

Source§

fn try_from_with( value: U, context: &C, ) -> Result<T, <T as TryFromWithContext<U, C>>::Error>

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.
Source§

impl<T, U, C> TryIntoWithContext<U, C> for T
where U: TryFromWithContext<T, C>,

Source§

type Error = <U as TryFromWithContext<T, C>>::Error

Source§

fn try_into_with( self, context: &C, ) -> Result<U, <T as TryIntoWithContext<U, C>>::Error>

Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

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

Source§

fn with<C>(&self, context: C) -> Contextual<&T, C>

Source§

fn into_with<C>(self, context: C) -> Contextual<T, C>
where T: Sized,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more