HCS.Passwordless.WebAuthn
1.0.0-beta001
This is a prerelease version of HCS.Passwordless.WebAuthn.
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package HCS.Passwordless.WebAuthn --version 1.0.0-beta001
NuGet\Install-Package HCS.Passwordless.WebAuthn -Version 1.0.0-beta001
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="HCS.Passwordless.WebAuthn" Version="1.0.0-beta001" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="HCS.Passwordless.WebAuthn" Version="1.0.0-beta001" />
<PackageReference Include="HCS.Passwordless.WebAuthn" />
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 HCS.Passwordless.WebAuthn --version 1.0.0-beta001
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: HCS.Passwordless.WebAuthn, 1.0.0-beta001"
#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 HCS.Passwordless.WebAuthn@1.0.0-beta001
#: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=HCS.Passwordless.WebAuthn&version=1.0.0-beta001&prerelease
#tool nuget:?package=HCS.Passwordless.WebAuthn&version=1.0.0-beta001&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
HCS.Passwordless.WebAuthn
WebAuthn / FIDO2 passkey add-on for HCS.Passwordless. Enables hardware-backed biometric or security-key authentication for Umbraco members using the browser's Credential Management API.
Requirements
- Umbraco 13 (
[13.0, 14.0)) - A browser that supports WebAuthn (all modern browsers)
HCS.Passwordless.Coreis pulled in automatically as a transitive dependency
Installation
dotnet add package HCS.Passwordless.WebAuthn
Setup
1. Register (Program.cs)
builder.CreateUmbracoBuilder()
.AddBackOffice()
.AddWebsite()
.AddPasswordlessWebAuthn()
.Build();
2. Map endpoints (Program.cs)
app.MapPasswordlessMembers()
.WithWebAuthn();
3. Configure (appsettings.json)
{
"HCS": {
"Authentication": {
"WebAuthn": {
"Enabled": true,
"RpName": "My Site",
"Origins": [ "https://example.com" ]
}
}
}
}
Important:
Originsmust exactly match the origin of the site as seen by the browser, including scheme and port.
4. Add passkey UI partials
{{-- Sign-in --}}
@await Html.PartialAsync("Passwordless/PasskeySignInButton")
{{-- On a member profile/settings page: --}}
@await Html.PartialAsync("Passwordless/PasskeyRegisterButton")
@await Html.PartialAsync("Passwordless/PasskeyCredentialList")
Configuration Options
HCS:Authentication:WebAuthn
| Key | Type | Default | Description |
|---|---|---|---|
Enabled |
bool | false |
Enable/disable WebAuthn flow |
RpName |
string | — | Relying party display name shown to the user |
Origins |
string[] | [] |
Allowed origins (must match browser origin exactly) |
Endpoints
| Method | Path | Description |
|---|---|---|
POST |
/webauthn/register/options |
Get registration challenge |
POST |
/webauthn/register/complete |
Complete credential registration |
POST |
/webauthn/signin/options |
Get authentication challenge |
POST |
/webauthn/signin/complete |
Complete authentication and sign in |
GET |
/webauthn/credentials |
List member's registered credentials |
DELETE |
/webauthn/credentials/{id} |
Remove a credential |
Database Migration
The package adds a MemberCredential table to the Umbraco database via Umbraco's migration system. This runs automatically on startup.
Security Notes
- Challenge state is stored in distributed cache and is single-use.
- Counter regression (a credential reporting a lower sign-count than previously recorded) triggers a
PasskeyCounterRegressionNotificationso the site can alert the member of a potential cloned authenticator. - WebAuthn requires HTTPS in production.
localhostis allowed for development.
Replacing Services
| Interface | Default | Purpose |
|---|---|---|
IWebAuthnChallengeStore |
Distributed cache implementation | Store WebAuthn challenges |
IMemberCredentialStore |
UmbracoDbMemberCredentialStore |
Persist credentials in Umbraco DB |
| 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 was computed. 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.
-
net8.0
- Fido2.AspNet (>= 4.0.1)
- HCS.Passwordless.Core (>= 1.0.0-beta001)
- Microsoft.Extensions.Caching.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Options.DataAnnotations (>= 8.0.0)
- System.Text.Json (>= 8.0.6)
- Umbraco.Cms.Core (>= 13.13.1 && < 14.0.0)
- Umbraco.Cms.Infrastructure (>= 13.13.1 && < 14.0.0)
- Umbraco.Cms.Web.Website (>= 13.13.1 && < 14.0.0)
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 |
|---|---|---|
| 2.0.2 | 77 | 5/18/2026 |
| 2.0.1 | 92 | 5/18/2026 |
| 2.0.0 | 79 | 5/18/2026 |
| 2.0.0-beta002 | 82 | 5/18/2026 |
| 2.0.0-beta001 | 71 | 5/18/2026 |
| 1.0.1 | 78 | 5/18/2026 |
| 1.0.0 | 77 | 5/18/2026 |
| 1.0.0-beta002 | 73 | 5/18/2026 |
| 1.0.0-beta001 | 72 | 5/18/2026 |