frends-community - Frends.Community.OAuth 2.3.0

Task to handle OAuth JWT tokens and Authorization headers.

PM> Install-Package Frends.Community.OAuth -Version 2.3.0 -Source https://www.myget.org/F/frends-community/api/v3/index.json

Copy to clipboard

> nuget.exe install Frends.Community.OAuth -Version 2.3.0 -Source https://www.myget.org/F/frends-community/api/v3/index.json

Copy to clipboard

> dotnet add package Frends.Community.OAuth --version 2.3.0 --source https://www.myget.org/F/frends-community/api/v3/index.json

Copy to clipboard

<PackageReference Include="Frends.Community.OAuth" Version="2.3.0" />

Copy to clipboard

source https://www.myget.org/F/frends-community/api/v3/index.json

nuget Frends.Community.OAuth  ~> 2.3.0

Copy to clipboard

> choco install Frends.Community.OAuth --version 2.3.0 --source https://www.myget.org/F/frends-community/api/v2

Copy to clipboard

Import-Module PowerShellGet
Register-PSRepository -Name "frends-community" -SourceLocation "https://www.myget.org/F/frends-community/api/v2"
Install-Module -Name "Frends.Community.OAuth" -RequiredVersion "2.3.0" -Repository "frends-community"

Copy to clipboard

Browse the sources in this package using Visual Studio or WinDbg by configuring the following legacy symbol server URL: https://www.myget.org/F/frends-community/symbols/

Frends.Community.OAuth

frends Community Task for OAuth.

MyGet

Installing
Tasks
Building
Contributing
Change Log

Installing

You can install the Task via frends UI Task View or you can find the NuGet package from the following NuGet feed https://www.myget.org/F/frends-community/api/v3/index.json and in Gallery view in MyGet https://www.myget.org/feed/frends-community/package/nuget/Frends.Community.OAuth

Tasks

CreateJwtToken

Task creates a signed JWT token.

Parameters

Property	Type	Description	Example
Issuer	`string`	Principal that issued the JWT.	`COOL_ISSUER`
Audience	`string`	The recipient(s) the JWT is intended for.	`COOL_AUDIENCE`
Expires	`DateTime?`	The expiration time on or after which the JWT must not be accepted for processing.	`DateTime.Now.AddDays(7)`
NotBefore	`DateTime?`	The time before which the JWT must not be accepted for processing.	`DateTime.Now.AddDays(7)`
PrivateKey	`string`	Private key in PEM format	See https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail
X509Thumbprint	`string`	X509 Certificate SHA-1 Thumbprint for x5t header as Base64 encoded string. Added only if the SigningAlgorithm is asymmetric	`m5836ev678LlLGyFEdq+Ec71Inw=`
SigningAlgorithm	enum<RS256, RS384, RS512, HS256, HS384, HS512, HMACSHA256>	Algorithm used for signing the token.	`RS256`
Claims	`JwtClaim[]`	Claim(s) that identifiy the principal that is the subject of the JWT. Multiple claims with same keys/names can be added. Claims are optional.	`[` `{ "Name", "John Doe" },` `{ "EMail", "john@example.com" },` `{ "Roles", "admin" },` `{ "Roles", "user" }` `]`

JwtClaim

Each identifies the principal that is the subject of the JWT.

Property	Type	Description	Example
ClaimKey	`string`	Key value for the claim.	`COOL_ISSUER`
ClaimValue	`string`	The value paired with the given key.	`COOL_AUDIENCE`

Result

Type	Description	Example
`string`	The JWT token signed with the provided private key.

ParseToken

Parses the provided OAuth JWT token or Authorization header. There is an option to skip validations.

Input

Property	Type	Description	Example
AuthHeaderOrToken	`string`	Either the JWT token or the AuthHeader through #trigger.data.httpHeaders["Authorization"]	`eyJ0eXAi...`
Audience	`string`	The expected Audiences of the token, e.g. ClientId	`fIVLouKUZihXfYP3...`
Issuer	`string`	The expected Issuer of the token	`https://example.eu.auth0.com`
ConfigurationSource	enum<WellKnownConfigurationUrl, Static>	Option whether to use .well-known or a static jwks configuration	WellKnownConfigurationUrl
WellKnownConfigurationUrl	`string`	.well-known configuration URL	`https://example.eu.auth0.com/.well-known/openid-configuration`
StaticJwksConfiguration	`string`	Staticly provided public keys used to sign the token	`{\"keys\":[{\"alg\":\"RS256\",\"kty\":\"RSA\",\"use\":\"sig\",\"x5c\":[\"MIIDATC...`

Options

Property	Type	Description	Example
SkipIssuerValidation	`bool`	Should issuer validation be skipped	`false`
SkipAudienceValidation	`bool`	Should audience validation be skipped	`false`
SkipLifetimeValidation	`bool`	Should lifetime validation be skipped	`false`
DecryptToken	`bool`	Should token be decrypted	`false`
DecryptionKey	`string`	Decryption key in PEM format	See https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail

Result

