|
| 1 | +package crypto |
| 2 | + |
| 3 | +import ( |
| 4 | + "crypto/hmac" |
| 5 | + "crypto/rand" |
| 6 | + "crypto/sha256" |
| 7 | + "crypto/subtle" |
| 8 | + "encoding/base64" |
| 9 | + "encoding/binary" |
| 10 | + "errors" |
| 11 | + |
| 12 | + "github.com/gofrs/uuid" |
| 13 | +) |
| 14 | + |
| 15 | +func GenerateRefreshTokenHmacKey() []byte { |
| 16 | + key := make([]byte, 32) |
| 17 | + must(rand.Read(key)) |
| 18 | + |
| 19 | + return key |
| 20 | +} |
| 21 | + |
| 22 | +const refreshTokenChecksumLength = 4 |
| 23 | +const refreshTokenSignatureLength = 16 |
| 24 | +const minRefreshTokenLength = 1 + 16 + 1 + refreshTokenSignatureLength + refreshTokenChecksumLength |
| 25 | +const maxRefreshTokenLength = minRefreshTokenLength + 8 |
| 26 | + |
| 27 | +// RefreshToken is an object that encodes a cryptographically authenticated |
| 28 | +// (signed) message containing a version, session ID and monotonically |
| 29 | +// increasing non-negative counter. |
| 30 | +// |
| 31 | +// The signature is a truncated (first 128 bits) of HMAC-SHA-256, which saves |
| 32 | +// on encoded length without sacrificing security. The checksum of 4 bytes at |
| 33 | +// the end is to lessen the load on the server with invalid strings (those that |
| 34 | +// are not likely to be a proper refresh token). |
| 35 | +type RefreshToken struct { |
| 36 | + Raw []byte |
| 37 | + |
| 38 | + Version byte |
| 39 | + SessionID uuid.UUID |
| 40 | + Counter int64 |
| 41 | + Signature []byte |
| 42 | +} |
| 43 | + |
| 44 | +func (RefreshToken) TableName() string { |
| 45 | + panic("crypto.RefreshToken is not meant to be saved in the database") |
| 46 | +} |
| 47 | + |
| 48 | +func (r *RefreshToken) CheckSignature(hmacSha256Key []byte) bool { |
| 49 | + bytes := r.Raw[:len(r.Raw)-refreshTokenSignatureLength-refreshTokenChecksumLength] |
| 50 | + |
| 51 | + h := hmac.New(sha256.New, hmacSha256Key) |
| 52 | + h.Write(bytes) |
| 53 | + signature := h.Sum(nil)[:refreshTokenSignatureLength] |
| 54 | + |
| 55 | + return hmac.Equal(signature, r.Signature) |
| 56 | +} |
| 57 | + |
| 58 | +func (r *RefreshToken) Encode(hmacSha256Key []byte) string { |
| 59 | + result := make([]byte, 0, maxRefreshTokenLength) |
| 60 | + |
| 61 | + result = append(result, 0) |
| 62 | + result = append(result, r.SessionID.Bytes()...) |
| 63 | + result = binary.AppendUvarint(result, uint64(r.Counter)) |
| 64 | + |
| 65 | + // Note on truncating the HMAC-SHA-256 output: |
| 66 | + // This does not impact security as the brute-force space is 2^128 and |
| 67 | + // the collision space is 2^64, both unattainable in practice. |
| 68 | + |
| 69 | + h := hmac.New(sha256.New, hmacSha256Key) |
| 70 | + h.Write(result) |
| 71 | + signature := h.Sum(nil)[:refreshTokenSignatureLength] |
| 72 | + |
| 73 | + result = append(result, signature...) |
| 74 | + |
| 75 | + checksum := sha256.Sum256(result) |
| 76 | + result = append(result, checksum[:refreshTokenChecksumLength]...) |
| 77 | + |
| 78 | + r.Version = 0 |
| 79 | + r.Raw = result |
| 80 | + r.Signature = signature |
| 81 | + |
| 82 | + return base64.RawURLEncoding.EncodeToString(result) |
| 83 | +} |
| 84 | + |
| 85 | +var ( |
| 86 | + ErrRefreshTokenLength = errors.New("crypto: refresh token length is not valid") |
| 87 | + ErrRefreshTokenUnknownVersion = errors.New("crypto: refresh token version is not 0") |
| 88 | + ErrRefreshTokenChecksumInvalid = errors.New("crypto: refresh token checksum is not valid") |
| 89 | + ErrRefreshTokenCounterInvalid = errors.New("crypto: refresh token's counter is not valid") |
| 90 | +) |
| 91 | + |
| 92 | +func ParseRefreshToken(token string) (*RefreshToken, error) { |
| 93 | + bytes, err := base64.RawURLEncoding.DecodeString(token) |
| 94 | + if err != nil { |
| 95 | + return nil, err |
| 96 | + } |
| 97 | + |
| 98 | + if len(bytes) < minRefreshTokenLength { |
| 99 | + return nil, ErrRefreshTokenLength |
| 100 | + } |
| 101 | + |
| 102 | + if bytes[0] != 0 { |
| 103 | + return nil, ErrRefreshTokenUnknownVersion |
| 104 | + } |
| 105 | + |
| 106 | + parseFrom := bytes[1 : len(bytes)-refreshTokenChecksumLength] |
| 107 | + |
| 108 | + checksum256 := sha256.Sum256(bytes[:len(bytes)-refreshTokenChecksumLength]) |
| 109 | + if subtle.ConstantTimeCompare(checksum256[:refreshTokenChecksumLength], bytes[len(bytes)-refreshTokenChecksumLength:len(bytes)]) != 1 { |
| 110 | + return nil, ErrRefreshTokenChecksumInvalid |
| 111 | + } |
| 112 | + |
| 113 | + sessionID, err := uuid.FromBytes(parseFrom[0:16]) |
| 114 | + if err != nil { |
| 115 | + return nil, err |
| 116 | + } |
| 117 | + |
| 118 | + parseFrom = parseFrom[16:] |
| 119 | + |
| 120 | + counter, counterBytes := binary.Uvarint(parseFrom) |
| 121 | + if counterBytes <= 0 { |
| 122 | + return nil, ErrRefreshTokenCounterInvalid |
| 123 | + } |
| 124 | + |
| 125 | + parseFrom = parseFrom[counterBytes:] |
| 126 | + |
| 127 | + if len(parseFrom) != 16 { |
| 128 | + return nil, ErrRefreshTokenLength |
| 129 | + } |
| 130 | + |
| 131 | + signature := parseFrom |
| 132 | + |
| 133 | + return &RefreshToken{ |
| 134 | + Raw: bytes, |
| 135 | + |
| 136 | + Version: 0, |
| 137 | + SessionID: sessionID, |
| 138 | + Counter: int64(counter), |
| 139 | + Signature: signature, |
| 140 | + }, nil |
| 141 | +} |
0 commit comments