Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .changeset/login-rate-limit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@hyperdx/api': patch
'@hyperdx/app': patch
---

fix: limit failed password logins to 10 per email every 15 minutes
120 changes: 120 additions & 0 deletions packages/api/src/routers/api/__tests__/login.int.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
import { getAgent, getLoggedInAgent, getServer } from '@/fixtures';
import User from '@/models/user';
import { LOGIN_MAX_FAILED_ATTEMPTS } from '@/routers/api/root';

const MOCK_USER = {
email: 'login-limit@example.com',
password: 'TacoCat!2#4X',
};

describe('POST /login/password rate limit', () => {
const server = getServer();
let signedInAgent: ReturnType<typeof getAgent>;

beforeAll(async () => {
await server.start();
({ agent: signedInAgent } = await getLoggedInAgent(server, MOCK_USER));
});

afterAll(async () => {
await server.stop();
});

const login = (email: string, password: string) =>
getAgent(server)
.post('/login/password')
.type('form')
.send({ email, password });

it('does not count successful logins', async () => {
for (let i = 0; i <= LOGIN_MAX_FAILED_ATTEMPTS; i++) {
const res = await login(MOCK_USER.email, MOCK_USER.password);
expect(res.status).toBe(303);
expect(res.headers.location).not.toContain('err=');
}
});

it('blocks an email after too many failed attempts, even with the right password', async () => {
for (let i = 0; i < LOGIN_MAX_FAILED_ATTEMPTS; i++) {
const res = await login(MOCK_USER.email, 'wrong-password');
expect(res.headers.location).toContain('/login?err=authFail');
}

const blocked = await login(MOCK_USER.email, MOCK_USER.password);
expect(blocked.status).toBe(303);
expect(blocked.headers.location).toContain('/login?err=tooManyAttempts');

// Emails are case-insensitive, so another spelling shares the limit.
const upper = await login(MOCK_USER.email.toUpperCase(), 'wrong-password');
expect(upper.headers.location).toContain('/login?err=tooManyAttempts');
});

it('keeps a separate limit for each email', async () => {
const res = await login('someone-else@example.com', 'wrong-password');
expect(res.headers.location).toContain('/login?err=authFail');
});

it('counts failed attempts made from a signed-in session', async () => {
const email = 'signed-in-target@example.com';
for (let i = 0; i < LOGIN_MAX_FAILED_ATTEMPTS; i++) {
await signedInAgent
.post('/login/password')
.type('form')
.send({ email, password: 'wrong-password' });
}

const res = await login(email, 'wrong-password');
expect(res.headers.location).toContain('/login?err=tooManyAttempts');
});

it('limits an email sent in the query string, as passport accepts it there', async () => {
const query = { email: 'query-target@example.com', password: 'wrong' };
// A new X-Forwarded-For each time, so falling back to req.ip can't limit it.
const attempt = (i: number) =>
getAgent(server)
.post('/login/password')
.set('X-Forwarded-For', `10.0.0.${i}`)
.query(query);
for (let i = 0; i < LOGIN_MAX_FAILED_ATTEMPTS; i++) {
await attempt(i);
}

const res = await attempt(LOGIN_MAX_FAILED_ATTEMPTS);
expect(res.headers.location).toContain('/login?err=tooManyAttempts');
});

it('does not count server errors, such as the database being down', async () => {
const email = 'outage@example.com';
const findByUsername = jest
.spyOn(User, 'findByUsername')
.mockImplementation(() => {
throw new Error('database unavailable');
});
try {
for (let i = 0; i <= LOGIN_MAX_FAILED_ATTEMPTS; i++) {
const res = await login(email, 'wrong-password');
expect(res.headers.location).toContain('/login?err=unknown');
}
} finally {
findByUsername.mockRestore();
}

const res = await login(email, 'wrong-password');
expect(res.headers.location).toContain('/login?err=authFail');
});

it('answers JSON clients such as the CLI with a 429', async () => {
const attempt = () =>
getAgent(server)
.post('/login/password')
.send({ email: 'json-client@example.com', password: 'wrong-password' });
for (let i = 0; i < LOGIN_MAX_FAILED_ATTEMPTS; i++) {
await attempt();
}

const res = await attempt();
expect(res.status).toBe(429);
expect(res.body.error).toBe('tooManyAttempts');
expect(res.body.message).toMatch(/too many failed login attempts/i);
});
});
59 changes: 59 additions & 0 deletions packages/api/src/routers/api/root.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,58 @@ import { handleAuthError, redirectToDashboard } from '@/middleware/auth';
import TeamInvite from '@/models/teamInvite';
import User from '@/models/user'; // TODO -> do not import model directly
import { setupTeamDefaults } from '@/setupDefaults';
import { getCounter, getServerSpan } from '@/utils/instrumentation';
import logger from '@/utils/logger';
import passport from '@/utils/passport';
import rateLimiter from '@/utils/rateLimiter';
import { isMongoConnected, mongoReadyStateName } from '@/utils/readiness';
import { passwordSchema } from '@/utils/validators';

