Hv.Sos100.SingleSignOn
1.0.1
See the version list below for details.
dotnet add package Hv.Sos100.SingleSignOn --version 1.0.1
NuGet\Install-Package Hv.Sos100.SingleSignOn -Version 1.0.1
<PackageReference Include="Hv.Sos100.SingleSignOn" Version="1.0.1" />
paket add Hv.Sos100.SingleSignOn --version 1.0.1
#r "nuget: Hv.Sos100.SingleSignOn, 1.0.1"
// Install Hv.Sos100.SingleSignOn as a Cake Addin
#addin nuget:?package=Hv.Sos100.SingleSignOn&version=1.0.1
// Install Hv.Sos100.SingleSignOn as a Cake Tool
#tool nuget:?package=Hv.Sos100.SingleSignOn&version=1.0.1
Guide for the use of Hv.Sos100.SingleSignOn
Installation
In the top menu of Visual Studio select Tools → NuGet Package Manager → Manage NuGet Packages for Solution.
Search for Hv.Sos100.SingleSignOn and install the latest version of the NuGet package.
Using Single Sign On (SSO)
The SSO system is used to manage user sessions and cookies. Used correctly the system will keep the user signed in even if they navigate between different domains and websites within the systems target. The system targets https or http localhost and all domains ending in .ei.hv.se.
[!IMPORTANT] All environments the SSO targets are kept seperate, so a user will not stay signed in if they nagivate from an
.ei.hv.sesite to alocalhostsite.
Prerequisites
- Add the using statement wherever you use code from the SSO
using Hv.Sos100.SingleSignOn;
- Add this code in
Program.cs
// Before var app = builder.Build();
builder.Services.AddScoped<AuthenticationService>();
builder.Services.AddSession();
// After var app = builder.Build();
app.UseSession();
Sessions & Cookies
The code is used in three main circumstances:
- When the user wants to start a new session
- When the user wants to resume an existing session
- When the user wants to end a session
If the user has never authenticated themselves (signed in) on their browser before or they signed out earlier, they will need to start a new session.
// Example of case where the CreateSession method is used. The user attempts to sign in and the html form directs here
// The user need to supply their username and password in the form
public async Task<IActionResult> Login(string username, string password)
{
// Create an instance of the authenticationservice, be careful not to mix it up with the native .NET AuthenticationService
var authenticationService = new AuthenticationService();
// Use the authenticationService object to call the CreateSession method and optionally store the result in a variable
// Make sure to supply the CreateSession method with the username, password and controllerBase:this, HttpContext
var authenticatedSession = await authenticationService.CreateSession(username, password, controllerBase:this, HttpContext);
// Depending on if the authentication was successfull the user can be directed to different pages
return authenticatedSession ? RedirectToAction("Index", "Home") : RedirectToAction("Privacy", "Home");
}
If the user has alredy authenticated themselves (signed in) on their browser, they can resume a previous session.
public async Task<IActionResult> Index()
{
// Create an instance of the authenticationservice, be careful not to mix it up with the native .NET AuthenticationService
var authenticationService = new AuthenticationService();
// Use the authenticationService object to call the ResumeSession method and optionally store the result in a variable
// The ResumeSession method does not need to be supplied with any user information as it checks the browser cookies for a valid token
var existingSession = await _authenticationService.ResumeSession(controllerBase:this, HttpContext);
return View();
}
Once the user has a session whether is was created or resumed, they will have session variables assigned which can be used by the application.
// Use the ReadSessionVariables method to get access to the user´s id as well as a IsAuthenticated string as a session variable
// You can then use these session variables in you html code to conditionally display information
// Or in your C# code to request data about the user from an api using the user´s id
authenticationService.ReadSessionVariables(controller: this, httpContext: HttpContext);
// Example of using session variables in html code
@{
var isAuthenticated = ViewData["IsAuthenticated"] as string;
var userId = ViewData["UserId"] as string;
}
<html>
<body>
@if (isAuthenticated != "true")
{
<h3>Please authenticate yourself to view the page</h3>
}
else
{
<h3>Welcome, @userId!</h3>
}
</body>
</html>
If the user wants to end their session and sign out all the data stored on their browser will be removed.
public IActionResult Logout()
{
// Create an instance of the authenticationservice, be careful not to mix it up with the native .NET AuthenticationService
var authenticationService = new AuthenticationService();
// Call the EndSession method to delete the cookie and end the user´s session
// This will force the user to authenticate themselves again if they want to have access
authenticationService.EndSession(controllerBase:this, HttpContext);
return RedirectToAction("Index", "Home");
}
| 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. |
-
net8.0
- Asp.Versioning.Mvc (>= 8.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.