@hitchy/plugin-auth 0.2.0 → 0.3.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.
Files changed (66) hide show
  1. package/.gitlab-ci.yml +42 -21
  2. package/LICENSE +21 -0
  3. package/api/controller/user.js +2 -29
  4. package/api/model/authorization/rule.js +0 -27
  5. package/api/model/role.js +0 -28
  6. package/api/model/user-to-role.js +0 -28
  7. package/api/model/user.js +2 -30
  8. package/api/policy/authentication.js +67 -64
  9. package/api/policy/authorization.js +0 -28
  10. package/api/policy/user.js +0 -28
  11. package/api/service/auth/manager.js +9 -28
  12. package/api/service/authentication/passport.js +1 -29
  13. package/api/service/authentication/strategies.js +176 -27
  14. package/api/service/authorization/node.js +0 -28
  15. package/api/service/authorization/policy-generator.js +0 -28
  16. package/api/service/authorization/tree.js +0 -28
  17. package/config/auth.js +5 -0
  18. package/coverage/base.css +224 -0
  19. package/coverage/block-navigation.js +79 -0
  20. package/coverage/favicon.png +0 -0
  21. package/coverage/index.html +231 -0
  22. package/coverage/plugin-auth/api/controller/index.html +111 -0
  23. package/coverage/plugin-auth/api/controller/user.js.html +368 -0
  24. package/coverage/plugin-auth/api/model/authorization/index.html +111 -0
  25. package/coverage/plugin-auth/api/model/authorization/rule.js.html +227 -0
  26. package/coverage/plugin-auth/api/model/index.html +141 -0
  27. package/coverage/plugin-auth/api/model/role.js.html +200 -0
  28. package/coverage/plugin-auth/api/model/user-to-role.js.html +167 -0
  29. package/coverage/plugin-auth/api/model/user.js.html +752 -0
  30. package/coverage/plugin-auth/api/policy/authentication.js.html +617 -0
  31. package/coverage/plugin-auth/api/policy/authorization.js.html +182 -0
  32. package/coverage/plugin-auth/api/policy/index.html +141 -0
  33. package/coverage/plugin-auth/api/policy/user.js.html +479 -0
  34. package/coverage/plugin-auth/api/service/auth/index.html +111 -0
  35. package/coverage/plugin-auth/api/service/auth/manager.js.html +863 -0
  36. package/coverage/plugin-auth/api/service/authentication/index.html +126 -0
  37. package/coverage/plugin-auth/api/service/authentication/passport.js.html +290 -0
  38. package/coverage/plugin-auth/api/service/authentication/strategies.js.html +860 -0
  39. package/coverage/plugin-auth/api/service/authorization/index.html +141 -0
  40. package/coverage/plugin-auth/api/service/authorization/node.js.html +944 -0
  41. package/coverage/plugin-auth/api/service/authorization/policy-generator.js.html +386 -0
  42. package/coverage/plugin-auth/api/service/authorization/tree.js.html +983 -0
  43. package/coverage/plugin-auth/config/auth.js.html +140 -0
  44. package/coverage/plugin-auth/config/index.html +111 -0
  45. package/coverage/plugin-auth/index.html +111 -0
  46. package/coverage/plugin-auth/index.js.html +344 -0
  47. package/coverage/prettify.css +1 -0
  48. package/coverage/prettify.js +2 -0
  49. package/coverage/sort-arrow-sprite.png +0 -0
  50. package/coverage/sorter.js +170 -0
  51. package/coverage/tmp/coverage-6744-1648396809135-0.json +1 -0
  52. package/docs/.vuepress/config.js +5 -2
  53. package/docs/api/config.md +14 -2
  54. package/docs/api/model/authorization-rule.md +1 -1
  55. package/docs/api/model/user.md +2 -2
  56. package/docs/api/service/authentication-passport.md +1 -1
  57. package/docs/guides/getting-started.md +2 -2
  58. package/docs/guides/idp-login.png +0 -0
  59. package/docs/guides/idp-saml-cert.png +0 -0
  60. package/docs/guides/openid-connect.md +164 -0
  61. package/docs/guides/readme.md +2 -0
  62. package/docs/guides/saml.md +161 -0
  63. package/docs/introduction.md +5 -5
  64. package/index.js +27 -50
  65. package/package.json +18 -13
  66. package/readme.md +11 -43
