index.js 62 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754
  1. import {
  2. ConfigSource,
  3. SCOPE,
  4. toNonBlankStringOrUndefined,
  5. } from '@growi/core/dist/interfaces';
  6. import { ErrorV3 } from '@growi/core/dist/models';
  7. import xss from 'xss';
  8. import { SupportedAction } from '~/interfaces/activity';
  9. import { PageDeleteConfigValue } from '~/interfaces/page-delete-config';
  10. import { accessTokenParser } from '~/server/middlewares/access-token-parser';
  11. import { generateAddActivityMiddleware } from '~/server/middlewares/add-activity';
  12. import { apiV3FormValidator } from '~/server/middlewares/apiv3-form-validator';
  13. import ShareLink from '~/server/models/share-link';
  14. import { configManager } from '~/server/service/config-manager';
  15. import loggerFactory from '~/utils/logger';
  16. import {
  17. prepareDeleteConfigValuesForCalc,
  18. validateDeleteConfigs,
  19. } from '~/utils/page-delete-config';
  20. import { checkSetupStrategiesHasAdmin } from './checkSetupStrategiesHasAdmin';
  21. import { handleSamlUpdate, samlAuthValidator } from './saml';
  22. const logger = loggerFactory('growi:routes:apiv3:security-setting');
  23. const express = require('express');
  24. const router = express.Router();
  25. const { body } = require('express-validator');
  26. const validator = {
  27. generalSetting: [
  28. body('sessionMaxAge').optional({ checkFalsy: true }).trim().isInt(),
  29. body('restrictGuestMode')
  30. .if((value) => value != null)
  31. .isString()
  32. .isIn(['Deny', 'Readonly']),
  33. body('pageCompleteDeletionAuthority')
  34. .if((value) => value != null)
  35. .isString()
  36. .isIn(Object.values(PageDeleteConfigValue)),
  37. body('hideRestrictedByOwner')
  38. .if((value) => value != null)
  39. .isBoolean(),
  40. body('hideRestrictedByGroup')
  41. .if((value) => value != null)
  42. .isBoolean(),
  43. body('isUsersHomepageDeletionEnabled')
  44. .if((value) => value != null)
  45. .isBoolean(),
  46. body('isForceDeleteUserHomepageOnUserDeletion')
  47. .if((value) => value != null)
  48. .isBoolean(),
  49. ],
  50. shareLinkSetting: [
  51. body('disableLinkSharing')
  52. .if((value) => value != null)
  53. .isBoolean(),
  54. ],
  55. authenticationSetting: [
  56. body('isEnabled')
  57. .if((value) => value != null)
  58. .isBoolean(),
  59. body('authId')
  60. .isString()
  61. .isIn(['local', 'ldap', 'saml', 'oidc', 'google', 'github']),
  62. ],
  63. localSetting: [
  64. body('registrationMode').isString().isIn(['Open', 'Restricted', 'Closed']),
  65. body('registrationWhitelist')
  66. .if((value) => value != null)
  67. .isArray()
  68. .customSanitizer((value, { req }) => {
  69. return value.filter((email) => email !== '');
  70. }),
  71. ],
  72. ldapAuth: [
  73. body('serverUrl')
  74. .if((value) => value != null)
  75. .isString(),
  76. body('isUserBind')
  77. .if((value) => value != null)
  78. .isBoolean(),
  79. body('ldapBindDN')
  80. .if((value) => value != null)
  81. .isString(),
  82. body('ldapBindDNPassword')
  83. .if((value) => value != null)
  84. .isString(),
  85. body('ldapSearchFilter')
  86. .if((value) => value != null)
  87. .isString(),
  88. body('ldapAttrMapUsername')
  89. .if((value) => value != null)
  90. .isString(),
  91. body('isSameUsernameTreatedAsIdenticalUser')
  92. .if((value) => value != null)
  93. .isBoolean(),
  94. body('ldapAttrMapMail')
  95. .if((value) => value != null)
  96. .isString(),
  97. body('ldapAttrMapName')
  98. .if((value) => value != null)
  99. .isString(),
  100. body('ldapGroupSearchBase')
  101. .if((value) => value != null)
  102. .isString(),
  103. body('ldapGroupSearchFilter')
  104. .if((value) => value != null)
  105. .isString(),
  106. body('ldapGroupDnProperty')
  107. .if((value) => value != null)
  108. .isString(),
  109. ],
  110. oidcAuth: [
  111. body('oidcProviderName')
  112. .if((value) => value != null)
  113. .isString(),
  114. body('oidcIssuerHost')
  115. .if((value) => value != null)
  116. .isString(),
  117. body('oidcAuthorizationEndpoint')
  118. .if((value) => value != null)
  119. .isString(),
  120. body('oidcTokenEndpoint')
  121. .if((value) => value != null)
  122. .isString(),
  123. body('oidcRevocationEndpoint')
  124. .if((value) => value != null)
  125. .isString(),
  126. body('oidcIntrospectionEndpoint')
  127. .if((value) => value != null)
  128. .isString(),
  129. body('oidcUserInfoEndpoint')
  130. .if((value) => value != null)
  131. .isString(),
  132. body('oidcEndSessionEndpoint')
  133. .if((value) => value != null)
  134. .isString(),
  135. body('oidcRegistrationEndpoint')
  136. .if((value) => value != null)
  137. .isString(),
  138. body('oidcJWKSUri')
  139. .if((value) => value != null)
  140. .isString(),
  141. body('oidcClientId')
  142. .if((value) => value != null)
  143. .isString(),
  144. body('oidcClientSecret')
  145. .if((value) => value != null)
  146. .isString(),
  147. body('oidcAttrMapId')
  148. .if((value) => value != null)
  149. .isString(),
  150. body('oidcAttrMapUserName')
  151. .if((value) => value != null)
  152. .isString(),
  153. body('oidcAttrMapEmail')
  154. .if((value) => value != null)
  155. .isString(),
  156. body('isSameUsernameTreatedAsIdenticalUser')
  157. .if((value) => value != null)
  158. .isBoolean(),
  159. body('isSameEmailTreatedAsIdenticalUser')
  160. .if((value) => value != null)
  161. .isBoolean(),
  162. ],
  163. googleOAuth: [
  164. body('googleClientId')
  165. .if((value) => value != null)
  166. .isString(),
  167. body('googleClientSecret')
  168. .if((value) => value != null)
  169. .isString(),
  170. body('isSameUsernameTreatedAsIdenticalUser')
  171. .if((value) => value != null)
  172. .isBoolean(),
  173. ],
  174. githubOAuth: [
  175. body('githubClientId')
  176. .if((value) => value != null)
  177. .isString(),
  178. body('githubClientSecret')
  179. .if((value) => value != null)
  180. .isString(),
  181. body('isSameUsernameTreatedAsIdenticalUser')
  182. .if((value) => value != null)
  183. .isBoolean(),
  184. ],
  185. };
  186. /**
  187. * @swagger
  188. *
  189. * components:
  190. * schemas:
  191. * GeneralSetting:
  192. * type: object
  193. * properties:
  194. * restrictGuestMode:
  195. * type: string
  196. * description: type of restrictGuestMode
  197. * pageDeletionAuthority:
  198. * type: string
  199. * description: type of pageDeletionAuthority
  200. * pageRecursiveDeletionAuthority:
  201. * type: string
  202. * description: type of pageRecursiveDeletionAuthority
  203. * pageRecursiveCompleteDeletionAuthority:
  204. * type: string
  205. * description: type of pageRecursiveCompleteDeletionAuthority
  206. * isAllGroupMembershipRequiredForPageCompleteDeletion:
  207. * type: boolean
  208. * description: enable all group membership required for page complete deletion
  209. * pageCompleteDeletionAuthority:
  210. * type: string
  211. * description: type of pageDeletionAuthority
  212. * hideRestrictedByOwner:
  213. * type: boolean
  214. * description: enable hide by owner
  215. * hideRestrictedByGroup:
  216. * type: boolean
  217. * description: enable hide by group
  218. * isUsersHomepageDeletionEnabled:
  219. * type: boolean
  220. * description: enable user homepage deletion
  221. * isForceDeleteUserHomepageOnUserDeletion:
  222. * type: boolean
  223. * description: enable force delete user homepage on user deletion
  224. * isRomUserAllowedToComment:
  225. * type: boolean
  226. * description: enable rom user allowed to comment
  227. * wikiMode:
  228. * type: string
  229. * description: type of wikiMode
  230. * sessionMaxAge:
  231. * type: integer
  232. * description: max age of session
  233. * ShareLinkSetting:
  234. * type: object
  235. * properties:
  236. * disableLinkSharing:
  237. * type: boolean
  238. * description: disable link sharing
  239. * LocalSetting:
  240. * type: object
  241. * properties:
  242. * useOnlyEnvVarsForSomeOptions:
  243. * type: boolean
  244. * description: use only env vars for some options
  245. * isPasswordResetEnabled:
  246. * type: boolean
  247. * description: enable password reset
  248. * isEmailAuthenticationEnabled:
  249. * type: boolean
  250. * description: enable email authentication
  251. * isLocalEnabled:
  252. * type: boolean
  253. * description: local setting mode
  254. * registrationMode:
  255. * type: string
  256. * description: type of registrationMode
  257. * registrationWhitelist:
  258. * type: array
  259. * description: array of regsitrationList
  260. * items:
  261. * type: string
  262. * description: registration whitelist
  263. * GeneralAuthSetting:
  264. * type: object
  265. * properties:
  266. * isLocalEnabled:
  267. * type: boolean
  268. * description: local setting mode
  269. * isLdapEnabled:
  270. * type: boolean
  271. * description: ldap setting mode
  272. * isSamlEnabled:
  273. * type: boolean
  274. * description: saml setting mode
  275. * isOidcEnabled:
  276. * type: boolean
  277. * description: oidc setting mode
  278. * isGoogleEnabled:
  279. * type: boolean
  280. * description: google setting mode
  281. * isGitHubEnabled:
  282. * type: boolean
  283. * description: github setting mode
  284. * LdapAuthSetting:
  285. * type: object
  286. * properties:
  287. * serverUrl:
  288. * type: string
  289. * description: server url for ldap
  290. * isUserBind:
  291. * type: boolean
  292. * description: enable user bind
  293. * ldapBindDN:
  294. * type: string
  295. * description: the query used to bind with the directory service
  296. * ldapBindDNPassword:
  297. * type: string
  298. * description: the password that is entered in the login page will be used to bind
  299. * ldapSearchFilter:
  300. * type: string
  301. * description: the query used to locate the authenticated user
  302. * ldapAttrMapUsername:
  303. * type: string
  304. * description: specification of mappings for username when creating new users
  305. * isSameUsernameTreatedAsIdenticalUser:
  306. * type: boolean
  307. * description: local account automatically linked the user name matched
  308. * ldapAttrMapMail:
  309. * type: string
  310. * description: specification of mappings for mail address when creating new users
  311. * ldapAttrMapName:
  312. * type: string
  313. * description: Specification of mappings for full name address when creating new users
  314. * ldapGroupSearchBase:
  315. * type: string
  316. * description: the base DN from which to search for groups.
  317. * ldapGroupSearchFilter:
  318. * type: string
  319. * description: the query used to filter for groups
  320. * ldapGroupDnProperty:
  321. * type: string
  322. * description: The property of user object to use in dn interpolation of Group Search Filter
  323. * OidcAuthSetting:
  324. * type: object
  325. * properties:
  326. * oidcProviderName:
  327. * type: string
  328. * description: provider name for oidc
  329. * oidcIssuerHost:
  330. * type: string
  331. * description: issuer host for oidc
  332. * oidcAuthorizationEndpoint:
  333. * type: string
  334. * description: authorization endpoint for oidc
  335. * oidcTokenEndpoint:
  336. * type: string
  337. * description: token endpoint for oidc
  338. * oidcRevocationEndpoint:
  339. * type: string
  340. * description: revocation endpoint for oidc
  341. * oidcIntrospectionEndpoint:
  342. * type: string
  343. * description: introspection endpoint for oidc
  344. * oidcUserInfoEndpoint:
  345. * type: string
  346. * description: userinfo endpoint for oidc
  347. * oidcEndSessionEndpoint:
  348. * type: string
  349. * description: end session endpoint for oidc
  350. * oidcRegistrationEndpoint:
  351. * type: string
  352. * description: registration endpoint for oidc
  353. * oidcJWKSUri:
  354. * type: string
  355. * description: JSON Web Key Set URI for oidc
  356. * oidcClientId:
  357. * type: string
  358. * description: client id for oidc
  359. * oidcClientSecret:
  360. * type: string
  361. * description: client secret for oidc
  362. * oidcAttrMapId:
  363. * type: string
  364. * description: attr map id for oidc
  365. * oidcAttrMapUserName:
  366. * type: string
  367. * description: attr map username for oidc
  368. * oidcAttrMapName:
  369. * type: string
  370. * description: attr map name for oidc
  371. * oidcAttrMapMail:
  372. * type: string
  373. * description: attr map mail for oidc
  374. * isSameUsernameTreatedAsIdenticalUser:
  375. * type: boolean
  376. * description: local account automatically linked the user name matched
  377. * isSameEmailTreatedAsIdenticalUser:
  378. * type: boolean
  379. * description: local account automatically linked the email matched
  380. * GitHubOAuthSetting:
  381. * type: object
  382. * properties:
  383. * githubClientId:
  384. * type: string
  385. * description: key of comsumer
  386. * githubClientSecret:
  387. * type: string
  388. * description: password of comsumer
  389. * isSameUsernameTreatedAsIdenticalUser:
  390. * type: boolean
  391. * description: local account automatically linked the email matched
  392. * GoogleOAuthSetting:
  393. * type: object
  394. * properties:
  395. * googleClientId:
  396. * type: string
  397. * description: key of comsumer
  398. * googleClientSecret:
  399. * type: string
  400. * description: password of comsumer
  401. * isSameUsernameTreatedAsIdenticalUser:
  402. * type: boolean
  403. * description: local account automatically linked the email matched
  404. */
  405. /** @param {import('~/server/crowi').default} crowi Crowi instance */
  406. module.exports = (crowi) => {
  407. const loginRequiredStrictly = require('~/server/middlewares/login-required')(
  408. crowi,
  409. );
  410. const adminRequired = require('~/server/middlewares/admin-required')(crowi);
  411. const addActivity = generateAddActivityMiddleware(crowi);
  412. const activityEvent = crowi.event('activity');
  413. async function updateAndReloadStrategySettings(
  414. authId,
  415. params,
  416. opts = { removeIfUndefined: false },
  417. ) {
  418. const { passportService } = crowi;
  419. // update config without publishing S2sMessage
  420. await configManager.updateConfigs(params, {
  421. skipPubsub: true,
  422. removeIfUndefined: opts.removeIfUndefined,
  423. });
  424. await passportService.setupStrategyById(authId);
  425. passportService.publishUpdatedMessage(authId);
  426. }
  427. /**
  428. * @swagger
  429. *
  430. * /security-setting/:
  431. * get:
  432. * tags: [SecuritySetting]
  433. * description: Get security paramators
  434. * responses:
  435. * 200:
  436. * description: params of security
  437. * content:
  438. * application/json:
  439. * schema:
  440. * properties:
  441. * securityParams:
  442. * type: object
  443. * description: security params
  444. * properties:
  445. * generalSetting:
  446. * $ref: '#/components/schemas/GeneralSetting'
  447. * shareLinkSetting:
  448. * $ref: '#/components/schemas/ShareLinkSetting'
  449. * localSetting:
  450. * $ref: '#/components/schemas/LocalSetting'
  451. * generalAuth:
  452. * $ref: '#/components/schemas/GeneralAuthSetting'
  453. * ldapAuth:
  454. * $ref: '#/components/schemas/LdapAuthSetting'
  455. * samlAuth:
  456. * $ref: '#/components/schemas/SamlAuthSetting'
  457. * oidcAuth:
  458. * $ref: '#/components/schemas/OidcAuthSetting'
  459. * googleOAuth:
  460. * $ref: '#/components/schemas/GoogleOAuthSetting'
  461. * githubOAuth:
  462. * $ref: '#/components/schemas/GitHubOAuthSetting'
  463. */
  464. router.get(
  465. '/',
  466. accessTokenParser([SCOPE.READ.ADMIN.SECURITY]),
  467. loginRequiredStrictly,
  468. adminRequired,
  469. async (req, res) => {
  470. const securityParams = {
  471. generalSetting: {
  472. restrictGuestMode: crowi.aclService.getGuestModeValue(),
  473. pageDeletionAuthority: await configManager.getConfig(
  474. 'security:pageDeletionAuthority',
  475. ),
  476. pageCompleteDeletionAuthority: await configManager.getConfig(
  477. 'security:pageCompleteDeletionAuthority',
  478. ),
  479. pageRecursiveDeletionAuthority: await configManager.getConfig(
  480. 'security:pageRecursiveDeletionAuthority',
  481. ),
  482. pageRecursiveCompleteDeletionAuthority: await configManager.getConfig(
  483. 'security:pageRecursiveCompleteDeletionAuthority',
  484. ),
  485. isAllGroupMembershipRequiredForPageCompleteDeletion:
  486. await configManager.getConfig(
  487. 'security:isAllGroupMembershipRequiredForPageCompleteDeletion',
  488. ),
  489. hideRestrictedByOwner: await configManager.getConfig(
  490. 'security:list-policy:hideRestrictedByOwner',
  491. ),
  492. hideRestrictedByGroup: await configManager.getConfig(
  493. 'security:list-policy:hideRestrictedByGroup',
  494. ),
  495. isUsersHomepageDeletionEnabled: await configManager.getConfig(
  496. 'security:user-homepage-deletion:isEnabled',
  497. ),
  498. isForceDeleteUserHomepageOnUserDeletion:
  499. await configManager.getConfig(
  500. 'security:user-homepage-deletion:isForceDeleteUserHomepageOnUserDeletion',
  501. ),
  502. isRomUserAllowedToComment: await configManager.getConfig(
  503. 'security:isRomUserAllowedToComment',
  504. ),
  505. wikiMode: await configManager.getConfig('security:wikiMode'),
  506. sessionMaxAge: await configManager.getConfig(
  507. 'security:sessionMaxAge',
  508. ),
  509. },
  510. shareLinkSetting: {
  511. disableLinkSharing: await configManager.getConfig(
  512. 'security:disableLinkSharing',
  513. ),
  514. },
  515. localSetting: {
  516. useOnlyEnvVarsForSomeOptions: await configManager.getConfig(
  517. 'env:useOnlyEnvVars:security:passport-local',
  518. ),
  519. registrationMode: await configManager.getConfig(
  520. 'security:registrationMode',
  521. ),
  522. registrationWhitelist: await configManager.getConfig(
  523. 'security:registrationWhitelist',
  524. ),
  525. isPasswordResetEnabled: await configManager.getConfig(
  526. 'security:passport-local:isPasswordResetEnabled',
  527. ),
  528. isEmailAuthenticationEnabled: await configManager.getConfig(
  529. 'security:passport-local:isEmailAuthenticationEnabled',
  530. ),
  531. },
  532. generalAuth: {
  533. isLocalEnabled: await configManager.getConfig(
  534. 'security:passport-local:isEnabled',
  535. ),
  536. isLdapEnabled: await configManager.getConfig(
  537. 'security:passport-ldap:isEnabled',
  538. ),
  539. isSamlEnabled: await configManager.getConfig(
  540. 'security:passport-saml:isEnabled',
  541. ),
  542. isOidcEnabled: await configManager.getConfig(
  543. 'security:passport-oidc:isEnabled',
  544. ),
  545. isGoogleEnabled: await configManager.getConfig(
  546. 'security:passport-google:isEnabled',
  547. ),
  548. isGitHubEnabled: await configManager.getConfig(
  549. 'security:passport-github:isEnabled',
  550. ),
  551. },
  552. ldapAuth: {
  553. serverUrl: await configManager.getConfig(
  554. 'security:passport-ldap:serverUrl',
  555. ),
  556. isUserBind: await configManager.getConfig(
  557. 'security:passport-ldap:isUserBind',
  558. ),
  559. ldapBindDN: await configManager.getConfig(
  560. 'security:passport-ldap:bindDN',
  561. ),
  562. ldapBindDNPassword: await configManager.getConfig(
  563. 'security:passport-ldap:bindDNPassword',
  564. ),
  565. ldapSearchFilter: await configManager.getConfig(
  566. 'security:passport-ldap:searchFilter',
  567. ),
  568. ldapAttrMapUsername: await configManager.getConfig(
  569. 'security:passport-ldap:attrMapUsername',
  570. ),
  571. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  572. 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser',
  573. ),
  574. ldapAttrMapMail: await configManager.getConfig(
  575. 'security:passport-ldap:attrMapMail',
  576. ),
  577. ldapAttrMapName: await configManager.getConfig(
  578. 'security:passport-ldap:attrMapName',
  579. ),
  580. ldapGroupSearchBase: await configManager.getConfig(
  581. 'security:passport-ldap:groupSearchBase',
  582. ),
  583. ldapGroupSearchFilter: await configManager.getConfig(
  584. 'security:passport-ldap:groupSearchFilter',
  585. ),
  586. ldapGroupDnProperty: await configManager.getConfig(
  587. 'security:passport-ldap:groupDnProperty',
  588. ),
  589. },
  590. samlAuth: {
  591. missingMandatoryConfigKeys:
  592. await crowi.passportService.getSamlMissingMandatoryConfigKeys(),
  593. useOnlyEnvVarsForSomeOptions: await configManager.getConfig(
  594. 'env:useOnlyEnvVars:security:passport-saml',
  595. ConfigSource.env,
  596. ),
  597. samlEntryPoint: await configManager.getConfig(
  598. 'security:passport-saml:entryPoint',
  599. ConfigSource.db,
  600. ),
  601. samlEnvVarEntryPoint: await configManager.getConfig(
  602. 'security:passport-saml:entryPoint',
  603. ConfigSource.env,
  604. ),
  605. samlIssuer: await configManager.getConfig(
  606. 'security:passport-saml:issuer',
  607. ConfigSource.db,
  608. ),
  609. samlEnvVarIssuer: await configManager.getConfig(
  610. 'security:passport-saml:issuer',
  611. ConfigSource.env,
  612. ),
  613. samlCert: await configManager.getConfig(
  614. 'security:passport-saml:cert',
  615. ConfigSource.db,
  616. ),
  617. samlEnvVarCert: await configManager.getConfig(
  618. 'security:passport-saml:cert',
  619. ConfigSource.env,
  620. ),
  621. samlAttrMapId: await configManager.getConfig(
  622. 'security:passport-saml:attrMapId',
  623. ConfigSource.db,
  624. ),
  625. samlEnvVarAttrMapId: await configManager.getConfig(
  626. 'security:passport-saml:attrMapId',
  627. ConfigSource.env,
  628. ),
  629. samlAttrMapUsername: await configManager.getConfig(
  630. 'security:passport-saml:attrMapUsername',
  631. ConfigSource.db,
  632. ),
  633. samlEnvVarAttrMapUsername: await configManager.getConfig(
  634. 'security:passport-saml:attrMapUsername',
  635. ConfigSource.env,
  636. ),
  637. samlAttrMapMail: await configManager.getConfig(
  638. 'security:passport-saml:attrMapMail',
  639. ConfigSource.db,
  640. ),
  641. samlEnvVarAttrMapMail: await configManager.getConfig(
  642. 'security:passport-saml:attrMapMail',
  643. ConfigSource.env,
  644. ),
  645. samlAttrMapFirstName: await configManager.getConfig(
  646. 'security:passport-saml:attrMapFirstName',
  647. ConfigSource.db,
  648. ),
  649. samlEnvVarAttrMapFirstName: await configManager.getConfig(
  650. 'security:passport-saml:attrMapFirstName',
  651. ConfigSource.env,
  652. ),
  653. samlAttrMapLastName: await configManager.getConfig(
  654. 'security:passport-saml:attrMapLastName',
  655. ConfigSource.db,
  656. ),
  657. samlEnvVarAttrMapLastName: await configManager.getConfig(
  658. 'security:passport-saml:attrMapLastName',
  659. ConfigSource.env,
  660. ),
  661. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  662. 'security:passport-saml:isSameUsernameTreatedAsIdenticalUser',
  663. ),
  664. isSameEmailTreatedAsIdenticalUser: await configManager.getConfig(
  665. 'security:passport-saml:isSameEmailTreatedAsIdenticalUser',
  666. ),
  667. samlABLCRule: await configManager.getConfig(
  668. 'security:passport-saml:ABLCRule',
  669. ConfigSource.db,
  670. ),
  671. samlEnvVarABLCRule: await configManager.getConfig(
  672. 'security:passport-saml:ABLCRule',
  673. ConfigSource.env,
  674. ),
  675. },
  676. oidcAuth: {
  677. oidcProviderName: await configManager.getConfig(
  678. 'security:passport-oidc:providerName',
  679. ),
  680. oidcIssuerHost: await configManager.getConfig(
  681. 'security:passport-oidc:issuerHost',
  682. ),
  683. oidcAuthorizationEndpoint: await configManager.getConfig(
  684. 'security:passport-oidc:authorizationEndpoint',
  685. ),
  686. oidcTokenEndpoint: await configManager.getConfig(
  687. 'security:passport-oidc:tokenEndpoint',
  688. ),
  689. oidcRevocationEndpoint: await configManager.getConfig(
  690. 'security:passport-oidc:revocationEndpoint',
  691. ),
  692. oidcIntrospectionEndpoint: await configManager.getConfig(
  693. 'security:passport-oidc:introspectionEndpoint',
  694. ),
  695. oidcUserInfoEndpoint: await configManager.getConfig(
  696. 'security:passport-oidc:userInfoEndpoint',
  697. ),
  698. oidcEndSessionEndpoint: await configManager.getConfig(
  699. 'security:passport-oidc:endSessionEndpoint',
  700. ),
  701. oidcRegistrationEndpoint: await configManager.getConfig(
  702. 'security:passport-oidc:registrationEndpoint',
  703. ),
  704. oidcJWKSUri: await configManager.getConfig(
  705. 'security:passport-oidc:jwksUri',
  706. ),
  707. oidcClientId: await configManager.getConfig(
  708. 'security:passport-oidc:clientId',
  709. ),
  710. oidcClientSecret: await configManager.getConfig(
  711. 'security:passport-oidc:clientSecret',
  712. ),
  713. oidcAttrMapId: await configManager.getConfig(
  714. 'security:passport-oidc:attrMapId',
  715. ),
  716. oidcAttrMapUserName: await configManager.getConfig(
  717. 'security:passport-oidc:attrMapUserName',
  718. ),
  719. oidcAttrMapName: await configManager.getConfig(
  720. 'security:passport-oidc:attrMapName',
  721. ),
  722. oidcAttrMapEmail: await configManager.getConfig(
  723. 'security:passport-oidc:attrMapMail',
  724. ),
  725. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  726. 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser',
  727. ),
  728. isSameEmailTreatedAsIdenticalUser: await configManager.getConfig(
  729. 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser',
  730. ),
  731. },
  732. googleOAuth: {
  733. googleClientId: await configManager.getConfig(
  734. 'security:passport-google:clientId',
  735. ),
  736. googleClientSecret: await configManager.getConfig(
  737. 'security:passport-google:clientSecret',
  738. ),
  739. isSameEmailTreatedAsIdenticalUser: await configManager.getConfig(
  740. 'security:passport-google:isSameEmailTreatedAsIdenticalUser',
  741. ),
  742. },
  743. githubOAuth: {
  744. githubClientId: await configManager.getConfig(
  745. 'security:passport-github:clientId',
  746. ),
  747. githubClientSecret: await configManager.getConfig(
  748. 'security:passport-github:clientSecret',
  749. ),
  750. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  751. 'security:passport-github:isSameUsernameTreatedAsIdenticalUser',
  752. ),
  753. },
  754. };
  755. return res.apiv3({ securityParams });
  756. },
  757. );
  758. /**
  759. * @swagger
  760. *
  761. * /security-setting/authentication/enabled:
  762. * put:
  763. * tags: [SecuritySetting]
  764. * description: Update authentication isEnabled
  765. * requestBody:
  766. * required: true
  767. * content:
  768. * application/json:
  769. * schema:
  770. * type: object
  771. * properties:
  772. * isEnabled:
  773. * type: boolean
  774. * authId:
  775. * type: string
  776. * responses:
  777. * 200:
  778. * description: Succeeded to enable authentication
  779. * content:
  780. * application/json:
  781. * schema:
  782. * type: object
  783. * description: updated param
  784. */
  785. // eslint-disable-next-line max-len
  786. router.put(
  787. '/authentication/enabled',
  788. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  789. loginRequiredStrictly,
  790. adminRequired,
  791. addActivity,
  792. validator.authenticationSetting,
  793. apiV3FormValidator,
  794. async (req, res) => {
  795. const { isEnabled, authId } = req.body;
  796. let setupStrategies = await crowi.passportService.getSetupStrategies();
  797. const parameters = {};
  798. // Reflect request param
  799. setupStrategies = setupStrategies.filter(
  800. (strategy) => strategy !== authId,
  801. );
  802. if (setupStrategies.length === 0) {
  803. return res.apiv3Err(new ErrorV3('Can not turn everything off'), 405);
  804. }
  805. if (!isEnabled) {
  806. const isSetupStrategiesHasAdmin =
  807. await checkSetupStrategiesHasAdmin(setupStrategies);
  808. // Return an error when disabling an strategy when there are no setup strategies with admin-enabled login
  809. if (!isSetupStrategiesHasAdmin) {
  810. return res.apiv3Err(
  811. new ErrorV3('Must have admin enabled authentication method'),
  812. 405,
  813. );
  814. }
  815. }
  816. const enableParams = {
  817. [`security:passport-${authId}:isEnabled`]: isEnabled,
  818. };
  819. try {
  820. await updateAndReloadStrategySettings(authId, enableParams);
  821. const responseParams = {
  822. [`security:passport-${authId}:isEnabled`]:
  823. await configManager.getConfig(
  824. `security:passport-${authId}:isEnabled`,
  825. ),
  826. };
  827. switch (authId) {
  828. case 'local':
  829. if (isEnabled) {
  830. parameters.action =
  831. SupportedAction.ACTION_ADMIN_AUTH_ID_PASS_ENABLED;
  832. break;
  833. }
  834. parameters.action =
  835. SupportedAction.ACTION_ADMIN_AUTH_ID_PASS_DISABLED;
  836. break;
  837. case 'ldap':
  838. if (isEnabled) {
  839. parameters.action =
  840. SupportedAction.ACTION_ADMIN_AUTH_LDAP_ENABLED;
  841. break;
  842. }
  843. parameters.action = SupportedAction.ACTION_ADMIN_AUTH_LDAP_DISABLED;
  844. break;
  845. case 'saml':
  846. if (isEnabled) {
  847. parameters.action =
  848. SupportedAction.ACTION_ADMIN_AUTH_SAML_ENABLED;
  849. break;
  850. }
  851. parameters.action = SupportedAction.ACTION_ADMIN_AUTH_SAML_DISABLED;
  852. break;
  853. case 'oidc':
  854. if (isEnabled) {
  855. parameters.action =
  856. SupportedAction.ACTION_ADMIN_AUTH_OIDC_ENABLED;
  857. break;
  858. }
  859. parameters.action = SupportedAction.ACTION_ADMIN_AUTH_OIDC_DISABLED;
  860. break;
  861. case 'google':
  862. if (isEnabled) {
  863. parameters.action =
  864. SupportedAction.ACTION_ADMIN_AUTH_GOOGLE_ENABLED;
  865. break;
  866. }
  867. parameters.action =
  868. SupportedAction.ACTION_ADMIN_AUTH_GOOGLE_DISABLED;
  869. break;
  870. case 'github':
  871. if (isEnabled) {
  872. parameters.action =
  873. SupportedAction.ACTION_ADMIN_AUTH_GITHUB_ENABLED;
  874. break;
  875. }
  876. parameters.action =
  877. SupportedAction.ACTION_ADMIN_AUTH_GITHUB_DISABLED;
  878. break;
  879. }
  880. activityEvent.emit('update', res.locals.activity._id, parameters);
  881. return res.apiv3({ responseParams });
  882. } catch (err) {
  883. const msg = 'Error occurred in updating enable setting';
  884. logger.error('Error', err);
  885. return res.apiv3Err(new ErrorV3(msg, 'update-enable-setting failed'));
  886. }
  887. },
  888. );
  889. /**
  890. * @swagger
  891. *
  892. * /security-setting/authentication:
  893. * get:
  894. * tags: [SecuritySetting]
  895. * security:
  896. * - cookieAuth: []
  897. * summary: /security-setting/authentication
  898. * description: Get setup strategies for passport
  899. * responses:
  900. * 200:
  901. * description: params of setup strategies
  902. * content:
  903. * application/json:
  904. * schema:
  905. * properties:
  906. * setupStrategies:
  907. * type: array
  908. * description: setup strategies list
  909. * items:
  910. * type: string
  911. * description: setup strategie
  912. * example: ["local"]
  913. */
  914. router.get(
  915. '/authentication/',
  916. accessTokenParser([SCOPE.READ.ADMIN.SECURITY]),
  917. loginRequiredStrictly,
  918. adminRequired,
  919. async (req, res) => {
  920. const setupStrategies = await crowi.passportService.getSetupStrategies();
  921. return res.apiv3({ setupStrategies });
  922. },
  923. );
  924. /**
  925. * @swagger
  926. *
  927. * /security-setting/general-setting:
  928. * put:
  929. * tags: [SecuritySetting]
  930. * security:
  931. * - cookieAuth: []
  932. * summary: /security-setting/general-setting
  933. * description: Update GeneralSetting
  934. * requestBody:
  935. * required: true
  936. * content:
  937. * application/json:
  938. * schema:
  939. * $ref: '#/components/schemas/GeneralSetting'
  940. * responses:
  941. * 200:
  942. * description: Succeeded to update general Setting
  943. * content:
  944. * application/json:
  945. * schema:
  946. * $ref: '#/components/schemas/GeneralSetting'
  947. */
  948. router.put(
  949. '/general-setting',
  950. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  951. loginRequiredStrictly,
  952. adminRequired,
  953. addActivity,
  954. validator.generalSetting,
  955. apiV3FormValidator,
  956. async (req, res) => {
  957. const updateData = {
  958. 'security:sessionMaxAge': parseInt(req.body.sessionMaxAge),
  959. 'security:restrictGuestMode': req.body.restrictGuestMode,
  960. 'security:pageDeletionAuthority': req.body.pageDeletionAuthority,
  961. 'security:pageRecursiveDeletionAuthority':
  962. req.body.pageRecursiveDeletionAuthority,
  963. 'security:pageCompleteDeletionAuthority':
  964. req.body.pageCompleteDeletionAuthority,
  965. 'security:pageRecursiveCompleteDeletionAuthority':
  966. req.body.pageRecursiveCompleteDeletionAuthority,
  967. 'security:isAllGroupMembershipRequiredForPageCompleteDeletion':
  968. req.body.isAllGroupMembershipRequiredForPageCompleteDeletion,
  969. 'security:list-policy:hideRestrictedByOwner':
  970. req.body.hideRestrictedByOwner,
  971. 'security:list-policy:hideRestrictedByGroup':
  972. req.body.hideRestrictedByGroup,
  973. 'security:user-homepage-deletion:isEnabled':
  974. req.body.isUsersHomepageDeletionEnabled,
  975. // Validate user-homepage-deletion config
  976. 'security:user-homepage-deletion:isForceDeleteUserHomepageOnUserDeletion':
  977. req.body.isUsersHomepageDeletionEnabled
  978. ? req.body.isForceDeleteUserHomepageOnUserDeletion
  979. : false,
  980. 'security:isRomUserAllowedToComment':
  981. req.body.isRomUserAllowedToComment,
  982. };
  983. // Validate delete config
  984. const [singleAuthority1, recursiveAuthority1] =
  985. prepareDeleteConfigValuesForCalc(
  986. req.body.pageDeletionAuthority,
  987. req.body.pageRecursiveDeletionAuthority,
  988. );
  989. // eslint-disable-next-line max-len
  990. const [singleAuthority2, recursiveAuthority2] =
  991. prepareDeleteConfigValuesForCalc(
  992. req.body.pageCompleteDeletionAuthority,
  993. req.body.pageRecursiveCompleteDeletionAuthority,
  994. );
  995. const isDeleteConfigNormalized =
  996. validateDeleteConfigs(singleAuthority1, recursiveAuthority1) &&
  997. validateDeleteConfigs(singleAuthority2, recursiveAuthority2);
  998. if (!isDeleteConfigNormalized) {
  999. return res.apiv3Err(
  1000. new ErrorV3(
  1001. 'Delete config values are not correct.',
  1002. 'delete_config_not_normalized',
  1003. ),
  1004. );
  1005. }
  1006. const wikiMode = await configManager.getConfig('security:wikiMode');
  1007. if (wikiMode === 'private' || wikiMode === 'public') {
  1008. logger.debug(
  1009. 'security:restrictGuestMode will not be changed because wiki mode is forced to set',
  1010. );
  1011. delete updateData['security:restrictGuestMode'];
  1012. }
  1013. try {
  1014. await configManager.updateConfigs(updateData);
  1015. const securitySettingParams = {
  1016. sessionMaxAge: await configManager.getConfig(
  1017. 'security:sessionMaxAge',
  1018. ),
  1019. restrictGuestMode: await configManager.getConfig(
  1020. 'security:restrictGuestMode',
  1021. ),
  1022. pageDeletionAuthority: await configManager.getConfig(
  1023. 'security:pageDeletionAuthority',
  1024. ),
  1025. pageCompleteDeletionAuthority: await configManager.getConfig(
  1026. 'security:pageCompleteDeletionAuthority',
  1027. ),
  1028. pageRecursiveDeletionAuthority: await configManager.getConfig(
  1029. 'security:pageRecursiveDeletionAuthority',
  1030. ),
  1031. pageRecursiveCompleteDeletionAuthority: await configManager.getConfig(
  1032. 'security:pageRecursiveCompleteDeletionAuthority',
  1033. ),
  1034. isAllGroupMembershipRequiredForPageCompleteDeletion:
  1035. await configManager.getConfig(
  1036. 'security:isAllGroupMembershipRequiredForPageCompleteDeletion',
  1037. ),
  1038. hideRestrictedByOwner: await configManager.getConfig(
  1039. 'security:list-policy:hideRestrictedByOwner',
  1040. ),
  1041. hideRestrictedByGroup: await configManager.getConfig(
  1042. 'security:list-policy:hideRestrictedByGroup',
  1043. ),
  1044. isUsersHomepageDeletionEnabled: await configManager.getConfig(
  1045. 'security:user-homepage-deletion:isEnabled',
  1046. ),
  1047. isForceDeleteUserHomepageOnUserDeletion:
  1048. await configManager.getConfig(
  1049. 'security:user-homepage-deletion:isForceDeleteUserHomepageOnUserDeletion',
  1050. ),
  1051. isRomUserAllowedToComment: await configManager.getConfig(
  1052. 'security:isRomUserAllowedToComment',
  1053. ),
  1054. };
  1055. const parameters = {
  1056. action: SupportedAction.ACTION_ADMIN_SECURITY_SETTINGS_UPDATE,
  1057. };
  1058. activityEvent.emit('update', res.locals.activity._id, parameters);
  1059. return res.apiv3({ securitySettingParams });
  1060. } catch (err) {
  1061. const msg = 'Error occurred in updating security setting';
  1062. logger.error('Error', err);
  1063. return res.apiv3Err(new ErrorV3(msg, 'update-secuirty-setting failed'));
  1064. }
  1065. },
  1066. );
  1067. /**
  1068. * @swagger
  1069. *
  1070. * /security-setting/share-link-setting:
  1071. * put:
  1072. * tags: [SecuritySetting]
  1073. * security:
  1074. * - cookieAuth: []
  1075. * summary: /security-setting/share-link-setting
  1076. * description: Update ShareLink Setting
  1077. * requestBody:
  1078. * required: true
  1079. * content:
  1080. * application/json:
  1081. * schema:
  1082. * $ref: '#/components/schemas/ShareLinkSetting'
  1083. * responses:
  1084. * 200:
  1085. * description: Succeeded to update ShareLink Setting
  1086. * content:
  1087. * application/json:
  1088. * schema:
  1089. * properties:
  1090. * securitySettingParams:
  1091. * $ref: '#/components/schemas/ShareLinkSetting'
  1092. */
  1093. router.put(
  1094. '/share-link-setting',
  1095. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1096. loginRequiredStrictly,
  1097. adminRequired,
  1098. addActivity,
  1099. validator.generalSetting,
  1100. apiV3FormValidator,
  1101. async (req, res) => {
  1102. const updateData = {
  1103. 'security:disableLinkSharing': req.body.disableLinkSharing,
  1104. };
  1105. try {
  1106. await configManager.updateConfigs(updateData);
  1107. const securitySettingParams = {
  1108. disableLinkSharing: configManager.getConfig(
  1109. 'security:disableLinkSharing',
  1110. ),
  1111. };
  1112. // eslint-disable-next-line max-len
  1113. const parameters = {
  1114. action: updateData['security:disableLinkSharing']
  1115. ? SupportedAction.ACTION_ADMIN_REJECT_SHARE_LINK
  1116. : SupportedAction.ACTION_ADMIN_PERMIT_SHARE_LINK,
  1117. };
  1118. activityEvent.emit('update', res.locals.activity._id, parameters);
  1119. return res.apiv3({ securitySettingParams });
  1120. } catch (err) {
  1121. const msg = 'Error occurred in updating security setting';
  1122. logger.error('Error', err);
  1123. return res.apiv3Err(new ErrorV3(msg, 'update-secuirty-setting failed'));
  1124. }
  1125. },
  1126. );
  1127. /**
  1128. * @swagger
  1129. *
  1130. * /security-setting/all-share-links:
  1131. * get:
  1132. * tags: [SecuritySetting]
  1133. * security:
  1134. * - cookieAuth: []
  1135. * summary: /security-setting/all-share-links
  1136. * description: Get All ShareLinks at Share Link Setting
  1137. * responses:
  1138. * 200:
  1139. * description: all share links
  1140. * content:
  1141. * application/json:
  1142. * schema:
  1143. * properties:
  1144. * securityParams:
  1145. * type: object
  1146. * description: suceed to get all share links
  1147. */
  1148. router.get(
  1149. '/all-share-links/',
  1150. accessTokenParser([SCOPE.READ.ADMIN.SECURITY]),
  1151. loginRequiredStrictly,
  1152. adminRequired,
  1153. async (req, res) => {
  1154. const page = parseInt(req.query.page) || 1;
  1155. const limit = 10;
  1156. const linkQuery = {};
  1157. try {
  1158. const paginateResult = await ShareLink.paginate(linkQuery, {
  1159. page,
  1160. limit,
  1161. populate: {
  1162. path: 'relatedPage',
  1163. select: 'path',
  1164. },
  1165. });
  1166. return res.apiv3({ paginateResult });
  1167. } catch (err) {
  1168. const msg = 'Error occured in get share link';
  1169. logger.error('Error', err);
  1170. return res.apiv3Err(new ErrorV3(msg, 'get-all-share-links-failed'));
  1171. }
  1172. },
  1173. );
  1174. /**
  1175. * @swagger
  1176. *
  1177. * /security-setting/all-share-links:
  1178. * delete:
  1179. * tags: [SecuritySetting]
  1180. * security:
  1181. * - cookieAuth: []
  1182. * summary: /security-setting/all-share-links
  1183. * description: Delete All ShareLinks at Share Link Setting
  1184. * responses:
  1185. * 200:
  1186. * description: succeed to delete all share links
  1187. * content:
  1188. * application/json:
  1189. * schema:
  1190. * properties:
  1191. * removeTotal:
  1192. * type: number
  1193. * description: total number of removed share links
  1194. */
  1195. router.delete(
  1196. '/all-share-links/',
  1197. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1198. loginRequiredStrictly,
  1199. adminRequired,
  1200. async (req, res) => {
  1201. try {
  1202. const removedAct = await ShareLink.remove({});
  1203. const removeTotal = await removedAct.n;
  1204. return res.apiv3({ removeTotal });
  1205. } catch (err) {
  1206. const msg = 'Error occured in delete all share links';
  1207. logger.error('Error', err);
  1208. return res.apiv3Err(
  1209. new ErrorV3(msg, 'failed-to-delete-all-share-links'),
  1210. );
  1211. }
  1212. },
  1213. );
  1214. /**
  1215. * @swagger
  1216. *
  1217. * /security-setting/local-setting:
  1218. * put:
  1219. * tags: [SecuritySetting]
  1220. * security:
  1221. * - cookieAuth: []
  1222. * summary: /security-setting/local-setting
  1223. * description: Update LocalSetting
  1224. * requestBody:
  1225. * required: true
  1226. * content:
  1227. * application/json:
  1228. * schema:
  1229. * $ref: '#/components/schemas/LocalSetting'
  1230. * responses:
  1231. * 200:
  1232. * description: Succeeded to update local Setting
  1233. * content:
  1234. * application/json:
  1235. * schema:
  1236. * properties:
  1237. * localSettingParams:
  1238. * $ref: '#/components/schemas/LocalSetting'
  1239. */
  1240. router.put(
  1241. '/local-setting',
  1242. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1243. loginRequiredStrictly,
  1244. adminRequired,
  1245. addActivity,
  1246. validator.localSetting,
  1247. apiV3FormValidator,
  1248. async (req, res) => {
  1249. try {
  1250. const sanitizedRegistrationWhitelist =
  1251. req.body.registrationWhitelist.map((line) =>
  1252. xss(line, { stripIgnoreTag: true }),
  1253. );
  1254. const requestParams = {
  1255. 'security:registrationMode': req.body.registrationMode,
  1256. 'security:registrationWhitelist': sanitizedRegistrationWhitelist,
  1257. 'security:passport-local:isPasswordResetEnabled':
  1258. req.body.isPasswordResetEnabled,
  1259. 'security:passport-local:isEmailAuthenticationEnabled':
  1260. req.body.isEmailAuthenticationEnabled,
  1261. };
  1262. await updateAndReloadStrategySettings('local', requestParams);
  1263. const localSettingParams = {
  1264. registrationMode: await configManager.getConfig(
  1265. 'security:registrationMode',
  1266. ),
  1267. registrationWhitelist: await configManager.getConfig(
  1268. 'security:registrationWhitelist',
  1269. ),
  1270. isPasswordResetEnabled: await configManager.getConfig(
  1271. 'security:passport-local:isPasswordResetEnabled',
  1272. ),
  1273. isEmailAuthenticationEnabled: await configManager.getConfig(
  1274. 'security:passport-local:isEmailAuthenticationEnabled',
  1275. ),
  1276. };
  1277. const parameters = {
  1278. action: SupportedAction.ACTION_ADMIN_AUTH_ID_PASS_UPDATE,
  1279. };
  1280. activityEvent.emit('update', res.locals.activity._id, parameters);
  1281. return res.apiv3({ localSettingParams });
  1282. } catch (err) {
  1283. const msg = 'Error occurred in updating local setting';
  1284. logger.error('Error', err);
  1285. return res.apiv3Err(new ErrorV3(msg, 'update-local-setting failed'));
  1286. }
  1287. },
  1288. );
  1289. /**
  1290. * @swagger
  1291. *
  1292. * /security-setting/ldap:
  1293. * put:
  1294. * tags: [SecuritySetting]
  1295. * security:
  1296. * - cookieAuth: []
  1297. * summary: /security-setting/ldap
  1298. * description: Update LDAP setting
  1299. * requestBody:
  1300. * required: true
  1301. * content:
  1302. * application/json:
  1303. * schema:
  1304. * $ref: '#/components/schemas/LdapAuthSetting'
  1305. * responses:
  1306. * 200:
  1307. * description: Succeeded to update LDAP setting
  1308. * content:
  1309. * application/json:
  1310. * schema:
  1311. * properties:
  1312. * securitySettingParams:
  1313. * $ref: '#/components/schemas/LdapAuthSetting'
  1314. */
  1315. router.put(
  1316. '/ldap',
  1317. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1318. loginRequiredStrictly,
  1319. adminRequired,
  1320. addActivity,
  1321. validator.ldapAuth,
  1322. apiV3FormValidator,
  1323. async (req, res) => {
  1324. const requestParams = {
  1325. 'security:passport-ldap:serverUrl': req.body.serverUrl,
  1326. 'security:passport-ldap:isUserBind': req.body.isUserBind,
  1327. 'security:passport-ldap:bindDN': req.body.ldapBindDN,
  1328. 'security:passport-ldap:bindDNPassword': req.body.ldapBindDNPassword,
  1329. 'security:passport-ldap:searchFilter': req.body.ldapSearchFilter,
  1330. 'security:passport-ldap:attrMapUsername': req.body.ldapAttrMapUsername,
  1331. 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser':
  1332. req.body.isSameUsernameTreatedAsIdenticalUser,
  1333. 'security:passport-ldap:attrMapMail': req.body.ldapAttrMapMail,
  1334. 'security:passport-ldap:attrMapName': req.body.ldapAttrMapName,
  1335. 'security:passport-ldap:groupSearchBase': req.body.ldapGroupSearchBase,
  1336. 'security:passport-ldap:groupSearchFilter':
  1337. req.body.ldapGroupSearchFilter,
  1338. 'security:passport-ldap:groupDnProperty': req.body.ldapGroupDnProperty,
  1339. };
  1340. try {
  1341. await updateAndReloadStrategySettings('ldap', requestParams);
  1342. const securitySettingParams = {
  1343. serverUrl: await configManager.getConfig(
  1344. 'security:passport-ldap:serverUrl',
  1345. ),
  1346. isUserBind: await configManager.getConfig(
  1347. 'security:passport-ldap:isUserBind',
  1348. ),
  1349. ldapBindDN: await configManager.getConfig(
  1350. 'security:passport-ldap:bindDN',
  1351. ),
  1352. ldapBindDNPassword: await configManager.getConfig(
  1353. 'security:passport-ldap:bindDNPassword',
  1354. ),
  1355. ldapSearchFilter: await configManager.getConfig(
  1356. 'security:passport-ldap:searchFilter',
  1357. ),
  1358. ldapAttrMapUsername: await configManager.getConfig(
  1359. 'security:passport-ldap:attrMapUsername',
  1360. ),
  1361. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  1362. 'security:passport-ldap:isSameUsernameTreatedAsIdenticalUser',
  1363. ),
  1364. ldapAttrMapMail: await configManager.getConfig(
  1365. 'security:passport-ldap:attrMapMail',
  1366. ),
  1367. ldapAttrMapName: await configManager.getConfig(
  1368. 'security:passport-ldap:attrMapName',
  1369. ),
  1370. ldapGroupSearchBase: await configManager.getConfig(
  1371. 'security:passport-ldap:groupSearchBase',
  1372. ),
  1373. ldapGroupSearchFilter: await configManager.getConfig(
  1374. 'security:passport-ldap:groupSearchFilter',
  1375. ),
  1376. ldapGroupDnProperty: await configManager.getConfig(
  1377. 'security:passport-ldap:groupDnProperty',
  1378. ),
  1379. };
  1380. const parameters = {
  1381. action: SupportedAction.ACTION_ADMIN_AUTH_LDAP_UPDATE,
  1382. };
  1383. activityEvent.emit('update', res.locals.activity._id, parameters);
  1384. return res.apiv3({ securitySettingParams });
  1385. } catch (err) {
  1386. const msg = 'Error occurred in updating SAML setting';
  1387. logger.error('Error', err);
  1388. return res.apiv3Err(new ErrorV3(msg, 'update-SAML-failed'));
  1389. }
  1390. },
  1391. );
  1392. /**
  1393. * @swagger
  1394. *
  1395. * /security-setting/saml:
  1396. * put:
  1397. * tags: [SecuritySetting]
  1398. * security:
  1399. * - cookieAuth: []
  1400. * summary: /security-setting/saml
  1401. * description: Update SAML setting
  1402. * requestBody:
  1403. * required: true
  1404. * content:
  1405. * application/json:
  1406. * schema:
  1407. * $ref: '#/components/schemas/SamlAuthSetting'
  1408. * responses:
  1409. * 200:
  1410. * description: Succeeded to update SAML setting
  1411. * content:
  1412. * application/json:
  1413. * schema:
  1414. * properties:
  1415. * securitySettingParams:
  1416. * $ref: '#/components/schemas/SamlAuthSetting'
  1417. */
  1418. router.put(
  1419. '/saml',
  1420. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1421. loginRequiredStrictly,
  1422. adminRequired,
  1423. addActivity,
  1424. samlAuthValidator,
  1425. apiV3FormValidator,
  1426. handleSamlUpdate(crowi, activityEvent, updateAndReloadStrategySettings),
  1427. );
  1428. /**
  1429. * @swagger
  1430. *
  1431. * /security-setting/oidc:
  1432. * put:
  1433. * tags: [SecuritySetting]
  1434. * security:
  1435. * - cookieAuth: []
  1436. * summary: /security-setting/oidc
  1437. * description: Update OpenID Connect setting
  1438. * requestBody:
  1439. * required: true
  1440. * content:
  1441. * application/json:
  1442. * schema:
  1443. * $ref: '#/components/schemas/OidcAuthSetting'
  1444. * responses:
  1445. * 200:
  1446. * description: Succeeded to update OpenID Connect setting
  1447. * content:
  1448. * application/json:
  1449. * schema:
  1450. * properties:
  1451. * securitySettingParams:
  1452. * $ref: '#/components/schemas/OidcAuthSetting'
  1453. */
  1454. router.put(
  1455. '/oidc',
  1456. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1457. loginRequiredStrictly,
  1458. adminRequired,
  1459. addActivity,
  1460. validator.oidcAuth,
  1461. apiV3FormValidator,
  1462. async (req, res) => {
  1463. const requestParams = {
  1464. 'security:passport-oidc:providerName': req.body.oidcProviderName,
  1465. 'security:passport-oidc:issuerHost': req.body.oidcIssuerHost,
  1466. 'security:passport-oidc:authorizationEndpoint':
  1467. req.body.oidcAuthorizationEndpoint,
  1468. 'security:passport-oidc:tokenEndpoint': req.body.oidcTokenEndpoint,
  1469. 'security:passport-oidc:revocationEndpoint':
  1470. req.body.oidcRevocationEndpoint,
  1471. 'security:passport-oidc:introspectionEndpoint':
  1472. req.body.oidcIntrospectionEndpoint,
  1473. 'security:passport-oidc:userInfoEndpoint':
  1474. req.body.oidcUserInfoEndpoint,
  1475. 'security:passport-oidc:endSessionEndpoint':
  1476. req.body.oidcEndSessionEndpoint,
  1477. 'security:passport-oidc:registrationEndpoint':
  1478. req.body.oidcRegistrationEndpoint,
  1479. 'security:passport-oidc:jwksUri': req.body.oidcJWKSUri,
  1480. 'security:passport-oidc:clientId': req.body.oidcClientId,
  1481. 'security:passport-oidc:clientSecret': req.body.oidcClientSecret,
  1482. 'security:passport-oidc:attrMapId': req.body.oidcAttrMapId,
  1483. 'security:passport-oidc:attrMapUserName': req.body.oidcAttrMapUserName,
  1484. 'security:passport-oidc:attrMapName': req.body.oidcAttrMapName,
  1485. 'security:passport-oidc:attrMapMail': req.body.oidcAttrMapEmail,
  1486. 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser':
  1487. req.body.isSameUsernameTreatedAsIdenticalUser,
  1488. 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser':
  1489. req.body.isSameEmailTreatedAsIdenticalUser,
  1490. };
  1491. try {
  1492. await updateAndReloadStrategySettings('oidc', requestParams);
  1493. const securitySettingParams = {
  1494. oidcProviderName: await configManager.getConfig(
  1495. 'security:passport-oidc:providerName',
  1496. ),
  1497. oidcIssuerHost: await configManager.getConfig(
  1498. 'security:passport-oidc:issuerHost',
  1499. ),
  1500. oidcAuthorizationEndpoint: await configManager.getConfig(
  1501. 'security:passport-oidc:authorizationEndpoint',
  1502. ),
  1503. oidcTokenEndpoint: await configManager.getConfig(
  1504. 'security:passport-oidc:tokenEndpoint',
  1505. ),
  1506. oidcRevocationEndpoint: await configManager.getConfig(
  1507. 'security:passport-oidc:revocationEndpoint',
  1508. ),
  1509. oidcIntrospectionEndpoint: await configManager.getConfig(
  1510. 'security:passport-oidc:introspectionEndpoint',
  1511. ),
  1512. oidcUserInfoEndpoint: await configManager.getConfig(
  1513. 'security:passport-oidc:userInfoEndpoint',
  1514. ),
  1515. oidcEndSessionEndpoint: await configManager.getConfig(
  1516. 'security:passport-oidc:endSessionEndpoint',
  1517. ),
  1518. oidcRegistrationEndpoint: await configManager.getConfig(
  1519. 'security:passport-oidc:registrationEndpoint',
  1520. ),
  1521. oidcJWKSUri: await configManager.getConfig(
  1522. 'security:passport-oidc:jwksUri',
  1523. ),
  1524. oidcClientId: await configManager.getConfig(
  1525. 'security:passport-oidc:clientId',
  1526. ),
  1527. oidcClientSecret: await configManager.getConfig(
  1528. 'security:passport-oidc:clientSecret',
  1529. ),
  1530. oidcAttrMapId: await configManager.getConfig(
  1531. 'security:passport-oidc:attrMapId',
  1532. ),
  1533. oidcAttrMapUserName: await configManager.getConfig(
  1534. 'security:passport-oidc:attrMapUserName',
  1535. ),
  1536. oidcAttrMapName: await configManager.getConfig(
  1537. 'security:passport-oidc:attrMapName',
  1538. ),
  1539. oidcAttrMapEmail: await configManager.getConfig(
  1540. 'security:passport-oidc:attrMapMail',
  1541. ),
  1542. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  1543. 'security:passport-oidc:isSameUsernameTreatedAsIdenticalUser',
  1544. ),
  1545. isSameEmailTreatedAsIdenticalUser: await configManager.getConfig(
  1546. 'security:passport-oidc:isSameEmailTreatedAsIdenticalUser',
  1547. ),
  1548. };
  1549. const parameters = {
  1550. action: SupportedAction.ACTION_ADMIN_AUTH_OIDC_UPDATE,
  1551. };
  1552. activityEvent.emit('update', res.locals.activity._id, parameters);
  1553. return res.apiv3({ securitySettingParams });
  1554. } catch (err) {
  1555. const msg = 'Error occurred in updating OpenIDConnect';
  1556. logger.error('Error', err);
  1557. return res.apiv3Err(new ErrorV3(msg, 'update-OpenIDConnect-failed'));
  1558. }
  1559. },
  1560. );
  1561. /**
  1562. * @swagger
  1563. *
  1564. * /security-setting/google-oauth:
  1565. * put:
  1566. * tags: [SecuritySetting]
  1567. * security:
  1568. * - cookieAuth: []
  1569. * summary: /security-setting/google-oauth
  1570. * description: Update google OAuth
  1571. * requestBody:
  1572. * required: true
  1573. * content:
  1574. * application/json:
  1575. * schema:
  1576. * $ref: '#/components/schemas/GoogleOAuthSetting'
  1577. * responses:
  1578. * 200:
  1579. * description: Succeeded to google OAuth
  1580. * content:
  1581. * application/json:
  1582. * schema:
  1583. * properties:
  1584. * securitySettingParams:
  1585. * $ref: '#/components/schemas/GoogleOAuthSetting'
  1586. */
  1587. router.put(
  1588. '/google-oauth',
  1589. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1590. loginRequiredStrictly,
  1591. adminRequired,
  1592. addActivity,
  1593. validator.googleOAuth,
  1594. apiV3FormValidator,
  1595. async (req, res) => {
  1596. try {
  1597. await updateAndReloadStrategySettings('google', {
  1598. 'security:passport-google:isSameEmailTreatedAsIdenticalUser':
  1599. req.body.isSameEmailTreatedAsIdenticalUser,
  1600. });
  1601. await updateAndReloadStrategySettings(
  1602. 'google',
  1603. {
  1604. 'security:passport-google:clientId': toNonBlankStringOrUndefined(
  1605. req.body.googleClientId,
  1606. ),
  1607. 'security:passport-google:clientSecret':
  1608. toNonBlankStringOrUndefined(req.body.googleClientSecret),
  1609. },
  1610. { removeIfUndefined: true },
  1611. );
  1612. const securitySettingParams = {
  1613. googleClientId: await configManager.getConfig(
  1614. 'security:passport-google:clientId',
  1615. ),
  1616. googleClientSecret: await configManager.getConfig(
  1617. 'security:passport-google:clientSecret',
  1618. ),
  1619. isSameEmailTreatedAsIdenticalUser: await configManager.getConfig(
  1620. 'security:passport-google:isSameEmailTreatedAsIdenticalUser',
  1621. ),
  1622. };
  1623. const parameters = {
  1624. action: SupportedAction.ACTION_ADMIN_AUTH_GOOGLE_UPDATE,
  1625. };
  1626. activityEvent.emit('update', res.locals.activity._id, parameters);
  1627. return res.apiv3({ securitySettingParams });
  1628. } catch (err) {
  1629. const msg = 'Error occurred in updating googleOAuth';
  1630. logger.error('Error', err);
  1631. return res.apiv3Err(new ErrorV3(msg, 'update-googleOAuth-failed'));
  1632. }
  1633. },
  1634. );
  1635. /**
  1636. * @swagger
  1637. *
  1638. * /security-setting/github-oauth:
  1639. * put:
  1640. * tags: [SecuritySetting]
  1641. * security:
  1642. * - cookieAuth: []
  1643. * summary: /security-setting/github-oauth
  1644. * description: Update github OAuth
  1645. * requestBody:
  1646. * required: true
  1647. * content:
  1648. * application/json:
  1649. * schema:
  1650. * $ref: '#/components/schemas/GitHubOAuthSetting'
  1651. * responses:
  1652. * 200:
  1653. * description: Succeeded to github OAuth
  1654. * content:
  1655. * application/json:
  1656. * schema:
  1657. * properties:
  1658. * securitySettingParams:
  1659. * $ref: '#/components/schemas/GitHubOAuthSetting'
  1660. */
  1661. router.put(
  1662. '/github-oauth',
  1663. accessTokenParser([SCOPE.WRITE.ADMIN.SECURITY]),
  1664. loginRequiredStrictly,
  1665. adminRequired,
  1666. addActivity,
  1667. validator.githubOAuth,
  1668. apiV3FormValidator,
  1669. async (req, res) => {
  1670. const requestParams = {
  1671. 'security:passport-github:clientId': req.body.githubClientId,
  1672. 'security:passport-github:clientSecret': req.body.githubClientSecret,
  1673. 'security:passport-github:isSameUsernameTreatedAsIdenticalUser':
  1674. req.body.isSameUsernameTreatedAsIdenticalUser,
  1675. };
  1676. try {
  1677. await updateAndReloadStrategySettings('github', requestParams);
  1678. const securitySettingParams = {
  1679. githubClientId: await configManager.getConfig(
  1680. 'security:passport-github:clientId',
  1681. ),
  1682. githubClientSecret: await configManager.getConfig(
  1683. 'security:passport-github:clientSecret',
  1684. ),
  1685. isSameUsernameTreatedAsIdenticalUser: await configManager.getConfig(
  1686. 'security:passport-github:isSameUsernameTreatedAsIdenticalUser',
  1687. ),
  1688. };
  1689. const parameters = {
  1690. action: SupportedAction.ACTION_ADMIN_AUTH_GITHUB_UPDATE,
  1691. };
  1692. activityEvent.emit('update', res.locals.activity._id, parameters);
  1693. return res.apiv3({ securitySettingParams });
  1694. } catch (err) {
  1695. // reset strategy
  1696. await crowi.passportService.resetGitHubStrategy();
  1697. const msg = 'Error occurred in updating githubOAuth';
  1698. logger.error('Error', err);
  1699. return res.apiv3Err(new ErrorV3(msg, 'update-githubOAuth-failed'));
  1700. }
  1701. },
  1702. );
  1703. return router;
  1704. };