
* Sign in with passkey (PoC) * 💄 Added "Login with Passkey" Button * refactor: Improve error response when WebAuthn challenge fails * signinResponse should be placed under the SigninWithPasskeyResponse object. * Frontend fix * Fix: Rate limiting key for passkey signin Use specific rate limiting key: 'signin-with-passkey' for passkey sign-in API to avoid collisions with signin rate-limit. * Refactor: enhance Passkey sign-in flow and error handling - Increased the rate limit for Passkey sign-in attempts to accommodate the two API calls needed per sign-in. - Improved error messages and handling in both the `WebAuthnService` and the `SigninWithPasskeyApiService`, providing more context and better usability. - Updated error messages to provide more specific and helpful details to the user. These changes aim to enhance the Passkey sign-in experience by providing more robust error handling, improving security by limiting API calls, and delivering a more user-friendly interface. * Refactor: Streamline 2FA flow and remove redundant Passkey button. - Separate the flow of 1FA and 2FA. - Remove duplicate passkey buttons * Fix: Add error messages to MkSignin * chore: Hide passkey button if the entered user does not use passkey login * Update CHANGELOG.md * Refactor: Rename functions and Add comments * Update locales/ja-JP.yml Co-authored-by: syuilo <4439005+syuilo@users.noreply.github.com> * Fix: Update translation - update index.d.ts - update ko-KR.yml, en-US.yml - Fix: Reflect Changed i18n key on MkSignin --------- Co-authored-by: Squarecat-meow <kw7551@gmail.com> Co-authored-by: syuilo <4439005+syuilo@users.noreply.github.com>
174 lines
5.0 KiB
TypeScript
174 lines
5.0 KiB
TypeScript
/*
|
|
* SPDX-FileCopyrightText: syuilo and misskey-project
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
|
|
import { randomUUID } from 'crypto';
|
|
import { Inject, Injectable } from '@nestjs/common';
|
|
import { IsNull } from 'typeorm';
|
|
import { DI } from '@/di-symbols.js';
|
|
import type {
|
|
SigninsRepository,
|
|
UserProfilesRepository,
|
|
UsersRepository,
|
|
} from '@/models/_.js';
|
|
import type { Config } from '@/config.js';
|
|
import { getIpHash } from '@/misc/get-ip-hash.js';
|
|
import type { MiLocalUser, MiUser } from '@/models/User.js';
|
|
import { IdService } from '@/core/IdService.js';
|
|
import { bindThis } from '@/decorators.js';
|
|
import { WebAuthnService } from '@/core/WebAuthnService.js';
|
|
import Logger from '@/logger.js';
|
|
import { LoggerService } from '@/core/LoggerService.js';
|
|
import type { IdentifiableError } from '@/misc/identifiable-error.js';
|
|
import { RateLimiterService } from './RateLimiterService.js';
|
|
import { SigninService } from './SigninService.js';
|
|
import type { AuthenticationResponseJSON } from '@simplewebauthn/types';
|
|
import type { FastifyReply, FastifyRequest } from 'fastify';
|
|
|
|
@Injectable()
|
|
export class SigninWithPasskeyApiService {
|
|
private logger: Logger;
|
|
constructor(
|
|
@Inject(DI.config)
|
|
private config: Config,
|
|
|
|
@Inject(DI.usersRepository)
|
|
private usersRepository: UsersRepository,
|
|
|
|
@Inject(DI.userProfilesRepository)
|
|
private userProfilesRepository: UserProfilesRepository,
|
|
|
|
@Inject(DI.signinsRepository)
|
|
private signinsRepository: SigninsRepository,
|
|
|
|
private idService: IdService,
|
|
private rateLimiterService: RateLimiterService,
|
|
private signinService: SigninService,
|
|
private webAuthnService: WebAuthnService,
|
|
private loggerService: LoggerService,
|
|
) {
|
|
this.logger = this.loggerService.getLogger('PasskeyAuth');
|
|
}
|
|
|
|
@bindThis
|
|
public async signin(
|
|
request: FastifyRequest<{
|
|
Body: {
|
|
credential?: AuthenticationResponseJSON;
|
|
context?: string;
|
|
};
|
|
}>,
|
|
reply: FastifyReply,
|
|
) {
|
|
reply.header('Access-Control-Allow-Origin', this.config.url);
|
|
reply.header('Access-Control-Allow-Credentials', 'true');
|
|
|
|
const body = request.body;
|
|
const credential = body['credential'];
|
|
|
|
function error(status: number, error: { id: string }) {
|
|
reply.code(status);
|
|
return { error };
|
|
}
|
|
|
|
const fail = async (userId: MiUser['id'], status?: number, failure?: { id: string }) => {
|
|
// Append signin history
|
|
await this.signinsRepository.insert({
|
|
id: this.idService.gen(),
|
|
userId: userId,
|
|
ip: request.ip,
|
|
headers: request.headers as any,
|
|
success: false,
|
|
});
|
|
return error(status ?? 500, failure ?? { id: '4e30e80c-e338-45a0-8c8f-44455efa3b76' });
|
|
};
|
|
|
|
try {
|
|
// Not more than 1 API call per 250ms and not more than 100 attempts per 30min
|
|
// NOTE: 1 Sign-in require 2 API calls
|
|
await this.rateLimiterService.limit({ key: 'signin-with-passkey', duration: 60 * 30 * 1000, max: 200, minInterval: 250 }, getIpHash(request.ip));
|
|
} catch (err) {
|
|
reply.code(429);
|
|
return {
|
|
error: {
|
|
message: 'Too many failed attempts to sign in. Try again later.',
|
|
code: 'TOO_MANY_AUTHENTICATION_FAILURES',
|
|
id: '22d05606-fbcf-421a-a2db-b32610dcfd1b',
|
|
},
|
|
};
|
|
}
|
|
|
|
// Initiate Passkey Auth challenge with context
|
|
if (!credential) {
|
|
const context = randomUUID();
|
|
this.logger.info(`Initiate Passkey challenge: context: ${context}`);
|
|
const authChallengeOptions = {
|
|
option: await this.webAuthnService.initiateSignInWithPasskeyAuthentication(context),
|
|
context: context,
|
|
};
|
|
reply.code(200);
|
|
return authChallengeOptions;
|
|
}
|
|
|
|
const context = body.context;
|
|
if (!context || typeof context !== 'string') {
|
|
// If try Authentication without context
|
|
return error(400, {
|
|
id: '1658cc2e-4495-461f-aee4-d403cdf073c1',
|
|
});
|
|
}
|
|
|
|
this.logger.debug(`Try Sign-in with Passkey: context: ${context}`);
|
|
|
|
let authorizedUserId: MiUser['id'] | null;
|
|
try {
|
|
authorizedUserId = await this.webAuthnService.verifySignInWithPasskeyAuthentication(context, credential);
|
|
} catch (err) {
|
|
this.logger.warn(`Passkey challenge Verify error! : ${err}`);
|
|
const errorId = (err as IdentifiableError).id;
|
|
return error(403, {
|
|
id: errorId,
|
|
});
|
|
}
|
|
|
|
if (!authorizedUserId) {
|
|
return error(403, {
|
|
id: '932c904e-9460-45b7-9ce6-7ed33be7eb2c',
|
|
});
|
|
}
|
|
|
|
// Fetch user
|
|
const user = await this.usersRepository.findOneBy({
|
|
id: authorizedUserId,
|
|
host: IsNull(),
|
|
}) as MiLocalUser | null;
|
|
|
|
if (user == null) {
|
|
return error(403, {
|
|
id: '652f899f-66d4-490e-993e-6606c8ec04c3',
|
|
});
|
|
}
|
|
|
|
if (user.isSuspended) {
|
|
return error(403, {
|
|
id: 'e03a5f46-d309-4865-9b69-56282d94e1eb',
|
|
});
|
|
}
|
|
|
|
const profile = await this.userProfilesRepository.findOneByOrFail({ userId: user.id });
|
|
|
|
// Authentication was successful, but passwordless login is not enabled
|
|
if (!profile.usePasswordLessLogin) {
|
|
return await fail(user.id, 403, {
|
|
id: '2d84773e-f7b7-4d0b-8f72-bb69b584c912',
|
|
});
|
|
}
|
|
|
|
const signinResponse = this.signinService.signin(request, reply, user);
|
|
return {
|
|
signinResponse: signinResponse,
|
|
};
|
|
}
|
|
}
|