Skip to content

Prune IdV branches from MFA otp verification logic#2437

Closed
jmhooper wants to merge 8 commits intomasterfrom
jmhooper-remove-idv-code-from-2fa-otp-verification
Closed

Prune IdV branches from MFA otp verification logic#2437
jmhooper wants to merge 8 commits intomasterfrom
jmhooper-remove-idv-code-from-2fa-otp-verification

Conversation

@jmhooper
Copy link
Contributor

Why: We started using separate otp verification controllers for MFA
and IdV in #2430. This commit is a follow-on to that to remove the code
that supported IdV in the MFA controller.

Hi! Before submitting your PR for review, and/or before merging it, please
go through the checklists below. These represent the more critical elements
of our code quality guidelines. The rest of the list can be found in
CONTRIBUTING.md

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**: The otp verification controller serves multiple puprose, phone
confirmation during sign up, sign in, edit phone, and idv. As a result
the logic is very complex and error prone. This commit creates a
separate controller specific for the IdV phone OTP confirmation since it
differs a good bit from the other use cases for phone confirmation.

This commit will need to be followed up by another to remove the old
code. I didn't do that here because the diff is already pretty
substantial without it.
**Why**: We started using separate otp verification controllers for MFA
and IdV in #2430. This commit is a follow-on to that to remove the code
that supported IdV in the MFA controller.
@jmhooper
Copy link
Contributor Author

After #2430 is done and merged, we'll need to change the base on this to master

@@ -66,7 +60,7 @@
def presenter_with_locale(locale)
Copy link
Contributor

Choose a reason for hiding this comment

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

This method doesn't seem to be used anywhere. Can we remove it?

Copy link
Contributor

@monfresh monfresh left a comment

Choose a reason for hiding this comment

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

LGTM % comment

@jmhooper jmhooper changed the base branch from jmhooper-idv-specific-otp-verification to master September 5, 2018 01:53
@jmhooper
Copy link
Contributor Author

jmhooper commented Sep 5, 2018

I tried rebasing this, but it's so far behind that it is hardly useful anymore. I'm going to close an open another after more cleanup.

@jmhooper jmhooper closed this Sep 5, 2018
@jmhooper jmhooper deleted the jmhooper-remove-idv-code-from-2fa-otp-verification branch February 15, 2019 19:15
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