security-setting.js 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178
  1. const loggerFactory = require('@alias/logger');
  2. const logger = loggerFactory('growi:routes:apiv3:security-setting');
  3. const express = require('express');
  4. const router = express.Router();
  5. const { body } = require('express-validator');
  6. const ErrorV3 = require('../../models/vo/error-apiv3');
  7. const removeNullPropertyFromObject = require('../../../lib/util/removeNullPropertyFromObject');
  8. const validator = {
  9. generalSetting: [
  10. body('sessionMaxAge').optional({ checkFalsy: true }).trim().isInt(),
  11. body('restrictGuestMode').if(value => value != null).isString().isIn([
  12. 'Deny', 'Readonly',
  13. ]),
  14. body('pageCompleteDeletionAuthority').if(value => value != null).isString().isIn([
  15. 'anyOne', 'adminOnly', 'adminAndAuthor',
  16. ]),
  17. body('hideRestrictedByOwner').if(value => value != null).isBoolean(),
  18. body('hideRestrictedByGroup').if(value => value != null).isBoolean(),
  19. ],
  20. shareLinkSetting: [
  21. body('disableLinkSharing').if(value => value != null).isBoolean(),
  22. ],
  23. authenticationSetting: [
  24. body('isEnabled').if(value => value != null).isBoolean(),
  25. body('authId').isString().isIn([
  26. 'local', 'ldap', 'saml', 'oidc', 'basic', 'google', 'github', 'twitter',
  27. ]),
  28. ],
  29. localSetting: [
  30. body('registrationMode').isString().isIn([
  31. 'Open', 'Restricted', 'Closed',
  32. ]),
  33. body('registrationWhiteList').if(value => value != null).isArray().customSanitizer((value, { req }) => {
  34. return value.filter(email => email !== '');
  35. }),
  36. ],
  37. ldapAuth: [
  38. body('serverUrl').if(value => value != null).isString(),
  39. body('isUserBind').if(value => value != null).isBoolean(),
  40. body('ldapBindDN').if(value => value != null).isString(),
  41. body('ldapBindDNPassword').if(value => value != null).isString(),
  42. body('ldapSearchFilter').if(value => value != null).isString(),
  43. body('ldapAttrMapUsername').if(value => value != null).isString(),
  44. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  45. body('ldapAttrMapMail').if(value => value != null).isString(),
  46. body('ldapAttrMapName').if(value => value != null).isString(),
  47. body('ldapGroupSearchBase').if(value => value != null).isString(),
  48. body('ldapGroupSearchFilter').if(value => value != null).isString(),
  49. body('ldapGroupDnProperty').if(value => value != null).isString(),
  50. ],
  51. samlAuth: [
  52. body('entryPoint').if(value => value != null).isString(),
  53. body('issuer').if(value => value != null).isString(),
  54. body('cert').if(value => value != null).isString(),
  55. body('attrMapId').if(value => value != null).isString(),
  56. body('attrMapUsername').if(value => value != null).isString(),
  57. body('attrMapMail').if(value => value != null).isString(),
  58. body('attrMapFirstName').if(value => value != null).isString(),
  59. body('attrMapLastName').if(value => value != null).isString(),
  60. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  61. body('isSameEmailTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  62. body('ABLCRule').if(value => value != null).isString(),
  63. ],
  64. oidcAuth: [
  65. body('oidcProviderName').if(value => value != null).isString(),
  66. body('oidcIssuerHost').if(value => value != null).isString(),
  67. body('oidcAuthorizationEndpoint').if(value => value != null).isString(),
  68. body('oidcTokenEndpoint').if(value => value != null).isString(),
  69. body('oidcRevocationEndpoint').if(value => value != null).isString(),
  70. body('oidcIntrospectionEndpoint').if(value => value != null).isString(),
  71. body('oidcUserInfoEndpoint').if(value => value != null).isString(),
  72. body('oidcEndSessionEndpoint').if(value => value != null).isString(),
  73. body('oidcRegistrationEndpoint').if(value => value != null).isString(),
  74. body('oidcJWKSUri').if(value => value != null).isString(),
  75. body('oidcClientId').if(value => value != null).isString(),
  76. body('oidcClientSecret').if(value => value != null).isString(),
  77. body('oidcAttrMapId').if(value => value != null).isString(),
  78. body('oidcAttrMapUserName').if(value => value != null).isString(),
  79. body('oidcAttrMapEmail').if(value => value != null).isString(),
  80. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  81. body('isSameEmailTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  82. ],
  83. basicAuth: [
  84. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  85. ],
  86. googleOAuth: [
  87. body('googleClientId').if(value => value != null).isString(),
  88. body('googleClientSecret').if(value => value != null).isString(),
  89. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  90. ],
  91. githubOAuth: [
  92. body('githubClientId').if(value => value != null).isString(),
  93. body('githubClientSecret').if(value => value != null).isString(),
  94. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  95. ],
  96. twitterOAuth: [
  97. body('twitterConsumerKey').if(value => value != null).isString(),
  98. body('twitterConsumerSecret').if(value => value != null).isString(),
  99. body('isSameUsernameTreatedAsIdenticalUser').if(value => value != null).isBoolean(),
  100. ],
  101. };
  102. /**
  103. * @swagger
  104. * tags:
  105. * name: SecuritySetting
  106. */
  107. /**
  108. * @swagger
  109. *
  110. * components:
  111. * schemas:
  112. * GeneralSetting:
  113. * type: object
  114. * properties:
  115. * restrictGuestMode:
  116. * type: string
  117. * description: type of restrictGuestMode
  118. * pageCompleteDeletionAuthority:
  119. * type: string
  120. * description: type of pageDeletionAuthority
  121. * hideRestrictedByOwner:
  122. * type: boolean
  123. * description: enable hide by owner
  124. * hideRestrictedByGroup:
  125. * type: boolean
  126. * description: enable hide by group
  127. * ShareLinkSetting:
  128. * type: object
  129. * properties:
  130. * disableLinkSharing:
  131. * type: boolean
  132. * description: disable link sharing
  133. * LocalSetting:
  134. * type: object
  135. * properties:
  136. * isLocalEnabled:
  137. * type: boolean
  138. * description: local setting mode
  139. * registrationMode:
  140. * type: string
  141. * description: type of registrationMode
  142. * registrationWhiteList:
  143. * type: array
  144. * description: array of regsitrationList
  145. * items:
  146. * type: string
  147. * description: registration whiteList
  148. * LdapAuthSetting:
  149. * type: object
  150. * properties:
  151. * serverUrl:
  152. * type: string
  153. * description: server url for ldap
  154. * isUserBind:
  155. * type: boolean
  156. * description: enable user bind
  157. * ldapBindDN:
  158. * type: string
  159. * description: the query used to bind with the directory service
  160. * ldapBindDNPassword:
  161. * type: string
  162. * description: the password that is entered in the login page will be used to bind
  163. * ldapSearchFilter:
  164. * type: string
  165. * description: the query used to locate the authenticated user
  166. * ldapAttrMapUsername:
  167. * type: string
  168. * description: specification of mappings for username when creating new users
  169. * isSameUsernameTreatedAsIdenticalUser:
  170. * type: boolean
  171. * description: local account automatically linked the user name matched
  172. * ldapAttrMapMail:
  173. * type: string
  174. * description: specification of mappings for mail address when creating new users
  175. * ldapAttrMapName:
  176. * type: string
  177. * description: Specification of mappings for full name address when creating new users
  178. * ldapGroupSearchBase:
  179. * type: string
  180. * description: the base DN from which to search for groups.
  181. * ldapGroupSearchFilter:
  182. * type: string
  183. * description: the query used to filter for groups
  184. * ldapGroupDnProperty:
  185. * type: string
  186. * description: The property of user object to use in dn interpolation of Group Search Filter
  187. * SamlAuthSetting:
  188. * type: object
  189. * properties:
  190. * samlEntryPoint:
  191. * type: string
  192. * description: entry point for saml
  193. * samlIssuer:
  194. * type: string
  195. * description: issuer for saml
  196. * samlCert:
  197. * type: string
  198. * description: certificate for saml
  199. * samlAttrMapId:
  200. * type: string
  201. * description: attribute mapping id for saml
  202. * samlAttrMapUserName:
  203. * type: string
  204. * description: attribute mapping user name for saml
  205. * samlAttrMapMail:
  206. * type: string
  207. * description: attribute mapping mail for saml
  208. * samlAttrMapFirstName:
  209. * type: string
  210. * description: attribute mapping first name for saml
  211. * samlAttrMapLastName:
  212. * type: string
  213. * description: attribute mapping last name for saml
  214. * isSameUsernameTreatedAsIdenticalUser:
  215. * type: boolean
  216. * description: local account automatically linked the user name matched
  217. * isSameEmailTreatedAsIdenticalUser:
  218. * type: boolean
  219. * description: local account automatically linked the email matched
  220. * samlABLCRule:
  221. * type: string
  222. * description: ABLCRule for saml
  223. * OidcAuthSetting:
  224. * type: object
  225. * properties:
  226. * oidcProviderName:
  227. * type: string
  228. * description: provider name for oidc
  229. * oidcIssuerHost:
  230. * type: string
  231. * description: issuer host for oidc
  232. * oidcAuthorizationEndpoint:
  233. * type: string
  234. * description: authorization endpoint for oidc
  235. * oidcTokenEndpoint:
  236. * type: string
  237. * description: token endpoint for oidc
  238. * oidcRevocationEndpoint:
  239. * type: string
  240. * description: revocation endpoint for oidc
  241. * oidcIntrospectionEndpoint:
  242. * type: string
  243. * description: introspection endpoint for oidc
  244. * oidcUserInfoEndpoint:
  245. * type: string
  246. * description: userinfo endpoint for oidc
  247. * oidcEndSessionEndpoint:
  248. * type: string
  249. * description: end session endpoint for oidc
  250. * oidcRegistrationEndpoint:
  251. * type: string
  252. * description: registration endpoint for oidc
  253. * oidcJWKSUri:
  254. * type: string
  255. * description: JSON Web Key Set URI for oidc
  256. * oidcClientId:
  257. * type: string
  258. * description: client id for oidc
  259. * oidcClientSecret:
  260. * type: string
  261. * description: client secret for oidc
  262. * oidcAttrMapId:
  263. * type: string
  264. * description: attr map id for oidc
  265. * oidcAttrMapUserName:
  266. * type: string
  267. * description: attr map username for oidc
  268. * oidcAttrMapName:
  269. * type: string
  270. * description: attr map name for oidc
  271. * oidcAttrMapMail:
  272. * type: string
  273. * description: attr map mail for oidc
  274. * isSameUsernameTreatedAsIdenticalUser:
  275. * type: boolean
  276. * description: local account automatically linked the user name matched
  277. * isSameEmailTreatedAsIdenticalUser:
  278. * type: boolean
  279. * description: local account automatically linked the email matched
  280. * BasicAuthSetting:
  281. * type: object
  282. * properties:
  283. * isSameUsernameTreatedAsIdenticalUser:
  284. * type: boolean
  285. * description: local account automatically linked the email matched
  286. * GitHubOAuthSetting:
  287. * type: object
  288. * properties:
  289. * githubClientId:
  290. * type: string
  291. * description: key of comsumer
  292. * githubClientSecret:
  293. * type: string
  294. * description: password of comsumer
  295. * isSameUsernameTreatedAsIdenticalUser:
  296. * type: boolean
  297. * description: local account automatically linked the email matched
  298. * GoogleOAuthSetting:
  299. * type: object
  300. * properties:
  301. * googleClientId:
  302. * type: string
  303. * description: key of comsumer
  304. * googleClientSecret:
  305. * type: string
  306. * description: password of comsumer
  307. * isSameUsernameTreatedAsIdenticalUser:
  308. * type: boolean
  309. * description: local account automatically linked the email matched
  310. * TwitterOAuthSetting:
  311. * type: object
  312. * properties:
  313. * twitterConsumerKey:
  314. * type: string
  315. * description: key of comsumer
  316. * twitterConsumerSecret:
  317. * type: string
  318. * description: password of comsumer
  319. * isSameUsernameTreatedAsIdenticalUser:
  320. * type: boolean
  321. * description: local account automatically linked the email matched
  322. */
  323. module.exports = (crowi) => {
  324. const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
  325. const adminRequired = require('../../middlewares/admin-required')(crowi);
  326. const csrf = require('../../middlewares/csrf')(crowi);
  327. const apiV3FormValidator = require('../../middlewares/apiv3-form-validator')(crowi);
  328. async function updateAndReloadStrategySettings(authId, params) {
  329. const { configManager, passportService } = crowi;
  330. // update config without publishing S2sMessage
  331. await configManager.updateConfigsInTheSameNamespace('crowi', params, true);
  332. await passportService.setupStrategyById(authId);
  333. passportService.publishUpdatedMessage(authId);
  334. }
  335. /**
  336. * @swagger
  337. *
  338. * /_api/v3/security-setting/:
  339. * get:
  340. * tags: [SecuritySetting, apiv3]
  341. * description: Get security paramators
  342. * responses:
  343. * 200:
  344. * description: params of security
  345. * content:
  346. * application/json:
  347. * schema:
  348. * properties:
  349. * securityParams:
  350. * type: object
  351. * description: security params
  352. */
  353. router.get('/', loginRequiredStrictly, adminRequired, async(req, res) => {
  354. const securityParams = {
  355. generalSetting: {
  356. restrictGuestMode: await crowi.configManager.getConfig('crowi', 'security:restrictGuestMode'),
  357. pageCompleteDeletionAuthority: await crowi.configManager.getConfig('crowi', 'security:pageCompleteDeletionAuthority'),
  358. hideRestrictedByOwner: await crowi.configManager.getConfig('crowi', 'security:list-policy:hideRestrictedByOwner'),
  359. hideRestrictedByGroup: await crowi.configManager.getConfig('crowi', 'security:list-policy:hideRestrictedByGroup'),
  360. wikiMode: await crowi.configManager.getConfig('crowi', 'security:wikiMode'),
  361. sessionMaxAge: await crowi.configManager.getConfig('crowi', 'security:sessionMaxAge'),
  362. },
  363. shareLinkSetting: {
  364. disableLinkSharing: await crowi.configManager.getConfig('crowi', 'security:disableLinkSharing'),
  365. },
  366. localSetting: {
  367. useOnlyEnvVarsForSomeOptions: await crowi.configManager.getConfig('crowi', 'security:passport-local:useOnlyEnvVarsForSomeOptions'),
  368. registrationMode: await crowi.configManager.getConfig('crowi', 'security:registrationMode'),
  369. registrationWhiteList: await crowi.configManager.getConfig('crowi', 'security:registrationWhiteList'),
  370. },
  371. generalAuth: {
  372. isLocalEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-local:isEnabled'),
  373. isLdapEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isEnabled'),
  374. isSamlEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isEnabled'),
  375. isOidcEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isEnabled'),
  376. isBasicEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-basic:isEnabled'),
  377. isGoogleEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-google:isEnabled'),
  378. isGitHubEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-github:isEnabled'),
  379. isTwitterEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:isEnabled'),
  380. },
  381. ldapAuth: {
  382. serverUrl: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:serverUrl'),
  383. isUserBind: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isUserBind'),
  384. ldapBindDN: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDN'),
  385. ldapBindDNPassword: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDNPassword'),
  386. ldapSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:searchFilter'),
  387. ldapAttrMapUsername: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapUsername'),
  388. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser'),
  389. ldapAttrMapMail: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapMail'),
  390. ldapAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapName'),
  391. ldapGroupSearchBase: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchBase'),
  392. ldapGroupSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchFilter'),
  393. ldapGroupDnProperty: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupDnProperty'),
  394. },
  395. samlAuth: {
  396. missingMandatoryConfigKeys: await crowi.passportService.getSamlMissingMandatoryConfigKeys(),
  397. useOnlyEnvVarsForSomeOptions: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:useOnlyEnvVarsForSomeOptions'),
  398. samlEntryPoint: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:entryPoint'),
  399. samlEnvVarEntryPoint: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:entryPoint'),
  400. samlIssuer: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:issuer'),
  401. samlEnvVarIssuer: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:issuer'),
  402. samlCert: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:cert'),
  403. samlEnvVarCert: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:cert'),
  404. samlAttrMapId: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapId'),
  405. samlEnvVarAttrMapId: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapId'),
  406. samlAttrMapUsername: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapUsername'),
  407. samlEnvVarAttrMapUsername: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapUsername'),
  408. samlAttrMapMail: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapMail'),
  409. samlEnvVarAttrMapMail: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapMail'),
  410. samlAttrMapFirstName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapFirstName'),
  411. samlEnvVarAttrMapFirstName: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapFirstName'),
  412. samlAttrMapLastName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapLastName'),
  413. samlEnvVarAttrMapLastName: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapLastName'),
  414. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser'),
  415. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameEmailTreatedAsIdenticalUser'),
  416. samlABLCRule: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:ABLCRule'),
  417. samlEnvVarABLCRule: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:ABLCRule'),
  418. },
  419. oidcAuth: {
  420. oidcProviderName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:providerName'),
  421. oidcIssuerHost: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:issuerHost'),
  422. oidcAuthorizationEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:authorizationEndpoint'),
  423. oidcTokenEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:tokenEndpoint'),
  424. oidcRevocationEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:revocationEndpoint'),
  425. oidcIntrospectionEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:introspectionEndpoint'),
  426. oidcUserInfoEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:userInfoEndpoint'),
  427. oidcEndSessionEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:endSessionEndpoint'),
  428. oidcRegistrationEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:registrationEndpoint'),
  429. oidcJWKSUri: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:jwksUri'),
  430. oidcClientId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientId'),
  431. oidcClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientSecret'),
  432. oidcAttrMapId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapId'),
  433. oidcAttrMapUserName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapUserName'),
  434. oidcAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapName'),
  435. oidcAttrMapEmail: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapMail'),
  436. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser'),
  437. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser'),
  438. },
  439. basicAuth: {
  440. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-basic:isSameUsernameTreatedAsIdenticalUser'),
  441. },
  442. googleOAuth: {
  443. googleClientId: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientId'),
  444. googleClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientSecret'),
  445. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-google:isSameUsernameTreatedAsIdenticalUser'),
  446. },
  447. githubOAuth: {
  448. githubClientId: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientId'),
  449. githubClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientSecret'),
  450. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-github:isSameUsernameTreatedAsIdenticalUser'),
  451. },
  452. twitterOAuth: {
  453. twitterConsumerKey: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerKey'),
  454. twitterConsumerSecret: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerSecret'),
  455. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:isSameUsernameTreatedAsIdenticalUser'),
  456. },
  457. };
  458. return res.apiv3({ securityParams });
  459. });
  460. /**
  461. * @swagger
  462. *
  463. * /_api/v3/security-setting/authentication/enabled:
  464. * put:
  465. * tags: [SecuritySetting, apiv3]
  466. * description: Update authentication isEnabled
  467. * requestBody:
  468. * required: true
  469. * content:
  470. * application/json:
  471. * schema:
  472. * type: object
  473. * properties:
  474. * isEnabled:
  475. * type: boolean
  476. * target:
  477. * type: string
  478. * responses:
  479. * 200:
  480. * description: Succeeded to enable authentication
  481. * content:
  482. * application/json:
  483. * schema:
  484. * type: object
  485. * description: updated param
  486. */
  487. router.put('/authentication/enabled', loginRequiredStrictly, adminRequired, csrf, validator.authenticationSetting, apiV3FormValidator, async(req, res) => {
  488. const { isEnabled, authId } = req.body;
  489. let setupStrategies = await crowi.passportService.getSetupStrategies();
  490. // Reflect request param
  491. setupStrategies = setupStrategies.filter(strategy => strategy !== authId);
  492. if (setupStrategies.length === 0) {
  493. return res.apiv3Err(new ErrorV3('Can not turn everything off'), 405);
  494. }
  495. const enableParams = { [`security:passport-${authId}:isEnabled`]: isEnabled };
  496. try {
  497. await updateAndReloadStrategySettings(authId, enableParams);
  498. const responseParams = {
  499. [`security:passport-${authId}:isEnabled`]: await crowi.configManager.getConfig('crowi', `security:passport-${authId}:isEnabled`),
  500. };
  501. return res.apiv3({ responseParams });
  502. }
  503. catch (err) {
  504. const msg = 'Error occurred in updating enable setting';
  505. logger.error('Error', err);
  506. return res.apiv3Err(new ErrorV3(msg, 'update-enable-setting failed'));
  507. }
  508. });
  509. /**
  510. * @swagger
  511. *
  512. * /_api/v3/security-setting/authentication:
  513. * get:
  514. * tags: [SecuritySetting, apiv3]
  515. * description: Get setup strategies for passport
  516. * responses:
  517. * 200:
  518. * description: params of setup strategies
  519. * content:
  520. * application/json:
  521. * schema:
  522. * properties:
  523. * setupStrategies:
  524. * type: array
  525. * description: setup strategies list
  526. * items:
  527. * type: string
  528. * description: setup strategie
  529. * example: ["local"]
  530. */
  531. router.get('/authentication/', loginRequiredStrictly, adminRequired, async(req, res) => {
  532. const setupStrategies = await crowi.passportService.getSetupStrategies();
  533. return res.apiv3({ setupStrategies });
  534. });
  535. /**
  536. * @swagger
  537. *
  538. * /_api/v3/security-setting/general-setting:
  539. * put:
  540. * tags: [SecuritySetting, apiv3]
  541. * description: Update GeneralSetting
  542. * requestBody:
  543. * required: true
  544. * content:
  545. * application/json:
  546. * schema:
  547. * $ref: '#/components/schemas/GeneralSetting'
  548. * responses:
  549. * 200:
  550. * description: Succeeded to update general Setting
  551. * content:
  552. * application/json:
  553. * schema:
  554. * $ref: '#/components/schemas/GeneralSetting'
  555. */
  556. router.put('/general-setting', loginRequiredStrictly, adminRequired, csrf, validator.generalSetting, apiV3FormValidator, async(req, res) => {
  557. const updateData = {
  558. 'security:sessionMaxAge': parseInt(req.body.sessionMaxAge),
  559. 'security:restrictGuestMode': req.body.restrictGuestMode,
  560. 'security:pageCompleteDeletionAuthority': req.body.pageCompleteDeletionAuthority,
  561. 'security:list-policy:hideRestrictedByOwner': req.body.hideRestrictedByOwner,
  562. 'security:list-policy:hideRestrictedByGroup': req.body.hideRestrictedByGroup,
  563. };
  564. const wikiMode = await crowi.configManager.getConfig('crowi', 'security:wikiMode');
  565. if (wikiMode === 'private' || wikiMode === 'public') {
  566. logger.debug('security:restrictGuestMode will not be changed because wiki mode is forced to set');
  567. delete updateData['security:restrictGuestMode'];
  568. }
  569. try {
  570. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', updateData);
  571. const securitySettingParams = {
  572. sessionMaxAge: await crowi.configManager.getConfig('crowi', 'security:sessionMaxAge'),
  573. restrictGuestMode: await crowi.configManager.getConfig('crowi', 'security:restrictGuestMode'),
  574. pageCompleteDeletionAuthority: await crowi.configManager.getConfig('crowi', 'security:pageCompleteDeletionAuthority'),
  575. hideRestrictedByOwner: await crowi.configManager.getConfig('crowi', 'security:list-policy:hideRestrictedByOwner'),
  576. hideRestrictedByGroup: await crowi.configManager.getConfig('crowi', 'security:list-policy:hideRestrictedByGroup'),
  577. };
  578. return res.apiv3({ securitySettingParams });
  579. }
  580. catch (err) {
  581. const msg = 'Error occurred in updating security setting';
  582. logger.error('Error', err);
  583. return res.apiv3Err(new ErrorV3(msg, 'update-secuirty-setting failed'));
  584. }
  585. });
  586. /**
  587. * @swagger
  588. *
  589. * /_api/v3/security-setting/share-link-setting:
  590. * put:
  591. * tags: [SecuritySetting, apiv3]
  592. * description: Update ShareLink Setting
  593. * requestBody:
  594. * required: true
  595. * content:
  596. * application/json:
  597. * schema:
  598. * $ref: '#/components/schemas/ShareLinkSetting'
  599. * responses:
  600. * 200:
  601. * description: Succeeded to update ShareLink Setting
  602. * content:
  603. * application/json:
  604. * schema:
  605. * $ref: '#/components/schemas/ShareLinkSetting'
  606. */
  607. router.put('/share-link-setting', loginRequiredStrictly, adminRequired, csrf, validator.generalSetting, apiV3FormValidator, async(req, res) => {
  608. const updateData = {
  609. 'security:disableLinkSharing': req.body.disableLinkSharing,
  610. };
  611. try {
  612. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', updateData);
  613. const securitySettingParams = {
  614. disableLinkSharing: crowi.configManager.getConfig('crowi', 'security:disableLinkSharing'),
  615. };
  616. return res.apiv3({ securitySettingParams });
  617. }
  618. catch (err) {
  619. const msg = 'Error occurred in updating security setting';
  620. logger.error('Error', err);
  621. return res.apiv3Err(new ErrorV3(msg, 'update-secuirty-setting failed'));
  622. }
  623. });
  624. /**
  625. * @swagger
  626. *
  627. * /_api/v3/security-setting/all-share-links:
  628. * get:
  629. * tags: [ShareLinkSettings, apiv3]
  630. * description: Get All ShareLinks at Share Link Setting
  631. * responses:
  632. * 200:
  633. * description: all share links
  634. * content:
  635. * application/json:
  636. * schema:
  637. * properties:
  638. * securityParams:
  639. * type: object
  640. * description: suceed to get all share links
  641. */
  642. router.get('/all-share-links/', loginRequiredStrictly, adminRequired, async(req, res) => {
  643. const ShareLink = crowi.model('ShareLink');
  644. const page = parseInt(req.query.page) || 1;
  645. const limit = 10;
  646. const linkQuery = {};
  647. try {
  648. const paginateResult = await ShareLink.paginate(
  649. linkQuery,
  650. {
  651. page,
  652. limit,
  653. populate: {
  654. path: 'relatedPage',
  655. select: 'path',
  656. },
  657. },
  658. );
  659. return res.apiv3({ paginateResult });
  660. }
  661. catch (err) {
  662. const msg = 'Error occured in get share link';
  663. logger.error('Error', err);
  664. return res.apiv3Err(new ErrorV3(msg, 'get-all-share-links-failed'));
  665. }
  666. });
  667. /**
  668. * @swagger
  669. *
  670. * /_api/v3/security-setting/all-share-links:
  671. * delete:
  672. * tags: [ShareLinkSettings, apiv3]
  673. * description: Delete All ShareLinks at Share Link Setting
  674. * responses:
  675. * 200:
  676. * description: succeed to delete all share links
  677. */
  678. router.delete('/all-share-links/', loginRequiredStrictly, adminRequired, async(req, res) => {
  679. const ShareLink = crowi.model('ShareLink');
  680. try {
  681. const removedAct = await ShareLink.remove({});
  682. const removeTotal = await removedAct.n;
  683. return res.apiv3({ removeTotal });
  684. }
  685. catch (err) {
  686. const msg = 'Error occured in delete all share links';
  687. logger.error('Error', err);
  688. return res.apiv3Err(new ErrorV3(msg, 'failed-to-delete-all-share-links'));
  689. }
  690. });
  691. /**
  692. * @swagger
  693. *
  694. * /_api/v3/security-setting/local-setting:
  695. * put:
  696. * tags: [LocalSetting, apiv3]
  697. * description: Update LocalSetting
  698. * requestBody:
  699. * required: true
  700. * content:
  701. * application/json:
  702. * schema:
  703. * $ref: '#/components/schemas/LocalSetting'
  704. * responses:
  705. * 200:
  706. * description: Succeeded to update local Setting
  707. * content:
  708. * application/json:
  709. * schema:
  710. * $ref: '#/components/schemas/LocalSetting'
  711. */
  712. router.put('/local-setting', loginRequiredStrictly, adminRequired, csrf, validator.localSetting, apiV3FormValidator, async(req, res) => {
  713. const requestParams = {
  714. 'security:registrationMode': req.body.registrationMode,
  715. 'security:registrationWhiteList': req.body.registrationWhiteList,
  716. };
  717. try {
  718. await updateAndReloadStrategySettings('local', requestParams);
  719. const localSettingParams = {
  720. registrationMode: await crowi.configManager.getConfig('crowi', 'security:registrationMode'),
  721. registrationWhiteList: await crowi.configManager.getConfig('crowi', 'security:registrationWhiteList'),
  722. };
  723. return res.apiv3({ localSettingParams });
  724. }
  725. catch (err) {
  726. const msg = 'Error occurred in updating local setting';
  727. logger.error('Error', err);
  728. return res.apiv3Err(new ErrorV3(msg, 'update-local-setting failed'));
  729. }
  730. });
  731. /**
  732. * @swagger
  733. *
  734. * /_api/v3/security-setting/ldap:
  735. * put:
  736. * tags: [SecuritySetting, apiv3]
  737. * description: Update LDAP setting
  738. * requestBody:
  739. * required: true
  740. * content:
  741. * application/json:
  742. * schema:
  743. * $ref: '#/components/schemas/LdapAuthSetting'
  744. * responses:
  745. * 200:
  746. * description: Succeeded to update LDAP setting
  747. * content:
  748. * application/json:
  749. * schema:
  750. * $ref: '#/components/schemas/LdapAuthSetting'
  751. */
  752. router.put('/ldap', loginRequiredStrictly, adminRequired, csrf, validator.ldapAuth, apiV3FormValidator, async(req, res) => {
  753. const requestParams = {
  754. 'security:passport-ldap:serverUrl': req.body.serverUrl,
  755. 'security:passport-ldap:isUserBind': req.body.isUserBind,
  756. 'security:passport-ldap:bindDN': req.body.ldapBindDN,
  757. 'security:passport-ldap:bindDNPassword': req.body.ldapBindDNPassword,
  758. 'security:passport-ldap:searchFilter': req.body.ldapSearchFilter,
  759. 'security:passport-ldap:attrMapUsername': req.body.ldapAttrMapUsername,
  760. 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  761. 'security:passport-ldap:attrMapMail': req.body.ldapAttrMapMail,
  762. 'security:passport-ldap:attrMapName': req.body.ldapAttrMapName,
  763. 'security:passport-ldap:groupSearchBase': req.body.ldapGroupSearchBase,
  764. 'security:passport-ldap:groupSearchFilter': req.body.ldapGroupSearchFilter,
  765. 'security:passport-ldap:groupDnProperty': req.body.ldapGroupDnProperty,
  766. };
  767. try {
  768. await updateAndReloadStrategySettings('ldap', requestParams);
  769. const securitySettingParams = {
  770. serverUrl: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:serverUrl'),
  771. isUserBind: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isUserBind'),
  772. ldapBindDN: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDN'),
  773. ldapBindDNPassword: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDNPassword'),
  774. ldapSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:searchFilter'),
  775. ldapAttrMapUsername: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapUsername'),
  776. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser'),
  777. ldapAttrMapMail: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapMail'),
  778. ldapAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapName'),
  779. ldapGroupSearchBase: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchBase'),
  780. ldapGroupSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchFilter'),
  781. ldapGroupDnProperty: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupDnProperty'),
  782. };
  783. return res.apiv3({ securitySettingParams });
  784. }
  785. catch (err) {
  786. const msg = 'Error occurred in updating SAML setting';
  787. logger.error('Error', err);
  788. return res.apiv3Err(new ErrorV3(msg, 'update-SAML-failed'));
  789. }
  790. });
  791. /**
  792. * @swagger
  793. *
  794. * /_api/v3/security-setting/saml:
  795. * put:
  796. * tags: [SecuritySetting, apiv3]
  797. * description: Update SAML setting
  798. * requestBody:
  799. * required: true
  800. * content:
  801. * application/json:
  802. * schema:
  803. * $ref: '#/components/schemas/SamlAuthSetting'
  804. * responses:
  805. * 200:
  806. * description: Succeeded to update SAML setting
  807. * content:
  808. * application/json:
  809. * schema:
  810. * $ref: '#/components/schemas/SamlAuthSetting'
  811. */
  812. router.put('/saml', loginRequiredStrictly, adminRequired, csrf, validator.samlAuth, apiV3FormValidator, async(req, res) => {
  813. // For the value of each mandatory items,
  814. // check whether it from the environment variables is empty and form value to update it is empty
  815. // validate the syntax of a attribute - based login control rule
  816. const invalidValues = [];
  817. for (const configKey of crowi.passportService.mandatoryConfigKeysForSaml) {
  818. const key = configKey.replace('security:passport-saml:', '');
  819. const formValue = req.body[key];
  820. if (crowi.configManager.getConfigFromEnvVars('crowi', configKey) === null && formValue == null) {
  821. const formItemName = req.t(`security_setting.form_item_name.${key}`);
  822. invalidValues.push(req.t('form_validation.required', formItemName));
  823. }
  824. }
  825. if (invalidValues.length !== 0) {
  826. return res.apiv3Err(req.t('form_validation.error_message'), 400, invalidValues);
  827. }
  828. const rule = req.body.ABLCRule;
  829. // Empty string disables attribute-based login control.
  830. // So, when rule is empty string, validation is passed.
  831. if (rule != null) {
  832. try {
  833. crowi.passportService.parseABLCRule(rule);
  834. }
  835. catch (err) {
  836. return res.apiv3Err(req.t('form_validation.invalid_syntax', req.t('security_setting.form_item_name.ABLCRule')), 400);
  837. }
  838. }
  839. const requestParams = {
  840. 'security:passport-saml:entryPoint': req.body.entryPoint,
  841. 'security:passport-saml:issuer': req.body.issuer,
  842. 'security:passport-saml:cert': req.body.cert,
  843. 'security:passport-saml:attrMapId': req.body.attrMapId,
  844. 'security:passport-saml:attrMapUsername': req.body.attrMapUsername,
  845. 'security:passport-saml:attrMapMail': req.body.attrMapMail,
  846. 'security:passport-saml:attrMapFirstName': req.body.attrMapFirstName,
  847. 'security:passport-saml:attrMapLastName': req.body.attrMapLastName,
  848. 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  849. 'security:passport-saml:isSameEmailTreatedAsIdenticalUser': req.body.isSameEmailTreatedAsIdenticalUser,
  850. 'security:passport-saml:ABLCRule': req.body.ABLCRule,
  851. };
  852. try {
  853. await updateAndReloadStrategySettings('saml', requestParams);
  854. const securitySettingParams = {
  855. missingMandatoryConfigKeys: await crowi.passportService.getSamlMissingMandatoryConfigKeys(),
  856. samlEntryPoint: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:entryPoint'),
  857. samlIssuer: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:issuer'),
  858. samlCert: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:cert'),
  859. samlAttrMapId: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapId'),
  860. samlAttrMapUsername: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapUsername'),
  861. samlAttrMapMail: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapMail'),
  862. samlAttrMapFirstName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapFirstName'),
  863. samlAttrMapLastName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapLastName'),
  864. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser'),
  865. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameEmailTreatedAsIdenticalUser'),
  866. samlABLCRule: await crowi.configManager.getConfig('crowi', 'security:passport-saml:ABLCRule'),
  867. };
  868. return res.apiv3({ securitySettingParams });
  869. }
  870. catch (err) {
  871. const msg = 'Error occurred in updating SAML setting';
  872. logger.error('Error', err);
  873. return res.apiv3Err(new ErrorV3(msg, 'update-SAML-failed'));
  874. }
  875. });
  876. /**
  877. * @swagger
  878. *
  879. * /_api/v3/security-setting/oidc:
  880. * put:
  881. * tags: [SecuritySetting, apiv3]
  882. * description: Update OpenID Connect setting
  883. * requestBody:
  884. * required: true
  885. * content:
  886. * application/json:
  887. * schema:
  888. * $ref: '#/components/schemas/OidcAuthSetting'
  889. * responses:
  890. * 200:
  891. * description: Succeeded to update OpenID Connect setting
  892. * content:
  893. * application/json:
  894. * schema:
  895. * $ref: '#/components/schemas/OidcAuthSetting'
  896. */
  897. router.put('/oidc', loginRequiredStrictly, adminRequired, csrf, validator.oidcAuth, apiV3FormValidator, async(req, res) => {
  898. const requestParams = {
  899. 'security:passport-oidc:providerName': req.body.oidcProviderName,
  900. 'security:passport-oidc:issuerHost': req.body.oidcIssuerHost,
  901. 'security:passport-oidc:authorizationEndpoint': req.body.oidcAuthorizationEndpoint,
  902. 'security:passport-oidc:tokenEndpoint': req.body.oidcTokenEndpoint,
  903. 'security:passport-oidc:revocationEndpoint': req.body.oidcRevocationEndpoint,
  904. 'security:passport-oidc:introspectionEndpoint': req.body.oidcIntrospectionEndpoint,
  905. 'security:passport-oidc:userInfoEndpoint': req.body.oidcUserInfoEndpoint,
  906. 'security:passport-oidc:endSessionEndpoint': req.body.oidcEndSessionEndpoint,
  907. 'security:passport-oidc:registrationEndpoint': req.body.oidcRegistrationEndpoint,
  908. 'security:passport-oidc:jwksUri': req.body.oidcJWKSUri,
  909. 'security:passport-oidc:clientId': req.body.oidcClientId,
  910. 'security:passport-oidc:clientSecret': req.body.oidcClientSecret,
  911. 'security:passport-oidc:attrMapId': req.body.oidcAttrMapId,
  912. 'security:passport-oidc:attrMapUserName': req.body.oidcAttrMapUserName,
  913. 'security:passport-oidc:attrMapName': req.body.oidcAttrMapName,
  914. 'security:passport-oidc:attrMapMail': req.body.oidcAttrMapEmail,
  915. 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  916. 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser': req.body.isSameEmailTreatedAsIdenticalUser,
  917. };
  918. try {
  919. await updateAndReloadStrategySettings('oidc', requestParams);
  920. const securitySettingParams = {
  921. oidcProviderName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:providerName'),
  922. oidcIssuerHost: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:issuerHost'),
  923. oidcAuthorizationEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:authorizationEndpoint'),
  924. oidcTokenEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:tokenEndpoint'),
  925. oidcRevocationEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:revocationEndpoint'),
  926. oidcIntrospectionEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:introspectionEndpoint'),
  927. oidcUserInfoEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:userInfoEndpoint'),
  928. oidcEndSessionEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:endSessionEndpoint'),
  929. oidcRegistrationEndpoint: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:registrationEndpoint'),
  930. oidcJWKSUri: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:jwksUri'),
  931. oidcClientId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientId'),
  932. oidcClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientSecret'),
  933. oidcAttrMapId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapId'),
  934. oidcAttrMapUserName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapUserName'),
  935. oidcAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapName'),
  936. oidcAttrMapEmail: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapMail'),
  937. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser'),
  938. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser'),
  939. };
  940. return res.apiv3({ securitySettingParams });
  941. }
  942. catch (err) {
  943. const msg = 'Error occurred in updating OpenIDConnect';
  944. logger.error('Error', err);
  945. return res.apiv3Err(new ErrorV3(msg, 'update-OpenIDConnect-failed'));
  946. }
  947. });
  948. /**
  949. * @swagger
  950. *
  951. * /_api/v3/security-setting/basic:
  952. * put:
  953. * tags: [SecuritySetting, apiv3]
  954. * description: Update basic
  955. * requestBody:
  956. * required: true
  957. * content:
  958. * application/json:
  959. * schema:
  960. * $ref: '#/components/schemas/BasicAuthSetting'
  961. * responses:
  962. * 200:
  963. * description: Succeeded to update basic
  964. * content:
  965. * application/json:
  966. * schema:
  967. * $ref: '#/components/schemas/BasicAuthSetting'
  968. */
  969. router.put('/basic', loginRequiredStrictly, adminRequired, csrf, validator.basicAuth, apiV3FormValidator, async(req, res) => {
  970. const requestParams = {
  971. 'security:passport-basic:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  972. };
  973. try {
  974. await updateAndReloadStrategySettings('basic', requestParams);
  975. const securitySettingParams = {
  976. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-basic:isSameUsernameTreatedAsIdenticalUser'),
  977. };
  978. return res.apiv3({ securitySettingParams });
  979. }
  980. catch (err) {
  981. const msg = 'Error occurred in updating basicAuth';
  982. logger.error('Error', err);
  983. return res.apiv3Err(new ErrorV3(msg, 'update-basicOAuth-failed'));
  984. }
  985. });
  986. /**
  987. * @swagger
  988. *
  989. * /_api/v3/security-setting/google-oauth:
  990. * put:
  991. * tags: [SecuritySetting, apiv3]
  992. * description: Update google OAuth
  993. * requestBody:
  994. * required: true
  995. * content:
  996. * application/json:
  997. * schema:
  998. * $ref: '#/components/schemas/GoogleOAuthSetting'
  999. * responses:
  1000. * 200:
  1001. * description: Succeeded to google OAuth
  1002. * content:
  1003. * application/json:
  1004. * schema:
  1005. * $ref: '#/components/schemas/GoogleOAuthSetting'
  1006. */
  1007. router.put('/google-oauth', loginRequiredStrictly, adminRequired, csrf, validator.googleOAuth, apiV3FormValidator, async(req, res) => {
  1008. const requestParams = {
  1009. 'security:passport-google:clientId': req.body.googleClientId,
  1010. 'security:passport-google:clientSecret': req.body.googleClientSecret,
  1011. 'security:passport-google:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  1012. };
  1013. try {
  1014. await updateAndReloadStrategySettings('google', requestParams);
  1015. const securitySettingParams = {
  1016. googleClientId: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientId'),
  1017. googleClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientSecret'),
  1018. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-google:isSameUsernameTreatedAsIdenticalUser'),
  1019. };
  1020. return res.apiv3({ securitySettingParams });
  1021. }
  1022. catch (err) {
  1023. const msg = 'Error occurred in updating googleOAuth';
  1024. logger.error('Error', err);
  1025. return res.apiv3Err(new ErrorV3(msg, 'update-googleOAuth-failed'));
  1026. }
  1027. });
  1028. /**
  1029. * @swagger
  1030. *
  1031. * /_api/v3/security-setting/github-oauth:
  1032. * put:
  1033. * tags: [SecuritySetting, apiv3]
  1034. * description: Update github OAuth
  1035. * requestBody:
  1036. * required: true
  1037. * content:
  1038. * application/json:
  1039. * schema:
  1040. * $ref: '#/components/schemas/GitHubOAuthSetting'
  1041. * responses:
  1042. * 200:
  1043. * description: Succeeded to github OAuth
  1044. * content:
  1045. * application/json:
  1046. * schema:
  1047. * $ref: '#/components/schemas/GitHubOAuthSetting'
  1048. */
  1049. router.put('/github-oauth', loginRequiredStrictly, adminRequired, csrf, validator.githubOAuth, apiV3FormValidator, async(req, res) => {
  1050. const requestParams = {
  1051. 'security:passport-github:clientId': req.body.githubClientId,
  1052. 'security:passport-github:clientSecret': req.body.githubClientSecret,
  1053. 'security:passport-github:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  1054. };
  1055. try {
  1056. await updateAndReloadStrategySettings('github', requestParams);
  1057. const securitySettingParams = {
  1058. githubClientId: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientId'),
  1059. githubClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientSecret'),
  1060. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-github:isSameUsernameTreatedAsIdenticalUser'),
  1061. };
  1062. return res.apiv3({ securitySettingParams });
  1063. }
  1064. catch (err) {
  1065. // reset strategy
  1066. await crowi.passportService.resetGitHubStrategy();
  1067. const msg = 'Error occurred in updating githubOAuth';
  1068. logger.error('Error', err);
  1069. return res.apiv3Err(new ErrorV3(msg, 'update-githubOAuth-failed'));
  1070. }
  1071. });
  1072. /**
  1073. * @swagger
  1074. *
  1075. * /_api/v3/security-setting/twitter-oauth:
  1076. * put:
  1077. * tags: [SecuritySetting, apiv3]
  1078. * description: Update twitter OAuth
  1079. * requestBody:
  1080. * required: true
  1081. * content:
  1082. * application/json:
  1083. * schema:
  1084. * $ref: '#/components/schemas/TwitterOAuthSetting'
  1085. * responses:
  1086. * 200:
  1087. * description: Succeeded to update twitter OAuth
  1088. * content:
  1089. * application/json:
  1090. * schema:
  1091. * $ref: '#/components/schemas/TwitterOAuthSetting'
  1092. */
  1093. router.put('/twitter-oauth', loginRequiredStrictly, adminRequired, csrf, validator.twitterOAuth, apiV3FormValidator, async(req, res) => {
  1094. let requestParams = {
  1095. 'security:passport-twitter:consumerKey': req.body.twitterConsumerKey,
  1096. 'security:passport-twitter:consumerSecret': req.body.twitterConsumerSecret,
  1097. 'security:passport-twitter:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  1098. };
  1099. requestParams = removeNullPropertyFromObject(requestParams);
  1100. try {
  1101. await updateAndReloadStrategySettings('twitter', requestParams);
  1102. const securitySettingParams = {
  1103. twitterConsumerId: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerKey'),
  1104. twitterConsumerSecret: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerSecret'),
  1105. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:isSameUsernameTreatedAsIdenticalUser'),
  1106. };
  1107. return res.apiv3({ securitySettingParams });
  1108. }
  1109. catch (err) {
  1110. const msg = 'Error occurred in updating twitterOAuth';
  1111. logger.error('Error', err);
  1112. return res.apiv3Err(new ErrorV3(msg, 'update-twitterOAuth-failed'));
  1113. }
  1114. });
  1115. return router;
  1116. };