Struct CipherView 

pub struct CipherView {

    pub id: Option<CipherId>,
    pub organization_id: Option<OrganizationId>,
    pub folder_id: Option<FolderId>,
    pub collection_ids: Vec<CollectionId>,
    pub key: Option<SymmetricCryptoKey>,
    pub name: String,
    pub notes: Option<String>,
    pub type: CipherType,
    pub login: Option<LoginView>,
    pub identity: Option<IdentityView>,
    pub card: Option<CardView>,
    pub secure_note: Option<SecureNoteView>,
    pub ssh_key: Option<SshKeyView>,
    pub bank_account: Option<BankAccountView>,
    pub drivers_license: Option<DriversLicenseView>,
    pub passport: Option<PassportView>,
    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<LocalDataView>,
    pub attachments: Option<Vec<AttachmentView>>,
    pub attachment_decryption_failures: Option<Vec<AttachmentView>>,
    pub fields: Option<Vec<FieldView>>,
    pub password_history: Option<Vec<PasswordHistoryView>>,
    pub creation_date: DateTime<Utc>,
    pub deleted_date: Option<DateTime<Utc>>,
    pub revision_date: DateTime<Utc>,
    pub archived_date: Option<DateTime<Utc>>,
    pub partial: bool,
}

Fields

id: Option<CipherId>

organization_id: Option<OrganizationId>

folder_id: Option<FolderId>

collection_ids: Vec<CollectionId>

key: Option<SymmetricCryptoKey>

name: String

notes: Option<String>

type: CipherType

login: Option<LoginView>

identity: Option<IdentityView>

card: Option<CardView>

secure_note: Option<SecureNoteView>

ssh_key: Option<SshKeyView>

bank_account: Option<BankAccountView>

drivers_license: Option<DriversLicenseView>

passport: Option<PassportView>

favorite: bool

reprompt: CipherRepromptType

organization_use_totp: bool

edit: bool

permissions: Option<CipherPermissions>

view_password: bool

local_data: Option<LocalDataView>

attachments: Option<Vec<AttachmentView>>

attachment_decryption_failures: Option<Vec<AttachmentView>>

Attachments that failed to decrypt. Only present when there are decryption failures.

fields: Option<Vec<FieldView>>

password_history: Option<Vec<PasswordHistoryView>>

creation_date: DateTime<Utc>

deleted_date: Option<DateTime<Utc>>

revision_date: DateTime<Utc>

archived_date: Option<DateTime<Utc>>

partial: bool

True when this view was produced from a server-restricted (PAM-gated) cipher. Only a sub-set of fields are populated; every secret field is absent. See Cipher::partial_data. Such a view is fail-closed against re-encryption: passing it to any encrypt path returns [bitwarden_crypto::CryptoError::EncryptRestrictedView] rather than silently stripping secrets.

Implementations

impl CipherView

Item Send payloads: the sealed blob is the entire data string of an Item Send, sealed directly under the send key. It has no outer cipher key and no metadata; only the blob contents (name, notes, type data, fields, password history) round-trip.

CipherView --seal_blob_for_item_sends(send key)--> SendItem.data (opaque string)
SendItem.data --unseal_blob_for_item_sends(send key)--> CipherView (metadata defaulted)

