1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
|
package bcrypt
import (
"fmt"
"strconv"
"github.com/go-crypt/x/bcrypt"
"github.com/go-crypt/crypt/algorithm"
"github.com/go-crypt/crypt/internal/encoding"
)
// RegisterDecoder the decoder with the algorithm.DecoderRegister.
func RegisterDecoder(r algorithm.DecoderRegister) (err error) {
if err = RegisterDecoderStandard(r); err != nil {
return err
}
if err = RegisterDecoderSHA256(r); err != nil {
return err
}
return nil
}
// RegisterDecoderStandard registers specifically the standard decoder variant with the algorithm.DecoderRegister.
func RegisterDecoderStandard(r algorithm.DecoderRegister) (err error) {
decodefunc := DecodeVariant(VariantStandard)
if err = r.RegisterDecodeFunc(VariantStandard.Prefix(), decodefunc); err != nil {
return err
}
if err = r.RegisterDecodeFunc(AlgIdentifierVerA, decodefunc); err != nil {
return err
}
if err = r.RegisterDecodeFunc(AlgIdentifierVerX, decodefunc); err != nil {
return err
}
if err = r.RegisterDecodeFunc(AlgIdentifierVerY, decodefunc); err != nil {
return err
}
if err = r.RegisterDecodeFunc(AlgIdentifierUnversioned, decodefunc); err != nil {
return err
}
return nil
}
// RegisterDecoderSHA256 registers specifically the sha256 decoder variant with the algorithm.DecoderRegister.
func RegisterDecoderSHA256(r algorithm.DecoderRegister) (err error) {
if err = r.RegisterDecodeFunc(VariantSHA256.Prefix(), DecodeVariant(VariantSHA256)); err != nil {
return err
}
return nil
}
// Decode the encoded digest into a algorithm.Digest.
func Decode(encodedDigest string) (digest algorithm.Digest, err error) {
return DecodeVariant(VariantNone)(encodedDigest)
}
// DecodeVariant the encoded digest into a algorithm.Digest provided it matches the provided bcrypt.Variant. If
// bcrypt.VariantNone is used all variants can be decoded.
func DecodeVariant(v Variant) func(encodedDigest string) (digest algorithm.Digest, err error) {
return func(encodedDigest string) (digest algorithm.Digest, err error) {
var (
parts []string
variant Variant
)
if variant, parts, err = decoderParts(encodedDigest); err != nil {
return nil, fmt.Errorf(algorithm.ErrFmtDigestDecode, AlgName, err)
}
if v != VariantNone && v != variant {
return nil, fmt.Errorf(algorithm.ErrFmtDigestDecode, AlgName, fmt.Errorf("the '%s' variant cannot be decoded only the '%s' variant can be", variant.String(), v.String()))
}
if digest, err = decode(variant, parts); err != nil {
return nil, fmt.Errorf(algorithm.ErrFmtDigestDecode, AlgName, err)
}
return digest, nil
}
}
func decoderParts(encodedDigest string) (variant Variant, parts []string, err error) {
parts = encoding.Split(encodedDigest, -1)
if len(parts) < 4 {
return VariantNone, nil, algorithm.ErrEncodedHashInvalidFormat
}
variant = NewVariant(parts[1])
if variant == VariantNone {
return variant, nil, fmt.Errorf("%w: identifier '%s' is not an encoded %s digest", algorithm.ErrEncodedHashInvalidIdentifier, parts[1], AlgName)
}
return variant, parts[2:], nil
}
func decode(variant Variant, parts []string) (digest algorithm.Digest, err error) {
countParts := len(parts)
var (
salt, key []byte
)
decoded := &Digest{
variant: variant,
}
switch decoded.variant {
case VariantStandard:
if countParts != 2 {
return nil, algorithm.ErrEncodedHashInvalidFormat
}
if decoded.iterations, err = strconv.Atoi(parts[0]); err != nil {
return nil, fmt.Errorf("%w: iterations could not be parsed: %v", algorithm.ErrEncodedHashInvalidOptionValue, err)
}
switch n, i := len(parts[1]), bcrypt.EncodedSaltSize+bcrypt.EncodedHashSize; n {
case i:
break
case 0:
return nil, fmt.Errorf("%w: key is expected to be %d bytes but it was empty", algorithm.ErrEncodedHashKeyEncoding, i)
default:
return nil, fmt.Errorf("%w: key is expected to be %d bytes but it has %d bytes", algorithm.ErrEncodedHashKeyEncoding, i, n)
}
salt, key = bcrypt.DecodeSecret([]byte(parts[1]))
case VariantSHA256:
if countParts != 3 {
return nil, algorithm.ErrEncodedHashInvalidFormat
}
salt, key = []byte(parts[1]), []byte(parts[2])
switch n := len(salt); n {
case bcrypt.EncodedSaltSize:
break
case 0:
return nil, fmt.Errorf("%w: salt is expected to be %d bytes but it was empty", algorithm.ErrEncodedHashSaltEncoding, bcrypt.EncodedSaltSize)
default:
return nil, fmt.Errorf("%w: salt is expected to be %d bytes but it has %d bytes", algorithm.ErrEncodedHashSaltEncoding, bcrypt.EncodedSaltSize, n)
}
switch n := len(key); n {
case bcrypt.EncodedHashSize:
break
case 0:
return nil, fmt.Errorf("%w: key is expected to be %d bytes but it was empty", algorithm.ErrEncodedHashKeyEncoding, bcrypt.EncodedHashSize)
default:
return nil, fmt.Errorf("%w: key is expected to be %d bytes but it has %d bytes", algorithm.ErrEncodedHashKeyEncoding, bcrypt.EncodedHashSize, n)
}
var params []encoding.Parameter
if params, err = encoding.DecodeParameterStr(parts[0]); err != nil {
return nil, err
}
for _, param := range params {
switch param.Key {
case oV, oT:
break
case oR:
decoded.iterations, err = param.Int()
default:
return nil, fmt.Errorf("%w: option '%s' with value '%s' is unknown", algorithm.ErrEncodedHashInvalidOptionKey, param.Key, param.Value)
}
if err != nil {
return nil, fmt.Errorf("%w: option '%s' has invalid value '%s': %v", algorithm.ErrEncodedHashInvalidOptionValue, param.Key, param.Value, err)
}
}
}
if decoded.salt, err = bcrypt.Base64Decode(salt); err != nil {
return nil, fmt.Errorf("%w: %v", algorithm.ErrEncodedHashSaltEncoding, err)
}
if len(key) == 0 {
return nil, fmt.Errorf("%w: key has 0 bytes", algorithm.ErrEncodedHashKeyEncoding)
}
decoded.key = key
return decoded, nil
}
|