Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LG-227 Improve OIDC token code error message #2133

Merged
merged 1 commit into from
May 2, 2018

Conversation

monfresh
Copy link
Contributor

@monfresh monfresh commented May 2, 2018

Why: Some agency developers have been sending requests to our
OIDC token endpoint with an invalid code, and received a generic
"Code invalid code" error message.

How: Explain why the code is invalid and point developers to
our documentation.

Hi! Before submitting your PR for review, and/or before merging it, please
go through the following checklist:

  • For DB changes, check for missing indexes, check to see if the changes
    affect other apps (such as the dashboard), make sure the DB columns in the
    various environments are properly populated, coordinate with devops, plan
    migrations in separate steps.

  • For route changes, make sure GET requests don't change state or result in
    destructive behavior. GET requests should only result in information being
    read, not written.

  • For encryption changes, make sure it is compatible with data that was
    encrypted with the old code.

  • For secrets changes, make sure to update the S3 secrets bucket with the
    new configs in all environments.

  • Do not disable Rubocop or Reek offenses unless you are absolutely sure
    they are false positives. If you're not sure how to fix the offense, please
    ask a teammate.

  • When reading data, write tests for nil values, empty strings,
    and invalid formats.

  • When calling redirect_to in a controller, use _url, not _path.

  • 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.

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

invalid_code: code non valide
invalid_code: est non valide soit parce qu'il est périmé, soit parce qu'il
ne correspond à aucun utilisateur. Veuillez consultez notre documentation
à https://developers.login.gov/oidc/#token
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that this endpoint is only called by agency applications, not by users, so it is very unlikely they are passing in any language parameters. In other words, I don't think this needs to be translated, but I updated the French string because I know French. If someone wants to provide the Spanish string in a timely manner, then I can update it. Otherwise, this should not hold up this PR.

@monfresh monfresh force-pushed the mb-lg-227-oidc-error-message branch from e99f22b to 07c7b13 Compare May 2, 2018 02:25
@monfresh monfresh requested a review from stevegsa May 2, 2018 02:26
Copy link
Contributor

@stevegsa stevegsa left a comment

Choose a reason for hiding this comment

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

LGTM

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.

Is there a Spanish translation?

@monfresh
Copy link
Contributor Author

monfresh commented May 2, 2018

@jgsmith-usds See my hidden comment above: #2133 (review)

@jgsmith-usds
Copy link
Contributor

Maybe:

no es válido porque ha caducado o no coincide con ningún usuario. Consulte nuestra documentación en https://developers.login.gov/oidc/#token

It reads okay to me. But I agree that it's low priority since this is aimed at developers of federal web applications.

**Why**: Some agency developers have been sending requests to our
OIDC token endpoint with an invalid code, and received a generic
"Code invalid code" error message.

**How**: Explain why the code is invalid and point developers to
our documentation.
@monfresh monfresh force-pushed the mb-lg-227-oidc-error-message branch from 07c7b13 to 868ee86 Compare May 2, 2018 20:10
@monfresh monfresh merged commit 22b35b4 into master May 2, 2018
@monfresh monfresh deleted the mb-lg-227-oidc-error-message branch May 2, 2018 20:21
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