Skip to content

net/ieee802154_security doc: Shape security expectations#16841

Merged
chrysn merged 1 commit intoRIOT-OS:masterfrom
chrysn-pull-requests:802154-security-expectations
Sep 13, 2021
Merged

net/ieee802154_security doc: Shape security expectations#16841
chrysn merged 1 commit intoRIOT-OS:masterfrom
chrysn-pull-requests:802154-security-expectations

Conversation

@chrysn
Copy link
Copy Markdown
Member

@chrysn chrysn commented Sep 12, 2021

Contribution description

The security module introduced in #15150 was, in my understanding, not intended for security critical use ("waives to use a proper key store to mitigate complexity"), but that didn't come across clearly in the documentation, and might thus give wrong impressions.

Testing procedure

  • Doc only change: Look at the new infobox in ieee802154__security_8h.html group__net__ieee802154__security.html of the built documentation.

Issues/PRs references

#15150 was where the module was introduced

[edit: Hotfixed after I found that the box wound up in the header file and not the module description]

@github-actions github-actions bot added Area: network Area: Networking Area: sys Area: System labels Sep 12, 2021
@chrysn chrysn added Area: doc Area: Documentation Area: security Area: Security-related libraries and subsystems Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed Area: sys Area: System labels Sep 12, 2021
@chrysn chrysn force-pushed the 802154-security-expectations branch from 73b66fe to 5710d5f Compare September 12, 2021 18:20
@github-actions github-actions bot added Area: sys Area: System and removed Area: doc Area: Documentation labels Sep 12, 2021
@chrysn chrysn added the Area: doc Area: Documentation label Sep 12, 2021
@chrysn
Copy link
Copy Markdown
Member Author

chrysn commented Sep 12, 2021

@chrysn chrysn merged commit 88de3c3 into RIOT-OS:master Sep 13, 2021
@chrysn chrysn deleted the 802154-security-expectations branch September 13, 2021 05:45
@benpicco benpicco added this to the Release 2021.10 milestone Oct 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation Area: network Area: Networking Area: security Area: Security-related libraries and subsystems Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants