Skip to content

LG-10909 Add an explanation for the OTP rate limiter structure #9374

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.

Sign up for GitHub

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

Merged
jmhooper merged 3 commits into from
Oct 13, 2023
+7 −0
Merged

LG-10909 Add an explanation for the OTP rate limiter structure #9374

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
40a0e4d
LG-10909 Add an explanation for the OTP rate limiter structure
jmhooper Oct 12, 2023
f0e370f
Update app/services/idv/send_phone_confirmation_otp.rb
jmhooper Oct 12, 2023
a8b7462
delint
jmhooper Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions app/services/idv/send_phone_confirmation_otp.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ def initialize(user:, idv_session:)
def call
otp_rate_limiter.reset_count_and_otp_last_sent_at if user.no_longer_locked_out?

# The pattern for checking the rate limiter, incrementing, then checking again was introduced
# in this change: https://github.com/18F/identity-idp/pull/2216
#
# This adds protection against a race condition that would result in sending a large number
# of OTPs and/or needlessly making atomic increments to the rate limit counter if
# a bad actor sends many requests at the same time.
#
return too_many_otp_sends_response if rate_limit_exceeded?
otp_rate_limiter.increment
return too_many_otp_sends_response if rate_limit_exceeded?
Expand Down