(Translated by https://www.hiragana.jp/)
Add implementation for AES CBC in Sys.Security.Crypto by josesimoes · Pull Request #2888 · nanoframework/nf-interpreter · GitHub
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

Add implementation for AES CBC in Sys.Security.Crypto #2888

Merged
merged 7 commits into from
Jul 30, 2024

Conversation

josesimoes
Copy link
Member

@josesimoes josesimoes commented Feb 28, 2024

Description

  • Add wrapper for mbedTLS API.
  • Update assembly declaration.

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • New Features

    • Introduced AES encryption and decryption methods using CBC (Cipher Block Chaining) mode, enhancing cryptographic capabilities.
    • Added support for initialization vectors (IVs) in the encryption process for improved security.
  • Bug Fixes

    • Enhanced memory management to prevent memory leaks during encryption and decryption processes.
  • Documentation

    • Updated assembly metadata to reflect changes in functionality and versioning.

@nfbot nfbot added Type: enhancement Type: dependencies Pull requests that update a dependency file(s) or version labels Feb 28, 2024
Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition :-)

Copy link

coderabbitai bot commented Jul 29, 2024

Walkthrough

The recent updates to the nanoFramework.System.Security.Cryptography module enhance its cryptographic capabilities by introducing AES encryption and decryption methods utilizing CBC mode, complementing the existing ECB functionalities. These improvements facilitate more secure data handling. Additionally, assembly metadata has been updated to signify a new version and identifier, highlighting significant enhancements in both functionality and usability.

Changes

Files Change Summary
src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.cpp Added AES EncryptAesCbc and DecryptAesCbc methods; updated assembly version from 2 to 3 and changed identifier.
src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.h Introduced CipherMode_CBC to the CipherMode enum; added FIELD___iv for IV management; declared new CBC methods.
src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography_System_Security_Cryptography_Aes.cpp Implemented chunked processing for AES CBC encryption and decryption, improving scalability and memory management.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between aa925c9 and 5c7b4d8.

Files selected for processing (3)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.cpp (2 hunks)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.h (1 hunks)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography_System_Security_Cryptography_Aes.cpp (5 hunks)
Additional comments not posted (10)
src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.cpp (2)

24-25: New AES CBC methods added to the lookup table.

The new methods EncryptAesCbc and DecryptAesCbc are correctly added to the method lookup table.


41-43: Native assembly data updated.

The assembly identifier and version are correctly updated to reflect the new changes.

src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.h (4)

35-35: New cipher mode added.

The new cipher mode CipherMode_CBC is correctly added to the CipherMode enum.


43-43: New field added to struct.

The new field FIELD___iv is correctly added to the Library_nf_sys_sec_cryptography_System_Security_Cryptography_Aes struct.


47-47: New native declaration added for EncryptAesCbc.

The new native declaration EncryptAesCbc___SZARRAY_U1__SZARRAY_U1 is correctly added.


48-48: New native declaration added for DecryptAesCbc.

The new native declaration DecryptAesCbc___SZARRAY_U1__SZARRAY_U1 is correctly added.

src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography_System_Security_Cryptography_Aes.cpp (4)

Line range hint 14-70:
AES ECB encryption loop added.

The new passCount variable and loop for processing data in 16-byte chunks are correctly implemented.


Line range hint 87-144:
AES ECB decryption loop added.

The new passCount variable and loop for processing data in 16-byte chunks are correctly implemented.


154-268: AES CBC encryption function added.

The new AES CBC encryption function is correctly implemented, including proper memory management and error handling.


Line range hint 270-353:
AES CBC decryption function added.

The new AES CBC decryption function is correctly implemented, including proper memory management and error handling.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5c7b4d8 and 035cf9d.

Files selected for processing (3)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.cpp (2 hunks)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.h (1 hunks)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography_System_Security_Cryptography_Aes.cpp (2 hunks)
Files skipped from review as they are similar to previous changes (3)
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.cpp
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography.h
  • src/nanoFramework.System.Security.Cryptography/nf_sys_sec_cryptography_System_Security_Cryptography_Aes.cpp

@josesimoes josesimoes merged commit 775c2c2 into nanoframework:main Jul 30, 2024
28 checks passed
@josesimoes josesimoes deleted the add-aes-cbc branch July 30, 2024 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: dependencies Pull requests that update a dependency file(s) or version Type: enhancement
Projects
None yet
3 participants