SimpleW.Service.OpenID
26.0.0
dotnet add package SimpleW.Service.OpenID --version 26.0.0
NuGet\Install-Package SimpleW.Service.OpenID -Version 26.0.0
<PackageReference Include="SimpleW.Service.OpenID" Version="26.0.0" />
<PackageVersion Include="SimpleW.Service.OpenID" Version="26.0.0" />
<PackageReference Include="SimpleW.Service.OpenID" />
paket add SimpleW.Service.OpenID --version 26.0.0
#r "nuget: SimpleW.Service.OpenID, 26.0.0"
#:package SimpleW.Service.OpenID@26.0.0
#addin nuget:?package=SimpleW.Service.OpenID&version=26.0.0
#tool nuget:?package=SimpleW.Service.OpenID&version=26.0.0
SimpleW.Service.OpenID
Features
SimpleW.Service.OpenID is the convenience module built on top of SimpleW.Helper.OpenID.
It lets you:
- restore the principal automatically from the OpenID auth cookie
- challenge handlers decorated with
OpenIDAuthAttribute - map
login,callback, andlogoutroutes under a base path - reuse the same provider and cookie options as
OpenIDHelper
Getting Started
Minimal module usage with controller metadata:
using SimpleW;
using SimpleW.Service.OpenID;
var server = new SimpleWServer(System.Net.IPAddress.Any, 8080);
server.UseOpenIDModule(options => {
options.CookieSecure = false; // local HTTP development only
options.Add("google", provider => {
provider.Authority = "https://accounts.google.com";
provider.ClientId = "<google-client-id>";
provider.ClientSecret = "<google-client-secret>";
provider.RedirectUri = "http://127.0.0.1:8080/auth/oidc/callback/google";
});
});
server.MapController<AccountController>("/api");
await server.RunAsync();
[Route("/account")]
public class AccountController : Controller {
[AllowAnonymous]
[Route("GET", "/public")]
public object Public() {
return new {
login = "/auth/oidc/login/google?returnUrl=/api/account/me",
logout = "/auth/oidc/logout?returnUrl=/"
};
}
[OpenIDAuth("google")]
[Route("GET", "/me")]
public object Me() {
return new {
user = Principal.Name,
email = Principal.Email,
provider = Principal.Get("provider")
};
}
}
Routes automatically mapped by the module:
GET /auth/oidc/login/:providerGET /auth/oidc/callback/:providerGET /auth/oidc/logout
OpenIDModuleOptions inherits from OpenIDHelperOptions, so provider discovery, cookie behavior, token validation, and PrincipalFactory stay identical to the helper package.
Use this package when you want the OpenID plumbing and metadata-driven challenge behavior already wired.
Use SimpleW.Helper.OpenID directly when you want to keep full control over the middleware and technical routes.
Documentation
To check out docs, visit simplew.net.
Changelog
Detailed changes for each release are documented in the CHANGELOG.
Contribution
Feel free to report issue.
License
This library is under the MIT License.
| 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. net9.0 is compatible. 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 is compatible. 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. |
-
net10.0
- SimpleW (>= 26.0.0 && < 26.1.0)
- SimpleW.Helper.OpenID (>= 26.0.0 && < 26.1.0)
-
net8.0
- SimpleW (>= 26.0.0 && < 26.1.0)
- SimpleW.Helper.OpenID (>= 26.0.0 && < 26.1.0)
-
net9.0
- SimpleW (>= 26.0.0 && < 26.1.0)
- SimpleW.Helper.OpenID (>= 26.0.0 && < 26.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
