authentication.mjs 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  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. const authResult = await WIKI.db.users.loginChangePassword(args, context)
  129. return {
  130. ...authResult,
  131. operation: generateSuccess('Password changed successfully')
  132. }
  133. } catch (err) {
  134. WIKI.logger.debug(err)
  135. return generateError(err)
  136. }
  137. },
  138. /**
  139. * Perform Forget Password
  140. */
  141. async forgotPassword (obj, args, context) {
  142. try {
  143. await WIKI.db.users.loginForgotPassword(args, context)
  144. return {
  145. operation: generateSuccess('Password reset request processed.')
  146. }
  147. } catch (err) {
  148. return generateError(err)
  149. }
  150. },
  151. /**
  152. * Register a new account
  153. */
  154. async register (obj, args, context) {
  155. try {
  156. const usr = await WIKI.db.users.createNewUser({ ...args, userInitiated: true })
  157. const authResult = await WIKI.db.users.afterLoginChecks(usr, WIKI.data.systemIds.localAuthId, context)
  158. return {
  159. ...authResult,
  160. operation: generateSuccess('Registration success')
  161. }
  162. } catch (err) {
  163. return generateError(err)
  164. }
  165. },
  166. /**
  167. * Refresh Token
  168. */
  169. async refreshToken (obj, args, context) {
  170. try {
  171. let decoded = {}
  172. if (!args.token) {
  173. throw new Error('ERR_MISSING_TOKEN')
  174. }
  175. try {
  176. decoded = jwt.verify(args.token, WIKI.config.auth.certs.public, {
  177. audience: WIKI.config.auth.audience,
  178. issuer: 'urn:wiki.js',
  179. algorithms: ['RS256'],
  180. ignoreExpiration: true
  181. })
  182. } catch (err) {
  183. throw new Error('ERR_INVALID_TOKEN')
  184. }
  185. if (DateTime.utc().minus(ms(WIKI.config.auth.tokenRenewal)) > DateTime.fromSeconds(decoded.exp)) {
  186. throw new Error('ERR_EXPIRED_TOKEN')
  187. }
  188. const newToken = await WIKI.db.users.refreshToken(decoded.id)
  189. return {
  190. jwt: newToken.token,
  191. operation: generateSuccess('Token refreshed successfully')
  192. }
  193. } catch (err) {
  194. return generateError(err)
  195. }
  196. },
  197. /**
  198. * Set API state
  199. */
  200. async setApiState (obj, args, context) {
  201. try {
  202. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  203. throw new Error('ERR_FORBIDDEN')
  204. }
  205. WIKI.config.api.isEnabled = args.enabled
  206. await WIKI.configSvc.saveToDb(['api'])
  207. return {
  208. operation: generateSuccess('API State changed successfully')
  209. }
  210. } catch (err) {
  211. return generateError(err)
  212. }
  213. },
  214. /**
  215. * Revoke an API key
  216. */
  217. async revokeApiKey (obj, args, context) {
  218. try {
  219. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  220. throw new Error('ERR_FORBIDDEN')
  221. }
  222. await WIKI.db.apiKeys.query().findById(args.id).patch({
  223. isRevoked: true
  224. })
  225. await WIKI.auth.reloadApiKeys()
  226. WIKI.events.outbound.emit('reloadApiKeys')
  227. return {
  228. operation: generateSuccess('API Key revoked successfully')
  229. }
  230. } catch (err) {
  231. return generateError(err)
  232. }
  233. },
  234. /**
  235. * Update Authentication Strategies
  236. */
  237. async updateAuthStrategies (obj, args, context) {
  238. try {
  239. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  240. throw new Error('ERR_FORBIDDEN')
  241. }
  242. const previousStrategies = await WIKI.db.authentication.getStrategies()
  243. for (const str of args.strategies) {
  244. const newStr = {
  245. displayName: str.displayName,
  246. isEnabled: str.isEnabled,
  247. config: _.reduce(str.config, (result, value, key) => {
  248. _.set(result, `${value.key}`, _.get(JSON.parse(value.value), 'v', null))
  249. return result
  250. }, {}),
  251. selfRegistration: str.selfRegistration,
  252. domainWhitelist: { v: str.domainWhitelist },
  253. autoEnrollGroups: { v: str.autoEnrollGroups }
  254. }
  255. if (_.some(previousStrategies, ['key', str.key])) {
  256. await WIKI.db.authentication.query().patch({
  257. key: str.key,
  258. strategyKey: str.strategyKey,
  259. ...newStr
  260. }).where('key', str.key)
  261. } else {
  262. await WIKI.db.authentication.query().insert({
  263. key: str.key,
  264. strategyKey: str.strategyKey,
  265. ...newStr
  266. })
  267. }
  268. }
  269. for (const str of _.differenceBy(previousStrategies, args.strategies, 'key')) {
  270. const hasUsers = await WIKI.db.users.query().count('* as total').where({ providerKey: str.key }).first()
  271. if (_.toSafeInteger(hasUsers.total) > 0) {
  272. throw new Error(`Cannot delete ${str.displayName} as 1 or more users are still using it.`)
  273. } else {
  274. await WIKI.db.authentication.query().delete().where('key', str.key)
  275. }
  276. }
  277. await WIKI.auth.activateStrategies()
  278. WIKI.events.outbound.emit('reloadAuthStrategies')
  279. return {
  280. responseResult: generateSuccess('Strategies updated successfully')
  281. }
  282. } catch (err) {
  283. return generateError(err)
  284. }
  285. },
  286. /**
  287. * Generate New Authentication Public / Private Key Certificates
  288. */
  289. async regenerateCertificates (obj, args, context) {
  290. try {
  291. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  292. throw new Error('ERR_FORBIDDEN')
  293. }
  294. await WIKI.auth.regenerateCertificates()
  295. return {
  296. responseResult: generateSuccess('Certificates have been regenerated successfully.')
  297. }
  298. } catch (err) {
  299. return generateError(err)
  300. }
  301. },
  302. /**
  303. * Reset Guest User
  304. */
  305. async resetGuestUser (obj, args, context) {
  306. try {
  307. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  308. throw new Error('ERR_FORBIDDEN')
  309. }
  310. await WIKI.auth.resetGuestUser()
  311. return {
  312. responseResult: generateSuccess('Guest user has been reset successfully.')
  313. }
  314. } catch (err) {
  315. return generateError(err)
  316. }
  317. }
  318. },
  319. // ------------------------------------------------------------------
  320. // TYPE: AuthenticationActiveStrategy
  321. // ------------------------------------------------------------------
  322. AuthenticationActiveStrategy: {
  323. config (obj, args, context) {
  324. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  325. throw new Error('ERR_FORBIDDEN')
  326. }
  327. return obj.config ?? {}
  328. },
  329. allowedEmailRegex (obj, args, context) {
  330. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  331. throw new Error('ERR_FORBIDDEN')
  332. }
  333. return obj.allowedEmailRegex ?? ''
  334. },
  335. autoEnrollGroups (obj, args, context) {
  336. if (!WIKI.auth.checkAccess(context.req.user, ['manage:system'])) {
  337. throw new Error('ERR_FORBIDDEN')
  338. }
  339. return obj.autoEnrollGroups ?? []
  340. },
  341. strategy (obj, args, context) {
  342. return _.find(WIKI.data.authentication, ['key', obj.module])
  343. }
  344. }
  345. }