Allow wildcards in hostmask

According to https://modern.ircdocs.horse/#wildcard-expressions
masks should support "*" and "?" wildcards.
Within TL this only impacts the /ignore functionality.

The reasoning for doing this is to ignore say GuestNNNN!*@* with
guest*!*@* and be done with it if someone spams a gateway.
This commit is contained in:
Reto Brunner 2021-11-02 21:42:17 +01:00
parent 3cab39c59b
commit 67503efd21
2 changed files with 75 additions and 4 deletions

View File

@ -43,6 +43,7 @@ const Helper = {
getDefaultNick, getDefaultNick,
parseHostmask, parseHostmask,
compareHostmask, compareHostmask,
compareWithWildcard,
password: { password: {
hash: passwordHash, hash: passwordHash,
@ -314,8 +315,27 @@ function parseHostmask(hostmask) {
function compareHostmask(a, b) { function compareHostmask(a, b) {
return ( return (
(a.nick.toLowerCase() === b.nick.toLowerCase() || a.nick === "*") && compareWithWildcard(a.nick, b.nick) &&
(a.ident.toLowerCase() === b.ident.toLowerCase() || a.ident === "*") && compareWithWildcard(a.ident, b.ident) &&
(a.hostname.toLowerCase() === b.hostname.toLowerCase() || a.hostname === "*") compareWithWildcard(a.hostname, b.hostname)
); );
} }
function compareWithWildcard(a, b) {
// we allow '*' and '?' wildcards in our comparison.
// this is mostly aligned with https://modern.ircdocs.horse/#wildcard-expressions
// but we do not support the escaping. The ABNF does not seem to be clear as to
// how to escape the escape char '\', which is valid in a nick,
// whereas the wildcards tend not to be (as per RFC1459).
// The "*" wildcard is ".*" in regex, "?" is "."
// so we tokenize and join with the proper char back together,
// escaping any other regex modifier
const wildmany_split = a.split("*").map((sub) => {
const wildone_split = sub.split("?").map((p) => _.escapeRegExp(p));
return wildone_split.join(".");
});
const user_regex = wildmany_split.join(".*");
const re = new RegExp(`^${user_regex}$`, "i"); // case insensitive
return re.test(b);
}

View File

@ -48,7 +48,14 @@ describe("Hostmask", function () {
it(".compareHostmask (wildcard)", function () { it(".compareHostmask (wildcard)", function () {
const a = Helper.parseHostmask("nick!user@host"); const a = Helper.parseHostmask("nick!user@host");
const b = Helper.parseHostmask("nick!*@*"); const b = Helper.parseHostmask("n?ck!*@*");
expect(Helper.compareHostmask(b, a)).to.be.true;
expect(Helper.compareHostmask(a, b)).to.be.false;
});
it(".compareHostmask (wildcard - partial)", function () {
const a = Helper.parseHostmask("nicky!user@host");
const b = Helper.parseHostmask("nick*!*e?@?os*");
expect(Helper.compareHostmask(b, a)).to.be.true; expect(Helper.compareHostmask(b, a)).to.be.true;
expect(Helper.compareHostmask(a, b)).to.be.false; expect(Helper.compareHostmask(a, b)).to.be.false;
}); });
@ -60,3 +67,47 @@ describe("Hostmask", function () {
expect(Helper.compareHostmask(a, b)).to.be.true; expect(Helper.compareHostmask(a, b)).to.be.true;
}); });
}); });
describe("compareWithWildcard", function () {
const goodPairs = [
["asdf", "asdf"],
["AsDf", "asdf"],
["a?df*", "asdf"],
["*asdf*", "asdf"],
["*asdf", "asdf"],
["asd?", "asdf"],
["asd?*", "asdf"],
["a??f", "asdf"],
["a*", "asdf"],
["*f", "asdf"],
["*s*", "asdf"],
["*", ""],
["**", ""],
];
for (const t of goodPairs) {
it(`("${t[0]}", "${t[1]}")`, function () {
expect(Helper.compareWithWildcard(t[0], t[1])).to.be.true;
});
}
const badPairs = [
["asdf", "fdsa"],
["a?df*", "adfg"],
["?", ""],
["?asdf", "asdf"],
["?*", ""],
["*?*", ""],
["*?", ""],
["asd", "asdf"],
["sdf", "asdf"],
["sd", "asdf"],
["", "asdf"],
];
for (const t of badPairs) {
it(`("${t[0]}", "${t[1]}")`, function () {
expect(Helper.compareWithWildcard(t[0], t[1])).to.be.false;
});
}
});