letsencrypt / letsencrypt/boulder
Change PausedProblem rateLimited to userActionRequired
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 5.8k
- Forks
- 649
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 24
Description
When initially designing account pausing/unpausing, I believe we overlooked a more applicable error that could be returned to the client. Currently we return ProblemType("rateLimited"), but instead I think we could implement and return ProblemType("userActionRequired"). RFC 8555 states,
| userActionRequired | Visit the "instance" URL and take |
| | actions specified there |
Now, the only example in the RFC about userActionRequired is for Changes of Terms of Service which we have done in the past, but not using this error type either.
If it's decided that boulder wants to use this, this comment should also be updated.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with probs/probs.go, including the rateLimited definition and its comment, then trace the paused-account response path to find where PausedProblem is returned. Update the problem type and its documentation, and verify that paused account requests expose the RFC 8555 userActionRequired behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100