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 permissions: Option<CipherPermissions>,
    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

permissions: Option<CipherPermissions>

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 decrypt_cipher_key( ctx: &mut KeyStoreContext<'_, KeyIds>, key: SymmetricKeyId, ciphers_key: &Option<EncString>, ) -> Result<SymmetricKeyId, CryptoError>

Decrypt the individual encryption key for this cipher into the provided KeyStoreContext and return it’s identifier. Note that some ciphers do not have individual encryption keys, in which case this will return the provided key identifier instead

Arguments

• ctx - The key store context where the cipher key will be decrypted, if it exists
• key - The key to use to decrypt the cipher key, this should be the user or organization key
• ciphers_key - The encrypted cipher key

fn get_kind(&self) -> Option<&dyn CipherKind>

Temporary helper to return a CipherKind instance based on the cipher type.

fn decrypt_subtitle( &self, ctx: &mut KeyStoreContext<'_, KeyIds>, key: SymmetricKeyId, ) -> Result<String, CryptoError>

Returns the decrypted subtitle for the cipher, if applicable.

fn get_copyable_fields(&self) -> Vec<CopyableCipherFields>

Returns a list of copyable field names for this cipher, based on the cipher type and populated properties.

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 Decryptable<KeyIds, SymmetricKeyId, CipherListView> for Cipher

fn decrypt( &self, ctx: &mut KeyStoreContext<'_, KeyIds>, key: SymmetricKeyId, ) -> Result<CipherListView, CryptoError>

impl Decryptable<KeyIds, SymmetricKeyId, CipherView> for Cipher

fn decrypt( &self, ctx: &mut KeyStoreContext<'_, KeyIds>, key: SymmetricKeyId, ) -> Result<CipherView, CryptoError>

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 Encryptable<KeyIds, SymmetricKeyId, Cipher> for CipherView

fn encrypt( &self, ctx: &mut KeyStoreContext<'_, KeyIds>, key: SymmetricKeyId, ) -> Result<Cipher, CryptoError>

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 From<Cipher> for JsValue

where Cipher: Serialize,

fn from(value: Cipher) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Cipher

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IdentifyKey<SymmetricKeyId> for Cipher

fn key_identifier(&self) -> SymmetricKeyId

impl IntoWasmAbi for Cipher

where Cipher: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

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<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 OptionFromWasmAbi for Cipher

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Cipher

where Cipher: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Cipher

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<Cipher>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RepositoryItem for Cipher

const NAME: &'static str = "Cipher"

The name of the type implementing this trait.

fn type_id() -> TypeId

Returns the TypeId of the type implementing this trait.

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 Tsify for Cipher

const DECL: &'static str = "export interface Cipher {\n id: Uuid | undefined;\n organizationId: Uuid | undefined;\n folderId: Uuid | undefined;\n collectionIds: Uuid[];\n /**\n * More recent ciphers uses individual encryption keys to encrypt the other fields of the\n * Cipher.\n */\n key: EncString | undefined;\n name: EncString;\n notes: EncString | undefined;\n type: CipherType;\n login: Login | undefined;\n identity: Identity | undefined;\n card: Card | undefined;\n secureNote: SecureNote | undefined;\n sshKey: SshKey | undefined;\n favorite: boolean;\n reprompt: CipherRepromptType;\n organizationUseTotp: boolean;\n edit: boolean;\n permissions: CipherPermissions | undefined;\n viewPassword: boolean;\n localData: LocalData | undefined;\n attachments: Attachment[] | undefined;\n fields: Field[] | undefined;\n passwordHistory: PasswordHistory[] | undefined;\n creationDate: DateTime<Utc>;\n deletedDate: DateTime<Utc> | undefined;\n revisionDate: DateTime<Utc>;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl<UT> TypeId<UT> for Cipher

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for Cipher

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for Cipher

where Cipher: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for Cipher

fn describe()

impl WasmDescribeVector for Cipher

fn describe_vector()

impl Internal for Cipher