1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796
|
package cli
import (
"bytes"
"crypto/rand"
"fmt"
"github.com/hlandau/acmetool/hooks"
"github.com/hlandau/acmetool/interaction"
"github.com/hlandau/acmetool/storage"
"github.com/hlandau/acmetool/storageops"
"gopkg.in/hlandau/acmeapi.v2"
"gopkg.in/hlandau/acmeapi.v2/acmeendpoints"
"gopkg.in/hlandau/svcutils.v1/exepath"
"gopkg.in/hlandau/svcutils.v1/passwd"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"reflect"
"strconv"
"strings"
)
func cmdQuickstart() {
s, err := storage.NewFDB(*stateFlag)
log.Fatale(err, "storage")
serverURL := promptServerURL()
s.DefaultTarget().Request.Provider = serverURL
err = s.SaveTarget(s.DefaultTarget())
log.Fatale(err, "set provider URL")
// key type
keyType := promptKeyType()
switch keyType {
case "rsa":
s.DefaultTarget().Request.Key.Type = "rsa"
rsaKeySize := promptRSAKeySize()
if rsaKeySize != 0 {
s.DefaultTarget().Request.Key.RSASize = rsaKeySize
err = s.SaveTarget(s.DefaultTarget())
log.Fatale(err, "set preferred RSA Key size")
}
case "ecdsa":
s.DefaultTarget().Request.Key.Type = "ecdsa"
ecdsaCurve := promptECDSACurve()
if ecdsaCurve != "" {
s.DefaultTarget().Request.Key.ECDSACurve = ecdsaCurve
err = s.SaveTarget(s.DefaultTarget())
log.Fatale(err, "set preferred ECDSA curve")
}
}
// hook method
method := promptHookMethod()
var webroot []string
switch method {
case "webroot":
webroot = []string{promptWebrootDir()}
}
if len(webroot) != 0 {
err = os.MkdirAll(webroot[0], 0755)
log.Fatale(err, "couldn't create webroot path")
}
s.DefaultTarget().Request.Challenge.WebrootPaths = webroot
err = s.SaveTarget(s.DefaultTarget())
log.Fatale(err, "set webroot path")
prog, err := interaction.Auto.Status(&interaction.StatusInfo{
Title: "Registering account...",
})
log.Fatale(err, "status")
prog.SetProgress(0, 1)
err = storageops.EnsureRegistration(s)
log.Fatale(err, "couldn't complete registration")
prog.SetProgress(1, 1)
prog.Close()
if method == "redirector" {
promptSystemd()
}
installDefaultHooks()
if promptInstallCombinedHooks() {
installCombinedHooks()
}
promptCron()
promptGettingStarted()
}
const reloadHookFile = `#!/bin/sh
## This file was installed by acmetool. Any updates to this script will
## overwrite changes you make. If you don't want acmetool to manage
## this file, remove the following line.
##!acmetool-managed!##
# This file reloads services when the preferred certificate for a hostname
# changes. A list of commonly used daemons is preconfigured. You can override
# this list by setting $SERVICES in /etc/{default,conf.d}/acme-reload.
#
# Configuration options:
# /etc/{default,conf.d}/acme-reload
# Sourced if they exist. Specify variables here.
# Please note that most of the time, you don't need to specify anything.
#
# $SERVICES
# Space-separated list of daemons to reload.
# Append with SERVICES="$SERVICES mydaemon".
###############################################################################
set -e
EVENT_NAME="$1"
[ "$EVENT_NAME" = "live-updated" ] || exit 42
SERVICES="httpd apache2 apache nginx tengine lighttpd postfix dovecot exim exim4 haproxy hitch quassel quasselcore opensmtpd freeswitch apache24"
[ -e "/etc/default/acme-reload" ] && . /etc/default/acme-reload
[ -e "/etc/conf.d/acme-reload" ] && . /etc/conf.d/acme-reload
[ -z "$ACME_STATE_DIR" ] && ACME_STATE_DIR="@@ACME_STATE_DIR@@"
# Restart services.
if which service >/dev/null 2>/dev/null; then
for x in $SERVICES; do
service "$x" reload >/dev/null 2>/dev/null || true
done
exit 0
fi
if which systemctl >/dev/null 2>/dev/null; then
for x in $SERVICES; do
[ -e "/lib/systemd/system/$x.service" -o -e "/etc/systemd/system/$x.service" ] && systemctl reload "$x.service" >/dev/null 2>/dev/null || true
done
exit 0
fi
if [ -e "/etc/init.d" ]; then
for x in $SERVICES; do
/etc/init.d/$x reload >/dev/null 2>/dev/null || true
done
exit 0
fi`
const combinedReloadHookFile = `#!/bin/sh
## This file was installed by acmetool. Any updates to this script will
## overwrite changes you make. If you don't want acmetool to manage
## this file, remove the following line.
##!acmetool-managed!##
# This file generates combined certificate+private key files for daemons which
# require them. It is called haproxy for legacy reasons, HAProxy being a common
# example of such a daemon, but can also be used with other daemons taking the
# same input format such as Hitch and Quasselcore.
#
# This is done outside of acmetool, because it is desired to avoid making
# unnecessary copies of private keys except in environments where it is
# necessary. This also demonstrates the power and flexibility of the hooks
# system.
#
# The files consist of the private key, followed by the certificate and
# certificate chain, followed by any data placed in conf/dhparams.
#
# This script is a no-op unless a daemon known to require combined files is
# found. You can override this by setting $HAPROXY_ALWAYS_GENERATE or
# $HAPROXY_DAEMONS in /etc/{default,conf.d}/acme-reload.
#
# (This file should be executed before 'reload'. So long as it is named
# 'haproxy' and reload is named 'reload', that is assured.)
#
# DEBUGGING NOTE: If you make changes to the configuration this will not
# be reflected simply by rerunning 'acmetool', because this script is only
# called when a symlink in 'live' is updated. You can force this script to
# be rerun by deleting all symlinks in 'live' and running 'acmetool'.
#
# Output:
# $ACME_STATE_DIR/live/$HOSTNAME/haproxy
# The combined certificate file for a hostname.
#
# $ACME_STATE_DIR/haproxy/$HOSTNAME
# Symlinked to the combined certificate file. Daemons such as HAProxy
# can prefer directories such as these, where each file is a hostname
# containing combined data.
#
# Configuration options:
# /etc/{default,conf.d}/acme-reload
# Sourced if they exist. Specify variables here.
# Please note that most of the time, you don't need to specify anything.
#
# $HAPROXY_ALWAYS_GENERATE
# If non-empty, always generate combined files.
#
# $HAPROXY_DAEMONS
# Space-separated list of binaries to search for in path. If any are found
# (or $HAPROXY_ALWAYS_GENERATE is set), generate combined files.
# Append with HAPROXY_DAEMONS="$HAPROXY_DAEMONS mydaemon".
# Defaults: see below.
#
# $HAPROXY_DH_PATH
# Defaults to "$ACME_STATE_DIR/conf/dhparams". If the file exists, it is
# appended verbatim to combined certificate files. Commonly used to attach
# custom Diffie-Hellman parameters.
#
# $HAPROXY_UMASK
# Don't change this unless you know what you're doing.
# If you change this, you must create a conf/perm file to reconfigure
# acmetool's permissions enforcement. See _doc directory in repository.
# Override path "certs/*/haproxy".
###############################################################################
set -e
EVENT_NAME="$1"
[ "$EVENT_NAME" = "live-updated" ] || exit 42
# List of services. If any of these are in PATH (or HAPROXY_ALWAYS_GENERATE is
# set), assume we need to generate combined files.
HAPROXY_DAEMONS="haproxy hitch quasselcore quassel lighttpd freeswitch"
HAPROXY_UMASK="0077"
[ -e "/etc/default/acme-reload" ] && . /etc/default/acme-reload
[ -e "/etc/conf.d/acme-reload" ] && . /etc/conf.d/acme-reload
[ -z "$ACME_STATE_DIR" ] && ACME_STATE_DIR="@@ACME_STATE_DIR@@"
[ -z "$HAPROXY_DH_PATH" ] && HAPROXY_DH_PATH="$ACME_STATE_DIR/conf/dhparams"
# Don't do anything if no daemon requiring combined files is found.
[ -n "$HAPROXY_ALWAYS_GENERATE" ] || {
ok=
for exe in $HAPROXY_DAEMONS; do
which "$exe" >/dev/null 2>/dev/null && ok=1 && break
done
[ -z "$ok" ] && exit 0
}
# Create coalesced files and a haproxy repository.
umask 0022
mkdir -p "$ACME_STATE_DIR/haproxy"
umask $HAPROXY_UMASK
while read name; do
certdir="$ACME_STATE_DIR/live/$name"
if [ -z "$name" -o ! -e "$certdir" ]; then
continue
fi
if [ -n "$HAPROXY_DH_PATH" -a -e "$HAPROXY_DH_PATH" ]; then
cat "$certdir/privkey" "$certdir/fullchain" "$HAPROXY_DH_PATH" > "$certdir/haproxy"
else
cat "$certdir/privkey" "$certdir/fullchain" > "$certdir/haproxy"
fi
[ -h "$ACME_STATE_DIR/haproxy/$name" ] || ln -fs "../live/$name/haproxy" "$ACME_STATE_DIR/haproxy/$name"
done`
func installHook(name, value string) {
hooks.Replace(*hooksFlag, name, strings.Replace(value, "@@ACME_STATE_DIR@@", *stateFlag, -1))
// fail silently, allow non-root, makes travis work.
}
func installDefaultHooks() {
installHook("reload", reloadHookFile)
}
func installCombinedHooks() {
installHook("haproxy", combinedReloadHookFile)
}
var errStop = fmt.Errorf("stop")
func isCronjobInstalled() bool {
ms, err := filepath.Glob("/etc/cron.*/*acmetool*")
log.Fatale(err, "glob")
if len(ms) > 0 {
return true
}
installed := false
filepath.Walk("/var/spool/cron", func(p string, fi os.FileInfo, err error) error {
if err != nil {
return nil
}
if (fi.Mode() & os.ModeType) != 0 {
return nil
}
if strings.Index(fi.Name(), "acmetool") >= 0 {
installed = true
return errStop
}
f, err := os.Open(p)
if err != nil {
return nil
}
defer f.Close()
b, err := ioutil.ReadAll(f)
if err != nil {
return nil
}
if bytes.Index(b, []byte("acmetool")) >= 0 {
installed = true
return errStop
}
return nil
})
return installed
}
func formulateCron(root bool) string {
// Randomise cron time to avoid hammering the ACME server.
var b [2]byte
_, err := rand.Read(b[:])
log.Panice(err)
m := b[0] % 60
h := b[1] % 24
s := ""
if root {
s = "SHELL=/bin/sh\nPATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin\nMAILTO=root\n"
}
s += fmt.Sprintf("%d %d * * * ", m, h)
if root {
s += "root "
}
s += fmt.Sprintf("%s --batch ", exepath.Abs)
if *stateFlag != storage.RecommendedPath {
s += fmt.Sprintf(`--state="%s" `, *stateFlag)
}
if !reflect.DeepEqual(*hooksFlag, hooks.RecommendedPaths) {
for _, hookDir := range *hooksFlag {
s += fmt.Sprintf(`--hooks="%s" `, hookDir)
}
}
s += "reconcile\n"
return s
}
func runningAsRoot() bool {
return os.Getuid() == 0
}
func promptCron() {
if isCronjobInstalled() {
return
}
var err error
cronString := formulateCron(runningAsRoot())
if runningAsRoot() {
_, err = os.Stat("/etc/cron.d")
} else {
_, err = exec.LookPath("crontab")
}
if err != nil {
log.Warnf("Don't know how to install a cron job on this system, please install the following job:\n%s\n", cronString)
return
}
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "Install auto-renewal cronjob?",
Body: "Would you like to install a cronjob to renew certificates automatically? This is recommended.",
ResponseType: interaction.RTYesNo,
UniqueID: "acmetool-quickstart-install-cronjob",
})
log.Fatale(err, "interaction")
if r.Cancelled {
return
}
if runningAsRoot() {
f, err := os.OpenFile("/etc/cron.d/acmetool", os.O_CREATE|os.O_WRONLY|os.O_EXCL, 0644)
if err != nil {
log.Errore(err, "failed to install cron job at /etc/cron.d/acmetool (does the file already exist?), wanted to install: ", cronString)
return
}
defer f.Close()
f.Write([]byte(cronString))
} else {
err := amendUserCron(cronString, "acmetool")
if err != nil {
log.Errore(err, "failed to amend user crontab to add: ", cronString)
return
}
}
}
func amendUserCron(cronLine, filterString string) error {
b, err := getUserCron()
if err != nil {
return err
}
if bytes.Index(b, []byte("acmetool")) >= 0 {
return nil
}
b = append(b, '\n')
b = append(b, []byte(cronLine)...)
return setUserCron(b)
}
func getUserCron() ([]byte, error) {
errBuf := bytes.Buffer{}
listCmd := exec.Command("crontab", "-l")
listCmd.Stderr = &errBuf
b, err := listCmd.Output()
if err == nil {
return b, nil
}
// crontab -l returns 1 if no crontab is installed, grep stderr to identify this condition
if bytes.Index(errBuf.Bytes(), []byte("no crontab for")) >= 0 {
return nil, nil
}
return b, nil
}
func setUserCron(b []byte) error {
setCmd := exec.Command("crontab", "-")
setCmd.Stdin = bytes.NewReader(b)
setCmd.Stdout = os.Stdout
setCmd.Stderr = os.Stderr
return setCmd.Run()
}
func promptInstallCombinedHooks() bool {
// Always install if the hook is already installed.
hooksPaths := *hooksFlag
if len(hooksPaths) == 0 {
hooksPaths = hooks.DefaultPaths
}
if hooks.Exists(hooksPaths, "haproxy") {
return true
}
// Prompt.
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "Install combined certificate files?",
Body: fmt.Sprintf(`By default, acmetool stores certificates and private keys separately. The vast majority of daemons prefer this format. However, some daemons, such as HAProxy, require combined files which contain both certificate and private key.
acmetool doesn't create such files by default to avoid creating unnecessary copies of private keys. acmetool can install a notification hook that will automatically generate an additional file called "haproxy" in every certificate directory. (These files are accepted by more than just HAProxy; the name is used for legacy reasons.) This means that you can point such daemons at "%s/live/HOSTNAME/haproxy".
These files will also be accessible in a directory of their own, "%s/haproxy/HOSTNAME", for daemons which like a directory of files named after hostnames.
If you place a PEM-encoded DH parameter file at "%s/conf/dhparams", those will also be included in each
"haproxy" file. This is optional.
Examples of daemons requiring combined files include HAProxy, Hitch, Quassel, Freeswitch. The hook script will not generate the files unless one of these daemons is detected, or you configure it to always generate combined files. (See the hook script for configuration documentation.) Therefore, installing the script is a no-op on systems without these daemons installed, and it is always safe to say yes here.
Do you want to install the combined file generation hook? If in doubt, say yes.`,
*stateFlag, *stateFlag, *stateFlag),
ResponseType: interaction.RTYesNo,
Implicit: !*expertFlag,
UniqueID: "acmetool-quickstart-install-haproxy-script",
})
if err != nil {
// Install by default, since the hook script does nothing unless a service requiring it is
// installed. Can still be overriden by --expert or response file.
return true
}
return !r.Cancelled
}
var usernamesToTry = []string{"daemon", "nobody"}
func determineAppropriateUsername() (string, error) {
for _, u := range usernamesToTry {
_, err := passwd.ParseUID(u)
if err == nil {
return u, nil
}
}
return "", fmt.Errorf("cannot find appropriate username")
}
func promptRSAKeySize() int {
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "RSA Key Size",
Body: `Please enter the RSA key size to use for keys and account keys.
The recommended key size is 2048. Unsupported key sizes will be clamped to the nearest supported value at generation time (the current minimum is 2048; the current maximum is 4096).
Leave blank to use the recommended value, currently 2048.`,
ResponseType: interaction.RTLineString,
UniqueID: "acmetool-quickstart-rsa-key-size",
Implicit: !*expertFlag,
})
if err != nil {
return 0
}
if r.Cancelled {
os.Exit(1)
return 0
}
v := strings.TrimSpace(r.Value)
if v == "" {
return 0
}
n, err := strconv.ParseUint(v, 10, 31)
if err != nil {
interaction.Auto.Prompt(&interaction.Challenge{
Title: "Invalid RSA Key Size",
Body: "The RSA key size must be an integer in decimal form.",
UniqueID: "acmetool-quickstart-invalid-rsa-key-size",
})
return promptRSAKeySize()
}
return int(n)
}
func promptKeyType() string {
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "Key Type Selection",
Body: `Select the type of keys you want to use for account keys and certificates.
If in doubt, select RSA.`,
ResponseType: interaction.RTSelect,
Options: []interaction.Option{
{
Title: "RSA",
Value: "rsa",
},
{
Title: "ECDSA",
Value: "ecdsa",
},
},
UniqueID: "acmetool-quickstart-key-type",
Implicit: !*expertFlag,
})
if err != nil {
return "rsa"
}
if r.Cancelled {
os.Exit(1)
return ""
}
return r.Value
}
func promptECDSACurve() string {
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "ECDSA Curve Selection",
Body: `Please select the ECDSA curve to use for keys and account keys.
NOTE: nistp521 is not as well supported as the others and is not supported
by Let's Encrypt.`,
ResponseType: interaction.RTSelect,
Options: []interaction.Option{
{
Title: "NIST P-256 (recommended)",
Value: "nistp256",
},
{
Title: "NIST P-384",
Value: "nistp384",
},
{
Title: "NIST P-521 (limited support)",
Value: "nistp521",
},
},
UniqueID: "acmetool-quickstart-ecdsa-curve",
Implicit: !*expertFlag,
})
if err != nil {
return ""
}
if r.Cancelled {
os.Exit(1)
return ""
}
return r.Value
}
func promptWebrootDir() string {
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "Enter Webroot Path",
Body: `Please enter the path at which challenges should be stored.
If your webroot path is /var/www, you would enter /var/www/.well-known/acme-challenge here.
The directory will be created if it does not exist.
Webroot paths vary by OS; please consult your web server configuration.
`,
ResponseType: interaction.RTLineString,
UniqueID: "acmetool-quickstart-webroot-path",
})
log.Fatale(err, "interaction")
if r.Cancelled {
os.Exit(1)
return ""
}
path := r.Value
path = strings.TrimRight(strings.TrimSpace(path), "/")
if !filepath.IsAbs(path) {
interaction.Auto.Prompt(&interaction.Challenge{
Title: "Invalid Webroot Path",
Body: "The webroot path must be an absolute path.",
UniqueID: "acmetool-quickstart-webroot-path-invalid",
})
return promptWebrootDir()
}
if !strings.HasSuffix(path, "/.well-known/acme-challenge") {
r1 := r
r, err = interaction.Auto.Prompt(&interaction.Challenge{
Title: "Are you sure?",
Body: `The webroot path you have entered does not end in "/.well-known/acme-challenge". This path will only work if you have specially configured your webserver to map requests for that path to the specified directory.
Do you want to continue? To enter a different webroot path, select No.`,
ResponseType: interaction.RTYesNo,
Implicit: *batchFlag || r1.Noninteractive,
UniqueID: "acmetool-quickstart-webroot-path-unlikely",
})
if r != nil && r.Cancelled {
return promptWebrootDir()
}
}
err = os.MkdirAll(path, 0755)
log.Fatale(err, "could not create directory: ", path)
return path
}
func promptGettingStarted() {
if *batchFlag {
return
}
interaction.PrintStderrMessage(
"Quickstart Complete",
fmt.Sprintf(`The quickstart process is complete.
Ensure your chosen challenge conveyance method is configured properly before attempting to request certificates. You can find more information about how to configure your system for each method in the acmetool documentation: https://github.com/hlandau/acmetool/blob/master/_doc/WSCONFIG.md
To request a certificate, run:
$ sudo acmetool want example.com www.example.com
If the certificate is successfully obtained, it will be placed in %s/live/example.com/{cert,chain,fullchain,privkey}.
`, *stateFlag))
}
func promptHookMethod() string {
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "Select Challenge Conveyance Method",
Body: `acmetool needs to be able to convey challenge responses to the ACME server in order to prove its control of the domains for which you issue certificates. These authorizations expire rapidly, as do ACME-issued certificates (Let's Encrypt certificates have a 90 day lifetime), thus it is essential that the completion of these challenges is a) automated and b) functioning properly. There are several options by which challenges can be facilitated:
WEBROOT: The webroot option installs challenge files to a given directory. You must configure your web server so that the files will be available at <http://[HOST]/.well-known/acme-challenge/>. For example, if your webroot is "/var/www", specifying a webroot of "/var/www/.well-known/acme-challenge" is likely to work well. The directory will be created automatically if it does not already exist.
PROXY: The proxy option requires you to configure your web server to proxy requests for paths under /.well-known/acme-challenge/ to a special web server running on port 402, which will serve challenges appropriately.
REDIRECTOR: The redirector option runs a special web server daemon on port 80. This means that you cannot run your own web server on port 80. The redirector redirects all HTTP requests to the equivalent HTTPS URL, so this is useful if you want to enforce use of HTTPS. You will need to configure your web server to not listen on port 80, and you will need to configure your system to run "acmetool redirector" as a daemon. If your system uses systemd, an appropriate unit file can automatically be installed.
LISTEN: Directly listen on port 80 or 443, whichever is available, in order to complete challenges. This is useful only for development purposes.
STATELESS: Some web servers can be configured to respond to challenges themselves. This removes any need for interaction with acmetool. See documentation for web server support.
HOOK: Programmatic challenge provisioning. Advanced users only. Please see documentation.`,
ResponseType: interaction.RTSelect,
Options: []interaction.Option{
{
Title: "WEBROOT - Place challenges in a directory",
Value: "webroot",
},
{Title: "PROXY - I'll proxy challenge requests to an HTTP server",
Value: "proxy",
},
{Title: "REDIRECTOR - I want to use acmetool's redirect-to-HTTPS functionality",
Value: "redirector",
},
{Title: "LISTEN - Listen on port 80 or 443 (only useful for development purposes)",
Value: "listen",
},
{Title: "STATELESS - I will configure my web server with my account key",
Value: "stateless",
},
{Title: "HOOK - I will write scripts to provision challenges",
Value: "hook",
},
},
UniqueID: "acmetool-quickstart-choose-method",
})
log.Fatale(err, "interaction")
if r.Cancelled {
os.Exit(1)
return ""
}
return r.Value
}
func promptServerURL() string {
var options []interaction.Option
acmeendpoints.Visit(func(e *acmeendpoints.Endpoint) error {
t := e.Title
switch e.Code {
case "LetsEncryptLive":
t += " - I want live certificates"
case "LetsEncryptStaging":
t += " - I want test certificates"
}
options = append(options, interaction.Option{
Title: t,
Value: e.DirectoryURL,
})
return nil
})
options = append(options, interaction.Option{
Title: "Enter an ACME server URL",
Value: "url",
})
r, err := interaction.Auto.Prompt(&interaction.Challenge{
Title: "Select ACME Server",
Body: `Please choose an ACME server from which to request certificates. Your principal choices are the Let's Encrypt Live Server, and the Let's Encrypt Staging Server.
You can use the Let's Encrypt Live Server to get real certificates.
The Let's Encrypt Staging Server does not issue publically trusted certificates. It is useful for development purposes, as it has far higher rate limits than the live server.`,
ResponseType: interaction.RTSelect,
Options: options,
UniqueID: "acmetool-quickstart-choose-server",
})
log.Fatale(err, "interaction")
if r.Cancelled {
os.Exit(1)
return ""
}
if r.Value == "url" {
for {
r, err = interaction.Auto.Prompt(&interaction.Challenge{
Title: "Select ACME Server",
Body: `Please enter the "Directory URL" of an ACME server. This must be an HTTPS URL pointing to the ACME directory for the server.`,
ResponseType: interaction.RTLineString,
UniqueID: "acmetool-quickstart-enter-directory-url",
})
log.Fatale(err, "interaction")
if r.Cancelled {
os.Exit(1)
return ""
}
if acmeapi.ValidURL(r.Value) {
break
}
interaction.Auto.Prompt(&interaction.Challenge{
Title: "Invalid ACME URL",
Body: "That was not a valid ACME Directory URL. An ACME Directory URL must be a valid HTTPS URL.",
ResponseType: interaction.RTAcknowledge,
UniqueID: "acmetool-quickstart-invalid-directory-url",
})
log.Fatale(err, "interaction")
if r.Cancelled {
os.Exit(1)
return ""
}
}
}
return r.Value
}
|