Skip to content

LG-508 Add client-side Crockford Base32 encoding helper#2417

Merged
mryenq merged 2 commits intomasterfrom
mryenq-add-base32-crockford-encode-to-pk-confirm
Aug 14, 2018
Merged

LG-508 Add client-side Crockford Base32 encoding helper#2417
mryenq merged 2 commits intomasterfrom
mryenq-add-base32-crockford-encode-to-pk-confirm

Conversation

@mryenq
Copy link
Contributor

@mryenq mryenq commented Aug 7, 2018

Why: Personal key confirmation modal lacks
conversion helper present in server-side code.

How: Add corresponding client-side code to
coerce mistakenly read characters into their
Crockford Base32 equivalents.

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.

mryenq added 2 commits August 7, 2018 15:26
**Why**: Personal key confirmation modal lacks
conversion helper present in server-side code.

**How**: Add corresponding client-side code to
coerce mistakenly read characters into their
Crockford Base32 equivalents.
**Why**: Personal key confirmation modal lacks
conversion helper present in server-side code.

**How**: Add corresponding client-side code to
coerce mistakenly read characters into their
Crockford Base32 equivalents.
allow(FeatureManagement).to receive(:prefill_otp_codes?).and_return(true)
user = create(:user, :with_phone)
code = 'ABC1-DEF2-GHI3-JKL4'
code = 'ABC1-DEF2-GH13-JK14'
Copy link
Contributor

Choose a reason for hiding this comment

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

What was the reason for changing this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This example key was incorrect based on our code, and wasn't exposed earlier for lack of test coverage. See:

https://github.com/18F/identity-idp/blob/master/app/services/personal_key_generator.rb#L35

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

@mryenq mryenq merged commit 823187a into master Aug 14, 2018
@amathews-fs amathews-fs deleted the mryenq-add-base32-crockford-encode-to-pk-confirm branch January 7, 2021 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants