ConnorDKeehan.AuthService 8.2.2

dotnet add package ConnorDKeehan.AuthService --version 8.2.2
                    
NuGet\Install-Package ConnorDKeehan.AuthService -Version 8.2.2
                    
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="ConnorDKeehan.AuthService" Version="8.2.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ConnorDKeehan.AuthService" Version="8.2.2" />
                    
Directory.Packages.props
<PackageReference Include="ConnorDKeehan.AuthService" />
                    
Project file
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 ConnorDKeehan.AuthService --version 8.2.2
                    
#r "nuget: ConnorDKeehan.AuthService, 8.2.2"
                    
#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 ConnorDKeehan.AuthService@8.2.2
                    
#: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=ConnorDKeehan.AuthService&version=8.2.2
                    
Install as a Cake Addin
#tool nuget:?package=ConnorDKeehan.AuthService&version=8.2.2
                    
Install as a Cake Tool

Currently this package requires a few things:

Create the necessary tables in the database you plan to use. This script is in the SqlScripts folder of the Nuget package and also below:

CREATE TABLE Logins (
    Id INT PRIMARY KEY IDENTITY(1,1) NOT NULL,
    Username NVARCHAR(100) NOT NULL,
    Email NVARCHAR(100) NULL,
    EmailVerified BIT NOT NULL,
    Password NVARCHAR(200) NOT NULL,
    AccessTokenVersion INT NOT NULL,
    Deleted BIT NOT NULL,
    PushNotificationToken NVARCHAR(200) NULL,
    SocialLoginIdentifier NVARCHAR(100) NULL,
    DateCreatedUtc DATETIME2,
    Metadata NVARCHAR(MAX) NULL
)

CREATE TABLE RefreshTokens (
    Id INT PRIMARY KEY IDENTITY(1,1) NOT NULL,
    LoginId INT NOT NULL REFERENCES Logins(Id),
    Token NVARCHAR(200) NOT NULL UNIQUE,
    DeviceId UNIQUEIDENTIFIER NOT NULL,
    DateCreatedUtc DATETIME2 NOT NULL,
    DateExpiryUtc DATETIME2 NOT NULL,
    Revoked BIT NOT NULL
)

CREATE TABLE TwoFactorAuthCodes (
    Id INT PRIMARY KEY IDENTITY(1,1) NOT NULL,
    LoginId INT NOT NULL REFERENCES Logins(Id),
    Code NVARCHAR(50) NOT NULL,
    Purpose NVARCHAR(50) NOT NULL,
    DateCreatedUtc DATETIME2 NOT NULL,
    DateExpiryUtc DATETIME2 NOT NULL,
    DateUsedUtc DATETIME2 NULL,
    Revoked BIT NOT NULL
)

You will also need to add the DI to your startup:

builder.Services.AddAuthService(builder.Configuration);

Some appsettings to be set, particularly:

  1. "Auth:Jwt:Issuer"
  2. "Auth:Jwt:Key"
  3. "Auth:Jwt:Audience"
  4. "Auth:ExpiryTimeMinutes"
  5. "Auth:ConnectionString" //For most people this will be the same as their default connection string, just duplicate it to there in that case.
  6. "Auth:RefreshTokenHmacKey"
  7. "Auth:RefreshTokenExpiryTimeDays"

And if you'd like to allow login with google account:

  1. "Auth:GoogleClientId"
  2. "Auth:GoogleClientSecret"

Similarly for Apple login you will need:

  1. "Auth:AppleClientId"

If you wish to use the default EmailService in the package you will need to include the below:

  1. "Auth:EnableDefaultEmailService": true
  2. "Auth:Smtp:Host"
  3. "Auth:Smtp:Port"
  4. "Auth:Smtp:Username"
  5. "Auth:Smtp:Password"
  6. "Auth:Smtp:From"
  7. "Auth:Smtp:EnableSsl"

If you don't choose to use the default email service you will need to register your own if you want to use the 2FA features:

builder.Services.AddScoped<IEmailService,MyCustomEmailService>();

And it must implement:

Task SendAsync(string to, string subject, string body);
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.  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.

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
8.2.2 262 4/14/2025
8.2.1 126 4/6/2025
8.2.0 116 4/6/2025
8.1.0 112 4/6/2025
1.0.0 157 4/3/2025