minio/cmd/jwt.go

/*
 * MinIO Cloud Storage, (C) 2016, 2017 MinIO, Inc.
 *
 * 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 cmd

import (
	"context"
	"errors"
	"fmt"
	"net/http"
	"time"

	jwtgo "github.com/dgrijalva/jwt-go"
	jwtreq "github.com/dgrijalva/jwt-go/request"
	"github.com/minio/minio/cmd/logger"
	"github.com/minio/minio/pkg/auth"
)

const (
	jwtAlgorithm = "Bearer"

	// Default JWT token for web handlers is one day.
	defaultJWTExpiry = 24 * time.Hour

	// Inter-node JWT token expiry is 100 years approx.
	defaultInterNodeJWTExpiry = 100 * 365 * 24 * time.Hour

	// URL JWT token expiry is one minute (might be exposed).
	defaultURLJWTExpiry = time.Minute
)

var (
	errInvalidAccessKeyID   = errors.New("The access key ID you provided does not exist in our records")
	errChangeCredNotAllowed = errors.New("Changing access key and secret key not allowed")
	errAuthentication       = errors.New("Authentication failed, check your access credentials")
	errNoAuthToken          = errors.New("JWT token missing")
	errIncorrectCreds       = errors.New("Current access key or secret key is incorrect")
)

func authenticateJWTUsers(accessKey, secretKey string, expiry time.Duration) (string, error) {
	passedCredential, err := auth.CreateCredentials(accessKey, secretKey)
	if err != nil {
		return "", err
	}
	expiresAt := UTCNow().Add(expiry)
	return authenticateJWTUsersWithCredentials(passedCredential, expiresAt)
}

func authenticateJWTUsersWithCredentials(credentials auth.Credentials, expiresAt time.Time) (string, error) {
	serverCred := globalActiveCred
	if serverCred.AccessKey != credentials.AccessKey {
		var ok bool
		serverCred, ok = globalIAMSys.GetUser(credentials.AccessKey)
		if !ok {
			return "", errInvalidAccessKeyID
		}
	}

	if !serverCred.Equal(credentials) {
		return "", errAuthentication
	}

	claims := jwtgo.MapClaims{}
	claims["exp"] = expiresAt.Unix()
	claims["sub"] = credentials.AccessKey
	claims["accessKey"] = credentials.AccessKey

	jwt := jwtgo.NewWithClaims(jwtgo.SigningMethodHS512, claims)
	return jwt.SignedString([]byte(serverCred.SecretKey))
}

func authenticateJWTAdmin(accessKey, secretKey string, expiry time.Duration) (string, error) {
	passedCredential, err := auth.CreateCredentials(accessKey, secretKey)
	if err != nil {
		return "", err
	}

	serverCred := globalActiveCred

	if serverCred.AccessKey != passedCredential.AccessKey {
		return "", errInvalidAccessKeyID
	}

	if !serverCred.Equal(passedCredential) {
		return "", errAuthentication
	}

	claims := jwtgo.MapClaims{}
	claims["exp"] = UTCNow().Add(expiry).Unix()
	claims["sub"] = passedCredential.AccessKey
	claims["accessKey"] = passedCredential.AccessKey

	jwt := jwtgo.NewWithClaims(jwtgo.SigningMethodHS512, claims)
	return jwt.SignedString([]byte(serverCred.SecretKey))
}

func authenticateNode(accessKey, secretKey string) (string, error) {
	return authenticateJWTAdmin(accessKey, secretKey, defaultInterNodeJWTExpiry)
}

func authenticateWeb(accessKey, secretKey string) (string, error) {
	return authenticateJWTUsers(accessKey, secretKey, defaultJWTExpiry)
}

func authenticateURL(accessKey, secretKey string) (string, error) {
	return authenticateJWTUsers(accessKey, secretKey, defaultURLJWTExpiry)
}

// Callback function used for parsing
func webTokenCallback(jwtToken *jwtgo.Token) (interface{}, error) {
	if _, ok := jwtToken.Method.(*jwtgo.SigningMethodHMAC); !ok {
		return nil, fmt.Errorf("Unexpected signing method: %v", jwtToken.Header["alg"])
	}

	if err := jwtToken.Claims.Valid(); err != nil {
		return nil, errAuthentication
	}

	if claimsPtr, ok := jwtToken.Claims.(*jwtgo.MapClaims); ok {
		claims := *claimsPtr
		accessKey, ok := claims["accessKey"].(string)
		if !ok {
			accessKey, ok = claims["sub"].(string)
			if !ok {
				return nil, errInvalidAccessKeyID
			}
		}
		if accessKey == globalActiveCred.AccessKey {
			return []byte(globalActiveCred.SecretKey), nil
		}
		if globalIAMSys == nil {
			return nil, errInvalidAccessKeyID
		}
		if _, ok = claims["aud"].(string); !ok {
			cred, ok := globalIAMSys.GetUser(accessKey)
			if !ok {
				return nil, errInvalidAccessKeyID
			}
			return []byte(cred.SecretKey), nil
		}
		return []byte(globalActiveCred.SecretKey), nil
	}

	return nil, errAuthentication
}

func parseJWTWithClaims(tokenString string, claims jwtgo.Claims) (*jwtgo.Token, error) {
	p := &jwtgo.Parser{
		SkipClaimsValidation: true,
		ValidMethods: []string{
			jwtgo.SigningMethodHS256.Alg(),
			jwtgo.SigningMethodHS512.Alg(),
		},
	}
	jwtToken, err := p.ParseWithClaims(tokenString, claims, webTokenCallback)
	if err != nil {
		switch e := err.(type) {
		case *jwtgo.ValidationError:
			if e.Inner == nil {
				return nil, errAuthentication
			}
			return nil, e.Inner
		}
		return nil, errAuthentication
	}
	return jwtToken, nil
}

func isAuthTokenValid(token string) bool {
	_, _, err := webTokenAuthenticate(token)
	return err == nil
}

func webTokenAuthenticate(token string) (mapClaims, bool, error) {
	var claims = jwtgo.MapClaims{}
	if token == "" {
		return mapClaims{claims}, false, errNoAuthToken
	}
	jwtToken, err := parseJWTWithClaims(token, &claims)
	if err != nil {
		return mapClaims{claims}, false, err
	}
	if !jwtToken.Valid {
		return mapClaims{claims}, false, errAuthentication
	}
	accessKey, ok := claims["accessKey"].(string)
	if !ok {
		accessKey, ok = claims["sub"].(string)
		if !ok {
			return mapClaims{claims}, false, errAuthentication
		}
	}
	owner := accessKey == globalActiveCred.AccessKey
	return mapClaims{claims}, owner, nil
}

type mapClaims struct {
	jwtgo.MapClaims
}

func (m mapClaims) Map() map[string]interface{} {
	return m.MapClaims
}

func (m mapClaims) AccessKey() string {
	claimSub, ok := m.MapClaims["accessKey"].(string)
	if !ok {
		claimSub, _ = m.MapClaims["sub"].(string)
	}
	return claimSub
}

// Check if the request is authenticated.
// Returns nil if the request is authenticated. errNoAuthToken if token missing.
// Returns errAuthentication for all other errors.
func webRequestAuthenticate(req *http.Request) (mapClaims, bool, error) {
	var claims = jwtgo.MapClaims{}
	tokStr, err := jwtreq.AuthorizationHeaderExtractor.ExtractToken(req)
	if err != nil {
		if err == jwtreq.ErrNoTokenInRequest {
			return mapClaims{claims}, false, errNoAuthToken
		}
		return mapClaims{claims}, false, err
	}
	jwtToken, err := parseJWTWithClaims(tokStr, &claims)
	if err != nil {
		return mapClaims{claims}, false, err
	}
	if !jwtToken.Valid {
		return mapClaims{claims}, false, errAuthentication
	}
	accessKey, ok := claims["accessKey"].(string)
	if !ok {
		accessKey, ok = claims["sub"].(string)
		if !ok {
			return mapClaims{claims}, false, errAuthentication
		}
	}
	owner := accessKey == globalActiveCred.AccessKey
	return mapClaims{claims}, owner, nil
}

func newAuthToken() string {
	cred := globalActiveCred
	token, err := authenticateNode(cred.AccessKey, cred.SecretKey)
	logger.CriticalIf(context.Background(), err)
	return token
}