export const LOGIN_MAX_FAILED_ATTEMPTS = 10;

const loginRateLimitedCounter = getCounter('hyperdx.api.login.rate_limited', {
description:
'Count of password logins refused because the email had too many recent failed attempts.',
});

// passport-local reads the email from the body, then the query string.
const getLoginEmail = (req: express.Request) => {
const email = req.body?.email || req.query.email;
return typeof email === 'string' ? email.trim().toLowerCase() : '';
};

// Only rejected credentials count, not server errors such as the database being
// down. Every outcome answers 303, and req.user is already set for a signed-in
// session, so the rejection is marked on the route instead. The key is the
// email, not the IP: behind the app's /api proxy, req.ip is the proxy or
// whatever X-Forwarded-For the client sends.
const loginRateLimiter = rateLimiter({
windowMs: 15 * 60 * 1000,
max: LOGIN_MAX_FAILED_ATTEMPTS,
standardHeaders: true,
legacyHeaders: false,
skipSuccessfulRequests: true,
requestWasSuccessful: (_req, res) => res.locals.loginRejected !== true,
keyGenerator: req => getLoginEmail(req) || req.ip || 'unknown',
Comment thread
Aryainguz marked this conversation as resolved.
Resolved
handler: (req, res) => {
loginRateLimitedCounter.add(1);
getServerSpan()?.setAttribute('hyperdx.login.rate_limited', true);
// The app's login page submits a form; the CLI posts JSON.
if (req.is('application/json')) {
res.status(429).json({
error: 'tooManyAttempts',
message:
'Too many failed login attempts. Please wait a few minutes and try again.',
});
return;
}
res.redirect(
303,
`${config.FRONTEND_REDIRECT_BASE}/login?err=tooManyAttempts`,
);
},
});

const registrationSchema = z
.object({
email: z.string().email(),
Expand Down Expand Up @@ -70,11 +117,23 @@ router.get('/installation', async (_, res: InstallationEspRes, next) => {

router.post(
'/login/password',
loginRateLimiter,
passport.authenticate('local', {
failWithError: true,
failureMessage: true,
}),
redirectToDashboard,
// passport passes on wrong credentials as an AuthenticationError and server
// errors as they are.
(
err: Error,
_req: express.Request,
res: express.Response,
next: express.NextFunction,
) => {
res.locals.loginRejected = err.name === 'AuthenticationError';
next(err);
},
handleAuthError,
);

Expand Down
4 changes: 3 additions & 1 deletion packages/app/src/AuthPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,9 @@ export default function AuthPage({ action }: { action: 'register' | 'login' }) {
? 'Password authentication is not allowed by your team admin.'
: err === 'teamAlreadyExists'
? 'Team already exists, please login instead.'
: 'Unknown error occurred, please try again later.'}
: err === 'tooManyAttempts'
? 'Too many failed login attempts. Please wait a few minutes and try again.'
: 'Unknown error occurred, please try again later.'}
</Notification>
)}

Expand Down
Loading