Update API to 8a67aafbe5e01a738b479ebb82185fbc947866f8 #578

bw-ghapp · 2025-11-24T04:17:09Z

Updates the API bindings to 8a67aafbe5e01a738b479ebb82185fbc947866f8

github-actions · 2025-11-24T04:20:48Z

Checkmarx One – Scan Summary & Details – 011b1b10-852b-4d53-8947-4ded0026890e

Great job! No new security vulnerabilities introduced in this pull request

claude · 2025-12-01T10:54:47Z

Claude finished @bw-ghapp[bot]'s task —— View job

Code Review Complete: API Binding Updates

Tasks

Analyze PR changes with code review agent
Provide comprehensive review feedback

Executive Summary

This PR updates auto-generated API bindings from the Bitwarden server, introducing 3 critical breaking changes and 1 high-severity security concern. While the changes are properly auto-generated, they will cause TypeScript compilation failures in consuming clients and require coordinated migration.

Recommendation: DO NOT MERGE without client team coordination and migration plan.

Critical Issues Found

1. 🚨 BREAKING CHANGE: OrganizationUpdateRequestModel Constructor

File: crates/bitwarden-api-api/src/models/organization_update_request_model.rs

Before:

pub fn new(name: String, billing_email: String) -> OrganizationUpdateRequestModel

After:

pub fn new() -> OrganizationUpdateRequestModel

Impact:

Constructor signature changed from new(name, billing_email) to new()
Two previously required fields (name, billing_email) are now optional
Two fields completely removed (business_name, permissions)
All existing consumers calling this constructor will break

2. 🚨 BREAKING CHANGE: Organizations API `put()` Method

File: crates/bitwarden-api-api/src/apis/organizations_api.rs

Changes:

Parameter type changed: id: &str → organization_id: uuid::Uuid
Return type changed: OrganizationResponseModel → () (no response body)

Impact:

Callers passing string IDs must convert to UUID
Callers expecting response data will receive nothing
This breaks the API contract for organization updates

3. 🔒 SECURITY CONCERN: Sensitive Data in Query Parameters

File: crates/bitwarden-api-api/src/apis/self_hosted_billing_api.rs (NEW FILE)

Problem: New self-hosted billing API accepts 60+ optional query parameters including highly sensitive data:

async fn get_metadata<'a>(
    &self,
    organization_id: &'a str,
    license_key: Option<&'a str>,      // ⚠️ License key in URL
    public_key: Option<&'a str>,       // ⚠️ Public key in URL
    private_key: Option<&'a str>,      // ⚠️ PRIVATE KEY IN URL!
    gateway_customer_id: Option<&'a str>,
    business_tax_number: Option<&'a str>,  // ⚠️ Tax ID in URL
    // ... 55+ more parameters
)

Security Risks:

Private keys exposed in URLs: Query parameters are logged in web server logs, proxy logs, browser history, and network monitoring tools
PII exposure: Tax numbers, billing emails in URLs
API design smell: This should likely be a POST request with JSON body for sensitive data

Recommendation:

Review server-side implementation to confirm this is intentional
Consider filing a security review with the server team
Document security implications if this endpoint is used by the SDK

4. 🚨 BREAKING CHANGE: Model Rename

Files: crates/bitwarden-api-identity/src/models/password_prelogin_response_model.rs

Change:

PreloginResponseModel renamed to PasswordPreloginResponseModel
PreloginRequestModel renamed to PasswordPreloginRequestModel
New field added: kdf_settings: Option<Box<models::KdfSettings>>

Impact:

TypeScript consumers using PreloginResponseModel will break
Migration required: Rename to PasswordPreloginResponseModel

Good news: The SDK's internal usage in crates/bitwarden-core/src/auth/login/prelogin.rs was correctly updated.

Non-Breaking Changes (Acceptable)

✅ New Policy Type: BlockClaimedDomainAccountCreation = 19 - properly integrated
✅ New Event Type: OrganizationUser_AutomaticallyConfirmed = 1517 - additive change
✅ New Endpoint: POST /organizations/{orgId}/users/{id}/auto-confirm - new optional functionality
✅ New Model: KdfSettings - structured KDF configuration (backward compatible)

