Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Algorithm and Digits methods #74

Merged
merged 2 commits into from
Aug 3, 2022
Merged

Add Algorithm and Digits methods #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac895e9
Add Algorithm and Digits methods
dominikschulz Aug 2, 2022
2304ae8
Make Digits return Digits not unit64
dominikschulz Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 39 additions & 7 deletions otp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@
package otp

import (
"github.com/boombuler/barcode"
"github.com/boombuler/barcode/qr"

"crypto/md5"
"crypto/sha1"
"crypto/sha256"
Expand All @@ -30,8 +27,11 @@ import (
"hash"
"image"
"net/url"
"strings"
"strconv"
"strings"

"github.com/boombuler/barcode"
"github.com/boombuler/barcode/qr"
)

// Error when attempting to convert the secret from base32 to raw bytes.
Expand Down Expand Up @@ -61,7 +61,6 @@ func NewKeyFromURL(orig string) (*Key, error) {
s := strings.TrimSpace(orig)

u, err := url.Parse(s)

if err != nil {
return nil, err
}
Expand All @@ -81,7 +80,6 @@ func (k *Key) String() string {
// to enroll a user's TOTP/HOTP key.
func (k *Key) Image(width int, height int) (image.Image, error) {
b, err := qr.Encode(k.orig, qr.M, qr.Auto)

if err != nil {
return nil, err
}
Expand Down Expand Up @@ -146,11 +144,45 @@ func (k *Key) Period() uint64 {
if u, err := strconv.ParseUint(q.Get("period"), 10, 64); err == nil {
return u
}

// If no period is defined 30 seconds is the default per (rfc6238)
return 30
}

// Digits returns a tiny int representing the number of OTP digits.
func (k *Key) Digits() Digits {
q := k.url.Query()

if u, err := strconv.ParseUint(q.Get("digits"), 10, 64); err == nil {
switch u {
case 8:
return DigitsEight
default:
return DigitsSix
}
}

// Six is the most common value.
return DigitsSix
}

// Algorithm returns the algorithm used or the default (SHA1).
func (k *Key) Algorithm() Algorithm {
q := k.url.Query()

a := strings.ToLower(q.Get("algorithm"))
switch a {
case "md5":
return AlgorithmMD5
case "sha256":
return AlgorithmSHA256
case "sha512":
return AlgorithmSHA512
default:
return AlgorithmSHA1
}
}

// URL returns the OTP URL as a string
func (k *Key) URL() string {
return k.url.String()
Expand Down
8 changes: 5 additions & 3 deletions otp_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,20 @@
package otp

import (
"github.com/stretchr/testify/require"

"testing"

"github.com/stretchr/testify/require"
)

func TestKeyAllThere(t *testing.T) {
k, err := NewKeyFromURL(`otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example`)
k, err := NewKeyFromURL(`otpauth://totp/Example:alice@google.com?secret=JBSWY3DPEHPK3PXP&issuer=Example&algorithm=sha256&digits=8`)
require.NoError(t, err, "failed to parse url")
require.Equal(t, "totp", k.Type(), "Extracting Type")
require.Equal(t, "Example", k.Issuer(), "Extracting Issuer")
require.Equal(t, "alice@google.com", k.AccountName(), "Extracting Account Name")
require.Equal(t, "JBSWY3DPEHPK3PXP", k.Secret(), "Extracting Secret")
require.Equal(t, AlgorithmSHA256, k.Algorithm())
require.Equal(t, DigitsEight, k.Digits())
}

func TestKeyIssuerOnlyInPath(t *testing.T) {
Expand Down