Skip to content

Specify channel key validation (MODE +k). #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 10, 2021
Merged

Specify channel key validation (MODE +k). #107

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e4b2d5
Specify channel key validation (MODE +k).
progval Aug 8, 2021
7f0b1bd
Reference ERR_BADCHANNELKEY from ERR_INVALIDKEY and vice versa
progval Aug 8, 2021
9f26651
Exhaustively document all known behaviors
progval Aug 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions _includes/modern-appendix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,13 @@ If this mode is set on a channel, and a client sends a `JOIN` request for that c
This mode is standard, and the mode letter used for it is `"+k"`.

This mode letter sets a 'key' that must be supplied in order to join this channel. If this mode is set, its' value is the key that is required.
Servers may validate the value (eg. to forbid spaces, as they make it harder to use the key in `JOIN` messages). If the value is invalid, they SHOULD return [`ERR_INVALIDMODEPARAM`](#errinvalidmodeparam-696).
However, clients MUST be able to handle any of the following:

* [`ERR_INVALIDMODEPARAM`](#errinvalidmodeparam-696)
* [`ERR_INVALIDKEY`](#errinvalidkey-525)
* `MODE` echoed with a different key (eg. truncated or stripped of invalid characters)
* the key changed ignored, and no `MODE` echoed if no other mode change was valid.

If this mode is set on a channel, and a client sends a `JOIN` request for that channel, they must supply `<key>` in order for the command to succeed. If they do not supply a `<key>`, or the key they supply does not match the value of this mode, they will receive an [`ERR_BADCHANNELKEY`](#errbadchannelkey-475) reply and the command will fail.

Expand Down Expand Up @@ -758,6 +765,8 @@ Returned to indicate that a [`JOIN`](#join-message) command failed because the c

Returned to indicate that a [`JOIN`](#join-message) command failed because the channel requires a [key](#key-channel-mode) and the key was either incorrect or not supplied. The text used in the last param of this message may vary.

Not to be confused with [`ERR_INVALIDKEY`](#errinvalidkey-525), which may be returned when setting a key.

### `ERR_NOPRIVILEGES (481)`

"<client> :Permission Denied- You're not an IRC operator"
Expand Down Expand Up @@ -794,6 +803,14 @@ Indicates that a [`MODE`](#mode-message) command affecting a user contained a `M

Indicates that a [`MODE`](#mode-message) command affecting a user failed because they were trying to set or view modes for other users. The text used in the last param of this message varies, for instance when trying to view modes for another user, a server may send: `"Can't view modes for other users"`.

### `ERR_INVALIDKEY (525)`

"<client> <target chan> :Key is not well-formed"

Indicates the value of a key channel mode change (`+k`) was rejected.

Not to be confused with [`ERR_BADCHANNELKEY`](#errbadchannelkey-475), which is returned when someone tries to join a channel.

### `RPL_STARTTLS (670)`

"<client> :STARTTLS successful, proceed with TLS handshake"
Expand All @@ -810,6 +827,12 @@ This numeric is used by the IRCv3 [`tls`](http://ircv3.net/specs/extensions/tls-

The text used in the last param of this message varies wildly.

### `ERR_INVALIDMODEPARAM (696)`

" <client> <target chan/user> <mode char> <parameter> :<description>"

Indicates that there was a problem with a mode parameter. Replaces various implementation-specific mode-specific numerics.

### `ERR_NOPRIVS (723)`

"<client> <priv> :Insufficient oper privileges."
Expand Down