1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
unleash.unleash/src/lib/routes/admin-api/user/pat.ts
Gastón Fournier 1cedd3dc33
feat: add PAT kill switch (#3454)
This PR disables PAT admin endpoints so it's not possible to create or
get PATs the kill switch is enabled, the UI is hidden but the existing
PATs will continue to work if they were created before. The delete
endpoint still works allowing an admin to delete old PATs

By default the kill switch is disabled (i.e. PAT is enabled by default)
2023-04-05 10:24:09 +02:00

126 lines
4.1 KiB
TypeScript

import { Response } from 'express';
import Controller from '../../controller';
import { Logger } from '../../../logger';
import {
IFlagResolver,
IUnleashConfig,
IUnleashServices,
} from '../../../types';
import { createRequestSchema } from '../../../openapi/util/create-request-schema';
import { createResponseSchema } from '../../../openapi/util/create-response-schema';
import { OpenApiService } from '../../../services/openapi-service';
import { emptyResponse } from '../../../openapi/util/standard-responses';
import PatService from '../../../services/pat-service';
import { NONE } from '../../../types/permissions';
import { IAuthRequest } from '../../unleash-types';
import { serializeDates } from '../../../types/serialize-dates';
import { PatSchema, patSchema } from '../../../openapi/spec/pat-schema';
import { patsSchema } from '../../../openapi/spec/pats-schema';
export default class PatController extends Controller {
private patService: PatService;
private openApiService: OpenApiService;
private logger: Logger;
private flagResolver: IFlagResolver;
constructor(
config: IUnleashConfig,
{
openApiService,
patService,
}: Pick<IUnleashServices, 'openApiService' | 'patService'>,
) {
super(config);
this.logger = config.getLogger('lib/routes/auth/pat-controller.ts');
this.flagResolver = config.flagResolver;
this.openApiService = openApiService;
this.patService = patService;
this.route({
method: 'get',
path: '',
handler: this.getPats,
permission: NONE,
middleware: [
openApiService.validPath({
tags: ['Personal access tokens'],
operationId: 'getPats',
responses: { 200: createResponseSchema('patsSchema') },
}),
],
});
this.route({
method: 'post',
path: '',
handler: this.createPat,
permission: NONE,
middleware: [
openApiService.validPath({
tags: ['Personal access tokens'],
operationId: 'createPat',
requestBody: createRequestSchema('patSchema'),
responses: { 200: createResponseSchema('patSchema') },
}),
],
});
this.route({
method: 'delete',
path: '/:id',
acceptAnyContentType: true,
handler: this.deletePat,
permission: NONE,
middleware: [
openApiService.validPath({
tags: ['Personal access tokens'],
operationId: 'deletePat',
responses: { 200: emptyResponse },
}),
],
});
}
async createPat(req: IAuthRequest, res: Response): Promise<void> {
if (this.flagResolver.isEnabled('personalAccessTokensKillSwitch')) {
res.status(404).send({ message: 'PAT is disabled' });
return;
}
const pat = req.body;
const createdPat = await this.patService.createPat(
pat,
req.user.id,
req.user,
);
this.openApiService.respondWithValidation(
201,
res,
patSchema.$id,
serializeDates(createdPat),
);
}
async getPats(req: IAuthRequest, res: Response<PatSchema>): Promise<void> {
if (this.flagResolver.isEnabled('personalAccessTokensKillSwitch')) {
res.status(404).send({ message: 'PAT is disabled' });
return;
}
const pats = await this.patService.getAll(req.user.id);
this.openApiService.respondWithValidation(200, res, patsSchema.$id, {
pats: serializeDates(pats),
});
}
async deletePat(
req: IAuthRequest<{ id: number }>,
res: Response,
): Promise<void> {
const { id } = req.params;
await this.patService.deletePat(id, req.user.id, req.user);
res.status(200).end();
}
}