├── .github ├── FUNDING.yml └── workflows │ ├── build-solution.yml │ ├── release-extensions.yml │ └── release-proxy.yml ├── src ├── Smartersoft.Identity.Client.Assertion.Proxy │ ├── appsettings.Development.json │ ├── appsettings.json │ ├── Models │ │ ├── MsiRequest.cs │ │ ├── KeyVaultKeyTokenRequest.cs │ │ ├── TokenResponse.cs │ │ ├── KeyVaultCertificateInfoRequest.cs │ │ ├── LocalTokenRequest.cs │ │ ├── KeyVaultCertificateTokenRequest.cs │ │ ├── TokenRequest.cs │ │ └── MsiResponse.cs │ ├── Properties │ │ └── launchSettings.json │ ├── ConsoleStyle.cs │ ├── Smartersoft.Identity.Client.Assertion.Proxy.csproj │ ├── Program.cs │ ├── Controllers │ │ ├── TokenController.cs │ │ └── MsiController.cs │ └── wwwroot │ │ └── index.html └── Smartersoft.Identity.Client.Assertion │ ├── CertificateInfo.cs │ ├── Smartersoft.Identity.Client.Assertion.csproj │ ├── ConfidentialClientApplicationBuilderExtensions.cs │ └── ClientAssertionGenerator.cs ├── GitVersion.yml ├── .vscode ├── launch.json └── tasks.json ├── Smartersoft.Identity.Client.Assertion.sln ├── .pipeline.yml ├── .gitattributes ├── README.md ├── .gitignore ├── docs ├── Smartersoft.Identity.Client.Assertion.md └── Smartersoft.Identity.Client.Assertion.Proxy.md └── LICENSE.txt /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: svrooij 4 | custom: https://smartersoft.nl/ -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Warning", 7 | "Microsoft.AspNetCore.Server.Kestrel": "Critical", 8 | "Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware": "Information" 9 | } 10 | }, 11 | "AllowedHosts": "*" 12 | 13 | } 14 | -------------------------------------------------------------------------------- /GitVersion.yml: -------------------------------------------------------------------------------- 1 | assembly-versioning-scheme: MajorMinorPatch 2 | mode: Mainline 3 | branches: 4 | feature: 5 | tag: beta 6 | ignore: 7 | sha: [] 8 | major-version-bump-message: "^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?(!:|:.*\\n\\n((.+\\n)+\\n)?BREAKING CHANGE:\\s.+)" 9 | minor-version-bump-message: "^(feat)(\\([\\w\\s-]*\\))?:" 10 | patch-version-bump-message: "^(build|chore|ci|docs|fix|perf|refactor|revert|style|test)(\\([\\w\\s-]*\\))?:" -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/MsiRequest.cs: -------------------------------------------------------------------------------- 1 | using System.ComponentModel.DataAnnotations; 2 | 3 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 4 | { 5 | /// 6 | /// MSI request as if this would come from CloudShell 7 | /// 8 | public class MsiRequest 9 | { 10 | /// 11 | /// The resource you want to get a token for 12 | /// 13 | [Required(AllowEmptyStrings = false)] 14 | public required string Resource { get; set; } 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /.github/workflows/build-solution.yml: -------------------------------------------------------------------------------- 1 | name: Build solution 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | - feature/* 8 | pull_request: 9 | branches: 10 | - main 11 | 12 | jobs: 13 | build: 14 | 15 | env: 16 | BUILD_CONFIG: 'Release' 17 | SOLUTION: 'Smartersoft.Identity.Client.Assertion.sln' 18 | 19 | runs-on: ubuntu-latest 20 | 21 | steps: 22 | - uses: actions/checkout@v4 23 | 24 | - uses: actions/setup-dotnet@v4 25 | with: 26 | dotnet-version: '8.x' 27 | 28 | - name: Restore dependencies 29 | run: dotnet restore $SOLUTION 30 | 31 | - name: Build 32 | run: dotnet build $SOLUTION --configuration $BUILD_CONFIG --no-restore 33 | 34 | # - name: Run formatter 35 | # run: dotnet format $SOLUTION 36 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json.schemastore.org/launchsettings.json", 3 | "iisSettings": { 4 | "windowsAuthentication": false, 5 | "anonymousAuthentication": true, 6 | "iisExpress": { 7 | "applicationUrl": "http://localhost:24655", 8 | "sslPort": 0 9 | } 10 | }, 11 | "profiles": { 12 | "Smartersoft.Identity.Client.Assertion.Proxy": { 13 | "commandName": "Project", 14 | "launchBrowser": true, 15 | "launchUrl": "swagger", 16 | "environmentVariables": { 17 | "ASPNETCORE_ENVIRONMENT": "Development" 18 | }, 19 | "dotnetRunMessages": true 20 | }, 21 | "IIS Express": { 22 | "commandName": "IISExpress", 23 | "launchBrowser": true, 24 | "launchUrl": "swagger", 25 | "environmentVariables": { 26 | "ASPNETCORE_ENVIRONMENT": "Development" 27 | } 28 | } 29 | } 30 | } -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion/CertificateInfo.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Text; 4 | 5 | namespace Smartersoft.Identity.Client.Assertion 6 | { 7 | /// 8 | /// Info about a certificate stored in the KeyVault 9 | /// 10 | public class CertificateInfo 11 | { 12 | /// 13 | /// Name of the certificate 14 | /// 15 | public string? CertificateName { get; set; } 16 | 17 | /// 18 | /// Base64Url encoded hash of certificate, used in the client assertion 19 | /// 20 | public string? Kid { get; set; } 21 | 22 | /// 23 | /// KeyId of the private key, used for signing. 24 | /// 25 | public Uri? KeyId { get; set; } 26 | 27 | /// 28 | /// When does the certificate expire 29 | /// 30 | public DateTimeOffset? ExpiresOn { get; set; } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | { 8 | "name": ".NET Core Launch (web)", 9 | "type": "coreclr", 10 | "request": "launch", 11 | "preLaunchTask": "build", 12 | "program": "${workspaceFolder}/src/Smartersoft.Identity.Client.Assertion.Proxy/bin/Debug/net6.0/Smartersoft.Identity.Client.Assertion.Proxy.dll", 13 | "args": [], 14 | "cwd": "${workspaceFolder}/src/Smartersoft.Identity.Client.Assertion.Proxy", 15 | "stopAtEntry": false, 16 | "serverReadyAction": { 17 | "action": "openExternally", 18 | "pattern": "\\bNow listening on:\\s+(https?://\\S+)" 19 | }, 20 | "env": { 21 | "ASPNETCORE_ENVIRONMENT": "Development" 22 | }, 23 | "sourceFileMap": { 24 | "/Views": "${workspaceFolder}/Views" 25 | } 26 | }, 27 | { 28 | "name": ".NET Core Attach", 29 | "type": "coreclr", 30 | "request": "attach" 31 | } 32 | ] 33 | } 34 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "build", 6 | "command": "dotnet", 7 | "type": "process", 8 | "args": [ 9 | "build", 10 | "${workspaceFolder}/src/Smartersoft.Identity.Client.Assertion.Proxy/Smartersoft.Identity.Client.Assertion.Proxy.csproj", 11 | "/property:GenerateFullPaths=true", 12 | "/consoleloggerparameters:NoSummary" 13 | ], 14 | "problemMatcher": "$msCompile" 15 | }, 16 | { 17 | "label": "publish", 18 | "command": "dotnet", 19 | "type": "process", 20 | "args": [ 21 | "publish", 22 | "${workspaceFolder}/src/Smartersoft.Identity.Client.Assertion.Proxy/Smartersoft.Identity.Client.Assertion.Proxy.csproj", 23 | "/property:GenerateFullPaths=true", 24 | "/consoleloggerparameters:NoSummary" 25 | ], 26 | "problemMatcher": "$msCompile" 27 | }, 28 | { 29 | "label": "watch", 30 | "command": "dotnet", 31 | "type": "process", 32 | "args": [ 33 | "watch", 34 | "run", 35 | "--project", 36 | "${workspaceFolder}/src/Smartersoft.Identity.Client.Assertion.Proxy/Smartersoft.Identity.Client.Assertion.Proxy.csproj" 37 | ], 38 | "problemMatcher": "$msCompile" 39 | } 40 | ] 41 | } 42 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/KeyVaultKeyTokenRequest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | 3 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 4 | { 5 | /// 6 | /// Request an access token with a key in a KeyVault 7 | /// 8 | public class KeyVaultKeyTokenRequest : TokenRequest 9 | { 10 | /// 11 | /// The Uri of the Key to use, found in KeyId in the KeyVault 12 | /// 13 | public Uri? KeyUri { get; set; } 14 | 15 | /// 16 | /// Base64encoded hash of the certificate, use the proxy /api/token/kv-key-info endpoint to find 17 | /// 18 | public string? KeyThumbprint { get; set; } 19 | } 20 | 21 | /// 22 | /// KeyVaultKeyTokenRequestValidator 23 | /// 24 | public class KeyVaultKeyTokenRequestValidator : AbstractValidator 25 | { 26 | /// 27 | /// KeyVaultKeyTokenRequestValidator constructor 28 | /// 29 | public KeyVaultKeyTokenRequestValidator() 30 | { 31 | Include(new TokenRequestValidator()); 32 | RuleFor(r => r.KeyUri) 33 | .NotEmpty() 34 | .Must(v => v?.IsAbsoluteUri == true) 35 | .WithMessage("Only absolute Uris permitted"); 36 | RuleFor(r => r.KeyThumbprint) 37 | .NotEmpty() 38 | .NotEqual("string"); 39 | } 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/TokenResponse.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.Identity.Client; 2 | using System.Text.Json.Serialization; 3 | 4 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 5 | { 6 | /// 7 | /// Response containing the access token 8 | /// 9 | public class TokenResponse 10 | { 11 | /// 12 | /// Access token (this will always be a JWT) 13 | /// 14 | [JsonPropertyName("access_token")] 15 | public string? AccessToken { get; set; } 16 | /// 17 | /// Lifetime is not returned from Azure, use expires_on 18 | /// 19 | public int Lifetime { get; set; } 20 | 21 | /// 22 | /// When will the token expire, according to Azure 23 | /// 24 | [JsonPropertyName("expires_on")] 25 | public DateTimeOffset ExpiresOn { get; set; } 26 | 27 | /// 28 | /// Which scopes where requested in the token 29 | /// 30 | public IEnumerable? Scopes { get; set; } 31 | 32 | internal static TokenResponse FromAuthenticationResult(AuthenticationResult authenticationResult) 33 | { 34 | return new TokenResponse 35 | { 36 | AccessToken = authenticationResult.AccessToken, 37 | Lifetime = 3600, 38 | ExpiresOn = authenticationResult.ExpiresOn, 39 | Scopes = authenticationResult.Scopes, 40 | }; 41 | } 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/KeyVaultCertificateInfoRequest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | 3 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 4 | { 5 | /// 6 | /// Request the info for a certificate in a KeyVault 7 | /// 8 | public class KeyVaultCertificateInfoRequest 9 | { 10 | /// 11 | /// The Uri of your KeyVault hosting the certificate 12 | /// 13 | public Uri? KeyVaultUri { get; set; } 14 | /// 15 | /// Name of the certificate you wish to use 16 | /// 17 | public string? CertificateName { get; set; } 18 | 19 | /// 20 | /// Skip the cache and get the latest info 21 | /// 22 | public bool SkipCache { get; set; } 23 | } 24 | 25 | /// 26 | /// KeyVaultCertificateInfoRequestValidator 27 | /// 28 | public class KeyVaultCertificateInfoRequestValidator : AbstractValidator 29 | { 30 | /// 31 | /// KeyVaultCertificateInfoRequestValidator constructor 32 | /// 33 | public KeyVaultCertificateInfoRequestValidator() 34 | { 35 | RuleFor(r => r.CertificateName) 36 | .NotEmpty() 37 | .NotEqual("string"); 38 | RuleFor(r => r.KeyVaultUri) 39 | .NotEmpty() 40 | .Must(v => v?.IsAbsoluteUri == true) 41 | .WithMessage("Only absolute Uris permitted"); 42 | } 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/LocalTokenRequest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | using System.ComponentModel.DataAnnotations; 3 | using System.Security.Cryptography.X509Certificates; 4 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 5 | { 6 | /// 7 | /// Request an access token with a certificate in the local certificate store 8 | /// 9 | public class LocalTokenRequest : TokenRequest 10 | { 11 | /// 12 | /// How do you want to search for the certificate 13 | /// 14 | public X509FindType? FindType { get; set; } = X509FindType.FindByThumbprint; 15 | /// 16 | /// With what value do you wish to search for the certificate? 17 | /// 18 | [Required] 19 | public required object FindValue { get; set; } 20 | } 21 | 22 | /// 23 | /// LocalTokenRequestValidator 24 | /// 25 | public class LocalTokenRequestValidator : AbstractValidator 26 | { 27 | /// 28 | /// LocalTokenRequestValidator constructor 29 | /// 30 | public LocalTokenRequestValidator() 31 | { 32 | Include(new TokenRequestValidator()); 33 | RuleFor(r => r.FindType) 34 | .NotEmpty() 35 | .IsInEnum() 36 | .WithMessage("Just use the default `FindByThumbprint`"); 37 | RuleFor(r => r.FindValue) 38 | .NotEmpty() 39 | .NotEqual("string"); 40 | } 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/KeyVaultCertificateTokenRequest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | 3 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 4 | { 5 | /// 6 | /// Request an access token with a certificate in a KeyVault 7 | /// 8 | public class KeyVaultCertificateTokenRequest : TokenRequest 9 | { 10 | /// 11 | /// The Uri of your KeyVault hosting the certificate 12 | /// 13 | public Uri? KeyVaultUri { get; set; } 14 | 15 | /// 16 | /// Name of the certificate you wish to use 17 | /// 18 | public string? CertificateName { get; set; } 19 | 20 | /// 21 | /// Skip the cache for the certificate 22 | /// 23 | public bool SkipCache { get; set; } 24 | } 25 | 26 | /// 27 | /// KeyVaultCertificateTokenRequestValidator 28 | /// 29 | public class KeyVaultCertificateTokenRequestValidator : AbstractValidator 30 | { 31 | /// 32 | /// KeyVaultCertificateTokenRequestValidator constuctor 33 | /// 34 | public KeyVaultCertificateTokenRequestValidator() 35 | { 36 | Include(new TokenRequestValidator()); 37 | RuleFor(r => r.CertificateName) 38 | .NotEmpty() 39 | .NotEqual("string"); 40 | RuleFor(r => r.KeyVaultUri) 41 | .NotEmpty() 42 | .Must(v => v?.IsAbsoluteUri == true) 43 | .WithMessage("Only absolute Uris permitted"); 44 | } 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /.github/workflows/release-extensions.yml: -------------------------------------------------------------------------------- 1 | name: Release extensions 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | paths: 8 | - .github/workflows/release-extensions.yml 9 | - src/Smartersoft.Identity.Client.Assertion/**/*.cs 10 | - src/Smartersoft.Identity.Client.Assertion/*.csproj 11 | 12 | jobs: 13 | build-and-push: 14 | 15 | env: 16 | BUILD_CONFIG: 'Release' 17 | SOLUTION: 'Smartersoft.Identity.Client.Assertion.sln' 18 | PROJECT: 'src/Smartersoft.Identity.Client.Assertion/Smartersoft.Identity.Client.Assertion.csproj' 19 | 20 | runs-on: ubuntu-latest 21 | 22 | steps: 23 | - uses: actions/checkout@v4 24 | with: 25 | fetch-depth: 0 26 | 27 | - name: Install GitVersion 28 | uses: gittools/actions/gitversion/setup@v0.12.1 29 | with: 30 | versionSpec: '5.x' 31 | 32 | - name: Determine Version 33 | uses: gittools/actions/gitversion/execute@v0.12.1 34 | with: 35 | useConfigFile: true 36 | configFilePath: GitVersion.yml 37 | additionalArguments: /updateprojectfiles 38 | 39 | - uses: actions/setup-dotnet@v4 40 | with: 41 | dotnet-version: '8.x' 42 | 43 | - name: Restore dependencies 44 | run: dotnet restore $SOLUTION 45 | 46 | - name: Build solution 47 | run: dotnet build $SOLUTION --configuration $BUILD_CONFIG --no-restore 48 | 49 | - name: Create nuget package 50 | run: dotnet pack $PROJECT -c $BUILD_CONFIG --no-build --no-restore --output . 51 | 52 | - name: Push KeyVault proxy to NuGet 53 | run: dotnet nuget push *.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{secrets.NUGET_API_KEY}} --skip-duplicate 54 | -------------------------------------------------------------------------------- /.github/workflows/release-proxy.yml: -------------------------------------------------------------------------------- 1 | name: Release az-kv-proxy 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | paths: 8 | - .github/workflows/release-proxy.yml 9 | - src/Smartersoft.Identity.Client.Assertion/**/*.cs 10 | - src/Smartersoft.Identity.Client.Assertion.Proxy/**/*.cs 11 | - src/Smartersoft.Identity.Client.Assertion.Proxy/*.csproj 12 | 13 | jobs: 14 | build-and-push: 15 | 16 | env: 17 | BUILD_CONFIG: 'Release' 18 | SOLUTION: 'Smartersoft.Identity.Client.Assertion.sln' 19 | PROJECT: 'src/Smartersoft.Identity.Client.Assertion.Proxy/Smartersoft.Identity.Client.Assertion.Proxy.csproj' 20 | 21 | runs-on: ubuntu-latest 22 | 23 | steps: 24 | - uses: actions/checkout@v4 25 | with: 26 | fetch-depth: 0 27 | 28 | - name: Install GitVersion 29 | uses: gittools/actions/gitversion/setup@v0.12.1 30 | with: 31 | versionSpec: '5.x' 32 | 33 | - name: Determine Version 34 | uses: gittools/actions/gitversion/execute@v0.12.1 35 | with: 36 | useConfigFile: true 37 | configFilePath: GitVersion.yml 38 | additionalArguments: /updateprojectfiles 39 | 40 | - uses: actions/setup-dotnet@v4 41 | with: 42 | dotnet-version: '8.x' 43 | 44 | - name: Restore dependencies 45 | run: dotnet restore $SOLUTION 46 | 47 | - name: Build solution 48 | run: dotnet build $SOLUTION --configuration $BUILD_CONFIG --no-restore 49 | 50 | - name: Create nuget package 51 | run: dotnet pack $PROJECT -c $BUILD_CONFIG --no-build --no-restore --output . 52 | 53 | - name: Push KeyVault proxy to NuGet 54 | run: dotnet nuget push *.nupkg --source https://api.nuget.org/v3/index.json --api-key ${{secrets.NUGET_API_KEY}} --skip-duplicate 55 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/TokenRequest.cs: -------------------------------------------------------------------------------- 1 | using FluentValidation; 2 | 3 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 4 | { 5 | /// 6 | /// Base class for all token requests 7 | /// 8 | public class TokenRequest 9 | { 10 | /// 11 | /// Azure Client ID for you application (also called application id) 12 | /// 13 | public string? ClientId { get; set; } 14 | /// 15 | /// The ID of the Azure Tenant, needed in all requests with client credentials 16 | /// 17 | public string? TenantId { get; set; } 18 | /// 19 | /// For what scopes are you requesting a token 20 | /// 21 | /// Even though this is an array, you should only specify just one! 22 | public IEnumerable? Scopes { get; set; } 23 | } 24 | 25 | /// 26 | /// TokenRequestValidator 27 | /// 28 | public class TokenRequestValidator : AbstractValidator 29 | { 30 | /// 31 | /// TokenRequestValidator constructor 32 | /// 33 | public TokenRequestValidator() 34 | { 35 | RuleFor(r => r.ClientId) 36 | .NotEmpty() 37 | .Must(v => Guid.TryParse(v, out _)) 38 | .WithMessage("'{PropertyName}' must be a guid."); 39 | RuleFor(r => r.TenantId) 40 | .NotEmpty() 41 | .Must(v => Guid.TryParse(v, out _)) 42 | .WithMessage("'{PropertyName}' must be a guid."); 43 | RuleFor(r => r.Scopes) 44 | .NotEmpty() 45 | .Must(v => !v!.Any(s => s == "string")) 46 | .WithMessage("'string' is not a valid scope."); 47 | } 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/ConsoleStyle.cs: -------------------------------------------------------------------------------- 1 | 2 | using System.Reflection; 3 | 4 | internal static class ConsoleStyle 5 | { 6 | private const string Header = @" 7 | _______ _______ _ _______ _______ _______ 8 | ( ___ )/ ___ ) | \ /\|\ /| ( ____ )( ____ )( ___ )|\ /||\ /| 9 | | ( ) |\/ ) | | \ / /| ) ( | | ( )|| ( )|| ( ) |( \ / )( \ / ) 10 | | (___) | / )_____ | (_/ / | | | | _____ | (____)|| (____)|| | | | \ (_) / \ (_) / 11 | | ___ | / /(_____)| _ ( ( ( ) )(_____)| _____)| __)| | | | ) _ ( \ / 12 | | ( ) | / / | ( \ \ \ \_/ / | ( | (\ ( | | | | / ( ) \ ) ( 13 | | ) ( | / (_/\ | / \ \ \ / | ) | ) \ \__| (___) |( / \ ) | | 14 | |/ \|(_______/ |_/ \/ \_/ |/ |/ \__/(_______)|/ \| \_/ 15 | 16 | "; 17 | public static void WriteHeader(int port = 5616) 18 | { 19 | Console.WriteLine(Header); 20 | Console.WriteLine("##############################################################"); 21 | Console.WriteLine("#"); 22 | Console.WriteLine("# command: az-kv-proxy"); 23 | Console.WriteLine("# version: {0}", Assembly.GetExecutingAssembly()?.GetName()?.Version?.ToString()); 24 | Console.WriteLine("#"); 25 | Console.WriteLine("# Repository: https://github.com/Smartersoft/identity-client-assertion"); 26 | Console.WriteLine("# Documentation: http://localhost:{0}/swagger/index.html", port); 27 | Console.WriteLine("#"); 28 | Console.WriteLine("# dotnet tool update --global Smartersoft.Identity.Client.Assertion.Proxy"); 29 | Console.WriteLine("#"); 30 | Console.WriteLine("#################### CTRL + C to Exit #################"); 31 | } 32 | } 33 | 34 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion/Smartersoft.Identity.Client.Assertion.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | netstandard2.0 4 | false 5 | enable 6 | 8.0 7 | Smartersoft B.V.,Stephan van Rooij 8 | Smartersoft B.V. 9 | README.md 10 | 2022 11 | true 12 | True 13 | LICENSE.txt 14 | git 15 | https://github.com/Smartersoft/identity-client-assertion 16 | Using MSAL ConfidentialClientApplicationBuilder with certificate stored in the KeyVault 17 | https://github.com/Smartersoft/identity-client-assertion.git 18 | MSAL;ConfidentialClientApplicationBuilder;KeyVault;Managed Identity 19 | 20 | 21 | 1701;1702;CS8616 22 | 23 | 24 | 1701;1702;CS8616;CS1591;CS8604 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Smartersoft.Identity.Client.Assertion.Proxy.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | net8.0 4 | enable 5 | enable 6 | Smartersoft B.V.,Stephan van Rooij 7 | Smartersoft B.V. 8 | README.md 9 | 2022 10 | true 11 | True 12 | LICENSE.txt 13 | git 14 | https://github.com/Smartersoft/identity-client-assertion 15 | Token endpoints using certificates, to be used during development to not expose certificates on dev machines 16 | https://github.com/Smartersoft/identity-client-assertion.git 17 | Managed Identity;Postman;Insomnia 18 | true 19 | az-kv-proxy 20 | true 21 | 22 | 23 | 1701;1702;CS8616 24 | 25 | 26 | 1701;1702;CS8616;CS1591;CS8604;CS8602 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | Always 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /Smartersoft.Identity.Client.Assertion.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.0.31919.166 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Smartersoft.Identity.Client.Assertion", "src\Smartersoft.Identity.Client.Assertion\Smartersoft.Identity.Client.Assertion.csproj", "{2AD955AA-91C5-484E-89FC-25C68A083FD1}" 7 | EndProject 8 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Deploy", "Deploy", "{1CA888C2-89BC-4DA4-A9FB-885673089C2A}" 9 | ProjectSection(SolutionItems) = preProject 10 | .pipeline.yml = .pipeline.yml 11 | .github\workflows\build-solution.yml = .github\workflows\build-solution.yml 12 | GitVersion.yml = GitVersion.yml 13 | .github\workflows\release-extensions.yml = .github\workflows\release-extensions.yml 14 | .github\workflows\release-proxy.yml = .github\workflows\release-proxy.yml 15 | EndProjectSection 16 | EndProject 17 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Smartersoft.Identity.Client.Assertion.Proxy", "src\Smartersoft.Identity.Client.Assertion.Proxy\Smartersoft.Identity.Client.Assertion.Proxy.csproj", "{75387092-CA7A-413F-AADC-4033C44CEACA}" 18 | EndProject 19 | Global 20 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 21 | Debug|Any CPU = Debug|Any CPU 22 | Release|Any CPU = Release|Any CPU 23 | EndGlobalSection 24 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 25 | {2AD955AA-91C5-484E-89FC-25C68A083FD1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 26 | {2AD955AA-91C5-484E-89FC-25C68A083FD1}.Debug|Any CPU.Build.0 = Debug|Any CPU 27 | {2AD955AA-91C5-484E-89FC-25C68A083FD1}.Release|Any CPU.ActiveCfg = Release|Any CPU 28 | {2AD955AA-91C5-484E-89FC-25C68A083FD1}.Release|Any CPU.Build.0 = Release|Any CPU 29 | {75387092-CA7A-413F-AADC-4033C44CEACA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 30 | {75387092-CA7A-413F-AADC-4033C44CEACA}.Debug|Any CPU.Build.0 = Debug|Any CPU 31 | {75387092-CA7A-413F-AADC-4033C44CEACA}.Release|Any CPU.ActiveCfg = Release|Any CPU 32 | {75387092-CA7A-413F-AADC-4033C44CEACA}.Release|Any CPU.Build.0 = Release|Any CPU 33 | EndGlobalSection 34 | GlobalSection(SolutionProperties) = preSolution 35 | HideSolutionNode = FALSE 36 | EndGlobalSection 37 | GlobalSection(ExtensibilityGlobals) = postSolution 38 | SolutionGuid = {C5EFA826-7A96-4B4D-8C89-09389B7D77D5} 39 | EndGlobalSection 40 | EndGlobal 41 | -------------------------------------------------------------------------------- /.pipeline.yml: -------------------------------------------------------------------------------- 1 | trigger: 2 | branches: 3 | include: 4 | - master 5 | - main 6 | - beta 7 | 8 | pool: 9 | vmImage: 'ubuntu-latest' 10 | 11 | variables: 12 | project: './src/Smartersoft.Identity.Client.Assertion/Smartersoft.Identity.Client.Assertion.csproj' 13 | proxyProject: './src/Smartersoft.Identity.Client.Assertion.Proxy/Smartersoft.Identity.Client.Assertion.Proxy.csproj' 14 | testProject: '**/*.Tests.csproj' 15 | buildPlatform: 'Any CPU' 16 | buildConfiguration: 'Release' 17 | 18 | steps: 19 | - task: gitversion/setup@0 20 | displayName: Install GitVersion 21 | inputs: 22 | versionSpec: '5.x' 23 | 24 | - task: gitversion/execute@0 25 | displayName: Determine Version 26 | inputs: 27 | useConfigFile: true 28 | configFilePath: './GitVersion.yml' 29 | 30 | - task: UseDotNet@2 31 | inputs: 32 | packageType: 'sdk' 33 | version: '8.x' 34 | 35 | - task: DotNetCoreCLI@2 36 | displayName: Restore dependencies library 37 | inputs: 38 | command: 'restore' 39 | verbosityRestore: 'Minimal' 40 | projects: | 41 | $(project) 42 | arguments: '/p:Version=$(GitVersion.NuGetVersionV2)' 43 | versioningScheme: byBuildNumber 44 | 45 | - task: DotNetCoreCLI@2 46 | displayName: Build library 47 | inputs: 48 | projects: '$(project)' 49 | arguments: '--configuration $(BuildConfiguration) /p:Version=$(GitVersion.NuGetVersionV2) --no-restore' 50 | 51 | - task: DotNetCoreCLI@2 52 | displayName: Restore dependencies proxy 53 | inputs: 54 | command: 'restore' 55 | verbosityRestore: 'Minimal' 56 | projects: | 57 | $(proxyProject) 58 | arguments: '/p:Version=$(GitVersion.NuGetVersionV2)' 59 | versioningScheme: byBuildNumber 60 | 61 | - task: DotNetCoreCLI@2 62 | displayName: Build proxy 63 | inputs: 64 | projects: '$(proxyProject)' 65 | arguments: '--configuration $(BuildConfiguration) /p:Version=$(GitVersion.NuGetVersionV2) --no-restore' 66 | 67 | - task: DotNetCoreCLI@2 68 | displayName: Package library and proxy 69 | inputs: 70 | command: pack 71 | nobuild: true 72 | includesymbols: false 73 | versioningScheme: byEnvVar 74 | versionEnvVar: GitVersion.NugetVersionV2 75 | 76 | - task: DotNetCoreCLI@2 77 | displayName: 'Nuget publish' 78 | inputs: 79 | command: 'push' 80 | packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg' 81 | nuGetFeedType: 'internal' 82 | publishVstsFeed: '2e414348-7aa7-4750-8681-c91e163fec25' 83 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | ############################################################################### 2 | # Set default behavior to automatically normalize line endings. 3 | ############################################################################### 4 | * text=auto 5 | 6 | ############################################################################### 7 | # Set default behavior for command prompt diff. 8 | # 9 | # This is need for earlier builds of msysgit that does not have it on by 10 | # default for csharp files. 11 | # Note: This is only used by command line 12 | ############################################################################### 13 | #*.cs diff=csharp 14 | 15 | ############################################################################### 16 | # Set the merge driver for project and solution files 17 | # 18 | # Merging from the command prompt will add diff markers to the files if there 19 | # are conflicts (Merging from VS is not affected by the settings below, in VS 20 | # the diff markers are never inserted). Diff markers may cause the following 21 | # file extensions to fail to load in VS. An alternative would be to treat 22 | # these files as binary and thus will always conflict and require user 23 | # intervention with every merge. To do so, just uncomment the entries below 24 | ############################################################################### 25 | #*.sln merge=binary 26 | #*.csproj merge=binary 27 | #*.vbproj merge=binary 28 | #*.vcxproj merge=binary 29 | #*.vcproj merge=binary 30 | #*.dbproj merge=binary 31 | #*.fsproj merge=binary 32 | #*.lsproj merge=binary 33 | #*.wixproj merge=binary 34 | #*.modelproj merge=binary 35 | #*.sqlproj merge=binary 36 | #*.wwaproj merge=binary 37 | 38 | ############################################################################### 39 | # behavior for image files 40 | # 41 | # image files are treated as binary by default. 42 | ############################################################################### 43 | #*.jpg binary 44 | #*.png binary 45 | #*.gif binary 46 | 47 | ############################################################################### 48 | # diff behavior for common document formats 49 | # 50 | # Convert binary document formats to text before diffing them. This feature 51 | # is only available from the command line. Turn it on by uncommenting the 52 | # entries below. 53 | ############################################################################### 54 | #*.doc diff=astextplain 55 | #*.DOC diff=astextplain 56 | #*.docx diff=astextplain 57 | #*.DOCX diff=astextplain 58 | #*.dot diff=astextplain 59 | #*.DOT diff=astextplain 60 | #*.pdf diff=astextplain 61 | #*.PDF diff=astextplain 62 | #*.rtf diff=astextplain 63 | #*.RTF diff=astextplain 64 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Models/MsiResponse.cs: -------------------------------------------------------------------------------- 1 | using System.Text.Json.Serialization; 2 | 3 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Models 4 | { 5 | /// 6 | /// MsiResponse that apparantly all managed identity endpoints return 7 | /// 8 | public record MsiResponse 9 | { 10 | /// 11 | /// Access token for the resource 12 | /// 13 | [JsonPropertyName("access_token")] 14 | public required string AccessToken { get; init; } 15 | 16 | /// 17 | /// Refresh token 18 | /// 19 | [JsonPropertyName("refresh_token")] 20 | public string? RefreshToken { get; init; } = string.Empty; 21 | 22 | /// 23 | /// Time in seconds until the token expires 24 | /// 25 | [JsonPropertyName("expires_in")] 26 | public required int ExpiresIn { get; init; } 27 | 28 | /// 29 | /// Unix timestamp when the token expires 30 | /// 31 | [JsonPropertyName("expires_on")] 32 | 33 | public required int ExpiresOn { get; init; } 34 | 35 | /// 36 | /// Unix timestamp when the token is valid from 37 | /// 38 | [JsonPropertyName("not_before")] 39 | 40 | public required int NotBefore { get; init; } 41 | 42 | /// 43 | /// Resource for which the token is valid 44 | /// 45 | [JsonPropertyName("resource")] 46 | public required string Resource { get; init; } 47 | 48 | /// 49 | /// Token type 50 | /// 51 | /// Will always return `Bearer`? 52 | [JsonPropertyName("token_type")] 53 | public string TokenType { get; init; } = "Bearer"; 54 | 55 | internal static MsiResponse FromAzureAccessToken(Azure.Core.AccessToken token, string resource) => new MsiResponse 56 | { 57 | AccessToken = token.Token, 58 | ExpiresIn = (int)token.ExpiresOn.Subtract(DateTimeOffset.UtcNow).TotalSeconds, 59 | ExpiresOn = (int)token.ExpiresOn.ToUnixTimeSeconds(), 60 | NotBefore = (int)DateTimeOffset.UtcNow.ToUnixTimeSeconds(), 61 | Resource = resource, 62 | }; 63 | 64 | internal static MsiResponse FromAuthenticationResult(Microsoft.Identity.Client.AuthenticationResult authenticationResult, string resource) => new MsiResponse 65 | { 66 | AccessToken = authenticationResult.AccessToken, 67 | ExpiresIn = (int)authenticationResult.ExpiresOn.Subtract(DateTimeOffset.UtcNow).TotalSeconds, 68 | ExpiresOn = (int)authenticationResult.ExpiresOn.ToUnixTimeSeconds(), 69 | NotBefore = (int)DateTimeOffset.UtcNow.ToUnixTimeSeconds(), 70 | Resource = resource, 71 | }; 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Program.cs: -------------------------------------------------------------------------------- 1 | using Azure.Core; 2 | using Azure.Identity; 3 | using FluentValidation; 4 | using FluentValidation.AspNetCore; 5 | using System.Reflection; 6 | using System.Text.Json.Serialization; 7 | 8 | var portIndex = Array.IndexOf(args, "--port"); 9 | int port = portIndex > -1 && args.Length > portIndex + 1 && int.TryParse(args[portIndex + 1], out int p) ? p : 5616; 10 | 11 | ConsoleStyle.WriteHeader(port); 12 | 13 | var builder = WebApplication.CreateBuilder(args); 14 | 15 | // Add services to the container. 16 | 17 | builder.Services.AddMemoryCache(); 18 | 19 | builder.Services.AddSingleton(new DefaultAzureCredential( 20 | new DefaultAzureCredentialOptions 21 | { 22 | AdditionallyAllowedTenants = { "*" }, // Allow all tenants 23 | ExcludeEnvironmentCredential = true, // Don't use environment variables (even interactive is better) 24 | ExcludeInteractiveBrowserCredential = false, 25 | ExcludeManagedIdentityCredential = true, // Don't run this api in production! 26 | } 27 | )); 28 | 29 | builder.Services.AddControllers() 30 | .AddJsonOptions(x => 31 | { 32 | // serialize enums as strings in api responses (e.g. Role) 33 | x.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()); 34 | }); 35 | 36 | builder.Services 37 | .AddValidatorsFromAssemblyContaining() 38 | .AddFluentValidationAutoValidation() 39 | .AddFluentValidationClientsideAdapters(); 40 | 41 | // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle 42 | builder.Services.AddEndpointsApiExplorer(); 43 | builder.Services.AddSwaggerGen(swagger => 44 | { 45 | swagger.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo 46 | { 47 | Version = Assembly.GetExecutingAssembly()?.GetName()?.Version?.ToString() ?? "v1", 48 | Title = "Smartersoft KeyVault proxy", 49 | Description = "Sort your certificates securly in Azure and use this proxy to request a token using it.", 50 | Contact = new Microsoft.OpenApi.Models.OpenApiContact 51 | { 52 | Name = "Smartersoft B.V. repository", 53 | Url = new Uri("https://github.com/Smartersoft/identity-client-assertion") 54 | }, 55 | License = new Microsoft.OpenApi.Models.OpenApiLicense 56 | { 57 | Name = "Open source licence GPL-3.0", 58 | Url = new Uri("https://github.com/Smartersoft/identity-client-assertion/blob/main/LICENSE.txt") 59 | }, 60 | }); 61 | var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; 62 | swagger.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename)); 63 | }); 64 | 65 | builder.Environment.ContentRootPath = Path.GetDirectoryName(System.Diagnostics.Process.GetCurrentProcess().MainModule!.FileName)!; 66 | builder.Environment.WebRootPath = Path.Combine(builder.Environment.ContentRootPath!, "wwwroot"); 67 | 68 | var app = builder.Build(); 69 | 70 | // Configure the HTTP request pipeline. 71 | if (true || app.Environment.IsDevelopment()) 72 | { 73 | app.UseSwagger(); 74 | app.UseSwaggerUI(); 75 | } 76 | 77 | //app.UseAuthorization(); 78 | app.UseDefaultFiles(); 79 | app.UseStaticFiles(); 80 | app.MapControllers(); 81 | 82 | app.Run($"http://localhost:{port}/"); 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Smartersoft.Identity.Client.Assertion 2 | 3 | This package allows you to use [Managed Identities](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview?wt.mc_id=SEC-MVP-5004985) 4 | with a multi tenant application. Your certificates used for getting access tokens with the **Client Credential** flow will be completely protected and can **NEVER** be extracted, not even by yourself. 5 | 6 | Managed Identities are great but they [don't support multi-tenant use cases](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/managed-identities-faq?wt.mc_id=SEC-MVP-5004985#can-i-use-a-managed-identity-to-access-a-resource-in-a-different-directorytenant), until now. 7 | 8 | This library is created by [Smartersoft B.V.](https://smartersoft.nl) and [licensed][link_license] as **GPL-3.0-only**. 9 | 10 | ## Smartersoft.Identity.Client.Assertion 11 | 12 | [![Nuget package][badge_nuget]][link_nuget] 13 | [![License][badge_license]][link_license] 14 | [![Source link][badge_source]][link_source] 15 | [![GitHub issues][badge_issues]][link_issues] 16 | [![GitHub Sponsors][badge_sponsor]][link_sponsor] 17 | 18 | [Smartersoft.Identity.Client.Assertion](docs/Smartersoft.Identity.Client.Assertion.md) has some useful extensions for the [ConfidentialClientApplicationBuilder](https://docs.microsoft.com/azure/active-directory/develop/msal-net-initializing-client-applications?wt.mc_id=SEC-MVP-5004985#initializing-a-confidential-client-application-from-code) 19 | 20 | ## Smartersoft.Identity.Client.Assertion.Proxy 21 | 22 | [![Nuget package][badge_nuget_proxy]][link_nuget_proxy] 23 | [![License][badge_license]][link_license] 24 | [![Source link][badge_source]][link_source] 25 | [![GitHub issues][badge_issues]][link_issues] 26 | [![GitHub Sponsors][badge_sponsor]][link_sponsor] 27 | 28 | [Smartersoft.Identity.Client.Assertion.Proxy](docs/Smartersoft.Identity.Client.Assertion.Proxy.md) is a small api you can run on your local machine to use certificates stored in the KeyVault (or local certificate store) to secure your client credentials during development. 29 | 30 | ## License 31 | 32 | These packages are [licensed][link_license] under `GPL-3.0`, if you wish to use this software under a different license. Or you feel that this really helped in your commercial application and wish to support us? You can [get in touch](https://smartersoft.nl/#contact) and we can talk terms. We are available as consultants. 33 | 34 | [badge_issues]: https://img.shields.io/github/issues/Smartersoft/identity-client-assertion?style=for-the-badge 35 | [badge_license]: https://img.shields.io/github/license/Smartersoft/identity-client-assertion?style=for-the-badge 36 | [badge_nuget_proxy]: https://img.shields.io/nuget/v/Smartersoft.Identity.Client.Assertion.Proxy?logoColor=00a880&style=for-the-badge 37 | [badge_nuget]: https://img.shields.io/nuget/v/Smartersoft.Identity.Client.Assertion?logoColor=00a880&style=for-the-badge 38 | [badge_source]: https://img.shields.io/badge/Source-Github-green?style=for-the-badge 39 | [badge_sponsor]: https://img.shields.io/github/sponsors/svrooij?label=Github%20Sponsors&style=for-the-badge 40 | 41 | [link_issues]: https://github.com/Smartersoft/identity-client-assertion/issues 42 | [link_license]: https://github.com/Smartersoft/identity-client-assertion/blob/main/LICENSE.txt 43 | [link_nuget_proxy]: https://www.nuget.org/packages/Smartersoft.Identity.Client.Assertion.Proxy/ 44 | [link_nuget]: https://www.nuget.org/packages/Smartersoft.Identity.Client.Assertion/ 45 | [link_source]: https://github.com/Smartersoft/identity-client-assertion/ 46 | [link_sponsor]: https://github.com/sponsors/svrooij/ -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Oo]ut/ 33 | [Ll]og/ 34 | [Ll]ogs/ 35 | 36 | # Visual Studio 2015/2017 cache/options directory 37 | .vs/ 38 | # Uncomment if you have tasks that create the project's static files in wwwroot 39 | #wwwroot/ 40 | 41 | # Visual Studio 2017 auto generated files 42 | Generated\ Files/ 43 | 44 | # MSTest test Results 45 | [Tt]est[Rr]esult*/ 46 | [Bb]uild[Ll]og.* 47 | 48 | # NUnit 49 | *.VisualState.xml 50 | TestResult.xml 51 | nunit-*.xml 52 | 53 | # Build Results of an ATL Project 54 | [Dd]ebugPS/ 55 | [Rr]eleasePS/ 56 | dlldata.c 57 | 58 | # Benchmark Results 59 | BenchmarkDotNet.Artifacts/ 60 | 61 | # .NET Core 62 | project.lock.json 63 | project.fragment.lock.json 64 | artifacts/ 65 | 66 | # ASP.NET Scaffolding 67 | ScaffoldingReadMe.txt 68 | 69 | # StyleCop 70 | StyleCopReport.xml 71 | 72 | # Files built by Visual Studio 73 | *_i.c 74 | *_p.c 75 | *_h.h 76 | *.ilk 77 | *.meta 78 | *.obj 79 | *.iobj 80 | *.pch 81 | *.pdb 82 | *.ipdb 83 | *.pgc 84 | *.pgd 85 | *.rsp 86 | *.sbr 87 | *.tlb 88 | *.tli 89 | *.tlh 90 | *.tmp 91 | *.tmp_proj 92 | *_wpftmp.csproj 93 | *.log 94 | *.vspscc 95 | *.vssscc 96 | .builds 97 | *.pidb 98 | *.svclog 99 | *.scc 100 | 101 | # Chutzpah Test files 102 | _Chutzpah* 103 | 104 | # Visual C++ cache files 105 | ipch/ 106 | *.aps 107 | *.ncb 108 | *.opendb 109 | *.opensdf 110 | *.sdf 111 | *.cachefile 112 | *.VC.db 113 | *.VC.VC.opendb 114 | 115 | # Visual Studio profiler 116 | *.psess 117 | *.vsp 118 | *.vspx 119 | *.sap 120 | 121 | # Visual Studio Trace Files 122 | *.e2e 123 | 124 | # TFS 2012 Local Workspace 125 | $tf/ 126 | 127 | # Guidance Automation Toolkit 128 | *.gpState 129 | 130 | # ReSharper is a .NET coding add-in 131 | _ReSharper*/ 132 | *.[Rr]e[Ss]harper 133 | *.DotSettings.user 134 | 135 | # TeamCity is a build add-in 136 | _TeamCity* 137 | 138 | # DotCover is a Code Coverage Tool 139 | *.dotCover 140 | 141 | # AxoCover is a Code Coverage Tool 142 | .axoCover/* 143 | !.axoCover/settings.json 144 | 145 | # Coverlet is a free, cross platform Code Coverage Tool 146 | coverage*.json 147 | coverage*.xml 148 | coverage*.info 149 | 150 | # Visual Studio code coverage results 151 | *.coverage 152 | *.coveragexml 153 | 154 | # NCrunch 155 | _NCrunch_* 156 | .*crunch*.local.xml 157 | nCrunchTemp_* 158 | 159 | # MightyMoose 160 | *.mm.* 161 | AutoTest.Net/ 162 | 163 | # Web workbench (sass) 164 | .sass-cache/ 165 | 166 | # Installshield output folder 167 | [Ee]xpress/ 168 | 169 | # DocProject is a documentation generator add-in 170 | DocProject/buildhelp/ 171 | DocProject/Help/*.HxT 172 | DocProject/Help/*.HxC 173 | DocProject/Help/*.hhc 174 | DocProject/Help/*.hhk 175 | DocProject/Help/*.hhp 176 | DocProject/Help/Html2 177 | DocProject/Help/html 178 | 179 | # Click-Once directory 180 | publish/ 181 | 182 | # Publish Web Output 183 | *.[Pp]ublish.xml 184 | *.azurePubxml 185 | # Note: Comment the next line if you want to checkin your web deploy settings, 186 | # but database connection strings (with potential passwords) will be unencrypted 187 | *.pubxml 188 | *.publishproj 189 | 190 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 191 | # checkin your Azure Web App publish settings, but sensitive information contained 192 | # in these scripts will be unencrypted 193 | PublishScripts/ 194 | 195 | # NuGet Packages 196 | *.nupkg 197 | # NuGet Symbol Packages 198 | *.snupkg 199 | # The packages folder can be ignored because of Package Restore 200 | **/[Pp]ackages/* 201 | # except build/, which is used as an MSBuild target. 202 | !**/[Pp]ackages/build/ 203 | # Uncomment if necessary however generally it will be regenerated when needed 204 | #!**/[Pp]ackages/repositories.config 205 | # NuGet v3's project.json files produces more ignorable files 206 | *.nuget.props 207 | *.nuget.targets 208 | 209 | # Microsoft Azure Build Output 210 | csx/ 211 | *.build.csdef 212 | 213 | # Microsoft Azure Emulator 214 | ecf/ 215 | rcf/ 216 | 217 | # Windows Store app package directories and files 218 | AppPackages/ 219 | BundleArtifacts/ 220 | Package.StoreAssociation.xml 221 | _pkginfo.txt 222 | *.appx 223 | *.appxbundle 224 | *.appxupload 225 | 226 | # Visual Studio cache files 227 | # files ending in .cache can be ignored 228 | *.[Cc]ache 229 | # but keep track of directories ending in .cache 230 | !?*.[Cc]ache/ 231 | 232 | # Others 233 | ClientBin/ 234 | ~$* 235 | *~ 236 | *.dbmdl 237 | *.dbproj.schemaview 238 | *.jfm 239 | *.pfx 240 | *.publishsettings 241 | orleans.codegen.cs 242 | 243 | # Including strong name files can present a security risk 244 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 245 | #*.snk 246 | 247 | # Since there are multiple workflows, uncomment next line to ignore bower_components 248 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 249 | #bower_components/ 250 | 251 | # RIA/Silverlight projects 252 | Generated_Code/ 253 | 254 | # Backup & report files from converting an old project file 255 | # to a newer Visual Studio version. Backup files are not needed, 256 | # because we have git ;-) 257 | _UpgradeReport_Files/ 258 | Backup*/ 259 | UpgradeLog*.XML 260 | UpgradeLog*.htm 261 | ServiceFabricBackup/ 262 | *.rptproj.bak 263 | 264 | # SQL Server files 265 | *.mdf 266 | *.ldf 267 | *.ndf 268 | 269 | # Business Intelligence projects 270 | *.rdl.data 271 | *.bim.layout 272 | *.bim_*.settings 273 | *.rptproj.rsuser 274 | *- [Bb]ackup.rdl 275 | *- [Bb]ackup ([0-9]).rdl 276 | *- [Bb]ackup ([0-9][0-9]).rdl 277 | 278 | # Microsoft Fakes 279 | FakesAssemblies/ 280 | 281 | # GhostDoc plugin setting file 282 | *.GhostDoc.xml 283 | 284 | # Node.js Tools for Visual Studio 285 | .ntvs_analysis.dat 286 | node_modules/ 287 | 288 | # Visual Studio 6 build log 289 | *.plg 290 | 291 | # Visual Studio 6 workspace options file 292 | *.opt 293 | 294 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 295 | *.vbw 296 | 297 | # Visual Studio LightSwitch build output 298 | **/*.HTMLClient/GeneratedArtifacts 299 | **/*.DesktopClient/GeneratedArtifacts 300 | **/*.DesktopClient/ModelManifest.xml 301 | **/*.Server/GeneratedArtifacts 302 | **/*.Server/ModelManifest.xml 303 | _Pvt_Extensions 304 | 305 | # Paket dependency manager 306 | .paket/paket.exe 307 | paket-files/ 308 | 309 | # FAKE - F# Make 310 | .fake/ 311 | 312 | # CodeRush personal settings 313 | .cr/personal 314 | 315 | # Python Tools for Visual Studio (PTVS) 316 | __pycache__/ 317 | *.pyc 318 | 319 | # Cake - Uncomment if you are using it 320 | # tools/** 321 | # !tools/packages.config 322 | 323 | # Tabs Studio 324 | *.tss 325 | 326 | # Telerik's JustMock configuration file 327 | *.jmconfig 328 | 329 | # BizTalk build output 330 | *.btp.cs 331 | *.btm.cs 332 | *.odx.cs 333 | *.xsd.cs 334 | 335 | # OpenCover UI analysis results 336 | OpenCover/ 337 | 338 | # Azure Stream Analytics local run output 339 | ASALocalRun/ 340 | 341 | # MSBuild Binary and Structured Log 342 | *.binlog 343 | 344 | # NVidia Nsight GPU debugger configuration file 345 | *.nvuser 346 | 347 | # MFractors (Xamarin productivity tool) working folder 348 | .mfractor/ 349 | 350 | # Local History for Visual Studio 351 | .localhistory/ 352 | 353 | # BeatPulse healthcheck temp database 354 | healthchecksdb 355 | 356 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 357 | MigrationBackup/ 358 | 359 | # Ionide (cross platform F# VS Code tools) working folder 360 | .ionide/ 361 | 362 | # Fody - auto-generated XML schema 363 | FodyWeavers.xsd -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Controllers/TokenController.cs: -------------------------------------------------------------------------------- 1 | using Azure.Core; 2 | using Azure.Identity; 3 | using Microsoft.AspNetCore.Http; 4 | using Microsoft.AspNetCore.Mvc; 5 | using Microsoft.Extensions.Caching.Memory; 6 | using Microsoft.Identity.Client; 7 | using System.Security.Cryptography.X509Certificates; 8 | 9 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Controllers 10 | { 11 | /// 12 | /// TokenController hosting all the KeyVault proxy endpoints 13 | /// 14 | [Route("api/[controller]")] 15 | [ApiController] 16 | public class TokenController : ControllerBase 17 | { 18 | private readonly ILogger _logger; 19 | private readonly TokenCredential _tokenCredential; 20 | private readonly IMemoryCache _memoryCache; 21 | 22 | /// 23 | /// TokenController constructor 24 | /// 25 | /// 26 | /// 27 | public TokenController(ILogger logger, TokenCredential tokenCredential, IMemoryCache memoryCache) 28 | { 29 | _logger = logger; 30 | _tokenCredential = tokenCredential; 31 | _memoryCache = memoryCache; 32 | } 33 | 34 | /// 35 | /// Get access token with KeyVault key 36 | /// 37 | [HttpPost("kv-key")] 38 | [ProducesResponseType(typeof(Models.TokenResponse), 200)] 39 | [ProducesResponseType(typeof(ProblemDetails), 400)] 40 | public async Task> KvKeyAccessToken([FromBody] Models.KeyVaultKeyTokenRequest tokenRequest, CancellationToken cancellationToken) 41 | { 42 | _logger.LogInformation("Token request with Key Vault key {clientId}, {keyUri}", tokenRequest.ClientId, tokenRequest.KeyUri?.ToString()); 43 | 44 | 45 | var app = ConfidentialClientApplicationBuilder 46 | .Create(tokenRequest.ClientId) 47 | .WithAuthority(AzureCloudInstance.AzurePublic, tokenRequest.TenantId) 48 | .WithKeyVaultKey(tokenRequest.KeyUri!, tokenRequest.KeyThumbprint!, _tokenCredential) 49 | .Build(); 50 | 51 | var authResult = await app 52 | .AcquireTokenForClient(tokenRequest.Scopes) 53 | .ExecuteAsync(cancellationToken); 54 | 55 | return Ok(Models.TokenResponse.FromAuthenticationResult(authResult)); 56 | } 57 | 58 | /// 59 | /// Get key info about a certificate in the KeyVault 60 | /// 61 | [HttpPost("kv-key-info")] 62 | [ProducesResponseType(typeof(CertificateInfo), 200)] 63 | [ProducesResponseType(typeof(ProblemDetails), 400)] 64 | public async Task> KvKeyInfo([FromBody] Models.KeyVaultCertificateInfoRequest tokenRequest, CancellationToken cancellationToken) 65 | { 66 | _logger.LogInformation("Certificate info for Key Vault certificate {certificateName}", tokenRequest.CertificateName); 67 | var cacheKey = $"{tokenRequest.KeyVaultUri}/{tokenRequest.CertificateName!}"; 68 | if (!tokenRequest.SkipCache && _memoryCache.TryGetValue(cacheKey, out CertificateInfo? cachedCertInfo)) 69 | { 70 | return Ok(cachedCertInfo); 71 | } 72 | 73 | var certInfo = await ClientAssertionGenerator.GetCertificateInfoFromKeyVault(tokenRequest.KeyVaultUri!, tokenRequest.CertificateName!, _tokenCredential, cancellationToken); 74 | 75 | if (!tokenRequest.SkipCache) 76 | { 77 | _memoryCache.Set(cacheKey, certInfo, certInfo.ExpiresOn ?? DateTimeOffset.UtcNow.AddDays(1)); 78 | } 79 | 80 | return Ok(certInfo); 81 | } 82 | 83 | /// 84 | /// Get access token with certificate hosted in KeyVault 85 | /// 86 | /// Fetching the key info with /api/Token/kv-key-info and using it with /api/Token/kv-key is way more efficient. 87 | [HttpPost("kv-certificate")] 88 | [ProducesResponseType(typeof(Models.TokenResponse), 200)] 89 | [ProducesResponseType(typeof(ProblemDetails), 400)] 90 | public async Task> KvCertAccessToken([FromBody] Models.KeyVaultCertificateTokenRequest tokenRequest, CancellationToken cancellationToken) 91 | { 92 | _logger.LogInformation("Token request with Key Vault certificate {clientId}, {certificateName}", tokenRequest.ClientId, tokenRequest.CertificateName); 93 | 94 | var app = ConfidentialClientApplicationBuilder 95 | .Create(tokenRequest.ClientId) 96 | .WithAuthority(AzureCloudInstance.AzurePublic, tokenRequest.TenantId) 97 | .WithKeyVaultCertificate(tokenRequest.KeyVaultUri!, tokenRequest.CertificateName!, _tokenCredential, tokenRequest.SkipCache ? null : _memoryCache) 98 | .Build(); 99 | 100 | var authResult = await app 101 | .AcquireTokenForClient(tokenRequest.Scopes) 102 | .ExecuteAsync(cancellationToken); 103 | 104 | return Ok(Models.TokenResponse.FromAuthenticationResult(authResult)); 105 | } 106 | 107 | /// 108 | /// Get access token with certificate from the local user certificate store 109 | /// 110 | [HttpPost("local-certificate")] 111 | [ProducesResponseType(typeof(Models.TokenResponse), 200)] 112 | [ProducesResponseType(typeof(ProblemDetails), 400)] 113 | public async Task> UserCertAccessToken([FromBody] Models.LocalTokenRequest tokenRequest, CancellationToken cancellationToken) 114 | { 115 | _logger.LogInformation("Token request with local certificate @{tokenRequest}", tokenRequest); 116 | var store = new X509Store(StoreLocation.CurrentUser); 117 | store.Open(OpenFlags.ReadOnly); 118 | var certificates = store.Certificates.Find(tokenRequest.FindType ?? X509FindType.FindByThumbprint, tokenRequest.FindValue, true); 119 | if (certificates == null || certificates.Count == 0) 120 | { 121 | return NotFound(); 122 | } 123 | 124 | var app = ConfidentialClientApplicationBuilder 125 | .Create(tokenRequest.ClientId) 126 | .WithAuthority(AzureCloudInstance.AzurePublic, tokenRequest.TenantId) 127 | .WithCertificate(certificates.First()) 128 | .Build(); 129 | 130 | var authResult = await app.AcquireTokenForClient(tokenRequest.Scopes).ExecuteAsync(cancellationToken); 131 | 132 | return Ok(Models.TokenResponse.FromAuthenticationResult(authResult)); 133 | } 134 | 135 | /// 136 | /// Get access token with certificate hosted in local computer certificate store 137 | /// 138 | [HttpPost("computer-certificate")] 139 | [ProducesResponseType(typeof(Models.TokenResponse), 200)] 140 | [ProducesResponseType(typeof(ProblemDetails), 400)] 141 | public async Task> ComputerCertAccessToken([FromBody] Models.LocalTokenRequest tokenRequest, CancellationToken cancellationToken) 142 | { 143 | _logger.LogInformation("Token request with local certificate @{tokenRequest}", tokenRequest); 144 | var store = new X509Store(StoreLocation.LocalMachine); 145 | store.Open(OpenFlags.ReadOnly); 146 | var certificates = store.Certificates.Find(tokenRequest.FindType ?? X509FindType.FindByThumbprint, tokenRequest.FindValue, true); 147 | if (certificates == null || certificates.Count == 0) 148 | { 149 | return NotFound(); 150 | } 151 | 152 | var app = ConfidentialClientApplicationBuilder 153 | .Create(tokenRequest.ClientId) 154 | .WithAuthority(AzureCloudInstance.AzurePublic, tokenRequest.TenantId) 155 | .WithCertificate(certificates.First()) 156 | .Build(); 157 | 158 | var authResult = await app 159 | .AcquireTokenForClient(tokenRequest.Scopes) 160 | .ExecuteAsync(cancellationToken); 161 | 162 | return Ok(Models.TokenResponse.FromAuthenticationResult(authResult)); 163 | } 164 | } 165 | } 166 | -------------------------------------------------------------------------------- /docs/Smartersoft.Identity.Client.Assertion.md: -------------------------------------------------------------------------------- 1 | # Smartersoft.Identity.Client.Assertion 2 | 3 | This package allows you to use [Managed Identities](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/overview?wt.mc_id=SEC-MVP-5004985) 4 | with a multi tenant application. Your certificates used for getting access tokens with the **Client Credential** flow will be completely protected and can **NEVER** be extracted, not even by yourself. 5 | 6 | Managed Identities are great but they [don't support multi-tenant use cases](https://docs.microsoft.com/azure/active-directory/managed-identities-azure-resources/managed-identities-faq?wt.mc_id=SEC-MVP-5004985#can-i-use-a-managed-identity-to-access-a-resource-in-a-different-directorytenant), until now. 7 | 8 | This library is created by [Smartersoft B.V.](https://smartersoft.nl) and [licensed](https://github.com/Smartersoft/identity-client-assertion/blob/main/LICENSE.txt) as **GPL-3.0-only**. 9 | 10 | More details on this library in [this post](https://svrooij.io/2022/01/20/secure-multi-tenant-app/#post) 11 | 12 | ## Prerequisites 13 | 14 | - Azure resource with support for managed identities (Azure Functions, App Service, ...) 15 | - KeyVault 16 | - `Key Sign` (and optionally `Get Certificate`) permission on the KeyVault with the managed identity 17 | - Multi-tenant app registration 18 | - Self-signed certificate in KeyVault, see below 19 | 20 | ## Creating a certificate in KeyVault 21 | 22 | When using a certificate for client assertions a self-signed certificate will suffice. It will only be used for digital signatures, so it doesn't matter if it's not from some known CA. 23 | 24 | 1. Go to the KeyVault in Azure Portal 25 | 2. Click certificates 26 | 3. Click Generate/Import 27 | 4. Enter any name (needed to get the certificate info later on) 28 | 5. Pick a subject, I always use `CN={app-name}.{company}.internal` 29 | 6. Set a Validity period (`12 months` is the default, which is fine) 30 | 7. Leave Content Type to `PKCS #12` 31 | 8. Set Lifetime action Type to `E-mail all contacts...` instead of auto-renew. You'll need to know when you'll have to take action. 32 | 9. **Configure** Advanced Policy Configuration! Set **X.509 Key Usage Flags** to `Digital Signature` only and **Exportable Private Key** to `No`. Leave the rest to their default setting. 33 | 10. Click Create 34 | 11. Click the new certificate, click the version, download in CER format (needed in app registration). 35 | 36 | When creating a certificate in the KeyVault, it's **IMPORTANT** to configure the **Advanced Policy Configuration**. 37 | This allows you to mark the private key as **NOT EXPORTABLE**, which means that private key will **NEVER** leave that KeyVault. 38 | 39 | ## Required usings 40 | 41 | ```csharp 42 | using Azure.Identity; 43 | using Microsoft.Identity.Client; 44 | using System; 45 | using System.Threading; 46 | using System.Threading.Tasks; 47 | using Smartersoft.Identity.Client.Assertion; 48 | ``` 49 | 50 | ## Get access token using certificate in KeyVault 51 | 52 | ```csharp 53 | private readonly IMemoryCache? _injectedCache; 54 | public async Task GetToken (CancellationToken cancellationToken) 55 | { 56 | // Create a token credential that suits your needs, used to access the KeyVault 57 | // You should get this from dependency injection as a singleton, because it will cache the token internally. 58 | var tokenCredential = new DefaultAzureCredential(); 59 | 60 | const string clientId = "d294e746-425b-44fa-896c-dacf2c7938b8"; 61 | const string tenantId = "42a26c5d-b8ed-4f1b-8760-655f98154373"; 62 | const string KeyVaultUri = "https://{kv-domain}.vault.azure.net/"; 63 | const string certificateName = "some-certificate"; 64 | 65 | // Use the ConfidentialClientApplicationBuilder as usual 66 | // but call `.WithKeyVaultCertificate(...)` instead of `.WithCertificate(...)` 67 | var app = ConfidentialClientApplicationBuilder 68 | .Create(clientId) 69 | .WithAuthority(AzureCloudInstance.AzurePublic, tenantId) 70 | .WithKeyVaultCertificate(new Uri(KeyVaultUri), certificateName, tokenCredential, _injectedCache) 71 | .Build(); 72 | 73 | // Use the app, just like before 74 | var tokenResult = await app.AcquireTokenForClient(new[] { "https://graph.microsoft.com/.default" }) 75 | .ExecuteAsync(cancellationToken); 76 | 77 | return tokenResult.AccessToken; 78 | } 79 | ``` 80 | 81 | ## Get access token using certificate in KeyVault, more efficiently 82 | 83 | To use the [Client Assertion](https://docs.microsoft.com/azure/active-directory/develop/msal-net-client-assertions?wt.mc_id=SEC-MVP-5004985) 84 | you'll need the Base64Url encoded certificate hash. This information about the certificate will almost never change, only after certificate renewal. 85 | 86 | It can be loaded only once and saved in a config file to reduce the calls to the KeyVault, the code above calls the KeyVault twice for each call to get a client assertion. 87 | 88 | ```csharp 89 | public async Task GetTokenEfficiently(CancellationToken cancellationToken) 90 | { 91 | // Create a token credential that suits your needs, used to access the KeyVault 92 | // You should get this from dependency injection as a singleton, because it will cache the token internally. 93 | var tokenCredential = new DefaultAzureCredential(); 94 | 95 | const string KeyVaultUri = "https://{kv-domain}.vault.azure.net/"; 96 | const string certificateName = "some-certificate"; 97 | 98 | Uri? keyId = null; 99 | string? kid = null; 100 | 101 | // Load once and save in Cache/Config/... 102 | var certificateInfo = await ClientAssertionGenerator.GetCertificateInfoFromKeyVault(new Uri(KeyVaultUri), certificateName, tokenCredential, cancellationToken); 103 | if (certificateInfo.Kid == null || certificateInfo.KeyId == null) 104 | { 105 | throw new Exception(); 106 | } 107 | keyId = certificateInfo.KeyId; 108 | kid = certificateInfo.Kid; 109 | 110 | 111 | const string clientId = "d294e746-425b-44fa-896c-dacf2c7938b8"; 112 | const string tenantId = "42a26c5d-b8ed-4f1b-8760-655f98154373"; 113 | 114 | // Use the ConfidentialClientApplicationBuilder as usual 115 | // but call `.WithKeyVaultKey(...)` instead of `.WithCertificate(...)` 116 | var app = ConfidentialClientApplicationBuilder 117 | .Create(clientId) 118 | .WithAuthority(AzureCloudInstance.AzurePublic, tenantId) 119 | .WithKeyVaultKey(keyId, kid, tokenCredential) 120 | .Build(); 121 | 122 | // Use the app, just like before 123 | var tokenResult = await app.AcquireTokenForClient(new[] { "https://graph.microsoft.com/.default" }) 124 | .ExecuteAsync(cancellationToken); 125 | 126 | return tokenResult.AccessToken; 127 | } 128 | ``` 129 | 130 | ## Security 131 | 132 | Why is this solution more secure that others? 133 | This solution will **prevent** attackers getting **persistent access** in case of a breach. 134 | 135 | All other samples I've seen use the [CertificateClient.DownloadCertificateAsync](https://learn.microsoft.com/en-us/dotnet/api/azure.security.keyvault.certificates.certificateclient.downloadcertificateasync?view=azure-dotnet&wt.mc_id=SEC-MVP-5004985) method to **Get the certificate information** and **Download the private key**. 136 | If the app can Get the secret, an attacker can do the same. 137 | 138 | This way the seemingly secure certificate can be extracted by some malicious actor, and if the breach goes undetected they now have a certificate that can possibly access data in several tenants. Without getting noticed. 139 | 140 | This solution does the signing in the KeyVault instead of on the client. The application doesn't need the private key. 141 | It just needs the **Sign** permission. 142 | 143 | Off course this solution still needs a secure way to access the Key Vault, like a managed identity. But if you need to implement [KeyVault access without managed identities](https://svrooij.io/2021/07/20/managed-identity-without-azure/#post), the attacker can only sign token requests during the breach. This way you'll always have a log file of the sign-in attempts, in your Azure AD. If they would succeed in extracting the certificate, the only logs would be in the client Azure AD. 144 | 145 | ### How does this work? 146 | 147 | 1. Generate an unsigned client assertion (just some json, Base64Url encoded) 148 | 2. Converts the unsigned client assertion to bytes 149 | 3. Asks the KeyVault to [Sign the data](https://docs.microsoft.com/dotnet/api/azure.security.keyvault.keys.cryptography.cryptographyclient.signdata?view=azure-dotnet&wt.mc_id=SEC-MVP-5004985). 150 | 4. Encodes the signature Base64Url 151 | 5. Appends the signature to the token 152 | 153 | ## License 154 | 155 | These packages are [licensed](https://github.com/Smartersoft/identity-client-assertion/blob/main/LICENSE.txt) under `GPL-3.0`, if you wish to use this software under a different license. Or you feel that this really helped in your commercial application and wish to support us? You can [get in touch](https://smartersoft.nl/#contact) and we can talk terms. We are available as consultants. 156 | 157 | ## Open-source 158 | 159 | This package is open-source for a reason. It's developed by [Stephan van Rooij](https://svrooij.io/), people make mistakes. Always check out what's doing and make sure it doesn't do anything strange with the tokens. 160 | 161 | -------------------------------------------------------------------------------- /docs/Smartersoft.Identity.Client.Assertion.Proxy.md: -------------------------------------------------------------------------------- 1 | # Smartersoft.Identity.Client.Assertion.Proxy 2 | 3 | If you are only allowed to use certificates as client credentials, and you're storing those in an Azure Key Vault. 4 | Your stuck when you want to use postman to debug your api. 5 | 6 | This small api allows you to requests access tokens with those secrets securely stored in the Key Vault. See [this post](https://svrooij.io/2022/01/20/secure-multi-tenant-app/) for more details. Or check the [live demo][link_twitch]. 7 | 8 | [![Github source][badge_source]][link_source] 9 | [![Nuget package][badge_nuget_proxy]][link_nuget_proxy] 10 | [![GitHub License][badge_license]][link_license] 11 | [![GitHub issues][badge_issues]][link_issues] 12 | [![GitHub Sponsors][badge_sponsor]][link_sponsor] 13 | 14 | ## Development only! 15 | 16 | **DON'T** use this proxy anywhere in production! Having an endpoint where every app can just request tokens without authentication with your developer credentials is a bad idea. 17 | This api is meant to be used during development only! For production check out [our extensions to ConfidentialClientApplicationBuilder](link_nuget). 18 | 19 | ## Using this proxy 20 | 21 | This proxy requires you to have `.NET 8` installed, and the `dotnet` command available in your terminal, make sure you install that beforehand. 22 | 23 | 1. Install the proxy with `dotnet tool install --global Smartersoft.Identity.Client.Assertion.Proxy` 24 | 2. Run the proxy with `az-kv-proxy` or `az-kv-proxy --urls http://localhost:5616` if you wish to use another port 25 | 3. Open de browser and go to [/swagger/index.html](http://localhost:5616/swagger/index.html) 26 | 4. Try the endpoints 27 | 28 | ### Usage with Insomnia 29 | 30 | 1. Create request called `GetToken` to one of the three endpoints. 31 | 2. Edit the original request, change authentication to Bearer. 32 | 3. Select `TOKEN` field and press `CTRL` + `SPACE`, and select `Response: Body attribute`. 33 | 4. Request: Select `GetToken`, Filter: `$.access_token`, Trigger Behavior: `When Expired` and Max Age: `3000` (any number between 300 and 3599) 34 | 35 | I like [Insomnia](https://insomnia.rest/) over postman, but your millage may vary. 36 | 37 | ### Usage with postman 38 | 39 | 1. Create an environment variable called `token`. 40 | 2. Create a request to one of the 3 endpoints to get a token. 41 | 3. In the **Tests** tab, save the `access_token` to the environment variable `token` 42 | 4. Change other requests to use environment variable `token` as the token. 43 | 44 | See [this post](https://blog.postman.com/extracting-data-from-responses-and-chaining-requests/) for more details. 45 | 46 | ## Available endpoints 47 | 48 | This api had several endpoints all requiring different parameters. 49 | 50 | They all respond with the same data (provided it succeeded to get a token). 51 | 52 | ```json 53 | { 54 | "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIx___0IjoxNTE2MjM5MDIyfQ.SflKxwR___6yJV_adQssw5c", 55 | "lifetime": 3600, 56 | "expires_on": "2022-01-27T11:26:21.0424181+00:00", 57 | "scopes": [ 58 | "https://graph.microsoft.com/.default" 59 | ] 60 | } 61 | ``` 62 | 63 | And there also is a Swagger UI running to try it out in the browser, `/swagger/index.html`. 64 | 65 | ### Using Key Vault Key 66 | 67 | This is the most efficient way to use the Key Vault with your secret securely saved. It requires to get info about the key. 68 | 69 | - **URL** `/api/Token/kv-key` 70 | - **Method** `POST` 71 | 72 | ```json 73 | { 74 | "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47", 75 | "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2", 76 | "scopes": [ 77 | "https://graph.microsoft.com/.default" 78 | ], 79 | "keyUri": "https://{kv-domain}.vault.azure.net/keys/{some-certificate-name}/{cert-version}", 80 | "keyThumbprint": "{base64Url-encoded-certificate-hash}" 81 | } 82 | ``` 83 | 84 | ### Using Key Vault Certificate 85 | 86 | This endpoint still keeps the certificate in the Key Store, but it does requests information about the certificate on each call. 87 | Depending on usage, you're better of using the endpoint above this one. 88 | 89 | - **URL** `/api/Token/kv-certificate` 90 | - **Method** `POST` 91 | 92 | ```json 93 | { 94 | "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47", 95 | "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2", 96 | "scopes": [ 97 | "https://graph.microsoft.com/.default" 98 | ], 99 | "keyVaultUri": "https://{kv-domain}.vault.azure.net/", 100 | "certificateName": "{some-certificate-name}" 101 | } 102 | ``` 103 | 104 | ### Using Certificate from current user certificate store 105 | 106 | This endpoint requires you to generate the certificate in the current user certificate store, but is at least safer than using a plain password as a secret. 107 | 108 | - **URL** `/api/Token/local-certificate` 109 | - **Method** `POST` 110 | 111 | ```json 112 | { 113 | "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47", 114 | "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2", 115 | "scopes": [ 116 | "https://graph.microsoft.com/.default" 117 | ], 118 | "findType": "FindByThumbprint", 119 | "findValue": "{value-to-find-certificate-Thumbprint-in-this-case}" 120 | } 121 | ``` 122 | 123 | ### Using Certificate from local computer certificate store 124 | 125 | This endpoint requires you to generate the certificate in the current user certificate store, but is at least safer than using a plain password as a secret. 126 | 127 | - **URL** `/api/Token/computer-certificate` 128 | - **Method** `POST` 129 | 130 | ```json 131 | { 132 | "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47", 133 | "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2", 134 | "scopes": [ 135 | "https://graph.microsoft.com/.default" 136 | ], 137 | "findType": "FindByThumbprint", 138 | "findValue": "{value-to-find-certificate-Thumbprint-in-this-case}" 139 | } 140 | ``` 141 | 142 | ## Mananged Identity Credential Emulator 143 | 144 | This api has a special endpoint to emulate the Managed Identity Credentials endpoint, (as used by the CloudShell). This is useful for local development and testing. 145 | If you want to know how the ManagedIdentityCredential works, check out [this blog post](https://svrooij.io/2021/07/20/managed-identity-without-azure/#managedidentitycredential-explained). 146 | 147 | For now you just have to know how to set it up: 148 | 149 | 1. Start the proxy 150 | 2. Pick your endpoint 151 | 3. Set the `MSI_ENDPOINT` environment variable to one of the MSI endpoints (see below). 152 | You can do this either in de debug settings of your IDE, in your user profile or in the launchSettings.json in the project. 153 | 4. Start your app and use `ManagedIdentityCredential` to get your tokens, as if you were running in the cloud. 154 | 155 | Setting the `MSI_ENDPOINT` environment variable tricks the `ManagedIdentityCredential` into thinking it's running as it would in the CloudShell. 156 | Specifically, it will trick the [ManagedIdentitySource](https://github.com/Azure/azure-sdk-for-net/blob/13bc415e43a92354af7019063718d54f10488c7e/sdk/identity/Azure.Identity/src/ManagedIdentityClient.cs#L80-L90), 157 | to pick the [CloudShellManagedIdentitySource](https://github.com/Azure/azure-sdk-for-net/blob/13bc415e43a92354af7019063718d54f10488c7e/sdk/identity/Azure.Identity/src/CloudShellManagedIdentitySource.cs), 158 | which happens to only need a `MSI_ENDPOINT` to work. 159 | 160 | More details on how you would use this in docker, check out [this blog post](https://svrooij.io/2023/08/03/emulate-managed-identities/). 161 | 162 | ### MSI - Forward 163 | 164 | MSI Endpoint: `http://localhost:5616/api/msi/forward` 165 | 166 | Your request is forwarded to the Microsoft Token Endpoint using DefaultAzureCredential, this might be useful in a situation where you want to test your app using MSI inside a docker container. 167 | If you want to use this in docker, make sure the docker container can reach the host machine on port 5616 and set the `MSI_ENDPOINT` to `http://host.docker.internal:5616/api/msi/forward`. 168 | 169 | ### MSI - Local certificate 170 | 171 | MSI Endpoint: `http://localhost:5616/api/msi/{tenant}/{clientId}/{machinecert_or_usercert}/{thumbprint}` 172 | 173 | Do a token request with a pre-registered application and a certificate in the local machine certificate store or the current user certificate store. 174 | 175 | ### MSI - Key Vault certificate 176 | 177 | MSI Endpoint: `http://localhost:5616/api/msi/{tenant}/{clientId}/kv/{keyvaultSubdomain}/{certificateName}` 178 | 179 | Do a token request with a pre-registered application and a certificate in the Key Vault, this uses signing inside the keyvault, the private key of the certificate is not downloaded! You should generate it inside the KeyVault and mark it as not exportable. See (#using-key-vault-certificate) for more info. 180 | 181 | ## License 182 | 183 | These packages are [licensed](https://github.com/Smartersoft/identity-client-assertion/blob/main/LICENSE.txt) under `GPL-3.0`, if you wish to use this software under a different license. Or you feel that this really helped in your commercial application and wish to support us? You can [get in touch](https://smartersoft.nl/#contact) and we can talk terms. We are available as consultants. 184 | 185 | [badge_issues]: https://img.shields.io/github/issues/Smartersoft/identity-client-assertion?style=for-the-badge 186 | [badge_license]: https://img.shields.io/github/license/Smartersoft/identity-client-assertion?style=for-the-badge 187 | [badge_nuget_proxy]: https://img.shields.io/nuget/v/Smartersoft.Identity.Client.Assertion.Proxy?logoColor=00a880&style=for-the-badge 188 | [badge_source]: https://img.shields.io/badge/Source-Github-green?style=for-the-badge 189 | [badge_sponsor]: https://img.shields.io/github/sponsors/svrooij?label=Github%20Sponsors&style=for-the-badge 190 | 191 | [link_issues]: https://github.com/Smartersoft/identity-client-assertion/issues 192 | [link_license]: https://github.com/Smartersoft/identity-client-assertion/blob/main/LICENSE.txt 193 | [link_nuget_proxy]: https://www.nuget.org/packages/Smartersoft.Identity.Client.Assertion.Proxy/ 194 | [link_source]: https://github.com/Smartersoft/identity-client-assertion/ 195 | [link_sponsor]: https://github.com/sponsors/svrooij/ 196 | [link_twitch]: https://www.twitch.tv/videos/1414084395 -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/Controllers/MsiController.cs: -------------------------------------------------------------------------------- 1 | using Azure.Core; 2 | using Azure.Identity; 3 | using Microsoft.AspNetCore.Mvc; 4 | using Microsoft.Extensions.Caching.Memory; 5 | using Microsoft.Identity.Client; 6 | using System.Security.Cryptography.X509Certificates; 7 | 8 | namespace Smartersoft.Identity.Client.Assertion.Proxy.Controllers 9 | { 10 | /// 11 | /// MSI controller to respond to ManagedIdentityCredential calls without a real MSI 12 | /// 13 | [Route("api/[controller]")] 14 | [ApiController] 15 | public class MsiController : ControllerBase 16 | { 17 | private readonly ILogger _logger; 18 | private readonly IMemoryCache? _cache; 19 | private readonly TokenCredential _tokenCredential; 20 | /// 21 | /// Main constructor 22 | /// 23 | /// 24 | /// 25 | /// 26 | public MsiController(ILogger logger, TokenCredential tokenCredential, IMemoryCache? cache = null) 27 | { 28 | _logger = logger; 29 | _cache = cache; 30 | _tokenCredential = tokenCredential; 31 | } 32 | 33 | /// 34 | /// Forward the call to the Microsoft Token Service using DefaultAzureCredential 35 | /// 36 | /// MSI request as if this would come from CloudShell 37 | /// 38 | [HttpPost("forward")] 39 | [ProducesResponseType(typeof(Models.MsiResponse), 200)] 40 | public async Task Forward([FromForm] Models.MsiRequest msiRequest, CancellationToken cancellationToken = default) 41 | { 42 | _logger.LogInformation("MSI request for {resource}", msiRequest.Resource); 43 | 44 | var tokenResult = await _tokenCredential.GetTokenAsync(new Azure.Core.TokenRequestContext(new[] { FixResourceUrl(msiRequest.Resource) }), cancellationToken); 45 | 46 | return Ok(Models.MsiResponse.FromAzureAccessToken(tokenResult, msiRequest.Resource)); 47 | } 48 | 49 | /// 50 | /// Forward the call to the Microsoft Token Service using DefaultAzureCredential and a specific tenant 51 | /// 52 | /// Pre-set the tenant so other tenants are skipped when setting the token 53 | /// MSI request as if this would come from CloudShell 54 | /// 55 | [HttpPost("{tenant}/forward")] 56 | [ProducesResponseType(typeof(Models.MsiResponse), 200)] 57 | public async Task TenantForward([FromRoute] string tenant, [FromForm] Models.MsiRequest msiRequest, CancellationToken cancellationToken = default) 58 | { 59 | _logger.LogInformation("MSI request for {resource}", msiRequest.Resource); 60 | 61 | var tokenResult = await _tokenCredential.GetTokenAsync(new Azure.Core.TokenRequestContext(new[] { FixResourceUrl(msiRequest.Resource) }, tenantId: tenant), cancellationToken); 62 | 63 | return Ok(Models.MsiResponse.FromAzureAccessToken(tokenResult, msiRequest.Resource)); 64 | } 65 | 66 | /// 67 | /// Forward ManagedIdentityCredential to the Microsoft Token Service using a pre-registered client and local user certificate 68 | /// 69 | /// Tenant 70 | /// Client ID (Application ID) 71 | /// Certificate Thumbprint 72 | /// MSI request as if this would come from CloudShell 73 | /// 74 | [HttpPost("{tenant}/{clientId}/usercert/{thumbprint}")] 75 | [ProducesResponseType(typeof(Models.MsiResponse), 200)] 76 | [ProducesResponseType(404)] 77 | public Task UserCert( 78 | [FromRoute] string tenant, 79 | [FromRoute] string clientId, 80 | [FromRoute] string thumbprint, 81 | [FromForm] Models.MsiRequest msiRequest, 82 | CancellationToken cancellationToken = default) => Cert(StoreLocation.CurrentUser, tenant, clientId, thumbprint, msiRequest, cancellationToken); 83 | 84 | /// 85 | /// Forward ManagedIdentityCredential to the Microsoft Token Service using a pre-registered client and local machine certificate 86 | /// 87 | /// Tenant 88 | /// Client ID (Application ID) 89 | /// Certificate Thumbprint 90 | /// MSI request as if this would come from CloudShell 91 | /// 92 | [HttpPost("{tenant}/{clientId}/machinecert/{thumbprint}")] 93 | [ProducesResponseType(typeof(Models.MsiResponse), 200)] 94 | [ProducesResponseType(404)] 95 | public Task MachineCert( 96 | [FromRoute] string tenant, 97 | [FromRoute] string clientId, 98 | [FromRoute] string thumbprint, 99 | [FromForm] Models.MsiRequest msiRequest, 100 | CancellationToken cancellationToken = default) => Cert(StoreLocation.LocalMachine, tenant, clientId, thumbprint, msiRequest, cancellationToken); 101 | 102 | private async Task Cert(StoreLocation storeLocation, string tenant, string clientId, string thumbprint, Models.MsiRequest msiRequest, CancellationToken cancellationToken) 103 | { 104 | _logger.LogInformation("MSI request for {resource}, clientId: {clientId} cert: {thumbprint} store: {store} ", msiRequest.Resource, clientId, thumbprint, storeLocation); 105 | var store = new X509Store(storeLocation); 106 | store.Open(OpenFlags.ReadOnly); 107 | var cert = store.Certificates.Find(X509FindType.FindByThumbprint, thumbprint, true).FirstOrDefault(); 108 | if (cert == null) 109 | { 110 | _logger.LogError("Cert not found"); 111 | return NotFound(); 112 | } 113 | 114 | var app = ConfidentialClientApplicationBuilder 115 | .Create(clientId) 116 | .WithAuthority(AzureCloudInstance.AzurePublic, tenant) 117 | .WithCertificate(cert) 118 | .Build(); 119 | 120 | var authResult = await app.AcquireTokenForClient(new[] { FixResourceUrl(msiRequest.Resource) }).ExecuteAsync(cancellationToken); 121 | 122 | return Ok(Models.MsiResponse.FromAuthenticationResult(authResult, msiRequest.Resource)); 123 | } 124 | 125 | /// 126 | /// Forward ManagedIdentityCredential to the Microsoft Token Service using a pre-registered client and a certificate stored in Azure Key Vault 127 | /// 128 | /// Tenant 129 | /// Client ID (Application ID) 130 | /// KeyVault subdomain 131 | /// Certificate name of certificate in KeyVault 132 | /// MSI request as if this would come from CloudShell 133 | /// 134 | [HttpPost("{tenant}/{clientId}/kv/{subdomain}/{certificateName}")] 135 | [ProducesResponseType(typeof(Models.MsiResponse), 200)] 136 | public async Task KeyVault( 137 | [FromRoute] string tenant, 138 | [FromRoute] string clientId, 139 | [FromRoute] string subdomain, 140 | [FromRoute] string certificateName, 141 | [FromForm] Models.MsiRequest msiRequest, 142 | CancellationToken cancellationToken = default) 143 | { 144 | _logger.LogInformation("MSI request for {resource}, clientId: {clientId} kv: {subdomain} cert: {certificateName}", msiRequest.Resource, clientId, subdomain, certificateName); 145 | 146 | var certInfo = await GetCertificateInfoAsync(subdomain, certificateName, cancellationToken); 147 | if (certInfo == null) 148 | { 149 | _logger.LogError("Cert not found"); 150 | return NotFound(); 151 | } 152 | var app = ConfidentialClientApplicationBuilder 153 | .Create(clientId) 154 | .WithAuthority(AzureCloudInstance.AzurePublic, tenant) 155 | .WithKeyVaultKey(certInfo.KeyId!, certInfo.Kid!, _tokenCredential) 156 | .Build(); 157 | 158 | var authResult = await app.AcquireTokenForClient(new[] { FixResourceUrl(msiRequest.Resource) }).ExecuteAsync(cancellationToken); 159 | 160 | return Ok(Models.MsiResponse.FromAuthenticationResult(authResult, msiRequest.Resource)); 161 | } 162 | 163 | private Task GetCertificateInfoAsync(string subdomain, string certificateName, CancellationToken cancellationToken) 164 | { 165 | if (_cache is not null) 166 | { 167 | return _cache.GetOrCreateAsync($"cert-info-{subdomain}-{certificateName}", async entry => 168 | { 169 | entry.AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(5); 170 | return await ClientAssertionGenerator.GetCertificateInfoFromKeyVault(GenerateKeyVaultUri(subdomain), certificateName, _tokenCredential, cancellationToken); 171 | })!; 172 | } 173 | 174 | return ClientAssertionGenerator.GetCertificateInfoFromKeyVault(GenerateKeyVaultUri(subdomain), certificateName, _tokenCredential, cancellationToken); 175 | } 176 | 177 | private Uri GenerateKeyVaultUri(string subdomain) 178 | { 179 | return new Uri($"https://{subdomain}.vault.azure.net/"); 180 | } 181 | 182 | private static string FixResourceUrl(string resource) 183 | { 184 | if (resource.EndsWith("/.default")) 185 | { 186 | return resource; 187 | } 188 | if (resource.EndsWith("/")) 189 | { 190 | return resource + ".default"; 191 | } 192 | return resource + "/.default"; 193 | } 194 | } 195 | } -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion/ConfidentialClientApplicationBuilderExtensions.cs: -------------------------------------------------------------------------------- 1 | using Azure.Core; 2 | using Azure.Identity; 3 | using Microsoft.Extensions.Caching.Memory; 4 | using Microsoft.Identity.Client; 5 | using System; 6 | using System.Threading; 7 | 8 | namespace Smartersoft.Identity.Client.Assertion 9 | { 10 | /// 11 | /// KeyVault extensions for Microsoft.Identity.Client.ConfidentialClientApplicationBuilder 12 | /// 13 | public static class ConfidentialClientApplicationBuilderExtensions 14 | { 15 | /// 16 | /// Add a client assertion, while they key stays in the KeyVault 17 | /// 18 | /// ConfidentialClientApplicationBuilder 19 | /// Tenant ID for which you want to use this token 20 | /// Client Identifier 21 | /// Uri of the KeyVault 22 | /// Name of certificate 23 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 24 | [Obsolete("Replaced by method without Tenant ID and Client ID")] 25 | public static ConfidentialClientApplicationBuilder WithKeyVaultCertificate(this ConfidentialClientApplicationBuilder applicationBuilder, string tenantId, string clientId, Uri vaultUri, string certificateName) 26 | { 27 | return applicationBuilder.WithKeyVaultCertificate(tenantId, clientId, vaultUri, certificateName, new DefaultAzureCredential()); 28 | } 29 | 30 | /// 31 | /// Add a client assertion, while they key stays in the KeyVault 32 | /// 33 | /// ConfidentialClientApplicationBuilder 34 | /// Tenant ID for which you want to use this token 35 | /// Client Identifier 36 | /// Uri of the KeyVault 37 | /// Name of certificate 38 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 39 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 40 | [Obsolete("Replaced by method without Tenant ID and Client ID")] 41 | public static ConfidentialClientApplicationBuilder WithKeyVaultCertificate(this ConfidentialClientApplicationBuilder applicationBuilder, string tenantId, string clientId, Uri vaultUri, string certificateName, TokenCredential tokenCredential) 42 | { 43 | return applicationBuilder 44 | //.WithAuthority(AzureCloudInstance.AzurePublic, tenantId) 45 | .WithClientAssertion((CancellationToken cancellationToken) => 46 | ClientAssertionGenerator.GetSignedTokenWithKeyVaultCertificate(tenantId, clientId, vaultUri, certificateName, tokenCredential, cancellationToken: cancellationToken) 47 | ); 48 | } 49 | 50 | /// 51 | /// Add a client assertion, while they key stays in the KeyVault 52 | /// 53 | /// ConfidentialClientApplicationBuilder 54 | /// Uri of the KeyVault 55 | /// Name of certificate 56 | /// This method does not cache the certificate information, using is preferred. 57 | public static ConfidentialClientApplicationBuilder WithKeyVaultCertificate(this ConfidentialClientApplicationBuilder applicationBuilder, Uri vaultUri, string certificateName) 58 | { 59 | return applicationBuilder.WithKeyVaultCertificate(vaultUri, certificateName, new DefaultAzureCredential()); 60 | } 61 | 62 | /// 63 | /// Add a client assertion, while they key stays in the KeyVault 64 | /// 65 | /// ConfidentialClientApplicationBuilder 66 | /// Uri of the KeyVault 67 | /// Name of certificate 68 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 69 | /// (optional) to cache the certificate information 70 | public static ConfidentialClientApplicationBuilder WithKeyVaultCertificate(this ConfidentialClientApplicationBuilder applicationBuilder, Uri vaultUri, string certificateName, TokenCredential tokenCredential, IMemoryCache? memoryCache = null) 71 | { 72 | return applicationBuilder 73 | //.WithAuthority(AzureCloudInstance.AzurePublic, tenantId) 74 | .WithClientAssertion((AssertionRequestOptions options) => 75 | ClientAssertionGenerator.GetSignedTokenWithKeyVaultCertificate(vaultUri, certificateName, options.TokenEndpoint, options.ClientID, tokenCredential, cancellationToken: options.CancellationToken, memoryCache) 76 | ); 77 | } 78 | 79 | /// 80 | /// Add a client assertion, while they key stays in the KeyVault 81 | /// 82 | /// ConfidentialClientApplicationBuilder 83 | /// Tenant ID for which you want to use this token 84 | /// Client Identifier 85 | /// KeyId, Uri of the actual key in the KeyVault 86 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 87 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 88 | [Obsolete("Replaced by method without Tenant ID and Client ID")] 89 | public static ConfidentialClientApplicationBuilder WithKeyVaultKey(this ConfidentialClientApplicationBuilder applicationBuilder, string tenantId, string clientId, Uri keyVaultKeyId, string kid) 90 | { 91 | return applicationBuilder.WithKeyVaultKey(tenantId, clientId, keyVaultKeyId, kid, new DefaultAzureCredential()); 92 | } 93 | 94 | /// 95 | /// Add a client assertion, while they key stays in the KeyVault 96 | /// 97 | /// ConfidentialClientApplicationBuilder 98 | /// Tenant ID for which you want to use this token 99 | /// Client Identifier 100 | /// KeyId, Uri of the actual key in the KeyVault 101 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 102 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 103 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 104 | [Obsolete("Replaced by method without Tenant ID and Client ID")] 105 | public static ConfidentialClientApplicationBuilder WithKeyVaultKey(this ConfidentialClientApplicationBuilder applicationBuilder, string tenantId, string clientId, Uri keyVaultKeyId, string kid, TokenCredential tokenCredential) 106 | { 107 | return applicationBuilder 108 | //.WithAuthority(AzureCloudInstance.AzurePublic, tenantId) 109 | .WithClientAssertion((CancellationToken cancellationToken) => 110 | ClientAssertionGenerator.GetSignedTokenWithKeyVaultKey(tenantId, clientId, keyVaultKeyId, kid, tokenCredential, cancellationToken: cancellationToken) 111 | ); 112 | } 113 | 114 | /// 115 | /// Add a client assertion, while they key stays in the KeyVault 116 | /// 117 | /// ConfidentialClientApplicationBuilder 118 | /// KeyId, Uri of the actual key in the KeyVault 119 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 120 | public static ConfidentialClientApplicationBuilder WithKeyVaultKey(this ConfidentialClientApplicationBuilder applicationBuilder, Uri keyVaultKeyId, string kid) 121 | { 122 | return applicationBuilder.WithKeyVaultKey(keyVaultKeyId, kid, new DefaultAzureCredential()); 123 | } 124 | 125 | /// 126 | /// Add a client assertion, while they key stays in the KeyVault 127 | /// 128 | /// ConfidentialClientApplicationBuilder 129 | /// KeyId, Uri of the actual key in the KeyVault 130 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 131 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 132 | public static ConfidentialClientApplicationBuilder WithKeyVaultKey(this ConfidentialClientApplicationBuilder applicationBuilder, Uri keyVaultKeyId, string kid, TokenCredential tokenCredential) 133 | { 134 | return applicationBuilder 135 | //.WithAuthority(AzureCloudInstance.AzurePublic, tenantId) 136 | .WithClientAssertion((AssertionRequestOptions options) => 137 | ClientAssertionGenerator.GetSignedTokenWithKeyVaultKey(keyVaultKeyId, kid, options.TokenEndpoint, options.ClientID, tokenCredential, cancellationToken: options.CancellationToken) 138 | ); 139 | } 140 | 141 | /// 142 | /// Add a client assertion using a Managed Identity, configured as Federated Credential. 143 | /// 144 | /// ConfidentialClientApplicationBuilder 145 | /// The scope used for the federated credential api 146 | /// Blog post 147 | /// This is experimental, since federated credentials are still in preview. 148 | public static ConfidentialClientApplicationBuilder WithManagedIdentity(this ConfidentialClientApplicationBuilder applicationBuilder, string managedIdentityScope) => applicationBuilder.WithManagedIdentity(managedIdentityScope, new ManagedIdentityCredential()); 149 | 150 | /// 151 | /// Add a client assertion using a Managed Identity, configured as Federated Credential. 152 | /// 153 | /// ConfidentialClientApplicationBuilder 154 | /// The scope used for the federated credential api, eg. `{app-uri}/.default` 155 | /// Use any TokenCredential (eg. new ManagedIdentityCredential()) 156 | /// Blog post 157 | /// This is experimental, since federated credentials are still in preview. 158 | public static ConfidentialClientApplicationBuilder WithManagedIdentity(this ConfidentialClientApplicationBuilder applicationBuilder, string managedIdentityScope, TokenCredential managedIdentityCredential) 159 | { 160 | return applicationBuilder.WithClientAssertion(async (AssertionRequestOptions options) => 161 | { 162 | var tokenResult = await managedIdentityCredential.GetTokenAsync(new TokenRequestContext(new[] { managedIdentityScope }), options.CancellationToken); 163 | return tokenResult.Token; 164 | }); 165 | } 166 | } 167 | } -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion/ClientAssertionGenerator.cs: -------------------------------------------------------------------------------- 1 | using Azure.Core; 2 | using Azure.Security.KeyVault.Certificates; 3 | using Azure.Security.KeyVault.Keys.Cryptography; 4 | using Microsoft.Extensions.Caching.Memory; 5 | using System; 6 | using System.Collections.Generic; 7 | using System.Security.Cryptography; 8 | using System.Security.Cryptography.X509Certificates; 9 | using System.Text; 10 | using System.Text.Json; 11 | using System.Threading; 12 | using System.Threading.Tasks; 13 | 14 | namespace Smartersoft.Identity.Client.Assertion 15 | { 16 | /// 17 | /// Generator for Signed client assertions 18 | /// 19 | /// Inspired by https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-net-client-assertions 20 | public static class ClientAssertionGenerator 21 | { 22 | /// 23 | /// Encode a byte array to a Base64Url encoded string. 24 | /// 25 | /// byte array 26 | /// string 27 | public static string Base64UrlEncode(byte[] input) 28 | { 29 | char Base64PadCharacter = '='; 30 | char Base64Character62 = '+'; 31 | char Base64Character63 = '/'; 32 | char Base64UrlCharacter62 = '-'; 33 | char Base64UrlCharacter63 = '_'; 34 | 35 | string s = Convert.ToBase64String(input); 36 | s = s.Split(Base64PadCharacter)[0]; // Remove any trailing padding 37 | s = s.Replace(Base64Character62, Base64UrlCharacter62); // 62nd char of encoding 38 | s = s.Replace(Base64Character63, Base64UrlCharacter63); // 63rd char of encoding 39 | 40 | return s; 41 | } 42 | 43 | /// 44 | /// Generate the required claims for a client assertion 45 | /// 46 | /// Audience token is used for eg `https://login.microsoftonline.com/{tenantId}/v2.0` 47 | /// Client ID of the calling application 48 | /// optional lifetime 49 | /// 50 | public static IDictionary GenerateClaimsForAudience(string audience, string clientId, int lifetime = 300) 51 | { 52 | 53 | DateTimeOffset validFrom = DateTimeOffset.UtcNow; 54 | DateTimeOffset validUntil = validFrom.AddSeconds(lifetime); 55 | return new Dictionary() 56 | { 57 | { "aud", audience }, 58 | { "exp", validUntil.ToUnixTimeSeconds() }, 59 | { "iss", clientId }, 60 | { "jti", Guid.NewGuid().ToString() }, 61 | { "nbf", validFrom.ToUnixTimeSeconds() }, 62 | { "sub", clientId } 63 | }; 64 | } 65 | 66 | /// 67 | /// Generate the required claims for a client assertion 68 | /// 69 | /// Tenant ID for which this token will be used 70 | /// Client ID of the calling application 71 | /// optional lifetime 72 | /// 73 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 74 | public static IDictionary GenerateClaimsForTenant(string tenantId, string clientId, int lifetime = 300) 75 | { 76 | string aud = $"https://login.microsoftonline.com/{tenantId}/v2.0"; 77 | return GenerateClaimsForAudience(aud, clientId, lifetime); 78 | } 79 | 80 | 81 | /// 82 | /// Generate the JWT header for the client assertion 83 | /// 84 | /// Base64Url encoded hash of the certificate 85 | /// 86 | public static IDictionary GenerateHeader(string kid) 87 | { 88 | return new Dictionary() 89 | { 90 | { "alg", "RS256"}, 91 | { "typ", "JWT"}, 92 | { "x5t", kid } 93 | }; 94 | } 95 | 96 | /// 97 | /// Generate the first two parts of the client assertion (no signature) 98 | /// 99 | /// Base64Url encoded hash of the certificate 100 | /// Client assertion claims 101 | /// 102 | public static string GetUnsignedToken(string kid, IDictionary assertionClaims) 103 | { 104 | var header = GenerateHeader(kid); 105 | 106 | var headerBytes = JsonSerializer.SerializeToUtf8Bytes(header); 107 | var claimsBytes = JsonSerializer.SerializeToUtf8Bytes(assertionClaims); 108 | return Base64UrlEncode(headerBytes) + "." + Base64UrlEncode(claimsBytes); 109 | } 110 | 111 | /// 112 | /// Generate the first two parts of the client assertion (no signature) 113 | /// 114 | /// Base64Url encoded hash of the certificate 115 | /// Tenant ID for which this token will be used 116 | /// Client ID of the calling application 117 | /// 118 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 119 | public static string GetUnsignedToken(string kid, string tenantId, string clientId) 120 | { 121 | return GetUnsignedToken(kid, GenerateClaimsForTenant(tenantId, clientId)); 122 | } 123 | 124 | /// 125 | /// Creates a signed client assertion, with a provided certificate. 126 | /// 127 | /// X509Certificate2, with private key included! 128 | /// Tenant ID for which this token will be used 129 | /// Client ID of the calling application 130 | /// Provided only as a reference, use WithClientCertificate on the ConfidentialAppBuilder. 131 | /// 132 | public static string GetSignedToken(X509Certificate2 certificate, string tenantId, string clientId) 133 | { 134 | var kid = Base64UrlEncode(certificate.GetCertHash()); 135 | var unsignedToken = GetUnsignedToken(kid, tenantId, clientId); 136 | var rsa = certificate.GetRSAPrivateKey(); 137 | 138 | if (rsa == null) 139 | { 140 | throw new ArgumentNullException(nameof(certificate)); 141 | } 142 | 143 | string signature = Base64UrlEncode(rsa.SignData(Encoding.UTF8.GetBytes(unsignedToken), HashAlgorithmName.SHA256, RSASignaturePadding.Pkcs1)); 144 | return unsignedToken + "." + signature; 145 | } 146 | 147 | /// 148 | /// Create a signed client assertion with a Key in the KeyVault 149 | /// 150 | /// Claims in client assertion, use `GenerateClaimsForAudience` or `GenerateClaimsForTenant` 151 | /// KeyId, Uri of the actual key in the KeyVault 152 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 153 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 154 | /// Use cancellation token if preferred 155 | /// Needs Key => Sign permission, the client assertion is signed in the Key Vault. Currently only RSA keys are supported 156 | /// Signed client assertion 157 | /// If the keyId or kid is null 158 | /// The local cryptographic provider threw an exception. 159 | /// The key is invalid for the current operation. 160 | /// The operation is not supported with the specified key. 161 | /// The server returned an error. See System.Exception.Message for details returned from the server. 162 | public static async Task GetSignedTokenWithKeyVaultKey(IDictionary assertionClaims, Uri keyId, string kid, TokenCredential tokenCredential, CancellationToken cancellationToken = default) 163 | { 164 | var unsignedToken = GetUnsignedToken(kid!, assertionClaims); 165 | var cryptographyClient = new CryptographyClient(keyId!, tokenCredential); 166 | 167 | // The signing takes place at the KeyVault, the private key never reaches the client. 168 | // This needs the `Key => Sign` permission, and counts as a KeyVault operation. 169 | var signResult = await cryptographyClient.SignDataAsync(SignatureAlgorithm.RS256, Encoding.UTF8.GetBytes(unsignedToken), cancellationToken); 170 | 171 | return unsignedToken + "." + Base64UrlEncode(signResult.Signature); 172 | } 173 | 174 | /// 175 | /// Create a signed client assertion with a Key in the KeyVault 176 | /// 177 | /// Tenant ID for which you want to use this token 178 | /// Client Identifier 179 | /// KeyId, Uri of the actual key in the KeyVault 180 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 181 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 182 | /// Use cancellation token if preferred 183 | /// Needs Key => Sign permission, the client assertion is signed in the KeyVault 184 | /// Signed client assertion 185 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 186 | [Obsolete("Use version with audience")] 187 | public static Task GetSignedTokenWithKeyVaultKey(string tenantId, string clientId, Uri keyId, string kid, TokenCredential tokenCredential, CancellationToken cancellationToken = default) 188 | { 189 | return GetSignedTokenWithKeyVaultKey(GenerateClaimsForTenant(tenantId, clientId), keyId, kid, tokenCredential, cancellationToken); 190 | } 191 | 192 | /// 193 | /// Create a signed client assertion with a Key in the KeyVault 194 | /// 195 | /// KeyId, Uri of the actual key in the KeyVault 196 | /// The Base64Url encoded hash of the certificate, use GetCertificateInfoFromKeyVault 197 | /// audience to use in the assertion 198 | /// Client Identifier 199 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 200 | /// Use cancellation token if preferred 201 | /// Needs Key => Sign permission, the client assertion is signed in the Key Vault. Currently only RSA keys are supported 202 | /// Signed client assertion 203 | /// If the keyId, kid, audience, of clientId are null 204 | /// The local cryptographic provider threw an exception. 205 | /// The key is invalid for the current operation. 206 | /// The operation is not supported with the specified key. 207 | /// The server returned an error. See System.Exception.Message for details returned from the server. 208 | public static Task GetSignedTokenWithKeyVaultKey(Uri keyId, string kid, string audience, string clientId, TokenCredential tokenCredential, CancellationToken cancellationToken = default) 209 | { 210 | return GetSignedTokenWithKeyVaultKey(GenerateClaimsForAudience(audience, clientId), keyId, kid, tokenCredential, cancellationToken); 211 | } 212 | 213 | /// 214 | /// Get the KeyId and the kid from the KeyVault, this info should be cached. It will hardly ever change. 215 | /// 216 | /// Uri of your KeyVault 217 | /// Name of the certificate 218 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 219 | /// Use cancellation token if preferred 220 | /// Calls GetCertificate, which will download the public information about the certificate. Always mark your keys as NOT EXPORTABLE, or this is to no use. 221 | /// CertificateInfo 222 | public static async Task GetCertificateInfoFromKeyVault(Uri vaultUri, string certificateName, TokenCredential tokenCredential, CancellationToken cancellationToken = default) 223 | { 224 | var certClient = new CertificateClient(vaultUri, tokenCredential); 225 | 226 | // This call needs the `GetCertificate` permission, but it only downlods the public info. 227 | // Be sure to mark the certificates' private key as NOT EXPORTABLE upon generation. That means no one can download the private key EVER! 228 | var certificateResult = await certClient.GetCertificateAsync(certificateName, cancellationToken); 229 | 230 | var certificate = new X509Certificate2(certificateResult.Value.Cer); 231 | 232 | return new CertificateInfo 233 | { 234 | CertificateName = certificateResult.Value.Name, 235 | KeyId = certificateResult.Value.KeyId, 236 | Kid = Base64UrlEncode(certificate.GetCertHash()), 237 | ExpiresOn = certificateResult.Value.Properties.ExpiresOn 238 | }; 239 | } 240 | 241 | /// 242 | /// Fetches information about the certificate, and then signs a token with the info from the KeyVault 243 | /// 244 | /// Claims in client assertion, use `GenerateClaimsForAudience` or `GenerateClaimsForTenant` 245 | /// Uri of the KeyVault 246 | /// Name of certificate 247 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 248 | /// Use cancellation token if preferred 249 | /// (optional) to cache the certificate information 250 | /// Signed client assertion 251 | /// Either supply the or use the method 252 | public static async Task GetSignedTokenWithKeyVaultCertificate(IDictionary assertionClaims, Uri vaultUri, string certificateName, TokenCredential tokenCredential, CancellationToken cancellationToken = default, IMemoryCache? memoryCache = null) 253 | { 254 | var cacheKey = $"{vaultUri}/{certificateName}"; 255 | if (memoryCache != null && memoryCache.TryGetValue(cacheKey, out CertificateInfo? certFromCache)) 256 | { 257 | return await GetSignedTokenWithKeyVaultKey(assertionClaims, certFromCache!.KeyId!, certFromCache.Kid!, tokenCredential, cancellationToken); 258 | } 259 | 260 | var certInfo = await GetCertificateInfoFromKeyVault(vaultUri, certificateName, tokenCredential, cancellationToken); 261 | 262 | if (certInfo.Kid == null || certInfo.KeyId == null) 263 | { 264 | throw new ArgumentNullException(nameof(certInfo)); 265 | } 266 | 267 | if (memoryCache != null) 268 | { 269 | MemoryCacheEntryOptions options = new MemoryCacheEntryOptions(); 270 | if (certInfo.ExpiresOn.HasValue) 271 | { 272 | options.AbsoluteExpiration = certInfo.ExpiresOn; 273 | } 274 | else 275 | { 276 | options.SetAbsoluteExpiration(TimeSpan.FromDays(1)); 277 | } 278 | memoryCache.Set(cacheKey, certInfo, options); 279 | } 280 | 281 | return await GetSignedTokenWithKeyVaultKey(assertionClaims, certInfo.KeyId, certInfo.Kid, tokenCredential, cancellationToken); 282 | } 283 | 284 | /// 285 | /// Fetches information about the certificate (should be cached!), and then signs a token with the info from the KeyVault 286 | /// 287 | /// Tenant ID for which you want to use this token 288 | /// Client Identifier 289 | /// Uri of the KeyVault 290 | /// Name of certificate 291 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 292 | /// Use cancellation token if preferred 293 | /// Signed client assertion 294 | /// `GetSignedTokenWithKeyVaultKey` is perferred over this method 295 | [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] 296 | [Obsolete("Use version with audience")] 297 | public static Task GetSignedTokenWithKeyVaultCertificate(string tenantId, string clientId, Uri vaultUri, string certificateName, TokenCredential tokenCredential, CancellationToken cancellationToken = default) 298 | { 299 | return GetSignedTokenWithKeyVaultCertificate(GenerateClaimsForTenant(tenantId, clientId), vaultUri, certificateName, tokenCredential, cancellationToken); 300 | } 301 | 302 | /// 303 | /// Fetches information about the certificate, and uses remote signing to sign the token in the KeyVault 304 | /// 305 | /// Uri of the KeyVault 306 | /// Name of certificate 307 | /// Assertion audience 308 | /// Client Identifier 309 | /// Use any TokenCredential (eg. new DefaultTokenCredential()) 310 | /// Use cancellation token if preferred 311 | /// (optional) to cache the certificate information 312 | /// Signed client assertion 313 | /// Either use this method with the supplied, or use the method. 314 | public static Task GetSignedTokenWithKeyVaultCertificate(Uri vaultUri, string certificateName, string audience, string clientId, TokenCredential tokenCredential, CancellationToken cancellationToken = default, IMemoryCache? memoryCache = null) 315 | { 316 | return GetSignedTokenWithKeyVaultCertificate(GenerateClaimsForAudience(audience, clientId), vaultUri, certificateName, tokenCredential, cancellationToken, memoryCache); 317 | } 318 | } 319 | } 320 | -------------------------------------------------------------------------------- /src/Smartersoft.Identity.Client.Assertion.Proxy/wwwroot/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 964 | 965 | 966 |

