Shaddix.OpenIddict.ExternalAuthentication 2.3.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Shaddix.OpenIddict.ExternalAuthentication --version 2.3.1                
NuGet\Install-Package Shaddix.OpenIddict.ExternalAuthentication -Version 2.3.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="Shaddix.OpenIddict.ExternalAuthentication" Version="2.3.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shaddix.OpenIddict.ExternalAuthentication --version 2.3.1                
#r "nuget: Shaddix.OpenIddict.ExternalAuthentication, 2.3.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.
// Install Shaddix.OpenIddict.ExternalAuthentication as a Cake Addin
#addin nuget:?package=Shaddix.OpenIddict.ExternalAuthentication&version=2.3.1

// Install Shaddix.OpenIddict.ExternalAuthentication as a Cake Tool
#tool nuget:?package=Shaddix.OpenIddict.ExternalAuthentication&version=2.3.1                

OpenIddictExternalAuthentication

NUGET MIT NET6

Library that simplifies integration of OpenIdDict to a several lines of code. It contain basic implementation of AuthenticationController, mostly taken from OpenIddict Samples.

What's inside

  1. Required endpoints to support 3rd party authentication (e.g. Google, Facebook, etc.)
  2. JWT access_token/refresh_token generation (i.e. default /connect/token endpoint)
  3. Refresh token flow
  4. Authorization Code flow
  5. Resource Owner Password Flow (disabled by default, could be enabled via configuration)

Here's the vanilla js or react demo of Google/Facebook authentication using OpenIddict on backend. The page has several buttons to log in via different providers. Example workflow

How to

  1. PREREQUISITE: it's implied, that openiddict is installed and configured in your project already (if it's not, head over to one of the samples).

  2. Install nuget to add the library to your project.

     dotnet add package Shaddix.OpenIddict.ExternalAuthentication
    
  3. Create you own AuthorizationController by inheriting from OpenIdAuthorizationControllerBase. This could look like:

    public class AuthorizationController : OpenIdAuthorizationControllerBase<IdentityUser, string>
    {
        public AuthorizationController(SignInManager<IdentityUser> signInManager,
         UserManager<IdentityUser> userManager,
         IOpenIddictClientConfigurationProvider clientConfigurationProvider) : base(signInManager, userManager,
         clientConfigurationProvider)
         {
         }
    
    }
    
  4. Override some functions (e.g. CreateNewUser or GetClaims) if you want to customize user creation behavior or provide more claims.

  5. From Configure function in Startup.cs add the following calls (in addition to standard OpenIddict setup):

    services
       .AddOpenIddict()
       .AddOpenIddictConfigurations(Configuration)
       .AddDefaultAuthorizationController()
    

    You could customize default authorization controller configuration (or even default OpenIddict configuration) by doing:

    .AddDefaultAuthorizationController(options => 
                     options.DisableRefreshTokenFlow())
    

    or

    .AddDefaultAuthorizationController(options =>
                     options.OpenIddictServerBuilder.AllowNoneFlow())
    
  6. Add external auth providers (i.e. .AddAuthentication().AddGoogle(), .AddFacebook(), etc.). Follow instructions on how to set up applications on OAuth provider side.

You could also take a look at OpenIddictExternalAuthentication.Example for example usage (keep in mind, that there are hardcoded ClientId/ClientSecret for FB and Google within Example app. They are for demo purposes and everyone can use them, so beware).

Frontend

  1. Use some proven openid client library (I personally recommend oidc-client-ts).
  2. Use standard auth code flow according to the library instructions, pointing to standard Authorize endpoint and passing ?provider=Google as a query parameter (i.e. authorization endpoint should look like /connect/authorize?provider=Google).
  3. You could check example implementation in plain-js or React

External user storage

We use standard Asp.Net Identity mechanism to store external logins (namely, AspNetUserLogins table). To find a user by external OAuth id you need to use _userManager.FindByLoginAsync(providerName, externalUserId)

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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
2.7.1 140 11/8/2024
2.6.9 2,022 3/6/2024
2.6.8 7,924 12/24/2023
2.6.7 122 12/24/2023
2.6.6 4,396 5/2/2023
2.6.5 163 5/2/2023
2.6.4 346 5/2/2023
2.6.3 148 5/2/2023
2.6.2 151 5/2/2023
2.6.1 144 5/2/2023
2.5.1 167 5/1/2023
2.4.3 8,934 12/23/2022
2.4.2 2,547 12/17/2022
2.4.1 286 12/17/2022
2.3.2 1,768 10/24/2022
2.3.1 2,235 8/15/2022
2.2.2 2,237 7/23/2022
2.2.1 527 7/20/2022
2.1.3 799 7/8/2022
2.1.2 429 7/7/2022
2.1.1 449 7/6/2022
2.0.3 1,049 6/21/2022
2.0.2 477 6/20/2022
2.0.1 397 6/20/2022
1.4.5 465 6/20/2022
1.4.4 398 6/20/2022
1.4.3 429 6/20/2022
1.4.2 420 6/19/2022
1.4.1 424 6/19/2022
1.3.2 433 6/18/2022
1.3.1 436 6/17/2022
1.2.3 489 6/9/2022
1.2.2 400 6/9/2022
1.2.1 427 6/8/2022
1.1.4 429 5/29/2022
1.1.3 986 5/5/2022
1.1.2 1,205 3/14/2022
1.0.5 440 3/14/2022
1.0.4 452 3/13/2022
1.0.2 433 3/13/2022
1.0.1 417 3/13/2022