samlesa 2.13.0 → 2.14.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.

Potentially problematic release.


This version of samlesa might be problematic. Click here for more details.

Files changed (149) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +36 -65
  3. package/build/.idea/deployment.xml +14 -0
  4. package/{src → build}/.idea/modules.xml +1 -1
  5. package/build/.idea/workspace.xml +57 -0
  6. package/build/index.js +18 -54
  7. package/build/index.js.map +1 -1
  8. package/build/src/api.js +18 -24
  9. package/build/src/api.js.map +1 -1
  10. package/build/src/binding-post.js +337 -365
  11. package/build/src/binding-post.js.map +1 -1
  12. package/build/src/binding-redirect.js +312 -340
  13. package/build/src/binding-redirect.js.map +1 -1
  14. package/build/src/binding-simplesign.js +201 -229
  15. package/build/src/binding-simplesign.js.map +1 -1
  16. package/build/src/entity-idp.js +119 -127
  17. package/build/src/entity-idp.js.map +1 -1
  18. package/build/src/entity-sp.js +88 -96
  19. package/build/src/entity-sp.js.map +1 -1
  20. package/build/src/entity.js +193 -225
  21. package/build/src/entity.js.map +1 -1
  22. package/build/src/extractor.js +361 -369
  23. package/build/src/extractor.js.map +1 -1
  24. package/build/src/flow.js +313 -320
  25. package/build/src/flow.js.map +1 -1
  26. package/build/src/libsaml.js +693 -721
  27. package/build/src/libsaml.js.map +1 -1
  28. package/build/src/metadata-idp.js +119 -127
  29. package/build/src/metadata-idp.js.map +1 -1
  30. package/build/src/metadata-sp.js +223 -231
  31. package/build/src/metadata-sp.js.map +1 -1
  32. package/build/src/metadata.js +138 -166
  33. package/build/src/metadata.js.map +1 -1
  34. package/build/src/types.js +4 -11
  35. package/build/src/types.js.map +1 -1
  36. package/build/src/urn.js +204 -212
  37. package/build/src/urn.js.map +1 -1
  38. package/build/src/utility.js +277 -292
  39. package/build/src/utility.js.map +1 -1
  40. package/build/src/validator.js +24 -27
  41. package/build/src/validator.js.map +1 -1
  42. package/package.json +19 -14
  43. package/types/api.d.ts +15 -0
  44. package/types/api.d.ts.map +1 -0
  45. package/types/binding-post.d.ts +48 -0
  46. package/types/binding-post.d.ts.map +1 -0
  47. package/types/binding-redirect.d.ts +54 -0
  48. package/types/binding-redirect.d.ts.map +1 -0
  49. package/types/binding-simplesign.d.ts +41 -0
  50. package/types/binding-simplesign.d.ts.map +1 -0
  51. package/types/entity-idp.d.ts +38 -0
  52. package/types/entity-idp.d.ts.map +1 -0
  53. package/types/entity-sp.d.ts +38 -0
  54. package/types/entity-sp.d.ts.map +1 -0
  55. package/types/entity.d.ts +100 -0
  56. package/types/entity.d.ts.map +1 -0
  57. package/types/extractor.d.ts +26 -0
  58. package/types/extractor.d.ts.map +1 -0
  59. package/types/flow.d.ts +7 -0
  60. package/types/flow.d.ts.map +1 -0
  61. package/types/index.d.ts +11 -10
  62. package/types/index.d.ts.map +1 -0
  63. package/types/libsaml.d.ts +208 -0
  64. package/types/libsaml.d.ts.map +1 -0
  65. package/types/metadata-idp.d.ts +25 -0
  66. package/types/metadata-idp.d.ts.map +1 -0
  67. package/types/metadata-sp.d.ts +37 -0
  68. package/types/metadata-sp.d.ts.map +1 -0
  69. package/types/metadata.d.ts +58 -0
  70. package/types/metadata.d.ts.map +1 -0
  71. package/types/src/api.d.ts +15 -13
  72. package/types/src/api.d.ts.map +1 -0
  73. package/types/src/binding-post.d.ts +48 -47
  74. package/types/src/binding-post.d.ts.map +1 -0
  75. package/types/src/binding-redirect.d.ts +54 -53
  76. package/types/src/binding-redirect.d.ts.map +1 -0
  77. package/types/src/binding-simplesign.d.ts +41 -40
  78. package/types/src/binding-simplesign.d.ts.map +1 -0
  79. package/types/src/entity-idp.d.ts +38 -37
  80. package/types/src/entity-idp.d.ts.map +1 -0
  81. package/types/src/entity-sp.d.ts +38 -36
  82. package/types/src/entity-sp.d.ts.map +1 -0
  83. package/types/src/entity.d.ts +100 -101
  84. package/types/src/entity.d.ts.map +1 -0
  85. package/types/src/extractor.d.ts +26 -25
  86. package/types/src/extractor.d.ts.map +1 -0
  87. package/types/src/flow.d.ts +7 -6
  88. package/types/src/flow.d.ts.map +1 -0
  89. package/types/src/libsaml.d.ts +208 -209
  90. package/types/src/libsaml.d.ts.map +1 -0
  91. package/types/src/metadata-idp.d.ts +25 -24
  92. package/types/src/metadata-idp.d.ts.map +1 -0
  93. package/types/src/metadata-sp.d.ts +37 -36
  94. package/types/src/metadata-sp.d.ts.map +1 -0
  95. package/types/src/metadata.d.ts +58 -59
  96. package/types/src/metadata.d.ts.map +1 -0
  97. package/types/src/types.d.ts +128 -129
  98. package/types/src/types.d.ts.map +1 -0
  99. package/types/src/urn.d.ts +195 -194
  100. package/types/src/urn.d.ts.map +1 -0
  101. package/types/src/utility.d.ts +133 -134
  102. package/types/src/utility.d.ts.map +1 -0
  103. package/types/src/validator.d.ts +4 -3
  104. package/types/src/validator.d.ts.map +1 -0
  105. package/types/types.d.ts +128 -0
  106. package/types/types.d.ts.map +1 -0
  107. package/types/urn.d.ts +195 -0
  108. package/types/urn.d.ts.map +1 -0
  109. package/types/utility.d.ts +133 -0
  110. package/types/utility.d.ts.map +1 -0
  111. package/types/validator.d.ts +4 -0
  112. package/types/validator.d.ts.map +1 -0
  113. package/.editorconfig +0 -19
  114. package/.github/FUNDING.yml +0 -1
  115. package/.idea/inspectionProfiles/Project_Default.xml +0 -6
  116. package/.idea/modules.xml +0 -8
  117. package/.idea/vcs.xml +0 -6
  118. package/.pre-commit.sh +0 -15
  119. package/.snyk +0 -8
  120. package/.travis.yml +0 -29
  121. package/Makefile +0 -25
  122. package/index.d.ts +0 -10
  123. package/index.js +0 -19
  124. package/index.js.map +0 -1
  125. package/index.ts +0 -28
  126. package/qodana.yaml +0 -29
  127. package/src/.idea/src.iml +0 -12
  128. package/src/.idea/vcs.xml +0 -6
  129. package/src/api.ts +0 -36
  130. package/src/binding-post.ts +0 -348
  131. package/src/binding-redirect.ts +0 -356
  132. package/src/binding-simplesign.ts +0 -238
  133. package/src/entity-idp.ts +0 -153
  134. package/src/entity-sp.ts +0 -114
  135. package/src/entity.ts +0 -243
  136. package/src/extractor.ts +0 -392
  137. package/src/flow.ts +0 -467
  138. package/src/libsaml.ts +0 -895
  139. package/src/metadata-idp.ts +0 -146
  140. package/src/metadata-sp.ts +0 -268
  141. package/src/metadata.ts +0 -166
  142. package/src/types.ts +0 -153
  143. package/src/urn.ts +0 -211
  144. package/src/utility.ts +0 -319
  145. package/src/validator.ts +0 -39
  146. package/tsconfig.json +0 -38
  147. package/tslint.json +0 -35
  148. package/types.d.ts +0 -2
  149. /package/{.idea/samlify.iml → build/.idea/build.iml} +0 -0
