Skip to content

Fix SASL PLAIN using ident instead of nick as authcid #121

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

Open
nbuechner wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix SASL PLAIN using ident instead of nick as authcid #121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 19 additions & 3 deletions src/irc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ export interface IrcClientOpts {
floodProtectionDelay?: number;
sasl?: boolean;
saslType?: 'PLAIN'|'EXTERNAL';
/**
* The account name to authenticate as via SASL PLAIN. Defaults to the connecting nick, which
* is correct for most networks/services but not guaranteed to be true everywhere (a NickServ
* account name need not match the nick in use). Set this explicitly if your network's account
* name differs from the nick.
*/
saslAccount?: string;
stripColors?: boolean;
channelPrefixes?: string;
messageSplit?: number;
Expand Down Expand Up @@ -940,14 +947,23 @@ export class Client extends (EventEmitter as unknown as new () => TypedEmitter<C
return;
}
switch (this.opt.saslType) {
case 'PLAIN':
case 'PLAIN': {
// SASL PLAIN payload is authzid\0authcid\0password. The identity to authenticate
// as must be the account being registered, not `opt.userName` (which is the
// separate IRC ident sent via USER) - using the ident here made servers that check
// the account name (e.g. Libera) reject the handshake with err_saslfail, even when
// the password was correct. The nick is the best default for this (and correct for
// most networks/services), but isn't guaranteed to match the actual account name,
// so allow it to be overridden via `saslAccount`.
const account = this.opt.saslAccount || this.nick;
this._send('AUTHENTICATE',
Buffer.from(
this.opt.userName + '\x00' +
this.opt.userName + '\x00' +
account + '\x00' +
account + '\x00' +
this.opt.password
).toString('base64'));
break;
}
case 'EXTERNAL':
this._send('AUTHENTICATE', '+');
break;
Expand Down