Smartersoft.Identity.Client.Assertion.Proxy

967 |

If you are only allowed to use certificates as client credentials, and you're storing those in an Azure Key Vault. 968 | Your stuck when you want to use postman to debug your api.

969 |

This small api allows you to requests access tokens with those secrets securely stored in the Key Vault. See this post for more details. Or check the live demo.

970 |

Github source 971 | Nuget package 972 | GitHub License 973 | GitHub issues 974 | GitHub Sponsors

975 |

Development only!

976 |

DON'T use this proxy anywhere in production! Having an endpoint where every app can just request tokens without authentication with your developer credentials is a bad idea. 977 | This api is meant to be used during development only! For production check out our extensions to ConfidentialClientApplicationBuilder.

978 |

Using this proxy

979 |
    980 |
  1. Install the proxy with dotnet tool install --global Smartersoft.Identity.Client.Assertion.Proxy
    2. 981 |
  2. Run the proxy with az-kv-proxy or az-kv-proxy --urls http://localhost:5616 if you wish to use another port
    3. 982 |
  3. Open de browser and go to /swagger/index.html
    4. 983 |
  4. Try the endpoints
    5. 984 |
985 |

Usage with Insomnia

986 |
    987 |
  1. Create request called GetToken to one of the three endpoints.
    2. 988 |
  2. Edit the original request, change authentication to Bearer.
    3. 989 |
  3. Select TOKEN field and press CTRL + SPACE, and select Response: Body attribute.
    4. 990 |
  4. Request: Select GetToken, Filter: $.access_token, Trigger Behavior: When Expired and Max Age: 3000 (any number between 300 and 3599)
    5. 991 |
