Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PM-18772] Rename AesCbc256 to Aes256Cbc #172

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

quexten
Copy link
Contributor

@quexten quexten commented Feb 28, 2025

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-18772
Clients bitwarden/clients#13637

📔 Objective

Currently we use: Aes256Cbc, but also AesCbc256 in the SDK. In the web clients we use AesCbc256. In general the former order is more common.

For instance, TLS defines: TLS_DHE_RSA_WITH_AES_256_CBC_SHA384. JWK defines: AES_128_CBC_HMAC_SHA_256, SSH defines aes256-cbc, COSE defines: A256CBC.
This is because the block cipher is: AES-128-Bit / AES-256-Bit, and the mode of operation is CBC. Semantically, we are currently splitting up the block cipher used and interjecting the mode of operation in the middle.

This PR renames the instances used in the SDK of AesCbc256 to be consistent with other standards, and to be consistent within our codebase. There will be a corresponding PR for the web clients (this is in draft until then).

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@quexten quexten marked this pull request as draft February 28, 2025 14:26
Copy link
Contributor

Logo
Checkmarx One – Scan Summary & Details76eda149-f322-4b0b-a711-6fb82f8a23e6

Great job, no security vulnerabilities found in this Pull Request

Copy link

codecov bot commented Feb 28, 2025

Codecov Report

Attention: Patch coverage is 80.00000% with 4 lines in your changes missing coverage. Please review.

Project coverage is 65.99%. Comparing base (131cbfa) to head (5ac0fe6).

Files with missing lines Patch % Lines
...rates/bitwarden-crypto/src/enc_string/symmetric.rs 81.25% 3 Missing ⚠️
crates/bitwarden-crypto/src/store/context.rs 50.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #172   +/-   ##
=======================================
  Coverage   65.99%   65.99%           
=======================================
  Files         198      198           
  Lines       15417    15417           
=======================================
  Hits        10174    10174           
  Misses       5243     5243           

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

@quexten quexten changed the title Rename AesCbc256 to Aes256Cbc [PM-18772] Rename AesCbc256 to Aes256Cbc Feb 28, 2025
@quexten quexten marked this pull request as ready for review February 28, 2025 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant