updated documentation

arag0re · Jan 6, 2023 · 5f22c14 · 5f22c14
1 parent f4d9e05
commit 5f22c14
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 24 deletions.
diff --git a/prime.go b/prime.go
@@ -1,7 +1,6 @@
 // prime.go - Generate safe primes
 //
 // Copyright 2013-2023 arag0re <arag0re.eth-at-protonmail-dot-com>
-
 // License: MIT
 package srp
 
@@ -35,9 +34,10 @@ func safePrime(bits int) (*big.Int, error) {
 // Return true if g is a generator for safe prime p
 //
 // From Cryptography Theory & Practive, Stinson and Paterson (Th. 6.8 pp 196):
-//   If p > 2 is a prime and g is in Zp*, then
-//   g is a primitive element modulo p iff g ^ (p-1)/q != 1 (mod p)
-//   for all primes q such that q divides (p-1).
+//
+//	If p > 2 is a prime and g is in Zp*, then
+//	g is a primitive element modulo p iff g ^ (p-1)/q != 1 (mod p)
+//	for all primes q such that q divides (p-1).
 //
 // "Primitive Element" and "Generator" are the same thing in Number Theory.
 //

diff --git a/srp.go b/srp.go
@@ -1,8 +1,7 @@
-// srp.go - golang implementation of SRP-6a like apple wants it 
+// srp.go - golang implementation of SRP-6a like apple wants it
 //
 // Copyright 2013-2023 arag0re <arag0re.eth-at-protonmail-dot-com>
 // License: MIT
-//
 
 // Package srp implements SRP-6a per [1]. It uses the standard library
 // and the golang extended library and nothing else.
@@ -20,12 +19,12 @@
 //
 // In this implementation:
 //
-//	H  = SHA1()
-//	k  = H(N | g)
-//  t  = H(I | ':' |P)
-//	x  = H(s | t)
-//	I  = clear text
-//	P  = clear text
+//		H  = SHA1()
+//		k  = H(N | g)
+//	 t  = H(I | ':' |P)
+//		x  = H(s | t)
+//		I  = clear text
+//		P  = clear text
 //
 // Per RFC-5054, we adopt the following padding convention:
 //
@@ -46,7 +45,7 @@ package srp
 //        All arithmetic is done modulo N.
 //   g    A generator modulo N
 //   k    Multiplier parameter 			(k = H(PAD(N) | PAD(g)) in SRP-6a, k = 3 for legacy SRP-6)
-//   s    User's salt		  
+//   s    User's salt
 //   I    Cleartext Username
 //   p    Cleartext Password
 //   t	  auth pair 					(t = H(I | ':' | p))
@@ -395,17 +394,17 @@ func (c *Client) Generate(srv string) (string, error) {
 	if u.Cmp(zero) == 0 {
 		return "", fmt.Errorf("srp: invalid server public key")
 	}
-	t := c.s.hashbyte(c.i, []byte{':'}, c.p)            				// t = H(I | ":" | p)
-	x := c.s.hashint(salt, t)                           				// x = H(s | t)
-	c.S = computeSessionKey(pf.N, pf.g, c.k, x, u, c.a, B) 				// S = 
-	K1 := c.s.hashbyte(c.S.Bytes(), []byte{0, 0, 0, 0})					// creates first half of K (K1) 
-	K2 := c.s.hashbyte(c.S.Bytes(), []byte{0, 0, 0, 1})					// creates second half of K (K2)
-	c.xK = append(K1, K2...) 											// K = H(S | \x00\x00\x00\x00) | H(S | \x00\x00\x00\x01)
-	hN := c.s.hashbyte(pf.N.Bytes())									// hN = H(N)
-	hg := c.s.hashbyte(pf.g.Bytes())									// hg = H(g)
-	hNhg := xor(hN, hg)													// hNhg = hN ^ hg	
-	hu := c.s.hashbyte(c.i)												// hu = H(I)	
-	c.xM = c.s.hashbyte(hNhg, hu, salt, c.xA.Bytes(), B.Bytes(), c.xK) 	// M1 = H(hNhg | hu | A | B | K)
+	t := c.s.hashbyte(c.i, []byte{':'}, c.p)                           // t = H(I | ":" | p)
+	x := c.s.hashint(salt, t)                                          // x = H(s | t)
+	c.S = computeSessionKey(pf.N, pf.g, c.k, x, u, c.a, B)             // S =
+	K1 := c.s.hashbyte(c.S.Bytes(), []byte{0, 0, 0, 0})                // creates first half of K (K1)
+	K2 := c.s.hashbyte(c.S.Bytes(), []byte{0, 0, 0, 1})                // creates second half of K (K2)
+	c.xK = append(K1, K2...)                                           // K = H(S | \x00\x00\x00\x00) | H(S | \x00\x00\x00\x01)
+	hN := c.s.hashbyte(pf.N.Bytes())                                   // hN = H(N)
+	hg := c.s.hashbyte(pf.g.Bytes())                                   // hg = H(g)
+	hNhg := xor(hN, hg)                                                // hNhg = hN ^ hg
+	hu := c.s.hashbyte(c.i)                                            // hu = H(I)
+	c.xM = c.s.hashbyte(hNhg, hu, salt, c.xA.Bytes(), B.Bytes(), c.xK) // M1 = H(hNhg | hu | A | B | K)
 	//fmt.Println(len(c.xM))
 
 	return hex.EncodeToString(c.xM), nil