Architecture & Code Quality Assessment

✅ Auto-Generated Code: All changes properly generated from OpenAPI specs with correct headers
✅ SDK Architecture: Changes confined to API layer, internal SDK code properly updated
✅ No Business Logic: No logic added to bindings layer (correct per CLAUDE.md)
⚠️ Security Pattern Violation: Sensitive data in query parameters

Impact Assessment for SDK Consumers

TypeScript/WASM Consumers ⚠️

The breaking change detection correctly flagged TypeScript compilation failures.

Expected Failures:

// Will break: Constructor signature changed
const updateRequest = new OrganizationUpdateRequestModel(name, email);

// Will break: Method signature changed
const response = await client.organizations.put(orgIdString, updateModel);

// Will break: Type renamed
import { PreloginResponseModel } from 'bitwarden-sdk';

Required Migration:

// Fix: Use builder pattern
const updateRequest = new OrganizationUpdateRequestModel();
updateRequest.name = name;
updateRequest.billingEmail = email;

// Fix: Convert to UUID and handle void return
await client.organizations.put(UUID.parse(orgIdString), updateModel);

// Fix: Update import
import { PasswordPreloginResponseModel } from 'bitwarden-sdk';

Mobile (Swift/Kotlin) Consumers ⚠️

Similar breaking changes expected in UniFFI-generated bindings.

Recommendations

Critical Actions Required:

DO NOT MERGE until client teams are ready:
- Web vault team needs migration plan
- Mobile teams need migration plan
- Desktop team needs migration plan
- CLI team needs assessment
Security Review: Escalate self-hosted billing API design to security team:
- Confirm private_key in query params is intentional
- Review server-side logging configuration
- Consider moving to POST with JSON body
- Document if this is internal-only or customer-facing
Document Breaking Changes:
- Create migration guide for each breaking change
- Add to CHANGELOG with [BREAKING] tags
- Document in PR description with migration examples
Coordinate Release:
- This must be a major version bump (semantic versioning)
- Coordinate release with client updates
- Consider feature flag or gradual rollout

Follow-up Tasks:

KDF Settings Migration: Consider updating SDK prelogin logic to use new KdfSettings object in future PR
API Cleanup: File issue to review organization update API design (why no response body?)
Breaking Change CI: The detection workflow is functioning correctly - these failures are legitimate

Conclusion

This PR contains legitimate, properly auto-generated API updates that correctly reflect server-side changes. However, it introduces 3 critical breaking changes that will cause compilation failures in all consuming clients.

The changes are technically correct but operationally blocked until:

✅ Security team reviews self-hosted billing API design
✅ Client teams prepare migration code
✅ Coordinated release plan is established
✅ Breaking change documentation is completed

Final Recommendation: HOLD - Do not merge until client coordination complete and security review passed.

crates/bitwarden-api-api/src/apis/self_hosted_billing_api.rs

crates/bitwarden-api-api/src/models/organization_update_request_model.rs

claude · 2025-12-01T10:57:26Z

crates/bitwarden-api-identity/src/models/password_prelogin_response_model.rs

+    #[serde(
+        rename = "kdfSettings",
+        alias = "KdfSettings",
+        skip_serializing_if = "Option::is_none"
+    )]
+    pub kdf_settings: Option<Box<models::KdfSettings>>,


💭 Question: With the new kdf_settings field containing structured KDF configuration, are the individual fields (kdf, kdf_iterations, kdf_memory, kdf_parallelism) being deprecated?

The consuming code in bitwarden-core/src/auth/login/prelogin.rs:29-61 still uses the individual fields. Consider if migration to kdf_settings is planned.

github-actions · 2025-12-03T14:33:59Z

🔍 SDK Breaking Change Detection Results

SDK Version: sdlc/api-update (ebd3949)
Completed: 2025-12-04 15:46:30 UTC
Total Time: 249s

Client	Status	Details
typescript	✅ No breaking changes detected	TypeScript compilation passed with new SDK version - View Details

