security-setting.js 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776
  1. /* eslint-disable max-len */
  2. /* eslint-disable no-unused-vars */
  3. const loggerFactory = require('@alias/logger');
  4. const logger = loggerFactory('growi:routes:apiv3:security-setting');
  5. const express = require('express');
  6. const router = express.Router();
  7. const { body } = require('express-validator/check');
  8. const ErrorV3 = require('../../models/vo/error-apiv3');
  9. const validator = {
  10. // TODO correct validator
  11. generalSetting: [
  12. body('restrictGuestMode').isString(),
  13. body('pageCompleteDeletionAuthority').isString(),
  14. body('hideRestrictedByOwner').isBoolean(),
  15. body('hideRestrictedByGroup').isBoolean(),
  16. ],
  17. ldapAuth: [
  18. body('serverUrl').isString(),
  19. body('isUserBind').isBoolean(),
  20. body('ldapBindDN').isString(),
  21. body('ldapBindDNPassword').isString(),
  22. body('ldapSearchFilter').isString(),
  23. body('ldapAttrMapUsername').isString(),
  24. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  25. body('ldapAttrMapMail').isString(),
  26. body('ldapAttrMapName').isString(),
  27. body('ldapGroupSearchBase').isString(),
  28. body('ldapGroupSearchFilter').isString(),
  29. body('ldapGroupDnProperty').isString(),
  30. ],
  31. samlAuth: [
  32. body('samlEntryPoint').isString(),
  33. body('samlIssuer').isString(),
  34. body('samlCert').isString(),
  35. body('samlAttrMapId').isString(),
  36. body('samlAttrMapUserName').isString(),
  37. body('samlAttrMapMail').isString(),
  38. body('samlAttrMapFirstName').isString(),
  39. body('samlAttrMapLastName').isString(),
  40. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  41. body('isSameEmailTreatedAsIdenticalUser').isBoolean(),
  42. ],
  43. oidcAuth: [
  44. body('oidcProviderName').isString(),
  45. body('oidcIssuerHost').isString(),
  46. body('oidcClientId').isString(),
  47. body('oidcClientSecret').isString(),
  48. body('oidcAttrMapId').isString(),
  49. body('oidcAttrMapUserName').isString(),
  50. body('oidcAttrMapEmail').isString(),
  51. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  52. body('isSameEmailTreatedAsIdenticalUser').isBoolean(),
  53. ],
  54. basicAuth: [
  55. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  56. ],
  57. googleOAuth: [
  58. body('googleClientId').isString(),
  59. body('googleClientSecret').isString(),
  60. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  61. ],
  62. githubOAuth: [
  63. body('githubClientId').isString(),
  64. body('githubClientSecret').isString(),
  65. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  66. ],
  67. twitterOAuth: [
  68. body('twitterConsumerKey').isString(),
  69. body('twitterConsumerSecret').isString(),
  70. body('isSameUsernameTreatedAsIdenticalUser').isBoolean(),
  71. ],
  72. };
  73. /**
  74. * @swagger
  75. * tags:
  76. * name: SecuritySetting
  77. */
  78. /**
  79. * @swagger
  80. *
  81. * components:
  82. * schemas:
  83. * GeneralSetting:
  84. * type:object
  85. * GuestModeParams:
  86. * type: object
  87. * properties:
  88. * restrictGuestMode:
  89. * type: string
  90. * description: type of restrictGuestMode
  91. * PageDeletionParams:
  92. * type: object
  93. * properties:
  94. * pageCompleteDeletionAuthority:
  95. * type: string
  96. * description: type of pageDeletionAuthority
  97. * Function:
  98. * type: object
  99. * properties:
  100. * hideRestrictedByOwner:
  101. * type: boolean
  102. * description: enable hide by owner
  103. * hideRestrictedByGroup:
  104. * type: boolean
  105. * description: enable hide by group
  106. * LdapAuthSetting:
  107. * type:object
  108. * serverUrl:
  109. * type: string
  110. * description: server url for ldap
  111. * isUserBind:
  112. * type: boolean
  113. * description: enable user bind
  114. * ldapBindDN:
  115. * type: string
  116. * description: the query used to bind with the directory service
  117. * ldapBindDNPassword:
  118. * type: string
  119. * description: the password that is entered in the login page will be used to bind
  120. * ldapSearchFilter:
  121. * type: string
  122. * description: the query used to locate the authenticated user
  123. * ldapAttrMapUsername:
  124. * type: string
  125. * description: specification of mappings for username when creating new users
  126. * isSameUsernameTreatedAsIdenticalUser:
  127. * type: boolean
  128. * description: local account automatically linked the user name matched
  129. * ldapAttrMapMail:
  130. * type: string
  131. * description: specification of mappings for mail address when creating new users
  132. * ldapAttrMapName:
  133. * type: string
  134. * description: Specification of mappings for full name address when creating new users
  135. * ldapGroupSearchBase:
  136. * type: string
  137. * description: the base DN from which to search for groups.
  138. * ldapGroupSearchFilter:
  139. * type: string
  140. * description: the query used to filter for groups
  141. * ldapGroupDnProperty:
  142. * type: string
  143. * description: The property of user object to use in dn interpolation of Group Search Filter
  144. * SamlAuthSetting:
  145. * type:object
  146. * samlEntryPoint:
  147. * type: string
  148. * description: entry point for saml
  149. * samlIssuer:
  150. * type: string
  151. * description: issuer for saml
  152. * samlCert:
  153. * type: string
  154. * description: certificate for saml
  155. * samlAttrMapId:
  156. * type: string
  157. * description: attribute mapping id for saml
  158. * samlAttrMapUserName:
  159. * type: string
  160. * description: attribute mapping user name for saml
  161. * samlAttrMapMail:
  162. * type: string
  163. * description: attribute mapping mail for saml
  164. * samlAttrMapFirstName:
  165. * type: string
  166. * description: attribute mapping first name for saml
  167. * samlAttrMapLastName:
  168. * type: string
  169. * description: attribute mapping last name for saml
  170. * isSameUsernameTreatedAsIdenticalUser
  171. * type: boolean
  172. * description: local account automatically linked the user name matched
  173. * isSameEmailTreatedAsIdenticalUser
  174. * type: boolean
  175. * description: local account automatically linked the email matched
  176. * OidcAuthSetting:
  177. * type:object
  178. * oidcProviderName:
  179. * type: string
  180. * description: provider name for oidc
  181. * oidcIssuerHost:
  182. * type: string
  183. * description: issuer host for oidc
  184. * oidcClientId:
  185. * type: string
  186. * description: client id for oidc
  187. * oidcClientSecret:
  188. * type: string
  189. * description: client secret for oidc
  190. * oidcAttrMapId:
  191. * type: string
  192. * description: attr map id for oidc
  193. * oidcAttrMapUserName:
  194. * type: string
  195. * description: attr map username for oidc
  196. * oidcAttrMapName:
  197. * type: string
  198. * description: attr map name for oidc
  199. * oidcAttrMapMail:
  200. * type: string
  201. * description: attr map mail for oidc
  202. * isSameUsernameTreatedAsIdenticalUser
  203. * type: boolean
  204. * description: local account automatically linked the user name matched
  205. * isSameEmailTreatedAsIdenticalUser
  206. * type: boolean
  207. * description: local account automatically linked the email matched
  208. * BasicAuthSetting:
  209. * type:object
  210. * isSameUsernameTreatedAsIdenticalUser
  211. * type: boolean
  212. * description: local account automatically linked the email matched
  213. * GitHubOAuthSetting:
  214. * type:object
  215. * githubClientId:
  216. * type: string
  217. * description: key of comsumer
  218. * githubClientSecret:
  219. * type: string
  220. * description: password of comsumer
  221. * isSameUsernameTreatedAsIdenticalUser
  222. * type: boolean
  223. * description: local account automatically linked the email matched
  224. * GoogleOAuthSetting:
  225. * type:object
  226. * googleClientId:
  227. * type: string
  228. * description: key of comsumer
  229. * googleClientSecret:
  230. * type: string
  231. * description: password of comsumer
  232. * isSameUsernameTreatedAsIdenticalUser
  233. * type: boolean
  234. * description: local account automatically linked the email matched
  235. * TwitterOAuthSetting:
  236. * type:object
  237. * twitterConsumerKey:
  238. * type: string
  239. * description: key of comsumer
  240. * twitterConsumerSecret:
  241. * type: string
  242. * description: password of comsumer
  243. * isSameUsernameTreatedAsIdenticalUser
  244. * type: boolean
  245. * description: local account automatically linked the email matched
  246. */
  247. module.exports = (crowi) => {
  248. const loginRequiredStrictly = require('../../middleware/login-required')(crowi);
  249. const adminRequired = require('../../middleware/admin-required')(crowi);
  250. const csrf = require('../../middleware/csrf')(crowi);
  251. const { ApiV3FormValidator } = crowi.middlewares;
  252. /**
  253. * @swagger
  254. *
  255. * /security-setting/:
  256. * get:
  257. * tags: [SecuritySetting]
  258. * description: Get security paramators
  259. * responses:
  260. * 200:
  261. * description: params of security
  262. * content:
  263. * application/json:
  264. * schema:
  265. * $ref: '#/components/schemas/GeneralSetting'
  266. * $ref: '#/components/schemas/LdapAuthSetting'
  267. * $ref: '#/components/schemas/SamlAuthSetting'
  268. * $ref: '#/components/schemas/OidcAuthSetting'
  269. * $ref: '#/components/schemas/BasicAuthSetting'
  270. * $ref: '#/components/schemas/GitHubOAuthSetting'
  271. * $ref: '#/components/schemas/GoogleOAuthSetting'
  272. * $ref: '#/components/schemas/TwitterOAuthSetting'
  273. */
  274. router.get('/', loginRequiredStrictly, adminRequired, async(req, res) => {
  275. const securityParams = {
  276. generalAuth: {
  277. isLdapEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isEnabled'),
  278. isSamlEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isEnabled'),
  279. isOidcEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isEnabled'),
  280. isBasicEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-basic:isEnabled'),
  281. isGoogleOAuthEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-google:isEnabled'),
  282. isGithubOAuthEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-github:isEnabled'),
  283. isTwitterOAuthEnabled: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:isEnabled'),
  284. },
  285. ldapAuth: {
  286. serverUrl: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:serverUrl'),
  287. isUserBind: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isUserBind'),
  288. ldapBindDN: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDN'),
  289. ldapBindDNPassword: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDNPassword'),
  290. ldapSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:searchFilter'),
  291. ldapAttrMapUsername: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapUsername'),
  292. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser'),
  293. ldapAttrMapMail: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapMail'),
  294. ldapAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapName'),
  295. ldapGroupSearchBase: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchBase'),
  296. ldapGroupSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchFilter'),
  297. ldapGroupDnProperty: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupDnProperty'),
  298. },
  299. samlAuth: {
  300. missingMandatoryConfigKeys: await crowi.passportService.getSamlMissingMandatoryConfigKeys(),
  301. samlEntryPoint: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:entryPoint'),
  302. samlEnvVarEntryPoint: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:entryPoint'),
  303. samlIssuer: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:issuer'),
  304. samlEnvVarIssuer: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:issuer'),
  305. samlCert: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:cert'),
  306. samlEnvVarCert: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:cert'),
  307. samlAttrMapId: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapId'),
  308. samlEnvVarAttrMapId: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapId'),
  309. samlAttrMapUserName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapUsername'),
  310. samlEnvVarAttrMapUserName: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapUsername'),
  311. samlAttrMapMail: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapMail'),
  312. samlEnvVarAttrMapMail: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapMail'),
  313. samlAttrMapFirstName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapFirstName'),
  314. samlEnvVarAttrMapFirstName: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapFirstName'),
  315. samlAttrMapLastName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapLastName'),
  316. samlEnvVarAttrMapLastName: await crowi.configManager.getConfigFromEnvVars('crowi', 'security:passport-saml:attrMapLastName'),
  317. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser'),
  318. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameEmailTreatedAsIdenticalUser'),
  319. },
  320. oidcAuth: {
  321. oidcProviderName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:providerName'),
  322. oidcIssuerHost: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:issuerHost'),
  323. oidcClientId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientId'),
  324. oidcClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientSecret'),
  325. oidcAttrMapId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapId'),
  326. oidcAttrMapUserName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapUserName'),
  327. oidcAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapName'),
  328. oidcAttrMapEmail: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapMail'),
  329. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser'),
  330. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser'),
  331. },
  332. basicAuth: {
  333. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-basic:isSameUsernameTreatedAsIdenticalUser'),
  334. },
  335. googleOAuth: {
  336. googleClientId: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientId'),
  337. googleClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientSecret'),
  338. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-google:isSameUsernameTreatedAsIdenticalUser'),
  339. },
  340. githubOAuth: {
  341. isGitHubStrategySetup: await crowi.passportService.isGitHubStrategySetup,
  342. githubClientId: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientId'),
  343. githubClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientSecret'),
  344. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-github:isSameUsernameTreatedAsIdenticalUser'),
  345. },
  346. twitterOAuth: {
  347. isTwitterStrategySetup: await crowi.passportService.isTwitterStrategySetup,
  348. twitterConsumerKey: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerKey'),
  349. twitterConsumerSecret: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerSecret'),
  350. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:isSameUsernameTreatedAsIdenticalUser'),
  351. },
  352. };
  353. return res.apiv3({ securityParams });
  354. });
  355. /**
  356. * @swagger
  357. *
  358. * /security-setting/general-setting:
  359. * put:
  360. * tags: [SecuritySetting]
  361. * description: Update GeneralSetting
  362. * requestBody:
  363. * required: true
  364. * content:
  365. * application/json:
  366. * schema:
  367. * $ref: '#/components/schemas/GeneralSetting'
  368. * responses:
  369. * 200:
  370. * description: Succeeded to update general Setting
  371. * content:
  372. * application/json:
  373. * schema:
  374. * $ref: '#/components/schemas/GeneralSetting'
  375. */
  376. router.put('/general-setting', loginRequiredStrictly, adminRequired, csrf, validator.generalSetting, ApiV3FormValidator, async(req, res) => {
  377. const requestParams = {
  378. 'security:restrictGuestMode': req.body.restrictGuestMode,
  379. 'security:pageCompleteDeletionAuthority': req.body.pageCompleteDeletionAuthority,
  380. 'security:list-policy:hideRestrictedByOwner': req.body.hideRestrictedByOwner,
  381. 'security:list-policy:hideRestrictedByGroup': req.body.hideRestrictedByGroup,
  382. };
  383. try {
  384. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  385. const securitySettingParams = {
  386. restrictGuestMode: await crowi.configManager.getConfig('crowi', 'security:restrictGuestMode'),
  387. pageCompleteDeletionAuthority: await crowi.configManager.getConfig('crowi', 'security:pageCompleteDeletionAuthority'),
  388. hideRestrictedByOwner: await crowi.configManager.getConfig('crowi', 'security:list-policy:hideRestrictedByOwner'),
  389. hideRestrictedByGroup: await crowi.configManager.getConfig('crowi', 'security:list-policy:hideRestrictedByGroup'),
  390. };
  391. return res.apiv3({ securitySettingParams });
  392. }
  393. catch (err) {
  394. const msg = 'Error occurred in updating security setting';
  395. logger.error('Error', err);
  396. return res.apiv3Err(new ErrorV3(msg, 'update-secuirty-setting failed'));
  397. }
  398. });
  399. /**
  400. * @swagger
  401. *
  402. * /security-setting/ldap:
  403. * put:
  404. * tags: [SecuritySetting]
  405. * description: Update LDAP setting
  406. * requestBody:
  407. * required: true
  408. * content:
  409. * application/json:
  410. * schema:
  411. * $ref: '#/components/schemas/LdapAuthSetting'
  412. * responses:
  413. * 200:
  414. * description: Succeeded to update LDAP setting
  415. * content:
  416. * application/json:
  417. * schema:
  418. * $ref: '#/components/schemas/LdapAuthSetting'
  419. */
  420. router.put('/ldap', loginRequiredStrictly, adminRequired, csrf, validator.ldapAuth, ApiV3FormValidator, async(req, res) => {
  421. const requestParams = {
  422. 'security:passport-ldap:serverUrl': req.body.serverUrl,
  423. 'security:passport-ldap:isUserBind': req.body.isUserBind,
  424. 'security:passport-ldap:bindDN': req.body.ldapBindDN,
  425. 'security:passport-ldap:bindDNPassword': req.body.ldapBindDNPassword,
  426. 'security:passport-ldap:searchFilter': req.body.ldapSearchFilter,
  427. 'security:passport-ldap:attrMapUsername': req.body.ldapAttrMapUserName,
  428. 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  429. 'security:passport-ldap:attrMapMail': req.body.ldapAttrMapMail,
  430. 'security:passport-ldap:attrMapName': req.body.ldapAttrMapName,
  431. 'security:passport-ldap:groupSearchBase': req.body.ldapGroupSearchBase,
  432. 'security:passport-ldap:groupSearchFilter': req.body.ldapGroupSearchFilter,
  433. 'security:passport-ldap:groupDnProperty': req.body.ldapGroupDnProperty,
  434. };
  435. try {
  436. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  437. const securitySettingParams = {
  438. serverUrl: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:serverUrl'),
  439. isUserBind: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isUserBind'),
  440. ldapBindDN: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDN'),
  441. ldapBindDNPassword: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:bindDNPassword'),
  442. ldapSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:searchFilter'),
  443. ldapAttrMapUsername: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapUsername'),
  444. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser'),
  445. ldapAttrMapMail: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapMail'),
  446. ldapAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:attrMapName'),
  447. ldapGroupSearchBase: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchBase'),
  448. ldapGroupSearchFilter: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupSearchFilter'),
  449. ldapGroupDnProperty: await crowi.configManager.getConfig('crowi', 'security:passport-ldap:groupDnProperty'),
  450. };
  451. return res.apiv3({ securitySettingParams });
  452. }
  453. catch (err) {
  454. const msg = 'Error occurred in updating SAML setting';
  455. logger.error('Error', err);
  456. return res.apiv3Err(new ErrorV3(msg, 'update-SAML-failed'));
  457. }
  458. });
  459. /**
  460. * @swagger
  461. *
  462. * /security-setting/saml:
  463. * put:
  464. * tags: [SecuritySetting]
  465. * description: Update SAML setting
  466. * requestBody:
  467. * required: true
  468. * content:
  469. * application/json:
  470. * schema:
  471. * $ref: '#/components/schemas/SamlAuthSetting'
  472. * responses:
  473. * 200:
  474. * description: Succeeded to update SAML setting
  475. * content:
  476. * application/json:
  477. * schema:
  478. * $ref: '#/components/schemas/SamlAuthSetting'
  479. */
  480. router.put('/saml', loginRequiredStrictly, adminRequired, csrf, validator.samlAuth, ApiV3FormValidator, async(req, res) => {
  481. const requestParams = {
  482. 'security:passport-saml:entryPoint': req.body.samlEntryPoint,
  483. 'security:passport-saml:issuer': req.body.samlIssuer,
  484. 'security:passport-saml:cert': req.body.samlCert,
  485. 'security:passport-saml:attrMapId': req.body.samlAttrMapId,
  486. 'security:passport-saml:attrMapUsername': req.body.samlAttrMapUserName,
  487. 'security:passport-saml:attrMapMail': req.body.samlAttrMapMail,
  488. 'security:passport-saml:attrMapFirstName': req.body.samlAttrMapFirstName,
  489. 'security:passport-saml:attrMapLastName': req.body.samlAttrMapLastName,
  490. 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  491. 'security:passport-saml:isSameEmailTreatedAsIdenticalUser': req.body.isSameEmailTreatedAsIdenticalUser,
  492. };
  493. try {
  494. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  495. const securitySettingParams = {
  496. missingMandatoryConfigKeys: await crowi.passportService.getSamlMissingMandatoryConfigKeys(),
  497. samlEntryPoint: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:entryPoint'),
  498. samlIssuer: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:issuer'),
  499. samlCert: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:cert'),
  500. samlAttrMapId: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapId'),
  501. samlAttrMapUserName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapUsername'),
  502. samlAttrMapMail: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapMail'),
  503. samlAttrMapFirstName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapFirstName'),
  504. samlAttrMapLastName: await crowi.configManager.getConfigFromDB('crowi', 'security:passport-saml:attrMapLastName'),
  505. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser'),
  506. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-saml:isSameEmailTreatedAsIdenticalUser'),
  507. };
  508. return res.apiv3({ securitySettingParams });
  509. }
  510. catch (err) {
  511. const msg = 'Error occurred in updating SAML setting';
  512. logger.error('Error', err);
  513. return res.apiv3Err(new ErrorV3(msg, 'update-SAML-failed'));
  514. }
  515. });
  516. /**
  517. * @swagger
  518. *
  519. * /security-setting/oidc:
  520. * put:
  521. * tags: [SecuritySetting]
  522. * description: Update OpenID Connect setting
  523. * requestBody:
  524. * required: true
  525. * content:
  526. * application/json:
  527. * schema:
  528. * $ref: '#/components/schemas/OidcAuthSetting'
  529. * responses:
  530. * 200:
  531. * description: Succeeded to update OpenID Connect setting
  532. * content:
  533. * application/json:
  534. * schema:
  535. * $ref: '#/components/schemas/OidcAuthSetting'
  536. */
  537. router.put('/oidc', loginRequiredStrictly, adminRequired, csrf, validator.oidcAuth, ApiV3FormValidator, async(req, res) => {
  538. const requestParams = {
  539. 'security:passport-oidc:providerName': req.body.oidcProviderName,
  540. 'security:passport-oidc:issuerHost': req.body.oidcIssuerHost,
  541. 'security:passport-oidc:clientId': req.body.oidcClientId,
  542. 'security:passport-oidc:clientSecret': req.body.oidcClientSecret,
  543. 'security:passport-oidc:attrMapId': req.body.oidcAttrMapId,
  544. 'security:passport-oidc:attrMapUserName': req.body.oidcAttrMapUserName,
  545. 'security:passport-oidc:attrMapName': req.body.oidcAttrMapName,
  546. 'security:passport-oidc:attrMapMail': req.body.oidcAttrMapEmail,
  547. 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  548. 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser': req.body.isSameEmailTreatedAsIdenticalUser,
  549. };
  550. try {
  551. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  552. const securitySettingParams = {
  553. oidcProviderName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:providerName'),
  554. oidcIssuerHost: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:issuerHost'),
  555. oidcClientId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientId'),
  556. oidcClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:clientSecret'),
  557. oidcAttrMapId: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapId'),
  558. oidcAttrMapUserName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapUserName'),
  559. oidcAttrMapName: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapName'),
  560. oidcAttrMapEmail: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:attrMapMail'),
  561. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser'),
  562. isSameEmailTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser'),
  563. };
  564. return res.apiv3({ securitySettingParams });
  565. }
  566. catch (err) {
  567. const msg = 'Error occurred in updating OpenIDConnect';
  568. logger.error('Error', err);
  569. return res.apiv3Err(new ErrorV3(msg, 'update-OpenIDConnect-failed'));
  570. }
  571. });
  572. /**
  573. * @swagger
  574. *
  575. * /security-setting/basic:
  576. * put:
  577. * tags: [SecuritySetting]
  578. * description: Update basic
  579. * requestBody:
  580. * required: true
  581. * content:
  582. * application/json:
  583. * schema:
  584. * $ref: '#/components/schemas/BasicAuthSetting'
  585. * responses:
  586. * 200:
  587. * description: Succeeded to update basic
  588. * content:
  589. * application/json:
  590. * schema:
  591. * $ref: '#/components/schemas/BasicAuthSetting'
  592. */
  593. router.put('/basic', loginRequiredStrictly, adminRequired, csrf, validator.basicAuth, ApiV3FormValidator, async(req, res) => {
  594. const requestParams = {
  595. 'security:passport-basic:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  596. };
  597. try {
  598. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  599. const securitySettingParams = {
  600. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-basic:isSameUsernameTreatedAsIdenticalUser'),
  601. };
  602. return res.apiv3({ securitySettingParams });
  603. }
  604. catch (err) {
  605. const msg = 'Error occurred in updating basicAuth';
  606. logger.error('Error', err);
  607. return res.apiv3Err(new ErrorV3(msg, 'update-basicOAuth-failed'));
  608. }
  609. });
  610. /**
  611. * @swagger
  612. *
  613. * /security-setting/google-oauth:
  614. * put:
  615. * tags: [SecuritySetting]
  616. * description: Update google OAuth
  617. * requestBody:
  618. * required: true
  619. * content:
  620. * application/json:
  621. * schema:
  622. * $ref: '#/components/schemas/GoogleOAuthSetting'
  623. * responses:
  624. * 200:
  625. * description: Succeeded to google OAuth
  626. * content:
  627. * application/json:
  628. * schema:
  629. * $ref: '#/components/schemas/GoogleOAuthSetting'
  630. */
  631. router.put('/google-oauth', loginRequiredStrictly, adminRequired, csrf, validator.googleOAuth, ApiV3FormValidator, async(req, res) => {
  632. const requestParams = {
  633. 'security:passport-google:clientId': req.body.googleClientId,
  634. 'security:passport-google:clientSecret': req.body.googleClientSecret,
  635. 'security:passport-google:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  636. };
  637. try {
  638. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  639. const securitySettingParams = {
  640. googleClientId: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientId'),
  641. googleClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-google:clientSecret'),
  642. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-google:isSameUsernameTreatedAsIdenticalUser'),
  643. };
  644. return res.apiv3({ securitySettingParams });
  645. }
  646. catch (err) {
  647. const msg = 'Error occurred in updating googleOAuth';
  648. logger.error('Error', err);
  649. return res.apiv3Err(new ErrorV3(msg, 'update-googleOAuth-failed'));
  650. }
  651. });
  652. /**
  653. * @swagger
  654. *
  655. * /security-setting/github-oauth:
  656. * put:
  657. * tags: [SecuritySetting]
  658. * description: Update github OAuth
  659. * requestBody:
  660. * required: true
  661. * content:
  662. * application/json:
  663. * schema:
  664. * $ref: '#/components/schemas/GitHubOAuthSetting'
  665. * responses:
  666. * 200:
  667. * description: Succeeded to github OAuth
  668. * content:
  669. * application/json:
  670. * schema:
  671. * $ref: '#/components/schemas/GitHubOAuthSetting'
  672. */
  673. router.put('/github-oauth', loginRequiredStrictly, adminRequired, csrf, validator.githubOAuth, ApiV3FormValidator, async(req, res) => {
  674. const requestParams = {
  675. 'security:passport-github:clientId': req.body.githubClientId,
  676. 'security:passport-github:clientSecret': req.body.githubClientSecret,
  677. 'security:passport-github:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  678. };
  679. try {
  680. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  681. const securitySettingParams = {
  682. isGitHubStrategySetup: await crowi.passportService.isGitHubStrategySetup,
  683. githubClientId: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientId'),
  684. githubClientSecret: await crowi.configManager.getConfig('crowi', 'security:passport-github:clientSecret'),
  685. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-github:isSameUsernameTreatedAsIdenticalUser'),
  686. };
  687. // reset strategy
  688. await crowi.passportService.resetGitHubStrategy();
  689. // setup strategy
  690. if (crowi.configManager.getConfig('crowi', 'security:passport-github:isEnabled')) {
  691. await crowi.passportService.setupGitHubStrategy(true);
  692. }
  693. return res.apiv3({ securitySettingParams });
  694. }
  695. catch (err) {
  696. // reset strategy
  697. await crowi.passportService.resetGitHubStrategy();
  698. const msg = 'Error occurred in updating githubOAuth';
  699. logger.error('Error', err);
  700. return res.apiv3Err(new ErrorV3(msg, 'update-githubOAuth-failed'));
  701. }
  702. });
  703. /**
  704. * @swagger
  705. *
  706. * /security-setting/twitter-oauth:
  707. * put:
  708. * tags: [SecuritySetting]
  709. * description: Update twitter OAuth
  710. * requestBody:
  711. * required: true
  712. * content:
  713. * application/json:
  714. * schema:
  715. * $ref: '#/components/schemas/TwitterOAuthSetting'
  716. * responses:
  717. * 200:
  718. * description: Succeeded to update twitter OAuth
  719. * content:
  720. * application/json:
  721. * schema:
  722. * $ref: '#/components/schemas/TwitterOAuthSetting'
  723. */
  724. router.put('/twitter-oauth', loginRequiredStrictly, adminRequired, csrf, validator.twitterOAuth, ApiV3FormValidator, async(req, res) => {
  725. const requestParams = {
  726. 'security:passport-twitter:consumerKey': req.body.twitterConsumerKey,
  727. 'security:passport-twitter:consumerSecret': req.body.twitterConsumerSecret,
  728. 'security:passport-twitter:isSameUsernameTreatedAsIdenticalUser': req.body.isSameUsernameTreatedAsIdenticalUser,
  729. };
  730. try {
  731. await crowi.configManager.updateConfigsInTheSameNamespace('crowi', requestParams);
  732. const securitySettingParams = {
  733. isTwitterStrategySetup: await crowi.passportService.isTwitterStrategySetup,
  734. twitterConsumerId: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerKey'),
  735. twitterConsumerSecret: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:consumerSecret'),
  736. isSameUsernameTreatedAsIdenticalUser: await crowi.configManager.getConfig('crowi', 'security:passport-twitter:isSameUsernameTreatedAsIdenticalUser'),
  737. };
  738. return res.apiv3({ securitySettingParams });
  739. }
  740. catch (err) {
  741. const msg = 'Error occurred in updating twitterOAuth';
  742. logger.error('Error', err);
  743. return res.apiv3Err(new ErrorV3(msg, 'update-twitterOAuth-failed'));
  744. }
  745. });
  746. return router;
  747. };