Give authentication a heading of its own - #89
Merged
Merged
Conversation
"BLE OCF framing" owned 234 lines covering four topics under one heading named after the first: the BLE codec, write retransmission, and then all of the authentication material. The providers every consumer has to use — CertificateAuth, PskAuth, ServerCertificateAuth, SamsungServerProfile and validate_identity — had no heading at all, so they were unlinkable and absent from the sidebar. Authentication is now an h2 with four sections: credentials from memory, Samsung server-certificate profiles, PSK credentials, OwnerPSK derivation. Write retransmission is its own h2, since it describes post() rather than any codec. BLE OCF framing keeps its 55 lines of codec. Both moved above the two codec sections. A consumer needs a credential before anything else and most never touch CoAP-over-TCP or BLE framing, so the order now runs quick start, writes, authentication, the supported import surface, the codecs, then the reference. Document order is otherwise unchanged, so this is headings and position rather than rewriting: 19 lines added, all of them headings and the Authentication intro. "create the provider from memory instead" now reads better too, since from_files appears in the quick start immediately above it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Second step of the README split, and the one flagged as outstanding in #88.
"BLE OCF framing" owned 234 lines covering four topics under a heading named after the first: the BLE codec, write retransmission, and then every piece of the authentication material.
CertificateAuth,PskAuth,ServerCertificateAuth,SamsungServerProfileandvalidate_identityhad no heading at all, which left the one thing every consumer has to get right unlinkable and absent from the sidebar.What changed
## Authenticationis now a section with four subsections, in the document order the text already had:## Writes and retransmissionis its own section. It describespost()and how the rate limiter eats into a caller's timeout, which is session behaviour and belongs beside the session material.## BLE OCF framingkeeps its 55 lines of codec.Both moved above the codecs
A consumer needs a credential before anything else, and most never touch CoAP-over-TCP or BLE framing. The library half now runs: quick start, writes and retransmission, authentication, the supported import surface, the two codecs, then the reference.
Scope
Document order within each block is untouched, so the change is headings and position only. 19 lines were added, all of them headings plus a short Authentication intro pointing at
docs/ocf-pki-laundry.mdfor which credential a given firmware generation needs.One sentence reads better for free: "create the provider from memory instead" now sits below a quick start that shows
from_files, where before the reader met it 350 lines later.Validation
798 tests pass on Python 3.11, 3.12, 3.13 and 3.14, and on the dependency floor.
check_share_safety.pyis clean, and the link test that came with #88 still passes, so no cross-file anchor moved out from under a link.