Skip to content
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

Jump to bottom

Genericize cap parsing and negotiation #79

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

Genericize cap parsing and negotiation #79

Show file tree
Hide file tree
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
101 changes: 46 additions & 55 deletions src/capabilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,57 +1,31 @@
import { Message } from "./parse_message";

class Capabilities {
constructor(
public caps = new Set<string>(),
public saslTypes = new Set<string>(),
public ready = false,
) {}

extend(messageArgs: string[]) {
let capabilityString = messageArgs[0];
// https://ircv3.net/specs/extensions/capability-negotiation.html#multiline-replies-to-cap-ls-and-cap-list
if (capabilityString === '*') {
capabilityString = messageArgs[1];
}
else {
this.ready = true;
}
const allCaps = capabilityString.trim().split(' ');
// Not all servers respond with the type of sasl supported.
const saslTypes = allCaps.find((s) => s.startsWith('sasl='))?.split('=')[1]
.split(',')
.map((s) => s.toUpperCase()) || [];
if (saslTypes) {
allCaps.push('sasl');
}

allCaps.forEach(c => this.caps.add(c));
saslTypes.forEach(t => this.saslTypes.add(t));
}
}

/**
* A helper class to handle capabilities sent by the IRCd.
*/
export class IrcCapabilities {
private serverCapabilites = new Capabilities();
private userCapabilites = new Capabilities();
private serverCapabilites: Map<string, string> = new Map();
private userCapabilites: Set<string> = new Set();
private ready = false;

constructor(
private readonly onCapsList: () => void,
private readonly onCapsConfirmed: () => void) {

}

public get capsReady() {
return this.userCapabilites.ready;
public isCapEnabled(cap: string): boolean {
if (!this.ready) {
throw Error('Server caps response has not arrived yet');
}
return this.userCapabilites.has(cap);
}

public get supportsSasl() {
if (!this.serverCapabilites.ready) {
throw Error('Server response has not arrived yet');
public getServerCap(cap: string): string|undefined {
if (!this.ready) {
throw Error('Server caps response has not arrived yet');
}
return this.serverCapabilites.caps.has('sasl');
return this.serverCapabilites.get(cap);
}

/**
Expand All @@ -62,17 +36,19 @@ export class IrcCapabilities {
* @returns True if supported, false otherwise.
* @throws If the capabilites have not returned yet.
*/
public supportsSaslMethod(method: string, allowNoMethods=false) {
if (!this.serverCapabilites.ready) {
public supportsSaslMethod(method: string, allowNoMethods=false): boolean {
if (!this.ready) {
throw Error('Server caps response has not arrived yet');
}
if (!this.serverCapabilites.caps.has('sasl')) {
const saslString = this.serverCapabilites.get('sasl');
if (saslString === undefined) {
return false;
}
if (this.serverCapabilites.saslTypes.size === 0) {
if (saslString === '') {
return allowNoMethods;
}
return this.serverCapabilites.saslTypes.has(method.toUpperCase());
const saslTypes = saslString.split(',');
return saslTypes.includes(method.toLowerCase());
}

/**
Expand All @@ -82,22 +58,37 @@ export class IrcCapabilities {
// E.g. CAP * LS :account-notify away-notify chghost extended-join multi-prefix
// sasl=PLAIN,ECDSA-NIST256P-CHALLENGE,EXTERNAL tls account-tag cap-notify echo-message
// solanum.chat/identify-msg solanum.chat/realhost
const [, subCmd, ...parts] = message.args;
if (subCmd === 'LS') {
this.serverCapabilites.extend(parts);

if (this.serverCapabilites.ready) {
// We now need to request user caps
if (message.args[1] === 'LS') {
const capsGiven = message.args.slice(-1);
if (capsGiven) {
const capArray = capsGiven[0].split(' ');
capArray.forEach(cap => {
const firstEqualSign = cap.indexOf('=');
if (firstEqualSign === -1) {
this.serverCapabilites.set(cap, '');
}
else {
const key = cap.substring(0, firstEqualSign);
// Normalize this to lowercase to avoid casing problems between ircds
const value = cap.substring(firstEqualSign+1).toLowerCase();
this.serverCapabilites.set(key, value);
}
})
}
// * as the penultimate parameter means there's more caps coming, so we wait to
// send the caps back until it's complete.
if (message.args.slice(-2, -1)[0] !== '*') {
this.ready = true;
this.onCapsList();
}
}
// The target might be * or the nickname, for now just accept either.
if (subCmd === 'ACK') {
this.userCapabilites.extend(parts);

if (this.userCapabilites.ready) {
this.onCapsConfirmed();
else if (message.args[1] === 'ACK') {
const capsGiven = message.args.slice(-1);
if (capsGiven) {
const acceptedCaps = capsGiven[0].split(' ');
acceptedCaps.forEach(cap => this.userCapabilites.add(cap));
}
this.onCapsConfirmed();
}
}
}
24 changes: 12 additions & 12 deletions src/irc.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export interface IrcClientOpts {
certExpired?: boolean;
floodProtection?: boolean;
floodProtectionDelay?: number;
sasl?: boolean;
capabilities?: Set<string>;
saslType?: 'PLAIN'|'EXTERNAL';
stripColors?: boolean;
channelPrefixes?: string;
Expand Down Expand Up @@ -127,7 +127,7 @@ interface IrcClientOptInternal extends IrcClientOpts {
certExpired: boolean;
floodProtection: boolean;
floodProtectionDelay: number;
sasl: boolean;
capabilities: Set<string>;
saslType: 'PLAIN'|'EXTERNAL';
stripColors: boolean;
channelPrefixes: string;
Expand Down Expand Up @@ -247,7 +247,7 @@ export class Client extends EventEmitter {
certExpired: false,
floodProtection: false,
floodProtectionDelay: 1000,
sasl: false,
capabilities: new Set(),
saslType: 'PLAIN',
stripColors: false,
channelPrefixes: '&#',
Expand Down Expand Up @@ -309,22 +309,22 @@ export class Client extends EventEmitter {
}

private onCapsList() {
const requiredCapabilites = [];
if (this.opt.sasl) {
requiredCapabilites.push('sasl');
}

if (requiredCapabilites.length === 0) {
if (this.opt.capabilities.size === 0) {
// Don't bother asking for any capabilities.
// We're finished checking for caps, so we can send an END.
this._send('CAP', 'END');
return;
}
this.send('CAP REQ :', ...requiredCapabilites);

// Filter out caps that we specified but the server doesn't support
const capsToReq = Array(...this.opt.capabilities).filter((cap) => {
return this.capabilities.getServerCap(cap) !== undefined;
})
this.send('CAP REQ', capsToReq.join(' '));
}

private onCapsConfirmed() {
if (!this.opt.sasl) {
if (!this.capabilities.isCapEnabled('sasl')) {
// We're not going to authenticate, so we can END.
this.send('CAP', 'END');
return;
Expand Down Expand Up @@ -1083,7 +1083,7 @@ export class Client extends EventEmitter {
if (this.opt.webirc.ip && this.opt.webirc.pass && this.opt.webirc.host) {
this._send('WEBIRC', this.opt.webirc.pass, this.opt.userName, this.opt.webirc.host, this.opt.webirc.ip);
}
if (!this.opt.sasl && this.opt.password) {
if (!this.opt.capabilities.has('sasl') && this.opt.password) {
// Legacy PASS command, use when not using sasl.
this._send('PASS', this.opt.password);
}
Expand Down