Skip to content

Add multi-underlay doc#207

Merged
plorenz merged 1 commit intomainfrom
add-multi-underlay-doc
Sep 2, 2025
Merged

Add multi-underlay doc#207
plorenz merged 1 commit intomainfrom
add-multi-underlay-doc

Conversation

@plorenz
Copy link
Member

@plorenz plorenz commented Aug 20, 2025

No description provided.

@plorenz plorenz requested a review from a team as a code owner August 20, 2025 09:16
@plorenz plorenz force-pushed the add-multi-underlay-doc branch from 57f5826 to eb2461b Compare August 20, 2025 09:17
An `Underlay` represents a single underlying transport connection (TCP, WebSocket, UDP, etc.). Multiple underlays can be grouped together under a single multi-channel using a shared group secret.

### Group Secret
A cryptographic token that identifies which underlays belong to the same logical channel. All underlays sharing the same group secret are considered part of the same multi-channel group.
Copy link
Member

@andrewpmartinez andrewpmartinez Aug 20, 2025

Choose a reason for hiding this comment

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

I took a quick look to see what cryptographic algorithms are used to generate these symmetric secrets. I could not find an implementation. It seems like it is up to the caller to decide the value. Might be worth documenting.

Copy link
Member Author

Choose a reason for hiding this comment

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

Mmm, I should fix that. It's not cryptographic, it's just a uuid used as a shared secret.

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated group secret text and also added a section for connection id

@plorenz plorenz force-pushed the add-multi-underlay-doc branch from eb2461b to 4604876 Compare September 2, 2025 18:09
@plorenz plorenz merged commit 505234e into main Sep 2, 2025
9 of 10 checks passed
@plorenz plorenz deleted the add-multi-underlay-doc branch September 2, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants