Skip to content

Fix sms bug with analytics endpoint#2631

Merged
stevegsa merged 5 commits intomasterfrom
stevegsa-fix-sms-bug-with-analytics
Nov 1, 2018
Merged

Fix sms bug with analytics endpoint#2631
stevegsa merged 5 commits intomasterfrom
stevegsa-fix-sms-bug-with-analytics

Conversation

@stevegsa
Copy link
Contributor

Why: When the feature flag is enabled the analytics endpoint tries to authenticate a logged in user by redirecting the XHR request to 2FA and automatically sends an sms (a second time)

How: Since the endpoint will be a generic endpoint to collect analytics it should not be require authentication. Put in a simple check to see if we have a user before logging the platform authenticator analytics.

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**: When the feature flag is enabled the analytics endpoint tries to authenticate a logged in user by redirecting the XHR request to 2FA and automatically sends an sms (a second time)

**How**: Since the endpoint will be a generic endpoint to collect analytics it should not be require authentication.  Put in a simple check to see if we have a user before logging the platform authenticator analytics.
@stevegsa stevegsa force-pushed the stevegsa-fix-sms-bug-with-analytics branch from 6413073 to 6844194 Compare October 29, 2018 03:41
@monfresh
Copy link
Contributor

At what point should I see the event Frontend: Browser capabilities recorded in events.log? Should I see it every time I sign in? Should it work in all browsers? It doesn't seem to be created when I sign in with Safari.

@stevegsa
Copy link
Contributor Author

@moncef As soon as current_user is valid and only once per session. On registration it is right after "User Registration: 2FA Setup visited".

@monfresh
Copy link
Contributor

Can you try it on Safari? Does it get recorded for you?

@stevegsa
Copy link
Contributor Author

@monfresh i will update the code. the reason Safari doesn't work is because not only does it not support platform authenticators it does not support webauthn. I think I mentioned in the story that we needed to log both data points. For now I'm just going to have it log a false for platform authenticator when webauthn is not supported.

if (!window.PublicKeyCredential) {
postPlatformAuthenticator(false);
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Style: rather than an explicit return, I'd wrap the implicit "else" in an explicit else { ... } to make it more obvious that it won't be reached if the condition is false.

@stevegsa stevegsa merged commit f3fcabb into master Nov 1, 2018
@amathews-fs amathews-fs deleted the stevegsa-fix-sms-bug-with-analytics branch January 7, 2021 18:45
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.

3 participants