mirror of
https://github.com/etcd-io/etcd.git
synced 2024-09-27 06:25:44 +00:00

This commit adds jwt token support in v3 auth API. Remaining major ToDos: - Currently token type isn't hidden from etcdserver. In the near future the information should be completely invisible from etcdserver package. - Configurable expiration of token. Currently tokens can be valid until keys are changed. How to use: 1. generate keys for signing and verfying jwt tokens: $ openssl genrsa -out app.rsa 1024 $ openssl rsa -in app.rsa -pubout > app.rsa.pub 2. add command line options to etcd like below: --auth-token-type jwt \ --auth-jwt-pub-key app.rsa.pub --auth-jwt-priv-key app.rsa \ --auth-jwt-sign-method RS512 3. launch etcd cluster Below is a performance comparison of serializable read w/ and w/o jwt token. Every (3) etcd node is executed on a single machine. Signing method is RS512 and key length is 1024 bit. As the results show, jwt based token introduces a performance overhead but it would be acceptable for a case that requires authentication. w/o jwt token auth (no auth): Summary: Total: 1.6172 secs. Slowest: 0.0125 secs. Fastest: 0.0001 secs. Average: 0.0002 secs. Stddev: 0.0004 secs. Requests/sec: 6183.5877 Response time histogram: 0.000 [1] | 0.001 [9982] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎ 0.003 [1] | 0.004 [1] | 0.005 [0] | 0.006 [0] | 0.008 [6] | 0.009 [0] | 0.010 [1] | 0.011 [5] | 0.013 [3] | Latency distribution: 10% in 0.0001 secs. 25% in 0.0001 secs. 50% in 0.0001 secs. 75% in 0.0001 secs. 90% in 0.0002 secs. 95% in 0.0002 secs. 99% in 0.0003 secs. w/ jwt token auth: Summary: Total: 2.5364 secs. Slowest: 0.0182 secs. Fastest: 0.0002 secs. Average: 0.0003 secs. Stddev: 0.0005 secs. Requests/sec: 3942.5185 Response time histogram: 0.000 [1] | 0.002 [9975] |∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎∎ 0.004 [0] | 0.006 [1] | 0.007 [11] | 0.009 [2] | 0.011 [4] | 0.013 [5] | 0.015 [0] | 0.016 [0] | 0.018 [1] | Latency distribution: 10% in 0.0002 secs. 25% in 0.0002 secs. 50% in 0.0002 secs. 75% in 0.0002 secs. 90% in 0.0003 secs. 95% in 0.0003 secs. 99% in 0.0004 secs.
138 lines
3.6 KiB
Go
138 lines
3.6 KiB
Go
// Copyright 2017 The etcd Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package auth
|
|
|
|
import (
|
|
"crypto/rsa"
|
|
"io/ioutil"
|
|
|
|
jwt "github.com/dgrijalva/jwt-go"
|
|
"golang.org/x/net/context"
|
|
)
|
|
|
|
type tokenJWT struct {
|
|
signMethod string
|
|
signKey *rsa.PrivateKey
|
|
verifyKey *rsa.PublicKey
|
|
}
|
|
|
|
func (t *tokenJWT) enable() {}
|
|
func (t *tokenJWT) disable() {}
|
|
func (t *tokenJWT) invalidateUser(string) {}
|
|
func (t *tokenJWT) genTokenPrefix() (string, error) { return "", nil }
|
|
|
|
func (t *tokenJWT) info(ctx context.Context, token string, rev uint64) (*AuthInfo, bool) {
|
|
// rev isn't used in JWT, it is only used in simple token
|
|
var (
|
|
username string
|
|
revision uint64
|
|
)
|
|
|
|
parsed, err := jwt.Parse(token, func(token *jwt.Token) (interface{}, error) {
|
|
return t.verifyKey, nil
|
|
})
|
|
|
|
switch err.(type) {
|
|
case nil:
|
|
if !parsed.Valid {
|
|
plog.Warningf("invalid jwt token: %s", token)
|
|
return nil, false
|
|
}
|
|
|
|
claims := parsed.Claims.(jwt.MapClaims)
|
|
|
|
username = claims["username"].(string)
|
|
revision = uint64(claims["revision"].(float64))
|
|
default:
|
|
plog.Warningf("failed to parse jwt token: %s", err)
|
|
return nil, false
|
|
}
|
|
|
|
return &AuthInfo{Username: username, Revision: revision}, true
|
|
}
|
|
|
|
func (t *tokenJWT) assign(ctx context.Context, username string, revision uint64) (string, error) {
|
|
// Future work: let a jwt token include permission infomation would be useful for
|
|
// permission checking in proxy side.
|
|
tk := jwt.NewWithClaims(jwt.GetSigningMethod(t.signMethod),
|
|
jwt.MapClaims{
|
|
"username": username,
|
|
"revision": revision,
|
|
})
|
|
|
|
token, err := tk.SignedString(t.signKey)
|
|
if err != nil {
|
|
plog.Debugf("failed to sign jwt token: %s", err)
|
|
return "", err
|
|
}
|
|
|
|
plog.Debugf("jwt token: %s", token)
|
|
|
|
return token, err
|
|
}
|
|
|
|
func prepareOpts(opts map[string]string) (jwtSignMethod, jwtPubKeyPath, jwtPrivKeyPath string, err error) {
|
|
for k, v := range opts {
|
|
switch k {
|
|
case "sign-method":
|
|
jwtSignMethod = v
|
|
case "pub-key":
|
|
jwtPubKeyPath = v
|
|
case "priv-key":
|
|
jwtPrivKeyPath = v
|
|
default:
|
|
plog.Errorf("unknown token specific option: %s", k)
|
|
return "", "", "", ErrInvalidAuthOpts
|
|
}
|
|
}
|
|
|
|
return jwtSignMethod, jwtPubKeyPath, jwtPrivKeyPath, nil
|
|
}
|
|
|
|
func newTokenProviderJWT(opts map[string]string) (*tokenJWT, error) {
|
|
jwtSignMethod, jwtPubKeyPath, jwtPrivKeyPath, err := prepareOpts(opts)
|
|
if err != nil {
|
|
return nil, ErrInvalidAuthOpts
|
|
}
|
|
|
|
t := &tokenJWT{}
|
|
|
|
t.signMethod = jwtSignMethod
|
|
|
|
verifyBytes, err := ioutil.ReadFile(jwtPubKeyPath)
|
|
if err != nil {
|
|
plog.Errorf("failed to read public key (%s) for jwt: %s", jwtPubKeyPath, err)
|
|
return nil, err
|
|
}
|
|
t.verifyKey, err = jwt.ParseRSAPublicKeyFromPEM(verifyBytes)
|
|
if err != nil {
|
|
plog.Errorf("failed to parse public key (%s): %s", jwtPubKeyPath, err)
|
|
return nil, err
|
|
}
|
|
|
|
signBytes, err := ioutil.ReadFile(jwtPrivKeyPath)
|
|
if err != nil {
|
|
plog.Errorf("failed to read private key (%s) for jwt: %s", jwtPrivKeyPath, err)
|
|
return nil, err
|
|
}
|
|
t.signKey, err = jwt.ParseRSAPrivateKeyFromPEM(signBytes)
|
|
if err != nil {
|
|
plog.Errorf("failed to parse private key (%s): %s", jwtPrivKeyPath, err)
|
|
return nil, err
|
|
}
|
|
|
|
return t, nil
|
|
}
|