k2hr3-api 1.0.42 → 2.0.1

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 (149) hide show
  1. package/config/k2hr3-init.sh.templ +4 -4
  2. package/dist/.gitkeep +0 -0
  3. package/dist/src/app.js +262 -0
  4. package/{bin → dist/src/bin}/run.sh +1 -1
  5. package/dist/src/bin/watcher.js +113 -0
  6. package/dist/src/bin/www.js +217 -0
  7. package/dist/src/lib/basicipcheck.js +392 -0
  8. package/dist/src/lib/cacerts.js +106 -0
  9. package/dist/src/lib/dbglogging.js +190 -0
  10. package/dist/src/lib/dummyuserapi.js +719 -0
  11. package/dist/src/lib/ipwatch.js +354 -0
  12. package/dist/src/lib/k2hr3acrutil.js +532 -0
  13. package/dist/src/lib/k2hr3apiutil.js +1444 -0
  14. package/dist/src/lib/k2hr3cliutil.js +183 -0
  15. package/dist/src/lib/k2hr3config.js +832 -0
  16. package/dist/src/lib/k2hr3cryptutil.js +258 -0
  17. package/dist/src/lib/k2hr3dkc.js +12121 -0
  18. package/dist/src/lib/k2hr3extdata.js +198 -0
  19. package/dist/src/lib/k2hr3keys.js +207 -0
  20. package/dist/src/lib/k2hr3resutil.js +111 -0
  21. package/dist/src/lib/k2hr3template.js +6546 -0
  22. package/dist/src/lib/k2hr3tokens.js +2643 -0
  23. package/dist/src/lib/k2hr3userdata.js +296 -0
  24. package/dist/src/lib/k8soidc.js +1000 -0
  25. package/dist/src/lib/openstackapiv2.js +695 -0
  26. package/dist/src/lib/openstackapiv3.js +932 -0
  27. package/dist/src/lib/openstackep.js +667 -0
  28. package/{tests/auto_common.js → dist/src/lib/types.js} +4 -38
  29. package/dist/src/routes/acr.js +704 -0
  30. package/dist/src/routes/debugVerify.js +294 -0
  31. package/dist/src/routes/extdata.js +219 -0
  32. package/dist/src/routes/list.js +264 -0
  33. package/dist/src/routes/policy.js +840 -0
  34. package/dist/src/routes/resource.js +1489 -0
  35. package/dist/src/routes/role.js +2627 -0
  36. package/dist/src/routes/service.js +908 -0
  37. package/dist/src/routes/tenant.js +1141 -0
  38. package/dist/src/routes/userTokens.js +482 -0
  39. package/dist/src/routes/userdata.js +212 -0
  40. package/dist/src/routes/version.js +103 -0
  41. package/package.json +152 -121
  42. package/ChangeLog +0 -378
  43. package/app.js +0 -292
  44. package/bin/watcher +0 -122
  45. package/bin/www +0 -180
  46. package/eslint.config.mjs +0 -68
  47. package/lib/basicipcheck.js +0 -376
  48. package/lib/cacerts.js +0 -71
  49. package/lib/dbglogging.js +0 -151
  50. package/lib/dummyuserapi.js +0 -766
  51. package/lib/ipwatch.js +0 -379
  52. package/lib/k2hr3acrutil.js +0 -516
  53. package/lib/k2hr3apiutil.js +0 -1494
  54. package/lib/k2hr3cliutil.js +0 -191
  55. package/lib/k2hr3config.js +0 -826
  56. package/lib/k2hr3cryptutil.js +0 -254
  57. package/lib/k2hr3dkc.js +0 -12632
  58. package/lib/k2hr3extdata.js +0 -198
  59. package/lib/k2hr3keys.js +0 -234
  60. package/lib/k2hr3resutil.js +0 -100
  61. package/lib/k2hr3template.js +0 -6925
  62. package/lib/k2hr3tokens.js +0 -2799
  63. package/lib/k2hr3userdata.js +0 -312
  64. package/lib/k8soidc.js +0 -1012
  65. package/lib/openstackapiv2.js +0 -764
  66. package/lib/openstackapiv3.js +0 -1032
  67. package/lib/openstackep.js +0 -553
  68. package/routes/acr.js +0 -738
  69. package/routes/debugVerify.js +0 -263
  70. package/routes/extdata.js +0 -232
  71. package/routes/list.js +0 -270
  72. package/routes/policy.js +0 -869
  73. package/routes/resource.js +0 -1441
  74. package/routes/role.js +0 -2664
  75. package/routes/service.js +0 -894
  76. package/routes/tenant.js +0 -1095
  77. package/routes/userTokens.js +0 -511
  78. package/routes/userdata.js +0 -218
  79. package/routes/version.js +0 -108
  80. package/templ/Dockerfile.templ +0 -71
  81. package/tests/auto_acr.js +0 -1101
  82. package/tests/auto_acr_spec.js +0 -79
  83. package/tests/auto_all_spec.js +0 -142
  84. package/tests/auto_control_subprocess.sh +0 -243
  85. package/tests/auto_extdata.js +0 -220
  86. package/tests/auto_extdata_spec.js +0 -79
  87. package/tests/auto_init_config_json.sh +0 -275
  88. package/tests/auto_k2hdkc_server.ini +0 -109
  89. package/tests/auto_k2hdkc_slave.ini +0 -83
  90. package/tests/auto_list.js +0 -439
  91. package/tests/auto_list_spec.js +0 -79
  92. package/tests/auto_policy.js +0 -1579
  93. package/tests/auto_policy_spec.js +0 -79
  94. package/tests/auto_resource.js +0 -10956
  95. package/tests/auto_resource_spec.js +0 -79
  96. package/tests/auto_role.js +0 -6150
  97. package/tests/auto_role_spec.js +0 -79
  98. package/tests/auto_service.js +0 -770
  99. package/tests/auto_service_spec.js +0 -79
  100. package/tests/auto_subprocesses.js +0 -114
  101. package/tests/auto_template.sh +0 -126
  102. package/tests/auto_tenant.js +0 -1100
  103. package/tests/auto_tenant_spec.js +0 -79
  104. package/tests/auto_token_util.js +0 -219
  105. package/tests/auto_userdata.js +0 -292
  106. package/tests/auto_userdata_spec.js +0 -79
  107. package/tests/auto_usertokens.js +0 -565
  108. package/tests/auto_usertokens_spec.js +0 -79
  109. package/tests/auto_version.js +0 -127
  110. package/tests/auto_version_spec.js +0 -79
  111. package/tests/auto_watcher.js +0 -157
  112. package/tests/auto_watcher_spec.js +0 -79
  113. package/tests/k2hdkc_test.data +0 -986
  114. package/tests/k2hdkc_test_load.sh +0 -255
  115. package/tests/k2hr3template_test.js +0 -187
  116. package/tests/k2hr3template_test.sh +0 -339
  117. package/tests/k2hr3template_test_async.js +0 -216
  118. package/tests/k2hr3template_test_template.result +0 -7117
  119. package/tests/k2hr3template_test_template.txt +0 -3608
  120. package/tests/k2hr3template_test_vars.js +0 -194
  121. package/tests/manual_acr_delete.js +0 -143
  122. package/tests/manual_acr_get.js +0 -297
  123. package/tests/manual_acr_postput.js +0 -215
  124. package/tests/manual_allusertenant_get.js +0 -113
  125. package/tests/manual_extdata_get.js +0 -191
  126. package/tests/manual_k2hr3keys_get.js +0 -84
  127. package/tests/manual_list_gethead.js +0 -230
  128. package/tests/manual_policy_delete.js +0 -132
  129. package/tests/manual_policy_gethead.js +0 -275
  130. package/tests/manual_policy_postput.js +0 -297
  131. package/tests/manual_resource_delete.js +0 -433
  132. package/tests/manual_resource_gethead.js +0 -423
  133. package/tests/manual_resource_postput.js +0 -487
  134. package/tests/manual_role_delete.js +0 -404
  135. package/tests/manual_role_gethead.js +0 -547
  136. package/tests/manual_role_postput.js +0 -544
  137. package/tests/manual_service_delete.js +0 -153
  138. package/tests/manual_service_gethead.js +0 -178
  139. package/tests/manual_service_postput.js +0 -348
  140. package/tests/manual_tenant_delete.js +0 -186
  141. package/tests/manual_tenant_gethead.js +0 -268
  142. package/tests/manual_tenant_postput.js +0 -293
  143. package/tests/manual_test.sh +0 -352
  144. package/tests/manual_userdata_get.js +0 -173
  145. package/tests/manual_usertoken_gethead.js +0 -136
  146. package/tests/manual_usertoken_postput.js +0 -310
  147. package/tests/manual_version_get.js +0 -127
  148. package/tests/run_local_test_k2hdkc.sh +0 -174
  149. package/tests/test.sh +0 -333
