SplatDev.Umbraco.Plugins.2fa
2.0.1
dotnet add package SplatDev.Umbraco.Plugins.2fa --version 2.0.1
NuGet\Install-Package SplatDev.Umbraco.Plugins.2fa -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SplatDev.Umbraco.Plugins.2fa" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SplatDev.Umbraco.Plugins.2fa" Version="2.0.1" />
<PackageReference Include="SplatDev.Umbraco.Plugins.2fa" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SplatDev.Umbraco.Plugins.2fa --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SplatDev.Umbraco.Plugins.2fa, 2.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package SplatDev.Umbraco.Plugins.2fa@2.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SplatDev.Umbraco.Plugins.2fa&version=2.0.1
#tool nuget:?package=SplatDev.Umbraco.Plugins.2fa&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
UmbracoCms.Plugins.2fa
Two-factor authentication plugin for Umbraco CMS. Implements TOTP (Time-based OTP) with EF Core-backed backup code storage.
Targets
- Umbraco 13 (net8.0)
- Umbraco 17 (net10.0)
Features
- TOTP secret generation (Base64-encoded HMAC-SHA1 key)
- TOTP verification with ±1 time-step window (30-second windows)
- Backup code generation (8 × 8-char hyphenated codes)
- Single-use backup code redemption
- EF Core schema:
twofactor.TwoFactorSetups,twofactor.BackupCodes - Backoffice dashboard (AngularJS for U13, Lit 3 Web Component for U17)
Database Migrations
Run EF Core migrations to create the schema:
dotnet ef migrations add InitialCreate --context TwoFactorDbContext
dotnet ef database update --context TwoFactorDbContext
API Endpoints
| Method | Route | Description |
|---|---|---|
| POST | /umbraco/api/twofactor/SetupTotp?memberId=N |
Generate / reset TOTP secret |
| POST | /umbraco/api/twofactor/VerifyTotp?memberId=N&code=XXXXXX |
Verify code and enable 2FA |
| POST | /umbraco/api/twofactor/GenerateBackupCodes?memberId=N&count=8 |
Generate backup codes |
| POST | /umbraco/api/twofactor/UseBackupCode?memberId=N&code=XXXX-XXXX |
Redeem a backup code |
| GET | /umbraco/api/twofactor/IsEnabled?memberId=N |
Check if 2FA is enabled |
| POST | /umbraco/api/twofactor/Disable?memberId=N |
Disable 2FA |
Note on TOTP
The built-in TOTP implementation is a simplified HMAC-SHA1 approach for demonstration. For production, replace with a dedicated library such as OtpNet.
Client Build
cd client
npm install
npm run build
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.EntityFrameworkCore.Design (>= 10.0.7)
- Microsoft.EntityFrameworkCore.SqlServer (>= 10.0.7)
- Umbraco.Cms.Core (>= 17.3.4)
- Umbraco.Cms.Web.Common (>= 17.3.4)
-
net8.0
- Microsoft.EntityFrameworkCore.Design (>= 8.0.20)
- Microsoft.EntityFrameworkCore.SqlServer (>= 8.0.20)
- Umbraco.Cms.Core (>= 13.12.0)
- Umbraco.Cms.Web.Common (>= 13.12.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.