Skip to content

Guard against nil email in password validator#2629

Merged
jmhooper merged 1 commit intomasterfrom
jmhooper-fix-password-reset-double-submit-500
Oct 26, 2018
Merged

Guard against nil email in password validator#2629
jmhooper merged 1 commit intomasterfrom
jmhooper-fix-password-reset-double-submit-500

Conversation

@jmhooper
Copy link
Contributor

Why: We were seeing NoMethodErrors on email in production
pointing at this code in the FormPasswordValidator:

def password_score
  @password_score = ZXCVBN_TESTER.test(
    password,
    ForbiddenPasswords.new(user.email_address.email).call
  )
end

When the reset password controller cannot find a user for a given
password reset token, it initializes an empty user with an error.
Once we added the #email_address method this started causing problems
because the nil user does not have an email.

This commit fixes the bug and also changes the form to differentiate
between invalid and expired tokens so the user sees the right error
message if their token is invalid.

Controllers

  • When adding a new controller that requires the user to be fully
    authenticated, make sure to add before_action :confirm_two_factor_authenticated
    as the first callback.

Database

  • Unsafe migrations are implemented over several PRs and over several
    deploys to avoid production errors. The strong_migrations gem
    will warn you about unsafe migrations and has great step-by-step instructions
    for various scenarios.

  • Indexes were added if necessary. This article provides a good overview
    of indexes in Rails.

  • Verified that the changes don't affect other apps (such as the dashboard)

  • When relevant, a rake task is created to populate the necessary DB columns
    in the various environments right before deploying, taking into account the users
    who might not have interacted with this column yet (such as users who have not
    set a password yet)

  • Migrations against existing tables have been tested against a copy of the
    production database. See LG-228 Make migrations safer and more resilient #2127 for an example when a migration caused deployment
    issues. In that case, all the migration did was add a new column and an index to
    the Users table, which might seem innocuous.

Encryption

  • The changes are compatible with data that was encrypted with the old code.

Routes

  • GET requests are not vulnerable to CSRF attacks (i.e. they don't change
    state or result in destructive behavior).

Session

  • When adding user data to the session, use the user_session helper
    instead of the session helper so the data does not persist beyond the user's
    session.

Testing

  • Tests added for this feature/bug
  • Prefer feature/integration specs over controller specs
  • When adding code that reads data, write tests for nil values, empty strings,
    and invalid inputs.

**Why**: We were seeing `NoMethodErrors` on `email` in production
pointing at this code in the `FormPasswordValidator`:

```ruby
def password_score
  @password_score = ZXCVBN_TESTER.test(
    password,
    ForbiddenPasswords.new(user.email_address.email).call
  )
end
```

When the reset password controller cannot find a user for a given
password reset token, it initializes an empty user with an error.
Once we added the `#email_address` method this started causing problems
because the nil user does not have an email.

This commit fixes the bug and also changes the form to differentiate
between invalid and expired tokens so the user sees the right error
message if their token is invalid.
Copy link
Contributor

@jgsmith-usds jgsmith-usds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jmhooper jmhooper merged commit f0e24b3 into master Oct 26, 2018
@jmhooper jmhooper deleted the jmhooper-fix-password-reset-double-submit-500 branch February 15, 2019 18:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants