gin/auth.go

108 lines
3.1 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"
"errors"
"fmt"
2014-06-17 23:42:34 +00:00
"sort"
)
const (
AuthUserKey = "user"
)
2014-06-17 23:42:34 +00:00
type (
2014-07-04 02:28:25 +00:00
Accounts map[string]string
2014-10-08 23:40:42 +00:00
authPair struct {
Value string
User string
}
authPairs []authPair
2014-06-17 23:42:34 +00:00
)
2014-10-08 23:40:42 +00:00
func (a authPairs) Len() int { return len(a) }
func (a authPairs) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a authPairs) Less(i, j int) bool { return a[i].Value < a[j].Value }
func (a authPairs) searchCredential(auth string) (string, bool) {
if len(auth) == 0 {
return "", false
}
// Search user in the slice of allowed credentials
r := sort.Search(len(a), func(i int) bool { return a[i].Value >= auth })
if r < len(a) && secureCompare(a[r].Value, auth) {
return a[r].User, true
} else {
return "", false
}
}
// Implements a basic Basic HTTP Authorization. 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
// (see http://tools.ietf.org/html/rfc2617#section-1.2)
func BasicAuthForRealm(accounts Accounts, realm string) HandlerFunc {
if realm == "" {
realm = "Authorization Required"
}
realm = fmt.Sprintf("Basic realm=\"%s\"", 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, ok := pairs.searchCredential(c.Request.Header.Get("Authorization"))
2014-10-08 23:40:42 +00:00
if !ok {
// Credentials doesn't match, we return 401 Unauthorized and abort request.
c.Writer.Header().Set("WWW-Authenticate", realm)
2014-10-08 23:40:42 +00:00
c.Fail(401, errors.New("Unauthorized"))
} else {
// user is allowed, set UserId to key "user" in this context, the userId can be read later using
// c.Get(gin.AuthUserKey)
c.Set(AuthUserKey, user)
}
}
}
2014-06-17 23:42:34 +00:00
// Implements a basic Basic HTTP Authorization. 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 {
2014-06-17 23:42:34 +00:00
if len(accounts) == 0 {
2015-04-08 00:58:35 +00:00
panic("Empty list of authorized credentials")
2014-06-17 23:42:34 +00:00
}
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 {
2014-10-08 23:40:42 +00:00
if len(user) == 0 {
2015-04-08 00:58:35 +00:00
panic("User can not be empty")
2014-06-17 23:42:34 +00:00
}
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-06-17 23:42:34 +00:00
}
// We have to sort the credentials in order to use bsearch later.
sort.Sort(pairs)
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
} else {
/* 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
}
}