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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
|
package jwt
import (
"crypto/rsa"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"sync"
"time"
"github.com/cristalhq/jwt/v3"
)
type ConnectToken struct {
// UserID tells library an ID of connecting user.
UserID string
// ExpireAt allows to set time in future when connection must be validated.
// Validation can be server-side or client-side using Refresh handler.
ExpireAt int64
// Info contains additional information about connection. It will be
// included into Join/Leave messages, into Presence information, also
// info becomes a part of published message if it was published from
// client directly. In some cases having additional info can be an
// overhead – but you are simply free to not use it.
Info []byte
// Channels slice contains channels to subscribe connection to on server-side.
Channels []string
}
type SubscribeToken struct {
// Client is a unique client ID string set to each connection on server.
// Will be compared with actual client ID.
Client string
// Channel client wants to subscribe. Will be compared with channel in
// subscribe command.
Channel string
// ExpireAt allows to set time in future when connection must be validated.
// Validation can be server-side or client-side using SubRefresh handler.
ExpireAt int64
// Info contains additional information about connection in channel.
// It will be included into Join/Leave messages, into Presence information,
// also channel info becomes a part of published message if it was published
// from subscribed client directly.
Info []byte
// ExpireTokenOnly used to indicate that library must only check token
// expiration but not turn on Subscription expiration checks on server side.
// This allows to implement one-time subscription tokens.
ExpireTokenOnly bool
}
type TokenVerifierConfig struct {
// HMACSecretKey is a secret key used to validate connection and subscription
// tokens generated using HMAC. Zero value means that HMAC tokens won't be allowed.
HMACSecretKey string
// RSAPublicKey is a public key used to validate connection and subscription
// tokens generated using RSA. Zero value means that RSA tokens won't be allowed.
RSAPublicKey *rsa.PublicKey
}
func NewTokenVerifier(config TokenVerifierConfig) *TokenVerifier {
verifier := &TokenVerifier{}
algorithms, err := newAlgorithms(config.HMACSecretKey, config.RSAPublicKey)
if err != nil {
panic(err)
}
verifier.algorithms = algorithms
return verifier
}
type TokenVerifier struct {
mu sync.RWMutex
algorithms *algorithms
}
var (
ErrTokenExpired = errors.New("token expired")
errUnsupportedAlgorithm = errors.New("unsupported JWT algorithm")
errDisabledAlgorithm = errors.New("disabled JWT algorithm")
)
type connectTokenClaims struct {
Info json.RawMessage `json:"info,omitempty"`
Base64Info string `json:"b64info,omitempty"`
Channels []string `json:"channels,omitempty"`
jwt.StandardClaims
}
type subscribeTokenClaims struct {
Client string `json:"client,omitempty"`
Channel string `json:"channel,omitempty"`
Info json.RawMessage `json:"info,omitempty"`
Base64Info string `json:"b64info,omitempty"`
ExpireTokenOnly bool `json:"eto,omitempty"`
jwt.StandardClaims
}
type algorithms struct {
HS256 jwt.Verifier
HS384 jwt.Verifier
HS512 jwt.Verifier
RS256 jwt.Verifier
RS384 jwt.Verifier
RS512 jwt.Verifier
}
func newAlgorithms(tokenHMACSecretKey string, pubKey *rsa.PublicKey) (*algorithms, error) {
alg := &algorithms{}
// HMAC SHA.
if tokenHMACSecretKey != "" {
verifierHS256, err := jwt.NewVerifierHS(jwt.HS256, []byte(tokenHMACSecretKey))
if err != nil {
return nil, err
}
verifierHS384, err := jwt.NewVerifierHS(jwt.HS384, []byte(tokenHMACSecretKey))
if err != nil {
return nil, err
}
verifierHS512, err := jwt.NewVerifierHS(jwt.HS512, []byte(tokenHMACSecretKey))
if err != nil {
return nil, err
}
alg.HS256 = verifierHS256
alg.HS384 = verifierHS384
alg.HS512 = verifierHS512
}
// RSA.
if pubKey != nil {
verifierRS256, err := jwt.NewVerifierRS(jwt.RS256, pubKey)
if err != nil {
return nil, err
}
verifierRS384, err := jwt.NewVerifierRS(jwt.RS384, pubKey)
if err != nil {
return nil, err
}
verifierRS512, err := jwt.NewVerifierRS(jwt.RS512, pubKey)
if err != nil {
return nil, err
}
alg.RS256 = verifierRS256
alg.RS384 = verifierRS384
alg.RS512 = verifierRS512
}
return alg, nil
}
func (s *algorithms) verify(token *jwt.Token) error {
var verifier jwt.Verifier
switch token.Header().Algorithm {
case jwt.HS256:
verifier = s.HS256
case jwt.HS384:
verifier = s.HS384
case jwt.HS512:
verifier = s.HS512
case jwt.RS256:
verifier = s.RS256
case jwt.RS384:
verifier = s.RS384
case jwt.RS512:
verifier = s.RS512
default:
return fmt.Errorf("%w: %s", errUnsupportedAlgorithm, string(token.Header().Algorithm))
}
if verifier == nil {
return fmt.Errorf("%w: %s", errDisabledAlgorithm, string(token.Header().Algorithm))
}
return verifier.Verify(token.Payload(), token.Signature())
}
func (verifier *TokenVerifier) verifySignature(token *jwt.Token) error {
verifier.mu.RLock()
defer verifier.mu.RUnlock()
return verifier.algorithms.verify(token)
}
func (verifier *TokenVerifier) VerifyConnectToken(t string) (ConnectToken, error) {
token, err := jwt.Parse([]byte(t))
if err != nil {
return ConnectToken{}, err
}
err = verifier.verifySignature(token)
if err != nil {
return ConnectToken{}, err
}
claims := &connectTokenClaims{}
err = json.Unmarshal(token.RawClaims(), claims)
if err != nil {
return ConnectToken{}, err
}
now := time.Now()
if !claims.IsValidExpiresAt(now) || !claims.IsValidNotBefore(now) {
return ConnectToken{}, ErrTokenExpired
}
ct := ConnectToken{
UserID: claims.StandardClaims.Subject,
Info: claims.Info,
Channels: claims.Channels,
}
if claims.ExpiresAt != nil {
ct.ExpireAt = claims.ExpiresAt.Unix()
}
if claims.Base64Info != "" {
byteInfo, err := base64.StdEncoding.DecodeString(claims.Base64Info)
if err != nil {
return ConnectToken{}, err
}
ct.Info = byteInfo
}
return ct, nil
}
func (verifier *TokenVerifier) VerifySubscribeToken(t string) (SubscribeToken, error) {
token, err := jwt.Parse([]byte(t))
if err != nil {
return SubscribeToken{}, err
}
err = verifier.verifySignature(token)
if err != nil {
return SubscribeToken{}, err
}
claims := &subscribeTokenClaims{}
err = json.Unmarshal(token.RawClaims(), claims)
if err != nil {
return SubscribeToken{}, err
}
now := time.Now()
if !claims.IsValidExpiresAt(now) || !claims.IsValidNotBefore(now) {
return SubscribeToken{}, ErrTokenExpired
}
st := SubscribeToken{
Client: claims.Client,
Info: claims.Info,
Channel: claims.Channel,
ExpireTokenOnly: claims.ExpireTokenOnly,
}
if claims.ExpiresAt != nil {
st.ExpireAt = claims.ExpiresAt.Unix()
}
if claims.Base64Info != "" {
byteInfo, err := base64.StdEncoding.DecodeString(claims.Base64Info)
if err != nil {
return SubscribeToken{}, err
}
st.Info = byteInfo
}
return st, nil
}
func (verifier *TokenVerifier) Reload(config TokenVerifierConfig) error {
verifier.mu.Lock()
defer verifier.mu.Unlock()
alg, err := newAlgorithms(config.HMACSecretKey, config.RSAPublicKey)
if err != nil {
return err
}
verifier.algorithms = alg
return nil
}
|