@nmnmcc/ability 0.2.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +462 -454
- package/dist/Authorizer.d.ts +241 -0
- package/dist/Authorizer.d.ts.map +1 -0
- package/dist/Authorizer.js +340 -0
- package/dist/Authorizer.js.map +1 -0
- package/dist/Condition.d.ts +915 -0
- package/dist/Condition.d.ts.map +1 -0
- package/dist/Condition.js +1123 -0
- package/dist/Condition.js.map +1 -0
- package/dist/Decision.d.ts +131 -0
- package/dist/Decision.d.ts.map +1 -0
- package/dist/Decision.js +83 -0
- package/dist/Decision.js.map +1 -0
- package/dist/Domain.d.ts +158 -0
- package/dist/Domain.d.ts.map +1 -0
- package/dist/Domain.js +76 -0
- package/dist/Domain.js.map +1 -0
- package/dist/HttpApi.d.ts +173 -0
- package/dist/HttpApi.d.ts.map +1 -0
- package/dist/HttpApi.js +185 -0
- package/dist/HttpApi.js.map +1 -0
- package/dist/Policy.d.ts +687 -0
- package/dist/Policy.d.ts.map +1 -0
- package/dist/Policy.js +1339 -0
- package/dist/Policy.js.map +1 -0
- package/dist/Principal.d.ts +35 -0
- package/dist/Principal.d.ts.map +1 -0
- package/dist/Principal.js +37 -0
- package/dist/Principal.js.map +1 -0
- package/dist/Resource.d.ts +364 -0
- package/dist/Resource.d.ts.map +1 -0
- package/dist/Resource.js +844 -0
- package/dist/Resource.js.map +1 -0
- package/dist/Rule.d.ts +275 -0
- package/dist/Rule.d.ts.map +1 -0
- package/dist/Rule.js +257 -0
- package/dist/Rule.js.map +1 -0
- package/dist/_virtual/_rolldown/runtime.js +1 -2
- package/dist/index.d.ts +9 -3
- package/dist/index.js +9 -3
- package/package.json +61 -72
- package/src/Authorizer.ts +894 -0
- package/src/Condition.ts +2997 -0
- package/src/Decision.ts +117 -0
- package/src/Domain.ts +246 -0
- package/src/HttpApi.ts +348 -0
- package/src/Policy.ts +3315 -0
- package/src/Principal.ts +41 -0
- package/src/Resource.ts +1805 -0
- package/src/Rule.ts +683 -0
- package/src/index.ts +57 -0
- package/dist/Ability.d.ts +0 -491
- package/dist/Ability.js +0 -207
- package/dist/AbilityExtra.d.ts +0 -79
- package/dist/AbilityExtra.js +0 -187
- package/dist/internal/ability.d.ts +0 -90
- package/dist/internal/ability.js +0 -550
- package/dist/internal/serializable.js +0 -22
|
@@ -0,0 +1,241 @@
|
|
|
1
|
+
import { Condition, Opaque } from "./Condition.js";
|
|
2
|
+
import { Any, CommonAction, Kind, Principal } from "./Domain.js";
|
|
3
|
+
import { Decision } from "./Decision.js";
|
|
4
|
+
import { Coverage, FieldlessTarget, KindRequest, KindTarget, Policy, Request, ResidualReads, Target as Target$1 } from "./Policy.js";
|
|
5
|
+
import * as Context from "effect/Context";
|
|
6
|
+
import * as Effect from "effect/Effect";
|
|
7
|
+
import * as Layer from "effect/Layer";
|
|
8
|
+
import * as Schema from "effect/Schema";
|
|
9
|
+
import * as Duration from "effect/Duration";
|
|
10
|
+
declare namespace Authorizer_d_exports {
|
|
11
|
+
export { AnyServiceClass, Authorizer, Config, DeciderRequest, Forbidden, GuardOptions, Options, Pending, PolicyUnavailable, Service, ServiceClass, Target, layer };
|
|
12
|
+
}
|
|
13
|
+
declare const Forbidden_base: Schema.Class<Forbidden, Schema.TaggedStruct<"Forbidden", {
|
|
14
|
+
readonly action: Schema.String;
|
|
15
|
+
readonly kind: Schema.String;
|
|
16
|
+
readonly field: Schema.optionalKey<Schema.String>;
|
|
17
|
+
readonly reason: Schema.optionalKey<Schema.String>;
|
|
18
|
+
}>, import("effect/Cause").YieldableError>;
|
|
19
|
+
/**
|
|
20
|
+
* The error when a policy says no.
|
|
21
|
+
*
|
|
22
|
+
* @stability stable
|
|
23
|
+
* @category errors
|
|
24
|
+
* @since 0.3.0
|
|
25
|
+
*/
|
|
26
|
+
export declare class Forbidden extends Forbidden_base {}
|
|
27
|
+
declare const PolicyUnavailable_base: Schema.Class<PolicyUnavailable, Schema.TaggedStruct<"PolicyUnavailable", {
|
|
28
|
+
readonly cause: Schema.Defect;
|
|
29
|
+
}>, import("effect/Cause").YieldableError>;
|
|
30
|
+
/**
|
|
31
|
+
* The error when the policy of the principal can not be loaded. The cause is
|
|
32
|
+
* kept, but it is not shown to the client.
|
|
33
|
+
*
|
|
34
|
+
* @stability stable
|
|
35
|
+
* @category errors
|
|
36
|
+
* @since 0.3.0
|
|
37
|
+
*/
|
|
38
|
+
export declare class PolicyUnavailable extends PolicyUnavailable_base {}
|
|
39
|
+
declare const Pending_base: Schema.Class<Pending, Schema.TaggedStruct<"Pending", {
|
|
40
|
+
readonly ticket: Schema.String;
|
|
41
|
+
readonly reason: Schema.optionalKey<Schema.String>;
|
|
42
|
+
}>, import("effect/Cause").YieldableError>;
|
|
43
|
+
/**
|
|
44
|
+
* The error when a decider must wait for an answer. `ticket` names the
|
|
45
|
+
* request that waits, so the client can come back for the answer.
|
|
46
|
+
*
|
|
47
|
+
* @stability stable
|
|
48
|
+
* @category errors
|
|
49
|
+
* @since 0.3.0
|
|
50
|
+
*/
|
|
51
|
+
export declare class Pending extends Pending_base {}
|
|
52
|
+
/**
|
|
53
|
+
* The services and the errors of the principal and the decider of an
|
|
54
|
+
* authorizer.
|
|
55
|
+
*
|
|
56
|
+
* @stability stable
|
|
57
|
+
* @category models
|
|
58
|
+
* @since 0.3.0
|
|
59
|
+
*/
|
|
60
|
+
export interface Config {
|
|
61
|
+
readonly requires?: unknown;
|
|
62
|
+
readonly error?: unknown;
|
|
63
|
+
}
|
|
64
|
+
type RequiresOf<C> = C extends {
|
|
65
|
+
readonly requires: infer R;
|
|
66
|
+
} ? R : never;
|
|
67
|
+
type ErrorOf<C> = C extends {
|
|
68
|
+
readonly error: infer E;
|
|
69
|
+
} ? E : never;
|
|
70
|
+
/**
|
|
71
|
+
* What a check is about: an act on a resource value, or an act on a kind of
|
|
72
|
+
* resource. A check on a kind passes only when the policy allows the act on
|
|
73
|
+
* every value of the kind. With a scope (`within`), it passes when the policy
|
|
74
|
+
* allows the act on every value in the scope, and the scope is not empty.
|
|
75
|
+
*
|
|
76
|
+
* @stability stable
|
|
77
|
+
* @category models
|
|
78
|
+
* @since 0.3.0
|
|
79
|
+
*/
|
|
80
|
+
export type Target<D> = Target$1<D> | KindTarget<D>;
|
|
81
|
+
/**
|
|
82
|
+
* A request to the decider.
|
|
83
|
+
*
|
|
84
|
+
* @stability stable
|
|
85
|
+
* @category models
|
|
86
|
+
* @since 0.3.0
|
|
87
|
+
*/
|
|
88
|
+
export type DeciderRequest<D> = Request<D> | KindRequest<D>;
|
|
89
|
+
/**
|
|
90
|
+
* The options of a guard.
|
|
91
|
+
*
|
|
92
|
+
* @stability stable
|
|
93
|
+
* @category models
|
|
94
|
+
* @since 0.3.0
|
|
95
|
+
*/
|
|
96
|
+
export type GuardOptions<D, E2, K extends string = Kind<D>> = {
|
|
97
|
+
/** The error when the principal may not see the resource. */
|
|
98
|
+
readonly hide: () => E2;
|
|
99
|
+
} & ("read" extends CommonAction<D, K> ? {
|
|
100
|
+
/**
|
|
101
|
+
* The action that lets the principal see the resource. It must be an
|
|
102
|
+
* action of every kind in `K`. The default is `"read"`.
|
|
103
|
+
*/
|
|
104
|
+
readonly read?: CommonAction<D, K>;
|
|
105
|
+
} : {
|
|
106
|
+
/**
|
|
107
|
+
* The action that lets the principal see the resource. It must be an
|
|
108
|
+
* action of every kind in `K`. Some kind in `K` has no `"read"`
|
|
109
|
+
* action, so you must give it.
|
|
110
|
+
*/
|
|
111
|
+
readonly read: CommonAction<D, K>;
|
|
112
|
+
});
|
|
113
|
+
/**
|
|
114
|
+
* The service.
|
|
115
|
+
*
|
|
116
|
+
* @stability stable
|
|
117
|
+
* @category models
|
|
118
|
+
* @since 0.3.0
|
|
119
|
+
*/
|
|
120
|
+
export interface Authorizer<D extends Any, E, R> {
|
|
121
|
+
readonly domain: D;
|
|
122
|
+
/** The principal of the current request. */
|
|
123
|
+
readonly principal: Effect.Effect<Principal<D>, E, R>;
|
|
124
|
+
/**
|
|
125
|
+
* The policy of the principal of the current request. Its predicates have
|
|
126
|
+
* the services of the layer. It may have predicates, so it is opaque.
|
|
127
|
+
*/
|
|
128
|
+
readonly policy: Effect.Effect<Policy<D, E, never, Opaque>, PolicyUnavailable | E, R>;
|
|
129
|
+
/** Gives the decision of the policy. It does not ask the decider. */
|
|
130
|
+
readonly decide: (target: Target$1<D>) => Effect.Effect<Decision, PolicyUnavailable | E, R>;
|
|
131
|
+
/** Succeeds when the principal may do the act, and fails when it may not. */
|
|
132
|
+
readonly check: (target: Target<D>) => Effect.Effect<void, Forbidden | Pending | PolicyUnavailable | E, R>;
|
|
133
|
+
/**
|
|
134
|
+
* Checks the read action first, and fails with the error of `hide` when the
|
|
135
|
+
* principal may not see the resource. Then it checks the act. Use it to
|
|
136
|
+
* answer "not found" to a principal that may not know that a resource
|
|
137
|
+
* exists.
|
|
138
|
+
*/
|
|
139
|
+
readonly guard: <const T extends Target$1<D>, E2>(target: T, options: GuardOptions<D, E2, T["resource"]["_tag"]>) => Effect.Effect<void, E2 | Forbidden | Pending | PolicyUnavailable | E, R>;
|
|
140
|
+
/**
|
|
141
|
+
* Gives the condition on resource values that the principal may act on,
|
|
142
|
+
* inside the scope of the target when it has one. Change it into a query
|
|
143
|
+
* with `Condition.fold`. It is `False` when the principal may act on no
|
|
144
|
+
* value, so the list is empty: it is not an error.
|
|
145
|
+
*/
|
|
146
|
+
readonly filter: <const T extends KindTarget<D>>(target: T) => Effect.Effect<Condition<E, never, Opaque, ResidualReads<D, T["kind"]>>, PolicyUnavailable | E, R>;
|
|
147
|
+
/**
|
|
148
|
+
* Tells if the principal may act on all, none or some of the values in
|
|
149
|
+
* the scope of the target. See `Policy.coverage`. Use it to show a button
|
|
150
|
+
* only when the answer is not `None`.
|
|
151
|
+
*/
|
|
152
|
+
readonly coverage: <const T extends KindTarget<D>>(target: T) => Effect.Effect<Coverage<E, never, Opaque, ResidualReads<D, T["kind"]>>, PolicyUnavailable | E, R>;
|
|
153
|
+
/** Gives the fields of a value that the principal may use. */
|
|
154
|
+
readonly permittedFields: (target: FieldlessTarget<D>) => Effect.Effect<ReadonlyArray<string>, PolicyUnavailable | E, R>;
|
|
155
|
+
/**
|
|
156
|
+
* Removes the cached policy of a principal, or of every principal. Call it
|
|
157
|
+
* after a change to the rules or roles of a principal.
|
|
158
|
+
*/
|
|
159
|
+
readonly invalidate: (principal?: Principal<D>) => Effect.Effect<void>;
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* The class made by {@link Service}. The static functions use the service
|
|
163
|
+
* from the context.
|
|
164
|
+
*
|
|
165
|
+
* @stability stable
|
|
166
|
+
* @category models
|
|
167
|
+
* @since 0.3.0
|
|
168
|
+
*/
|
|
169
|
+
export interface ServiceClass<Self, Id extends string, D extends Any, E, R> extends Context.ServiceClass<Self, Id, Authorizer<D, E, R>> {
|
|
170
|
+
readonly domain: D;
|
|
171
|
+
readonly decide: (target: Target$1<D>) => Effect.Effect<Decision, PolicyUnavailable | E, R | Self>;
|
|
172
|
+
readonly check: (target: Target<D>) => Effect.Effect<void, Forbidden | Pending | PolicyUnavailable | E, R | Self>;
|
|
173
|
+
readonly guard: <const T extends Target$1<D>, E2>(target: T, options: GuardOptions<D, E2, T["resource"]["_tag"]>) => Effect.Effect<void, E2 | Forbidden | Pending | PolicyUnavailable | E, R | Self>;
|
|
174
|
+
readonly filter: <const T extends KindTarget<D>>(target: T) => Effect.Effect<Condition<E, never, Opaque, ResidualReads<D, T["kind"]>>, PolicyUnavailable | E, R | Self>;
|
|
175
|
+
readonly coverage: <const T extends KindTarget<D>>(target: T) => Effect.Effect<Coverage<E, never, Opaque, ResidualReads<D, T["kind"]>>, PolicyUnavailable | E, R | Self>;
|
|
176
|
+
readonly permittedFields: (target: FieldlessTarget<D>) => Effect.Effect<ReadonlyArray<string>, PolicyUnavailable | E, R | Self>;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
* Any service class made by {@link Service}.
|
|
180
|
+
*
|
|
181
|
+
* @stability stable
|
|
182
|
+
* @category models
|
|
183
|
+
* @since 0.3.0
|
|
184
|
+
*/
|
|
185
|
+
export type AnyServiceClass = Context.Key<any, any> & {
|
|
186
|
+
readonly domain: Any;
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Makes an authorizer service class for a domain.
|
|
190
|
+
*
|
|
191
|
+
* @stability stable
|
|
192
|
+
* @category constructors
|
|
193
|
+
* @since 0.3.0
|
|
194
|
+
*/
|
|
195
|
+
export declare const Service: <Self, C extends Config = {}>() => <const Id extends string, D extends Any>(id: Id, domain: D) => ServiceClass<Self, Id, D, ErrorOf<C>, RequiresOf<C>>;
|
|
196
|
+
/**
|
|
197
|
+
* The options of {@link layer}.
|
|
198
|
+
*
|
|
199
|
+
* @stability stable
|
|
200
|
+
* @category models
|
|
201
|
+
* @since 0.3.0
|
|
202
|
+
*/
|
|
203
|
+
export interface Options<D extends Any, E, R, EL, RL, RP> {
|
|
204
|
+
/** Gives the principal of the current request. */
|
|
205
|
+
readonly principal: Effect.Effect<Principal<D>, E, R>;
|
|
206
|
+
/**
|
|
207
|
+
* Loads the policy of a principal. A failure becomes
|
|
208
|
+
* {@link PolicyUnavailable}. The services of the predicates of the policy
|
|
209
|
+
* are taken when the layer is built.
|
|
210
|
+
*/
|
|
211
|
+
readonly policy: (principal: Principal<D>) => Effect.Effect<Policy<D, E, RP, any>, EL, RL>;
|
|
212
|
+
/**
|
|
213
|
+
* Answers when no rule gives an answer. Without a decider, such a request
|
|
214
|
+
* fails with {@link Forbidden}.
|
|
215
|
+
*/
|
|
216
|
+
readonly decider?: (request: DeciderRequest<D>) => Effect.Effect<Decision, Pending | E, R>;
|
|
217
|
+
/**
|
|
218
|
+
* How the policies are kept. The default keeps 1000 policies for 30 seconds.
|
|
219
|
+
* Give `false` to load the policy for each check.
|
|
220
|
+
*
|
|
221
|
+
* Two principals with the same data get one policy from the cache. So the
|
|
222
|
+
* loader must decide by the data of the principal only. When it tests that
|
|
223
|
+
* an object of the principal is a given object, as `role === admin` does,
|
|
224
|
+
* give `false`. A principal with objects in an array, a set or the keys of
|
|
225
|
+
* a map is not kept, because such tests are usual there.
|
|
226
|
+
*/
|
|
227
|
+
readonly cache?: {
|
|
228
|
+
readonly capacity?: number;
|
|
229
|
+
readonly timeToLive?: Duration.Input;
|
|
230
|
+
} | false;
|
|
231
|
+
}
|
|
232
|
+
/**
|
|
233
|
+
* Makes the layer of an authorizer.
|
|
234
|
+
*
|
|
235
|
+
* @stability stable
|
|
236
|
+
* @category layers
|
|
237
|
+
* @since 0.3.0
|
|
238
|
+
*/
|
|
239
|
+
export declare const layer: <Self, Id extends string, D extends Any, E, R, EL = never, RL = never, RP = never>(service: ServiceClass<Self, Id, D, E, R>, options: Options<D, NoInfer<E>, NoInfer<R>, EL, RL, RP>) => Layer.Layer<Self, never, RL | RP>;
|
|
240
|
+
export { Authorizer_d_exports };
|
|
241
|
+
//# sourceMappingURL=Authorizer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Authorizer.d.ts","names":["Policy.Target","Policy.KindTarget","Policy.Request","Policy.KindRequest","Domain.Kind","Domain.CommonAction","Domain.Any","Domain.Principal","Condition.Opaque","Policy.Policy","Decision.Decision","Policy.ResidualReads","Condition.Condition","Policy.Coverage","Policy.FieldlessTarget"],"sources":["../src/Authorizer.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;qBAgEa,kBAAkB;;;;;;;;;;;;qBAiBlB,0BAA0B;;;;;;;;;;;;;qBAY1B,gBAAgB;;;;;;;;;iBAeZ;WACP;WACA;;KAGL,WAAW,KAAK;WAAqB,gBAAgB;IAAM;KAC3D,QAAQ,KAAK;WAAqB,aAAa;IAAM;;;;;;;;;;;YAY9C,OAAO,KAAKA,SAAc,KAAKC,WAAkB;;;;;;;;YASjD,eAAe,KAAKC,QAAe,KAAKC,YAAmB;;;;;;;;YAS3D,aAAa,GAAG,IAAI,mBAAmBC,KAAY;;WAErD,YAAY;oBACFC,aAAoB,GAAG;;;;;WAM/B,OAAOA,aAAoB,GAAG;;;;;;;WAQ9B,MAAMA,aAAoB,GAAG;;;;;;;;;iBAUxB,WAAW,UAAUC,KAAY,GAAG;WAC3C,QAAQ;;WAER,WAAW,OAAO,OAAOC,UAAiB,IAAI,GAAG;;;;;WAKjD,QAAQ,OAAO,OACvBE,OAAc,GAAG,UAAUD,SAC3B,oBAAoB,GACpB;;WAGQ,SACR,QAAQR,SAAc,OAClB,OAAO,OAAOU,UAAmB,oBAAoB,GAAG;;WAEpD,QACR,QAAQ,OAAO,OACX,OAAO,aAAa,YAAY,UAAU,oBAAoB,GAAG;;;;;;;WAO7D,cAAc,UAAUV,SAAc,IAAI,IAClD,QAAQ,GACR,SAAS,aAAa,GAAG,IAAI,2BACzB,OAAO,aAAa,KAAK,YAAY,UAAU,oBAAoB,GAAG;;;;;;;WAOlE,eAAe,UAAUC,WAAkB,IACnD,QAAQ,MACJ,OAAO,OACXW,UACC,UAEAJ,QACAG,cAAqB,GAAG,aAEzB,oBAAoB,GACpB;;;;;;WAOQ,iBAAiB,UAAUV,WAAkB,IACrD,QAAQ,MACJ,OAAO,OACXY,SACC,UAEAL,QACAG,cAAqB,GAAG,aAEzB,oBAAoB,GACpB;;WAGQ,kBACR,QAAQG,gBAAuB,OAC3B,OAAO,OAAO,uBAAuB,oBAAoB,GAAG;;;;;WAKxD,aAAa,YAAYP,UAAiB,OAAO,OAAO;;;;;;;;;;iBAWjD,aAChB,MACA,mBACA,UAAUD,KACV,GACA,WACS,QAAQ,aAAa,MAAM,IAAI,WAAW,GAAG,GAAG;WAChD,QAAQ;WACR,SACR,QAAQN,SAAc,OAClB,OAAO,OAAOU,UAAmB,oBAAoB,GAAG,IAAI;WACxD,QACR,QAAQ,OAAO,OACX,OAAO,aAEX,YAAY,UAAU,oBAAoB,GAC1C,IAAI;WAEI,cAAc,UAAUV,SAAc,IAAI,IAClD,QAAQ,GACR,SAAS,aAAa,GAAG,IAAI,2BACzB,OAAO,aAEX,KAAK,YAAY,UAAU,oBAAoB,GAC/C,IAAI;WAEI,eAAe,UAAUC,WAAkB,IACnD,QAAQ,MACJ,OAAO,OACXW,UACC,UAEAJ,QACAG,cAAqB,GAAG,aAEzB,oBAAoB,GACpB,IAAI;WAEI,iBAAiB,UAAUV,WAAkB,IACrD,QAAQ,MACJ,OAAO,OACXY,SACC,UAEAL,QACAG,cAAqB,GAAG,aAEzB,oBAAoB,GACpB,IAAI;WAEI,kBACR,QAAQG,gBAAuB,OAC3B,OAAO,OAAO,uBAAuB,oBAAoB,GAAG,IAAI;;;;;;;;;YAU1D,kBAAkB,QAAQ;WAC5B,QAAQR;;;;;;;;;qBAUL,UAAU,MAAM,UAAU,yBAChC,mBACN,UAAUA,KAEV,IAAI,IACJ,QAAQ,MACJ,aAAa,MAAM,IAAI,GAAG,QAAQ,IAAI,WAAW;;;;;;;;iBAmCrC,QAAQ,UAAUA,KAAY,GAAG,GAAG,IAAI,IAAI;;WAEnD,WAAW,OAAO,OAAOC,UAAiB,IAAI,GAAG;;;;;;WAMjD,SACR,WAAWA,UAAiB,OACxB,OAAO,OAAOE,OAAc,GAAG,GAAG,UAAU,IAAI;;;;;WAK5C,WACR,SAAS,eAAe,OACpB,OAAO,OAAOC,UAAmB,UAAU,GAAG;;;;;;;;;;;WAW1C;aAEG;aACA,aAAa,SAAS;;;;;;;;;;qBAgetB,QACZ,MACA,mBACA,UAAUJ,KACV,GACA,GACA,YACA,YACA,YAEA,SAAS,aAAa,MAAM,IAAI,GAAG,GAAG,IACtC,SAAS,QAAQ,GAAG,QAAQ,IAAI,QAAQ,IAAI,IAAI,IAAI,QAChD,MAAM,MAAM,aAAa,KAAK"}
|
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
import { __exportAll } from "./_virtual/_rolldown/runtime.js";
|
|
2
|
+
import { kindOf } from "./Resource.js";
|
|
3
|
+
import { satisfiable } from "./Condition.js";
|
|
4
|
+
import { Allow, Deny, NotApplicable, reason } from "./Decision.js";
|
|
5
|
+
import { descriptorOf } from "./Domain.js";
|
|
6
|
+
import { coverage, decide, fitsKind, permittedFields, provideContext, residual, residuals, scopeHasValue } from "./Policy.js";
|
|
7
|
+
import * as Arr from "effect/Array";
|
|
8
|
+
import * as Cache from "effect/Cache";
|
|
9
|
+
import * as Context from "effect/Context";
|
|
10
|
+
import * as Effect from "effect/Effect";
|
|
11
|
+
import * as Equal from "effect/Equal";
|
|
12
|
+
import * as Hash from "effect/Hash";
|
|
13
|
+
import * as Layer from "effect/Layer";
|
|
14
|
+
import * as MutableHashMap from "effect/MutableHashMap";
|
|
15
|
+
import * as Option from "effect/Option";
|
|
16
|
+
import * as Schema from "effect/Schema";
|
|
17
|
+
// src/Authorizer.ts
|
|
18
|
+
/**
|
|
19
|
+
* An authorizer is an Effect service that makes decisions for the principal
|
|
20
|
+
* of the current request.
|
|
21
|
+
*
|
|
22
|
+
* You make the service class, in the same way as `Context.Service`. Give the
|
|
23
|
+
* services that the principal and the decider need as `requires`, and their
|
|
24
|
+
* errors as `error`:
|
|
25
|
+
*
|
|
26
|
+
* ```ts
|
|
27
|
+
* class Auth extends Authorizer.Service<Auth, { requires: Identity }>()(
|
|
28
|
+
* "app/Auth",
|
|
29
|
+
* App,
|
|
30
|
+
* ) {}
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
33
|
+
* Then give a layer with {@link layer}. It says where the principal comes
|
|
34
|
+
* from and how to load its policy. The policy of each principal is loaded
|
|
35
|
+
* once and kept in a cache for a short time.
|
|
36
|
+
*
|
|
37
|
+
* Then use the service in a handler:
|
|
38
|
+
*
|
|
39
|
+
* ```ts
|
|
40
|
+
* yield* Auth.check({ action: "update", resource: bot })
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* A "no" answer goes into the error channel as {@link Forbidden}. When the
|
|
44
|
+
* policy can not be loaded, the check fails with {@link PolicyUnavailable}.
|
|
45
|
+
* So the check fails closed: an error is never a "yes".
|
|
46
|
+
*
|
|
47
|
+
* When no rule gives an answer, the authorizer asks the decider, if there is
|
|
48
|
+
* one. A decider may answer at once, or fail with {@link Pending} when a person
|
|
49
|
+
* or a Bot must answer later.
|
|
50
|
+
*
|
|
51
|
+
* @stability stable
|
|
52
|
+
* @since 0.3.0
|
|
53
|
+
*/
|
|
54
|
+
var Authorizer_exports = /* @__PURE__ */ __exportAll({
|
|
55
|
+
Forbidden: () => Forbidden,
|
|
56
|
+
Pending: () => Pending,
|
|
57
|
+
PolicyUnavailable: () => PolicyUnavailable,
|
|
58
|
+
Service: () => Service,
|
|
59
|
+
layer: () => layer
|
|
60
|
+
});
|
|
61
|
+
/**
|
|
62
|
+
* The error when a policy says no.
|
|
63
|
+
*
|
|
64
|
+
* @stability stable
|
|
65
|
+
* @category errors
|
|
66
|
+
* @since 0.3.0
|
|
67
|
+
*/
|
|
68
|
+
var Forbidden = class extends Schema.TaggedError("@nmnmcc/ability/Authorizer/Forbidden")("Forbidden", {
|
|
69
|
+
action: Schema.String,
|
|
70
|
+
kind: Schema.String,
|
|
71
|
+
field: Schema.optionalKey(Schema.String),
|
|
72
|
+
reason: Schema.optionalKey(Schema.String)
|
|
73
|
+
}) {};
|
|
74
|
+
/**
|
|
75
|
+
* The error when the policy of the principal can not be loaded. The cause is
|
|
76
|
+
* kept, but it is not shown to the client.
|
|
77
|
+
*
|
|
78
|
+
* @stability stable
|
|
79
|
+
* @category errors
|
|
80
|
+
* @since 0.3.0
|
|
81
|
+
*/
|
|
82
|
+
var PolicyUnavailable = class extends Schema.TaggedError("@nmnmcc/ability/Authorizer/PolicyUnavailable")("PolicyUnavailable", { cause: Schema.Defect() }) {};
|
|
83
|
+
/**
|
|
84
|
+
* The error when a decider must wait for an answer. `ticket` names the
|
|
85
|
+
* request that waits, so the client can come back for the answer.
|
|
86
|
+
*
|
|
87
|
+
* @stability stable
|
|
88
|
+
* @category errors
|
|
89
|
+
* @since 0.3.0
|
|
90
|
+
*/
|
|
91
|
+
var Pending = class extends Schema.TaggedError("@nmnmcc/ability/Authorizer/Pending")("Pending", {
|
|
92
|
+
ticket: Schema.String,
|
|
93
|
+
reason: Schema.optionalKey(Schema.String)
|
|
94
|
+
}) {};
|
|
95
|
+
/**
|
|
96
|
+
* Makes an authorizer service class for a domain.
|
|
97
|
+
*
|
|
98
|
+
* @stability stable
|
|
99
|
+
* @category constructors
|
|
100
|
+
* @since 0.3.0
|
|
101
|
+
*/
|
|
102
|
+
const Service = (() => (id, domain) => {
|
|
103
|
+
const Base = Context.Service()(id);
|
|
104
|
+
return class extends Base {
|
|
105
|
+
static domain = domain;
|
|
106
|
+
static decide = (target) => this.use((service) => service.decide(target));
|
|
107
|
+
static check = (target) => this.use((service) => service.check(target));
|
|
108
|
+
static guard = (target, options) => this.use((service) => service.guard(target, options));
|
|
109
|
+
static filter = (target) => this.use((service) => service.filter(target));
|
|
110
|
+
static coverage = (target) => this.use((service) => service.coverage(target));
|
|
111
|
+
static permittedFields = (target) => this.use((service) => service.permittedFields(target));
|
|
112
|
+
};
|
|
113
|
+
});
|
|
114
|
+
/**
|
|
115
|
+
* A cache key for a principal. Two keys are equal when they have the same
|
|
116
|
+
* text, so two principals with the same value share one policy. The key also
|
|
117
|
+
* keeps the principal, so the cache can load its policy. A plain `Data` value
|
|
118
|
+
* can not do both, so the key gives its own equality with `Equal.Equal`.
|
|
119
|
+
*/
|
|
120
|
+
var PrincipalKey = class PrincipalKey {
|
|
121
|
+
principal;
|
|
122
|
+
text;
|
|
123
|
+
constructor(principal, text) {
|
|
124
|
+
this.principal = principal;
|
|
125
|
+
this.text = text;
|
|
126
|
+
}
|
|
127
|
+
[Equal.symbol](that) {
|
|
128
|
+
return that instanceof PrincipalKey && that.text === this.text;
|
|
129
|
+
}
|
|
130
|
+
[Hash.symbol]() {
|
|
131
|
+
return Hash.string(this.text);
|
|
132
|
+
}
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* Tests if an array has a plain field at each index below its length. With
|
|
136
|
+
* one more own key for `length`, it then has no other own keys.
|
|
137
|
+
*/
|
|
138
|
+
const hasEveryIndex = (value) => Arr.every(Array.from({ length: value.length }, (_, index) => index), (index) => isPlainField(value, String(index)));
|
|
139
|
+
/**
|
|
140
|
+
* Tests if an own key of an object holds plain data that the text shows: it
|
|
141
|
+
* can be seen in a loop over the keys, and it is not a getter.
|
|
142
|
+
*/
|
|
143
|
+
const isPlainField = (value, key) => {
|
|
144
|
+
const descriptor = Object.getOwnPropertyDescriptor(value, key);
|
|
145
|
+
return descriptor !== void 0 && descriptor.enumerable === true && "value" in descriptor;
|
|
146
|
+
};
|
|
147
|
+
const isObjectLike = (value) => typeof value === "object" && value !== null || typeof value === "function";
|
|
148
|
+
/** Gives a number that is only for this class, in this layer. */
|
|
149
|
+
const classId = (classes, constructor) => {
|
|
150
|
+
const id = Option.getOrElse(MutableHashMap.get(classes, constructor), () => {
|
|
151
|
+
const fresh = MutableHashMap.size(classes);
|
|
152
|
+
MutableHashMap.set(classes, constructor, fresh);
|
|
153
|
+
return fresh;
|
|
154
|
+
});
|
|
155
|
+
return `#${String(id)}`;
|
|
156
|
+
};
|
|
157
|
+
/** The most levels of objects in a principal that the cache takes. */
|
|
158
|
+
const maxKeyDepth = 256;
|
|
159
|
+
/**
|
|
160
|
+
* Gives a text that names a principal value. Two values get one text only when
|
|
161
|
+
* they have the same types and the same data. So a string `"1"` and a bigint
|
|
162
|
+
* `1n` get two texts. The text keeps the class of each object, by a number
|
|
163
|
+
* that is its own, because two classes may have one name.
|
|
164
|
+
*
|
|
165
|
+
* It reads only the fields of plain objects and of `Schema.Class` values, and
|
|
166
|
+
* only when each own key is a plain field that a loop over the keys can see.
|
|
167
|
+
* An object of another class may keep its data where the text can not see it,
|
|
168
|
+
* as a `URL` does. So it gives `undefined` for such an object, unless it is a
|
|
169
|
+
* plain `Date`, `URL`, array, `Map` or `Set` with no extra own keys. It also
|
|
170
|
+
* gives `undefined` for a function, a symbol, or a value with one object in two
|
|
171
|
+
* places. The text can not show that two places hold the same object, and a
|
|
172
|
+
* loader may test it, as `set.has(value)` does.
|
|
173
|
+
* The private fields (`#name`) of a class can not be seen, so a principal
|
|
174
|
+
* class must not keep its data in them.
|
|
175
|
+
*
|
|
176
|
+
* It also gives `undefined` for a value with more than {@link maxKeyDepth}
|
|
177
|
+
* levels of objects. The walk calls itself for each level, so a deeper value
|
|
178
|
+
* could fill the stack. Such a principal is not cached.
|
|
179
|
+
*/
|
|
180
|
+
const keyText = (value, seen, classes, depth = 0) => {
|
|
181
|
+
const plain = (text) => text;
|
|
182
|
+
switch (typeof value) {
|
|
183
|
+
case "string": return plain(`s${JSON.stringify(value)}`);
|
|
184
|
+
case "number": return plain(Object.is(value, -0) ? "n-0" : `n${String(value)}`);
|
|
185
|
+
case "bigint": return plain(`b${String(value)}`);
|
|
186
|
+
case "boolean": return plain(value ? "true" : "false");
|
|
187
|
+
case "undefined": return plain("undefined");
|
|
188
|
+
case "object": break;
|
|
189
|
+
default: return;
|
|
190
|
+
}
|
|
191
|
+
if (value === null) return plain("null");
|
|
192
|
+
if (seen.has(value) || depth >= maxKeyDepth) return;
|
|
193
|
+
seen.add(value);
|
|
194
|
+
const list = (items, wrap) => {
|
|
195
|
+
const texts = Arr.map(items, (item) => keyText(item, seen, classes, depth + 1));
|
|
196
|
+
return Arr.every(texts, (text) => text !== void 0) ? wrap(texts) : void 0;
|
|
197
|
+
};
|
|
198
|
+
const prototype = Object.getPrototypeOf(value);
|
|
199
|
+
const own = Reflect.ownKeys(value);
|
|
200
|
+
if (prototype === Date.prototype && own.length === 0) return `d${String(value.getTime())}`;
|
|
201
|
+
if (prototype === URL.prototype && own.length === 0) return `u${JSON.stringify(value.href)}`;
|
|
202
|
+
if (prototype === Array.prototype && own.length === value.length + 1 && hasEveryIndex(value) && !Arr.some(value, isObjectLike)) return list(value, (texts) => `[${texts.join(",")}]`);
|
|
203
|
+
if (prototype === Map.prototype && own.length === 0 && !Arr.some(Array.from(value.keys()), isObjectLike)) return list(Arr.flatMap(Array.from(value), ([key, item]) => [key, item]), (texts) => `Map{${texts.join(",")}}`);
|
|
204
|
+
if (prototype === Set.prototype && own.length === 0 && !Arr.some(Array.from(value), isObjectLike)) return list(Array.from(value), (texts) => `Set{${texts.join(",")}}`);
|
|
205
|
+
if ((prototype === null || prototype === Object.prototype || Schema.isSchema(prototype.constructor) && prototype.constructor.prototype === prototype) && Arr.every(own, (key) => typeof key === "string" && isPlainField(value, key))) {
|
|
206
|
+
const keys = own;
|
|
207
|
+
const name = prototype === null ? "" : classId(classes, prototype.constructor);
|
|
208
|
+
return list(Arr.map(keys, (key) => value[key]), (texts) => `${name}{${Arr.map(keys, (key, index) => `${JSON.stringify(key)}:${texts[index]}`).join(",")}}`);
|
|
209
|
+
}
|
|
210
|
+
};
|
|
211
|
+
const forbidden = (target, kind, reason) => Forbidden.make({
|
|
212
|
+
action: target.action,
|
|
213
|
+
kind,
|
|
214
|
+
...target.field === void 0 ? {} : { field: target.field },
|
|
215
|
+
...reason === void 0 ? {} : { reason }
|
|
216
|
+
});
|
|
217
|
+
const makeLayer = (service, options) => {
|
|
218
|
+
const domain = service.domain;
|
|
219
|
+
const classes = MutableHashMap.empty();
|
|
220
|
+
const keyOf = (principal) => {
|
|
221
|
+
const text = keyText(principal, /* @__PURE__ */ new Set(), classes);
|
|
222
|
+
return text === void 0 ? void 0 : new PrincipalKey(principal, text);
|
|
223
|
+
};
|
|
224
|
+
return Layer.effect(service, Effect.gen(function* () {
|
|
225
|
+
const services = yield* Effect.context();
|
|
226
|
+
const load = (principal) => options.policy(principal).pipe(Effect.provideContext(services), Effect.filterOrFail((value) => value.domain === domain, () => new globalThis.Error("The loaded policy is not a policy of this domain")), Effect.mapError((cause) => PolicyUnavailable.make({ cause })), Effect.map((value) => provideContext(value, services)));
|
|
227
|
+
const cache = options.cache === false ? void 0 : yield* Cache.make({
|
|
228
|
+
capacity: options.cache?.capacity ?? 1e3,
|
|
229
|
+
timeToLive: options.cache?.timeToLive ?? "30 seconds",
|
|
230
|
+
lookup: (key) => load(key.principal)
|
|
231
|
+
});
|
|
232
|
+
const policyFor = (principal) => {
|
|
233
|
+
const key = cache === void 0 ? void 0 : keyOf(principal);
|
|
234
|
+
if (cache === void 0 || key === void 0) return load(principal);
|
|
235
|
+
return Cache.get(cache, key).pipe(Effect.tapError(() => Cache.invalidate(cache, key)));
|
|
236
|
+
};
|
|
237
|
+
const withServices = (effect) => Effect.provideContext(effect, services);
|
|
238
|
+
const current = Effect.gen(function* () {
|
|
239
|
+
const principal = yield* options.principal;
|
|
240
|
+
return {
|
|
241
|
+
principal,
|
|
242
|
+
policy: yield* policyFor(principal)
|
|
243
|
+
};
|
|
244
|
+
});
|
|
245
|
+
const decideWith = Effect.fnUntraced(function* ({ principal, policy: value }, target) {
|
|
246
|
+
return yield* withServices(decide(value, {
|
|
247
|
+
...target,
|
|
248
|
+
principal
|
|
249
|
+
}));
|
|
250
|
+
});
|
|
251
|
+
const decide$1 = (target) => Effect.flatMap(current, (snapshot) => decideWith(snapshot, target));
|
|
252
|
+
const kindDecision = (value, principal, target) => {
|
|
253
|
+
const request = {
|
|
254
|
+
...target,
|
|
255
|
+
principal
|
|
256
|
+
};
|
|
257
|
+
const covered = coverage(value, request);
|
|
258
|
+
if (covered._tag === "All") return Allow({});
|
|
259
|
+
if (covered._tag !== "Unknown" && scopeHasValue(value, request)) {
|
|
260
|
+
const deny = residuals(value, request).deny;
|
|
261
|
+
const schema = descriptorOf(value.domain, target.kind ?? "")?.schema;
|
|
262
|
+
if (deny._tag === "False" || satisfiable(deny, { schema })._tag === "Unsatisfiable") return NotApplicable;
|
|
263
|
+
}
|
|
264
|
+
return Deny({});
|
|
265
|
+
};
|
|
266
|
+
const checkWith = Effect.fnUntraced(function* ({ principal, policy: value }, target) {
|
|
267
|
+
const kind = target.resource === void 0 ? target.kind ?? "" : kindOf(target.resource) ?? "";
|
|
268
|
+
const descriptor = descriptorOf(domain, kind);
|
|
269
|
+
if (descriptor === void 0 || !fitsKind(descriptor, target)) return yield* forbidden(target, kind, void 0);
|
|
270
|
+
const fromPolicy = target.resource === void 0 ? kindDecision(value, principal, target) : yield* withServices(decide(value, {
|
|
271
|
+
...target,
|
|
272
|
+
principal
|
|
273
|
+
}));
|
|
274
|
+
const decision = fromPolicy._tag === "NotApplicable" && options.decider !== void 0 ? yield* options.decider({
|
|
275
|
+
...target,
|
|
276
|
+
principal
|
|
277
|
+
}) : fromPolicy;
|
|
278
|
+
if (decision._tag !== "Allow") return yield* forbidden(target, kind, reason(decision));
|
|
279
|
+
});
|
|
280
|
+
const check = (target) => Effect.flatMap(current, (snapshot) => checkWith(snapshot, target));
|
|
281
|
+
const guard = Effect.fnUntraced(function* (target, guardOptions) {
|
|
282
|
+
const snapshot = yield* current;
|
|
283
|
+
const read = guardOptions.read ?? "read";
|
|
284
|
+
const { field: _field, ...rest } = target;
|
|
285
|
+
if ((yield* decideWith(snapshot, {
|
|
286
|
+
...rest,
|
|
287
|
+
action: read
|
|
288
|
+
}))._tag !== "Allow") return yield* Effect.fail(guardOptions.hide());
|
|
289
|
+
if (target.action !== read || target.field !== void 0) yield* checkWith(snapshot, target);
|
|
290
|
+
});
|
|
291
|
+
const filter = (target) => Effect.map(current, ({ principal, policy: value }) => {
|
|
292
|
+
const request = {
|
|
293
|
+
...target,
|
|
294
|
+
principal
|
|
295
|
+
};
|
|
296
|
+
const covered = coverage(value, request);
|
|
297
|
+
return covered._tag === "Unknown" ? residual(value, request) : covered.condition;
|
|
298
|
+
});
|
|
299
|
+
const coverage$1 = (target) => Effect.map(current, ({ principal, policy: value }) => coverage(value, {
|
|
300
|
+
...target,
|
|
301
|
+
principal
|
|
302
|
+
}));
|
|
303
|
+
const permittedFields$1 = Effect.fnUntraced(function* (target) {
|
|
304
|
+
const { principal, policy: value } = yield* current;
|
|
305
|
+
return yield* withServices(permittedFields(value, {
|
|
306
|
+
...target,
|
|
307
|
+
principal
|
|
308
|
+
}));
|
|
309
|
+
});
|
|
310
|
+
const invalidate = (principal) => {
|
|
311
|
+
if (cache === void 0) return Effect.void;
|
|
312
|
+
if (principal === void 0) return Cache.invalidateAll(cache);
|
|
313
|
+
const key = keyOf(principal);
|
|
314
|
+
return key === void 0 ? Effect.void : Cache.invalidate(cache, key);
|
|
315
|
+
};
|
|
316
|
+
return {
|
|
317
|
+
domain,
|
|
318
|
+
principal: options.principal,
|
|
319
|
+
policy: Effect.map(current, ({ policy: value }) => value),
|
|
320
|
+
decide: decide$1,
|
|
321
|
+
check,
|
|
322
|
+
guard,
|
|
323
|
+
filter,
|
|
324
|
+
coverage: coverage$1,
|
|
325
|
+
permittedFields: permittedFields$1,
|
|
326
|
+
invalidate
|
|
327
|
+
};
|
|
328
|
+
}));
|
|
329
|
+
};
|
|
330
|
+
/**
|
|
331
|
+
* Makes the layer of an authorizer.
|
|
332
|
+
*
|
|
333
|
+
* @stability stable
|
|
334
|
+
* @category layers
|
|
335
|
+
* @since 0.3.0
|
|
336
|
+
*/
|
|
337
|
+
const layer = makeLayer;
|
|
338
|
+
export { Authorizer_exports, Forbidden, Pending, PolicyUnavailable, Service, layer };
|
|
339
|
+
|
|
340
|
+
//# sourceMappingURL=Authorizer.js.map
|