mirror of
https://github.com/dani-garcia/vaultwarden.wiki.git
synced 2026-11-13 19:28:36 +02:00
Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7b7341b004 | ||
|
|
81fcc94e86 | ||
|
|
975f316110 | ||
|
|
1430a64547 | ||
|
|
7c82fbed0c | ||
|
|
d28c8339fb | ||
|
|
5ad0c6d41a |
No files matched your search
@@ -411,6 +411,9 @@
|
||||
## - "biometrics-sdk-ipc": Enable biometric unlock over the SDK IPC framework (Desktop >= 2026.9.0, Browser >= 2026.9.0)
|
||||
## - "windows-native-credential-sync": Register the desktop app as a passkey provider in Windows, so passkeys in the vault can be used by other apps and browsers.
|
||||
## Requires the Microsoft Store (appx) build of the desktop app. Stable releases up to and including 2026.9.1 lack the required plugin registration, so it has no effect there yet.
|
||||
## - "pm-27278-v2-password-registration": Register new accounts with v2 encryption. (Web >= 2026.6.4, Desktop/Browser/CLI >= 2026.7.0, Android >= 2026.4.1, iOS >= 2026.5.1)
|
||||
## - "enable-account-encryption-v2-jit-password-registration": Give SSO users who set their master password on their first login v2 encryption. (Web >= 2026.1.1, Desktop/Browser/CLI >= 2026.1.0, Android >= 2026.4.1, iOS >= 2026.6.0)
|
||||
## These two flags can't be undone: a v2 account stays v2, and it can only log in from clients that are 2026.10.1 or newer (2026.10.2 for the desktop app), so the versions above are only enough to create one.
|
||||
# EXPERIMENTAL_CLIENT_FEATURE_FLAGS=
|
||||
|
||||
## Require new device emails. When a user logs in an email is required to be sent.
|
||||
|
||||
@@ -158,6 +158,13 @@ jobs:
|
||||
if: ${{ !cancelled() }}
|
||||
run: |
|
||||
cargo test --profile ci --features postgresql
|
||||
|
||||
# The test seeder only exists with this feature, which no release build has
|
||||
- name: "test features: sqlite,unsafe_test_mode"
|
||||
id: test_unsafe_test_mode
|
||||
if: ${{ !cancelled() }}
|
||||
run: |
|
||||
cargo test --profile ci --features sqlite,unsafe_test_mode
|
||||
# End Run cargo tests
|
||||
|
||||
|
||||
@@ -167,6 +174,12 @@ jobs:
|
||||
if: ${{ !cancelled() && matrix.channel == 'rust-toolchain' }}
|
||||
run: |
|
||||
cargo clippy --profile ci --features sqlite,mysql,postgresql,enable_mimalloc,s3
|
||||
|
||||
- name: "clippy features: sqlite,unsafe_test_mode"
|
||||
id: clippy_unsafe_test_mode
|
||||
if: ${{ !cancelled() && matrix.channel == 'rust-toolchain' }}
|
||||
run: |
|
||||
cargo clippy --profile ci --features sqlite,unsafe_test_mode
|
||||
# End Run cargo clippy
|
||||
|
||||
|
||||
@@ -190,7 +203,9 @@ jobs:
|
||||
TEST_SQLITE: ${{ steps.test_sqlite.outcome }}
|
||||
TEST_MYSQL: ${{ steps.test_mysql.outcome }}
|
||||
TEST_POSTGRESQL: ${{ steps.test_postgresql.outcome }}
|
||||
TEST_UNSAFE_TEST_MODE: ${{ steps.test_unsafe_test_mode.outcome }}
|
||||
CLIPPY: ${{ steps.clippy.outcome }}
|
||||
CLIPPY_UNSAFE_TEST_MODE: ${{ steps.clippy_unsafe_test_mode.outcome }}
|
||||
FMT: ${{ steps.formatting.outcome }}
|
||||
run: |
|
||||
echo "### :x: Checks Failed!" >> "${GITHUB_STEP_SUMMARY}"
|
||||
@@ -203,7 +218,9 @@ jobs:
|
||||
echo "|test (sqlite)|${TEST_SQLITE}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "|test (mysql)|${TEST_MYSQL}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "|test (postgresql)|${TEST_POSTGRESQL}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "|test (sqlite,unsafe_test_mode)|${TEST_UNSAFE_TEST_MODE}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "|clippy (sqlite,mysql,postgresql,enable_mimalloc,s3)|${CLIPPY}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "|clippy (sqlite,unsafe_test_mode)|${CLIPPY_UNSAFE_TEST_MODE}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "|fmt|${FMT}|" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "" >> "${GITHUB_STEP_SUMMARY}"
|
||||
echo "Please check the failed jobs and fix where needed." >> "${GITHUB_STEP_SUMMARY}"
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
name: SDK live tests
|
||||
permissions: {}
|
||||
|
||||
# Runs the live-server end-to-end tests of bitwarden/sdk-internal against this branch, see tools/sdk-live-tests/run.sh.
|
||||
# It builds the SDK too, so it only runs by hand and on changes to the test seeder or the runner.
|
||||
on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
sdk_ref:
|
||||
description: "Branch, tag or commit of bitwarden/sdk-internal to test with"
|
||||
required: true
|
||||
default: "main"
|
||||
pull_request:
|
||||
paths:
|
||||
- ".github/workflows/sdk-live-tests.yml"
|
||||
- "src/api/test_seeder.rs"
|
||||
- "tools/sdk-live-tests/**"
|
||||
|
||||
defaults:
|
||||
run:
|
||||
shell: bash
|
||||
|
||||
jobs:
|
||||
sdk-live-tests:
|
||||
name: SDK live tests
|
||||
runs-on: ubuntu-24.04
|
||||
timeout-minutes: 90
|
||||
steps:
|
||||
- name: "Install dependencies Ubuntu"
|
||||
run: sudo apt-get update && sudo apt-get install -y --no-install-recommends build-essential libssl-dev pkg-config
|
||||
|
||||
- name: "Checkout"
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Checkout sdk-internal"
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
repository: bitwarden/sdk-internal
|
||||
ref: ${{ inputs.sdk_ref || 'main' }}
|
||||
path: sdk-internal
|
||||
persist-credentials: false
|
||||
|
||||
# Each checkout pins its own toolchain in rust-toolchain.toml
|
||||
- name: "Install toolchains"
|
||||
run: |
|
||||
rustup toolchain install
|
||||
cd sdk-internal
|
||||
rustup toolchain install
|
||||
rustup target add wasm32-unknown-unknown
|
||||
rustup component add rust-src
|
||||
|
||||
- name: "Cache Rust builds"
|
||||
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
|
||||
with:
|
||||
workspaces: |
|
||||
. -> target
|
||||
sdk-internal -> target
|
||||
|
||||
- name: "Setup Node"
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
with:
|
||||
node-version-file: sdk-internal/.nvmrc
|
||||
|
||||
- name: "Run the SDK live tests"
|
||||
run: tools/sdk-live-tests/run.sh --sdk-dir sdk-internal
|
||||
|
||||
- name: "Upload logs"
|
||||
if: ${{ !cancelled() }}
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
||||
with:
|
||||
name: sdk-live-tests-logs
|
||||
path: target/sdk-live-tests/**/*.log
|
||||
+2
-3
@@ -14,9 +14,8 @@ extend-ignore-re = [
|
||||
# In SMTP it's called HELO, so ignore it
|
||||
"(?i)helo_name",
|
||||
"Server name sent during.+HELO",
|
||||
# COSE Is short for CBOR Object Signing and Encryption, ignore these specific items
|
||||
"COSEKey",
|
||||
"COSEAlgorithm",
|
||||
# COSE Is short for CBOR Object Signing and Encryption
|
||||
"(?i)cose",
|
||||
# Ignore this specific string as it's valid
|
||||
"Ensure they are valid OTPs",
|
||||
# This word is misspelled upstream
|
||||
|
||||
Generated
+1
@@ -6270,6 +6270,7 @@ dependencies = [
|
||||
"rustls",
|
||||
"semver",
|
||||
"serde",
|
||||
"serde_cbor_2",
|
||||
"serde_json",
|
||||
"subtle",
|
||||
"svg-hush",
|
||||
|
||||
+5
-1
@@ -57,6 +57,9 @@ oidc-accept-string-booleans = ["openidconnect/accept-string-booleans"]
|
||||
# Currently only used to enable rusts official ip support
|
||||
unstable = []
|
||||
|
||||
# Enables special test mode features. This should NEVER be enabled in production
|
||||
unsafe_test_mode = ["dep:serde_cbor_2"]
|
||||
|
||||
[target."cfg(unix)".dependencies]
|
||||
nix = { version = "0.31.3", features = ["fs"] }
|
||||
# Logging
|
||||
@@ -107,7 +110,7 @@ serde = { version = "1.0.229", features = ["derive"] }
|
||||
serde_json = "1.0.154"
|
||||
|
||||
# A safe, extensible ORM and Query builder
|
||||
diesel = { version = "2.3.14", features = ["chrono", "r2d2", "numeric"] }
|
||||
diesel = { version = "2.3.14", features = ["chrono", "r2d2", "numeric", "64-column-tables"] }
|
||||
diesel_migrations = "2.3.2"
|
||||
|
||||
derive_more = { version = "2.1.1", features = [
|
||||
@@ -157,6 +160,7 @@ yubico_ng = { version = "1.0.0", default-features = false }
|
||||
webauthn-rs = { version = "0.5.5", features = ["danger-allow-state-serialisation", "danger-credential-internals"] }
|
||||
webauthn-rs-proto = "0.5.5"
|
||||
webauthn-rs-core = "0.5.5"
|
||||
serde_cbor_2 = { version = "0.13.0", optional = true }
|
||||
|
||||
# Handling of URL's for WebAuthn and favicons
|
||||
url = "2.5.8"
|
||||
|
||||
Whitespace-only changes.
@@ -0,0 +1,3 @@
|
||||
-- A blob-encrypted cipher keeps all of its content in `data`, up to 500,000 characters, so the
|
||||
-- 64 KiB of TEXT is too small. Like upstream, which uses LONGTEXT.
|
||||
ALTER TABLE ciphers MODIFY data LONGTEXT NOT NULL;
|
||||
@@ -0,0 +1,5 @@
|
||||
DROP TABLE IF EXISTS user_signature_key_pairs;
|
||||
|
||||
ALTER TABLE users DROP COLUMN signed_public_key;
|
||||
ALTER TABLE users DROP COLUMN security_state;
|
||||
ALTER TABLE users DROP COLUMN security_version;
|
||||
@@ -0,0 +1,14 @@
|
||||
ALTER TABLE users ADD COLUMN signed_public_key TEXT;
|
||||
ALTER TABLE users ADD COLUMN security_state TEXT;
|
||||
ALTER TABLE users ADD COLUMN security_version INTEGER;
|
||||
|
||||
CREATE TABLE user_signature_key_pairs (
|
||||
uuid CHAR(36) NOT NULL PRIMARY KEY,
|
||||
user_uuid CHAR(36) NOT NULL UNIQUE,
|
||||
signature_algorithm INTEGER NOT NULL, -- 0 = ed25519, 1 = mldsa44
|
||||
signing_key TEXT NOT NULL,
|
||||
verifying_key TEXT NOT NULL,
|
||||
created_at DATETIME NOT NULL,
|
||||
updated_at DATETIME NOT NULL,
|
||||
FOREIGN KEY (user_uuid) REFERENCES users (uuid) ON DELETE CASCADE
|
||||
);
|
||||
Whitespace-only changes.
@@ -0,0 +1,4 @@
|
||||
-- Key rotations before this kept the id of the old user key, so every new
|
||||
-- cipher was refused from then on. Stale ids can't be told apart, so clear
|
||||
-- all of them; clients record their current key's id again when it's empty.
|
||||
UPDATE users SET key_id = NULL;
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE users DROP COLUMN v2_upgrade_token;
|
||||
ALTER TABLE users_organizations DROP COLUMN v2_upgrade_token;
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE users ADD COLUMN v2_upgrade_token TEXT;
|
||||
ALTER TABLE users_organizations ADD COLUMN v2_upgrade_token TEXT;
|
||||
Whitespace-only changes.
@@ -0,0 +1,3 @@
|
||||
-- TEXT has no size limit here, only MySQL needed the change.
|
||||
-- PostgreSQL rejects a migration that is only comments ("Received an empty query"), hence the no-op.
|
||||
SELECT 1;
|
||||
@@ -0,0 +1,5 @@
|
||||
DROP TABLE IF EXISTS user_signature_key_pairs;
|
||||
|
||||
ALTER TABLE users DROP COLUMN signed_public_key;
|
||||
ALTER TABLE users DROP COLUMN security_state;
|
||||
ALTER TABLE users DROP COLUMN security_version;
|
||||
@@ -0,0 +1,13 @@
|
||||
ALTER TABLE users ADD COLUMN signed_public_key TEXT;
|
||||
ALTER TABLE users ADD COLUMN security_state TEXT;
|
||||
ALTER TABLE users ADD COLUMN security_version INTEGER;
|
||||
|
||||
CREATE TABLE user_signature_key_pairs (
|
||||
uuid CHAR(36) NOT NULL PRIMARY KEY,
|
||||
user_uuid CHAR(36) NOT NULL UNIQUE REFERENCES users (uuid) ON DELETE CASCADE,
|
||||
signature_algorithm INTEGER NOT NULL, -- 0 = ed25519, 1 = mldsa44
|
||||
signing_key TEXT NOT NULL,
|
||||
verifying_key TEXT NOT NULL,
|
||||
created_at TIMESTAMP NOT NULL,
|
||||
updated_at TIMESTAMP NOT NULL
|
||||
);
|
||||
Whitespace-only changes.
@@ -0,0 +1,4 @@
|
||||
-- Key rotations before this kept the id of the old user key, so every new
|
||||
-- cipher was refused from then on. Stale ids can't be told apart, so clear
|
||||
-- all of them; clients record their current key's id again when it's empty.
|
||||
UPDATE users SET key_id = NULL;
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE users DROP COLUMN v2_upgrade_token;
|
||||
ALTER TABLE users_organizations DROP COLUMN v2_upgrade_token;
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE users ADD COLUMN v2_upgrade_token TEXT;
|
||||
ALTER TABLE users_organizations ADD COLUMN v2_upgrade_token TEXT;
|
||||
Whitespace-only changes.
@@ -0,0 +1 @@
|
||||
-- TEXT has no size limit here, only MySQL needed the change
|
||||
@@ -0,0 +1,5 @@
|
||||
DROP TABLE IF EXISTS user_signature_key_pairs;
|
||||
|
||||
ALTER TABLE users DROP COLUMN signed_public_key;
|
||||
ALTER TABLE users DROP COLUMN security_state;
|
||||
ALTER TABLE users DROP COLUMN security_version;
|
||||
@@ -0,0 +1,13 @@
|
||||
ALTER TABLE users ADD COLUMN signed_public_key TEXT;
|
||||
ALTER TABLE users ADD COLUMN security_state TEXT;
|
||||
ALTER TABLE users ADD COLUMN security_version INTEGER;
|
||||
|
||||
CREATE TABLE user_signature_key_pairs (
|
||||
uuid TEXT NOT NULL PRIMARY KEY,
|
||||
user_uuid TEXT NOT NULL UNIQUE REFERENCES users (uuid) ON DELETE CASCADE,
|
||||
signature_algorithm INTEGER NOT NULL, -- 0 = ed25519, 1 = mldsa44
|
||||
signing_key TEXT NOT NULL,
|
||||
verifying_key TEXT NOT NULL,
|
||||
created_at DATETIME NOT NULL,
|
||||
updated_at DATETIME NOT NULL
|
||||
);
|
||||
Whitespace-only changes.
@@ -0,0 +1,4 @@
|
||||
-- Key rotations before this kept the id of the old user key, so every new
|
||||
-- cipher was refused from then on. Stale ids can't be told apart, so clear
|
||||
-- all of them; clients record their current key's id again when it's empty.
|
||||
UPDATE users SET key_id = NULL;
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE users DROP COLUMN v2_upgrade_token;
|
||||
ALTER TABLE users_organizations DROP COLUMN v2_upgrade_token;
|
||||
@@ -0,0 +1,2 @@
|
||||
ALTER TABLE users ADD COLUMN v2_upgrade_token TEXT;
|
||||
ALTER TABLE users_organizations ADD COLUMN v2_upgrade_token TEXT;
|
||||
+1
-1
@@ -445,7 +445,7 @@ async fn delete_user(user_id: UserId, token: AdminToken, conn: DbConn, nt: Notif
|
||||
if res.is_ok() {
|
||||
nt.send_logout(&user, None, &conn).await;
|
||||
if has_push_device {
|
||||
push_logout_to_relay(&user, None);
|
||||
push_logout_to_relay(&user, None, None);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+971
-173
File diff suppressed because it is too large.
Load diff
+923
-316
File diff suppressed because it is too large.
Load diff
@@ -10,7 +10,9 @@ use crate::{
|
||||
auth::{AdminHeaders, Headers},
|
||||
db::{
|
||||
DbConn, DbPool,
|
||||
models::{Cipher, CipherId, Event, EventType, Membership, MembershipId, OrganizationId, UserId},
|
||||
models::{
|
||||
Cipher, CipherAccessScope, CipherId, Event, EventType, Membership, MembershipId, OrganizationId, UserId,
|
||||
},
|
||||
},
|
||||
error::MapResult,
|
||||
util::parse_date,
|
||||
@@ -220,7 +222,7 @@ async fn post_events_collect(data: Json<Vec<EventCollection>>, headers: Headers,
|
||||
// user can actually access it instead of trusting the provided cipher uuid.
|
||||
if let Some(cipher_uuid) = &event.cipher_id
|
||||
&& let Some(cipher) = Cipher::find_by_uuid(cipher_uuid, &conn).await
|
||||
&& cipher.is_accessible_to_user(&headers.user.uuid, &conn).await
|
||||
&& cipher.is_accessible_to_user(&headers.user.uuid, CipherAccessScope::User, &conn).await
|
||||
&& let Some(org_id) = cipher.organization_uuid
|
||||
{
|
||||
log_event_impl(
|
||||
|
||||
@@ -14,6 +14,8 @@ pub use ciphers::{CipherData, CipherSyncData, CipherSyncType, purge_trashed_ciph
|
||||
pub use emergency_access::{emergency_notification_reminder_job, emergency_request_timeout_job};
|
||||
pub use events::{event_cleanup_job, log_event, log_user_event};
|
||||
pub use sends::purge_sends;
|
||||
#[cfg(feature = "unsafe_test_mode")]
|
||||
pub use {ciphers::seed_cipher, sends::seed_send};
|
||||
|
||||
use reqwest::Method;
|
||||
use rocket::{Catcher, Route, serde::json::Json, serde::json::Value};
|
||||
|
||||
+114
-28
@@ -8,17 +8,18 @@ use crate::{
|
||||
CONFIG,
|
||||
api::admin::FAKE_ADMIN_UUID,
|
||||
api::{
|
||||
EmptyResult, JsonResult, Notify, PasswordOrOtpData, UpdateType,
|
||||
ApiResult, EmptyResult, JsonResult, Notify, PasswordOrOtpData, UpdateType,
|
||||
core::{CipherSyncData, CipherSyncType, accept_org_invite, log_event, two_factor},
|
||||
},
|
||||
auth::{AdminHeaders, Headers, ManagerHeaders, ManagerHeadersLoose, OrgMemberHeaders, OwnerHeaders, decode_invite},
|
||||
db::{
|
||||
DbConn,
|
||||
models::{
|
||||
Cipher, CipherId, Collection, CollectionCipher, CollectionGroup, CollectionId, CollectionUser,
|
||||
CustomPermission, Device, EventType, FillAssistPolicyData, Group, GroupId, GroupUser, Invitation,
|
||||
Membership, MembershipId, MembershipStatus, MembershipType, OrgPolicy, OrgPolicyType, Organization,
|
||||
OrganizationApiKey, OrganizationId, TwoFactor, TwoFactorType, User, UserId, custom_roles_enabled,
|
||||
Cipher, CipherAccessScope, CipherId, Collection, CollectionCipher, CollectionGroup, CollectionId,
|
||||
CollectionUser, CustomPermission, Device, EventType, FillAssistPolicyData, Group, GroupId, GroupUser,
|
||||
Invitation, Membership, MembershipId, MembershipStatus, MembershipType, OrgPolicy, OrgPolicyType,
|
||||
Organization, OrganizationApiKey, OrganizationId, TwoFactor, TwoFactorType, User, UserId,
|
||||
custom_roles_enabled,
|
||||
},
|
||||
},
|
||||
mail,
|
||||
@@ -47,6 +48,7 @@ pub fn routes() -> Vec<Route> {
|
||||
bulk_delete_organization_collections,
|
||||
post_bulk_collections,
|
||||
get_org_details,
|
||||
get_assigned_org_details,
|
||||
get_org_domain_sso_verified,
|
||||
get_members,
|
||||
send_invite,
|
||||
@@ -841,7 +843,7 @@ async fn get_org_details(data: OrgIdData, headers: ManagerHeadersLoose, conn: Db
|
||||
err_code!("Resource not found.", "Organization id's do not match", Status::NotFound.code);
|
||||
}
|
||||
|
||||
if !headers.membership.has_full_access() {
|
||||
if !headers.membership.can_edit_any_collection() {
|
||||
err_code!("Resource not found.", "User does not have full access", Status::NotFound.code);
|
||||
}
|
||||
|
||||
@@ -859,7 +861,12 @@ async fn get_org_details_impl(
|
||||
conn: &DbConn,
|
||||
) -> Result<Value, crate::Error> {
|
||||
let ciphers = Cipher::find_by_org(org_id, conn).await;
|
||||
let cipher_sync_data = CipherSyncData::new(user_id, CipherSyncType::Organization, conn).await;
|
||||
let mut cipher_sync_data = CipherSyncData::new(user_id, CipherSyncType::Organization, conn).await;
|
||||
// Every cipher of the organization is listed, so list every collection of them too
|
||||
cipher_sync_data.cipher_collections = HashMap::new();
|
||||
for (cipher_id, collection_id) in Cipher::get_collections_with_cipher_by_organization(org_id, conn).await {
|
||||
cipher_sync_data.cipher_collections.entry(cipher_id).or_default().push(collection_id);
|
||||
}
|
||||
|
||||
let mut ciphers_json = Vec::with_capacity(ciphers.len());
|
||||
for c in ciphers {
|
||||
@@ -868,6 +875,39 @@ async fn get_org_details_impl(
|
||||
Ok(json!(ciphers_json))
|
||||
}
|
||||
|
||||
// The Admin Console lists these instead of every cipher of the organization for a member who may not edit every
|
||||
// cipher, like a Custom member with Delete any collection only. As in Bitwarden, any confirmed member may list them.
|
||||
#[get("/ciphers/organization-details/assigned?<data..>")]
|
||||
async fn get_assigned_org_details(data: OrgIdData, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let Some(member) =
|
||||
Membership::find_confirmed_by_user_and_org(&headers.user.uuid, &data.organization_id, &conn).await
|
||||
else {
|
||||
err_code!("Resource not found.", "User is not a confirmed member of the organization", Status::NotFound.code);
|
||||
};
|
||||
|
||||
let (assigned, unassigned) = Cipher::find_assigned_to_member(&member, &conn).await;
|
||||
let mut ciphers_json = Vec::with_capacity(assigned.len() + unassigned.len());
|
||||
// The ciphers of the member's own vault, as they are there
|
||||
let cipher_sync_data = CipherSyncData::new(&headers.user.uuid, CipherSyncType::User, &conn).await;
|
||||
for cipher in assigned {
|
||||
ciphers_json.push(
|
||||
cipher
|
||||
.to_json(&headers.host, &headers.user.uuid, Some(&cipher_sync_data), CipherSyncType::User, &conn)
|
||||
.await?,
|
||||
);
|
||||
}
|
||||
// The ciphers in no collection, as the member may use them in the Admin Console
|
||||
for cipher in unassigned {
|
||||
ciphers_json.push(cipher.to_json_org_admin(&headers.host, &headers.user.uuid, &conn).await?);
|
||||
}
|
||||
|
||||
Ok(Json(json!({
|
||||
"data": ciphers_json,
|
||||
"object": "list",
|
||||
"continuationToken": null,
|
||||
})))
|
||||
}
|
||||
|
||||
// Returning a Domain/Organization here allow to prefill it and prevent prompting the user
|
||||
// So we return a dummy value, since we only support a single SSO integration, and do not use the response anywhere
|
||||
// In use since `v2025.6.0`, appears to use only the first `organizationIdentifier`
|
||||
@@ -1866,7 +1906,7 @@ async fn post_org_import(
|
||||
cipher_data.folder_id = None;
|
||||
// Replace the client-provided, unvalidated organizationId with the real target org
|
||||
cipher_data.organization_id = Some(org_id.clone());
|
||||
let mut cipher = Cipher::new(cipher_data.r#type, cipher_data.name.clone());
|
||||
let mut cipher = Cipher::new(cipher_data.r#type);
|
||||
update_cipher_from_data(
|
||||
&mut cipher,
|
||||
cipher_data,
|
||||
@@ -1875,6 +1915,7 @@ async fn post_org_import(
|
||||
&conn,
|
||||
&nt,
|
||||
UpdateType::None,
|
||||
true,
|
||||
)
|
||||
.await
|
||||
.ok();
|
||||
@@ -1908,29 +1949,37 @@ struct BulkCollectionsData {
|
||||
async fn post_bulk_collections(data: Json<BulkCollectionsData>, headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
let data: BulkCollectionsData = data.into_inner();
|
||||
|
||||
if Membership::find_confirmed_by_user_and_org(&headers.user.uuid, &data.organization_id, &conn).await.is_none() {
|
||||
let Some(member) =
|
||||
Membership::find_confirmed_by_user_and_org(&headers.user.uuid, &data.organization_id, &conn).await
|
||||
else {
|
||||
err!("You need to be a Member of the Organization to call this endpoint")
|
||||
}
|
||||
};
|
||||
// A member who may edit any collection may use every collection of the organization
|
||||
let can_edit_any_collection = member.can_edit_any_collection();
|
||||
|
||||
// Get all the collection available to the user in one query
|
||||
// Also filter based upon the provided collections
|
||||
let user_collections: HashMap<CollectionId, Collection> =
|
||||
Collection::find_by_organization_and_user_uuid(&data.organization_id, &headers.user.uuid, &conn)
|
||||
.await
|
||||
.into_iter()
|
||||
.filter_map(|c| {
|
||||
if data.collection_ids.contains(&c.uuid) {
|
||||
Some((c.uuid.clone(), c))
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
let collections = if can_edit_any_collection {
|
||||
Collection::find_by_organization(&data.organization_id, &conn).await
|
||||
} else {
|
||||
Collection::find_by_organization_and_user_uuid(&data.organization_id, &headers.user.uuid, &conn).await
|
||||
};
|
||||
let user_collections: HashMap<CollectionId, Collection> = collections
|
||||
.into_iter()
|
||||
.filter_map(|c| {
|
||||
if data.collection_ids.contains(&c.uuid) {
|
||||
Some((c.uuid.clone(), c))
|
||||
} else {
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
|
||||
// Verify if all the collections requested exists and are writable for the user, else abort
|
||||
for collection_uuid in &data.collection_ids {
|
||||
match user_collections.get(collection_uuid) {
|
||||
Some(collection) if collection.is_writable_by_user(&headers.user.uuid, &conn).await => (),
|
||||
Some(collection)
|
||||
if can_edit_any_collection || collection.is_writable_by_user(&headers.user.uuid, &conn).await => {}
|
||||
_ => err_code!("Resource not found", "User does not have access to a collection", 404),
|
||||
}
|
||||
}
|
||||
@@ -1939,7 +1988,7 @@ async fn post_bulk_collections(data: Json<BulkCollectionsData>, headers: Headers
|
||||
// Only act on existing cipher uuid's
|
||||
// Do not abort the operation just ignore it, it could be a cipher was just deleted for example
|
||||
if let Some(cipher) = Cipher::find_by_uuid_and_org(cipher_id, &data.organization_id, &conn).await
|
||||
&& cipher.is_write_accessible_to_user(&headers.user.uuid, &conn).await
|
||||
&& cipher.is_write_accessible_to_user(&headers.user.uuid, CipherAccessScope::OrganizationAdmin, &conn).await
|
||||
{
|
||||
// When selecting a specific collection from the left filter list, and use the bulk option, you can remove an item from that collection
|
||||
// In these cases the client will call this endpoint twice, once for adding the new collections and a second for deleting.
|
||||
@@ -2869,8 +2918,26 @@ struct OrganizationUserRecoverAccountRequest {
|
||||
// But the clients do not seem to use this at all
|
||||
// Just add it here in case they will
|
||||
#[get("/organizations/<org_id>/public-key")]
|
||||
async fn get_organization_public_key(org_id: OrganizationId, headers: OrgMemberHeaders, conn: DbConn) -> JsonResult {
|
||||
if org_id != headers.membership.org_uuid {
|
||||
async fn get_organization_public_key(
|
||||
org_id: OrganizationId,
|
||||
headers: Headers,
|
||||
member: Result<OrgMemberHeaders, &'static str>,
|
||||
conn: DbConn,
|
||||
) -> JsonResult {
|
||||
// SSO users without an org get the fake one, whose key the v2 JIT password flow fetches anyway
|
||||
if org_id.eq_ignore_ascii_case(FAKE_SSO_IDENTIFIER) && headers.user.private_key.is_none() {
|
||||
return Ok(Json(json!({
|
||||
"object": "organizationPublicKey",
|
||||
"publicKey": fake_sso_org_public_key().await?,
|
||||
})));
|
||||
}
|
||||
let member = match member {
|
||||
Ok(member) => member,
|
||||
// The guard already logged it
|
||||
Err(e) => return Err(crate::error::Error::new_msg(e).with_code(Status::Unauthorized.code)),
|
||||
};
|
||||
|
||||
if org_id != member.membership.org_uuid {
|
||||
err!("Organization not found", "Organization id's do not match");
|
||||
}
|
||||
let Some(org) = Organization::find_by_uuid(&org_id, &conn).await else {
|
||||
@@ -2883,11 +2950,30 @@ async fn get_organization_public_key(org_id: OrganizationId, headers: OrgMemberH
|
||||
})))
|
||||
}
|
||||
|
||||
/// The SDK only uses this key to wrap an account recovery key that it never sends for the fake org,
|
||||
/// so it is made once and its private half dropped.
|
||||
async fn fake_sso_org_public_key() -> ApiResult<String> {
|
||||
static PUBLIC_KEY: std::sync::LazyLock<Option<String>> = std::sync::LazyLock::new(|| {
|
||||
let der = openssl::rsa::Rsa::generate(2048).and_then(|rsa| rsa.public_key_to_der()).ok()?;
|
||||
Some(data_encoding::BASE64.encode(&der))
|
||||
});
|
||||
|
||||
let Ok(Some(public_key)) = tokio::task::spawn_blocking(|| PUBLIC_KEY.clone()).await else {
|
||||
err!("Failed to generate the organization key")
|
||||
};
|
||||
Ok(public_key)
|
||||
}
|
||||
|
||||
// Obsolete - Renamed to public-key (2023.8), left for backwards compatibility with older clients
|
||||
// https://github.com/bitwarden/server/blob/9ebe16587175b1c0e9208f84397bb75d0d595510/src/Api/AdminConsole/Controllers/OrganizationsController.cs#L487-L492
|
||||
#[get("/organizations/<org_id>/keys")]
|
||||
async fn get_organization_keys(org_id: OrganizationId, headers: OrgMemberHeaders, conn: DbConn) -> JsonResult {
|
||||
get_organization_public_key(org_id, headers, conn).await
|
||||
async fn get_organization_keys(
|
||||
org_id: OrganizationId,
|
||||
headers: Headers,
|
||||
member: Result<OrgMemberHeaders, &'static str>,
|
||||
conn: DbConn,
|
||||
) -> JsonResult {
|
||||
get_organization_public_key(org_id, headers, member, conn).await
|
||||
}
|
||||
|
||||
// Will allow to reset 2FA too
|
||||
|
||||
@@ -126,6 +126,23 @@ async fn enforce_disable_hide_email_policy(data: &SendData, headers: &Headers, c
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Stores a text Send that is already encrypted, as [`create_send`] does, for the test seeder (`unsafe_test_mode`).
|
||||
/// Its deletion date becomes a week from now: a recorded one can be years ahead, more than a Send may be.
|
||||
#[cfg(feature = "unsafe_test_mode")]
|
||||
pub async fn seed_send(mut encrypted: Value, user_id: &UserId, conn: &DbConn) -> ApiResult<SendId> {
|
||||
let Some(fields) = encrypted.as_object_mut() else {
|
||||
err!("A seeded Send has to be a JSON object")
|
||||
};
|
||||
fields.insert("deletionDate".to_owned(), serde_json::to_value(Utc::now() + TimeDelta::try_days(7).unwrap())?);
|
||||
let data: SendData = serde_json::from_value(encrypted)?;
|
||||
if data.r#type != SendType::Text as i32 {
|
||||
err!("Only text Sends can be seeded: a file Send needs its file")
|
||||
}
|
||||
let mut send = create_send(data, user_id.clone())?;
|
||||
send.save(conn).await?;
|
||||
Ok(send.uuid)
|
||||
}
|
||||
|
||||
fn create_send(data: SendData, user_id: UserId) -> ApiResult<Send> {
|
||||
let data_val = if data.r#type == SendType::Text as i32 {
|
||||
data.text
|
||||
|
||||
+133
-35
@@ -29,7 +29,7 @@ use crate::{
|
||||
db::{
|
||||
DbConn,
|
||||
models::{
|
||||
AuthRequest, AuthRequestId, Device, DeviceId, EventType, Invitation, OIDCCodeResponseError,
|
||||
AuthRequest, AuthRequestId, Device, DeviceId, DeviceType, EventType, Invitation, OIDCCodeResponseError,
|
||||
OrganizationApiKey, OrganizationId, SendId, SsoAuth, SsoUser, TwoFactor, TwoFactorIncomplete,
|
||||
TwoFactorType, User, UserId,
|
||||
},
|
||||
@@ -77,14 +77,14 @@ async fn login(data: Form<ConnectData>, client_header: ClientHeaders, conn: DbCo
|
||||
check_is_some(data.device_name.as_ref(), "device_name cannot be blank")?;
|
||||
check_is_some(data.device_type.as_ref(), "device_type cannot be blank")?;
|
||||
|
||||
password_login(data, &mut user_id, &conn, &client_header.ip).await
|
||||
password_login(data, &mut user_id, &conn, &client_header).await
|
||||
}
|
||||
"client_credentials" => {
|
||||
check_is_some(data.client_id.as_ref(), "client_id cannot be blank")?;
|
||||
check_is_some(data.client_secret.as_ref(), "client_secret cannot be blank")?;
|
||||
check_is_some(data.scope.as_ref(), "scope cannot be blank")?;
|
||||
|
||||
api_key_login(data, &mut user_id, &conn, &client_header.ip).await
|
||||
api_key_login(data, &mut user_id, &conn, &client_header).await
|
||||
}
|
||||
"authorization_code" if CONFIG.sso_enabled() => {
|
||||
check_is_some(data.client_id.as_ref(), "client_id cannot be blank")?;
|
||||
@@ -95,7 +95,7 @@ async fn login(data: Form<ConnectData>, client_header: ClientHeaders, conn: DbCo
|
||||
check_is_some(data.device_name.as_ref(), "device_name cannot be blank")?;
|
||||
check_is_some(data.device_type.as_ref(), "device_type cannot be blank")?;
|
||||
|
||||
sso_login(data, &mut user_id, &conn, &client_header.ip).await
|
||||
sso_login(data, &mut user_id, &conn, &client_header).await
|
||||
}
|
||||
"authorization_code" => err!("SSO sign-in is not available"),
|
||||
"send_access" => {
|
||||
@@ -179,7 +179,13 @@ async fn refresh_login(data: ConnectData, conn: &DbConn, ip: &ClientIp) -> JsonR
|
||||
}
|
||||
|
||||
// After exchanging the code we need to check first if 2FA is needed before continuing
|
||||
async fn sso_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbConn, ip: &ClientIp) -> JsonResult {
|
||||
async fn sso_login(
|
||||
data: ConnectData,
|
||||
user_id: &mut Option<UserId>,
|
||||
conn: &DbConn,
|
||||
client_header: &ClientHeaders,
|
||||
) -> JsonResult {
|
||||
let ip = &client_header.ip;
|
||||
AuthMethod::Sso.check_scope(data.scope.as_ref())?;
|
||||
|
||||
// Ratelimit the login
|
||||
@@ -317,6 +323,8 @@ async fn sso_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbCon
|
||||
}
|
||||
|
||||
let mut user = User::new(&user_infos.email, user_infos.user_name.clone());
|
||||
// Before saving, so that a client that can't log in doesn't create the account
|
||||
check_client_version(&user, client_header)?;
|
||||
user.verified_at = Some(now);
|
||||
user.save(conn).await?;
|
||||
|
||||
@@ -325,6 +333,8 @@ async fn sso_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbCon
|
||||
(user, device, None, None)
|
||||
}
|
||||
Some((user, _)) if !user.enabled => {
|
||||
// Set in both arms, not only after the match, so that their failed logins are logged
|
||||
*user_id = Some(user.uuid.clone());
|
||||
err!(
|
||||
"This user has been disabled",
|
||||
format!("IP: {}. Username: {}.", ip.ip, user.email),
|
||||
@@ -334,6 +344,9 @@ async fn sso_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbCon
|
||||
)
|
||||
}
|
||||
Some((mut user, sso_user)) => {
|
||||
*user_id = Some(user.uuid.clone());
|
||||
check_client_version(&user, client_header)?;
|
||||
|
||||
let mut device = get_device(&data, conn, &user).await?;
|
||||
|
||||
let twofactor_token = twofactor_auth(&mut user, &data, &mut device, ip, conn).await?;
|
||||
@@ -368,7 +381,13 @@ async fn sso_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbCon
|
||||
authenticated_response(&user, &mut device, auth_tokens, twofactor_token, conn, ip).await
|
||||
}
|
||||
|
||||
async fn password_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbConn, ip: &ClientIp) -> JsonResult {
|
||||
async fn password_login(
|
||||
data: ConnectData,
|
||||
user_id: &mut Option<UserId>,
|
||||
conn: &DbConn,
|
||||
client_header: &ClientHeaders,
|
||||
) -> JsonResult {
|
||||
let ip = &client_header.ip;
|
||||
// Validate scope
|
||||
AuthMethod::Password.check_scope(data.scope.as_ref())?;
|
||||
|
||||
@@ -438,6 +457,8 @@ async fn password_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &
|
||||
)
|
||||
}
|
||||
|
||||
check_client_version(&user, client_header)?;
|
||||
|
||||
// Change the KDF Iterations (only when not logging in with an auth request)
|
||||
if data.auth_request.is_none() {
|
||||
kdf_upgrade(&mut user, password, conn).await?;
|
||||
@@ -499,6 +520,66 @@ async fn password_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &
|
||||
authenticated_response(&user, &mut device, auth_tokens, twofactor_token, conn, ip).await
|
||||
}
|
||||
|
||||
/// Like upstream's `ClientVersionValidator`, every login needs the `Bitwarden-Client-Version` header, and a V2 account
|
||||
/// ([`User::has_v2_encryption`]) a client of at least 2026.10.1 (2026.10.2 for the desktop app). Called right after the
|
||||
/// credentials are checked, like upstream, so that it doesn't tell anyone else which accounts are V2.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/15c94ac58bf361a162381749c146d254a21b2098/src/Identity/IdentityServer/RequestValidators/ClientVersionValidator.cs#L33-L79>
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/15c94ac58bf361a162381749c146d254a21b2098/src/Core/KeyManagement/Constants.cs#L5-L6>
|
||||
fn check_client_version(user: &User, client_header: &ClientHeaders) -> EmptyResult {
|
||||
let Some((error, description)) = client_version_error(
|
||||
user.has_v2_encryption(),
|
||||
client_header.client_version.as_ref(),
|
||||
client_header.device_type,
|
||||
) else {
|
||||
return Ok(());
|
||||
};
|
||||
Err(crate::error::Error::from((
|
||||
// Escaped: on a first SSO login the email comes from the provider and isn't validated yet
|
||||
format!("IP: {}. Username: {}. {error}", client_header.ip.ip, user.email.escape_debug()),
|
||||
json!({
|
||||
"error": error,
|
||||
"error_description": description,
|
||||
"ErrorModel": { "Message": description, "Object": "error" },
|
||||
}),
|
||||
))
|
||||
.with_event(crate::error::ErrorEvent {
|
||||
event: EventType::UserFailedLogIn,
|
||||
}))
|
||||
}
|
||||
|
||||
/// The error id and message of [`check_client_version`], `None` when the client may log in.
|
||||
fn client_version_error(
|
||||
is_v2: bool,
|
||||
client_version: Option<&semver::Version>,
|
||||
device_type: i32,
|
||||
) -> Option<(&'static str, &'static str)> {
|
||||
const MIN_V2_CLIENT: semver::Version = semver::Version::new(2026, 10, 1);
|
||||
const MIN_V2_DESKTOP_CLIENT: semver::Version = semver::Version::new(2026, 10, 2);
|
||||
|
||||
let Some(version) = client_version else {
|
||||
return Some((
|
||||
"version_header_missing",
|
||||
"No client version header found, required to prevent encryption errors. Please confirm your client is supplying the header: \"Bitwarden-Client-Version\"",
|
||||
));
|
||||
};
|
||||
if !is_v2 {
|
||||
return None;
|
||||
}
|
||||
// Upstream's desktop device types
|
||||
// Ref: <https://github.com/bitwarden/server/blob/15c94ac58bf361a162381749c146d254a21b2098/src/Libraries/Clients/DeviceTypes.cs#L14-L20>
|
||||
let is_desktop = matches!(
|
||||
DeviceType::from_i32(device_type),
|
||||
DeviceType::WindowsDesktop | DeviceType::MacOsDesktop | DeviceType::LinuxDesktop | DeviceType::Uwp
|
||||
);
|
||||
let min_version = if is_desktop {
|
||||
&MIN_V2_DESKTOP_CLIENT
|
||||
} else {
|
||||
&MIN_V2_CLIENT
|
||||
};
|
||||
(version < min_version).then_some(("invalid_client_version", "Please update your app to continue using Bitwarden"))
|
||||
}
|
||||
|
||||
async fn authenticated_response(
|
||||
user: &User,
|
||||
device: &mut Device,
|
||||
@@ -546,24 +627,13 @@ async fn authenticated_response(
|
||||
// https://github.com/bitwarden/android/blob/release/2025.12-rc41/network/src/main/kotlin/com/bitwarden/network/model/MasterPasswordUnlockDataJson.kt#L22-L26
|
||||
"MasterKeyEncryptedUserKey": user.akey,
|
||||
"MasterKeyWrappedUserKey": user.akey,
|
||||
"Salt": user.email
|
||||
"Salt": user.master_password_salt()
|
||||
})
|
||||
} else {
|
||||
Value::Null
|
||||
};
|
||||
|
||||
let account_keys = if user.private_key.is_some() {
|
||||
json!({
|
||||
"publicKeyEncryptionKeyPair": {
|
||||
"wrappedPrivateKey": user.private_key,
|
||||
"publicKey": user.public_key,
|
||||
"Object": "publicKeyEncryptionKeyPair"
|
||||
},
|
||||
"Object": "privateKeys"
|
||||
})
|
||||
} else {
|
||||
Value::Null
|
||||
};
|
||||
let account_keys = user.account_keys_json(conn).await;
|
||||
|
||||
let mut result = json!({
|
||||
"access_token": auth_tokens.access_token(),
|
||||
@@ -598,7 +668,13 @@ async fn authenticated_response(
|
||||
Ok(Json(result))
|
||||
}
|
||||
|
||||
async fn api_key_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &DbConn, ip: &ClientIp) -> JsonResult {
|
||||
async fn api_key_login(
|
||||
data: ConnectData,
|
||||
user_id: &mut Option<UserId>,
|
||||
conn: &DbConn,
|
||||
client_header: &ClientHeaders,
|
||||
) -> JsonResult {
|
||||
let ip = &client_header.ip;
|
||||
// Ratelimit the login
|
||||
crate::ratelimit::check_limit_login(&ip.ip)?;
|
||||
|
||||
@@ -610,7 +686,7 @@ async fn api_key_login(data: ConnectData, user_id: &mut Option<UserId>, conn: &D
|
||||
check_is_some(data.device_name.as_ref(), "device_name cannot be blank")?;
|
||||
check_is_some(data.device_type.as_ref(), "device_type cannot be blank")?;
|
||||
|
||||
user_api_key_login(data, user_id, conn, ip).await
|
||||
user_api_key_login(data, user_id, conn, client_header).await
|
||||
}
|
||||
Some(scope) if scope == &AuthMethod::OrgApiKey.scope() => organization_api_key_login(data, conn, ip).await,
|
||||
_ => err!("Scope not supported"),
|
||||
@@ -621,8 +697,9 @@ async fn user_api_key_login(
|
||||
data: ConnectData,
|
||||
user_id: &mut Option<UserId>,
|
||||
conn: &DbConn,
|
||||
ip: &ClientIp,
|
||||
client_header: &ClientHeaders,
|
||||
) -> JsonResult {
|
||||
let ip = &client_header.ip;
|
||||
// Get the user via the client_id
|
||||
let client_id = data.client_id.as_ref().unwrap();
|
||||
let Some(client_user_id) = client_id.strip_prefix("user.") else {
|
||||
@@ -659,6 +736,8 @@ async fn user_api_key_login(
|
||||
)
|
||||
}
|
||||
|
||||
check_client_version(&user, client_header)?;
|
||||
|
||||
let mut device = get_device(&data, conn, &user).await?;
|
||||
|
||||
if CONFIG.mail_enabled() && device.is_new() {
|
||||
@@ -703,24 +782,13 @@ async fn user_api_key_login(
|
||||
// https://github.com/bitwarden/android/blob/release/2025.12-rc41/network/src/main/kotlin/com/bitwarden/network/model/MasterPasswordUnlockDataJson.kt#L22-L26
|
||||
"MasterKeyEncryptedUserKey": user.akey,
|
||||
"MasterKeyWrappedUserKey": user.akey,
|
||||
"Salt": user.email
|
||||
"Salt": user.master_password_salt()
|
||||
})
|
||||
} else {
|
||||
Value::Null
|
||||
};
|
||||
|
||||
let account_keys = if user.private_key.is_some() {
|
||||
json!({
|
||||
"publicKeyEncryptionKeyPair": {
|
||||
"wrappedPrivateKey": user.private_key,
|
||||
"publicKey": user.public_key,
|
||||
"Object": "publicKeyEncryptionKeyPair"
|
||||
},
|
||||
"Object": "privateKeys"
|
||||
})
|
||||
} else {
|
||||
Value::Null
|
||||
};
|
||||
let account_keys = user.account_keys_json(conn).await;
|
||||
|
||||
// Note: No refresh_token is returned. The CLI just repeats the
|
||||
// client_credentials login flow when the existing token expires.
|
||||
@@ -1351,3 +1419,33 @@ async fn authorize(data: AuthorizeData, cookies: &CookieJar<'_>, secure: Secure,
|
||||
|
||||
Ok(Redirect::temporary(String::from(auth_url)))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_client_version_error() {
|
||||
let version = |v| semver::Version::parse(v).unwrap();
|
||||
let web = DeviceType::ChromeBrowser as i32;
|
||||
let desktop = DeviceType::WindowsDesktop as i32;
|
||||
// Every login needs the header
|
||||
assert_eq!(client_version_error(false, None, web).map(|e| e.0), Some("version_header_missing"));
|
||||
assert_eq!(client_version_error(true, None, desktop).map(|e| e.0), Some("version_header_missing"));
|
||||
// V1 accounts log in from any version
|
||||
assert_eq!(client_version_error(false, Some(&version("2024.1.0")), web), None);
|
||||
assert_eq!(client_version_error(false, Some(&version("2024.1.0")), desktop), None);
|
||||
// V2 accounts need 2026.10.1, and 2026.10.2 for the desktop app
|
||||
assert_eq!(
|
||||
client_version_error(true, Some(&version("2026.10.0")), web).map(|e| e.0),
|
||||
Some("invalid_client_version")
|
||||
);
|
||||
assert_eq!(client_version_error(true, Some(&version("2026.10.1")), web), None);
|
||||
assert_eq!(
|
||||
client_version_error(true, Some(&version("2026.10.1")), desktop).map(|e| e.0),
|
||||
Some("invalid_client_version")
|
||||
);
|
||||
assert_eq!(client_version_error(true, Some(&version("2026.10.2")), DeviceType::Uwp as i32), None);
|
||||
assert_eq!(client_version_error(true, Some(&version("2026.11.0")), desktop), None);
|
||||
}
|
||||
}
|
||||
+6
-1
@@ -4,8 +4,13 @@ mod icons;
|
||||
mod identity;
|
||||
mod notifications;
|
||||
mod push;
|
||||
#[cfg(feature = "unsafe_test_mode")]
|
||||
mod test_seeder;
|
||||
mod web;
|
||||
|
||||
#[cfg(feature = "unsafe_test_mode")]
|
||||
pub use test_seeder::routes as test_seeder_routes;
|
||||
|
||||
use rocket::serde::json::Json;
|
||||
use serde_json::Value;
|
||||
|
||||
@@ -23,7 +28,7 @@ pub use crate::api::{
|
||||
icons::routes as icons_routes,
|
||||
identity::routes as identity_routes,
|
||||
notifications::routes as notifications_routes,
|
||||
notifications::{AnonymousNotify, Notify, UpdateType, WS_ANONYMOUS_SUBSCRIPTIONS, WS_USERS},
|
||||
notifications::{AnonymousNotify, LogOutReason, Notify, UpdateType, WS_ANONYMOUS_SUBSCRIPTIONS, WS_USERS},
|
||||
push::{
|
||||
push_cipher_update, push_folder_update, push_logout, push_logout_to_relay, push_send_update, push_user_update,
|
||||
register_push_device, unregister_push_device,
|
||||
|
||||
@@ -412,23 +412,35 @@ impl WebSocketUsers {
|
||||
}
|
||||
|
||||
pub async fn send_logout(&self, user: &User, acting_device: Option<&Device>, conn: &DbConn) {
|
||||
self.send_logout_with_reason(user, acting_device, None, conn).await;
|
||||
}
|
||||
|
||||
/// A logout that clients may handle differently depending on `reason`
|
||||
pub async fn send_logout_with_reason(
|
||||
&self,
|
||||
user: &User,
|
||||
acting_device: Option<&Device>,
|
||||
reason: Option<LogOutReason>,
|
||||
conn: &DbConn,
|
||||
) {
|
||||
// Skip any processing if both WebSockets and Push are not active
|
||||
if *NOTIFICATIONS_DISABLED {
|
||||
return;
|
||||
}
|
||||
let acting_device_id = acting_device.map(|d| d.uuid.clone());
|
||||
let data = create_update(
|
||||
vec![("UserId".into(), user.uuid.to_string().into()), ("Date".into(), serialize_date(user.updated_at))],
|
||||
UpdateType::LogOut,
|
||||
acting_device_id,
|
||||
);
|
||||
let mut payload =
|
||||
vec![("UserId".into(), user.uuid.to_string().into()), ("Date".into(), serialize_date(user.updated_at))];
|
||||
if let Some(reason) = reason {
|
||||
payload.push(("Reason".into(), (reason as i32).into()));
|
||||
}
|
||||
let data = create_update(payload, UpdateType::LogOut, acting_device_id);
|
||||
|
||||
if CONFIG.enable_websocket() {
|
||||
self.send_update(&user.uuid, &data).await;
|
||||
}
|
||||
|
||||
if CONFIG.push_enabled() {
|
||||
push_logout(user, acting_device, conn).await;
|
||||
push_logout(user, acting_device, reason, conn).await;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -692,6 +704,14 @@ fn create_anonymous_update(payload: Vec<(Value, Value)>, ut: UpdateType, user_id
|
||||
serialize(&value)
|
||||
}
|
||||
|
||||
/// Why a logout was pushed, absent for a plain one. `KdfChange` isn't sent yet.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/Enums/PushNotificationLogOutReason.cs#L3-L7>
|
||||
#[derive(Copy, Clone, Eq, PartialEq)]
|
||||
pub enum LogOutReason {
|
||||
KeyRotation = 1,
|
||||
}
|
||||
|
||||
// https://github.com/bitwarden/server/blob/375af7c43b10d9da03525d41452f95de3f921541/src/Core/Enums/PushType.cs
|
||||
#[derive(Copy, Clone, Eq, PartialEq)]
|
||||
pub enum UpdateType {
|
||||
|
||||
+6
-5
@@ -12,7 +12,7 @@ use tokio::sync::RwLock;
|
||||
|
||||
use crate::{
|
||||
CONFIG,
|
||||
api::{ApiResult, EmptyResult, UpdateType},
|
||||
api::{ApiResult, EmptyResult, LogOutReason, UpdateType},
|
||||
db::{
|
||||
DbConn,
|
||||
models::{AuthRequestId, Cipher, Device, Folder, PushId, Send, User, UserId},
|
||||
@@ -192,15 +192,15 @@ pub async fn push_cipher_update(ut: UpdateType, cipher: &Cipher, device: &Device
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn push_logout(user: &User, acting_device: Option<&Device>, conn: &DbConn) {
|
||||
pub async fn push_logout(user: &User, acting_device: Option<&Device>, reason: Option<LogOutReason>, conn: &DbConn) {
|
||||
if Device::check_user_has_push_device(&user.uuid, conn).await {
|
||||
push_logout_to_relay(user, acting_device);
|
||||
push_logout_to_relay(user, acting_device, reason);
|
||||
}
|
||||
}
|
||||
|
||||
// Sends the logout without checking for push devices first.
|
||||
// Needed after deleting a user, when the devices are already gone from the database.
|
||||
pub fn push_logout_to_relay(user: &User, acting_device: Option<&Device>) {
|
||||
pub fn push_logout_to_relay(user: &User, acting_device: Option<&Device>, reason: Option<LogOutReason>) {
|
||||
tokio::task::spawn(send_to_push_relay(json!({
|
||||
"userId": user.uuid,
|
||||
"organizationId": (),
|
||||
@@ -209,7 +209,8 @@ pub fn push_logout_to_relay(user: &User, acting_device: Option<&Device>) {
|
||||
"type": UpdateType::LogOut as i32,
|
||||
"payload": {
|
||||
"userId": user.uuid,
|
||||
"date": format_date(&user.updated_at)
|
||||
"date": format_date(&user.updated_at),
|
||||
"reason": reason.map(|r| r as i32),
|
||||
},
|
||||
"clientType": null,
|
||||
"installationId": null
|
||||
|
||||
@@ -0,0 +1,511 @@
|
||||
//! A seeder API for the end-to-end tests, only in builds with the `unsafe_test_mode` feature: it creates accounts with
|
||||
//! no checks at all, so it must never be in a release or a deployment.
|
||||
//!
|
||||
//! It answers the calls the SDK's live tests make to upstream's `util/SeederApi` (`POST /seed` with a scene,
|
||||
//! `DELETE /seed/{playId}`), under `/test/seeder`. Each request needs HTTP basic auth with `TEST_SEEDER_USERNAME` and
|
||||
//! `TEST_SEEDER_PASSWORD` from the environment; without both, every route answers 404. Seeding needs an `X-Play-Id`
|
||||
//! header, and destroying a play deletes the accounts seeded under it. Plays are kept in memory, which is enough for a
|
||||
//! test server that starts on an empty database.
|
||||
//!
|
||||
//! Scenes:
|
||||
//! - `SingleUserScene`: a V1 account for an email and password, under a mangled address like upstream's, with
|
||||
//! PBKDF2 at upstream's default of 5000 iterations.
|
||||
//! - `TestVectorUserScene`: one of the SDK's user test vectors (`test-vectors/users/*.json`), stored as it is: the
|
||||
//! account and its vault are already encrypted. Unlike upstream, the address isn't mangled, since our master
|
||||
//! password salt is the email, so a vector can be seeded once at a time. Text Sends are stored too.
|
||||
//!
|
||||
//! Ref: <https://github.com/bitwarden/server/blob/15c94ac58bf361a162381749c146d254a21b2098/util/SeederApi/Controllers/SeedController.cs#L11-L107>
|
||||
//! Ref: <https://github.com/bitwarden/server/blob/15c94ac58bf361a162381749c146d254a21b2098/util/Seeder/Scenes/SingleUserScene.cs#L38-L154>
|
||||
|
||||
use std::{
|
||||
collections::HashMap,
|
||||
num::NonZeroU32,
|
||||
sync::{LazyLock, Mutex},
|
||||
};
|
||||
|
||||
use chrono::Utc;
|
||||
use data_encoding::{BASE64, HEXLOWER};
|
||||
use openssl::{
|
||||
pkey::PKey,
|
||||
rsa::Rsa,
|
||||
symm::{Cipher, encrypt},
|
||||
};
|
||||
use ring::{hkdf, hmac, pbkdf2};
|
||||
use rocket::{
|
||||
Request, Route,
|
||||
http::Status,
|
||||
request::{FromRequest, Outcome},
|
||||
serde::json::Json,
|
||||
};
|
||||
use serde_json::{Value, json};
|
||||
|
||||
use crate::{
|
||||
api::{
|
||||
ApiResult, JsonResult,
|
||||
core::{seed_cipher, seed_send},
|
||||
},
|
||||
crypto,
|
||||
db::{
|
||||
DbConn,
|
||||
models::{Folder, FolderId, KeyId, SignatureAlgorithm, User, UserId, UserKdfType, UserSignatureKeyPair},
|
||||
},
|
||||
};
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![seed, destroy_play]
|
||||
}
|
||||
|
||||
/// The accounts seeded under each play id.
|
||||
static PLAYS: LazyLock<Mutex<HashMap<String, Vec<UserId>>>> = LazyLock::new(Mutex::default);
|
||||
|
||||
/// HTTP basic auth with `TEST_SEEDER_USERNAME` and `TEST_SEEDER_PASSWORD`.
|
||||
struct SeederAuth;
|
||||
|
||||
#[rocket::async_trait]
|
||||
impl<'r> FromRequest<'r> for SeederAuth {
|
||||
type Error = &'static str;
|
||||
|
||||
async fn from_request(request: &'r Request<'_>) -> Outcome<Self, Self::Error> {
|
||||
let (Ok(username), Ok(password)) =
|
||||
(std::env::var("TEST_SEEDER_USERNAME"), std::env::var("TEST_SEEDER_PASSWORD"))
|
||||
else {
|
||||
return Outcome::Error((Status::NotFound, "The test seeder is off"));
|
||||
};
|
||||
if username.is_empty() || password.is_empty() {
|
||||
return Outcome::Error((Status::NotFound, "The test seeder is off"));
|
||||
}
|
||||
let expected = format!("Basic {}", BASE64.encode(format!("{username}:{password}").as_bytes()));
|
||||
match request.headers().get_one("Authorization") {
|
||||
Some(given) if crypto::ct_eq(given, expected) => Outcome::Success(Self),
|
||||
_ => Outcome::Error((Status::Unauthorized, "Invalid test seeder credentials")),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The `X-Play-Id` header, which names the play a seeding belongs to.
|
||||
struct PlayId(String);
|
||||
|
||||
#[rocket::async_trait]
|
||||
impl<'r> FromRequest<'r> for PlayId {
|
||||
type Error = &'static str;
|
||||
|
||||
async fn from_request(request: &'r Request<'_>) -> Outcome<Self, Self::Error> {
|
||||
match request.headers().get_one("X-Play-Id").map(str::trim) {
|
||||
Some(play_id) if !play_id.is_empty() => Outcome::Success(Self(play_id.to_owned())),
|
||||
_ => Outcome::Error((Status::BadRequest, "Seeding needs an X-Play-Id header")),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct SeedRequest {
|
||||
template: String,
|
||||
arguments: Option<Value>,
|
||||
}
|
||||
|
||||
#[post("/seed", data = "<data>")]
|
||||
async fn seed(data: Json<SeedRequest>, _auth: SeederAuth, play: PlayId, conn: DbConn) -> JsonResult {
|
||||
let data = data.into_inner();
|
||||
let arguments = data.arguments.unwrap_or(Value::Null);
|
||||
let response = match data.template.as_str() {
|
||||
"SingleUserScene" => single_user_scene(serde_json::from_value(arguments)?, &play.0, &conn).await?,
|
||||
"TestVectorUserScene" => test_vector_user_scene(serde_json::from_value(arguments)?, &play.0, &conn).await?,
|
||||
other => err_code!(format!("Unknown scene {}", other.escape_debug()), Status::NotFound.code),
|
||||
};
|
||||
Ok(Json(response))
|
||||
}
|
||||
|
||||
/// Records an account in its play as soon as it's saved, so that destroying the play removes it even when the rest of
|
||||
/// the seeding fails.
|
||||
fn track(play: &str, user_id: &UserId) {
|
||||
PLAYS.lock().unwrap().entry(play.to_owned()).or_default().push(user_id.clone());
|
||||
}
|
||||
|
||||
/// Deletes the accounts seeded under `play_id`; an unknown play is a no-op, like upstream.
|
||||
#[delete("/seed/<play_id>")]
|
||||
async fn destroy_play(play_id: &str, _auth: SeederAuth, conn: DbConn) -> JsonResult {
|
||||
let user_ids = PLAYS.lock().unwrap().remove(play_id).unwrap_or_default();
|
||||
let mut remaining = Vec::new();
|
||||
let mut error = None;
|
||||
for user_id in &user_ids {
|
||||
let Some(user) = User::find_by_uuid(user_id, &conn).await else {
|
||||
continue;
|
||||
};
|
||||
if let Err(e) = user.delete(&conn).await {
|
||||
remaining.push(user_id.clone());
|
||||
error.get_or_insert(e);
|
||||
}
|
||||
}
|
||||
if let Some(error) = error {
|
||||
// Kept in the play, so that destroying it again retries them
|
||||
PLAYS.lock().unwrap().entry(play_id.to_owned()).or_default().extend(remaining);
|
||||
return Err(error);
|
||||
}
|
||||
Ok(Json(json!({ "userIds": user_ids })))
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct SingleUserRequest {
|
||||
email: String,
|
||||
password: String,
|
||||
#[serde(default)]
|
||||
email_verified: bool,
|
||||
kdf_iterations: Option<u32>,
|
||||
#[serde(default)]
|
||||
enroll_in_email2_fa: bool,
|
||||
#[serde(default)]
|
||||
corrupt_private_key: bool,
|
||||
}
|
||||
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/15c94ac58bf361a162381749c146d254a21b2098/util/Seeder/Models/UserSeed.cs#L55>
|
||||
const DEFAULT_KDF_ITERATIONS: u32 = 5_000;
|
||||
|
||||
async fn single_user_scene(request: SingleUserRequest, play: &str, conn: &DbConn) -> ApiResult<Value> {
|
||||
if request.enroll_in_email2_fa || request.corrupt_private_key {
|
||||
err!("enrollInEmail2Fa and corruptPrivateKey aren't supported")
|
||||
}
|
||||
let iterations = request.kdf_iterations.unwrap_or(DEFAULT_KDF_ITERATIONS);
|
||||
if !(5_000..=2_000_000).contains(&iterations) {
|
||||
err!("kdfIterations must be between 5000 and 2000000")
|
||||
}
|
||||
let Some((local, domain)) = request.email.split_once('@') else {
|
||||
err!("The email has no @")
|
||||
};
|
||||
// Like upstream's ManglerService: unique addresses for every seeding
|
||||
let mangled = format!("{}+{local}@{domain}", HEXLOWER.encode(&crypto::get_random_bytes::<4>()));
|
||||
|
||||
let mut user = User::new(&mangled, None);
|
||||
let keys = V1Keys::new(&request.password, &user.master_password_salt(), iterations)?;
|
||||
user.client_kdf_type = UserKdfType::Pbkdf2 as i32;
|
||||
user.client_kdf_iter = iterations.cast_signed();
|
||||
user.client_kdf_memory = None;
|
||||
user.client_kdf_parallelism = None;
|
||||
user.private_key = Some(keys.private_key.clone());
|
||||
user.public_key = Some(keys.public_key.clone());
|
||||
if request.email_verified {
|
||||
user.verified_at = Some(Utc::now().naive_utc());
|
||||
}
|
||||
user.set_password(&keys.master_password_hash, Some(keys.wrapped_user_key.clone()), false, None, conn).await?;
|
||||
user.save(conn).await?;
|
||||
track(play, &user.uuid);
|
||||
|
||||
let response = json!({
|
||||
"mangleMap": mangle_map(&request.email, &user.email),
|
||||
"result": {
|
||||
"userId": user.uuid,
|
||||
"kdf": "PBKDF2_SHA256",
|
||||
"kdfIterations": iterations,
|
||||
"key": keys.wrapped_user_key,
|
||||
"publicKey": keys.public_key,
|
||||
"privateKey": keys.private_key,
|
||||
},
|
||||
});
|
||||
Ok(response)
|
||||
}
|
||||
|
||||
/// What a V1 client makes when it registers, from the master password.
|
||||
struct V1Keys {
|
||||
/// The master password authentication hash, which the client logs in with.
|
||||
master_password_hash: String,
|
||||
/// The user key, wrapped by the stretched master key.
|
||||
wrapped_user_key: String,
|
||||
/// The PKCS#8 RSA private key, wrapped by the user key.
|
||||
private_key: String,
|
||||
/// The SPKI RSA public key.
|
||||
public_key: String,
|
||||
}
|
||||
|
||||
impl V1Keys {
|
||||
fn new(password: &str, salt: &str, iterations: u32) -> ApiResult<Self> {
|
||||
let master_key = pbkdf2_sha256(password.as_bytes(), salt.as_bytes(), iterations);
|
||||
let master_password_hash = BASE64.encode(&pbkdf2_sha256(&master_key, password.as_bytes(), 1));
|
||||
let stretched_enc = hkdf_expand(&master_key, b"enc");
|
||||
let stretched_mac = hkdf_expand(&master_key, b"mac");
|
||||
|
||||
let user_key = crypto::get_random_bytes::<64>();
|
||||
let wrapped_user_key = enc_string(&user_key, &stretched_enc, &stretched_mac)?;
|
||||
|
||||
let key_pair = PKey::from_rsa(Rsa::generate(2048)?)?;
|
||||
let private_key = enc_string(&key_pair.private_key_to_pkcs8()?, &user_key[..32], &user_key[32..])?;
|
||||
let public_key = BASE64.encode(&key_pair.public_key_to_der()?);
|
||||
|
||||
Ok(Self {
|
||||
master_password_hash,
|
||||
wrapped_user_key,
|
||||
private_key,
|
||||
public_key,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
fn pbkdf2_sha256(secret: &[u8], salt: &[u8], iterations: u32) -> [u8; 32] {
|
||||
let mut out = [0u8; 32];
|
||||
let iterations = NonZeroU32::new(iterations).expect("iterations aren't zero");
|
||||
pbkdf2::derive(pbkdf2::PBKDF2_HMAC_SHA256, iterations, salt, secret, &mut out);
|
||||
out
|
||||
}
|
||||
|
||||
/// HKDF-Expand with `key` as the pseudorandom key, as clients stretch the master key.
|
||||
fn hkdf_expand(key: &[u8; 32], info: &[u8]) -> [u8; 32] {
|
||||
let mut out = [0u8; 32];
|
||||
hkdf::Prk::new_less_safe(hkdf::HKDF_SHA256, key)
|
||||
.expand(&[info], hkdf::HKDF_SHA256)
|
||||
.and_then(|okm| okm.fill(&mut out))
|
||||
.expect("32 bytes is a valid HKDF-SHA256 length");
|
||||
out
|
||||
}
|
||||
|
||||
/// An `AesCbc256_HmacSha256_B64` (type 2) EncString.
|
||||
fn enc_string(plaintext: &[u8], enc_key: &[u8], mac_key: &[u8]) -> ApiResult<String> {
|
||||
let iv = crypto::get_random_bytes::<16>();
|
||||
let ciphertext = encrypt(Cipher::aes_256_cbc(), enc_key, Some(&iv), plaintext)?;
|
||||
let mac = hmac::sign(&hmac::Key::new(hmac::HMAC_SHA256, mac_key), &[iv.as_slice(), &ciphertext].concat());
|
||||
Ok(format!("2.{}|{}|{}", BASE64.encode(&iv), BASE64.encode(&ciphertext), BASE64.encode(mac.as_ref())))
|
||||
}
|
||||
|
||||
/// A user test vector; only what a server holds is read from it.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/sdk-internal/blob/ee307a55d5604e96b983595c6379cc9f76ca2f87/e2e/wasm/vectors/load.ts>
|
||||
#[derive(Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct TestVector {
|
||||
name: String,
|
||||
account: VectorAccount,
|
||||
unlock_methods: Vec<Value>,
|
||||
master_password_authentication_hash: Option<String>,
|
||||
raw_cryptographic_state: VectorRawCryptographicState,
|
||||
#[serde(default)]
|
||||
vault: VectorVault,
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct VectorAccount {
|
||||
email: String,
|
||||
security_version: Option<i32>,
|
||||
account_cryptographic_state: Value,
|
||||
}
|
||||
|
||||
/// The public halves the vector records; its private halves are never read.
|
||||
#[derive(Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct VectorRawCryptographicState {
|
||||
public_key: String,
|
||||
verifying_key: Option<String>,
|
||||
user_key_id: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Default, Deserialize)]
|
||||
struct VectorVault {
|
||||
#[serde(default)]
|
||||
ciphers: Vec<VectorItem>,
|
||||
#[serde(default)]
|
||||
folders: Vec<VectorItem>,
|
||||
#[serde(default)]
|
||||
sends: Vec<VectorItem>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
struct VectorItem {
|
||||
id: String,
|
||||
encrypted: Value,
|
||||
}
|
||||
|
||||
/// Upstream's scene, not merged there yet:
|
||||
/// <https://github.com/bitwarden/server/blob/9614f3f54f78ad57090a1fd5228f9c2fac5cbfe2/util/Seeder/Scenes/TestVectorUserScene.cs#L43-L361>
|
||||
async fn test_vector_user_scene(vector: TestVector, play: &str, conn: &DbConn) -> ApiResult<Value> {
|
||||
let Some(unlock) =
|
||||
vector.unlock_methods.iter().find_map(|m| m.pointer("/masterPasswordUnlock/master_password_unlock"))
|
||||
else {
|
||||
err!(format!("Vector {} has no master password unlock method", vector.name.escape_debug()))
|
||||
};
|
||||
let Some(hash) = vector.master_password_authentication_hash.as_deref() else {
|
||||
err!(format!("Vector {} records no master password authentication hash", vector.name.escape_debug()))
|
||||
};
|
||||
let (Some(wrapped_user_key), Some(salt)) = (unlock["masterKeyWrappedUserKey"].as_str(), unlock["salt"].as_str())
|
||||
else {
|
||||
err!("The master password unlock method has no wrapped user key or salt")
|
||||
};
|
||||
|
||||
let mut user = User::new(&vector.account.email, Some(vector.name.clone()));
|
||||
if user.master_password_salt() != salt {
|
||||
err!("The vector's master password salt isn't its email, which is the only salt Vaultwarden supports")
|
||||
}
|
||||
if User::find_by_mail(&user.email, conn).await.is_some() {
|
||||
err!("This vector is already seeded: destroy its play first, its address can't be mangled")
|
||||
}
|
||||
|
||||
apply_kdf(&mut user, &unlock["kdf"])?;
|
||||
let state = &vector.account.account_cryptographic_state;
|
||||
let (v2, private_key) = match (state.get("V1"), state.get("V2")) {
|
||||
(Some(v1), None) => (None, &v1["private_key"]),
|
||||
(None, Some(v2)) => (Some(v2), &v2["private_key"]),
|
||||
_ => err!("The account cryptographic state is neither V1 nor V2"),
|
||||
};
|
||||
user.private_key = Some(json_str(private_key, "private_key")?);
|
||||
user.public_key = Some(vector.raw_cryptographic_state.public_key.clone());
|
||||
let key_id = vector.raw_cryptographic_state.user_key_id.as_deref().or_else(|| unlock["containedKeyId"].as_str());
|
||||
user.key_id = key_id.map(|id| serde_json::from_value::<KeyId>(json!(id))).transpose()?;
|
||||
let signature_key_pair = match v2 {
|
||||
Some(v2) => {
|
||||
user.signed_public_key = Some(json_str(&v2["signed_public_key"], "signed_public_key")?);
|
||||
user.security_state = Some(json_str(&v2["security_state"], "security_state")?);
|
||||
user.security_version = Some(vector.account.security_version.unwrap_or(2));
|
||||
let Some(verifying_key) = vector.raw_cryptographic_state.verifying_key.clone() else {
|
||||
err!("A V2 vector needs its verifying key")
|
||||
};
|
||||
let algorithm = cose_signature_algorithm(&verifying_key)?;
|
||||
Some((algorithm, json_str(&v2["signing_key"], "signing_key")?, verifying_key))
|
||||
}
|
||||
None => None,
|
||||
};
|
||||
user.verified_at = Some(Utc::now().naive_utc());
|
||||
user.set_password(hash, Some(wrapped_user_key.to_owned()), false, None, conn).await?;
|
||||
user.save(conn).await?;
|
||||
track(play, &user.uuid);
|
||||
if let Some((algorithm, signing_key, verifying_key)) = signature_key_pair {
|
||||
UserSignatureKeyPair::new(user.uuid.clone(), algorithm, signing_key, verifying_key).save(conn).await?;
|
||||
}
|
||||
|
||||
// The vault, already encrypted, under fresh ids
|
||||
let mut folder_ids = HashMap::new();
|
||||
let mut folder_ids_by_vector_id = serde_json::Map::new();
|
||||
for folder in &vector.vault.folders {
|
||||
let mut saved = Folder::new(user.uuid.clone(), json_str(&folder.encrypted["name"], "name")?);
|
||||
saved.save(conn).await?;
|
||||
folder_ids.insert(serde_json::from_value::<FolderId>(json!(folder.id))?, saved.uuid.clone());
|
||||
folder_ids_by_vector_id.insert(folder.id.clone(), json!(saved.uuid));
|
||||
}
|
||||
let mut cipher_ids = serde_json::Map::new();
|
||||
for cipher in vector.vault.ciphers {
|
||||
let cipher_id = seed_cipher(cipher.encrypted, &user.uuid, &folder_ids, conn).await?;
|
||||
cipher_ids.insert(cipher.id, json!(cipher_id));
|
||||
}
|
||||
for send in vector.vault.sends {
|
||||
seed_send(send.encrypted, &user.uuid, conn).await?;
|
||||
}
|
||||
|
||||
let response = json!({
|
||||
"mangleMap": mangle_map(&vector.account.email, &user.email),
|
||||
"result": {
|
||||
"userId": user.uuid,
|
||||
"email": user.email,
|
||||
"cipherIds": cipher_ids,
|
||||
"folderIds": folder_ids_by_vector_id,
|
||||
},
|
||||
});
|
||||
Ok(response)
|
||||
}
|
||||
|
||||
/// The vector's KDF: `{"pBKDF2": {"iterations"}}` or `{"argon2id": {"iterations", "memory", "parallelism"}}`.
|
||||
fn apply_kdf(user: &mut User, kdf: &Value) -> ApiResult<()> {
|
||||
let int = |value: &Value| value.as_i64().and_then(|v| i32::try_from(v).ok());
|
||||
if let Some(iterations) = kdf.pointer("/pBKDF2/iterations").and_then(int) {
|
||||
user.client_kdf_type = UserKdfType::Pbkdf2 as i32;
|
||||
user.client_kdf_iter = iterations;
|
||||
user.client_kdf_memory = None;
|
||||
user.client_kdf_parallelism = None;
|
||||
} else if let Some(argon2) = kdf.get("argon2id") {
|
||||
let Some(iterations) = int(&argon2["iterations"]) else {
|
||||
err!("The Argon2id KDF has no iterations")
|
||||
};
|
||||
user.client_kdf_type = UserKdfType::Argon2id as i32;
|
||||
user.client_kdf_iter = iterations;
|
||||
user.client_kdf_memory = int(&argon2["memory"]);
|
||||
user.client_kdf_parallelism = int(&argon2["parallelism"]);
|
||||
} else {
|
||||
err!("Unknown KDF")
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The signature algorithm a COSE verifying key names in its `alg` (label 3) entry.
|
||||
fn cose_signature_algorithm(verifying_key: &str) -> ApiResult<SignatureAlgorithm> {
|
||||
const ALG: i128 = 3;
|
||||
const EDDSA: i128 = -8;
|
||||
const ML_DSA_44: i128 = -48;
|
||||
|
||||
let Ok(bytes) = BASE64.decode(verifying_key.as_bytes()) else {
|
||||
err!("The verifying key isn't base64")
|
||||
};
|
||||
let Ok(serde_cbor_2::Value::Map(entries)) = serde_cbor_2::from_slice::<serde_cbor_2::Value>(&bytes) else {
|
||||
err!("The verifying key isn't a COSE key")
|
||||
};
|
||||
match entries.get(&serde_cbor_2::Value::Integer(ALG)) {
|
||||
Some(serde_cbor_2::Value::Integer(EDDSA)) => Ok(SignatureAlgorithm::Ed25519),
|
||||
Some(serde_cbor_2::Value::Integer(ML_DSA_44)) => Ok(SignatureAlgorithm::MlDsa44),
|
||||
_ => err!("The verifying key's algorithm isn't Ed25519 or ML-DSA-44"),
|
||||
}
|
||||
}
|
||||
|
||||
/// Upstream's map from the address a scene was asked for to the one it stored.
|
||||
fn mangle_map(requested: &str, stored: &str) -> Value {
|
||||
let mut map = serde_json::Map::new();
|
||||
map.insert(requested.to_owned(), json!(stored));
|
||||
Value::Object(map)
|
||||
}
|
||||
|
||||
fn json_str(value: &Value, field: &str) -> ApiResult<String> {
|
||||
let Some(value) = value.as_str() else {
|
||||
err!(format!("The vector's {field} is missing"))
|
||||
};
|
||||
Ok(value.to_owned())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use openssl::symm::decrypt;
|
||||
|
||||
use super::*;
|
||||
|
||||
// From sdk-internal's `test-vectors/users/v1-pbkdf2-min-iterations.json` (d9119f7af)
|
||||
const EMAIL: &str = "v1-pbkdf2-min-iterations@test.bitwarden.com";
|
||||
const PASSWORD: &str = "password-v1-pbkdf2-min-iterations";
|
||||
const ITERATIONS: u32 = 5_000;
|
||||
const AUTHENTICATION_HASH: &str = "4HcwTg4bQKEbuINCJGMqrij1yipl63Ugu/RazH2y7Qw=";
|
||||
const WRAPPED_USER_KEY: &str = "2.tl+DrZdn+fVyBVu+0c/Gvg==|9ivOLNtKbvirNaUnkGsEtysp9de53ibTSu88HLkDOGLig3t8nhvK5JIqxSY1/ukcr2Y/Ly9OJ12tXUGjIlJ/PtIEIdYj3gZDwhAflPUwtW8=|FD5WuIvviib3yWYcI3slmqBSqMf38Z0CMwttPG1w5DY=";
|
||||
const USER_KEY: &str = "49LghK4AVIybWSZFikb4nAn/BofxxBIoXv83EJWOP4taVMbR5XCfrbF2m/eUmfZdeFW7VybPYSGT/bmv5eeMBg==";
|
||||
|
||||
/// Decrypts a type 2 EncString, checking its MAC.
|
||||
fn dec_string(enc_string: &str, enc_key: &[u8], mac_key: &[u8]) -> Vec<u8> {
|
||||
let parts: Vec<Vec<u8>> = enc_string
|
||||
.strip_prefix("2.")
|
||||
.unwrap()
|
||||
.split('|')
|
||||
.map(|part| BASE64.decode(part.as_bytes()).unwrap())
|
||||
.collect();
|
||||
let [iv, ciphertext, mac] = parts.as_slice() else {
|
||||
panic!("not three parts")
|
||||
};
|
||||
let key = hmac::Key::new(hmac::HMAC_SHA256, mac_key);
|
||||
hmac::verify(&key, &[iv.as_slice(), ciphertext].concat(), mac).unwrap();
|
||||
decrypt(Cipher::aes_256_cbc(), enc_key, Some(iv), ciphertext).unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn derives_the_vectors_keys() {
|
||||
let master_key = pbkdf2_sha256(PASSWORD.as_bytes(), EMAIL.as_bytes(), ITERATIONS);
|
||||
assert_eq!(BASE64.encode(&pbkdf2_sha256(&master_key, PASSWORD.as_bytes(), 1)), AUTHENTICATION_HASH);
|
||||
|
||||
let user_key =
|
||||
dec_string(WRAPPED_USER_KEY, &hkdf_expand(&master_key, b"enc"), &hkdf_expand(&master_key, b"mac"));
|
||||
assert_eq!(BASE64.encode(&user_key), USER_KEY);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn makes_keys_a_client_can_open() {
|
||||
let keys = V1Keys::new(PASSWORD, EMAIL, ITERATIONS).unwrap();
|
||||
assert_eq!(keys.master_password_hash, AUTHENTICATION_HASH);
|
||||
|
||||
let master_key = pbkdf2_sha256(PASSWORD.as_bytes(), EMAIL.as_bytes(), ITERATIONS);
|
||||
let user_key =
|
||||
dec_string(&keys.wrapped_user_key, &hkdf_expand(&master_key, b"enc"), &hkdf_expand(&master_key, b"mac"));
|
||||
assert_eq!(user_key.len(), 64);
|
||||
|
||||
let pkcs8 = dec_string(&keys.private_key, &user_key[..32], &user_key[32..]);
|
||||
let private_key = PKey::private_key_from_pkcs8(&pkcs8).unwrap();
|
||||
assert_eq!(BASE64.encode(&private_key.public_key_to_der().unwrap()), keys.public_key);
|
||||
}
|
||||
}
|
||||
+12
-25
@@ -34,7 +34,7 @@ use crate::{
|
||||
models::{
|
||||
AttachmentId, CipherId, Collection, CollectionId, Device, DeviceId, DeviceType, EmergencyAccessId,
|
||||
EventType, Membership, MembershipId, MembershipStatus, MembershipType, OrgApiKeyId, OrganizationId,
|
||||
SendFileId, SendId, User, UserId, UserStampException,
|
||||
SendFileId, SendId, User, UserId,
|
||||
},
|
||||
},
|
||||
error::Error,
|
||||
@@ -632,6 +632,9 @@ impl<'r> FromRequest<'r> for Host {
|
||||
pub struct ClientHeaders {
|
||||
pub device_type: i32,
|
||||
pub ip: ClientIp,
|
||||
/// `Bitwarden-Client-Version`, `None` when missing or not a version. Unlike the [`ClientVersion`] guard, this
|
||||
/// doesn't log an error, as not every client sends it.
|
||||
pub client_version: Option<semver::Version>,
|
||||
}
|
||||
|
||||
#[rocket::async_trait]
|
||||
@@ -648,10 +651,13 @@ impl<'r> FromRequest<'r> for ClientHeaders {
|
||||
.get_one("device-type")
|
||||
.and_then(|d| d.parse().ok())
|
||||
.unwrap_or(DeviceType::UnknownBrowser as i32);
|
||||
let client_version =
|
||||
request.headers().get_one("Bitwarden-Client-Version").and_then(|v| semver::Version::parse(v).ok());
|
||||
|
||||
Outcome::Success(ClientHeaders {
|
||||
device_type,
|
||||
ip,
|
||||
client_version,
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -707,31 +713,12 @@ impl<'r> FromRequest<'r> for Headers {
|
||||
};
|
||||
|
||||
if user.security_stamp != claims.sstamp {
|
||||
if let Some(stamp_exception) =
|
||||
user.stamp_exception.as_deref().and_then(|s| serde_json::from_str::<UserStampException>(s).ok())
|
||||
{
|
||||
let Some(current_route) = request.route().and_then(|r| r.name.as_deref()) else {
|
||||
err_handler!("Error getting current route for stamp exception")
|
||||
};
|
||||
let Some(current_route) = request.route().and_then(|r| r.name.as_deref()) else {
|
||||
err_handler!("Error getting current route for stamp exception")
|
||||
};
|
||||
|
||||
// Check if the stamp exception has expired first.
|
||||
// Then, check if the current route matches any of the allowed routes.
|
||||
// After that check the stamp in exception matches the one in the claims.
|
||||
if Utc::now().timestamp() > stamp_exception.expire {
|
||||
// If the stamp exception has been expired remove it from the database.
|
||||
// This prevents checking this stamp exception for new requests.
|
||||
let mut user = user;
|
||||
user.reset_stamp_exception();
|
||||
if let Err(e) = user.save(&conn).await {
|
||||
error!("Error updating user: {e:#?}");
|
||||
}
|
||||
err_handler!("Stamp exception is expired")
|
||||
} else if !stamp_exception.routes.contains(¤t_route.to_owned()) {
|
||||
err_handler!("Invalid security stamp: Current route and exception route do not match")
|
||||
} else if stamp_exception.security_stamp != claims.sstamp {
|
||||
err_handler!("Invalid security stamp for matched stamp exception")
|
||||
}
|
||||
} else {
|
||||
// Expired exceptions are only dropped on reset; writing them back here could undo a newer reset
|
||||
if !user.stamp_exceptions().iter().any(|e| e.allows(&claims.sstamp, current_route)) {
|
||||
err_handler!("Invalid security stamp")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1516,6 +1516,8 @@ pub const SUPPORTED_FEATURE_FLAGS: &[&str] = &[
|
||||
// Key Management Team
|
||||
"biometrics-sdk-ipc",
|
||||
"windows-native-credential-sync",
|
||||
"enable-account-encryption-v2-jit-password-registration",
|
||||
"pm-27278-v2-password-registration",
|
||||
// Mobile Team
|
||||
"pm-34171-card-scanner",
|
||||
// Platform Team
|
||||
|
||||
+158
-4
@@ -1,7 +1,11 @@
|
||||
mod query_logger;
|
||||
|
||||
use std::{
|
||||
sync::{Arc, OnceLock},
|
||||
future::Future,
|
||||
sync::{
|
||||
Arc, OnceLock,
|
||||
atomic::{AtomicBool, Ordering},
|
||||
},
|
||||
time::Duration,
|
||||
};
|
||||
|
||||
@@ -123,6 +127,7 @@ pub static ACTIVE_DB_TYPE: OnceLock<DbConnType> = OnceLock::new();
|
||||
pub struct DbConn {
|
||||
conn: Arc<Mutex<Option<PooledConnection<DbConnManager>>>>,
|
||||
permit: Option<OwnedSemaphorePermit>,
|
||||
transaction_open: AtomicBool,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
@@ -150,6 +155,7 @@ impl Drop for DbConn {
|
||||
fn drop(&mut self) {
|
||||
let conn = Arc::clone(&self.conn);
|
||||
let permit = self.permit.take();
|
||||
let transaction_open = self.transaction_open.load(Ordering::Acquire);
|
||||
|
||||
// Since connection can't be on the stack in an async fn during an
|
||||
// await, we have to spawn a new blocking-safe thread...
|
||||
@@ -157,7 +163,13 @@ impl Drop for DbConn {
|
||||
// And then re-enter the runtime to wait on the async mutex, but in a blocking fashion.
|
||||
let mut conn = tokio::runtime::Handle::current().block_on(conn.lock_owned());
|
||||
|
||||
if let Some(conn) = conn.take() {
|
||||
if let Some(mut conn) = conn.take() {
|
||||
if transaction_open {
|
||||
// A cancelled request must not return an open transaction to the pool.
|
||||
if let Err(error) = conn.batch_execute("ROLLBACK") {
|
||||
error!("Failed to roll back a cancelled database transaction: {error}");
|
||||
}
|
||||
}
|
||||
drop(conn);
|
||||
}
|
||||
|
||||
@@ -248,6 +260,7 @@ impl DbPool {
|
||||
Ok(DbConn {
|
||||
conn: Arc::new(Mutex::new(Some(c))),
|
||||
permit: Some(permit),
|
||||
transaction_open: AtomicBool::new(false),
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -320,6 +333,29 @@ impl DbConnType {
|
||||
}
|
||||
|
||||
impl DbConn {
|
||||
/// Run asynchronous model calls on this request's pooled connection in one transaction.
|
||||
/// Send external notifications only after this returns successfully.
|
||||
pub async fn transaction<F, Fut, T>(&self, operation: F) -> Result<T, Error>
|
||||
where
|
||||
F: FnOnce() -> Fut,
|
||||
Fut: Future<Output = Result<T, Error>>,
|
||||
{
|
||||
self.run(|conn| conn.batch_execute("BEGIN")).await.map_res("Error starting database transaction")?;
|
||||
self.transaction_open.store(true, Ordering::Release);
|
||||
let result = operation().await;
|
||||
if result.is_ok() {
|
||||
let committed = self.run(|conn| conn.batch_execute("COMMIT")).await;
|
||||
let closed = committed.is_ok() || self.run(|conn| conn.batch_execute("ROLLBACK")).await.is_ok();
|
||||
if closed {
|
||||
self.transaction_open.store(false, Ordering::Release);
|
||||
}
|
||||
committed.map_res("Error committing database transaction")?;
|
||||
} else if self.run(|conn| conn.batch_execute("ROLLBACK")).await.is_ok() {
|
||||
self.transaction_open.store(false, Ordering::Release);
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
pub async fn run<F, R>(&self, f: F) -> R
|
||||
where
|
||||
F: FnOnce(&mut DbConnInner) -> R + Send,
|
||||
@@ -538,9 +574,61 @@ mod postgresql_migrations {
|
||||
/// A throwaway SQLite database with the real schema, for tests that need to run queries.
|
||||
#[cfg(all(test, sqlite))]
|
||||
pub mod test_db {
|
||||
use super::sqlite_migrations::MIGRATIONS;
|
||||
use diesel::connection::SimpleConnection;
|
||||
use super::{DbConn, DbConnManager, sqlite_migrations::MIGRATIONS};
|
||||
use diesel::{Connection, connection::SimpleConnection, r2d2::Pool, sqlite::SqliteConnection};
|
||||
use diesel_migrations::MigrationHarness;
|
||||
use std::sync::{Arc, atomic::AtomicBool};
|
||||
use tokio::sync::Mutex;
|
||||
|
||||
pub struct TestDb {
|
||||
pool: Pool<DbConnManager>,
|
||||
// Keep the named in-memory database alive across pooled connections.
|
||||
_keeper: SqliteConnection,
|
||||
}
|
||||
|
||||
impl TestDb {
|
||||
fn new() -> Self {
|
||||
let url = format!("sqlite://{}?mode=memory&cache=shared", crate::util::get_uuid());
|
||||
let mut keeper = SqliteConnection::establish(&url).unwrap();
|
||||
keeper.run_pending_migrations(MIGRATIONS).unwrap();
|
||||
let pool = Pool::builder().max_size(2).build(DbConnManager::new(&url)).unwrap();
|
||||
Self {
|
||||
pool,
|
||||
_keeper: keeper,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn conn(&self) -> DbConn {
|
||||
DbConn {
|
||||
conn: Arc::new(Mutex::new(Some(self.pool.get().unwrap()))),
|
||||
permit: None,
|
||||
transaction_open: AtomicBool::new(false),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// CONFIG must initialize in a child process: the DNS bootstrap test needs it uninitialized.
|
||||
pub fn run(test: impl AsyncFnOnce(&TestDb)) {
|
||||
if std::env::var_os("VAULTWARDEN_ISOLATED_CONFIG_TEST").is_none() {
|
||||
let output = std::process::Command::new(std::env::current_exe().unwrap())
|
||||
.args(["--exact", std::thread::current().name().unwrap(), "--nocapture"])
|
||||
.env("VAULTWARDEN_ISOLATED_CONFIG_TEST", "1")
|
||||
.env("DATABASE_URL", "sqlite://:memory:")
|
||||
.output()
|
||||
.unwrap();
|
||||
assert!(
|
||||
output.status.success() && String::from_utf8_lossy(&output.stdout).contains("1 passed; 0 failed"),
|
||||
"{}\n{}",
|
||||
String::from_utf8_lossy(&output.stdout),
|
||||
String::from_utf8_lossy(&output.stderr)
|
||||
);
|
||||
return;
|
||||
}
|
||||
// DbConn::run uses block_in_place, requiring a multi-threaded runtime.
|
||||
tokio::runtime::Builder::new_multi_thread().enable_all().build().unwrap().block_on(async {
|
||||
test(&TestDb::new()).await;
|
||||
});
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn custom_role_migration_preserves_memberships_and_guards_downgrade() {
|
||||
@@ -604,4 +692,70 @@ pub mod test_db {
|
||||
assert_eq!(grants(&mut conn), 0);
|
||||
assert_eq!(rows(&mut conn), before);
|
||||
}
|
||||
|
||||
use super::models::{Collection, CustomPermission, Membership, MembershipType, Organization, OrganizationId, User};
|
||||
|
||||
pub async fn organization(conn: &DbConn) -> Organization {
|
||||
let org = Organization::new("Org".into(), "billing@example.com", None, None);
|
||||
org.save(conn).await.unwrap();
|
||||
org
|
||||
}
|
||||
|
||||
pub async fn member(
|
||||
conn: &DbConn,
|
||||
org: &OrganizationId,
|
||||
role: MembershipType,
|
||||
permissions: &[CustomPermission],
|
||||
) -> (User, Membership) {
|
||||
let mut user = User::new(&format!("{}@example.com", crate::util::get_uuid()), None);
|
||||
user.password_hash = b"existing-account".to_vec();
|
||||
user.save(conn).await.unwrap();
|
||||
let mut member = Membership::new(user.uuid.clone(), org.clone(), None);
|
||||
member.set_type(role);
|
||||
member.status = 2;
|
||||
member.set_custom_permissions(&permissions.iter().copied().collect());
|
||||
member.save(conn).await.unwrap();
|
||||
(user, member)
|
||||
}
|
||||
|
||||
pub async fn custom_member(conn: &DbConn, permission: CustomPermission) -> (Organization, User, Membership) {
|
||||
let org = organization(conn).await;
|
||||
let (user, member) = member(conn, &org.uuid, MembershipType::Custom, &[permission]).await;
|
||||
(org, user, member)
|
||||
}
|
||||
|
||||
pub async fn collection(conn: &DbConn, org: &OrganizationId) -> Collection {
|
||||
let collection = Collection::new(org.clone(), "Collection".into(), None);
|
||||
collection.save(conn).await.unwrap();
|
||||
collection
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn transactions_rollback_before_connection_reuse_and_commit_success() {
|
||||
use crate::error::MapResult;
|
||||
use diesel::RunQueryDsl;
|
||||
run(async |db| {
|
||||
let conn = db.conn();
|
||||
conn.run(|c| c.batch_execute("CREATE TABLE probe (id INTEGER PRIMARY KEY)")).await.unwrap();
|
||||
for (sql, expected) in [
|
||||
("INSERT INTO probe VALUES (1); INSERT INTO probe VALUES (1)", 0_i64),
|
||||
("INSERT INTO probe VALUES (1)", 1),
|
||||
] {
|
||||
let result: Result<(), super::Error> = conn
|
||||
.transaction(async || conn.run(move |c| c.batch_execute(sql)).await.map_res("Insert failed"))
|
||||
.await;
|
||||
assert_eq!(result.is_ok(), expected == 1);
|
||||
let count: i64 = conn
|
||||
.run(|c| {
|
||||
diesel::select(diesel::dsl::sql::<diesel::sql_types::BigInt>("(SELECT COUNT(*) FROM probe)"))
|
||||
.get_result(c)
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(count, expected);
|
||||
// The same live connection must accept another transaction, before DbConn::drop can help.
|
||||
conn.run(|c| c.batch_execute("BEGIN; ROLLBACK")).await.unwrap();
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
+240
-73
@@ -1,4 +1,4 @@
|
||||
use std::borrow::Cow;
|
||||
use std::{borrow::Cow, collections::HashSet};
|
||||
|
||||
use chrono::{NaiveDateTime, TimeDelta, Utc};
|
||||
use derive_more::{AsRef, Deref, Display, From};
|
||||
@@ -19,7 +19,7 @@ use crate::{
|
||||
},
|
||||
},
|
||||
error::MapResult,
|
||||
util::LowerCase,
|
||||
util::{LowerCase, convert_json_key_lcase_first},
|
||||
};
|
||||
use macros::UuidFromParam;
|
||||
|
||||
@@ -63,14 +63,68 @@ pub struct Cipher {
|
||||
pub reprompt: Option<i32>,
|
||||
}
|
||||
|
||||
/// Whether `data` is a v2 cipher blob, recognized like upstream by a top-level `format_version` key.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/Vault/Entities/Cipher.cs#L36-L41>
|
||||
pub fn is_data_blob_encrypted(data: &str) -> bool {
|
||||
serde_json::from_str::<Value>(data).is_ok_and(|d| is_blob_value(&d))
|
||||
}
|
||||
|
||||
/// [`is_data_blob_encrypted`] for `data` that was already parsed.
|
||||
fn is_blob_value(data: &Value) -> bool {
|
||||
data.get("format_version").is_some()
|
||||
}
|
||||
|
||||
pub enum RepromptType {
|
||||
None = 0,
|
||||
Password = 1,
|
||||
}
|
||||
|
||||
/// Which access a cipher operation is authorized with.
|
||||
///
|
||||
/// The administrative cipher routes (`/ciphers/<id>/admin` and friends) are served by the same handlers as the
|
||||
/// regular vault routes, so the handlers state which one applies. They only differ for a Custom member with Edit
|
||||
/// any collection, who reaches every cipher of the organization on the administrative routes, but keeps their
|
||||
/// own vault limited to the collections they are assigned to.
|
||||
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
||||
pub enum CipherAccessScope {
|
||||
User,
|
||||
OrganizationAdmin,
|
||||
}
|
||||
|
||||
impl CipherAccessScope {
|
||||
/// Whether `member` reaches every cipher of their organization with this access.
|
||||
fn reaches_all_ciphers(self, member: &Membership) -> bool {
|
||||
match self {
|
||||
CipherAccessScope::User => member.has_full_access(),
|
||||
CipherAccessScope::OrganizationAdmin => member.can_edit_any_collection(),
|
||||
}
|
||||
}
|
||||
|
||||
/// The access the v2 attachment upload asks for with `adminRequest`. It only picks which check runs, the
|
||||
/// administrative one still needs a member who may edit any collection.
|
||||
pub fn requested(admin_request: Option<bool>) -> Self {
|
||||
if admin_request == Some(true) {
|
||||
CipherAccessScope::OrganizationAdmin
|
||||
} else {
|
||||
CipherAccessScope::User
|
||||
}
|
||||
}
|
||||
|
||||
/// The access for a route that does not tell which one it is, from the member's own membership.
|
||||
pub fn for_member(member: Option<&Membership>) -> Self {
|
||||
if member.is_some_and(Membership::can_edit_any_collection) {
|
||||
CipherAccessScope::OrganizationAdmin
|
||||
} else {
|
||||
CipherAccessScope::User
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Local methods
|
||||
impl Cipher {
|
||||
pub fn new(atype: i32, name: String) -> Self {
|
||||
/// The name is set when the data is saved, since a blob-encrypted cipher has it inside `data`
|
||||
pub fn new(atype: i32) -> Self {
|
||||
let now = Utc::now().naive_utc();
|
||||
|
||||
Self {
|
||||
@@ -84,7 +138,7 @@ impl Cipher {
|
||||
key: None,
|
||||
|
||||
atype,
|
||||
name,
|
||||
name: String::new(),
|
||||
|
||||
notes: None,
|
||||
fields: None,
|
||||
@@ -110,6 +164,16 @@ impl Cipher {
|
||||
.insert(format!("Ciphers[{index}].Notes"), serde_json::to_value([&max_note_size_msg]).unwrap());
|
||||
}
|
||||
|
||||
let is_blob = cipher.is_blob();
|
||||
if let Err(e) = cipher.validate_content(is_blob) {
|
||||
validation_errors
|
||||
.insert(format!("Ciphers[{index}].{}", e.field), serde_json::to_value([e.message]).unwrap());
|
||||
}
|
||||
if let Err(e) = cipher.validate_type_data(is_blob) {
|
||||
validation_errors
|
||||
.insert(format!("Ciphers[{index}].Type"), serde_json::to_value([e.message()]).unwrap());
|
||||
}
|
||||
|
||||
// Validate the password history if it contains `null` values and if so, return a warning
|
||||
if let Some(Value::Array(password_history)) = &cipher.password_history {
|
||||
for pwh in password_history {
|
||||
@@ -151,9 +215,36 @@ impl Cipher {
|
||||
cipher_sync_data: Option<&CipherSyncData>,
|
||||
sync_type: CipherSyncType,
|
||||
conn: &DbConn,
|
||||
) -> Result<Value, crate::Error> {
|
||||
self.to_json_scoped(host, user_uuid, cipher_sync_data, sync_type, CipherAccessScope::User, conn).await
|
||||
}
|
||||
|
||||
/// [`Cipher::to_json`] for an administrative route, telling what the member may do with the cipher there.
|
||||
pub async fn to_json_org_admin(
|
||||
&self,
|
||||
host: &str,
|
||||
user_uuid: &UserId,
|
||||
conn: &DbConn,
|
||||
) -> Result<Value, crate::Error> {
|
||||
self.to_json_scoped(host, user_uuid, None, CipherSyncType::User, CipherAccessScope::OrganizationAdmin, conn)
|
||||
.await
|
||||
}
|
||||
|
||||
async fn to_json_scoped(
|
||||
&self,
|
||||
host: &str,
|
||||
user_uuid: &UserId,
|
||||
cipher_sync_data: Option<&CipherSyncData>,
|
||||
sync_type: CipherSyncType,
|
||||
scope: CipherAccessScope,
|
||||
conn: &DbConn,
|
||||
) -> Result<Value, crate::Error> {
|
||||
use crate::util::{format_date, validate_and_format_date};
|
||||
|
||||
// Parsed once, since `data` can be large and this runs for every cipher in a sync
|
||||
let type_data = serde_json::from_str::<Value>(&self.data);
|
||||
let is_blob_encrypted = type_data.as_ref().is_ok_and(is_blob_value);
|
||||
|
||||
let mut attachments_json: Value = Value::Null;
|
||||
if let Some(cipher_sync_data) = cipher_sync_data {
|
||||
if let Some(attachments) = cipher_sync_data.cipher_attachments.get(&self.uuid)
|
||||
@@ -179,7 +270,7 @@ impl Cipher {
|
||||
// We don't need these values at all for Organizational syncs
|
||||
// Skip any other database calls if this is the case and just return false.
|
||||
let (read_only, hide_passwords, _) = if sync_type == CipherSyncType::User {
|
||||
if let Some((ro, hp, mn)) = self.get_access_restrictions(user_uuid, cipher_sync_data, conn).await {
|
||||
if let Some((ro, hp, mn)) = self.get_access_restrictions(user_uuid, scope, cipher_sync_data, conn).await {
|
||||
(ro, hp, mn)
|
||||
} else {
|
||||
error!("Cipher ownership assertion failure");
|
||||
@@ -250,63 +341,9 @@ impl Cipher {
|
||||
})
|
||||
.unwrap_or_default();
|
||||
|
||||
// Get the type_data or a default to an empty json object '{}'.
|
||||
// If not passing an empty object, mobile clients will crash.
|
||||
let mut type_data_json = serde_json::from_str::<LowerCase<Value>>(&self.data)
|
||||
.inspect_err(|_| warn!("Error parsing data field for {}", self.uuid))
|
||||
.map_or_else(|_| Value::Object(serde_json::Map::new()), |d| d.data);
|
||||
|
||||
// NOTE: This was marked as *Backwards Compatibility Code*, but as of January 2021 this is still being used by upstream
|
||||
// Set the first element of the Uris array as Uri, this is needed several (mobile) clients.
|
||||
if self.atype == 1 {
|
||||
// Upstream always has an `uri` key/value
|
||||
type_data_json["uri"] = Value::Null;
|
||||
if let Some(uris) = type_data_json["uris"].as_array_mut()
|
||||
&& !uris.is_empty()
|
||||
{
|
||||
// Fix uri match values first, they are only allowed to be a number or null
|
||||
// If it is a string, convert it to an int or null if that fails
|
||||
for uri in &mut *uris {
|
||||
if uri["match"].is_string() {
|
||||
let match_value = match uri["match"].as_str().unwrap_or_default().parse::<u8>() {
|
||||
Ok(n) => json!(n),
|
||||
_ => Value::Null,
|
||||
};
|
||||
uri["match"] = match_value;
|
||||
}
|
||||
}
|
||||
type_data_json["uri"] = uris[0]["uri"].clone();
|
||||
}
|
||||
|
||||
// Check if `passwordRevisionDate` is a valid date, else convert it
|
||||
if let Some(pw_revision) = type_data_json["passwordRevisionDate"].as_str() {
|
||||
type_data_json["passwordRevisionDate"] = json!(validate_and_format_date(pw_revision));
|
||||
}
|
||||
}
|
||||
|
||||
// Fix secure note issues when data is invalid
|
||||
// This breaks at least the native mobile clients
|
||||
if self.atype == 2 {
|
||||
match type_data_json {
|
||||
Value::Object(ref t) if t.get("type").is_some_and(Value::is_number) => {}
|
||||
_ => {
|
||||
type_data_json = json!({"type": 0});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Fix invalid SSH Entries
|
||||
// This breaks at least the native mobile client if invalid
|
||||
// The only way to fix this is by setting type_data_json to `null`
|
||||
// Opening this ssh-key in the mobile client will probably crash the client, but you can edit, save and afterwards delete it
|
||||
if self.atype == 5
|
||||
&& (type_data_json["keyFingerprint"].as_str().is_none_or(str::is_empty)
|
||||
|| type_data_json["privateKey"].as_str().is_none_or(str::is_empty)
|
||||
|| type_data_json["publicKey"].as_str().is_none_or(str::is_empty))
|
||||
{
|
||||
warn!("Error parsing ssh-key, mandatory fields are invalid for {}", self.uuid);
|
||||
type_data_json = Value::Null;
|
||||
}
|
||||
// Like upstream, fields and password history stored as NULL are sent as null, not `[]`
|
||||
let fields_json = self.fields.is_some().then_some(fields_json);
|
||||
let password_history_json = self.password_history.is_some().then_some(password_history_json);
|
||||
|
||||
let collection_ids = if let Some(cipher_sync_data) = cipher_sync_data {
|
||||
if let Some(cipher_collections) = cipher_sync_data.cipher_collections.get(&self.uuid) {
|
||||
@@ -403,10 +440,84 @@ impl Cipher {
|
||||
_ => err!(format!("Cipher {} has an invalid type {}", self.uuid, self.atype)),
|
||||
};
|
||||
|
||||
json_object[key] = type_data_json;
|
||||
if is_blob_encrypted {
|
||||
// Like upstream, sent as-is with the structured fields null
|
||||
json_object["data"] = json!(self.data);
|
||||
json_object["name"] = Value::Null;
|
||||
} else {
|
||||
json_object[key] = self.legacy_type_data_json(type_data);
|
||||
}
|
||||
Ok(json_object)
|
||||
}
|
||||
|
||||
/// The per-type data of a legacy cipher, with fixups for values known to break clients.
|
||||
fn legacy_type_data_json(&self, type_data: Result<Value, serde_json::Error>) -> Value {
|
||||
use crate::util::validate_and_format_date;
|
||||
|
||||
// Get the type_data or a default to an empty json object '{}'.
|
||||
// If not passing an empty object, mobile clients will crash.
|
||||
let mut type_data_json = if let Ok(data @ Value::Object(_)) = type_data {
|
||||
convert_json_key_lcase_first(data)
|
||||
} else {
|
||||
warn!("Error parsing data field for {}", self.uuid);
|
||||
Value::Object(serde_json::Map::new())
|
||||
};
|
||||
|
||||
// NOTE: This was marked as *Backwards Compatibility Code*, but as of January 2021 this is still being used by upstream
|
||||
// Set the first element of the Uris array as Uri, this is needed several (mobile) clients.
|
||||
if self.atype == 1 {
|
||||
// Upstream always has an `uri` key/value
|
||||
type_data_json["uri"] = Value::Null;
|
||||
if let Some(uris) = type_data_json["uris"].as_array_mut()
|
||||
&& !uris.is_empty()
|
||||
{
|
||||
// Fix uri match values first, they are only allowed to be a number or null
|
||||
// If it is a string, convert it to an int or null if that fails
|
||||
for uri in &mut *uris {
|
||||
if uri["match"].is_string() {
|
||||
let match_value = match uri["match"].as_str().unwrap_or_default().parse::<u8>() {
|
||||
Ok(n) => json!(n),
|
||||
_ => Value::Null,
|
||||
};
|
||||
uri["match"] = match_value;
|
||||
}
|
||||
}
|
||||
type_data_json["uri"] = uris[0]["uri"].clone();
|
||||
}
|
||||
|
||||
// Check if `passwordRevisionDate` is a valid date, else convert it
|
||||
if let Some(pw_revision) = type_data_json["passwordRevisionDate"].as_str() {
|
||||
type_data_json["passwordRevisionDate"] = json!(validate_and_format_date(pw_revision));
|
||||
}
|
||||
}
|
||||
|
||||
// Fix secure note issues when data is invalid
|
||||
// This breaks at least the native mobile clients
|
||||
if self.atype == 2 {
|
||||
match type_data_json {
|
||||
Value::Object(ref t) if t.get("type").is_some_and(Value::is_number) => {}
|
||||
_ => {
|
||||
type_data_json = json!({"type": 0});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Fix invalid SSH Entries
|
||||
// This breaks at least the native mobile client if invalid
|
||||
// The only way to fix this is by setting type_data_json to `null`
|
||||
// Opening this ssh-key in the mobile client will probably crash the client, but you can edit, save and afterwards delete it
|
||||
if self.atype == 5
|
||||
&& (type_data_json["keyFingerprint"].as_str().is_none_or(str::is_empty)
|
||||
|| type_data_json["privateKey"].as_str().is_none_or(str::is_empty)
|
||||
|| type_data_json["publicKey"].as_str().is_none_or(str::is_empty))
|
||||
{
|
||||
warn!("Error parsing ssh-key, mandatory fields are invalid for {}", self.uuid);
|
||||
type_data_json = Value::Null;
|
||||
}
|
||||
|
||||
type_data_json
|
||||
}
|
||||
|
||||
pub async fn update_users_revision(&self, conn: &DbConn) -> Vec<UserId> {
|
||||
let mut user_uuids = Vec::new();
|
||||
match self.user_uuid {
|
||||
@@ -562,20 +673,21 @@ impl Cipher {
|
||||
self.user_uuid.is_some() && self.user_uuid.as_ref().unwrap() == user_uuid
|
||||
}
|
||||
|
||||
/// Returns whether this cipher is owned by an org in which the user has full access.
|
||||
/// Returns whether this cipher is owned by an org in which the user reaches every cipher with `scope`.
|
||||
async fn is_in_full_access_org(
|
||||
&self,
|
||||
user_uuid: &UserId,
|
||||
scope: CipherAccessScope,
|
||||
cipher_sync_data: Option<&CipherSyncData>,
|
||||
conn: &DbConn,
|
||||
) -> bool {
|
||||
if let Some(ref org_uuid) = self.organization_uuid {
|
||||
if let Some(cipher_sync_data) = cipher_sync_data {
|
||||
if let Some(cached_member) = cipher_sync_data.members.get(org_uuid) {
|
||||
return cached_member.has_full_access();
|
||||
return scope.reaches_all_ciphers(cached_member);
|
||||
}
|
||||
} else if let Some(member) = Membership::find_confirmed_by_user_and_org(user_uuid, org_uuid, conn).await {
|
||||
return member.has_full_access();
|
||||
return scope.reaches_all_ciphers(&member);
|
||||
}
|
||||
}
|
||||
false
|
||||
@@ -608,6 +720,7 @@ impl Cipher {
|
||||
pub async fn get_access_restrictions(
|
||||
&self,
|
||||
user_uuid: &UserId,
|
||||
scope: CipherAccessScope,
|
||||
cipher_sync_data: Option<&CipherSyncData>,
|
||||
conn: &DbConn,
|
||||
) -> Option<(bool, bool, bool)> {
|
||||
@@ -615,7 +728,7 @@ impl Cipher {
|
||||
// a collection that the user has full access to. If so, there are no
|
||||
// access restrictions.
|
||||
if self.is_owned_by_user(user_uuid)
|
||||
|| self.is_in_full_access_org(user_uuid, cipher_sync_data, conn).await
|
||||
|| self.is_in_full_access_org(user_uuid, scope, cipher_sync_data, conn).await
|
||||
|| self.is_in_full_access_group(user_uuid, cipher_sync_data, conn).await
|
||||
{
|
||||
return Some((false, false, true));
|
||||
@@ -738,8 +851,13 @@ impl Cipher {
|
||||
.await
|
||||
}
|
||||
|
||||
pub async fn is_write_accessible_to_user(&self, user_uuid: &UserId, conn: &DbConn) -> bool {
|
||||
match self.get_access_restrictions(user_uuid, None, conn).await {
|
||||
pub async fn is_write_accessible_to_user(
|
||||
&self,
|
||||
user_uuid: &UserId,
|
||||
scope: CipherAccessScope,
|
||||
conn: &DbConn,
|
||||
) -> bool {
|
||||
match self.get_access_restrictions(user_uuid, scope, None, conn).await {
|
||||
Some((read_only, _hide_passwords, manage)) => !read_only || manage,
|
||||
None => false,
|
||||
}
|
||||
@@ -747,15 +865,20 @@ impl Cipher {
|
||||
|
||||
// used for checking if collection can be edited (only if user has access to a collection they
|
||||
// can write to and also passwords are not hidden to prevent privilege escalation)
|
||||
pub async fn is_in_editable_collection_by_user(&self, user_uuid: &UserId, conn: &DbConn) -> bool {
|
||||
match self.get_access_restrictions(user_uuid, None, conn).await {
|
||||
pub async fn is_in_editable_collection_by_user(
|
||||
&self,
|
||||
user_uuid: &UserId,
|
||||
scope: CipherAccessScope,
|
||||
conn: &DbConn,
|
||||
) -> bool {
|
||||
match self.get_access_restrictions(user_uuid, scope, None, conn).await {
|
||||
Some((read_only, hide_passwords, manage)) => (!read_only && !hide_passwords) || manage,
|
||||
None => false,
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn is_accessible_to_user(&self, user_uuid: &UserId, conn: &DbConn) -> bool {
|
||||
self.get_access_restrictions(user_uuid, None, conn).await.is_some()
|
||||
pub async fn is_accessible_to_user(&self, user_uuid: &UserId, scope: CipherAccessScope, conn: &DbConn) -> bool {
|
||||
self.get_access_restrictions(user_uuid, scope, None, conn).await.is_some()
|
||||
}
|
||||
|
||||
// Returns whether this cipher is a favorite of the specified user.
|
||||
@@ -1193,6 +1316,50 @@ impl Cipher {
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
/// Every collection of every cipher of the organization, for the members who may see all of them.
|
||||
pub async fn get_collections_with_cipher_by_organization(
|
||||
org_uuid: &OrganizationId,
|
||||
conn: &DbConn,
|
||||
) -> Vec<(CipherId, CollectionId)> {
|
||||
conn.run(move |conn| {
|
||||
ciphers_collections::table
|
||||
.inner_join(collections::table.on(collections::uuid.eq(ciphers_collections::collection_uuid)))
|
||||
.filter(collections::org_uuid.eq(org_uuid))
|
||||
.select(ciphers_collections::all_columns)
|
||||
.load::<(CipherId, CollectionId)>(conn)
|
||||
.unwrap_or_default()
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
/// The ciphers of the organization of `member` the Admin Console lists when they may not edit every cipher, like
|
||||
/// Bitwarden does: the ones in the member's own vault, then, for a member who may edit any collection, the ones in
|
||||
/// no collection at all.
|
||||
pub async fn find_assigned_to_member(member: &Membership, conn: &DbConn) -> (Vec<Self>, Vec<Self>) {
|
||||
let assigned: Vec<Self> = Self::find_by_user_visible(&member.user_uuid, conn)
|
||||
.await
|
||||
.into_iter()
|
||||
.filter(|cipher| cipher.organization_uuid.as_ref() == Some(&member.org_uuid))
|
||||
.collect();
|
||||
if !member.can_edit_any_collection() {
|
||||
return (assigned, Vec::new());
|
||||
}
|
||||
|
||||
let listed: HashSet<CipherId> = assigned.iter().map(|cipher| cipher.uuid.clone()).collect();
|
||||
let in_collections: HashSet<CipherId> =
|
||||
Self::get_collections_with_cipher_by_organization(&member.org_uuid, conn)
|
||||
.await
|
||||
.into_iter()
|
||||
.map(|(cipher, _)| cipher)
|
||||
.collect();
|
||||
let unassigned = Self::find_by_org(&member.org_uuid, conn)
|
||||
.await
|
||||
.into_iter()
|
||||
.filter(|cipher| !in_collections.contains(&cipher.uuid) && !listed.contains(&cipher.uuid))
|
||||
.collect();
|
||||
(assigned, unassigned)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(
|
||||
|
||||
@@ -17,11 +17,12 @@ mod two_factor;
|
||||
mod two_factor_duo_context;
|
||||
mod two_factor_incomplete;
|
||||
mod user;
|
||||
mod user_signature_key_pair;
|
||||
|
||||
pub use self::archive::Archive;
|
||||
pub use self::attachment::{Attachment, AttachmentId};
|
||||
pub use self::auth_request::{AuthRequest, AuthRequestId};
|
||||
pub use self::cipher::{Cipher, CipherId, RepromptType};
|
||||
pub use self::cipher::{Cipher, CipherAccessScope, CipherId, RepromptType, is_data_blob_encrypted};
|
||||
pub use self::collection::{Collection, CollectionCipher, CollectionId, CollectionUser};
|
||||
pub use self::device::{Device, DeviceId, DeviceType, DeviceWithAuthRequest, PushId};
|
||||
pub use self::emergency_access::{
|
||||
@@ -41,4 +42,5 @@ pub use self::sso_auth::{OIDCAuthenticatedUser, OIDCCodeResponseError, SsoAuth};
|
||||
pub use self::two_factor::{TwoFactor, TwoFactorType};
|
||||
pub use self::two_factor_duo_context::TwoFactorDuoContext;
|
||||
pub use self::two_factor_incomplete::TwoFactorIncomplete;
|
||||
pub use self::user::{Invitation, KeyId, SsoUser, User, UserId, UserKdfType, UserStampException};
|
||||
pub use self::user::{Invitation, KeyId, SsoUser, User, UserId, UserKdfType};
|
||||
pub use self::user_signature_key_pair::{SignatureAlgorithm, UserSignatureKeyPair};
|
||||
@@ -69,6 +69,9 @@ pub struct Membership {
|
||||
access_event_logs: bool,
|
||||
access_import_export: bool,
|
||||
access_reports: bool,
|
||||
|
||||
/// The user's v2 upgrade token, for the org to unwrap the v2 user key after an upgrade. Opaque to us.
|
||||
pub v2_upgrade_token: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Identifiable, Queryable, Insertable, AsChangeset)]
|
||||
@@ -407,6 +410,8 @@ impl Membership {
|
||||
access_event_logs: false,
|
||||
access_import_export: false,
|
||||
access_reports: false,
|
||||
|
||||
v2_upgrade_token: None,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -483,6 +488,35 @@ impl Membership {
|
||||
)
|
||||
}
|
||||
|
||||
fn custom_permission(&self, permission: CustomPermission) -> bool {
|
||||
match permission {
|
||||
CustomPermission::ManageUsers => self.manage_users,
|
||||
CustomPermission::ManageGroups => self.manage_groups,
|
||||
CustomPermission::ManagePolicies => self.manage_policies,
|
||||
CustomPermission::CreateNewCollections => self.create_new_collections,
|
||||
CustomPermission::EditAnyCollection => self.edit_any_collection,
|
||||
CustomPermission::DeleteAnyCollection => self.delete_any_collection,
|
||||
CustomPermission::AccessEventLogs => self.access_event_logs,
|
||||
CustomPermission::AccessImportExport => self.access_import_export,
|
||||
CustomPermission::AccessReports => self.access_reports,
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether the role of this member grants `permission`. Only a Custom role grants any, only while Custom roles
|
||||
/// are enabled, and only the permissions this version enforces.
|
||||
fn grants_custom_permission(&self, permission: CustomPermission) -> bool {
|
||||
custom_roles_enabled()
|
||||
&& permission.is_supported()
|
||||
&& self.has_type(MembershipType::Custom)
|
||||
&& self.custom_permission(permission)
|
||||
}
|
||||
|
||||
/// Whether this member may act with `permission`, granted by their Custom role. Like the authority of any
|
||||
/// other role, it needs a confirmed membership.
|
||||
pub fn has_custom_permission(&self, permission: CustomPermission) -> bool {
|
||||
self.has_status(MembershipStatus::Confirmed) && self.grants_custom_permission(permission)
|
||||
}
|
||||
|
||||
pub fn restore(&mut self) -> bool {
|
||||
if self.status < MembershipStatus::Invited as i32 {
|
||||
self.status += ACTIVATE_REVOKE_DIFF;
|
||||
@@ -1001,6 +1035,13 @@ impl Membership {
|
||||
(self.access_all || self.atype >= MembershipType::Admin) && self.has_status(MembershipStatus::Confirmed)
|
||||
}
|
||||
|
||||
/// Whether this member may edit every collection and the items in them in the Admin Console: every member with
|
||||
/// full access, and a Custom member with Edit any collection. Unlike full access, the permission does not add
|
||||
/// anything to the member's own vault.
|
||||
pub fn can_edit_any_collection(&self) -> bool {
|
||||
self.has_full_access() || self.has_custom_permission(CustomPermission::EditAnyCollection)
|
||||
}
|
||||
|
||||
pub async fn find_by_uuid(uuid: &MembershipId, conn: &DbConn) -> Option<Self> {
|
||||
conn.run(move |conn| {
|
||||
users_organizations::table.filter(users_organizations::uuid.eq(uuid)).first::<Self>(conn).ok()
|
||||
|
||||
+202
-28
@@ -6,6 +6,7 @@ use serde_json::Value;
|
||||
use crate::{
|
||||
CONFIG,
|
||||
api::EmptyResult,
|
||||
auth::DEFAULT_ACCESS_VALIDITY,
|
||||
crypto,
|
||||
db::{
|
||||
DbConn,
|
||||
@@ -20,7 +21,7 @@ use macros::UuidFromParam;
|
||||
|
||||
use super::{
|
||||
AuthRequest, Cipher, Device, EmergencyAccess, Favorite, Folder, Membership, MembershipType, TwoFactor,
|
||||
TwoFactorIncomplete,
|
||||
TwoFactorIncomplete, UserSignatureKeyPair,
|
||||
};
|
||||
|
||||
#[derive(Identifiable, Queryable, Insertable, AsChangeset, Selectable)]
|
||||
@@ -72,6 +73,13 @@ pub struct User {
|
||||
pub external_id: Option<String>, // Todo: Needs to be removed in the future, this is not used anymore.
|
||||
|
||||
pub key_id: Option<KeyId>,
|
||||
|
||||
// The v2 state: all set, with a `user_signature_key_pairs` row, or none, see `User::is_v2`
|
||||
pub signed_public_key: Option<String>,
|
||||
pub security_state: Option<String>,
|
||||
pub security_version: Option<i32>,
|
||||
/// JSON `{"wrappedUserKey1", "wrappedUserKey2"}` for sessions that still hold the v1 user key. Opaque to us.
|
||||
pub v2_upgrade_token: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Identifiable, Queryable, Insertable)]
|
||||
@@ -100,13 +108,28 @@ enum UserStatus {
|
||||
_Disabled = 2,
|
||||
}
|
||||
|
||||
/// A previous security stamp that is still accepted, until `expire`.
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct UserStampException {
|
||||
pub routes: Vec<String>,
|
||||
/// The routes the stamp is still accepted on, or `None` for any route.
|
||||
pub routes: Option<Vec<String>>,
|
||||
pub security_stamp: String,
|
||||
pub expire: i64,
|
||||
}
|
||||
|
||||
impl UserStampException {
|
||||
pub fn is_expired(&self) -> bool {
|
||||
Utc::now().timestamp() > self.expire
|
||||
}
|
||||
|
||||
/// Whether this exception lets a token carrying `security_stamp` through on `route`.
|
||||
pub fn allows(&self, security_stamp: &str, route: &str) -> bool {
|
||||
!self.is_expired()
|
||||
&& self.security_stamp == security_stamp
|
||||
&& self.routes.as_ref().is_none_or(|routes| routes.iter().any(|r| r == route))
|
||||
}
|
||||
}
|
||||
|
||||
/// Local methods
|
||||
impl User {
|
||||
pub const CLIENT_KDF_TYPE_DEFAULT: i32 = UserKdfType::Pbkdf2 as i32;
|
||||
@@ -159,9 +182,31 @@ impl User {
|
||||
external_id: None, // Todo: Needs to be removed in the future, this is not used anymore.
|
||||
|
||||
key_id: None,
|
||||
|
||||
signed_public_key: None,
|
||||
security_state: None,
|
||||
security_version: None,
|
||||
v2_upgrade_token: None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn is_v2(&self) -> bool {
|
||||
self.signed_public_key.is_some() && self.security_state.is_some() && self.security_version.is_some()
|
||||
}
|
||||
|
||||
/// Upstream's `HasV2Encryption`: a private key wrapped as `CoseEncrypt0B64` (type 7) and security version 2.
|
||||
/// Upstream only uses it to decide which accounts need a v2-capable client.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/8da186ad73f80d37157fe6fd42323e4284e83ec1/src/Core/Entities/User.cs#L245-L278>
|
||||
pub fn has_v2_encryption(&self) -> bool {
|
||||
self.security_version == Some(2)
|
||||
&& self
|
||||
.private_key
|
||||
.as_deref()
|
||||
.and_then(|private_key| private_key.split_once('.'))
|
||||
.is_some_and(|(enc_type, _)| enc_type.parse::<u8>() == Ok(7))
|
||||
}
|
||||
|
||||
pub fn check_valid_password(&self, password: &str) -> bool {
|
||||
crypto::verify_password_hash(
|
||||
password.as_bytes(),
|
||||
@@ -171,6 +216,7 @@ impl User {
|
||||
)
|
||||
}
|
||||
|
||||
/// Upstream's `GetMasterPasswordSalt`: there is no separate salt, so the normalized email
|
||||
pub fn master_password_salt(&self) -> String {
|
||||
self.email.trim().to_lowercase()
|
||||
}
|
||||
@@ -225,10 +271,33 @@ impl User {
|
||||
|
||||
pub async fn reset_security_stamp(&mut self, conn: &DbConn) -> EmptyResult {
|
||||
self.security_stamp = get_uuid();
|
||||
// Keeps the unexpired route exceptions, set for the stamp being replaced, and drops a rotation's grace
|
||||
let mut exceptions = self.stamp_exceptions();
|
||||
exceptions.retain(|e| e.routes.is_some() && !e.is_expired());
|
||||
self.set_stamp_exceptions(&exceptions);
|
||||
Device::rotate_refresh_tokens_by_user(&self.uuid, conn).await?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Resets the stamp but lets issued access tokens run out, as upstream only checks it on refresh.
|
||||
pub async fn reset_security_stamp_after_key_rotation(&mut self, conn: &DbConn) -> EmptyResult {
|
||||
let previous_stamp = self.security_stamp.clone();
|
||||
let mut grace: Vec<UserStampException> =
|
||||
self.stamp_exceptions().into_iter().filter(|e| e.routes.is_none() && !e.is_expired()).collect();
|
||||
|
||||
self.reset_security_stamp(conn).await?;
|
||||
|
||||
grace.push(UserStampException {
|
||||
routes: None,
|
||||
security_stamp: previous_stamp,
|
||||
expire: (Utc::now() + *DEFAULT_ACCESS_VALIDITY).timestamp(),
|
||||
});
|
||||
let mut exceptions = self.stamp_exceptions();
|
||||
exceptions.extend(grace);
|
||||
self.set_stamp_exceptions(&exceptions);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Set the stamp_exception to only allow a subsequent request matching a specific route using the current security-stamp.
|
||||
///
|
||||
/// # Arguments
|
||||
@@ -237,17 +306,30 @@ impl User {
|
||||
/// After these 2 minutes this stamp will expire.
|
||||
///
|
||||
pub fn set_stamp_exception(&mut self, route_exception: Vec<String>) {
|
||||
let stamp_exception = UserStampException {
|
||||
routes: route_exception,
|
||||
self.set_stamp_exceptions(&[UserStampException {
|
||||
routes: Some(route_exception),
|
||||
security_stamp: self.security_stamp.clone(),
|
||||
expire: (Utc::now() + TimeDelta::try_minutes(2).unwrap()).timestamp(),
|
||||
};
|
||||
self.stamp_exception = Some(serde_json::to_string(&stamp_exception).unwrap_or_default());
|
||||
}]);
|
||||
}
|
||||
|
||||
/// Resets the stamp_exception to prevent re-use of the previous security-stamp
|
||||
pub fn reset_stamp_exception(&mut self) {
|
||||
self.stamp_exception = None;
|
||||
/// The previous security stamps that are still accepted, expired ones included.
|
||||
pub fn stamp_exceptions(&self) -> Vec<UserStampException> {
|
||||
let Some(stored) = self.stamp_exception.as_deref() else {
|
||||
return Vec::new();
|
||||
};
|
||||
// Before key rotations kept sessions alive, only a single route exception was stored.
|
||||
serde_json::from_str::<Vec<UserStampException>>(stored)
|
||||
.or_else(|_| serde_json::from_str::<UserStampException>(stored).map(|e| vec![e]))
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
fn set_stamp_exceptions(&mut self, exceptions: &[UserStampException]) {
|
||||
self.stamp_exception = if exceptions.is_empty() {
|
||||
None
|
||||
} else {
|
||||
Some(serde_json::to_string(&exceptions).unwrap_or_default())
|
||||
};
|
||||
}
|
||||
|
||||
pub fn display_name(&self) -> &str {
|
||||
@@ -266,18 +348,37 @@ impl User {
|
||||
!CONFIG.mail_enabled() || self.verified_at.is_some()
|
||||
}
|
||||
|
||||
async fn v2_signature_key_pair(&self, conn: &DbConn) -> Option<UserSignatureKeyPair> {
|
||||
if !self.is_v2() {
|
||||
return None;
|
||||
}
|
||||
UserSignatureKeyPair::find_by_user(&self.uuid, conn).await
|
||||
}
|
||||
|
||||
/// The `accountKeys` object (upstream's `PrivateKeysResponseModel`), null without a key pair
|
||||
pub fn account_keys_json(&self) -> Value {
|
||||
pub async fn account_keys_json(&self, conn: &DbConn) -> Value {
|
||||
if self.private_key.is_some() {
|
||||
let (signed_public_key, signature_key_pair, security_state) = match self.v2_signature_key_pair(conn).await {
|
||||
Some(key_pair) => (
|
||||
json!(self.signed_public_key),
|
||||
key_pair.to_json(),
|
||||
json!({
|
||||
"securityState": self.security_state,
|
||||
"securityVersion": self.security_version,
|
||||
}),
|
||||
),
|
||||
None => (Value::Null, Value::Null, Value::Null),
|
||||
};
|
||||
|
||||
json!({
|
||||
"publicKeyEncryptionKeyPair": {
|
||||
"wrappedPrivateKey": self.private_key,
|
||||
"publicKey": self.public_key,
|
||||
"signedPublicKey": null,
|
||||
"signedPublicKey": signed_public_key,
|
||||
"object": "publicKeyEncryptionKeyPair",
|
||||
},
|
||||
"securityState": null,
|
||||
"signatureKeyPair": null,
|
||||
"securityState": security_state,
|
||||
"signatureKeyPair": signature_key_pair,
|
||||
"object": "privateKeys"
|
||||
})
|
||||
} else {
|
||||
@@ -285,6 +386,24 @@ impl User {
|
||||
}
|
||||
}
|
||||
|
||||
pub async fn public_keys_json(&self, conn: &DbConn) -> Value {
|
||||
let (signed_public_key, verifying_key) = match self.v2_signature_key_pair(conn).await {
|
||||
Some(key_pair) => (json!(self.signed_public_key), json!(key_pair.verifying_key)),
|
||||
None => (Value::Null, Value::Null),
|
||||
};
|
||||
|
||||
json!({
|
||||
"publicKey": self.public_key,
|
||||
"signedPublicKey": signed_public_key,
|
||||
"verifyingKey": verifying_key,
|
||||
"object": "publicKeys"
|
||||
})
|
||||
}
|
||||
|
||||
pub fn v2_upgrade_token_json(&self) -> Option<Value> {
|
||||
self.v2_upgrade_token.as_ref().and_then(|token| serde_json::from_str(token).ok())
|
||||
}
|
||||
|
||||
pub async fn to_json(&self, conn: &DbConn) -> Value {
|
||||
let mut orgs_json = Vec::new();
|
||||
for c in Membership::find_confirmed_by_user(&self.uuid, conn).await {
|
||||
@@ -305,7 +424,7 @@ impl User {
|
||||
UserStatus::Enabled
|
||||
};
|
||||
|
||||
let account_keys = self.account_keys_json();
|
||||
let account_keys = self.account_keys_json(conn).await;
|
||||
|
||||
json!({
|
||||
"_status": status as i32,
|
||||
@@ -382,6 +501,7 @@ impl User {
|
||||
Device::delete_all_by_user(&self.uuid, conn).await?;
|
||||
TwoFactor::delete_all_by_user(&self.uuid, conn).await?;
|
||||
TwoFactorIncomplete::delete_all_by_user(&self.uuid, conn).await?;
|
||||
UserSignatureKeyPair::delete_all_by_user(&self.uuid, conn).await?;
|
||||
Invitation::take(&self.email, conn).await; // Delete invitation if any
|
||||
|
||||
conn.run(move |conn| {
|
||||
@@ -553,25 +673,26 @@ impl Invitation {
|
||||
pub struct UserId(String);
|
||||
|
||||
#[derive(
|
||||
Clone,
|
||||
Debug,
|
||||
DieselNewType,
|
||||
FromForm,
|
||||
PartialEq,
|
||||
Eq,
|
||||
Hash,
|
||||
Serialize,
|
||||
Deserialize,
|
||||
AsRef,
|
||||
Deref,
|
||||
Display,
|
||||
From,
|
||||
UuidFromParam,
|
||||
Clone, Debug, DieselNewType, FromForm, PartialEq, Eq, Hash, Serialize, AsRef, Deref, Display, From, UuidFromParam,
|
||||
)]
|
||||
#[deref(forward)]
|
||||
#[from(forward)]
|
||||
pub struct KeyId(String);
|
||||
|
||||
/// Like upstream, a key id is 32 lowercase hex characters. Key ids are compared as strings, so one in any other
|
||||
/// format would never match the id the clients send.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/8da186ad73f80d37157fe6fd42323e4284e83ec1/src/Core/KeyManagement/Models/Data/KeyId.cs#L20-L42>
|
||||
impl<'de> serde::Deserialize<'de> for KeyId {
|
||||
fn deserialize<D: serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
|
||||
let key_id = String::deserialize(deserializer)?;
|
||||
if key_id.len() != 32 || !key_id.bytes().all(|b| matches!(b, b'0'..=b'9' | b'a'..=b'f')) {
|
||||
return Err(serde::de::Error::custom("Key id must be 32 lowercase hex characters"));
|
||||
}
|
||||
Ok(Self(key_id))
|
||||
}
|
||||
}
|
||||
|
||||
impl SsoUser {
|
||||
pub async fn save(&self, conn: &DbConn) -> EmptyResult {
|
||||
db_run! { conn:
|
||||
@@ -625,3 +746,56 @@ impl SsoUser {
|
||||
.await
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_key_id_format() {
|
||||
let key_id: KeyId = serde_json::from_str(r#""0123456789abcdef0123456789abcdef""#).unwrap();
|
||||
assert_eq!(key_id.as_ref(), "0123456789abcdef0123456789abcdef");
|
||||
|
||||
for invalid in ["", "0123456789ABCDEF0123456789ABCDEF", "0123456789abcdef", "0123456789abcdef0123456789abcdeg"]
|
||||
{
|
||||
assert!(serde_json::from_str::<KeyId>(&format!("\"{invalid}\"")).is_err(), "{invalid:?}");
|
||||
}
|
||||
|
||||
// An absent key id stays optional
|
||||
assert_eq!(serde_json::from_str::<Option<KeyId>>("null").unwrap(), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_has_v2_encryption() {
|
||||
// User::new loads CONFIG; isolate it from the DNS bootstrap test and filesystem configuration.
|
||||
if std::env::var_os("VAULTWARDEN_ISOLATED_CONFIG_TEST").is_none() {
|
||||
let output = std::process::Command::new(std::env::current_exe().unwrap())
|
||||
.args(["--exact", std::thread::current().name().unwrap(), "--nocapture"])
|
||||
.env("VAULTWARDEN_ISOLATED_CONFIG_TEST", "1")
|
||||
.env("DATABASE_URL", "sqlite://:memory:")
|
||||
.output()
|
||||
.unwrap();
|
||||
assert!(
|
||||
output.status.success() && String::from_utf8_lossy(&output.stdout).contains("1 passed; 0 failed"),
|
||||
"{}\n{}",
|
||||
String::from_utf8_lossy(&output.stdout),
|
||||
String::from_utf8_lossy(&output.stderr)
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
let user = |private_key: Option<&str>, security_version: Option<i32>| {
|
||||
let mut user = User::new("user@example.com", None);
|
||||
user.private_key = private_key.map(String::from);
|
||||
user.security_version = security_version;
|
||||
user
|
||||
};
|
||||
|
||||
assert!(user(Some("7.cose"), Some(2)).has_v2_encryption());
|
||||
assert!(!user(Some("7.cose"), Some(1)).has_v2_encryption());
|
||||
assert!(!user(Some("7.cose"), None).has_v2_encryption());
|
||||
assert!(!user(Some("2.iv|data|mac"), Some(2)).has_v2_encryption());
|
||||
assert!(!user(Some("7"), Some(2)).has_v2_encryption());
|
||||
assert!(!user(None, Some(2)).has_v2_encryption());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
use chrono::{NaiveDateTime, Utc};
|
||||
use derive_more::{AsRef, Deref, Display, From};
|
||||
use diesel::prelude::*;
|
||||
use serde_json::Value;
|
||||
|
||||
use crate::{
|
||||
api::EmptyResult,
|
||||
db::{DbConn, schema::user_signature_key_pairs},
|
||||
error::MapResult,
|
||||
util::get_uuid,
|
||||
};
|
||||
|
||||
use super::UserId;
|
||||
|
||||
/// A user's signature key pair, part of the v2 state, in its own table like upstream.
|
||||
///
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Sql/dbo/KeyManagement/Tables/UserSignatureKeyPair.sql#L1-L15>
|
||||
#[derive(Identifiable, Queryable, Insertable, AsChangeset, Selectable)]
|
||||
#[diesel(table_name = user_signature_key_pairs)]
|
||||
#[diesel(treat_none_as_null = true)]
|
||||
#[diesel(primary_key(uuid))]
|
||||
pub struct UserSignatureKeyPair {
|
||||
pub uuid: UserSignatureKeyPairId,
|
||||
pub user_uuid: UserId,
|
||||
|
||||
pub signature_algorithm: i32,
|
||||
/// The signing (private) key, wrapped by the user key.
|
||||
pub signing_key: String,
|
||||
/// The COSE-encoded public verifying key.
|
||||
pub verifying_key: String,
|
||||
|
||||
pub created_at: NaiveDateTime,
|
||||
pub updated_at: NaiveDateTime,
|
||||
}
|
||||
|
||||
/// Ref: <https://github.com/bitwarden/server/blob/9030c42bf7d8f9ac2ff9fee85c39588d5eb81499/src/Core/KeyManagement/Enums/SignatureAlgorithm.cs#L6-L10>
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub enum SignatureAlgorithm {
|
||||
Ed25519 = 0,
|
||||
MlDsa44 = 1,
|
||||
}
|
||||
|
||||
impl SignatureAlgorithm {
|
||||
pub fn parse(algorithm: &str) -> Option<Self> {
|
||||
match algorithm {
|
||||
"ed25519" => Some(Self::Ed25519),
|
||||
"mldsa44" => Some(Self::MlDsa44),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Local methods
|
||||
impl UserSignatureKeyPair {
|
||||
pub fn new(
|
||||
user_uuid: UserId,
|
||||
signature_algorithm: SignatureAlgorithm,
|
||||
signing_key: String,
|
||||
verifying_key: String,
|
||||
) -> Self {
|
||||
let now = Utc::now().naive_utc();
|
||||
|
||||
Self {
|
||||
uuid: UserSignatureKeyPairId(get_uuid()),
|
||||
user_uuid,
|
||||
signature_algorithm: signature_algorithm as i32,
|
||||
signing_key,
|
||||
verifying_key,
|
||||
created_at: now,
|
||||
updated_at: now,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn to_json(&self) -> Value {
|
||||
json!({
|
||||
"wrappedSigningKey": self.signing_key,
|
||||
"verifyingKey": self.verifying_key,
|
||||
"object": "signatureKeyPair",
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// Database methods
|
||||
impl UserSignatureKeyPair {
|
||||
pub async fn save(&mut self, conn: &DbConn) -> EmptyResult {
|
||||
self.updated_at = Utc::now().naive_utc();
|
||||
|
||||
db_run! { conn:
|
||||
mysql {
|
||||
diesel::insert_into(user_signature_key_pairs::table)
|
||||
.values(&*self)
|
||||
.on_conflict(diesel::dsl::DuplicatedKeys)
|
||||
.do_update()
|
||||
.set(&*self)
|
||||
.execute(conn)
|
||||
.map_res("Error saving user signature key pair")
|
||||
}
|
||||
postgresql, sqlite {
|
||||
diesel::insert_into(user_signature_key_pairs::table)
|
||||
.values(&*self)
|
||||
.on_conflict(user_signature_key_pairs::user_uuid)
|
||||
.do_update()
|
||||
.set(&*self)
|
||||
.execute(conn)
|
||||
.map_res("Error saving user signature key pair")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The user's key pair. There is at most one, enforced by a unique index on `user_uuid`.
|
||||
pub async fn find_by_user(user_uuid: &UserId, conn: &DbConn) -> Option<Self> {
|
||||
conn.run(move |conn| {
|
||||
user_signature_key_pairs::table
|
||||
.filter(user_signature_key_pairs::user_uuid.eq(user_uuid))
|
||||
.first::<Self>(conn)
|
||||
.ok()
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
pub async fn delete_all_by_user(user_uuid: &UserId, conn: &DbConn) -> EmptyResult {
|
||||
conn.run(move |conn| {
|
||||
diesel::delete(user_signature_key_pairs::table.filter(user_signature_key_pairs::user_uuid.eq(user_uuid)))
|
||||
.execute(conn)
|
||||
.map_res("Error deleting user signature key pairs")
|
||||
})
|
||||
.await
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Clone, Debug, AsRef, Deref, DieselNewType, Display, From, Hash, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct UserSignatureKeyPairId(String);
|
||||
@@ -219,6 +219,22 @@ table! {
|
||||
avatar_color -> Nullable<Text>,
|
||||
external_id -> Nullable<Text>,
|
||||
key_id -> Nullable<Text>,
|
||||
signed_public_key -> Nullable<Text>,
|
||||
security_state -> Nullable<Text>,
|
||||
security_version -> Nullable<Integer>,
|
||||
v2_upgrade_token -> Nullable<Text>,
|
||||
}
|
||||
}
|
||||
|
||||
table! {
|
||||
user_signature_key_pairs (uuid) {
|
||||
uuid -> Text,
|
||||
user_uuid -> Text,
|
||||
signature_algorithm -> Integer,
|
||||
signing_key -> Text,
|
||||
verifying_key -> Text,
|
||||
created_at -> Timestamp,
|
||||
updated_at -> Timestamp,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -253,6 +269,7 @@ table! {
|
||||
access_event_logs -> Bool,
|
||||
access_import_export -> Bool,
|
||||
access_reports -> Bool,
|
||||
v2_upgrade_token -> Nullable<Text>,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -393,6 +410,7 @@ joinable!(collections_groups -> groups (groups_uuid));
|
||||
joinable!(event -> users_organizations (uuid));
|
||||
joinable!(auth_requests -> users (user_uuid));
|
||||
joinable!(sso_users -> users (user_uuid));
|
||||
joinable!(user_signature_key_pairs -> users (user_uuid));
|
||||
|
||||
allow_tables_to_appear_in_same_query!(
|
||||
archives,
|
||||
@@ -419,4 +437,5 @@ allow_tables_to_appear_in_same_query!(
|
||||
collections_groups,
|
||||
event,
|
||||
auth_requests,
|
||||
user_signature_key_pairs,
|
||||
);
|
||||
+11
-1
@@ -577,9 +577,19 @@ async fn launch_rocket(pool: db::DbPool, extra_debug: bool) -> Result<(), Error>
|
||||
.limit("data-form", 525.megabytes()) // This needs to match the maximum allowed file size for Send
|
||||
.limit("file", 525.megabytes()); // This needs to match the maximum allowed file size for attachments
|
||||
|
||||
let rocket = rocket::custom(config);
|
||||
#[cfg(feature = "unsafe_test_mode")]
|
||||
let rocket = {
|
||||
warn!(
|
||||
"This build has `unsafe_test_mode`: its test seeder at /test/seeder creates accounts without any checks. \
|
||||
Never use it outside of tests!"
|
||||
);
|
||||
rocket.mount([basepath, "/test/seeder"].concat(), api::test_seeder_routes())
|
||||
};
|
||||
|
||||
// If adding more paths here, consider also adding them to
|
||||
// crate::utils::LOGGED_ROUTES to make sure they appear in the log
|
||||
let instance = rocket::custom(config)
|
||||
let instance = rocket
|
||||
.mount([basepath, "/"].concat(), api::web_routes())
|
||||
.mount([basepath, "/api"].concat(), api::core_routes())
|
||||
.mount([basepath, "/admin"].concat(), api::admin_routes())
|
||||
|
||||
@@ -899,6 +899,12 @@ pub fn parse_experimental_client_feature_flags(
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Whether the admin enabled this supported client feature flag
|
||||
pub fn is_client_feature_flag_enabled(flag: &str) -> bool {
|
||||
parse_experimental_client_feature_flags(&CONFIG.experimental_client_feature_flags(), &FeatureFlagFilter::ValidOnly)
|
||||
.contains_key(flag)
|
||||
}
|
||||
|
||||
/// TODO: This is extracted from IpAddr::is_global, which is unstable:
|
||||
/// https://doc.rust-lang.org/nightly/std/net/enum.IpAddr.html#method.is_global
|
||||
/// Remove once https://github.com/rust-lang/rust/issues/27709 is merged
|
||||
|
||||
Executable
+141
@@ -0,0 +1,141 @@
|
||||
#!/usr/bin/env bash
|
||||
# Runs the live-server end-to-end tests of bitwarden/sdk-internal (e2e/wasm) against vaultwarden.
|
||||
#
|
||||
# Usage: tools/sdk-live-tests/run.sh --sdk-dir <path> [--skip-sdk-build] [--mode vectors|seeder] [-- <vitest args>]
|
||||
#
|
||||
# The server is built with `unsafe_test_mode`, whose test seeder (src/api/test_seeder.rs) creates the test accounts.
|
||||
# - vectors: for SDK versions whose live tests log in to one given account. Every user test vector with a master
|
||||
# password gets a fresh server, is seeded there with its vault, and the tests run on it (they rotate its keys).
|
||||
# - seeder: for SDK versions whose tests seed their own accounts through BW_LIVE_SEEDER_URL. One server, one run.
|
||||
# The mode follows what the SDK's e2e/wasm/live/config.ts reads, unless --mode says otherwise. Arguments after `--` go
|
||||
# to vitest, e.g. `-- tests/user-crypto-management/rotate-user-keys.live.test.ts` to run one file.
|
||||
#
|
||||
# Every vector runs even after a failure; a summary follows, and the exit code is 1 if any failed. The server logs are
|
||||
# in <target dir>/sdk-live-tests/. BW_LIVE_CLIENT_VERSION defaults to 2026.10.1, the minimum for V2 accounts.
|
||||
#
|
||||
# Needs: the SDK's Rust toolchain with the wasm32-unknown-unknown target and rust-src, Node.js >= 22.12, curl, python3.
|
||||
set -euo pipefail
|
||||
|
||||
VW_DIR="$(cd "$(dirname "$0")/../.." && pwd)"
|
||||
TARGET_DIR="${CARGO_TARGET_DIR:-${VW_DIR}/target}"
|
||||
OUT_DIR="${TARGET_DIR}/sdk-live-tests"
|
||||
PORT=8099
|
||||
URL="http://127.0.0.1:${PORT}"
|
||||
SEEDER_URL="${URL}/test/seeder"
|
||||
SEEDER_USERNAME="sdk-live-tests"
|
||||
SEEDER_PASSWORD="$(python3 -c 'import secrets; print(secrets.token_urlsafe(24))')"
|
||||
SKIP=3 # seed_vector.py's exit code for a vector the tests can't use
|
||||
export BW_LIVE_CLIENT_VERSION="${BW_LIVE_CLIENT_VERSION:-2026.10.1}"
|
||||
|
||||
SDK_DIR=""
|
||||
BUILD_SDK=1
|
||||
MODE=""
|
||||
VITEST_ARGS=()
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--sdk-dir) SDK_DIR="$(cd "$2" && pwd)"; shift 2 ;;
|
||||
--skip-sdk-build) BUILD_SDK=0; shift ;;
|
||||
--mode) MODE="$2"; shift 2 ;;
|
||||
--) shift; VITEST_ARGS=("$@"); break ;;
|
||||
*) echo "Unknown argument: $1" >&2; exit 2 ;;
|
||||
esac
|
||||
done
|
||||
[[ -n "${SDK_DIR}" ]] || { echo "--sdk-dir is required" >&2; exit 2; }
|
||||
TESTS_DIR="${SDK_DIR}/e2e/wasm"
|
||||
[[ -f "${TESTS_DIR}/live/config.ts" ]] || { echo "${TESTS_DIR}/live/config.ts not found: no live tests in this SDK" >&2; exit 2; }
|
||||
if [[ -z "${MODE}" ]]; then
|
||||
if grep -q BW_LIVE_SEEDER_URL "${TESTS_DIR}/live/config.ts"; then MODE=seeder; else MODE=vectors; fi
|
||||
fi
|
||||
[[ "${MODE}" == vectors || "${MODE}" == seeder ]] || { echo "--mode must be vectors or seeder" >&2; exit 2; }
|
||||
echo "Mode: ${MODE}, client version ${BW_LIVE_CLIENT_VERSION}"
|
||||
|
||||
(cd "${VW_DIR}" && cargo build --features sqlite,unsafe_test_mode)
|
||||
if [[ ${BUILD_SDK} -eq 1 ]]; then
|
||||
bash "${SDK_DIR}/crates/bitwarden-wasm-internal/build.sh"
|
||||
(cd "${TESTS_DIR}" && npm ci)
|
||||
fi
|
||||
|
||||
server=""
|
||||
trap 'if [[ -n "${server}" ]]; then kill "${server}" 2>/dev/null || true; fi' EXIT
|
||||
|
||||
# Starts a server on an empty database in $OUT_DIR/$1
|
||||
start_server() {
|
||||
local data_dir="${OUT_DIR}/$1"
|
||||
rm -rf "${data_dir}" && mkdir -p "${data_dir}"
|
||||
if curl -s -o /dev/null "${URL}/alive"; then
|
||||
echo "Something already answers on port ${PORT}" >&2
|
||||
return 1
|
||||
fi
|
||||
ENV_FILE=/dev/null DATA_FOLDER="${data_dir}" DATABASE_URL="sqlite://${data_dir}/db.sqlite3" \
|
||||
ROCKET_ADDRESS=127.0.0.1 ROCKET_PORT="${PORT}" DOMAIN="${URL}" WEB_VAULT_ENABLED=false \
|
||||
SIGNUPS_ALLOWED=true SIGNUPS_VERIFY=false LOGIN_RATELIMIT_MAX_BURST=1000 \
|
||||
TEST_SEEDER_USERNAME="${SEEDER_USERNAME}" TEST_SEEDER_PASSWORD="${SEEDER_PASSWORD}" \
|
||||
"${TARGET_DIR}/debug/vaultwarden" > "${data_dir}/vaultwarden.log" 2>&1 &
|
||||
server=$!
|
||||
local i
|
||||
for i in $(seq 1 60); do
|
||||
if ! kill -0 "${server}" 2>/dev/null; then break; fi
|
||||
if curl -sf -o /dev/null "${URL}/alive"; then return 0; fi
|
||||
sleep 1
|
||||
done
|
||||
echo "The server didn't start; the end of ${data_dir}/vaultwarden.log:" >&2
|
||||
tail -50 "${data_dir}/vaultwarden.log" >&2
|
||||
stop_server
|
||||
return 1
|
||||
}
|
||||
|
||||
stop_server() {
|
||||
if [[ -n "${server}" ]]; then
|
||||
kill "${server}" 2>/dev/null || true
|
||||
wait "${server}" 2>/dev/null || true
|
||||
server=""
|
||||
fi
|
||||
}
|
||||
|
||||
run_tests() {
|
||||
(cd "${TESTS_DIR}" && BW_LIVE_SERVER_URL="${URL}" "$@" npm run test:live -- "${VITEST_ARGS[@]}")
|
||||
}
|
||||
|
||||
results=()
|
||||
failed=0
|
||||
if [[ "${MODE}" == seeder ]]; then
|
||||
if start_server seeder && run_tests env BW_LIVE_SEEDER_URL="${SEEDER_URL}" \
|
||||
BW_LIVE_SEEDER_USERNAME="${SEEDER_USERNAME}" BW_LIVE_SEEDER_PASSWORD="${SEEDER_PASSWORD}"; then
|
||||
results+=("seeder: pass")
|
||||
else
|
||||
results+=("seeder: FAIL")
|
||||
failed=1
|
||||
fi
|
||||
stop_server
|
||||
else
|
||||
for vector_file in "${SDK_DIR}"/test-vectors/users/*.json; do
|
||||
vector="$(basename "${vector_file}" .json)"
|
||||
echo "=== ${vector}"
|
||||
if ! start_server "${vector}"; then
|
||||
results+=("${vector}: FAIL (server didn't start)")
|
||||
failed=1
|
||||
continue
|
||||
fi
|
||||
status=0
|
||||
credentials="$(python3 -I "${VW_DIR}/tools/sdk-live-tests/seed_vector.py" "${vector_file}" "${SEEDER_URL}" \
|
||||
"${SEEDER_USERNAME}" "${SEEDER_PASSWORD}")" || status=$?
|
||||
if [[ ${status} -eq ${SKIP} ]]; then
|
||||
results+=("${vector}: skip (${credentials})")
|
||||
elif [[ ${status} -ne 0 ]]; then
|
||||
results+=("${vector}: FAIL (seeding)")
|
||||
failed=1
|
||||
elif run_tests env BW_LIVE_EMAIL="$(sed -n 1p <<< "${credentials}")" \
|
||||
BW_LIVE_PASSWORD="$(sed -n 2p <<< "${credentials}")"; then
|
||||
results+=("${vector}: pass")
|
||||
else
|
||||
results+=("${vector}: FAIL")
|
||||
failed=1
|
||||
fi
|
||||
stop_server
|
||||
done
|
||||
fi
|
||||
|
||||
echo
|
||||
echo "=== Summary (logs in ${OUT_DIR})"
|
||||
printf '%s\n' "${results[@]}"
|
||||
exit "${failed}"
|
||||
@@ -0,0 +1,59 @@
|
||||
"""Seeds one of the SDK's user test vectors, vault included, through vaultwarden's test seeder.
|
||||
|
||||
Usage: seed_vector.py <vector.json> <seeder url> <seeder username> <seeder password>
|
||||
|
||||
Prints the account's email and password, one per line. Exits 3, printing why, for a vector the tests can't log in
|
||||
with (no master password), and 1 if the seeder refuses it.
|
||||
"""
|
||||
|
||||
import base64
|
||||
import json
|
||||
import sys
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
import uuid
|
||||
|
||||
SKIP = 3
|
||||
|
||||
|
||||
def main() -> int:
|
||||
vector_file, seeder_url, username, password = sys.argv[1:5]
|
||||
with open(vector_file, encoding="utf-8") as f:
|
||||
vector = json.load(f)
|
||||
|
||||
has_master_password = any("masterPasswordUnlock" in method for method in vector.get("unlockMethods", []))
|
||||
if not has_master_password or "password" not in vector.get("account", {}):
|
||||
print("no master password")
|
||||
return SKIP
|
||||
|
||||
# Without attachments: the rotation test compares the vault before and after, and our sync gives each attachment
|
||||
# a link with a fresh download token every time (upstream's is the same on every sync). A vector's legacy
|
||||
# attachments, without a key of their own, would also make the SDK refuse to rotate at all.
|
||||
for cipher in vector.get("vault", {}).get("ciphers", []):
|
||||
cipher.get("encrypted", {}).pop("attachments", None)
|
||||
|
||||
credentials = base64.b64encode(f"{username}:{password}".encode()).decode()
|
||||
request = urllib.request.Request(
|
||||
f"{seeder_url}/seed",
|
||||
data=json.dumps({"template": "TestVectorUserScene", "arguments": vector}).encode(),
|
||||
method="POST",
|
||||
headers={
|
||||
"Authorization": f"Basic {credentials}",
|
||||
"Content-Type": "application/json",
|
||||
"X-Play-Id": f"sdk-live-tests-{uuid.uuid4()}",
|
||||
},
|
||||
)
|
||||
try:
|
||||
with urllib.request.urlopen(request) as response:
|
||||
result = json.load(response)["result"]
|
||||
except urllib.error.HTTPError as e:
|
||||
print(f"The seeder refused {vector_file}: {e.code} {e.read().decode(errors='replace')}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
print(result["email"])
|
||||
print(vector["account"]["password"])
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
Reference in new issue
Block a user