Crate bitwarden_core

Source
Expand description

§Bitwarden Core

Contains core functionality used by the feature crates. For an introduction to the Bitwarden SDK and the bitwarden-core create please refer to the SDK Architecture documentation.

Generally you should not find yourself needing to edit this crate! When possible, please use the feature crates instead.

§Features

  • internal - Internal unstable APIs that should only be consumed by internal Bitwarden clients.
  • no-memory-hardening - Disables bitwarden-crypto memory hardening.
  • secrets - Secrets Manager specific functionality.
  • uniffi - Mobile bindings.
  • wasm - WebAssembly bindings.

Re-exports§

pub use client::Client;
pub use client::ClientSettings;
pub use client::DeviceType;

Modules§

admin_console
Admin console module for Bitwarden Core.
auth
Authentication module
client
Bitwarden SDK Client
error 🔒
Errors that can occur when using this SDK
ids 🔒
key_management
This module contains the definition for the key identifiers used by the rest of the crates. Any code that needs to interact with the [KeyStore] should use these types.
mobile
Mobile specific functionality.
platform
Platform code
secrets_manager
Secrets Manager specific code.
uniffi_support 🔒
This module contains custom type converters for Uniffi.
util 🔒

Macros§

require
This macro is used to require that a value is present or return an error otherwise. It is equivalent to using val.ok_or(Error::MissingFields)?, but easier to use and with a more descriptive error message. Note that this macro will return early from the function if the value is not present.

Structs§

MissingFieldError
Missing required field.
MissingPrivateKeyError
Missing private key.
NotAuthenticatedError
Client is not authenticated or the session has expired.
OrganizationId
NewType wrapper for OrganizationId
VaultLockedError
Client vault is locked.
WrongPasswordError
Wrong password.
ZeroizingAllocator
Allocator wrapper that zeros on free

Enums§

ApiError
Errors from performing network requests.

Constants§

UNIFFI_META_CONST_NAMESPACE_BITWARDEN_CORE 🔒
Export namespace metadata.