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

feat(wpa_supplicant): Add optimized PSK impl (IDFGH-14280) #15073

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

Conversation

ivq
Copy link

@ivq ivq commented Dec 21, 2024

Description

Add an optimized Wi-Fi PSK implementation.
Resolves #15072 .

ESP32 is not supported as it makes the impl complex a lot as the SHA-1 of ESP32 does not support interleaving operation. fastpbkdf2 has handled the oddness of it and I do not want to do it again.
Also, it is using typical SHA-1 mode rather than DMA mode as DMA mode would be far more complex: There are GDMA and non-GDMA DMA, and the DMA is a shared resource so proper locking is needed and so on. It would be hard not to adjust the hal architecture when using DMA mode. I just want it to be simple.

For benchmark result, see #15072.

Main issue of the impl is that it is not a generic PBKDF2 and depends on hal directly, I believe. However, this is a trade-off we have to pay for optimal efficiency.

Related

Testing

Test cases are to be added.


Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@CLAassistant
Copy link

CLAassistant commented Dec 21, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Dec 21, 2024

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello ivq, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 82c04ea

@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 21, 2024
@github-actions github-actions bot changed the title feat(wpa_supplicant): Add optimized PSK impl feat(wpa_supplicant): Add optimized PSK impl (IDFGH-14280) Dec 21, 2024

void fast_psk_f(const char *password, size_t password_len, const uint8_t *ssid, size_t ssid_len, uint32_t count, uint8_t digest[SHA1_OUTPUT_SZ])
{
struct fast_psk_context ctx_, *ctx = &ctx_;
Copy link
Author

Choose a reason for hiding this comment

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

Big stack usage(276 bytes). Maybe replace with malloc?

@kapilkedawat
Copy link
Collaborator

@ivq Thank you for the contribution, give me some time to go through this.

PUT_UINT32_BE(count, ctx->inner.block[1].bytes, ssid_len);
pad_blocks(&ctx->inner, SHA1_BLOCK_SZ + ssid_len + 4);

sha1_setup();
Copy link
Author

Choose a reason for hiding this comment

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

The calling task will hold the SHA1 lock for a long time so other tasks may suffer from starvation. If this could be an issue, we could mitigate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Wi-Fi PSK routine could be optimized further (IDFGH-14279)
4 participants