@@ -1,356 +0,0 @@
1
- /**
2
- * @file binding-redirect.ts
3
- * @author tngan
4
- * @desc Binding-level API, declare the functions using Redirect binding
5
- */
6
- import utility, {get} from './utility.js';
7
- import libsaml from './libsaml.js';
8
- import {BindingContext} from './entity.js';
9
- import {IdentityProvider as Idp} from './entity-idp.js';
10
- import {ServiceProvider as Sp} from './entity-sp.js';
11
-
12
- import {wording, namespace} from './urn.js';
13
-
14
- const binding = wording.binding;
15
- const urlParams = wording.urlParams;
16
-
17
- export interface BuildRedirectConfig {
18
- baseUrl: string;
19
- type: string;
20
- isSigned: boolean;
21
- context: string;
22
- entitySetting: any;
23
- relayState?: string;
24
- }
25
-
26
- /**
27
- * @private
28
- * @desc Helper of generating URL param/value pair
29
- * @param {string} param key
30
- * @param {string} value value of key
31
- * @param {boolean} first determine whether the param is the starting one in order to add query header '?'
32
- * @return {string}
33
- */
34
- function pvPair(param: string, value: string, first?: boolean): string {
35
- return (first === true ? '?' : '&') + param + '=' + value;
36
- }
37
-
38
- /**
39
- * @private
40
- * @desc Refractored part of URL generation for login/logout request
41
- * @param {string} type
42
- * @param {boolean} isSigned
43
- * @param {string} rawSamlRequest
44
- * @param {object} entitySetting
45
- * @return {string}
46
- */
47
- function buildRedirectURL(opts: BuildRedirectConfig) {
48
- const {
49
- baseUrl,
50
- type,
51
- isSigned,
52
- context,
53
- entitySetting,
54
- } = opts;
55
- let {relayState = ''} = opts;
56
- let noParams = true
57
- try {
58
- noParams = new URL(baseUrl)?.searchParams?.size === 0
59
- } catch {
60
- noParams = true
61
- }
62
-
63
- const queryParam = libsaml.getQueryParamByType(type);
64
- // In general, this xmlstring is required to do deflate -> base64 -> urlencode
65
- const samlRequest = encodeURIComponent(utility.base64Encode(utility.deflateString(context)));
66
- if (relayState !== '') {
67
- relayState = pvPair(urlParams.relayState, encodeURIComponent(relayState));
68
- }
69
- if (isSigned) {
70
- const sigAlg = pvPair(urlParams.sigAlg, encodeURIComponent(entitySetting.requestSignatureAlgorithm));
71
- const octetString = samlRequest + relayState + sigAlg;
72
- return baseUrl
73
- + pvPair(queryParam, octetString, noParams)
74
- + pvPair(urlParams.signature, encodeURIComponent(
75
- libsaml.constructMessageSignature(
76
- queryParam + '=' + octetString,
77
- entitySetting.privateKey,
78
- entitySetting.privateKeyPass,
79
- undefined,
80
- entitySetting.requestSignatureAlgorithm
81
- ).toString()
82
- )
83
- );
84
- }
85
- return baseUrl + pvPair(queryParam, samlRequest + relayState, noParams);
86
- }
87
-
88
- /**
89
- * @desc Redirect URL for login request
90
- * @param {object} entity object includes both idp and sp
91
- * @param {function} customTagReplacement used when developers have their own login response template
92
- * @return {string} redirect URL
93
- */
94
- function loginRequestRedirectURL(entity: {
95
- idp: Idp,
96
- sp: Sp
97
- }, customTagReplacement?: (template: string) => BindingContext): BindingContext {
98
-
99
- const metadata: any = {idp: entity.idp.entityMeta, sp: entity.sp.entityMeta};
100
- const spSetting: any = entity.sp.entitySetting;
101
- let id: string = '';
102
-
103
- if (metadata && metadata.idp && metadata.sp) {
104
- const base = metadata.idp.getSingleSignOnService(binding.redirect);
105
- let rawSamlRequest: string;
106
- if (spSetting.loginRequestTemplate && customTagReplacement) {
107
- const info = customTagReplacement(spSetting.loginRequestTemplate);
108
- id = get(info, 'id', null);
109
- rawSamlRequest = get(info, 'context', null);
110
- } else {
111
- const nameIDFormat = spSetting.nameIDFormat;
112
- const selectedNameIDFormat = Array.isArray(nameIDFormat) ? nameIDFormat[0] : nameIDFormat;
113
- id = spSetting.generateID();
114
- rawSamlRequest = libsaml.replaceTagsByValue(libsaml.defaultLoginRequestTemplate.context, {
115
- ID: id,
116
- Destination: base,
117
- Issuer: metadata.sp.getEntityID(),
118
- IssueInstant: new Date().toISOString(),
119
- NameIDFormat: selectedNameIDFormat,
120
- AssertionConsumerServiceURL: metadata.sp.getAssertionConsumerService(binding.post),
121
- EntityID: metadata.sp.getEntityID(),
122
- AllowCreate: spSetting.allowCreate,
123
- } as any);
124
- }
125
- return {
126
- id,
127
- context: buildRedirectURL({
128
- context: rawSamlRequest,
129
- type: urlParams.samlRequest,
130
- isSigned: metadata.sp.isAuthnRequestSigned(),
131
- entitySetting: spSetting,
132
- baseUrl: base,
133
- relayState: spSetting.relayState,
134
- }),
135
- };
136
- }
137
- throw new Error('ERR_GENERATE_REDIRECT_LOGIN_REQUEST_MISSING_METADATA');
138
- }
139
-
140
- /**
141
- * @desc Redirect URL for login response
142
- * @param {object} requestInfo corresponding request, used to obtain the id
143
- * @param {object} entity object includes both idp and sp
144
- * @param {object} user current logged user (e.g. req.user)
145
- * @param {String} relayState the relaystate sent by sp corresponding request
146
- * @param {function} customTagReplacement used when developers have their own login response template
147
- * @param AttributeStatement
148
- */
149
- function loginResponseRedirectURL(requestInfo: any, entity: any, user: any = {}, relayState?: string, customTagReplacement?: (template: string) => BindingContext,AttributeStatement =[]): BindingContext {
150
- const idpSetting = entity.idp.entitySetting;
151
- const spSetting = entity.sp.entitySetting;
152
- const metadata = {
153
- idp: entity.idp.entityMeta,
154
- sp: entity.sp.entityMeta,
155
- };
156
-
157
- let id: string = idpSetting.generateID();
158
- if (metadata && metadata.idp && metadata.sp) {
159
- const base = metadata.sp.getAssertionConsumerService(binding.redirect) ;
160
- if(!base){
161
- throw new Error('dont have a base url');
162
- }
163
- let rawSamlResponse: string;
164
- //
165
- const nameIDFormat = idpSetting.nameIDFormat;
166
- const selectedNameIDFormat = Array.isArray(nameIDFormat) ? nameIDFormat[0] : nameIDFormat;
167
- const nowTime = new Date();
168
- // Five minutes later : nowtime + 5 * 60 * 1000 (in milliseconds)
169
- const fiveMinutesLaterTime = new Date(nowTime.getTime() + 300_000);
170
- const now = nowTime.toISOString();
171
- console.log(`现在是北京时间:${nowTime.toLocaleString()}`)
172
- const sessionIndex = 'session'+idpSetting.generateID(); // 这个是当前系统的会话索引,用于单点注销
173
- const tenHoursLaterTime = new Date(nowTime.getTime());
174
- tenHoursLaterTime.setHours(tenHoursLaterTime.getHours() + 10);
175
- const tenHoursLater = tenHoursLaterTime.toISOString();
176
- const tvalue: any = {
177
- ID: id,
178
- AssertionID: idpSetting.generateID(),
179
- Destination: base,
180
- SubjectRecipient: base,
181
- Issuer: metadata.idp.getEntityID(),
182
- Audience: metadata.sp.getEntityID(),
183
- EntityID: metadata.sp.getEntityID(),
184
- IssueInstant: nowTime.toISOString(),
185
- AssertionConsumerServiceURL: base,
186
- StatusCode: namespace.statusCode.success,
187
- // can be customized
188
- ConditionsNotBefore: nowTime.toISOString(),
189
- ConditionsNotOnOrAfter: fiveMinutesLaterTime.toISOString(),
190
- SubjectConfirmationDataNotOnOrAfter: fiveMinutesLaterTime.toISOString(),
191
- NameIDFormat: selectedNameIDFormat,
192
- NameID: user.NameID || '',
193
- InResponseTo: get(requestInfo, 'extract.request.id', ''),
194
- AuthnStatement: `<saml:AuthnStatement AuthnInstant="${now}" SessionNotOnOrAfter="${tenHoursLater}" SessionIndex="${sessionIndex}"><saml:AuthnContext><saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:Password</saml:AuthnContextClassRef></saml:AuthnContext></saml:AuthnStatement>`,
195
- AttributeStatement: libsaml.attributeStatementBuilder(AttributeStatement),
196
- };
197
-
198
- if (idpSetting.loginResponseTemplate && customTagReplacement) {
199
- const template = customTagReplacement(idpSetting.loginResponseTemplate.context);
200
- id = get(template, 'id', null);
201
- rawSamlResponse = get(template, 'context', null);
202
- } else {
203
-
204
- if (requestInfo !== null) {
205
- tvalue.InResponseTo = requestInfo?.extract?.request?.id;
206
- }
207
- rawSamlResponse = libsaml.replaceTagsByValue(libsaml.defaultLoginResponseTemplate.context, tvalue);
208
- }
209
-
210
- const {privateKey, privateKeyPass, requestSignatureAlgorithm: signatureAlgorithm} = idpSetting;
211
- const config = {
212
- privateKey,
213
- privateKeyPass,
214
- signatureAlgorithm,
215
- signingCert: metadata.idp.getX509Certificate('signing'),
216
- isBase64Output: false,
217
- };
218
- // step: sign assertion ? -> encrypted ? -> sign message ?
219
- if (metadata.sp.isWantAssertionsSigned()) {
220
- rawSamlResponse = libsaml.constructSAMLSignature({
221
- ...config,
222
- rawSamlMessage: rawSamlResponse,
223
- transformationAlgorithms: spSetting.transformationAlgorithms,
224
- referenceTagXPath: "/*[local-name(.)='Response']/*[local-name(.)='Assertion']",
225
- signatureConfig: {
226
- prefix: 'ds',
227
- location: {
228
- reference: "/*[local-name(.)='Response']/*[local-name(.)='Assertion']/*[local-name(.)='Issuer']",
229
- action: 'after'
230
- },
231
- },
232
- });
233
- }
234
-
235
- // Like in post binding, SAML response is always signed
236
- return {
237
- id,
238
- context: buildRedirectURL({
239
- baseUrl: base,
240
- type: urlParams.samlResponse,
241
- isSigned: true,
242
- context: rawSamlResponse,
243
- entitySetting: idpSetting,
244
- relayState,
245
- }),
246
- };
247
- }
248
- throw new Error('ERR_GENERATE_REDIRECT_LOGIN_RESPONSE_MISSING_METADATA');
249
- }
250
-
251
- /**
252
- * @desc Redirect URL for logout request
253
- * @param {object} user current logged user (e.g. req.user)
254
- * @param {object} entity object includes both idp and sp
255
- * @param {function} customTagReplacement used when developers have their own login response template
256
- * @return {string} redirect URL
257
- */
258
- function logoutRequestRedirectURL(user, entity, relayState?: string, customTagReplacement?: (template: string, tags: object) => BindingContext): BindingContext {
259
- const metadata = {init: entity.init.entityMeta, target: entity.target.entityMeta};
260
- const initSetting = entity.init.entitySetting;
261
- let id: string = initSetting.generateID();
262
- const nameIDFormat = initSetting.nameIDFormat;
263
- const selectedNameIDFormat = Array.isArray(nameIDFormat) ? nameIDFormat[0] : nameIDFormat;
264
-
265
- if (metadata && metadata.init && metadata.target) {
266
- const base = metadata.target.getSingleLogoutService(binding.redirect);
267
- let rawSamlRequest: string = '';
268
- const requiredTags = {
269
- ID: id,
270
- Destination: base,
271
- EntityID: metadata.init.getEntityID(),
272
- Issuer: metadata.init.getEntityID(),
273
- IssueInstant: new Date().toISOString(),
274
- NameIDFormat: selectedNameIDFormat,
275
- NameID: user.NameID || '',
276
- SessionIndex: user.sessionIndex,
277
- };
278
- if (initSetting.logoutRequestTemplate && customTagReplacement) {
279
- const info = customTagReplacement(initSetting.logoutRequestTemplate, requiredTags);
280
- id = get(info, 'id', null);
281
- rawSamlRequest = get(info, 'context', null);
282
- } else {
283
- rawSamlRequest = libsaml.replaceTagsByValue(libsaml.defaultLogoutRequestTemplate.context, requiredTags as any);
284
- }
285
- return {
286
- id,
287
- context: buildRedirectURL({
288
- context: rawSamlRequest,
289
- relayState,
290
- type: urlParams.logoutRequest,
291
- isSigned: entity.target.entitySetting.wantLogoutRequestSigned,
292
- entitySetting: initSetting,
293
- baseUrl: base,
294
- }),
295
- };
296
- }
297
- throw new Error('ERR_GENERATE_REDIRECT_LOGOUT_REQUEST_MISSING_METADATA');
298
- }
299
-
300
- /**
301
- * @desc Redirect URL for logout response
302
- * @param {object} requescorresponding request, used to obtain the id
303
- * @param {object} entity object includes both idp and sp
304
- * @param {function} customTagReplacement used when developers have their own login response template
305
- */
306
- function logoutResponseRedirectURL(requestInfo: any, entity: any, relayState?: string, customTagReplacement?: (template: string) => BindingContext): BindingContext {
307
- const metadata = {
308
- init: entity.init.entityMeta,
309
- target: entity.target.entityMeta,
310
- };
311
- const initSetting = entity.init.entitySetting;
312
- let id: string = initSetting.generateID();
313
- if (metadata && metadata.init && metadata.target) {
314
- const base = metadata.target.getSingleLogoutService(binding.redirect);
315
- let rawSamlResponse: string;
316
- if (initSetting.logoutResponseTemplate && customTagReplacement) {
317
- const template = customTagReplacement(initSetting.logoutResponseTemplate);
318
- id = get(template, 'id', null);
319
- rawSamlResponse = get(template, 'context', null);
320
- } else {
321
- const tvalue: any = {
322
- ID: id,
323
- Destination: base,
324
- Issuer: metadata.init.getEntityID(),
325
- EntityID: metadata.init.getEntityID(),
326
- IssueInstant: new Date().toISOString(),
327
- StatusCode: namespace.statusCode.success,
328
- };
329
- if (requestInfo && requestInfo.extract && requestInfo.extract.request) {
330
- tvalue.InResponseTo = requestInfo?.extract?.request?.id;
331
- }
332
- rawSamlResponse = libsaml.replaceTagsByValue(libsaml.defaultLogoutResponseTemplate.context, tvalue);
333
- }
334
- return {
335
- id,
336
- context: buildRedirectURL({
337
- baseUrl: base,
338
- type: urlParams.logoutResponse,
339
- isSigned: entity.target.entitySetting.wantLogoutResponseSigned,
340
- context: rawSamlResponse,
341
- entitySetting: initSetting,
342
- relayState,
343
- }),
344
- };
345
- }
346
- throw new Error('ERR_GENERATE_REDIRECT_LOGOUT_RESPONSE_MISSING_METADATA');
347
- }
348
-
349
- const redirectBinding = {
350
- loginRequestRedirectURL,
351
- loginResponseRedirectURL,
352
- logoutRequestRedirectURL,
353
- logoutResponseRedirectURL,
354
- };
355
-
356
- export default redirectBinding;
@@ -1,238 +0,0 @@
1
- /**
2
- * @file binding-simplesign.ts
3
- * @author Orange
4
- * @desc Binding-level API, declare the functions using POST SimpleSign binding
5
- */
6
-
7
- import { wording, StatusCode } from './urn.js';
8
- import { BindingContext, SimpleSignComputedContext } from './entity.js';
9
- import libsaml from './libsaml.js';
10
- import utility, { get } from './utility.js';
11
-
12
- const binding = wording.binding;
13
- const urlParams = wording.urlParams;
14
-
15
- export interface BuildSimpleSignConfig {
16
- type: string;
17
- context: string;
18
- entitySetting: any;
19
- relayState?: string;
20
- }
21
-
22
- export interface BindingSimpleSignContext {
23
- id: string;
24
- context: string;
25
- signature: any;
26
- sigAlg: string;
27
- }
28
-
29
- /**
30
- * @private
31
- * @desc Helper of generating URL param/value pair
32
- * @param {string} param key
33
- * @param {string} value value of key
34
- * @param {boolean} first determine whether the param is the starting one in order to add query header '?'
35
- * @return {string}
36
- */
37
- function pvPair(param: string, value: string, first?: boolean): string {
38
- return (first === true ? '?' : '&') + param + '=' + value;
39
- }
40
- /**
41
- * @private
42
- * @desc Refactored part of simple signature generation for login/logout request
43
- * @param {string} type
44
- * @param {string} rawSamlRequest
45
- * @param {object} entitySetting
46
- * @return {string}
47
- */
48
- function buildSimpleSignature(opts: BuildSimpleSignConfig) : string {
49
- const {
50
- type,
51
- context,
52
- entitySetting,
53
- } = opts;
54
- let { relayState = '' } = opts;
55
- const queryParam = libsaml.getQueryParamByType(type);
56
-
57
- if (relayState !== '') {
58
- relayState = pvPair(urlParams.relayState, relayState);
59
- }
60
-
61
- const sigAlg = pvPair(urlParams.sigAlg, entitySetting.requestSignatureAlgorithm);
62
- const octetString = context + relayState + sigAlg;
63
- return libsaml.constructMessageSignature(
64
- queryParam + '=' + octetString,
65
- entitySetting.privateKey,
66
- entitySetting.privateKeyPass,
67
- undefined,
68
- entitySetting.requestSignatureAlgorithm
69
- ).toString();
70
- }
71
-
72
- /**
73
- * @desc Generate a base64 encoded login request
74
- * @param {string} referenceTagXPath reference uri
75
- * @param {object} entity object includes both idp and sp
76
- * @param {function} customTagReplacement used when developers have their own login response template
77
- */
78
- function base64LoginRequest(entity: any, customTagReplacement?: (template: string) => BindingContext): SimpleSignComputedContext {
79
- const metadata = { idp: entity.idp.entityMeta, sp: entity.sp.entityMeta };
80
- const spSetting = entity.sp.entitySetting;
81
- let id: string = '';
82
-
83
- if (metadata && metadata.idp && metadata.sp) {
84
- const base = metadata.idp.getSingleSignOnService(binding.simpleSign);
85
- let rawSamlRequest: string;
86
- if (spSetting.loginRequestTemplate && customTagReplacement) {
87
- const info = customTagReplacement(spSetting.loginRequestTemplate.context);
88
- id = get(info, 'id', null);
89
- rawSamlRequest = get(info, 'context', null);
90
- } else {
91
- const nameIDFormat = spSetting.nameIDFormat;
92
- const selectedNameIDFormat = Array.isArray(nameIDFormat) ? nameIDFormat[0] : nameIDFormat;
93
- id = spSetting.generateID();
94
- rawSamlRequest = libsaml.replaceTagsByValue(libsaml.defaultLoginRequestTemplate.context, {
95
- ID: id,
96
- Destination: base,
97
- Issuer: metadata.sp.getEntityID(),
98
- IssueInstant: new Date().toISOString(),
99
- AssertionConsumerServiceURL: metadata.sp.getAssertionConsumerService(binding.simpleSign),
100
- EntityID: metadata.sp.getEntityID(),
101
- AllowCreate: spSetting.allowCreate,
102
- NameIDFormat: selectedNameIDFormat
103
- } as any);
104
- }
105
-
106
- let simpleSignatureContext : any = null;
107
- if (metadata.idp.isWantAuthnRequestsSigned()) {
108
- const simpleSignature = buildSimpleSignature({
109
- type: urlParams.samlRequest,
110
- context: rawSamlRequest,
111
- entitySetting: spSetting,
112
- relayState: spSetting.relayState,
113
- });
114
-
115
- simpleSignatureContext = {
116
- signature: simpleSignature,
117
- sigAlg: spSetting.requestSignatureAlgorithm,
118
- };
119
- }
120
- // No need to embeded XML signature
121
- return {
122
- id,
123
- context: utility.base64Encode(rawSamlRequest),
124
- ...simpleSignatureContext,
125
- };
126
- }
127
- throw new Error('ERR_GENERATE_POST_SIMPLESIGN_LOGIN_REQUEST_MISSING_METADATA');
128
- }
129
- /**
130
- * @desc Generate a base64 encoded login response
131
- * @param {object} requestInfo corresponding request, used to obtain the id
132
- * @param {object} entity object includes both idp and sp
133
- * @param {object} user current logged user (e.g. req.user)
134
- * @param {string} relayState the relay state
135
- * @param {function} customTagReplacement used when developers have their own login response template
136
- * @param AttributeStatement
137
- */
138
- async function base64LoginResponse(requestInfo: any = {}, entity: any, user: any = {}, relayState?: string, customTagReplacement?: (template: string) => BindingContext, AttributeStatement:[] = []): Promise<BindingSimpleSignContext> {
139
- const idpSetting = entity.idp.entitySetting;
140
- const spSetting = entity.sp.entitySetting;
141
- const id = idpSetting.generateID();
142
- const metadata = {
143
- idp: entity.idp.entityMeta,
144
- sp: entity.sp.entityMeta,
145
- };
146
- const nameIDFormat = idpSetting.nameIDFormat;
147
- const selectedNameIDFormat = Array.isArray(nameIDFormat) ? nameIDFormat[0] : nameIDFormat;
148
- if (metadata && metadata.idp && metadata.sp) {
149
- const base = metadata.sp.getAssertionConsumerService(binding.simpleSign);
150
- let rawSamlResponse: string;
151
- const nowTime = new Date();
152
- // Five minutes later : nowtime + 5 * 60 * 1000 (in milliseconds)
153
- const fiveMinutesLaterTime = new Date(nowTime.getTime() + 300_000 );
154
- const now = nowTime.toISOString();
155
- console.log(`现在是北京时间:${nowTime.toLocaleString()}`)
156
- const sessionIndex = 'session'+idpSetting.generateID(); // 这个是当前系统的会话索引,用于单点注销
157
- const tenHoursLaterTime = new Date(nowTime.getTime());
158
- tenHoursLaterTime.setHours(tenHoursLaterTime.getHours() + 10);
159
- const tenHoursLater = tenHoursLaterTime.toISOString();
160
- const tvalue: any = {
161
- ID: id,
162
- AssertionID: idpSetting.generateID(),
163
- Destination: base,
164
- Audience: metadata.sp.getEntityID(),
165
- EntityID: metadata.sp.getEntityID(),
166
- SubjectRecipient: base,
167
- Issuer: metadata.idp.getEntityID(),
168
- IssueInstant: nowTime.toISOString(),
169
- AssertionConsumerServiceURL: base,
170
- StatusCode: StatusCode.Success,
171
- // can be customized
172
- ConditionsNotBefore: nowTime.toISOString(),
173
- ConditionsNotOnOrAfter: fiveMinutesLaterTime.toISOString(),
174
- SubjectConfirmationDataNotOnOrAfter: fiveMinutesLaterTime.toISOString(),
175
- NameIDFormat: selectedNameIDFormat,
176
- NameID: user.NameID || '',
177
- InResponseTo: get(requestInfo, 'extract.request.id', ''),
178
- AuthnStatement: `<saml:AuthnStatement AuthnInstant="${now}" SessionNotOnOrAfter="${tenHoursLater}" SessionIndex="${sessionIndex}"><saml:AuthnContext><saml:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:Password</saml:AuthnContextClassRef></saml:AuthnContext></saml:AuthnStatement>`,
179
- AttributeStatement: libsaml.attributeStatementBuilder(AttributeStatement),
180
- };
181
- if (idpSetting.loginResponseTemplate && customTagReplacement) {
182
- const template = customTagReplacement(idpSetting.loginResponseTemplate.context);
183
- rawSamlResponse = get(template, 'context', null);
184
- } else {
185
- if (requestInfo !== null) {
186
- tvalue.InResponseTo = requestInfo?.extract?.request?.id;
187
- }
188
- rawSamlResponse = libsaml.replaceTagsByValue(libsaml.defaultLoginResponseTemplate.context, tvalue);
189
- }
190
- const { privateKey, privateKeyPass, requestSignatureAlgorithm: signatureAlgorithm } = idpSetting;
191
- const config = {
192
- privateKey,
193
- privateKeyPass,
194
- signatureAlgorithm,
195
- signingCert: metadata.idp.getX509Certificate('signing'),
196
- isBase64Output: false,
197
- };
198
- // step: sign assertion ? -> encrypted ? -> sign message ?
199
- if (metadata.sp.isWantAssertionsSigned()) {
200
- rawSamlResponse = libsaml.constructSAMLSignature({
201
- ...config,
202
- rawSamlMessage: rawSamlResponse,
203
- transformationAlgorithms: spSetting.transformationAlgorithms,
204
- referenceTagXPath: "/*[local-name(.)='Response']/*[local-name(.)='Assertion']",
205
- signatureConfig: {
206
- prefix: 'ds',
207
- location: { reference: "/*[local-name(.)='Response']/*[local-name(.)='Assertion']/*[local-name(.)='Issuer']", action: 'after' },
208
- },
209
- });
210
- }
211
-
212
- // SAML response must be signed sign message first, then encrypt
213
- let simpleSignature: string = '';
214
- // like in post and redirect bindings, login response is always signed.
215
- simpleSignature = buildSimpleSignature({
216
- type: urlParams.samlResponse,
217
- context: rawSamlResponse,
218
- entitySetting: idpSetting,
219
- relayState: relayState,
220
- } );
221
-
222
- return Promise.resolve({
223
- id,
224
- context: utility.base64Encode(rawSamlResponse),
225
- signature: simpleSignature,
226
- sigAlg: idpSetting.requestSignatureAlgorithm,
227
- });
228
-
229
- }
230
- throw new Error('ERR_GENERATE_POST_SIMPLESIGN_LOGIN_RESPONSE_MISSING_METADATA');
231
- }
232
-
233
- const simpleSignBinding = {
234
- base64LoginRequest,
235
- base64LoginResponse,
236
- };
237
-
238
- export default simpleSignBinding;