mirror of
https://github.com/caddyserver/caddy.git
synced 2024-11-26 02:09:47 +08:00
6e3063b15a
* caddyauth: Speed up basicauth provisioning, precalculate fake password * Deprecate scrypt, allow using decoded bcrypt hashes * Add TODO note Co-authored-by: Matt Holt <mholt@users.noreply.github.com> Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
138 lines
3.6 KiB
Go
138 lines
3.6 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 (
|
|
"bufio"
|
|
"bytes"
|
|
"encoding/base64"
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"os/signal"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
caddycmd "github.com/caddyserver/caddy/v2/cmd"
|
|
"golang.org/x/term"
|
|
)
|
|
|
|
func init() {
|
|
caddycmd.RegisterCommand(caddycmd.Command{
|
|
Name: "hash-password",
|
|
Func: cmdHashPassword,
|
|
Usage: "[--algorithm <name>] [--salt <string>] [--plaintext <password>]",
|
|
Short: "Hashes a password and writes base64",
|
|
Long: `
|
|
Convenient way to hash a plaintext password. The resulting
|
|
hash is written to stdout as a base64 string.
|
|
|
|
--plaintext, when omitted, will be read from stdin. If
|
|
Caddy is attached to a controlling tty, the plaintext will
|
|
not be echoed.
|
|
|
|
--algorithm may be bcrypt or scrypt. If scrypt, the default
|
|
parameters are used.
|
|
|
|
Use the --salt flag for algorithms which require a salt to
|
|
be provided (scrypt).
|
|
|
|
Note that scrypt is deprecated. Please use 'bcrypt' instead.
|
|
`,
|
|
Flags: func() *flag.FlagSet {
|
|
fs := flag.NewFlagSet("hash-password", flag.ExitOnError)
|
|
fs.String("algorithm", "bcrypt", "Name of the hash algorithm")
|
|
fs.String("plaintext", "", "The plaintext password")
|
|
fs.String("salt", "", "The password salt")
|
|
return fs
|
|
}(),
|
|
})
|
|
}
|
|
|
|
func cmdHashPassword(fs caddycmd.Flags) (int, error) {
|
|
var err error
|
|
|
|
algorithm := fs.String("algorithm")
|
|
plaintext := []byte(fs.String("plaintext"))
|
|
salt := []byte(fs.String("salt"))
|
|
|
|
if len(plaintext) == 0 {
|
|
fd := int(os.Stdin.Fd())
|
|
if term.IsTerminal(fd) {
|
|
// ensure the terminal state is restored on SIGINT
|
|
state, _ := term.GetState(fd)
|
|
c := make(chan os.Signal, 1)
|
|
signal.Notify(c, os.Interrupt)
|
|
go func() {
|
|
<-c
|
|
_ = term.Restore(fd, state)
|
|
os.Exit(caddy.ExitCodeFailedStartup)
|
|
}()
|
|
defer signal.Stop(c)
|
|
|
|
fmt.Fprint(os.Stderr, "Enter password: ")
|
|
plaintext, err = term.ReadPassword(fd)
|
|
fmt.Fprintln(os.Stderr)
|
|
if err != nil {
|
|
return caddy.ExitCodeFailedStartup, err
|
|
}
|
|
|
|
fmt.Fprint(os.Stderr, "Confirm password: ")
|
|
confirmation, err := term.ReadPassword(fd)
|
|
fmt.Fprintln(os.Stderr)
|
|
if err != nil {
|
|
return caddy.ExitCodeFailedStartup, err
|
|
}
|
|
|
|
if !bytes.Equal(plaintext, confirmation) {
|
|
return caddy.ExitCodeFailedStartup, fmt.Errorf("password does not match")
|
|
}
|
|
} else {
|
|
rd := bufio.NewReader(os.Stdin)
|
|
plaintext, err = rd.ReadBytes('\n')
|
|
if err != nil {
|
|
return caddy.ExitCodeFailedStartup, err
|
|
}
|
|
|
|
plaintext = plaintext[:len(plaintext)-1] // Trailing newline
|
|
}
|
|
|
|
if len(plaintext) == 0 {
|
|
return caddy.ExitCodeFailedStartup, fmt.Errorf("plaintext is required")
|
|
}
|
|
}
|
|
|
|
var hash []byte
|
|
var hashString string
|
|
switch algorithm {
|
|
case "bcrypt":
|
|
hash, err = BcryptHash{}.Hash(plaintext, nil)
|
|
hashString = string(hash)
|
|
case "scrypt":
|
|
def := ScryptHash{}
|
|
def.SetDefaults()
|
|
hash, err = def.Hash(plaintext, salt)
|
|
hashString = base64.StdEncoding.EncodeToString(hash)
|
|
default:
|
|
return caddy.ExitCodeFailedStartup, fmt.Errorf("unrecognized hash algorithm: %s", algorithm)
|
|
}
|
|
if err != nil {
|
|
return caddy.ExitCodeFailedStartup, err
|
|
}
|
|
|
|
fmt.Println(hashString)
|
|
|
|
return 0, nil
|
|
}
|