authentication.mjs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362
  1. import _ from 'lodash-es'
  2. import { generateError, generateSuccess } from '../../helpers/graph.mjs'
  3. import jwt from 'jsonwebtoken'
  4. import ms from 'ms'
  5. import { DateTime } from 'luxon'
  6. export default {
  7. Query: {
  8. /**
  9. * List of API Keys
  10. */
  11. async apiKeys (obj, args, context) {
  12. const keys = await WIKI.db.apiKeys.query().orderBy(['isRevoked', 'name'])
  13. return keys.map(k => ({
  14. id: k.id,
  15. name: k.name,
  16. keyShort: '...' + k.key.substring(k.key.length - 20),
  17. isRevoked: k.isRevoked,
  18. expiration: k.expiration,
  19. createdAt: k.createdAt,
  20. updatedAt: k.updatedAt
  21. }))
  22. },
  23. /**
  24. * Current API State
  25. */
  26. apiState () {
  27. return WIKI.config.api.isEnabled
  28. },
  29. /**
  30. * Fetch authentication strategies
  31. */
  32. async authStrategies () {
  33. return WIKI.data.authentication.map(stg => ({
  34. ...stg,
  35. isAvailable: stg.isAvailable === true
  36. }))
  37. },
  38. /**
  39. * Fetch active authentication strategies
  40. */
  41. async authActiveStrategies (obj, args, context) {
  42. const strategies = await WIKI.db.authentication.getStrategies({ enabledOnly: args.enabledOnly })
  43. return strategies.map(a => {
  44. const str = _.find(WIKI.data.authentication, ['key', a.module]) || {}
  45. return {
  46. ...a,
  47. config: _.transform(str.props, (r, v, k) => {
  48. r[k] = v.sensitive ? '********' : a.config[k]
  49. }, {})
  50. }
  51. })
  52. },
  53. /**
  54. * Fetch site authentication strategies
  55. */
  56. async authSiteStrategies (obj, args, context, info) {
  57. const site = await WIKI.db.sites.query().findById(args.siteId)
  58. const activeStrategies = await WIKI.db.authentication.getStrategies({ enabledOnly: true })
  59. const siteStrategies = _.sortBy(activeStrategies.map(str => {
  60. const siteAuth = _.find(site.config.authStrategies, ['id', str.id]) || {}
  61. return {
  62. id: str.id,
  63. activeStrategy: str,
  64. order: siteAuth.order ?? 0,
  65. isVisible: siteAuth.isVisible ?? false
  66. }
  67. }), ['order'])
  68. return args.visibleOnly ? siteStrategies.filter(s => s.isVisible) : siteStrategies
  69. }
  70. },
  71. Mutation: {
  72. /**
  73. * Create New API Key
  74. */
  75. async createApiKey (obj, args, context) {
  76. try {
  77. const key = await WIKI.db.apiKeys.createNewKey(args)
  78. await WIKI.auth.reloadApiKeys()
  79. WIKI.events.outbound.emit('reloadApiKeys')
  80. return {
  81. key,
  82. operation: generateSuccess('API Key created successfully')
  83. }
  84. } catch (err) {
  85. WIKI.logger.warn(err)
  86. return generateError(err)
  87. }
  88. },
  89. /**
  90. * Perform Login
  91. */
  92. async login (obj, args, context) {
  93. try {
  94. const authResult = await WIKI.db.users.login(args, context)
  95. return {
  96. ...authResult,
  97. operation: generateSuccess('Login success')
  98. }
  99. } catch (err) {
  100. // LDAP Debug Flag
  101. if (args.strategy === 'ldap' && WIKI.config.flags.ldapdebug) {
  102. WIKI.logger.warn('LDAP LOGIN ERROR (c1): ', err)
  103. }
  104. WIKI.logger.debug(err)
  105. return generateError(err)
  106. }
  107. },
  108. /**
  109. * Perform 2FA Login
  110. */
  111. async loginTFA (obj, args, context) {
  112. try {
  113. const authResult = await WIKI.db.users.loginTFA(args, context)
  114. return {
  115. ...authResult,
  116. operation: generateSuccess('TFA success')
  117. }
  118. } catch (err) {
  119. WIKI.logger.debug(err)
  120. return generateError(err)
  121. }
  122. },
  123. /**
  124. * Perform Password Change
  125. */
  126. async changePassword (obj, args, context) {
  127. try {
  128. if (args.continuationToken) {
  129. const authResult = await WIKI.db.users.loginChangePassword(args, context)
  130. return {
  131. ...authResult,
  132. operation: generateSuccess('Password set successfully')
  133. }
  134. } else {
  135. await WIKI.db.users.changePassword(args, context)
  136. return {
  137. operation: generateSuccess('Password changed successfully')
  138. }
  139. }
  140. } catch (err) {
  141. WIKI.logger.debug(err)
  142. return generateError(err)
  143. }
  144. },
  145. /**
  146. * Perform Forget Password
  147. */
  148. async forgotPassword (obj, args, context) {
  149. try {
  150. await WIKI.db.users.loginForgotPassword(args, context)
  151. return {
  152. operation: generateSuccess('Password reset request processed.')
  153. }
  154. } catch (err) {
  155. return generateError(err)
  156. }
  157. },
  158. /**
  159. * Register a new account
  160. */
  161. async register (obj, args, context) {
  162. try {
  163. const usr = await WIKI.db.users.createNewUser({ ...args, userInitiated: true })
  164. const authResult = await WIKI.db.users.afterLoginChecks(usr, WIKI.data.systemIds.localAuthId, context)
  165. return {
  166. ...authResult,
  167. operation: generateSuccess('Registration success')
  168. }
  169. } catch (err) {
  170. return generateError(err)
  171. }
  172. },
  173. /**
  174. * Refresh Token
  175. */
  176. async refreshToken (obj, args, context) {
  177. try {
  178. let decoded = {}
  179. if (!args.token) {
  180. throw new Error('ERR_MISSING_TOKEN')
  181. }
  182. try {
  183. decoded = jwt.verify(args.token, WIKI.config.auth.certs.public, {
  184. audience: WIKI.config.auth.audience,
  185. issuer: 'urn:wiki.js',
  186. algorithms: ['RS256'],
  187. ignoreExpiration: true
  188. })
  189. } catch (err) {
  190. throw new Error('ERR_INVALID_TOKEN')
  191. }
  192. if (DateTime.utc().minus(ms(WIKI.config.auth.tokenRenewal)) > DateTime.fromSeconds(decoded.exp)) {
  193. throw new Error('ERR_EXPIRED_TOKEN')
  194. }
  195. const newToken = await WIKI.db.users.refreshToken(decoded.id)
  196. return {
  197. jwt: newToken.token,
  198. operation: generateSuccess('Token refreshed successfully')
  199. }
  200. } catch (err) {
  201. return generateError(err)
  202. }
  203. },
  204. /**
  205. * Set API state
  206. */
  207. async setApiState (obj, args, context) {
  208. try {
  209. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  210. throw new Error('ERR_FORBIDDEN')
  211. }
  212. WIKI.config.api.isEnabled = args.enabled
  213. await WIKI.configSvc.saveToDb(['api'])
  214. return {
  215. operation: generateSuccess('API State changed successfully')
  216. }
  217. } catch (err) {
  218. return generateError(err)
  219. }
  220. },
  221. /**
  222. * Revoke an API key
  223. */
  224. async revokeApiKey (obj, args, context) {
  225. try {
  226. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  227. throw new Error('ERR_FORBIDDEN')
  228. }
  229. await WIKI.db.apiKeys.query().findById(args.id).patch({
  230. isRevoked: true
  231. })
  232. await WIKI.auth.reloadApiKeys()
  233. WIKI.events.outbound.emit('reloadApiKeys')
  234. return {
  235. operation: generateSuccess('API Key revoked successfully')
  236. }
  237. } catch (err) {
  238. return generateError(err)
  239. }
  240. },
  241. /**
  242. * Update Authentication Strategies
  243. */
  244. async updateAuthStrategies (obj, args, context) {
  245. try {
  246. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  247. throw new Error('ERR_FORBIDDEN')
  248. }
  249. const previousStrategies = await WIKI.db.authentication.getStrategies()
  250. for (const str of args.strategies) {
  251. const newStr = {
  252. displayName: str.displayName,
  253. isEnabled: str.isEnabled,
  254. config: _.reduce(str.config, (result, value, key) => {
  255. _.set(result, `${value.key}`, _.get(JSON.parse(value.value), 'v', null))
  256. return result
  257. }, {}),
  258. selfRegistration: str.selfRegistration,
  259. domainWhitelist: { v: str.domainWhitelist },
  260. autoEnrollGroups: { v: str.autoEnrollGroups }
  261. }
  262. if (_.some(previousStrategies, ['key', str.key])) {
  263. await WIKI.db.authentication.query().patch({
  264. key: str.key,
  265. strategyKey: str.strategyKey,
  266. ...newStr
  267. }).where('key', str.key)
  268. } else {
  269. await WIKI.db.authentication.query().insert({
  270. key: str.key,
  271. strategyKey: str.strategyKey,
  272. ...newStr
  273. })
  274. }
  275. }
  276. for (const str of _.differenceBy(previousStrategies, args.strategies, 'key')) {
  277. const hasUsers = await WIKI.db.users.query().count('* as total').where({ providerKey: str.key }).first()
  278. if (_.toSafeInteger(hasUsers.total) > 0) {
  279. throw new Error(`Cannot delete ${str.displayName} as 1 or more users are still using it.`)
  280. } else {
  281. await WIKI.db.authentication.query().delete().where('key', str.key)
  282. }
  283. }
  284. await WIKI.auth.activateStrategies()
  285. WIKI.events.outbound.emit('reloadAuthStrategies')
  286. return {
  287. responseResult: generateSuccess('Strategies updated successfully')
  288. }
  289. } catch (err) {
  290. return generateError(err)
  291. }
  292. },
  293. /**
  294. * Generate New Authentication Public / Private Key Certificates
  295. */
  296. async regenerateCertificates (obj, args, context) {
  297. try {
  298. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  299. throw new Error('ERR_FORBIDDEN')
  300. }
  301. await WIKI.auth.regenerateCertificates()
  302. return {
  303. responseResult: generateSuccess('Certificates have been regenerated successfully.')
  304. }
  305. } catch (err) {
  306. return generateError(err)
  307. }
  308. },
  309. /**
  310. * Reset Guest User
  311. */
  312. async resetGuestUser (obj, args, context) {
  313. try {
  314. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  315. throw new Error('ERR_FORBIDDEN')
  316. }
  317. await WIKI.auth.resetGuestUser()
  318. return {
  319. responseResult: generateSuccess('Guest user has been reset successfully.')
  320. }
  321. } catch (err) {
  322. return generateError(err)
  323. }
  324. }
  325. },
  326. // ------------------------------------------------------------------
  327. // TYPE: AuthenticationActiveStrategy
  328. // ------------------------------------------------------------------
  329. AuthenticationActiveStrategy: {
  330. config (obj, args, context) {
  331. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  332. throw new Error('ERR_FORBIDDEN')
  333. }
  334. return obj.config ?? {}
  335. },
  336. allowedEmailRegex (obj, args, context) {
  337. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  338. throw new Error('ERR_FORBIDDEN')
  339. }
  340. return obj.allowedEmailRegex ?? ''
  341. },
  342. autoEnrollGroups (obj, args, context) {
  343. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  344. throw new Error('ERR_FORBIDDEN')
  345. }
  346. return obj.autoEnrollGroups ?? []
  347. },
  348. strategy (obj, args, context) {
  349. return _.find(WIKI.data.authentication, ['key', obj.module])
  350. }
  351. }
  352. }