Add implementation

Signed-off-by: jolheiser <john.olheiser@gmail.com>

IMPLEMENTATION.md

@@ -0,0 +1,132 @@
+## User Key Derivation
+([code](user_key.go))
+
+A user's key should be generated at "construction" time of a potential client. The user key derivation step is the
+longer part of the generation and should be separated from the cheaper site key and password generation steps.
+
+### Variables
+
+* `user_name`
+* `user_secret`
+
+### Steps
+
+1. `user_name` as byte slice
+2. `user_secret` as byte slice
+3. `key_scope` ([Authentication](#scopes)) as byte slice
+4. `key_salt` = `key_scope` + `len(user_name)` (big endian) + `user_name`
+5. `user_key` = `scrypt(password = user_secret, salt = key_salt, N = 32768, r = 8, p = 2, key_length = 64)`
+
+Store the `user_key` for use later.
+
+
+## Site Key Generation
+([code](site_key.go))
+
+The site key generation step is part of getting a password and is used against a [template](#templates).
+
+### Variables
+
+* `site_name`
+* `counter`
+* [`scope`](#scopes)
+
+### Steps
+
+1. `site_name` as byte slice
+2. `scope` as byte slice 
+3. `key_salt` = `scope` + `len(site_name)` (big endian) + `site_name` + `counter` (big endian)
+4. `site_key` = `HMAC-SHA256(key = user_key, data = key_salt)`
+
+
+## Site Password Generation
+([code](site_password.go))
+
+### Variables
+
+* `site_name`
+* `counter` (default is `1`)
+* `scope` (default is [Authentication](#scopes))
+* `template_type` (default is [based on scope](#scopes))
+
+### Steps
+
+1. `site_key` as byte slice
+2. `template_set` = `templates[ template_type ]` ([templates](#templates))
+3. `template` = `template_set[ site_key[0] % len(template_set) ]`
+4. for each character `b` in the template (`loop_index` starting at `0`)
+   1. `chars` = `characters[ b ]` ([characters](#characters))
+   2. `char` = `chars[ site_key[ loop_index + 1 ] % len(chars) ]`
+   3. add `char` to output string
+
+
+## Walkthrough
+
+* `user_name` = `Robert Lee Mitchell`
+* `user_secret` = `banana colored duckling`
+* `scope` = [Authentication](#scopes)
+* `counter` = `1`
+* `template` = [Long](#scopes)
+* `site_name` = `masterpasswordapp.com`
+
+### User Key
+
+```text
+[24 76 42 206 37 187 113 129 122 202 164 134 75 113 147 21 177 89 17 50 52 178 162 191 86 144 232 125 103 172 42 251 195 72 15 109 194 103 28 206 230 240 192 133 230 226 64 32 195 166 175 242 54 123 217 242 58 194 205 104 168 74 95 194]
+```
+
+### Site Key
+
+```text
+[18 27 156 216 202 205 54 139 226 53 64 140 63 35 242 105 24 249 162 30 135 30 0 50 101 141 213 27 212 150 120 210]
+```
+
+### Site Password
+
+`Jejr5[RepuSosp`
+
+## Appendix
+
+### Scopes
+([code](scope.go))
+
+|Scope|Value|Default Template|
+|:---:|:---:|:---:|
+|Authentication|`com.lyndir.masterpassword`|Long|
+|Identification|`com.lyndir.masterpaswword.login`|Name|
+|Recovery|`com.lyndir.masterpassword.answer`|Phrase|
+
+**NOTE:** One difference in my implementations compared to the original is allowing consumers to choose
+their own "scoper", some interface that can respond to the three scopes with whatever response they choose.  
+**This means that any custom implementation will not return the same results, so keep that in mind when using
+a service.**
+
+### Templates
+([code](template.go))
+
+|Template|Sets|
+|:---:|:---:|
+|Maximum| `["anoxxxxxxxxxxxxxxxxx", "axxxxxxxxxxxxxxxxxno"]`|
+|Long|`["CvcvnoCvcvCvcv", "CvcvCvcvnoCvcv", "CvcvCvcvCvcvno", "CvccnoCvcvCvcv", "CvccCvcvnoCvcv", "CvccCvcvCvcvno", "CvcvnoCvccCvcv", "CvcvCvccnoCvcv", "CvcvCvccCvcvno", "CvcvnoCvcvCvcc", "CvcvCvcvnoCvcc", "CvcvCvcvCvccno", "CvccnoCvccCvcv", "CvccCvccnoCvcv", "CvccCvccCvcvno", "CvcvnoCvccCvcc", "CvcvCvccnoCvcc", "CvcvCvccCvccno", "CvccnoCvcvCvcc", "CvccCvcvnoCvcc", "CvccCvcvCvccno"]`|
+|Medium|`["CvcnoCvc", "CvcCvcno"]`|
+|Short|`["Cvcn"]`|
+|Pin|`["nnnn"]`|
+|Name|`["cvccvcvcv"]`|
+|Phrase|`["cvcc cvc cvccvcv cvc", "cvc cvccvcvcv cvcv", "cv cvccv cvc cvcvccv"]`|
+|Basic|`["aaanaaan", "aannaaan", "aaannaaa"]`|
+
+### Characters
+([code](template.go))
+
+|Symbol|Set|
+|:---:|:---:|
+|V|`AEIOU`|
+|C|`BCDFGHJKLMNPQRSTVWXYZ`|
+|v|`aeiou`|
+|c|`bcdfghjklmnpqrstvwxyz`|
+|A|`AEIOUBCDFGHJKLMNPQRSTVWXYZ`|
+|a|`AEIOUaeiouBCDFGHJKLMNPQRSTVWXYZbcdfghjklmnpqrstvwxyz`|
+|n|`0123456789`|
+|o|`@&%?,=[]_:-+*$#!'^~;()/.`|
+|x|`AEIOUaeiouBCDFGHJKLMNPQRSTVWXYZbcdfghjklmnpqrstvwxyz0123456789!@#$%^&*()`|
+|(literal space)|` `|

README.md

@@ -9,6 +9,10 @@ It also passes the JS [sanity check](https://gitlab.com/spectre.app/www/-/blob/3
 
 This is because I've only implemented v3 of the algorithm and the main pieces.
 
+[Implementation breakdown](IMPLEMENTATION.md)
+
+Generally code wouldn't split across files this liberally. It's done here for ease of reference.
+
 ## License
 
 [GPLv3](LICENSE) - same as the algorithm author

site_key.go

@@ -0,0 +1,31 @@
+package spectre
+
+import (
+	"crypto/hmac"
+	"crypto/sha256"
+)
+
+func siteKey(userKey []byte, scoper Scoper, siteName string, counter int, scope Scope) []byte {
+	nameBytes := []byte(siteName)
+	scopeBytes := []byte(scoper.Scope(scope))
+
+	nameBytesLen := len(nameBytes)
+	keySalt := append(scopeBytes,
+		byte(nameBytesLen>>24),
+		byte(nameBytesLen>>16),
+		byte(nameBytesLen>>8),
+		byte(nameBytesLen),
+	)
+	keySalt = append(keySalt, nameBytes...)
+	keySalt = append(keySalt,
+		byte(counter>>24),
+		byte(counter>>16),
+		byte(counter>>8),
+		byte(counter),
+	)
+
+	sign := hmac.New(sha256.New, userKey)
+	sign.Write(keySalt)
+
+	return sign.Sum(nil)
+}

site_password.go

@@ -0,0 +1,31 @@
+package spectre
+
+import "strings"
+
+func site(userKey []byte, scoper Scoper, siteName string, opts ...SiteOption) string {
+	siteOpts := &options{
+		template: "",
+		counter:  1,
+		scope:    Authentication,
+	}
+	for _, opt := range opts {
+		opt(siteOpts)
+	}
+
+	if siteOpts.template == "" {
+		siteOpts.template = siteOpts.scope.DefaultTemplate()
+	}
+
+	siteKey := siteKey(userKey, scoper, siteName, siteOpts.counter, siteOpts.scope)
+
+	templateSet := templates[siteOpts.template]
+	template := templateSet[int(siteKey[0])%len(templateSet)]
+
+	var out strings.Builder
+	for idx, b := range template {
+		chars := characters[string(b)]
+		char := chars[int(siteKey[idx+1])%len(chars)]
+		out.WriteByte(char)
+	}
+	return out.String()
+}

spectre.go

@@ -1,12 +1,5 @@
 package spectre
 
-import (
-	"crypto/hmac"
-	"crypto/sha256"
-	"golang.org/x/crypto/scrypt"
-	"strings"
-)
-
 // Spectre is a spectre client
 type Spectre struct {
 	name   string
@@ -26,7 +19,7 @@ func New(name, secret string, opts ...Option) (s *Spectre, err error) {
 	for _, opt := range opts {
 		opt(s)
 	}
-	s.key, err = s.userKey()
+	s.key, err = userKey(s.name, s.secret, s.scoper)
 	return
 }
 
@@ -40,75 +33,9 @@ func WithScoper(scoper Scoper) Option {
 	}
 }
 
-func (s *Spectre) userKey() ([]byte, error) {
-	nameBytes := []byte(s.name)
-	secretBytes := []byte(s.secret)
-	keyScope := []byte(s.scoper.Scope(Authentication))
-
-	nameBytesLen := len(nameBytes)
-	keySalt := append(keyScope,
-		byte(nameBytesLen>>24),
-		byte(nameBytesLen>>16),
-		byte(nameBytesLen>>8),
-		byte(nameBytesLen),
-	)
-	keySalt = append(keySalt, nameBytes...)
-
-	return scrypt.Key(secretBytes, keySalt, 32768, 8, 2, 64)
-}
-
-func (s *Spectre) siteKey(name string, counter int, scope Scope) []byte {
-	nameBytes := []byte(name)
-	scopeBytes := []byte(s.scoper.Scope(scope))
-
-	nameBytesLen := len(nameBytes)
-	keySalt := append(scopeBytes,
-		byte(nameBytesLen>>24),
-		byte(nameBytesLen>>16),
-		byte(nameBytesLen>>8),
-		byte(nameBytesLen),
-	)
-	keySalt = append(keySalt, nameBytes...)
-	keySalt = append(keySalt,
-		byte(counter>>24),
-		byte(counter>>16),
-		byte(counter>>8),
-		byte(counter),
-	)
-
-	sign := hmac.New(sha256.New, s.key)
-	sign.Write(keySalt)
-
-	return sign.Sum(nil)
-}
-
 // Site returns a site password based on Options
 func (s *Spectre) Site(siteName string, opts ...SiteOption) string {
-	siteOpts := &options{
+	return site(s.key, s.scoper, siteName, opts...)
-		template: "",
-		counter:  1,
-		scope:    Authentication,
-	}
-	for _, opt := range opts {
-		opt(siteOpts)
-	}
-
-	if siteOpts.template == "" {
-		siteOpts.template = siteOpts.scope.DefaultTemplate()
-	}
-
-	siteKey := s.siteKey(siteName, siteOpts.counter, siteOpts.scope)
-
-	templateSet := templates[siteOpts.template]
-	template := templateSet[int(siteKey[0])%len(templateSet)]
-
-	var out strings.Builder
-	for idx, b := range template {
-		chars := characters[string(b)]
-		char := chars[int(siteKey[idx+1])%len(chars)]
-		out.WriteByte(char)
-	}
-	return out.String()
 }
 
 type options struct {

user_key.go

@@ -0,0 +1,20 @@
+package spectre
+
+import "golang.org/x/crypto/scrypt"
+
+func userKey(name, secret string, scoper Scoper) ([]byte, error) {
+	nameBytes := []byte(name)
+	secretBytes := []byte(secret)
+	keyScope := []byte(scoper.Scope(Authentication))
+
+	nameBytesLen := len(nameBytes)
+	keySalt := append(keyScope,
+		byte(nameBytesLen>>24),
+		byte(nameBytesLen>>16),
+		byte(nameBytesLen>>8),
+		byte(nameBytesLen),
+	)
+	keySalt = append(keySalt, nameBytes...)
+
+	return scrypt.Key(secretBytes, keySalt, 32768, 8, 2, 64)
+}