⭐ Star us on GitHub - it motivates us a lot!

Table of Contents

• About the Getting Started
• About Abblix OIDC Server
• How to Build
• License
• Key Contacts & Resources

🚀 About the Getting Started

This repository contains all the necessary code from the Getting Started article on creating an OpenID Connect provider using ASP.NET MVC and our Abblix OIDC Server solution.

Before diving into this solution, make sure to review either the Getting Started Guide or the Practical Implementation of Modern Authentication on the .NET Platform: OpenID Connect, BFF and SPA. This solution includes projects that are implementations described in these guides, which provide detailed, step-by-step instructions to help you fully understand each project.

Important

This codebase is intended primarily for self-checks. We strongly recommend building the entire project from scratch to significantly enhance your understanding of these technologies.

Included projects

• OpenIDProviderApp
  The OpenIDProviderApp serves as the OpenID Connect provider within this project. Its primary responsibilities include authenticating users, managing their sessions, and issuing tokens in accordance with the OpenID Connect protocol. Specifically, it validates client requests and provides access and refresh tokens that authorize user resource access, as well as ID tokens that verify user identity. The application employs the Abblix OIDC Server solution to function effectively as an OpenID Connect protocol server. Additionally, the app is designed to handle various OAuth 2.0 flows, ensuring secure and compliant user authentication and authorization processes in modern web applications.

• AspNetIdentitySample
  The AspNetIdentitySample is the OpenIDProviderApp taken one step toward production: it replaces the in-memory demo user list with a real ASP.NET Core Identity user store backed by Entity Framework Core and SQLite. It demonstrates the two seams where Abblix OIDC Server meets an external user system. First, an IUserInfoProvider adapter over Identity's UserManager turns a subject identifier into claims. Second, a login flow that keeps responsibilities cleanly split: Identity verifies the password through CheckPasswordSignInAsync (password hashing, failed-attempt counting, and lockout), while the library's IAuthSessionService issues the OpenID Connect session cookie. The result is a provider whose users, credentials, and profile data live in a database rather than in code, while the protocol handling stays entirely with the library. Its sign-in and sign-up screens are a React and Tailwind SPA that talks to a JSON auth API, with the client's types generated from the server's OpenAPI document, so the same UI works over an MVC or a Minimal API host unchanged.

• TestClientApp
  The TestClientApp functions as the Relying Party, acting as a client that depends on the OpenIDProviderApp for user authentication. It demonstrates the interaction between a client application and an OpenID Connect provider, showing how users are authenticated, tokens are obtained, and protected resources are accessed. This scenario offers practical insight into integrating OpenID Connect authentication into client applications. The TestClientApp uses Microsoft.AspNetCore.Authentication.OpenIdConnect to operate as an OpenID Connect client, making it a practical example of real-world authentication in .NET environments.

• BffSample
  The BffSample implements the Backend-For-Frontend (BFF) architectural pattern for a React Single Page Application (built with Vite) served by a .NET backend. The backend is a confidential OpenID Connect client: it runs the authorization code flow with PKCE, keeps the resulting tokens in an encrypted, HttpOnly session cookie, and never exposes them to browser JavaScript. Requests from the SPA to protected APIs are proxied through the backend, which strips the session cookie and attaches the access token, so the browser holds a session reference rather than a bearer token. The sample follows the IETF draft-ietf-oauth-browser-based-apps BFF profile and pairs with ApiSample as the protected resource. It is the runnable counterpart to the Securing a React SPA with the BFF Pattern guide.

• BlazorSample
  The BlazorSample is a Blazor Web App (interactive Server render mode) acting as an OpenID Connect client of the OpenIDProviderApp. It shows the pattern that keeps Blazor and OIDC working together: the pages are rendered by Blazor, but sign-in and sign-out run on plain HTTP endpoints rather than inside an interactive circuit, because writing the authentication cookie and issuing the OIDC redirect both need the HTTP response. The sample uses Microsoft.AspNetCore.Authentication.OpenIdConnect with cookie sessions, the authorization code flow and PKCE.

• ApiSample
  The ApiSample demonstrates how to build a secure backend API that works in conjunction with an OpenID Connect provider to authenticate and authorize client requests. This sample illustrates the integration of security protocols like OAuth 2.0 and OpenID Connect into API development, ensuring that only authenticated and authorized users can access protected resources. The ApiSample serves as a practical guide for implementing secure APIs that comply with modern authentication standards, providing a robust foundation for securing backend services in a distributed web application architecture.

🛡️ About Abblix OIDC Server

Abblix OIDC Server is a .NET library designed to provide comprehensive support for OAuth2 and OpenID Connect on the server side. It adheres to high standards of flexibility, reusability, and reliability, utilizing well-known software design patterns, including modular and hexagonal architectures. These patterns ensure the following benefits:

• Modularity: Different parts of the library can function independently, enhancing the library's modularity and allowing for easier maintenance and updates.
• Testability: Improved separation of concerns makes the code more testable.
• Maintainability: Clear structure and separation facilitate better management of the codebase.

The library also supports Dependency Injection through the standard .NET DI container, aiding in the organization and management of code. Specifically tailored for seamless integration with ASP.NET WebApi, Abblix OIDC Server employs standard controller classes, binding, and routing mechanisms, simplifying the integration of OpenID Connect into your services.

🛠️ How to Build

Setting up your development environment for this project is straightforward. The following steps will guide you through cloning the repository, restoring dependencies, and building the project. This ensures that all necessary tools and libraries are properly configured for development.

# Ensure Git and .NET SDK are installed on your system
# Git is required for cloning the repository, and the .NET SDK is necessary for building the project.

# Clone the repository
git clone https://github.com/Abblix/Oidc.Server.GettingStarted.git

# Navigate to the project directory
cd Oidc.Server.GettingStarted

# Restore dependencies and build the project
# 'dotnet restore' downloads all the required .NET dependencies specified in the project file.
# 'dotnet build' compiles the project, making it ready for execution.
dotnet restore
dotnet build

🤝 Contributing

If you plan to send a pull request, set up local pre-commit hooks once:

pip install pre-commit
pre-commit install

After this, git commit automatically runs actionlint and a custom secrets-interpolation check on any change to .github/workflows/. The same checks run in CI as a backstop.

📃 License

This project is licensed under the Creative Commons Attribution 4.0 International License. You can review the full license text at the following link: CC BY 4.0 License.

🔗 Key Contacts & Resources

For more details about our products, services, or any general information regarding the Abblix OIDC Server, feel free to reach out to us. We are here to provide support and answer any questions you may have. Below are the best ways to contact our team:

• Email: Send us your inquiries or support requests at support@abblix.com.
• Website: Visit the official page for more information.
• GitHub Repository: Explore the source code and contribute to the Abblix OIDC Server.
• Abblix Documentation: Access detailed documentation for all our products and services.

We look forward to assisting you and ensuring your experience with our products is successful and enjoyable!

Back to top