SingPassAuth 1.0.0

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

// Install SingPassAuth as a Cake Tool
#tool nuget:?package=SingPassAuth&version=1.0.0                

SingPass .NET Authentication

The SingPass .NET Authentication project is an open-source and cross-platfrom implementation to provide Log in with SingPass authentication in .NET application.

Prerequisites

  1. You'll need to install NodeJS and add the NodeJS executable to the Path environment variable.
  2. You'll need to install npm package node-jose in the project folder.
  3. You'll need to perform SingPass onboarding process, where you will exchange following:
    • ClientJwks , share either your app JWKS urls or manually created JWKS. Please note that SingPass prefer EC key type. (Responsibility: You/Application Owner)
    • RedirectUrl, share one or more redirect urls for SingPass authentication. Default: /signin-singpass. (Responsibility: You/Application Owner)
    • ClientId , after the onboarding SingPass will provide ClientId. (Responsibility: SingPass)

Getting Started

  1. Install Package
    Using Package Manager:

    PM> Install-Package SingPassNetAuth
    

    Using .NET CLI:

    > dotnet add-package SingPassNetAuth
    
  2. Add Authentication in the Startup.cs

    public void ConfigureServices(IServiceCollection services)
    {
        ...other contents...
        // Refer to SingPass API documentation - https://stg-id.singpass.gov.sg/docs/authorization/api#_staging_and_production_urls
    
        services.AddAuthentication()
           .AddSingPass(options => {
                     options.Authority = "";
                     options.ClientId = "";
                     options.ClientJwks = "";
           })
    
       ...other contents...
    }
    
    

Target Frameworks

  • .NET Standard 2.0
  • .NET Core 3.1
  • .NET 5.0

Platforms

  • Windows
  • Linux

References

  1. Login with SingPass
  2. NDI Authentication Service Provider

How to Engage, Contribute, and Give Feedback

Need help or wanna share your thoughts? Don't hesitate to create issue, or pull request.

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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 374 12/19/2021
1.0.0 286 12/17/2021