Umbraco.Community.User2FA 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Umbraco.Community.User2FA --version 1.0.0                

                    
                

            
NuGet\Install-Package Umbraco.Community.User2FA -Version 1.0.0
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="Umbraco.Community.User2FA" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Umbraco.Community.User2FA --version 1.0.0                

                    
                

            
#r "nuget: Umbraco.Community.User2FA, 1.0.0"
#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. 
// Install Umbraco.Community.User2FA as a Cake Addin
#addin nuget:?package=Umbraco.Community.User2FA&version=1.0.0

// Install Umbraco.Community.User2FA as a Cake Tool
#tool nuget:?package=Umbraco.Community.User2FA&version=1.0.0

Umbraco Community User2FA

This is a simple package designed for Umbraco V14+ that adds Two Factor Auth (2FA) login to Umbraco backoffice users.

This is based on an Umbraco Docs tutorial, howver I saw this tutorial as mostly plumbing of creating C# files in order to add 2FA and thus package is designed to help save you time in creating these files over and over again.

How to use

  • Install the Nuget package into your Umbraco V14 site
  • Login to Umbraco backoffice
  • Click User avatar top right
  • Click button labeled Configure Two Factor
  • Enable Two Factor by scanning QR code with a phone such as

2FA Mobile Applications

I have also verified this to work with 1Password Desktop App to save/store the 2FA QR code and generate the correct pin.

Configuration

Configuration Key Description
User2FA:AuthenticatorIssuerName This is the name that will be displayed in the 2FA app when you scan the QR code, this is useful if you have multiple Umbraco sites and want to differentiate between them. 
{
	...

	"Umbraco": {
		...
	},
	"User2FA": {
		"AuthenticatorIssuerName": "My Awesome Website"
	}
	
	...
}

Contributing

The example website project has a backoffice user account setup ready to have a 2FA account applied to it, you can login in with the following credentials.

Username Password
warren@hackmakedo.com password1234

Lovingly crafted for you by Warren Buckley❤️<br/> Available for hire

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.1 119 7/14/2024
1.0.0 92 7/11/2024