solid-server 5.8.6 → 5.8.8-22f4cfec

package/lib/requests/{password-change-request.js → password-change-request.mjs}

@@ -1,201 +1,132 @@
-'use strict'
-
-const AuthRequest = require('./auth-request')
-const debug = require('./../debug').accounts
-
-class PasswordChangeRequest extends AuthRequest {
-  /**
-   * @constructor
-   * @param options {Object}
-   * @param options.accountManager {AccountManager}
-   * @param options.userStore {UserStore}
-   * @param options.response {ServerResponse} express response object
-   * @param [options.token] {string} One-time reset password token (from email)
-   * @param [options.returnToUrl] {string}
-   * @param [options.newPassword] {string} New password to save
-   */
-  constructor (options) {
-    super(options)
-
-    this.token = options.token
-    this.returnToUrl = options.returnToUrl
-
-    this.validToken = false
-
-    this.newPassword = options.newPassword
-  }
-
-  /**
-   * Factory method, returns an initialized instance of PasswordChangeRequest
-   * from an incoming http request.
-   *
-   * @param req {IncomingRequest}
-   * @param res {ServerResponse}
-   *
-   * @return {PasswordChangeRequest}
-   */
-  static fromParams (req, res) {
-    const locals = req.app.locals
-    const accountManager = locals.accountManager
-    const userStore = locals.oidc.users
-
-    const returnToUrl = this.parseParameter(req, 'returnToUrl')
-    const token = this.parseParameter(req, 'token')
-    const oldPassword = this.parseParameter(req, 'password')
-    const newPassword = this.parseParameter(req, 'newPassword')
-
-    const options = {
-      accountManager,
-      userStore,
-      returnToUrl,
-      token,
-      oldPassword,
-      newPassword,
-      response: res
-    }
-
-    return new PasswordChangeRequest(options)
-  }
-
-  /**
-   * Handles a Change Password GET request on behalf of a middleware handler.
-   *
-   * @param req {IncomingRequest}
-   * @param res {ServerResponse}
-   *
-   * @return {Promise}
-   */
-  static get (req, res) {
-    const request = PasswordChangeRequest.fromParams(req, res)
-
-    return Promise.resolve()
-      .then(() => request.validateToken())
-      .then(() => request.renderForm())
-      .catch(error => request.error(error))
-  }
-
-  /**
-   * Handles a Change Password POST request on behalf of a middleware handler.
-   *
-   * @param req {IncomingRequest}
-   * @param res {ServerResponse}
-   *
-   * @return {Promise}
-   */
-  static post (req, res) {
-    const request = PasswordChangeRequest.fromParams(req, res)
-
-    return PasswordChangeRequest.handlePost(request)
-  }
-
-  /**
-   * Performs the 'Change Password' operation, after the user submits the
-   * password change form. Validates the parameters (the one-time token,
-   * the new password), changes the password, and renders the success view.
-   *
-   * @param request {PasswordChangeRequest}
-   *
-   * @return {Promise}
-   */
-  static handlePost (request) {
-    return Promise.resolve()
-      .then(() => request.validatePost())
-      .then(() => request.validateToken())
-      .then(tokenContents => request.changePassword(tokenContents))
-      .then(() => request.renderSuccess())
-      .catch(error => request.error(error))
-  }
-
-  /**
-   * Validates the 'Change Password' parameters, and throws an error if any
-   * validation fails.
-   *
-   * @throws {Error}
-   */
-  validatePost () {
-    if (!this.newPassword) {
-      throw new Error('Please enter a new password')
-    }
-  }
-
-  /**
-   * Validates the one-time Password Reset token that was emailed to the user.
-   * If the token service has a valid token saved for the given key, it returns
-   * the token object value (which contains the user's WebID URI, etc).
-   * If no token is saved, returns `false`.
-   *
-   * @return {Promise<Object|false>}
-   */
-  validateToken () {
-    return Promise.resolve()
-      .then(() => {
-        if (!this.token) { return false }
-
-        return this.accountManager.validateResetToken(this.token)
-      })
-      .then(validToken => {
-        if (validToken) {
-          this.validToken = true
-        }
-
-        return validToken
-      })
-      .catch(error => {
-        this.token = null
-        throw error
-      })
-  }
-
-  /**
-   * Changes the password that's saved in the user store.
-   * If the user has no user store entry, it creates one.
-   *
-   * @param tokenContents {Object}
-   * @param tokenContents.webId {string}
-   *
-   * @return {Promise}
-   */
-  changePassword (tokenContents) {
-    const user = this.accountManager.userAccountFrom(tokenContents)
-
-    debug('Changing password for user:', user.webId)
-
-    return this.userStore.findUser(user.id)
-      .then(userStoreEntry => {
-        if (userStoreEntry) {
-          return this.userStore.updatePassword(user, this.newPassword)
-        } else {
-          return this.userStore.createUser(user, this.newPassword)
-        }
-      })
-  }
-
-  /**
-   * Renders the 'change password' form.
-   *
-   * @param [error] {Error} Optional error to display
-   */
-  renderForm (error) {
-    const params = {
-      validToken: this.validToken,
-      returnToUrl: this.returnToUrl,
-      token: this.token
-    }
-
-    if (error) {
-      params.error = error.message
-      this.response.status(error.statusCode)
-    }
-
-    this.response.render('auth/change-password', params)
-  }
-
-  /**
-   * Displays the 'password has been changed' success view.
-   */
-  renderSuccess () {
-    this.response.render('auth/password-changed', { returnToUrl: this.returnToUrl })
-  }
-}
-
-module.exports = PasswordChangeRequest
+import debugModule from '../debug.mjs'
+import AuthRequest from './auth-request.mjs'
+
+const debug = debugModule.accounts
+
+export default class PasswordChangeRequest extends AuthRequest {
+  constructor (options) {
+    super(options)
+
+    this.token = options.token
+    this.returnToUrl = options.returnToUrl
+
+    this.validToken = false
+
+    this.newPassword = options.newPassword
+    this.userStore = options.userStore
+    this.response = options.response
+  }
+
+  static fromParams (req, res) {
+    const locals = req.app && req.app.locals ? req.app.locals : {}
+    const accountManager = locals.accountManager
+    const userStore = locals.oidc ? locals.oidc.users : undefined
+
+    const returnToUrl = this.parseParameter(req, 'returnToUrl')
+    const token = this.parseParameter(req, 'token')
+    const oldPassword = this.parseParameter(req, 'password')
+    const newPassword = this.parseParameter(req, 'newPassword')
+
+    const options = {
+      accountManager,
+      userStore,
+      returnToUrl,
+      token,
+      oldPassword,
+      newPassword,
+      response: res
+    }
+
+    return new PasswordChangeRequest(options)
+  }
+
+  static get (req, res) {
+    const request = PasswordChangeRequest.fromParams(req, res)
+
+    return Promise.resolve()
+      .then(() => request.validateToken())
+      .then(() => request.renderForm())
+      .catch(error => request.error(error))
+  }
+
+  static post (req, res) {
+    const request = PasswordChangeRequest.fromParams(req, res)
+
+    return PasswordChangeRequest.handlePost(request)
+  }
+
+  static handlePost (request) {
+    return Promise.resolve()
+      .then(() => request.validatePost())
+      .then(() => request.validateToken())
+      .then(tokenContents => request.changePassword(tokenContents))
+      .then(() => request.renderSuccess())
+      .catch(error => request.error(error))
+  }
+
+  validatePost () {
+    if (!this.newPassword) {
+      throw new Error('Please enter a new password')
+    }
+  }
+
+  validateToken () {
+    return Promise.resolve()
+      .then(() => {
+        if (!this.token) { return false }
+
+        return this.accountManager.validateResetToken(this.token)
+      })
+      .then(validToken => {
+        if (validToken) {
+          this.validToken = true
+        }
+
+        return validToken
+      })
+      .catch(error => {
+        this.token = null
+        throw error
+      })
+  }
+
+  changePassword (tokenContents) {
+    const user = this.accountManager.userAccountFrom(tokenContents)
+
+    debug('Changing password for user:', user.webId)
+
+    return this.userStore.findUser(user.id)
+      .then(userStoreEntry => {
+        if (userStoreEntry) {
+          return this.userStore.updatePassword(user, this.newPassword)
+        } else {
+          return this.userStore.createUser(user, this.newPassword)
+        }
+      })
+  }
+
+  renderForm (error) {
+    const params = {
+      validToken: this.validToken,
+      returnToUrl: this.returnToUrl,
+      token: this.token
+    }
+
+    if (error) {
+      params.error = error.message
+      this.response.status(error.statusCode)
+    }
+
+    this.response.render('auth/change-password', params)
+  }
+
+  renderSuccess () {
+    this.response.render('auth/password-changed', { returnToUrl: this.returnToUrl })
+  }
+
+  error (error) {
+    error.statusCode = error.statusCode || 400
+
+    this.renderForm(error)
+  }
+}