@@ -0,0 +1,386 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for plugin-auth/api/service/authorization/policy-generator.js</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../../../prettify.css" />
9
+ <link rel="stylesheet" href="../../../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../../../index.html">All files</a> / <a href="index.html">plugin-auth/api/service/authorization</a> policy-generator.js</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">93.13% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>95/102</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">79.16% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>19/24</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">100% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>3/3</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">93.13% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>95/102</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ </div>
58
+ <div class='status-line high'></div>
59
+ <pre><table class="coverage">
60
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
61
+ <a name='L2'></a><a href='#L2'>2</a>
62
+ <a name='L3'></a><a href='#L3'>3</a>
63
+ <a name='L4'></a><a href='#L4'>4</a>
64
+ <a name='L5'></a><a href='#L5'>5</a>
65
+ <a name='L6'></a><a href='#L6'>6</a>
66
+ <a name='L7'></a><a href='#L7'>7</a>
67
+ <a name='L8'></a><a href='#L8'>8</a>
68
+ <a name='L9'></a><a href='#L9'>9</a>
69
+ <a name='L10'></a><a href='#L10'>10</a>
70
+ <a name='L11'></a><a href='#L11'>11</a>
71
+ <a name='L12'></a><a href='#L12'>12</a>
72
+ <a name='L13'></a><a href='#L13'>13</a>
73
+ <a name='L14'></a><a href='#L14'>14</a>
74
+ <a name='L15'></a><a href='#L15'>15</a>
75
+ <a name='L16'></a><a href='#L16'>16</a>
76
+ <a name='L17'></a><a href='#L17'>17</a>
77
+ <a name='L18'></a><a href='#L18'>18</a>
78
+ <a name='L19'></a><a href='#L19'>19</a>
79
+ <a name='L20'></a><a href='#L20'>20</a>
80
+ <a name='L21'></a><a href='#L21'>21</a>
81
+ <a name='L22'></a><a href='#L22'>22</a>
82
+ <a name='L23'></a><a href='#L23'>23</a>
83
+ <a name='L24'></a><a href='#L24'>24</a>
84
+ <a name='L25'></a><a href='#L25'>25</a>
85
+ <a name='L26'></a><a href='#L26'>26</a>
86
+ <a name='L27'></a><a href='#L27'>27</a>
87
+ <a name='L28'></a><a href='#L28'>28</a>
88
+ <a name='L29'></a><a href='#L29'>29</a>
89
+ <a name='L30'></a><a href='#L30'>30</a>
90
+ <a name='L31'></a><a href='#L31'>31</a>
91
+ <a name='L32'></a><a href='#L32'>32</a>
92
+ <a name='L33'></a><a href='#L33'>33</a>
93
+ <a name='L34'></a><a href='#L34'>34</a>
94
+ <a name='L35'></a><a href='#L35'>35</a>
95
+ <a name='L36'></a><a href='#L36'>36</a>
96
+ <a name='L37'></a><a href='#L37'>37</a>
97
+ <a name='L38'></a><a href='#L38'>38</a>
98
+ <a name='L39'></a><a href='#L39'>39</a>
99
+ <a name='L40'></a><a href='#L40'>40</a>
100
+ <a name='L41'></a><a href='#L41'>41</a>
101
+ <a name='L42'></a><a href='#L42'>42</a>
102
+ <a name='L43'></a><a href='#L43'>43</a>
103
+ <a name='L44'></a><a href='#L44'>44</a>
104
+ <a name='L45'></a><a href='#L45'>45</a>
105
+ <a name='L46'></a><a href='#L46'>46</a>
106
+ <a name='L47'></a><a href='#L47'>47</a>
107
+ <a name='L48'></a><a href='#L48'>48</a>
108
+ <a name='L49'></a><a href='#L49'>49</a>
109
+ <a name='L50'></a><a href='#L50'>50</a>
110
+ <a name='L51'></a><a href='#L51'>51</a>
111
+ <a name='L52'></a><a href='#L52'>52</a>
112
+ <a name='L53'></a><a href='#L53'>53</a>
113
+ <a name='L54'></a><a href='#L54'>54</a>
114
+ <a name='L55'></a><a href='#L55'>55</a>
115
+ <a name='L56'></a><a href='#L56'>56</a>
116
+ <a name='L57'></a><a href='#L57'>57</a>
117
+ <a name='L58'></a><a href='#L58'>58</a>
118
+ <a name='L59'></a><a href='#L59'>59</a>
119
+ <a name='L60'></a><a href='#L60'>60</a>
120
+ <a name='L61'></a><a href='#L61'>61</a>
121
+ <a name='L62'></a><a href='#L62'>62</a>
122
+ <a name='L63'></a><a href='#L63'>63</a>
123
+ <a name='L64'></a><a href='#L64'>64</a>
124
+ <a name='L65'></a><a href='#L65'>65</a>
125
+ <a name='L66'></a><a href='#L66'>66</a>
126
+ <a name='L67'></a><a href='#L67'>67</a>
127
+ <a name='L68'></a><a href='#L68'>68</a>
128
+ <a name='L69'></a><a href='#L69'>69</a>
129
+ <a name='L70'></a><a href='#L70'>70</a>
130
+ <a name='L71'></a><a href='#L71'>71</a>
131
+ <a name='L72'></a><a href='#L72'>72</a>
132
+ <a name='L73'></a><a href='#L73'>73</a>
133
+ <a name='L74'></a><a href='#L74'>74</a>
134
+ <a name='L75'></a><a href='#L75'>75</a>
135
+ <a name='L76'></a><a href='#L76'>76</a>
136
+ <a name='L77'></a><a href='#L77'>77</a>
137
+ <a name='L78'></a><a href='#L78'>78</a>
138
+ <a name='L79'></a><a href='#L79'>79</a>
139
+ <a name='L80'></a><a href='#L80'>80</a>
140
+ <a name='L81'></a><a href='#L81'>81</a>
141
+ <a name='L82'></a><a href='#L82'>82</a>
142
+ <a name='L83'></a><a href='#L83'>83</a>
143
+ <a name='L84'></a><a href='#L84'>84</a>
144
+ <a name='L85'></a><a href='#L85'>85</a>
145
+ <a name='L86'></a><a href='#L86'>86</a>
146
+ <a name='L87'></a><a href='#L87'>87</a>
147
+ <a name='L88'></a><a href='#L88'>88</a>
148
+ <a name='L89'></a><a href='#L89'>89</a>
149
+ <a name='L90'></a><a href='#L90'>90</a>
150
+ <a name='L91'></a><a href='#L91'>91</a>
151
+ <a name='L92'></a><a href='#L92'>92</a>
152
+ <a name='L93'></a><a href='#L93'>93</a>
153
+ <a name='L94'></a><a href='#L94'>94</a>
154
+ <a name='L95'></a><a href='#L95'>95</a>
155
+ <a name='L96'></a><a href='#L96'>96</a>
156
+ <a name='L97'></a><a href='#L97'>97</a>
157
+ <a name='L98'></a><a href='#L98'>98</a>
158
+ <a name='L99'></a><a href='#L99'>99</a>
159
+ <a name='L100'></a><a href='#L100'>100</a>
160
+ <a name='L101'></a><a href='#L101'>101</a>
161
+ <a name='L102'></a><a href='#L102'>102</a>
162
+ <a name='L103'></a><a href='#L103'>103</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
163
+ <span class="cline-any cline-yes">1x</span>
164
+ <span class="cline-any cline-yes">1x</span>
165
+ <span class="cline-any cline-yes">18x</span>
166
+ <span class="cline-any cline-yes">18x</span>
167
+ <span class="cline-any cline-yes">18x</span>
168
+ <span class="cline-any cline-yes">18x</span>
169
+ <span class="cline-any cline-yes">18x</span>
170
+ <span class="cline-any cline-yes">18x</span>
171
+ <span class="cline-any cline-yes">18x</span>
172
+ <span class="cline-any cline-yes">18x</span>
173
+ <span class="cline-any cline-yes">18x</span>
174
+ <span class="cline-any cline-yes">18x</span>
175
+ <span class="cline-any cline-yes">18x</span>
176
+ <span class="cline-any cline-yes">18x</span>
177
+ <span class="cline-any cline-yes">18x</span>
178
+ <span class="cline-any cline-yes">18x</span>
179
+ <span class="cline-any cline-yes">1x</span>
180
+ <span class="cline-any cline-no">&nbsp;</span>
181
+ <span class="cline-any cline-no">&nbsp;</span>
182
+ <span class="cline-any cline-yes">1x</span>
183
+ <span class="cline-any cline-yes">1x</span>
184
+ <span class="cline-any cline-yes">1x</span>
185
+ <span class="cline-any cline-yes">1x</span>
186
+ <span class="cline-any cline-no">&nbsp;</span>
187
+ <span class="cline-any cline-no">&nbsp;</span>
188
+ <span class="cline-any cline-no">&nbsp;</span>
189
+ <span class="cline-any cline-yes">1x</span>
190
+ <span class="cline-any cline-yes">1x</span>
191
+ <span class="cline-any cline-yes">1x</span>
192
+ <span class="cline-any cline-yes">1x</span>
193
+ <span class="cline-any cline-yes">1x</span>
194
+ <span class="cline-any cline-yes">8x</span>
195
+ <span class="cline-any cline-yes">3x</span>
196
+ <span class="cline-any cline-yes">3x</span>
197
+ <span class="cline-any cline-yes">3x</span>
198
+ <span class="cline-any cline-yes">3x</span>
199
+ <span class="cline-any cline-yes">3x</span>
200
+ <span class="cline-any cline-yes">3x</span>
201
+ <span class="cline-any cline-yes">3x</span>
202
+ <span class="cline-any cline-yes">3x</span>
203
+ <span class="cline-any cline-yes">2x</span>
204
+ <span class="cline-any cline-yes">2x</span>
205
+ <span class="cline-any cline-yes">2x</span>
206
+ <span class="cline-any cline-yes">3x</span>
207
+ <span class="cline-any cline-yes">1x</span>
208
+ <span class="cline-any cline-yes">6x</span>
209
+ <span class="cline-any cline-yes">6x</span>
210
+ <span class="cline-any cline-yes">6x</span>
211
+ <span class="cline-any cline-yes">6x</span>
212
+ <span class="cline-any cline-yes">6x</span>
213
+ <span class="cline-any cline-yes">6x</span>
214
+ <span class="cline-any cline-yes">1x</span>
215
+ <span class="cline-any cline-yes">1x</span>
216
+ <span class="cline-any cline-yes">18x</span>
217
+ <span class="cline-any cline-yes">18x</span>
218
+ <span class="cline-any cline-yes">18x</span>
219
+ <span class="cline-any cline-yes">18x</span>
220
+ <span class="cline-any cline-yes">18x</span>
221
+ <span class="cline-any cline-yes">18x</span>
222
+ <span class="cline-any cline-yes">18x</span>
223
+ <span class="cline-any cline-yes">18x</span>
224
+ <span class="cline-any cline-yes">18x</span>
225
+ <span class="cline-any cline-yes">18x</span>
226
+ <span class="cline-any cline-yes">18x</span>
227
+ <span class="cline-any cline-yes">2x</span>
228
+ <span class="cline-any cline-no">&nbsp;</span>
229
+ <span class="cline-any cline-no">&nbsp;</span>
230
+ <span class="cline-any cline-yes">2x</span>
231
+ <span class="cline-any cline-yes">2x</span>
232
+ <span class="cline-any cline-yes">2x</span>
233
+ <span class="cline-any cline-yes">2x</span>
234
+ <span class="cline-any cline-yes">16x</span>
235
+ <span class="cline-any cline-yes">6x</span>
236
+ <span class="cline-any cline-yes">6x</span>
237
+ <span class="cline-any cline-yes">6x</span>
238
+ <span class="cline-any cline-yes">2x</span>
239
+ <span class="cline-any cline-yes">2x</span>
240
+ <span class="cline-any cline-yes">2x</span>
241
+ <span class="cline-any cline-yes">4x</span>
242
+ <span class="cline-any cline-yes">4x</span>
243
+ <span class="cline-any cline-yes">4x</span>
244
+ <span class="cline-any cline-yes">4x</span>
245
+ <span class="cline-any cline-yes">4x</span>
246
+ <span class="cline-any cline-yes">4x</span>
247
+ <span class="cline-any cline-yes">2x</span>
248
+ <span class="cline-any cline-yes">2x</span>
249
+ <span class="cline-any cline-yes">2x</span>
250
+ <span class="cline-any cline-yes">4x</span>
251
+ <span class="cline-any cline-yes">2x</span>
252
+ <span class="cline-any cline-yes">12x</span>
253
+ <span class="cline-any cline-yes">12x</span>
254
+ <span class="cline-any cline-yes">12x</span>
255
+ <span class="cline-any cline-yes">12x</span>
256
+ <span class="cline-any cline-yes">12x</span>
257
+ <span class="cline-any cline-yes">12x</span>
258
+ <span class="cline-any cline-yes">2x</span>
259
+ <span class="cline-any cline-yes">2x</span>
260
+ <span class="cline-any cline-yes">18x</span>
261
+ <span class="cline-any cline-yes">18x</span>
262
+ <span class="cline-any cline-yes">18x</span>
263
+ <span class="cline-any cline-yes">1x</span>
264
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">"use strict";
265
+ &nbsp;
266
+ module.exports = function() {
267
+ /**
268
+ * Implements factory functions for policy handlers checking a requesting
269
+ * user's authorization.
270
+ */
271
+ class AuthorizationPolicyGenerator {
272
+ /**
273
+ * Generates policy handler testing a request's user for having any of
274
+ * the listed roles and instantly rejecting requests of users who don't.
275
+ * Request is also rejected of request's user is unknown.
276
+ *
277
+ * @param {string|string[]} roles lists roles to accept
278
+ * @returns {Hitchy.Core.RequestPolicyHandler} policy handler rejecting requests of users who doesn't have any of the listed roles
279
+ */
280
+ static hasRole( roles ) {
281
+ if ( !roles ) <span class="branch-0 cbranch-no" title="branch not covered" >{</span>
282
+ <span class="cstat-no" title="statement not covered" > throw new Error( "missing roles to test" );</span>
283
+ <span class="cstat-no" title="statement not covered" > }</span>
284
+ &nbsp;
285
+ const accepted = {};
286
+ &nbsp;
287
+ if ( Array.isArray( roles ) ) <span class="branch-0 cbranch-no" title="branch not covered" >{</span>
288
+ <span class="cstat-no" title="statement not covered" > for ( const role of roles ) {</span>
289
+ <span class="cstat-no" title="statement not covered" > accepted[role] = true;</span>
290
+ <span class="cstat-no" title="statement not covered" > }</span>
291
+ } else {
292
+ accepted[String( roles )] = true;
293
+ }
294
+ &nbsp;
295
+ return ( req, res, next ) =&gt; {
296
+ if ( req.user &amp;&amp; Array.isArray( req.user.roles ) ) {
297
+ const { adminRole } = req.hitchy.runtime.services.AuthManager;
298
+ const userRoles = req.user.roles;
299
+ const numUserRoles = userRoles.length;
300
+ &nbsp;
301
+ for ( let i = 0; i &lt; numUserRoles; i++ ) {
302
+ const role = userRoles[i].name;
303
+ &nbsp;
304
+ if ( role === adminRole || accepted[role] ) {
305
+ next();
306
+ return;
307
+ }
308
+ }
309
+ }
310
+ &nbsp;
311
+ res
312
+ .status( 403 )
313
+ .json( {
314
+ error: "access forbidden",
315
+ } );
316
+ };
317
+ }
318
+ &nbsp;
319
+ /**
320
+ * Generates policy handler testing a request's user for being
321
+ * authorized to access any of the listed resources and instantly
322
+ * rejecting requests of users who don't. Request is also rejected of
323
+ * request's user is unknown.
324
+ *
325
+ * @param {string|string[]} resource name(s) of resource(s)
326
+ * @returns {Hitchy.Core.RequestPolicyHandler} policy handler rejecting requests of users who mustn't access any of the named resources
327
+ */
328
+ static mayAccess( resource ) {
329
+ if ( !resource ) <span class="branch-0 cbranch-no" title="branch not covered" >{</span>
330
+ <span class="cstat-no" title="statement not covered" > throw new Error( "missing resources to test" );</span>
331
+ <span class="cstat-no" title="statement not covered" > }</span>
332
+ &nbsp;
333
+ const resources = Array.isArray( resource ) <span class="branch-0 cbranch-no" title="branch not covered" >? resource </span>: [resource];
334
+ &nbsp;
335
+ return function( req, res, next ) {
336
+ if ( req.user ) {
337
+ const roleNames = Array.isArray( req.user.roles ) ? req.user.roles.map( role =&gt; role.name ) <span class="branch-0 cbranch-no" title="branch not covered" >: [];</span>
338
+ &nbsp;
339
+ if ( roleNames.indexOf( this.services.AuthManager.adminRole ) &gt; -1 ) {
340
+ next();
341
+ return;
342
+ }
343
+ &nbsp;
344
+ const { current } = this.services.AuthorizationTree;
345
+ const numResources = resources.length;
346
+ &nbsp;
347
+ for ( let i = 0; i &lt; numResources; i++ ) {
348
+ if ( current.isAuthorized( resources[i], req.user, roleNames ) ) {
349
+ next();
350
+ return;
351
+ }
352
+ }
353
+ }
354
+ &nbsp;
355
+ res
356
+ .status( 403 )
357
+ .json( {
358
+ error: "access forbidden",
359
+ } );
360
+ };
361
+ }
362
+ }
363
+ &nbsp;
364
+ return AuthorizationPolicyGenerator;
365
+ };
366
+ &nbsp;</pre></td></tr></table></pre>
367
+
368
+ <div class='push'></div><!-- for sticky footer -->
369
+ </div><!-- /wrapper -->
370
+ <div class='footer quiet pad2 space-top1 center small'>
371
+ Code coverage generated by
372
+ <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
373
+ at Sun Mar 27 2022 18:00:09 GMT+0200 (Mitteleuropäische Sommerzeit)
374
+ </div>
375
+ </div>
376
+ <script src="../../../../prettify.js"></script>
377
+ <script>
378
+ window.onload = function () {
379
+ prettyPrint();
380
+ };
381
+ </script>
382
+ <script src="../../../../sorter.js"></script>
383
+ <script src="../../../../block-navigation.js"></script>
384
+ </body>
385
+ </html>
386
+