992 |

I like Insomnia over postman, but your millage may vary.

993 |

Usage with postman

994 |
    995 |
  1. Create an environment variable called token.
    2. 996 |
  2. Create a request to one of the 3 endpoints to get a token.
    3. 997 |
  3. In the Tests tab, save the access_token to the environment variable token
    4. 998 |
  4. Change other requests to use environment variable token as the token.
    5. 999 |
1000 |

See this post for more details.

1001 |

Available endpoints

1002 |

This api had several endpoints all requiring different parameters.

1003 |

They all respond with the same data (provided it succeeded to get a token).

1004 | 
{
1005 |   "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIx___0IjoxNTE2MjM5MDIyfQ.SflKxwR___6yJV_adQssw5c",
1006 |   "lifetime": 3600,
1007 |   "expires_on": "2022-01-27T11:26:21.0424181+00:00",
1008 |   "scopes": [
1009 |     "https://graph.microsoft.com/.default"
1010 |   ]
1011 | }
1012 |
1013 |

And there also is a Swagger UI running to try it out in the browser, /swagger/index.html.

1014 |

Using Key Vault Key

1015 |

This is the most efficient way to use the Key Vault with your secret securely saved. It requires to get info about the key.

1016 |
    1017 |
  • URL /api/Token/kv-key
    • 1018 |
  • Method POST
    • 1019 |
