diff --git a/apps/server-nestjs/src/main.module.ts b/apps/server-nestjs/src/main.module.ts index 4a03fb39d2..1e66f12ee8 100644 --- a/apps/server-nestjs/src/main.module.ts +++ b/apps/server-nestjs/src/main.module.ts @@ -21,6 +21,7 @@ import { ProjectModule } from './modules/project/project.module' import { RepositoryModule } from './modules/repository/repository.module' import { SystemConfigModule } from './modules/system-config/system-config.module' import { SystemSettingsModule } from './modules/system-settings/system-settings.module' +import { UserTokensModule } from './modules/user-tokens/user-tokens.module' import { VersionModule } from './modules/version/version.module' import { getDotenvPaths } from './utils/dotenv.utils' @@ -50,6 +51,7 @@ import { getDotenvPaths } from './utils/dotenv.utils' ScheduleModule.forRoot(), SystemConfigModule, SystemSettingsModule, + UserTokensModule, VersionModule, ], controllers: [], diff --git a/apps/server-nestjs/src/modules/admin-role/admin-role-testing.utils.ts b/apps/server-nestjs/src/modules/admin-role/admin-role-testing.utils.ts index 89bc4d85e8..1b7f74ee83 100644 --- a/apps/server-nestjs/src/modules/admin-role/admin-role-testing.utils.ts +++ b/apps/server-nestjs/src/modules/admin-role/admin-role-testing.utils.ts @@ -1,5 +1,4 @@ import type { AdminRole } from './admin-role-queries.utils' -import type { AdminRoleService } from './admin-role.service' import type { CreateAdminRoleBody, PatchAdminRolesBody } from './admin-role.utils' export function makeAdminRole(overrides: Partial = {}): AdminRole { diff --git a/apps/server-nestjs/src/modules/gitlab/gitlab.service.spec.ts b/apps/server-nestjs/src/modules/gitlab/gitlab.service.spec.ts index 33b81f4f48..4b6bc1de5a 100644 --- a/apps/server-nestjs/src/modules/gitlab/gitlab.service.spec.ts +++ b/apps/server-nestjs/src/modules/gitlab/gitlab.service.spec.ts @@ -589,7 +589,8 @@ describe('gitlabService', () => { const staleSecret = makeVaultSecret({ data: { MIRROR_USER: accessToken.name, MIRROR_TOKEN: accessToken.token }, metadata: { - created_time: faker.date.past({ years: 2 }).toISOString(), + // Birthday-style age, always decades past the 250d rotation threshold. + created_time: faker.date.birthdate({ min: 45, max: 55, mode: 'age' }).toISOString(), custom_metadata: null, deletion_time: '', destroyed: false, diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens-queries.utils.spec.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens-queries.utils.spec.ts new file mode 100644 index 0000000000..44511f6f95 --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens-queries.utils.spec.ts @@ -0,0 +1,46 @@ +import type { Prisma } from '@prisma/client' +import type { DeepMockProxy } from 'vitest-mock-extended' +import { faker } from '@faker-js/faker' +import { beforeEach, describe, expect, it } from 'vitest' +import { mockDeep } from 'vitest-mock-extended' +import { + createUserToken, + listUserTokens, + userTokenSelect, +} from './user-tokens-queries.utils' + +describe('user-tokens-queries.utils', () => { + let tx: DeepMockProxy + + beforeEach(() => { + tx = mockDeep() + }) + + describe('listUserTokens', () => { + it('scopes by userId and uses the shared select', async () => { + const userId = faker.string.uuid() + tx.personalAccessToken.findMany.mockResolvedValue([]) + + await listUserTokens(tx, userId) + + expect(tx.personalAccessToken.findMany).toHaveBeenCalledWith( + expect.objectContaining({ where: { userId }, select: userTokenSelect }), + ) + }) + }) + + describe('createUserToken', () => { + it('creates a personal access token with the provided fields', async () => { + const data = { + name: faker.word.noun(), + expirationDate: faker.date.future(), + hash: faker.string.alphanumeric(64), + userId: faker.string.uuid(), + } + + await createUserToken(tx, data) + + expect(tx.personalAccessToken.create).toHaveBeenCalledWith({ data, select: userTokenSelect }) + }) + }) +}) diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens-queries.utils.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens-queries.utils.ts new file mode 100644 index 0000000000..ba2d3e6115 --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens-queries.utils.ts @@ -0,0 +1,58 @@ +import type { Prisma } from '@prisma/client' + +export const userTokenOwnerSelect = { + id: true, + email: true, + firstName: true, + lastName: true, + type: true, +} satisfies Prisma.UserSelect + +export const userTokenSelect = { + id: true, + name: true, + lastUse: true, + expirationDate: true, + status: true, + createdAt: true, + userId: true, + owner: { + select: userTokenOwnerSelect, + }, +} satisfies Prisma.PersonalAccessTokenSelect + +export type UserTokenRecord = Prisma.PersonalAccessTokenGetPayload<{ + select: typeof userTokenSelect +}> + +export function listUserTokens(tx: Prisma.TransactionClient, userId: string) { + return tx.personalAccessToken.findMany({ + where: { userId }, + orderBy: [{ status: 'asc' }, { createdAt: 'asc' }], + select: userTokenSelect, + }) +} + +export function createUserToken(tx: Prisma.TransactionClient, data: { + name: string + expirationDate: Date + hash: string + userId: string +}) { + return tx.personalAccessToken.create({ + data: { + name: data.name, + hash: data.hash, + expirationDate: data.expirationDate, + userId: data.userId, + }, + select: userTokenSelect, + }) +} + +export function deleteUserToken(tx: Prisma.TransactionClient, where: { + id: string + userId: string +}) { + return tx.personalAccessToken.deleteMany({ where }) +} diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens.controller.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens.controller.ts new file mode 100644 index 0000000000..e4811a1d85 --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens.controller.ts @@ -0,0 +1,39 @@ +import type { UserContext } from '../infrastructure/auth/auth-user.decorator' +import type { CreatePersonalAccessTokenBody } from './user-tokens.utils' +import { Body, Controller, Delete, Get, HttpCode, HttpStatus, Inject, Param, ParseUUIDPipe, Post, UseGuards } from '@nestjs/common' +import { AuthUser } from '../infrastructure/auth/auth-user.decorator' +import { RequireUserType } from '../infrastructure/permission/user/user-type.decorator' +import { UserGuard } from '../infrastructure/permission/user/user.guard' +import { ZodValidationPipe } from '../infrastructure/pipe/zod-validation.pipe' +import { UserTokensService } from './user-tokens.service' +import { CreatePersonalAccessTokenBodySchema } from './user-tokens.utils' + +@Controller('api/v1/user/tokens') +@UseGuards(UserGuard) +@RequireUserType('human') +export class UserTokensController { + constructor(@Inject(UserTokensService) private readonly service: UserTokensService) {} + + @Get() + async list(@AuthUser() user: UserContext) { + return this.service.list(user.userId) + } + + @Post() + @HttpCode(HttpStatus.CREATED) + async create( + @Body(new ZodValidationPipe(CreatePersonalAccessTokenBodySchema)) data: CreatePersonalAccessTokenBody, + @AuthUser() user: UserContext, + ) { + return this.service.create(data, user.userId) + } + + @Delete(':tokenId') + @HttpCode(HttpStatus.NO_CONTENT) + async delete( + @Param('tokenId', ParseUUIDPipe) tokenId: string, + @AuthUser() user: UserContext, + ): Promise { + return this.service.delete(tokenId, user.userId) + } +} diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens.module.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens.module.ts new file mode 100644 index 0000000000..bb068669d7 --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens.module.ts @@ -0,0 +1,14 @@ +import { Module } from '@nestjs/common' +import { AuthModule } from '../infrastructure/auth/auth.module' +import { DatabaseModule } from '../infrastructure/database/database.module' +import { UserPermissionModule } from '../infrastructure/permission/user/user.module' +import { UserTokensController } from './user-tokens.controller' +import { UserTokensService } from './user-tokens.service' + +@Module({ + imports: [AuthModule, DatabaseModule, UserPermissionModule], + controllers: [UserTokensController], + providers: [UserTokensService], + exports: [UserTokensService], +}) +export class UserTokensModule {} diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens.service.spec.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens.service.spec.ts new file mode 100644 index 0000000000..9547729b1f --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens.service.spec.ts @@ -0,0 +1,149 @@ +import type { TestingModule } from '@nestjs/testing' +import type { DeepMockProxy } from 'vitest-mock-extended' +import { faker } from '@faker-js/faker' +import { Test } from '@nestjs/testing' +import { beforeEach, describe, expect, it } from 'vitest' +import { mockDeep } from 'vitest-mock-extended' +import { PrismaService } from '../infrastructure/database/prisma.service' +import { userTokenSelect } from './user-tokens-queries.utils' +import { UserTokensService } from './user-tokens.service' +import { CreatePersonalAccessTokenBodySchema } from './user-tokens.utils' + +describe('userTokensService', () => { + let module: TestingModule + let service: UserTokensService + let prisma: DeepMockProxy + + beforeEach(async () => { + prisma = mockDeep() + + module = await Test.createTestingModule({ + providers: [ + UserTokensService, + { provide: PrismaService, useValue: prisma }, + ], + }).compile() + + service = module.get(UserTokensService) + }) + + describe('list', () => { + it('returns user tokens ordered by status then creation date', async () => { + const userId = faker.string.uuid() + const tokenId = faker.string.uuid() + prisma.personalAccessToken.findMany.mockResolvedValue([{ + id: tokenId, + name: faker.word.noun(), + lastUse: null, + expirationDate: faker.date.future(), + status: 'active' as const, + createdAt: faker.date.past(), + userId, + hash: faker.string.alphanumeric(64), + }]) + + const result = await service.list(userId) + + expect(prisma.personalAccessToken.findMany).toHaveBeenCalledWith( + expect.objectContaining({ + where: { userId }, + orderBy: [{ status: 'asc' }, { createdAt: 'asc' }], + }), + ) + expect(result).toHaveLength(1) + expect(result[0].id).toBe(tokenId) + }) + + it('selects only exposed token fields', async () => { + const userId = faker.string.uuid() + prisma.personalAccessToken.findMany.mockResolvedValue([]) + + await service.list(userId) + + expect(prisma.personalAccessToken.findMany).toHaveBeenCalledWith( + expect.objectContaining({ select: userTokenSelect }), + ) + }) + }) + + describe('create', () => { + it('rejects a non-parseable expirationDate via the body schema', () => { + const name = faker.word.noun() + const result = CreatePersonalAccessTokenBodySchema.safeParse({ name, expirationDate: 'not-a-date' }) + expect(result.success).toBe(false) + }) + + it('rejects an expirationDate that is too soon via the body schema', () => { + const name = faker.word.noun() + const today = faker.date.recent() + const result = CreatePersonalAccessTokenBodySchema.safeParse({ name, expirationDate: today.toISOString() }) + expect(result.success).toBe(false) + }) + + it('returns created token with plaintext password', async () => { + const userId = faker.string.uuid() + const tokenId = faker.string.uuid() + const tokenName = faker.word.noun() + prisma.personalAccessToken.create.mockResolvedValue({ + id: tokenId, + name: tokenName, + lastUse: null, + expirationDate: faker.date.future(), + status: 'active' as const, + createdAt: faker.date.past(), + userId, + hash: faker.string.alphanumeric(64), + }) + + const result = await service.create({ name: tokenName, expirationDate: faker.date.future() }, userId) + + expect(prisma.personalAccessToken.create).toHaveBeenCalledWith( + expect.objectContaining({ + data: expect.objectContaining({ + userId, + name: tokenName, + }), + select: userTokenSelect, + }), + ) + expect(result.id).toBe(tokenId) + expect(result.password).toBeTruthy() + }) + + it('rejects an expirationDate that is not at least tomorrow', async () => { + const userId = faker.string.uuid() + const tokenName = faker.word.noun() + + await expect( + service.create({ name: tokenName, expirationDate: faker.date.past() }, userId), + ).rejects.toThrow('Date d\'expiration trop courte') + expect(prisma.personalAccessToken.create).not.toHaveBeenCalled() + }) + }) + + describe('delete', () => { + it('deletes token scoped to its owner in a single atomic call', async () => { + const tokenId = faker.string.uuid() + const userId = faker.string.uuid() + prisma.personalAccessToken.deleteMany.mockResolvedValue({ count: 1 }) + + await service.delete(tokenId, userId) + + expect(prisma.personalAccessToken.deleteMany).toHaveBeenCalledWith({ + where: { id: tokenId, userId }, + }) + }) + + it('no-ops (count 0) when token is missing or belongs to another user', async () => { + const tokenId = faker.string.uuid() + const userId = faker.string.uuid() + prisma.personalAccessToken.deleteMany.mockResolvedValue({ count: 0 }) + + await service.delete(tokenId, userId) + + expect(prisma.personalAccessToken.deleteMany).toHaveBeenCalledWith({ + where: { id: tokenId, userId }, + }) + }) + }) +}) diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens.service.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens.service.ts new file mode 100644 index 0000000000..78a446bb23 --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens.service.ts @@ -0,0 +1,79 @@ +import type { CreatePersonalAccessTokenBody } from './user-tokens.utils' +import { isAtLeastTomorrow } from '@cpn-console/shared' +import { BadRequestException, Inject, Injectable, Logger } from '@nestjs/common' +import { trace } from '@opentelemetry/api' +import { generateTokenPair } from '../../utils/crypto.utils' +import { PrismaService } from '../infrastructure/database/prisma.service' +import { StartActiveSpan } from '../infrastructure/telemetry/telemetry.decorator' +import { createUserToken, deleteUserToken, listUserTokens } from './user-tokens-queries.utils' + +@Injectable() +export class UserTokensService { + private readonly logger = new Logger(UserTokensService.name) + + constructor(@Inject(PrismaService) private readonly prisma: PrismaService) {} + + @StartActiveSpan() + async list(userId: string) { + const span = trace.getActiveSpan() + span?.setAttribute('userTokens.list.userId', userId) + this.logger.log(`userTokens.list requested (userId=${userId})`) + + const tokens = await listUserTokens(this.prisma, userId) + + span?.setAttribute('userTokens.list.count', tokens.length) + this.logger.log(`userTokens.list completed (userId=${userId}, count=${tokens.length})`) + return tokens + } + + @StartActiveSpan() + async create(data: CreatePersonalAccessTokenBody, userId: string) { + const span = trace.getActiveSpan() + span?.setAttribute('userTokens.create.name', data.name) + span?.setAttribute('userTokens.create.userId', userId) + this.logger.log(`userTokens.create started (tokenName=${data.name}, userId=${userId})`) + + if (!isAtLeastTomorrow(data.expirationDate)) { + throw new BadRequestException('Date d\'expiration trop courte') + } + + try { + const { password, hash } = generateTokenPair() + + const token = await createUserToken(this.prisma, { + ...data, + hash, + userId, + }) + + span?.setAttribute('userTokens.create.tokenId', token.id) + this.logger.log(`userTokens.create completed (tokenId=${token.id}, userId=${userId})`) + return { + ...token, + password, + } + } catch (error) { + this.logger.error( + `userTokens.create failed (tokenName=${data.name}, userId=${userId}): ${error instanceof Error ? error.message : String(error)}`, + error instanceof Error ? error.stack : undefined, + ) + throw error + } + } + + @StartActiveSpan() + async delete(tokenId: string, userId: string): Promise { + const span = trace.getActiveSpan() + span?.setAttribute('userTokens.delete.tokenId', tokenId) + span?.setAttribute('userTokens.delete.userId', userId) + this.logger.log(`userTokens.delete started (tokenId=${tokenId}, userId=${userId})`) + + const { count } = await deleteUserToken(this.prisma, { id: tokenId, userId }) + + if (count > 0) { + this.logger.log(`userTokens.delete completed (tokenId=${tokenId})`) + } else { + this.logger.log(`userTokens.delete skipped (tokenId=${tokenId}, reason=notFoundOrNotOwner)`) + } + } +} diff --git a/apps/server-nestjs/src/modules/user-tokens/user-tokens.utils.ts b/apps/server-nestjs/src/modules/user-tokens/user-tokens.utils.ts new file mode 100644 index 0000000000..80ed512b32 --- /dev/null +++ b/apps/server-nestjs/src/modules/user-tokens/user-tokens.utils.ts @@ -0,0 +1,11 @@ +import { isAtLeastTomorrow, PersonalAccessTokenSchema } from '@cpn-console/shared' +import { z } from 'zod' + +export const ExpirationDateSchema = z.coerce.date() + .refine(value => isAtLeastTomorrow(value), { message: 'Date d\'expiration trop courte' }) + +export const CreatePersonalAccessTokenBodySchema = PersonalAccessTokenSchema + .pick({ name: true, expirationDate: true }) + .extend({ expirationDate: ExpirationDateSchema }) + .required() +export type CreatePersonalAccessTokenBody = z.infer diff --git a/apps/server-nestjs/test/user-tokens.e2e-spec.ts b/apps/server-nestjs/test/user-tokens.e2e-spec.ts new file mode 100644 index 0000000000..bae4d48beb --- /dev/null +++ b/apps/server-nestjs/test/user-tokens.e2e-spec.ts @@ -0,0 +1,182 @@ +import type { TestingModule } from '@nestjs/testing' +import { createHash } from 'node:crypto' +import { faker } from '@faker-js/faker' +import { ConfigModule } from '@nestjs/config' +import { Test } from '@nestjs/testing' +import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest' +import { baseConfigFactory } from '../src/config/base.config' +import { AuthModule } from '../src/modules/infrastructure/auth/auth.module' +import { DatabaseModule } from '../src/modules/infrastructure/database/database.module' +import { PrismaService } from '../src/modules/infrastructure/database/prisma.service' +import { LoggerModule } from '../src/modules/infrastructure/logger/logger.module' +import { PermissionModule } from '../src/modules/infrastructure/permission/permission.module' +import { UserTokensModule } from '../src/modules/user-tokens/user-tokens.module' +import { UserTokensService } from '../src/modules/user-tokens/user-tokens.service' +import { getDotenvPaths } from '../src/utils/dotenv.utils' + +const canRunUserTokensE2E = Boolean(process.env.E2E) + +const describeWithUserTokens = describe.runIf(canRunUserTokensE2E) + +describeWithUserTokens('UserTokensService (e2e)', () => { + let moduleRef: TestingModule + let service: UserTokensService + let prisma: PrismaService + + const createdTokenIds: string[] = [] + const createdUserIds: string[] = [] + let ownerId: string + let otherUserId: string + + beforeAll(async () => { + moduleRef = await Test.createTestingModule({ + imports: [ConfigModule.forRoot({ envFilePath: getDotenvPaths(), isGlobal: true, load: [baseConfigFactory] }), AuthModule, DatabaseModule, LoggerModule, PermissionModule, UserTokensModule], + }).compile() + + await moduleRef.init() + + service = moduleRef.get(UserTokensService) + prisma = moduleRef.get(PrismaService) + + ownerId = faker.string.uuid() + otherUserId = faker.string.uuid() + + await prisma.user.create({ + data: { + id: ownerId, + email: faker.internet.email().toLowerCase(), + firstName: faker.person.firstName(), + lastName: faker.person.lastName(), + type: 'human', + adminRoleIds: [], + }, + }) + createdUserIds.push(ownerId) + + await prisma.user.create({ + data: { + id: otherUserId, + email: faker.internet.email().toLowerCase(), + firstName: faker.person.firstName(), + lastName: faker.person.lastName(), + type: 'human', + adminRoleIds: [], + }, + }) + createdUserIds.push(otherUserId) + }) + + afterAll(async () => { + if (prisma) { + await prisma.personalAccessToken.deleteMany({ where: { id: { in: createdTokenIds } } }).catch(() => {}) + await prisma.user.deleteMany({ where: { id: { in: createdUserIds } } }).catch(() => {}) + } + + await moduleRef?.close() + vi.restoreAllMocks() + vi.unstubAllEnvs() + }) + + it('should create a personal access token with plaintext password', async () => { + const result = await service.create({ + name: faker.helpers.slugify(`e2e-pat-${faker.string.uuid()}`), + expirationDate: faker.date.future(), + }, ownerId) + + expect(result.id).toBeTruthy() + expect(result.password).toBeTruthy() + expect(result.password.length).toBe(48) + expect(result.name).toBeTruthy() + expect(result.expirationDate).toBeTruthy() + + createdTokenIds.push(result.id) + }) + + it('should list only tokens for the requesting user', async () => { + const tokenName = faker.helpers.slugify(`e2e-pat-list-${faker.string.uuid()}`) + const created = await service.create({ + name: tokenName, + expirationDate: faker.date.future(), + }, ownerId) + createdTokenIds.push(created.id) + + const otherTokenName = faker.helpers.slugify(`e2e-pat-other-${faker.string.uuid()}`) + const otherToken = await service.create({ + name: otherTokenName, + expirationDate: faker.date.future(), + }, otherUserId) + createdTokenIds.push(otherToken.id) + + const userTokens = await service.list(ownerId) + expect(userTokens.some(t => t.id === created.id)).toBe(true) + expect(userTokens.some(t => t.id === otherToken.id)).toBe(false) + }) + + it('should hard-delete token and remove it from list', async () => { + const created = await service.create({ + name: faker.helpers.slugify(`e2e-pat-delete-${faker.string.uuid()}`), + expirationDate: faker.date.future(), + }, ownerId) + createdTokenIds.push(created.id) + + await service.delete(created.id, ownerId) + + const userTokens = await service.list(ownerId) + expect(userTokens.some(t => t.id === created.id)).toBe(false) + + const stored = await prisma.personalAccessToken.findUnique({ where: { id: created.id } }) + expect(stored).toBeNull() + }) + + it('should not delete another user\'s token', async () => { + const otherToken = await service.create({ + name: faker.helpers.slugify(`e2e-pat-foreign-${faker.string.uuid()}`), + expirationDate: faker.date.future(), + }, otherUserId) + createdTokenIds.push(otherToken.id) + + await service.delete(otherToken.id, ownerId) + + const stored = await prisma.personalAccessToken.findUnique({ where: { id: otherToken.id } }) + expect(stored).not.toBeNull() + }) + + it('should reject creation with expiration date in the past', async () => { + const yesterday = faker.date.past() + await expect(service.create({ + name: faker.helpers.slugify(`e2e-pat-expired-${faker.string.uuid()}`), + expirationDate: yesterday, + }, ownerId)).rejects.toThrow('Date d\'expiration trop courte') + }) + + it('should persist SHA256 hash of the password in DB', async () => { + const created = await service.create({ + name: faker.helpers.slugify(`e2e-pat-hash-${faker.string.uuid()}`), + expirationDate: faker.date.future(), + }, ownerId) + createdTokenIds.push(created.id) + + const stored = await prisma.personalAccessToken.findUniqueOrThrow({ + where: { id: created.id }, + select: { hash: true }, + }) + + const expectedHash = createHash('sha256').update(created.password).digest('hex') + expect(stored.hash).toBe(expectedHash) + }) + + it('should omit hash from API responses', async () => { + const created = await service.create({ + name: faker.helpers.slugify(`e2e-pat-omit-${faker.string.uuid()}`), + expirationDate: faker.date.future(), + }, ownerId) + createdTokenIds.push(created.id) + + expect(created).not.toHaveProperty('hash') + + const listed = await service.list(ownerId) + const found = listed.find(t => t.id === created.id) + expect(found).toBeTruthy() + expect(found).not.toHaveProperty('hash') + }) +})