-
Notifications
You must be signed in to change notification settings - Fork 39
/
global_permission_grant.ts
162 lines (149 loc) · 4.83 KB
/
global_permission_grant.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
import { AugmentedFastifyInstance } from "types";
import { VError } from "verror";
import Intent, { globalIntents } from "./authz/intents";
import { AuthenticatedRequest } from "./httpd/lib";
import { toHttpError } from "./http_errors";
import * as NotAuthenticated from "./http_errors/not_authenticated";
import { Ctx } from "./lib/ctx";
import { safeIdSchema } from "./lib/joiValidation";
import * as Result from "./result";
import { Identity } from "./service/domain/organization/identity";
import { ServiceUser } from "./service/domain/organization/service_user";
import Joi = require("joi");
/**
* Represents the request body of the endpoint
*/
interface RequestBodyV1 {
apiVersion: "1.0";
data: {
identity: Identity;
intent: Intent;
};
}
const requestBodyV1Schema = Joi.object({
apiVersion: Joi.valid("1.0").required(),
data: Joi.object({
identity: safeIdSchema.required(),
intent: Joi.valid(globalIntents).required(),
}).required(),
});
type RequestBody = RequestBodyV1;
const requestBodySchema = Joi.alternatives([requestBodyV1Schema]);
/**
* Validates the request body of the http request
*
* @param body the request body
* @returns the request body wrapped in a {@link Result.Type}. Contains either the object or an error
*/
function validateRequestBody(body): Result.Type<RequestBody> {
const { error, value } = Joi.validate(body, requestBodySchema);
return !error ? value : error;
}
/**
* Creates the swagger schema for the `/global.grantPermission` endpoint
*
* @param server fastify server
* @returns the swagger schema for this endpoint
*/
function mkSwaggerSchema(server: AugmentedFastifyInstance) {
return {
preValidation: [server.authenticate],
schema: {
description:
"Grant the right to execute a specific intent on the Global scope to a given user.",
tags: ["global"],
summary: "Grant a permission to a user",
security: [
{
bearerToken: [],
},
],
body: {
type: "object",
required: ["apiVersion", "data"],
properties: {
apiVersion: { type: "string", example: "1.0" },
data: {
type: "object",
required: ["identity", "intent"],
properties: {
identity: { type: "string", example: "aSmith" },
intent: { type: "string", enum: globalIntents, example: "global.createProject" },
},
},
},
},
response: {
200: {
description: "successful response",
type: "object",
properties: {
apiVersion: { type: "string", example: "1.0" },
data: { type: "object" },
},
},
401: NotAuthenticated.schema,
},
},
};
}
/**
* Interface representing the service that handles granting of global permissions
*/
interface Service {
grantGlobalPermission(
ctx: Ctx,
user: ServiceUser,
userOrganization: string,
grantee: Identity,
permission: Intent,
): Promise<Result.Type<void>>;
}
/**
* Creates an http handler that handles incoming http requests for the `/global.grantPermission` route
*
* @param server the current fastify server instance
* @param urlPrefix the prefix of the http url
* @param service the service {@link Service} object used to offer an interface to the domain logic
*/
export function addHttpHandler(
server: AugmentedFastifyInstance,
urlPrefix: string,
service: Service,
) {
server.post(`${urlPrefix}/global.grantPermission`, mkSwaggerSchema(server), (request, reply) => {
const ctx: Ctx = { requestId: request.id, source: "http" };
const user: ServiceUser = {
id: (request as AuthenticatedRequest).user.userId,
groups: (request as AuthenticatedRequest).user.groups,
address: (request as AuthenticatedRequest).user.address,
};
const userOrganization = (request as AuthenticatedRequest).user.organization;
const bodyResult = validateRequestBody(request.body);
if (Result.isErr(bodyResult)) {
const { code, body } = toHttpError(
new VError(bodyResult, "failed to grant global permission"),
);
reply.status(code).send(body);
request.log.error({ err: bodyResult }, "Invalid request body");
return;
}
const { identity: grantee, intent } = bodyResult.data;
service
.grantGlobalPermission(ctx, user, userOrganization, grantee, intent)
.then((result) => {
if (Result.isErr(result)) throw new VError(result, "global.grantPermission failed");
const code = 200;
const body = {
apiVersion: "1.0",
data: {},
};
reply.status(code).send(body);
})
.catch((err) => {
const { code, body } = toHttpError(err);
reply.status(code).send(body);
request.log.error({ err }, "Error while granting global permission");
});
});
}