Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/damienbod/blazor.bff.azuread.template
Blazor.BFF.AzureAD.Template, Blazor WASM hosted in ASP.NET Core using Microsoft Entra ID BFF (server authentication)
https://github.com/damienbod/blazor.bff.azuread.template
aad azuread blazor csp dotnet microsoftentraid microsoftidentity oauth2 oidc template
Last synced: 4 days ago
JSON representation
Blazor.BFF.AzureAD.Template, Blazor WASM hosted in ASP.NET Core using Microsoft Entra ID BFF (server authentication)
- Host: GitHub
- URL: https://github.com/damienbod/blazor.bff.azuread.template
- Owner: damienbod
- License: mit
- Created: 2021-11-29T19:12:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-03T16:10:03.000Z (9 months ago)
- Last Synced: 2024-04-26T08:03:59.277Z (6 months ago)
- Topics: aad, azuread, blazor, csp, dotnet, microsoftentraid, microsoftidentity, oauth2, oidc, template
- Language: CSS
- Homepage: https://www.nuget.org/packages/Blazor.BFF.AzureAD.Template/
- Size: 4.34 MB
- Stars: 74
- Watchers: 4
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README-NUGET.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Blazor.BFF.AzureAD.Template
[](https://github.com/damienbod/Blazor.BFF.AzureAD.Template/actions/workflows/dotnet.yml) [](https://www.nuget.org/packages/Blazor.BFF.AzureAD.Template/) [Change log](https://github.com/damienbod/Blazor.BFF.AzureAD.Template/blob/main/Changelog.md)
This template can be used to create a Blazor WASM application hosted in an ASP.NET Core Web app using Microsoft Entra ID and Microsoft.Identity.Web to authenticate using the BFF security architecture. (server authentication) This removes the tokens from the browser and uses cookies with each HTTP request, response. The template also adds the required security headers as best it can for a Blazor application.
## Features
- WASM hosted in ASP.NET Core 8
- BFF with Microsoft Entra ID using Microsoft.Identity.Web
- OAuth2 and OpenID Connect OIDC
- No tokens in the browser
- Microsoft Entra ID Continuous Access Evaluation CAE support
## Using the template
### install
```
dotnet new install Blazor.BFF.AzureAD.Template
```
### run
```
dotnet new blazorbffaad -n YourCompany.Bff
```
Use the `-n` or `--name` parameter to change the name of the output created. This string is also used to substitute the namespace name in the .cs file for the project.
## Setup after installation
Add the Microsoft Entra ID App registration settings
```
{
"AzureAd": {
"Instance": "https://login.microsoftonline.com/",
"Domain": "[Enter the domain of your tenant, e.g. contoso.onmicrosoft.com]",
"TenantId": "[Enter 'common', or 'organizations' or the Tenant Id (Obtained from the Azure portal. Select 'Endpoints' from the 'App registrations' blade and use the GUID in any of the URLs), e.g. da41245a5-11b3-996c-00a8-4d99re19f292]",
"ClientId": "[Enter the Client Id (Application ID obtained from the Azure portal), e.g. ba74781c2-53c2-442a-97c2-3d60re42f403]",
"ClientSecret": "[Copy the client secret added to the app from the Azure portal]",
"ClientCertificates": [
],
// the following is required to handle Continuous Access Evaluation challenges
"ClientCapabilities": [ "cp1" ],
"CallbackPath": "/signin-oidc"
},
```
Add the scopes for the downstream API if required
```
"DownstreamApi": {
"Scopes": "User.ReadBasic.All user.read"
},
```
### Use Continuous Access Evaluation CAE with a downstream API (access_token)
#### Azure app registration manifest
```json
"optionalClaims": {
"idToken": [],
"accessToken": [
{
"name": "xms_cc",
"source": null,
"essential": false,
"additionalProperties": []
}
],
"saml2Token": []
},
```
Any API call for the Blazor WASM could be implemented like this:
```
[HttpGet]
public async Task Get()
{
try
{
// Do logic which calls an API and throws claims challenge
// WebApiMsalUiRequiredException. The WWW-Authenticate header is set
// using the OpenID Connect standards and Signals spec.
}
catch (WebApiMsalUiRequiredException hex)
{
var claimChallenge = WwwAuthenticateParameters
.GetClaimChallengeFromResponseHeaders(hex.Headers);
return Unauthorized(claimChallenge);
}
}
```
The downstream API call could be implemented something like this:
```
public async Task CallApiAsync(string url)
{
var client = _clientFactory.CreateClient();
// ... add bearer token
var response = await client.GetAsync(url);
if (response.IsSuccessStatusCode)
{
var stream = await response.Content.ReadAsStreamAsync();
var payload = await JsonSerializer.DeserializeAsync(stream);
return payload;
}
// You can check the WWW-Authenticate header first, if it is a CAE challenge
throw new WebApiMsalUiRequiredException($"Error: {response.StatusCode}.", response);
}
```
### Use Continuous Access Evaluation CAE in a standalone app (id_token)
#### Azure app registration manifest
```json
"optionalClaims": {
"idToken": [
{
"name": "xms_cc",
"source": null,
"essential": false,
"additionalProperties": []
}
],
"accessToken": [],
"saml2Token": []
},
```
If using a CAE Authcontext in a standalone project, you only need to challenge against the claims in the application.
```
private readonly CaeClaimsChallengeService _caeClaimsChallengeService;
public AdminApiCallsController(CaeClaimsChallengeService caeClaimsChallengeService)
{
_caeClaimsChallengeService = caeClaimsChallengeService;
}
[HttpGet]
public IActionResult Get()
{
// if CAE claim missing in id token, the required claims challenge is returned
var claimsChallenge = _caeClaimsChallengeService
.CheckForRequiredAuthContextIdToken(AuthContextId.C1, HttpContext);
if (claimsChallenge != null)
{
return Unauthorized(claimsChallenge);
}
```
### uninstall
```
dotnet new uninstall Blazor.BFF.AzureAD.Template
```
## Credits, Used NuGet packages + ASP.NET Core 8.0 standard packages
- NetEscapades.AspNetCore.SecurityHeaders
## Links
https://github.com/AzureAD/microsoft-identity-web
https://damienbod.com/2022/04/20/implement-azure-ad-continuous-access-evaluation-in-an-asp-net-core-razor-page-app-using-a-web-api/