docs(airplay): clear the stale "untested against hardware" caveats - #45
Closed
nikhilshastry2003 wants to merge 1 commit into
Closed
docs(airplay): clear the stale "untested against hardware" caveats#45nikhilshastry2003 wants to merge 1 commit into
nikhilshastry2003 wants to merge 1 commit into
Conversation
Transient pair-setup was confirmed against a Mac running AirTunes/950.7.1 on 2026-08-26 (#27, after #41/#42/#43 landed), but every status line in the docs still said pairing was unconfirmed, and the crate's own module comment said "treat pairing as untested-in-the-field". #27's write-up asked for exactly these to move to "pairing confirmed; mirroring unconfirmed". What changes, all wording, no behaviour: - README status paragraph and protocol table, docs/protocols.md table and docs/crypto.md summary now say pairing is confirmed and mirroring is not. - docs/crypto.md's "Caveat: still unconfirmed" section is replaced by what the hardware run actually established: the 384-byte B corroborating the group, the two bugs it took to reach M4 (X-Apple-HKP, minimal-encoding g), that transient pairing ends at M4 with no pair-verify, the encrypted control channel, the 0x03 back-off trap, and why mirroring is still open. The 403 attempt stays as history under "What the first attempt produced". - docs/protocols.md's AirPlay flow described "transient pair-setup followed by pair-verify, then POST /stream on the verified connection". That is not what session.rs does: the transient flow has no pair-verify, POST /stream goes through control_channel.rs, and the path then stops with an explicit error because MirrorStream cannot yet frame video for the encrypted connection. Documented as such, and the pairing-modes list now says which flow reaches M5/M6 and that pair_verify has no callers. - docs/troubleshooting.md gains the two failures that look like something they are not (0x03 back-off, connection closed after a successful M4) and the "mirror stream cannot yet send video" stop. - docs/contributing.md: the "Not useful" paragraph was sitting in the middle of the bullet list, orphaning the two bullets after it; moved below the list. The "confirm pairing" item becomes "confirm mirroring". - control_channel.rs and the control_probe example were undocumented; added to crypto.md, the architecture crate table and the crate README. - hap_pairing.rs module comment updated to match. Deliberately untouched, because #44 rewrites them: CLAUDE.md, and every sentence about the model-string / FairPlay refusal. Verified: cargo fmt --all --check clean; cargo clippy -p openplay-airplay --all-targets --all-features -D warnings clean; cargo test -p openplay-airplay 42 + 27 passed; every relative link and anchor under README.md and docs/ resolves.
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
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.
Follows up on the write-up in #27: transient pair-setup completed against a Mac running
AirTunes/950.7.1on 2026-08-26 (after #41/#42/#43), and that comment listed the caveats that should now read "pairing confirmed against hardware; mirroring unconfirmed". This does that, and the same for the other places that said the same thing.Docs only — no behaviour change. The one
.rstouched is the//!module comment inhap_pairing.rs.What changes
README.md(status paragraph + protocol table),docs/protocols.mdtable,docs/crypto.mdsummary table,crates/openplay-airplay/README.md: pairing confirmed, mirroring not.docs/crypto.md— the "Caveat: still unconfirmed against hardware" section becomes "Confirmed against hardware" and records what the run established: the 384-byteBcorroborating the group from the far side, the two bugs it took to reach M4 (X-Apple-HKP, minimal-encodingg), that transient pairing ends at M4 with no pair-verify, the control channel, the0x03back-off trap, and why mirroring is still open. The 403 attempt stays, as "What the first attempt produced". Summary table gains a control-channel row; the pair-verify row now says it has no callers rather than "unreachable until pairing is confirmed".docs/protocols.md— the AirPlay flow said "transient pair-setup followed by pair-verify, thenPOST /streamon the verified connection".session.rsdoes not do that: no pair-verify,POST /streamgoes throughcontrol_channel.rs, and the path stops with an explicit error becauseMirrorStreamcannot yet frame video for the encrypted connection. Now described as such. Pairing-modes list says which flow reaches M5/M6 and thatpair_verifyhas no callers.docs/troubleshooting.md— adds the two failures that are not what they look like (0x03back-off; connection closed right after a successful M4) and the "mirror stream cannot yet send video" stop.docs/contributing.md— the "Not useful" paragraph sat in the middle of the bullet list, orphaning the two bullets after it. Moved below the list. "Confirm pairing" item becomes "confirm mirroring".control_channel.rsand thecontrol_probeexample were not mentioned anywhere indocs/; added tocrypto.md, the architecture crate table and the crate README.Deliberately untouched
CLAUDE.md, and every sentence about the model-string / FairPlay refusal — #44 rewrites those, and touching them here would only conflict. Same for the "501 or 403" retry list inprotocols.md, which #44 widens. Once #44 lands, itsCLAUDE.mdstatus bullet still says "unconfirmed against hardware (issue #27)"; that one line is the only follow-up.Verified
cargo fmt --all -- --checkcleancargo clippy -p openplay-airplay --all-targets --all-features -- -D warningscleancargo test -p openplay-airplay— 42 + 27 passedREADME.mdanddocs/resolves (the newcrypto.md#confirmed-against-hardwareanchor included)Not run: the full
cargo test --all— this machine has no GStreamer, so-pipeline/-sender/-receiverdo not build here. Nothing in the change can affect them.