users.js 27.3 KB
Newer Older
1 2 3 4 5
/* global WIKI */

const bcrypt = require('bcryptjs-then')
const _ = require('lodash')
const tfa = require('node-2fa')
6
const jwt = require('jsonwebtoken')
7
const Model = require('objection').Model
8
const validate = require('validate.js')
9
const qr = require('qr-image')
10 11 12 13 14 15 16 17 18 19 20 21

const bcryptRegexp = /^\$2[ayb]\$[0-9]{2}\$[A-Za-z0-9./]{53}$/

/**
 * Users model
 */
module.exports = class User extends Model {
  static get tableName() { return 'users' }

  static get jsonSchema () {
    return {
      type: 'object',
22
      required: ['email'],
23 24 25 26 27

      properties: {
        id: {type: 'integer'},
        email: {type: 'string', format: 'email'},
        name: {type: 'string', minLength: 1, maxLength: 255},
28
        providerId: {type: 'string'},
29 30
        password: {type: 'string'},
        tfaIsActive: {type: 'boolean', default: false},
31
        tfaSecret: {type: ['string', null]},
32 33 34
        jobTitle: {type: 'string'},
        location: {type: 'string'},
        pictureUrl: {type: 'string'},
35
        isSystem: {type: 'boolean'},
36 37
        isActive: {type: 'boolean'},
        isVerified: {type: 'boolean'},
38 39 40 41 42 43 44 45 46 47
        createdAt: {type: 'string'},
        updatedAt: {type: 'string'}
      }
    }
  }

  static get relationMappings() {
    return {
      groups: {
        relation: Model.ManyToManyRelation,
48
        modelClass: require('./groups'),
49 50 51 52 53 54 55 56
        join: {
          from: 'users.id',
          through: {
            from: 'userGroups.userId',
            to: 'userGroups.groupId'
          },
          to: 'groups.id'
        }
NGPixel's avatar
NGPixel committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
      },
      provider: {
        relation: Model.BelongsToOneRelation,
        modelClass: require('./authentication'),
        join: {
          from: 'users.providerKey',
          to: 'authentication.key'
        }
      },
      defaultEditor: {
        relation: Model.BelongsToOneRelation,
        modelClass: require('./editors'),
        join: {
          from: 'users.editorKey',
          to: 'editors.key'
        }
      },
      locale: {
        relation: Model.BelongsToOneRelation,
        modelClass: require('./locales'),
        join: {
          from: 'users.localeCode',
          to: 'locales.code'
        }
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
      }
    }
  }

  async $beforeUpdate(opt, context) {
    await super.$beforeUpdate(opt, context)

    this.updatedAt = new Date().toISOString()

    if (!(opt.patch && this.password === undefined)) {
      await this.generateHash()
    }
  }
  async $beforeInsert(context) {
    await super.$beforeInsert(context)

    this.createdAt = new Date().toISOString()
    this.updatedAt = new Date().toISOString()

    await this.generateHash()
  }

103 104 105 106
  // ------------------------------------------------
  // Instance Methods
  // ------------------------------------------------

107 108 109 110 111 112 113 114
  async generateHash() {
    if (this.password) {
      if (bcryptRegexp.test(this.password)) { return }
      this.password = await bcrypt.hash(this.password, 12)
    }
  }

  async verifyPassword(pwd) {
115
    if (await bcrypt.compare(pwd, this.password) === true) {
116 117 118 119 120 121
      return true
    } else {
      throw new WIKI.Error.AuthLoginFailed()
    }
  }

122
  async generateTFA() {
123
    let tfaInfo = tfa.generateSecret({
124 125
      name: WIKI.config.title,
      account: this.email
126
    })
127 128
    await WIKI.models.users.query().findById(this.id).patch({
      tfaIsActive: false,
129 130
      tfaSecret: tfaInfo.secret
    })
131 132
    const safeTitle = WIKI.config.title.replace(/[\s-.,=!@#$%?&*()+[\]{}/\\;<>]/g, '')
    return qr.imageSync(`otpauth://totp/${safeTitle}:${this.email}?secret=${tfaInfo.secret}`, { type: 'svg' })
133 134 135 136 137 138
  }

  async enableTFA() {
    return WIKI.models.users.query().findById(this.id).patch({
      tfaIsActive: true
    })
139 140 141 142 143 144 145 146 147
  }

  async disableTFA() {
    return this.$query.patch({
      tfaIsActive: false,
      tfaSecret: ''
    })
  }

148
  verifyTFA(code) {
149 150 151 152
    let result = tfa.verifyToken(this.tfaSecret, code)
    return (result && _.has(result, 'delta') && result.delta === 0)
  }

153 154 155 156 157 158
  getGlobalPermissions() {
    return _.uniq(_.flatten(_.map(this.groups, 'permissions')))
  }

  getGroups() {
    return _.uniq(_.map(this.groups, 'id'))
159 160
  }

161 162 163 164
  // ------------------------------------------------
  // Model Methods
  // ------------------------------------------------

165 166
  static async processProfile({ profile, providerKey }) {
    const provider = _.get(WIKI.auth.strategies, providerKey, {})
167
    provider.info = _.find(WIKI.data.authentication, ['key', provider.stategyKey])
168 169 170

    // Find existing user
    let user = await WIKI.models.users.query().findOne({
Nick's avatar
Nick committed
171
      providerId: _.toString(profile.id),
172 173 174 175
      providerKey
    })

    // Parse email
176 177
    let primaryEmail = ''
    if (_.isArray(profile.emails)) {
Nick's avatar
Nick committed
178
      const e = _.find(profile.emails, ['primary', true])
179
      primaryEmail = (e) ? e.value : _.first(profile.emails).value
180
    } else if (_.isArray(profile.email)) {
181
      primaryEmail = _.first(_.flattenDeep([profile.email]))
182 183 184 185 186 187 188
    } else if (_.isString(profile.email) && profile.email.length > 5) {
      primaryEmail = profile.email
    } else if (_.isString(profile.mail) && profile.mail.length > 5) {
      primaryEmail = profile.mail
    } else if (profile.user && profile.user.email && profile.user.email.length > 5) {
      primaryEmail = profile.user.email
    } else {
189
      throw new Error('Missing or invalid email address from profile.')
190 191 192
    }
    primaryEmail = _.toLower(primaryEmail)

193 194 195 196 197 198 199 200 201 202 203 204 205 206
    // Find pending social user
    if (!user) {
      user = await WIKI.models.users.query().findOne({
        email: primaryEmail,
        providerId: null,
        providerKey
      })
      if (user) {
        user = await user.$query().patchAndFetch({
          providerId: _.toString(profile.id)
        })
      }
    }

207 208 209 210 211 212 213 214 215 216
    // Parse display name
    let displayName = ''
    if (_.isString(profile.displayName) && profile.displayName.length > 0) {
      displayName = profile.displayName
    } else if (_.isString(profile.name) && profile.name.length > 0) {
      displayName = profile.name
    } else {
      displayName = primaryEmail.split('@')[0]
    }

NGPixel's avatar
NGPixel committed
217 218 219 220 221 222 223 224 225 226
    // Parse picture URL / Data
    let pictureUrl = ''
    if (profile.picture && Buffer.isBuffer(profile.picture)) {
      pictureUrl = 'internal'
    } else {
      pictureUrl = _.truncate(_.get(profile, 'picture', _.get(user, 'pictureUrl', null)), {
        length: 255,
        omission: ''
      })
    }
227 228

    // Update existing user
229
    if (user) {
230 231 232 233 234 235 236 237
      if (!user.isActive) {
        throw new WIKI.Error.AuthAccountBanned()
      }
      if (user.isSystem) {
        throw new Error('This is a system reserved account and cannot be used.')
      }

      user = await user.$query().patchAndFetch({
238
        email: primaryEmail,
239 240 241 242
        name: displayName,
        pictureUrl: pictureUrl
      })

NGPixel's avatar
NGPixel committed
243 244 245 246
      if (pictureUrl === 'internal') {
        await WIKI.models.users.updateUserAvatarData(user.id, profile.picture)
      }

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
      return user
    }

    // Self-registration
    if (provider.selfRegistration) {
      // Check if email domain is whitelisted
      if (_.get(provider, 'domainWhitelist', []).length > 0) {
        const emailDomain = _.last(primaryEmail.split('@'))
        if (!_.includes(provider.domainWhitelist, emailDomain)) {
          throw new WIKI.Error.AuthRegistrationDomainUnauthorized()
        }
      }

      // Create account
      user = await WIKI.models.users.query().insertAndFetch({
        providerKey: providerKey,
Nick's avatar
Nick committed
263
        providerId: _.toString(profile.id),
264 265 266 267 268 269 270 271 272
        email: primaryEmail,
        name: displayName,
        pictureUrl: pictureUrl,
        localeCode: WIKI.config.lang.code,
        defaultEditor: 'markdown',
        tfaIsActive: false,
        isSystem: false,
        isActive: true,
        isVerified: true
273
      })
274 275 276 277 278 279

      // Assign to group(s)
      if (provider.autoEnrollGroups.length > 0) {
        await user.$relatedQuery('groups').relate(provider.autoEnrollGroups)
      }

NGPixel's avatar
NGPixel committed
280 281 282 283
      if (pictureUrl === 'internal') {
        await WIKI.models.users.updateUserAvatarData(user.id, profile.picture)
      }

284
      return user
285 286
    }

287
    throw new Error('You are not authorized to login.')
288 289
  }

290 291 292
  /**
   * Login a user
   */
293
  static async login (opts, context) {
NGPixel's avatar
NGPixel committed
294
    if (_.has(WIKI.auth.strategies, opts.strategy)) {
295
      const selStrategy = _.get(WIKI.auth.strategies, opts.strategy)
296 297 298 299
      if (!selStrategy.isEnabled) {
        throw new WIKI.Error.AuthProviderInvalid()
      }

300
      const strInfo = _.find(WIKI.data.authentication, ['key', selStrategy.strategyKey])
Nick's avatar
Nick committed
301 302 303 304 305

      // Inject form user/pass
      if (strInfo.useForm) {
        _.set(context.req, 'body.email', opts.username)
        _.set(context.req, 'body.password', opts.password)
NGPixel's avatar
NGPixel committed
306
        _.set(context.req.params, 'strategy', opts.strategy)
Nick's avatar
Nick committed
307
      }
308 309 310

      // Authenticate
      return new Promise((resolve, reject) => {
311
        WIKI.auth.passport.authenticate(selStrategy.key, {
Nick's avatar
Nick committed
312
          session: !strInfo.useForm,
313
          scope: strInfo.scopes ? strInfo.scopes : null
Nick's avatar
Nick committed
314
        }, async (err, user, info) => {
315 316 317
          if (err) { return reject(err) }
          if (!user) { return reject(new WIKI.Error.AuthLoginFailed()) }

318
          try {
319 320 321 322
            const resp = await WIKI.models.users.afterLoginChecks(user, context, {
              skipTFA: !strInfo.useForm,
              skipChangePwd: !strInfo.useForm
            })
323 324 325
            resolve(resp)
          } catch (err) {
            reject(err)
326
          }
327 328 329 330 331 332 333
        })(context.req, context.res, () => {})
      })
    } else {
      throw new WIKI.Error.AuthProviderInvalid()
    }
  }

334 335 336
  /**
   * Perform post-login checks
   */
337 338 339 340 341
  static async afterLoginChecks (user, context, { skipTFA, skipChangePwd } = { skipTFA: false, skipChangePwd: false }) {
    // Get redirect target
    user.groups = await user.$relatedQuery('groups').select('groups.id', 'permissions', 'redirectOnLogin')
    let redirect = '/'
    if (user.groups && user.groups.length > 0) {
342 343 344 345 346 347
      for (const grp of user.groups) {
        if (!_.isEmpty(grp.redirectOnLogin) && grp.redirectOnLogin !== '/') {
          redirect = grp.redirectOnLogin
          break
        }
      }
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
    }

    // Is 2FA required?
    if (!skipTFA) {
      if (user.tfaIsActive && user.tfaSecret) {
        try {
          const tfaToken = await WIKI.models.userKeys.generateToken({
            kind: 'tfa',
            userId: user.id
          })
          return {
            mustProvideTFA: true,
            continuationToken: tfaToken,
            redirect
          }
        } catch (errc) {
          WIKI.logger.warn(errc)
          throw new WIKI.Error.AuthGenericError()
        }
      } else if (WIKI.config.auth.enforce2FA || (user.tfaIsActive && !user.tfaSecret)) {
        try {
          const tfaQRImage = await user.generateTFA()
          const tfaToken = await WIKI.models.userKeys.generateToken({
            kind: 'tfaSetup',
            userId: user.id
          })
          return {
            mustSetupTFA: true,
            continuationToken: tfaToken,
            tfaQRImage,
            redirect
          }
        } catch (errc) {
          WIKI.logger.warn(errc)
          throw new WIKI.Error.AuthGenericError()
        }
      }
    }

    // Must Change Password?
    if (!skipChangePwd && user.mustChangePwd) {
      try {
        const pwdChangeToken = await WIKI.models.userKeys.generateToken({
          kind: 'changePwd',
          userId: user.id
        })

        return {
          mustChangePwd: true,
          continuationToken: pwdChangeToken,
          redirect
        }
      } catch (errc) {
        WIKI.logger.warn(errc)
        throw new WIKI.Error.AuthGenericError()
      }
    }

    return new Promise((resolve, reject) => {
      context.req.login(user, { session: false }, async errc => {
        if (errc) { return reject(errc) }
        const jwtToken = await WIKI.models.users.refreshToken(user)
        resolve({ jwt: jwtToken.token, redirect })
      })
    })
  }

415 416 417
  /**
   * Generate a new token for a user
   */
418 419
  static async refreshToken(user) {
    if (_.isSafeInteger(user)) {
NGPixel's avatar
NGPixel committed
420
      user = await WIKI.models.users.query().findById(user).withGraphFetched('groups').modifyGraph('groups', builder => {
421 422
        builder.select('groups.id', 'permissions')
      })
423 424 425 426
      if (!user) {
        WIKI.logger.warn(`Failed to refresh token for user ${user}: Not found.`)
        throw new WIKI.Error.AuthGenericError()
      }
427 428 429 430
      if (!user.isActive) {
        WIKI.logger.warn(`Failed to refresh token for user ${user}: Inactive.`)
        throw new WIKI.Error.AuthAccountBanned()
      }
431
    } else if (_.isNil(user.groups)) {
NGPixel's avatar
NGPixel committed
432
      user.groups = await user.$relatedQuery('groups').select('groups.id', 'permissions')
433
    }
434

435
    // Update Last Login Date
436 437
    // -> Bypass Objection.js to avoid updating the updatedAt field
    await WIKI.models.knex('users').where('id', user.id).update({ lastLoginAt: new Date().toISOString() })
438

439 440 441 442 443
    return {
      token: jwt.sign({
        id: user.id,
        email: user.email,
        name: user.name,
444 445 446 447 448 449
        av: user.pictureUrl,
        tz: user.timezone,
        lc: user.localeCode,
        df: user.dateFormat,
        ap: user.appearance,
        // defaultEditor: user.defaultEditor,
450 451
        permissions: user.getGlobalPermissions(),
        groups: user.getGroups()
452 453 454 455 456
      }, {
        key: WIKI.config.certs.private,
        passphrase: WIKI.config.sessionSecret
      }, {
        algorithm: 'RS256',
457 458
        expiresIn: WIKI.config.auth.tokenExpiration,
        audience: WIKI.config.auth.audience,
459 460 461 462 463 464
        issuer: 'urn:wiki.js'
      }),
      user
    }
  }

465 466 467
  /**
   * Verify a TFA login
   */
468 469 470 471 472 473 474 475 476 477 478
  static async loginTFA ({ securityCode, continuationToken, setup }, context) {
    if (securityCode.length === 6 && continuationToken.length > 1) {
      const user = await WIKI.models.userKeys.validateToken({
        kind: setup ? 'tfaSetup' : 'tfa',
        token: continuationToken,
        skipDelete: setup
      })
      if (user) {
        if (user.verifyTFA(securityCode)) {
          if (setup) {
            await user.enableTFA()
479
          }
480 481 482
          return WIKI.models.users.afterLoginChecks(user, context, { skipTFA: true })
        } else {
          throw new WIKI.Error.AuthTFAFailed()
483 484 485 486 487
        }
      }
    }
    throw new WIKI.Error.AuthTFAInvalid()
  }
488

489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
  /**
   * Change Password from a Mandatory Password Change after Login
   */
  static async loginChangePassword ({ continuationToken, newPassword }, context) {
    if (!newPassword || newPassword.length < 6) {
      throw new WIKI.Error.InputInvalid('Password must be at least 6 characters!')
    }
    const usr = await WIKI.models.userKeys.validateToken({
      kind: 'changePwd',
      token: continuationToken
    })

    if (usr) {
      await WIKI.models.users.query().patch({
        password: newPassword,
        mustChangePwd: false
      }).findById(usr.id)

      return new Promise((resolve, reject) => {
        context.req.logIn(usr, { session: false }, async err => {
          if (err) { return reject(err) }
          const jwtToken = await WIKI.models.users.refreshToken(usr)
          resolve({ jwt: jwtToken.token })
        })
      })
    } else {
      throw new WIKI.Error.UserNotFound()
    }
  }

NGPixel's avatar
NGPixel committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
  /**
   * Send a password reset request
   */
  static async loginForgotPassword ({ email }, context) {
    const usr = await WIKI.models.users.query().where({
      email,
      providerKey: 'local'
    }).first()
    if (!usr) {
      WIKI.logger.debug(`Password reset attempt on nonexistant local account ${email}: [DISCARDED]`)
      return
    }
    const resetToken = await WIKI.models.userKeys.generateToken({
      userId: usr.id,
      kind: 'resetPwd'
    })

    await WIKI.mail.send({
      template: 'accountResetPwd',
      to: email,
      subject: `Password Reset Request`,
      data: {
        preheadertext: `A password reset was requested for ${WIKI.config.title}`,
        title: `A password reset was requested for ${WIKI.config.title}`,
        content: `Click the button below to reset your password. If you didn't request this password reset, simply discard this email.`,
        buttonLink: `${WIKI.config.host}/login-reset/${resetToken}`,
        buttonText: 'Reset Password'
      },
      text: `A password reset was requested for wiki ${WIKI.config.title}. Open the following link to proceed: ${WIKI.config.host}/login-reset/${resetToken}`
    })
  }

Nick's avatar
Nick committed
551 552 553 554 555
  /**
   * Create a new user
   *
   * @param {Object} param0 User Fields
   */
556 557 558 559 560
  static async createNewUser ({ providerKey, email, passwordRaw, name, groups, mustChangePassword, sendWelcomeEmail }) {
    // Input sanitization
    email = _.toLower(email)

    // Input validation
561 562 563 564 565 566 567 568 569 570 571 572
    let validation = null
    if (providerKey === 'local') {
      validation = validate({
        email,
        passwordRaw,
        name
      }, {
        email: {
          email: true,
          length: {
            maximum: 255
          }
573
        },
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
        passwordRaw: {
          presence: {
            allowEmpty: false
          },
          length: {
            minimum: 6
          }
        },
        name: {
          presence: {
            allowEmpty: false
          },
          length: {
            minimum: 2,
            maximum: 255
          }
590
        }
591 592 593 594 595 596 597 598 599 600 601
      }, { format: 'flat' })
    } else {
      validation = validate({
        email,
        name
      }, {
        email: {
          email: true,
          length: {
            maximum: 255
          }
602
        },
603 604 605 606 607 608 609 610
        name: {
          presence: {
            allowEmpty: false
          },
          length: {
            minimum: 2,
            maximum: 255
          }
611
        }
612 613 614
      }, { format: 'flat' })
    }

615 616 617 618 619 620 621 622
    if (validation && validation.length > 0) {
      throw new WIKI.Error.InputInvalid(validation[0])
    }

    // Check if email already exists
    const usr = await WIKI.models.users.query().findOne({ email, providerKey })
    if (!usr) {
      // Create the account
623 624
      let newUsrData = {
        providerKey,
625 626 627 628 629 630 631 632
        email,
        name,
        locale: 'en',
        defaultEditor: 'markdown',
        tfaIsActive: false,
        isSystem: false,
        isActive: true,
        isVerified: true,
633 634 635 636 637 638 639 640 641
        mustChangePwd: false
      }

      if (providerKey === `local`) {
        newUsrData.password = passwordRaw
        newUsrData.mustChangePwd = (mustChangePassword === true)
      }

      const newUsr = await WIKI.models.users.query().insert(newUsrData)
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668

      // Assign to group(s)
      if (groups.length > 0) {
        await newUsr.$relatedQuery('groups').relate(groups)
      }

      if (sendWelcomeEmail) {
        // Send welcome email
        await WIKI.mail.send({
          template: 'accountWelcome',
          to: email,
          subject: `Welcome to the wiki ${WIKI.config.title}`,
          data: {
            preheadertext: `You've been invited to the wiki ${WIKI.config.title}`,
            title: `You've been invited to the wiki ${WIKI.config.title}`,
            content: `Click the button below to access the wiki.`,
            buttonLink: `${WIKI.config.host}/login`,
            buttonText: 'Login'
          },
          text: `You've been invited to the wiki ${WIKI.config.title}: ${WIKI.config.host}/login`
        })
      }
    } else {
      throw new WIKI.Error.AuthAccountAlreadyExists()
    }
  }

Nick's avatar
Nick committed
669 670 671 672 673
  /**
   * Update an existing user
   *
   * @param {Object} param0 User ID and fields to update
   */
674
  static async updateUser ({ id, email, name, newPassword, groups, location, jobTitle, timezone, dateFormat, appearance }) {
Nick's avatar
Nick committed
675 676 677 678 679 680 681
    const usr = await WIKI.models.users.query().findById(id)
    if (usr) {
      let usrData = {}
      if (!_.isEmpty(email) && email !== usr.email) {
        const dupUsr = await WIKI.models.users.query().select('id').where({
          email,
          providerKey: usr.providerKey
682
        }).first()
Nick's avatar
Nick committed
683 684 685
        if (dupUsr) {
          throw new WIKI.Error.AuthAccountAlreadyExists()
        }
686
        usrData.email = _.toLower(email)
Nick's avatar
Nick committed
687 688 689 690 691 692 693 694 695 696
      }
      if (!_.isEmpty(name) && name !== usr.name) {
        usrData.name = _.trim(name)
      }
      if (!_.isEmpty(newPassword)) {
        if (newPassword.length < 6) {
          throw new WIKI.Error.InputInvalid('Password must be at least 6 characters!')
        }
        usrData.password = newPassword
      }
697
      if (_.isArray(groups)) {
Nick's avatar
Nick committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
        const usrGroupsRaw = await usr.$relatedQuery('groups')
        const usrGroups = _.map(usrGroupsRaw, 'id')
        // Relate added groups
        const addUsrGroups = _.difference(groups, usrGroups)
        for (const grp of addUsrGroups) {
          await usr.$relatedQuery('groups').relate(grp)
        }
        // Unrelate removed groups
        const remUsrGroups = _.difference(usrGroups, groups)
        for (const grp of remUsrGroups) {
          await usr.$relatedQuery('groups').unrelate().where('groupId', grp)
        }
      }
      if (!_.isEmpty(location) && location !== usr.location) {
        usrData.location = _.trim(location)
      }
      if (!_.isEmpty(jobTitle) && jobTitle !== usr.jobTitle) {
        usrData.jobTitle = _.trim(jobTitle)
      }
      if (!_.isEmpty(timezone) && timezone !== usr.timezone) {
        usrData.timezone = timezone
      }
720 721 722 723 724 725
      if (!_.isNil(dateFormat) && dateFormat !== usr.dateFormat) {
        usrData.dateFormat = dateFormat
      }
      if (!_.isNil(appearance) && appearance !== usr.appearance) {
        usrData.appearance = appearance
      }
Nick's avatar
Nick committed
726 727
      await WIKI.models.users.query().patch(usrData).findById(id)
    } else {
728 729 730 731 732 733 734 735 736
      throw new WIKI.Error.UserNotFound()
    }
  }

  /**
   * Delete a User
   *
   * @param {*} id User ID
   */
737
  static async deleteUser (id, replaceId) {
738 739
    const usr = await WIKI.models.users.query().findById(id)
    if (usr) {
740 741 742 743 744 745
      await WIKI.models.assets.query().patch({ authorId: replaceId }).where('authorId', id)
      await WIKI.models.comments.query().patch({ authorId: replaceId }).where('authorId', id)
      await WIKI.models.pageHistory.query().patch({ authorId: replaceId }).where('authorId', id)
      await WIKI.models.pages.query().patch({ authorId: replaceId }).where('authorId', id)
      await WIKI.models.pages.query().patch({ creatorId: replaceId }).where('creatorId', id)

746 747 748
      await WIKI.models.userKeys.query().delete().where('userId', id)
      await WIKI.models.users.query().deleteById(id)
    } else {
Nick's avatar
Nick committed
749 750 751 752 753 754 755 756 757 758
      throw new WIKI.Error.UserNotFound()
    }
  }

  /**
   * Register a new user (client-side registration)
   *
   * @param {Object} param0 User fields
   * @param {Object} context GraphQL Context
   */
759
  static async register ({ email, password, name, verify = false, bypassChecks = false }, context) {
760 761
    const localStrg = await WIKI.models.authentication.getStrategy('local')
    // Check if self-registration is enabled
762 763 764 765
    if (localStrg.selfRegistration || bypassChecks) {
      // Input sanitization
      email = _.toLower(email)

766 767
      // Input validation
      const validation = validate({
768 769
        email,
        password,
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
        name
      }, {
        email: {
          email: true,
          length: {
            maximum: 255
          }
        },
        password: {
          presence: {
            allowEmpty: false
          },
          length: {
            minimum: 6
          }
        },
        name: {
          presence: {
            allowEmpty: false
          },
          length: {
            minimum: 2,
            maximum: 255
          }
794
        }
795 796 797 798 799 800
      }, { format: 'flat' })
      if (validation && validation.length > 0) {
        throw new WIKI.Error.InputInvalid(validation[0])
      }

      // Check if email domain is whitelisted
801
      if (_.get(localStrg, 'domainWhitelist.v', []).length > 0 && !bypassChecks) {
802 803 804 805 806 807 808 809 810
        const emailDomain = _.last(email.split('@'))
        if (!_.includes(localStrg.domainWhitelist.v, emailDomain)) {
          throw new WIKI.Error.AuthRegistrationDomainUnauthorized()
        }
      }
      // Check if email already exists
      const usr = await WIKI.models.users.query().findOne({ email, providerKey: 'local' })
      if (!usr) {
        // Create the account
811
        const newUsr = await WIKI.models.users.query().insert({
812 813 814 815 816 817 818
          provider: 'local',
          email,
          name,
          password,
          locale: 'en',
          defaultEditor: 'markdown',
          tfaIsActive: false,
819 820 821 822 823
          isSystem: false,
          isActive: true,
          isVerified: false
        })

824 825 826 827 828
        // Assign to group(s)
        if (_.get(localStrg, 'autoEnrollGroups.v', []).length > 0) {
          await newUsr.$relatedQuery('groups').relate(localStrg.autoEnrollGroups.v)
        }

829 830 831 832 833 834
        if (verify) {
          // Create verification token
          const verificationToken = await WIKI.models.userKeys.generateToken({
            kind: 'verify',
            userId: newUsr.id
          })
835

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
          // Send verification email
          await WIKI.mail.send({
            template: 'accountVerify',
            to: email,
            subject: 'Verify your account',
            data: {
              preheadertext: 'Verify your account in order to gain access to the wiki.',
              title: 'Verify your account',
              content: 'Click the button below in order to verify your account and gain access to the wiki.',
              buttonLink: `${WIKI.config.host}/verify/${verificationToken}`,
              buttonText: 'Verify'
            },
            text: `You must open the following link in your browser to verify your account and gain access to the wiki: ${WIKI.config.host}/verify/${verificationToken}`
          })
        }
851 852 853 854
        return true
      } else {
        throw new WIKI.Error.AuthAccountAlreadyExists()
      }
855
    } else {
856
      throw new WIKI.Error.AuthRegistrationDisabled()
857 858
    }
  }
859

860 861 862 863 864 865 866 867 868 869 870 871
  /**
   * Logout the current user
   */
  static async logout (context) {
    if (!context.req.user || context.req.user.id === 2) {
      return '/'
    }
    const usr = await WIKI.models.users.query().findById(context.req.user.id).select('providerKey')
    const provider = _.find(WIKI.auth.strategies, ['key', usr.providerKey])
    return provider.logout ? provider.logout(provider.config) : '/'
  }

872
  static async getGuestUser () {
873
    const user = await WIKI.models.users.query().findById(2).withGraphJoined('groups').modifyGraph('groups', builder => {
874 875 876 877 878 879
      builder.select('groups.id', 'permissions')
    })
    if (!user) {
      WIKI.logger.error('CRITICAL ERROR: Guest user is missing!')
      process.exit(1)
    }
880
    user.permissions = user.getGlobalPermissions()
881 882
    return user
  }
883 884 885 886 887 888 889 890 891 892

  static async getRootUser () {
    let user = await WIKI.models.users.query().findById(1)
    if (!user) {
      WIKI.logger.error('CRITICAL ERROR: Root Administrator user is missing!')
      process.exit(1)
    }
    user.permissions = ['manage:system']
    return user
  }
NGPixel's avatar
NGPixel committed
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932

  /**
   * Add / Update User Avatar Data
   */
  static async updateUserAvatarData (userId, data) {
    try {
      WIKI.logger.debug(`Updating user ${userId} avatar data...`)
      if (data.length > 1024 * 1024) {
        throw new Error('Avatar image filesize is too large. 1MB max.')
      }
      const existing = await WIKI.models.knex('userAvatars').select('id').where('id', userId).first()
      if (existing) {
        await WIKI.models.knex('userAvatars').where({
          id: userId
        }).update({
          data
        })
      } else {
        await WIKI.models.knex('userAvatars').insert({
          id: userId,
          data
        })
      }
    } catch (err) {
      WIKI.logger.warn(`Failed to process binary thumbnail data for user ${userId}: ${err.message}`)
    }
  }

  static async getUserAvatarData (userId) {
    try {
      const usrData = await WIKI.models.knex('userAvatars').where('id', userId).first()
      if (usrData) {
        return usrData.data
      } else {
        return null
      }
    } catch (err) {
      WIKI.logger.warn(`Failed to process binary thumbnail data for user ${userId}`)
    }
  }
933
}