mirror of
https://github.com/caddyserver/caddy.git
synced 2025-10-31 10:37:24 -04:00
49dac61b07
* feat: add bcrypt cost parameter to hash-password * revert: typos * refactor: take the cost out of interface * fix: default bcrypt cost to 14 * fix: follow bcrypt library for min and max cost * doc: mention defaultBcryptCost in cost parameter description * chore: gci format * fix: more specific bcrypt cost algorithm flag * feat: bcrypt cost provisioning * Revert "feat: bcrypt cost provisioning" This reverts commit e09d4bd036e7657588ed7785afd2c5388b29fb2a. * chore: gci format * chore: gci format * chore: gci format * chore: golangcilint fmted --------- Co-authored-by: Mohammed Al Sahaf <msaa1990@gmail.com>
81 lines
2.2 KiB
Go
81 lines
2.2 KiB
Go
// 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 (
|
|
"errors"
|
|
|
|
"golang.org/x/crypto/bcrypt"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
)
|
|
|
|
func init() {
|
|
caddy.RegisterModule(BcryptHash{})
|
|
}
|
|
|
|
// defaultBcryptCost cost 14 strikes a solid balance between security, usability, and hardware performance
|
|
const defaultBcryptCost = 14
|
|
|
|
// BcryptHash implements the bcrypt hash.
|
|
type BcryptHash struct {
|
|
// cost is the bcrypt hashing difficulty factor (work factor).
|
|
// Higher values increase computation time and security.
|
|
cost int
|
|
}
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (BcryptHash) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "http.authentication.hashes.bcrypt",
|
|
New: func() caddy.Module { return new(BcryptHash) },
|
|
}
|
|
}
|
|
|
|
// Compare compares passwords.
|
|
func (BcryptHash) Compare(hashed, plaintext []byte) (bool, error) {
|
|
err := bcrypt.CompareHashAndPassword(hashed, plaintext)
|
|
if errors.Is(err, bcrypt.ErrMismatchedHashAndPassword) {
|
|
return false, nil
|
|
}
|
|
if err != nil {
|
|
return false, err
|
|
}
|
|
return true, nil
|
|
}
|
|
|
|
// Hash hashes plaintext using a random salt.
|
|
func (b BcryptHash) Hash(plaintext []byte) ([]byte, error) {
|
|
cost := b.cost
|
|
if cost < bcrypt.MinCost || cost > bcrypt.MaxCost {
|
|
cost = defaultBcryptCost
|
|
}
|
|
|
|
return bcrypt.GenerateFromPassword(plaintext, cost)
|
|
}
|
|
|
|
// FakeHash returns a fake hash.
|
|
func (BcryptHash) FakeHash() []byte {
|
|
// hashed with the following command:
|
|
// caddy hash-password --plaintext "antitiming" --algorithm "bcrypt"
|
|
return []byte("$2a$14$X3ulqf/iGxnf1k6oMZ.RZeJUoqI9PX2PM4rS5lkIKJXduLGXGPrt6")
|
|
}
|
|
|
|
// Interface guards
|
|
var (
|
|
_ Comparer = (*BcryptHash)(nil)
|
|
_ Hasher = (*BcryptHash)(nil)
|
|
)
|