2019-10-11 04:37:27 +08:00
|
|
|
// Copyright 2015 Matthew Holt and The Caddy 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 caddyauth
|
|
|
|
|
|
|
|
import (
|
2020-01-07 23:50:18 +08:00
|
|
|
"encoding/base64"
|
2019-10-11 04:37:27 +08:00
|
|
|
"encoding/json"
|
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
|
|
)
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
caddy.RegisterModule(HTTPBasicAuth{})
|
|
|
|
}
|
|
|
|
|
|
|
|
// HTTPBasicAuth facilitates HTTP basic authentication.
|
|
|
|
type HTTPBasicAuth struct {
|
2019-12-24 03:45:35 +08:00
|
|
|
// The algorithm with which the passwords are hashed. Default: bcrypt
|
|
|
|
HashRaw json.RawMessage `json:"hash,omitempty" caddy:"namespace=http.authentication.hashes inline_key=algorithm"`
|
|
|
|
|
|
|
|
// The list of accounts to authenticate.
|
|
|
|
AccountList []Account `json:"accounts,omitempty"`
|
|
|
|
|
|
|
|
// The name of the realm. Default: restricted
|
|
|
|
Realm string `json:"realm,omitempty"`
|
2019-10-11 04:37:27 +08:00
|
|
|
|
|
|
|
Accounts map[string]Account `json:"-"`
|
|
|
|
Hash Comparer `json:"-"`
|
|
|
|
}
|
|
|
|
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
|
|
func (HTTPBasicAuth) CaddyModule() caddy.ModuleInfo {
|
|
|
|
return caddy.ModuleInfo{
|
2019-12-11 04:36:46 +08:00
|
|
|
ID: "http.authentication.providers.http_basic",
|
|
|
|
New: func() caddy.Module { return new(HTTPBasicAuth) },
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Provision provisions the HTTP basic auth provider.
|
|
|
|
func (hba *HTTPBasicAuth) Provision(ctx caddy.Context) error {
|
|
|
|
if hba.HashRaw == nil {
|
2020-02-18 03:19:59 +08:00
|
|
|
hba.HashRaw = json.RawMessage(`{"algorithm": "bcrypt"}`)
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// load password hasher
|
2019-12-11 04:36:46 +08:00
|
|
|
hasherIface, err := ctx.LoadModule(hba, "HashRaw")
|
2019-10-11 04:37:27 +08:00
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("loading password hasher module: %v", err)
|
|
|
|
}
|
2019-12-11 04:36:46 +08:00
|
|
|
hba.Hash = hasherIface.(Comparer)
|
2019-10-11 04:37:27 +08:00
|
|
|
|
|
|
|
if hba.Hash == nil {
|
|
|
|
return fmt.Errorf("hash is required")
|
|
|
|
}
|
|
|
|
|
2020-01-07 23:50:18 +08:00
|
|
|
repl := caddy.NewReplacer()
|
|
|
|
|
2019-10-11 04:37:27 +08:00
|
|
|
// load account list
|
|
|
|
hba.Accounts = make(map[string]Account)
|
2020-01-07 23:50:18 +08:00
|
|
|
for i, acct := range hba.AccountList {
|
2019-10-11 04:37:27 +08:00
|
|
|
if _, ok := hba.Accounts[acct.Username]; ok {
|
2020-01-07 23:50:18 +08:00
|
|
|
return fmt.Errorf("account %d: username is not unique: %s", i, acct.Username)
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
2020-01-07 23:50:18 +08:00
|
|
|
|
|
|
|
acct.Username = repl.ReplaceAll(acct.Username, "")
|
2020-04-09 05:31:51 +08:00
|
|
|
acct.Password = repl.ReplaceAll(acct.Password, "")
|
|
|
|
acct.Salt = repl.ReplaceAll(acct.Salt, "")
|
2020-01-07 23:50:18 +08:00
|
|
|
|
|
|
|
if acct.Username == "" || acct.Password == "" {
|
|
|
|
return fmt.Errorf("account %d: username and password are required", i)
|
|
|
|
}
|
|
|
|
|
|
|
|
acct.password, err = base64.StdEncoding.DecodeString(acct.Password)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("base64-decoding password: %v", err)
|
|
|
|
}
|
|
|
|
if acct.Salt != "" {
|
|
|
|
acct.salt, err = base64.StdEncoding.DecodeString(acct.Salt)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("base64-decoding salt: %v", err)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-10-11 04:37:27 +08:00
|
|
|
hba.Accounts[acct.Username] = acct
|
|
|
|
}
|
|
|
|
hba.AccountList = nil // allow GC to deallocate
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Authenticate validates the user credentials in req and returns the user, if valid.
|
|
|
|
func (hba HTTPBasicAuth) Authenticate(w http.ResponseWriter, req *http.Request) (User, bool, error) {
|
|
|
|
username, plaintextPasswordStr, ok := req.BasicAuth()
|
|
|
|
if !ok {
|
2020-04-08 10:39:13 +08:00
|
|
|
return hba.promptForCredentials(w, nil)
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
plaintextPassword := []byte(plaintextPasswordStr)
|
|
|
|
|
|
|
|
account, accountExists := hba.Accounts[username]
|
|
|
|
// don't return early if account does not exist; we want
|
|
|
|
// to try to avoid side-channels that leak existence
|
|
|
|
|
2020-01-07 23:50:18 +08:00
|
|
|
same, err := hba.Hash.Compare(account.password, plaintextPassword, account.salt)
|
2019-10-11 04:37:27 +08:00
|
|
|
if err != nil {
|
2020-04-08 10:39:13 +08:00
|
|
|
return hba.promptForCredentials(w, err)
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
|
|
|
if !same || !accountExists {
|
2020-04-08 10:39:13 +08:00
|
|
|
return hba.promptForCredentials(w, nil)
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
return User{ID: username}, true, nil
|
|
|
|
}
|
|
|
|
|
2020-04-08 10:39:13 +08:00
|
|
|
func (hba HTTPBasicAuth) promptForCredentials(w http.ResponseWriter, err error) (User, bool, error) {
|
|
|
|
// browsers show a message that says something like:
|
|
|
|
// "The website says: <realm>"
|
|
|
|
// which is kinda dumb, but whatever.
|
|
|
|
realm := hba.Realm
|
|
|
|
if realm == "" {
|
|
|
|
realm = "restricted"
|
|
|
|
}
|
|
|
|
w.Header().Set("WWW-Authenticate", fmt.Sprintf(`Basic realm="%s"`, realm))
|
|
|
|
return User{}, false, err
|
|
|
|
}
|
|
|
|
|
2019-10-11 04:37:27 +08:00
|
|
|
// Comparer is a type that can securely compare
|
|
|
|
// a plaintext password with a hashed password
|
|
|
|
// in constant-time. Comparers should hash the
|
|
|
|
// plaintext password and then use constant-time
|
|
|
|
// comparison.
|
|
|
|
type Comparer interface {
|
|
|
|
// Compare returns true if the result of hashing
|
|
|
|
// plaintextPassword with salt is hashedPassword,
|
|
|
|
// false otherwise. An error is returned only if
|
|
|
|
// there is a technical/configuration error.
|
|
|
|
Compare(hashedPassword, plaintextPassword, salt []byte) (bool, error)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Account contains a username, password, and salt (if applicable).
|
|
|
|
type Account struct {
|
2019-12-24 03:45:35 +08:00
|
|
|
// A user's username.
|
2019-10-11 04:37:27 +08:00
|
|
|
Username string `json:"username"`
|
2019-12-24 03:45:35 +08:00
|
|
|
|
|
|
|
// The user's hashed password, base64-encoded.
|
2020-01-07 23:50:18 +08:00
|
|
|
Password string `json:"password"`
|
2019-12-24 03:45:35 +08:00
|
|
|
|
|
|
|
// The user's password salt, base64-encoded; for
|
|
|
|
// algorithms where external salt is needed.
|
2020-01-07 23:50:18 +08:00
|
|
|
Salt string `json:"salt,omitempty"`
|
|
|
|
|
|
|
|
password, salt []byte
|
2019-10-11 04:37:27 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
// Interface guards
|
|
|
|
var (
|
|
|
|
_ caddy.Provisioner = (*HTTPBasicAuth)(nil)
|
|
|
|
_ Authenticator = (*HTTPBasicAuth)(nil)
|
|
|
|
)
|