-
-
Notifications
You must be signed in to change notification settings - Fork 7
/
bouncer.ts
363 lines (329 loc) · 9.97 KB
/
bouncer.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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
/*
* @adonisjs/bouncer
*
* (c) AdonisJS
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
import { inspect } from 'node:util'
import { RuntimeException } from '@poppinss/utils'
import type { EmitterLike } from '@adonisjs/core/types/events'
import { type ContainerResolver } from '@adonisjs/core/container'
import debug from './debug.js'
import { AuthorizationResponse } from './response.js'
import { E_AUTHORIZATION_FAILURE } from './errors.js'
import { ability as createAbility } from './ability.js'
import { AbilitiesBuilder } from './abilities_builder.js'
import { PolicyAuthorizer } from './policy_authorizer.js'
import type {
LazyImport,
Constructor,
BouncerEvents,
BouncerAbility,
ResponseBuilder,
UnWrapLazyImport,
BouncerAuthorizer,
AuthorizerResponse,
NarrowAbilitiesForAUser,
} from './types.js'
/**
* Bouncer exposes the API to evaluate bouncer abilities and policies to
* verify if a user is authorized to perform the given action
*/
export class Bouncer<
User extends Record<any, any>,
Abilities extends Record<string, BouncerAbility<any>> | undefined = undefined,
Policies extends Record<string, LazyImport<Constructor<any>>> | undefined = undefined,
> {
/**
* Response builder is used to normalize bouncer responses
*/
static responseBuilder: ResponseBuilder = (response) => {
return typeof response === 'boolean' ? new AuthorizationResponse(response) : response
}
/**
* Define an ability using the AbilityBuilder
*/
static define<Name extends string, Authorizer extends BouncerAuthorizer<any>>(
name: Name,
authorizer: Authorizer,
options?: { allowGuest: boolean }
) {
return new AbilitiesBuilder({}).define(name, authorizer, options)
}
/**
* Emitter to emit events
*/
static emitter?: EmitterLike<BouncerEvents>
/**
* Define a bouncer ability from a callback
*/
static ability = createAbility
/**
* User resolver to lazily resolve the user
*/
#userOrResolver: User | (() => User | null) | null
/**
* Reference to the resolved user
*/
#user?: User | null
/**
* Pre-defined abilities
*/
abilities?: Abilities
/**
* Pre-defined policies
*/
policies?: Policies
/**
* Reference to the container resolver to construct
* policy classes.
*/
#containerResolver?: ContainerResolver<any>
/**
* An object with helpers to be shared with Edge for
* performing authorization.
*/
edgeHelpers: {
bouncer: {
parent: Bouncer<User, Abilities, Policies>
can(action: string, ...args: any[]): Promise<boolean>
cannot(action: string, ...args: any[]): Promise<boolean>
}
} = {
bouncer: {
parent: this,
can(action: string, ...args: any[]) {
const [policyName, ...policyMethods] = action.split('.')
if (policyMethods.length) {
return this.parent.with(policyName as any).allows(policyMethods.join('.'), ...args)
}
return this.parent.allows(policyName as any, ...args)
},
cannot(action: string, ...args: any[]) {
const [policyName, ...policyMethods] = action.split('.')
if (policyMethods.length) {
return this.parent.with(policyName as any).denies(policyMethods.join('.'), ...args)
}
return this.parent.denies(policyName as any, ...args)
},
},
}
constructor(
userOrResolver: User | (() => User | null) | null,
abilities?: Abilities,
policies?: Policies
) {
this.#userOrResolver = userOrResolver
this.abilities = abilities
this.policies = policies
}
/**
* Returns reference to the user object
*/
#getUser() {
if (this.#user === undefined) {
if (typeof this.#userOrResolver === 'function') {
this.#user = this.#userOrResolver()
} else {
this.#user = this.#userOrResolver
}
}
return this.#user
}
/**
* Emits the event and sends normalized response
*/
#emitAndRespond(abilitiy: string, result: boolean | AuthorizationResponse, args: any[]) {
const response = Bouncer.responseBuilder(result)
if (Bouncer.emitter) {
Bouncer.emitter.emit('authorization:finished', {
user: this.#user,
action: abilitiy,
response,
parameters: args,
})
}
return response
}
/**
* Returns an instance of PolicyAuthorizer. PolicyAuthorizer is
* used to authorize user and actions using a given policy
*/
with<Policy extends keyof Policies>(
policy: Policy
): Policies extends Record<string, LazyImport<Constructor<any>>>
? PolicyAuthorizer<User, UnWrapLazyImport<Policies[Policy]>>
: never
with<Policy extends Constructor<any>>(policy: Policy): PolicyAuthorizer<User, Policy>
with<Policy extends keyof Policies & string>(policy: Policy) {
if (typeof policy !== 'function') {
/**
* Ensure the policy is pre-registered
*/
if (!this.policies || !this.policies[policy]) {
throw new RuntimeException(`Invalid bouncer policy "${inspect(policy)}"`)
}
return new PolicyAuthorizer(this.#getUser(), this.policies[policy], Bouncer.responseBuilder)
.setContainerResolver(this.#containerResolver)
.setEmitter(Bouncer.emitter)
}
return new PolicyAuthorizer(this.#getUser(), policy, Bouncer.responseBuilder)
.setContainerResolver(this.#containerResolver)
.setEmitter(Bouncer.emitter)
}
/**
* Set a container resolver to use for resolving policies
*/
setContainerResolver(containerResolver?: ContainerResolver<any>): this {
this.#containerResolver = containerResolver
return this
}
/**
* Execute an ability by reference
*/
execute<Ability extends BouncerAbility<User>>(
ability: Ability,
...args: Ability extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<AuthorizationResponse>
/**
* Execute an ability from the list of pre-defined abilities
*/
execute<Ability extends NarrowAbilitiesForAUser<User, Abilities>>(
ability: Ability,
...args: Abilities[Ability] extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<AuthorizationResponse>
async execute(ability: any, ...args: any[]): Promise<AuthorizationResponse> {
/**
* Executing ability from a pre-defined list of abilities
*/
if (this.abilities && this.abilities[ability]) {
debug('executing pre-registered ability "%s"', ability)
return this.#emitAndRespond(
ability,
await this.abilities[ability].execute(this.#getUser(), ...args),
args
)
}
/**
* Ensure value is an ability reference or throw error
*/
if (!ability || typeof ability !== 'object' || 'execute' in ability === false) {
throw new RuntimeException(`Invalid bouncer ability "${inspect(ability)}"`)
}
/**
* Executing ability by reference
*/
if (debug.enabled) {
debug('executing ability "%s"', ability.name)
}
return this.#emitAndRespond(
ability.original.name,
await (ability as BouncerAbility<User>).execute(this.#getUser(), ...args),
args
)
}
/**
* Check if a user is allowed to perform an action using
* the ability provided by reference
*/
allows<Ability extends BouncerAbility<User>>(
ability: Ability,
...args: Ability extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<boolean>
/**
* Check if a user is allowed to perform an action using
* the ability from the pre-defined list of abilities
*/
allows<Ability extends NarrowAbilitiesForAUser<User, Abilities>>(
ability: Ability,
...args: Abilities[Ability] extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<boolean>
async allows(ability: any, ...args: any[]): Promise<boolean> {
const response = await this.execute(ability, ...args)
return response.authorized
}
/**
* Check if a user is denied from performing an action using
* the ability provided by reference
*/
denies<Action extends BouncerAbility<User>>(
action: Action,
...args: Action extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<boolean>
/**
* Check if a user is denied from performing an action using
* the ability from the pre-defined list of abilities
*/
denies<Action extends NarrowAbilitiesForAUser<User, Abilities>>(
action: Action,
...args: Abilities[Action] extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<boolean>
async denies(action: any, ...args: any[]): Promise<boolean> {
const response = await this.execute(action, ...args)
return !response.authorized
}
/**
* Authorize a user against for a given ability
*
* @throws AuthorizationException
*/
authorize<Action extends BouncerAbility<User>>(
action: Action,
...args: Action extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<void>
/**
* Authorize a user against a given ability
*
* @throws {@link E_AUTHORIZATION_FAILURE}
*/
authorize<Ability extends NarrowAbilitiesForAUser<User, Abilities>>(
ability: Ability,
...args: Abilities[Ability] extends {
original: (user: User, ...args: infer Args) => AuthorizerResponse
}
? Args
: never
): Promise<void>
async authorize(ability: any, ...args: any[]): Promise<void> {
const response = await this.execute(ability, ...args)
if (!response.authorized) {
throw new E_AUTHORIZATION_FAILURE(response)
}
}
/**
* Create AuthorizationResponse to deny access
*/
deny(message: string, status?: number) {
return AuthorizationResponse.deny(message, status)
}
}