gin/auth.go

97 lines
2.9 KiB
Go
Raw Normal View History

2014-08-29 17:49:50 +00:00
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
// Use of this source code is governed by a MIT style
// license that can be found in the LICENSE file.
2014-06-17 23:42:34 +00:00
package gin
import (
"crypto/subtle"
"encoding/base64"
"net/http"
"strconv"
2014-06-17 23:42:34 +00:00
)
2017-08-16 03:55:50 +00:00
// AuthUserKey is the cookie name for user credential in basic auth.
const AuthUserKey = "user"
2017-08-16 03:55:50 +00:00
// Accounts defines a key/value for user/pass list of authorized logins.
2017-07-05 07:47:36 +00:00
type Accounts map[string]string
type authPair struct {
value string
user string
2017-07-05 07:47:36 +00:00
}
type authPairs []authPair
2014-06-17 23:42:34 +00:00
2015-05-19 18:35:38 +00:00
func (a authPairs) searchCredential(authValue string) (string, bool) {
2017-09-28 16:22:35 +00:00
if authValue == "" {
return "", false
}
2015-05-19 18:35:38 +00:00
for _, pair := range a {
if pair.value == authValue {
return pair.user, true
2015-05-19 18:35:38 +00:00
}
}
2015-05-19 18:35:38 +00:00
return "", false
}
// BasicAuthForRealm returns a Basic HTTP Authorization middleware. It takes as arguments a map[string]string where
// the key is the user name and the value is the password, as well as the name of the Realm.
// If the realm is empty, "Authorization Required" will be used by default.
// (see http://tools.ietf.org/html/rfc2617#section-1.2)
func BasicAuthForRealm(accounts Accounts, realm string) HandlerFunc {
if realm == "" {
realm = "Authorization Required"
}
realm = "Basic realm=" + strconv.Quote(realm)
2015-03-23 03:38:32 +00:00
pairs := processAccounts(accounts)
2014-10-08 23:40:42 +00:00
return func(c *Context) {
// Search user in the slice of allowed credentials
user, found := pairs.searchCredential(c.requestHeader("Authorization"))
2015-05-19 18:20:52 +00:00
if !found {
// Credentials doesn't match, we return 401 and abort handlers chain.
c.Header("WWW-Authenticate", realm)
c.AbortWithStatus(http.StatusUnauthorized)
2017-07-18 00:54:38 +00:00
return
2014-10-08 23:40:42 +00:00
}
2017-07-18 00:54:38 +00:00
// The user credentials was found, set user's id to key AuthUserKey in this context, the user's id can be read later using
2017-08-16 03:55:50 +00:00
// c.MustGet(gin.AuthUserKey).
2017-07-18 00:54:38 +00:00
c.Set(AuthUserKey, user)
2014-10-08 23:40:42 +00:00
}
}
2014-06-17 23:42:34 +00:00
// BasicAuth returns a Basic HTTP Authorization middleware. It takes as argument a map[string]string where
// the key is the user name and the value is the password.
func BasicAuth(accounts Accounts) HandlerFunc {
return BasicAuthForRealm(accounts, "")
}
2015-03-23 03:38:32 +00:00
func processAccounts(accounts Accounts) authPairs {
2016-01-27 23:35:09 +00:00
assert1(len(accounts) > 0, "Empty list of authorized credentials")
2014-10-08 23:40:42 +00:00
pairs := make(authPairs, 0, len(accounts))
2014-07-04 02:28:25 +00:00
for user, password := range accounts {
2017-09-28 16:22:35 +00:00
assert1(user != "", "User can not be empty")
2015-04-08 13:32:50 +00:00
value := authorizationHeader(user, password)
2014-10-08 23:40:42 +00:00
pairs = append(pairs, authPair{
value: value,
user: user,
2014-10-08 23:40:42 +00:00
})
2014-06-17 23:42:34 +00:00
}
2015-03-23 03:38:32 +00:00
return pairs
2014-06-17 23:42:34 +00:00
}
func authorizationHeader(user, password string) string {
base := user + ":" + password
return "Basic " + base64.StdEncoding.EncodeToString([]byte(base))
2014-06-17 23:42:34 +00:00
}
2014-10-08 23:40:42 +00:00
func secureCompare(given, actual string) bool {
if subtle.ConstantTimeEq(int32(len(given)), int32(len(actual))) == 1 {
return subtle.ConstantTimeCompare([]byte(given), []byte(actual)) == 1
2014-06-17 23:42:34 +00:00
}
2017-08-16 03:55:50 +00:00
// Securely compare actual to itself to keep constant time, but always return false.
return subtle.ConstantTimeCompare([]byte(actual), []byte(actual)) == 1 && false
2014-06-17 23:42:34 +00:00
}