Crate bitwarden_wasm_internal 

bitwarden-wasm-internal

Note: This is only for internal use. Bitwarden will not provide any support for this crate.

Bitwarden WASM internal exposes WebAssembly bindings for the Bitwarden SDK. This crate should contain no logic but rather only handle WASM unique conversions and bindings. Business logic MUST be placed in the relevant feature crates.

Getting Started

Requirements

• wasm32-unknown-unknown rust target.
• binaryen installed for wasm-opt and wasm2js.
• npm packages must be installed in the npm folder. Run npm ci inside:
  • OSS: crates/bitwarden-wasm-internal/npm
  • Commercial: crates/bitwarden-wasm-internal/bitwarden_license/npm

rustup target add wasm32-unknown-unknown
brew install binaryen

Building

# dev
./build.sh

# dev with commercial license
./build.sh -b

# release
./build.sh -r

# release with commercial license
./build.sh -r -b

Modules

client 🔒

custom_types 🔒

flight_recorder 🔒

WASM bindings for the Flight Recorder.

init 🔒

platform 🔒

pure_crypto 🔒

ssh 🔒

Structs

ChannelError

DeserializeError

FlightRecorderClient

WASM client for reading Flight Recorder logs.

InviteLinkAdminClient

Client for organization invite link administrative (organization-key) operations: creating, refreshing, updating, deleting, and inspecting invite links, and recovering the invite secret.

InviteLinkClient

Client for organization invite link operations.

InviteLinkUserClient

Client for organization invite link invitee (user) operations: checking link status, validating email eligibility, and accepting or self-confirming an invite.

JsCommunicationBackend

JavaScript implementation of the CommunicationBackend trait for IPC communication.

JsCommunicationBackendSender

JavaScript interface for handling outgoing messages from the IPC framework.

JsIpcClient

JavaScript wrapper around the IPC client. For more information, see the [IpcClient] trait documentation.

JsIpcClientSubscription

JavaScript wrapper around the IPC client subscription. For more information, see the IpcClientSubscription documentation.

JsServerCommunicationConfigClient

JavaScript wrapper for ServerCommunicationConfigClient

JsServerCommunicationConfigPlatformApi

Thread-safe JavaScript implementation of ServerCommunicationConfigPlatformApi

JsServerCommunicationConfigRepository

Thread-safe JavaScript implementation of ServerCommunicationConfigRepository

JsSessionRepository

Thread safe JavaScript implementation of the SessionRepository trait for IPC sessions.

ManagedSettingsClient

Handle to the host system’s Unified Endpoint Management profile.

OrganizationInviteLink

An organization invite link as persisted by the server.

OrganizationInviteLinkSsoView

SSO details for an organization referenced by an invite link status.

OrganizationInviteLinkStatusView

The status of an organization invite link, used to verify basic availability before an invitee attempts to accept.

OrganizationInviteLinkView

An organization invite link with reconstructed URL for display by the client.

OrganizationUserBulkResponse

The outcome of a bulk member operation for one organization member.

OrganizationUsersManagementClient

Client for administering the members of an organization.

PasswordManagerClient

The main entry point for the Bitwarden SDK in WebAssembly environments

RawJsServerCommunicationConfigPlatformApi

JavaScript interface for the ServerCommunicationConfigPlatformApi

RawJsServerCommunicationConfigRepository

JavaScript interface for the ServerCommunicationConfigRepository

RawJsSessionRepository

JavaScript interface for handling outgoing messages from the IPC framework.

RawJsSharedUnlockDriver

JavaScript implementation of shared unlock operations used by shared unlock protocol.

SharedUnlockPeer

Shared-unlock peer for WASM clients.

Enums

InviteLinkError

Errors returned from invite link client operations.

OrganizationUsersManagementError

Errors returned from OrganizationUsersManagementClient operations.

WasmCommunicationError

Error type for the WASM communication backend’s send and receive operations.

Traits

InviteLinkClientExt

Extension trait that exposes InviteLinkClient on [Client].

OrganizationUsersManagementClientExt

Extension trait exposing OrganizationUsersManagementClient on [Client].

Functions

init_sdk

Initialize the SDK. Must be called before using any other API. Only the first invocation has effect; subsequent calls are ignored.

ipc_register_discover_handler

Registers a DiscoverHandler so that the client can respond to DiscoverRequests.

ipc_request_discover

Sends a DiscoverRequest to the specified destination and returns the response.