pub fn seal_blob_for_item_sends( &self, ctx: &mut KeyStoreContext<'_, KeySlotIds>, key: SymmetricKeySlotId, ) -> Result<String, CryptoError>

Seals the sensitive contents of this view into an opaque blob string under key.

pub fn unseal_blob_for_item_sends( data: &str, ctx: &mut KeyStoreContext<'_, KeySlotIds>, key: SymmetricKeySlotId, ) -> Result<CipherView, CryptoError>

Unseals a blob produced by CipherView::seal_blob_for_item_sends. Metadata absent from the blob (ids, dates, flags) is set to defaults; the type follows the blob contents.

impl CipherView

fn encrypt_legacy_field_encryption( &mut self, ctx: &mut KeyStoreContext<'_, KeySlotIds>, key: SymmetricKeySlotId, ) -> Result<Cipher, CryptoError>

impl CipherView

pub fn load_cipher_key_slot( &mut self, ctx: &mut KeyStoreContext<'_, KeySlotIds>, ) -> Result<SymmetricKeySlotId, CryptoError>

Returns the context slot holding the cipher’s own key, generating and storing one if the view doesn’t have it yet. Every cipher the SDK encrypts carries its own key.

pub fn generate_checksums(&mut self)

pub fn remove_invalid_checksums(&mut self)

pub fn get_fido2_credentials(&self) -> Vec<Fido2CredentialView>

pub fn move_to_organization( &mut self, organization_id: OrganizationId, ) -> Result<(), CipherError>

Moves the cipher to an organization by assigning the organization ID to the cipher.

Arguments

• organization_id - The ID of the organization to move the cipher to

pub fn validate_attachment_keys(&mut self) -> Result<(), CipherError>

Validates that all attachments have keys, returning an error if any are missing.

Key re-wrapping under the new wrapping key happens at encrypt time inside CompositeEncryptable / encrypt_legacy_field_encryption.

pub fn set_new_fido2_credentials( &mut self, creds: Vec<Fido2CredentialFullView>, ) -> Result<(), CipherError>

pub(crate) fn update_password_history(&mut self, original_cipher: &CipherView)

pub(crate) fn to_list_view(&self) -> Result<CipherListView, CryptoError>

Projects this CipherView into a CipherListView.

Used by the blob decryption path: blob ciphers are fully unsealed to a CipherView by decrypt_blob_cipher, and this method then derives the list-view shape without re-decrypting any sensitive fields.

fn subtitle(&self) -> String

Derives the list-view subtitle from the decrypted view fields.

Mirrors the per-type logic that CipherKind::decrypt_subtitle runs against encrypted fields, but operates on the already-decrypted view.

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

Derives copyable-field hints from the decrypted view fields.

Mirrors the per-type logic that CipherKind::get_copyable_fields runs on encrypted types.

Trait Implementations

impl Clone for CipherView

fn clone(&self) -> CipherView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for CipherView

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

impl Debug for CipherView

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

Formats the value using the given formatter.

impl Decryptable<KeySlotIds, SymmetricKeySlotId, CipherView> for Cipher

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

Decrypts self into an Output under key. See the trait-level contract: the result must contain no cipher text.

impl Decryptable<KeySlotIds, SymmetricKeySlotId, CipherView> for StrictDecrypt<Cipher>

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

Decrypts self into an Output under key. See the trait-level contract: the result must contain no cipher text.

impl<'de> Deserialize<'de> for CipherView

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 CipherView

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<CipherView> for JsValue

where CipherView: Serialize,

fn from(value: CipherView) -> Self

Converts to this type from the input type.

impl FromWasmAbi for CipherView

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<SymmetricKeySlotId> for CipherView

fn key_identifier(&self) -> SymmetricKeySlotId

impl IntoWasmAbi for &CipherView

where CipherView: 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 IntoWasmAbi for CipherView

where CipherView: 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 CipherView

type FfiType = <CipherView 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 CipherView

type LiftType = CipherView

impl<UT> LiftReturn<UT> for CipherView

type ReturnType = <CipherView 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 CipherView

type FfiType = <CipherView 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 CipherView

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CipherView

type ReturnType = <CipherView 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 CipherView

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 CipherView

where CipherView: Serialize,

fn none() -> Self::Abi

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

impl PartialEq for CipherView

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

Equality operator ==.

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

Inequality operator !=.

impl RefFromWasmAbi for CipherView

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<CipherView>

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 Serialize for CipherView

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CipherView

impl TryFrom<CipherView> for CipherEditRequest

type Error = MissingFieldError

The type returned in the event of a conversion error.

fn try_from(value: CipherView) -> Result<Self, Self::Error>

Performs the conversion.

impl Tsify for CipherView

const DECL: &'static str = "export interface CipherView {\n id: CipherId | undefined;\n organizationId: OrganizationId | undefined;\n folderId: FolderId | undefined;\n collectionIds: CollectionId[];\n key: SymmetricKey | undefined;\n name: string;\n notes: string | undefined;\n type: CipherType;\n login: LoginView | undefined;\n identity: IdentityView | undefined;\n card: CardView | undefined;\n secureNote: SecureNoteView | undefined;\n sshKey: SshKeyView | undefined;\n bankAccount: BankAccountView | undefined;\n driversLicense: DriversLicenseView | undefined;\n passport: PassportView | undefined;\n favorite: boolean;\n reprompt: CipherRepromptType;\n organizationUseTotp: boolean;\n edit: boolean;\n permissions: CipherPermissions | undefined;\n viewPassword: boolean;\n localData: LocalDataView | undefined;\n attachments: AttachmentView[] | undefined;\n /**\n * Attachments that failed to decrypt. Only present when there are decryption failures.\n */\n attachmentDecryptionFailures?: AttachmentView[];\n fields: FieldView[] | undefined;\n passwordHistory: PasswordHistoryView[] | undefined;\n creationDate: DateTime<Utc>;\n deletedDate: DateTime<Utc> | undefined;\n revisionDate: DateTime<Utc>;\n archivedDate: DateTime<Utc> | undefined;\n /**\n * True when this view was produced from a server-restricted (PAM-gated) cipher. Only a\n * sub-set of fields are populated; every secret field is absent. See\n * [`Cipher::partial_data`].\n * Such a view is fail-closed against re-encryption: passing it to any encrypt path returns\n * [`bitwarden_crypto::CryptoError::EncryptRestrictedView`] rather than silently stripping\n * secrets.\n */\n partial?: boolean;\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 CipherView

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for CipherView

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

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

impl VectorIntoWasmAbi for CipherView

where CipherView: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

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

impl WasmDescribe for CipherView

fn describe()

impl WasmDescribeVector for CipherView

fn describe_vector()