This is an implementation of HOTP and TOTP which are commonly used for multi factor authentication by using a shared key between the client and the server to generate and verify one time use codes. This library is capable of generating and verifying both TOTP and HOTP authentication codes. The calculations in this library are known to be compatible with Google 2-Step Verification and consequently the Google Authenticator smartphone app. It is also known to be able to generate codes for Amazon Web Services Multi Factor Authentication and Dropbox 2 step authentication. It should work with any other service or client that is RFC compliant.
This library is released under an MIT license. No warranty is provided as to the correctness of the library and the consumer of the library assumes all risk for the use thereof, as per the MIT license.
Every effort has gone into implementing this library in accordance with the RFCs mentioned above. However it is up to the users of this library to read through the RFCs and ensure that this implementation is in accordance with the security procedures outlined therein.
The implementation includes the code calculation as well as simple verification. Persistence of the keys, secure key storage, ensuring that a single code can't be validated multiple times and other things are not a part of this library. Thus far those functions (and any others mentioned in the RFCs) are up to the consumer of this library.
For documentation please visit the project website.
See the version list below for details.
Install-Package OtpSharp -Version 22.214.171.124
dotnet add package OtpSharp --version 126.96.36.199
<PackageReference Include="OtpSharp" Version="188.8.131.52" />
paket add OtpSharp --version 184.108.40.206
1.1 Change the Key api to no longer require returning the plaintext key. (will break any custom key implementations)
1.0.6 Change the computed values from ints to padded strings. (Breaking change but is a more appropriate API)
1.0.5 Change package name from OTP-Sharp to OtpSharp
1.0.4 Changed the Protected Key API to be more explicit (may break existing direct useage of the protected key)
The protected key no longer implicitly causes side effects (destroying the plaintext key provided must be done explicitly)
Added a time correction class with experimental NTP abilities.
This package has no dependencies.
This package is not used by any popular GitHub repositories.