import { BadRequestException, Inject, Injectable, InternalServerErrorException, UnauthorizedException, } from '@nestjs/common'; import { isNumber, isString } from 'class-validator'; import cookieParser from 'cookie'; import { DateTime } from 'luxon'; import { IncomingHttpHeaders } from 'node:http'; import { ClientMetadata, Issuer, UserinfoResponse, custom, generators } from 'openid-client'; import { AccessCore, Permission } from 'src/cores/access.core'; import { SystemConfigCore } from 'src/cores/system-config.core'; import { UserCore } from 'src/cores/user.core'; import { AuthType, IMMICH_ACCESS_COOKIE, IMMICH_API_KEY_HEADER, IMMICH_AUTH_TYPE_COOKIE, IMMICH_IS_AUTHENTICATED, LOGIN_URL, MOBILE_REDIRECT, } from 'src/domain/auth/auth.constant'; import { AuthDeviceResponseDto, AuthDto, ChangePasswordDto, LoginCredentialDto, LoginResponseDto, LogoutResponseDto, OAuthAuthorizeResponseDto, OAuthCallbackDto, OAuthConfigDto, SignUpDto, mapLoginResponse, mapUserToken, } from 'src/domain/auth/auth.dto'; import { IAccessRepository } from 'src/domain/repositories/access.repository'; import { IKeyRepository } from 'src/domain/repositories/api-key.repository'; import { ICryptoRepository } from 'src/domain/repositories/crypto.repository'; import { ILibraryRepository } from 'src/domain/repositories/library.repository'; import { ISharedLinkRepository } from 'src/domain/repositories/shared-link.repository'; import { ISystemConfigRepository } from 'src/domain/repositories/system-config.repository'; import { IUserTokenRepository } from 'src/domain/repositories/user-token.repository'; import { IUserRepository } from 'src/domain/repositories/user.repository'; import { UserResponseDto, mapUser } from 'src/domain/user/response-dto/user-response.dto'; import { SystemConfig } from 'src/infra/entities/system-config.entity'; import { UserEntity } from 'src/infra/entities/user.entity'; import { ImmichLogger } from 'src/infra/logger'; import { HumanReadableSize } from 'src/utils'; export interface LoginDetails { isSecure: boolean; clientIp: string; deviceType: string; deviceOS: string; } interface LoginResponse { response: LoginResponseDto; cookie: string[]; } interface OAuthProfile extends UserinfoResponse { email: string; } interface ClaimOptions { key: string; default: T; isValid: (value: unknown) => boolean; } @Injectable() export class AuthService { private access: AccessCore; private configCore: SystemConfigCore; private logger = new ImmichLogger(AuthService.name); private userCore: UserCore; constructor( @Inject(IAccessRepository) accessRepository: IAccessRepository, @Inject(ICryptoRepository) private cryptoRepository: ICryptoRepository, @Inject(ISystemConfigRepository) configRepository: ISystemConfigRepository, @Inject(ILibraryRepository) libraryRepository: ILibraryRepository, @Inject(IUserRepository) private userRepository: IUserRepository, @Inject(IUserTokenRepository) private userTokenRepository: IUserTokenRepository, @Inject(ISharedLinkRepository) private sharedLinkRepository: ISharedLinkRepository, @Inject(IKeyRepository) private keyRepository: IKeyRepository, ) { this.access = AccessCore.create(accessRepository); this.configCore = SystemConfigCore.create(configRepository); this.userCore = UserCore.create(cryptoRepository, libraryRepository, userRepository); custom.setHttpOptionsDefaults({ timeout: 30_000 }); } async login(dto: LoginCredentialDto, details: LoginDetails): Promise { const config = await this.configCore.getConfig(); if (!config.passwordLogin.enabled) { throw new UnauthorizedException('Password login has been disabled'); } let user = await this.userRepository.getByEmail(dto.email, true); if (user) { const isAuthenticated = this.validatePassword(dto.password, user); if (!isAuthenticated) { user = null; } } if (!user) { this.logger.warn(`Failed login attempt for user ${dto.email} from ip address ${details.clientIp}`); throw new UnauthorizedException('Incorrect email or password'); } return this.createLoginResponse(user, AuthType.PASSWORD, details); } async logout(auth: AuthDto, authType: AuthType): Promise { if (auth.userToken) { await this.userTokenRepository.delete(auth.userToken.id); } return { successful: true, redirectUri: await this.getLogoutEndpoint(authType), }; } async changePassword(auth: AuthDto, dto: ChangePasswordDto) { const { password, newPassword } = dto; const user = await this.userRepository.getByEmail(auth.user.email, true); if (!user) { throw new UnauthorizedException(); } const valid = this.validatePassword(password, user); if (!valid) { throw new BadRequestException('Wrong password'); } return this.userCore.updateUser(auth.user, auth.user.id, { password: newPassword }); } async adminSignUp(dto: SignUpDto): Promise { const adminUser = await this.userRepository.getAdmin(); if (adminUser) { throw new BadRequestException('The server already has an admin'); } const admin = await this.userCore.createUser({ isAdmin: true, email: dto.email, name: dto.name, password: dto.password, storageLabel: 'admin', }); return mapUser(admin); } async validate(headers: IncomingHttpHeaders, params: Record): Promise { const shareKey = (headers['x-immich-share-key'] || params.key) as string; const userToken = (headers['x-immich-user-token'] || params.userToken || this.getBearerToken(headers) || this.getCookieToken(headers)) as string; const apiKey = (headers[IMMICH_API_KEY_HEADER] || params.apiKey) as string; if (shareKey) { return this.validateSharedLink(shareKey); } if (userToken) { return this.validateUserToken(userToken); } if (apiKey) { return this.validateApiKey(apiKey); } throw new UnauthorizedException('Authentication required'); } async getDevices(auth: AuthDto): Promise { const userTokens = await this.userTokenRepository.getAll(auth.user.id); return userTokens.map((userToken) => mapUserToken(userToken, auth.userToken?.id)); } async logoutDevice(auth: AuthDto, id: string): Promise { await this.access.requirePermission(auth, Permission.AUTH_DEVICE_DELETE, id); await this.userTokenRepository.delete(id); } async logoutDevices(auth: AuthDto): Promise { const devices = await this.userTokenRepository.getAll(auth.user.id); for (const device of devices) { if (device.id === auth.userToken?.id) { continue; } await this.userTokenRepository.delete(device.id); } } getMobileRedirect(url: string) { return `${MOBILE_REDIRECT}?${url.split('?')[1] || ''}`; } async authorize(dto: OAuthConfigDto): Promise { const config = await this.configCore.getConfig(); if (!config.oauth.enabled) { throw new BadRequestException('OAuth is not enabled'); } const client = await this.getOAuthClient(config); const url = client.authorizationUrl({ redirect_uri: this.normalize(config, dto.redirectUri), scope: config.oauth.scope, state: generators.state(), }); return { url }; } async callback( dto: OAuthCallbackDto, loginDetails: LoginDetails, ): Promise<{ response: LoginResponseDto; cookie: string[] }> { const config = await this.configCore.getConfig(); const profile = await this.getOAuthProfile(config, dto.url); this.logger.debug(`Logging in with OAuth: ${JSON.stringify(profile)}`); let user = await this.userRepository.getByOAuthId(profile.sub); // link existing user if (!user) { const emailUser = await this.userRepository.getByEmail(profile.email); if (emailUser) { user = await this.userRepository.update(emailUser.id, { oauthId: profile.sub }); } } const { autoRegister, defaultStorageQuota, storageLabelClaim, storageQuotaClaim } = config.oauth; // register new user if (!user) { if (!autoRegister) { this.logger.warn( `Unable to register ${profile.email}. To enable set OAuth Auto Register to true in admin settings.`, ); throw new BadRequestException(`User does not exist and auto registering is disabled.`); } this.logger.log(`Registering new user: ${profile.email}/${profile.sub}`); this.logger.verbose(`OAuth Profile: ${JSON.stringify(profile)}`); const storageLabel = this.getClaim(profile, { key: storageLabelClaim, default: '', isValid: isString, }); const storageQuota = this.getClaim(profile, { key: storageQuotaClaim, default: defaultStorageQuota, isValid: (value: unknown) => isNumber(value) && value >= 0, }); const userName = profile.name ?? `${profile.given_name || ''} ${profile.family_name || ''}`; user = await this.userCore.createUser({ name: userName, email: profile.email, oauthId: profile.sub, quotaSizeInBytes: storageQuota * HumanReadableSize.GiB || null, storageLabel: storageLabel || null, }); } return this.createLoginResponse(user, AuthType.OAUTH, loginDetails); } async link(auth: AuthDto, dto: OAuthCallbackDto): Promise { const config = await this.configCore.getConfig(); const { sub: oauthId } = await this.getOAuthProfile(config, dto.url); const duplicate = await this.userRepository.getByOAuthId(oauthId); if (duplicate && duplicate.id !== auth.user.id) { this.logger.warn(`OAuth link account failed: sub is already linked to another user (${duplicate.email}).`); throw new BadRequestException('This OAuth account has already been linked to another user.'); } return mapUser(await this.userRepository.update(auth.user.id, { oauthId })); } async unlink(auth: AuthDto): Promise { return mapUser(await this.userRepository.update(auth.user.id, { oauthId: '' })); } private async getLogoutEndpoint(authType: AuthType): Promise { if (authType !== AuthType.OAUTH) { return LOGIN_URL; } const config = await this.configCore.getConfig(); if (!config.oauth.enabled) { return LOGIN_URL; } const client = await this.getOAuthClient(config); return client.issuer.metadata.end_session_endpoint || LOGIN_URL; } private async getOAuthProfile(config: SystemConfig, url: string): Promise { const redirectUri = this.normalize(config, url.split('?')[0]); const client = await this.getOAuthClient(config); const params = client.callbackParams(url); try { const tokens = await client.callback(redirectUri, params, { state: params.state }); return client.userinfo(tokens.access_token || ''); } catch (error: Error | any) { if (error.message.includes('unexpected JWT alg received')) { this.logger.warn( [ 'Algorithm mismatch. Make sure the signing algorithm is set correctly in the OAuth settings.', 'Or, that you have specified a signing key in your OAuth provider.', ].join(' '), ); } throw error; } } private async getOAuthClient(config: SystemConfig) { const { enabled, clientId, clientSecret, issuerUrl, signingAlgorithm } = config.oauth; if (!enabled) { throw new BadRequestException('OAuth2 is not enabled'); } const metadata: ClientMetadata = { client_id: clientId, client_secret: clientSecret, response_types: ['code'], }; try { const issuer = await Issuer.discover(issuerUrl); metadata.id_token_signed_response_alg = signingAlgorithm; return new issuer.Client(metadata); } catch (error: any | AggregateError) { this.logger.error(`Error in OAuth discovery: ${error}`, error?.stack, error?.errors); throw new InternalServerErrorException(`Error in OAuth discovery: ${error}`, { cause: error }); } } private normalize(config: SystemConfig, redirectUri: string) { const isMobile = redirectUri.startsWith(MOBILE_REDIRECT); const { mobileRedirectUri, mobileOverrideEnabled } = config.oauth; if (isMobile && mobileOverrideEnabled && mobileRedirectUri) { return mobileRedirectUri; } return redirectUri; } private getBearerToken(headers: IncomingHttpHeaders): string | null { const [type, token] = (headers.authorization || '').split(' '); if (type.toLowerCase() === 'bearer') { return token; } return null; } private getCookieToken(headers: IncomingHttpHeaders): string | null { const cookies = cookieParser.parse(headers.cookie || ''); return cookies[IMMICH_ACCESS_COOKIE] || null; } async validateSharedLink(key: string | string[]): Promise { key = Array.isArray(key) ? key[0] : key; const bytes = Buffer.from(key, key.length === 100 ? 'hex' : 'base64url'); const sharedLink = await this.sharedLinkRepository.getByKey(bytes); if (sharedLink && (!sharedLink.expiresAt || new Date(sharedLink.expiresAt) > new Date())) { const user = sharedLink.user; if (user) { return { user, sharedLink }; } } throw new UnauthorizedException('Invalid share key'); } private async validateApiKey(key: string): Promise { const hashedKey = this.cryptoRepository.hashSha256(key); const apiKey = await this.keyRepository.getKey(hashedKey); if (apiKey?.user) { return { user: apiKey.user, apiKey }; } throw new UnauthorizedException('Invalid API key'); } private validatePassword(inputPassword: string, user: UserEntity): boolean { if (!user || !user.password) { return false; } return this.cryptoRepository.compareBcrypt(inputPassword, user.password); } private async validateUserToken(tokenValue: string): Promise { const hashedToken = this.cryptoRepository.hashSha256(tokenValue); let userToken = await this.userTokenRepository.getByToken(hashedToken); if (userToken?.user) { const now = DateTime.now(); const updatedAt = DateTime.fromJSDate(userToken.updatedAt); const diff = now.diff(updatedAt, ['hours']); if (diff.hours > 1) { userToken = await this.userTokenRepository.save({ ...userToken, updatedAt: new Date() }); } return { user: userToken.user, userToken }; } throw new UnauthorizedException('Invalid user token'); } private async createLoginResponse(user: UserEntity, authType: AuthType, loginDetails: LoginDetails) { const key = this.cryptoRepository.randomBytes(32).toString('base64').replaceAll(/\W/g, ''); const token = this.cryptoRepository.hashSha256(key); await this.userTokenRepository.create({ token, user, deviceOS: loginDetails.deviceOS, deviceType: loginDetails.deviceType, }); const response = mapLoginResponse(user, key); const cookie = this.getCookies(response, authType, loginDetails); return { response, cookie }; } private getCookies(loginResponse: LoginResponseDto, authType: AuthType, { isSecure }: LoginDetails) { const maxAge = 400 * 24 * 3600; // 400 days let authTypeCookie = ''; let accessTokenCookie = ''; let isAuthenticatedCookie = ''; if (isSecure) { accessTokenCookie = `${IMMICH_ACCESS_COOKIE}=${loginResponse.accessToken}; HttpOnly; Secure; Path=/; Max-Age=${maxAge}; SameSite=Lax;`; authTypeCookie = `${IMMICH_AUTH_TYPE_COOKIE}=${authType}; HttpOnly; Secure; Path=/; Max-Age=${maxAge}; SameSite=Lax;`; isAuthenticatedCookie = `${IMMICH_IS_AUTHENTICATED}=true; Secure; Path=/; Max-Age=${maxAge}; SameSite=Lax;`; } else { accessTokenCookie = `${IMMICH_ACCESS_COOKIE}=${loginResponse.accessToken}; HttpOnly; Path=/; Max-Age=${maxAge}; SameSite=Lax;`; authTypeCookie = `${IMMICH_AUTH_TYPE_COOKIE}=${authType}; HttpOnly; Path=/; Max-Age=${maxAge}; SameSite=Lax;`; isAuthenticatedCookie = `${IMMICH_IS_AUTHENTICATED}=true; Path=/; Max-Age=${maxAge}; SameSite=Lax;`; } return [accessTokenCookie, authTypeCookie, isAuthenticatedCookie]; } private getClaim(profile: OAuthProfile, options: ClaimOptions): T { const value = profile[options.key as keyof OAuthProfile]; return options.isValid(value) ? (value as T) : options.default; } }