AspNet.Security.OAuth.OneID 1.1.45

dotnet add package AspNet.Security.OAuth.OneID --version 1.1.45
NuGet\Install-Package AspNet.Security.OAuth.OneID -Version 1.1.45
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="AspNet.Security.OAuth.OneID" Version="1.1.45" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AspNet.Security.OAuth.OneID --version 1.1.45
#r "nuget: AspNet.Security.OAuth.OneID, 1.1.45"
#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 AspNet.Security.OAuth.OneID as a Cake Addin
#addin nuget:?package=AspNet.Security.OAuth.OneID&version=1.1.45

// Install AspNet.Security.OAuth.OneID as a Cake Tool
#tool nuget:?package=AspNet.Security.OAuth.OneID&version=1.1.45

Ontario Health (OH) OneID Authentication Middleware

  • An easy to use library that makes connecting with Ontario Health easy for .NET Kestrel/Owin/Katana applications.

CI Nuget Nuget Tests

About | Usage | Development | Gallery | Acknowledgement | License


🔰 About

This library was created by Clinical Support Systems and Kori Francis, who have experience integrating with APIs of varying complexity. We wanted to simplify the connection in .NET web applications so we could get on with the actual API implementation.

🎉 Supported Ontario Health (OH) Services

To make integration simple, there's support in this middlewear to adjust the scope and profile depending on the service you're integrating with. As such, we currently support the following:

This will allow you to perform authentication once but retrieve an access_token that can access multiple services.

Supported oAuth/OIDC Features

  • ✔️ Authenticate
  • ✔️ Discovery
  • ✔️ User Info
  • ✔️ Validation (use JSON Web Key Set)
  • ✔️ Manual refresh
  • ❌ End Session
  • ❌ Logout

☀️ Usage

Here is how to use this library in your project.

🔌 NuGet Installation

Install-Package AspNet.Security.OAuth.OneID

📦 Startup.cs

Add the following to your authentication pipeline:

OWIN/Katana (ASP.NET)

app.UseOneIdAuthentication(new OneIdAuthenticationOptions()
    {
        CertificateThumbprint = ConfigurationManager.AppSettings["EHS:CertificateThumbprint"],
        ClientId = ConfigurationManager.AppSettings["EHS:AuthClientId"],
        Environment = OneIdAuthenticationEnvironment.PartnerSelfTest
    });

Kestrel (ASP.NET Core)

services.AddAuthentication().AddOneId(options =>
    {
        options.ClientId = Configuration["EHS:AuthClientId"];
        options.CertificateThumbprint = Configuration["EHS:CertificateThumbprint"];
        options.Environment = OneIdAuthenticationEnvironment.PartnerSelfTest;
    });

In the case of multiple service usage, simply specify that in the authentication options:

services.AddAuthentication().AddOneId(OneIdAuthenticationDefaults.AuthenticationScheme, (OneIdAuthenticationOptions options) =>
    {
        // ...
        options.ServiceProfileOptions = OneIdAuthenticationServiceProfiles.OLIS | OneIdAuthenticationServiceProfiles.DHDR;
    });

🔧 Development

If you want other people to contribute to this project, this is the section, make sure you always add this.

📓 Pre-Requisites

List all the pre-requisites the system needs to develop this project.

  • You will need a PKI certificate from Ontario Health (OH)
  • You will need login credentials from Ontario Health (OH)

🔥 Contribution

Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.

  1. Report a bug <br> If you think you have encountered a bug, and I should know about it, feel free to report it and I will take care of it.

  2. Request a feature <br> You can also request for a feature.

  3. Create a pull request <br> It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

🌵 Branches

I use an agile continuous integration methodology, so the version is frequently updated and development is really fast.

  1. develop is the development branch.

  2. master is the production branch.

  3. No further branches should be created in the main repository.

Steps to create a pull request

  1. Make a PR to master branch.
  2. Comply with the best practices and guidelines e.g. where the PR concerns visual elements it should have an image showing the effect.
  3. It must pass all continuous integration checks and get positive reviews.

After this, changes will be merged.

OneId Authentication

🌟 Credit/Acknowledgment

  • Kori Francis
  • David Ball
  • Alex McKeever
  • Victoria Tolls

🔒 License

License

https://login.oneidfederation.ehealthontario.ca/sso/oauth2/realms/root/realms/idaasoidc/.well-known/openid-configuration

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 is compatible.  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. 
.NET Framework net48 is compatible.  net481 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.1.45 799 6/1/2023
1.1.44 956 2/13/2023
1.1.43 777 1/20/2023
1.1.41 738 1/20/2023
1.1.40 775 11/10/2022
1.1.38 768 11/7/2022
1.1.37 876 11/3/2022
1.1.36 788 11/1/2022
1.1.34 808 11/1/2022
1.1.33 798 11/1/2022
1.1.28 806 11/1/2022
1.1.27 803 11/1/2022
1.1.26 798 11/1/2022
1.1.25 842 11/1/2022
1.1.24 780 11/1/2022
1.1.23 797 11/1/2022
1.1.19 777 11/1/2022
1.1.16 833 11/1/2022
1.1.15 803 11/1/2022
1.1.14 809 11/1/2022
1.1.13 826 10/31/2022
1.1.12 759 10/31/2022
1.1.11 797 10/31/2022
1.1.10 804 10/28/2022
1.1.9 799 10/26/2022
1.1.8 819 10/26/2022
1.1.7 861 10/25/2022
1.1.6 825 10/25/2022
1.1.5 832 10/25/2022
1.1.4 834 10/25/2022
1.1.3 874 10/19/2022
1.1.2 847 10/19/2022
1.1.1 860 10/19/2022
1.0.17 896 10/14/2022
1.0.16 855 10/14/2022
1.0.15 869 10/14/2022
1.0.14 877 10/14/2022
1.0.12 843 10/14/2022
1.0.11 1,341 2/24/2022
1.0.8 872 11/29/2021
1.0.7 862 10/12/2021
1.0.6 830 10/12/2021
1.0.5 840 10/8/2021
1.0.4 855 9/16/2021
1.0.3 818 9/16/2021
1.0.2 802 9/16/2021
1.0.1 1,059 6/18/2021
1.0.0 818 6/18/2021
0.5.4-beta-gbf669a996d 1,092 11/26/2020
0.5.4-beta-g9ece0e71be 856 10/23/2020
0.5.4-beta-g3c0cdfdeeb 741 11/26/2020
0.5.3-beta-gf90864d1d9 831 10/23/2020
0.5.3-beta-g859c56758b 861 9/24/2020
0.5.3-beta-g1fbff73a8c 824 10/23/2020
0.5.2-beta-gf1fe4f7d2a 889 9/17/2020
0.5.1-beta-g01069f6024 940 9/17/2020
0.5.0-beta-g919276409b 828 9/17/2020