https://github.com/luismisanve/oauth_api

REST API with OAuth 2.0 using Built-in Identity Server | Client-themed Template Project
https://github.com/luismisanve/oauth_api

asp-net-core csharp jwt-token oauth2 rest-api visual-studio

Last synced: 3 days ago
JSON representation

REST API with OAuth 2.0 using Built-in Identity Server | Client-themed Template Project

• Host: GitHub
• URL: https://github.com/luismisanve/oauth_api
• Owner: LuisMiSanVe
• License: gpl-3.0
• Created: 2024-09-23T10:39:12.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-01T11:56:37.000Z (16 days ago)
• Last Synced: 2024-11-01T12:28:25.816Z (16 days ago)
• Topics: asp-net-core, csharp, jwt-token, oauth2, rest-api, visual-studio
• Language: C#
• Homepage:
• Size: 3.23 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> [See in spanish/Ver en español](https://github.com/LuisMiSanVe/OAuth_API/tree/spanish)

# 🔐 C# REST API with OAuth 2.0

It's an client-themed REST API Template with OAuth 2.0 implemented in a built-in Identity Server (as a class) with user hierarchy.

## 📝 OAuth 2.0 Explanation

OAuth 2.0 is an token-based authentication protocol. It's implementation consists in having an Authentication Server (OAuth Server) and a Resource Server.

As you can see in the image, the process is split in two, the green part would be the authentication part where the OAuth 2.0 protocol takes place and the orange one, where the authorization takes place.\



## 📖 About the project

This is a functional Template where you have 2 sections (controllers):

- Login: it contains the Login Endpoint, where you need to introduce your user credentials in order to get a session Token.

- Endpoints: it contains the rest of endpoints of the API, it only includes two, one can be executed with a non-admin account but the other one requires administrator permissions.

## 📂 Files

The main files of the project are:

- [Program.cs](https://github.com/LuisMiSanVe/OAuth_API/blob/main/OAuth_API/Program.cs): has the main configuration of the project and works as the Resource Server.

- [Users.cs](https://github.com/LuisMiSanVe/OAuth_API/blob/main/OAuth_API/Users.cs): provisional class that have declared the different users and it's permissions.

> [!WARNING]

> Users are hardcoded, is recomendable to replace it with an actual database of users.

- [Model/Client.cs](https://github.com/LuisMiSanVe/OAuth_API/blob/main/OAuth_API/Model/Client.cs): is the scheme or model of the object that our endpoint retrieve.

- [Controllers/EndpointsController.cs](https://github.com/LuisMiSanVe/OAuth_API/blob/main/OAuth_API/Controllers/EndpointsController.cs): It's the controller where the endspoints are contained.

- [Controllers/LoginController.cs](https://github.com/LuisMiSanVe/OAuth_API/blob/main/OAuth_API/Controllers/LoginController.cs): It's the controller where the Login endpoint is contained and works as the Authentication Server.

## 🚀 Project Usage Explanation

Using the image above as guiance, the green part, as I said earlier, is the authentication process, it happens when a client logs in successfully and gets an JWT Bearer-type Token.\

Meanwhile the orange part, the authorization process, ocurs when the client, already logged in, tries to access a endpoint, and if the token is valid, it returns the resources given by the endpoint.\

This repository is meant to be used as a template for your new securized REST API.

> This is a summary of the [Documentation](/RepositoryResources/Documentation.pdf) which includes a short guide.

## 🎨 Customization Options

A bunch of the Swashbuckle's Swagger customization options are included in the template.\

Such as having more than one Swagger Document, Custom names for Controllers and Endpoints, a searchbox and even custom CSS.\

The majority of these options can be changed in [OAuth_API/Program.cs](https://github.com/LuisMiSanVe/OAuth_API/blob/main/OAuth_API/Program.cs) on the `app.UseSwaggerUI(options =>` lambda expresion.\

In order to add custom files like images or style sheets, you'll need to place them in the special folder [wwwroot](https://github.com/LuisMiSanVe/OAuth_API/tree/main/OAuth_API/wwwroot). An empty .css file is already created.

> If you're only interested in the security configurations, use the [oauthonly](https://github.com/LuisMiSanVe/OAuth_API/tree/oauthonly) branch.

## 💻 Technologies used

- Programming Lenguage: [C#](https://dotnet.microsoft.com/en-us/languages/csharp)

- Framework: [ASP.NET Core](https://dotnet.microsoft.com/en-us/apps/aspnet) (Project made with [.Net](https://dotnet.microsoft.com/en-us/learn/dotnet/what-is-dotnet) 8.0 Framework)

- NuGets:

  - [Swashbuckle.AspNetCore](https://github.com/domaindrivendev/Swashbuckle.AspNetCore) (6.4.0)

  - [Swashbuckle.AspNetCore.Annotations](https://github.com/domaindrivendev/Swashbuckle.AspNetCore?tab=readme-ov-file#swashbuckleaspnetcoreannotations) (6.6.2)

  - [Microsoft.AspNetCore.authentication.JwtBearer](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.JwtBearer) (8.0.6)

- Other:

  - [OAuth 2.0](https://oauth.net/2/) (Protocol)

  - [JWT Bearer](https://jwt.io/introduction) (Token type)

- Recommended IDE: [Visual Studio](https://visualstudio.microsoft.com/) 2022