[docs] Fixed wrong description concerning passphrase #1701
Conversation
maxsharabayko
added
the
Type: Maintenance
This comment has been minimized.
This comment has been minimized.
docs/APISocketOptions.md
Outdated
|
|
||
| When a socket with configured passphrase is being connected, the peer must | ||
| have the same password set, or otherwise the connection is rejected. This | ||
| behavior can be changed by [`SRTO_ENFORCEDENCRYPTION`](#SRTO_ENFORCEDENCRYPTION). | ||
|
|
||
| Note that since the introduction of bidirectional support, there's only one | ||
| initial SEK to encrypt the stream (new keys after refreshing will be updated |
There was a problem hiding this comment.
This is not part of the PR changes but I have been surprise by this 'SEK' popping here. I don't see it defined around while the KEK is written in full word two paragraphs before. Is there a lexicon we can link to.
There was a problem hiding this comment.
We may link to the Encryption section of the RFC.
This information about SEK is maybe extra in this document: too detailed. I mean, "there's only one
initial SEK to encrypt...".
There was a problem hiding this comment.
I'd simply replace it with "encryption key".
docs/APISocketOptions.md
Outdated
| disables it, if an empty passphrase is passed). The password must be minimum | ||
| 10 and maximum 79 characters long. If an empty password is specified (default), | ||
| the encryption is disabled. |
There was a problem hiding this comment.
The sentence "If an empty password is specified (default),
the encryption is disabled." is redundant (see line 870)
There was a problem hiding this comment.
Right. How I overlooked it. Will be removed.
docs/APISocketOptions.md
Outdated
| When a socket with configured passphrase is being connected, the peer must | ||
| have the same password set, or otherwise the connection is rejected. This | ||
| behavior can be changed by [`SRTO_ENFORCEDENCRYPTION`](#SRTO_ENFORCEDENCRYPTION). |
There was a problem hiding this comment.
When a socket with configured passphrase is being connected, the peer must
have the same password set, or the connection is rejected. This
behavior can be changed by SRTO_ENFORCEDENCRYPTION.
No description provided.