mirror of
https://github.com/jeremyd/ergo.git
synced 2026-07-27 01:18:10 -07:00
first draft of atheme migration code
This commit is contained in:
Shivaram Lingamneni
@@ -0,0 +1,20 @@
|
||||
package migrations
|
||||
|
||||
import (
|
||||
"golang.org/x/crypto/bcrypt"
|
||||
)
|
||||
|
||||
// See the v12-to-v13 schema change. The format of this hash is:
|
||||
// 30 bytes of global salt, 30 bytes of per-passphrase salt, then the bcrypt hash
|
||||
func CheckOragonoPassphraseV0(hash, passphrase []byte) error {
|
||||
globalSalt := hash[:30]
|
||||
passphraseSalt := hash[30:60]
|
||||
bcryptHash := hash[60:]
|
||||
assembledPasswordBytes := make([]byte, 0, 60+len(passphrase)+2)
|
||||
assembledPasswordBytes = append(assembledPasswordBytes, globalSalt...)
|
||||
assembledPasswordBytes = append(assembledPasswordBytes, '-')
|
||||
assembledPasswordBytes = append(assembledPasswordBytes, passphraseSalt...)
|
||||
assembledPasswordBytes = append(assembledPasswordBytes, '-')
|
||||
assembledPasswordBytes = append(assembledPasswordBytes, passphrase...)
|
||||
return bcrypt.CompareHashAndPassword(bcryptHash, assembledPasswordBytes)
|
||||
}
|
||||
@@ -0,0 +1,183 @@
|
||||
package migrations
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"crypto/hmac"
|
||||
"crypto/md5"
|
||||
"crypto/sha1"
|
||||
"crypto/sha256"
|
||||
"crypto/sha512"
|
||||
"crypto/subtle"
|
||||
"encoding/base64"
|
||||
"encoding/hex"
|
||||
"errors"
|
||||
"hash"
|
||||
"strconv"
|
||||
|
||||
"github.com/GehirnInc/crypt/md5_crypt"
|
||||
"golang.org/x/crypto/pbkdf2"
|
||||
)
|
||||
|
||||
var (
|
||||
ErrHashInvalid = errors.New("password hash invalid for algorithm")
|
||||
ErrHashCheckFailed = errors.New("passphrase did not match stored hash")
|
||||
|
||||
hmacServerKeyText = []byte("Server Key")
|
||||
athemePBKDF2V2Prefix = []byte("$z")
|
||||
)
|
||||
|
||||
type PassphraseCheck func(hash, passphrase []byte) (err error)
|
||||
|
||||
func CheckAthemePassphrase(hash, passphrase []byte) (err error) {
|
||||
if len(hash) < 60 {
|
||||
return checkAthemePosixCrypt(hash, passphrase)
|
||||
} else if bytes.HasPrefix(hash, athemePBKDF2V2Prefix) {
|
||||
return checkAthemePBKDF2V2(hash, passphrase)
|
||||
} else {
|
||||
return checkAthemePBKDF2(hash, passphrase)
|
||||
}
|
||||
}
|
||||
|
||||
func checkAthemePosixCrypt(hash, passphrase []byte) (err error) {
|
||||
// crypto/posix: the platform's crypt(3) function
|
||||
// MD5 on linux, DES on MacOS: forget MacOS
|
||||
md5crypt := md5_crypt.New()
|
||||
return md5crypt.Verify(string(hash), []byte(passphrase))
|
||||
}
|
||||
|
||||
type pbkdf2v2Algo struct {
|
||||
Hash func() hash.Hash
|
||||
OutputSize int
|
||||
SCRAM bool
|
||||
SaltB64 bool
|
||||
}
|
||||
|
||||
func athemePBKDF2V2ParseAlgo(algo string) (result pbkdf2v2Algo, err error) {
|
||||
// https://github.com/atheme/atheme/blob/a11e85efc67d86fc4738e3e2a4f220bfa69153f0/include/atheme/pbkdf2.h#L34-L52
|
||||
algoInt, err := strconv.Atoi(algo)
|
||||
if err != nil {
|
||||
return result, ErrHashInvalid
|
||||
}
|
||||
hashCode := algoInt % 10
|
||||
algoCode := algoInt - hashCode
|
||||
|
||||
switch algoCode {
|
||||
case 0:
|
||||
// e.g., #define PBKDF2_PRF_HMAC_MD5 3U
|
||||
// no SCRAM, no SHA256
|
||||
case 20:
|
||||
// e.g., #define PBKDF2_PRF_HMAC_MD5_S64 23U
|
||||
// no SCRAM, base64
|
||||
result.SaltB64 = true
|
||||
case 40:
|
||||
// e.g., #define PBKDF2_PRF_SCRAM_MD5 43U
|
||||
// SCRAM, no base64
|
||||
result.SCRAM = true
|
||||
case 60:
|
||||
// e.g., #define PBKDF2_PRF_SCRAM_MD5_S64 63U
|
||||
result.SaltB64 = true
|
||||
result.SCRAM = true
|
||||
default:
|
||||
return result, ErrHashInvalid
|
||||
}
|
||||
|
||||
switch hashCode {
|
||||
case 3:
|
||||
result.Hash, result.OutputSize = md5.New, (128 / 8)
|
||||
case 4:
|
||||
result.Hash, result.OutputSize = sha1.New, (160 / 8)
|
||||
case 5:
|
||||
result.Hash, result.OutputSize = sha256.New, (256 / 8)
|
||||
case 6:
|
||||
result.Hash, result.OutputSize = sha512.New, (512 / 8)
|
||||
default:
|
||||
return result, ErrHashInvalid
|
||||
}
|
||||
|
||||
return result, nil
|
||||
}
|
||||
|
||||
func checkAthemePBKDF2V2(hash, passphrase []byte) (err error) {
|
||||
// crypto/pbkdf2v2, the default as of september 2020:
|
||||
// "the format for pbkdf2v2 is $z$alg$iter$salt$digest
|
||||
// where the z is literal,
|
||||
// the alg is one from https://github.com/atheme/atheme/blob/master/include/atheme/pbkdf2.h#L34-L52
|
||||
// iter is the iteration count.
|
||||
// if the alg ends in _S64 then the salt is base64-encoded, otherwise taken literally
|
||||
// (an ASCII salt, inherited from the pbkdf2 module).
|
||||
// if alg is a SCRAM one, then digest is actually serverkey$storedkey (see RFC 5802).
|
||||
// digest, serverkey and storedkey are base64-encoded."
|
||||
parts := bytes.Split(hash, []byte{'$'})
|
||||
if len(parts) < 6 {
|
||||
return ErrHashInvalid
|
||||
}
|
||||
algo, err := athemePBKDF2V2ParseAlgo(string(parts[2]))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
iter, err := strconv.Atoi(string(parts[3]))
|
||||
if err != nil {
|
||||
return ErrHashInvalid
|
||||
}
|
||||
|
||||
salt := parts[4]
|
||||
if algo.SaltB64 {
|
||||
salt, err = base64.StdEncoding.DecodeString(string(salt))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// if SCRAM, parts[5] is ServerKey; otherwise it's the actual PBKDF2 output
|
||||
// either way, it's what we'll test against
|
||||
expected, err := base64.StdEncoding.DecodeString(string(parts[5]))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var key []byte
|
||||
if algo.SCRAM {
|
||||
if len(parts) != 7 {
|
||||
return ErrHashInvalid
|
||||
}
|
||||
stretch := pbkdf2.Key(passphrase, salt, iter, algo.OutputSize, algo.Hash)
|
||||
mac := hmac.New(algo.Hash, stretch)
|
||||
mac.Write(hmacServerKeyText)
|
||||
key = mac.Sum(nil)
|
||||
} else {
|
||||
if len(parts) != 6 {
|
||||
return ErrHashInvalid
|
||||
}
|
||||
key = pbkdf2.Key(passphrase, salt, iter, len(expected), algo.Hash)
|
||||
}
|
||||
|
||||
if subtle.ConstantTimeCompare(key, expected) == 1 {
|
||||
return nil
|
||||
} else {
|
||||
return ErrHashCheckFailed
|
||||
}
|
||||
}
|
||||
|
||||
func checkAthemePBKDF2(hash, passphrase []byte) (err error) {
|
||||
// crypto/pbkdf2:
|
||||
// "SHA2-512, 128000 iterations, 16-ASCII-character salt, hexadecimal encoding of digest,
|
||||
// digest appended directly to salt, for a single string consisting of only 144 characters"
|
||||
if len(hash) != 144 {
|
||||
return ErrHashInvalid
|
||||
}
|
||||
|
||||
salt := hash[:16]
|
||||
digest := make([]byte, 64)
|
||||
cnt, err := hex.Decode(digest, hash[16:])
|
||||
if err != nil || cnt != 64 {
|
||||
return ErrHashCheckFailed
|
||||
}
|
||||
|
||||
key := pbkdf2.Key(passphrase, salt, 128000, 64, sha512.New)
|
||||
if subtle.ConstantTimeCompare(key, digest) == 1 {
|
||||
return nil
|
||||
} else {
|
||||
return ErrHashCheckFailed
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
// Copyright (c) 2020 Shivaram Lingamneni <slingamn@cs.stanford.edu>
|
||||
// released under the MIT license
|
||||
|
||||
package migrations
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestAthemePassphrases(t *testing.T) {
|
||||
var err error
|
||||
|
||||
err = CheckAthemePassphrase([]byte("$1$hcspif$nCm4r3S14Me9ifsOPGuJT."), []byte("shivarampassphrase"))
|
||||
if err != nil {
|
||||
t.Errorf("failed to check passphrase: %v", err)
|
||||
}
|
||||
|
||||
err = CheckAthemePassphrase([]byte("$1$hcspif$nCm4r3S14Me9ifsOPGuJT."), []byte("sh1varampassphrase"))
|
||||
if err == nil {
|
||||
t.Errorf("accepted invalid passphrase")
|
||||
}
|
||||
|
||||
err = CheckAthemePassphrase([]byte("khMlbBBIFya2ihyN42abc3e768663e2c4fd0e0020e46292bf9fdf44e9a51d2a2e69509cb73b4b1bf9c1b6355a1fc9ea663fcd6da902287159494f15b905e5e651d6a60f2ec834598"), []byte("password"))
|
||||
if err != nil {
|
||||
t.Errorf("failed to check passphrase: %v", err)
|
||||
}
|
||||
|
||||
err = CheckAthemePassphrase([]byte("khMlbBBIFya2ihyN42abc3e768663e2c4fd0e0020e46292bf9fdf44e9a51d2a2e69509cb73b4b1bf9c1b6355a1fc9ea663fcd6da902287159494f15b905e5e651d6a60f2ec834598"), []byte("passw0rd"))
|
||||
if err == nil {
|
||||
t.Errorf("accepted invalid passphrase")
|
||||
}
|
||||
|
||||
err = CheckAthemePassphrase([]byte("$z$65$64000$1kz1I9YJPJ2gkJALbrpL2DoxRDhYPBOg60KNJMK/6do=$Cnfg6pYhBNrVXiaXYH46byrC+3HKet/XvYwvI1BvZbs=$m0hrT33gcF90n2TU3lm8tdm9V9XC4xEV13KsjuT38iY="), []byte("password"))
|
||||
if err != nil {
|
||||
t.Errorf("failed to check passphrase: %v", err)
|
||||
}
|
||||
|
||||
err = CheckAthemePassphrase([]byte("$z$65$64000$1kz1I9YJPJ2gkJALbrpL2DoxRDhYPBOg60KNJMK/6do=$Cnfg6pYhBNrVXiaXYH46byrC+3HKet/XvYwvI1BvZbs=$m0hrT33gcF90n2TU3lm8tdm9V9XC4xEV13KsjuT38iY="), []byte("passw0rd"))
|
||||
if err == nil {
|
||||
t.Errorf("accepted invalid passphrase")
|
||||
}
|
||||
}
|
||||
|
||||
func TestOragonoLegacyPassphrase(t *testing.T) {
|
||||
shivaramHash, err := base64.StdEncoding.DecodeString("ZPLKvCGipalUo9AlDIlMzAuY/ACWvM3yr1kh7k0/wa7lLlCwaPpe2ht9LNZZlZ9FPUWggUi7D4jyg2WnJDJhJDE0JDRsN0gwVmYvNHlyNjR1U212U2Q0YU9EVmRvWngwcXNGLkkyYVc4eUZISGxYaGE4SWVrRzRt")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
edHash, err := base64.StdEncoding.DecodeString("ZPLKvCGipalUo9AlDIlMzAuY/ACWvM3yr1kh7k0/+42q72mFnpDZWgjmqp1Zd77rEUO8ItYe4aGwWelUJDJhJDE0JHFqSGJ5NWVJbnJTdXBRT29pUmNUUWV5U2xmWjZETlRNcXlSMExUb2RmY3l1Skw2c3BTb3lh")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
err = CheckOragonoPassphraseV0(shivaramHash, []byte("shivarampassphrase"))
|
||||
if err != nil {
|
||||
t.Errorf("failed to check passphrase: %v", err)
|
||||
}
|
||||
err = CheckOragonoPassphraseV0(shivaramHash, []byte("edpassphrase"))
|
||||
if err == nil {
|
||||
t.Errorf("accepted invalid passphrase")
|
||||
}
|
||||
|
||||
err = CheckOragonoPassphraseV0(edHash, []byte("edpassphrase"))
|
||||
if err != nil {
|
||||
t.Errorf("failed to check passphrase: %v", err)
|
||||
}
|
||||
err = CheckOragonoPassphraseV0(edHash, []byte("shivarampassphrase"))
|
||||
if err == nil {
|
||||
t.Errorf("accepted invalid passphrase")
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user