1020 | 
{
1021 |   "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47",
1022 |   "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2",
1023 |   "scopes": [
1024 |     "https://graph.microsoft.com/.default"
1025 |   ],
1026 |   "keyUri": "https://{kv-domain}.vault.azure.net/keys/{some-certificate-name}/{cert-version}",
1027 |   "keyThumbprint": "{base64Url-encoded-certificate-hash}"
1028 | }
1029 |
1030 |

Using Key Vault Certificate

1031 |

This endpoint still keeps the certificate in the Key Store, but it does requests information about the certificate on each call. 1032 | Depending on usage, you're better of using the endpoint above this one.

1033 |
    1034 |
  • URL /api/Token/kv-certificate
    • 1035 |
  • Method POST
    • 1036 |
1037 | 
{
1038 |   "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47",
1039 |   "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2",
1040 |   "scopes": [
1041 |     "https://graph.microsoft.com/.default"
1042 |   ],
1043 |   "keyVaultUri": "https://{kv-domain}.vault.azure.net/",
1044 |   "certificateName": "{some-certificate-name}"
1045 | }
1046 |
1047 |

Using Certificate from current user certificate store

1048 |

This endpoint requires you to generate the certificate in the current user certificate store, but is at least safer than using a plain password as a secret.

1049 |
    1050 |
  • URL /api/Token/local-certificate
    • 1051 |
  • Method POST
    • 1052 |