package/lib/requests/{password-reset-email-request.js → password-reset-email-request.mjs}

@@ -1,202 +1,123 @@
-'use strict'
-
-const AuthRequest = require('./auth-request')
-const debug = require('./../debug').accounts
-
-class PasswordResetEmailRequest extends AuthRequest {
-  /**
-   * @constructor
-   * @param options {Object}
-   * @param options.accountManager {AccountManager}
-   * @param options.response {ServerResponse} express response object
-   * @param [options.returnToUrl] {string}
-   * @param [options.username] {string} Username / account name (e.g. 'alice')
-   */
-  constructor (options) {
-    super(options)
-
-    this.returnToUrl = options.returnToUrl
-    this.username = options.username
-  }
-
-  /**
-   * Factory method, returns an initialized instance of PasswordResetEmailRequest
-   * from an incoming http request.
-   *
-   * @param req {IncomingRequest}
-   * @param res {ServerResponse}
-   *
-   * @return {PasswordResetEmailRequest}
-   */
-  static fromParams (req, res) {
-    const locals = req.app.locals
-    const accountManager = locals.accountManager
-
-    const returnToUrl = this.parseParameter(req, 'returnToUrl')
-    const username = this.parseParameter(req, 'username')
-
-    const options = {
-      accountManager,
-      returnToUrl,
-      username,
-      response: res
-    }
-
-    return new PasswordResetEmailRequest(options)
-  }
-
-  /**
-   * Handles a Reset Password GET request on behalf of a middleware handler.
-   * Usage:
-   *
-   *   ```
-   *   app.get('/password/reset', PasswordResetEmailRequest.get)
-   *   ```
-   *
-   * @param req {IncomingRequest}
-   * @param res {ServerResponse}
-   */
-  static get (req, res) {
-    const request = PasswordResetEmailRequest.fromParams(req, res)
-
-    request.renderForm()
-  }
-
-  /**
-   * Handles a Reset Password POST request on behalf of a middleware handler.
-   * Usage:
-   *
-   *   ```
-   *   app.get('/password/reset', PasswordResetEmailRequest.get)
-   *   ```
-   *
-   * @param req {IncomingRequest}
-   * @param res {ServerResponse}
-   */
-  static post (req, res) {
-    const request = PasswordResetEmailRequest.fromParams(req, res)
-
-    debug(`User '${request.username}' requested to be sent a password reset email`)
-
-    return PasswordResetEmailRequest.handlePost(request)
-  }
-
-  /**
-   * Performs a 'send me a password reset email' request operation, after the
-   * user has entered an email into the reset form.
-   *
-   * @param request {PasswordResetEmailRequest}
-   *
-   * @return {Promise}
-   */
-  static handlePost (request) {
-    return Promise.resolve()
-      .then(() => request.validate())
-      .then(() => request.loadUser())
-      .then(userAccount => request.sendResetLink(userAccount))
-      .then(() => request.resetLinkMessage())
-      .catch(error => request.error(error))
-  }
-
-  /**
-   * Validates the request parameters, and throws an error if any
-   * validation fails.
-   *
-   * @throws {Error}
-   */
-  validate () {
-    if (this.accountManager.multiuser && !this.username) {
-      throw new Error('Username required')
-    }
-  }
-
-  /**
-   * Returns a user account instance for the submitted username.
-   *
-   * @throws {Error} Rejects if user account does not exist for the username
-   *
-   * @returns {Promise<UserAccount>}
-   */
-  loadUser () {
-    const username = this.username
-
-    return this.accountManager.accountExists(username)
-      .then(exists => {
-        if (!exists) {
-          // For security reasons, avoid leaking error information
-          // See: https://github.com/nodeSolidServer/node-solid-server/issues/1770
-          this.accountManager.verifyEmailDependencies()
-          return this.resetLinkMessage()
-        }
-
-        const userData = { username }
-
-        return this.accountManager.userAccountFrom(userData)
-      })
-  }
-
-  /**
-   * Loads the account recovery email for a given user and sends out a
-   * password request email.
-   *
-   * @param userAccount {UserAccount}
-   *
-   * @return {Promise}
-   */
-  sendResetLink (userAccount) {
-    const accountManager = this.accountManager
-
-    return accountManager.loadAccountRecoveryEmail(userAccount)
-      .then(recoveryEmail => {
-        userAccount.email = recoveryEmail
-
-        debug('Sending recovery email to:', recoveryEmail)
-
-        return accountManager
-          .sendPasswordResetEmail(userAccount, this.returnToUrl)
-      })
-  }
-
-  /**
-   * Renders the 'send password reset link' form along with the provided error.
-   * Serves as an error handler for this request workflow.
-   *
-   * @param error {Error}
-   */
-  error (error) {
-    const res = this.response
-
-    debug(error)
-
-    const params = {
-      error: error.message,
-      returnToUrl: this.returnToUrl,
-      multiuser: this.accountManager.multiuser
-    }
-
-    res.status(error.statusCode || 400)
-
-    res.render('auth/reset-password', params)
-  }
-
-  /**
-   * Renders the 'send password reset link' form
-   */
-  renderForm () {
-    const params = {
-      returnToUrl: this.returnToUrl,
-      multiuser: this.accountManager.multiuser
-    }
-
-    this.response.render('auth/reset-password', params)
-  }
-
-  /**
-   * Displays the 'your reset link has been sent' success message view
-   */
-  resetLinkMessage () {
-    this.response.render('auth/reset-link-sent')
-  }
-}
-
-module.exports = PasswordResetEmailRequest
+import AuthRequest from './auth-request.mjs'
+import debugModule from './../debug.mjs'
+
+const debug = debugModule.accounts
+
+export default class PasswordResetEmailRequest extends AuthRequest {
+  constructor (options) {
+    super(options)
+
+    this.accountManager = options.accountManager
+    this.userStore = options.userStore
+    this.returnToUrl = options.returnToUrl
+    this.username = options.username
+    this.response = options.response
+  }
+
+  static fromParams (req, res) {
+    const locals = req.app.locals
+    const accountManager = locals.accountManager
+
+    const returnToUrl = this.parseParameter(req, 'returnToUrl')
+    const username = this.parseParameter(req, 'username')
+
+    const options = {
+      accountManager,
+      returnToUrl,
+      username,
+      response: res
+    }
+
+    return new PasswordResetEmailRequest(options)
+  }
+
+  static get (req, res) {
+    const request = PasswordResetEmailRequest.fromParams(req, res)
+
+    request.renderForm()
+  }
+
+  static post (req, res) {
+    const request = PasswordResetEmailRequest.fromParams(req, res)
+
+    debug(`User '${request.username}' requested to be sent a password reset email`)
+
+    return PasswordResetEmailRequest.handlePost(request)
+  }
+
+  static handlePost (request) {
+    return Promise.resolve()
+      .then(() => request.validate())
+      .then(() => request.loadUser())
+      .then(userAccount => request.sendResetLink(userAccount))
+      .then(() => request.resetLinkMessage())
+      .catch(error => request.error(error))
+  }
+
+  validate () {
+    if (this.accountManager.multiuser && !this.username) {
+      throw new Error('Username required')
+    }
+  }
+
+  loadUser () {
+    const username = this.username
+
+    return this.accountManager.accountExists(username)
+      .then(exists => {
+        if (!exists) {
+          // For security reasons, avoid leaking error information
+          // See: https://github.com/nodeSolidServer/node-solid-server/issues/1770
+          this.accountManager.verifyEmailDependencies()
+          return this.resetLinkMessage()
+        }
+
+        const userData = { username }
+
+        return this.accountManager.userAccountFrom(userData)
+      })
+  }
+
+  sendResetLink (userAccount) {
+    const accountManager = this.accountManager
+
+    return accountManager.loadAccountRecoveryEmail(userAccount)
+      .then(recoveryEmail => {
+        userAccount.email = recoveryEmail
+
+        debug('Sending recovery email to:', recoveryEmail)
+
+        return accountManager
+          .sendPasswordResetEmail(userAccount, this.returnToUrl)
+      })
+  }
+
+  error (error) {
+    const res = this.response
+
+    debug(error)
+
+    const params = {
+      error: error.message,
+      returnToUrl: this.returnToUrl,
+      multiuser: this.accountManager.multiuser
+    }
+
+    res.status(error.statusCode || 400)
+
+    res.render('auth/reset-password', params)
+  }
+
+  renderForm () {
+    const params = {
+      returnToUrl: this.returnToUrl,
+      multiuser: this.accountManager.multiuser
+    }
+
+    this.response.render('auth/reset-password', params)
+  }
+
+  resetLinkMessage () {
+    this.response.render('auth/reset-link-sent')
+  }
+}