package/lib/k8soidc.js DELETED
@@ -1,1012 +0,0 @@
1
- /*
2
- * K2HR3 REST API
3
- *
4
- * Copyright 2017 Yahoo Japan Corporation.
5
- *
6
- * K2HR3 is K2hdkc based Resource and Roles and policy Rules, gathers
7
- * common management information for the cloud.
8
- * K2HR3 can dynamically manage information as "who", "what", "operate".
9
- * These are stored as roles, resources, policies in K2hdkc, and the
10
- * client system can dynamically read and modify these information.
11
- *
12
- * For the full copyright and license information, please view
13
- * the license file that was distributed with this source code.
14
- *
15
- * AUTHOR: Hirotaka Wakabayashi
16
- * CREATE: Fri, Aug 20 2021
17
- * REVISION:
18
- *
19
- */
20
-
21
- //------------------------------------------------------------------------
22
- // Usage
23
- //------------------------------------------------------------------------
24
- // To enable this module, make the following settings in the K2HR3 API
25
- // configuration file(ex, production.json/local.json/etc).
26
- //
27
- // {
28
- // 'keystone': {
29
- // 'type': 'k8soidc'
30
- // }
31
- // }
32
- //
33
- // Set the value of the 'keystone'->'type' object to 'k8soidc'.
34
- //
35
- // Next, this module requires its own information, so the following
36
- // settings in configuration file are required.
37
- //
38
- // {
39
- // 'k8soidc': {
40
- // 'audience': '<client id for open id connect>',
41
- // 'issuer': '<issue url for open id connect>',
42
- // 'usernamekey': '<user name key name in token>',
43
- // 'k8sapi_url': '<kubernetes api url>',
44
- // 'k8s_ca_path': '<CA cert file path for kubernetes api url>',
45
- // 'k8s_sa_token': '<Service account token for kubernetes>'
46
- // 'unscopedtoken_exp':'<Expire limit for unscoped Token created from oidc>'
47
- // }
48
- // }
49
- //
50
- // Set the 'k8soidc' object as above. This object should contain the
51
- // following keys(objects). The contents of each setting are explained.
52
- //
53
- // [audience]
54
- // Set the client id for Open id connect. This key and value are
55
- // required.
56
- // [issuer]
57
- // Set the issuer URL of Open id connect. This key and value are
58
- // required.
59
- // [usernamekey]
60
- // Specify the key name that is the Username set in the Token of
61
- // Open id connect. If there is no key representing Username in
62
- // Token, it can be omitted. If omitted, the value of the 'sub'
63
- // key is treated as the Username.
64
- // [k8sapi_url]
65
- // Specify the URL of the Kubernetes API. This module accesses
66
- // the Kubernetes API to get the list of Kubernetes Namespaces.
67
- // For example, that is 'https://kubernetes.default.svc'. This key
68
- // and value are required.
69
- // [k8s_ca_path]
70
- // Specify the path of the CA certificate to access the Kubernetes
71
- // API. If you're running the K2HR3 API inside a Kubernetes pod,
72
- // it's '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt'.
73
- // This key and value are required.
74
- // [k8s_sa_token]
75
- // Specify the Token of the Service Account to access the Kubernetes
76
- // API. If you're running the K2HR3 API inside a Kubernetes pod,
77
- // it's '/var/run/secrets/kubernetes.io/serviceaccount/token'.
78
- // This key and value are required.
79
- // [unscopedtoken_exp]
80
- // Specifies the expiration date of the Unscoped token created by
81
- // OIDC. This value is specified in seconds(s).
82
- // If this value does not exist or is less than or equal to 0,
83
- // the default value will be used. The default value is the same
84
- // as the OIDC token expiration date.
85
- //
86
- //------------------------------------------------------------------------
87
-
88
- 'use strict';
89
-
90
- var apiutil = require('./k2hr3apiutil');
91
- var k2hr3 = require('./k2hr3dkc');
92
- var r3keys = require('./k2hr3keys').getK2hr3Keys;
93
-
94
- // Debug logging objects
95
- var r3logger = require('../lib/dbglogging');
96
-
97
- // decode oidc token libraries
98
- var { decode } = require('jose').base64url;
99
- var { jwtVerify } = require('jose');
100
- var { createRemoteJWKSet } = require('jose');
101
-
102
- // kubernetes client api
103
- var k8sclientapi = require('@kubernetes/client-node');
104
- var fs = require('fs');
105
-
106
- // https library
107
- var https = require('https');
108
-
109
- // const variables
110
- var K8S_PUBLISHER_NAME = 'K8SOIDC';
111
- var K8S_REGION_NAME = 'K8sCluster';
112
- var OIDC_JWKS_URI_KEYNAME = 'jwks_uri';
113
-
114
- //
115
- // Global variables from configuration file
116
- //
117
- var oidc_config = null;
118
- var oidc_audience = null;
119
- var oidc_issuer = null;
120
- var oidc_jwks_uri = null;
121
- var oidc_username = null;
122
- var k8s_api_url = null;
123
- var k8s_ca_cert = null;
124
- var k2hr3_k8s_sa_token = null;
125
- var unscopedtoken_exp = 0; // Expire limit for unscoped Token created from oidc(default is 0 means as same as oidc limit)
126
-
127
- (function()
128
- {
129
- var r3Conf = require('./k2hr3config').r3ApiConfig;
130
- var apiConf = new r3Conf();
131
- oidc_config = apiConf.getOtherObject('k8soidc');
132
-
133
- if(apiutil.isSafeEntity(oidc_config)){
134
- oidc_audience = oidc_config.audience;
135
- oidc_issuer = oidc_config.issuer;
136
- oidc_username = oidc_config.usernamekey;
137
- k8s_api_url = oidc_config.k8sapi_url;
138
- k8s_ca_cert = oidc_config.k8s_ca_path;
139
- k2hr3_k8s_sa_token = fs.readFileSync(oidc_config.k8s_sa_token, 'utf8');
140
-
141
- // unscopedtoken_exp must be number
142
- if(apiutil.isSafeEntity(oidc_config.unscopedtoken_exp) && !isNaN(oidc_config.unscopedtoken_exp) && 0 < oidc_config.unscopedtoken_exp){
143
- unscopedtoken_exp = oidc_config.unscopedtoken_exp;
144
- }
145
- }
146
- }());
147
-
148
- //---------------------------------------------------------
149
- // User Token for k8s oidc
150
- //---------------------------------------------------------
151
- //
152
- // user : user name which is verified authentication
153
- // user_id : user id which is verified authentication
154
- // expire_limit : specify expire second(default 24H = 24 * 60 * 60 sec), and allow empty
155
- //
156
- // result : {
157
- // result: true/false
158
- // message: null or error message string
159
- // token: undefined(error) or user token string
160
- // expire_at: expire date(UTC ISO 8601)
161
- // token_seed: JSON token seed data
162
- // userid: user id
163
- // }
164
- //
165
- // [NOTE]
166
- // user token seed value is following
167
- // {
168
- // publisher: "K8SOIDC"
169
- // userexid: "user extra id(a part of seed uuid4)"
170
- // date: "UTC ISO 8601 time at create"
171
- // expire: "UTC ISO 8601 time at expire"
172
- // creator: "User full yrn"
173
- // base: "32byte hex string"
174
- // user: "user name"
175
- // ip: always null
176
- // hostname: always null
177
- // port: always 0
178
- // cuk: always null
179
- // extra: always null
180
- // tenant: if scoped token, this is "tenant name". if not, this is null
181
- // }
182
- //
183
- function rawCreateUserTokenByK8sUser(user, user_id, tenant, expire_limit)
184
- {
185
- var resobj = {result: true, message: null};
186
-
187
- if(!apiutil.isSafeString(user)){ // allow another parameter is null
188
- resobj.result = false;
189
- resobj.message = 'parameter is wrong : user=' + JSON.stringify(user);
190
- r3logger.elog(resobj.message);
191
- return resobj;
192
- }
193
- if(!apiutil.isSafeStrUuid4(user_id)){ // user_id is uuid4
194
- resobj.result = false;
195
- resobj.message = 'parameter is wrong : user_id(must be uuid4)=' + JSON.stringify(user_id);
196
- r3logger.elog(resobj.message);
197
- return resobj;
198
- }
199
- if(!apiutil.isSafeString(tenant)){
200
- tenant = null;
201
- }
202
- if(0 < unscopedtoken_exp){
203
- expire_limit = unscopedtoken_exp; // override expire limit by config
204
- }else{
205
- if(!apiutil.isSafeEntity(expire_limit) || isNaN(expire_limit) || expire_limit <= 0){
206
- expire_limit = 24 * 60 * 60; // default 24H
207
- }
208
- }
209
-
210
- var dkcobj = k2hr3.getK2hdkc(true, false); // use permanent object(need to clean)
211
- user = user.toLowerCase();
212
- var keys = r3keys(user, null);
213
- if(!apiutil.isSafeEntity(dkcobj)){
214
- resobj.result = false;
215
- resobj.message = 'Not initialize yet.';
216
- r3logger.elog(resobj.message);
217
- return resobj;
218
- }
219
-
220
- var user_id_uuid4 = user_id; // user id must be UUID4
221
- var user_ex_id = apiutil.getStrUuid4(); // set seed(uuid4)
222
-
223
- // make token seed value
224
- var now_unixtime = apiutil.getUnixtime();
225
- var token_seed = {};
226
- token_seed.publisher= K8S_PUBLISHER_NAME; // "K8SOIDC"
227
- token_seed.userexid = user_ex_id; // seed(uuid4)
228
- token_seed.date = (new Date(now_unixtime * 1000)).toISOString(); // now date(UTC ISO 8601)
229
- token_seed.expire = (new Date((now_unixtime + expire_limit) * 1000)).toISOString(); // expire date(UTC ISO 8601)
230
- token_seed.creator = keys.USER_KEY; // "yrn:yahoo::::user:<user>"
231
- token_seed.user = user; // user(creator)
232
- token_seed.hostname = null; // hostname(creator)
233
- token_seed.ip = null; // ip(creator)
234
- token_seed.port = 0; // port(creator)
235
- token_seed.cuk = null; // cuk(creator)
236
- token_seed.extra = null; // extra(creator)
237
- token_seed.tenant = tenant; // tenant(if scope, not null)
238
-
239
- // user token and yrn key
240
- var user_token = '';
241
- var token_user_key = null;
242
-
243
- // create key
244
- for(var is_loop = true; is_loop; ){ // for eslint
245
- // make user token
246
- var token_elements = apiutil.makeStringToken256(user_ex_id, user_id_uuid4);
247
- if(!apiutil.isSafeEntity(token_elements)){
248
- resobj.result = false;
249
- resobj.message = 'could not make token from ' + JSON.stringify(user_ex_id) + ' and ' + JSON.stringify(user_id);
250
- r3logger.elog(resobj.message);
251
- dkcobj.clean();
252
- return resobj;
253
- }
254
- user_token = token_elements.str_token;
255
- token_seed.base = token_elements.str_base; // token base
256
-
257
- // user token key
258
- token_user_key = keys.TOKEN_USER_TOP_KEY + '/' + user_token; // "yrn:yahoo::::token:user/<user token>"
259
-
260
- // get user token for existing check
261
- var value = dkcobj.getValue(token_user_key, null, true, null);
262
- if(!apiutil.isSafeEntity(value)){
263
- // succeed uniq token
264
- break;
265
- }
266
- r3logger.dlog('conflict user token(' + user_token + ') which already is used, so remake token for uniq.');
267
- }
268
-
269
- // Add user token/expire/seed into result object.
270
- resobj.token = user_token;
271
- resobj.expire_at = token_seed.expire;
272
- resobj.token_seed = JSON.stringify(token_seed);
273
- resobj.userid = user_id;
274
-
275
- dkcobj.clean();
276
- return resobj;
277
- }
278
-
279
- //---------------------------------------------------------
280
- // Verify User Token Publisher For k8s oidc
281
- //---------------------------------------------------------
282
- //
283
- // token_seed : token seed data
284
- //
285
- // result : {
286
- // result: true/false
287
- // message: null or error message string
288
- // }
289
- //
290
- function rawWrapVerifyUserTokenPublisherForK8s(token_seed)
291
- {
292
- var resobj = {result: true, message: null};
293
-
294
- var seed = apiutil.parseJSON(token_seed);
295
- if( !apiutil.isSafeEntity(seed) ||
296
- !apiutil.isSafeString(seed.publisher) ||
297
- (seed.publisher != K8S_PUBLISHER_NAME) ) // publisher must be 'K8SOIDC'
298
- {
299
- resobj.result = false;
300
- resobj.message = 'token_seed(not printable) is not safe entity.';
301
- r3logger.elog(resobj.message);
302
- return resobj;
303
- }
304
- return resobj;
305
- }
306
-
307
- //---------------------------------------------------------
308
- // Verify User Token (OIDC Token)
309
- //---------------------------------------------------------
310
- //
311
- // dkcobj_permanent : dkcobj object
312
- // user : target user name for token
313
- // tenant : target tenant name for token(if token is scoped)
314
- // token : check token
315
- // token_seed : token seed data
316
- //
317
- // result : {
318
- // result: true/false
319
- // message: null or error message string
320
- // }
321
- //
322
- function rawVerifyUserTokenByK8sUser(dkcobj_permanent, user, tenant, token, token_seed)
323
- {
324
- var resobj = {result: true, message: null};
325
-
326
- if(!apiutil.isSafeStrings(token, token_seed, user)){
327
- resobj.result = false;
328
- resobj.message = 'some parameters are wrong : token=' + JSON.stringify(token) + ', token_seed=<not printable>, user=' + JSON.stringify(user);
329
- r3logger.elog(resobj.message);
330
- return resobj;
331
- }
332
-
333
- // check all seed values
334
- var seed = apiutil.parseJSON(token_seed);
335
- if( !apiutil.isSafeEntity(seed) ||
336
- !apiutil.isSafeString(seed.publisher) ||
337
- (seed.publisher != K8S_PUBLISHER_NAME) || // publisher must be 'K8SOIDC'
338
- !apiutil.isSafeString(seed.userexid) ||
339
- !apiutil.isSafeString(seed.date) ||
340
- !apiutil.isSafeString(seed.expire) ||
341
- !apiutil.isSafeString(seed.creator) ||
342
- !apiutil.isSafeString(seed.base) ||
343
- !apiutil.isSafeString(seed.user) ||
344
- !apiutil.compareCaseString(seed.user, user))
345
- {
346
- resobj.result = false;
347
- resobj.message = 'token_seed(not printable) is not safe entity.';
348
- r3logger.elog(resobj.message);
349
- return resobj;
350
- }
351
-
352
- // check expire
353
- if(apiutil.isExpired(seed.expire)){
354
- resobj.result = false;
355
- resobj.message = 'token is expired by expire date(' + seed.expire + ') in token_seed.';
356
- r3logger.elog(resobj.message);
357
- return resobj;
358
- }
359
-
360
- // check tenant name(if tenant is specified, seed must have same tenant name)
361
- if(apiutil.isSafeString(seed.tenant) !== apiutil.isSafeString(tenant) || (apiutil.isSafeString(seed.tenant) && !apiutil.compareCaseString(seed.tenant, tenant))){
362
- resobj.result = false;
363
- resobj.message = 'token_seed(not printable) is (un)scoped, but tenant name is (not) specified. Then unmatched.';
364
- r3logger.elog(resobj.message);
365
- return resobj;
366
- }
367
-
368
- // k2hdkc
369
- var keys = r3keys(seed.user, seed.tenant);
370
- var dkcobj = dkcobj_permanent;
371
- if(!apiutil.isSafeEntity(dkcobj)){
372
- dkcobj = k2hr3.getK2hdkc(true, false); // use permanent object(need to clean)
373
- if(!apiutil.isSafeEntity(dkcobj)){
374
- resobj.result = false;
375
- resobj.message = 'Not initialize yet.';
376
- r3logger.elog(resobj.message);
377
- return resobj;
378
- }
379
- }
380
-
381
- // get user id
382
- var userid = dkcobj.getValue(keys.USER_ID_KEY, null, true, null); // get user id from "yrn:yahoo::::user:<user>:id"
383
- if(!apiutil.isSafeEntity(dkcobj_permanent)){
384
- dkcobj.clean();
385
- }
386
- if(!apiutil.isSafeString(userid)){
387
- resobj.result = false;
388
- resobj.message = 'could not get user id for user(' + seed.user + ').';
389
- r3logger.elog(resobj.message);
390
- return resobj;
391
- }
392
-
393
- // make verify token
394
- var token_elements = apiutil.makeStringToken256(seed.userexid, userid, seed.base);
395
- if(!apiutil.isSafeEntity(token_elements)){
396
- resobj.result = false;
397
- resobj.message = 'could not make verify token from ' + JSON.stringify(seed.userexid) + ' and ' + JSON.stringify(userid) + ' and ' + JSON.stringify(seed.base);
398
- r3logger.elog(resobj.message);
399
- return resobj;
400
- }
401
- if(token !== token_elements.str_token){
402
- resobj.result = false;
403
- resobj.message = 'token(' + token + ') verify is failure, verify token is ' + token_elements.str_token + '.';
404
- r3logger.elog(resobj.message);
405
- return resobj;
406
- }
407
-
408
- return resobj;
409
- }
410
-
411
- //---------------------------------------------------------
412
- // Get User/Tenant information by User Token
413
- //---------------------------------------------------------
414
- //
415
- // Result: {
416
- // result: true/false
417
- // message: null or error message string
418
- // user: user name
419
- // userid: user id
420
- // tenant: if token is scoped token, this value is set tenant name.
421
- // }
422
- //
423
- function rawGetUserTenantInfoByUserToken(token)
424
- {
425
- var resobj = {result: true, message: null};
426
-
427
- if(!apiutil.isSafeString(token)){
428
- resobj.result = false;
429
- resobj.message = 'parameter is wrong : token=' + JSON.stringify(token);
430
- r3logger.elog(resobj.message);
431
- return resobj;
432
- }
433
- var dkcobj = k2hr3.getK2hdkc(true, false); // use permanent object(need to clean)
434
- var keys = r3keys();
435
- if(!apiutil.isSafeEntity(dkcobj)){
436
- resobj.result = false;
437
- resobj.message = 'Not initialize yet.';
438
- r3logger.elog(resobj.message);
439
- return resobj;
440
- }
441
-
442
- // get token key under user key
443
- var token_value_key = keys.TOKEN_USER_TOP_KEY + '/' + token; // "yrn:yahoo::::token:user/<token>"
444
- var user_token_key = dkcobj.getValue(token_value_key, null, true, null); // "yrn:yahoo::::user:<user>:tenant/{<tenant>}/token/<token>"
445
- if(!apiutil.isSafeString(user_token_key)){
446
- resobj.result = false;
447
- resobj.message = 'token key(' + token_value_key + ') for token(' + token + ') is not existed.';
448
- r3logger.elog(resobj.message);
449
- dkcobj.clean();
450
- return resobj;
451
- }
452
-
453
- // get user name and tenant name from token key yrn path
454
- var pattern = new RegExp('^' + keys.MATCH_ANY_USER_TOKEN); // regex = /^yrn:yahoo::::user:(.*):tenant\/(.*)\/token\/(.*)/
455
- var matches = user_token_key.match(pattern); // reverse to user/tenant names
456
- if(apiutil.isEmptyArray(matches) || matches.length < 4 || '' === apiutil.getSafeString(matches[1])){
457
- resobj.result = false;
458
- resobj.message = 'token key(' + token_value_key + ') for token(' + token + ') has wrong format value(' + user_token_key + ')';
459
- r3logger.elog(resobj.message);
460
- dkcobj.clean();
461
- return resobj;
462
- }
463
- var token_user = apiutil.getSafeString(matches[1]);
464
- var token_tenant= apiutil.getSafeString(matches[2]);
465
- if('' === token_tenant){
466
- token_tenant= null;
467
- }
468
-
469
- // get token seed
470
- var user_token_seed_key = user_token_key + '/' + keys.SEED_KW; // "yrn:yahoo::::user:<user>:tenant/{<tenant>}/token/<token>/seed"
471
- var token_seed = dkcobj.getValue(user_token_seed_key, null, true, null);
472
- if(!apiutil.isSafeString(token_seed)){
473
- resobj.result = false;
474
- resobj.message = 'token key(' + token_value_key + ') for token(' + token + ') does not have token seed data.';
475
- r3logger.elog(resobj.message);
476
- dkcobj.clean();
477
- return resobj;
478
- }
479
-
480
- // verify token
481
- var vres = rawVerifyUserTokenByK8sUser(dkcobj, token_user, token_tenant, token, token_seed);
482
- if(!vres.result){
483
- resobj.result = false;
484
- resobj.message = 'failed to verify token(' + token + ') with seed by ' + vres.message;
485
- r3logger.elog(resobj.message);
486
- dkcobj.clean();
487
- return resobj;
488
- }
489
-
490
- // get user id
491
- keys = r3keys(token_user, null); // remake keys
492
- var userid = dkcobj.getValue(keys.USER_ID_KEY, null, true, null); // get user id from "yrn:yahoo::::user:<user>:id"
493
- if(!apiutil.isSafeString(userid)){
494
- resobj.result = false;
495
- resobj.message = 'could not get user id for user(' + token_user + ').';
496
- r3logger.elog(resobj.message);
497
- dkcobj.clean();
498
- return resobj;
499
- }
500
- dkcobj.clean();
501
-
502
- // make result
503
- resobj.user = token_user;
504
- resobj.userid = userid;
505
- resobj.tenant = token_tenant;
506
-
507
- return resobj;
508
- }
509
-
510
- //---------------------------------------------------------
511
- // Verify (Un)scoped Token
512
- //---------------------------------------------------------
513
- //
514
- // token : unscoped/scoped token
515
- //
516
- function rawVerifyUnscopedToken(token)
517
- {
518
- if(!apiutil.isSafeString(token)){
519
- r3logger.elog('token(' + JSON.stringify(token) + ') parameter is wrong.');
520
- return false;
521
- }
522
-
523
- var dkcobj = k2hr3.getK2hdkc(true, false); // use permanent object(need to clean)
524
- var keys = r3keys();
525
- if(!apiutil.isSafeEntity(dkcobj)){
526
- r3logger.elog('K2hdkc client is not initialized yet.');
527
- return false;
528
- }
529
-
530
- // get token key under user key
531
- var token_value_key = keys.TOKEN_USER_TOP_KEY + '/' + token; // "yrn:yahoo::::token:user/<token>"
532
- var user_token_key = dkcobj.getValue(token_value_key, null, true, null); // "yrn:yahoo::::user:<user>:tenant/{<tenant>}/token/<token>"
533
- if(!apiutil.isSafeString(user_token_key)){
534
- r3logger.elog('token key(' + token_value_key + ') for token(' + token + ') is not existed.');
535
- dkcobj.clean();
536
- return false;
537
- }
538
-
539
- // get user name and tenant name from token key yrn path
540
- var pattern = new RegExp('^' + keys.MATCH_ANY_USER_TOKEN); // regex = /^yrn:yahoo::::user:(.*):tenant\/(.*)\/token\/(.*)/
541
- var matches = user_token_key.match(pattern); // reverse to user/tenant names
542
- if(apiutil.isEmptyArray(matches) || matches.length < 4 || '' === apiutil.getSafeString(matches[1])){
543
- r3logger.elog('token key(' + token_value_key + ') for token(' + token + ') has wrong format value(' + user_token_key + ')');
544
- dkcobj.clean();
545
- return false;
546
- }
547
- var token_user = apiutil.getSafeString(matches[1]);
548
- var token_tenant= apiutil.getSafeString(matches[2]);
549
- if('' === token_tenant){
550
- token_tenant= null;
551
- }
552
-
553
- // get token seed
554
- var user_token_seed_key = user_token_key + '/' + keys.SEED_KW; // "yrn:yahoo::::user:<user>:tenant/{<tenant>}/token/<token>/seed"
555
- var token_seed = dkcobj.getValue(user_token_seed_key, null, true, null);
556
- if(!apiutil.isSafeString(token_seed)){
557
- r3logger.elog('token key(' + token_value_key + ') for token(' + token + ') does not have token seed data.');
558
- dkcobj.clean();
559
- return false;
560
- }
561
-
562
- // verify token
563
- var vres = rawVerifyUserTokenByK8sUser(dkcobj, token_user, token_tenant, token, token_seed);
564
- if(!vres.result){
565
- r3logger.elog('failed to verify token(' + token + ') with seed by ' + vres.message);
566
- dkcobj.clean();
567
- return false;
568
- }
569
- dkcobj.clean();
570
- return true;
571
- }
572
-
573
- //---------------------------------------------------------
574
- // Get Scoped token from k8s user token
575
- //---------------------------------------------------------
576
- //
577
- // callback(error, result):
578
- // result = {
579
- // user: user name
580
- // userid: user id
581
- // scoped: always true
582
- // token: token string
583
- // expire: expire string(UTC ISO 8601)
584
- // region: region string
585
- // token_seed: JSON token seed data
586
- // }
587
- //
588
- // [NOTE]
589
- // The token is allowed scoped token, but it must be same tenant token.
590
- //
591
- function rawGetUserScopedTokenK8s(token, tenant, callback)
592
- {
593
- var error;
594
-
595
- if(!apiutil.isSafeStrings(token, tenant)){
596
- error = new Error('some parameters are wrong : token=' + JSON.stringify(token) + ', tenant=' + JSON.stringify(tenant));
597
- r3logger.elog(error.message);
598
- callback(error, null);
599
- return;
600
- }
601
-
602
- // verify and get user/tenant information
603
- var token_info = rawGetUserTenantInfoByUserToken(token);
604
- if(!token_info.result){
605
- error = new Error('could not get any information from token(' + token + '), result : ' + token_info.message);
606
- r3logger.elog(error.message);
607
- callback(error, null);
608
- return;
609
- }
610
-
611
- // check tenant name
612
- if(apiutil.isSafeString(token_info.tenant) && token_info.tenant !== tenant){
613
- error = new Error('token(' + token + ') has scoped(' + token_info.tenant + '), but it is not as same as the request tenant(' + tenant + ').');
614
- r3logger.elog(error.message);
615
- callback(error, null);
616
- return;
617
- }
618
-
619
- // create scoped token
620
- var resobj = rawCreateUserTokenByK8sUser(token_info.user, token_info.userid, tenant); // not specify expire limit now(using default).
621
- if(!resobj.result){
622
- error = new Error('could not create user scoped token for uname(' + token_info.user + ')/user id(' + token_info.userid + ') for tenant(' + tenant + ').');
623
- r3logger.elog(error.message);
624
- callback(error, null);
625
- return;
626
- }
627
-
628
- // make result
629
- var result = {};
630
- result.user = token_info.user;
631
- result.userid = token_info.userid;
632
- result.scoped = true;
633
- result.token = resobj.token;
634
- result.expire = resobj.expire_at;
635
- result.region = K8S_REGION_NAME;
636
- result.token_seed = resobj.token_seed;
637
-
638
- callback(null, result);
639
- }
640
-
641
- //---------------------------------------------------------
642
- // Get Unscoped token by oidc token
643
- //---------------------------------------------------------
644
- //
645
- // callback(error, result):
646
- // result = {
647
- // user: user name User name in token: set user name if specified user name key name in config. if not specified, set user id
648
- // userid: user id User id in token: payload in token has 'sub' key, it is user id.
649
- // scoped: false (always false)
650
- // token: token string(id) OIDC Token
651
- // expire: expire string expire in token: payload in token has 'exp' key, it is expire unix time.
652
- // region: region string (always n/a)
653
- // token_seed: seed ({publisher: 'K8SOIDC'})
654
- // }
655
- //
656
-
657
- //
658
- // Utility - Verify OIDC token and get user name
659
- //
660
- // token: oidc token
661
- //
662
- async function rawVerifyTokenAndGetUsername(token)
663
- {
664
- var jwtParam = {
665
- issuer: oidc_issuer,
666
- audience: oidc_audience
667
- };
668
-
669
- var myPromise = function(issuer_url, conf_key){
670
- return new Promise(function(resolve, reject){
671
- https.get(oidc_issuer + '/.well-known/openid-configuration', function(res){
672
- if(res.statusCode !== 200){
673
- res.resume();
674
- reject('statusCode should be 200, not ', res.statusCode);
675
- }
676
- res.setEncoding('utf8');
677
- let rawData = '';
678
- res.on('data', function(chunk){ rawData += chunk; });
679
- res.on('end', function(){
680
- var parsedData = apiutil.parseJSON(rawData);
681
- if(apiutil.isSafeEntity(parsedData[conf_key])){
682
- resolve(parsedData[conf_key]);
683
- }else{
684
- var errorMsg = ('the ' + conf_key + ' key should exist, but no such a key');
685
- r3logger.elog(errorMsg);
686
- reject(errorMsg);
687
- }
688
- });
689
- }).on('error', function(err){
690
- r3logger.elog(err.message);
691
- reject(err.message);
692
- });
693
- });
694
- };
695
-
696
- // 1. Calls async here.
697
- async function asyncFunction(){
698
- // 2. Calls await() here.
699
- try{
700
- oidc_jwks_uri = await myPromise(oidc_issuer, OIDC_JWKS_URI_KEYNAME);
701
- if(!apiutil.isSafeString(oidc_jwks_uri)){
702
- var error = new Error('oidc_jwks_uri should be defined, but no oidc_jwks_uri.');
703
- r3logger.elog(error.message);
704
- throw error;
705
- }
706
- }catch(err){
707
- r3logger.elog(err.message);
708
- throw err;
709
- }
710
- var JWKS = createRemoteJWKSet(new URL(oidc_jwks_uri));
711
- var { payload, protectedHeader } = await jwtVerify(token, JWKS, jwtParam).catch(function(err){ // eslint-disable-line no-unused-vars
712
- r3logger.elog(err.message);
713
- throw err;
714
- });
715
-
716
- var userName = null;
717
- if(apiutil.isSafeString(oidc_username)){
718
- userName = payload[oidc_username];
719
- }else{
720
- if(apiutil.isSafeString(payload.sub)){
721
- userName = payload.sub;
722
- }
723
- }
724
- if(!apiutil.isSafeString(userName)){
725
- error = new Error('failed to verify token for getting user name.');
726
- r3logger.elog(error.message);
727
- throw error;
728
- }
729
- return userName;
730
- }
731
- return asyncFunction();
732
- }
733
-
734
- function rawGetUserUnscopedTokenK8s(token, callback)
735
- {
736
- if(!apiutil.isSafeString(token)){
737
- var error = new Error('oidc token parameter is not string or empty.');
738
- r3logger.elog(error.message);
739
- callback(error, null);
740
- return;
741
- }
742
-
743
- //
744
- // Check the id_token.
745
- //
746
- // see. https://openid.net/specs/openid-connect-core-1_0.html#IDToken
747
- //
748
- var parts = token.split('.', 2);
749
- if(2 !== parts.length){
750
- error = new Error('oidc token must have two parts, but it has ' + parts.length + ' parts.');
751
- r3logger.elog(error.message);
752
- callback(error, null);
753
- return;
754
- }
755
-
756
- //
757
- // decode part[1] to payload
758
- //
759
- var payload = apiutil.parseJSON(new TextDecoder().decode(decode(parts[1])));
760
- if(!apiutil.isSafeEntity(payload)){
761
- error = new Error('could not decode json from the part[1] in oidc token.');
762
- r3logger.elog(error.message);
763
- callback(error, null);
764
- return;
765
- }
766
-
767
- //
768
- // payload must have 'sub' key for user id
769
- //
770
- var userid;
771
- if(apiutil.isSafeString(payload.sub)){
772
- userid = payload.sub;
773
- }else{
774
- error = new Error('token payload should contain sub(userid), but not find sub(userid).');
775
- r3logger.elog(error.message);
776
- callback(error, null);
777
- return;
778
- }
779
-
780
- //
781
- // get user name from payload
782
- //
783
- var username;
784
- if(apiutil.isSafeString(oidc_username)){
785
- if(apiutil.isSafeString(payload[oidc_username])){
786
- username = payload[oidc_username];
787
- }else{
788
- error = new Error('token payload should contain user name(' + oidc_username + '), but not find it.');
789
- r3logger.elog(error.message);
790
- callback(error, null);
791
- return;
792
- }
793
- }else{
794
- // If user name key is not specified, user id will be used instead.
795
- username = userid;
796
- }
797
-
798
- //
799
- // verify token by JWT library and get user name
800
- //
801
- var _callback = callback;
802
- var lower_username = username.toLowerCase(); // to lower case
803
- var verified_username;
804
- rawVerifyTokenAndGetUsername(token).then(function(result){
805
- verified_username = result;
806
-
807
- //
808
- // compare user name
809
- //
810
- if(!apiutil.compareCaseString(lower_username, verified_username)){
811
- error = new Error('oidc token has ' + lower_username + ' username, but verified username(' + verified_username + ') is different.');
812
- r3logger.elog(error.message);
813
- _callback(error, null);
814
- return;
815
- }
816
-
817
- // core seed
818
- var user_id_uuid4 = apiutil.cvtNumberStringToUuid4(userid, 10); // payload.sub is decimal string
819
- var expire_limit;
820
- if(apiutil.isSafeEntity(payload['exp']) && !isNaN(payload['exp'])){
821
- expire_limit = payload['exp'] - apiutil.getUnixtime();
822
- if(expire_limit <= 0){
823
- expire_limit= 24 * 60 * 60; // default 24H
824
- }
825
- }else{
826
- expire_limit = 24 * 60 * 60; // default 24H
827
- }
828
-
829
- // create token
830
- var resobj = rawCreateUserTokenByK8sUser(lower_username, user_id_uuid4, null, expire_limit);
831
- if(!resobj.result){
832
- error = new Error('could not create user token for uname(' + lower_username + ') or something wrong result : ' + resobj.message);
833
- r3logger.elog(error.message);
834
- _callback(error, null);
835
- return;
836
- }
837
-
838
- // make result
839
- var resultobj = {};
840
- resultobj.user = lower_username;
841
- resultobj.userid = resobj.userid;
842
- resultobj.scoped = false;
843
- resultobj.token = resobj.token;
844
- resultobj.expire = resobj.expire_at;
845
- resultobj.region = K8S_REGION_NAME;
846
- resultobj.token_seed = resobj.token_seed;
847
-
848
- _callback(null, resultobj);
849
-
850
- }).catch(function(err){
851
- r3logger.elog(err.message);
852
- _callback(err, null);
853
- return;
854
- });
855
-
856
- return;
857
- }
858
-
859
- //---------------------------------------------------------
860
- // Get tenant list by unscoped token
861
- //---------------------------------------------------------
862
- //
863
- // unscopedtoken: oidc token(Not use)
864
- //
865
- function rawGetUserTenantListK8s(unscopedtoken, callback)
866
- {
867
- if(!apiutil.isSafeString(unscopedtoken)){
868
- var error = new Error('unscopedtoken parameter is wrong.');
869
- r3logger.elog(error.message);
870
- callback(error, null);
871
- return;
872
- }
873
-
874
- // Verify unscoped token
875
- if(!rawVerifyUnscopedToken(unscopedtoken)){
876
- error = new Error('unscopedtoken is not safe, varidation is failed.');
877
- r3logger.elog(error.message);
878
- callback(error, null);
879
- return;
880
- }
881
- var _callback = callback;
882
-
883
- //
884
- // Get Namespaces by Service Access token
885
- //
886
- var cluster = {
887
- server: k8s_api_url,
888
- caFile: k8s_ca_cert,
889
- skipTLSVerify: false
890
- };
891
- var user = {
892
- token: k2hr3_k8s_sa_token // [NOTE] k2hr3_k8s_sa_token is global variable
893
- };
894
-
895
- var kubeconfig = new k8sclientapi.KubeConfig();
896
- kubeconfig.loadFromClusterAndUser(cluster, user);
897
-
898
- var k8sApi = kubeconfig.makeApiClient(k8sclientapi.CoreV1Api);
899
- k8sApi.setDefaultAuthentication({
900
- applyToRequest: function(opts){ // [NOTE] Make this an arrow function in the future.
901
- opts.headers.Authorization = 'Bearer ' + k2hr3_k8s_sa_token, // [NOTE] k2hr3_k8s_sa_token is global variable
902
- opts.rejectUnauthorized = false;
903
- }
904
- });
905
-
906
- var k8s_ns = ['kube-node-lease', 'kube-public', 'kube-system', 'kubernetes-dashboard'];
907
- var resarr = new Array;
908
- k8sApi.listNamespace().then(function(response){ // [NOTE] Using Promise
909
- for(var pos = 0; pos < response.body.items.length; ++pos){
910
- // check body...items
911
- if( !apiutil.isSafeEntity(response.body) ||
912
- !apiutil.isArray(response.body.items) ||
913
- !apiutil.isSafeEntity(response.body.items[pos].metadata) ||
914
- !apiutil.isSafeString(response.body.items[pos].metadata.name) )
915
- {
916
- r3logger.wlog('one of response for project(tenant) list is something wrong : ' + JSON.stringify(response.body));
917
- continue;
918
- }
919
-
920
- // Is the k8s cluster namespace in kubernetes system namespaces?
921
- if(apiutil.findStringInArray(k8s_ns, response.body.items[pos].metadata.name)){
922
- continue;
923
- }
924
- var tenant = {};
925
- tenant.name = response.body.items[pos].metadata.name;
926
- tenant.id = response.body.items[pos].metadata.uid;
927
- tenant.description = response.body.items[pos].metadata.name;
928
- tenant.display = response.body.items[pos].metadata.name;
929
- resarr.push(tenant);
930
- }
931
-
932
- if(0 === resarr.length){
933
- error = new Error('no tenant exists');
934
- r3logger.elog(error.message);
935
- _callback(error, null);
936
- return;
937
- }
938
- _callback(null, resarr);
939
-
940
- }).catch (function(error) {
941
- r3logger.elog(error.message);
942
- _callback(error, null);
943
- });
944
- return;
945
- }
946
-
947
- //---------------------------------------------------------
948
- // Exports
949
- //---------------------------------------------------------
950
- //
951
- // uname: username
952
- // passwd: passwd
953
- //
954
- exports.getUserUnscopedToken = function(uname, passwd, callback)
955
- {
956
- var error = new Error('getUserUnscopedToken is not implemented');
957
- r3logger.elog(error.message);
958
- callback(error, null);
959
- };
960
-
961
- //
962
- // Get Unscoped Token
963
- //
964
- // token: OIDC token
965
- //
966
- exports.getUserUnscopedTokenByToken = function(token, callback)
967
- {
968
- return rawGetUserUnscopedTokenK8s(token, callback);
969
- };
970
-
971
- //
972
- // Get Scoped Token
973
- //
974
- // tenantid: not used
975
- //
976
- exports.getUserScopedToken = function(unscopedtoken, tenantname, tenantid, callback)
977
- {
978
- return rawGetUserScopedTokenK8s(unscopedtoken, tenantname, callback);
979
- };
980
-
981
- //
982
- // Verify publisher type in seed
983
- //
984
- exports.verifyUserTokenPublisher = function(token_seed)
985
- {
986
- return rawWrapVerifyUserTokenPublisherForK8s(token_seed);
987
- };
988
-
989
- //
990
- // Verify token
991
- //
992
- exports.verifyUserToken = function(user, tenant, token, token_seed)
993
- {
994
- return rawVerifyUserTokenByK8sUser(null, user, tenant, token, token_seed);
995
- };
996
-
997
- //
998
- // Get tenant list
999
- //
1000
- exports.getUserTenantList = function(unscopedtoken, userid, callback)
1001
- {
1002
- return rawGetUserTenantListK8s(unscopedtoken, callback);
1003
- };
1004
-
1005
- /*
1006
- * Local variables:
1007
- * tab-width: 4
1008
- * c-basic-offset: 4
1009
- * End:
1010
- * vim600: noexpandtab sw=4 ts=4 fdm=marker
1011
- * vim<600: noexpandtab sw=4 ts=4
1012
- */