SimpleOTP 1.0.0

.NET 5.0
There is a newer version of this package available.
See the version list below for details.
Install-Package SimpleOTP -Version 1.0.0
dotnet add package SimpleOTP --version 1.0.0
<PackageReference Include="SimpleOTP" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SimpleOTP --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SimpleOTP, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install SimpleOTP as a Cake Addin
#addin nuget:?package=SimpleOTP&version=1.0.0

// Install SimpleOTP as a Cake Tool
#tool nuget:?package=SimpleOTP&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

SimpleOTP

.NET library for TOTP/HOTP implementation on server (ASP.NET) or client (Xamarin) side

Features

  • Generate and validate OTP codes
  • Support of TOTP (RFC 6238) and HOTP (RFC 4226) algorithms
  • Support of HMAC-SHA1, HMAC-SHA256 and HMAC-SHA512 hashing algorithms
  • Setup URI parser
  • Database-ready configuration models
  • Configuration generator for server-side implementation
  • QR code generator
  • No dependencies

Usage

See more at project's wiki

Generate code

string sample_config_uri = "otpauth://totp/FoxDev%20Studio:eugene@xfox111.net?secret=ESQVTYRM2CWZC3NX24GRRWIAUUWVHWQH&issuer=FoxDev%20Studio";
OTPConfiguration config = OTPConfiguration.GetConfiguration(sample_config_uri);
// OTPModel { Id = af2358b0-3f69-4dd7-9537-32c07d6663aa, Type = TOTP, IssuerLabel = FoxDev Studio, AccountName = eugene@xfox111.net, Secret = ESQVTYRM2CWZC3NX24GRRWIAUUWVHWQH, Issuer = FoxDev Studio, Algorithm = SHA1, Digits = 6, Counter = 0, Period = 00:00:30 }

OTPCode code = OTPService.GenerateCode(ref config);
// OTPasswordModel { Code = 350386, Expiring = 23-May-21 06:08:30 PM }

Validate code

int codeToValidate = 350386;
bool isValid = OTPService.ValidateCode(codeToValidate, config, TimeSpan.FromSeconds(30)); // True

Generate setup config

OTPConfiguration config = OTPConfiguration.GenerateConfiguration("FoxDev Studio", "eugene@xfox111.net");
// OTPModel { Id = af2358b0-3f69-4dd7-9537-32c07d6663aa, Type = TOTP, IssuerLabel = FoxDev Studio, AccountName = eugene@xfox111.net, Secret = ESQVTYRM2CWZC3NX24GRRWIAUUWVHWQH, Issuer = FoxDev Studio, Algorithm = SHA1, Digits = 6, Counter = 0, Period = 00:00:30 }

Uri uri = config.GetUri();	// otpauth://totp/FoxDev%20Studio:eugene@xfox111.net?secret=ESQVTYRM2CWZC3NX24GRRWIAUUWVHWQH&issuer=FoxDev%20Studio
string qrCode = config.GetQrImage(300); // data:image/png;base64,...

Streamline code generation for client

OTPFactory factory = new (config);

factory.CodeUpdated += (newCode) => Console.WriteLine(newCode);
// OTPasswordModel { Code = 350386, Expiring = 23-May-21 06:08:30 PM }
factory.PropertyChanged += (sender, args) =>
{
	if (args.PropertyName == nameof(factory.TimeLeft))
		Console.WriteLine(factory.TimeLeft);
	else
		Console.WriteLine(factory.Code);
}
...
factory.Dispose();

Download

Contributing

There are many ways in which you can participate in the project, for example:

If you are interested in fixing issues and contributing directly to the code base, please see the Contribution Guidelines, which covers the following:

Code of Conduct

This project has adopted the Contributor Covenant. For more information see the Code of Conduct

Copyrights

©2021 Eugene Fox

Licensed under MIT License

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net5.0

    • No dependencies.

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.2.3 155 12/5/2021
1.2.2 284 7/8/2021
1.2.1 142 6/13/2021
1.2.0 164 6/12/2021
1.1.0 175 5/30/2021
1.0.0 164 5/28/2021