Property	Type	Description	Example
ClaimPrincipal	ClaimsPrincipal	The ClaimsPrincipal parsed from the token.
Token	JwtSecurityToken	The validated security token. If you want the token as a string use .ToString() method (e.g. #result.Token.ToString())

ReadToken

Parses a string into an JwtSecurityToken.

Input

Property	Type	Description	Example
JWTToken	`string`	A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.	`eyJ0eXAi...`

Result

Type	Description	Example
JwtSecurityToken	The security token. If you want the token as a string use .ToString() method (e.g. #result.ToString())

Validate

Validates the provided OAuth JWT token or the authorization header.

Input

Property	Type	Description	Example
AuthHeaderOrToken	`string`	Either the JWT token or the AuthHeader through #trigger.data.httpHeaders["Authorization"]	`eyJ0eXAi...`
Audience	`string`	The expected Audiences of the token, e.g. ClientId	`fIVLouKUZihXfYP3...`
Issuer	`string`	The expected Issuer of the token	`https://example.eu.auth0.com`
ConfigurationSource	enum<WellKnownConfigurationUrl, Static>	Option whether to use .well-known or a static jwks configuration	WellKnownConfigurationUrl
WellKnownConfigurationUrl	`string`	.well-known configuration URL	`https://example.eu.auth0.com/.well-known/openid-configuration`
StaticJwksConfiguration	`string`	Staticly provided public keys used to sign the token	`{\"keys\":[{\"alg\":\"RS256\",\"kty\":\"RSA\",\"use\":\"sig\",\"x5c\":[\"MIIDATC...`

Result

The result is an object with following properties

Property	Type	Description	Example
ClaimPrincipal	ClaimsPrincipal	The ClaimsPrincipal parsed from the token.
Token	JwtSecurityToken	The validated security token. If you want the token as a string use .ToString() method (e.g. #result.Token.ToString())

Building

Clone a copy of the repository.

git clone https://github.com/CommunityHiQ/Frends.Community.OAuth.git

Build the project.

dotnet build

Run tests.

dotnet test

Create a NuGet package.

dotnet pack --configuration Release

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Fork the repository on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Change Log

Version	Changes
1.0.0	Frends.Community.OAuth.Validate and Frends.Community.JWT.CreateToken merged as one task collection.
2.0.0	Renaming ReadToken to ReadJwtToken.
2.1.0	Tasks now imports correctly to frends.
2.1.0	Tasks now correctly saves in .Net Standard 2.0 processes.
2.3.0	Signing algorithm and token decryption options added
2.4.0	x5t Header option for JTWToken creation added
2.5.0	Added support for HMACSHA256 encryption.

.NETFramework 4.7.1
- Microsoft.CSharp (>= 4.7.0)
- Microsoft.IdentityModel.Protocols (>= 6.8.0)
- Microsoft.IdentityModel.Protocols.OpenIdConnect (>= 6.8.0)
- Microsoft.IdentityModel.Tokens (>= 6.8.0)
- Newtonsoft.Json (>= 12.0.1)
- PemUtils (>= 3.0.0.82)
- System.ComponentModel.Annotations (>= 4.7.0)
- System.IdentityModel.Tokens.Jwt (>= 6.8.0)
.NETStandard 2.0
- Microsoft.CSharp (>= 4.7.0)
- Microsoft.IdentityModel.Protocols (>= 6.8.0)
- Microsoft.IdentityModel.Protocols.OpenIdConnect (>= 6.8.0)
- Microsoft.IdentityModel.Tokens (>= 6.8.0)
- Newtonsoft.Json (>= 12.0.1)
- PemUtils (>= 3.0.0.82)
- System.ComponentModel.Annotations (>= 4.7.0)
- System.IdentityModel.Tokens.Jwt (>= 6.8.0)

.NETFramework 4.7.1: 4.7.1.0
.NETStandard 2.0: 2.0.0.0

Assembly	Assembly hash	Match
/lib/net471/frends.community.oauth.dll	598467a52a8349f08ab2928fc596b6feFFFFFFFF
/lib/netstandard2.0/frends.community.oauth.dll	d3d7b81128c142e697d7a48bc96800c8FFFFFFFF

Owners

FRENDS Community Feed User

Authors

HiQ Finland

Project URL

https://github.com/CommunityHiQ/Frends.Community.OAuth

License

Unknown

Info

358 total downloads

31 downloads for version 2.3.0

Download (21.61 KB)

Download legacy symbols (35.65 KB)

Found on the current feed only

Package history

Version	Size	Last updated	Downloads
2.5.0	45.62 KB	Fri, 22 Aug 2025 06:10:51 GMT	12
2.4.1	45.07 KB	Mon, 10 Feb 2025 07:56:07 GMT	27
2.4.0	23.06 KB	Tue, 26 Apr 2022 05:52:21 GMT	150
2.3.0	21.61 KB	Mon, 10 Jan 2022 12:00:51 GMT	31
2.2.0	19.7 KB	Fri, 26 Feb 2021 13:16:27 GMT	51
2.1.0	19.71 KB	Wed, 24 Feb 2021 09:39:00 GMT	9
2.0.0	19.7 KB	Mon, 22 Feb 2021 13:19:23 GMT	7
1.0.1	9.14 KB	Tue, 29 Sep 2020 06:22:13 GMT	26
1.0.0	19.38 KB	Mon, 15 Feb 2021 13:28:00 GMT	45

frends-community - Frends.Community.OAuth 2.3.0

Frends.Community.OAuth

Installing

Tasks

CreateJwtToken

Parameters

JwtClaim

Result

ParseToken

Input

Options

Result

ReadToken

Input

Result

Validate

Input

Result

Building

Contributing

Change Log

Owners

Authors

Project URL

License

Tags

Info

Package history