1053 | 
{
1054 |   "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47",
1055 |   "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2",
1056 |   "scopes": [
1057 |     "https://graph.microsoft.com/.default"
1058 |   ],
1059 |   "findType": "FindByThumbprint",
1060 |   "findValue": "{value-to-find-certificate-Thumbprint-in-this-case}"
1061 | }
1062 |
1063 |

Using Certificate from local computer certificate store

1064 |

This endpoint requires you to generate the certificate in the current user certificate store, but is at least safer than using a plain password as a secret.

1065 |
    1066 |
  • URL /api/Token/computer-certificate
    • 1067 |
  • Method POST
    • 1068 |
1069 | 
{
1070 |   "clientId": "7e36ca13-5d1e-4c62-95f1-66570bfcec47",
1071 |   "tenantId": "8cd0791b-341e-40d5-a6de-9a0249c447f2",
1072 |   "scopes": [
1073 |     "https://graph.microsoft.com/.default"
1074 |   ],
1075 |   "findType": "FindByThumbprint",
1076 |   "findValue": "{value-to-find-certificate-Thumbprint-in-this-case}"
1077 | }
1078 |
1079 |

License

1080 |

These packages are licensed under GPL-3.0, if you wish to use this software under a different license. Or you feel that this really helped in your commercial application and wish to support us? You can get in touch and we can talk terms. We are available as consultants.

1081 | 1082 | 1083 | 1084 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------