rubyforgood / rubyforgood/skillrx
Add Optional Two-Factor Authentication (2FA) for User Accounts
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 16
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
To improve account security, we should add optional two-factor authentication (2FA) for users. This will allow users to enable 2FA via TOTP (e.g., Google Authenticator, Authy) in their account settings, but not require it for all users.
Requirements:
- Users can enable or disable 2FA from their account settings.
- When enabled, users must scan a QR code with an authenticator app to set up 2FA.
- On login, if 2FA is enabled, users must enter a valid TOTP code after password authentication.
- Users should be able to generate and view backup codes for account recovery.
- Store TOTP secrets and backup codes securely.
- UI/UX for enabling/disabling 2FA, entering codes, and managing backup codes.
Technical Notes:
- Use the rotp gem for TOTP generation/validation.
- Use the rqrcode gem to generate QR codes.
- Add otp_secret and otp_backup_codes columns to the users table.
- Update authentication flow to require TOTP code if 2FA is enabled.
Acceptance Criteria:
- Users can opt in/out of 2FA.
- 2FA is enforced only for users who have enabled it.
- Backup codes are available and can be regenerated.
- All sensitive data is handled securely.
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 by locating the existing account settings, authentication flow, and users table described in the issue. Review how rotp and rqrcode would fit those entry points, then verify that opt-in 2FA, TOTP login, secure secrets, and backup-code recovery meet the listed acceptance criteria.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- authentication, database, frontend, security
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100