authentication.mjs 10 KB

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