Skip to content

Structure project documentation for installation and features #18

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
coding-libs merged 1 commit into from
Sep 2, 2025
Merged

Structure project documentation for installation and features #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
Multi Factor Authentication
CodingLibs Laravel MFA

Compatibility
- Laravel 11 and 12
- PHP >= 8.2
[![Packagist Version](https://img.shields.io/packagist/v/coding-libs/laravel-mfa.svg)](https://packagist.org/packages/coding-libs/laravel-mfa)

Installation
- Install via Composer from Packagist:
Expand All @@ -22,18 +20,22 @@ Packagist
- `https://packagist.org/packages/coding-libs/laravel-mfa`

Features
- Email and SMS one-time code challenges with pluggable channels
- Google Authenticator compatible TOTP (RFC 6238) setup and verification
- **Email** and **SMS** one-time code challenges with pluggable channels
- Google Authenticator compatible **TOTP** (RFC 6238) setup and verification
- Built-in QR code generation to display TOTP provisioning URI (uses bacon/bacon-qr-code)
- Remember device support via secure, hashed tokens stored in `mfa_remembered_devices`
- Simple API via `MFA` facade/service for issuing and verifying codes
- Publishable config and migrations; encrypted storage of TOTP secret
- Extendable channel system to add providers like WhatsApp, Twilio, etc.

MFA Channels
- Email: delivers a one-time code via Laravel Mail
- SMS: delivers a one-time code via the configured SMS driver (defaults to `log`)
- TOTP: time-based one-time password compatible with Google Authenticator and similar apps
- **Email**: delivers a one-time code via Laravel Mail
- **SMS**: delivers a one-time code via the configured SMS driver (defaults to `log`)
- **TOTP**: time-based one-time password compatible with Google Authenticator and similar apps

Compatibility
- Laravel 11 and 12
- PHP >= 8.2


Usage
Expand Down