Breaking change detection completed. View SDK workflow

codecov · 2025-12-03T14:44:29Z

Codecov Report

❌ Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 79.73%. Comparing base (ab7ae36) to head (ebd3949).

Files with missing lines	Patch %	Lines
crates/bitwarden-core/src/auth/login/prelogin.rs	0.00%	3 Missing ⚠️
crates/bitwarden-core/src/admin_console/policy.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #578      +/-   ##
==========================================
- Coverage   79.74%   79.73%   -0.01%     
==========================================
  Files         304      304              
  Lines       32757    32758       +1     
==========================================
  Hits        26121    26121              
- Misses       6636     6637       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Update API bindings - fdfec0ac4df89b33896aadf532e95404f01747c0

631a4c0

bw-ghapp bot requested a review from a team as a code owner November 24, 2025 04:17

bw-ghapp bot requested a review from dani-garcia November 24, 2025 04:17

Update API bindings - 8a67aafbe5e01a738b479ebb82185fbc947866f8

b2e75bf

bw-ghapp bot changed the title ~~Update API to fdfec0ac4df89b33896aadf532e95404f01747c0~~ Update API to 8a67aafbe5e01a738b479ebb82185fbc947866f8 Dec 1, 2025

Merge branch 'main' into sdlc/api-update

adc237f

claude bot reviewed Dec 1, 2025

View reviewed changes

crates/bitwarden-api-api/src/apis/self_hosted_billing_api.rs Show resolved Hide resolved

claude bot reviewed Dec 1, 2025

View reviewed changes

crates/bitwarden-api-api/src/models/organization_update_request_model.rs Show resolved Hide resolved

claude bot reviewed Dec 1, 2025

View reviewed changes

dani-garcia added 2 commits December 3, 2025 15:05

add missing policy type

43186e4

Fix prelogin rename

5635837

github-actions bot added the breaking-change label Dec 3, 2025

Merge branch 'main' into sdlc/api-update

ebd3949

github-actions bot removed the breaking-change label Dec 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update API to 8a67aafbe5e01a738b479ebb82185fbc947866f8 #578

Update API to 8a67aafbe5e01a738b479ebb82185fbc947866f8 #578

Uh oh!

bw-ghapp bot commented Nov 24, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Nov 24, 2025 •

edited

Loading

Uh oh!

claude bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

claude bot Dec 1, 2025

Uh oh!

github-actions bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 3, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update API to 8a67aafbe5e01a738b479ebb82185fbc947866f8 #578

Are you sure you want to change the base?

Update API to 8a67aafbe5e01a738b479ebb82185fbc947866f8 #578

Uh oh!

Conversation

bw-ghapp bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Great job! No new security vulnerabilities introduced in this pull request

Uh oh!

claude bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review Complete: API Binding Updates

Tasks

Executive Summary

Critical Issues Found

1. 🚨 BREAKING CHANGE: OrganizationUpdateRequestModel Constructor

2. 🚨 BREAKING CHANGE: Organizations API put() Method

3. 🔒 SECURITY CONCERN: Sensitive Data in Query Parameters

4. 🚨 BREAKING CHANGE: Model Rename

Non-Breaking Changes (Acceptable)

Architecture & Code Quality Assessment

Impact Assessment for SDK Consumers

TypeScript/WASM Consumers ⚠️

Mobile (Swift/Kotlin) Consumers ⚠️

Recommendations

Critical Actions Required:

Follow-up Tasks:

Conclusion

Uh oh!

Uh oh!

Uh oh!

claude bot Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 SDK Breaking Change Detection Results

Uh oh!

codecov bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bw-ghapp bot commented Nov 24, 2025 •

edited

Loading

github-actions bot commented Nov 24, 2025 •

edited

Loading

claude bot commented Dec 1, 2025 •

edited

Loading

2. 🚨 BREAKING CHANGE: Organizations API `put()` Method

github-actions bot commented Dec 3, 2025 •

edited

Loading

codecov bot commented Dec 3, 2025 •

edited

Loading