2015-01-13 12:22:56 +00:00
|
|
|
// Copyright (C) 2014 Jakob Borg
|
2014-09-04 06:31:38 +00:00
|
|
|
|
2014-07-04 13:56:33 +00:00
|
|
|
// Package luhn generates and validates Luhn mod N check digits.
|
2014-06-29 23:42:03 +00:00
|
|
|
package luhn
|
|
|
|
|
2014-07-04 14:16:50 +00:00
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"strings"
|
|
|
|
)
|
2014-06-29 23:42:03 +00:00
|
|
|
|
2014-07-04 13:56:33 +00:00
|
|
|
// An alphabet is a string of N characters, representing the digits of a given
|
|
|
|
// base N.
|
2014-06-29 23:42:03 +00:00
|
|
|
type Alphabet string
|
|
|
|
|
|
|
|
var (
|
2014-07-04 13:56:33 +00:00
|
|
|
Base32 Alphabet = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567"
|
2014-06-29 23:42:03 +00:00
|
|
|
)
|
|
|
|
|
2014-07-04 13:56:33 +00:00
|
|
|
// Generate returns a check digit for the string s, which should be composed
|
|
|
|
// of characters from the Alphabet a.
|
2014-07-04 14:16:50 +00:00
|
|
|
func (a Alphabet) Generate(s string) (rune, error) {
|
2014-07-15 11:04:37 +00:00
|
|
|
if err := a.check(); err != nil {
|
|
|
|
return 0, err
|
2014-07-04 14:16:50 +00:00
|
|
|
}
|
|
|
|
|
2014-06-29 23:42:03 +00:00
|
|
|
factor := 1
|
|
|
|
sum := 0
|
|
|
|
n := len(a)
|
|
|
|
|
|
|
|
for i := range s {
|
|
|
|
codepoint := strings.IndexByte(string(a), s[i])
|
2014-07-04 14:16:50 +00:00
|
|
|
if codepoint == -1 {
|
|
|
|
return 0, fmt.Errorf("Digit %q not valid in alphabet %q", s[i], a)
|
|
|
|
}
|
2014-06-29 23:42:03 +00:00
|
|
|
addend := factor * codepoint
|
|
|
|
if factor == 2 {
|
|
|
|
factor = 1
|
|
|
|
} else {
|
|
|
|
factor = 2
|
|
|
|
}
|
|
|
|
addend = (addend / n) + (addend % n)
|
|
|
|
sum += addend
|
|
|
|
}
|
|
|
|
remainder := sum % n
|
|
|
|
checkCodepoint := (n - remainder) % n
|
2014-07-04 14:16:50 +00:00
|
|
|
return rune(a[checkCodepoint]), nil
|
2014-06-29 23:42:03 +00:00
|
|
|
}
|
|
|
|
|
2014-07-04 13:56:33 +00:00
|
|
|
// Validate returns true if the last character of the string s is correct, for
|
|
|
|
// a string s composed of characters in the alphabet a.
|
2014-06-29 23:42:03 +00:00
|
|
|
func (a Alphabet) Validate(s string) bool {
|
|
|
|
t := s[:len(s)-1]
|
2014-07-04 14:16:50 +00:00
|
|
|
c, err := a.Generate(t)
|
|
|
|
if err != nil {
|
|
|
|
return false
|
|
|
|
}
|
2014-06-29 23:42:03 +00:00
|
|
|
return rune(s[len(s)-1]) == c
|
|
|
|
}
|
2014-07-04 14:16:50 +00:00
|
|
|
|
|
|
|
// check returns an error if the given alphabet does not consist of unique characters
|
|
|
|
func (a Alphabet) check() error {
|
|
|
|
cm := make(map[byte]bool, len(a))
|
|
|
|
for i := range a {
|
|
|
|
if cm[a[i]] {
|
|
|
|
return fmt.Errorf("Digit %q non-unique in alphabet %q", a[i], a)
|
|
|
|
}
|
|
|
|
cm[a[i]] = true
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|