AlgorandAuthentication 1.0.9

There is a newer version of this package available.
See the version list below for details.
dotnet add package AlgorandAuthentication --version 1.0.9                
NuGet\Install-Package AlgorandAuthentication -Version 1.0.9                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AlgorandAuthentication" Version="1.0.9" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AlgorandAuthentication --version 1.0.9                
#r "nuget: AlgorandAuthentication, 1.0.9"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install AlgorandAuthentication as a Cake Addin
#addin nuget:?package=AlgorandAuthentication&version=1.0.9

// Install AlgorandAuthentication as a Cake Tool
#tool nuget:?package=AlgorandAuthentication&version=1.0.9                

Algorand Standard for authentication implementation in .net

ARC-0014 implementation in .net

https://github.com/algorandfoundation/ARCs/issues/42

Usage

StartUp.cs

public void ConfigureServices(
	IServiceCollection services)
{

...

	var algorandAuthenticationOptions = new AlgorandAuthenticationOptions();
	builder.Configuration.GetSection("AlgorandAuthentication").Bind(algorandAuthenticationOptions);

	builder.Services
	 .AddAuthentication(AlgorandAuthenticationHandler.ID)
	 .AddAlgorand(o =>
	 {
		 o.CheckExpiration = algorandAuthenticationOptions.CheckExpiration;
		 o.Debug = algorandAuthenticationOptions.Debug;
		 o.AlgodServer = algorandAuthenticationOptions.AlgodServer;
		 o.AlgodServerToken = algorandAuthenticationOptions.AlgodServerToken;
		 o.AlgodServerHeader = algorandAuthenticationOptions.AlgodServerHeader;
		 o.Realm = algorandAuthenticationOptions.Realm;
		 o.NetworkGenesisHash = algorandAuthenticationOptions.NetworkGenesisHash;
		 o.MsPerBlock = algorandAuthenticationOptions.MsPerBlock;
		 o.EmptySuccessOnFailure = algorandAuthenticationOptions.EmptySuccessOnFailure;
		 o.EmptySuccessOnFailure = algorandAuthenticationOptions.EmptySuccessOnFailure;
	 });

...

}

public void Configure(
	IApplicationBuilder app
	)
{

...

  app.UseAuthentication();
  app.UseAuthorization();

...

}

appsettings.json

{
  "AlgorandAuthentication": {
    "AlgodServer": "https://testnet-api.algonode.cloud",
    "AlgodServerToken": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "NetworkGenesisHash": "SGO1GKSzyE7IEPItTxCByw9x8FmnrCDexi9/cOUJOiI=",
    "AlgodServerHeader": "X-Algo-API-Token",
    "Realm": "2FA#ARC14",
    "CheckExpiration": "true",
    "Debug": "true"
  }
}

Controller/Example.cs

        [Authorize]
        [HttpPost("Create")]
        public async Task<ActionResult<bool>> Create()
        {
        ...
        }

Activity diagram

Plantuml:

@startuml

User -> Website: User wish to login to the website 


Website -> AnyAlgorandNode : Request /v2/transactions/params
AnyAlgorandNode  -> Website : Returns transaction params

Website -> Wallet : Website produces through algosdk messege to be signed, note as realm, params as session timeout
Wallet -> Website: Signed tx, website stores tx in temporary memory, localstorage or cookie the same as jwt

Website --> User: Displays eg auth address

Website -> Backend: Request authorized method, use SigTx Authorization header, fe /getUser

Backend -> AnyAlgorandNode : Request /v2/transactions/params
AnyAlgorandNode  -> Backend : Returns current block round number

Backend -> Website: 401 if signature, genesis or round is wrong
Backend -> Website: 200 if authorized and returns content

Website --> User: Displays /getUser content, fe roles or username

@enduml

image

Example use

Algorand KMD Node

Algorand KMD Node is proxy to algorand participation node which allow to create participation keys. It uses ARC-0014 authentication to ensure no spam traffic to cpu sensitive methods.

https://github.com/scholtz/AlgorandKMDServer/blob/f9d04b717f0f58cf9151bd8fa9a65b7e805db87c/Program.cs#L48

Hasura Algorand Auth Web Hook

GraphQL algorand authentication for live websocket authenticated feeds.

https://github.com/scholtz/HasuraAlgorandAuthWebHook

Algorand 2FA Multisig

Project aims to create multisig account from hot wallet account, 2fa authentication account and cold storage account.

https://github.com/scholtz/Algorand2FAMultisig

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.11 97 10/15/2024
1.0.10 90 10/15/2024
1.0.9 270 6/25/2023
1.0.8 170 5/22/2023
1.0.7 477 9/16/2022
1.0.6 481 9/14/2022
1.0.5 481 9/14/2022
1.0.4 466 4/5/2022
1.0.3 436 4/5/2022
1.0.2 433 4/4/2022
1.0.0 412 10/31/2021