serverless-ircd 0.1.0 → 0.2.0

package/packages/irc-core/tests/commands/registration.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it } from 'vitest';
+import { cloakHost } from '../../src/cloak';
 import { generateIsupport } from '../../src/commands/isupport';
 import {
   buildWelcomeLines,
@@ -75,9 +76,9 @@ function expectedWelcome(nick: string, user: string, host: string | undefined):
   );
   return [
     L(`${prefix} 001 ${nick} :Welcome to the ExampleNet IRC Network, ${hostmask}`),
-    L(`${prefix} 002 ${nick} :Your host is ${sv}, running version 0.1.0`),
+    L(`${prefix} 002 ${nick} :Your host is ${sv}, running version 0.2.0`),
     L(`${prefix} 003 ${nick} :This server was created in Phase 1`),
-    L(`${prefix} 004 ${nick} ${sv} 0.1.0 iosw biklmnstp`),
+    L(`${prefix} 004 ${nick} ${sv} 0.2.0 iosw biklmnstp`),
     ...isupport,
     L(`${prefix} 375 ${nick} :- ${sv} Message of the day -`),
     L(`${prefix} 372 ${nick} :- MOTD placeholder`),
@@ -567,33 +568,300 @@ describe('emitWelcomeIfReady', () => {
     state.user = 'alice';
     const ctx = makeCtx(state);
     const effect = emitWelcomeIfReady(state, ctx);
-    expect(effect).toEqual(Effect.send('c1', expectedWelcome('alice', 'alice', undefined)));
+    expect(effect).toEqual([Effect.send('c1', expectedWelcome('alice', 'alice', undefined))]);
     expect(state.registration).toBe('registered');
   });
 
-  it('returns null and does not transition when nick is missing', () => {
+  it('returns an empty array and does not transition when nick is missing', () => {
     const state = makeState();
     state.user = 'alice';
     const ctx = makeCtx(state);
     const effect = emitWelcomeIfReady(state, ctx);
-    expect(effect).toBeNull();
+    expect(effect).toEqual([]);
     expect(state.registration).toBe('pre-registration');
   });
 
-  it('returns null and does not transition when user is missing', () => {
+  it('returns an empty array and does not transition when user is missing', () => {
     const state = makeState();
     state.nick = 'alice';
     const ctx = makeCtx(state);
     const effect = emitWelcomeIfReady(state, ctx);
-    expect(effect).toBeNull();
+    expect(effect).toEqual([]);
     expect(state.registration).toBe('pre-registration');
   });
 
-  it('returns null when already registered', () => {
+  it('returns an empty array when already registered', () => {
     const state = registeredState();
     const ctx = makeCtx(state);
     const effect = emitWelcomeIfReady(state, ctx);
-    expect(effect).toBeNull();
+    expect(effect).toEqual([]);
     expect(state.registration).toBe('registered');
   });
 });
+
+// ============================================================================
+// emitWelcomeIfReady — server-password gate
+// ============================================================================
+
+/** Builds a ctx whose serverConfig has a serverPassword set. */
+function makeCtxWithPassword(state: ConnectionState, password: string): Ctx {
+  return buildCtx({
+    serverConfig: { ...serverConfig, serverPassword: password },
+    clock: new FakeClock(1_000),
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: state,
+  });
+}
+
+describe('emitWelcomeIfReady — server-password gate', () => {
+  it('proceeds with registration when no serverPassword is configured', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    const ctx = makeCtx(state);
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(effects).toEqual([Effect.send('c1', expectedWelcome('alice', 'alice', undefined))]);
+    expect(state.registration).toBe('registered');
+  });
+
+  it('proceeds with registration when serverPassword is empty (disabled)', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    const ctx = makeCtxWithPassword(state, '');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(state.registration).toBe('registered');
+    expect(effects).toEqual([Effect.send('c1', expectedWelcome('alice', 'alice', undefined))]);
+  });
+
+  it('blocks registration with 464 + Disconnect when passAttempt is missing', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(state.registration).not.toBe('registered');
+    expect(effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 464 alice :Password mismatch')]),
+      Effect.disconnect('c1', 'Bad Password'),
+    ]);
+  });
+
+  it('blocks registration with 464 + Disconnect when passAttempt is wrong', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.passAttempt = 'wrong';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(state.registration).not.toBe('registered');
+    expect(effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 464 alice :Password mismatch')]),
+      Effect.disconnect('c1', 'Bad Password'),
+    ]);
+  });
+
+  it('proceeds with registration when passAttempt matches serverPassword', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.passAttempt = 's3cret';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(state.registration).toBe('registered');
+    expect(effects).toEqual([Effect.send('c1', expectedWelcome('alice', 'alice', undefined))]);
+  });
+
+  it('satisfies the gate when SASL has authenticated an account (no PASS needed)', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.account = 'alice';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(state.registration).toBe('registered');
+    expect(effects).toEqual([Effect.send('c1', expectedWelcome('alice', 'alice', undefined))]);
+  });
+
+  it('does not register when nick is missing even if password is configured', () => {
+    const state = makeState();
+    state.user = 'alice';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(effects).toEqual([]);
+    expect(state.registration).toBe('pre-registration');
+  });
+
+  it('does not register when capNegotiating is true even if password is configured', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.capNegotiating = true;
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const effects = emitWelcomeIfReady(state, ctx);
+    expect(effects).toEqual([]);
+    expect(state.registration).toBe('pre-registration');
+  });
+});
+
+// ============================================================================
+// userReducer / nickReducer — server-password gate integration
+// ============================================================================
+
+describe('userReducer — server-password gate integration', () => {
+  it('emits 464 + Disconnect on the completing USER when passAttempt is wrong', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.registration = 'registering';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const out = userReducer(
+      state,
+      { command: 'USER', params: ['alice', '0', '*', 'Alice'], tags: {} },
+      ctx,
+    );
+    expect(state.registration).not.toBe('registered');
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', [L(':irc.example.com 464 alice :Password mismatch')]),
+      Effect.disconnect('c1', 'Bad Password'),
+    ]);
+  });
+
+  it('completes registration on the completing USER when passAttempt matches', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.passAttempt = 's3cret';
+    state.registration = 'registering';
+    const ctx = makeCtxWithPassword(state, 's3cret');
+    const out = userReducer(
+      state,
+      { command: 'USER', params: ['alice', '0', '*', 'Alice'], tags: {} },
+      ctx,
+    );
+    expect(state.registration).toBe('registered');
+    expect(out.effects).toEqual<EffectType[]>([
+      Effect.send('c1', expectedWelcome('alice', 'alice', undefined)),
+    ]);
+  });
+});
+
+// ============================================================================
+// emitWelcomeIfReady — hostmask cloaking integration
+// ============================================================================
+
+function makeCtxWithCloaking(
+  state: ConnectionState,
+  cloaking: { enabled: boolean; secret: string; cloakedSuffix?: string },
+): Ctx {
+  return buildCtx({
+    serverConfig: { ...serverConfig, cloaking },
+    clock: new FakeClock(1_000),
+    ids: new SequentialIdFactory(),
+    motd: EmptyMotdProvider,
+    connection: state,
+  });
+}
+
+describe('emitWelcomeIfReady — hostmask cloaking', () => {
+  it('leaves host untouched when cloaking is disabled', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.host = '203.0.113.5';
+    const ctx = makeCtxWithCloaking(state, { enabled: false, secret: 's3cret' });
+    emitWelcomeIfReady(state, ctx);
+    expect(state.host).toBe('203.0.113.5');
+  });
+
+  it('replaces the real host with a deterministic cloak when enabled', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.host = '203.0.113.5';
+    const ctx = makeCtxWithCloaking(state, { enabled: true, secret: 's3cret' });
+    emitWelcomeIfReady(state, ctx);
+    expect(state.host).toBe(
+      cloakHost('203.0.113.5', { enabled: true, secret: 's3cret' }, 'ExampleNet'),
+    );
+    expect(state.host).not.toBe('203.0.113.5');
+  });
+
+  it('uses the configured cloakedSuffix when supplied', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.host = '203.0.113.5';
+    const ctx = makeCtxWithCloaking(state, {
+      enabled: true,
+      secret: 's3cret',
+      cloakedSuffix: 'hidden.lan',
+    });
+    emitWelcomeIfReady(state, ctx);
+    expect(state.host).toBe(
+      cloakHost(
+        '203.0.113.5',
+        { enabled: true, secret: 's3cret', cloakedSuffix: 'hidden.lan' },
+        'ExampleNet',
+      ),
+    );
+    expect(state.host.endsWith('.hidden.lan')).toBe(true);
+  });
+
+  it('cloaks the host before building the welcome hostmask so 001 shows the cloak', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    state.host = '203.0.113.5';
+    const ctx = makeCtxWithCloaking(state, { enabled: true, secret: 's3cret' });
+    const effects = emitWelcomeIfReady(state, ctx);
+    const expectedCloak = cloakHost(
+      '203.0.113.5',
+      { enabled: true, secret: 's3cret' },
+      'ExampleNet',
+    );
+    const expectedHostmask = `alice!alice@${expectedCloak}`;
+    expect(effects).toEqual([
+      Effect.send('c1', expectedWelcomeWithHost('alice', expectedHostmask)),
+    ]);
+  });
+
+  it('does not cloak when host is already absent (nothing to cloak)', () => {
+    const state = makeState();
+    state.nick = 'alice';
+    state.user = 'alice';
+    const ctx = makeCtxWithCloaking(state, { enabled: true, secret: 's3cret' });
+    emitWelcomeIfReady(state, ctx);
+    expect(state.host).toBeUndefined();
+  });
+});
+
+/** Builds the welcome block with an explicit cloaked host (used for cloak tests). */
+function expectedWelcomeWithHost(nick: string, hostmask: string): RawLine[] {
+  const sv = 'irc.example.com';
+  const prefix = `:${sv}`;
+  const isupport = generateIsupport(
+    {
+      serverName: sv,
+      networkName: 'ExampleNet',
+      maxChannelsPerUser: 30,
+      maxTargetsPerCommand: 10,
+      maxListEntries: 50,
+      nickLen: 30,
+      channelLen: 50,
+      topicLen: 390,
+      quitMessage: 'Client Quit',
+    },
+    new Set<string>(),
+    nick,
+  );
+  return [
+    L(`${prefix} 001 ${nick} :Welcome to the ExampleNet IRC Network, ${hostmask}`),
+    L(`${prefix} 002 ${nick} :Your host is ${sv}, running version 0.2.0`),
+    L(`${prefix} 003 ${nick} :This server was created in Phase 1`),
+    L(`${prefix} 004 ${nick} ${sv} 0.2.0 iosw biklmnstp`),
+    ...isupport,
+    L(`${prefix} 375 ${nick} :- ${sv} Message of the day -`),
+    L(`${prefix} 372 ${nick} :- MOTD placeholder`),
+    L(`${prefix} 376 ${nick} :End of MOTD command`),
+  ];
+}