Struct Cipher

pub struct Cipher {

    pub id: Option<Uuid>,
    pub organization_id: Option<Uuid>,
    pub folder_id: Option<Uuid>,
    pub collection_ids: Vec<Uuid>,
    pub key: Option<EncString>,
    pub name: EncString,
    pub notes: Option<EncString>,
    pub type: CipherType,
    pub login: Option<Login>,
    pub identity: Option<Identity>,
    pub card: Option<Card>,
    pub secure_note: Option<SecureNote>,
    pub ssh_key: Option<SshKey>,
    pub favorite: bool,
    pub reprompt: CipherRepromptType,
    pub organization_use_totp: bool,
    pub edit: bool,
    pub view_password: bool,
    pub local_data: Option<LocalData>,
    pub attachments: Option<Vec<Attachment>>,
    pub fields: Option<Vec<Field>>,
    pub password_history: Option<Vec<PasswordHistory>>,
    pub creation_date: DateTime<Utc>,
    pub deleted_date: Option<DateTime<Utc>>,
    pub revision_date: DateTime<Utc>,
}

Fields

id: Option<Uuid>

organization_id: Option<Uuid>

folder_id: Option<Uuid>

collection_ids: Vec<Uuid>

key: Option<EncString>

More recent ciphers uses individual encryption keys to encrypt the other fields of the Cipher.

name: EncString

notes: Option<EncString>

type: CipherType

login: Option<Login>

identity: Option<Identity>

card: Option<Card>

secure_note: Option<SecureNote>

ssh_key: Option<SshKey>

favorite: bool

reprompt: CipherRepromptType

organization_use_totp: bool

edit: bool

view_password: bool

local_data: Option<LocalData>

attachments: Option<Vec<Attachment>>

fields: Option<Vec<Field>>

password_history: Option<Vec<PasswordHistory>>

creation_date: DateTime<Utc>

deleted_date: Option<DateTime<Utc>>

revision_date: DateTime<Utc>

Implementations

impl Cipher

pub(super) fn get_cipher_key( key: &SymmetricCryptoKey, ciphers_key: &Option<EncString>, ) -> Result<Option<SymmetricCryptoKey>, CryptoError>

Get the decrypted individual encryption key for this cipher. Note that some ciphers do not have individual encryption keys, in which case this will return Ok(None) and the key associated with this cipher’s user or organization must be used instead

fn get_decrypted_subtitle( &self, key: &SymmetricCryptoKey, ) -> Result<String, CryptoError>

Trait Implementations

impl Clone for Cipher

fn clone(&self) -> Cipher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for Cipher

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for Cipher

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Cipher

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for Cipher

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl JsonSchema for Cipher

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl KeyDecryptable<SymmetricCryptoKey, CipherListView> for Cipher

fn decrypt_with_key( &self, key: &SymmetricCryptoKey, ) -> Result<CipherListView, CryptoError>

impl KeyDecryptable<SymmetricCryptoKey, CipherView> for Cipher

fn decrypt_with_key( &self, key: &SymmetricCryptoKey, ) -> Result<CipherView, CryptoError>

impl KeyEncryptable<SymmetricCryptoKey, Cipher> for CipherView

fn encrypt_with_key( self, key: &SymmetricCryptoKey, ) -> Result<Cipher, CryptoError>

impl<UT> Lift<UT> for Cipher

type FfiType = <Cipher as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for Cipher

type LiftType = Cipher

impl<UT> LiftReturn<UT> for Cipher

type ReturnType = <Cipher as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl LocateKey for Cipher

fn locate_key<'a>( &self, enc: &'a dyn KeyContainer, _: &Option<Uuid>, ) -> Result<&'a SymmetricCryptoKey, CryptoError>

impl<UT> Lower<UT> for Cipher

type FfiType = <Cipher as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for Cipher

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Cipher

type ReturnType = <Cipher as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl Serialize for Cipher

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CipherDetailsResponseModel> for Cipher

type Error = VaultParseError

The type returned in the event of a conversion error.

fn try_from(cipher: CipherDetailsResponseModel) -> Result<Self, Self::Error>

Performs the conversion.

impl<UT> TypeId<UT> for Cipher

const TYPE_ID_META: MetadataBuffer = _