README
¶
Current test status
totp
This package implements the RFC 6238 OATH-TOTP algorithm;
Installation
go get github.com/sec51/twofactor
Features
-
Built-in support for secure crypto keys generation
-
Built in encryption of the secret keys when converted to bytes, so that they can be safely transmitted over the network, or stored in a DB
-
Built-in back-off time when a user fails to authenticate more than 3 times
-
Bult-in serialization and deserialization to store the one time token struct in a persistence layer
-
Automatic re-synchronization with the client device
-
Built-in generation of a PNG QR Code for adding easily the secret key on the user device
-
Supports 6, 7, 8 digits tokens
-
Supports HMAC-SHA1, HMAC-SHA256, HMAC-SHA512
Storing Keys
The key is created using Golang crypto random function. It's a secret key and therefore it needs to be protected against unauthorized access. The key cannot be leaked, otherwise the security is completely compromised. The key is presented to the user in a form of QR Code. Once scanned the key should never be revealed again. In addition when the QR code is shared with the client for scanning, the connection used must be secured (HTTPS).
The totp struct can be easily serialized using the ToBytes() function.
The bytes can then be stored on a persistent layer (database for example). The bytes are encrypted using cryptoengine library (NaCl)
You can then retrieve the object back with the function: TOTPFromBytes
You can transfer the bytes securely via a network connection (Ex. if the database is in a different server) because they are encrypted and authenticated.
The struct needs to be stored in a persistent layer becase its values, like last token verification time, max user authentication failures, etc.. need to be preserved. The secret key needs to be preserved too, between the user accound and the user device. The secret key is in fact used to derive tokens.
Upcoming features
-
Generation of recovery tokens.
-
Integration with Twilio for sending the token via SMS, in case the user loses its entry in the Google authenticator app.
Example Usages
Case 1: Google Authenticator
- How to use the library
1- Import the library
import github.com/sec51/twofactor
2- Instanciate the totp object via:
otp, err := twofactor.NewTOTP("info@sec51.com", "Sec51", crypto.SHA1, 8)
if err != nil {
return err
}
3- Display the PNG QR code to the user and an input text field, so that he can insert the token generated from his device
qrBytes, err := otp.QR()
if err != nil {
return err
}
4- Verify the user provided token, coming from the google authenticator app
err := otp.Validate(USER_PROVIDED_TOKEN)
if err != nil {
return err
}
// if there is an error, then the authentication failed
// if it succeeded, then store this information and do not display the QR code ever again.
5- All following authentications should display only a input field with no QR code.
Case 2: Calculate OTP from secret
If you used the totp.Secret() function, you got a string, so first we have to convert it back into an []byte object and after start to initialize the object.
secretBytes, err := base32.StdEncoding.DecodeString(reqSecret.TwofactorSecret)
if err != nil {
panic(fmt.Errorf("couldn't convert base32 secret to string: %w", err))
}
totp, err := twofactor.NewTOTPWithKey(secretBytes, "YOUR_USER_ACCOUNT", "YOUR_ISSUER", crypto.SHA256, 6)
if err != nil {
panic(fmt.Errorf("couldn't create TOTP object: %w", err))
}
otp := twofactor.CalculateTOTP(totp, 0)
fmt.Printf("OTP: %v\n", otp)
References
Author
Initialliy totp was written by Sec51 info@sec51.com and the further development was made by dnnspaul dennis@blaumedia.com.
License
Copyright (c) 2015 Sec51.com <info@sec51.com>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Documentation
¶
Overview ¶
The package twofactor implements the RFC 6238 TOTP: Time-Based One-Time Password Algorithm
The library provides a simple and secure way to generate and verify the OTP tokens and provides the possibility to display QR codes out of the box
The library supports HMAC-SHA1, HMAC-SHA256, HMAC-SHA512
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
LockDownError = errors.New("The verification is locked down, because of too many trials.")
)
Functions ¶
func CalculateTOTP ¶ added in v1.0.2
Private function which calculates the OTP token based on the index offset example: 1 * steps or -1 * steps
Types ¶
type Totp ¶
type Totp struct {
// contains filtered or unexported fields
}
WARNING: The `Totp` struct should never be instantiated manually! Use the `NewTOTP` function
func NewTOTP ¶
This function creates a new TOTP object This is the function which is needed to start the whole process account: usually the user email issuer: the name of the company/service hash: is the crypto function used: crypto.SHA1, crypto.SHA256, crypto.SHA512 digits: is the token amount of digits (6 or 7 or 8) steps: the amount of second the token is valid it automatically generates a secret key using the golang crypto rand package. If there is not enough entropy the function returns an error The key is not encrypted in this package. It's a secret key. Therefore if you transfer the key bytes in the network, please take care of protecting the key or in fact all the bytes.
func NewTOTPWithKey ¶ added in v1.0.2
func TOTPFromBytes ¶
TOTPFromBytes converts a byte array to a totp object it stores the state of the TOTP object, like the key, the current counter, the client offset, the total amount of verification failures and the last time a verification happened
func (*Totp) QR ¶
QR generates a byte array containing QR code encoded PNG image, with level Q error correction, needed for the client apps to generate tokens The QR code should be displayed only the first time the user enabled the Two-Factor authentication. The QR code contains the shared KEY between the server application and the client application, therefore the QR code should be delivered via secure connection.
func (*Totp) Secret ¶
Secret returns the underlying base32 encoded secret. This should only be displayed the first time a user enables 2FA, and should be transmitted over a secure connection. Useful for supporting TOTP clients that don't support QR scanning.
func (*Totp) ToBytes ¶
ToBytes serialises a TOTP object in a byte array Sizes: 4 4 N 8 4 4 N 4 N 4 4 4 8 4 Format: |total_bytes|key_size|key|counter|digits|issuer_size|issuer|account_size|account|steps|offset|total_failures|verification_time|hashFunction_type| hashFunction_type: 0 = SHA1; 1 = SHA256; 2 = SHA512 The data is encrypted using the cryptoengine library (which is a wrapper around the golang NaCl library) TODO: 1- improve sizes. For instance the hashFunction_type could be a short.
func (*Totp) Validate ¶
This function validates the user provided token It calculates 3 different tokens. The current one, one before now and one after now. The difference is driven by the TOTP step size Based on which of the 3 steps it succeeds to validates, the client offset is updated. It also updates the total amount of verification failures and the last time a verification happened in UTC time Returns an error in case of verification failure, with the reason There is a very basic method which protects from timing attacks, although if the step time used is low it should not be necessary An attacker can still learn the synchronization offset. This is however irrelevant because the attacker has then 30 seconds to guess the code and after 3 failures the function returns an error for the following 5 minutes
Source Files