core: Version 0.7.0

removed tls cache option

.github/workflows/ci.yml

@@ -1,126 +0,0 @@
-# Used as inspiration: https://github.com/mvdan/github-actions-golang
-
-name: Cross-Platform
-
-on:
-  push:
-    branches: 
-      - v2
-  pull_request:
-    branches: 
-      - v2
-
-jobs:
-  test:
-    strategy:
-      # Default is true, cancels jobs for other platforms in the matrix if one fails
-      fail-fast: false
-      matrix:
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
-        go-version: [ 1.14.x ]
-
-        # Set some variables per OS, usable via ${{ matrix.VAR }}
-        # CADDY_BIN_PATH: the path to the compiled Caddy binary, for artifact publishing
-        # SUCCESS: the typical value for $? per OS (Windows/pwsh returns 'True')
-        include:
-        - os: ubuntu-latest
-          CADDY_BIN_PATH: ./cmd/caddy/caddy
-          SUCCESS: 0
-
-        - os: macos-latest
-          CADDY_BIN_PATH: ./cmd/caddy/caddy
-          SUCCESS: 0
-
-        - os: windows-latest
-          CADDY_BIN_PATH: ./cmd/caddy/caddy.exe
-          SUCCESS: 'True'
-
-    runs-on: ${{ matrix.os }}
-
-    steps:
-    - name: Install Go
-      uses: actions/setup-go@v1
-      with:
-        go-version: ${{ matrix.go-version }}
-
-    - name: Checkout code
-      uses: actions/checkout@v2
-
-    # These tools would be useful if we later decide to reinvestigate
-    # publishing test/coverage reports to some tool for easier consumption
-    # - name: Install test and coverage analysis tools
-    #   run: |
-    #     go get github.com/axw/gocov/gocov
-    #     go get github.com/AlekSi/gocov-xml
-    #     go get -u github.com/jstemmer/go-junit-report
-    #     echo "::add-path::$(go env GOPATH)/bin"
-
-    - name: Print Go version and environment
-      id: vars
-      run: |
-        printf "Using go at: $(which go)\n"
-        printf "Go version: $(go version)\n"
-        printf "\n\nGo environment:\n\n"
-        go env
-        printf "\n\nSystem environment:\n\n"
-        env
-        # Calculate the short SHA1 hash of the git commit
-        echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
-
-    - name: Get dependencies
-      run: |
-        go get -v -t -d ./...
-        # mkdir test-results
-
-    - name: Build Caddy
-      working-directory: ./cmd/caddy
-      env:
-        CGO_ENABLED: 0
-      run: |
-        go build -trimpath -a -ldflags="-w -s" -v
-
-    - name: Publish Build Artifact
-      uses: actions/upload-artifact@v1
-      with:
-        name: caddy_v2_${{ runner.os }}_${{ steps.vars.outputs.short_sha }}
-        path: ${{ matrix.CADDY_BIN_PATH }}
-
-    # Commented bits below were useful to allow the job to continue
-    # even if the tests fail, so we can publish the report separately
-    # For info about set-output, see https://stackoverflow.com/questions/57850553/github-actions-check-steps-status
-    - name: Run tests
-      # id: step_test
-      # continue-on-error: true
-      run: |
-        # (go test -v -coverprofile=cover-profile.out -race ./... 2>&1) > test-results/test-result.out
-        go test -v -coverprofile="cover-profile.out" -race ./...
-        # echo "::set-output name=status::$?"
-
-    # Relevant step if we reinvestigate publishing test/coverage reports
-    # - name: Prepare coverage reports
-    #   run: |
-    #     mkdir coverage
-    #     gocov convert cover-profile.out > coverage/coverage.json
-    #     # Because Windows doesn't work with input redirection like *nix, but output redirection works.
-    #     (cat ./coverage/coverage.json | gocov-xml) > coverage/coverage.xml
-
-    # To return the correct result even though we set 'continue-on-error: true'
-    # - name: Coerce correct build result
-    #   if: matrix.os != 'windows-latest' && steps.step_test.outputs.status != ${{ matrix.SUCCESS }}
-    #   run: |
-    #     echo "step_test ${{ steps.step_test.outputs.status }}\n"
-    #     exit 1
-
-  # From https://github.com/reviewdog/action-golangci-lint
-  golangci-lint:
-    name: runner / golangci-lint
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code into the Go module directory
-        uses: actions/checkout@v2
-
-      - name: Run golangci-lint
-        uses: reviewdog/action-golangci-lint@v1
-        # uses: docker://reviewdog/action-golangci-lint:v1 # pre-build docker image
-        with:
-          github_token: ${{ secrets.github_token }}

.github/workflows/fuzzing.yml

@@ -1,84 +0,0 @@
-name: Fuzzing
-
-on:
-  # Regression testing
-  push:
-    branches: 
-      - v2
-  pull_request:
-    branches: 
-      - v2
-
-  # Daily midnight fuzzing
-  schedule:
-    - cron: '0 0 * * *'
-
-jobs:
-  fuzzing:
-    name: Fuzzing
-
-    strategy:
-      matrix:
-        os: [ ubuntu-latest ]
-        go-version: [ 1.14.x ]
-    runs-on: ${{ matrix.os }}
-
-    steps:
-    - name: Install Go
-      uses: actions/setup-go@v1
-      with:
-        go-version: ${{ matrix.go-version }}
-
-    - name: Checkout code
-      uses: actions/checkout@v2
-
-    - name: Download go-fuzz tools and the Fuzzit CLI, move Fuzzit CLI to GOBIN
-      # If we decide we need to prevent this from running on forks, we can use this line:
-      # if: github.repository == 'caddyserver/caddy'
-      run: |
-        # Install Clang-7.0 because other versions seem to be missing the file libclang_rt.fuzzer-x86_64.a
-        sudo add-apt-repository "deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-7 main"
-        wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
-        sudo apt update && sudo apt install -y clang-7 lldb-7 lld-7
-
-        go get -v github.com/dvyukov/go-fuzz/go-fuzz github.com/dvyukov/go-fuzz/go-fuzz-build
-        wget -q -O fuzzit https://github.com/fuzzitdev/fuzzit/releases/download/v2.4.77/fuzzit_Linux_x86_64
-        chmod a+x fuzzit
-        mv fuzzit $(go env GOPATH)/bin
-        echo "::add-path::$(go env GOPATH)/bin"
-
-    - name: Generate fuzzers & submit them to Fuzzit
-      continue-on-error: true
-      env:
-        FUZZIT_API_KEY: ${{ secrets.FUZZIT_API_KEY }}
-      run: |
-        declare -A fuzzers_funcs=(\
-          ["./caddyconfig/httpcaddyfile/addresses_fuzz.go"]="FuzzParseAddress" \
-          ["./caddyconfig/caddyfile/parse_fuzz.go"]="FuzzParseCaddyfile" \
-          ["./listeners_fuzz.go"]="FuzzParseNetworkAddress" \
-          ["./replacer_fuzz.go"]="FuzzReplacer" \
-        )
-
-        declare -A fuzzers_targets=(\
-          ["./caddyconfig/httpcaddyfile/addresses_fuzz.go"]="parse-address" \
-          ["./caddyconfig/caddyfile/parse_fuzz.go"]="parse-caddyfile" \
-          ["./listeners_fuzz.go"]="parse-network-address" \
-          ["./replacer_fuzz.go"]="replacer" \
-        )
-
-        fuzz_type="local-regression"
-        if [[ ${{ github.event_name }} == "schedule" ]]; then
-          fuzz_type="fuzzing"
-        fi
-        echo "Github event: ${{ github.event_name }}"
-        echo "Fuzzing type: $fuzz_type"
-
-        for f in $(find . -name \*_fuzz.go); do
-          FUZZER_DIRECTORY=$(dirname $f)
-          echo "go-fuzz-build func ${fuzzers_funcs[$f]} residing in $f"
-          go-fuzz-build -func "${fuzzers_funcs[$f]}" -libfuzzer -o "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}.a" $FUZZER_DIRECTORY
-          echo "Generating fuzzer binary of func ${fuzzers_funcs[$f]} which resides in $f"
-          clang-7 -fsanitize=fuzzer "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}.a" -o "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}"
-          fuzzit create job caddyserver/${fuzzers_targets[$f]} $FUZZER_DIRECTORY/${fuzzers_targets[$f]} --api-key ${FUZZIT_API_KEY} --type "${fuzz_type}" --branch "${SYSTEM_PULLREQUEST_SOURCEBRANCH}" --revision "${BUILD_SOURCEVERSION}"
-          echo "Completed $f"
-        done

.gitignore

@@ -1,18 +1,12 @@
-_gitignore/
-*.log
-Caddyfile
-!caddyfile/
-
-# artifacts from pprof tooling
-*.prof
-*.test
-
-# build artifacts
-cmd/caddy/caddy
-cmd/caddy/caddy.exe
-
-# mac specific
 .DS_Store
+Thumbs.db
+_gitignore/
+Vagrantfile
+.vagrant/
+dist/
 
-# go modules
-vendor
+error.log
+access.log
+
+/*.conf
+Caddyfile

.golangci.yml

@@ -1,49 +0,0 @@
-linters-settings:
-  errcheck:
-    ignore: fmt:.*,io/ioutil:^Read.*,github.com/caddyserver/caddy/v2/caddyconfig:RegisterAdapter,github.com/caddyserver/caddy/v2:RegisterModule
-    ignoretests: true
-  misspell:
-    locale: US
-
-linters:
-  enable:
-    - bodyclose
-    - errcheck
-    - gofmt
-    - goimports
-    - gosec
-    - ineffassign
-    - misspell
-
-run:
-  # default concurrency is a available CPU number.
-  # concurrency: 4 # explicitly omit this value to fully utilize available resources.
-  deadline: 5m
-  issues-exit-code: 1
-  tests: false
-
-# output configuration options
-output:
-  format: 'colored-line-number'
-  print-issued-lines: true
-  print-linter-name: true
-
-issues:
-  exclude-rules:
-    # we aren't calling unknown URL
-    - text: "G107" # G107: Url provided to HTTP request as taint input
-      linters:
-        - gosec
-    # as a web server that's expected to handle any template, this is totally in the hands of the user.
-    - text: "G203" # G203: Use of unescaped data in HTML templates
-      linters:
-        - gosec
-    # we're shelling out to known commands, not relying on user-defined input.
-    - text: "G204" # G204: Audit use of command execution
-      linters:
-        - gosec
-    # the choice of weakrand is deliberate, hence the named import "weakrand"
-    - path: modules/caddyhttp/reverseproxy/selectionpolicies.go
-      text: "G404" # G404: Insecure random number source (rand)
-      linters:
-        - gosec

.travis.yml

@@ -0,0 +1,2 @@
+language: go
+script: go test ./...

AUTHORS

@@ -1,10 +0,0 @@
-# This is the official list of Caddy Authors for copyright purposes.
-# Authors may be either individual people or legal entities.
-#
-# Not all individual contributors are authors. For the full list of
-# contributors, refer to the project's page on GitHub or the repo's
-# commit history.
-
-Matthew Holt <Matthew.Holt@gmail.com>
-Light Code Labs <sales@lightcodelabs.com>
-Ardan Labs <info@ardanlabs.com>

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+## Contributing to Caddy
+
+**[Join us on Slack](https://gophers.slack.com/messages/caddy/)** to chat with other Caddy developers! ([Request an invite](http://bit.ly/go-slack-signup), then join the #caddy channel.)
+
+This project gladly accepts contributions and we encourage interested users to get involved!
+
+
+#### For small tweaks, bug fixes, and tests
+
+Submit [pull requests](https://github.com/mholt/caddy/pulls) at any time. Thank you for helping out in simple ways! Bug fixes should be under test to assert correct behavior.
+
+
+#### Ideas, questions, bug reports
+
+You should totally [open an issue](https://github.com/mholt/caddy/issues) with your ideas, questions, and bug reports, if one does not already exist for it. Bug reports should state expected behavior and contain clear instructions for reproducing the problem.
+
+
+#### New features
+
+Before submitting a pull request, please open an issue first to discuss it and claim it. This prevents overlapping efforts and keeps the project in-line with its goals. If you prefer to discuss the feature privately, you can reach other developers on Slack or you may email me directly. (My email address is below.)
+
+And don't forget to write tests for new features!
+
+
+#### Vulnerabilities
+
+If you've found a vulnerability that is serious, please email me: Matthew dot Holt at Gmail. If it's not a big deal, a pull request will probably be faster.
+
+
+## Thank you
+
+Thanks for your help! Caddy would not be what it is today without your contributions.

LICENSE.md

@@ -1,4 +1,3 @@
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -179,7 +178,7 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
@@ -187,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright {yyyy} {name of copyright owner}
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,131 +1,125 @@
-Caddy 2
-=======
+[![Caddy](https://caddyserver.com/resources/images/caddy-boxed.png)](https://caddyserver.com)
 
-This is the development branch for Caddy 2, the web server of the Go community.
+[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/mholt/caddy) [![Build Status](https://img.shields.io/travis/mholt/caddy.svg?style=flat-square)](https://travis-ci.org/mholt/caddy)
 
-**Caddy 2 is production-ready, but there may be breaking changes before the stable 2.0 release.** Please test it and deploy it as much as you are able, and submit your feedback!
+Caddy is a lightweight, general-purpose web server for Windows, Mac, Linux, BSD, and [Android](https://github.com/mholt/caddy/wiki/Running-Caddy-on-Android). It is a capable alternative to other popular web servers that is easy to use.
 
----
+The most notable features are HTTP/2, Virtual Hosts, TLS + SNI, and easy configuration with a [Caddyfile](https://caddyserver.com/docs/caddyfile). Usually, you have one Caddyfile per site. Most directives for the Caddyfile invoke a layer of middleware which can be [used in your own Go programs](https://github.com/mholt/caddy/wiki/Using-Caddy-Middleware-in-Your-Own-Programs).
+
+[Download](https://github.com/mholt/caddy/releases) · [User Guide](https://caddyserver.com/docs)
 
-<p align="center">
-	<a href="https://caddyserver.com"><img src="https://user-images.githubusercontent.com/1128849/36338535-05fb646a-136f-11e8-987b-e6901e717d5a.png" alt="Caddy" width="450"></a>
-</p>
-<h3 align="center">Every site on HTTPS</h3>
-<p align="center">Caddy is an extensible server platform that uses TLS by default.</p>
-<p align="center">
-	<a href="https://github.com/caddyserver/caddy/actions?query=workflow%3ACross-Platform"><img src="https://github.com/caddyserver/caddy/workflows/Cross-Platform/badge.svg?branch=v2"></a>
-	<a href="https://pkg.go.dev/github.com/caddyserver/caddy/v2"><img src="https://img.shields.io/badge/godoc-reference-blue.svg"></a>
-	<a href="https://app.fuzzit.dev/orgs/caddyserver-gh/dashboard"><img src="https://app.fuzzit.dev/badge?org_id=caddyserver-gh"></a>
-	<br>
-	<a href="https://twitter.com/caddyserver" title="@caddyserver on Twitter"><img src="https://img.shields.io/badge/twitter-@caddyserver-55acee.svg" alt="@caddyserver on Twitter"></a>
-	<a href="https://caddy.community" title="Caddy Forum"><img src="https://img.shields.io/badge/community-forum-ff69b4.svg" alt="Caddy Forum"></a>
-	<a href="https://sourcegraph.com/github.com/caddyserver/caddy?badge" title="Caddy on Sourcegraph"><img src="https://sourcegraph.com/github.com/caddyserver/caddy/-/badge.svg" alt="Caddy on Sourcegraph"></a>
-</p>
-<p align="center">
-	<a href="https://github.com/caddyserver/caddy/releases">Download</a> ·
-	<a href="https://caddyserver.com/docs/">Documentation</a> ·
-	<a href="https://caddy.community">Community</a>
-</p>
 
 
 
 ### Menu
 
-- [Build from source](#build-from-source)
-	- [For development](#for-development)
-	- [With version information and/or plugins](#with-version-information-andor-plugins)
-- [Getting started](#getting-started)
-- [Overview](#overview)
-- [Full documentation](#full-documentation)
-- [Getting help](#getting-help)
-- [About](#about)
+- [Getting Caddy](#getting-caddy)
+- [Running from Source](#running-from-source)
+- [Quick Start](#quick-start)
+- [Contributing](#contributing)
+- [About the Project](#about-the-project)
 
-<p align="center">
-	<b>Powered by</b>
-	<br>
-	<a href="https://github.com/caddyserver/certmagic"><img src="https://user-images.githubusercontent.com/1128849/49704830-49d37200-fbd5-11e8-8385-767e0cd033c3.png" alt="CertMagic" width="250"></a>
-</p>
 
-## Build from source
 
-Requirements:
 
-- [Go 1.14 or newer](https://golang.org/dl/)
-- Do NOT disable [Go modules](https://github.com/golang/go/wiki/Modules) (`export GO111MODULE=on`)
+## Getting Caddy
 
-### For development
+Caddy binaries have no dependencies and are available for nearly every platform.
 
-_**Note:** These steps [will not embed proper version information](https://github.com/golang/go/issues/29228). For that, please follow the instructions below._
- 
-```bash
-$ git clone -b v2 "https://github.com/caddyserver/caddy.git"
-$ cd caddy/cmd/caddy/
-$ go build
+[Latest release](https://github.com/mholt/caddy/releases/latest)
+
+
+## Running from Source
+
+Note: You will need **[Go 1.4](https://golang.org/dl)** or newer
+
+1. `$ go get github.com/mholt/caddy`
+2. `cd` into your website's directory
+3. Run `caddy` (assumes `$GOPATH/bin` is in your `$PATH`)
+
+If you're tinkering, you can also use `go run main.go`.
+
+By default, Caddy serves the current directory at [localhost:2015](http://localhost:2015). You can place a Caddyfile to configure Caddy for serving your site.
+
+Caddy accepts some flags from the command line. Run `caddy -h` to view the help for flags. You can also pipe a Caddyfile into the caddy command.
+
+
+
+#### Docker Container
+
+Caddy is [available as a Docker container](https://registry.hub.docker.com/u/darron/caddy/).
+
+
+
+#### 3rd-party libraries
+
+Although Caddy's binaries are completely static, Caddy relies on some excellent libraries. [Godoc.org](https://godoc.org/github.com/mholt/caddy) shows the packages that each Caddy package imports.
+
+
+
+
+## Quick Start
+
+The website has [full documentation](https://caddyserver.com/docs) but this will get you started in about 30 seconds:
+
+Place a file named "Caddyfile" with your site. Paste this into it and save:
+
+```
+localhost
+
+gzip
+browse
+ext .html
+websocket /echo cat
+log ../access.log
+header /api Access-Control-Allow-Origin *
 ```
 
-### With version information and/or plugins
+Run `caddy` from that directory, and it will automatically use that Caddyfile to configure itself.
 
-1. Create a new folder: `mkdir caddy`
-2. Change into it: `cd caddy`
-3. Copy [Caddy's main.go](https://github.com/caddyserver/caddy/blob/v2/cmd/caddy/main.go) into the empty folder. Add imports for any custom plugins you want to add.
-4. Initialize a Go module: `go mod init caddy`
-5. Pin Caddy version: `go get github.com/caddyserver/caddy/v2@TAG` replacing `TAG` with a git tag or commit.
-6. Compile: `go build`
+That simple file enables compression, allows directory browsing (for folders without an index file), serves clean URLs, hosts an echo server for WebSocket connections at /echo, logs accesses to access.log, and adds the coveted `Access-Control-Allow-Origin: *` header for all responses from some API.
+
+Wow! Caddy can do a lot with just a few lines.
+
+#### Defining multiple sites
+
+You can run multiple sites from the same Caddyfile, too:
+
+```
+http://mysite.com,
+http://www.mysite.com {
+	redir https://mysite.com
+}
+
+https://mysite.com {
+	tls mysite.crt mysite.key
+	# ...
+}
+```
+
+Note that the secure host will automatically be served with HTTP/2 if the client supports it.
+
+For more documentation, please view [the website](https://caddyserver.com/docs). You may also be interested in the [developer guide](https://github.com/mholt/caddy/wiki) on this project's GitHub wiki.
 
 
 
 
-## Quick start
 
-The [Caddy website](https://caddyserver.com/docs/) has documentation that includes tutorials, quick-start guides, reference, and more.
 
-**We recommend that all users do our [Getting Started](https://caddyserver.com/docs/getting-started) guide to become familiar with using Caddy.**
+## Contributing
 
-If you've only got a minute, [the website has several quick-start tutorials](https://caddyserver.com/docs/quick-starts) to choose from! However, after finishing a quick-start tutorial, please read more documentation to understand how the software works. 🙂
+**[Join us on Slack](https://gophers.slack.com/messages/caddy/)** to chat with other Caddy developers! ([Request an invite](http://bit.ly/go-slack-signup), then join the #caddy channel.)
+
+This project would not be what it is without your help. Please see the [contributing guidelines](https://github.com/mholt/caddy/blob/master/CONTRIBUTING.md) if you haven't already.
+
+Thanks for making Caddy -- and the Web -- better!
 
 
 
 
-## Overview
+## About the project
 
-Caddy is most often used as an HTTPS server, but it is suitable for any long-running Go program. First and foremost, it is a platform to run Go applications. Caddy "apps" are just Go programs that are implemented as Caddy modules. Two apps -- `tls` and `http` -- ship standard with Caddy.
-
-Caddy apps instantly benefit from [automated documentation](https://caddyserver.com/docs/json/), graceful on-line [config changes via API](https://caddyserver.com/docs/api), and unification with other Caddy apps.
-
-Although [JSON](https://caddyserver.com/docs/json/) is Caddy's native config language, Caddy can accept input from [config adapters](https://caddyserver.com/docs/config-adapters) which can essentially convert any config format of your choice into JSON: Caddyfile, JSON 5, YAML, TOML, NGINX config, and more.
-
-The primary way to configure Caddy is through [its API](https://caddyserver.com/docs/api), but if you prefer config files, the [command-line interface](https://caddyserver.com/docs/command-line) supports those too.
-
-Caddy exposes an unprecedented level of control compared to any web server in existence. In Caddy, you are usually setting the actual values of the initialized types in memory that power everything from your HTTP handlers and TLS handshakes to your storage medium. Caddy is also ridiculously extensible, with a powerful plugin system that makes vast improvements over other web servers.
-
-To wield the power of this design, you need to know how the config document is structured. Please see the [our documentation site](https://caddyserver.com/docs/) for details about [Caddy's config structure](https://caddyserver.com/docs/json/).
-
-Nearly all of Caddy's configuration is contained in a single config document, rather than being scattered across CLI flags and env variables and a configuration file as with other web servers. This makes managing your server config more straightforward and reduces hidden variables/factors.
+Caddy was born out of the need for a "batteries-included" web server that runs anywhere and doesn't have to take its configuration with it. Caddy took inspiration from [spark](https://github.com/rif/spark), nginx, lighttpd, Websocketd, and Vagrant, and provides a pleasant mixture of features from each of them.
 
 
-## Full documentation
-
-Our website has complete documentation:
-
-**https://caddyserver.com/docs/**
-
-The docs are also open source. You can contribute to them here: https://github.com/caddyserver/website
-
-
-
-## Getting help
-
-- We **strongly recommend** that all professionals or companies using Caddy get a support contract through [Ardan Labs](https://www.ardanlabs.com/my/contact-us?dd=caddy) before help is needed.
-
-- Individuals can exchange help for free on our community forum at https://caddy.community. Remember that people give help out of their spare time and good will. The best way to get help is to give it first!
-
-Please use our [issue tracker](/caddyserver/caddy/issues) only for bug reports and feature requests, i.e. actionable development items (support questions will usually be referred to the forums).
-
-
-
-## About
-
-**The name "Caddy" is trademarked.** The name of the software is "Caddy", not "Caddy Server" or "CaddyServer". Please call it "Caddy" or, if you wish to clarify, "the Caddy web server". Caddy is a registered trademark of Light Code Labs, LLC.
-
-- _Project on Twitter: [@caddyserver](https://twitter.com/caddyserver)_
-- _Author on Twitter: [@mholt6](https://twitter.com/mholt6)_
+*Twitter: [@mholt6](https://twitter.com/mholt6)*

admin.go

@@ -1,792 +0,0 @@
-// 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 caddy
-
-import (
-	"bytes"
-	"context"
-	"encoding/json"
-	"expvar"
-	"fmt"
-	"io"
-	"net/http"
-	"net/http/pprof"
-	"net/url"
-	"os"
-	"path"
-	"regexp"
-	"strconv"
-	"strings"
-	"sync"
-	"time"
-
-	"go.uber.org/zap"
-)
-
-// TODO: is there a way to make the admin endpoint so that it can be plugged into the HTTP app? see issue #2833
-
-// AdminConfig configures Caddy's API endpoint, which is used
-// to manage Caddy while it is running.
-type AdminConfig struct {
-	// If true, the admin endpoint will be completely disabled.
-	// Note that this makes any runtime changes to the config
-	// impossible, since the interface to do so is through the
-	// admin endpoint.
-	Disabled bool `json:"disabled,omitempty"`
-
-	// The address to which the admin endpoint's listener should
-	// bind itself. Can be any single network address that can be
-	// parsed by Caddy. Default: localhost:2019
-	Listen string `json:"listen,omitempty"`
-
-	// If true, CORS headers will be emitted, and requests to the
-	// API will be rejected if their `Host` and `Origin` headers
-	// do not match the expected value(s). Use `origins` to
-	// customize which origins/hosts are allowed.If `origins` is
-	// not set, the listen address is the only value allowed by
-	// default.
-	EnforceOrigin bool `json:"enforce_origin,omitempty"`
-
-	// The list of allowed origins for API requests. Only used if
-	// `enforce_origin` is true. If not set, the listener address
-	// will be the default value. If set but empty, no origins will
-	// be allowed.
-	Origins []string `json:"origins,omitempty"`
-
-	// Options related to configuration management.
-	Config *ConfigSettings `json:"config,omitempty"`
-}
-
-// ConfigSettings configures the, uh, configuration... and
-// management thereof.
-type ConfigSettings struct {
-	// Whether to keep a copy of the active config on disk. Default is true.
-	Persist *bool `json:"persist,omitempty"`
-}
-
-// listenAddr extracts a singular listen address from ac.Listen,
-// returning the network and the address of the listener.
-func (admin AdminConfig) listenAddr() (string, string, error) {
-	input := admin.Listen
-	if input == "" {
-		input = DefaultAdminListen
-	}
-	listenAddr, err := ParseNetworkAddress(input)
-	if err != nil {
-		return "", "", fmt.Errorf("parsing admin listener address: %v", err)
-	}
-	if listenAddr.PortRangeSize() != 1 {
-		return "", "", fmt.Errorf("admin endpoint must have exactly one address; cannot listen on %v", listenAddr)
-	}
-	return listenAddr.Network, listenAddr.JoinHostPort(0), nil
-}
-
-// newAdminHandler reads admin's config and returns an http.Handler suitable
-// for use in an admin endpoint server, which will be listening on listenAddr.
-func (admin AdminConfig) newAdminHandler(listenAddr string) adminHandler {
-	muxWrap := adminHandler{
-		enforceOrigin:  admin.EnforceOrigin,
-		allowedOrigins: admin.allowedOrigins(listenAddr),
-		mux:            http.NewServeMux(),
-	}
-
-	// addRoute just calls muxWrap.mux.Handle after
-	// wrapping the handler with error handling
-	addRoute := func(pattern string, h AdminHandler) {
-		wrapper := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
-			err := h.ServeHTTP(w, r)
-			muxWrap.handleError(w, r, err)
-		})
-		muxWrap.mux.Handle(pattern, wrapper)
-	}
-
-	// register standard config control endpoints
-	addRoute("/"+rawConfigKey+"/", AdminHandlerFunc(handleConfig))
-	addRoute("/id/", AdminHandlerFunc(handleConfigID))
-	addRoute("/stop", AdminHandlerFunc(handleStop))
-
-	// register debugging endpoints
-	muxWrap.mux.HandleFunc("/debug/pprof/", pprof.Index)
-	muxWrap.mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
-	muxWrap.mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
-	muxWrap.mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
-	muxWrap.mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
-	muxWrap.mux.Handle("/debug/vars", expvar.Handler())
-
-	// register third-party module endpoints
-	for _, m := range GetModules("admin.api") {
-		router := m.New().(AdminRouter)
-		for _, route := range router.Routes() {
-			addRoute(route.Pattern, route.Handler)
-		}
-	}
-
-	return muxWrap
-}
-
-// allowedOrigins returns a list of origins that are allowed.
-// If admin.Origins is nil (null), the provided listen address
-// will be used as the default origin. If admin.Origins is
-// empty, no origins will be allowed, effectively bricking the
-// endpoint, but whatever.
-func (admin AdminConfig) allowedOrigins(listen string) []string {
-	uniqueOrigins := make(map[string]struct{})
-	for _, o := range admin.Origins {
-		uniqueOrigins[o] = struct{}{}
-	}
-	if admin.Origins == nil {
-		uniqueOrigins[listen] = struct{}{}
-	}
-	var allowed []string
-	for origin := range uniqueOrigins {
-		allowed = append(allowed, origin)
-	}
-	return allowed
-}
-
-// replaceAdmin replaces the running admin server according
-// to the relevant configuration in cfg. If no configuration
-// for the admin endpoint exists in cfg, a default one is
-// used, so that there is always an admin server (unless it
-// is explicitly configured to be disabled).
-func replaceAdmin(cfg *Config) error {
-	// always be sure to close down the old admin endpoint
-	// as gracefully as possible, even if the new one is
-	// disabled -- careful to use reference to the current
-	// (old) admin endpoint since it will be different
-	// when the function returns
-	oldAdminServer := adminServer
-	defer func() {
-		// do the shutdown asynchronously so that any
-		// current API request gets a response; this
-		// goroutine may last a few seconds
-		if oldAdminServer != nil {
-			go func(oldAdminServer *http.Server) {
-				err := stopAdminServer(oldAdminServer)
-				if err != nil {
-					Log().Named("admin").Error("stopping current admin endpoint", zap.Error(err))
-				}
-			}(oldAdminServer)
-		}
-	}()
-
-	// always get a valid admin config
-	adminConfig := DefaultAdminConfig
-	if cfg != nil && cfg.Admin != nil {
-		adminConfig = cfg.Admin
-	}
-
-	// if new admin endpoint is to be disabled, we're done
-	if adminConfig.Disabled {
-		Log().Named("admin").Warn("admin endpoint disabled")
-		return nil
-	}
-
-	// extract a singular listener address
-	netw, addr, err := adminConfig.listenAddr()
-	if err != nil {
-		return err
-	}
-
-	handler := adminConfig.newAdminHandler(addr)
-
-	ln, err := Listen(netw, addr)
-	if err != nil {
-		return err
-	}
-
-	adminServer = &http.Server{
-		Handler:           handler,
-		ReadTimeout:       10 * time.Second,
-		ReadHeaderTimeout: 5 * time.Second,
-		IdleTimeout:       60 * time.Second,
-		MaxHeaderBytes:    1024 * 64,
-	}
-
-	go adminServer.Serve(ln)
-
-	Log().Named("admin").Info(
-		"admin endpoint started",
-		zap.String("address", addr),
-		zap.Bool("enforce_origin", adminConfig.EnforceOrigin),
-		zap.Strings("origins", handler.allowedOrigins),
-	)
-
-	return nil
-}
-
-func stopAdminServer(srv *http.Server) error {
-	if srv == nil {
-		return fmt.Errorf("no admin server")
-	}
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
-	defer cancel()
-	err := srv.Shutdown(ctx)
-	if err != nil {
-		return fmt.Errorf("shutting down admin server: %v", err)
-	}
-	Log().Named("admin").Info("stopped previous server")
-	return nil
-}
-
-// AdminRouter is a type which can return routes for the admin API.
-type AdminRouter interface {
-	Routes() []AdminRoute
-}
-
-// AdminRoute represents a route for the admin endpoint.
-type AdminRoute struct {
-	Pattern string
-	Handler AdminHandler
-}
-
-type adminHandler struct {
-	enforceOrigin  bool
-	allowedOrigins []string
-	mux            *http.ServeMux
-}
-
-// ServeHTTP is the external entry point for API requests.
-// It will only be called once per request.
-func (h adminHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
-	Log().Named("admin.api").Info("received request",
-		zap.String("method", r.Method),
-		zap.String("uri", r.RequestURI),
-		zap.String("remote_addr", r.RemoteAddr),
-		zap.Reflect("headers", r.Header),
-	)
-	h.serveHTTP(w, r)
-}
-
-// serveHTTP is the internal entry point for API requests. It may
-// be called more than once per request, for example if a request
-// is rewritten (i.e. internal redirect).
-func (h adminHandler) serveHTTP(w http.ResponseWriter, r *http.Request) {
-	if h.enforceOrigin {
-		// DNS rebinding mitigation
-		err := h.checkHost(r)
-		if err != nil {
-			h.handleError(w, r, err)
-			return
-		}
-
-		// cross-site mitigation
-		origin, err := h.checkOrigin(r)
-		if err != nil {
-			h.handleError(w, r, err)
-			return
-		}
-
-		if r.Method == http.MethodOptions {
-			w.Header().Set("Access-Control-Allow-Methods", "OPTIONS, GET, POST, PUT, PATCH, DELETE")
-			w.Header().Set("Access-Control-Allow-Headers", "Content-Type, Content-Length, Cache-Control")
-			w.Header().Set("Access-Control-Allow-Credentials", "true")
-		}
-		w.Header().Set("Access-Control-Allow-Origin", origin)
-	}
-
-	// TODO: authentication & authorization, if configured
-
-	h.mux.ServeHTTP(w, r)
-}
-
-func (h adminHandler) handleError(w http.ResponseWriter, r *http.Request, err error) {
-	if err == nil {
-		return
-	}
-	if err == ErrInternalRedir {
-		h.serveHTTP(w, r)
-		return
-	}
-
-	apiErr, ok := err.(APIError)
-	if !ok {
-		apiErr = APIError{
-			Code: http.StatusInternalServerError,
-			Err:  err,
-		}
-	}
-	if apiErr.Code == 0 {
-		apiErr.Code = http.StatusInternalServerError
-	}
-	if apiErr.Message == "" && apiErr.Err != nil {
-		apiErr.Message = apiErr.Err.Error()
-	}
-
-	Log().Named("admin.api").Error("request error",
-		zap.Error(err),
-		zap.Int("status_code", apiErr.Code),
-	)
-
-	w.Header().Set("Content-Type", "application/json")
-	w.WriteHeader(apiErr.Code)
-	json.NewEncoder(w).Encode(apiErr)
-}
-
-// checkHost returns a handler that wraps next such that
-// it will only be called if the request's Host header matches
-// a trustworthy/expected value. This helps to mitigate DNS
-// rebinding attacks.
-func (h adminHandler) checkHost(r *http.Request) error {
-	var allowed bool
-	for _, allowedHost := range h.allowedOrigins {
-		if r.Host == allowedHost {
-			allowed = true
-			break
-		}
-	}
-	if !allowed {
-		return APIError{
-			Code: http.StatusForbidden,
-			Err:  fmt.Errorf("host not allowed: %s", r.Host),
-		}
-	}
-	return nil
-}
-
-// checkOrigin ensures that the Origin header, if
-// set, matches the intended target; prevents arbitrary
-// sites from issuing requests to our listener. It
-// returns the origin that was obtained from r.
-func (h adminHandler) checkOrigin(r *http.Request) (string, error) {
-	origin := h.getOriginHost(r)
-	if origin == "" {
-		return origin, APIError{
-			Code: http.StatusForbidden,
-			Err:  fmt.Errorf("missing required Origin header"),
-		}
-	}
-	if !h.originAllowed(origin) {
-		return origin, APIError{
-			Code: http.StatusForbidden,
-			Err:  fmt.Errorf("client is not allowed to access from origin %s", origin),
-		}
-	}
-	return origin, nil
-}
-
-func (h adminHandler) getOriginHost(r *http.Request) string {
-	origin := r.Header.Get("Origin")
-	if origin == "" {
-		origin = r.Header.Get("Referer")
-	}
-	originURL, err := url.Parse(origin)
-	if err == nil && originURL.Host != "" {
-		origin = originURL.Host
-	}
-	return origin
-}
-
-func (h adminHandler) originAllowed(origin string) bool {
-	for _, allowedOrigin := range h.allowedOrigins {
-		originCopy := origin
-		if !strings.Contains(allowedOrigin, "://") {
-			// no scheme specified, so allow both
-			originCopy = strings.TrimPrefix(originCopy, "http://")
-			originCopy = strings.TrimPrefix(originCopy, "https://")
-		}
-		if originCopy == allowedOrigin {
-			return true
-		}
-	}
-	return false
-}
-
-func handleConfig(w http.ResponseWriter, r *http.Request) error {
-	switch r.Method {
-	case http.MethodGet:
-		w.Header().Set("Content-Type", "application/json")
-
-		err := readConfig(r.URL.Path, w)
-		if err != nil {
-			return APIError{Code: http.StatusBadRequest, Err: err}
-		}
-
-		return nil
-
-	case http.MethodPost,
-		http.MethodPut,
-		http.MethodPatch,
-		http.MethodDelete:
-
-		// DELETE does not use a body, but the others do
-		var body []byte
-		if r.Method != http.MethodDelete {
-			if ct := r.Header.Get("Content-Type"); !strings.Contains(ct, "/json") {
-				return APIError{
-					Code: http.StatusBadRequest,
-					Err:  fmt.Errorf("unacceptable content-type: %v; 'application/json' required", ct),
-				}
-			}
-
-			buf := bufPool.Get().(*bytes.Buffer)
-			buf.Reset()
-			defer bufPool.Put(buf)
-
-			_, err := io.Copy(buf, r.Body)
-			if err != nil {
-				return APIError{
-					Code: http.StatusBadRequest,
-					Err:  fmt.Errorf("reading request body: %v", err),
-				}
-			}
-			body = buf.Bytes()
-		}
-
-		forceReload := r.Header.Get("Cache-Control") == "must-revalidate"
-
-		err := changeConfig(r.Method, r.URL.Path, body, forceReload)
-		if err != nil {
-			return err
-		}
-
-	default:
-		return APIError{
-			Code: http.StatusMethodNotAllowed,
-			Err:  fmt.Errorf("method %s not allowed", r.Method),
-		}
-	}
-
-	return nil
-}
-
-func handleConfigID(w http.ResponseWriter, r *http.Request) error {
-	idPath := r.URL.Path
-
-	parts := strings.Split(idPath, "/")
-	if len(parts) < 3 || parts[2] == "" {
-		return fmt.Errorf("request path is missing object ID")
-	}
-	if parts[0] != "" || parts[1] != "id" {
-		return fmt.Errorf("malformed object path")
-	}
-	id := parts[2]
-
-	// map the ID to the expanded path
-	currentCfgMu.RLock()
-	expanded, ok := rawCfgIndex[id]
-	defer currentCfgMu.RUnlock()
-	if !ok {
-		return fmt.Errorf("unknown object ID '%s'", id)
-	}
-
-	// piece the full URL path back together
-	parts = append([]string{expanded}, parts[3:]...)
-	r.URL.Path = path.Join(parts...)
-
-	return ErrInternalRedir
-}
-
-func handleStop(w http.ResponseWriter, r *http.Request) error {
-	err := handleUnload(w, r)
-	if err != nil {
-		Log().Named("admin.api").Error("unload error", zap.Error(err))
-	}
-	go func() {
-		err := stopAdminServer(adminServer)
-		var exitCode int
-		if err != nil {
-			exitCode = ExitCodeFailedQuit
-			Log().Named("admin.api").Error("failed to stop admin server gracefully", zap.Error(err))
-		}
-		Log().Named("admin.api").Info("stopping now, bye!! 👋")
-		os.Exit(exitCode)
-	}()
-	return nil
-}
-
-// handleUnload stops the current configuration that is running.
-// Note that doing this can also be accomplished with DELETE /config/
-// but we leave this function because handleStop uses it.
-func handleUnload(w http.ResponseWriter, r *http.Request) error {
-	if r.Method != http.MethodPost {
-		return APIError{
-			Code: http.StatusMethodNotAllowed,
-			Err:  fmt.Errorf("method not allowed"),
-		}
-	}
-	currentCfgMu.RLock()
-	hasCfg := currentCfg != nil
-	currentCfgMu.RUnlock()
-	if !hasCfg {
-		Log().Named("admin.api").Info("nothing to unload")
-		return nil
-	}
-	Log().Named("admin.api").Info("unloading")
-	if err := stopAndCleanup(); err != nil {
-		Log().Named("admin.api").Error("error unloading", zap.Error(err))
-	} else {
-		Log().Named("admin.api").Info("unloading completed")
-	}
-	return nil
-}
-
-// unsyncedConfigAccess traverses into the current config and performs
-// the operation at path according to method, using body and out as
-// needed. This is a low-level, unsynchronized function; most callers
-// will want to use changeConfig or readConfig instead. This requires a
-// read or write lock on currentCfgMu, depending on method (GET needs
-// only a read lock; all others need a write lock).
-func unsyncedConfigAccess(method, path string, body []byte, out io.Writer) error {
-	var err error
-	var val interface{}
-
-	// if there is a request body, decode it into the
-	// variable that will be set in the config according
-	// to method and path
-	if len(body) > 0 {
-		err = json.Unmarshal(body, &val)
-		if err != nil {
-			return fmt.Errorf("decoding request body: %v", err)
-		}
-	}
-
-	enc := json.NewEncoder(out)
-
-	cleanPath := strings.Trim(path, "/")
-	if cleanPath == "" {
-		return fmt.Errorf("no traversable path")
-	}
-
-	parts := strings.Split(cleanPath, "/")
-	if len(parts) == 0 {
-		return fmt.Errorf("path missing")
-	}
-
-	// A path that ends with "..." implies:
-	// 1) the part before it is an array
-	// 2) the payload is an array
-	// and means that the user wants to expand the elements
-	// in the payload array and append each one into the
-	// destination array, like so:
-	//     array = append(array, elems...)
-	// This special case is handled below.
-	ellipses := parts[len(parts)-1] == "..."
-	if ellipses {
-		parts = parts[:len(parts)-1]
-	}
-
-	var ptr interface{} = rawCfg
-
-traverseLoop:
-	for i, part := range parts {
-		switch v := ptr.(type) {
-		case map[string]interface{}:
-			// if the next part enters a slice, and the slice is our destination,
-			// handle it specially (because appending to the slice copies the slice
-			// header, which does not replace the original one like we want)
-			if arr, ok := v[part].([]interface{}); ok && i == len(parts)-2 {
-				var idx int
-				if method != http.MethodPost {
-					idxStr := parts[len(parts)-1]
-					idx, err = strconv.Atoi(idxStr)
-					if err != nil {
-						return fmt.Errorf("[%s] invalid array index '%s': %v",
-							path, idxStr, err)
-					}
-					if idx < 0 || idx >= len(arr) {
-						return fmt.Errorf("[%s] array index out of bounds: %s", path, idxStr)
-					}
-				}
-
-				switch method {
-				case http.MethodGet:
-					err = enc.Encode(arr[idx])
-					if err != nil {
-						return fmt.Errorf("encoding config: %v", err)
-					}
-				case http.MethodPost:
-					if ellipses {
-						valArray, ok := val.([]interface{})
-						if !ok {
-							return fmt.Errorf("final element is not an array")
-						}
-						v[part] = append(arr, valArray...)
-					} else {
-						v[part] = append(arr, val)
-					}
-				case http.MethodPut:
-					// avoid creation of new slice and a second copy (see
-					// https://github.com/golang/go/wiki/SliceTricks#insert)
-					arr = append(arr, nil)
-					copy(arr[idx+1:], arr[idx:])
-					arr[idx] = val
-					v[part] = arr
-				case http.MethodPatch:
-					arr[idx] = val
-				case http.MethodDelete:
-					v[part] = append(arr[:idx], arr[idx+1:]...)
-				default:
-					return fmt.Errorf("unrecognized method %s", method)
-				}
-				break traverseLoop
-			}
-
-			if i == len(parts)-1 {
-				switch method {
-				case http.MethodGet:
-					err = enc.Encode(v[part])
-					if err != nil {
-						return fmt.Errorf("encoding config: %v", err)
-					}
-				case http.MethodPost:
-					// if the part is an existing list, POST appends to
-					// it, otherwise it just sets or creates the value
-					if arr, ok := v[part].([]interface{}); ok {
-						if ellipses {
-							valArray, ok := val.([]interface{})
-							if !ok {
-								return fmt.Errorf("final element is not an array")
-							}
-							v[part] = append(arr, valArray...)
-						} else {
-							v[part] = append(arr, val)
-						}
-					} else {
-						v[part] = val
-					}
-				case http.MethodPut:
-					if _, ok := v[part]; ok {
-						return fmt.Errorf("[%s] key already exists: %s", path, part)
-					}
-					v[part] = val
-				case http.MethodPatch:
-					if _, ok := v[part]; !ok {
-						return fmt.Errorf("[%s] key does not exist: %s", path, part)
-					}
-					v[part] = val
-				case http.MethodDelete:
-					delete(v, part)
-				default:
-					return fmt.Errorf("unrecognized method %s", method)
-				}
-			} else {
-				// if we are "PUTting" a new resource, the key(s) in its path
-				// might not exist yet; that's OK but we need to make them as
-				// we go, while we still have a pointer from the level above
-				if v[part] == nil && method == http.MethodPut {
-					v[part] = make(map[string]interface{})
-				}
-				ptr = v[part]
-			}
-
-		case []interface{}:
-			partInt, err := strconv.Atoi(part)
-			if err != nil {
-				return fmt.Errorf("[/%s] invalid array index '%s': %v",
-					strings.Join(parts[:i+1], "/"), part, err)
-			}
-			if partInt < 0 || partInt >= len(v) {
-				return fmt.Errorf("[/%s] array index out of bounds: %s",
-					strings.Join(parts[:i+1], "/"), part)
-			}
-			ptr = v[partInt]
-
-		default:
-			return fmt.Errorf("invalid traversal path at: %s", strings.Join(parts[:i+1], "/"))
-		}
-	}
-
-	return nil
-}
-
-// RemoveMetaFields removes meta fields like "@id" from a JSON message
-// by using a simple regular expression. (An alternate way to do this
-// would be to delete them from the raw, map[string]interface{}
-// representation as they are indexed, then iterate the index we made
-// and add them back after encoding as JSON, but this is simpler.)
-func RemoveMetaFields(rawJSON []byte) []byte {
-	return idRegexp.ReplaceAllFunc(rawJSON, func(in []byte) []byte {
-		// matches with a comma on both sides (when "@id" property is
-		// not the first or last in the object) need to keep exactly
-		// one comma for correct JSON syntax
-		comma := []byte{','}
-		if bytes.HasPrefix(in, comma) && bytes.HasSuffix(in, comma) {
-			return comma
-		}
-		return []byte{}
-	})
-}
-
-// AdminHandler is like http.Handler except ServeHTTP may return an error.
-//
-// If any handler encounters an error, it should be returned for proper
-// handling.
-type AdminHandler interface {
-	ServeHTTP(http.ResponseWriter, *http.Request) error
-}
-
-// AdminHandlerFunc is a convenience type like http.HandlerFunc.
-type AdminHandlerFunc func(http.ResponseWriter, *http.Request) error
-
-// ServeHTTP implements the Handler interface.
-func (f AdminHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request) error {
-	return f(w, r)
-}
-
-// APIError is a structured error that every API
-// handler should return for consistency in logging
-// and client responses. If Message is unset, then
-// Err.Error() will be serialized in its place.
-type APIError struct {
-	Code    int    `json:"-"`
-	Err     error  `json:"-"`
-	Message string `json:"error"`
-}
-
-func (e APIError) Error() string {
-	if e.Err != nil {
-		return e.Err.Error()
-	}
-	return e.Message
-}
-
-var (
-	// DefaultAdminListen is the address for the admin
-	// listener, if none is specified at startup.
-	DefaultAdminListen = "localhost:2019"
-
-	// ErrInternalRedir indicates an internal redirect
-	// and is useful when admin API handlers rewrite
-	// the request; in that case, authentication and
-	// authorization needs to happen again for the
-	// rewritten request.
-	ErrInternalRedir = fmt.Errorf("internal redirect; re-authorization required")
-
-	// DefaultAdminConfig is the default configuration
-	// for the administration endpoint.
-	DefaultAdminConfig = &AdminConfig{
-		Listen: DefaultAdminListen,
-	}
-)
-
-// idRegexp is used to match ID fields and their associated values
-// in the config. It also matches adjacent commas so that syntax
-// can be preserved no matter where in the object the field appears.
-// It supports string and most numeric values.
-var idRegexp = regexp.MustCompile(`(?m),?\s*"` + idKey + `":\s?(-?[0-9]+(\.[0-9]+)?|(?U)".*")\s*,?`)
-
-const (
-	rawConfigKey = "config"
-	idKey        = "@id"
-)
-
-var bufPool = sync.Pool{
-	New: func() interface{} {
-		return new(bytes.Buffer)
-	},
-}
-
-var adminServer *http.Server

admin_test.go

@@ -1,132 +0,0 @@
-// 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 caddy
-
-import (
-	"encoding/json"
-	"reflect"
-	"testing"
-)
-
-func TestUnsyncedConfigAccess(t *testing.T) {
-	// each test is performed in sequence, so
-	// each change builds on the previous ones;
-	// the config is not reset between tests
-	for i, tc := range []struct {
-		method    string
-		path      string // rawConfigKey will be prepended
-		payload   string
-		expect    string // JSON representation of what the whole config is expected to be after the request
-		shouldErr bool
-	}{
-		{
-			method:  "POST",
-			path:    "",
-			payload: `{"foo": "bar", "list": ["a", "b", "c"]}`, // starting value
-			expect:  `{"foo": "bar", "list": ["a", "b", "c"]}`,
-		},
-		{
-			method:  "POST",
-			path:    "/foo",
-			payload: `"jet"`,
-			expect:  `{"foo": "jet", "list": ["a", "b", "c"]}`,
-		},
-		{
-			method:  "POST",
-			path:    "/bar",
-			payload: `{"aa": "bb", "qq": "zz"}`,
-			expect:  `{"foo": "jet", "bar": {"aa": "bb", "qq": "zz"}, "list": ["a", "b", "c"]}`,
-		},
-		{
-			method: "DELETE",
-			path:   "/bar/qq",
-			expect: `{"foo": "jet", "bar": {"aa": "bb"}, "list": ["a", "b", "c"]}`,
-		},
-		{
-			method:  "POST",
-			path:    "/list",
-			payload: `"e"`,
-			expect:  `{"foo": "jet", "bar": {"aa": "bb"}, "list": ["a", "b", "c", "e"]}`,
-		},
-		{
-			method:  "PUT",
-			path:    "/list/3",
-			payload: `"d"`,
-			expect:  `{"foo": "jet", "bar": {"aa": "bb"}, "list": ["a", "b", "c", "d", "e"]}`,
-		},
-		{
-			method: "DELETE",
-			path:   "/list/3",
-			expect: `{"foo": "jet", "bar": {"aa": "bb"}, "list": ["a", "b", "c", "e"]}`,
-		},
-		{
-			method:  "PATCH",
-			path:    "/list/3",
-			payload: `"d"`,
-			expect:  `{"foo": "jet", "bar": {"aa": "bb"}, "list": ["a", "b", "c", "d"]}`,
-		},
-		{
-			method:  "POST",
-			path:    "/list/...",
-			payload: `["e", "f", "g"]`,
-			expect:  `{"foo": "jet", "bar": {"aa": "bb"}, "list": ["a", "b", "c", "d", "e", "f", "g"]}`,
-		},
-	} {
-		err := unsyncedConfigAccess(tc.method, rawConfigKey+tc.path, []byte(tc.payload), nil)
-
-		if tc.shouldErr && err == nil {
-			t.Fatalf("Test %d: Expected error return value, but got: %v", i, err)
-		}
-		if !tc.shouldErr && err != nil {
-			t.Fatalf("Test %d: Should not have had error return value, but got: %v", i, err)
-		}
-
-		// decode the expected config so we can do a convenient DeepEqual
-		var expectedDecoded interface{}
-		err = json.Unmarshal([]byte(tc.expect), &expectedDecoded)
-		if err != nil {
-			t.Fatalf("Test %d: Unmarshaling expected config: %v", i, err)
-		}
-
-		// make sure the resulting config is as we expect it
-		if !reflect.DeepEqual(rawCfg[rawConfigKey], expectedDecoded) {
-			t.Fatalf("Test %d:\nExpected:\n\t%#v\nActual:\n\t%#v",
-				i, expectedDecoded, rawCfg[rawConfigKey])
-		}
-	}
-}
-
-func BenchmarkLoad(b *testing.B) {
-	for i := 0; i < b.N; i++ {
-		cfg := []byte(`{
-			"apps": {
-				"http": {
-					"servers": {
-						"myserver": {
-							"listen": ["tcp/localhost:8080-8084"],
-							"read_timeout": "30s"
-						},
-						"yourserver": {
-							"listen": ["127.0.0.1:5000"],
-							"read_header_timeout": "15s"
-						}
-					}
-				}
-			}
-		}
-		`)
-		Load(cfg, true)
-	}
-}

app/app.go

@@ -0,0 +1,76 @@
+// Package app holds application-global state to make it accessible
+// by other packages in the application.
+//
+// This package differs from config in that the things in app aren't
+// really related to server configuration.
+package app
+
+import (
+	"errors"
+	"runtime"
+	"strconv"
+	"strings"
+	"sync"
+
+	"github.com/mholt/caddy/server"
+)
+
+const (
+	// Name is the program name
+	Name = "Caddy"
+
+	// Version is the program version
+	Version = "0.7.0"
+)
+
+var (
+	// Servers is a list of all the currently-listening servers
+	Servers []*server.Server
+
+	// ServersMutex protects the Servers slice during changes
+	ServersMutex sync.Mutex
+
+	// Wg is used to wait for all servers to shut down
+	Wg sync.WaitGroup
+
+	// Http2 indicates whether HTTP2 is enabled or not
+	Http2 bool // TODO: temporary flag until http2 is standard
+
+	// Quiet mode hides non-error initialization output
+	Quiet bool
+)
+
+// SetCPU parses string cpu and sets GOMAXPROCS
+// according to its value. It accepts either
+// a number (e.g. 3) or a percent (e.g. 50%).
+func SetCPU(cpu string) error {
+	var numCPU int
+
+	availCPU := runtime.NumCPU()
+
+	if strings.HasSuffix(cpu, "%") {
+		// Percent
+		var percent float32
+		pctStr := cpu[:len(cpu)-1]
+		pctInt, err := strconv.Atoi(pctStr)
+		if err != nil || pctInt < 1 || pctInt > 100 {
+			return errors.New("Invalid CPU value: percentage must be between 1-100")
+		}
+		percent = float32(pctInt) / 100
+		numCPU = int(float32(availCPU) * percent)
+	} else {
+		// Number
+		num, err := strconv.Atoi(cpu)
+		if err != nil || num < 1 {
+			return errors.New("Invalid CPU value: provide a number or percent greater than 0")
+		}
+		numCPU = num
+	}
+
+	if numCPU > availCPU {
+		numCPU = availCPU
+	}
+
+	runtime.GOMAXPROCS(numCPU)
+	return nil
+}

caddy.go

@@ -1,570 +0,0 @@
-// 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 caddy
-
-import (
-	"bytes"
-	"context"
-	"encoding/json"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"log"
-	"net/http"
-	"os"
-	"path"
-	"path/filepath"
-	"runtime/debug"
-	"strconv"
-	"strings"
-	"sync"
-	"time"
-
-	"github.com/caddyserver/certmagic"
-	"go.uber.org/zap"
-)
-
-// Config is the top (or beginning) of the Caddy configuration structure.
-// Caddy config is expressed natively as a JSON document. If you prefer
-// not to work with JSON directly, there are [many config adapters](/docs/config-adapters)
-// available that can convert various inputs into Caddy JSON.
-//
-// Many parts of this config are extensible through the use of Caddy modules.
-// Fields which have a json.RawMessage type and which appear as dots (•••) in
-// the online docs can be fulfilled by modules in a certain module
-// namespace. The docs show which modules can be used in a given place.
-//
-// Whenever a module is used, its name must be given either inline as part of
-// the module, or as the key to the module's value. The docs will make it clear
-// which to use.
-//
-// Generally, all config settings are optional, as it is Caddy convention to
-// have good, documented default values. If a parameter is required, the docs
-// should say so.
-//
-// Go programs which are directly building a Config struct value should take
-// care to populate the JSON-encodable fields of the struct (i.e. the fields
-// with `json` struct tags) if employing the module lifecycle (e.g. Provision
-// method calls).
-type Config struct {
-	Admin   *AdminConfig `json:"admin,omitempty"`
-	Logging *Logging     `json:"logging,omitempty"`
-
-	// StorageRaw is a storage module that defines how/where Caddy
-	// stores assets (such as TLS certificates). The default storage
-	// module is `caddy.storage.file_system` (the local file system),
-	// and the default path
-	// [depends on the OS and environment](/docs/conventions#data-directory).
-	StorageRaw json.RawMessage `json:"storage,omitempty" caddy:"namespace=caddy.storage inline_key=module"`
-
-	// AppsRaw are the apps that Caddy will load and run. The
-	// app module name is the key, and the app's config is the
-	// associated value.
-	AppsRaw ModuleMap `json:"apps,omitempty" caddy:"namespace="`
-
-	apps    map[string]App
-	storage certmagic.Storage
-
-	cancelFunc context.CancelFunc
-}
-
-// App is a thing that Caddy runs.
-type App interface {
-	Start() error
-	Stop() error
-}
-
-// Run runs the given config, replacing any existing config.
-func Run(cfg *Config) error {
-	cfgJSON, err := json.Marshal(cfg)
-	if err != nil {
-		return err
-	}
-	return Load(cfgJSON, true)
-}
-
-// Load loads the given config JSON and runs it only
-// if it is different from the current config or
-// forceReload is true.
-func Load(cfgJSON []byte, forceReload bool) error {
-	return changeConfig(http.MethodPost, "/"+rawConfigKey, cfgJSON, forceReload)
-}
-
-// changeConfig changes the current config (rawCfg) according to the
-// method, traversed via the given path, and uses the given input as
-// the new value (if applicable; i.e. "DELETE" doesn't have an input).
-// If the resulting config is the same as the previous, no reload will
-// occur unless forceReload is true. This function is safe for
-// concurrent use.
-func changeConfig(method, path string, input []byte, forceReload bool) error {
-	switch method {
-	case http.MethodGet,
-		http.MethodHead,
-		http.MethodOptions,
-		http.MethodConnect,
-		http.MethodTrace:
-		return fmt.Errorf("method not allowed")
-	}
-
-	currentCfgMu.Lock()
-	defer currentCfgMu.Unlock()
-
-	err := unsyncedConfigAccess(method, path, input, nil)
-	if err != nil {
-		return err
-	}
-
-	// the mutation is complete, so encode the entire config as JSON
-	newCfg, err := json.Marshal(rawCfg[rawConfigKey])
-	if err != nil {
-		return APIError{
-			Code: http.StatusBadRequest,
-			Err:  fmt.Errorf("encoding new config: %v", err),
-		}
-	}
-
-	// if nothing changed, no need to do a whole reload unless the client forces it
-	if !forceReload && bytes.Equal(rawCfgJSON, newCfg) {
-		Log().Named("admin.api").Info("config is unchanged")
-		return nil
-	}
-
-	// find any IDs in this config and index them
-	idx := make(map[string]string)
-	err = indexConfigObjects(rawCfg[rawConfigKey], "/"+rawConfigKey, idx)
-	if err != nil {
-		return APIError{
-			Code: http.StatusInternalServerError,
-			Err:  fmt.Errorf("indexing config: %v", err),
-		}
-	}
-
-	// load this new config; if it fails, we need to revert to
-	// our old representation of caddy's actual config
-	err = unsyncedDecodeAndRun(newCfg)
-	if err != nil {
-		if len(rawCfgJSON) > 0 {
-			// restore old config state to keep it consistent
-			// with what caddy is still running; we need to
-			// unmarshal it again because it's likely that
-			// pointers deep in our rawCfg map were modified
-			var oldCfg interface{}
-			err2 := json.Unmarshal(rawCfgJSON, &oldCfg)
-			if err2 != nil {
-				err = fmt.Errorf("%v; additionally, restoring old config: %v", err, err2)
-			}
-			rawCfg[rawConfigKey] = oldCfg
-		}
-
-		return fmt.Errorf("loading new config: %v", err)
-	}
-
-	// success, so update our stored copy of the encoded
-	// config to keep it consistent with what caddy is now
-	// running (storing an encoded copy is not strictly
-	// necessary, but avoids an extra json.Marshal for
-	// each config change)
-	rawCfgJSON = newCfg
-	rawCfgIndex = idx
-
-	return nil
-}
-
-// readConfig traverses the current config to path
-// and writes its JSON encoding to out.
-func readConfig(path string, out io.Writer) error {
-	currentCfgMu.RLock()
-	defer currentCfgMu.RUnlock()
-	return unsyncedConfigAccess(http.MethodGet, path, nil, out)
-}
-
-// indexConfigObjects recursively searches ptr for object fields named
-// "@id" and maps that ID value to the full configPath in the index.
-// This function is NOT safe for concurrent access; obtain a write lock
-// on currentCfgMu.
-func indexConfigObjects(ptr interface{}, configPath string, index map[string]string) error {
-	switch val := ptr.(type) {
-	case map[string]interface{}:
-		for k, v := range val {
-			if k == idKey {
-				switch idVal := v.(type) {
-				case string:
-					index[idVal] = configPath
-				case float64: // all JSON numbers decode as float64
-					index[fmt.Sprintf("%v", idVal)] = configPath
-				default:
-					return fmt.Errorf("%s: %s field must be a string or number", configPath, idKey)
-				}
-				continue
-			}
-			// traverse this object property recursively
-			err := indexConfigObjects(val[k], path.Join(configPath, k), index)
-			if err != nil {
-				return err
-			}
-		}
-	case []interface{}:
-		// traverse each element of the array recursively
-		for i := range val {
-			err := indexConfigObjects(val[i], path.Join(configPath, strconv.Itoa(i)), index)
-			if err != nil {
-				return err
-			}
-		}
-	}
-
-	return nil
-}
-
-// unsyncedDecodeAndRun removes any meta fields (like @id tags)
-// from cfgJSON, decodes the result into a *Config, and runs
-// it as the new config, replacing any other current config.
-// It does NOT update the raw config state, as this is a
-// lower-level function; most callers will want to use Load
-// instead. A write lock on currentCfgMu is required!
-func unsyncedDecodeAndRun(cfgJSON []byte) error {
-	// remove any @id fields from the JSON, which would cause
-	// loading to break since the field wouldn't be recognized
-	strippedCfgJSON := RemoveMetaFields(cfgJSON)
-
-	var newCfg *Config
-	err := strictUnmarshalJSON(strippedCfgJSON, &newCfg)
-	if err != nil {
-		return err
-	}
-
-	// run the new config and start all its apps
-	err = run(newCfg, true)
-	if err != nil {
-		return err
-	}
-
-	// swap old config with the new one
-	oldCfg := currentCfg
-	currentCfg = newCfg
-
-	// Stop, Cleanup each old app
-	unsyncedStop(oldCfg)
-
-	// autosave a non-nil config, if not disabled
-	if newCfg != nil &&
-		(newCfg.Admin == nil ||
-			newCfg.Admin.Config == nil ||
-			newCfg.Admin.Config.Persist == nil ||
-			*newCfg.Admin.Config.Persist) {
-		dir := filepath.Dir(ConfigAutosavePath)
-		err := os.MkdirAll(dir, 0700)
-		if err != nil {
-			Log().Error("unable to create folder for config autosave",
-				zap.String("dir", dir),
-				zap.Error(err))
-		} else {
-			err := ioutil.WriteFile(ConfigAutosavePath, cfgJSON, 0600)
-			if err == nil {
-				Log().Info("autosaved config", zap.String("file", ConfigAutosavePath))
-			} else {
-				Log().Error("unable to autosave config",
-					zap.String("file", ConfigAutosavePath),
-					zap.Error(err))
-			}
-		}
-	}
-
-	return nil
-}
-
-// run runs newCfg and starts all its apps if
-// start is true. If any errors happen, cleanup
-// is performed if any modules were provisioned;
-// apps that were started already will be stopped,
-// so this function should not leak resources if
-// an error is returned. However, if no error is
-// returned and start == false, you should cancel
-// the config if you are not going to start it,
-// so that each provisioned module will be
-// cleaned up.
-//
-// This is a low-level function; most callers
-// will want to use Run instead, which also
-// updates the config's raw state.
-func run(newCfg *Config, start bool) error {
-	// because we will need to roll back any state
-	// modifications if this function errors, we
-	// keep a single error value and scope all
-	// sub-operations to their own functions to
-	// ensure this error value does not get
-	// overridden or missed when it should have
-	// been set by a short assignment
-	var err error
-
-	// start the admin endpoint (and stop any prior one)
-	if start {
-		err = replaceAdmin(newCfg)
-		if err != nil {
-			return fmt.Errorf("starting caddy administration endpoint: %v", err)
-		}
-	}
-
-	if newCfg == nil {
-		return nil
-	}
-
-	// prepare the new config for use
-	newCfg.apps = make(map[string]App)
-
-	// create a context within which to load
-	// modules - essentially our new config's
-	// execution environment; be sure that
-	// cleanup occurs when we return if there
-	// was an error; if no error, it will get
-	// cleaned up on next config cycle
-	ctx, cancel := NewContext(Context{Context: context.Background(), cfg: newCfg})
-	defer func() {
-		if err != nil {
-			// if there were any errors during startup,
-			// we should cancel the new context we created
-			// since the associated config won't be used;
-			// this will cause all modules that were newly
-			// provisioned to clean themselves up
-			cancel()
-
-			// also undo any other state changes we made
-			if currentCfg != nil {
-				certmagic.Default.Storage = currentCfg.storage
-			}
-		}
-	}()
-	newCfg.cancelFunc = cancel // clean up later
-
-	// set up logging before anything bad happens
-	if newCfg.Logging == nil {
-		newCfg.Logging = new(Logging)
-	}
-	err = newCfg.Logging.openLogs(ctx)
-	if err != nil {
-		return err
-	}
-
-	// set up global storage and make it CertMagic's default storage, too
-	err = func() error {
-		if newCfg.StorageRaw != nil {
-			val, err := ctx.LoadModule(newCfg, "StorageRaw")
-			if err != nil {
-				return fmt.Errorf("loading storage module: %v", err)
-			}
-			stor, err := val.(StorageConverter).CertMagicStorage()
-			if err != nil {
-				return fmt.Errorf("creating storage value: %v", err)
-			}
-			newCfg.storage = stor
-		}
-
-		if newCfg.storage == nil {
-			newCfg.storage = &certmagic.FileStorage{Path: AppDataDir()}
-		}
-		certmagic.Default.Storage = newCfg.storage
-
-		return nil
-	}()
-	if err != nil {
-		return err
-	}
-
-	// Load and Provision each app and their submodules
-	err = func() error {
-		for appName := range newCfg.AppsRaw {
-			if _, err := ctx.App(appName); err != nil {
-				return err
-			}
-		}
-		return nil
-	}()
-	if err != nil {
-		return err
-	}
-
-	if !start {
-		return nil
-	}
-
-	// Start
-	return func() error {
-		var started []string
-		for name, a := range newCfg.apps {
-			err := a.Start()
-			if err != nil {
-				// an app failed to start, so we need to stop
-				// all other apps that were already started
-				for _, otherAppName := range started {
-					err2 := newCfg.apps[otherAppName].Stop()
-					if err2 != nil {
-						err = fmt.Errorf("%v; additionally, aborting app %s: %v",
-							err, otherAppName, err2)
-					}
-				}
-				return fmt.Errorf("%s app module: start: %v", name, err)
-			}
-			started = append(started, name)
-		}
-		return nil
-	}()
-}
-
-// Stop stops running the current configuration.
-// It is the antithesis of Run(). This function
-// will log any errors that occur during the
-// stopping of individual apps and continue to
-// stop the others. Stop should only be called
-// if not replacing with a new config.
-func Stop() error {
-	currentCfgMu.Lock()
-	defer currentCfgMu.Unlock()
-	unsyncedStop(currentCfg)
-	currentCfg = nil
-	rawCfgJSON = nil
-	rawCfgIndex = nil
-	rawCfg[rawConfigKey] = nil
-	return nil
-}
-
-// unsyncedStop stops cfg from running, but has
-// no locking around cfg. It is a no-op if cfg is
-// nil. If any app returns an error when stopping,
-// it is logged and the function continues stopping
-// the next app. This function assumes all apps in
-// cfg were successfully started first.
-func unsyncedStop(cfg *Config) {
-	if cfg == nil {
-		return
-	}
-
-	// stop each app
-	for name, a := range cfg.apps {
-		err := a.Stop()
-		if err != nil {
-			log.Printf("[ERROR] stop %s: %v", name, err)
-		}
-	}
-
-	// clean up all modules
-	cfg.cancelFunc()
-}
-
-// stopAndCleanup calls stop and cleans up anything
-// else that is expedient. This should only be used
-// when stopping and not replacing with a new config.
-func stopAndCleanup() error {
-	if err := Stop(); err != nil {
-		return err
-	}
-	certmagic.CleanUpOwnLocks()
-	return nil
-}
-
-// Validate loads, provisions, and validates
-// cfg, but does not start running it.
-func Validate(cfg *Config) error {
-	err := run(cfg, false)
-	if err == nil {
-		cfg.cancelFunc() // call Cleanup on all modules
-	}
-	return err
-}
-
-// Duration can be an integer or a string. An integer is
-// interpreted as nanoseconds. If a string, it is a Go
-// time.Duration value such as `300ms`, `1.5h`, or `2h45m`;
-// valid units are `ns`, `us`/`µs`, `ms`, `s`, `m`, and `h`.
-type Duration time.Duration
-
-// UnmarshalJSON satisfies json.Unmarshaler.
-func (d *Duration) UnmarshalJSON(b []byte) error {
-	if len(b) == 0 {
-		return io.EOF
-	}
-	var dur time.Duration
-	var err error
-	if b[0] == byte('"') && b[len(b)-1] == byte('"') {
-		dur, err = time.ParseDuration(strings.Trim(string(b), `"`))
-	} else {
-		err = json.Unmarshal(b, &dur)
-	}
-	*d = Duration(dur)
-	return err
-}
-
-// GoModule returns the build info of this Caddy
-// build from debug.BuildInfo (requires Go modules).
-// If no version information is available, a non-nil
-// value will still be returned, but with an
-// unknown version.
-func GoModule() *debug.Module {
-	var mod debug.Module
-	return goModule(&mod)
-}
-
-// goModule holds the actual implementation of GoModule.
-// Allocating debug.Module in GoModule() and passing a
-// reference to goModule enables mid-stack inlining.
-func goModule(mod *debug.Module) *debug.Module {
-	mod.Version = "unknown"
-	bi, ok := debug.ReadBuildInfo()
-	if ok {
-		mod.Path = bi.Main.Path
-		// The recommended way to build Caddy involves
-		// creating a separate main module, which
-		// TODO: track related Go issue: https://github.com/golang/go/issues/29228
-		// once that issue is fixed, we should just be able to use bi.Main... hopefully.
-		for _, dep := range bi.Deps {
-			if dep.Path == ImportPath {
-				return dep
-			}
-		}
-		return &bi.Main
-	}
-	return mod
-}
-
-// CtxKey is a value type for use with context.WithValue.
-type CtxKey string
-
-// This group of variables pertains to the current configuration.
-var (
-	// currentCfgMu protects everything in this var block.
-	currentCfgMu sync.RWMutex
-
-	// currentCfg is the currently-running configuration.
-	currentCfg *Config
-
-	// rawCfg is the current, generic-decoded configuration;
-	// we initialize it as a map with one field ("config")
-	// to maintain parity with the API endpoint and to avoid
-	// the special case of having to access/mutate the variable
-	// directly without traversing into it.
-	rawCfg = map[string]interface{}{
-		rawConfigKey: nil,
-	}
-
-	// rawCfgJSON is the JSON-encoded form of rawCfg. Keeping
-	// this around avoids an extra Marshal call during changes.
-	rawCfgJSON []byte
-
-	// rawCfgIndex is the map of user-assigned ID to expanded
-	// path, for converting /id/ paths to /config/ paths.
-	rawCfgIndex map[string]string
-)
-
-// ImportPath is the package import path for Caddy core.
-const ImportPath = "github.com/caddyserver/caddy/v2"

caddyconfig/caddyfile/adapter.go

@@ -1,86 +0,0 @@
-// 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 caddyfile
-
-import (
-	"encoding/json"
-	"fmt"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-)
-
-// Adapter adapts Caddyfile to Caddy JSON.
-type Adapter struct {
-	ServerType ServerType
-}
-
-// Adapt converts the Caddyfile config in body to Caddy JSON.
-func (a Adapter) Adapt(body []byte, options map[string]interface{}) ([]byte, []caddyconfig.Warning, error) {
-	if a.ServerType == nil {
-		return nil, nil, fmt.Errorf("no server type")
-	}
-	if options == nil {
-		options = make(map[string]interface{})
-	}
-
-	filename, _ := options["filename"].(string)
-	if filename == "" {
-		filename = "Caddyfile"
-	}
-
-	serverBlocks, err := Parse(filename, body)
-	if err != nil {
-		return nil, nil, err
-	}
-
-	cfg, warnings, err := a.ServerType.Setup(serverBlocks, options)
-	if err != nil {
-		return nil, warnings, err
-	}
-
-	marshalFunc := json.Marshal
-	if options["pretty"] == "true" {
-		marshalFunc = caddyconfig.JSONIndent
-	}
-	result, err := marshalFunc(cfg)
-
-	return result, warnings, err
-}
-
-// Unmarshaler is a type that can unmarshal
-// Caddyfile tokens to set itself up for a
-// JSON encoding. The goal of an unmarshaler
-// is not to set itself up for actual use,
-// but to set itself up for being marshaled
-// into JSON. Caddyfile-unmarshaled values
-// will not be used directly; they will be
-// encoded as JSON and then used from that.
-type Unmarshaler interface {
-	UnmarshalCaddyfile(d *Dispenser) error
-}
-
-// ServerType is a type that can evaluate a Caddyfile and set up a caddy config.
-type ServerType interface {
-	// Setup takes the server blocks which
-	// contain tokens, as well as options
-	// (e.g. CLI flags) and creates a Caddy
-	// config, along with any warnings or
-	// an error.
-	Setup([]ServerBlock, map[string]interface{}) (*caddy.Config, []caddyconfig.Warning, error)
-}
-
-// Interface guard
-var _ caddyconfig.Adapter = (*Adapter)(nil)

caddyconfig/caddyfile/dispenser.go

@@ -1,384 +0,0 @@
-// 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 caddyfile
-
-import (
-	"errors"
-	"fmt"
-	"strings"
-)
-
-// Dispenser is a type that dispenses tokens, similarly to a lexer,
-// except that it can do so with some notion of structure. An empty
-// Dispenser is invalid; call NewDispenser to make a proper instance.
-type Dispenser struct {
-	tokens  []Token
-	cursor  int
-	nesting int
-}
-
-// NewDispenser returns a Dispenser filled with the given tokens.
-func NewDispenser(tokens []Token) *Dispenser {
-	return &Dispenser{
-		tokens: tokens,
-		cursor: -1,
-	}
-}
-
-// Next loads the next token. Returns true if a token
-// was loaded; false otherwise. If false, all tokens
-// have been consumed.
-func (d *Dispenser) Next() bool {
-	if d.cursor < len(d.tokens)-1 {
-		d.cursor++
-		return true
-	}
-	return false
-}
-
-// Prev moves to the previous token. It does the inverse
-// of Next(), except this function may decrement the cursor
-// to -1 so that the next call to Next() points to the
-// first token; this allows dispensing to "start over". This
-// method returns true if the cursor ends up pointing to a
-// valid token.
-func (d *Dispenser) Prev() bool {
-	if d.cursor > -1 {
-		d.cursor--
-		return d.cursor > -1
-	}
-	return false
-}
-
-// NextArg loads the next token if it is on the same
-// line and if it is not a block opening (open curly
-// brace). Returns true if an argument token was
-// loaded; false otherwise. If false, all tokens on
-// the line have been consumed except for potentially
-// a block opening. It handles imported tokens
-// correctly.
-func (d *Dispenser) NextArg() bool {
-	if !d.nextOnSameLine() {
-		return false
-	}
-	if d.Val() == "{" {
-		// roll back; a block opening is not an argument
-		d.cursor--
-		return false
-	}
-	return true
-}
-
-// nextOnSameLine advances the cursor if the next
-// token is on the same line of the same file.
-func (d *Dispenser) nextOnSameLine() bool {
-	if d.cursor < 0 {
-		d.cursor++
-		return true
-	}
-	if d.cursor >= len(d.tokens) {
-		return false
-	}
-	if d.cursor < len(d.tokens)-1 &&
-		d.tokens[d.cursor].File == d.tokens[d.cursor+1].File &&
-		d.tokens[d.cursor].Line+d.numLineBreaks(d.cursor) == d.tokens[d.cursor+1].Line {
-		d.cursor++
-		return true
-	}
-	return false
-}
-
-// NextLine loads the next token only if it is not on the same
-// line as the current token, and returns true if a token was
-// loaded; false otherwise. If false, there is not another token
-// or it is on the same line. It handles imported tokens correctly.
-func (d *Dispenser) NextLine() bool {
-	if d.cursor < 0 {
-		d.cursor++
-		return true
-	}
-	if d.cursor >= len(d.tokens) {
-		return false
-	}
-	if d.cursor < len(d.tokens)-1 &&
-		(d.tokens[d.cursor].File != d.tokens[d.cursor+1].File ||
-			d.tokens[d.cursor].Line+d.numLineBreaks(d.cursor) < d.tokens[d.cursor+1].Line) {
-		d.cursor++
-		return true
-	}
-	return false
-}
-
-// NextBlock can be used as the condition of a for loop
-// to load the next token as long as it opens a block or
-// is already in a block nested more than initialNestingLevel.
-// In other words, a loop over NextBlock() will iterate
-// all tokens in the block assuming the next token is an
-// open curly brace, until the matching closing brace.
-// The open and closing brace tokens for the outer-most
-// block will be consumed internally and omitted from
-// the iteration.
-//
-// Proper use of this method looks like this:
-//
-//     for nesting := d.Nesting(); d.NextBlock(nesting); {
-//     }
-//
-// However, in simple cases where it is known that the
-// Dispenser is new and has not already traversed state
-// by a loop over NextBlock(), this will do:
-//
-//     for d.NextBlock(0) {
-//     }
-//
-// As with other token parsing logic, a loop over
-// NextBlock() should be contained within a loop over
-// Next(), as it is usually prudent to skip the initial
-// token.
-func (d *Dispenser) NextBlock(initialNestingLevel int) bool {
-	if d.nesting > initialNestingLevel {
-		if !d.Next() {
-			return false // should be EOF error
-		}
-		if d.Val() == "}" && !d.nextOnSameLine() {
-			d.nesting--
-		} else if d.Val() == "{" && !d.nextOnSameLine() {
-			d.nesting++
-		}
-		return d.nesting > initialNestingLevel
-	}
-	if !d.nextOnSameLine() { // block must open on same line
-		return false
-	}
-	if d.Val() != "{" {
-		d.cursor-- // roll back if not opening brace
-		return false
-	}
-	d.Next() // consume open curly brace
-	if d.Val() == "}" {
-		return false // open and then closed right away
-	}
-	d.nesting++
-	return true
-}
-
-// Nesting returns the current nesting level. Necessary
-// if using NextBlock()
-func (d *Dispenser) Nesting() int {
-	return d.nesting
-}
-
-// Val gets the text of the current token. If there is no token
-// loaded, it returns empty string.
-func (d *Dispenser) Val() string {
-	if d.cursor < 0 || d.cursor >= len(d.tokens) {
-		return ""
-	}
-	return d.tokens[d.cursor].Text
-}
-
-// Line gets the line number of the current token.
-// If there is no token loaded, it returns 0.
-func (d *Dispenser) Line() int {
-	if d.cursor < 0 || d.cursor >= len(d.tokens) {
-		return 0
-	}
-	return d.tokens[d.cursor].Line
-}
-
-// File gets the filename where the current token originated.
-func (d *Dispenser) File() string {
-	if d.cursor < 0 || d.cursor >= len(d.tokens) {
-		return ""
-	}
-	return d.tokens[d.cursor].File
-}
-
-// Args is a convenience function that loads the next arguments
-// (tokens on the same line) into an arbitrary number of strings
-// pointed to in targets. If there are not enough argument tokens
-// available to fill targets, false is returned and the remaining
-// targets are left unchanged. If all the targets are filled,
-// then true is returned.
-func (d *Dispenser) Args(targets ...*string) bool {
-	for i := 0; i < len(targets); i++ {
-		if !d.NextArg() {
-			return false
-		}
-		*targets[i] = d.Val()
-	}
-	return true
-}
-
-// AllArgs is like Args, but if there are more argument tokens
-// available than there are targets, false is returned. The
-// number of available argument tokens must match the number of
-// targets exactly to return true.
-func (d *Dispenser) AllArgs(targets ...*string) bool {
-	if !d.Args(targets...) {
-		return false
-	}
-	if d.NextArg() {
-		d.Prev()
-		return false
-	}
-	return true
-}
-
-// RemainingArgs loads any more arguments (tokens on the same line)
-// into a slice and returns them. Open curly brace tokens also indicate
-// the end of arguments, and the curly brace is not included in
-// the return value nor is it loaded.
-func (d *Dispenser) RemainingArgs() []string {
-	var args []string
-	for d.NextArg() {
-		args = append(args, d.Val())
-	}
-	return args
-}
-
-// NewFromNextSegment returns a new dispenser with a copy of
-// the tokens from the current token until the end of the
-// "directive" whether that be to the end of the line or
-// the end of a block that starts at the end of the line;
-// in other words, until the end of the segment.
-func (d *Dispenser) NewFromNextSegment() *Dispenser {
-	return NewDispenser(d.NextSegment())
-}
-
-// NextSegment returns a copy of the tokens from the current
-// token until the end of the line or block that starts at
-// the end of the line.
-func (d *Dispenser) NextSegment() Segment {
-	tkns := Segment{d.Token()}
-	for d.NextArg() {
-		tkns = append(tkns, d.Token())
-	}
-	var openedBlock bool
-	for nesting := d.Nesting(); d.NextBlock(nesting); {
-		if !openedBlock {
-			// because NextBlock() consumes the initial open
-			// curly brace, we rewind here to append it, since
-			// our case is special in that we want the new
-			// dispenser to have all the tokens including
-			// surrounding curly braces
-			d.Prev()
-			tkns = append(tkns, d.Token())
-			d.Next()
-			openedBlock = true
-		}
-		tkns = append(tkns, d.Token())
-	}
-	if openedBlock {
-		// include closing brace
-		tkns = append(tkns, d.Token())
-
-		// do not consume the closing curly brace; the
-		// next iteration of the enclosing loop will
-		// call Next() and consume it
-	}
-	return tkns
-}
-
-// Token returns the current token.
-func (d *Dispenser) Token() Token {
-	if d.cursor < 0 || d.cursor >= len(d.tokens) {
-		return Token{}
-	}
-	return d.tokens[d.cursor]
-}
-
-// Reset sets d's cursor to the beginning, as
-// if this was a new and unused dispenser.
-func (d *Dispenser) Reset() {
-	d.cursor = -1
-	d.nesting = 0
-}
-
-// ArgErr returns an argument error, meaning that another
-// argument was expected but not found. In other words,
-// a line break or open curly brace was encountered instead of
-// an argument.
-func (d *Dispenser) ArgErr() error {
-	if d.Val() == "{" {
-		return d.Err("Unexpected token '{', expecting argument")
-	}
-	return d.Errf("Wrong argument count or unexpected line ending after '%s'", d.Val())
-}
-
-// SyntaxErr creates a generic syntax error which explains what was
-// found and what was expected.
-func (d *Dispenser) SyntaxErr(expected string) error {
-	msg := fmt.Sprintf("%s:%d - Syntax error: Unexpected token '%s', expecting '%s'", d.File(), d.Line(), d.Val(), expected)
-	return errors.New(msg)
-}
-
-// EOFErr returns an error indicating that the dispenser reached
-// the end of the input when searching for the next token.
-func (d *Dispenser) EOFErr() error {
-	return d.Errf("Unexpected EOF")
-}
-
-// Err generates a custom parse-time error with a message of msg.
-func (d *Dispenser) Err(msg string) error {
-	msg = fmt.Sprintf("%s:%d - Error during parsing: %s", d.File(), d.Line(), msg)
-	return errors.New(msg)
-}
-
-// Errf is like Err, but for formatted error messages
-func (d *Dispenser) Errf(format string, args ...interface{}) error {
-	return d.Err(fmt.Sprintf(format, args...))
-}
-
-// Delete deletes the current token and returns the updated slice
-// of tokens. The cursor is not advanced to the next token.
-// Because deletion modifies the underlying slice, this method
-// should only be called if you have access to the original slice
-// of tokens and/or are using the slice of tokens outside this
-// Dispenser instance. If you do not re-assign the slice with the
-// return value of this method, inconsistencies in the token
-// array will become apparent (or worse, hide from you like they
-// did me for 3 and a half freaking hours late one night).
-func (d *Dispenser) Delete() []Token {
-	if d.cursor >= 0 && d.cursor <= len(d.tokens)-1 {
-		d.tokens = append(d.tokens[:d.cursor], d.tokens[d.cursor+1:]...)
-		d.cursor--
-	}
-	return d.tokens
-}
-
-// numLineBreaks counts how many line breaks are in the token
-// value given by the token index tknIdx. It returns 0 if the
-// token does not exist or there are no line breaks.
-func (d *Dispenser) numLineBreaks(tknIdx int) int {
-	if tknIdx < 0 || tknIdx >= len(d.tokens) {
-		return 0
-	}
-	return strings.Count(d.tokens[tknIdx].Text, "\n")
-}
-
-// isNewLine determines whether the current token is on a different
-// line (higher line number) than the previous token. It handles imported
-// tokens correctly. If there isn't a previous token, it returns true.
-func (d *Dispenser) isNewLine() bool {
-	if d.cursor < 1 {
-		return true
-	}
-	if d.cursor > len(d.tokens)-1 {
-		return false
-	}
-	return d.tokens[d.cursor-1].File != d.tokens[d.cursor].File ||
-		d.tokens[d.cursor-1].Line+d.numLineBreaks(d.cursor-1) < d.tokens[d.cursor].Line
-}

caddyconfig/caddyfile/formatter.go

@@ -1,148 +0,0 @@
-// 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 caddyfile
-
-import (
-	"bytes"
-	"io"
-	"unicode"
-)
-
-// Format formats a Caddyfile to conventional standards.
-func Format(body []byte) []byte {
-	reader := bytes.NewReader(body)
-	result := new(bytes.Buffer)
-
-	var (
-		commented,
-		quoted,
-		escaped,
-		environ,
-		lineBegin bool
-
-		firstIteration = true
-
-		indentation = 0
-
-		prev,
-		curr,
-		next rune
-
-		err error
-	)
-
-	insertTabs := func(num int) {
-		for tabs := num; tabs > 0; tabs-- {
-			result.WriteRune('\t')
-		}
-	}
-
-	for {
-		prev = curr
-		curr = next
-
-		if curr < 0 {
-			break
-		}
-
-		next, _, err = reader.ReadRune()
-		if err != nil {
-			if err == io.EOF {
-				next = -1
-			} else {
-				panic(err)
-			}
-		}
-
-		if firstIteration {
-			firstIteration = false
-			lineBegin = true
-			continue
-		}
-
-		if quoted {
-			if escaped {
-				escaped = false
-			} else {
-				if curr == '\\' {
-					escaped = true
-				}
-				if curr == '"' {
-					quoted = false
-				}
-			}
-			if curr == '\n' {
-				quoted = false
-			}
-		} else if commented {
-			if curr == '\n' {
-				commented = false
-			}
-		} else {
-			if curr == '"' {
-				quoted = true
-			}
-			if curr == '#' {
-				commented = true
-			}
-			if curr == '}' {
-				if environ {
-					environ = false
-				} else if indentation > 0 {
-					indentation--
-				}
-			}
-			if curr == '{' {
-				if unicode.IsSpace(next) {
-					indentation++
-
-					if !unicode.IsSpace(prev) && !lineBegin {
-						result.WriteRune(' ')
-					}
-				} else {
-					environ = true
-				}
-			}
-			if lineBegin {
-				if curr == ' ' || curr == '\t' {
-					continue
-				} else {
-					lineBegin = false
-					if curr == '{' && unicode.IsSpace(next) {
-						// If the block is global, i.e., starts with '{'
-						// One less indentation for these blocks.
-						insertTabs(indentation - 1)
-					} else {
-						insertTabs(indentation)
-					}
-				}
-			} else {
-				if prev == '{' &&
-					(curr == ' ' || curr == '\t') &&
-					(next != '\n' && next != '\r') {
-					curr = '\n'
-				}
-			}
-		}
-
-		if curr == '\n' {
-			lineBegin = true
-		}
-
-		result.WriteRune(curr)
-	}
-
-	return result.Bytes()
-}

caddyconfig/caddyfile/formatter_test.go

@@ -1,228 +0,0 @@
-// 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 caddyfile
-
-import (
-	"testing"
-)
-
-func TestFormatBasicIndentation(t *testing.T) {
-	input := []byte(`
-  a
-b
-
-	c {
-		d
-}
-
-e { f
-}
-
-g {
-h {
-i
-}
-}
-
-j { k {
-l
-}
-}
-
-m {
-	n { o
-	}
-}
-
-{
-	p
-}
-
-  { q
-}
-
-	{
-{ r
-}
-}
-`)
-	expected := []byte(`
-a
-b
-
-c {
-	d
-}
-
-e {
-	f
-}
-
-g {
-	h {
-		i
-	}
-}
-
-j {
-	k {
-		l
-	}
-}
-
-m {
-	n {
-		o
-	}
-}
-
-{
-	p
-}
-
-{
-	q
-}
-
-{
-	{
-		r
-	}
-}
-`)
-	testFormat(t, input, expected)
-}
-
-func TestFormatBasicSpacing(t *testing.T) {
-	input := []byte(`
-a{
-	b
-}
-
-c{ d
-}
-`)
-	expected := []byte(`
-a {
-	b
-}
-
-c {
-	d
-}
-`)
-	testFormat(t, input, expected)
-}
-
-func TestFormatEnvironmentVariable(t *testing.T) {
-	input := []byte(`
-{$A}
-
-b {
-{$C}
-}
-
-d { {$E}
-}
-
-{ {$F}
-}
-`)
-	expected := []byte(`
-{$A}
-
-b {
-	{$C}
-}
-
-d {
-	{$E}
-}
-
-{
-	{$F}
-}
-`)
-	testFormat(t, input, expected)
-}
-
-func TestFormatComments(t *testing.T) {
-	input := []byte(`
-# a "\n"
-
-# b {
-	c
-}
-
-d {
-e # f
-# g
-}
-
-h { # i
-}
-`)
-	expected := []byte(`
-# a "\n"
-
-# b {
-c
-}
-
-d {
-	e # f
-	# g
-}
-
-h {
-	# i
-}
-`)
-	testFormat(t, input, expected)
-}
-
-func TestFormatQuotesAndEscapes(t *testing.T) {
-	input := []byte(`
-"a \"b\" #c
-	d
-
-e {
-"f"
-}
-
-g { "h"
-}
-`)
-	expected := []byte(`
-"a \"b\" #c
-d
-
-e {
-	"f"
-}
-
-g {
-	"h"
-}
-`)
-	testFormat(t, input, expected)
-}
-
-func testFormat(t *testing.T, input, expected []byte) {
-	output := Format(input)
-	if string(output) != string(expected) {
-		t.Errorf("Expected:\n%s\ngot:\n%s", string(expected), string(output))
-	}
-}

caddyconfig/caddyfile/lexer_test.go

@@ -1,238 +0,0 @@
-// Copyright 2015 Light Code Labs, LLC
-//
-// 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 caddyfile
-
-import (
-	"log"
-	"strings"
-	"testing"
-)
-
-type lexerTestCase struct {
-	input    string
-	expected []Token
-}
-
-func TestLexer(t *testing.T) {
-	testCases := []lexerTestCase{
-		{
-			input: `host:123`,
-			expected: []Token{
-				{Line: 1, Text: "host:123"},
-			},
-		},
-		{
-			input: `host:123
-
-					directive`,
-			expected: []Token{
-				{Line: 1, Text: "host:123"},
-				{Line: 3, Text: "directive"},
-			},
-		},
-		{
-			input: `host:123 {
-						directive
-					}`,
-			expected: []Token{
-				{Line: 1, Text: "host:123"},
-				{Line: 1, Text: "{"},
-				{Line: 2, Text: "directive"},
-				{Line: 3, Text: "}"},
-			},
-		},
-		{
-			input: `host:123 { directive }`,
-			expected: []Token{
-				{Line: 1, Text: "host:123"},
-				{Line: 1, Text: "{"},
-				{Line: 1, Text: "directive"},
-				{Line: 1, Text: "}"},
-			},
-		},
-		{
-			input: `host:123 {
-						#comment
-						directive
-						# comment
-						foobar # another comment
-					}`,
-			expected: []Token{
-				{Line: 1, Text: "host:123"},
-				{Line: 1, Text: "{"},
-				{Line: 3, Text: "directive"},
-				{Line: 5, Text: "foobar"},
-				{Line: 6, Text: "}"},
-			},
-		},
-		{
-			input: `a "quoted value" b
-					foobar`,
-			expected: []Token{
-				{Line: 1, Text: "a"},
-				{Line: 1, Text: "quoted value"},
-				{Line: 1, Text: "b"},
-				{Line: 2, Text: "foobar"},
-			},
-		},
-		{
-			input: `A "quoted \"value\" inside" B`,
-			expected: []Token{
-				{Line: 1, Text: "A"},
-				{Line: 1, Text: `quoted "value" inside`},
-				{Line: 1, Text: "B"},
-			},
-		},
-		{
-			input: "An escaped \"newline\\\ninside\" quotes",
-			expected: []Token{
-				{Line: 1, Text: "An"},
-				{Line: 1, Text: "escaped"},
-				{Line: 1, Text: "newline\\\ninside"},
-				{Line: 2, Text: "quotes"},
-			},
-		},
-		{
-			input: "An escaped newline\\\noutside quotes",
-			expected: []Token{
-				{Line: 1, Text: "An"},
-				{Line: 1, Text: "escaped"},
-				{Line: 1, Text: "newline"},
-				{Line: 1, Text: "outside"},
-				{Line: 1, Text: "quotes"},
-			},
-		},
-		{
-			input: "line1\\\nescaped\nline2\nline3",
-			expected: []Token{
-				{Line: 1, Text: "line1"},
-				{Line: 1, Text: "escaped"},
-				{Line: 3, Text: "line2"},
-				{Line: 4, Text: "line3"},
-			},
-		},
-		{
-			input: "line1\\\nescaped1\\\nescaped2\nline4\nline5",
-			expected: []Token{
-				{Line: 1, Text: "line1"},
-				{Line: 1, Text: "escaped1"},
-				{Line: 1, Text: "escaped2"},
-				{Line: 4, Text: "line4"},
-				{Line: 5, Text: "line5"},
-			},
-		},
-		{
-			input: `"unescapable\ in quotes"`,
-			expected: []Token{
-				{Line: 1, Text: `unescapable\ in quotes`},
-			},
-		},
-		{
-			input: `"don't\escape"`,
-			expected: []Token{
-				{Line: 1, Text: `don't\escape`},
-			},
-		},
-		{
-			input: `"don't\\escape"`,
-			expected: []Token{
-				{Line: 1, Text: `don't\\escape`},
-			},
-		},
-		{
-			input: `un\escapable`,
-			expected: []Token{
-				{Line: 1, Text: `un\escapable`},
-			},
-		},
-		{
-			input: `A "quoted value with line
-					break inside" {
-						foobar
-					}`,
-			expected: []Token{
-				{Line: 1, Text: "A"},
-				{Line: 1, Text: "quoted value with line\n\t\t\t\t\tbreak inside"},
-				{Line: 2, Text: "{"},
-				{Line: 3, Text: "foobar"},
-				{Line: 4, Text: "}"},
-			},
-		},
-		{
-			input: `"C:\php\php-cgi.exe"`,
-			expected: []Token{
-				{Line: 1, Text: `C:\php\php-cgi.exe`},
-			},
-		},
-		{
-			input: `empty "" string`,
-			expected: []Token{
-				{Line: 1, Text: `empty`},
-				{Line: 1, Text: ``},
-				{Line: 1, Text: `string`},
-			},
-		},
-		{
-			input: "skip those\r\nCR characters",
-			expected: []Token{
-				{Line: 1, Text: "skip"},
-				{Line: 1, Text: "those"},
-				{Line: 2, Text: "CR"},
-				{Line: 2, Text: "characters"},
-			},
-		},
-		{
-			input: "\xEF\xBB\xBF:8080", // test with leading byte order mark
-			expected: []Token{
-				{Line: 1, Text: ":8080"},
-			},
-		},
-	}
-
-	for i, testCase := range testCases {
-		actual := tokenize(testCase.input)
-		lexerCompare(t, i, testCase.expected, actual)
-	}
-}
-
-func tokenize(input string) (tokens []Token) {
-	l := lexer{}
-	if err := l.load(strings.NewReader(input)); err != nil {
-		log.Printf("[ERROR] load failed: %v", err)
-	}
-	for l.next() {
-		tokens = append(tokens, l.token)
-	}
-	return
-}
-
-func lexerCompare(t *testing.T, n int, expected, actual []Token) {
-	if len(expected) != len(actual) {
-		t.Errorf("Test case %d: expected %d token(s) but got %d", n, len(expected), len(actual))
-	}
-
-	for i := 0; i < len(actual) && i < len(expected); i++ {
-		if actual[i].Line != expected[i].Line {
-			t.Errorf("Test case %d token %d ('%s'): expected line %d but was line %d",
-				n, i, expected[i].Text, expected[i].Line, actual[i].Line)
-			break
-		}
-		if actual[i].Text != expected[i].Text {
-			t.Errorf("Test case %d token %d: expected text '%s' but was '%s'",
-				n, i, expected[i].Text, actual[i].Text)
-			break
-		}
-	}
-}

caddyconfig/caddyfile/parse.go

@@ -1,536 +0,0 @@
-// Copyright 2015 Light Code Labs, LLC
-//
-// 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 caddyfile
-
-import (
-	"bytes"
-	"io/ioutil"
-	"log"
-	"os"
-	"path/filepath"
-	"strings"
-)
-
-// Parse parses the input just enough to group tokens, in
-// order, by server block. No further parsing is performed.
-// Server blocks are returned in the order in which they appear.
-// Directives that do not appear in validDirectives will cause
-// an error. If you do not want to check for valid directives,
-// pass in nil instead.
-//
-// Environment variables in {$ENVIRONMENT_VARIABLE} notation
-// will be replaced before parsing begins.
-func Parse(filename string, input []byte) ([]ServerBlock, error) {
-	tokens, err := allTokens(filename, input)
-	if err != nil {
-		return nil, err
-	}
-	p := parser{Dispenser: NewDispenser(tokens)}
-	return p.parseAll()
-}
-
-// replaceEnvVars replaces all occurrences of environment variables.
-func replaceEnvVars(input []byte) ([]byte, error) {
-	var offset int
-	for {
-		begin := bytes.Index(input[offset:], spanOpen)
-		if begin < 0 {
-			break
-		}
-		begin += offset // make beginning relative to input, not offset
-		end := bytes.Index(input[begin+len(spanOpen):], spanClose)
-		if end < 0 {
-			break
-		}
-		end += begin + len(spanOpen) // make end relative to input, not begin
-
-		// get the name; if there is no name, skip it
-		envVarName := input[begin+len(spanOpen) : end]
-		if len(envVarName) == 0 {
-			offset = end + len(spanClose)
-			continue
-		}
-
-		// get the value of the environment variable
-		envVarValue := []byte(os.ExpandEnv(os.Getenv(string(envVarName))))
-
-		// splice in the value
-		input = append(input[:begin],
-			append(envVarValue, input[end+len(spanClose):]...)...)
-
-		// continue at the end of the replacement
-		offset = begin + len(envVarValue)
-	}
-	return input, nil
-}
-
-// allTokens lexes the entire input, but does not parse it.
-// It returns all the tokens from the input, unstructured
-// and in order.
-func allTokens(filename string, input []byte) ([]Token, error) {
-	input, err := replaceEnvVars(input)
-	if err != nil {
-		return nil, err
-	}
-	l := new(lexer)
-	err = l.load(bytes.NewReader(input))
-	if err != nil {
-		return nil, err
-	}
-	var tokens []Token
-	for l.next() {
-		l.token.File = filename
-		tokens = append(tokens, l.token)
-	}
-	return tokens, nil
-}
-
-type parser struct {
-	*Dispenser
-	block           ServerBlock // current server block being parsed
-	eof             bool        // if we encounter a valid EOF in a hard place
-	definedSnippets map[string][]Token
-	nesting         int
-}
-
-func (p *parser) parseAll() ([]ServerBlock, error) {
-	var blocks []ServerBlock
-
-	for p.Next() {
-		err := p.parseOne()
-		if err != nil {
-			return blocks, err
-		}
-		if len(p.block.Keys) > 0 || len(p.block.Segments) > 0 {
-			blocks = append(blocks, p.block)
-		}
-		if p.nesting > 0 {
-			return blocks, p.EOFErr()
-		}
-	}
-
-	return blocks, nil
-}
-
-func (p *parser) parseOne() error {
-	p.block = ServerBlock{}
-	return p.begin()
-}
-
-func (p *parser) begin() error {
-	if len(p.tokens) == 0 {
-		return nil
-	}
-
-	err := p.addresses()
-
-	if err != nil {
-		return err
-	}
-
-	if p.eof {
-		// this happens if the Caddyfile consists of only
-		// a line of addresses and nothing else
-		return nil
-	}
-
-	if ok, name := p.isSnippet(); ok {
-		if p.definedSnippets == nil {
-			p.definedSnippets = map[string][]Token{}
-		}
-		if _, found := p.definedSnippets[name]; found {
-			return p.Errf("redeclaration of previously declared snippet %s", name)
-		}
-		// consume all tokens til matched close brace
-		tokens, err := p.snippetTokens()
-		if err != nil {
-			return err
-		}
-		p.definedSnippets[name] = tokens
-		// empty block keys so we don't save this block as a real server.
-		p.block.Keys = nil
-		return nil
-	}
-
-	return p.blockContents()
-}
-
-func (p *parser) addresses() error {
-	var expectingAnother bool
-
-	for {
-		tkn := p.Val()
-
-		// special case: import directive replaces tokens during parse-time
-		if tkn == "import" && p.isNewLine() {
-			err := p.doImport()
-			if err != nil {
-				return err
-			}
-			continue
-		}
-
-		// Open brace definitely indicates end of addresses
-		if tkn == "{" {
-			if expectingAnother {
-				return p.Errf("Expected another address but had '%s' - check for extra comma", tkn)
-			}
-			break
-		}
-
-		if tkn != "" { // empty token possible if user typed ""
-			// Trailing comma indicates another address will follow, which
-			// may possibly be on the next line
-			if tkn[len(tkn)-1] == ',' {
-				tkn = tkn[:len(tkn)-1]
-				expectingAnother = true
-			} else {
-				expectingAnother = false // but we may still see another one on this line
-			}
-
-			p.block.Keys = append(p.block.Keys, tkn)
-		}
-
-		// Advance token and possibly break out of loop or return error
-		hasNext := p.Next()
-		if expectingAnother && !hasNext {
-			return p.EOFErr()
-		}
-		if !hasNext {
-			p.eof = true
-			break // EOF
-		}
-		if !expectingAnother && p.isNewLine() {
-			break
-		}
-	}
-
-	return nil
-}
-
-func (p *parser) blockContents() error {
-	errOpenCurlyBrace := p.openCurlyBrace()
-	if errOpenCurlyBrace != nil {
-		// single-server configs don't need curly braces
-		p.cursor--
-	}
-
-	err := p.directives()
-	if err != nil {
-		return err
-	}
-
-	// only look for close curly brace if there was an opening
-	if errOpenCurlyBrace == nil {
-		err = p.closeCurlyBrace()
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// directives parses through all the lines for directives
-// and it expects the next token to be the first
-// directive. It goes until EOF or closing curly brace
-// which ends the server block.
-func (p *parser) directives() error {
-	for p.Next() {
-		// end of server block
-		if p.Val() == "}" {
-			// p.nesting has already been decremented
-			break
-		}
-
-		// special case: import directive replaces tokens during parse-time
-		if p.Val() == "import" {
-			err := p.doImport()
-			if err != nil {
-				return err
-			}
-			p.cursor-- // cursor is advanced when we continue, so roll back one more
-			continue
-		}
-
-		// normal case: parse a directive as a new segment
-		// (a "segment" is a line which starts with a directive
-		// and which ends at the end of the line or at the end of
-		// the block that is opened at the end of the line)
-		if err := p.directive(); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-// doImport swaps out the import directive and its argument
-// (a total of 2 tokens) with the tokens in the specified file
-// or globbing pattern. When the function returns, the cursor
-// is on the token before where the import directive was. In
-// other words, call Next() to access the first token that was
-// imported.
-func (p *parser) doImport() error {
-	// syntax checks
-	if !p.NextArg() {
-		return p.ArgErr()
-	}
-	importPattern := p.Val()
-	if importPattern == "" {
-		return p.Err("Import requires a non-empty filepath")
-	}
-	if p.NextArg() {
-		return p.Err("Import takes only one argument (glob pattern or file)")
-	}
-	// splice out the import directive and its argument (2 tokens total)
-	tokensBefore := p.tokens[:p.cursor-1]
-	tokensAfter := p.tokens[p.cursor+1:]
-	var importedTokens []Token
-
-	// first check snippets. That is a simple, non-recursive replacement
-	if p.definedSnippets != nil && p.definedSnippets[importPattern] != nil {
-		importedTokens = p.definedSnippets[importPattern]
-	} else {
-		// make path relative to the file of the _token_ being processed rather
-		// than current working directory (issue #867) and then use glob to get
-		// list of matching filenames
-		absFile, err := filepath.Abs(p.Dispenser.File())
-		if err != nil {
-			return p.Errf("Failed to get absolute path of file: %s: %v", p.Dispenser.File(), err)
-		}
-
-		var matches []string
-		var globPattern string
-		if !filepath.IsAbs(importPattern) {
-			globPattern = filepath.Join(filepath.Dir(absFile), importPattern)
-		} else {
-			globPattern = importPattern
-		}
-		if strings.Count(globPattern, "*") > 1 || strings.Count(globPattern, "?") > 1 ||
-			(strings.Contains(globPattern, "[") && strings.Contains(globPattern, "]")) {
-			// See issue #2096 - a pattern with many glob expansions can hang for too long
-			return p.Errf("Glob pattern may only contain one wildcard (*), but has others: %s", globPattern)
-		}
-		matches, err = filepath.Glob(globPattern)
-
-		if err != nil {
-			return p.Errf("Failed to use import pattern %s: %v", importPattern, err)
-		}
-		if len(matches) == 0 {
-			if strings.ContainsAny(globPattern, "*?[]") {
-				log.Printf("[WARNING] No files matching import glob pattern: %s", importPattern)
-			} else {
-				return p.Errf("File to import not found: %s", importPattern)
-			}
-		}
-
-		// collect all the imported tokens
-
-		for _, importFile := range matches {
-			newTokens, err := p.doSingleImport(importFile)
-			if err != nil {
-				return err
-			}
-			importedTokens = append(importedTokens, newTokens...)
-		}
-	}
-
-	// splice the imported tokens in the place of the import statement
-	// and rewind cursor so Next() will land on first imported token
-	p.tokens = append(tokensBefore, append(importedTokens, tokensAfter...)...)
-	p.cursor--
-
-	return nil
-}
-
-// doSingleImport lexes the individual file at importFile and returns
-// its tokens or an error, if any.
-func (p *parser) doSingleImport(importFile string) ([]Token, error) {
-	file, err := os.Open(importFile)
-	if err != nil {
-		return nil, p.Errf("Could not import %s: %v", importFile, err)
-	}
-	defer file.Close()
-
-	if info, err := file.Stat(); err != nil {
-		return nil, p.Errf("Could not import %s: %v", importFile, err)
-	} else if info.IsDir() {
-		return nil, p.Errf("Could not import %s: is a directory", importFile)
-	}
-
-	input, err := ioutil.ReadAll(file)
-	if err != nil {
-		return nil, p.Errf("Could not read imported file %s: %v", importFile, err)
-	}
-
-	importedTokens, err := allTokens(importFile, input)
-	if err != nil {
-		return nil, p.Errf("Could not read tokens while importing %s: %v", importFile, err)
-	}
-
-	// Tack the file path onto these tokens so errors show the imported file's name
-	// (we use full, absolute path to avoid bugs: issue #1892)
-	filename, err := filepath.Abs(importFile)
-	if err != nil {
-		return nil, p.Errf("Failed to get absolute path of file: %s: %v", importFile, err)
-	}
-	for i := 0; i < len(importedTokens); i++ {
-		importedTokens[i].File = filename
-	}
-
-	return importedTokens, nil
-}
-
-// directive collects tokens until the directive's scope
-// closes (either end of line or end of curly brace block).
-// It expects the currently-loaded token to be a directive
-// (or } that ends a server block). The collected tokens
-// are loaded into the current server block for later use
-// by directive setup functions.
-func (p *parser) directive() error {
-
-	// a segment is a list of tokens associated with this directive
-	var segment Segment
-
-	// the directive itself is appended as a relevant token
-	segment = append(segment, p.Token())
-
-	for p.Next() {
-		if p.Val() == "{" {
-			p.nesting++
-		} else if p.isNewLine() && p.nesting == 0 {
-			p.cursor-- // read too far
-			break
-		} else if p.Val() == "}" && p.nesting > 0 {
-			p.nesting--
-		} else if p.Val() == "}" && p.nesting == 0 {
-			return p.Err("Unexpected '}' because no matching opening brace")
-		} else if p.Val() == "import" && p.isNewLine() {
-			if err := p.doImport(); err != nil {
-				return err
-			}
-			p.cursor-- // cursor is advanced when we continue, so roll back one more
-			continue
-		}
-
-		segment = append(segment, p.Token())
-	}
-
-	p.block.Segments = append(p.block.Segments, segment)
-
-	if p.nesting > 0 {
-		return p.EOFErr()
-	}
-
-	return nil
-}
-
-// openCurlyBrace expects the current token to be an
-// opening curly brace. This acts like an assertion
-// because it returns an error if the token is not
-// a opening curly brace. It does NOT advance the token.
-func (p *parser) openCurlyBrace() error {
-	if p.Val() != "{" {
-		return p.SyntaxErr("{")
-	}
-	return nil
-}
-
-// closeCurlyBrace expects the current token to be
-// a closing curly brace. This acts like an assertion
-// because it returns an error if the token is not
-// a closing curly brace. It does NOT advance the token.
-func (p *parser) closeCurlyBrace() error {
-	if p.Val() != "}" {
-		return p.SyntaxErr("}")
-	}
-	return nil
-}
-
-func (p *parser) isSnippet() (bool, string) {
-	keys := p.block.Keys
-	// A snippet block is a single key with parens. Nothing else qualifies.
-	if len(keys) == 1 && strings.HasPrefix(keys[0], "(") && strings.HasSuffix(keys[0], ")") {
-		return true, strings.TrimSuffix(keys[0][1:], ")")
-	}
-	return false, ""
-}
-
-// read and store everything in a block for later replay.
-func (p *parser) snippetTokens() ([]Token, error) {
-	// snippet must have curlies.
-	err := p.openCurlyBrace()
-	if err != nil {
-		return nil, err
-	}
-	nesting := 1 // count our own nesting in snippets
-	tokens := []Token{}
-	for p.Next() {
-		if p.Val() == "}" {
-			nesting--
-			if nesting == 0 {
-				break
-			}
-		}
-		if p.Val() == "{" {
-			nesting++
-		}
-		tokens = append(tokens, p.tokens[p.cursor])
-	}
-	// make sure we're matched up
-	if nesting != 0 {
-		return nil, p.SyntaxErr("}")
-	}
-	return tokens, nil
-}
-
-// ServerBlock associates any number of keys from the
-// head of the server block with tokens, which are
-// grouped by segments.
-type ServerBlock struct {
-	Keys     []string
-	Segments []Segment
-}
-
-// DispenseDirective returns a dispenser that contains
-// all the tokens in the server block.
-func (sb ServerBlock) DispenseDirective(dir string) *Dispenser {
-	var tokens []Token
-	for _, seg := range sb.Segments {
-		if len(seg) > 0 && seg[0].Text == dir {
-			tokens = append(tokens, seg...)
-		}
-	}
-	return NewDispenser(tokens)
-}
-
-// Segment is a list of tokens which begins with a directive
-// and ends at the end of the directive (either at the end of
-// the line, or at the end of a block it opens).
-type Segment []Token
-
-// Directive returns the directive name for the segment.
-// The directive name is the text of the first token.
-func (s Segment) Directive() string {
-	if len(s) > 0 {
-		return s[0].Text
-	}
-	return ""
-}
-
-// spanOpen and spanClose are used to bound spans that
-// contain the name of an environment variable.
-var spanOpen, spanClose = []byte{'{', '$'}, []byte{'}'}

caddyconfig/caddyfile/parse_fuzz.go

@@ -1,32 +0,0 @@
-// 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.
-
-// +build gofuzz
-// +build gofuzz_libfuzzer
-
-package caddyfile
-
-func FuzzParseCaddyfile(data []byte) (score int) {
-	sb, err := Parse("Caddyfile", data)
-	if err != nil {
-		// if both an error is received and some ServerBlocks,
-		// then the parse was able to parse partially. Mark this
-		// result as interesting to push the fuzzer further through the parser.
-		if sb != nil && len(sb) > 0 {
-			return 1
-		}
-		return 0
-	}
-	return 1
-}

caddyconfig/caddyfile/parse_test.go

@@ -1,674 +0,0 @@
-// Copyright 2015 Light Code Labs, LLC
-//
-// 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 caddyfile
-
-import (
-	"bytes"
-	"io/ioutil"
-	"os"
-	"path/filepath"
-	"testing"
-)
-
-func TestAllTokens(t *testing.T) {
-	input := []byte("a b c\nd e")
-	expected := []string{"a", "b", "c", "d", "e"}
-	tokens, err := allTokens("TestAllTokens", input)
-
-	if err != nil {
-		t.Fatalf("Expected no error, got %v", err)
-	}
-	if len(tokens) != len(expected) {
-		t.Fatalf("Expected %d tokens, got %d", len(expected), len(tokens))
-	}
-
-	for i, val := range expected {
-		if tokens[i].Text != val {
-			t.Errorf("Token %d should be '%s' but was '%s'", i, val, tokens[i].Text)
-		}
-	}
-}
-
-func TestParseOneAndImport(t *testing.T) {
-	testParseOne := func(input string) (ServerBlock, error) {
-		p := testParser(input)
-		p.Next() // parseOne doesn't call Next() to start, so we must
-		err := p.parseOne()
-		return p.block, err
-	}
-
-	for i, test := range []struct {
-		input     string
-		shouldErr bool
-		keys      []string
-		numTokens []int // number of tokens to expect in each segment
-	}{
-		{`localhost`, false, []string{
-			"localhost",
-		}, []int{}},
-
-		{`localhost
-		  dir1`, false, []string{
-			"localhost",
-		}, []int{1}},
-
-		{`localhost:1234
-		  dir1 foo bar`, false, []string{
-			"localhost:1234",
-		}, []int{3},
-		},
-
-		{`localhost {
-		    dir1
-		  }`, false, []string{
-			"localhost",
-		}, []int{1}},
-
-		{`localhost:1234 {
-		    dir1 foo bar
-		    dir2
-		  }`, false, []string{
-			"localhost:1234",
-		}, []int{3, 1}},
-
-		{`http://localhost https://localhost
-		  dir1 foo bar`, false, []string{
-			"http://localhost",
-			"https://localhost",
-		}, []int{3}},
-
-		{`http://localhost https://localhost {
-		    dir1 foo bar
-		  }`, false, []string{
-			"http://localhost",
-			"https://localhost",
-		}, []int{3}},
-
-		{`http://localhost, https://localhost {
-		    dir1 foo bar
-		  }`, false, []string{
-			"http://localhost",
-			"https://localhost",
-		}, []int{3}},
-
-		{`http://localhost, {
-		  }`, true, []string{
-			"http://localhost",
-		}, []int{}},
-
-		{`host1:80, http://host2.com
-		  dir1 foo bar
-		  dir2 baz`, false, []string{
-			"host1:80",
-			"http://host2.com",
-		}, []int{3, 2}},
-
-		{`http://host1.com,
-		  http://host2.com,
-		  https://host3.com`, false, []string{
-			"http://host1.com",
-			"http://host2.com",
-			"https://host3.com",
-		}, []int{}},
-
-		{`http://host1.com:1234, https://host2.com
-		  dir1 foo {
-		    bar baz
-		  }
-		  dir2`, false, []string{
-			"http://host1.com:1234",
-			"https://host2.com",
-		}, []int{6, 1}},
-
-		{`127.0.0.1
-		  dir1 {
-		    bar baz
-		  }
-		  dir2 {
-		    foo bar
-		  }`, false, []string{
-			"127.0.0.1",
-		}, []int{5, 5}},
-
-		{`localhost
-		  dir1 {
-		    foo`, true, []string{
-			"localhost",
-		}, []int{3}},
-
-		{`localhost
-		  dir1 {
-		  }`, false, []string{
-			"localhost",
-		}, []int{3}},
-
-		{`localhost
-		  dir1 {
-		  } }`, true, []string{
-			"localhost",
-		}, []int{}},
-
-		{`localhost
-		  dir1 {
-		    nested {
-		      foo
-		    }
-		  }
-		  dir2 foo bar`, false, []string{
-			"localhost",
-		}, []int{7, 3}},
-
-		{``, false, []string{}, []int{}},
-
-		{`localhost
-		  dir1 arg1
-		  import testdata/import_test1.txt`, false, []string{
-			"localhost",
-		}, []int{2, 3, 1}},
-
-		{`import testdata/import_test2.txt`, false, []string{
-			"host1",
-		}, []int{1, 2}},
-
-		{`import testdata/import_test1.txt testdata/import_test2.txt`, true, []string{}, []int{}},
-
-		{`import testdata/not_found.txt`, true, []string{}, []int{}},
-
-		{`""`, false, []string{}, []int{}},
-
-		{``, false, []string{}, []int{}},
-
-		// test cases found by fuzzing!
-		{`import }{$"`, true, []string{}, []int{}},
-		{`import /*/*.txt`, true, []string{}, []int{}},
-		{`import /???/?*?o`, true, []string{}, []int{}},
-		{`import /??`, true, []string{}, []int{}},
-		{`import /[a-z]`, true, []string{}, []int{}},
-		{`import {$}`, true, []string{}, []int{}},
-		{`import {%}`, true, []string{}, []int{}},
-		{`import {$$}`, true, []string{}, []int{}},
-		{`import {%%}`, true, []string{}, []int{}},
-	} {
-		result, err := testParseOne(test.input)
-
-		if test.shouldErr && err == nil {
-			t.Errorf("Test %d: Expected an error, but didn't get one", i)
-		}
-		if !test.shouldErr && err != nil {
-			t.Errorf("Test %d: Expected no error, but got: %v", i, err)
-		}
-
-		if len(result.Keys) != len(test.keys) {
-			t.Errorf("Test %d: Expected %d keys, got %d",
-				i, len(test.keys), len(result.Keys))
-			continue
-		}
-		for j, addr := range result.Keys {
-			if addr != test.keys[j] {
-				t.Errorf("Test %d, key %d: Expected '%s', but was '%s'",
-					i, j, test.keys[j], addr)
-			}
-		}
-
-		if len(result.Segments) != len(test.numTokens) {
-			t.Errorf("Test %d: Expected %d segments, had %d",
-				i, len(test.numTokens), len(result.Segments))
-			continue
-		}
-
-		for j, seg := range result.Segments {
-			if len(seg) != test.numTokens[j] {
-				t.Errorf("Test %d, segment %d: Expected %d tokens, counted %d",
-					i, j, test.numTokens[j], len(seg))
-				continue
-			}
-		}
-	}
-}
-
-func TestRecursiveImport(t *testing.T) {
-	testParseOne := func(input string) (ServerBlock, error) {
-		p := testParser(input)
-		p.Next() // parseOne doesn't call Next() to start, so we must
-		err := p.parseOne()
-		return p.block, err
-	}
-
-	isExpected := func(got ServerBlock) bool {
-		if len(got.Keys) != 1 || got.Keys[0] != "localhost" {
-			t.Errorf("got keys unexpected: expect localhost, got %v", got.Keys)
-			return false
-		}
-		if len(got.Segments) != 2 {
-			t.Errorf("got wrong number of segments: expect 2, got %d", len(got.Segments))
-			return false
-		}
-		if len(got.Segments[0]) != 1 || len(got.Segments[1]) != 2 {
-			t.Errorf("got unexpected tokens: %v", got.Segments)
-			return false
-		}
-		return true
-	}
-
-	recursiveFile1, err := filepath.Abs("testdata/recursive_import_test1")
-	if err != nil {
-		t.Fatal(err)
-	}
-	recursiveFile2, err := filepath.Abs("testdata/recursive_import_test2")
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	// test relative recursive import
-	err = ioutil.WriteFile(recursiveFile1, []byte(
-		`localhost
-		dir1
-		import recursive_import_test2`), 0644)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.Remove(recursiveFile1)
-
-	err = ioutil.WriteFile(recursiveFile2, []byte("dir2 1"), 0644)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.Remove(recursiveFile2)
-
-	// import absolute path
-	result, err := testParseOne("import " + recursiveFile1)
-	if err != nil {
-		t.Fatal(err)
-	}
-	if !isExpected(result) {
-		t.Error("absolute+relative import failed")
-	}
-
-	// import relative path
-	result, err = testParseOne("import testdata/recursive_import_test1")
-	if err != nil {
-		t.Fatal(err)
-	}
-	if !isExpected(result) {
-		t.Error("relative+relative import failed")
-	}
-
-	// test absolute recursive import
-	err = ioutil.WriteFile(recursiveFile1, []byte(
-		`localhost
-		dir1
-		import `+recursiveFile2), 0644)
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	// import absolute path
-	result, err = testParseOne("import " + recursiveFile1)
-	if err != nil {
-		t.Fatal(err)
-	}
-	if !isExpected(result) {
-		t.Error("absolute+absolute import failed")
-	}
-
-	// import relative path
-	result, err = testParseOne("import testdata/recursive_import_test1")
-	if err != nil {
-		t.Fatal(err)
-	}
-	if !isExpected(result) {
-		t.Error("relative+absolute import failed")
-	}
-}
-
-func TestDirectiveImport(t *testing.T) {
-	testParseOne := func(input string) (ServerBlock, error) {
-		p := testParser(input)
-		p.Next() // parseOne doesn't call Next() to start, so we must
-		err := p.parseOne()
-		return p.block, err
-	}
-
-	isExpected := func(got ServerBlock) bool {
-		if len(got.Keys) != 1 || got.Keys[0] != "localhost" {
-			t.Errorf("got keys unexpected: expect localhost, got %v", got.Keys)
-			return false
-		}
-		if len(got.Segments) != 2 {
-			t.Errorf("got wrong number of segments: expect 2, got %d", len(got.Segments))
-			return false
-		}
-		if len(got.Segments[0]) != 1 || len(got.Segments[1]) != 8 {
-			t.Errorf("got unexpected tokens: %v", got.Segments)
-			return false
-		}
-		return true
-	}
-
-	directiveFile, err := filepath.Abs("testdata/directive_import_test")
-	if err != nil {
-		t.Fatal(err)
-	}
-
-	err = ioutil.WriteFile(directiveFile, []byte(`prop1 1
-	prop2 2`), 0644)
-	if err != nil {
-		t.Fatal(err)
-	}
-	defer os.Remove(directiveFile)
-
-	// import from existing file
-	result, err := testParseOne(`localhost
-	dir1
-	proxy {
-		import testdata/directive_import_test
-		transparent
-	}`)
-	if err != nil {
-		t.Fatal(err)
-	}
-	if !isExpected(result) {
-		t.Error("directive import failed")
-	}
-
-	// import from nonexistent file
-	_, err = testParseOne(`localhost
-	dir1
-	proxy {
-		import testdata/nonexistent_file
-		transparent
-	}`)
-	if err == nil {
-		t.Fatal("expected error when importing a nonexistent file")
-	}
-}
-
-func TestParseAll(t *testing.T) {
-	for i, test := range []struct {
-		input     string
-		shouldErr bool
-		keys      [][]string // keys per server block, in order
-	}{
-		{`localhost`, false, [][]string{
-			{"localhost"},
-		}},
-
-		{`localhost:1234`, false, [][]string{
-			{"localhost:1234"},
-		}},
-
-		{`localhost:1234 {
-		  }
-		  localhost:2015 {
-		  }`, false, [][]string{
-			{"localhost:1234"},
-			{"localhost:2015"},
-		}},
-
-		{`localhost:1234, http://host2`, false, [][]string{
-			{"localhost:1234", "http://host2"},
-		}},
-
-		{`localhost:1234, http://host2,`, true, [][]string{}},
-
-		{`http://host1.com, http://host2.com {
-		  }
-		  https://host3.com, https://host4.com {
-		  }`, false, [][]string{
-			{"http://host1.com", "http://host2.com"},
-			{"https://host3.com", "https://host4.com"},
-		}},
-
-		{`import testdata/import_glob*.txt`, false, [][]string{
-			{"glob0.host0"},
-			{"glob0.host1"},
-			{"glob1.host0"},
-			{"glob2.host0"},
-		}},
-
-		{`import notfound/*`, false, [][]string{}},        // glob needn't error with no matches
-		{`import notfound/file.conf`, true, [][]string{}}, // but a specific file should
-	} {
-		p := testParser(test.input)
-		blocks, err := p.parseAll()
-
-		if test.shouldErr && err == nil {
-			t.Errorf("Test %d: Expected an error, but didn't get one", i)
-		}
-		if !test.shouldErr && err != nil {
-			t.Errorf("Test %d: Expected no error, but got: %v", i, err)
-		}
-
-		if len(blocks) != len(test.keys) {
-			t.Errorf("Test %d: Expected %d server blocks, got %d",
-				i, len(test.keys), len(blocks))
-			continue
-		}
-		for j, block := range blocks {
-			if len(block.Keys) != len(test.keys[j]) {
-				t.Errorf("Test %d: Expected %d keys in block %d, got %d",
-					i, len(test.keys[j]), j, len(block.Keys))
-				continue
-			}
-			for k, addr := range block.Keys {
-				if addr != test.keys[j][k] {
-					t.Errorf("Test %d, block %d, key %d: Expected '%s', but got '%s'",
-						i, j, k, test.keys[j][k], addr)
-				}
-			}
-		}
-	}
-}
-
-func TestEnvironmentReplacement(t *testing.T) {
-	os.Setenv("FOOBAR", "foobar")
-
-	for i, test := range []struct {
-		input  string
-		expect string
-	}{
-		{
-			input:  "",
-			expect: "",
-		},
-		{
-			input:  "foo",
-			expect: "foo",
-		},
-		{
-			input:  "{$NOT_SET}",
-			expect: "",
-		},
-		{
-			input:  "foo{$NOT_SET}bar",
-			expect: "foobar",
-		},
-		{
-			input:  "{$FOOBAR}",
-			expect: "foobar",
-		},
-		{
-			input:  "foo {$FOOBAR} bar",
-			expect: "foo foobar bar",
-		},
-		{
-			input:  "foo{$FOOBAR}bar",
-			expect: "foofoobarbar",
-		},
-		{
-			input:  "foo\n{$FOOBAR}\nbar",
-			expect: "foo\nfoobar\nbar",
-		},
-		{
-			input:  "{$FOOBAR} {$FOOBAR}",
-			expect: "foobar foobar",
-		},
-		{
-			input:  "{$FOOBAR}{$FOOBAR}",
-			expect: "foobarfoobar",
-		},
-		{
-			input:  "{$FOOBAR",
-			expect: "{$FOOBAR",
-		},
-		{
-			input:  "{$LONGER_NAME $FOOBAR}",
-			expect: "",
-		},
-		{
-			input:  "{$}",
-			expect: "{$}",
-		},
-		{
-			input:  "{$$}",
-			expect: "",
-		},
-		{
-			input:  "{$",
-			expect: "{$",
-		},
-		{
-			input:  "}{$",
-			expect: "}{$",
-		},
-	} {
-		actual, err := replaceEnvVars([]byte(test.input))
-		if err != nil {
-			t.Fatal(err)
-		}
-		if !bytes.Equal(actual, []byte(test.expect)) {
-			t.Errorf("Test %d: Expected: '%s' but got '%s'", i, test.expect, actual)
-		}
-	}
-}
-
-func TestSnippets(t *testing.T) {
-	p := testParser(`
-		(common) {
-			gzip foo
-			errors stderr
-		}
-		http://example.com {
-			import common
-		}
-	`)
-	blocks, err := p.parseAll()
-	if err != nil {
-		t.Fatal(err)
-	}
-	for _, b := range blocks {
-		t.Log(b.Keys)
-		t.Log(b.Segments)
-	}
-	if len(blocks) != 1 {
-		t.Fatalf("Expect exactly one server block. Got %d.", len(blocks))
-	}
-	if actual, expected := blocks[0].Keys[0], "http://example.com"; expected != actual {
-		t.Errorf("Expected server name to be '%s' but was '%s'", expected, actual)
-	}
-	if len(blocks[0].Segments) != 2 {
-		t.Fatalf("Server block should have tokens from import, got: %+v", blocks[0])
-	}
-	if actual, expected := blocks[0].Segments[0][0].Text, "gzip"; expected != actual {
-		t.Errorf("Expected argument to be '%s' but was '%s'", expected, actual)
-	}
-	if actual, expected := blocks[0].Segments[1][1].Text, "stderr"; expected != actual {
-		t.Errorf("Expected argument to be '%s' but was '%s'", expected, actual)
-	}
-}
-
-func writeStringToTempFileOrDie(t *testing.T, str string) (pathToFile string) {
-	file, err := ioutil.TempFile("", t.Name())
-	if err != nil {
-		panic(err) // get a stack trace so we know where this was called from.
-	}
-	if _, err := file.WriteString(str); err != nil {
-		panic(err)
-	}
-	if err := file.Close(); err != nil {
-		panic(err)
-	}
-	return file.Name()
-}
-
-func TestImportedFilesIgnoreNonDirectiveImportTokens(t *testing.T) {
-	fileName := writeStringToTempFileOrDie(t, `
-		http://example.com {
-			# This isn't an import directive, it's just an arg with value 'import'
-			basicauth / import password
-		}
-	`)
-	// Parse the root file that imports the other one.
-	p := testParser(`import ` + fileName)
-	blocks, err := p.parseAll()
-	if err != nil {
-		t.Fatal(err)
-	}
-	for _, b := range blocks {
-		t.Log(b.Keys)
-		t.Log(b.Segments)
-	}
-	auth := blocks[0].Segments[0]
-	line := auth[0].Text + " " + auth[1].Text + " " + auth[2].Text + " " + auth[3].Text
-	if line != "basicauth / import password" {
-		// Previously, it would be changed to:
-		//   basicauth / import /path/to/test/dir/password
-		// referencing a file that (probably) doesn't exist and changing the
-		// password!
-		t.Errorf("Expected basicauth tokens to be 'basicauth / import password' but got %#q", line)
-	}
-}
-
-func TestSnippetAcrossMultipleFiles(t *testing.T) {
-	// Make the derived Caddyfile that expects (common) to be defined.
-	fileName := writeStringToTempFileOrDie(t, `
-		http://example.com {
-			import common
-		}
-	`)
-
-	// Parse the root file that defines (common) and then imports the other one.
-	p := testParser(`
-		(common) {
-			gzip foo
-		}
-		import ` + fileName + `
-	`)
-
-	blocks, err := p.parseAll()
-	if err != nil {
-		t.Fatal(err)
-	}
-	for _, b := range blocks {
-		t.Log(b.Keys)
-		t.Log(b.Segments)
-	}
-	if len(blocks) != 1 {
-		t.Fatalf("Expect exactly one server block. Got %d.", len(blocks))
-	}
-	if actual, expected := blocks[0].Keys[0], "http://example.com"; expected != actual {
-		t.Errorf("Expected server name to be '%s' but was '%s'", expected, actual)
-	}
-	if len(blocks[0].Segments) != 1 {
-		t.Fatalf("Server block should have tokens from import")
-	}
-	if actual, expected := blocks[0].Segments[0][0].Text, "gzip"; expected != actual {
-		t.Errorf("Expected argument to be '%s' but was '%s'", expected, actual)
-	}
-}
-
-func testParser(input string) parser {
-	return parser{Dispenser: newTestDispenser(input)}
-}

caddyconfig/caddyfile/testdata/import_glob0.txt

@@ -1,6 +0,0 @@
-glob0.host0 {
-	dir2 arg1
-}
-
-glob0.host1 {
-}

caddyconfig/caddyfile/testdata/import_glob1.txt

@@ -1,4 +0,0 @@
-glob1.host0 {
-	dir1
-	dir2 arg1
-}

caddyconfig/caddyfile/testdata/import_glob2.txt

@@ -1,3 +0,0 @@
-glob2.host0 {
-	dir2 arg1
-}

caddyconfig/caddyfile/testdata/import_test1.txt

@@ -1,2 +0,0 @@
-dir2 arg1 arg2
-dir3

caddyconfig/caddyfile/testdata/import_test2.txt

@@ -1,4 +0,0 @@
-host1 {
-	dir1
-	dir2 arg1
-}

caddyconfig/configadapters.go

@@ -1,136 +0,0 @@
-// 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 caddyconfig
-
-import (
-	"encoding/json"
-	"fmt"
-
-	"github.com/caddyserver/caddy/v2"
-)
-
-// Adapter is a type which can adapt a configuration to Caddy JSON.
-// It returns the results and any warnings, or an error.
-type Adapter interface {
-	Adapt(body []byte, options map[string]interface{}) ([]byte, []Warning, error)
-}
-
-// Warning represents a warning or notice related to conversion.
-type Warning struct {
-	File      string `json:"file,omitempty"`
-	Line      int    `json:"line,omitempty"`
-	Directive string `json:"directive,omitempty"`
-	Message   string `json:"message,omitempty"`
-}
-
-// JSON encodes val as JSON, returning it as a json.RawMessage. Any
-// marshaling errors (which are highly unlikely with correct code)
-// are converted to warnings. This is convenient when filling config
-// structs that require a json.RawMessage, without having to worry
-// about errors.
-func JSON(val interface{}, warnings *[]Warning) json.RawMessage {
-	b, err := json.Marshal(val)
-	if err != nil {
-		if warnings != nil {
-			*warnings = append(*warnings, Warning{Message: err.Error()})
-		}
-		return nil
-	}
-	return b
-}
-
-// JSONModuleObject is like JSON, except it marshals val into a JSON object
-// and then adds a key to that object named fieldName with the value fieldVal.
-// This is useful for JSON-encoding module values where the module name has to
-// be described within the object by a certain key; for example,
-// "responder": "file_server" for a file server HTTP responder. The val must
-// encode into a map[string]interface{} (i.e. it must be a struct or map),
-// and any errors are converted into warnings, so this can be conveniently
-// used when filling a struct. For correct code, there should be no errors.
-func JSONModuleObject(val interface{}, fieldName, fieldVal string, warnings *[]Warning) json.RawMessage {
-	// encode to a JSON object first
-	enc, err := json.Marshal(val)
-	if err != nil {
-		if warnings != nil {
-			*warnings = append(*warnings, Warning{Message: err.Error()})
-		}
-		return nil
-	}
-
-	// then decode the object
-	var tmp map[string]interface{}
-	err = json.Unmarshal(enc, &tmp)
-	if err != nil {
-		if warnings != nil {
-			*warnings = append(*warnings, Warning{Message: err.Error()})
-		}
-		return nil
-	}
-
-	// so we can easily add the module's field with its appointed value
-	tmp[fieldName] = fieldVal
-
-	// then re-marshal as JSON
-	result, err := json.Marshal(tmp)
-	if err != nil {
-		if warnings != nil {
-			*warnings = append(*warnings, Warning{Message: err.Error()})
-		}
-		return nil
-	}
-
-	return result
-}
-
-// JSONIndent is used to JSON-marshal the final resulting Caddy
-// configuration in a consistent, human-readable way.
-func JSONIndent(val interface{}) ([]byte, error) {
-	return json.MarshalIndent(val, "", "\t")
-}
-
-// RegisterAdapter registers a config adapter with the given name.
-// This should usually be done at init-time.
-func RegisterAdapter(name string, adapter Adapter) error {
-	if _, ok := configAdapters[name]; ok {
-		return fmt.Errorf("%s: already registered", name)
-	}
-	configAdapters[name] = adapter
-	return caddy.RegisterModule(adapterModule{name, adapter})
-}
-
-// GetAdapter returns the adapter with the given name,
-// or nil if one with that name is not registered.
-func GetAdapter(name string) Adapter {
-	return configAdapters[name]
-}
-
-// adapterModule is a wrapper type that can turn any config
-// adapter into a Caddy module, which has the benefit of being
-// counted with other modules, even though they do not
-// technically extend the Caddy configuration structure.
-// See caddyserver/caddy#3132.
-type adapterModule struct {
-	name string
-	Adapter
-}
-
-func (am adapterModule) CaddyModule() caddy.ModuleInfo {
-	return caddy.ModuleInfo{
-		ID:  caddy.ModuleID("caddy.adapters." + am.name),
-		New: func() caddy.Module { return am },
-	}
-}
-
-var configAdapters = make(map[string]Adapter)

caddyconfig/httpcaddyfile/addresses.go

@@ -1,353 +0,0 @@
-// 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 httpcaddyfile
-
-import (
-	"fmt"
-	"net"
-	"reflect"
-	"strconv"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
-	"github.com/caddyserver/certmagic"
-)
-
-// mapAddressToServerBlocks returns a map of listener address to list of server
-// blocks that will be served on that address. To do this, each server block is
-// expanded so that each one is considered individually, although keys of a
-// server block that share the same address stay grouped together so the config
-// isn't repeated unnecessarily. For example, this Caddyfile:
-//
-// 	example.com {
-// 		bind 127.0.0.1
-// 	}
-// 	www.example.com, example.net/path, localhost:9999 {
-// 		bind 127.0.0.1 1.2.3.4
-// 	}
-//
-// has two server blocks to start with. But expressed in this Caddyfile are
-// actually 4 listener addresses: 127.0.0.1:443, 1.2.3.4:443, 127.0.0.1:9999,
-// and 127.0.0.1:9999. This is because the bind directive is applied to each
-// key of its server block (specifying the host part), and each key may have
-// a different port. And we definitely need to be sure that a site which is
-// bound to be served on a specific interface is not served on others just
-// because that is more convenient: it would be a potential security risk
-// if the difference between interfaces means private vs. public.
-//
-// So what this function does for the example above is iterate each server
-// block, and for each server block, iterate its keys. For the first, it
-// finds one key (example.com) and determines its listener address
-// (127.0.0.1:443 - because of 'bind' and automatic HTTPS). It then adds
-// the listener address to the map value returned by this function, with
-// the first server block as one of its associations.
-//
-// It then iterates each key on the second server block and associates them
-// with one or more listener addresses. Indeed, each key in this block has
-// two listener addresses because of the 'bind' directive. Once we know
-// which addresses serve which keys, we can create a new server block for
-// each address containing the contents of the server block and only those
-// specific keys of the server block which use that address.
-//
-// It is possible and even likely that some keys in the returned map have
-// the exact same list of server blocks (i.e. they are identical). This
-// happens when multiple hosts are declared with a 'bind' directive and
-// the resulting listener addresses are not shared by any other server
-// block (or the other server blocks are exactly identical in their token
-// contents). This happens with our example above because 1.2.3.4:443
-// and 1.2.3.4:9999 are used exclusively with the second server block. This
-// repetition may be undesirable, so call consolidateAddrMappings() to map
-// multiple addresses to the same lists of server blocks (a many:many mapping).
-// (Doing this is essentially a map-reduce technique.)
-func (st *ServerType) mapAddressToServerBlocks(originalServerBlocks []serverBlock,
-	options map[string]interface{}) (map[string][]serverBlock, error) {
-	sbmap := make(map[string][]serverBlock)
-
-	for i, sblock := range originalServerBlocks {
-		// within a server block, we need to map all the listener addresses
-		// implied by the server block to the keys of the server block which
-		// will be served by them; this has the effect of treating each
-		// key of a server block as its own, but without having to repeat its
-		// contents in cases where multiple keys really can be served together
-		addrToKeys := make(map[string][]string)
-		for j, key := range sblock.block.Keys {
-			// a key can have multiple listener addresses if there are multiple
-			// arguments to the 'bind' directive (although they will all have
-			// the same port, since the port is defined by the key or is implicit
-			// through automatic HTTPS)
-			addrs, err := st.listenerAddrsForServerBlockKey(sblock, key, options)
-			if err != nil {
-				return nil, fmt.Errorf("server block %d, key %d (%s): determining listener address: %v", i, j, key, err)
-			}
-
-			// associate this key with each listener address it is served on
-			for _, addr := range addrs {
-				addrToKeys[addr] = append(addrToKeys[addr], key)
-			}
-		}
-
-		// now that we know which addresses serve which keys of this
-		// server block, we iterate that mapping and create a list of
-		// new server blocks for each address where the keys of the
-		// server block are only the ones which use the address; but
-		// the contents (tokens) are of course the same
-		for addr, keys := range addrToKeys {
-			sbmap[addr] = append(sbmap[addr], serverBlock{
-				block: caddyfile.ServerBlock{
-					Keys:     keys,
-					Segments: sblock.block.Segments,
-				},
-				pile: sblock.pile,
-			})
-		}
-	}
-
-	return sbmap, nil
-}
-
-// consolidateAddrMappings eliminates repetition of identical server blocks in a mapping of
-// single listener addresses to lists of server blocks. Since multiple addresses may serve
-// identical sites (server block contents), this function turns a 1:many mapping into a
-// many:many mapping. Server block contents (tokens) must be exactly identical so that
-// reflect.DeepEqual returns true in order for the addresses to be combined. Identical
-// entries are deleted from the addrToServerBlocks map. Essentially, each pairing (each
-// association from multiple addresses to multiple server blocks; i.e. each element of
-// the returned slice) becomes a server definition in the output JSON.
-func (st *ServerType) consolidateAddrMappings(addrToServerBlocks map[string][]serverBlock) []sbAddrAssociation {
-	var sbaddrs []sbAddrAssociation
-	for addr, sblocks := range addrToServerBlocks {
-		// we start with knowing that at least this address
-		// maps to these server blocks
-		a := sbAddrAssociation{
-			addresses:    []string{addr},
-			serverBlocks: sblocks,
-		}
-
-		// now find other addresses that map to identical
-		// server blocks and add them to our list of
-		// addresses, while removing them from the map
-		for otherAddr, otherSblocks := range addrToServerBlocks {
-			if addr == otherAddr {
-				continue
-			}
-			if reflect.DeepEqual(sblocks, otherSblocks) {
-				a.addresses = append(a.addresses, otherAddr)
-				delete(addrToServerBlocks, otherAddr)
-			}
-		}
-
-		sbaddrs = append(sbaddrs, a)
-	}
-	return sbaddrs
-}
-
-func (st *ServerType) listenerAddrsForServerBlockKey(sblock serverBlock, key string,
-	options map[string]interface{}) ([]string, error) {
-	addr, err := ParseAddress(key)
-	if err != nil {
-		return nil, fmt.Errorf("parsing key: %v", err)
-	}
-	addr = addr.Normalize()
-
-	// figure out the HTTP and HTTPS ports; either
-	// use defaults, or override with user config
-	httpPort, httpsPort := strconv.Itoa(certmagic.HTTPPort), strconv.Itoa(certmagic.HTTPSPort)
-	if hport, ok := options["http_port"]; ok {
-		httpPort = strconv.Itoa(hport.(int))
-	}
-	if hsport, ok := options["https_port"]; ok {
-		httpsPort = strconv.Itoa(hsport.(int))
-	}
-
-	// default port is the HTTPS port
-	lnPort := httpsPort
-	if addr.Port != "" {
-		// port explicitly defined
-		lnPort = addr.Port
-	} else if addr.Scheme == "http" {
-		// port inferred from scheme
-		lnPort = httpPort
-	}
-
-	// error if scheme and port combination violate convention
-	if (addr.Scheme == "http" && lnPort == httpsPort) || (addr.Scheme == "https" && lnPort == httpPort) {
-		return nil, fmt.Errorf("[%s] scheme and port violate convention", key)
-	}
-
-	// the bind directive specifies hosts, but is optional
-	var lnHosts []string
-	for _, cfgVal := range sblock.pile["bind"] {
-		lnHosts = append(lnHosts, cfgVal.Value.([]string)...)
-	}
-	if len(lnHosts) == 0 {
-		lnHosts = []string{""}
-	}
-
-	// use a map to prevent duplication
-	listeners := make(map[string]struct{})
-	for _, host := range lnHosts {
-		addr, err := caddy.ParseNetworkAddress(host)
-		if err == nil && addr.IsUnixNetwork() {
-			listeners[host] = struct{}{}
-		} else {
-			listeners[net.JoinHostPort(host, lnPort)] = struct{}{}
-		}
-	}
-
-	// now turn map into list
-	var listenersList []string
-	for lnStr := range listeners {
-		listenersList = append(listenersList, lnStr)
-	}
-
-	return listenersList, nil
-}
-
-// Address represents a site address. It contains
-// the original input value, and the component
-// parts of an address. The component parts may be
-// updated to the correct values as setup proceeds,
-// but the original value should never be changed.
-//
-// The Host field must be in a normalized form.
-type Address struct {
-	Original, Scheme, Host, Port, Path string
-}
-
-// ParseAddress parses an address string into a structured format with separate
-// scheme, host, port, and path portions, as well as the original input string.
-func ParseAddress(str string) (Address, error) {
-	const maxLen = 4096
-	if len(str) > maxLen {
-		str = str[:maxLen]
-	}
-	remaining := strings.TrimSpace(str)
-	a := Address{Original: remaining}
-
-	// extract scheme
-	splitScheme := strings.SplitN(remaining, "://", 2)
-	switch len(splitScheme) {
-	case 0:
-		return a, nil
-	case 1:
-		remaining = splitScheme[0]
-	case 2:
-		a.Scheme = splitScheme[0]
-		remaining = splitScheme[1]
-	}
-
-	// extract host and port
-	hostSplit := strings.SplitN(remaining, "/", 2)
-	if len(hostSplit) > 0 {
-		host, port, err := net.SplitHostPort(hostSplit[0])
-		if err != nil {
-			host, port, err = net.SplitHostPort(hostSplit[0] + ":")
-			if err != nil {
-				host = hostSplit[0]
-			}
-		}
-		a.Host = host
-		a.Port = port
-	}
-	if len(hostSplit) == 2 {
-		// all that remains is the path
-		a.Path = "/" + hostSplit[1]
-	}
-
-	// make sure port is valid
-	if a.Port != "" {
-		if portNum, err := strconv.Atoi(a.Port); err != nil {
-			return Address{}, fmt.Errorf("invalid port '%s': %v", a.Port, err)
-		} else if portNum < 0 || portNum > 65535 {
-			return Address{}, fmt.Errorf("port %d is out of range", portNum)
-		}
-	}
-
-	return a, nil
-}
-
-// String returns a human-readable form of a. It will
-// be a cleaned-up and filled-out URL string.
-func (a Address) String() string {
-	if a.Host == "" && a.Port == "" {
-		return ""
-	}
-	scheme := a.Scheme
-	if scheme == "" {
-		if a.Port == strconv.Itoa(certmagic.HTTPSPort) {
-			scheme = "https"
-		} else {
-			scheme = "http"
-		}
-	}
-	s := scheme
-	if s != "" {
-		s += "://"
-	}
-	if a.Port != "" &&
-		((scheme == "https" && a.Port != strconv.Itoa(caddyhttp.DefaultHTTPSPort)) ||
-			(scheme == "http" && a.Port != strconv.Itoa(caddyhttp.DefaultHTTPPort))) {
-		s += net.JoinHostPort(a.Host, a.Port)
-	} else {
-		s += a.Host
-	}
-	if a.Path != "" {
-		s += a.Path
-	}
-	return s
-}
-
-// Normalize returns a normalized version of a.
-func (a Address) Normalize() Address {
-	path := a.Path
-
-	// ensure host is normalized if it's an IP address
-	host := strings.TrimSpace(a.Host)
-	if ip := net.ParseIP(host); ip != nil {
-		host = ip.String()
-	}
-
-	return Address{
-		Original: a.Original,
-		Scheme:   strings.ToLower(a.Scheme),
-		Host:     strings.ToLower(host),
-		Port:     a.Port,
-		Path:     path,
-	}
-}
-
-// Key returns a string form of a, much like String() does, but this
-// method doesn't add anything default that wasn't in the original.
-func (a Address) Key() string {
-	res := ""
-	if a.Scheme != "" {
-		res += a.Scheme + "://"
-	}
-	if a.Host != "" {
-		res += a.Host
-	}
-	// insert port only if the original has its own explicit port
-	if a.Port != "" &&
-		len(a.Original) >= len(res) &&
-		strings.HasPrefix(a.Original[len(res):], ":"+a.Port) {
-		res += ":" + a.Port
-	}
-	if a.Path != "" {
-		res += a.Path
-	}
-	return res
-}

caddyconfig/httpcaddyfile/addresses_fuzz.go

@@ -1,29 +0,0 @@
-// 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.
-
-// +build gofuzz
-// +build gofuzz_libfuzzer
-
-package httpcaddyfile
-
-func FuzzParseAddress(data []byte) int {
-	addr, err := ParseAddress(string(data))
-	if err != nil {
-		if addr == (Address{}) {
-			return 1
-		}
-		return 0
-	}
-	return 1
-}

caddyconfig/httpcaddyfile/addresses_test.go

@@ -1,163 +0,0 @@
-package httpcaddyfile
-
-import (
-	"testing"
-)
-
-func TestParseAddress(t *testing.T) {
-	for i, test := range []struct {
-		input                    string
-		scheme, host, port, path string
-		shouldErr                bool
-	}{
-		{``, "", "", "", "", false},
-		{`localhost`, "", "localhost", "", "", false},
-		{`localhost:1234`, "", "localhost", "1234", "", false},
-		{`localhost:`, "", "localhost", "", "", false},
-		{`0.0.0.0`, "", "0.0.0.0", "", "", false},
-		{`127.0.0.1:1234`, "", "127.0.0.1", "1234", "", false},
-		{`:1234`, "", "", "1234", "", false},
-		{`[::1]`, "", "::1", "", "", false},
-		{`[::1]:1234`, "", "::1", "1234", "", false},
-		{`:`, "", "", "", "", false},
-		{`:http`, "", "", "", "", true},
-		{`:https`, "", "", "", "", true},
-		{`localhost:http`, "", "", "", "", true}, // using service name in port is verboten, as of Go 1.12.8
-		{`localhost:https`, "", "", "", "", true},
-		{`http://localhost:https`, "", "", "", "", true}, // conflict
-		{`http://localhost:http`, "", "", "", "", true},  // repeated scheme
-		{`host:https/path`, "", "", "", "", true},
-		{`http://localhost:443`, "http", "localhost", "443", "", false}, // NOTE: not conventional
-		{`https://localhost:80`, "https", "localhost", "80", "", false}, // NOTE: not conventional
-		{`http://localhost`, "http", "localhost", "", "", false},
-		{`https://localhost`, "https", "localhost", "", "", false},
-		{`http://{env.APP_DOMAIN}`, "http", "{env.APP_DOMAIN}", "", "", false},
-		{`{env.APP_DOMAIN}:80`, "", "{env.APP_DOMAIN}", "80", "", false},
-		{`{env.APP_DOMAIN}/path`, "", "{env.APP_DOMAIN}", "", "/path", false},
-		{`example.com/{env.APP_PATH}`, "", "example.com", "", "/{env.APP_PATH}", false},
-		{`http://127.0.0.1`, "http", "127.0.0.1", "", "", false},
-		{`https://127.0.0.1`, "https", "127.0.0.1", "", "", false},
-		{`http://[::1]`, "http", "::1", "", "", false},
-		{`http://localhost:1234`, "http", "localhost", "1234", "", false},
-		{`https://127.0.0.1:1234`, "https", "127.0.0.1", "1234", "", false},
-		{`http://[::1]:1234`, "http", "::1", "1234", "", false},
-		{``, "", "", "", "", false},
-		{`::1`, "", "::1", "", "", false},
-		{`localhost::`, "", "localhost::", "", "", false},
-		{`#$%@`, "", "#$%@", "", "", false}, // don't want to presume what the hostname could be
-		{`host/path`, "", "host", "", "/path", false},
-		{`http://host/`, "http", "host", "", "/", false},
-		{`//asdf`, "", "", "", "//asdf", false},
-		{`:1234/asdf`, "", "", "1234", "/asdf", false},
-		{`http://host/path`, "http", "host", "", "/path", false},
-		{`https://host:443/path/foo`, "https", "host", "443", "/path/foo", false},
-		{`host:80/path`, "", "host", "80", "/path", false},
-		{`/path`, "", "", "", "/path", false},
-	} {
-		actual, err := ParseAddress(test.input)
-
-		if err != nil && !test.shouldErr {
-			t.Errorf("Test %d (%s): Expected no error, but had error: %v", i, test.input, err)
-		}
-		if err == nil && test.shouldErr {
-			t.Errorf("Test %d (%s): Expected error, but had none (%#v)", i, test.input, actual)
-		}
-
-		if !test.shouldErr && actual.Original != test.input {
-			t.Errorf("Test %d (%s): Expected original '%s', got '%s'", i, test.input, test.input, actual.Original)
-		}
-		if actual.Scheme != test.scheme {
-			t.Errorf("Test %d (%s): Expected scheme '%s', got '%s'", i, test.input, test.scheme, actual.Scheme)
-		}
-		if actual.Host != test.host {
-			t.Errorf("Test %d (%s): Expected host '%s', got '%s'", i, test.input, test.host, actual.Host)
-		}
-		if actual.Port != test.port {
-			t.Errorf("Test %d (%s): Expected port '%s', got '%s'", i, test.input, test.port, actual.Port)
-		}
-		if actual.Path != test.path {
-			t.Errorf("Test %d (%s): Expected path '%s', got '%s'", i, test.input, test.path, actual.Path)
-		}
-	}
-}
-
-func TestAddressString(t *testing.T) {
-	for i, test := range []struct {
-		addr     Address
-		expected string
-	}{
-		{Address{Scheme: "http", Host: "host", Port: "1234", Path: "/path"}, "http://host:1234/path"},
-		{Address{Scheme: "", Host: "host", Port: "", Path: ""}, "http://host"},
-		{Address{Scheme: "", Host: "host", Port: "80", Path: ""}, "http://host"},
-		{Address{Scheme: "", Host: "host", Port: "443", Path: ""}, "https://host"},
-		{Address{Scheme: "https", Host: "host", Port: "443", Path: ""}, "https://host"},
-		{Address{Scheme: "https", Host: "host", Port: "", Path: ""}, "https://host"},
-		{Address{Scheme: "", Host: "host", Port: "80", Path: "/path"}, "http://host/path"},
-		{Address{Scheme: "http", Host: "", Port: "1234", Path: ""}, "http://:1234"},
-		{Address{Scheme: "", Host: "", Port: "", Path: ""}, ""},
-	} {
-		actual := test.addr.String()
-		if actual != test.expected {
-			t.Errorf("Test %d: expected '%s' but got '%s'", i, test.expected, actual)
-		}
-	}
-}
-
-func TestKeyNormalization(t *testing.T) {
-	testCases := []struct {
-		input  string
-		expect string
-	}{
-		{
-			input:  "http://host:1234/path",
-			expect: "http://host:1234/path",
-		},
-		{
-			input:  "HTTP://A/ABCDEF",
-			expect: "http://a/ABCDEF",
-		},
-		{
-			input:  "A/ABCDEF",
-			expect: "a/ABCDEF",
-		},
-		{
-			input:  "A:2015/Path",
-			expect: "a:2015/Path",
-		},
-		{
-			input:  ":80",
-			expect: ":80",
-		},
-		{
-			input:  ":443",
-			expect: ":443",
-		},
-		{
-			input:  ":1234",
-			expect: ":1234",
-		},
-		{
-			input:  "",
-			expect: "",
-		},
-		{
-			input:  ":",
-			expect: "",
-		},
-		{
-			input:  "[::]",
-			expect: "::",
-		},
-	}
-	for i, tc := range testCases {
-		addr, err := ParseAddress(tc.input)
-		if err != nil {
-			t.Errorf("Test %d: Parsing address '%s': %v", i, tc.input, err)
-			continue
-		}
-		if actual := addr.Normalize().Key(); actual != tc.expect {
-			t.Errorf("Test %d: Normalized key for address '%s' was '%s' but expected '%s'", i, tc.input, actual, tc.expect)
-		}
-
-	}
-}

caddyconfig/httpcaddyfile/builtins.go

@@ -1,555 +0,0 @@
-// 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 httpcaddyfile
-
-import (
-	"fmt"
-	"html"
-	"net/http"
-	"reflect"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-	"go.uber.org/zap/zapcore"
-)
-
-func init() {
-	RegisterDirective("bind", parseBind)
-	RegisterDirective("tls", parseTLS)
-	RegisterHandlerDirective("root", parseRoot)
-	RegisterHandlerDirective("redir", parseRedir)
-	RegisterHandlerDirective("respond", parseRespond)
-	RegisterHandlerDirective("route", parseRoute)
-	RegisterHandlerDirective("handle", parseHandle)
-	RegisterDirective("handle_errors", parseHandleErrors)
-	RegisterDirective("log", parseLog)
-}
-
-// parseBind parses the bind directive. Syntax:
-//
-//     bind <addresses...>
-//
-func parseBind(h Helper) ([]ConfigValue, error) {
-	var lnHosts []string
-	for h.Next() {
-		lnHosts = append(lnHosts, h.RemainingArgs()...)
-	}
-	return h.NewBindAddresses(lnHosts), nil
-}
-
-// parseTLS parses the tls directive. Syntax:
-//
-//     tls [<email>|internal]|[<cert_file> <key_file>] {
-//         protocols <min> [<max>]
-//         ciphers   <cipher_suites...>
-//         curves    <curves...>
-//         alpn      <values...>
-//         load      <paths...>
-//         ca        <acme_ca_endpoint>
-//         ca_root   <pem_file>
-//         dns       <provider_name>
-//         on_demand
-//     }
-//
-func parseTLS(h Helper) ([]ConfigValue, error) {
-	cp := new(caddytls.ConnectionPolicy)
-	var fileLoader caddytls.FileLoader
-	var folderLoader caddytls.FolderLoader
-	var acmeIssuer *caddytls.ACMEIssuer
-	var internalIssuer *caddytls.InternalIssuer
-	var onDemand bool
-
-	for h.Next() {
-		// file certificate loader
-		firstLine := h.RemainingArgs()
-		switch len(firstLine) {
-		case 0:
-		case 1:
-			if firstLine[0] == "internal" {
-				internalIssuer = new(caddytls.InternalIssuer)
-			} else if !strings.Contains(firstLine[0], "@") {
-				return nil, h.Err("single argument must either be 'internal' or an email address")
-			} else {
-				if acmeIssuer == nil {
-					acmeIssuer = new(caddytls.ACMEIssuer)
-				}
-				acmeIssuer.Email = firstLine[0]
-			}
-
-		case 2:
-			certFilename := firstLine[0]
-			keyFilename := firstLine[1]
-
-			// tag this certificate so if multiple certs match, specifically
-			// this one that the user has provided will be used, see #2588:
-			// https://github.com/caddyserver/caddy/issues/2588 ... but we
-			// must be careful about how we do this; being careless will
-			// lead to failed handshakes
-			//
-			// we need to remember which cert files we've seen, since we
-			// must load each cert only once; otherwise, they each get a
-			// different tag... since a cert loaded twice has the same
-			// bytes, it will overwrite the first one in the cache, and
-			// only the last cert (and its tag) will survive, so a any conn
-			// policy that is looking for any tag but the last one to be
-			// loaded won't find it, and TLS handshakes will fail (see end)
-			// of issue #3004)
-			//
-			// tlsCertTags maps certificate filenames to their tag.
-			// This is used to remember which tag is used for each
-			// certificate files, since we need to avoid loading
-			// the same certificate files more than once, overwriting
-			// previous tags
-			tlsCertTags, ok := h.State["tlsCertTags"].(map[string]string)
-			if !ok {
-				tlsCertTags = make(map[string]string)
-				h.State["tlsCertTags"] = tlsCertTags
-			}
-
-			tag, ok := tlsCertTags[certFilename]
-			if !ok {
-				// haven't seen this cert file yet, let's give it a tag
-				// and add a loader for it
-				tag = fmt.Sprintf("cert%d", len(tlsCertTags))
-				fileLoader = append(fileLoader, caddytls.CertKeyFilePair{
-					Certificate: certFilename,
-					Key:         keyFilename,
-					Tags:        []string{tag},
-				})
-				// remember this for next time we see this cert file
-				tlsCertTags[certFilename] = tag
-			}
-			certSelector := caddytls.CustomCertSelectionPolicy{Tag: tag}
-			cp.CertSelection = caddyconfig.JSONModuleObject(certSelector, "policy", "custom", h.warnings)
-		default:
-			return nil, h.ArgErr()
-		}
-
-		var hasBlock bool
-		for h.NextBlock(0) {
-			hasBlock = true
-
-			switch h.Val() {
-			case "protocols":
-				args := h.RemainingArgs()
-				if len(args) == 0 {
-					return nil, h.SyntaxErr("one or two protocols")
-				}
-				if len(args) > 0 {
-					if _, ok := caddytls.SupportedProtocols[args[0]]; !ok {
-						return nil, h.Errf("Wrong protocol name or protocol not supported: '%s'", args[0])
-					}
-					cp.ProtocolMin = args[0]
-				}
-				if len(args) > 1 {
-					if _, ok := caddytls.SupportedProtocols[args[1]]; !ok {
-						return nil, h.Errf("Wrong protocol name or protocol not supported: '%s'", args[1])
-					}
-					cp.ProtocolMax = args[1]
-				}
-
-			case "ciphers":
-				for h.NextArg() {
-					if _, ok := caddytls.SupportedCipherSuites[h.Val()]; !ok {
-						return nil, h.Errf("Wrong cipher suite name or cipher suite not supported: '%s'", h.Val())
-					}
-					cp.CipherSuites = append(cp.CipherSuites, h.Val())
-				}
-
-			case "curves":
-				for h.NextArg() {
-					if _, ok := caddytls.SupportedCurves[h.Val()]; !ok {
-						return nil, h.Errf("Wrong curve name or curve not supported: '%s'", h.Val())
-					}
-					cp.Curves = append(cp.Curves, h.Val())
-				}
-
-			case "alpn":
-				args := h.RemainingArgs()
-				if len(args) == 0 {
-					return nil, h.ArgErr()
-				}
-				cp.ALPN = args
-
-			case "load":
-				folderLoader = append(folderLoader, h.RemainingArgs()...)
-
-			case "ca":
-				arg := h.RemainingArgs()
-				if len(arg) != 1 {
-					return nil, h.ArgErr()
-				}
-				if acmeIssuer == nil {
-					acmeIssuer = new(caddytls.ACMEIssuer)
-				}
-				acmeIssuer.CA = arg[0]
-
-			case "dns":
-				if !h.Next() {
-					return nil, h.ArgErr()
-				}
-				if acmeIssuer == nil {
-					acmeIssuer = new(caddytls.ACMEIssuer)
-				}
-				provName := h.Val()
-				if acmeIssuer.Challenges == nil {
-					acmeIssuer.Challenges = new(caddytls.ChallengesConfig)
-				}
-				dnsProvModule, err := caddy.GetModule("tls.dns." + provName)
-				if err != nil {
-					return nil, h.Errf("getting DNS provider module named '%s': %v", provName, err)
-				}
-				acmeIssuer.Challenges.DNSRaw = caddyconfig.JSONModuleObject(dnsProvModule.New(), "provider", provName, h.warnings)
-
-			case "ca_root":
-				arg := h.RemainingArgs()
-				if len(arg) != 1 {
-					return nil, h.ArgErr()
-				}
-				if acmeIssuer == nil {
-					acmeIssuer = new(caddytls.ACMEIssuer)
-				}
-				acmeIssuer.TrustedRootsPEMFiles = append(acmeIssuer.TrustedRootsPEMFiles, arg[0])
-
-			case "on_demand":
-				if h.NextArg() {
-					return nil, h.ArgErr()
-				}
-				onDemand = true
-
-			default:
-				return nil, h.Errf("unknown subdirective: %s", h.Val())
-			}
-		}
-
-		// a naked tls directive is not allowed
-		if len(firstLine) == 0 && !hasBlock {
-			return nil, h.ArgErr()
-		}
-	}
-
-	// begin building the final config values
-	var configVals []ConfigValue
-
-	// certificate loaders
-	if len(fileLoader) > 0 {
-		configVals = append(configVals, ConfigValue{
-			Class: "tls.certificate_loader",
-			Value: fileLoader,
-		})
-	}
-	if len(folderLoader) > 0 {
-		configVals = append(configVals, ConfigValue{
-			Class: "tls.certificate_loader",
-			Value: folderLoader,
-		})
-	}
-
-	// issuer
-	if acmeIssuer != nil && internalIssuer != nil {
-		// the logic to support this would be complex
-		return nil, h.Err("cannot use both ACME and internal issuers in same server block")
-	}
-	if acmeIssuer != nil {
-		// fill in global defaults, if configured
-		if email := h.Option("email"); email != nil && acmeIssuer.Email == "" {
-			acmeIssuer.Email = email.(string)
-		}
-		if acmeCA := h.Option("acme_ca"); acmeCA != nil && acmeIssuer.CA == "" {
-			acmeIssuer.CA = acmeCA.(string)
-		}
-		if caPemFile := h.Option("acme_ca_root"); caPemFile != nil {
-			acmeIssuer.TrustedRootsPEMFiles = append(acmeIssuer.TrustedRootsPEMFiles, caPemFile.(string))
-		}
-
-		configVals = append(configVals, ConfigValue{
-			Class: "tls.cert_issuer",
-			Value: acmeIssuer,
-		})
-	} else if internalIssuer != nil {
-		configVals = append(configVals, ConfigValue{
-			Class: "tls.cert_issuer",
-			Value: internalIssuer,
-		})
-	}
-
-	// on-demand TLS
-	if onDemand {
-		configVals = append(configVals, ConfigValue{
-			Class: "tls.on_demand",
-			Value: true,
-		})
-	}
-
-	// connection policy -- always add one, to ensure that TLS
-	// is enabled, because this directive was used (this is
-	// needed, for instance, when a site block has a key of
-	// just ":5000" - i.e. no hostname, and only on-demand TLS
-	// is enabled)
-	configVals = append(configVals, ConfigValue{
-		Class: "tls.connection_policy",
-		Value: cp,
-	})
-
-	return configVals, nil
-}
-
-// parseRoot parses the root directive. Syntax:
-//
-//     root [<matcher>] <path>
-//
-func parseRoot(h Helper) (caddyhttp.MiddlewareHandler, error) {
-	var root string
-	for h.Next() {
-		if !h.NextArg() {
-			return nil, h.ArgErr()
-		}
-		root = h.Val()
-		if h.NextArg() {
-			return nil, h.ArgErr()
-		}
-	}
-	return caddyhttp.VarsMiddleware{"root": root}, nil
-}
-
-// parseRedir parses the redir directive. Syntax:
-//
-//     redir [<matcher>] <to> [<code>]
-//
-func parseRedir(h Helper) (caddyhttp.MiddlewareHandler, error) {
-	if !h.Next() {
-		return nil, h.ArgErr()
-	}
-
-	if !h.NextArg() {
-		return nil, h.ArgErr()
-	}
-	to := h.Val()
-
-	var code string
-	if h.NextArg() {
-		code = h.Val()
-	}
-	if code == "permanent" {
-		code = "301"
-	}
-	if code == "temporary" || code == "" {
-		code = "302"
-	}
-	var body string
-	if code == "html" {
-		// Script tag comes first since that will better imitate a redirect in the browser's
-		// history, but the meta tag is a fallback for most non-JS clients.
-		const metaRedir = `<!DOCTYPE html>
-<html>
-	<head>
-		<title>Redirecting...</title>
-		<script>window.location.replace("%s");</script>
-		<meta http-equiv="refresh" content="0; URL='%s'">
-	</head>
-	<body>Redirecting to <a href="%s">%s</a>...</body>
-</html>
-`
-		safeTo := html.EscapeString(to)
-		body = fmt.Sprintf(metaRedir, safeTo, safeTo, safeTo, safeTo)
-	}
-
-	return caddyhttp.StaticResponse{
-		StatusCode: caddyhttp.WeakString(code),
-		Headers:    http.Header{"Location": []string{to}},
-		Body:       body,
-	}, nil
-}
-
-// parseRespond parses the respond directive.
-func parseRespond(h Helper) (caddyhttp.MiddlewareHandler, error) {
-	sr := new(caddyhttp.StaticResponse)
-	err := sr.UnmarshalCaddyfile(h.Dispenser)
-	if err != nil {
-		return nil, err
-	}
-	return sr, nil
-}
-
-// parseRoute parses the route directive.
-func parseRoute(h Helper) (caddyhttp.MiddlewareHandler, error) {
-	sr := new(caddyhttp.Subroute)
-
-	for h.Next() {
-		for nesting := h.Nesting(); h.NextBlock(nesting); {
-			dir := h.Val()
-
-			dirFunc, ok := registeredDirectives[dir]
-			if !ok {
-				return nil, h.Errf("unrecognized directive: %s", dir)
-			}
-
-			subHelper := h
-			subHelper.Dispenser = h.NewFromNextSegment()
-
-			results, err := dirFunc(subHelper)
-			if err != nil {
-				return nil, h.Errf("parsing caddyfile tokens for '%s': %v", dir, err)
-			}
-			for _, result := range results {
-				switch handler := result.Value.(type) {
-				case caddyhttp.Route:
-					sr.Routes = append(sr.Routes, handler)
-				case caddyhttp.Subroute:
-					// directives which return a literal subroute instead of a route
-					// means they intend to keep those handlers together without
-					// them being reordered; we're doing that anyway since we're in
-					// the route directive, so just append its handlers
-					sr.Routes = append(sr.Routes, handler.Routes...)
-				default:
-					return nil, h.Errf("%s directive returned something other than an HTTP route or subroute: %#v (only handler directives can be used in routes)", dir, result.Value)
-				}
-			}
-		}
-	}
-
-	return sr, nil
-}
-
-func parseHandle(h Helper) (caddyhttp.MiddlewareHandler, error) {
-	return parseSegmentAsSubroute(h)
-}
-
-func parseHandleErrors(h Helper) ([]ConfigValue, error) {
-	subroute, err := parseSegmentAsSubroute(h)
-	if err != nil {
-		return nil, err
-	}
-	return []ConfigValue{
-		{
-			Class: "error_route",
-			Value: subroute,
-		},
-	}, nil
-}
-
-// parseLog parses the log directive. Syntax:
-//
-//     log {
-//         output <writer_module> ...
-//         format <encoder_module> ...
-//         level  <level>
-//     }
-//
-func parseLog(h Helper) ([]ConfigValue, error) {
-	var configValues []ConfigValue
-	for h.Next() {
-		cl := new(caddy.CustomLog)
-
-		for h.NextBlock(0) {
-			switch h.Val() {
-			case "output":
-				if !h.NextArg() {
-					return nil, h.ArgErr()
-				}
-				moduleName := h.Val()
-
-				// can't use the usual caddyfile.Unmarshaler flow with the
-				// standard writers because they are in the caddy package
-				// (because they are the default) and implementing that
-				// interface there would unfortunately create circular import
-				var wo caddy.WriterOpener
-				switch moduleName {
-				case "stdout":
-					wo = caddy.StdoutWriter{}
-				case "stderr":
-					wo = caddy.StderrWriter{}
-				case "discard":
-					wo = caddy.DiscardWriter{}
-				default:
-					mod, err := caddy.GetModule("caddy.logging.writers." + moduleName)
-					if err != nil {
-						return nil, h.Errf("getting log writer module named '%s': %v", moduleName, err)
-					}
-					unm, ok := mod.New().(caddyfile.Unmarshaler)
-					if !ok {
-						return nil, h.Errf("log writer module '%s' is not a Caddyfile unmarshaler", mod)
-					}
-					err = unm.UnmarshalCaddyfile(h.NewFromNextSegment())
-					if err != nil {
-						return nil, err
-					}
-					wo, ok = unm.(caddy.WriterOpener)
-					if !ok {
-						return nil, h.Errf("module %s is not a WriterOpener", mod)
-					}
-				}
-				cl.WriterRaw = caddyconfig.JSONModuleObject(wo, "output", moduleName, h.warnings)
-
-			case "format":
-				if !h.NextArg() {
-					return nil, h.ArgErr()
-				}
-				moduleName := h.Val()
-				mod, err := caddy.GetModule("caddy.logging.encoders." + moduleName)
-				if err != nil {
-					return nil, h.Errf("getting log encoder module named '%s': %v", moduleName, err)
-				}
-				unm, ok := mod.New().(caddyfile.Unmarshaler)
-				if !ok {
-					return nil, h.Errf("log encoder module '%s' is not a Caddyfile unmarshaler", mod)
-				}
-				err = unm.UnmarshalCaddyfile(h.NewFromNextSegment())
-				if err != nil {
-					return nil, err
-				}
-				enc, ok := unm.(zapcore.Encoder)
-				if !ok {
-					return nil, h.Errf("module %s is not a zapcore.Encoder", mod)
-				}
-				cl.EncoderRaw = caddyconfig.JSONModuleObject(enc, "format", moduleName, h.warnings)
-
-			case "level":
-				if !h.NextArg() {
-					return nil, h.ArgErr()
-				}
-				cl.Level = h.Val()
-				if h.NextArg() {
-					return nil, h.ArgErr()
-				}
-
-			default:
-				return nil, h.Errf("unrecognized subdirective: %s", h.Val())
-			}
-		}
-
-		var val namedCustomLog
-		if !reflect.DeepEqual(cl, new(caddy.CustomLog)) {
-			logCounter, ok := h.State["logCounter"].(int)
-			if !ok {
-				logCounter = 0
-			}
-			val.name = fmt.Sprintf("log%d", logCounter)
-			cl.Include = []string{"http.log.access." + val.name}
-			val.log = cl
-			logCounter++
-			h.State["logCounter"] = logCounter
-		}
-		configValues = append(configValues, ConfigValue{
-			Class: "custom_log",
-			Value: val,
-		})
-	}
-	return configValues, nil
-}

caddyconfig/httpcaddyfile/directives.go

@@ -1,403 +0,0 @@
-// 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 httpcaddyfile
-
-import (
-	"encoding/json"
-	"sort"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
-)
-
-// directiveOrder specifies the order
-// to apply directives in HTTP routes.
-var directiveOrder = []string{
-	"header",
-
-	"redir",
-	"rewrite",
-
-	"root",
-
-	// URI manipulation
-	"uri",
-	"try_files",
-
-	// middleware handlers; some wrap responses
-	"basicauth",
-	"request_header",
-	"encode",
-	"templates",
-
-	// special routing directives
-	"handle",
-	"route",
-
-	// handlers that typically respond to requests
-	"respond",
-	"reverse_proxy",
-	"php_fastcgi",
-	"file_server",
-}
-
-// directiveIsOrdered returns true if dir is
-// a known, ordered (sorted) directive.
-func directiveIsOrdered(dir string) bool {
-	for _, d := range directiveOrder {
-		if d == dir {
-			return true
-		}
-	}
-	return false
-}
-
-// RegisterDirective registers a unique directive dir with an
-// associated unmarshaling (setup) function. When directive dir
-// is encountered in a Caddyfile, setupFunc will be called to
-// unmarshal its tokens.
-func RegisterDirective(dir string, setupFunc UnmarshalFunc) {
-	if _, ok := registeredDirectives[dir]; ok {
-		panic("directive " + dir + " already registered")
-	}
-	registeredDirectives[dir] = setupFunc
-}
-
-// RegisterHandlerDirective is like RegisterDirective, but for
-// directives which specifically output only an HTTP handler.
-// Directives registered with this function will always have
-// an optional matcher token as the first argument.
-func RegisterHandlerDirective(dir string, setupFunc UnmarshalHandlerFunc) {
-	RegisterDirective(dir, func(h Helper) ([]ConfigValue, error) {
-		if !h.Next() {
-			return nil, h.ArgErr()
-		}
-
-		matcherSet, ok, err := h.MatcherToken()
-		if err != nil {
-			return nil, err
-		}
-		if ok {
-			// strip matcher token; we don't need to
-			// use the return value here because a
-			// new dispenser should have been made
-			// solely for this directive's tokens,
-			// with no other uses of same slice
-			h.Dispenser.Delete()
-		}
-
-		h.Dispenser.Reset() // pretend this lookahead never happened
-		val, err := setupFunc(h)
-		if err != nil {
-			return nil, err
-		}
-
-		return h.NewRoute(matcherSet, val), nil
-	})
-}
-
-// Helper is a type which helps setup a value from
-// Caddyfile tokens.
-type Helper struct {
-	*caddyfile.Dispenser
-	// State stores intermediate variables during caddyfile adaptation.
-	State        map[string]interface{}
-	options      map[string]interface{}
-	warnings     *[]caddyconfig.Warning
-	matcherDefs  map[string]caddy.ModuleMap
-	parentBlock  caddyfile.ServerBlock
-	groupCounter counter
-}
-
-// Option gets the option keyed by name.
-func (h Helper) Option(name string) interface{} {
-	return h.options[name]
-}
-
-// Caddyfiles returns the list of config files from
-// which tokens in the current server block were loaded.
-func (h Helper) Caddyfiles() []string {
-	// first obtain set of names of files involved
-	// in this server block, without duplicates
-	files := make(map[string]struct{})
-	for _, segment := range h.parentBlock.Segments {
-		for _, token := range segment {
-			files[token.File] = struct{}{}
-		}
-	}
-	// then convert the set into a slice
-	filesSlice := make([]string, 0, len(files))
-	for file := range files {
-		filesSlice = append(filesSlice, file)
-	}
-	return filesSlice
-}
-
-// JSON converts val into JSON. Any errors are added to warnings.
-func (h Helper) JSON(val interface{}) json.RawMessage {
-	return caddyconfig.JSON(val, h.warnings)
-}
-
-// MatcherToken assumes the next argument token is (possibly) a matcher,
-// and if so, returns the matcher set along with a true value. If the next
-// token is not a matcher, nil and false is returned. Note that a true
-// value may be returned with a nil matcher set if it is a catch-all.
-func (h Helper) MatcherToken() (caddy.ModuleMap, bool, error) {
-	if !h.NextArg() {
-		return nil, false, nil
-	}
-	return matcherSetFromMatcherToken(h.Dispenser.Token(), h.matcherDefs, h.warnings)
-}
-
-// ExtractMatcherSet is like MatcherToken, except this is a higher-level
-// method that returns the matcher set described by the matcher token,
-// or nil if there is none, and deletes the matcher token from the
-// dispenser and resets it as if this look-ahead never happened. Useful
-// when wrapping a route (one or more handlers) in a user-defined matcher.
-func (h Helper) ExtractMatcherSet() (caddy.ModuleMap, error) {
-	matcherSet, hasMatcher, err := h.MatcherToken()
-	if err != nil {
-		return nil, err
-	}
-	if hasMatcher {
-		h.Dispenser.Delete() // strip matcher token
-	}
-	h.Dispenser.Reset() // pretend this lookahead never happened
-	return matcherSet, nil
-}
-
-// NewRoute returns config values relevant to creating a new HTTP route.
-func (h Helper) NewRoute(matcherSet caddy.ModuleMap,
-	handler caddyhttp.MiddlewareHandler) []ConfigValue {
-	mod, err := caddy.GetModule(caddy.GetModuleID(handler))
-	if err != nil {
-		*h.warnings = append(*h.warnings, caddyconfig.Warning{
-			File:    h.File(),
-			Line:    h.Line(),
-			Message: err.Error(),
-		})
-		return nil
-	}
-	var matcherSetsRaw []caddy.ModuleMap
-	if matcherSet != nil {
-		matcherSetsRaw = append(matcherSetsRaw, matcherSet)
-	}
-	return []ConfigValue{
-		{
-			Class: "route",
-			Value: caddyhttp.Route{
-				MatcherSetsRaw: matcherSetsRaw,
-				HandlersRaw:    []json.RawMessage{caddyconfig.JSONModuleObject(handler, "handler", mod.ID.Name(), h.warnings)},
-			},
-		},
-	}
-}
-
-// GroupRoutes adds the routes (caddyhttp.Route type) in vals to the
-// same group, if there is more than one route in vals.
-func (h Helper) GroupRoutes(vals []ConfigValue) {
-	// ensure there's at least two routes; group of one is pointless
-	var count int
-	for _, v := range vals {
-		if _, ok := v.Value.(caddyhttp.Route); ok {
-			count++
-			if count > 1 {
-				break
-			}
-		}
-	}
-	if count < 2 {
-		return
-	}
-
-	// now that we know the group will have some effect, do it
-	groupName := h.groupCounter.nextGroup()
-	for i := range vals {
-		if route, ok := vals[i].Value.(caddyhttp.Route); ok {
-			route.Group = groupName
-			vals[i].Value = route
-		}
-	}
-}
-
-// NewBindAddresses returns config values relevant to adding
-// listener bind addresses to the config.
-func (h Helper) NewBindAddresses(addrs []string) []ConfigValue {
-	return []ConfigValue{{Class: "bind", Value: addrs}}
-}
-
-// ConfigValue represents a value to be added to the final
-// configuration, or a value to be consulted when building
-// the final configuration.
-type ConfigValue struct {
-	// The kind of value this is. As the config is
-	// being built, the adapter will look in the
-	// "pile" for values belonging to a certain
-	// class when it is setting up a certain part
-	// of the config. The associated value will be
-	// type-asserted and placed accordingly.
-	Class string
-
-	// The value to be used when building the config.
-	// Generally its type is associated with the
-	// name of the Class.
-	Value interface{}
-
-	directive string
-}
-
-func sortRoutes(routes []ConfigValue) {
-	dirPositions := make(map[string]int)
-	for i, dir := range directiveOrder {
-		dirPositions[dir] = i
-	}
-
-	// while we are sorting, we will need to decode a route's path matcher
-	// in order to sub-sort by path length; we can amortize this operation
-	// for efficiency by storing the decoded matchers in a slice
-	decodedMatchers := make([]caddyhttp.MatchPath, len(routes))
-
-	sort.SliceStable(routes, func(i, j int) bool {
-		iDir, jDir := routes[i].directive, routes[j].directive
-		if iDir == jDir {
-			// directives are the same; sub-sort by path matcher length
-			// if there's only one matcher set and one path (common case)
-			iRoute, ok := routes[i].Value.(caddyhttp.Route)
-			if !ok {
-				return false
-			}
-			jRoute, ok := routes[j].Value.(caddyhttp.Route)
-			if !ok {
-				return false
-			}
-
-			// use already-decoded matcher, or decode if it's the first time seeing it
-			iPM, jPM := decodedMatchers[i], decodedMatchers[j]
-			if iPM == nil && len(iRoute.MatcherSetsRaw) == 1 {
-				var pathMatcher caddyhttp.MatchPath
-				_ = json.Unmarshal(iRoute.MatcherSetsRaw[0]["path"], &pathMatcher)
-				decodedMatchers[i] = pathMatcher
-				iPM = pathMatcher
-			}
-			if jPM == nil && len(jRoute.MatcherSetsRaw) == 1 {
-				var pathMatcher caddyhttp.MatchPath
-				_ = json.Unmarshal(jRoute.MatcherSetsRaw[0]["path"], &pathMatcher)
-				decodedMatchers[j] = pathMatcher
-				jPM = pathMatcher
-			}
-
-			// sort by longer path (more specific) first; missing
-			// path matchers are treated as zero-length paths
-			var iPathLen, jPathLen int
-			if iPM != nil {
-				iPathLen = len(iPM[0])
-			}
-			if jPM != nil {
-				jPathLen = len(jPM[0])
-			}
-			return iPathLen > jPathLen
-		}
-
-		return dirPositions[iDir] < dirPositions[jDir]
-	})
-}
-
-// parseSegmentAsSubroute parses the segment such that its subdirectives
-// are themselves treated as directives, from which a subroute is built
-// and returned.
-func parseSegmentAsSubroute(h Helper) (caddyhttp.MiddlewareHandler, error) {
-	var allResults []ConfigValue
-
-	for h.Next() {
-		// slice the linear list of tokens into top-level segments
-		var segments []caddyfile.Segment
-		for nesting := h.Nesting(); h.NextBlock(nesting); {
-			segments = append(segments, h.NextSegment())
-		}
-
-		// copy existing matcher definitions so we can augment
-		// new ones that are defined only in this scope
-		matcherDefs := make(map[string]caddy.ModuleMap, len(h.matcherDefs))
-		for key, val := range h.matcherDefs {
-			matcherDefs[key] = val
-		}
-
-		// find and extract any embedded matcher definitions in this scope
-		for i, seg := range segments {
-			if strings.HasPrefix(seg.Directive(), matcherPrefix) {
-				err := parseMatcherDefinitions(caddyfile.NewDispenser(seg), matcherDefs)
-				if err != nil {
-					return nil, err
-				}
-				segments = append(segments[:i], segments[i+1:]...)
-			}
-		}
-
-		// with matchers ready to go, evaluate each directive's segment
-		for _, seg := range segments {
-			dir := seg.Directive()
-			dirFunc, ok := registeredDirectives[dir]
-			if !ok {
-				return nil, h.Errf("unrecognized directive: %s", dir)
-			}
-
-			subHelper := h
-			subHelper.Dispenser = caddyfile.NewDispenser(seg)
-			subHelper.matcherDefs = matcherDefs
-
-			results, err := dirFunc(subHelper)
-			if err != nil {
-				return nil, h.Errf("parsing caddyfile tokens for '%s': %v", dir, err)
-			}
-			for _, result := range results {
-				result.directive = dir
-				allResults = append(allResults, result)
-			}
-		}
-	}
-
-	return buildSubroute(allResults, h.groupCounter)
-}
-
-// serverBlock pairs a Caddyfile server block
-// with a "pile" of config values, keyed by class
-// name.
-type serverBlock struct {
-	block caddyfile.ServerBlock
-	pile  map[string][]ConfigValue // config values obtained from directives
-}
-
-type (
-	// UnmarshalFunc is a function which can unmarshal Caddyfile
-	// tokens into zero or more config values using a Helper type.
-	// These are passed in a call to RegisterDirective.
-	UnmarshalFunc func(h Helper) ([]ConfigValue, error)
-
-	// UnmarshalHandlerFunc is like UnmarshalFunc, except the
-	// output of the unmarshaling is an HTTP handler. This
-	// function does not need to deal with HTTP request matching
-	// which is abstracted away. Since writing HTTP handlers
-	// with Caddyfile support is very common, this is a more
-	// convenient way to add a handler to the chain since a lot
-	// of the details common to HTTP handlers are taken care of
-	// for you. These are passed to a call to
-	// RegisterHandlerDirective.
-	UnmarshalHandlerFunc func(h Helper) (caddyhttp.MiddlewareHandler, error)
-)
-
-var registeredDirectives = make(map[string]UnmarshalFunc)

caddyconfig/httpcaddyfile/httptype.go

@@ -1,938 +0,0 @@
-// 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 httpcaddyfile
-
-import (
-	"encoding/json"
-	"fmt"
-	"reflect"
-	"sort"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-)
-
-func init() {
-	caddyconfig.RegisterAdapter("caddyfile", caddyfile.Adapter{ServerType: ServerType{}})
-}
-
-// ServerType can set up a config from an HTTP Caddyfile.
-type ServerType struct {
-}
-
-// Setup makes a config from the tokens.
-func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
-	options map[string]interface{}) (*caddy.Config, []caddyconfig.Warning, error) {
-	var warnings []caddyconfig.Warning
-	gc := counter{new(int)}
-	state := make(map[string]interface{})
-
-	// load all the server blocks and associate them with a "pile"
-	// of config values; also prohibit duplicate keys because they
-	// can make a config confusing if more than one server block is
-	// chosen to handle a request - we actually will make each
-	// server block's route terminal so that only one will run
-	sbKeys := make(map[string]struct{})
-	var serverBlocks []serverBlock
-	for i, sblock := range originalServerBlocks {
-		for j, k := range sblock.Keys {
-			if _, ok := sbKeys[k]; ok {
-				return nil, warnings, fmt.Errorf("duplicate site address not allowed: '%s' in %v (site block %d, key %d)", k, sblock.Keys, i, j)
-			}
-			sbKeys[k] = struct{}{}
-		}
-		serverBlocks = append(serverBlocks, serverBlock{
-			block: sblock,
-			pile:  make(map[string][]ConfigValue),
-		})
-	}
-
-	// apply any global options
-	var err error
-	serverBlocks, err = st.evaluateGlobalOptionsBlock(serverBlocks, options)
-	if err != nil {
-		return nil, warnings, err
-	}
-
-	for _, sb := range serverBlocks {
-		// replace shorthand placeholders (which are
-		// convenient when writing a Caddyfile) with
-		// their actual placeholder identifiers or
-		// variable names
-		replacer := strings.NewReplacer(
-			"{dir}", "{http.request.uri.path.dir}",
-			"{file}", "{http.request.uri.path.file}",
-			"{host}", "{http.request.host}",
-			"{hostport}", "{http.request.hostport}",
-			"{method}", "{http.request.method}",
-			"{path}", "{http.request.uri.path}",
-			"{query}", "{http.request.uri.query}",
-			"{remote}", "{http.request.remote}",
-			"{remote_host}", "{http.request.remote.host}",
-			"{remote_port}", "{http.request.remote.port}",
-			"{scheme}", "{http.request.scheme}",
-			"{uri}", "{http.request.uri}",
-			"{tls_cipher}", "{http.request.tls.cipher_suite}",
-			"{tls_version}", "{http.request.tls.version}",
-			"{tls_client_fingerprint}", "{http.request.tls.client.fingerprint}",
-			"{tls_client_issuer}", "{http.request.tls.client.issuer}",
-			"{tls_client_serial}", "{http.request.tls.client.serial}",
-			"{tls_client_subject}", "{http.request.tls.client.subject}",
-		)
-		for _, segment := range sb.block.Segments {
-			for i := 0; i < len(segment); i++ {
-				segment[i].Text = replacer.Replace(segment[i].Text)
-			}
-		}
-
-		if len(sb.block.Keys) == 0 {
-			return nil, warnings, fmt.Errorf("server block without any key is global configuration, and if used, it must be first")
-		}
-
-		// extract matcher definitions
-		matcherDefs := make(map[string]caddy.ModuleMap)
-		for _, segment := range sb.block.Segments {
-			if dir := segment.Directive(); strings.HasPrefix(dir, matcherPrefix) {
-				d := sb.block.DispenseDirective(dir)
-				err := parseMatcherDefinitions(d, matcherDefs)
-				if err != nil {
-					return nil, warnings, err
-				}
-			}
-		}
-
-		// evaluate each directive ("segment") in this block
-		for _, segment := range sb.block.Segments {
-			dir := segment.Directive()
-
-			if strings.HasPrefix(dir, matcherPrefix) {
-				// matcher definitions were pre-processed
-				continue
-			}
-
-			dirFunc, ok := registeredDirectives[dir]
-			if !ok {
-				tkn := segment[0]
-				return nil, warnings, fmt.Errorf("%s:%d: unrecognized directive: %s", tkn.File, tkn.Line, dir)
-			}
-
-			h := Helper{
-				Dispenser:    caddyfile.NewDispenser(segment),
-				options:      options,
-				warnings:     &warnings,
-				matcherDefs:  matcherDefs,
-				parentBlock:  sb.block,
-				groupCounter: gc,
-				State:        state,
-			}
-
-			results, err := dirFunc(h)
-			if err != nil {
-				return nil, warnings, fmt.Errorf("parsing caddyfile tokens for '%s': %v", dir, err)
-			}
-			for _, result := range results {
-				result.directive = dir
-				sb.pile[result.Class] = append(sb.pile[result.Class], result)
-			}
-		}
-	}
-
-	// map
-	sbmap, err := st.mapAddressToServerBlocks(serverBlocks, options)
-	if err != nil {
-		return nil, warnings, err
-	}
-
-	// reduce
-	pairings := st.consolidateAddrMappings(sbmap)
-
-	// each pairing of listener addresses to list of server
-	// blocks is basically a server definition
-	servers, err := st.serversFromPairings(pairings, options, &warnings, gc)
-	if err != nil {
-		return nil, warnings, err
-	}
-
-	// now that each server is configured, make the HTTP app
-	httpApp := caddyhttp.App{
-		HTTPPort:  tryInt(options["http_port"], &warnings),
-		HTTPSPort: tryInt(options["https_port"], &warnings),
-		Servers:   servers,
-	}
-
-	// then make the TLS app
-	tlsApp, warnings, err := st.buildTLSApp(pairings, options, warnings)
-	if err != nil {
-		return nil, warnings, err
-	}
-
-	// if experimental HTTP/3 is enabled, enable it on each server
-	if enableH3, ok := options["experimental_http3"].(bool); ok && enableH3 {
-		for _, srv := range httpApp.Servers {
-			srv.ExperimentalHTTP3 = true
-		}
-	}
-
-	// extract any custom logs, and enforce configured levels
-	var customLogs []namedCustomLog
-	var hasDefaultLog bool
-	for _, sb := range serverBlocks {
-		for _, clVal := range sb.pile["custom_log"] {
-			ncl := clVal.Value.(namedCustomLog)
-			if ncl.name == "" {
-				continue
-			}
-			if ncl.name == "default" {
-				hasDefaultLog = true
-			}
-			if _, ok := options["debug"]; ok && ncl.log.Level == "" {
-				ncl.log.Level = "DEBUG"
-			}
-			customLogs = append(customLogs, ncl)
-		}
-	}
-	if !hasDefaultLog {
-		// if the default log was not customized, ensure we
-		// configure it with any applicable options
-		if _, ok := options["debug"]; ok {
-			customLogs = append(customLogs, namedCustomLog{
-				name: "default",
-				log:  &caddy.CustomLog{Level: "DEBUG"},
-			})
-		}
-	}
-
-	// annnd the top-level config, then we're done!
-	cfg := &caddy.Config{AppsRaw: make(caddy.ModuleMap)}
-	if len(httpApp.Servers) > 0 {
-		cfg.AppsRaw["http"] = caddyconfig.JSON(httpApp, &warnings)
-	}
-	if !reflect.DeepEqual(tlsApp, &caddytls.TLS{CertificatesRaw: make(caddy.ModuleMap)}) {
-		cfg.AppsRaw["tls"] = caddyconfig.JSON(tlsApp, &warnings)
-	}
-	if storageCvtr, ok := options["storage"].(caddy.StorageConverter); ok {
-		cfg.StorageRaw = caddyconfig.JSONModuleObject(storageCvtr,
-			"module",
-			storageCvtr.(caddy.Module).CaddyModule().ID.Name(),
-			&warnings)
-	}
-	if adminConfig, ok := options["admin"].(string); ok && adminConfig != "" {
-		if adminConfig == "off" {
-			cfg.Admin = &caddy.AdminConfig{Disabled: true}
-		} else {
-			cfg.Admin = &caddy.AdminConfig{Listen: adminConfig}
-		}
-	}
-	if len(customLogs) > 0 {
-		if cfg.Logging == nil {
-			cfg.Logging = &caddy.Logging{
-				Logs: make(map[string]*caddy.CustomLog),
-			}
-		}
-		for _, ncl := range customLogs {
-			if ncl.name != "" {
-				cfg.Logging.Logs[ncl.name] = ncl.log
-			}
-		}
-	}
-	if len(customLogs) > 0 {
-		if cfg.Logging == nil {
-			cfg.Logging = &caddy.Logging{
-				Logs: make(map[string]*caddy.CustomLog),
-			}
-		}
-		for _, ncl := range customLogs {
-			if ncl.name != "" {
-				cfg.Logging.Logs[ncl.name] = ncl.log
-			}
-		}
-	}
-
-	return cfg, warnings, nil
-}
-
-// evaluateGlobalOptionsBlock evaluates the global options block,
-// which is expected to be the first server block if it has zero
-// keys. It returns the updated list of server blocks with the
-// global options block removed, and updates options accordingly.
-func (ServerType) evaluateGlobalOptionsBlock(serverBlocks []serverBlock, options map[string]interface{}) ([]serverBlock, error) {
-	if len(serverBlocks) == 0 || len(serverBlocks[0].block.Keys) > 0 {
-		return serverBlocks, nil
-	}
-
-	for _, segment := range serverBlocks[0].block.Segments {
-		dir := segment.Directive()
-		var val interface{}
-		var err error
-		disp := caddyfile.NewDispenser(segment)
-		switch dir {
-		case "debug":
-			val = true
-		case "http_port":
-			val, err = parseOptHTTPPort(disp)
-		case "https_port":
-			val, err = parseOptHTTPSPort(disp)
-		case "default_sni":
-			val, err = parseOptSingleString(disp)
-		case "order":
-			val, err = parseOptOrder(disp)
-		case "experimental_http3":
-			val, err = parseOptExperimentalHTTP3(disp)
-		case "storage":
-			val, err = parseOptStorage(disp)
-		case "acme_ca", "acme_dns", "acme_ca_root":
-			val, err = parseOptSingleString(disp)
-		case "email":
-			val, err = parseOptSingleString(disp)
-		case "admin":
-			val, err = parseOptAdmin(disp)
-		case "on_demand_tls":
-			val, err = parseOptOnDemand(disp)
-		case "local_certs":
-			val = true
-		default:
-			return nil, fmt.Errorf("unrecognized parameter name: %s", dir)
-		}
-		if err != nil {
-			return nil, fmt.Errorf("%s: %v", dir, err)
-		}
-		options[dir] = val
-	}
-
-	return serverBlocks[1:], nil
-}
-
-// hostsFromServerBlockKeys returns a list of all the non-empty hostnames
-// found in the keys of the server block sb. If sb has a key that omits
-// the hostname (i.e. is a catch-all/empty host), then the returned list
-// is empty, because the server block effectively matches ALL hosts.
-// The list may not be in a consistent order.
-func (st *ServerType) hostsFromServerBlockKeys(sb caddyfile.ServerBlock) ([]string, error) {
-	// first get each unique hostname
-	hostMap := make(map[string]struct{})
-	for _, sblockKey := range sb.Keys {
-		addr, err := ParseAddress(sblockKey)
-		if err != nil {
-			return nil, fmt.Errorf("parsing server block key: %v", err)
-		}
-		addr = addr.Normalize()
-		if addr.Host == "" {
-			// server block contains a key like ":443", i.e. the host portion
-			// is empty / catch-all, which means to match all hosts
-			return []string{}, nil
-		}
-		hostMap[addr.Host] = struct{}{}
-	}
-
-	// convert map to slice
-	sblockHosts := make([]string, 0, len(hostMap))
-	for host := range hostMap {
-		sblockHosts = append(sblockHosts, host)
-	}
-
-	return sblockHosts, nil
-}
-
-// serversFromPairings creates the servers for each pairing of addresses
-// to server blocks. Each pairing is essentially a server definition.
-func (st *ServerType) serversFromPairings(
-	pairings []sbAddrAssociation,
-	options map[string]interface{},
-	warnings *[]caddyconfig.Warning,
-	groupCounter counter,
-) (map[string]*caddyhttp.Server, error) {
-	servers := make(map[string]*caddyhttp.Server)
-	defaultSNI := tryString(options["default_sni"], warnings)
-
-	for i, p := range pairings {
-		srv := &caddyhttp.Server{
-			Listen: p.addresses,
-		}
-
-		// sort server blocks by their keys; this is important because
-		// only the first matching site should be evaluated, and we should
-		// attempt to match most specific site first (host and path), in
-		// case their matchers overlap; we do this somewhat naively by
-		// descending sort by length of host then path
-		sort.SliceStable(p.serverBlocks, func(i, j int) bool {
-			// TODO: we could pre-process the specificities for efficiency,
-			// but I don't expect many blocks will have SO many keys...
-			var iLongestPath, jLongestPath string
-			var iLongestHost, jLongestHost string
-			for _, key := range p.serverBlocks[i].block.Keys {
-				addr, _ := ParseAddress(key)
-				if specificity(addr.Host) > specificity(iLongestHost) {
-					iLongestHost = addr.Host
-				}
-				if specificity(addr.Path) > specificity(iLongestPath) {
-					iLongestPath = addr.Path
-				}
-			}
-			for _, key := range p.serverBlocks[j].block.Keys {
-				addr, _ := ParseAddress(key)
-				if specificity(addr.Host) > specificity(jLongestHost) {
-					jLongestHost = addr.Host
-				}
-				if specificity(addr.Path) > specificity(jLongestPath) {
-					jLongestPath = addr.Path
-				}
-			}
-			if specificity(iLongestHost) == specificity(jLongestHost) {
-				return len(iLongestPath) > len(jLongestPath)
-			}
-			return specificity(iLongestHost) > specificity(jLongestHost)
-		})
-
-		var hasCatchAllTLSConnPolicy bool
-
-		// create a subroute for each site in the server block
-		for _, sblock := range p.serverBlocks {
-			matcherSetsEnc, err := st.compileEncodedMatcherSets(sblock.block)
-			if err != nil {
-				return nil, fmt.Errorf("server block %v: compiling matcher sets: %v", sblock.block.Keys, err)
-			}
-
-			hosts, err := st.hostsFromServerBlockKeys(sblock.block)
-			if err != nil {
-				return nil, err
-			}
-
-			// tls: connection policies
-			if cpVals, ok := sblock.pile["tls.connection_policy"]; ok {
-				// tls connection policies
-				for _, cpVal := range cpVals {
-					cp := cpVal.Value.(*caddytls.ConnectionPolicy)
-
-					// make sure the policy covers all hostnames from the block
-					for _, h := range hosts {
-						if h == defaultSNI {
-							hosts = append(hosts, "")
-							cp.DefaultSNI = defaultSNI
-							break
-						}
-					}
-
-					if len(hosts) > 0 {
-						cp.MatchersRaw = caddy.ModuleMap{
-							"sni": caddyconfig.JSON(hosts, warnings), // make sure to match all hosts, not just auto-HTTPS-qualified ones
-						}
-					} else {
-						cp.DefaultSNI = defaultSNI
-						hasCatchAllTLSConnPolicy = true
-					}
-
-					srv.TLSConnPolicies = append(srv.TLSConnPolicies, cp)
-				}
-			}
-
-			// exclude any hosts that were defined explicitly with
-			// "http://" in the key from automated cert management (issue #2998)
-			for _, key := range sblock.block.Keys {
-				addr, err := ParseAddress(key)
-				if err != nil {
-					return nil, err
-				}
-				addr = addr.Normalize()
-				if addr.Scheme == "http" && addr.Host != "" {
-					if srv.AutoHTTPS == nil {
-						srv.AutoHTTPS = new(caddyhttp.AutoHTTPSConfig)
-					}
-					if !sliceContains(srv.AutoHTTPS.Skip, addr.Host) {
-						srv.AutoHTTPS.Skip = append(srv.AutoHTTPS.Skip, addr.Host)
-					}
-				}
-			}
-
-			// set up each handler directive, making sure to honor directive order
-			dirRoutes := sblock.pile["route"]
-			siteSubroute, err := buildSubroute(dirRoutes, groupCounter)
-			if err != nil {
-				return nil, err
-			}
-
-			// add the site block's route(s) to the server
-			srv.Routes = appendSubrouteToRouteList(srv.Routes, siteSubroute, matcherSetsEnc, p, warnings)
-
-			// if error routes are defined, add those too
-			if errorSubrouteVals, ok := sblock.pile["error_route"]; ok {
-				if srv.Errors == nil {
-					srv.Errors = new(caddyhttp.HTTPErrorConfig)
-				}
-				for _, val := range errorSubrouteVals {
-					sr := val.Value.(*caddyhttp.Subroute)
-					srv.Errors.Routes = appendSubrouteToRouteList(srv.Errors.Routes, sr, matcherSetsEnc, p, warnings)
-				}
-			}
-
-			// add log associations
-			for _, cval := range sblock.pile["custom_log"] {
-				ncl := cval.Value.(namedCustomLog)
-				if srv.Logs == nil {
-					srv.Logs = &caddyhttp.ServerLogConfig{
-						LoggerNames: make(map[string]string),
-					}
-				}
-				hosts, err := st.hostsFromServerBlockKeys(sblock.block)
-				if err != nil {
-					return nil, err
-				}
-				for _, h := range hosts {
-					if ncl.name != "" {
-						srv.Logs.LoggerNames[h] = ncl.name
-					}
-				}
-			}
-		}
-
-		// a catch-all TLS conn policy is necessary to ensure TLS can
-		// be offered to all hostnames of the server; even though only
-		// one policy is needed to enable TLS for the server, that
-		// policy might apply to only certain TLS handshakes; but when
-		// using the Caddyfile, user would expect all handshakes to at
-		// least have a matching connection policy, so here we append a
-		// catch-all/default policy if there isn't one already (it's
-		// important that it goes at the end) - see issue #3004:
-		// https://github.com/caddyserver/caddy/issues/3004
-		// TODO: maybe a smarter way to handle this might be to just make the
-		// auto-HTTPS logic at provision-time detect if there is any connection
-		// policy missing for any HTTPS-enabled hosts, if so, add it... maybe?
-		if !hasCatchAllTLSConnPolicy && (len(srv.TLSConnPolicies) > 0 || defaultSNI != "") {
-			srv.TLSConnPolicies = append(srv.TLSConnPolicies, &caddytls.ConnectionPolicy{DefaultSNI: defaultSNI})
-		}
-
-		// tidy things up a bit
-		srv.TLSConnPolicies = consolidateConnPolicies(srv.TLSConnPolicies)
-		srv.Routes = consolidateRoutes(srv.Routes)
-
-		servers[fmt.Sprintf("srv%d", i)] = srv
-	}
-
-	return servers, nil
-}
-
-// consolidateConnPolicies combines TLS connection policies that are the same,
-// for a cleaner overall output.
-func consolidateConnPolicies(cps caddytls.ConnectionPolicies) caddytls.ConnectionPolicies {
-	for i := 0; i < len(cps); i++ {
-		for j := 0; j < len(cps); j++ {
-			if j == i {
-				continue
-			}
-
-			// if they're exactly equal in every way, just keep one of them
-			if reflect.DeepEqual(cps[i], cps[j]) {
-				cps = append(cps[:j], cps[j+1:]...)
-				i--
-				break
-			}
-		}
-	}
-	return cps
-}
-
-// appendSubrouteToRouteList appends the routes in subroute
-// to the routeList, optionally qualified by matchers.
-func appendSubrouteToRouteList(routeList caddyhttp.RouteList,
-	subroute *caddyhttp.Subroute,
-	matcherSetsEnc []caddy.ModuleMap,
-	p sbAddrAssociation,
-	warnings *[]caddyconfig.Warning) caddyhttp.RouteList {
-	if len(matcherSetsEnc) == 0 && len(p.serverBlocks) == 1 {
-		// no need to wrap the handlers in a subroute if this is
-		// the only server block and there is no matcher for it
-		routeList = append(routeList, subroute.Routes...)
-	} else {
-		routeList = append(routeList, caddyhttp.Route{
-			MatcherSetsRaw: matcherSetsEnc,
-			HandlersRaw: []json.RawMessage{
-				caddyconfig.JSONModuleObject(subroute, "handler", "subroute", warnings),
-			},
-			Terminal: true, // only first matching site block should be evaluated
-		})
-	}
-	return routeList
-}
-
-// buildSubroute turns the config values, which are expected to be routes
-// into a clean and orderly subroute that has all the routes within it.
-func buildSubroute(routes []ConfigValue, groupCounter counter) (*caddyhttp.Subroute, error) {
-	for _, val := range routes {
-		if !directiveIsOrdered(val.directive) {
-			return nil, fmt.Errorf("directive '%s' is not ordered, so it cannot be used here", val.directive)
-		}
-	}
-
-	sortRoutes(routes)
-
-	subroute := new(caddyhttp.Subroute)
-
-	// some directives are mutually exclusive (only first matching
-	// instance should be evaluated); this is done by putting their
-	// routes in the same group
-	mutuallyExclusiveDirs := map[string]*struct {
-		count     int
-		groupName string
-	}{
-		// as a special case, group rewrite directives so that they are mutually exclusive;
-		// this means that only the first matching rewrite will be evaluated, and that's
-		// probably a good thing, since there should never be a need to do more than one
-		// rewrite (I think?), and cascading rewrites smell bad... imagine these rewrites:
-		//     rewrite /docs/json/* /docs/json/index.html
-		//     rewrite /docs/*      /docs/index.html
-		// (We use this on the Caddy website, or at least we did once.) The first rewrite's
-		// result is also matched by the second rewrite, making the first rewrite pointless.
-		// See issue #2959.
-		"rewrite": {},
-
-		// handle blocks are also mutually exclusive by definition
-		"handle": {},
-
-		// root just sets a variable, so if it was not mutually exclusive, intersecting
-		// root directives would overwrite previously-matched ones; they should not cascade
-		"root": {},
-	}
-	for meDir, info := range mutuallyExclusiveDirs {
-		// see how many instances of the directive there are
-		for _, r := range routes {
-			if r.directive == meDir {
-				info.count++
-				if info.count > 1 {
-					break
-				}
-			}
-		}
-		// if there is more than one, put them in a group
-		// (special case: "rewrite" directive must always be in
-		// its own group--even if there is only one--because we
-		// do not want a rewrite to be consolidated into other
-		// adjacent routes that happen to have the same matcher,
-		// see caddyserver/caddy#3108 - because the implied
-		// intent of rewrite is to do an internal redirect,
-		// we can't assume that the request will continue to
-		// match the same matcher; anyway, giving a route a
-		// unique group name should keep it from consolidating)
-		if info.count > 1 || meDir == "rewrite" {
-			info.groupName = groupCounter.nextGroup()
-		}
-	}
-
-	// add all the routes piled in from directives
-	for _, r := range routes {
-		// put this route into a group if it is mutually exclusive
-		if info, ok := mutuallyExclusiveDirs[r.directive]; ok {
-			route := r.Value.(caddyhttp.Route)
-			route.Group = info.groupName
-			r.Value = route
-		}
-
-		switch route := r.Value.(type) {
-		case caddyhttp.Subroute:
-			// if a route-class config value is actually a Subroute handler
-			// with nothing but a list of routes, then it is the intention
-			// of the directive to keep these handlers together and in this
-			// same order, but not necessarily in a subroute (if it wanted
-			// to keep them in a subroute, the directive would have returned
-			// a route with a Subroute as its handler); this is useful to
-			// keep multiple handlers/routes together and in the same order
-			// so that the sorting procedure we did above doesn't reorder them
-			if route.Errors != nil {
-				// if error handlers are also set, this is confusing; it's
-				// probably supposed to be wrapped in a Route and encoded
-				// as a regular handler route... programmer error.
-				panic("found subroute with more than just routes; perhaps it should have been wrapped in a route?")
-			}
-			subroute.Routes = append(subroute.Routes, route.Routes...)
-		case caddyhttp.Route:
-			subroute.Routes = append(subroute.Routes, route)
-		}
-	}
-
-	subroute.Routes = consolidateRoutes(subroute.Routes)
-
-	return subroute, nil
-}
-
-// consolidateRoutes combines routes with the same properties
-// (same matchers, same Terminal and Group settings) for a
-// cleaner overall output.
-func consolidateRoutes(routes caddyhttp.RouteList) caddyhttp.RouteList {
-	for i := 0; i < len(routes)-1; i++ {
-		if reflect.DeepEqual(routes[i].MatcherSetsRaw, routes[i+1].MatcherSetsRaw) &&
-			routes[i].Terminal == routes[i+1].Terminal &&
-			routes[i].Group == routes[i+1].Group {
-			// keep the handlers in the same order, then splice out repetitive route
-			routes[i].HandlersRaw = append(routes[i].HandlersRaw, routes[i+1].HandlersRaw...)
-			routes = append(routes[:i+1], routes[i+2:]...)
-			i--
-		}
-	}
-	return routes
-}
-
-func matcherSetFromMatcherToken(
-	tkn caddyfile.Token,
-	matcherDefs map[string]caddy.ModuleMap,
-	warnings *[]caddyconfig.Warning,
-) (caddy.ModuleMap, bool, error) {
-	// matcher tokens can be wildcards, simple path matchers,
-	// or refer to a pre-defined matcher by some name
-	if tkn.Text == "*" {
-		// match all requests == no matchers, so nothing to do
-		return nil, true, nil
-	} else if strings.HasPrefix(tkn.Text, "/") {
-		// convenient way to specify a single path match
-		return caddy.ModuleMap{
-			"path": caddyconfig.JSON(caddyhttp.MatchPath{tkn.Text}, warnings),
-		}, true, nil
-	} else if strings.HasPrefix(tkn.Text, matcherPrefix) {
-		// pre-defined matcher
-		m, ok := matcherDefs[tkn.Text]
-		if !ok {
-			return nil, false, fmt.Errorf("unrecognized matcher name: %+v", tkn.Text)
-		}
-		return m, true, nil
-	}
-	return nil, false, nil
-}
-
-func (st *ServerType) compileEncodedMatcherSets(sblock caddyfile.ServerBlock) ([]caddy.ModuleMap, error) {
-	type hostPathPair struct {
-		hostm caddyhttp.MatchHost
-		pathm caddyhttp.MatchPath
-	}
-
-	// keep routes with common host and path matchers together
-	var matcherPairs []*hostPathPair
-
-	var catchAllHosts bool
-	for _, key := range sblock.Keys {
-		addr, err := ParseAddress(key)
-		if err != nil {
-			return nil, fmt.Errorf("server block %v: parsing and standardizing address '%s': %v", sblock.Keys, key, err)
-		}
-		addr = addr.Normalize()
-
-		// choose a matcher pair that should be shared by this
-		// server block; if none exists yet, create one
-		var chosenMatcherPair *hostPathPair
-		for _, mp := range matcherPairs {
-			if (len(mp.pathm) == 0 && addr.Path == "") ||
-				(len(mp.pathm) == 1 && mp.pathm[0] == addr.Path) {
-				chosenMatcherPair = mp
-				break
-			}
-		}
-		if chosenMatcherPair == nil {
-			chosenMatcherPair = new(hostPathPair)
-			if addr.Path != "" {
-				chosenMatcherPair.pathm = []string{addr.Path}
-			}
-			matcherPairs = append(matcherPairs, chosenMatcherPair)
-		}
-
-		// if one of the keys has no host (i.e. is a catch-all for
-		// any hostname), then we need to null out the host matcher
-		// entirely so that it matches all hosts
-		if addr.Host == "" && !catchAllHosts {
-			chosenMatcherPair.hostm = nil
-			catchAllHosts = true
-		}
-		if catchAllHosts {
-			continue
-		}
-
-		// add this server block's keys to the matcher
-		// pair if it doesn't already exist
-		if addr.Host != "" {
-			var found bool
-			for _, h := range chosenMatcherPair.hostm {
-				if h == addr.Host {
-					found = true
-					break
-				}
-			}
-			if !found {
-				chosenMatcherPair.hostm = append(chosenMatcherPair.hostm, addr.Host)
-			}
-		}
-	}
-
-	// iterate each pairing of host and path matchers and
-	// put them into a map for JSON encoding
-	var matcherSets []map[string]caddyhttp.RequestMatcher
-	for _, mp := range matcherPairs {
-		matcherSet := make(map[string]caddyhttp.RequestMatcher)
-		if len(mp.hostm) > 0 {
-			matcherSet["host"] = mp.hostm
-		}
-		if len(mp.pathm) > 0 {
-			matcherSet["path"] = mp.pathm
-		}
-		if len(matcherSet) > 0 {
-			matcherSets = append(matcherSets, matcherSet)
-		}
-	}
-
-	// finally, encode each of the matcher sets
-	var matcherSetsEnc []caddy.ModuleMap
-	for _, ms := range matcherSets {
-		msEncoded, err := encodeMatcherSet(ms)
-		if err != nil {
-			return nil, fmt.Errorf("server block %v: %v", sblock.Keys, err)
-		}
-		matcherSetsEnc = append(matcherSetsEnc, msEncoded)
-	}
-
-	return matcherSetsEnc, nil
-}
-
-func parseMatcherDefinitions(d *caddyfile.Dispenser, matchers map[string]caddy.ModuleMap) error {
-	for d.Next() {
-		definitionName := d.Val()
-
-		if _, ok := matchers[definitionName]; ok {
-			return fmt.Errorf("matcher is defined more than once: %s", definitionName)
-		}
-		matchers[definitionName] = make(caddy.ModuleMap)
-
-		// in case there are multiple instances of the same matcher, concatenate
-		// their tokens (we expect that UnmarshalCaddyfile should be able to
-		// handle more than one segment); otherwise, we'd overwrite other
-		// instances of the matcher in this set
-		tokensByMatcherName := make(map[string][]caddyfile.Token)
-		for nesting := d.Nesting(); d.NextBlock(nesting); {
-			matcherName := d.Val()
-			tokensByMatcherName[matcherName] = append(tokensByMatcherName[matcherName], d.NextSegment()...)
-		}
-		for matcherName, tokens := range tokensByMatcherName {
-			mod, err := caddy.GetModule("http.matchers." + matcherName)
-			if err != nil {
-				return fmt.Errorf("getting matcher module '%s': %v", matcherName, err)
-			}
-			unm, ok := mod.New().(caddyfile.Unmarshaler)
-			if !ok {
-				return fmt.Errorf("matcher module '%s' is not a Caddyfile unmarshaler", matcherName)
-			}
-			err = unm.UnmarshalCaddyfile(caddyfile.NewDispenser(tokens))
-			if err != nil {
-				return err
-			}
-			rm, ok := unm.(caddyhttp.RequestMatcher)
-			if !ok {
-				return fmt.Errorf("matcher module '%s' is not a request matcher", matcherName)
-			}
-			matchers[definitionName][matcherName] = caddyconfig.JSON(rm, nil)
-		}
-	}
-	return nil
-}
-
-func encodeMatcherSet(matchers map[string]caddyhttp.RequestMatcher) (caddy.ModuleMap, error) {
-	msEncoded := make(caddy.ModuleMap)
-	for matcherName, val := range matchers {
-		jsonBytes, err := json.Marshal(val)
-		if err != nil {
-			return nil, fmt.Errorf("marshaling matcher set %#v: %v", matchers, err)
-		}
-		msEncoded[matcherName] = jsonBytes
-	}
-	return msEncoded, nil
-}
-
-// tryInt tries to convert val to an integer. If it fails,
-// it downgrades the error to a warning and returns 0.
-func tryInt(val interface{}, warnings *[]caddyconfig.Warning) int {
-	intVal, ok := val.(int)
-	if val != nil && !ok && warnings != nil {
-		*warnings = append(*warnings, caddyconfig.Warning{Message: "not an integer type"})
-	}
-	return intVal
-}
-
-func tryString(val interface{}, warnings *[]caddyconfig.Warning) string {
-	stringVal, ok := val.(string)
-	if val != nil && !ok && warnings != nil {
-		*warnings = append(*warnings, caddyconfig.Warning{Message: "not a string type"})
-	}
-	return stringVal
-}
-
-// sliceContains returns true if needle is in haystack.
-func sliceContains(haystack []string, needle string) bool {
-	for _, s := range haystack {
-		if s == needle {
-			return true
-		}
-	}
-	return false
-}
-
-// specificity returns len(s) minus any wildcards (*) and
-// placeholders ({...}). Basically, it's a length count
-// that penalizes the use of wildcards and placeholders.
-// This is useful for comparing hostnames and paths.
-// However, wildcards in paths are not a sure answer to
-// the question of specificity. For example,
-// '*.example.com' is clearly less specific than
-// 'a.example.com', but is '/a' more or less specific
-// than '/a*'?
-func specificity(s string) int {
-	l := len(s) - strings.Count(s, "*")
-	for len(s) > 0 {
-		start := strings.Index(s, "{")
-		if start < 0 {
-			return l
-		}
-		end := strings.Index(s[start:], "}") + start + 1
-		if end <= start {
-			return l
-		}
-		l -= end - start
-		s = s[end:]
-	}
-	return l
-}
-
-type counter struct {
-	n *int
-}
-
-func (c counter) nextGroup() string {
-	name := fmt.Sprintf("group%d", *c.n)
-	*c.n++
-	return name
-}
-
-type namedCustomLog struct {
-	name string
-	log  *caddy.CustomLog
-}
-
-// sbAddrAssociation is a mapping from a list of
-// addresses to a list of server blocks that are
-// served on those addresses.
-type sbAddrAssociation struct {
-	addresses    []string
-	serverBlocks []serverBlock
-}
-
-const matcherPrefix = "@"
-
-// Interface guard
-var _ caddyfile.ServerType = (*ServerType)(nil)

caddyconfig/httpcaddyfile/httptype_test.go

@@ -1,149 +0,0 @@
-package httpcaddyfile
-
-import (
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-)
-
-func TestServerType(t *testing.T) {
-	for i, tc := range []struct {
-		input       string
-		expectWarn  bool
-		expectError bool
-	}{
-		{
-			input: `http://localhost
-			@debug {
-			  query showdebug=1
-			}
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `http://localhost
-			@debug {
-			  query bad format
-			}
-			`,
-			expectWarn:  false,
-			expectError: true,
-		},
-	} {
-
-		adapter := caddyfile.Adapter{
-			ServerType: ServerType{},
-		}
-
-		_, warnings, err := adapter.Adapt([]byte(tc.input), nil)
-
-		if len(warnings) > 0 != tc.expectWarn {
-			t.Errorf("Test %d warning expectation failed Expected: %v, got %v", i, tc.expectWarn, warnings)
-			continue
-		}
-
-		if err != nil != tc.expectError {
-			t.Errorf("Test %d error expectation failed Expected: %v, got %s", i, tc.expectError, err)
-			continue
-		}
-	}
-}
-
-func TestSpecificity(t *testing.T) {
-	for i, tc := range []struct {
-		input  string
-		expect int
-	}{
-		{"", 0},
-		{"*", 0},
-		{"*.*", 1},
-		{"{placeholder}", 0},
-		{"/{placeholder}", 1},
-		{"foo", 3},
-		{"example.com", 11},
-		{"a.example.com", 13},
-		{"*.example.com", 12},
-		{"/foo", 4},
-		{"/foo*", 4},
-		{"{placeholder}.example.com", 12},
-		{"{placeholder.example.com", 24},
-		{"}.", 2},
-		{"}{", 2},
-		{"{}", 0},
-		{"{{{}}", 1},
-	} {
-		actual := specificity(tc.input)
-		if actual != tc.expect {
-			t.Errorf("Test %d (%s): Expected %d but got %d", i, tc.input, tc.expect, actual)
-		}
-	}
-}
-
-func TestGlobalOptions(t *testing.T) {
-	for i, tc := range []struct {
-		input       string
-		expectWarn  bool
-		expectError bool
-	}{
-		{
-			input: `
-				{
-					email test@example.com
-				}
-				:80
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `
-				{
-					admin off
-				}
-				:80
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `
-				{
-					admin 127.0.0.1:2020
-				}
-				:80
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `
-				{
-					admin {
-						disabled false
-					}
-				}
-				:80
-			`,
-			expectWarn:  false,
-			expectError: true,
-		},
-	} {
-
-		adapter := caddyfile.Adapter{
-			ServerType: ServerType{},
-		}
-
-		_, warnings, err := adapter.Adapt([]byte(tc.input), nil)
-
-		if len(warnings) > 0 != tc.expectWarn {
-			t.Errorf("Test %d warning expectation failed Expected: %v, got %v", i, tc.expectWarn, warnings)
-			continue
-		}
-
-		if err != nil != tc.expectError {
-			t.Errorf("Test %d error expectation failed Expected: %v, got %s", i, tc.expectError, err)
-			continue
-		}
-	}
-}

caddyconfig/httpcaddyfile/options.go

@@ -1,250 +0,0 @@
-// 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 httpcaddyfile
-
-import (
-	"strconv"
-	"time"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-)
-
-func parseOptHTTPPort(d *caddyfile.Dispenser) (int, error) {
-	var httpPort int
-	for d.Next() {
-		var httpPortStr string
-		if !d.AllArgs(&httpPortStr) {
-			return 0, d.ArgErr()
-		}
-		var err error
-		httpPort, err = strconv.Atoi(httpPortStr)
-		if err != nil {
-			return 0, d.Errf("converting port '%s' to integer value: %v", httpPortStr, err)
-		}
-	}
-	return httpPort, nil
-}
-
-func parseOptHTTPSPort(d *caddyfile.Dispenser) (int, error) {
-	var httpsPort int
-	for d.Next() {
-		var httpsPortStr string
-		if !d.AllArgs(&httpsPortStr) {
-			return 0, d.ArgErr()
-		}
-		var err error
-		httpsPort, err = strconv.Atoi(httpsPortStr)
-		if err != nil {
-			return 0, d.Errf("converting port '%s' to integer value: %v", httpsPortStr, err)
-		}
-	}
-	return httpsPort, nil
-}
-
-func parseOptExperimentalHTTP3(d *caddyfile.Dispenser) (bool, error) {
-	return true, nil
-}
-
-func parseOptOrder(d *caddyfile.Dispenser) ([]string, error) {
-	newOrder := directiveOrder
-
-	for d.Next() {
-		// get directive name
-		if !d.Next() {
-			return nil, d.ArgErr()
-		}
-		dirName := d.Val()
-		if _, ok := registeredDirectives[dirName]; !ok {
-			return nil, d.Errf("%s is not a registered directive", dirName)
-		}
-
-		// get positional token
-		if !d.Next() {
-			return nil, d.ArgErr()
-		}
-		pos := d.Val()
-
-		// if directive exists, first remove it
-		for i, d := range newOrder {
-			if d == dirName {
-				newOrder = append(newOrder[:i], newOrder[i+1:]...)
-				break
-			}
-		}
-
-		// act on the positional
-		switch pos {
-		case "first":
-			newOrder = append([]string{dirName}, newOrder...)
-			if d.NextArg() {
-				return nil, d.ArgErr()
-			}
-			directiveOrder = newOrder
-			return newOrder, nil
-		case "last":
-			newOrder = append(newOrder, dirName)
-			if d.NextArg() {
-				return nil, d.ArgErr()
-			}
-			directiveOrder = newOrder
-			return newOrder, nil
-		case "before":
-		case "after":
-		default:
-			return nil, d.Errf("unknown positional '%s'", pos)
-		}
-
-		// get name of other directive
-		if !d.NextArg() {
-			return nil, d.ArgErr()
-		}
-		otherDir := d.Val()
-		if d.NextArg() {
-			return nil, d.ArgErr()
-		}
-
-		// insert directive into proper position
-		for i, d := range newOrder {
-			if d == otherDir {
-				if pos == "before" {
-					newOrder = append(newOrder[:i], append([]string{dirName}, newOrder[i:]...)...)
-				} else if pos == "after" {
-					newOrder = append(newOrder[:i+1], append([]string{dirName}, newOrder[i+1:]...)...)
-				}
-				break
-			}
-		}
-	}
-
-	directiveOrder = newOrder
-
-	return newOrder, nil
-}
-
-func parseOptStorage(d *caddyfile.Dispenser) (caddy.StorageConverter, error) {
-	if !d.Next() {
-		return nil, d.ArgErr()
-	}
-	args := d.RemainingArgs()
-	if len(args) != 1 {
-		return nil, d.ArgErr()
-	}
-	modName := args[0]
-	mod, err := caddy.GetModule("caddy.storage." + modName)
-	if err != nil {
-		return nil, d.Errf("getting storage module '%s': %v", modName, err)
-	}
-	unm, ok := mod.New().(caddyfile.Unmarshaler)
-	if !ok {
-		return nil, d.Errf("storage module '%s' is not a Caddyfile unmarshaler", mod.ID)
-	}
-	err = unm.UnmarshalCaddyfile(d.NewFromNextSegment())
-	if err != nil {
-		return nil, err
-	}
-	storage, ok := unm.(caddy.StorageConverter)
-	if !ok {
-		return nil, d.Errf("module %s is not a StorageConverter", mod.ID)
-	}
-	return storage, nil
-}
-
-func parseOptSingleString(d *caddyfile.Dispenser) (string, error) {
-	d.Next() // consume parameter name
-	if !d.Next() {
-		return "", d.ArgErr()
-	}
-	val := d.Val()
-	if d.Next() {
-		return "", d.ArgErr()
-	}
-	return val, nil
-}
-
-func parseOptAdmin(d *caddyfile.Dispenser) (string, error) {
-	if d.Next() {
-		var listenAddress string
-		if !d.AllArgs(&listenAddress) {
-			return "", d.ArgErr()
-		}
-		if listenAddress == "" {
-			listenAddress = caddy.DefaultAdminListen
-		}
-		return listenAddress, nil
-	}
-	return "", nil
-}
-
-func parseOptOnDemand(d *caddyfile.Dispenser) (*caddytls.OnDemandConfig, error) {
-	var ond *caddytls.OnDemandConfig
-	for d.Next() {
-		if d.NextArg() {
-			return nil, d.ArgErr()
-		}
-		for nesting := d.Nesting(); d.NextBlock(nesting); {
-			switch d.Val() {
-			case "ask":
-				if !d.NextArg() {
-					return nil, d.ArgErr()
-				}
-				if ond == nil {
-					ond = new(caddytls.OnDemandConfig)
-				}
-				ond.Ask = d.Val()
-
-			case "interval":
-				if !d.NextArg() {
-					return nil, d.ArgErr()
-				}
-				dur, err := time.ParseDuration(d.Val())
-				if err != nil {
-					return nil, err
-				}
-				if ond == nil {
-					ond = new(caddytls.OnDemandConfig)
-				}
-				if ond.RateLimit == nil {
-					ond.RateLimit = new(caddytls.RateLimit)
-				}
-				ond.RateLimit.Interval = caddy.Duration(dur)
-
-			case "burst":
-				if !d.NextArg() {
-					return nil, d.ArgErr()
-				}
-				burst, err := strconv.Atoi(d.Val())
-				if err != nil {
-					return nil, err
-				}
-				if ond == nil {
-					ond = new(caddytls.OnDemandConfig)
-				}
-				if ond.RateLimit == nil {
-					ond.RateLimit = new(caddytls.RateLimit)
-				}
-				ond.RateLimit.Burst = burst
-
-			default:
-				return nil, d.Errf("unrecognized parameter '%s'", d.Val())
-			}
-		}
-	}
-	if ond == nil {
-		return nil, d.Err("expected at least one config parameter for on_demand_tls")
-	}
-	return ond, nil
-}

caddyconfig/httpcaddyfile/tlsapp.go

@@ -1,386 +0,0 @@
-// 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 httpcaddyfile
-
-import (
-	"bytes"
-	"fmt"
-	"reflect"
-	"sort"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-	"github.com/caddyserver/certmagic"
-)
-
-func (st ServerType) buildTLSApp(
-	pairings []sbAddrAssociation,
-	options map[string]interface{},
-	warnings []caddyconfig.Warning,
-) (*caddytls.TLS, []caddyconfig.Warning, error) {
-
-	tlsApp := &caddytls.TLS{CertificatesRaw: make(caddy.ModuleMap)}
-	var certLoaders []caddytls.CertificateLoader
-
-	// count how many server blocks have a key with no host,
-	// and find all hosts that share a server block with a
-	// hostless key, so that they don't get forgotten/omitted
-	// by auto-HTTPS (since they won't appear in route matchers)
-	var serverBlocksWithHostlessKey int
-	hostsSharedWithHostlessKey := make(map[string]struct{})
-	for _, pair := range pairings {
-		for _, sb := range pair.serverBlocks {
-			for _, key := range sb.block.Keys {
-				addr, err := ParseAddress(key)
-				if err != nil {
-					return nil, warnings, err
-				}
-				addr = addr.Normalize()
-				if addr.Host == "" {
-					serverBlocksWithHostlessKey++
-					// this server block has a hostless key, now
-					// go through and add all the hosts to the set
-					for _, otherKey := range sb.block.Keys {
-						if otherKey == key {
-							continue
-						}
-						addr, err := ParseAddress(otherKey)
-						if err != nil {
-							return nil, warnings, err
-						}
-						addr = addr.Normalize()
-						if addr.Host != "" {
-							hostsSharedWithHostlessKey[addr.Host] = struct{}{}
-						}
-					}
-					break
-				}
-			}
-		}
-	}
-
-	catchAllAP, err := newBaseAutomationPolicy(options, warnings, false)
-	if err != nil {
-		return nil, warnings, err
-	}
-
-	for _, p := range pairings {
-		for _, sblock := range p.serverBlocks {
-			// get values that populate an automation policy for this block
-			var ap *caddytls.AutomationPolicy
-
-			sblockHosts, err := st.hostsFromServerBlockKeys(sblock.block)
-			if err != nil {
-				return nil, warnings, err
-			}
-			if len(sblockHosts) == 0 {
-				ap = catchAllAP
-			}
-
-			// on-demand tls
-			if _, ok := sblock.pile["tls.on_demand"]; ok {
-				if ap == nil {
-					var err error
-					ap, err = newBaseAutomationPolicy(options, warnings, true)
-					if err != nil {
-						return nil, warnings, err
-					}
-				}
-				ap.OnDemand = true
-			}
-
-			// certificate issuers
-			if issuerVals, ok := sblock.pile["tls.cert_issuer"]; ok {
-				for _, issuerVal := range issuerVals {
-					issuer := issuerVal.Value.(certmagic.Issuer)
-					if ap == nil {
-						var err error
-						ap, err = newBaseAutomationPolicy(options, warnings, true)
-						if err != nil {
-							return nil, warnings, err
-						}
-					}
-					encoded := caddyconfig.JSONModuleObject(issuer, "module", issuer.(caddy.Module).CaddyModule().ID.Name(), &warnings)
-					if ap == catchAllAP && ap.IssuerRaw != nil && !bytes.Equal(ap.IssuerRaw, encoded) {
-						return nil, warnings, fmt.Errorf("conflicting issuer configuration: %s != %s", ap.IssuerRaw, encoded)
-					}
-					ap.IssuerRaw = encoded
-				}
-			}
-
-			if ap != nil {
-				// first make sure this block is allowed to create an automation policy;
-				// doing so is forbidden if it has a key with no host (i.e. ":443")
-				// and if there is a different server block that also has a key with no
-				// host -- since a key with no host matches any host, we need its
-				// associated automation policy to have an empty Subjects list, i.e. no
-				// host filter, which is indistinguishable between the two server blocks
-				// because automation is not done in the context of a particular server...
-				// this is an example of a poor mapping from Caddyfile to JSON but that's
-				// the least-leaky abstraction I could figure out
-				if len(sblockHosts) == 0 {
-					if serverBlocksWithHostlessKey > 1 {
-						// this server block and at least one other has a key with no host,
-						// making the two indistinguishable; it is misleading to define such
-						// a policy within one server block since it actually will apply to
-						// others as well
-						return nil, warnings, fmt.Errorf("cannot make a TLS automation policy from a server block that has a host-less address when there are other server block addresses lacking a host")
-					}
-					if catchAllAP == nil {
-						// this server block has a key with no hosts, but there is not yet
-						// a catch-all automation policy (probably because no global options
-						// were set), so this one becomes it
-						catchAllAP = ap
-					}
-				}
-
-				// associate our new automation policy with this server block's hosts,
-				// unless, of course, the server block has a key with no hosts, in which
-				// case its automation policy becomes or blends with the default/global
-				// automation policy because, of necessity, it applies to all hostnames
-				// (i.e. it has no Subjects filter) -- in that case, we'll append it last
-				if ap != catchAllAP {
-					ap.Subjects = sblockHosts
-
-					// if a combination of public and internal names were given
-					// for this same server block and no issuer was specified, we
-					// need to separate them out in the automation policies so
-					// that the internal names can use the internal issuer and
-					// the other names can use the default/public/ACME issuer
-					var ap2 *caddytls.AutomationPolicy
-					if ap.Issuer == nil {
-						var internal, external []string
-						for _, s := range ap.Subjects {
-							if certmagic.SubjectQualifiesForPublicCert(s) {
-								external = append(external, s)
-							} else {
-								internal = append(internal, s)
-							}
-						}
-						if len(external) > 0 && len(internal) > 0 {
-							ap.Subjects = external
-							apCopy := *ap
-							ap2 = &apCopy
-							ap2.Subjects = internal
-							ap2.IssuerRaw = caddyconfig.JSONModuleObject(caddytls.InternalIssuer{}, "module", "internal", &warnings)
-						}
-					}
-					if tlsApp.Automation == nil {
-						tlsApp.Automation = new(caddytls.AutomationConfig)
-					}
-					tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, ap)
-					if ap2 != nil {
-						tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, ap2)
-					}
-				}
-			}
-
-			// certificate loaders
-			if clVals, ok := sblock.pile["tls.certificate_loader"]; ok {
-				for _, clVal := range clVals {
-					certLoaders = append(certLoaders, clVal.Value.(caddytls.CertificateLoader))
-				}
-			}
-		}
-	}
-
-	// group certificate loaders by module name, then add to config
-	if len(certLoaders) > 0 {
-		loadersByName := make(map[string]caddytls.CertificateLoader)
-		for _, cl := range certLoaders {
-			name := caddy.GetModuleName(cl)
-			// ugh... technically, we may have multiple FileLoader and FolderLoader
-			// modules (because the tls directive returns one per occurrence), but
-			// the config structure expects only one instance of each kind of loader
-			// module, so we have to combine them... instead of enumerating each
-			// possible cert loader module in a type switch, we can use reflection,
-			// which works on any cert loaders that are slice types
-			if reflect.TypeOf(cl).Kind() == reflect.Slice {
-				combined := reflect.ValueOf(loadersByName[name])
-				if !combined.IsValid() {
-					combined = reflect.New(reflect.TypeOf(cl)).Elem()
-				}
-				clVal := reflect.ValueOf(cl)
-				for i := 0; i < clVal.Len(); i++ {
-					combined = reflect.Append(reflect.Value(combined), clVal.Index(i))
-				}
-				loadersByName[name] = combined.Interface().(caddytls.CertificateLoader)
-			}
-		}
-		for certLoaderName, loaders := range loadersByName {
-			tlsApp.CertificatesRaw[certLoaderName] = caddyconfig.JSON(loaders, &warnings)
-		}
-	}
-
-	// set any of the on-demand options, for if/when on-demand TLS is enabled
-	if onDemand, ok := options["on_demand_tls"].(*caddytls.OnDemandConfig); ok {
-		if tlsApp.Automation == nil {
-			tlsApp.Automation = new(caddytls.AutomationConfig)
-		}
-		tlsApp.Automation.OnDemand = onDemand
-	}
-
-	// if there is a global/catch-all automation policy, ensure it goes last
-	if catchAllAP != nil {
-		if tlsApp.Automation == nil {
-			tlsApp.Automation = new(caddytls.AutomationConfig)
-		}
-		tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, catchAllAP)
-	}
-
-	// if any hostnames appear on the same server block as a key with
-	// no host, they will not be used with route matchers because the
-	// hostless key matches all hosts, therefore, it wouldn't be
-	// considered for auto-HTTPS, so we need to make sure those hosts
-	// are manually considered for managed certificates
-	var al caddytls.AutomateLoader
-	for h := range hostsSharedWithHostlessKey {
-		al = append(al, h)
-	}
-	if len(al) > 0 {
-		tlsApp.CertificatesRaw["automate"] = caddyconfig.JSON(al, &warnings)
-	}
-
-	// do a little verification & cleanup
-	if tlsApp.Automation != nil {
-		// ensure automation policies don't overlap subjects (this should be
-		// an error at provision-time as well, but catch it in the adapt phase
-		// for convenience)
-		automationHostSet := make(map[string]struct{})
-		for _, ap := range tlsApp.Automation.Policies {
-			for _, s := range ap.Subjects {
-				if _, ok := automationHostSet[s]; ok {
-					return nil, warnings, fmt.Errorf("hostname appears in more than one automation policy, making certificate management ambiguous: %s", s)
-				}
-				automationHostSet[s] = struct{}{}
-			}
-		}
-
-		// consolidate automation policies that are the exact same
-		tlsApp.Automation.Policies = consolidateAutomationPolicies(tlsApp.Automation.Policies)
-	}
-
-	return tlsApp, warnings, nil
-}
-
-// newBaseAutomationPolicy returns a new TLS automation policy that gets
-// its values from the global options map. It should be used as the base
-// for any other automation policies. A nil policy (and no error) will be
-// returned if there are no default/global options. However, if always is
-// true, a non-nil value will always be returned (unless there is an error).
-func newBaseAutomationPolicy(options map[string]interface{}, warnings []caddyconfig.Warning, always bool) (*caddytls.AutomationPolicy, error) {
-	acmeCA, hasACMECA := options["acme_ca"]
-	acmeDNS, hasACMEDNS := options["acme_dns"]
-	acmeCARoot, hasACMECARoot := options["acme_ca_root"]
-	email, hasEmail := options["email"]
-	localCerts, hasLocalCerts := options["local_certs"]
-
-	hasGlobalAutomationOpts := hasACMECA || hasACMEDNS || hasACMECARoot || hasEmail || hasLocalCerts
-
-	// if there are no global options related to automation policies
-	// set, then we can just return right away
-	if !hasGlobalAutomationOpts {
-		if always {
-			return new(caddytls.AutomationPolicy), nil
-		}
-		return nil, nil
-	}
-
-	ap := new(caddytls.AutomationPolicy)
-
-	if localCerts != nil {
-		// internal issuer enabled trumps any ACME configurations; useful in testing
-		ap.IssuerRaw = caddyconfig.JSONModuleObject(caddytls.InternalIssuer{}, "module", "internal", &warnings)
-	} else {
-		if acmeCA == nil {
-			acmeCA = ""
-		}
-		if email == nil {
-			email = ""
-		}
-		mgr := caddytls.ACMEIssuer{
-			CA:    acmeCA.(string),
-			Email: email.(string),
-		}
-		if acmeDNS != nil {
-			provName := acmeDNS.(string)
-			dnsProvModule, err := caddy.GetModule("tls.dns." + provName)
-			if err != nil {
-				return nil, fmt.Errorf("getting DNS provider module named '%s': %v", provName, err)
-			}
-			mgr.Challenges = &caddytls.ChallengesConfig{
-				DNSRaw: caddyconfig.JSONModuleObject(dnsProvModule.New(), "provider", provName, &warnings),
-			}
-		}
-		if acmeCARoot != nil {
-			mgr.TrustedRootsPEMFiles = []string{acmeCARoot.(string)}
-		}
-		ap.IssuerRaw = caddyconfig.JSONModuleObject(mgr, "module", "acme", &warnings)
-	}
-
-	return ap, nil
-}
-
-// consolidateAutomationPolicies combines automation policies that are the same,
-// for a cleaner overall output.
-func consolidateAutomationPolicies(aps []*caddytls.AutomationPolicy) []*caddytls.AutomationPolicy {
-	for i := 0; i < len(aps); i++ {
-		for j := 0; j < len(aps); j++ {
-			if j == i {
-				continue
-			}
-
-			// if they're exactly equal in every way, just keep one of them
-			if reflect.DeepEqual(aps[i], aps[j]) {
-				aps = append(aps[:j], aps[j+1:]...)
-				i--
-				break
-			}
-
-			// if the policy is the same, we can keep just one, but we have
-			// to be careful which one we keep; if only one has any hostnames
-			// defined, then we need to keep the one without any hostnames,
-			// otherwise the one without any subjects (a catch-all) would be
-			// eaten up by the one with subjects; and if both have subjects, we
-			// need to combine their lists
-			if bytes.Equal(aps[i].IssuerRaw, aps[j].IssuerRaw) &&
-				bytes.Equal(aps[i].StorageRaw, aps[j].StorageRaw) &&
-				aps[i].MustStaple == aps[j].MustStaple &&
-				aps[i].KeyType == aps[j].KeyType &&
-				aps[i].OnDemand == aps[j].OnDemand &&
-				aps[i].RenewalWindowRatio == aps[j].RenewalWindowRatio &&
-				aps[i].ManageSync == aps[j].ManageSync {
-				if len(aps[i].Subjects) == 0 && len(aps[j].Subjects) > 0 {
-					aps = append(aps[:j], aps[j+1:]...)
-				} else if len(aps[i].Subjects) > 0 && len(aps[j].Subjects) == 0 {
-					aps = append(aps[:i], aps[i+1:]...)
-				} else {
-					aps[i].Subjects = append(aps[i].Subjects, aps[j].Subjects...)
-					aps = append(aps[:j], aps[j+1:]...)
-				}
-				i--
-				break
-			}
-		}
-	}
-
-	// ensure any catch-all policies go last
-	sort.SliceStable(aps, func(i, j int) bool {
-		return len(aps[i].Subjects) > len(aps[j].Subjects)
-	})
-
-	return aps
-}

caddyconfig/json5/json5.go

@@ -1,43 +0,0 @@
-// 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 json5adapter
-
-import (
-	"encoding/json"
-
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/ilibs/json5"
-)
-
-func init() {
-	caddyconfig.RegisterAdapter("json5", Adapter{})
-}
-
-// Adapter adapts JSON5 to Caddy JSON.
-type Adapter struct{}
-
-// Adapt converts the JSON5 config in body to Caddy JSON.
-func (a Adapter) Adapt(body []byte, options map[string]interface{}) (result []byte, warnings []caddyconfig.Warning, err error) {
-	var decoded interface{}
-	err = json5.Unmarshal(body, &decoded)
-	if err != nil {
-		return
-	}
-	result, err = json.Marshal(decoded)
-	return
-}
-
-// Interface guard
-var _ caddyconfig.Adapter = (*Adapter)(nil)

caddyconfig/jsonc/jsonc.go

@@ -1,49 +0,0 @@
-// 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 jsoncadapter
-
-import (
-	"encoding/json"
-
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/muhammadmuzzammil1998/jsonc"
-)
-
-func init() {
-	caddyconfig.RegisterAdapter("jsonc", Adapter{})
-}
-
-// Adapter adapts JSON-C to Caddy JSON.
-type Adapter struct{}
-
-// Adapt converts the JSON-C config in body to Caddy JSON.
-func (a Adapter) Adapt(body []byte, options map[string]interface{}) (result []byte, warnings []caddyconfig.Warning, err error) {
-	result = jsonc.ToJSON(body)
-
-	// any errors in the JSON will be
-	// reported during config load, but
-	// we can at least warn here that
-	// it is not valid JSON
-	if !json.Valid(result) {
-		warnings = append(warnings, caddyconfig.Warning{
-			Message: "Resulting JSON is invalid.",
-		})
-	}
-
-	return
-}
-
-// Interface guard
-var _ caddyconfig.Adapter = (*Adapter)(nil)

caddyconfig/load.go

@@ -1,153 +0,0 @@
-// 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 caddyconfig
-
-import (
-	"bytes"
-	"encoding/json"
-	"fmt"
-	"io"
-	"mime"
-	"net/http"
-	"strings"
-	"sync"
-
-	"github.com/caddyserver/caddy/v2"
-)
-
-func init() {
-	caddy.RegisterModule(adminLoad{})
-}
-
-// adminLoad is a module that provides the /load endpoint
-// for the Caddy admin API. The only reason it's not baked
-// into the caddy package directly is because of the import
-// of the caddyconfig package for its GetAdapter function.
-// If the caddy package depends on the caddyconfig package,
-// then the caddyconfig package will not be able to import
-// the caddy package, and it can more easily cause backward
-// edges in the dependency tree (i.e. import cycle).
-// Fortunately, the admin API has first-class support for
-// adding endpoints from modules.
-type adminLoad struct{}
-
-// CaddyModule returns the Caddy module information.
-func (adminLoad) CaddyModule() caddy.ModuleInfo {
-	return caddy.ModuleInfo{
-		ID:  "admin.api.load",
-		New: func() caddy.Module { return new(adminLoad) },
-	}
-}
-
-// Routes returns a route for the /load endpoint.
-func (al adminLoad) Routes() []caddy.AdminRoute {
-	return []caddy.AdminRoute{
-		{
-			Pattern: "/load",
-			Handler: caddy.AdminHandlerFunc(al.handleLoad),
-		},
-	}
-}
-
-// handleLoad replaces the entire current configuration with
-// a new one provided in the response body. It supports config
-// adapters through the use of the Content-Type header. A
-// config that is identical to the currently-running config
-// will be a no-op unless Cache-Control: must-revalidate is set.
-func (adminLoad) handleLoad(w http.ResponseWriter, r *http.Request) error {
-	if r.Method != http.MethodPost {
-		return caddy.APIError{
-			Code: http.StatusMethodNotAllowed,
-			Err:  fmt.Errorf("method not allowed"),
-		}
-	}
-
-	buf := bufPool.Get().(*bytes.Buffer)
-	buf.Reset()
-	defer bufPool.Put(buf)
-
-	_, err := io.Copy(buf, r.Body)
-	if err != nil {
-		return caddy.APIError{
-			Code: http.StatusBadRequest,
-			Err:  fmt.Errorf("reading request body: %v", err),
-		}
-	}
-	body := buf.Bytes()
-
-	// if the config is formatted other than Caddy's native
-	// JSON, we need to adapt it before loading it
-	if ctHeader := r.Header.Get("Content-Type"); ctHeader != "" {
-		ct, _, err := mime.ParseMediaType(ctHeader)
-		if err != nil {
-			return caddy.APIError{
-				Code: http.StatusBadRequest,
-				Err:  fmt.Errorf("invalid Content-Type: %v", err),
-			}
-		}
-		if !strings.HasSuffix(ct, "/json") {
-			slashIdx := strings.Index(ct, "/")
-			if slashIdx < 0 {
-				return caddy.APIError{
-					Code: http.StatusBadRequest,
-					Err:  fmt.Errorf("malformed Content-Type"),
-				}
-			}
-			adapterName := ct[slashIdx+1:]
-			cfgAdapter := GetAdapter(adapterName)
-			if cfgAdapter == nil {
-				return caddy.APIError{
-					Code: http.StatusBadRequest,
-					Err:  fmt.Errorf("unrecognized config adapter '%s'", adapterName),
-				}
-			}
-			result, warnings, err := cfgAdapter.Adapt(body, nil)
-			if err != nil {
-				return caddy.APIError{
-					Code: http.StatusBadRequest,
-					Err:  fmt.Errorf("adapting config using %s adapter: %v", adapterName, err),
-				}
-			}
-			if len(warnings) > 0 {
-				respBody, err := json.Marshal(warnings)
-				if err != nil {
-					caddy.Log().Named("admin.api.load").Error(err.Error())
-				}
-				_, _ = w.Write(respBody)
-			}
-			body = result
-		}
-	}
-
-	forceReload := r.Header.Get("Cache-Control") == "must-revalidate"
-
-	err = caddy.Load(body, forceReload)
-	if err != nil {
-		return caddy.APIError{
-			Code: http.StatusBadRequest,
-			Err:  fmt.Errorf("loading config: %v", err),
-		}
-	}
-
-	caddy.Log().Named("admin.api").Info("load complete")
-
-	return nil
-}
-
-var bufPool = sync.Pool{
-	New: func() interface{} {
-		return new(bytes.Buffer)
-	},
-}

caddytest/a.caddy.localhost.crt

@@ -1,23 +0,0 @@
------BEGIN CERTIFICATE-----
-MIID5zCCAs8CFG4+w/pqR5AZQ+aVB330uRRRKMF0MA0GCSqGSIb3DQEBCwUAMIGv
-MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlkxGzAZBgNVBAoMEkxvY2FsIERldmVs
-b3BlbWVudDEbMBkGA1UEBwwSTG9jYWwgRGV2ZWxvcGVtZW50MRowGAYDVQQDDBFh
-LmNhZGR5LmxvY2FsaG9zdDEbMBkGA1UECwwSTG9jYWwgRGV2ZWxvcGVtZW50MSAw
-HgYJKoZIhvcNAQkBFhFhZG1pbkBjYWRkeS5sb2NhbDAeFw0yMDAzMTMxODUwMTda
-Fw0zMDAzMTExODUwMTdaMIGvMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlkxGzAZ
-BgNVBAoMEkxvY2FsIERldmVsb3BlbWVudDEbMBkGA1UEBwwSTG9jYWwgRGV2ZWxv
-cGVtZW50MRowGAYDVQQDDBFhLmNhZGR5LmxvY2FsaG9zdDEbMBkGA1UECwwSTG9j
-YWwgRGV2ZWxvcGVtZW50MSAwHgYJKoZIhvcNAQkBFhFhZG1pbkBjYWRkeS5sb2Nh
-bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMd9pC9wF7j0459FndPs
-Deud/rq41jEZFsVOVtjQgjS1A5ct6NfeMmSlq8i1F7uaTMPZjbOHzY6y6hzLc9+y
-/VWNgyUC543HjXnNTnp9Xug6tBBxOxvRMw5mv2nAyzjBGDePPgN84xKhOXG2Wj3u
-fOZ+VPVISefRNvjKfN87WLJ0B0HI9wplG5ASVdPQsWDY1cndrZgt2sxQ/3fjIno4
-VvrgRWC9Penizgps/a0ZcFZMD/6HJoX/mSZVa1LjopwbMTXvyHCpXkth21E+rBt6
-I9DMHerdioVQcX25CqPmAwePxPZSNGEQo/Qu32kzcmscmYxTtYBhDa+yLuHgGggI
-j7ECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAP/94KPtkpYtkWADnhtzDmgQ6Q1pH
-SubTUZdCwQtm6/LrvpT+uFNsOj4L3Mv3TVUnIQDmKd5VvR42W2MRBiTN2LQptgEn
-C7g9BB+UA9kjL3DPk1pJMjzxLHohh0uNLi7eh4mAj8eNvjz9Z4qMWPQoVS0y7/ZK
-cCBRKh2GkIqKm34ih6pX7xmMpPEQsFoTVPRHYJfYD1SZ8Iui+EN+7WqLuJWPsPXw
-JM1HuZKn7pZmJU2MZZBsrupHGUvNMbBg2mFJcxt4D1VvU+p+a67PSjpFQ6dJG2re
-pZoF+N1vMGAFkxe6UqhcC/bXDX+ILVQHJ+RNhzDO6DcWf8dRrC2LaJk3WA==
------END CERTIFICATE-----

caddytest/a.caddy.localhost.key

@@ -1,27 +0,0 @@
------BEGIN RSA PRIVATE KEY-----
-MIIEpAIBAAKCAQEAx32kL3AXuPTjn0Wd0+wN653+urjWMRkWxU5W2NCCNLUDly3o
-194yZKWryLUXu5pMw9mNs4fNjrLqHMtz37L9VY2DJQLnjceNec1Oen1e6Dq0EHE7
-G9EzDma/acDLOMEYN48+A3zjEqE5cbZaPe585n5U9UhJ59E2+Mp83ztYsnQHQcj3
-CmUbkBJV09CxYNjVyd2tmC3azFD/d+MiejhW+uBFYL096eLOCmz9rRlwVkwP/ocm
-hf+ZJlVrUuOinBsxNe/IcKleS2HbUT6sG3oj0Mwd6t2KhVBxfbkKo+YDB4/E9lI0
-YRCj9C7faTNyaxyZjFO1gGENr7Iu4eAaCAiPsQIDAQABAoIBAQDD/YFIBeWYlifn
-e9risQDAIrp3sk7lb9O6Rwv1+Wxi4hBEABvJsYhq74VFK/3EF4UhyWR5JIvkjYyK
-e6w887oGyoA05ZSe65XoO7fFidSrbbkoikZbPv3dQT7/ZCWEfdkQBNAVVyY0UGeC
-e3hPbjYRsb5AOSQ694X9idqC6uhqcOrBDjITFrctUoP4S6l9A6a+mLSUIwiICcuh
-mrNl+j0lzy7DMXRp/Z5Hyo5kuUlrC0dCLa1UHqtrrK7MR55AVEOihSNp1w+OC+vw
-f0VjE4JUtO7RQEQUmD1tDfLXwNfMFeWaobB2W0WMvRg0IqoitiqPxsPHRm56OxfM
-SRo/Q7QBAoGBAP8DapzBMuaIcJ7cE8Yl07ZGndWWf8buIKIItGF8rkEO3BXhrIke
-EmpOi+ELtpbMOG0APhORZyQ58f4ZOVrqZfneNKtDiEZV4mJZaYUESm1pU+2Y6+y5
-g4bpQSVKN0ow0xR+MH7qDYtSlsmBU7qAOz775L7BmMA1Bnu72aN/H1JBAoGBAMhD
-OzqCSakHOjUbEd22rPwqWmcIyVyo04gaSmcVVT2dHbqR4/t0gX5a9D9U2qwyO6xi
-/R+PXyMd32xIeVR2D/7SQ0x6dK68HXICLV8ofHZ5UQcHbxy5og4v/YxSZVTkN374
-cEsUeyB0s/UPOHLktFU5hpIlON72/Rp7b+pNIwFxAoGAczpq+Qu/YTWzlcSh1r4O
-7OT5uqI3eH7vFehTAV3iKxl4zxZa7NY+wfRd9kFhrr/2myIp6pOgBFl+hC+HoBIc
-JAyIxf5M3GNAWOpH6MfojYmzV7/qktu8l8BcJGplk0t+hVsDtMUze4nFAqZCXBpH
-Kw2M7bjyuZ78H/rgu6TcVUECgYEAo1M5ldE2U/VCApeuLX1TfWDpU8i1uK0zv3d5
-oLKkT1i5KzTak3SEO9HgC1qf8PoS8tfUio26UICHe99rnHehOfivzEq+qNdgyF+A
-M3BoeZMdgzcL5oh640k+Zte4LtDlddcWdhUhCepD7iPYrNNbQ3pkBwL2a9lRuOxc
-7OC2IPECgYBH8f3OrwXjDltIG1dDvuDPNljxLZbFEFbQyVzMePYNftgZknAyGEdh
-NW/LuWeTzstnmz/s6RE3jN5ZrrMa4sW77VA9+yU9QW2dkHqFyukQ4sfuNg6kDDNZ
-+lqZYMCLw0M5P9fIbmnIYwey7tXkHfmzoCpnYHGQDN6hL0Bh0zGwmg==
------END RSA PRIVATE KEY-----

caddytest/caddy.localhost.crt

@@ -1,23 +0,0 @@
------BEGIN CERTIFICATE-----
-MIID5zCCAs8CFFmAAFKV79uhzxc5qXbUw3oBNsYXMA0GCSqGSIb3DQEBCwUAMIGv
-MQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlkxGzAZBgNVBAoMEkxvY2FsIERldmVs
-b3BlbWVudDEbMBkGA1UEBwwSTG9jYWwgRGV2ZWxvcGVtZW50MRowGAYDVQQDDBEq
-LmNhZGR5LmxvY2FsaG9zdDEbMBkGA1UECwwSTG9jYWwgRGV2ZWxvcGVtZW50MSAw
-HgYJKoZIhvcNAQkBFhFhZG1pbkBjYWRkeS5sb2NhbDAeFw0yMDAzMDIwODAxMTZa
-Fw0zMDAyMjgwODAxMTZaMIGvMQswCQYDVQQGEwJVUzELMAkGA1UECAwCTlkxGzAZ
-BgNVBAoMEkxvY2FsIERldmVsb3BlbWVudDEbMBkGA1UEBwwSTG9jYWwgRGV2ZWxv
-cGVtZW50MRowGAYDVQQDDBEqLmNhZGR5LmxvY2FsaG9zdDEbMBkGA1UECwwSTG9j
-YWwgRGV2ZWxvcGVtZW50MSAwHgYJKoZIhvcNAQkBFhFhZG1pbkBjYWRkeS5sb2Nh
-bDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJngfeirQkWaU8ihgIC5
-SKpRQX/3koRjljDK/oCbhLs+wg592kIwVv06l7+mn7NSaNBloabjuA1GqyLRsNLL
-ptrv0HvXa5qLx28+icsb2Ny3dJnQaj9w9PwjxQ1qZqEJfWRH1D8Vz9AmB+QSV/Gu
-8e8alGFewlYZVfH1kbxoTT6QorF37TeA3bh1fgKFtzsGYKswcaZNdDBBHzLunCKZ
-HU6U6L45hm+yLADj3mmDLafUeiVOt6MRLLoSD1eLRVSXGrNo+brJ87zkZntI9+W1
-JxOBoXtZCwka7k2DlAtLihsrmBZA2ZC9yVeu/SQy3qb3iCNnTFTCyAnWeTCr6Tcq
-6w8CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAOWfXqpAmD4C3wGiMeZAeaaS4hDAR
-+JmN+avPDA6F6Bq7DB4NJuIwVUlaDL2s07w5VJJtW52aZVKoBlgHR5yG/XUli6J7
-YUJRmdQJvHUSu26cmKvyoOaTrEYbmvtGICWtZc8uTlMf9wQZbJA4KyxTgEQJDXsZ
-B2XFe+wVdhAgEpobYDROi+l/p8TL5z3U24LpwVTcJy5sEZVv7Wfs886IyxU8ORt8
-VZNcDiH6V53OIGeiufIhia/mPe6jbLntfGZfIFxtCcow4IA/lTy1ned7K5fmvNNb
-ZilxOQUk+wVK8genjdrZVAnAxsYLHJIb5yf9O7rr6fWciVMF3a0k5uNK1w==
------END CERTIFICATE-----

caddytest/caddy.localhost.key

@@ -1,27 +0,0 @@
------BEGIN RSA PRIVATE KEY-----
-MIIEogIBAAKCAQEAmeB96KtCRZpTyKGAgLlIqlFBf/eShGOWMMr+gJuEuz7CDn3a
-QjBW/TqXv6afs1Jo0GWhpuO4DUarItGw0sum2u/Qe9drmovHbz6JyxvY3Ld0mdBq
-P3D0/CPFDWpmoQl9ZEfUPxXP0CYH5BJX8a7x7xqUYV7CVhlV8fWRvGhNPpCisXft
-N4DduHV+AoW3OwZgqzBxpk10MEEfMu6cIpkdTpTovjmGb7IsAOPeaYMtp9R6JU63
-oxEsuhIPV4tFVJcas2j5usnzvORme0j35bUnE4Ghe1kLCRruTYOUC0uKGyuYFkDZ
-kL3JV679JDLepveII2dMVMLICdZ5MKvpNyrrDwIDAQABAoIBAFcPK01zb6hfm12c
-+k5aBiHOnUdgc/YRPg1XHEz5MEycQkDetZjTLrRQ7UBSbnKPgpu9lIsOtbhVLkgh
-6XAqJroiCou2oruqr+hhsqZGmBiwdvj7cNF6ADGTr05az7v22YneFdinZ481pStF
-sZocx+bm2+KHMV5zMSwXKyA0xtdJLxs2yklniDBxSZRppgppq1pDPprP5DkgKPfe
-3ekUmbQd5bHmivhW8ItbJLuf82XSsMBZ9ZhKiKIlWlbKAgiSV3SqnUQb5fi7l8hG
-yYZxbuCUIGFwKmEpUBBt/nyxrOlMiNtDh9JhrPmijTV3slq70pCLwLL/Ai2aeear
-EVA5VhkCgYEAyAmxfPqc2P7BsDAp67/sA7OEPso9qM4WyuWiVdlX2gb9TLNLYbPX
-Kk/UmpAIVzpoTAGY5Zp3wkvdD/ou8uUQsE8ioNn4S1a4G9XURH1wVhcEbUiAKI1S
-QVBH9B/Pj3eIp5OTKwob0Wj7DNdxoH7ed/Eok0EaTWzOA8pCWADKv/MCgYEAxOzY
-YsX7Nl+eyZr2+9unKyeAK/D1DCT/o99UUAHx72/xaBVP/06cfzpvKBNcF9iYc+fq
-R1yIUIrDRoSmYKBq+Kb3+nOg1nrqih/NBTokbTiI4Q+/30OQt0Al1e7y9iNKqV8H
-jYZItzluGNrWKedZbATwBwbVCY2jnNl6RMDnS3UCgYBxj3cwQUHLuoyQjjcuO80r
-qLzZvIxWiXDNDKIk5HcIMlGYOmz/8U2kGp/SgxQJGQJeq8V2C0QTjGfaCyieAcaA
-oNxCvptDgd6RBsoze5bLeNOtiqwe2WOp6n5+q5R0mOJ+Z7vzghCayGNFPgWmnH+F
-TeW/+wSIkc0+v5L8TK7NWwKBgBrlWlyLO9deUfqpHqihhICBYaEexOlGuF+yZfqT
-eW7BdFBJ8OYm33sFCR+JHV/oZlIWT8o1Wizd9vPPtEWoQ1P4wg/D8Si6GwSIeWEI
-YudD/HX4x7T/rmlI6qIAg9CYW18sqoRq3c2gm2fro6qPfYgiWIItLbWjUcBfd7Ki
-QjTtAoGARKdRv3jMWL84rlEx1nBRgL3pe9Dt+Uxzde2xT3ZeF+5Hp9NfU01qE6M6
-1I6H64smqpetlsXmCEVKwBemP3pJa6avLKgIYiQvHAD/v4rs9mqgy1RTqtYyGNhR
-1A/6dKkbiZ6wzePLLPasXVZxSKEviXf5gJooqumQVSVhCswyCZ0=
------END RSA PRIVATE KEY-----

caddytest/caddytest.go

@@ -1,309 +0,0 @@
-package caddytest
-
-import (
-	"bytes"
-	"context"
-	"crypto/tls"
-	"encoding/json"
-	"errors"
-	"fmt"
-	"io/ioutil"
-	"log"
-	"net"
-	"net/http"
-	"os"
-	"path"
-	"regexp"
-	"runtime"
-	"strings"
-	"testing"
-	"time"
-
-	caddycmd "github.com/caddyserver/caddy/v2/cmd"
-
-	// plug in Caddy modules here
-	_ "github.com/caddyserver/caddy/v2/modules/standard"
-)
-
-// Defaults store any configuration required to make the tests run
-type Defaults struct {
-	// Port we expect caddy to listening on
-	AdminPort int
-	// Certificates we expect to be loaded before attempting to run the tests
-	Certifcates []string
-}
-
-// Default testing values
-var Default = Defaults{
-	AdminPort:   2019,
-	Certifcates: []string{"/caddy.localhost.crt", "/caddy.localhost.key"},
-}
-
-var (
-	matchKey  = regexp.MustCompile(`(/[\w\d\.]+\.key)`)
-	matchCert = regexp.MustCompile(`(/[\w\d\.]+\.crt)`)
-)
-
-type configLoadError struct {
-	Response string
-}
-
-func (e configLoadError) Error() string { return e.Response }
-
-func timeElapsed(start time.Time, name string) {
-	elapsed := time.Since(start)
-	log.Printf("%s took %s", name, elapsed)
-}
-
-// InitServer this will configure the server with a configurion of a specific
-// type. The configType must be either "json" or the adapter type.
-func InitServer(t *testing.T, rawConfig string, configType string) {
-	if err := initServer(t, rawConfig, configType); errors.Is(err, &configLoadError{}) {
-		t.Logf("failed to load config: %s", err)
-		t.Fail()
-	}
-}
-
-// InitServer this will configure the server with a configurion of a specific
-// type. The configType must be either "json" or the adapter type.
-func initServer(t *testing.T, rawConfig string, configType string) error {
-
-	err := validateTestPrerequisites()
-	if err != nil {
-		t.Skipf("skipping tests as failed integration prerequisites. %s", err)
-		return nil
-	}
-
-	t.Cleanup(func() {
-		if t.Failed() {
-			res, err := http.Get(fmt.Sprintf("http://localhost:%d/config/", Default.AdminPort))
-			if err != nil {
-				t.Log("unable to read the current config")
-			}
-			defer res.Body.Close()
-			body, err := ioutil.ReadAll(res.Body)
-
-			var out bytes.Buffer
-			json.Indent(&out, body, "", "  ")
-			t.Logf("----------- failed with config -----------\n%s", out.String())
-		}
-	})
-
-	rawConfig = prependCaddyFilePath(rawConfig)
-	client := &http.Client{
-		Timeout: time.Second * 2,
-	}
-
-	start := time.Now()
-	req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/load", Default.AdminPort), strings.NewReader(rawConfig))
-	if err != nil {
-		t.Errorf("failed to create request. %s", err)
-		return err
-	}
-
-	if configType == "json" {
-		req.Header.Add("Content-Type", "application/json")
-	} else {
-		req.Header.Add("Content-Type", "text/"+configType)
-	}
-
-	res, err := client.Do(req)
-	if err != nil {
-		t.Errorf("unable to contact caddy server. %s", err)
-		return err
-	}
-	timeElapsed(start, "caddytest: config load time")
-
-	defer res.Body.Close()
-	body, err := ioutil.ReadAll(res.Body)
-	if err != nil {
-		t.Errorf("unable to read response. %s", err)
-		return err
-	}
-
-	if res.StatusCode != 200 {
-		return configLoadError{Response: string(body)}
-	}
-
-	return nil
-}
-
-var hasValidated bool
-var arePrerequisitesValid bool
-
-func validateTestPrerequisites() error {
-
-	if hasValidated {
-		if !arePrerequisitesValid {
-			return errors.New("caddy integration prerequisites failed. see first error")
-		}
-		return nil
-	}
-
-	hasValidated = true
-	arePrerequisitesValid = false
-
-	// check certificates are found
-	for _, certName := range Default.Certifcates {
-		if _, err := os.Stat(getIntegrationDir() + certName); os.IsNotExist(err) {
-			return fmt.Errorf("caddy integration test certificates (%s) not found", certName)
-		}
-	}
-
-	if isCaddyAdminRunning() != nil {
-		// start inprocess caddy server
-		os.Args = []string{"caddy", "run"}
-		go func() {
-			caddycmd.Main()
-		}()
-
-		// wait for caddy to start
-		retries := 4
-		for ; retries > 0 && isCaddyAdminRunning() != nil; retries-- {
-			time.Sleep(10 * time.Millisecond)
-		}
-	}
-
-	// assert that caddy is running
-	if err := isCaddyAdminRunning(); err != nil {
-		return err
-	}
-
-	arePrerequisitesValid = true
-	return nil
-}
-
-func isCaddyAdminRunning() error {
-	// assert that caddy is running
-	client := &http.Client{
-		Timeout: time.Second * 2,
-	}
-	_, err := client.Get(fmt.Sprintf("http://localhost:%d/config/", Default.AdminPort))
-	if err != nil {
-		return errors.New("caddy integration test caddy server not running. Expected to be listening on localhost:2019")
-	}
-
-	return nil
-}
-
-func getIntegrationDir() string {
-
-	_, filename, _, ok := runtime.Caller(1)
-	if !ok {
-		panic("unable to determine the current file path")
-	}
-
-	return path.Dir(filename)
-}
-
-// use the convention to replace /[certificatename].[crt|key] with the full path
-// this helps reduce the noise in test configurations and also allow this
-// to run in any path
-func prependCaddyFilePath(rawConfig string) string {
-	r := matchKey.ReplaceAllString(rawConfig, getIntegrationDir()+"$1")
-	r = matchCert.ReplaceAllString(r, getIntegrationDir()+"$1")
-	return r
-}
-
-// creates a testing transport that forces call dialing connections to happen locally
-func createTestingTransport() *http.Transport {
-
-	dialer := net.Dialer{
-		Timeout:   5 * time.Second,
-		KeepAlive: 5 * time.Second,
-		DualStack: true,
-	}
-
-	dialContext := func(ctx context.Context, network, addr string) (net.Conn, error) {
-		parts := strings.Split(addr, ":")
-		destAddr := fmt.Sprintf("127.0.0.1:%s", parts[1])
-		log.Printf("caddytest: redirecting the dialer from %s to %s", addr, destAddr)
-		return dialer.DialContext(ctx, network, destAddr)
-	}
-
-	return &http.Transport{
-		Proxy:                 http.ProxyFromEnvironment,
-		DialContext:           dialContext,
-		ForceAttemptHTTP2:     true,
-		MaxIdleConns:          100,
-		IdleConnTimeout:       90 * time.Second,
-		TLSHandshakeTimeout:   5 * time.Second,
-		ExpectContinueTimeout: 1 * time.Second,
-		TLSClientConfig:       &tls.Config{InsecureSkipVerify: true},
-	}
-}
-
-// AssertLoadError will load a config and expect an error
-func AssertLoadError(t *testing.T, rawConfig string, configType string, expectedError string) {
-	err := initServer(t, rawConfig, configType)
-	if !strings.Contains(err.Error(), expectedError) {
-		t.Errorf("expected error \"%s\" but got \"%s\"", expectedError, err.Error())
-	}
-}
-
-// AssertGetResponse request a URI and assert the status code and the body contains a string
-func AssertGetResponse(t *testing.T, requestURI string, statusCode int, expectedBody string) (*http.Response, string) {
-	resp, body := AssertGetResponseBody(t, requestURI, statusCode)
-	if !strings.Contains(body, expectedBody) {
-		t.Errorf("requesting \"%s\" expected response body \"%s\" but got \"%s\"", requestURI, expectedBody, body)
-	}
-	return resp, string(body)
-}
-
-// AssertGetResponseBody request a URI and assert the status code matches
-func AssertGetResponseBody(t *testing.T, requestURI string, expectedStatusCode int) (*http.Response, string) {
-
-	client := &http.Client{
-		Transport: createTestingTransport(),
-	}
-
-	resp, err := client.Get(requestURI)
-	if err != nil {
-		t.Errorf("failed to call server %s", err)
-		return nil, ""
-	}
-
-	defer resp.Body.Close()
-
-	if expectedStatusCode != resp.StatusCode {
-		t.Errorf("requesting \"%s\" expected status code: %d but got %d", requestURI, expectedStatusCode, resp.StatusCode)
-	}
-
-	body, err := ioutil.ReadAll(resp.Body)
-	if err != nil {
-		t.Errorf("unable to read the response body %s", err)
-		return nil, ""
-	}
-
-	return resp, string(body)
-}
-
-// AssertRedirect makes a request and asserts the redirection happens
-func AssertRedirect(t *testing.T, requestURI string, expectedToLocation string, expectedStatusCode int) *http.Response {
-
-	redirectPolicyFunc := func(req *http.Request, via []*http.Request) error {
-		return http.ErrUseLastResponse
-	}
-
-	client := &http.Client{
-		CheckRedirect: redirectPolicyFunc,
-		Transport:     createTestingTransport(),
-	}
-
-	resp, err := client.Get(requestURI)
-	if err != nil {
-		t.Errorf("failed to call server %s", err)
-		return nil
-	}
-
-	if expectedStatusCode != resp.StatusCode {
-		t.Errorf("requesting \"%s\" expected status code: %d but got %d", requestURI, expectedStatusCode, resp.StatusCode)
-	}
-
-	loc, err := resp.Location()
-	if expectedToLocation != loc.String() {
-		t.Errorf("requesting \"%s\" expected location: \"%s\" but got \"%s\"", requestURI, expectedToLocation, loc.String())
-	}
-
-	return resp
-}

caddytest/caddytest_test.go

@@ -1,33 +0,0 @@
-package caddytest
-
-import (
-	"strings"
-	"testing"
-)
-
-func TestReplaceCertificatePaths(t *testing.T) {
-	rawConfig := `a.caddy.localhost:9443 {
-		tls /caddy.localhost.crt /caddy.localhost.key {
-		}
-
-		redir / https://b.caddy.localhost:9443/version 301
-    
-		respond /version 200 {
-		  body "hello from a.caddy.localhost"
-		}	
-	  }`
-
-	r := prependCaddyFilePath(rawConfig)
-
-	if !strings.Contains(r, getIntegrationDir()+"/caddy.localhost.crt") {
-		t.Error("expected the /caddy.localhost.crt to be expanded to include the full path")
-	}
-
-	if !strings.Contains(r, getIntegrationDir()+"/caddy.localhost.key") {
-		t.Error("expected the /caddy.localhost.crt to be expanded to include the full path")
-	}
-
-	if !strings.Contains(r, "https://b.caddy.localhost:9443/version") {
-		t.Error("expected redirect uri to be unchanged")
-	}
-}

caddytest/integration/caddyfile_test.go

@@ -1,68 +0,0 @@
-package integration
-
-import (
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddytest"
-)
-
-func TestRespond(t *testing.T) {
-
-	// arrange
-	caddytest.InitServer(t, ` 
-  {
-    http_port     9080
-    https_port    9443
-  }
-  
-  localhost:9080 {
-    respond /version 200 {
-      body "hello from localhost"
-    }	
-    }
-  `, "caddyfile")
-
-	// act and assert
-	caddytest.AssertGetResponse(t, "http://localhost:9080/version", 200, "hello from localhost")
-}
-
-func TestRedirect(t *testing.T) {
-
-	// arrange
-	caddytest.InitServer(t, `
-  {
-    http_port     9080
-    https_port    9443
-  }
-  
-  localhost:9080 {
-    
-    redir / http://localhost:9080/hello 301
-    
-    respond /hello 200 {
-      body "hello from localhost"
-    }	
-    }
-  `, "caddyfile")
-
-	// act and assert
-	caddytest.AssertRedirect(t, "http://localhost:9080/", "http://localhost:9080/hello", 301)
-
-	// follow redirect
-	caddytest.AssertGetResponse(t, "http://localhost:9080/", 200, "hello from localhost")
-}
-
-func TestDuplicateHosts(t *testing.T) {
-
-	// act and assert
-	caddytest.AssertLoadError(t,
-		`
-    localhost:9080 {
-    }
-  
-    localhost:9080 { 
-    }
-    `,
-		"caddyfile",
-		"duplicate site address not allowed")
-}

caddytest/integration/sni_test.go

@@ -1,277 +0,0 @@
-package integration
-
-import (
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddytest"
-)
-
-func TestDefaultSNI(t *testing.T) {
-
-	// arrange
-	caddytest.InitServer(t, `{
-    "apps": {
-      "http": {
-        "http_port": 9080,
-        "https_port": 9443,
-        "servers": {
-          "srv0": {
-            "listen": [
-              ":9443"
-            ],
-            "routes": [
-              {
-                "handle": [
-                  {
-                    "handler": "subroute",
-                    "routes": [
-                      {
-                        "handle": [
-                          {
-                            "body": "hello from a.caddy.localhost",
-                            "handler": "static_response",
-                            "status_code": 200
-                          }
-                        ],
-                        "match": [
-                          {
-                            "path": [
-                              "/version"
-                            ]
-                          }
-                        ]
-                      }
-                    ]
-                  }
-                ],
-                "match": [
-                  {
-                    "host": [
-                      "127.0.0.1"
-                    ]
-                  }
-                ],
-                "terminal": true
-              }
-            ],
-            "tls_connection_policies": [
-              {
-                "certificate_selection": {
-                  "policy": "custom",
-                  "tag": "cert0"
-                },
-                "match": {
-                  "sni": [
-                    "127.0.0.1"
-                  ]
-                }
-              },
-              {
-                "default_sni": "*.caddy.localhost"
-              }
-            ]
-          }
-        }
-      },
-      "tls": {
-        "certificates": {
-          "load_files": [
-            {
-              "certificate": "/caddy.localhost.crt",
-              "key": "/caddy.localhost.key",
-              "tags": [
-                "cert0"
-              ]
-            }
-          ]
-        }
-      },
-      "pki": {
-        "certificate_authorities" : {
-          "local" : {
-            "install_trust": false
-          }
-        }
-      }
-    }
-  }
-  `, "json")
-
-	// act and assert
-	// makes a request with no sni
-	caddytest.AssertGetResponse(t, "https://127.0.0.1:9443/version", 200, "hello from a")
-}
-
-func TestDefaultSNIWithNamedHostAndExplicitIP(t *testing.T) {
-
-	// arrange
-	caddytest.InitServer(t, ` 
-  {
-    "apps": {
-      "http": {
-        "http_port": 9080,
-        "https_port": 9443,
-        "servers": {
-          "srv0": {
-            "listen": [
-              ":9443"
-            ],
-            "routes": [
-              {
-                "handle": [
-                  {
-                    "handler": "subroute",
-                    "routes": [
-                      {
-                        "handle": [
-                          {
-                            "body": "hello from a",
-                            "handler": "static_response",
-                            "status_code": 200
-                          }
-                        ],
-                        "match": [
-                          {
-                            "path": [
-                              "/version"
-                            ]
-                          }
-                        ]
-                      }
-                    ]
-                  }
-                ],
-                "match": [
-                  {
-                    "host": [
-                      "a.caddy.localhost",
-                      "127.0.0.1"
-                    ]
-                  }
-                ],
-                "terminal": true
-              }
-            ],
-            "tls_connection_policies": [
-              {
-                "certificate_selection": {
-                  "policy": "custom",
-                  "tag": "cert0"
-                },
-                "default_sni": "a.caddy.localhost",
-                "match": {
-                  "sni": [
-                    "a.caddy.localhost",
-                    "127.0.0.1",
-                    ""
-                  ]
-                }
-              },
-              {
-                "default_sni": "a.caddy.localhost"
-              }
-            ]
-          }
-        }
-      },
-      "tls": {
-        "certificates": {
-          "load_files": [
-            {
-              "certificate": "/a.caddy.localhost.crt",
-              "key": "/a.caddy.localhost.key",
-              "tags": [
-                "cert0"
-              ]
-            }
-          ]
-        }
-      },
-      "pki": {
-        "certificate_authorities" : {
-          "local" : {
-            "install_trust": false
-          }
-        }
-      }
-    }
-  }
-  `, "json")
-
-	// act and assert
-	// makes a request with no sni
-	caddytest.AssertGetResponse(t, "https://127.0.0.1:9443/version", 200, "hello from a")
-}
-
-func TestDefaultSNIWithPortMappingOnly(t *testing.T) {
-
-	// arrange
-	caddytest.InitServer(t, ` 
-  {
-    "apps": {
-      "http": {
-        "http_port": 9080,
-        "https_port": 9443,
-        "servers": {
-          "srv0": {
-            "listen": [
-              ":9443"
-            ],
-            "routes": [
-              {
-                "handle": [
-                  {
-                    "body": "hello from a.caddy.localhost",
-                    "handler": "static_response",
-                    "status_code": 200
-                  }
-                ],
-                "match": [
-                  {
-                    "path": [
-                      "/version"
-                    ]
-                  }
-                ]
-              }
-            ],
-            "tls_connection_policies": [
-              {
-                "certificate_selection": {
-                  "policy": "custom",
-                  "tag": "cert0"
-                },
-                "default_sni": "a.caddy.localhost"
-              }
-            ]
-          }
-        }
-      },
-      "tls": {
-        "certificates": {
-          "load_files": [
-            {
-              "certificate": "/a.caddy.localhost.crt",
-              "key": "/a.caddy.localhost.key",
-              "tags": [
-                "cert0"
-              ]
-            }
-          ]
-        }
-      },
-      "pki": {
-        "certificate_authorities" : {
-          "local" : {
-            "install_trust": false
-          }
-        }
-      }
-    }
-  }
-  `, "json")
-
-	// act and assert
-	// makes a request with no sni
-	caddytest.AssertGetResponse(t, "https://127.0.0.1:9443/version", 200, "hello from a")
-}

cmd/caddy/main.go

@@ -1,38 +0,0 @@
-// 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 main is the entry point of the Caddy application.
-// Most of Caddy's functionality is provided through modules,
-// which can be plugged in by adding their import below.
-//
-// There is no need to modify the Caddy source code to customize your
-// builds. You can easily build a custom Caddy with these simple steps:
-//
-//   1. Copy this file (main.go) into a new folder
-//   2. Edit the imports below to include the modules you want plugged in
-//   3. Run `go mod init caddy`
-//   4. Run `go install` or `go build` - you now have a custom binary!
-//
-package main
-
-import (
-	caddycmd "github.com/caddyserver/caddy/v2/cmd"
-
-	// plug in Caddy modules here
-	_ "github.com/caddyserver/caddy/v2/modules/standard"
-)
-
-func main() {
-	caddycmd.Main()
-}

cmd/commandfuncs.go

@@ -1,637 +0,0 @@
-// 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 caddycmd
-
-import (
-	"bytes"
-	"crypto/rand"
-	"encoding/json"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"log"
-	"net"
-	"net/http"
-	"os"
-	"os/exec"
-	"reflect"
-	"runtime"
-	"runtime/debug"
-	"sort"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/certmagic"
-	"go.uber.org/zap"
-)
-
-func cmdStart(fl Flags) (int, error) {
-	startCmdConfigFlag := fl.String("config")
-	startCmdConfigAdapterFlag := fl.String("adapter")
-	startCmdWatchFlag := fl.Bool("watch")
-
-	// open a listener to which the child process will connect when
-	// it is ready to confirm that it has successfully started
-	ln, err := net.Listen("tcp", "127.0.0.1:0")
-	if err != nil {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("opening listener for success confirmation: %v", err)
-	}
-	defer ln.Close()
-
-	// craft the command with a pingback address and with a
-	// pipe for its stdin, so we can tell it our confirmation
-	// code that we expect so that some random port scan at
-	// the most unfortunate time won't fool us into thinking
-	// the child succeeded (i.e. the alternative is to just
-	// wait for any connection on our listener, but better to
-	// ensure it's the process we're expecting - we can be
-	// sure by giving it some random bytes and having it echo
-	// them back to us)
-	cmd := exec.Command(os.Args[0], "run", "--pingback", ln.Addr().String())
-	if startCmdConfigFlag != "" {
-		cmd.Args = append(cmd.Args, "--config", startCmdConfigFlag)
-	}
-	if startCmdConfigAdapterFlag != "" {
-		cmd.Args = append(cmd.Args, "--adapter", startCmdConfigAdapterFlag)
-	}
-	if startCmdWatchFlag {
-		cmd.Args = append(cmd.Args, "--watch")
-	}
-	stdinpipe, err := cmd.StdinPipe()
-	if err != nil {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("creating stdin pipe: %v", err)
-	}
-	cmd.Stdout = os.Stdout
-	cmd.Stderr = os.Stderr
-
-	// generate the random bytes we'll send to the child process
-	expect := make([]byte, 32)
-	_, err = rand.Read(expect)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("generating random confirmation bytes: %v", err)
-	}
-
-	// begin writing the confirmation bytes to the child's
-	// stdin; use a goroutine since the child hasn't been
-	// started yet, and writing synchronously would result
-	// in a deadlock
-	go func() {
-		stdinpipe.Write(expect)
-		stdinpipe.Close()
-	}()
-
-	// start the process
-	err = cmd.Start()
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("starting caddy process: %v", err)
-	}
-
-	// there are two ways we know we're done: either
-	// the process will connect to our listener, or
-	// it will exit with an error
-	success, exit := make(chan struct{}), make(chan error)
-
-	// in one goroutine, we await the success of the child process
-	go func() {
-		for {
-			conn, err := ln.Accept()
-			if err != nil {
-				if !strings.Contains(err.Error(), "use of closed network connection") {
-					log.Println(err)
-				}
-				break
-			}
-			err = handlePingbackConn(conn, expect)
-			if err == nil {
-				close(success)
-				break
-			}
-			log.Println(err)
-		}
-	}()
-
-	// in another goroutine, we await the failure of the child process
-	go func() {
-		err := cmd.Wait() // don't send on this line! Wait blocks, but send starts before it unblocks
-		exit <- err       // sending on separate line ensures select won't trigger until after Wait unblocks
-	}()
-
-	// when one of the goroutines unblocks, we're done and can exit
-	select {
-	case <-success:
-		fmt.Printf("Successfully started Caddy (pid=%d) - Caddy is running in the background\n", cmd.Process.Pid)
-	case err := <-exit:
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("caddy process exited with error: %v", err)
-	}
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdRun(fl Flags) (int, error) {
-	runCmdConfigFlag := fl.String("config")
-	runCmdConfigAdapterFlag := fl.String("adapter")
-	runCmdResumeFlag := fl.Bool("resume")
-	runCmdPrintEnvFlag := fl.Bool("environ")
-	runCmdWatchFlag := fl.Bool("watch")
-	runCmdPingbackFlag := fl.String("pingback")
-
-	// if we are supposed to print the environment, do that first
-	if runCmdPrintEnvFlag {
-		printEnvironment()
-	}
-
-	// TODO: This is TEMPORARY, until the RCs
-	moveStorage()
-
-	// load the config, depending on flags
-	var config []byte
-	var err error
-	if runCmdResumeFlag {
-		config, err = ioutil.ReadFile(caddy.ConfigAutosavePath)
-		if os.IsNotExist(err) {
-			// not a bad error; just can't resume if autosave file doesn't exist
-			caddy.Log().Info("no autosave file exists", zap.String("autosave_file", caddy.ConfigAutosavePath))
-			runCmdResumeFlag = false
-		} else if err != nil {
-			return caddy.ExitCodeFailedStartup, err
-		} else {
-			caddy.Log().Info("resuming from last configuration", zap.String("autosave_file", caddy.ConfigAutosavePath))
-		}
-	}
-	// we don't use 'else' here since this value might have been changed in 'if' block; i.e. not mutually exclusive
-	var configFile string
-	if !runCmdResumeFlag {
-		config, configFile, err = loadConfig(runCmdConfigFlag, runCmdConfigAdapterFlag)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup, err
-		}
-	}
-
-	// set a fitting User-Agent for ACME requests
-	goModule := caddy.GoModule()
-	cleanModVersion := strings.TrimPrefix(goModule.Version, "v")
-	certmagic.UserAgent = "Caddy/" + cleanModVersion
-
-	// run the initial config
-	err = caddy.Load(config, true)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("loading initial config: %v", err)
-	}
-	caddy.Log().Info("serving initial configuration")
-
-	// if we are to report to another process the successful start
-	// of the server, do so now by echoing back contents of stdin
-	if runCmdPingbackFlag != "" {
-		confirmationBytes, err := ioutil.ReadAll(os.Stdin)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup,
-				fmt.Errorf("reading confirmation bytes from stdin: %v", err)
-		}
-		conn, err := net.Dial("tcp", runCmdPingbackFlag)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup,
-				fmt.Errorf("dialing confirmation address: %v", err)
-		}
-		defer conn.Close()
-		_, err = conn.Write(confirmationBytes)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup,
-				fmt.Errorf("writing confirmation bytes to %s: %v", runCmdPingbackFlag, err)
-		}
-	}
-
-	// if enabled, reload config file automatically on changes
-	// (this better only be used in dev!)
-	if runCmdWatchFlag {
-		go watchConfigFile(configFile, runCmdConfigAdapterFlag)
-	}
-
-	// warn if the environment does not provide enough information about the disk
-	hasXDG := os.Getenv("XDG_DATA_HOME") != "" &&
-		os.Getenv("XDG_CONFIG_HOME") != "" &&
-		os.Getenv("XDG_CACHE_HOME") != ""
-	switch runtime.GOOS {
-	case "windows":
-		if os.Getenv("HOME") == "" && os.Getenv("USERPROFILE") == "" && !hasXDG {
-			caddy.Log().Warn("neither HOME nor USERPROFILE environment variables are set - please fix; some assets might be stored in ./caddy")
-		}
-	case "plan9":
-		if os.Getenv("home") == "" && !hasXDG {
-			caddy.Log().Warn("$home environment variable is empty - please fix; some assets might be stored in ./caddy")
-		}
-	default:
-		if os.Getenv("HOME") == "" && !hasXDG {
-			caddy.Log().Warn("$HOME environment variable is empty - please fix; some assets might be stored in ./caddy")
-		}
-	}
-
-	select {}
-}
-
-func cmdStop(fl Flags) (int, error) {
-	stopCmdAddrFlag := fl.String("address")
-
-	adminAddr := caddy.DefaultAdminListen
-	if stopCmdAddrFlag != "" {
-		adminAddr = stopCmdAddrFlag
-	}
-	stopEndpoint := fmt.Sprintf("http://%s/stop", adminAddr)
-
-	req, err := http.NewRequest(http.MethodPost, stopEndpoint, nil)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("making request: %v", err)
-	}
-	req.Header.Set("Origin", adminAddr)
-
-	err = apiRequest(req)
-	if err != nil {
-		caddy.Log().Warn("failed using API to stop instance",
-			zap.String("endpoint", stopEndpoint),
-			zap.Error(err),
-		)
-		return caddy.ExitCodeFailedStartup, err
-	}
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdReload(fl Flags) (int, error) {
-	reloadCmdConfigFlag := fl.String("config")
-	reloadCmdConfigAdapterFlag := fl.String("adapter")
-	reloadCmdAddrFlag := fl.String("address")
-
-	// get the config in caddy's native format
-	config, configFile, err := loadConfig(reloadCmdConfigFlag, reloadCmdConfigAdapterFlag)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, err
-	}
-	if configFile == "" {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("no config file to load")
-	}
-
-	// get the address of the admin listener and craft endpoint URL
-	adminAddr := reloadCmdAddrFlag
-	if adminAddr == "" && len(config) > 0 {
-		var tmpStruct struct {
-			Admin caddy.AdminConfig `json:"admin"`
-		}
-		err = json.Unmarshal(config, &tmpStruct)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup,
-				fmt.Errorf("unmarshaling admin listener address from config: %v", err)
-		}
-		adminAddr = tmpStruct.Admin.Listen
-	}
-	if adminAddr == "" {
-		adminAddr = caddy.DefaultAdminListen
-	}
-	loadEndpoint := fmt.Sprintf("http://%s/load", adminAddr)
-
-	// prepare the request to update the configuration
-	req, err := http.NewRequest(http.MethodPost, loadEndpoint, bytes.NewReader(config))
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("making request: %v", err)
-	}
-	req.Header.Set("Content-Type", "application/json")
-	req.Header.Set("Origin", adminAddr)
-
-	err = apiRequest(req)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("sending configuration to instance: %v", err)
-	}
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdVersion(_ Flags) (int, error) {
-	goModule := caddy.GoModule()
-	fmt.Print(goModule.Version)
-	if goModule.Sum != "" {
-		// a build with a known version will also have a checksum
-		fmt.Printf(" %s", goModule.Sum)
-	}
-	if goModule.Replace != nil {
-		fmt.Printf(" => %s", goModule.Replace.Path)
-		if goModule.Replace.Version != "" {
-			fmt.Printf(" %s", goModule.Replace.Version)
-		}
-	}
-	fmt.Println()
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdBuildInfo(fl Flags) (int, error) {
-	bi, ok := debug.ReadBuildInfo()
-	if !ok {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("no build information")
-	}
-
-	fmt.Printf("path: %s\n", bi.Path)
-	fmt.Printf("main: %s %s %s\n", bi.Main.Path, bi.Main.Version, bi.Main.Sum)
-	fmt.Println("dependencies:")
-
-	for _, goMod := range bi.Deps {
-		fmt.Printf("%s %s %s", goMod.Path, goMod.Version, goMod.Sum)
-		if goMod.Replace != nil {
-			fmt.Printf(" => %s %s %s", goMod.Replace.Path, goMod.Replace.Version, goMod.Replace.Sum)
-		}
-		fmt.Println()
-	}
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdListModules(fl Flags) (int, error) {
-	versions := fl.Bool("versions")
-
-	bi, ok := debug.ReadBuildInfo()
-	if !ok || !versions {
-		// if there's no build information,
-		// just print out the modules
-		for _, m := range caddy.Modules() {
-			fmt.Println(m)
-		}
-		return caddy.ExitCodeSuccess, nil
-	}
-
-	for _, modID := range caddy.Modules() {
-		modInfo, err := caddy.GetModule(modID)
-		if err != nil {
-			// that's weird
-			fmt.Println(modID)
-			continue
-		}
-
-		// to get the Caddy plugin's version info, we need to know
-		// the package that the Caddy module's value comes from; we
-		// can use reflection but we need a non-pointer value (I'm
-		// not sure why), and since New() should return a pointer
-		// value, we need to dereference it first
-		iface := interface{}(modInfo.New())
-		if rv := reflect.ValueOf(iface); rv.Kind() == reflect.Ptr {
-			iface = reflect.New(reflect.TypeOf(iface).Elem()).Elem().Interface()
-		}
-		modPkgPath := reflect.TypeOf(iface).PkgPath()
-
-		// now we find the Go module that the Caddy module's package
-		// belongs to; we assume the Caddy module package path will
-		// be prefixed by its Go module path, and we will choose the
-		// longest matching prefix in case there are nested modules
-		var matched *debug.Module
-		for _, dep := range bi.Deps {
-			if strings.HasPrefix(modPkgPath, dep.Path) {
-				if matched == nil || len(dep.Path) > len(matched.Path) {
-					matched = dep
-				}
-			}
-		}
-
-		// if we could find no matching module, just print out
-		// the module ID instead
-		if matched == nil {
-			fmt.Println(modID)
-			continue
-		}
-
-		fmt.Printf("%s %s\n", modID, matched.Version)
-	}
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdEnviron(_ Flags) (int, error) {
-	printEnvironment()
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdAdaptConfig(fl Flags) (int, error) {
-	adaptCmdInputFlag := fl.String("config")
-	adaptCmdAdapterFlag := fl.String("adapter")
-	adaptCmdPrettyFlag := fl.Bool("pretty")
-	adaptCmdValidateFlag := fl.Bool("validate")
-
-	// if no input file was specified, try a default
-	// Caddyfile if the Caddyfile adapter is plugged in
-	if adaptCmdInputFlag == "" && caddyconfig.GetAdapter("caddyfile") != nil {
-		_, err := os.Stat("Caddyfile")
-		if err == nil {
-			// default Caddyfile exists
-			adaptCmdInputFlag = "Caddyfile"
-			caddy.Log().Info("using adjacent Caddyfile")
-		} else if !os.IsNotExist(err) {
-			// default Caddyfile exists, but error accessing it
-			return caddy.ExitCodeFailedStartup, fmt.Errorf("accessing default Caddyfile: %v", err)
-		}
-	}
-
-	if adaptCmdInputFlag == "" {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("input file required when there is no Caddyfile in current directory (use --config flag)")
-	}
-	if adaptCmdAdapterFlag == "" {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("adapter name is required (use --adapt flag or leave unspecified for default)")
-	}
-
-	cfgAdapter := caddyconfig.GetAdapter(adaptCmdAdapterFlag)
-	if cfgAdapter == nil {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("unrecognized config adapter: %s", adaptCmdAdapterFlag)
-	}
-
-	input, err := ioutil.ReadFile(adaptCmdInputFlag)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("reading input file: %v", err)
-	}
-
-	opts := make(map[string]interface{})
-	if adaptCmdPrettyFlag {
-		opts["pretty"] = "true"
-	}
-	opts["filename"] = adaptCmdInputFlag
-
-	adaptedConfig, warnings, err := cfgAdapter.Adapt(input, opts)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, err
-	}
-
-	// print warnings to stderr
-	for _, warn := range warnings {
-		msg := warn.Message
-		if warn.Directive != "" {
-			msg = fmt.Sprintf("%s: %s", warn.Directive, warn.Message)
-		}
-		fmt.Fprintf(os.Stderr, "[WARNING][%s] %s:%d: %s\n", adaptCmdAdapterFlag, warn.File, warn.Line, msg)
-	}
-
-	// print result to stdout
-	fmt.Println(string(adaptedConfig))
-
-	// validate output if requested
-	if adaptCmdValidateFlag {
-		var cfg *caddy.Config
-		err = json.Unmarshal(adaptedConfig, &cfg)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup, fmt.Errorf("decoding config: %v", err)
-		}
-		err = caddy.Validate(cfg)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup, fmt.Errorf("validation: %v", err)
-		}
-	}
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdValidateConfig(fl Flags) (int, error) {
-	validateCmdConfigFlag := fl.String("config")
-	validateCmdAdapterFlag := fl.String("adapter")
-
-	input, _, err := loadConfig(validateCmdConfigFlag, validateCmdAdapterFlag)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, err
-	}
-	input = caddy.RemoveMetaFields(input)
-
-	var cfg *caddy.Config
-	err = json.Unmarshal(input, &cfg)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("decoding config: %v", err)
-	}
-
-	err = caddy.Validate(cfg)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup, err
-	}
-
-	fmt.Println("Valid configuration")
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdFmt(fl Flags) (int, error) {
-	formatCmdConfigFile := fl.Arg(0)
-	if formatCmdConfigFile == "" {
-		formatCmdConfigFile = "Caddyfile"
-	}
-	overwrite := fl.Bool("overwrite")
-
-	input, err := ioutil.ReadFile(formatCmdConfigFile)
-	if err != nil {
-		return caddy.ExitCodeFailedStartup,
-			fmt.Errorf("reading input file: %v", err)
-	}
-
-	output := caddyfile.Format(input)
-
-	if overwrite {
-		err = ioutil.WriteFile(formatCmdConfigFile, output, 0644)
-		if err != nil {
-			return caddy.ExitCodeFailedStartup, nil
-		}
-	} else {
-		fmt.Print(string(output))
-	}
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func cmdHelp(fl Flags) (int, error) {
-	const fullDocs = `Full documentation is available at:
-https://caddyserver.com/docs/command-line`
-
-	args := fl.Args()
-	if len(args) == 0 {
-		s := `Caddy is an extensible server platform.
-
-usage:
-  caddy <command> [<args...>]
-
-commands:
-`
-		keys := make([]string, 0, len(commands))
-		for k := range commands {
-			keys = append(keys, k)
-		}
-		sort.Strings(keys)
-		for _, k := range keys {
-			cmd := commands[k]
-			short := strings.TrimSuffix(cmd.Short, ".")
-			s += fmt.Sprintf("  %-15s %s\n", cmd.Name, short)
-		}
-
-		s += "\nUse 'caddy help <command>' for more information about a command.\n"
-		s += "\n" + fullDocs + "\n"
-
-		fmt.Print(s)
-
-		return caddy.ExitCodeSuccess, nil
-	} else if len(args) > 1 {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("can only give help with one command")
-	}
-
-	subcommand, ok := commands[args[0]]
-	if !ok {
-		return caddy.ExitCodeFailedStartup, fmt.Errorf("unknown command: %s", args[0])
-	}
-
-	helpText := strings.TrimSpace(subcommand.Long)
-	if helpText == "" {
-		helpText = subcommand.Short
-		if !strings.HasSuffix(helpText, ".") {
-			helpText += "."
-		}
-	}
-
-	result := fmt.Sprintf("%s\n\nusage:\n  caddy %s %s\n",
-		helpText,
-		subcommand.Name,
-		strings.TrimSpace(subcommand.Usage),
-	)
-
-	if help := flagHelp(subcommand.Flags); help != "" {
-		result += fmt.Sprintf("\nflags:\n%s", help)
-	}
-
-	result += "\n" + fullDocs + "\n"
-
-	fmt.Print(result)
-
-	return caddy.ExitCodeSuccess, nil
-}
-
-func apiRequest(req *http.Request) error {
-	resp, err := http.DefaultClient.Do(req)
-	if err != nil {
-		return fmt.Errorf("performing request: %v", err)
-	}
-	defer resp.Body.Close()
-
-	// if it didn't work, let the user know
-	if resp.StatusCode >= 400 {
-		respBody, err := ioutil.ReadAll(io.LimitReader(resp.Body, 1024*10))
-		if err != nil {
-			return fmt.Errorf("HTTP %d: reading error message: %v", resp.StatusCode, err)
-		}
-		return fmt.Errorf("caddy responded with error: HTTP %d: %s", resp.StatusCode, respBody)
-	}
-
-	return nil
-}

cmd/commands.go

@@ -1,304 +0,0 @@
-// 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 caddycmd
-
-import (
-	"flag"
-	"regexp"
-)
-
-// Command represents a subcommand. Name, Func,
-// and Short are required.
-type Command struct {
-	// The name of the subcommand. Must conform to the
-	// format described by the RegisterCommand() godoc.
-	// Required.
-	Name string
-
-	// Run is a function that executes a subcommand using
-	// the parsed flags. It returns an exit code and any
-	// associated error.
-	// Required.
-	Func CommandFunc
-
-	// Usage is a brief message describing the syntax of
-	// the subcommand's flags and args. Use [] to indicate
-	// optional parameters and <> to enclose literal values
-	// intended to be replaced by the user. Do not prefix
-	// the string with "caddy" or the name of the command
-	// since these will be prepended for you; only include
-	// the actual parameters for this command.
-	Usage string
-
-	// Short is a one-line message explaining what the
-	// command does. Should not end with punctuation.
-	// Required.
-	Short string
-
-	// Long is the full help text shown to the user.
-	// Will be trimmed of whitespace on both ends before
-	// being printed.
-	Long string
-
-	// Flags is the flagset for command.
-	Flags *flag.FlagSet
-}
-
-// CommandFunc is a command's function. It runs the
-// command and returns the proper exit code along with
-// any error that occurred.
-type CommandFunc func(Flags) (int, error)
-
-var commands = make(map[string]Command)
-
-func init() {
-	RegisterCommand(Command{
-		Name:  "help",
-		Func:  cmdHelp,
-		Usage: "<command>",
-		Short: "Shows help for a Caddy subcommand",
-	})
-
-	RegisterCommand(Command{
-		Name:  "start",
-		Func:  cmdStart,
-		Usage: "[--config <path> [--adapter <name>]] [--watch]",
-		Short: "Starts the Caddy process in the background and then returns",
-		Long: `
-Starts the Caddy process, optionally bootstrapped with an initial config file.
-This command unblocks after the server starts running or fails to run.
-
-On Windows, the spawned child process will remain attached to the terminal, so
-closing the window will forcefully stop Caddy; to avoid forgetting this, try
-using 'caddy run' instead to keep it in the foreground.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("start", flag.ExitOnError)
-			fs.String("config", "", "Configuration file")
-			fs.String("adapter", "", "Name of config adapter to apply")
-			fs.Bool("watch", false, "Reload changed config file automatically")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "run",
-		Func:  cmdRun,
-		Usage: "[--config <path> [--adapter <name>]] [--environ] [--watch]",
-		Short: `Starts the Caddy process and blocks indefinitely`,
-		Long: `
-Starts the Caddy process, optionally bootstrapped with an initial config file,
-and blocks indefinitely until the server is stopped; i.e. runs Caddy in
-"daemon" mode (foreground).
-
-If a config file is specified, it will be applied immediately after the process
-is running. If the config file is not in Caddy's native JSON format, you can
-specify an adapter with --adapter to adapt the given config file to
-Caddy's native format. The config adapter must be a registered module. Any
-warnings will be printed to the log, but beware that any adaptation without
-errors will immediately be used. If you want to review the results of the
-adaptation first, use the 'adapt' subcommand.
-
-As a special case, if the current working directory has a file called
-"Caddyfile" and the caddyfile config adapter is plugged in (default), then
-that file will be loaded and used to configure Caddy, even without any command
-line flags.
-
-If --environ is specified, the environment as seen by the Caddy process will
-be printed before starting. This is the same as the environ command but does
-not quit after printing, and can be useful for troubleshooting.
-
-The --resume flag will override the --config flag if there is a config auto-
-save file. It is not an error if --resume is used and no autosave file exists.
-
-If --watch is specified, the config file will be loaded automatically after
-changes. ⚠️ This is dangerous in production! Only use this option in a local
-development environment.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("run", flag.ExitOnError)
-			fs.String("config", "", "Configuration file")
-			fs.String("adapter", "", "Name of config adapter to apply")
-			fs.Bool("environ", false, "Print environment")
-			fs.Bool("resume", false, "Use saved config, if any (and prefer over --config file)")
-			fs.Bool("watch", false, "Watch config file for changes and reload it automatically")
-			fs.String("pingback", "", "Echo confirmation bytes to this address on success")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "stop",
-		Func:  cmdStop,
-		Short: "Gracefully stops a started Caddy process",
-		Long: `
-Stops the background Caddy process as gracefully as possible.
-
-It requires that the admin API is enabled and accessible, since it will
-use the API's /stop endpoint. The address of this request can be
-customized using the --address flag if it is not the default.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("stop", flag.ExitOnError)
-			fs.String("address", "", "The address to use to reach the admin API endpoint, if not the default")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "reload",
-		Func:  cmdReload,
-		Usage: "--config <path> [--adapter <name>] [--address <interface>]",
-		Short: "Changes the config of the running Caddy instance",
-		Long: `
-Gives the running Caddy instance a new configuration. This has the same effect
-as POSTing a document to the /load API endpoint, but is convenient for simple
-workflows revolving around config files.
-
-Since the admin endpoint is configurable, the endpoint configuration is loaded
-from the --address flag if specified; otherwise it is loaded from the given
-config file; otherwise the default is assumed.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("reload", flag.ExitOnError)
-			fs.String("config", "", "Configuration file (required)")
-			fs.String("adapter", "", "Name of config adapter to apply")
-			fs.String("address", "", "Address of the administration listener, if different from config")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "version",
-		Func:  cmdVersion,
-		Short: "Prints the version",
-	})
-
-	RegisterCommand(Command{
-		Name:  "list-modules",
-		Func:  cmdListModules,
-		Usage: "[--versions]",
-		Short: "Lists the installed Caddy modules",
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("list-modules", flag.ExitOnError)
-			fs.Bool("versions", false, "Print version information")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "build-info",
-		Func:  cmdBuildInfo,
-		Short: "Prints information about this build",
-	})
-
-	RegisterCommand(Command{
-		Name:  "environ",
-		Func:  cmdEnviron,
-		Short: "Prints the environment",
-	})
-
-	RegisterCommand(Command{
-		Name:  "adapt",
-		Func:  cmdAdaptConfig,
-		Usage: "--config <path> [--adapter <name>] [--pretty] [--validate]",
-		Short: "Adapts a configuration to Caddy's native JSON",
-		Long: `
-Adapts a configuration to Caddy's native JSON format and writes the
-output to stdout, along with any warnings to stderr.
-
-If --pretty is specified, the output will be formatted with indentation
-for human readability.
-
-If --validate is used, the adapted config will be checked for validity.
-If the config is invalid, an error will be printed to stderr and a non-
-zero exit status will be returned.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("adapt", flag.ExitOnError)
-			fs.String("config", "", "Configuration file to adapt (required)")
-			fs.String("adapter", "caddyfile", "Name of config adapter")
-			fs.Bool("pretty", false, "Format the output for human readability")
-			fs.Bool("validate", false, "Validate the output")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "validate",
-		Func:  cmdValidateConfig,
-		Usage: "--config <path> [--adapter <name>]",
-		Short: "Tests whether a configuration file is valid",
-		Long: `
-Loads and provisions the provided config, but does not start running it.
-This reveals any errors with the configuration through the loading and
-provisioning stages.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("load", flag.ExitOnError)
-			fs.String("config", "", "Input configuration file")
-			fs.String("adapter", "", "Name of config adapter")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "fmt",
-		Func:  cmdFmt,
-		Usage: "[--overwrite] [<path>]",
-		Short: "Formats a Caddyfile",
-		Long: `
-Formats the Caddyfile by adding proper indentation and spaces to improve
-human readability. It prints the result to stdout.
-
-If --write is specified, the output will be written to the config file
-directly instead of printing it.`,
-		Flags: func() *flag.FlagSet {
-			fs := flag.NewFlagSet("format", flag.ExitOnError)
-			fs.Bool("overwrite", false, "Overwrite the input file with the results")
-			return fs
-		}(),
-	})
-
-}
-
-// RegisterCommand registers the command cmd.
-// cmd.Name must be unique and conform to the
-// following format:
-//
-//    - lowercase
-//    - alphanumeric and hyphen characters only
-//    - cannot start or end with a hyphen
-//    - hyphen cannot be adjacent to another hyphen
-//
-// This function panics if the name is already registered,
-// if the name does not meet the described format, or if
-// any of the fields are missing from cmd.
-//
-// This function should be used in init().
-func RegisterCommand(cmd Command) {
-	if cmd.Name == "" {
-		panic("command name is required")
-	}
-	if cmd.Func == nil {
-		panic("command function missing")
-	}
-	if cmd.Short == "" {
-		panic("command short string is required")
-	}
-	if _, exists := commands[cmd.Name]; exists {
-		panic("command already registered: " + cmd.Name)
-	}
-	if !commandNameRegex.MatchString(cmd.Name) {
-		panic("invalid command name")
-	}
-	commands[cmd.Name] = cmd
-}
-
-var commandNameRegex = regexp.MustCompile(`^[a-z0-9]$|^([a-z0-9]+-?[a-z0-9]*)+[a-z0-9]$`)

cmd/main.go

@@ -1,409 +0,0 @@
-// 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 caddycmd
-
-import (
-	"bytes"
-	"flag"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"net"
-	"os"
-	"path/filepath"
-	"runtime"
-	"strconv"
-	"strings"
-	"time"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"go.uber.org/zap"
-)
-
-// Main implements the main function of the caddy command.
-// Call this if Caddy is to be the main() if your program.
-func Main() {
-	caddy.TrapSignals()
-
-	switch len(os.Args) {
-	case 0:
-		fmt.Printf("[FATAL] no arguments provided by OS; args[0] must be command\n")
-		os.Exit(caddy.ExitCodeFailedStartup)
-	case 1:
-		os.Args = append(os.Args, "help")
-	}
-
-	subcommandName := os.Args[1]
-	subcommand, ok := commands[subcommandName]
-	if !ok {
-		if strings.HasPrefix(os.Args[1], "-") {
-			// user probably forgot to type the subcommand
-			fmt.Println("[ERROR] first argument must be a subcommand; see 'caddy help'")
-		} else {
-			fmt.Printf("[ERROR] '%s' is not a recognized subcommand; see 'caddy help'\n", os.Args[1])
-		}
-		os.Exit(caddy.ExitCodeFailedStartup)
-	}
-
-	fs := subcommand.Flags
-	if fs == nil {
-		fs = flag.NewFlagSet(subcommand.Name, flag.ExitOnError)
-	}
-
-	err := fs.Parse(os.Args[2:])
-	if err != nil {
-		fmt.Println(err)
-		os.Exit(caddy.ExitCodeFailedStartup)
-	}
-
-	exitCode, err := subcommand.Func(Flags{fs})
-	if err != nil {
-		fmt.Fprintf(os.Stderr, "%s: %v\n", subcommand.Name, err)
-	}
-
-	os.Exit(exitCode)
-}
-
-// handlePingbackConn reads from conn and ensures it matches
-// the bytes in expect, or returns an error if it doesn't.
-func handlePingbackConn(conn net.Conn, expect []byte) error {
-	defer conn.Close()
-	confirmationBytes, err := ioutil.ReadAll(io.LimitReader(conn, 32))
-	if err != nil {
-		return err
-	}
-	if !bytes.Equal(confirmationBytes, expect) {
-		return fmt.Errorf("wrong confirmation: %x", confirmationBytes)
-	}
-	return nil
-}
-
-// loadConfig loads the config from configFile and adapts it
-// using adapterName. If adapterName is specified, configFile
-// must be also. If no configFile is specified, it tries
-// loading a default config file. The lack of a config file is
-// not treated as an error, but false will be returned if
-// there is no config available. It prints any warnings to stderr,
-// and returns the resulting JSON config bytes along with
-// whether a config file was loaded or not.
-func loadConfig(configFile, adapterName string) ([]byte, string, error) {
-	// specifying an adapter without a config file is ambiguous
-	if adapterName != "" && configFile == "" {
-		return nil, "", fmt.Errorf("cannot adapt config without config file (use --config)")
-	}
-
-	// load initial config and adapter
-	var config []byte
-	var cfgAdapter caddyconfig.Adapter
-	var err error
-	if configFile != "" {
-		config, err = ioutil.ReadFile(configFile)
-		if err != nil {
-			return nil, "", fmt.Errorf("reading config file: %v", err)
-		}
-		caddy.Log().Info("using provided configuration",
-			zap.String("config_file", configFile),
-			zap.String("config_adapter", adapterName))
-	} else if adapterName == "" {
-		// as a special case when no config file or adapter
-		// is specified, see if the Caddyfile adapter is
-		// plugged in, and if so, try using a default Caddyfile
-		cfgAdapter = caddyconfig.GetAdapter("caddyfile")
-		if cfgAdapter != nil {
-			config, err = ioutil.ReadFile("Caddyfile")
-			if os.IsNotExist(err) {
-				// okay, no default Caddyfile; pretend like this never happened
-				cfgAdapter = nil
-			} else if err != nil {
-				// default Caddyfile exists, but error reading it
-				return nil, "", fmt.Errorf("reading default Caddyfile: %v", err)
-			} else {
-				// success reading default Caddyfile
-				configFile = "Caddyfile"
-				caddy.Log().Info("using adjacent Caddyfile")
-			}
-		}
-	}
-
-	// as a special case, if a config file called "Caddyfile" was
-	// specified, and no adapter is specified, assume caddyfile adapter
-	// for convenience
-	if strings.HasPrefix(filepath.Base(configFile), "Caddyfile") &&
-		filepath.Ext(configFile) != ".json" &&
-		adapterName == "" {
-		adapterName = "caddyfile"
-	}
-
-	// load config adapter
-	if adapterName != "" {
-		cfgAdapter = caddyconfig.GetAdapter(adapterName)
-		if cfgAdapter == nil {
-			return nil, "", fmt.Errorf("unrecognized config adapter: %s", adapterName)
-		}
-	}
-
-	// adapt config
-	if cfgAdapter != nil {
-		adaptedConfig, warnings, err := cfgAdapter.Adapt(config, map[string]interface{}{
-			"filename": configFile,
-		})
-		if err != nil {
-			return nil, "", fmt.Errorf("adapting config using %s: %v", adapterName, err)
-		}
-		for _, warn := range warnings {
-			msg := warn.Message
-			if warn.Directive != "" {
-				msg = fmt.Sprintf("%s: %s", warn.Directive, warn.Message)
-			}
-			fmt.Printf("[WARNING][%s] %s:%d: %s\n", adapterName, warn.File, warn.Line, msg)
-		}
-		config = adaptedConfig
-	}
-
-	return config, configFile, nil
-}
-
-// watchConfigFile watches the config file at filename for changes
-// and reloads the config if the file was updated. This function
-// blocks indefinitely; it only quits if the poller has errors for
-// long enough time. The filename passed in must be the actual
-// config file used, not one to be discovered.
-func watchConfigFile(filename, adapterName string) {
-	// make our logger; since config reloads can change the
-	// default logger, we need to get it dynamically each time
-	logger := func() *zap.Logger {
-		return caddy.Log().
-			Named("watcher").
-			With(zap.String("config_file", filename))
-	}
-
-	// get the initial timestamp on the config file
-	info, err := os.Stat(filename)
-	if err != nil {
-		logger().Error("cannot watch config file", zap.Error(err))
-		return
-	}
-	lastModified := info.ModTime()
-
-	logger().Info("watching config file for changes")
-
-	// if the file disappears or something, we can
-	// stop polling if the error lasts long enough
-	var lastErr time.Time
-	finalError := func(err error) bool {
-		if lastErr.IsZero() {
-			lastErr = time.Now()
-			return false
-		}
-		if time.Since(lastErr) > 30*time.Second {
-			logger().Error("giving up watching config file; too many errors",
-				zap.Error(err))
-			return true
-		}
-		return false
-	}
-
-	// begin poller
-	for range time.Tick(1 * time.Second) {
-		// get the file info
-		info, err := os.Stat(filename)
-		if err != nil {
-			if finalError(err) {
-				return
-			}
-			continue
-		}
-		lastErr = time.Time{} // no error, so clear any memory of one
-
-		// if it hasn't changed, nothing to do
-		if !info.ModTime().After(lastModified) {
-			continue
-		}
-
-		logger().Info("config file changed; reloading")
-
-		// remember this timestamp
-		lastModified = info.ModTime()
-
-		// load the contents of the file
-		config, _, err := loadConfig(filename, adapterName)
-		if err != nil {
-			logger().Error("unable to load latest config", zap.Error(err))
-			continue
-		}
-
-		// apply the updated config
-		err = caddy.Load(config, false)
-		if err != nil {
-			logger().Error("applying latest config", zap.Error(err))
-			continue
-		}
-	}
-}
-
-// Flags wraps a FlagSet so that typed values
-// from flags can be easily retrieved.
-type Flags struct {
-	*flag.FlagSet
-}
-
-// String returns the string representation of the
-// flag given by name. It panics if the flag is not
-// in the flag set.
-func (f Flags) String(name string) string {
-	return f.FlagSet.Lookup(name).Value.String()
-}
-
-// Bool returns the boolean representation of the
-// flag given by name. It returns false if the flag
-// is not a boolean type. It panics if the flag is
-// not in the flag set.
-func (f Flags) Bool(name string) bool {
-	val, _ := strconv.ParseBool(f.String(name))
-	return val
-}
-
-// Int returns the integer representation of the
-// flag given by name. It returns 0 if the flag
-// is not an integer type. It panics if the flag is
-// not in the flag set.
-func (f Flags) Int(name string) int {
-	val, _ := strconv.ParseInt(f.String(name), 0, strconv.IntSize)
-	return int(val)
-}
-
-// Float64 returns the float64 representation of the
-// flag given by name. It returns false if the flag
-// is not a float63 type. It panics if the flag is
-// not in the flag set.
-func (f Flags) Float64(name string) float64 {
-	val, _ := strconv.ParseFloat(f.String(name), 64)
-	return val
-}
-
-// Duration returns the duration representation of the
-// flag given by name. It returns false if the flag
-// is not a duration type. It panics if the flag is
-// not in the flag set.
-func (f Flags) Duration(name string) time.Duration {
-	val, _ := time.ParseDuration(f.String(name))
-	return val
-}
-
-// flagHelp returns the help text for fs.
-func flagHelp(fs *flag.FlagSet) string {
-	if fs == nil {
-		return ""
-	}
-
-	// temporarily redirect output
-	out := fs.Output()
-	defer fs.SetOutput(out)
-
-	buf := new(bytes.Buffer)
-	fs.SetOutput(buf)
-	fs.PrintDefaults()
-	return buf.String()
-}
-
-func printEnvironment() {
-	fmt.Printf("caddy.HomeDir=%s\n", caddy.HomeDir())
-	fmt.Printf("caddy.AppDataDir=%s\n", caddy.AppDataDir())
-	fmt.Printf("caddy.AppConfigDir=%s\n", caddy.AppConfigDir())
-	fmt.Printf("caddy.ConfigAutosavePath=%s\n", caddy.ConfigAutosavePath)
-	fmt.Printf("runtime.GOOS=%s\n", runtime.GOOS)
-	fmt.Printf("runtime.GOARCH=%s\n", runtime.GOARCH)
-	fmt.Printf("runtime.Compiler=%s\n", runtime.Compiler)
-	fmt.Printf("runtime.NumCPU=%d\n", runtime.NumCPU())
-	fmt.Printf("runtime.GOMAXPROCS=%d\n", runtime.GOMAXPROCS(0))
-	fmt.Printf("runtime.Version=%s\n", runtime.Version())
-	cwd, err := os.Getwd()
-	if err != nil {
-		cwd = fmt.Sprintf("<error: %v>", err)
-	}
-	fmt.Printf("os.Getwd=%s\n\n", cwd)
-	for _, v := range os.Environ() {
-		fmt.Println(v)
-	}
-}
-
-// moveStorage moves the old default dataDir to the new default dataDir.
-// TODO: This is TEMPORARY until the release candidates.
-func moveStorage() {
-	// get the home directory (the old way)
-	oldHome := os.Getenv("HOME")
-	if oldHome == "" && runtime.GOOS == "windows" {
-		drive := os.Getenv("HOMEDRIVE")
-		path := os.Getenv("HOMEPATH")
-		oldHome = drive + path
-		if drive == "" || path == "" {
-			oldHome = os.Getenv("USERPROFILE")
-		}
-	}
-	if oldHome == "" {
-		oldHome = "."
-	}
-	oldDataDir := filepath.Join(oldHome, ".local", "share", "caddy")
-
-	// nothing to do if old data dir doesn't exist
-	_, err := os.Stat(oldDataDir)
-	if os.IsNotExist(err) {
-		return
-	}
-
-	// nothing to do if the new data dir is the same as the old one
-	newDataDir := caddy.AppDataDir()
-	if oldDataDir == newDataDir {
-		return
-	}
-
-	logger := caddy.Log().Named("automigrate").With(
-		zap.String("old_dir", oldDataDir),
-		zap.String("new_dir", newDataDir))
-
-	logger.Info("beginning one-time data directory migration",
-		zap.String("details", "https://github.com/caddyserver/caddy/issues/2955"))
-
-	// if new data directory exists, avoid auto-migration as a conservative safety measure
-	_, err = os.Stat(newDataDir)
-	if !os.IsNotExist(err) {
-		logger.Error("new data directory already exists; skipping auto-migration as conservative safety measure",
-			zap.Error(err),
-			zap.String("instructions", "https://github.com/caddyserver/caddy/issues/2955#issuecomment-570000333"))
-		return
-	}
-
-	// construct the new data directory's parent folder
-	err = os.MkdirAll(filepath.Dir(newDataDir), 0700)
-	if err != nil {
-		logger.Error("unable to make new datadirectory - follow link for instructions",
-			zap.String("instructions", "https://github.com/caddyserver/caddy/issues/2955#issuecomment-570000333"),
-			zap.Error(err))
-		return
-	}
-
-	// folder structure is same, so just try to rename (move) it;
-	// this fails if the new path is on a separate device
-	err = os.Rename(oldDataDir, newDataDir)
-	if err != nil {
-		logger.Error("new data directory already exists; skipping auto-migration as conservative safety measure - follow link for instructions",
-			zap.String("instructions", "https://github.com/caddyserver/caddy/issues/2955#issuecomment-570000333"),
-			zap.Error(err))
-	}
-
-	logger.Info("successfully completed one-time migration of data directory",
-		zap.String("details", "https://github.com/caddyserver/caddy/issues/2955"))
-}

cmd/proc_posix.go

@@ -1,37 +0,0 @@
-// 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.
-
-// +build !windows
-
-package caddycmd
-
-import (
-	"fmt"
-	"os"
-	"path/filepath"
-	"syscall"
-)
-
-func gracefullyStopProcess(pid int) error {
-	fmt.Print("Graceful stop... ")
-	err := syscall.Kill(pid, syscall.SIGINT)
-	if err != nil {
-		return fmt.Errorf("kill: %v", err)
-	}
-	return nil
-}
-
-func getProcessName() string {
-	return filepath.Base(os.Args[0])
-}

cmd/proc_windows.go

@@ -1,44 +0,0 @@
-// 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 caddycmd
-
-import (
-	"fmt"
-	"os"
-	"os/exec"
-	"path/filepath"
-	"strconv"
-)
-
-func gracefullyStopProcess(pid int) error {
-	fmt.Print("Forceful stop... ")
-	// process on windows will not stop unless forced with /f
-	cmd := exec.Command("taskkill", "/pid", strconv.Itoa(pid), "/f")
-	if err := cmd.Run(); err != nil {
-		return fmt.Errorf("taskkill: %v", err)
-	}
-	return nil
-}
-
-// On Windows the app name passed in os.Args[0] will match how
-// caddy was started eg will match caddy or caddy.exe.
-// So return appname with .exe for consistency
-func getProcessName() string {
-	base := filepath.Base(os.Args[0])
-	if filepath.Ext(base) == "" {
-		return base + ".exe"
-	}
-	return base
-}

config/config.go

@@ -0,0 +1,169 @@
+package config
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"log"
+	"net"
+
+	"github.com/mholt/caddy/app"
+	"github.com/mholt/caddy/config/parse"
+	"github.com/mholt/caddy/config/setup"
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/server"
+)
+
+const (
+	DefaultHost = "0.0.0.0"
+	DefaultPort = "2015"
+	DefaultRoot = "."
+
+	// DefaultConfigFile is the name of the configuration file that is loaded
+	// by default if no other file is specified.
+	DefaultConfigFile = "Caddyfile"
+)
+
+func Load(filename string, input io.Reader) ([]server.Config, error) {
+	var configs []server.Config
+
+	// turn off timestamp for parsing
+	flags := log.Flags()
+	log.SetFlags(0)
+
+	serverBlocks, err := parse.ServerBlocks(filename, input)
+	if err != nil {
+		return configs, err
+	}
+
+	// Each server block represents a single server/address.
+	// Iterate each server block and make a config for each one,
+	// executing the directives that were parsed.
+	for _, sb := range serverBlocks {
+		config := server.Config{
+			Host:       sb.Host,
+			Port:       sb.Port,
+			Root:       Root,
+			Middleware: make(map[string][]middleware.Middleware),
+			ConfigFile: filename,
+			AppName:    app.Name,
+			AppVersion: app.Version,
+		}
+
+		// It is crucial that directives are executed in the proper order.
+		for _, dir := range directiveOrder {
+			// Execute directive if it is in the server block
+			if tokens, ok := sb.Tokens[dir.name]; ok {
+				// Each setup function gets a controller, which is the
+				// server config and the dispenser containing only
+				// this directive's tokens.
+				controller := &setup.Controller{
+					Config:    &config,
+					Dispenser: parse.NewDispenserTokens(filename, tokens),
+				}
+
+				midware, err := dir.setup(controller)
+				if err != nil {
+					return configs, err
+				}
+				if midware != nil {
+					// TODO: For now, we only support the default path scope /
+					config.Middleware["/"] = append(config.Middleware["/"], midware)
+				}
+			}
+		}
+
+		if config.Port == "" {
+			config.Port = Port
+		}
+
+		configs = append(configs, config)
+	}
+
+	// restore logging settings
+	log.SetFlags(flags)
+
+	return configs, nil
+}
+
+// ArrangeBindings groups configurations by their bind address. For example,
+// a server that should listen on localhost and another on 127.0.0.1 will
+// be grouped into the same address: 127.0.0.1. It will return an error
+// if the address lookup fails or if a TLS listener is configured on the
+// same address as a plaintext HTTP listener. The return value is a map of
+// bind address to list of configs that would become VirtualHosts on that
+// server.
+func ArrangeBindings(allConfigs []server.Config) (map[*net.TCPAddr][]server.Config, error) {
+	addresses := make(map[*net.TCPAddr][]server.Config)
+
+	// Group configs by bind address
+	for _, conf := range allConfigs {
+		newAddr, err := net.ResolveTCPAddr("tcp", conf.Address())
+		if err != nil {
+			return addresses, errors.New("Could not serve " + conf.Address() + " - " + err.Error())
+		}
+
+		// Make sure to compare the string representation of the address,
+		// not the pointer, since a new *TCPAddr is created each time.
+		var existing bool
+		for addr := range addresses {
+			if addr.String() == newAddr.String() {
+				addresses[addr] = append(addresses[addr], conf)
+				existing = true
+				break
+			}
+		}
+		if !existing {
+			addresses[newAddr] = append(addresses[newAddr], conf)
+		}
+	}
+
+	// Don't allow HTTP and HTTPS to be served on the same address
+	for _, configs := range addresses {
+		isTLS := configs[0].TLS.Enabled
+		for _, config := range configs {
+			if config.TLS.Enabled != isTLS {
+				thisConfigProto, otherConfigProto := "HTTP", "HTTP"
+				if config.TLS.Enabled {
+					thisConfigProto = "HTTPS"
+				}
+				if configs[0].TLS.Enabled {
+					otherConfigProto = "HTTPS"
+				}
+				return addresses, fmt.Errorf("Configuration error: Cannot multiplex %s (%s) and %s (%s) on same address",
+					configs[0].Address(), otherConfigProto, config.Address(), thisConfigProto)
+			}
+		}
+	}
+
+	return addresses, nil
+}
+
+// validDirective returns true if d is a valid
+// directive; false otherwise.
+func validDirective(d string) bool {
+	for _, dir := range directiveOrder {
+		if dir.name == d {
+			return true
+		}
+	}
+	return false
+}
+
+// Default makes a default configuration which
+// is empty except for root, host, and port,
+// which are essentials for serving the cwd.
+func Default() server.Config {
+	return server.Config{
+		Root: Root,
+		Host: Host,
+		Port: Port,
+	}
+}
+
+// These three defaults are configurable through the command line
+var (
+	Root = DefaultRoot
+	Host = DefaultHost
+	Port = DefaultPort
+)

config/directives.go

@@ -0,0 +1,80 @@
+package config
+
+import (
+	"github.com/mholt/caddy/config/parse"
+	"github.com/mholt/caddy/config/setup"
+	"github.com/mholt/caddy/middleware"
+)
+
+func init() {
+	// The parse package must know which directives
+	// are valid, but it must not import the setup
+	// or config package. To solve this problem, we
+	// fill up this map in our init function here.
+	// The parse package does not need to know the
+	// ordering of the directives.
+	for _, dir := range directiveOrder {
+		parse.ValidDirectives[dir.name] = struct{}{}
+	}
+}
+
+// Directives are registered in the order they should be
+// executed. Middleware (directives that inject a handler)
+// are executed in the order A-B-C-*-C-B-A, assuming
+// they all call the Next handler in the chain.
+//
+// Ordering is VERY important. Every middleware will
+// feel the effects of all other middleware below
+// (after) them during a request, but they must not
+// care what middleware above them are doing.
+//
+// For example, log needs to know the status code and
+// exactly how many bytes were written to the client,
+// which every other middleware can affect, so it gets
+// registered first. The errors middleware does not
+// care if gzip or log modifies its response, so it
+// gets registered below them. Gzip, on the other hand,
+// DOES care what errors does to the response since it
+// must compress every output to the client, even error
+// pages, so it must be registered before the errors
+// middleware and any others that would write to the
+// response.
+var directiveOrder = []directive{
+	// Essential directives that initialize vital configuration settings
+	{"root", setup.Root},
+	{"tls", setup.TLS},
+	{"bind", setup.BindHost},
+
+	// Other directives that don't create HTTP handlers
+	{"startup", setup.Startup},
+	{"shutdown", setup.Shutdown},
+	{"git", setup.Git},
+
+	// Directives that inject handlers (middleware)
+	{"log", setup.Log},
+	{"gzip", setup.Gzip},
+	{"errors", setup.Errors},
+	{"header", setup.Headers},
+	{"rewrite", setup.Rewrite},
+	{"redir", setup.Redir},
+	{"ext", setup.Ext},
+	{"basicauth", setup.BasicAuth},
+	{"internal", setup.Internal},
+	{"proxy", setup.Proxy},
+	{"fastcgi", setup.FastCGI},
+	{"websocket", setup.WebSocket},
+	{"markdown", setup.Markdown},
+	{"templates", setup.Templates},
+	{"browse", setup.Browse},
+}
+
+// directive ties together a directive name with its setup function.
+type directive struct {
+	name  string
+	setup setupFunc
+}
+
+// A setup function takes a setup controller. Its return values may
+// both be nil. If middleware is not nil, it will be chained into
+// the HTTP handlers in the order specified in this package.
+type setupFunc func(c *setup.Controller) (middleware.Middleware, error)

config/parse/dispenser.go

@@ -0,0 +1,217 @@
+package parse
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"strings"
+)
+
+// Dispenser is a type that dispenses tokens, similarly to a lexer,
+// except that it can do so with some notion of structure and has
+// some really convenient methods.
+type Dispenser struct {
+	filename string
+	tokens   []token
+	cursor   int
+	nesting  int
+}
+
+// NewDispenser returns a Dispenser, ready to use for parsing the given input.
+func NewDispenser(filename string, input io.Reader) Dispenser {
+	return Dispenser{
+		filename: filename,
+		tokens:   allTokens(input),
+		cursor:   -1,
+	}
+}
+
+// NewDispenserTokens returns a Dispenser filled with the given tokens.
+func NewDispenserTokens(filename string, tokens []token) Dispenser {
+	return Dispenser{
+		filename: filename,
+		tokens:   tokens,
+		cursor:   -1,
+	}
+}
+
+// Next loads the next token. Returns true if a token
+// was loaded; false otherwise. If false, all tokens
+// have already been consumed.
+func (d *Dispenser) Next() bool {
+	if d.cursor < len(d.tokens)-1 {
+		d.cursor++
+		return true
+	}
+	return false
+}
+
+// NextArg loads the next token if it is on the same
+// line. Returns true if a token was loaded; false
+// otherwise. If false, all tokens on the line have
+// been consumed.
+func (d *Dispenser) NextArg() bool {
+	if d.cursor < 0 {
+		d.cursor++
+		return true
+	}
+	if d.cursor >= len(d.tokens) {
+		return false
+	}
+	if d.cursor < len(d.tokens)-1 &&
+		(d.tokens[d.cursor].line+d.numLineBreaks(d.cursor) == d.tokens[d.cursor+1].line) {
+		d.cursor++
+		return true
+	}
+	return false
+}
+
+// NextLine loads the next token only if it is not on the same
+// line as the current token, and returns true if a token was
+// loaded; false otherwise. If false, there is not another token
+// or it is on the same line.
+func (d *Dispenser) NextLine() bool {
+	if d.cursor < 0 {
+		d.cursor++
+		return true
+	}
+	if d.cursor >= len(d.tokens) {
+		return false
+	}
+	if d.cursor < len(d.tokens)-1 &&
+		d.tokens[d.cursor].line+d.numLineBreaks(d.cursor) < d.tokens[d.cursor+1].line {
+		d.cursor++
+		return true
+	}
+	return false
+}
+
+// NextBlock can be used as the condition of a for loop
+// to load the next token as long as it opens a block or
+// is already in a block. It returns true if a token was
+// loaded, or false when the block's closing curly brace
+// was loaded and thus the block ended. Nested blocks are
+// not supported.
+func (d *Dispenser) NextBlock() bool {
+	if d.nesting > 0 {
+		d.Next()
+		if d.Val() == "}" {
+			d.nesting--
+			return false
+		}
+		return true
+	}
+	if !d.NextArg() { // block must open on same line
+		return false
+	}
+	if d.Val() != "{" {
+		d.cursor-- // roll back if not opening brace
+		return false
+	}
+	d.Next()
+	if d.Val() == "}" {
+		// Open and then closed right away
+		return false
+	}
+	d.nesting++
+	return true
+}
+
+// Val gets the text of the current token. If there is no token
+// loaded, it returns empty string.
+func (d *Dispenser) Val() string {
+	if d.cursor < 0 || d.cursor >= len(d.tokens) {
+		return ""
+	}
+	return d.tokens[d.cursor].text
+}
+
+// Line gets the line number of the current token. If there is no token
+// loaded, it returns 0.
+func (d *Dispenser) Line() int {
+	if d.cursor < 0 || d.cursor >= len(d.tokens) {
+		return 0
+	}
+	return d.tokens[d.cursor].line
+}
+
+// Args is a convenience function that loads the next arguments
+// (tokens on the same line) into an arbitrary number of strings
+// pointed to in targets. If there are fewer tokens available
+// than string pointers, the remaining strings will not be changed
+// and false will be returned. If there were enough tokens available
+// to fill the arguments, then true will be returned.
+func (d *Dispenser) Args(targets ...*string) bool {
+	enough := true
+	for i := 0; i < len(targets); i++ {
+		if !d.NextArg() {
+			enough = false
+			break
+		}
+		*targets[i] = d.Val()
+	}
+	return enough
+}
+
+// RemainingArgs loads any more arguments (tokens on the same line)
+// into a slice and returns them. Open curly brace tokens also indicate
+// the end of arguments, and the curly brace is not included in
+// the return value nor is it loaded.
+func (d *Dispenser) RemainingArgs() []string {
+	var args []string
+
+	for d.NextArg() {
+		if d.Val() == "{" {
+			d.cursor--
+			break
+		}
+		args = append(args, d.Val())
+	}
+
+	return args
+}
+
+// ArgErr returns an argument error, meaning that another
+// argument was expected but not found. In other words,
+// a line break or open curly brace was encountered instead of
+// an argument.
+func (d *Dispenser) ArgErr() error {
+	if d.Val() == "{" {
+		return d.Err("Unexpected token '{', expecting argument")
+	}
+	return d.Errf("Wrong argument count or unexpected line ending after '%s'", d.Val())
+}
+
+// SyntaxErr creates a generic syntax error which explains what was
+// found and what was expected.
+func (d *Dispenser) SyntaxErr(expected string) error {
+	msg := fmt.Sprintf("%s:%d - Syntax error: Unexpected token '%s', expecting '%s'", d.filename, d.Line(), d.Val(), expected)
+	return errors.New(msg)
+}
+
+// EofErr returns an EOF error, meaning that end of input
+// was found when another token was expected.
+func (d *Dispenser) EofErr() error {
+	return d.Errf("Unexpected EOF")
+}
+
+// Err generates a custom parse error with a message of msg.
+func (d *Dispenser) Err(msg string) error {
+	msg = fmt.Sprintf("%s:%d - Parse error: %s", d.filename, d.Line(), msg)
+	return errors.New(msg)
+}
+
+// Errf is like Err, but for formatted error messages
+func (d *Dispenser) Errf(format string, args ...interface{}) error {
+	return d.Err(fmt.Sprintf(format, args...))
+}
+
+// numLineBreaks counts how many line breaks are in the token
+// value given by the token index tknIdx. It returns 0 if the
+// token does not exist or there are no line breaks.
+func (d *Dispenser) numLineBreaks(tknIdx int) int {
+	if tknIdx < 0 || tknIdx >= len(d.tokens) {
+		return 0
+	}
+	return strings.Count(d.tokens[tknIdx].text, "\n")
+}

config/parse/dispenser_test.go

@@ -1,22 +1,6 @@
-// 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 caddyfile
+package parse
 
 import (
-	"io"
-	"log"
 	"reflect"
 	"strings"
 	"testing"
@@ -27,7 +11,7 @@ func TestDispenser_Val_Next(t *testing.T) {
 			  dir1 arg1
 			  dir2 arg2 arg3
 			  dir3`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	if val := d.Val(); val != "" {
 		t.Fatalf("Val(): Should return empty string when no token loaded; got '%s'", val)
@@ -65,7 +49,7 @@ func TestDispenser_NextArg(t *testing.T) {
 	input := `dir1 arg1
 			  dir2 arg2 arg3
 			  dir3`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	assertNext := func(shouldLoad bool, expectedVal string, expectedCursor int) {
 		if d.Next() != shouldLoad {
@@ -80,7 +64,7 @@ func TestDispenser_NextArg(t *testing.T) {
 	}
 
 	assertNextArg := func(expectedVal string, loadAnother bool, expectedCursor int) {
-		if !d.NextArg() {
+		if d.NextArg() != true {
 			t.Error("NextArg(): Should load next argument but got false instead")
 		}
 		if d.cursor != expectedCursor {
@@ -90,7 +74,7 @@ func TestDispenser_NextArg(t *testing.T) {
 			t.Errorf("Val(): Expected '%s' but got '%s'", expectedVal, val)
 		}
 		if !loadAnother {
-			if d.NextArg() {
+			if d.NextArg() != false {
 				t.Fatalf("NextArg(): Should NOT load another argument, but got true instead (val: '%s')", d.Val())
 			}
 			if d.cursor != expectedCursor {
@@ -112,7 +96,7 @@ func TestDispenser_NextLine(t *testing.T) {
 	input := `host:port
 			  dir1 arg1
 			  dir2 arg2 arg3`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	assertNextLine := func(shouldLoad bool, expectedVal string, expectedCursor int) {
 		if d.NextLine() != shouldLoad {
@@ -145,10 +129,10 @@ func TestDispenser_NextBlock(t *testing.T) {
 			  }
 			  foobar2 {
 			  }`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	assertNextBlock := func(shouldLoad bool, expectedCursor, expectedNesting int) {
-		if loaded := d.NextBlock(0); loaded != shouldLoad {
+		if loaded := d.NextBlock(); loaded != shouldLoad {
 			t.Errorf("NextBlock(): Should return %v but got %v", shouldLoad, loaded)
 		}
 		if d.cursor != expectedCursor {
@@ -175,7 +159,7 @@ func TestDispenser_Args(t *testing.T) {
 			  dir2 arg4 arg5
 			  dir3 arg6 arg7
 			  dir4`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	d.Next() // dir1
 
@@ -242,7 +226,7 @@ func TestDispenser_RemainingArgs(t *testing.T) {
 			  dir2 arg4 arg5
 			  dir3 arg6 { arg7
 			  dir4`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	d.Next() // dir1
 
@@ -279,7 +263,7 @@ func TestDispenser_ArgErr_Err(t *testing.T) {
 	input := `dir1 {
 			  }
 			  dir2 arg1 arg2`
-	d := newTestDispenser(input)
+	d := NewDispenser("Testfile", strings.NewReader(input))
 
 	d.cursor = 1 // {
 
@@ -306,11 +290,3 @@ func TestDispenser_ArgErr_Err(t *testing.T) {
 		t.Errorf("Expected error message with custom message in it ('foobar'); got '%v'", err)
 	}
 }
-
-func newTestDispenser(input string) *Dispenser {
-	tokens, err := allTokens("Testfile", []byte(input))
-	if err != nil && err != io.EOF {
-		log.Fatalf("getting all tokens from input: %v", err)
-	}
-	return NewDispenser(tokens)
-}

config/parse/lexer.go

@@ -1,18 +1,4 @@
-// Copyright 2015 Light Code Labs, LLC
-//
-// 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 caddyfile
+package parse
 
 import (
 	"bufio"
@@ -26,38 +12,22 @@ type (
 	// are separated by whitespace. A word can be enclosed
 	// in quotes if it contains whitespace.
 	lexer struct {
-		reader       *bufio.Reader
-		token        Token
-		line         int
-		skippedLines int
+		reader *bufio.Reader
+		token  token
+		line   int
 	}
 
-	// Token represents a single parsable unit.
-	Token struct {
-		File string
-		Line int
-		Text string
+	// token represents a single parsable unit.
+	token struct {
+		line int
+		text string
 	}
 )
 
 // load prepares the lexer to scan an input for tokens.
-// It discards any leading byte order mark.
 func (l *lexer) load(input io.Reader) error {
 	l.reader = bufio.NewReader(input)
 	l.line = 1
-
-	// discard byte order mark, if present
-	firstCh, _, err := l.reader.ReadRune()
-	if err != nil {
-		return err
-	}
-	if firstCh != 0xFEFF {
-		err := l.reader.UnreadRune()
-		if err != nil {
-			return err
-		}
-	}
-
 	return nil
 }
 
@@ -76,7 +46,7 @@ func (l *lexer) next() bool {
 	var comment, quoted, escaped bool
 
 	makeToken := func() bool {
-		l.token.Text = string(val)
+		l.token.text = string(val)
 		return true
 	}
 
@@ -92,29 +62,27 @@ func (l *lexer) next() bool {
 			panic(err)
 		}
 
-		if !escaped && ch == '\\' {
-			escaped = true
-			continue
-		}
-
 		if quoted {
-			if escaped {
-				// all is literal in quoted area,
-				// so only escape quotes
-				if ch != '"' {
-					val = append(val, '\\')
-				}
-				escaped = false
-			} else {
-				if ch == '"' {
+			if !escaped {
+				if ch == '\\' {
+					escaped = true
+					continue
+				} else if ch == '"' {
+					quoted = false
 					return makeToken()
 				}
 			}
 			if ch == '\n' {
-				l.line += 1 + l.skippedLines
-				l.skippedLines = 0
+				l.line++
+			}
+			if escaped {
+				// only escape quotes
+				if ch != '"' {
+					val = append(val, '\\')
+				}
 			}
 			val = append(val, ch)
+			escaped = false
 			continue
 		}
 
@@ -123,13 +91,7 @@ func (l *lexer) next() bool {
 				continue
 			}
 			if ch == '\n' {
-				if escaped {
-					l.skippedLines++
-					escaped = false
-				} else {
-					l.line += 1 + l.skippedLines
-					l.skippedLines = 0
-				}
+				l.line++
 				comment = false
 			}
 			if len(val) > 0 {
@@ -141,23 +103,19 @@ func (l *lexer) next() bool {
 		if ch == '#' {
 			comment = true
 		}
+
 		if comment {
 			continue
 		}
 
 		if len(val) == 0 {
-			l.token = Token{Line: l.line}
+			l.token = token{line: l.line}
 			if ch == '"' {
 				quoted = true
 				continue
 			}
 		}
 
-		if escaped {
-			val = append(val, '\\')
-			escaped = false
-		}
-
 		val = append(val, ch)
 	}
 }

config/parse/lexer_test.go

@@ -0,0 +1,165 @@
+package parse
+
+import (
+	"strings"
+	"testing"
+)
+
+type lexerTestCase struct {
+	input    string
+	expected []token
+}
+
+func TestLexer(t *testing.T) {
+	testCases := []lexerTestCase{
+		{
+			input: `host:123`,
+			expected: []token{
+				{line: 1, text: "host:123"},
+			},
+		},
+		{
+			input: `host:123
+
+					directive`,
+			expected: []token{
+				{line: 1, text: "host:123"},
+				{line: 3, text: "directive"},
+			},
+		},
+		{
+			input: `host:123 {
+						directive
+					}`,
+			expected: []token{
+				{line: 1, text: "host:123"},
+				{line: 1, text: "{"},
+				{line: 2, text: "directive"},
+				{line: 3, text: "}"},
+			},
+		},
+		{
+			input: `host:123 { directive }`,
+			expected: []token{
+				{line: 1, text: "host:123"},
+				{line: 1, text: "{"},
+				{line: 1, text: "directive"},
+				{line: 1, text: "}"},
+			},
+		},
+		{
+			input: `host:123 {
+						#comment
+						directive
+						# comment
+						foobar # another comment
+					}`,
+			expected: []token{
+				{line: 1, text: "host:123"},
+				{line: 1, text: "{"},
+				{line: 3, text: "directive"},
+				{line: 5, text: "foobar"},
+				{line: 6, text: "}"},
+			},
+		},
+		{
+			input: `a "quoted value" b
+					foobar`,
+			expected: []token{
+				{line: 1, text: "a"},
+				{line: 1, text: "quoted value"},
+				{line: 1, text: "b"},
+				{line: 2, text: "foobar"},
+			},
+		},
+		{
+			input: `A "quoted \"value\" inside" B`,
+			expected: []token{
+				{line: 1, text: "A"},
+				{line: 1, text: `quoted "value" inside`},
+				{line: 1, text: "B"},
+			},
+		},
+		{
+			input: `"don't\escape"`,
+			expected: []token{
+				{line: 1, text: `don't\escape`},
+			},
+		},
+		{
+			input: `"don't\\escape"`,
+			expected: []token{
+				{line: 1, text: `don't\\escape`},
+			},
+		},
+		{
+			input: `A "quoted value with line
+					break inside" {
+						foobar
+					}`,
+			expected: []token{
+				{line: 1, text: "A"},
+				{line: 1, text: "quoted value with line\n\t\t\t\t\tbreak inside"},
+				{line: 2, text: "{"},
+				{line: 3, text: "foobar"},
+				{line: 4, text: "}"},
+			},
+		},
+		{
+			input: `"C:\php\php-cgi.exe"`,
+			expected: []token{
+				{line: 1, text: `C:\php\php-cgi.exe`},
+			},
+		},
+		{
+			input: `empty "" string`,
+			expected: []token{
+				{line: 1, text: `empty`},
+				{line: 1, text: ``},
+				{line: 1, text: `string`},
+			},
+		},
+		{
+			input: "skip those\r\nCR characters",
+			expected: []token{
+				{line: 1, text: "skip"},
+				{line: 1, text: "those"},
+				{line: 2, text: "CR"},
+				{line: 2, text: "characters"},
+			},
+		},
+	}
+
+	for i, testCase := range testCases {
+		actual := tokenize(testCase.input)
+		lexerCompare(t, i, testCase.expected, actual)
+	}
+}
+
+func tokenize(input string) (tokens []token) {
+	l := lexer{}
+	l.load(strings.NewReader(input))
+	for l.next() {
+		tokens = append(tokens, l.token)
+	}
+	return
+}
+
+func lexerCompare(t *testing.T, n int, expected, actual []token) {
+	if len(expected) != len(actual) {
+		t.Errorf("Test case %d: expected %d token(s) but got %d", n, len(expected), len(actual))
+	}
+
+	for i := 0; i < len(actual) && i < len(expected); i++ {
+		if actual[i].line != expected[i].line {
+			t.Errorf("Test case %d token %d ('%s'): expected line %d but was line %d",
+				n, i, expected[i].text, expected[i].line, actual[i].line)
+			break
+		}
+		if actual[i].text != expected[i].text {
+			t.Errorf("Test case %d token %d: expected text '%s' but was '%s'",
+				n, i, expected[i].text, actual[i].text)
+			break
+		}
+	}
+}

config/parse/parse.go

@@ -0,0 +1,29 @@
+// Package parse provides facilities for parsing configuration files.
+package parse
+
+import "io"
+
+// ServerBlocks parses the input just enough to organize tokens,
+// in order, by server block. No further parsing is performed.
+// Server blocks are returned in the order in which they appear.
+func ServerBlocks(filename string, input io.Reader) ([]serverBlock, error) {
+	p := parser{Dispenser: NewDispenser(filename, input)}
+	blocks, err := p.parseAll()
+	return blocks, err
+}
+
+// allTokens lexes the entire input, but does not parse it.
+// It returns all the tokens from the input, unstructured
+// and in order.
+func allTokens(input io.Reader) (tokens []token) {
+	l := new(lexer)
+	l.load(input)
+	for l.next() {
+		tokens = append(tokens, l.token)
+	}
+	return
+}
+
+// Set of directives that are valid (unordered). Populated
+// by config package's init function.
+var ValidDirectives = make(map[string]struct{})

config/parse/parse_test.go

@@ -0,0 +1,22 @@
+package parse
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestAllTokens(t *testing.T) {
+	input := strings.NewReader("a b c\nd e")
+	expected := []string{"a", "b", "c", "d", "e"}
+	tokens := allTokens(input)
+
+	if len(tokens) != len(expected) {
+		t.Fatalf("Expected %d tokens, got %d", len(expected), len(tokens))
+	}
+
+	for i, val := range expected {
+		if tokens[i].text != val {
+			t.Errorf("Token %d should be '%s' but was '%s'", i, val, tokens[i].text)
+		}
+	}
+}

config/parse/parsing.go

@@ -0,0 +1,310 @@
+package parse
+
+import (
+	"net"
+	"os"
+	"strings"
+)
+
+type parser struct {
+	Dispenser
+	block multiServerBlock // current server block being parsed
+	eof   bool             // if we encounter a valid EOF in a hard place
+}
+
+func (p *parser) parseAll() ([]serverBlock, error) {
+	var blocks []serverBlock
+
+	for p.Next() {
+		err := p.parseOne()
+		if err != nil {
+			return blocks, err
+		}
+
+		// explode the multiServerBlock into multiple serverBlocks
+		for _, addr := range p.block.addresses {
+			blocks = append(blocks, serverBlock{
+				Host:   addr.host,
+				Port:   addr.port,
+				Tokens: p.block.tokens,
+			})
+		}
+	}
+
+	return blocks, nil
+}
+
+func (p *parser) parseOne() error {
+	p.block = multiServerBlock{tokens: make(map[string][]token)}
+
+	err := p.begin()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *parser) begin() error {
+	if len(p.tokens) == 0 {
+		return nil
+	}
+
+	err := p.addresses()
+	if err != nil {
+		return err
+	}
+
+	if p.eof {
+		// this happens if the Caddyfile consists of only
+		// a line of addresses and nothing else
+		return nil
+	}
+
+	err = p.blockContents()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (p *parser) addresses() error {
+	var expectingAnother bool
+
+	for {
+		tkn, startLine := p.Val(), p.Line()
+
+		// Open brace definitely indicates end of addresses
+		if tkn == "{" {
+			if expectingAnother {
+				return p.Errf("Expected another address but had '%s' - check for extra comma", tkn)
+			}
+			break
+		}
+
+		// Trailing comma indicates another address will follow, which
+		// may possibly be on the next line
+		if tkn[len(tkn)-1] == ',' {
+			tkn = tkn[:len(tkn)-1]
+			expectingAnother = true
+		} else {
+			expectingAnother = false // but we may still see another one on this line
+		}
+
+		// Parse and save this address
+		host, port, err := standardAddress(tkn)
+		if err != nil {
+			return err
+		}
+		p.block.addresses = append(p.block.addresses, address{host, port})
+
+		// Advance token and possibly break out of loop or return error
+		hasNext := p.Next()
+		if expectingAnother && !hasNext {
+			return p.EofErr()
+		}
+		if !expectingAnother && p.Line() > startLine {
+			break
+		}
+		if !hasNext {
+			p.eof = true
+			break // EOF
+		}
+	}
+
+	return nil
+}
+
+func (p *parser) blockContents() error {
+	errOpenCurlyBrace := p.openCurlyBrace()
+	if errOpenCurlyBrace != nil {
+		// single-server configs don't need curly braces
+		p.cursor--
+	}
+
+	err := p.directives()
+	if err != nil {
+		return err
+	}
+
+	// Only look for close curly brace if there was an opening
+	if errOpenCurlyBrace == nil {
+		err = p.closeCurlyBrace()
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+// directives parses through all the lines for directives
+// and it expects the next token to be the first
+// directive. It goes until EOF or closing curly brace
+// which ends the server block.
+func (p *parser) directives() error {
+	for p.Next() {
+		// end of server block
+		if p.Val() == "}" {
+			break
+		}
+
+		// special case: import directive replaces tokens during parse-time
+		if p.Val() == "import" {
+			err := p.doImport()
+			if err != nil {
+				return err
+			}
+			continue
+		}
+
+		// normal case: parse a directive on this line
+		if err := p.directive(); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// doImport swaps out the import directive and its argument
+// (a total of 2 tokens) with the tokens in the file specified.
+// When the function returns, the cursor is on the token before
+// where the import directive was. In other words, call Next()
+// to access the first token that was imported.
+func (p *parser) doImport() error {
+	if !p.NextArg() {
+		return p.ArgErr()
+	}
+	importFile := p.Val()
+	if p.NextArg() {
+		return p.Err("Import allows only one file to import")
+	}
+
+	file, err := os.Open(importFile)
+	if err != nil {
+		return p.Errf("Could not import %s - %v", importFile, err)
+	}
+	defer file.Close()
+	importedTokens := allTokens(file)
+
+	// Splice out the import directive and its argument (2 tokens total)
+	// and insert the imported tokens.
+	tokensBefore := p.tokens[:p.cursor-1]
+	tokensAfter := p.tokens[p.cursor+1:]
+	p.tokens = append(tokensBefore, append(importedTokens, tokensAfter...)...)
+	p.cursor -= 2
+
+	return nil
+}
+
+// directive collects tokens until the directive's scope
+// closes (either end of line or end of curly brace block).
+// It expects the currently-loaded token to be a directive
+// (or } that ends a server block). The collected tokens
+// are loaded into the current server block for later use
+// by directive setup functions.
+func (p *parser) directive() error {
+	dir := p.Val()
+	line := p.Line()
+	nesting := 0
+
+	if _, ok := ValidDirectives[dir]; !ok {
+		return p.Errf("Unknown directive '%s'", dir)
+	}
+
+	// The directive itself is appended as a relevant token
+	p.block.tokens[dir] = append(p.block.tokens[dir], p.tokens[p.cursor])
+
+	for p.Next() {
+		if p.Val() == "{" {
+			nesting++
+		} else if p.Line()+p.numLineBreaks(p.cursor) > line && nesting == 0 {
+			p.cursor-- // read too far
+			break
+		} else if p.Val() == "}" && nesting > 0 {
+			nesting--
+		} else if p.Val() == "}" && nesting == 0 {
+			return p.Err("Unexpected '}' because no matching opening brace")
+		}
+		p.block.tokens[dir] = append(p.block.tokens[dir], p.tokens[p.cursor])
+	}
+
+	if nesting > 0 {
+		return p.EofErr()
+	}
+	return nil
+}
+
+// openCurlyBrace expects the current token to be an
+// opening curly brace. This acts like an assertion
+// because it returns an error if the token is not
+// a opening curly brace. It does not advance the token.
+func (p *parser) openCurlyBrace() error {
+	if p.Val() != "{" {
+		return p.SyntaxErr("{")
+	}
+	return nil
+}
+
+// closeCurlyBrace expects the current token to be
+// a closing curly brace. This acts like an assertion
+// because it returns an error if the token is not
+// a closing curly brace. It does not advance the token.
+func (p *parser) closeCurlyBrace() error {
+	if p.Val() != "}" {
+		return p.SyntaxErr("}")
+	}
+	return nil
+}
+
+// standardAddress turns the accepted host and port patterns
+// into a format accepted by net.Dial.
+func standardAddress(str string) (host, port string, err error) {
+	var schemePort, splitPort string
+
+	if strings.HasPrefix(str, "https://") {
+		schemePort = "https"
+		str = str[8:]
+	} else if strings.HasPrefix(str, "http://") {
+		schemePort = "http"
+		str = str[7:]
+	}
+
+	host, splitPort, err = net.SplitHostPort(str)
+	if err != nil {
+		host, splitPort, err = net.SplitHostPort(str + ":") // tack on empty port
+	}
+	if err != nil {
+		// ¯\_(ツ)_/¯
+		host = str
+	}
+
+	if splitPort != "" {
+		port = splitPort
+	} else {
+		port = schemePort
+	}
+
+	return
+}
+
+type (
+	// serverBlock stores tokens by directive name for a
+	// single host:port (address)
+	serverBlock struct {
+		Host, Port string
+		Tokens     map[string][]token // directive name to tokens (including directive)
+	}
+
+	// multiServerBlock is the same as serverBlock but for
+	// multiple addresses that share the same tokens
+	multiServerBlock struct {
+		addresses []address
+		tokens    map[string][]token
+	}
+
+	address struct {
+		host, port string
+	}
+)

config/parse/parsing_test.go

@@ -0,0 +1,365 @@
+package parse
+
+import (
+	"reflect"
+	"strings"
+	"testing"
+)
+
+func TestStandardAddress(t *testing.T) {
+	for i, test := range []struct {
+		input      string
+		host, port string
+		shouldErr  bool
+	}{
+		{`localhost`, "localhost", "", false},
+		{`localhost:1234`, "localhost", "1234", false},
+		{`localhost:`, "localhost", "", false},
+		{`0.0.0.0`, "0.0.0.0", "", false},
+		{`127.0.0.1:1234`, "127.0.0.1", "1234", false},
+		{`:1234`, "", "1234", false},
+		{`[::1]`, "::1", "", false},
+		{`[::1]:1234`, "::1", "1234", false},
+		{`:`, "", "", false},
+		{`localhost:http`, "localhost", "http", false},
+		{`localhost:https`, "localhost", "https", false},
+		{`:http`, "", "http", false},
+		{`:https`, "", "https", false},
+		{`http://localhost`, "localhost", "http", false},
+		{`https://localhost`, "localhost", "https", false},
+		{`http://127.0.0.1`, "127.0.0.1", "http", false},
+		{`https://127.0.0.1`, "127.0.0.1", "https", false},
+		{`http://[::1]`, "::1", "http", false},
+		{`http://localhost:1234`, "localhost", "1234", false},
+		{`https://127.0.0.1:1234`, "127.0.0.1", "1234", false},
+		{`http://[::1]:1234`, "::1", "1234", false},
+		{``, "", "", false},
+		{`::1`, "::1", "", true},
+		{`localhost::`, "localhost::", "", true},
+		{`#$%@`, "#$%@", "", true},
+	} {
+		host, port, err := standardAddress(test.input)
+
+		if err != nil && !test.shouldErr {
+			t.Errorf("Test %d: Expected no error, but had error: %v", i, err)
+		}
+		if err == nil && test.shouldErr {
+			t.Errorf("Test %d: Expected error, but had none", i)
+		}
+
+		if host != test.host {
+			t.Errorf("Test %d: Expected host '%s', got '%s'", i, test.host, host)
+		}
+
+		if port != test.port {
+			t.Errorf("Test %d: Expected port '%s', got '%s'", i, test.port, port)
+		}
+	}
+}
+
+func TestParseOne(t *testing.T) {
+	setupParseTests()
+
+	testParseOne := func(input string) (multiServerBlock, error) {
+		p := testParser(input)
+		p.Next()
+		err := p.parseOne()
+		return p.block, err
+	}
+
+	for i, test := range []struct {
+		input     string
+		shouldErr bool
+		addresses []address
+		tokens    map[string]int // map of directive name to number of tokens expected
+	}{
+		{`localhost`, false, []address{
+			{"localhost", ""},
+		}, map[string]int{}},
+
+		{`localhost
+		  dir1`, false, []address{
+			{"localhost", ""},
+		}, map[string]int{
+			"dir1": 1,
+		}},
+
+		{`localhost:1234
+		  dir1 foo bar`, false, []address{
+			{"localhost", "1234"},
+		}, map[string]int{
+			"dir1": 3,
+		}},
+
+		{`localhost {
+		    dir1
+		  }`, false, []address{
+			{"localhost", ""},
+		}, map[string]int{
+			"dir1": 1,
+		}},
+
+		{`localhost:1234 {
+		    dir1 foo bar
+		    dir2
+		  }`, false, []address{
+			{"localhost", "1234"},
+		}, map[string]int{
+			"dir1": 3,
+			"dir2": 1,
+		}},
+
+		{`http://localhost https://localhost
+		  dir1 foo bar`, false, []address{
+			{"localhost", "http"},
+			{"localhost", "https"},
+		}, map[string]int{
+			"dir1": 3,
+		}},
+
+		{`http://localhost https://localhost {
+		    dir1 foo bar
+		  }`, false, []address{
+			{"localhost", "http"},
+			{"localhost", "https"},
+		}, map[string]int{
+			"dir1": 3,
+		}},
+
+		{`http://localhost, https://localhost {
+		    dir1 foo bar
+		  }`, false, []address{
+			{"localhost", "http"},
+			{"localhost", "https"},
+		}, map[string]int{
+			"dir1": 3,
+		}},
+
+		{`http://localhost, {
+		  }`, true, []address{
+			{"localhost", "http"},
+		}, map[string]int{}},
+
+		{`host1:80, http://host2.com
+		  dir1 foo bar
+		  dir2 baz`, false, []address{
+			{"host1", "80"},
+			{"host2.com", "http"},
+		}, map[string]int{
+			"dir1": 3,
+			"dir2": 2,
+		}},
+
+		{`http://host1.com,
+		  http://host2.com,
+		  https://host3.com`, false, []address{
+			{"host1.com", "http"},
+			{"host2.com", "http"},
+			{"host3.com", "https"},
+		}, map[string]int{}},
+
+		{`http://host1.com:1234, https://host2.com
+		  dir1 foo {
+		    bar baz
+		  }
+		  dir2`, false, []address{
+			{"host1.com", "1234"},
+			{"host2.com", "https"},
+		}, map[string]int{
+			"dir1": 6,
+			"dir2": 1,
+		}},
+
+		{`127.0.0.1
+		  dir1 {
+		    bar baz
+		  }
+		  dir2 {
+		    foo bar
+		  }`, false, []address{
+			{"127.0.0.1", ""},
+		}, map[string]int{
+			"dir1": 5,
+			"dir2": 5,
+		}},
+
+		{`127.0.0.1
+		  unknown_directive`, true, []address{
+			{"127.0.0.1", ""},
+		}, map[string]int{}},
+
+		{`localhost
+		  dir1 {
+		    foo`, true, []address{
+			{"localhost", ""},
+		}, map[string]int{
+			"dir1": 3,
+		}},
+
+		{`localhost
+		  dir1 {
+		  }`, false, []address{
+			{"localhost", ""},
+		}, map[string]int{
+			"dir1": 3,
+		}},
+
+		{`localhost
+		  dir1 {
+		    nested {
+		      foo
+		    }
+		  }
+		  dir2 foo bar`, false, []address{
+			{"localhost", ""},
+		}, map[string]int{
+			"dir1": 7,
+			"dir2": 3,
+		}},
+
+		{``, false, []address{}, map[string]int{}},
+	} {
+		result, err := testParseOne(test.input)
+
+		if test.shouldErr && err == nil {
+			t.Errorf("Test %d: Expected an error, but didn't get one", i)
+		}
+		if !test.shouldErr && err != nil {
+			t.Errorf("Test %d: Expected no error, but got: %v", i, err)
+		}
+
+		if len(result.addresses) != len(test.addresses) {
+			t.Errorf("Test %d: Expected %d addresses, got %d",
+				i, len(test.addresses), len(result.addresses))
+			continue
+		}
+		for j, addr := range result.addresses {
+			if addr.host != test.addresses[j].host {
+				t.Errorf("Test %d, address %d: Expected host to be '%s', but was '%s'",
+					i, j, test.addresses[j].host, addr.host)
+			}
+			if addr.port != test.addresses[j].port {
+				t.Errorf("Test %d, address %d: Expected port to be '%s', but was '%s'",
+					i, j, test.addresses[j].port, addr.port)
+			}
+		}
+
+		if len(result.tokens) != len(test.tokens) {
+			t.Errorf("Test %d: Expected %d directives, had %d",
+				i, len(test.tokens), len(result.tokens))
+			continue
+		}
+		for directive, tokens := range result.tokens {
+			if len(tokens) != test.tokens[directive] {
+				t.Errorf("Test %d, directive '%s': Expected %d tokens, counted %d",
+					i, directive, test.tokens[directive], len(tokens))
+				continue
+			}
+		}
+	}
+}
+
+func TestParseAll(t *testing.T) {
+	setupParseTests()
+
+	for i, test := range []struct {
+		input     string
+		shouldErr bool
+		addresses []address // one per expected server block, in order
+	}{
+		{`localhost`, false, []address{
+			{"localhost", ""},
+		}},
+
+		{`localhost:1234`, false, []address{
+			{"localhost", "1234"},
+		}},
+
+		{`localhost:1234 {
+		  }
+		  localhost:2015 {
+		  }`, false, []address{
+			{"localhost", "1234"},
+			{"localhost", "2015"},
+		}},
+
+		{`localhost:1234, http://host2`, false, []address{
+			{"localhost", "1234"},
+			{"host2", "http"},
+		}},
+
+		{`localhost:1234, http://host2,`, true, []address{}},
+
+		{`http://host1.com, http://host2.com {
+		  }
+		  https://host3.com, https://host4.com {
+		  }`, false, []address{
+			{"host1.com", "http"},
+			{"host2.com", "http"},
+			{"host3.com", "https"},
+			{"host4.com", "https"},
+		}},
+	} {
+		p := testParser(test.input)
+		blocks, err := p.parseAll()
+
+		if test.shouldErr && err == nil {
+			t.Errorf("Test %d: Expected an error, but didn't get one", i)
+		}
+		if !test.shouldErr && err != nil {
+			t.Errorf("Test %d: Expected no error, but got: %v", i, err)
+		}
+
+		if len(blocks) != len(test.addresses) {
+			t.Errorf("Test %d: Expected %d server blocks, got %d",
+				i, len(test.addresses), len(blocks))
+			continue
+		}
+		for j, block := range blocks {
+			if block.Host != test.addresses[j].host {
+				t.Errorf("Test %d, block %d: Expected host to be '%s', but was '%s'",
+					i, j, test.addresses[j].host, block.Host)
+			}
+			if block.Port != test.addresses[j].port {
+				t.Errorf("Test %d, block %d: Expected port to be '%s', but was '%s'",
+					i, j, test.addresses[j].port, block.Port)
+			}
+		}
+	}
+
+	// Exploding the server blocks that have more than one address should replicate/share tokens
+	p := testParser(`host1 {
+	                   dir1 foo bar
+	                 }
+
+	                 host2, host3 {
+	                   dir2 foo bar
+	                   dir3 foo {
+	                     bar
+	                   }
+	                 }`)
+	blocks, err := p.parseAll()
+	if err != nil {
+		t.Fatalf("Expected there to not be an error, but there was: %v", err)
+	}
+
+	if !reflect.DeepEqual(blocks[1].Tokens, blocks[2].Tokens) {
+		t.Errorf("Expected host2 and host3 to have same tokens, but they didn't.\nhost2 Block: %v\nhost3 Block: %v",
+			blocks[1].Tokens, blocks[2].Tokens)
+	}
+}
+
+func setupParseTests() {
+	// Set up some bogus directives for testing
+	ValidDirectives = map[string]struct{}{
+		"dir1": struct{}{},
+		"dir2": struct{}{},
+		"dir3": struct{}{},
+	}
+}
+
+func testParser(input string) parser {
+	buf := strings.NewReader(input)
+	p := parser{Dispenser: NewDispenser("Test", buf)}
+	return p
+}

config/setup/basicauth.go

@@ -0,0 +1,53 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/basicauth"
+)
+
+// BasicAuth configures a new BasicAuth middleware instance.
+func BasicAuth(c *Controller) (middleware.Middleware, error) {
+	rules, err := basicAuthParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	basic := basicauth.BasicAuth{Rules: rules}
+
+	return func(next middleware.Handler) middleware.Handler {
+		basic.Next = next
+		return basic
+	}, nil
+}
+
+func basicAuthParse(c *Controller) ([]basicauth.Rule, error) {
+	var rules []basicauth.Rule
+
+	for c.Next() {
+		var rule basicauth.Rule
+
+		args := c.RemainingArgs()
+
+		switch len(args) {
+		case 2:
+			rule.Username = args[0]
+			rule.Password = args[1]
+			for c.NextBlock() {
+				rule.Resources = append(rule.Resources, c.Val())
+				if c.NextArg() {
+					return rules, c.Errf("Expecting only one resource per line (extra '%s')", c.Val())
+				}
+			}
+		case 3:
+			rule.Resources = append(rule.Resources, args[0])
+			rule.Username = args[1]
+			rule.Password = args[2]
+		default:
+			return rules, c.ArgErr()
+		}
+
+		rules = append(rules, rule)
+	}
+
+	return rules, nil
+}

config/setup/basicauth_test.go

@@ -0,0 +1,100 @@
+package setup
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/mholt/caddy/middleware/basicauth"
+)
+
+func TestBasicAuth(t *testing.T) {
+	c := newTestController(`basicauth user pwd`)
+
+	mid, err := BasicAuth(c)
+	if err != nil {
+		t.Errorf("Expected no errors, but got: %v", err)
+	}
+	if mid == nil {
+		t.Fatal("Expected middleware, was nil instead")
+	}
+
+	handler := mid(emptyNext)
+	myHandler, ok := handler.(basicauth.BasicAuth)
+	if !ok {
+		t.Fatalf("Expected handler to be type BasicAuth, got: %#v", handler)
+	}
+
+	if !sameNext(myHandler.Next, emptyNext) {
+		t.Error("'Next' field of handler was not set properly")
+	}
+}
+
+func TestBasicAuthParse(t *testing.T) {
+	tests := []struct {
+		input     string
+		shouldErr bool
+		expected  []basicauth.Rule
+	}{
+		{`basicauth user pwd`, false, []basicauth.Rule{
+			{Username: "user", Password: "pwd"},
+		}},
+		{`basicauth user pwd {
+		}`, false, []basicauth.Rule{
+			{Username: "user", Password: "pwd"},
+		}},
+		{`basicauth user pwd {
+			/resource1
+			/resource2
+		}`, false, []basicauth.Rule{
+			{Username: "user", Password: "pwd", Resources: []string{"/resource1", "/resource2"}},
+		}},
+		{`basicauth /resource user pwd`, false, []basicauth.Rule{
+			{Username: "user", Password: "pwd", Resources: []string{"/resource"}},
+		}},
+		{`basicauth /res1 user1 pwd1
+		  basicauth /res2 user2 pwd2`, false, []basicauth.Rule{
+			{Username: "user1", Password: "pwd1", Resources: []string{"/res1"}},
+			{Username: "user2", Password: "pwd2", Resources: []string{"/res2"}},
+		}},
+		{`basicauth user`, true, []basicauth.Rule{}},
+		{`basicauth`, true, []basicauth.Rule{}},
+		{`basicauth /resource user pwd asdf`, true, []basicauth.Rule{}},
+	}
+
+	for i, test := range tests {
+		c := newTestController(test.input)
+		actual, err := basicAuthParse(c)
+
+		if err == nil && test.shouldErr {
+			t.Errorf("Test %d didn't error, but it should have", i)
+		} else if err != nil && !test.shouldErr {
+			t.Errorf("Test %d errored, but it shouldn't have; got '%v'", i, err)
+		}
+
+		if len(actual) != len(test.expected) {
+			t.Fatalf("Test %d expected %d rules, but got %d",
+				i, len(test.expected), len(actual))
+		}
+
+		for j, expectedRule := range test.expected {
+			actualRule := actual[j]
+
+			if actualRule.Username != expectedRule.Username {
+				t.Errorf("Test %d, rule %d: Expected username '%s', got '%s'",
+					i, j, expectedRule.Username, actualRule.Username)
+			}
+
+			if actualRule.Password != expectedRule.Password {
+				t.Errorf("Test %d, rule %d: Expected password '%s', got '%s'",
+					i, j, expectedRule.Password, actualRule.Password)
+			}
+
+			expectedRes := fmt.Sprintf("%v", expectedRule.Resources)
+			actualRes := fmt.Sprintf("%v", actualRule.Resources)
+			if actualRes != expectedRes {
+				t.Errorf("Test %d, rule %d: Expected resource list %s, but got %s",
+					i, j, expectedRes, actualRes)
+			}
+		}
+	}
+}

config/setup/bindhost.go

@@ -0,0 +1,12 @@
+package setup
+
+import "github.com/mholt/caddy/middleware"
+
+func BindHost(c *Controller) (middleware.Middleware, error) {
+	for c.Next() {
+		if !c.Args(&c.BindHost) {
+			return nil, c.ArgErr()
+		}
+	}
+	return nil, nil
+}

config/setup/browse.go

@@ -0,0 +1,222 @@
+package setup
+
+import (
+	"fmt"
+	"html/template"
+	"io/ioutil"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/browse"
+)
+
+// Browse configures a new Browse middleware instance.
+func Browse(c *Controller) (middleware.Middleware, error) {
+	configs, err := browseParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	browse := browse.Browse{
+		Root:    c.Root,
+		Configs: configs,
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		browse.Next = next
+		return browse
+	}, nil
+}
+
+func browseParse(c *Controller) ([]browse.Config, error) {
+	var configs []browse.Config
+
+	appendCfg := func(bc browse.Config) error {
+		for _, c := range configs {
+			if c.PathScope == bc.PathScope {
+				return fmt.Errorf("Duplicate browsing config for %s", c.PathScope)
+			}
+		}
+		configs = append(configs, bc)
+		return nil
+	}
+
+	for c.Next() {
+		var bc browse.Config
+
+		// First argument is directory to allow browsing; default is site root
+		if c.NextArg() {
+			bc.PathScope = c.Val()
+		} else {
+			bc.PathScope = "/"
+		}
+
+		// Second argument would be the template file to use
+		var tplText string
+		if c.NextArg() {
+			tplBytes, err := ioutil.ReadFile(c.Val())
+			if err != nil {
+				return configs, err
+			}
+			tplText = string(tplBytes)
+		} else {
+			tplText = defaultTemplate
+		}
+
+		// Build the template
+		tpl, err := template.New("listing").Parse(tplText)
+		if err != nil {
+			return configs, err
+		}
+		bc.Template = tpl
+
+		// Save configuration
+		err = appendCfg(bc)
+		if err != nil {
+			return configs, err
+		}
+	}
+
+	return configs, nil
+}
+
+// The default template to use when serving up directory listings
+const defaultTemplate = `<!DOCTYPE html>
+<html>
+	<head>
+		<title>{{.Name}}</title>
+		<meta charset="utf-8">
+<style>
+* { padding: 0; margin: 0; }
+
+body {
+	padding: 1% 2%;
+	font: 16px Arial;
+}
+
+header {
+	font-size: 45px;
+	padding: 25px;
+}
+
+header a {
+	text-decoration: none;
+	color: inherit;
+}
+
+header .up {
+	display: inline-block;
+	height: 50px;
+	width: 50px;
+	text-align: center;
+	margin-right: 20px;
+}
+
+header a.up:hover {
+	background: #000;
+	color: #FFF;
+}
+
+h1 {
+	font-size: 30px;
+	display: inline;
+}
+
+table {
+	border: 0;
+	border-collapse: collapse;
+	max-width: 750px;
+	margin: 0 auto;
+}
+
+th,
+td {
+	padding: 4px 20px;
+	vertical-align: middle;
+	line-height: 1.5em; /* emoji are kind of odd heights */
+}
+
+th {
+	text-align: left;
+}
+
+@media (max-width: 700px) {
+	.hideable {
+		display: none;
+	}
+
+	body {
+		padding: 0;
+	}
+
+	header,
+	header h1 {
+		font-size: 16px;
+	}
+
+	header {
+		position: fixed;
+		top: 0;
+		width: 100%;
+		background: #333;
+		color: #FFF;
+		padding: 15px;
+		text-align: center;
+	}
+
+	header .up {
+		height: auto;
+		width: auto;
+		display: none;
+	}
+
+	header a.up {
+		display: inline-block;
+		position: absolute;
+		left: 0;
+		top: 0;
+		width: 40px;
+		height: 48px;
+		font-size: 35px;
+	}
+
+	header h1 {
+		font-weight: normal;
+	}
+
+	main {
+		margin-top: 70px;
+	}
+}
+</style>
+	</head>
+	<body>
+		<header>
+			{{if .CanGoUp}}
+			<a href=".." class="up" title="Up one level">&#11025;</a>
+			{{else}}
+			<div class="up">&nbsp;</div>
+			{{end}}
+
+			<h1>{{.Path}}</h1>
+		</header>
+		<main>
+			<table>
+				<tr>
+					<th>Name</th>
+					<th>Size</th>
+					<th class="hideable">Modified</th>
+				</tr>
+				{{range .Items}}
+				<tr>
+					<td>
+						{{if .IsDir}}&#128194;{{else}}&#128196;{{end}}
+						<a href="{{.URL}}">{{.Name}}</a>
+					</td>
+					<td>{{.HumanSize}}</td>
+					<td class="hideable">{{.HumanModTime "01/02/2006 3:04:05 PM -0700"}}</td>
+				</tr>
+				{{end}}
+			</table>
+		</main>
+	</body>
+</html>`

config/setup/controller.go

@@ -0,0 +1,11 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/config/parse"
+	"github.com/mholt/caddy/server"
+)
+
+type Controller struct {
+	*server.Config
+	parse.Dispenser
+}

config/setup/controller_test.go

@@ -0,0 +1,32 @@
+package setup
+
+import (
+	"fmt"
+	"net/http"
+	"strings"
+
+	"github.com/mholt/caddy/config/parse"
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/server"
+)
+
+// newTestController creates a new *Controller for
+// the input specified, with a filename of "Testfile"
+func newTestController(input string) *Controller {
+	return &Controller{
+		Config:    &server.Config{},
+		Dispenser: parse.NewDispenser("Testfile", strings.NewReader(input)),
+	}
+}
+
+// emptyNext is a no-op function that can be passed into
+// middleware.Middleware functions so that the assignment
+// to the Next field of the Handler can be tested.
+var emptyNext = middleware.HandlerFunc(func(w http.ResponseWriter, r *http.Request) (int, error) {
+	return 0, nil
+})
+
+// sameNext does a pointer comparison between next1 and next2.
+func sameNext(next1, next2 middleware.Handler) bool {
+	return fmt.Sprintf("%p", next1) == fmt.Sprintf("%p", next2)
+}

config/setup/errors.go

@@ -0,0 +1,103 @@
+package setup
+
+import (
+	"log"
+	"os"
+	"path"
+	"strconv"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/errors"
+)
+
+// Errors configures a new gzip middleware instance.
+func Errors(c *Controller) (middleware.Middleware, error) {
+	handler, err := errorsParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	// Open the log file for writing when the server starts
+	c.Startup = append(c.Startup, func() error {
+		var err error
+		var file *os.File
+
+		if handler.LogFile == "stdout" {
+			file = os.Stdout
+		} else if handler.LogFile == "stderr" {
+			file = os.Stderr
+		} else if handler.LogFile != "" {
+			file, err = os.OpenFile(handler.LogFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
+			if err != nil {
+				return err
+			}
+		}
+
+		handler.Log = log.New(file, "", 0)
+		return nil
+	})
+
+	return func(next middleware.Handler) middleware.Handler {
+		handler.Next = next
+		return handler
+	}, nil
+}
+
+func errorsParse(c *Controller) (*errors.ErrorHandler, error) {
+	// Very important that we make a pointer because the Startup
+	// function that opens the log file must have access to the
+	// same instance of the handler, not a copy.
+	handler := &errors.ErrorHandler{ErrorPages: make(map[int]string)}
+
+	optionalBlock := func() (bool, error) {
+		var hadBlock bool
+
+		for c.NextBlock() {
+			hadBlock = true
+
+			what := c.Val()
+			if !c.NextArg() {
+				return hadBlock, c.ArgErr()
+			}
+			where := c.Val()
+
+			if what == "log" {
+				handler.LogFile = where
+			} else {
+				// Error page; ensure it exists
+				where = path.Join(c.Root, where)
+				f, err := os.Open(where)
+				if err != nil {
+					return hadBlock, c.Err("Unable to open error page '" + where + "': " + err.Error())
+				}
+				f.Close()
+
+				whatInt, err := strconv.Atoi(what)
+				if err != nil {
+					return hadBlock, c.Err("Expecting a numeric status code, got '" + what + "'")
+				}
+				handler.ErrorPages[whatInt] = where
+			}
+		}
+		return hadBlock, nil
+	}
+
+	for c.Next() {
+		// Configuration may be in a block
+		hadBlock, err := optionalBlock()
+		if err != nil {
+			return handler, err
+		}
+
+		// Otherwise, the only argument would be an error log file name
+		if !hadBlock {
+			if c.NextArg() {
+				handler.LogFile = c.Val()
+			} else {
+				handler.LogFile = errors.DefaultLogFilename
+			}
+		}
+	}
+
+	return handler, nil
+}

config/setup/ext.go

@@ -0,0 +1,54 @@
+package setup
+
+import (
+	"os"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/extensions"
+)
+
+// Ext configures a new instance of 'extensions' middleware for clean URLs.
+func Ext(c *Controller) (middleware.Middleware, error) {
+	root := c.Root
+
+	exts, err := extParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		return extensions.Ext{
+			Next:       next,
+			Extensions: exts,
+			Root:       root,
+		}
+	}, nil
+}
+
+// extParse sets up an instance of extension middleware
+// from a middleware controller and returns a list of extensions.
+func extParse(c *Controller) ([]string, error) {
+	var exts []string
+
+	for c.Next() {
+		// At least one extension is required
+		if !c.NextArg() {
+			return exts, c.ArgErr()
+		}
+		exts = append(exts, c.Val())
+
+		// Tack on any other extensions that may have been listed
+		exts = append(exts, c.RemainingArgs()...)
+	}
+
+	return exts, nil
+}
+
+// resourceExists returns true if the file specified at
+// root + path exists; false otherwise.
+func resourceExists(root, path string) bool {
+	_, err := os.Stat(root + path)
+	// technically we should use os.IsNotExist(err)
+	// but we don't handle any other kinds of errors anyway
+	return err == nil
+}

config/setup/fastcgi.go

@@ -0,0 +1,110 @@
+package setup
+
+import (
+	"errors"
+	"net/http"
+	"path/filepath"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/fastcgi"
+)
+
+// FastCGI configures a new FastCGI middleware instance.
+func FastCGI(c *Controller) (middleware.Middleware, error) {
+	absRoot, err := filepath.Abs(c.Root)
+	if err != nil {
+		return nil, err
+	}
+
+	rules, err := fastcgiParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		return fastcgi.Handler{
+			Next:            next,
+			Rules:           rules,
+			Root:            c.Root,
+			AbsRoot:         absRoot,
+			FileSys:         http.Dir(c.Root),
+			SoftwareName:    c.AppName,
+			SoftwareVersion: c.AppVersion,
+			ServerName:      c.Host,
+			ServerPort:      c.Port,
+		}
+	}, nil
+}
+
+func fastcgiParse(c *Controller) ([]fastcgi.Rule, error) {
+	var rules []fastcgi.Rule
+
+	for c.Next() {
+		var rule fastcgi.Rule
+
+		args := c.RemainingArgs()
+
+		switch len(args) {
+		case 0:
+			return rules, c.ArgErr()
+		case 1:
+			rule.Path = "/"
+			rule.Address = args[0]
+		case 2:
+			rule.Path = args[0]
+			rule.Address = args[1]
+		case 3:
+			rule.Path = args[0]
+			rule.Address = args[1]
+			err := fastcgiPreset(args[2], &rule)
+			if err != nil {
+				return rules, c.Err("Invalid fastcgi rule preset '" + args[2] + "'")
+			}
+		}
+
+		for c.NextBlock() {
+			switch c.Val() {
+			case "ext":
+				if !c.NextArg() {
+					return rules, c.ArgErr()
+				}
+				rule.Ext = c.Val()
+			case "split":
+				if !c.NextArg() {
+					return rules, c.ArgErr()
+				}
+				rule.SplitPath = c.Val()
+			case "index":
+				args := c.RemainingArgs()
+				if len(args) == 0 {
+					return rules, c.ArgErr()
+				}
+				rule.IndexFiles = args
+			case "env":
+				envArgs := c.RemainingArgs()
+				if len(envArgs) < 2 {
+					return rules, c.ArgErr()
+				}
+				rule.EnvVars = append(rule.EnvVars, [2]string{envArgs[0], envArgs[1]})
+			}
+		}
+
+		rules = append(rules, rule)
+	}
+
+	return rules, nil
+}
+
+// fastcgiPreset configures rule according to name. It returns an error if
+// name is not a recognized preset name.
+func fastcgiPreset(name string, rule *fastcgi.Rule) error {
+	switch name {
+	case "php":
+		rule.Ext = ".php"
+		rule.SplitPath = ".php"
+		rule.IndexFiles = []string{"index.php"}
+	default:
+		return errors.New(name + " is not a valid preset name")
+	}
+	return nil
+}

config/setup/git.go

@@ -0,0 +1,193 @@
+package setup
+
+import (
+	"fmt"
+	"log"
+	"net/url"
+	"path/filepath"
+	"runtime"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/git"
+)
+
+// Git configures a new Git service routine.
+func Git(c *Controller) (middleware.Middleware, error) {
+	repo, err := gitParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	c.Startup = append(c.Startup, func() error {
+		// Startup functions are blocking; start
+		// service routine in background
+		go func() {
+			for {
+				time.Sleep(repo.Interval)
+
+				err := repo.Pull()
+				if err != nil {
+					if git.Logger == nil {
+						log.Println(err)
+					} else {
+						git.Logger.Println(err)
+					}
+				}
+			}
+		}()
+
+		// Do a pull right away to return error
+		return repo.Pull()
+	})
+
+	return nil, err
+}
+
+func gitParse(c *Controller) (*git.Repo, error) {
+	repo := &git.Repo{Branch: "master", Interval: git.DefaultInterval, Path: c.Root}
+
+	for c.Next() {
+		args := c.RemainingArgs()
+
+		switch len(args) {
+		case 2:
+			repo.Path = filepath.Clean(c.Root + string(filepath.Separator) + args[1])
+			fallthrough
+		case 1:
+			repo.URL = args[0]
+		}
+
+		for c.NextBlock() {
+			switch c.Val() {
+			case "repo":
+				if !c.NextArg() {
+					return nil, c.ArgErr()
+				}
+				repo.URL = c.Val()
+			case "path":
+				if !c.NextArg() {
+					return nil, c.ArgErr()
+				}
+				repo.Path = filepath.Clean(c.Root + string(filepath.Separator) + c.Val())
+			case "branch":
+				if !c.NextArg() {
+					return nil, c.ArgErr()
+				}
+				repo.Branch = c.Val()
+			case "key":
+				if !c.NextArg() {
+					return nil, c.ArgErr()
+				}
+				repo.KeyPath = c.Val()
+			case "interval":
+				if !c.NextArg() {
+					return nil, c.ArgErr()
+				}
+				t, _ := strconv.Atoi(c.Val())
+				if t > 0 {
+					repo.Interval = time.Duration(t) * time.Second
+				}
+			case "then":
+				thenArgs := c.RemainingArgs()
+				if len(thenArgs) == 0 {
+					return nil, c.ArgErr()
+				}
+				repo.Then = strings.Join(thenArgs, " ")
+			default:
+				return nil, c.ArgErr()
+			}
+		}
+	}
+
+	// if repo is not specified, return error
+	if repo.URL == "" {
+		return nil, c.ArgErr()
+	}
+
+	// if private key is not specified, convert repository URL to https
+	// to avoid ssh authentication
+	// else validate git URL
+	// Note: private key support not yet available on Windows
+	var err error
+	if repo.KeyPath == "" {
+		repo.URL, repo.Host, err = sanitizeHTTP(repo.URL)
+	} else {
+		repo.URL, repo.Host, err = sanitizeGit(repo.URL)
+		// TODO add Windows support for private repos
+		if runtime.GOOS == "windows" {
+			return nil, fmt.Errorf("Private repository not yet supported on Windows")
+		}
+	}
+
+	if err != nil {
+		return nil, err
+	}
+
+	// validate git requirements
+	if err = git.Init(); err != nil {
+		return nil, err
+	}
+
+	return repo, repo.Prepare()
+}
+
+// sanitizeHTTP cleans up repository URL and converts to https format
+// if currently in ssh format.
+// Returns sanitized url, hostName (e.g. github.com, bitbucket.com)
+// and possible error
+func sanitizeHTTP(repoURL string) (string, string, error) {
+	url, err := url.Parse(repoURL)
+	if err != nil {
+		return "", "", err
+	}
+
+	if url.Host == "" && strings.HasPrefix(url.Path, "git@") {
+		url.Path = url.Path[len("git@"):]
+		i := strings.Index(url.Path, ":")
+		if i < 0 {
+			return "", "", fmt.Errorf("Invalid git url %s", repoURL)
+		}
+		url.Host = url.Path[:i]
+		url.Path = "/" + url.Path[i+1:]
+	}
+
+	repoURL = "https://" + url.Host + url.Path
+
+	// add .git suffix if missing
+	if !strings.HasSuffix(repoURL, ".git") {
+		repoURL += ".git"
+	}
+
+	return repoURL, url.Host, nil
+}
+
+// sanitizeGit cleans up repository url and converts to ssh format for private
+// repositories if required.
+// Returns sanitized url, hostName (e.g. github.com, bitbucket.com)
+// and possible error
+func sanitizeGit(repoURL string) (string, string, error) {
+	repoURL = strings.TrimSpace(repoURL)
+
+	// check if valid ssh format
+	if !strings.HasPrefix(repoURL, "git@") || strings.Index(repoURL, ":") < len("git@a:") {
+		// check if valid http format and convert to ssh
+		if url, err := url.Parse(repoURL); err == nil && strings.HasPrefix(url.Scheme, "http") {
+			repoURL = fmt.Sprintf("git@%v:%v", url.Host, url.Path[1:])
+		} else {
+			return "", "", fmt.Errorf("Invalid git url %s", repoURL)
+		}
+	}
+	hostURL := repoURL[len("git@"):]
+	i := strings.Index(hostURL, ":")
+	host := hostURL[:i]
+
+	// add .git suffix if missing
+	if !strings.HasSuffix(repoURL, ".git") {
+		repoURL += ".git"
+	}
+
+	return repoURL, host, nil
+}

config/setup/git_test.go

@@ -0,0 +1,144 @@
+package setup
+
+import (
+	"testing"
+	"time"
+
+	"github.com/mholt/caddy/middleware/git"
+	"github.com/mholt/caddy/middleware/git/gittest"
+)
+
+// init sets the OS used to fakeOS
+func init() {
+	git.SetOS(gittest.FakeOS)
+}
+
+func TestGit(t *testing.T) {
+	c := newTestController(`git git@github.com:mholt/caddy.git`)
+
+	mid, err := Git(c)
+	if err != nil {
+		t.Errorf("Expected no errors, but got: %v", err)
+	}
+	if mid != nil {
+		t.Fatal("Git middleware is a background service and expected to be nil.")
+	}
+}
+
+func TestGitParse(t *testing.T) {
+	tests := []struct {
+		input     string
+		shouldErr bool
+		expected  *git.Repo
+	}{
+		{`git git@github.com:user/repo`, false, &git.Repo{
+			URL: "https://github.com/user/repo.git",
+		}},
+		{`git github.com/user/repo`, false, &git.Repo{
+			URL: "https://github.com/user/repo.git",
+		}},
+		{`git git@github.com/user/repo`, true, nil},
+		{`git http://github.com/user/repo`, false, &git.Repo{
+			URL: "https://github.com/user/repo.git",
+		}},
+		{`git https://github.com/user/repo`, false, &git.Repo{
+			URL: "https://github.com/user/repo.git",
+		}},
+		{`git http://github.com/user/repo {
+			key ~/.key
+		}`, false, &git.Repo{
+			KeyPath: "~/.key",
+			URL:     "git@github.com:user/repo.git",
+		}},
+		{`git git@github.com:user/repo {
+			key ~/.key
+		}`, false, &git.Repo{
+			KeyPath: "~/.key",
+			URL:     "git@github.com:user/repo.git",
+		}},
+		{`git `, true, nil},
+		{`git {
+		}`, true, nil},
+		{`git {
+		repo git@github.com:user/repo.git`, true, nil},
+		{`git {
+		repo git@github.com:user/repo
+		key ~/.key
+		}`, false, &git.Repo{
+			KeyPath: "~/.key",
+			URL:     "git@github.com:user/repo.git",
+		}},
+		{`git {
+		repo git@github.com:user/repo
+		key ~/.key
+		interval 600
+		}`, false, &git.Repo{
+			KeyPath:  "~/.key",
+			URL:      "git@github.com:user/repo.git",
+			Interval: time.Second * 600,
+		}},
+		{`git {
+		repo git@github.com:user/repo
+		branch dev
+		}`, false, &git.Repo{
+			Branch: "dev",
+			URL:    "https://github.com/user/repo.git",
+		}},
+		{`git {
+		key ~/.key
+		}`, true, nil},
+		{`git {
+		repo git@github.com:user/repo
+		key ~/.key
+		then echo hello world
+		}`, false, &git.Repo{
+			KeyPath: "~/.key",
+			URL:     "git@github.com:user/repo.git",
+			Then:    "echo hello world",
+		}},
+	}
+
+	for i, test := range tests {
+		c := newTestController(test.input)
+		repo, err := gitParse(c)
+		if !test.shouldErr && err != nil {
+			t.Errorf("Test %v should not error but found %v", i, err)
+			continue
+		}
+		if test.shouldErr && err == nil {
+			t.Errorf("Test %v should error but found nil", i)
+			continue
+		}
+		if !reposEqual(test.expected, repo) {
+			t.Errorf("Test %v expects %v but found %v", i, test.expected, repo)
+		}
+	}
+}
+
+func reposEqual(expected, repo *git.Repo) bool {
+	if expected == nil {
+		return repo == nil
+	}
+	if expected.Branch != "" && expected.Branch != repo.Branch {
+		return false
+	}
+	if expected.Host != "" && expected.Host != repo.Host {
+		return false
+	}
+	if expected.Interval != 0 && expected.Interval != repo.Interval {
+		return false
+	}
+	if expected.KeyPath != "" && expected.KeyPath != repo.KeyPath {
+		return false
+	}
+	if expected.Path != "" && expected.Path != repo.Path {
+		return false
+	}
+	if expected.Then != "" && expected.Then != repo.Then {
+		return false
+	}
+	if expected.URL != "" && expected.URL != repo.URL {
+		return false
+	}
+	return true
+}

config/setup/gzip.go

@@ -0,0 +1,13 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/gzip"
+)
+
+// Gzip configures a new gzip middleware instance.
+func Gzip(c *Controller) (middleware.Middleware, error) {
+	return func(next middleware.Handler) middleware.Handler {
+		return gzip.Gzip{Next: next}
+	}, nil
+}

config/setup/gzip_test.go

@@ -0,0 +1,29 @@
+package setup
+
+import (
+	"testing"
+
+	"github.com/mholt/caddy/middleware/gzip"
+)
+
+func TestGzip(t *testing.T) {
+	c := newTestController(`gzip`)
+
+	mid, err := Gzip(c)
+	if err != nil {
+		t.Errorf("Expected no errors, but got: %v", err)
+	}
+	if mid == nil {
+		t.Fatal("Expected middleware, was nil instead")
+	}
+
+	handler := mid(emptyNext)
+	myHandler, ok := handler.(gzip.Gzip)
+	if !ok {
+		t.Fatalf("Expected handler to be type Gzip, got: %#v", handler)
+	}
+
+	if !sameNext(myHandler.Next, emptyNext) {
+		t.Error("'Next' field of handler was not set properly")
+	}
+}

config/setup/headers.go

@@ -0,0 +1,84 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/headers"
+)
+
+// Headers configures a new Headers middleware instance.
+func Headers(c *Controller) (middleware.Middleware, error) {
+	rules, err := headersParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		return headers.Headers{Next: next, Rules: rules}
+	}, nil
+}
+
+func headersParse(c *Controller) ([]headers.Rule, error) {
+	var rules []headers.Rule
+
+	for c.NextLine() {
+		var head headers.Rule
+		var isNewPattern bool
+
+		if !c.NextArg() {
+			return rules, c.ArgErr()
+		}
+		pattern := c.Val()
+
+		// See if we already have a definition for this Path pattern...
+		for _, h := range rules {
+			if h.Path == pattern {
+				head = h
+				break
+			}
+		}
+
+		// ...otherwise, this is a new pattern
+		if head.Path == "" {
+			head.Path = pattern
+			isNewPattern = true
+		}
+
+		for c.NextBlock() {
+			// A block of headers was opened...
+
+			h := headers.Header{Name: c.Val()}
+
+			if c.NextArg() {
+				h.Value = c.Val()
+			}
+
+			head.Headers = append(head.Headers, h)
+		}
+		if c.NextArg() {
+			// ... or single header was defined as an argument instead.
+
+			h := headers.Header{Name: c.Val()}
+
+			h.Value = c.Val()
+
+			if c.NextArg() {
+				h.Value = c.Val()
+			}
+
+			head.Headers = append(head.Headers, h)
+		}
+
+		if isNewPattern {
+			rules = append(rules, head)
+		} else {
+			for i := 0; i < len(rules); i++ {
+				if rules[i].Path == pattern {
+					rules[i] = head
+					break
+				}
+			}
+		}
+	}
+
+	return rules, nil
+}

config/setup/headers_test.go

@@ -0,0 +1,85 @@
+package setup
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/mholt/caddy/middleware/headers"
+)
+
+func TestHeaders(t *testing.T) {
+	c := newTestController(`header / Foo Bar`)
+
+	mid, err := Headers(c)
+	if err != nil {
+		t.Errorf("Expected no errors, but got: %v", err)
+	}
+	if mid == nil {
+		t.Fatal("Expected middleware, was nil instead")
+	}
+
+	handler := mid(emptyNext)
+	myHandler, ok := handler.(headers.Headers)
+	if !ok {
+		t.Fatalf("Expected handler to be type Headers, got: %#v", handler)
+	}
+
+	if !sameNext(myHandler.Next, emptyNext) {
+		t.Error("'Next' field of handler was not set properly")
+	}
+}
+
+func TestHeadersParse(t *testing.T) {
+	tests := []struct {
+		input     string
+		shouldErr bool
+		expected  []headers.Rule
+	}{
+		{`header /foo Foo "Bar Baz"`,
+			false, []headers.Rule{
+				{Path: "/foo", Headers: []headers.Header{
+					{"Foo", "Bar Baz"},
+				}},
+			}},
+		{`header /bar { Foo "Bar Baz" Baz Qux }`,
+			false, []headers.Rule{
+				{Path: "/bar", Headers: []headers.Header{
+					{"Foo", "Bar Baz"},
+					{"Baz", "Qux"},
+				}},
+			}},
+	}
+
+	for i, test := range tests {
+		c := newTestController(test.input)
+		actual, err := headersParse(c)
+
+		if err == nil && test.shouldErr {
+			t.Errorf("Test %d didn't error, but it should have", i)
+		} else if err != nil && !test.shouldErr {
+			t.Errorf("Test %d errored, but it shouldn't have; got '%v'", i, err)
+		}
+
+		if len(actual) != len(test.expected) {
+			t.Fatalf("Test %d expected %d rules, but got %d",
+				i, len(test.expected), len(actual))
+		}
+
+		for j, expectedRule := range test.expected {
+			actualRule := actual[j]
+
+			if actualRule.Path != expectedRule.Path {
+				t.Errorf("Test %d, rule %d: Expected path %s, but got %s",
+					i, j, expectedRule.Path, actualRule.Path)
+			}
+
+			expectedHeaders := fmt.Sprintf("%v", expectedRule.Headers)
+			actualHeaders := fmt.Sprintf("%v", actualRule.Headers)
+
+			if actualHeaders != expectedHeaders {
+				t.Errorf("Test %d, rule %d: Expected headers %s, but got %s",
+					i, j, expectedHeaders, actualHeaders)
+			}
+		}
+	}
+}

config/setup/internal.go

@@ -0,0 +1,31 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/internal"
+)
+
+// Internal configures a new Internal middleware instance.
+func Internal(c *Controller) (middleware.Middleware, error) {
+	paths, err := internalParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		return internal.Internal{Next: next, Paths: paths}
+	}, nil
+}
+
+func internalParse(c *Controller) ([]string, error) {
+	var paths []string
+
+	for c.Next() {
+		if !c.NextArg() {
+			return paths, c.ArgErr()
+		}
+		paths = append(paths, c.Val())
+	}
+
+	return paths, nil
+}

config/setup/log.go

@@ -0,0 +1,91 @@
+package setup
+
+import (
+	"log"
+	"os"
+
+	"github.com/mholt/caddy/middleware"
+	caddylog "github.com/mholt/caddy/middleware/log"
+)
+
+// Log sets up the logging middleware.
+func Log(c *Controller) (middleware.Middleware, error) {
+	rules, err := logParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	// Open the log files for writing when the server starts
+	c.Startup = append(c.Startup, func() error {
+		for i := 0; i < len(rules); i++ {
+			var err error
+			var file *os.File
+
+			if rules[i].OutputFile == "stdout" {
+				file = os.Stdout
+			} else if rules[i].OutputFile == "stderr" {
+				file = os.Stderr
+			} else {
+				file, err = os.OpenFile(rules[i].OutputFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
+				if err != nil {
+					return err
+				}
+			}
+
+			rules[i].Log = log.New(file, "", 0)
+		}
+
+		return nil
+	})
+
+	return func(next middleware.Handler) middleware.Handler {
+		return caddylog.Logger{Next: next, Rules: rules}
+	}, nil
+}
+
+func logParse(c *Controller) ([]caddylog.Rule, error) {
+	var rules []caddylog.Rule
+
+	for c.Next() {
+		args := c.RemainingArgs()
+
+		if len(args) == 0 {
+			// Nothing specified; use defaults
+			rules = append(rules, caddylog.Rule{
+				PathScope:  "/",
+				OutputFile: caddylog.DefaultLogFilename,
+				Format:     caddylog.DefaultLogFormat,
+			})
+		} else if len(args) == 1 {
+			// Only an output file specified
+			rules = append(rules, caddylog.Rule{
+				PathScope:  "/",
+				OutputFile: args[0],
+				Format:     caddylog.DefaultLogFormat,
+			})
+		} else {
+			// Path scope, output file, and maybe a format specified
+
+			format := caddylog.DefaultLogFormat
+
+			if len(args) > 2 {
+				switch args[2] {
+				case "{common}":
+					format = caddylog.CommonLogFormat
+				case "{combined}":
+					format = caddylog.CombinedLogFormat
+				default:
+					format = args[2]
+				}
+			}
+
+			rules = append(rules, caddylog.Rule{
+				PathScope:  args[0],
+				OutputFile: args[1],
+				Format:     format,
+			})
+		}
+	}
+
+	return rules, nil
+}

config/setup/markdown.go

@@ -0,0 +1,163 @@
+package setup
+
+import (
+	"io/ioutil"
+	"net/http"
+	"os"
+	"path"
+	"path/filepath"
+	"strings"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/markdown"
+	"github.com/russross/blackfriday"
+)
+
+// Markdown configures a new Markdown middleware instance.
+func Markdown(c *Controller) (middleware.Middleware, error) {
+	mdconfigs, err := markdownParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	md := markdown.Markdown{
+		Root:       c.Root,
+		FileSys:    http.Dir(c.Root),
+		Configs:    mdconfigs,
+		IndexFiles: []string{"index.md"},
+	}
+
+	// For any configs that enabled static site gen, sweep the whole path at startup
+	c.Startup = append(c.Startup, func() error {
+		for _, cfg := range mdconfigs {
+			if cfg.StaticDir == "" {
+				continue
+			}
+
+			// If generated site already exists, clear it out
+			_, err := os.Stat(cfg.StaticDir)
+			if err == nil {
+				err := os.RemoveAll(cfg.StaticDir)
+				if err != nil {
+					return err
+				}
+			}
+
+			fp := filepath.Join(md.Root, cfg.PathScope)
+			filepath.Walk(fp, func(path string, info os.FileInfo, err error) error {
+				for _, ext := range cfg.Extensions {
+					if !info.IsDir() && strings.HasSuffix(info.Name(), ext) {
+						// Load the file
+						body, err := ioutil.ReadFile(path)
+						if err != nil {
+							return err
+						}
+
+						// Get the relative path as if it were a HTTP request,
+						// then prepend with "/" (like a real HTTP request)
+						reqPath, err := filepath.Rel(md.Root, path)
+						if err != nil {
+							return err
+						}
+						reqPath = "/" + reqPath
+
+						// Generate the static file
+						_, err = md.Process(cfg, reqPath, body)
+						if err != nil {
+							return err
+						}
+
+						break // don't try other file extensions
+					}
+				}
+
+				return nil
+			})
+		}
+
+		return nil
+	})
+
+	return func(next middleware.Handler) middleware.Handler {
+		md.Next = next
+		return md
+	}, nil
+}
+
+func markdownParse(c *Controller) ([]markdown.Config, error) {
+	var mdconfigs []markdown.Config
+
+	for c.Next() {
+		md := markdown.Config{
+			Renderer:    blackfriday.HtmlRenderer(0, "", ""),
+			Templates:   make(map[string]string),
+			StaticFiles: make(map[string]string),
+		}
+
+		// Get the path scope
+		if !c.NextArg() || c.Val() == "{" {
+			return mdconfigs, c.ArgErr()
+		}
+		md.PathScope = c.Val()
+
+		// Load any other configuration parameters
+		for c.NextBlock() {
+			switch c.Val() {
+			case "ext":
+				exts := c.RemainingArgs()
+				if len(exts) == 0 {
+					return mdconfigs, c.ArgErr()
+				}
+				md.Extensions = append(md.Extensions, exts...)
+			case "css":
+				if !c.NextArg() {
+					return mdconfigs, c.ArgErr()
+				}
+				md.Styles = append(md.Styles, c.Val())
+			case "js":
+				if !c.NextArg() {
+					return mdconfigs, c.ArgErr()
+				}
+				md.Scripts = append(md.Scripts, c.Val())
+			case "template":
+				tArgs := c.RemainingArgs()
+				switch len(tArgs) {
+				case 0:
+					return mdconfigs, c.ArgErr()
+				case 1:
+					if _, ok := md.Templates[markdown.DefaultTemplate]; ok {
+						return mdconfigs, c.Err("only one default template is allowed, use alias.")
+					}
+					fpath := filepath.Clean(c.Root + string(filepath.Separator) + tArgs[0])
+					md.Templates[markdown.DefaultTemplate] = fpath
+				case 2:
+					fpath := filepath.Clean(c.Root + string(filepath.Separator) + tArgs[1])
+					md.Templates[tArgs[0]] = fpath
+				default:
+					return mdconfigs, c.ArgErr()
+				}
+			case "sitegen":
+				if c.NextArg() {
+					md.StaticDir = path.Join(c.Root, c.Val())
+				} else {
+					md.StaticDir = path.Join(c.Root, markdown.DefaultStaticDir)
+				}
+				if c.NextArg() {
+					// only 1 argument allowed
+					return mdconfigs, c.ArgErr()
+				}
+			default:
+				return mdconfigs, c.Err("Expected valid markdown configuration property")
+			}
+		}
+
+		// If no extensions were specified, assume .md
+		if len(md.Extensions) == 0 {
+			md.Extensions = []string{".md"}
+		}
+
+		mdconfigs = append(mdconfigs, md)
+	}
+
+	return mdconfigs, nil
+}

config/setup/proxy.go

@@ -0,0 +1,17 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/proxy"
+)
+
+// Proxy configures a new Proxy middleware instance.
+func Proxy(c *Controller) (middleware.Middleware, error) {
+	if upstreams, err := proxy.NewStaticUpstreams(c.Dispenser); err == nil {
+		return func(next middleware.Handler) middleware.Handler {
+			return proxy.Proxy{Next: next, Upstreams: upstreams}
+		}, nil
+	} else {
+		return nil, err
+	}
+}

config/setup/redir.go

@@ -0,0 +1,77 @@
+package setup
+
+import (
+	"net/http"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/redirect"
+)
+
+// Redir configures a new Redirect middleware instance.
+func Redir(c *Controller) (middleware.Middleware, error) {
+	rules, err := redirParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		return redirect.Redirect{Next: next, Rules: rules}
+	}, nil
+}
+
+func redirParse(c *Controller) ([]redirect.Rule, error) {
+	var redirects []redirect.Rule
+
+	for c.Next() {
+		var rule redirect.Rule
+		args := c.RemainingArgs()
+
+		switch len(args) {
+		case 1:
+			// To specified
+			rule.From = "/"
+			rule.To = args[0]
+			rule.Code = http.StatusMovedPermanently
+		case 2:
+			// To and Code specified
+			rule.From = "/"
+			rule.To = args[0]
+			if code, ok := httpRedirs[args[1]]; !ok {
+				return redirects, c.Err("Invalid redirect code '" + args[1] + "'")
+			} else {
+				rule.Code = code
+			}
+		case 3:
+			// From, To, and Code specified
+			rule.From = args[0]
+			rule.To = args[1]
+			if code, ok := httpRedirs[args[2]]; !ok {
+				return redirects, c.Err("Invalid redirect code '" + args[2] + "'")
+			} else {
+				rule.Code = code
+			}
+		default:
+			return redirects, c.ArgErr()
+		}
+
+		if rule.From == rule.To {
+			return redirects, c.Err("Redirect rule cannot allow From and To arguments to be the same.")
+		}
+
+		redirects = append(redirects, rule)
+	}
+
+	return redirects, nil
+}
+
+// httpRedirs is a list of supported HTTP redirect codes.
+var httpRedirs = map[string]int{
+	"300": 300,
+	"301": 301,
+	"302": 302,
+	"303": 303,
+	"304": 304,
+	"305": 305,
+	"307": 307,
+	"308": 308,
+}

config/setup/rewrite.go

@@ -0,0 +1,79 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/rewrite"
+)
+
+// Rewrite configures a new Rewrite middleware instance.
+func Rewrite(c *Controller) (middleware.Middleware, error) {
+	rewrites, err := rewriteParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		return rewrite.Rewrite{Next: next, Rules: rewrites}
+	}, nil
+}
+
+func rewriteParse(c *Controller) ([]rewrite.Rule, error) {
+	var simpleRules []rewrite.Rule
+	var regexpRules []rewrite.Rule
+
+	for c.Next() {
+		var rule rewrite.Rule
+		var err error
+		var base = "/"
+		var pattern, to string
+		var ext []string
+
+		args := c.RemainingArgs()
+
+		switch len(args) {
+		case 2:
+			rule = rewrite.NewSimpleRule(args[0], args[1])
+			simpleRules = append(simpleRules, rule)
+		case 1:
+			base = args[0]
+			fallthrough
+		case 0:
+			for c.NextBlock() {
+				switch c.Val() {
+				case "r", "regexp":
+					if !c.NextArg() {
+						return nil, c.ArgErr()
+					}
+					pattern = c.Val()
+				case "to":
+					if !c.NextArg() {
+						return nil, c.ArgErr()
+					}
+					to = c.Val()
+				case "ext":
+					args1 := c.RemainingArgs()
+					if len(args1) == 0 {
+						return nil, c.ArgErr()
+					}
+					ext = args1
+				default:
+					return nil, c.ArgErr()
+				}
+			}
+			// ensure pattern and to are specified
+			if pattern == "" || to == "" {
+				return nil, c.ArgErr()
+			}
+			if rule, err = rewrite.NewRegexpRule(base, pattern, to, ext); err != nil {
+				return nil, err
+			}
+			regexpRules = append(regexpRules, rule)
+		default:
+			return nil, c.ArgErr()
+		}
+
+	}
+
+	// put simple rules in front to avoid regexp computation for them
+	return append(simpleRules, regexpRules...), nil
+}

config/setup/rewrite_test.go

@@ -0,0 +1,184 @@
+package setup
+
+import (
+	"testing"
+
+	"fmt"
+	"github.com/mholt/caddy/middleware/rewrite"
+	"regexp"
+)
+
+func TestRewrite(t *testing.T) {
+	c := newTestController(`rewrite /from /to`)
+
+	mid, err := Rewrite(c)
+	if err != nil {
+		t.Errorf("Expected no errors, but got: %v", err)
+	}
+	if mid == nil {
+		t.Fatal("Expected middleware, was nil instead")
+	}
+
+	handler := mid(emptyNext)
+	myHandler, ok := handler.(rewrite.Rewrite)
+	if !ok {
+		t.Fatalf("Expected handler to be type Rewrite, got: %#v", handler)
+	}
+
+	if !sameNext(myHandler.Next, emptyNext) {
+		t.Error("'Next' field of handler was not set properly")
+	}
+
+	if len(myHandler.Rules) != 1 {
+		t.Errorf("Expected handler to have %d rule, has %d instead", 1, len(myHandler.Rules))
+	}
+}
+
+func TestRewriteParse(t *testing.T) {
+	simpleTests := []struct {
+		input     string
+		shouldErr bool
+		expected  []rewrite.Rule
+	}{
+		{`rewrite /from /to`, false, []rewrite.Rule{
+			rewrite.SimpleRule{"/from", "/to"},
+		}},
+		{`rewrite /from /to
+		  rewrite a b`, false, []rewrite.Rule{
+			rewrite.SimpleRule{"/from", "/to"},
+			rewrite.SimpleRule{"a", "b"},
+		}},
+		{`rewrite a`, true, []rewrite.Rule{}},
+		{`rewrite`, true, []rewrite.Rule{}},
+		{`rewrite a b c`, true, []rewrite.Rule{
+			rewrite.SimpleRule{"a", "b"},
+		}},
+	}
+
+	for i, test := range simpleTests {
+		c := newTestController(test.input)
+		actual, err := rewriteParse(c)
+
+		if err == nil && test.shouldErr {
+			t.Errorf("Test %d didn't error, but it should have", i)
+		} else if err != nil && !test.shouldErr {
+			t.Errorf("Test %d errored, but it shouldn't have; got '%v'", i, err)
+		} else if err != nil && test.shouldErr {
+			continue
+		}
+
+		if len(actual) != len(test.expected) {
+			t.Fatalf("Test %d expected %d rules, but got %d",
+				i, len(test.expected), len(actual))
+		}
+
+		for j, e := range test.expected {
+			actualRule := actual[j].(rewrite.SimpleRule)
+			expectedRule := e.(rewrite.SimpleRule)
+
+			if actualRule.From != expectedRule.From {
+				t.Errorf("Test %d, rule %d: Expected From=%s, got %s",
+					i, j, expectedRule.From, actualRule.From)
+			}
+
+			if actualRule.To != expectedRule.To {
+				t.Errorf("Test %d, rule %d: Expected To=%s, got %s",
+					i, j, expectedRule.To, actualRule.To)
+			}
+		}
+	}
+
+	regexpTests := []struct {
+		input     string
+		shouldErr bool
+		expected  []rewrite.Rule
+	}{
+		{`rewrite {
+			r	.*
+			to	/to
+		 }`, false, []rewrite.Rule{
+			&rewrite.RegexpRule{"/", "/to", nil, regexp.MustCompile(".*")},
+		}},
+		{`rewrite {
+			regexp	.*
+			to		/to
+			ext		/ html txt
+		 }`, false, []rewrite.Rule{
+			&rewrite.RegexpRule{"/", "/to", []string{"/", "html", "txt"}, regexp.MustCompile(".*")},
+		}},
+		{`rewrite /path {
+			r	rr
+			to	/dest
+		 }
+		 rewrite / {
+		 	regexp	[a-z]+
+		 	to 		/to
+		 }
+		 `, false, []rewrite.Rule{
+			&rewrite.RegexpRule{"/path", "/dest", nil, regexp.MustCompile("rr")},
+			&rewrite.RegexpRule{"/", "/to", nil, regexp.MustCompile("[a-z]+")},
+		}},
+		{`rewrite {
+			to	/to
+		 }`, true, []rewrite.Rule{
+			&rewrite.RegexpRule{},
+		}},
+		{`rewrite {
+			r	.*
+		 }`, true, []rewrite.Rule{
+			&rewrite.RegexpRule{},
+		}},
+		{`rewrite {
+
+		 }`, true, []rewrite.Rule{
+			&rewrite.RegexpRule{},
+		}},
+		{`rewrite /`, true, []rewrite.Rule{
+			&rewrite.RegexpRule{},
+		}},
+	}
+
+	for i, test := range regexpTests {
+		c := newTestController(test.input)
+		actual, err := rewriteParse(c)
+
+		if err == nil && test.shouldErr {
+			t.Errorf("Test %d didn't error, but it should have", i)
+		} else if err != nil && !test.shouldErr {
+			t.Errorf("Test %d errored, but it shouldn't have; got '%v'", i, err)
+		} else if err != nil && test.shouldErr {
+			continue
+		}
+
+		if len(actual) != len(test.expected) {
+			t.Fatalf("Test %d expected %d rules, but got %d",
+				i, len(test.expected), len(actual))
+		}
+
+		for j, e := range test.expected {
+			actualRule := actual[j].(*rewrite.RegexpRule)
+			expectedRule := e.(*rewrite.RegexpRule)
+
+			if actualRule.Base != expectedRule.Base {
+				t.Errorf("Test %d, rule %d: Expected Base=%s, got %s",
+					i, j, expectedRule.Base, actualRule.Base)
+			}
+
+			if actualRule.To != expectedRule.To {
+				t.Errorf("Test %d, rule %d: Expected To=%s, got %s",
+					i, j, expectedRule.To, actualRule.To)
+			}
+
+			if fmt.Sprint(actualRule.Exts) != fmt.Sprint(expectedRule.Exts) {
+				t.Errorf("Test %d, rule %d: Expected Ext=%v, got %v",
+					i, j, expectedRule.To, actualRule.To)
+			}
+
+			if actualRule.String() != expectedRule.String() {
+				t.Errorf("Test %d, rule %d: Expected Pattern=%s, got %s",
+					i, j, expectedRule.String(), actualRule.String())
+			}
+		}
+	}
+
+}

config/setup/root.go

@@ -0,0 +1,31 @@
+package setup
+
+import (
+	"log"
+	"os"
+
+	"github.com/mholt/caddy/middleware"
+)
+
+func Root(c *Controller) (middleware.Middleware, error) {
+	for c.Next() {
+		if !c.NextArg() {
+			return nil, c.ArgErr()
+		}
+		c.Root = c.Val()
+	}
+
+	// Check if root path exists
+	_, err := os.Stat(c.Root)
+	if err != nil {
+		if os.IsNotExist(err) {
+			// Allow this, because the folder might appear later.
+			// But make sure the user knows!
+			log.Printf("Warning: Root path does not exist: %s", c.Root)
+		} else {
+			return nil, c.Errf("Unable to access root path '%s': %v", c.Root, err)
+		}
+	}
+
+	return nil, nil
+}

config/setup/startupshutdown.go

@@ -0,0 +1,58 @@
+package setup
+
+import (
+	"os"
+	"os/exec"
+	"strings"
+
+	"github.com/mholt/caddy/middleware"
+)
+
+func Startup(c *Controller) (middleware.Middleware, error) {
+	return nil, registerCallback(c, &c.Startup)
+}
+
+func Shutdown(c *Controller) (middleware.Middleware, error) {
+	return nil, registerCallback(c, &c.Shutdown)
+}
+
+// registerCallback registers a callback function to execute by
+// using c to parse the line. It appends the callback function
+// to the list of callback functions passed in by reference.
+func registerCallback(c *Controller, list *[]func() error) error {
+	for c.Next() {
+		args := c.RemainingArgs()
+		if len(args) == 0 {
+			return c.ArgErr()
+		}
+
+		nonblock := false
+		if len(args) > 1 && args[len(args)-1] == "&" {
+			// Run command in background; non-blocking
+			nonblock = true
+			args = args[:len(args)-1]
+		}
+
+		command, args, err := middleware.SplitCommandAndArgs(strings.Join(args, " "))
+		if err != nil {
+			return c.Err(err.Error())
+		}
+
+		fn := func() error {
+			cmd := exec.Command(command, args...)
+			cmd.Stdin = os.Stdin
+			cmd.Stdout = os.Stdout
+			cmd.Stderr = os.Stderr
+
+			if nonblock {
+				return cmd.Start()
+			} else {
+				return cmd.Run()
+			}
+		}
+
+		*list = append(*list, fn)
+	}
+
+	return nil
+}

config/setup/templates.go

@@ -0,0 +1,61 @@
+package setup
+
+import (
+	"net/http"
+
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/templates"
+)
+
+// Templates configures a new Templates middleware instance.
+func Templates(c *Controller) (middleware.Middleware, error) {
+	rules, err := templatesParse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	tmpls := templates.Templates{
+		Rules:   rules,
+		Root:    c.Root,
+		FileSys: http.Dir(c.Root),
+	}
+
+	return func(next middleware.Handler) middleware.Handler {
+		tmpls.Next = next
+		return tmpls
+	}, nil
+}
+
+func templatesParse(c *Controller) ([]templates.Rule, error) {
+	var rules []templates.Rule
+
+	for c.Next() {
+		var rule templates.Rule
+
+		if c.NextArg() {
+			// First argument would be the path
+			rule.Path = c.Val()
+
+			// Any remaining arguments are extensions
+			rule.Extensions = c.RemainingArgs()
+			if len(rule.Extensions) == 0 {
+				rule.Extensions = defaultExtensions
+			}
+		} else {
+			rule.Path = defaultPath
+			rule.Extensions = defaultExtensions
+		}
+
+		for _, ext := range rule.Extensions {
+			rule.IndexFiles = append(rule.IndexFiles, "index"+ext)
+		}
+
+		rules = append(rules, rule)
+	}
+
+	return rules, nil
+}
+
+const defaultPath = "/"
+
+var defaultExtensions = []string{".html", ".htm", ".tmpl", ".tpl", ".txt"}

config/setup/tls.go

@@ -0,0 +1,134 @@
+package setup
+
+import (
+	"crypto/tls"
+	"log"
+	"strings"
+
+	"github.com/mholt/caddy/middleware"
+)
+
+func TLS(c *Controller) (middleware.Middleware, error) {
+	c.TLS.Enabled = true
+	if c.Port == "http" {
+		c.TLS.Enabled = false
+		log.Printf("Warning: TLS disabled for %s://%s. To force TLS over the plaintext HTTP port, "+
+			"specify port 80 explicitly (https://%s:80).", c.Port, c.Host, c.Host)
+	}
+
+	for c.Next() {
+		if !c.NextArg() {
+			return nil, c.ArgErr()
+		}
+		c.TLS.Certificate = c.Val()
+
+		if !c.NextArg() {
+			return nil, c.ArgErr()
+		}
+		c.TLS.Key = c.Val()
+
+		// Optional block
+		for c.NextBlock() {
+			switch c.Val() {
+			case "protocols":
+				args := c.RemainingArgs()
+				if len(args) != 2 {
+					return nil, c.ArgErr()
+				}
+				value, ok := supportedProtocols[strings.ToLower(args[0])]
+				if !ok {
+					return nil, c.Errf("Wrong protocol name or protocol not supported '%s'", c.Val())
+				}
+				c.TLS.ProtocolMinVersion = value
+				value, ok = supportedProtocols[strings.ToLower(args[1])]
+				if !ok {
+					return nil, c.Errf("Wrong protocol name or protocol not supported '%s'", c.Val())
+				}
+				c.TLS.ProtocolMaxVersion = value
+			case "ciphers":
+				for c.NextArg() {
+					value, ok := supportedCiphersMap[strings.ToUpper(c.Val())]
+					if !ok {
+						return nil, c.Errf("Wrong cipher name or cipher not supported '%s'", c.Val())
+					}
+					c.TLS.Ciphers = append(c.TLS.Ciphers, value)
+				}
+			default:
+				return nil, c.Errf("Unknown keyword '%s'")
+			}
+		}
+	}
+
+	// If no ciphers provided, use all that Caddy supports for the protocol
+	if len(c.TLS.Ciphers) == 0 {
+		c.TLS.Ciphers = supportedCiphers
+	}
+
+	// Not a cipher suite, but still important for mitigating protocol downgrade attacks
+	c.TLS.Ciphers = append(c.TLS.Ciphers, tls.TLS_FALLBACK_SCSV)
+
+	// Set default protocol min and max versions - must balance compatibility and security
+	if c.TLS.ProtocolMinVersion == 0 {
+		c.TLS.ProtocolMinVersion = tls.VersionTLS10
+	}
+	if c.TLS.ProtocolMaxVersion == 0 {
+		c.TLS.ProtocolMaxVersion = tls.VersionTLS12
+	}
+
+	// Prefer server cipher suites
+	c.TLS.PreferServerCipherSuites = true
+
+	return nil, nil
+}
+
+// Map of supported protocols
+// SSLv3 will be not supported in future release
+// HTTP/2 only supports TLS 1.2 and higher
+var supportedProtocols = map[string]uint16{
+	"ssl3.0": tls.VersionSSL30,
+	"tls1.0": tls.VersionTLS10,
+	"tls1.1": tls.VersionTLS11,
+	"tls1.2": tls.VersionTLS12,
+}
+
+// Map of supported ciphers, used only for parsing config.
+//
+// Note that, at time of writing, HTTP/2 blacklists 276 cipher suites,
+// including all but two of the suites below (the two GCM suites).
+// See https://http2.github.io/http2-spec/#BadCipherSuites
+//
+// TLS_FALLBACK_SCSV is not in this list because we manually ensure
+// it is always added (even though it is not technically a cipher suite).
+//
+// This map, like any map, is NOT ORDERED. Do not range over this map.
+var supportedCiphersMap = map[string]uint16{
+	"ECDHE-RSA-AES128-GCM-SHA256":   tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
+	"ECDHE-ECDSA-AES128-GCM-SHA256": tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
+	"ECDHE-RSA-AES128-CBC-SHA":      tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
+	"ECDHE-RSA-AES256-CBC-SHA":      tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
+	"ECDHE-ECDSA-AES256-CBC-SHA":    tls.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
+	"ECDHE-ECDSA-AES128-CBC-SHA":    tls.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
+	"RSA-AES128-CBC-SHA":            tls.TLS_RSA_WITH_AES_128_CBC_SHA,
+	"RSA-AES256-CBC-SHA":            tls.TLS_RSA_WITH_AES_256_CBC_SHA,
+	"ECDHE-RSA-3DES-EDE-CBC-SHA":    tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,
+	"RSA-3DES-EDE-CBC-SHA":          tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA,
+}
+
+// List of supported cipher suites in descending order of preference.
+// Ordering is very important! Getting the wrong order will break
+// mainstream clients, especially with HTTP/2.
+//
+// Note that TLS_FALLBACK_SCSV is not in this list since it is always
+// added manually.
+var supportedCiphers = []uint16{
+	tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
+	tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
+	tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
+	tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
+	tls.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
+	tls.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
+	tls.TLS_RSA_WITH_AES_256_CBC_SHA,
+	tls.TLS_RSA_WITH_AES_128_CBC_SHA,
+	tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,
+	tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA,
+}

config/setup/tls_test.go

@@ -0,0 +1,129 @@
+package setup
+
+import (
+	"crypto/tls"
+	"testing"
+)
+
+func TestTLSParseBasic(t *testing.T) {
+	c := newTestController(`tls cert.pem key.pem`)
+
+	_, err := TLS(c)
+	if err != nil {
+		t.Errorf("Expected no errors, got: %v", err)
+	}
+
+	// Basic checks
+	if c.TLS.Certificate != "cert.pem" {
+		t.Errorf("Expected certificate arg to be 'cert.pem', was '%s'", c.TLS.Certificate)
+	}
+	if c.TLS.Key != "key.pem" {
+		t.Errorf("Expected key arg to be 'key.pem', was '%s'", c.TLS.Key)
+	}
+	if !c.TLS.Enabled {
+		t.Error("Expected TLS Enabled=true, but was false")
+	}
+
+	// Security defaults
+	if c.TLS.ProtocolMinVersion != tls.VersionTLS10 {
+		t.Errorf("Expected 'tls1.0 (0x0301)' as ProtocolMinVersion, got %#v", c.TLS.ProtocolMinVersion)
+	}
+	if c.TLS.ProtocolMaxVersion != tls.VersionTLS12 {
+		t.Errorf("Expected 'tls1.2 (0x0303)' as ProtocolMaxVersion, got %v", c.TLS.ProtocolMaxVersion)
+	}
+
+	// Cipher checks
+	expectedCiphers := []uint16{
+		tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
+		tls.TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,
+		tls.TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,
+		tls.TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,
+		tls.TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,
+		tls.TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,
+		tls.TLS_RSA_WITH_AES_256_CBC_SHA,
+		tls.TLS_RSA_WITH_AES_128_CBC_SHA,
+		tls.TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA,
+		tls.TLS_RSA_WITH_3DES_EDE_CBC_SHA,
+		tls.TLS_FALLBACK_SCSV,
+	}
+
+	// Ensure count is correct (plus one for TLS_FALLBACK_SCSV)
+	if len(c.TLS.Ciphers) != len(supportedCiphers)+1 {
+		t.Errorf("Expected %v Ciphers (including TLS_FALLBACK_SCSV), got %v",
+			len(supportedCiphers)+1, len(c.TLS.Ciphers))
+	}
+
+	// Ensure ordering is correct
+	for i, actual := range c.TLS.Ciphers {
+		if actual != expectedCiphers[i] {
+			t.Errorf("Expected cipher in position %d to be %0x, got %0x", i, expectedCiphers[i], actual)
+		}
+	}
+
+	if !c.TLS.PreferServerCipherSuites {
+		t.Error("Expected PreferServerCipherSuites = true, but was false")
+	}
+}
+
+func TestTLSParseIncompleteParams(t *testing.T) {
+	c := newTestController(`tls`)
+
+	_, err := TLS(c)
+	if err == nil {
+		t.Errorf("Expected errors, but no error returned")
+	}
+
+	c = newTestController(`tls cert.key`)
+
+	_, err = TLS(c)
+	if err == nil {
+		t.Errorf("Expected errors, but no error returned")
+	}
+}
+
+func TestTLSParseWithOptionalParams(t *testing.T) {
+	params := `tls cert.crt cert.key {
+            protocols ssl3.0 tls1.2
+            ciphers RSA-3DES-EDE-CBC-SHA RSA-AES256-CBC-SHA ECDHE-RSA-AES128-GCM-SHA256
+        }`
+	c := newTestController(params)
+
+	_, err := TLS(c)
+	if err != nil {
+		t.Errorf("Expected no errors, got: %v", err)
+	}
+
+	if c.TLS.ProtocolMinVersion != tls.VersionSSL30 {
+		t.Errorf("Expected 'ssl3.0 (0x0300)' as ProtocolMinVersion, got %#v", c.TLS.ProtocolMinVersion)
+	}
+
+	if c.TLS.ProtocolMaxVersion != tls.VersionTLS12 {
+		t.Errorf("Expected 'tls1.2 (0x0302)' as ProtocolMaxVersion, got %#v", c.TLS.ProtocolMaxVersion)
+	}
+
+	if len(c.TLS.Ciphers)-1 != 3 {
+		t.Errorf("Expected 3 Ciphers (not including TLS_FALLBACK_SCSV), got %v", len(c.TLS.Ciphers))
+	}
+}
+
+func TestTLSParseWithWrongOptionalParams(t *testing.T) {
+	// Test protocols wrong params
+	params := `tls cert.crt cert.key {
+			protocols ssl tls
+		}`
+	c := newTestController(params)
+	_, err := TLS(c)
+	if err == nil {
+		t.Errorf("Expected errors, but no error returned")
+	}
+
+	// Test ciphers wrong params
+	params = `tls cert.crt cert.key {
+			ciphers not-valid-cipher
+		}`
+	c = newTestController(params)
+	_, err = TLS(c)
+	if err == nil {
+		t.Errorf("Expected errors, but no error returned")
+	}
+}

config/setup/websocket.go

@@ -0,0 +1,77 @@
+package setup
+
+import (
+	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/websockets"
+)
+
+// WebSocket configures a new WebSockets middleware instance.
+func WebSocket(c *Controller) (middleware.Middleware, error) {
+	var websocks []websockets.Config
+	var respawn bool
+
+	optionalBlock := func() (hadBlock bool, err error) {
+		for c.NextBlock() {
+			hadBlock = true
+			if c.Val() == "respawn" {
+				respawn = true
+			} else {
+				return true, c.Err("Expected websocket configuration parameter in block")
+			}
+		}
+		return
+	}
+
+	for c.Next() {
+		var val, path, command string
+
+		// Path or command; not sure which yet
+		if !c.NextArg() {
+			return nil, c.ArgErr()
+		}
+		val = c.Val()
+
+		// Extra configuration may be in a block
+		hadBlock, err := optionalBlock()
+		if err != nil {
+			return nil, err
+		}
+
+		if !hadBlock {
+			// The next argument on this line will be the command or an open curly brace
+			if c.NextArg() {
+				path = val
+				command = c.Val()
+			} else {
+				path = "/"
+				command = val
+			}
+
+			// Okay, check again for optional block
+			hadBlock, err = optionalBlock()
+			if err != nil {
+				return nil, err
+			}
+		}
+
+		// Split command into the actual command and its arguments
+		cmd, args, err := middleware.SplitCommandAndArgs(command)
+		if err != nil {
+			return nil, err
+		}
+
+		websocks = append(websocks, websockets.Config{
+			Path:      path,
+			Command:   cmd,
+			Arguments: args,
+			Respawn:   respawn, // TODO: This isn't used currently
+		})
+	}
+
+	websockets.GatewayInterface = c.AppName + "-CGI/1.1"
+	websockets.ServerSoftware = c.AppName + "/" + c.AppVersion
+
+	return func(next middleware.Handler) middleware.Handler {
+		return websockets.WebSockets{Next: next, Sockets: websocks}
+	}, nil
+}

context.go

@@ -1,412 +0,0 @@
-// 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 caddy
-
-import (
-	"context"
-	"encoding/json"
-	"fmt"
-	"log"
-	"reflect"
-
-	"github.com/caddyserver/certmagic"
-	"go.uber.org/zap"
-)
-
-// Context is a type which defines the lifetime of modules that
-// are loaded and provides access to the parent configuration
-// that spawned the modules which are loaded. It should be used
-// with care and wrapped with derivation functions from the
-// standard context package only if you don't need the Caddy
-// specific features. These contexts are canceled when the
-// lifetime of the modules loaded from it is over.
-//
-// Use NewContext() to get a valid value (but most modules will
-// not actually need to do this).
-type Context struct {
-	context.Context
-	moduleInstances map[string][]interface{}
-	cfg             *Config
-	cleanupFuncs    []func()
-}
-
-// NewContext provides a new context derived from the given
-// context ctx. Normally, you will not need to call this
-// function unless you are loading modules which have a
-// different lifespan than the ones for the context the
-// module was provisioned with. Be sure to call the cancel
-// func when the context is to be cleaned up so that
-// modules which are loaded will be properly unloaded.
-// See standard library context package's documentation.
-func NewContext(ctx Context) (Context, context.CancelFunc) {
-	newCtx := Context{moduleInstances: make(map[string][]interface{}), cfg: ctx.cfg}
-	c, cancel := context.WithCancel(ctx.Context)
-	wrappedCancel := func() {
-		cancel()
-
-		for _, f := range ctx.cleanupFuncs {
-			f()
-		}
-
-		for modName, modInstances := range newCtx.moduleInstances {
-			for _, inst := range modInstances {
-				if cu, ok := inst.(CleanerUpper); ok {
-					err := cu.Cleanup()
-					if err != nil {
-						log.Printf("[ERROR] %s (%p): cleanup: %v", modName, inst, err)
-					}
-				}
-			}
-		}
-	}
-	newCtx.Context = c
-	return newCtx, wrappedCancel
-}
-
-// OnCancel executes f when ctx is canceled.
-func (ctx *Context) OnCancel(f func()) {
-	ctx.cleanupFuncs = append(ctx.cleanupFuncs, f)
-}
-
-// LoadModule loads the Caddy module(s) from the specified field of the parent struct
-// pointer and returns the loaded module(s). The struct pointer and its field name as
-// a string are necessary so that reflection can be used to read the struct tag on the
-// field to get the module namespace and inline module name key (if specified).
-//
-// The field can be any one of the supported raw module types: json.RawMessage,
-// []json.RawMessage, map[string]json.RawMessage, or []map[string]json.RawMessage.
-// ModuleMap may be used in place of map[string]json.RawMessage. The return value's
-// underlying type mirrors the input field's type:
-//
-//    json.RawMessage              => interface{}
-//    []json.RawMessage            => []interface{}
-//    map[string]json.RawMessage   => map[string]interface{}
-//    []map[string]json.RawMessage => []map[string]interface{}
-//
-// The field must have a "caddy" struct tag in this format:
-//
-//    caddy:"key1=val1 key2=val2"
-//
-// To load modules, a "namespace" key is required. For example, to load modules
-// in the "http.handlers" namespace, you'd put: `namespace=http.handlers` in the
-// Caddy struct tag.
-//
-// The module name must also be available. If the field type is a map or slice of maps,
-// then key is assumed to be the module name if an "inline_key" is NOT specified in the
-// caddy struct tag. In this case, the module name does NOT need to be specified in-line
-// with the module itself.
-//
-// If not a map, or if inline_key is non-empty, then the module name must be embedded
-// into the values, which must be objects; then there must be a key in those objects
-// where its associated value is the module name. This is called the "inline key",
-// meaning the key containing the module's name that is defined inline with the module
-// itself. You must specify the inline key in a struct tag, along with the namespace:
-//
-//    caddy:"namespace=http.handlers inline_key=handler"
-//
-// This will look for a key/value pair like `"handler": "..."` in the json.RawMessage
-// in order to know the module name.
-//
-// To make use of the loaded module(s) (the return value), you will probably want
-// to type-assert each interface{} value(s) to the types that are useful to you
-// and store them on the same struct. Storing them on the same struct makes for
-// easy garbage collection when your host module is no longer needed.
-//
-// Loaded modules have already been provisioned and validated. Upon returning
-// successfully, this method clears the json.RawMessage(s) in the field since
-// the raw JSON is no longer needed, and this allows the GC to free up memory.
-func (ctx Context) LoadModule(structPointer interface{}, fieldName string) (interface{}, error) {
-	val := reflect.ValueOf(structPointer).Elem().FieldByName(fieldName)
-	typ := val.Type()
-
-	field, ok := reflect.TypeOf(structPointer).Elem().FieldByName(fieldName)
-	if !ok {
-		panic(fmt.Sprintf("field %s does not exist in %#v", fieldName, structPointer))
-	}
-
-	opts, err := ParseStructTag(field.Tag.Get("caddy"))
-	if err != nil {
-		panic(fmt.Sprintf("malformed tag on field %s: %v", fieldName, err))
-	}
-
-	moduleNamespace, ok := opts["namespace"]
-	if !ok {
-		panic(fmt.Sprintf("missing 'namespace' key in struct tag on field %s", fieldName))
-	}
-	inlineModuleKey := opts["inline_key"]
-
-	var result interface{}
-
-	switch val.Kind() {
-	case reflect.Slice:
-		if isJSONRawMessage(typ) {
-			// val is `json.RawMessage` ([]uint8 under the hood)
-
-			if inlineModuleKey == "" {
-				panic("unable to determine module name without inline_key when type is not a ModuleMap")
-			}
-			val, err := ctx.loadModuleInline(inlineModuleKey, moduleNamespace, val.Interface().(json.RawMessage))
-			if err != nil {
-				return nil, err
-			}
-			result = val
-
-		} else if isJSONRawMessage(typ.Elem()) {
-			// val is `[]json.RawMessage`
-
-			if inlineModuleKey == "" {
-				panic("unable to determine module name without inline_key because type is not a ModuleMap")
-			}
-			var all []interface{}
-			for i := 0; i < val.Len(); i++ {
-				val, err := ctx.loadModuleInline(inlineModuleKey, moduleNamespace, val.Index(i).Interface().(json.RawMessage))
-				if err != nil {
-					return nil, fmt.Errorf("position %d: %v", i, err)
-				}
-				all = append(all, val)
-			}
-			result = all
-
-		} else if isModuleMapType(typ.Elem()) {
-			// val is `[]map[string]json.RawMessage`
-
-			var all []map[string]interface{}
-			for i := 0; i < val.Len(); i++ {
-				thisSet, err := ctx.loadModulesFromSomeMap(moduleNamespace, inlineModuleKey, val.Index(i))
-				if err != nil {
-					return nil, err
-				}
-				all = append(all, thisSet)
-			}
-			result = all
-		}
-
-	case reflect.Map:
-		// val is a ModuleMap or some other kind of map
-		result, err = ctx.loadModulesFromSomeMap(moduleNamespace, inlineModuleKey, val)
-		if err != nil {
-			return nil, err
-		}
-
-	default:
-		return nil, fmt.Errorf("unrecognized type for module: %s", typ)
-	}
-
-	// we're done with the raw bytes; allow GC to deallocate
-	val.Set(reflect.Zero(typ))
-
-	return result, nil
-}
-
-// loadModulesFromSomeMap loads modules from val, which must be a type of map[string]interface{}.
-// Depending on inlineModuleKey, it will be interpreted as either a ModuleMap (key is the module
-// name) or as a regular map (key is not the module name, and module name is defined inline).
-func (ctx Context) loadModulesFromSomeMap(namespace, inlineModuleKey string, val reflect.Value) (map[string]interface{}, error) {
-	// if no inline_key is specified, then val must be a ModuleMap,
-	// where the key is the module name
-	if inlineModuleKey == "" {
-		if !isModuleMapType(val.Type()) {
-			panic(fmt.Sprintf("expected ModuleMap because inline_key is empty; but we do not recognize this type: %s", val.Type()))
-		}
-		return ctx.loadModuleMap(namespace, val)
-	}
-
-	// otherwise, val is a map with modules, but the module name is
-	// inline with each value (the key means something else)
-	return ctx.loadModulesFromRegularMap(namespace, inlineModuleKey, val)
-}
-
-// loadModulesFromRegularMap loads modules from val, where val is a map[string]json.RawMessage.
-// Map keys are NOT interpreted as module names, so module names are still expected to appear
-// inline with the objects.
-func (ctx Context) loadModulesFromRegularMap(namespace, inlineModuleKey string, val reflect.Value) (map[string]interface{}, error) {
-	mods := make(map[string]interface{})
-	iter := val.MapRange()
-	for iter.Next() {
-		k := iter.Key()
-		v := iter.Value()
-		mod, err := ctx.loadModuleInline(inlineModuleKey, namespace, v.Interface().(json.RawMessage))
-		if err != nil {
-			return nil, fmt.Errorf("key %s: %v", k, err)
-		}
-		mods[k.String()] = mod
-	}
-	return mods, nil
-}
-
-// loadModuleMap loads modules from a ModuleMap, i.e. map[string]interface{}, where the key is the
-// module name. With a module map, module names do not need to be defined inline with their values.
-func (ctx Context) loadModuleMap(namespace string, val reflect.Value) (map[string]interface{}, error) {
-	all := make(map[string]interface{})
-	iter := val.MapRange()
-	for iter.Next() {
-		k := iter.Key().Interface().(string)
-		v := iter.Value().Interface().(json.RawMessage)
-		moduleName := namespace + "." + k
-		if namespace == "" {
-			moduleName = k
-		}
-		val, err := ctx.LoadModuleByID(moduleName, v)
-		if err != nil {
-			return nil, fmt.Errorf("module name '%s': %v", k, err)
-		}
-		all[k] = val
-	}
-	return all, nil
-}
-
-// LoadModuleByID decodes rawMsg into a new instance of mod and
-// returns the value. If mod.New is nil, an error is returned.
-// If the module implements Validator or Provisioner interfaces,
-// those methods are invoked to ensure the module is fully
-// configured and valid before being used.
-//
-// This is a lower-level method and will usually not be called
-// directly by most modules. However, this method is useful when
-// dynamically loading/unloading modules in their own context,
-// like from embedded scripts, etc.
-func (ctx Context) LoadModuleByID(id string, rawMsg json.RawMessage) (interface{}, error) {
-	modulesMu.RLock()
-	mod, ok := modules[id]
-	modulesMu.RUnlock()
-	if !ok {
-		return nil, fmt.Errorf("unknown module: %s", id)
-	}
-
-	if mod.New == nil {
-		return nil, fmt.Errorf("module '%s' has no constructor", mod.ID)
-	}
-
-	val := mod.New().(interface{})
-
-	// value must be a pointer for unmarshaling into concrete type, even if
-	// the module's concrete type is a slice or map; New() *should* return
-	// a pointer, otherwise unmarshaling errors or panics will occur
-	if rv := reflect.ValueOf(val); rv.Kind() != reflect.Ptr {
-		log.Printf("[WARNING] ModuleInfo.New() for module '%s' did not return a pointer,"+
-			" so we are using reflection to make a pointer instead; please fix this by"+
-			" using new(Type) or &Type notation in your module's New() function.", id)
-		val = reflect.New(rv.Type()).Elem().Addr().Interface().(Module)
-	}
-
-	// fill in its config only if there is a config to fill in
-	if len(rawMsg) > 0 {
-		err := strictUnmarshalJSON(rawMsg, &val)
-		if err != nil {
-			return nil, fmt.Errorf("decoding module config: %s: %v", mod, err)
-		}
-	}
-
-	if val == nil {
-		// returned module values are almost always type-asserted
-		// before being used, so a nil value would panic; and there
-		// is no good reason to explicitly declare null modules in
-		// a config; it might be because the user is trying to achieve
-		// a result the developer isn't expecting, which is a smell
-		return nil, fmt.Errorf("module value cannot be null")
-	}
-
-	if prov, ok := val.(Provisioner); ok {
-		err := prov.Provision(ctx)
-		if err != nil {
-			// incomplete provisioning could have left state
-			// dangling, so make sure it gets cleaned up
-			if cleanerUpper, ok := val.(CleanerUpper); ok {
-				err2 := cleanerUpper.Cleanup()
-				if err2 != nil {
-					err = fmt.Errorf("%v; additionally, cleanup: %v", err, err2)
-				}
-			}
-			return nil, fmt.Errorf("provision %s: %v", mod, err)
-		}
-	}
-
-	if validator, ok := val.(Validator); ok {
-		err := validator.Validate()
-		if err != nil {
-			// since the module was already provisioned, make sure we clean up
-			if cleanerUpper, ok := val.(CleanerUpper); ok {
-				err2 := cleanerUpper.Cleanup()
-				if err2 != nil {
-					err = fmt.Errorf("%v; additionally, cleanup: %v", err, err2)
-				}
-			}
-			return nil, fmt.Errorf("%s: invalid configuration: %v", mod, err)
-		}
-	}
-
-	ctx.moduleInstances[id] = append(ctx.moduleInstances[id], val)
-
-	return val, nil
-}
-
-// loadModuleInline loads a module from a JSON raw message which decodes to
-// a map[string]interface{}, where one of the object keys is moduleNameKey
-// and the corresponding value is the module name (as a string) which can
-// be found in the given scope. In other words, the module name is declared
-// in-line with the module itself.
-//
-// This allows modules to be decoded into their concrete types and used when
-// their names cannot be the unique key in a map, such as when there are
-// multiple instances in the map or it appears in an array (where there are
-// no custom keys). In other words, the key containing the module name is
-// treated special/separate from all the other keys in the object.
-func (ctx Context) loadModuleInline(moduleNameKey, moduleScope string, raw json.RawMessage) (interface{}, error) {
-	moduleName, raw, err := getModuleNameInline(moduleNameKey, raw)
-	if err != nil {
-		return nil, err
-	}
-
-	val, err := ctx.LoadModuleByID(moduleScope+"."+moduleName, raw)
-	if err != nil {
-		return nil, fmt.Errorf("loading module '%s': %v", moduleName, err)
-	}
-
-	return val, nil
-}
-
-// App returns the configured app named name. If that app has
-// not yet been loaded and provisioned, it will be immediately
-// loaded and provisioned. If no app with that name is
-// configured, a new empty one will be instantiated instead.
-// (The app module must still be registered.) This must not be
-// called during the Provision/Validate phase to reference a
-// module's own host app (since the parent app module is still
-// in the process of being provisioned, it is not yet ready).
-func (ctx Context) App(name string) (interface{}, error) {
-	if app, ok := ctx.cfg.apps[name]; ok {
-		return app, nil
-	}
-	appRaw := ctx.cfg.AppsRaw[name]
-	modVal, err := ctx.LoadModuleByID(name, appRaw)
-	if err != nil {
-		return nil, fmt.Errorf("loading %s app module: %v", name, err)
-	}
-	if appRaw != nil {
-		ctx.cfg.AppsRaw[name] = nil // allow GC to deallocate
-	}
-	ctx.cfg.apps[name] = modVal.(App)
-	return modVal, nil
-}
-
-// Storage returns the configured Caddy storage implementation.
-func (ctx Context) Storage() certmagic.Storage {
-	return ctx.cfg.storage
-}
-
-// Logger returns a logger that can be used by mod.
-func (ctx Context) Logger(mod Module) *zap.Logger {
-	return ctx.cfg.Logging.Logger(mod)
-}

context_test.go

@@ -1,118 +0,0 @@
-// 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 caddy
-
-import (
-	"encoding/json"
-	"io"
-)
-
-func ExampleContext_LoadModule() {
-	// this whole first part is just setting up for the example;
-	// note the struct tags - very important; we specify inline_key
-	// because that is the only way to know the module name
-	var ctx Context
-	myStruct := &struct {
-		// This godoc comment will appear in module documentation.
-		GuestModuleRaw json.RawMessage `json:"guest_module,omitempty" caddy:"namespace=example inline_key=name"`
-
-		// this is where the decoded module will be stored; in this
-		// example, we pretend we need an io.Writer but it can be
-		// any interface type that is useful to you
-		guestModule io.Writer
-	}{
-		GuestModuleRaw: json.RawMessage(`{"name":"module_name","foo":"bar"}`),
-	}
-
-	// if a guest module is provided, we can load it easily
-	if myStruct.GuestModuleRaw != nil {
-		mod, err := ctx.LoadModule(myStruct, "GuestModuleRaw")
-		if err != nil {
-			// you'd want to actually handle the error here
-			// return fmt.Errorf("loading guest module: %v", err)
-		}
-		// mod contains the loaded and provisioned module,
-		// it is now ready for us to use
-		myStruct.guestModule = mod.(io.Writer)
-	}
-
-	// use myStruct.guestModule from now on
-}
-
-func ExampleContext_LoadModule_array() {
-	// this whole first part is just setting up for the example;
-	// note the struct tags - very important; we specify inline_key
-	// because that is the only way to know the module name
-	var ctx Context
-	myStruct := &struct {
-		// This godoc comment will appear in module documentation.
-		GuestModulesRaw []json.RawMessage `json:"guest_modules,omitempty" caddy:"namespace=example inline_key=name"`
-
-		// this is where the decoded module will be stored; in this
-		// example, we pretend we need an io.Writer but it can be
-		// any interface type that is useful to you
-		guestModules []io.Writer
-	}{
-		GuestModulesRaw: []json.RawMessage{
-			json.RawMessage(`{"name":"module1_name","foo":"bar1"}`),
-			json.RawMessage(`{"name":"module2_name","foo":"bar2"}`),
-		},
-	}
-
-	// since our input is []json.RawMessage, the output will be []interface{}
-	mods, err := ctx.LoadModule(myStruct, "GuestModulesRaw")
-	if err != nil {
-		// you'd want to actually handle the error here
-		// return fmt.Errorf("loading guest modules: %v", err)
-	}
-	for _, mod := range mods.([]interface{}) {
-		myStruct.guestModules = append(myStruct.guestModules, mod.(io.Writer))
-	}
-
-	// use myStruct.guestModules from now on
-}
-
-func ExampleContext_LoadModule_map() {
-	// this whole first part is just setting up for the example;
-	// note the struct tags - very important; we don't specify
-	// inline_key because the map key is the module name
-	var ctx Context
-	myStruct := &struct {
-		// This godoc comment will appear in module documentation.
-		GuestModulesRaw ModuleMap `json:"guest_modules,omitempty" caddy:"namespace=example"`
-
-		// this is where the decoded module will be stored; in this
-		// example, we pretend we need an io.Writer but it can be
-		// any interface type that is useful to you
-		guestModules map[string]io.Writer
-	}{
-		GuestModulesRaw: ModuleMap{
-			"module1_name": json.RawMessage(`{"foo":"bar1"}`),
-			"module2_name": json.RawMessage(`{"foo":"bar2"}`),
-		},
-	}
-
-	// since our input is map[string]json.RawMessage, the output will be map[string]interface{}
-	mods, err := ctx.LoadModule(myStruct, "GuestModulesRaw")
-	if err != nil {
-		// you'd want to actually handle the error here
-		// return fmt.Errorf("loading guest modules: %v", err)
-	}
-	for modName, mod := range mods.(map[string]interface{}) {
-		myStruct.guestModules[modName] = mod.(io.Writer)
-	}
-
-	// use myStruct.guestModules from now on
-}

go.mod

@@ -1,37 +0,0 @@
-module github.com/caddyserver/caddy/v2
-
-go 1.14
-
-require (
-	github.com/Masterminds/sprig/v3 v3.0.2
-	github.com/alecthomas/chroma v0.7.2-0.20200305040604-4f3623dce67a
-	github.com/andybalholm/brotli v1.0.0
-	github.com/caddyserver/certmagic v0.10.4
-	github.com/dustin/go-humanize v1.0.1-0.20200219035652-afde56e7acac
-	github.com/go-acme/lego/v3 v3.5.0
-	github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e
-	github.com/google/cel-go v0.4.0
-	github.com/ilibs/json5 v1.0.1
-	github.com/jsternberg/zap-logfmt v1.2.0
-	github.com/klauspost/compress v1.10.3
-	github.com/klauspost/cpuid v1.2.3
-	github.com/lucas-clemente/quic-go v0.15.2
-	github.com/manifoldco/promptui v0.7.0 // indirect
-	github.com/miekg/dns v1.1.29 // indirect
-	github.com/muhammadmuzzammil1998/jsonc v0.0.0-20200303171503-1e787b591db7
-	github.com/naoina/go-stringutil v0.1.0 // indirect
-	github.com/naoina/toml v0.1.1
-	github.com/smallstep/certificates v0.14.0-rc.5
-	github.com/smallstep/cli v0.14.0-rc.3
-	github.com/smallstep/truststore v0.9.4
-	github.com/vulcand/oxy v1.0.0
-	github.com/yuin/goldmark v1.1.25
-	github.com/yuin/goldmark-highlighting v0.0.0-20200307114337-60d527fdb691
-	go.uber.org/zap v1.14.1
-	golang.org/x/crypto v0.0.0-20200317142112-1b76d66859c6
-	golang.org/x/net v0.0.0-20200319234117-63522dbf7eec
-	google.golang.org/genproto v0.0.0-20200305110556-506484158171
-	gopkg.in/natefinch/lumberjack.v2 v2.0.0
-	gopkg.in/square/go-jose.v2 v2.4.1 // indirect
-	gopkg.in/yaml.v2 v2.2.8
-)

listeners.go

@@ -1,407 +0,0 @@
-// 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 caddy
-
-import (
-	"fmt"
-	"log"
-	"net"
-	"strconv"
-	"strings"
-	"sync"
-	"sync/atomic"
-	"time"
-)
-
-// Listen returns a listener suitable for use in a Caddy module.
-// Always be sure to close listeners when you are done with them.
-func Listen(network, addr string) (net.Listener, error) {
-	lnKey := network + "/" + addr
-
-	listenersMu.Lock()
-	defer listenersMu.Unlock()
-
-	// if listener already exists, increment usage counter, then return listener
-	if lnGlobal, ok := listeners[lnKey]; ok {
-		atomic.AddInt32(&lnGlobal.usage, 1)
-		return &fakeCloseListener{
-			usage:      &lnGlobal.usage,
-			deadline:   &lnGlobal.deadline,
-			deadlineMu: &lnGlobal.deadlineMu,
-			key:        lnKey,
-			Listener:   lnGlobal.ln,
-		}, nil
-	}
-
-	// or, create new one and save it
-	ln, err := net.Listen(network, addr)
-	if err != nil {
-		return nil, err
-	}
-
-	// make sure to start its usage counter at 1
-	lnGlobal := &globalListener{usage: 1, ln: ln}
-	listeners[lnKey] = lnGlobal
-
-	return &fakeCloseListener{
-		usage:      &lnGlobal.usage,
-		deadline:   &lnGlobal.deadline,
-		deadlineMu: &lnGlobal.deadlineMu,
-		key:        lnKey,
-		Listener:   ln,
-	}, nil
-}
-
-// ListenPacket returns a net.PacketConn suitable for use in a Caddy module.
-// Always be sure to close the PacketConn when you are done.
-func ListenPacket(network, addr string) (net.PacketConn, error) {
-	lnKey := network + "/" + addr
-
-	listenersMu.Lock()
-	defer listenersMu.Unlock()
-
-	// if listener already exists, increment usage counter, then return listener
-	if lnGlobal, ok := listeners[lnKey]; ok {
-		atomic.AddInt32(&lnGlobal.usage, 1)
-		log.Printf("[DEBUG] %s: Usage counter should not go above 2 or maybe 3, is now: %d", lnKey, atomic.LoadInt32(&lnGlobal.usage)) // TODO: remove
-		return &fakeClosePacketConn{usage: &lnGlobal.usage, key: lnKey, PacketConn: lnGlobal.pc}, nil
-	}
-
-	// or, create new one and save it
-	pc, err := net.ListenPacket(network, addr)
-	if err != nil {
-		return nil, err
-	}
-
-	// make sure to start its usage counter at 1
-	lnGlobal := &globalListener{usage: 1, pc: pc}
-	listeners[lnKey] = lnGlobal
-
-	return &fakeClosePacketConn{usage: &lnGlobal.usage, key: lnKey, PacketConn: pc}, nil
-}
-
-// fakeCloseListener's Close() method is a no-op. This allows
-// stopping servers that are using the listener without giving
-// up the socket; thus, servers become hot-swappable while the
-// listener remains running. Listeners should be re-wrapped in
-// a new fakeCloseListener each time the listener is reused.
-// Other than the 'closed' field (which pertains to this value
-// only), the other fields in this struct should be pointers to
-// the associated globalListener's struct fields (except 'key'
-// which is there for read-only purposes, so it can be a copy).
-type fakeCloseListener struct {
-	closed       int32       // accessed atomically; belongs to this struct only
-	usage        *int32      // accessed atomically; global
-	deadline     *bool       // protected by deadlineMu; global
-	deadlineMu   *sync.Mutex // global
-	key          string      // global, but read-only, so can be copy
-	net.Listener             // global
-}
-
-// Accept accepts connections until Close() is called.
-func (fcl *fakeCloseListener) Accept() (net.Conn, error) {
-	// if the listener is already "closed", return error
-	if atomic.LoadInt32(&fcl.closed) == 1 {
-		return nil, fcl.fakeClosedErr()
-	}
-
-	// wrap underlying accept
-	conn, err := fcl.Listener.Accept()
-	if err == nil {
-		return conn, nil
-	}
-
-	// accept returned with error
-	// TODO: This may be better as a condition variable so the deadline is cleared only once?
-	fcl.deadlineMu.Lock()
-	if *fcl.deadline {
-		switch ln := fcl.Listener.(type) {
-		case *net.TCPListener:
-			ln.SetDeadline(time.Time{})
-		case *net.UnixListener:
-			ln.SetDeadline(time.Time{})
-		}
-		*fcl.deadline = false
-	}
-	fcl.deadlineMu.Unlock()
-
-	if atomic.LoadInt32(&fcl.closed) == 1 {
-		// if we canceled the Accept() by setting a deadline
-		// on the listener, we need to make sure any callers of
-		// Accept() think the listener was actually closed;
-		// if we return the timeout error instead, callers might
-		// simply retry, leaking goroutines for longer
-		if netErr, ok := err.(net.Error); ok && netErr.Timeout() {
-			return nil, fcl.fakeClosedErr()
-		}
-	}
-
-	return nil, err
-}
-
-// Close stops accepting new connections without
-// closing the underlying listener, unless no one
-// else is using it.
-func (fcl *fakeCloseListener) Close() error {
-	if atomic.CompareAndSwapInt32(&fcl.closed, 0, 1) {
-		// unfortunately, there is no way to cancel any
-		// currently-blocking calls to Accept() that are
-		// awaiting connections since we're not actually
-		// closing the listener; so we cheat by setting
-		// a deadline in the past, which forces it to
-		// time out; note that this only works for
-		// certain types of listeners...
-		fcl.deadlineMu.Lock()
-		if !*fcl.deadline {
-			switch ln := fcl.Listener.(type) {
-			case *net.TCPListener:
-				ln.SetDeadline(time.Now().Add(-1 * time.Minute))
-			case *net.UnixListener:
-				ln.SetDeadline(time.Now().Add(-1 * time.Minute))
-			}
-			*fcl.deadline = true
-		}
-		fcl.deadlineMu.Unlock()
-
-		// since we're no longer using this listener,
-		// decrement the usage counter and, if no one
-		// else is using it, close underlying listener
-		if atomic.AddInt32(fcl.usage, -1) == 0 {
-			listenersMu.Lock()
-			delete(listeners, fcl.key)
-			listenersMu.Unlock()
-			err := fcl.Listener.Close()
-			if err != nil {
-				return err
-			}
-		}
-
-	}
-
-	return nil
-}
-
-func (fcl *fakeCloseListener) fakeClosedErr() error {
-	return &net.OpError{
-		Op:   "accept",
-		Net:  fcl.Listener.Addr().Network(),
-		Addr: fcl.Listener.Addr(),
-		Err:  errFakeClosed,
-	}
-}
-
-type fakeClosePacketConn struct {
-	closed int32  // accessed atomically
-	usage  *int32 // accessed atomically
-	key    string
-	net.PacketConn
-}
-
-func (fcpc *fakeClosePacketConn) Close() error {
-	log.Println("[DEBUG] Fake-closing underlying packet conn") // TODO: remove this
-
-	if atomic.CompareAndSwapInt32(&fcpc.closed, 0, 1) {
-		// since we're no longer using this listener,
-		// decrement the usage counter and, if no one
-		// else is using it, close underlying listener
-		if atomic.AddInt32(fcpc.usage, -1) == 0 {
-			listenersMu.Lock()
-			delete(listeners, fcpc.key)
-			listenersMu.Unlock()
-			err := fcpc.PacketConn.Close()
-			if err != nil {
-				return err
-			}
-		}
-	}
-
-	return nil
-}
-
-// ErrFakeClosed is the underlying error value returned by
-// fakeCloseListener.Accept() after Close() has been called,
-// indicating that it is pretending to be closed so that the
-// server using it can terminate, while the underlying
-// socket is actually left open.
-var errFakeClosed = fmt.Errorf("listener 'closed' 😉")
-
-// globalListener keeps global state for a listener
-// that may be shared by multiple servers. In other
-// words, values in this struct exist only once and
-// all other uses of these values point to the ones
-// in this struct. In particular, the usage count
-// (how many callers are using the listener), the
-// actual listener, and synchronization of the
-// listener's deadline changes are singular, global
-// values that must not be copied.
-type globalListener struct {
-	usage      int32 // accessed atomically
-	deadline   bool
-	deadlineMu sync.Mutex
-	ln         net.Listener
-	pc         net.PacketConn
-}
-
-// ParsedAddress contains the individual components
-// for a parsed network address of the form accepted
-// by ParseNetworkAddress(). Network should be a
-// network value accepted by Go's net package. Port
-// ranges are given by [StartPort, EndPort].
-type ParsedAddress struct {
-	Network   string
-	Host      string
-	StartPort uint
-	EndPort   uint
-}
-
-// IsUnixNetwork returns true if pa.Network is
-// unix, unixgram, or unixpacket.
-func (pa ParsedAddress) IsUnixNetwork() bool {
-	return isUnixNetwork(pa.Network)
-}
-
-// JoinHostPort is like net.JoinHostPort, but where the port
-// is StartPort + offset.
-func (pa ParsedAddress) JoinHostPort(offset uint) string {
-	if pa.IsUnixNetwork() {
-		return pa.Host
-	}
-	return net.JoinHostPort(pa.Host, strconv.Itoa(int(pa.StartPort+offset)))
-}
-
-// PortRangeSize returns how many ports are in
-// pa's port range. Port ranges are inclusive,
-// so the size is the difference of start and
-// end ports plus one.
-func (pa ParsedAddress) PortRangeSize() uint {
-	return (pa.EndPort - pa.StartPort) + 1
-}
-
-// String reconstructs the address string to the form expected
-// by ParseNetworkAddress().
-func (pa ParsedAddress) String() string {
-	port := strconv.FormatUint(uint64(pa.StartPort), 10)
-	if pa.StartPort != pa.EndPort {
-		port += "-" + strconv.FormatUint(uint64(pa.EndPort), 10)
-	}
-	return JoinNetworkAddress(pa.Network, pa.Host, port)
-}
-
-func isUnixNetwork(netw string) bool {
-	return netw == "unix" || netw == "unixgram" || netw == "unixpacket"
-}
-
-// ParseNetworkAddress parses addr into its individual
-// components. The input string is expected to be of
-// the form "network/host:port-range" where any part is
-// optional. The default network, if unspecified, is tcp.
-// Port ranges are inclusive.
-//
-// Network addresses are distinct from URLs and do not
-// use URL syntax.
-func ParseNetworkAddress(addr string) (ParsedAddress, error) {
-	var host, port string
-	network, host, port, err := SplitNetworkAddress(addr)
-	if network == "" {
-		network = "tcp"
-	}
-	if err != nil {
-		return ParsedAddress{}, err
-	}
-	if isUnixNetwork(network) {
-		return ParsedAddress{
-			Network: network,
-			Host:    host,
-		}, nil
-	}
-	ports := strings.SplitN(port, "-", 2)
-	if len(ports) == 1 {
-		ports = append(ports, ports[0])
-	}
-	var start, end uint64
-	start, err = strconv.ParseUint(ports[0], 10, 16)
-	if err != nil {
-		return ParsedAddress{}, fmt.Errorf("invalid start port: %v", err)
-	}
-	end, err = strconv.ParseUint(ports[1], 10, 16)
-	if err != nil {
-		return ParsedAddress{}, fmt.Errorf("invalid end port: %v", err)
-	}
-	if end < start {
-		return ParsedAddress{}, fmt.Errorf("end port must not be less than start port")
-	}
-	if (end - start) > maxPortSpan {
-		return ParsedAddress{}, fmt.Errorf("port range exceeds %d ports", maxPortSpan)
-	}
-	return ParsedAddress{
-		Network:   network,
-		Host:      host,
-		StartPort: uint(start),
-		EndPort:   uint(end),
-	}, nil
-}
-
-// SplitNetworkAddress splits a into its network, host, and port components.
-// Note that port may be a port range (:X-Y), or omitted for unix sockets.
-func SplitNetworkAddress(a string) (network, host, port string, err error) {
-	if idx := strings.Index(a, "/"); idx >= 0 {
-		network = strings.ToLower(strings.TrimSpace(a[:idx]))
-		a = a[idx+1:]
-	}
-	if isUnixNetwork(network) {
-		host = a
-		return
-	}
-	host, port, err = net.SplitHostPort(a)
-	return
-}
-
-// JoinNetworkAddress combines network, host, and port into a single
-// address string of the form accepted by ParseNetworkAddress(). For
-// unix sockets, the network should be "unix" (or "unixgram" or
-// "unixpacket") and the path to the socket should be given as the
-// host parameter.
-func JoinNetworkAddress(network, host, port string) string {
-	var a string
-	if network != "" {
-		a = network + "/"
-	}
-	if host != "" && port == "" {
-		a += host
-	} else if port != "" {
-		a += net.JoinHostPort(host, port)
-	}
-	return a
-}
-
-// ListenerWrapper is a type that wraps a listener
-// so it can modify the input listener's methods.
-// Modules that implement this interface are found
-// in the caddy.listeners namespace. Usually, to
-// wrap a listener, you will define your own struct
-// type that embeds the input listener, then
-// implement your own methods that you want to wrap,
-// calling the underlying listener's methods where
-// appropriate.
-type ListenerWrapper interface {
-	WrapListener(net.Listener) net.Listener
-}
-
-var (
-	listeners   = make(map[string]*globalListener)
-	listenersMu sync.Mutex
-)
-
-const maxPortSpan = 65535

listeners_fuzz.go

@@ -1,26 +0,0 @@
-// 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.
-
-// +build gofuzz
-// +build gofuzz_libfuzzer
-
-package caddy
-
-func FuzzParseNetworkAddress(data []byte) int {
-	_, err := ParseNetworkAddress(string(data))
-	if err != nil {
-		return 0
-	}
-	return 1
-}

listeners_test.go

@@ -1,301 +0,0 @@
-// 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 caddy
-
-import (
-	"reflect"
-	"testing"
-)
-
-func TestSplitNetworkAddress(t *testing.T) {
-	for i, tc := range []struct {
-		input         string
-		expectNetwork string
-		expectHost    string
-		expectPort    string
-		expectErr     bool
-	}{
-		{
-			input:     "",
-			expectErr: true,
-		},
-		{
-			input:     "foo",
-			expectErr: true,
-		},
-		{
-			input:      "foo:1234",
-			expectHost: "foo",
-			expectPort: "1234",
-		},
-		{
-			input:      "foo:1234-5678",
-			expectHost: "foo",
-			expectPort: "1234-5678",
-		},
-		{
-			input:         "udp/foo:1234",
-			expectNetwork: "udp",
-			expectHost:    "foo",
-			expectPort:    "1234",
-		},
-		{
-			input:         "tcp6/foo:1234-5678",
-			expectNetwork: "tcp6",
-			expectHost:    "foo",
-			expectPort:    "1234-5678",
-		},
-		{
-			input:         "udp/",
-			expectNetwork: "udp",
-			expectErr:     true,
-		},
-		{
-			input:         "unix//foo/bar",
-			expectNetwork: "unix",
-			expectHost:    "/foo/bar",
-		},
-		{
-			input:         "unixgram//foo/bar",
-			expectNetwork: "unixgram",
-			expectHost:    "/foo/bar",
-		},
-		{
-			input:         "unixpacket//foo/bar",
-			expectNetwork: "unixpacket",
-			expectHost:    "/foo/bar",
-		},
-	} {
-		actualNetwork, actualHost, actualPort, err := SplitNetworkAddress(tc.input)
-		if tc.expectErr && err == nil {
-			t.Errorf("Test %d: Expected error but got: %v", i, err)
-		}
-		if !tc.expectErr && err != nil {
-			t.Errorf("Test %d: Expected no error but got: %v", i, err)
-		}
-		if actualNetwork != tc.expectNetwork {
-			t.Errorf("Test %d: Expected network '%s' but got '%s'", i, tc.expectNetwork, actualNetwork)
-		}
-		if actualHost != tc.expectHost {
-			t.Errorf("Test %d: Expected host '%s' but got '%s'", i, tc.expectHost, actualHost)
-		}
-		if actualPort != tc.expectPort {
-			t.Errorf("Test %d: Expected port '%s' but got '%s'", i, tc.expectPort, actualPort)
-		}
-	}
-}
-
-func TestJoinNetworkAddress(t *testing.T) {
-	for i, tc := range []struct {
-		network, host, port string
-		expect              string
-	}{
-		{
-			network: "", host: "", port: "",
-			expect: "",
-		},
-		{
-			network: "tcp", host: "", port: "",
-			expect: "tcp/",
-		},
-		{
-			network: "", host: "foo", port: "",
-			expect: "foo",
-		},
-		{
-			network: "", host: "", port: "1234",
-			expect: ":1234",
-		},
-		{
-			network: "", host: "", port: "1234-5678",
-			expect: ":1234-5678",
-		},
-		{
-			network: "", host: "foo", port: "1234",
-			expect: "foo:1234",
-		},
-		{
-			network: "udp", host: "foo", port: "1234",
-			expect: "udp/foo:1234",
-		},
-		{
-			network: "udp", host: "", port: "1234",
-			expect: "udp/:1234",
-		},
-		{
-			network: "unix", host: "/foo/bar", port: "",
-			expect: "unix//foo/bar",
-		},
-		{
-			network: "", host: "::1", port: "1234",
-			expect: "[::1]:1234",
-		},
-	} {
-		actual := JoinNetworkAddress(tc.network, tc.host, tc.port)
-		if actual != tc.expect {
-			t.Errorf("Test %d: Expected '%s' but got '%s'", i, tc.expect, actual)
-		}
-	}
-}
-
-func TestParseNetworkAddress(t *testing.T) {
-	for i, tc := range []struct {
-		input      string
-		expectAddr ParsedAddress
-		expectErr  bool
-	}{
-		{
-			input:     "",
-			expectErr: true,
-		},
-		{
-			input:     ":",
-			expectErr: true,
-		},
-		{
-			input: ":1234",
-			expectAddr: ParsedAddress{
-				Network:   "tcp",
-				Host:      "",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "tcp/:1234",
-			expectAddr: ParsedAddress{
-				Network:   "tcp",
-				Host:      "",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "tcp6/:1234",
-			expectAddr: ParsedAddress{
-				Network:   "tcp6",
-				Host:      "",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "tcp4/localhost:1234",
-			expectAddr: ParsedAddress{
-				Network:   "tcp4",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "unix//foo/bar",
-			expectAddr: ParsedAddress{
-				Network: "unix",
-				Host:    "/foo/bar",
-			},
-		},
-		{
-			input: "localhost:1234-1234",
-			expectAddr: ParsedAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input:     "localhost:2-1",
-			expectErr: true,
-		},
-		{
-			input: "localhost:0",
-			expectAddr: ParsedAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 0,
-				EndPort:   0,
-			},
-		},
-		{
-			input:     "localhost:1-999999999999",
-			expectErr: true,
-		},
-	} {
-		actualAddr, err := ParseNetworkAddress(tc.input)
-		if tc.expectErr && err == nil {
-			t.Errorf("Test %d: Expected error but got: %v", i, err)
-		}
-		if !tc.expectErr && err != nil {
-			t.Errorf("Test %d: Expected no error but got: %v", i, err)
-		}
-
-		if actualAddr.Network != tc.expectAddr.Network {
-			t.Errorf("Test %d: Expected network '%v' but got '%v'", i, tc.expectAddr, actualAddr)
-		}
-		if !reflect.DeepEqual(tc.expectAddr, actualAddr) {
-			t.Errorf("Test %d: Expected addresses %v but got %v", i, tc.expectAddr, actualAddr)
-		}
-	}
-}
-
-func TestJoinHostPort(t *testing.T) {
-	for i, tc := range []struct {
-		pa     ParsedAddress
-		offset uint
-		expect string
-	}{
-		{
-			pa: ParsedAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-			expect: "localhost:1234",
-		},
-		{
-			pa: ParsedAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1235,
-			},
-			expect: "localhost:1234",
-		},
-		{
-			pa: ParsedAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1235,
-			},
-			offset: 1,
-			expect: "localhost:1235",
-		},
-		{
-			pa: ParsedAddress{
-				Network: "unix",
-				Host:    "/run/php/php7.3-fpm.sock",
-			},
-			expect: "/run/php/php7.3-fpm.sock",
-		},
-	} {
-		actual := tc.pa.JoinHostPort(tc.offset)
-		if actual != tc.expect {
-			t.Errorf("Test %d: Expected '%s' but got '%s'", i, tc.expect, actual)
-		}
-	}
-}

logging.go

@@ -1,696 +0,0 @@
-// 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 caddy
-
-import (
-	"encoding/json"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"log"
-	"os"
-	"strings"
-	"sync"
-	"time"
-
-	"go.uber.org/zap"
-	"go.uber.org/zap/zapcore"
-	"golang.org/x/crypto/ssh/terminal"
-)
-
-func init() {
-	RegisterModule(StdoutWriter{})
-	RegisterModule(StderrWriter{})
-	RegisterModule(DiscardWriter{})
-}
-
-// Logging facilitates logging within Caddy. The default log is
-// called "default" and you can customize it. You can also define
-// additional logs.
-//
-// By default, all logs at INFO level and higher are written to
-// standard error ("stderr" writer) in a human-readable format
-// ("console" encoder if stdout is an interactive terminal, "json"
-// encoder otherwise).
-//
-// All defined logs accept all log entries by default, but you
-// can filter by level and module/logger names. A logger's name
-// is the same as the module's name, but a module may append to
-// logger names for more specificity. For example, you can
-// filter logs emitted only by HTTP handlers using the name
-// "http.handlers", because all HTTP handler module names have
-// that prefix.
-//
-// Caddy logs (except the sink) are zero-allocation, so they are
-// very high-performing in terms of memory and CPU time. Enabling
-// sampling can further increase throughput on extremely high-load
-// servers.
-type Logging struct {
-	// Sink is the destination for all unstructured logs emitted
-	// from Go's standard library logger. These logs are common
-	// in dependencies that are not designed specifically for use
-	// in Caddy. Because it is global and unstructured, the sink
-	// lacks most advanced features and customizations.
-	Sink *StandardLibLog `json:"sink,omitempty"`
-
-	// Logs are your logs, keyed by an arbitrary name of your
-	// choosing. The default log can be customized by defining
-	// a log called "default". You can further define other logs
-	// and filter what kinds of entries they accept.
-	Logs map[string]*CustomLog `json:"logs,omitempty"`
-
-	// a list of all keys for open writers; all writers
-	// that are opened to provision this logging config
-	// must have their keys added to this list so they
-	// can be closed when cleaning up
-	writerKeys []string
-}
-
-// openLogs sets up the config and opens all the configured writers.
-// It closes its logs when ctx is canceled, so it should clean up
-// after itself.
-func (logging *Logging) openLogs(ctx Context) error {
-	// make sure to deallocate resources when context is done
-	ctx.OnCancel(func() {
-		err := logging.closeLogs()
-		if err != nil {
-			Log().Error("closing logs", zap.Error(err))
-		}
-	})
-
-	// set up the "sink" log first (std lib's default global logger)
-	if logging.Sink != nil {
-		err := logging.Sink.provision(ctx, logging)
-		if err != nil {
-			return fmt.Errorf("setting up sink log: %v", err)
-		}
-	}
-
-	// as a special case, set up the default structured Caddy log next
-	if err := logging.setupNewDefault(ctx); err != nil {
-		return err
-	}
-
-	// then set up any other custom logs
-	for name, l := range logging.Logs {
-		// the default log is already set up
-		if name == "default" {
-			continue
-		}
-
-		err := l.provision(ctx, logging)
-		if err != nil {
-			return fmt.Errorf("setting up custom log '%s': %v", name, err)
-		}
-
-		// Any other logs that use the discard writer can be deleted
-		// entirely. This avoids encoding and processing of each
-		// log entry that would just be thrown away anyway. Notably,
-		// we do not reach this point for the default log, which MUST
-		// exist, otherwise core log emissions would panic because
-		// they use the Log() function directly which expects a non-nil
-		// logger. Even if we keep logs with a discard writer, they
-		// have a nop core, and keeping them at all seems unnecessary.
-		if _, ok := l.writerOpener.(*DiscardWriter); ok {
-			delete(logging.Logs, name)
-			continue
-		}
-	}
-
-	return nil
-}
-
-func (logging *Logging) setupNewDefault(ctx Context) error {
-	if logging.Logs == nil {
-		logging.Logs = make(map[string]*CustomLog)
-	}
-
-	// extract the user-defined default log, if any
-	newDefault := new(defaultCustomLog)
-	if userDefault, ok := logging.Logs["default"]; ok {
-		newDefault.CustomLog = userDefault
-	} else {
-		// if none, make one with our own default settings
-		var err error
-		newDefault, err = newDefaultProductionLog()
-		if err != nil {
-			return fmt.Errorf("setting up default Caddy log: %v", err)
-		}
-		logging.Logs["default"] = newDefault.CustomLog
-	}
-
-	// set up this new log
-	err := newDefault.CustomLog.provision(ctx, logging)
-	if err != nil {
-		return fmt.Errorf("setting up default log: %v", err)
-	}
-	newDefault.logger = zap.New(newDefault.CustomLog.core)
-
-	// redirect the default caddy logs
-	defaultLoggerMu.Lock()
-	oldDefault := defaultLogger
-	defaultLogger = newDefault
-	defaultLoggerMu.Unlock()
-
-	// if the new writer is different, indicate it in the logs for convenience
-	var newDefaultLogWriterKey, currentDefaultLogWriterKey string
-	var newDefaultLogWriterStr, currentDefaultLogWriterStr string
-	if newDefault.writerOpener != nil {
-		newDefaultLogWriterKey = newDefault.writerOpener.WriterKey()
-		newDefaultLogWriterStr = newDefault.writerOpener.String()
-	}
-	if oldDefault.writerOpener != nil {
-		currentDefaultLogWriterKey = oldDefault.writerOpener.WriterKey()
-		currentDefaultLogWriterStr = oldDefault.writerOpener.String()
-	}
-	if newDefaultLogWriterKey != currentDefaultLogWriterKey {
-		oldDefault.logger.Info("redirected default logger",
-			zap.String("from", currentDefaultLogWriterStr),
-			zap.String("to", newDefaultLogWriterStr),
-		)
-	}
-
-	return nil
-}
-
-// closeLogs cleans up resources allocated during openLogs.
-// A successful call to openLogs calls this automatically
-// when the context is canceled.
-func (logging *Logging) closeLogs() error {
-	for _, key := range logging.writerKeys {
-		_, err := writers.Delete(key)
-		if err != nil {
-			log.Printf("[ERROR] Closing log writer %v: %v", key, err)
-		}
-	}
-	return nil
-}
-
-// Logger returns a logger that is ready for the module to use.
-func (logging *Logging) Logger(mod Module) *zap.Logger {
-	modID := string(mod.CaddyModule().ID)
-	var cores []zapcore.Core
-
-	if logging != nil {
-		for _, l := range logging.Logs {
-			if l.matchesModule(modID) {
-				if len(l.Include) == 0 && len(l.Exclude) == 0 {
-					cores = append(cores, l.core)
-					continue
-				}
-				cores = append(cores, &filteringCore{Core: l.core, cl: l})
-			}
-		}
-	}
-
-	multiCore := zapcore.NewTee(cores...)
-
-	return zap.New(multiCore).Named(string(modID))
-}
-
-// openWriter opens a writer using opener, and returns true if
-// the writer is new, or false if the writer already exists.
-func (logging *Logging) openWriter(opener WriterOpener) (io.WriteCloser, bool, error) {
-	key := opener.WriterKey()
-	writer, loaded, err := writers.LoadOrNew(key, func() (Destructor, error) {
-		w, err := opener.OpenWriter()
-		return writerDestructor{w}, err
-	})
-	if err != nil {
-		return nil, false, err
-	}
-	logging.writerKeys = append(logging.writerKeys, key)
-	return writer.(io.WriteCloser), !loaded, nil
-}
-
-// WriterOpener is a module that can open a log writer.
-// It can return a human-readable string representation
-// of itself so that operators can understand where
-// the logs are going.
-type WriterOpener interface {
-	fmt.Stringer
-
-	// WriterKey is a string that uniquely identifies this
-	// writer configuration. It is not shown to humans.
-	WriterKey() string
-
-	// OpenWriter opens a log for writing. The writer
-	// should be safe for concurrent use but need not
-	// be synchronous.
-	OpenWriter() (io.WriteCloser, error)
-}
-
-type writerDestructor struct {
-	io.WriteCloser
-}
-
-func (wdest writerDestructor) Destruct() error {
-	return wdest.Close()
-}
-
-// StandardLibLog configures the default Go standard library
-// global logger in the log package. This is necessary because
-// module dependencies which are not built specifically for
-// Caddy will use the standard logger. This is also known as
-// the "sink" logger.
-type StandardLibLog struct {
-	// The module that writes out log entries for the sink.
-	WriterRaw json.RawMessage `json:"writer,omitempty" caddy:"namespace=caddy.logging.writers inline_key=output"`
-
-	writer io.WriteCloser
-}
-
-func (sll *StandardLibLog) provision(ctx Context, logging *Logging) error {
-	if sll.WriterRaw != nil {
-		mod, err := ctx.LoadModule(sll, "WriterRaw")
-		if err != nil {
-			return fmt.Errorf("loading sink log writer module: %v", err)
-		}
-		wo := mod.(WriterOpener)
-
-		var isNew bool
-		sll.writer, isNew, err = logging.openWriter(wo)
-		if err != nil {
-			return fmt.Errorf("opening sink log writer %#v: %v", mod, err)
-		}
-
-		if isNew {
-			log.Printf("[INFO] Redirecting sink to: %s", wo)
-			log.SetOutput(sll.writer)
-			log.Printf("[INFO] Redirected sink to here (%s)", wo)
-		}
-	}
-
-	return nil
-}
-
-// CustomLog represents a custom logger configuration.
-//
-// By default, a log will emit all log entries. Some entries
-// will be skipped if sampling is enabled. Further, the Include
-// and Exclude parameters define which loggers (by name) are
-// allowed or rejected from emitting in this log. If both Include
-// and Exclude are populated, their values must be mutually
-// exclusive, and longer namespaces have priority. If neither
-// are populated, all logs are emitted.
-type CustomLog struct {
-	// The writer defines where log entries are emitted.
-	WriterRaw json.RawMessage `json:"writer,omitempty" caddy:"namespace=caddy.logging.writers inline_key=output"`
-
-	// The encoder is how the log entries are formatted or encoded.
-	EncoderRaw json.RawMessage `json:"encoder,omitempty" caddy:"namespace=caddy.logging.encoders inline_key=format"`
-
-	// Level is the minimum level to emit, and is inclusive.
-	// Possible levels: DEBUG, INFO, WARN, ERROR, PANIC, and FATAL
-	Level string `json:"level,omitempty"`
-
-	// Sampling configures log entry sampling. If enabled,
-	// only some log entries will be emitted. This is useful
-	// for improving performance on extremely high-pressure
-	// servers.
-	Sampling *LogSampling `json:"sampling,omitempty"`
-
-	// Include defines the names of loggers to emit in this
-	// log. For example, to include only logs emitted by the
-	// admin API, you would include "admin.api".
-	Include []string `json:"include,omitempty"`
-
-	// Exclude defines the names of loggers that should be
-	// skipped by this log. For example, to exclude only
-	// HTTP access logs, you would exclude "http.log.access".
-	Exclude []string `json:"exclude,omitempty"`
-
-	writerOpener WriterOpener
-	writer       io.WriteCloser
-	encoder      zapcore.Encoder
-	levelEnabler zapcore.LevelEnabler
-	core         zapcore.Core
-}
-
-func (cl *CustomLog) provision(ctx Context, logging *Logging) error {
-	// Replace placeholder for log level
-	repl := NewReplacer()
-	level, err := repl.ReplaceOrErr(cl.Level, true, true)
-	if err != nil {
-		return fmt.Errorf("invalid log level: %v", err)
-	}
-	level = strings.ToLower(level)
-
-	// set up the log level
-	switch level {
-	case "debug":
-		cl.levelEnabler = zapcore.DebugLevel
-	case "", "info":
-		cl.levelEnabler = zapcore.InfoLevel
-	case "warn":
-		cl.levelEnabler = zapcore.WarnLevel
-	case "error":
-		cl.levelEnabler = zapcore.ErrorLevel
-	case "panic":
-		cl.levelEnabler = zapcore.PanicLevel
-	case "fatal":
-		cl.levelEnabler = zapcore.FatalLevel
-	default:
-		return fmt.Errorf("unrecognized log level: %s", cl.Level)
-	}
-
-	// If both Include and Exclude lists are populated, then each item must
-	// be a superspace or subspace of an item in the other list, because
-	// populating both lists means that any given item is either a rule
-	// or an exception to another rule. But if the item is not a super-
-	// or sub-space of any item in the other list, it is neither a rule
-	// nor an exception, and is a contradiction. Ensure, too, that the
-	// sets do not intersect, which is also a contradiction.
-	if len(cl.Include) > 0 && len(cl.Exclude) > 0 {
-		// prevent intersections
-		for _, allow := range cl.Include {
-			for _, deny := range cl.Exclude {
-				if allow == deny {
-					return fmt.Errorf("include and exclude must not intersect, but found %s in both lists", allow)
-				}
-			}
-		}
-
-		// ensure namespaces are nested
-	outer:
-		for _, allow := range cl.Include {
-			for _, deny := range cl.Exclude {
-				if strings.HasPrefix(allow+".", deny+".") ||
-					strings.HasPrefix(deny+".", allow+".") {
-					continue outer
-				}
-			}
-			return fmt.Errorf("when both include and exclude are populated, each element must be a superspace or subspace of one in the other list; check '%s' in include", allow)
-		}
-	}
-
-	if cl.EncoderRaw != nil {
-		mod, err := ctx.LoadModule(cl, "EncoderRaw")
-		if err != nil {
-			return fmt.Errorf("loading log encoder module: %v", err)
-		}
-		cl.encoder = mod.(zapcore.Encoder)
-	}
-	if cl.encoder == nil {
-		cl.encoder = newDefaultProductionLogEncoder()
-	}
-
-	if cl.WriterRaw != nil {
-		mod, err := ctx.LoadModule(cl, "WriterRaw")
-		if err != nil {
-			return fmt.Errorf("loading log writer module: %v", err)
-		}
-		cl.writerOpener = mod.(WriterOpener)
-	}
-	if cl.writerOpener == nil {
-		cl.writerOpener = StderrWriter{}
-	}
-
-	cl.writer, _, err = logging.openWriter(cl.writerOpener)
-	if err != nil {
-		return fmt.Errorf("opening log writer using %#v: %v", cl.writerOpener, err)
-	}
-
-	cl.buildCore()
-
-	return nil
-}
-
-func (cl *CustomLog) buildCore() {
-	// logs which only discard their output don't need
-	// to perform encoding or any other processing steps
-	// at all, so just shorcut to a nop core instead
-	if _, ok := cl.writerOpener.(*DiscardWriter); ok {
-		cl.core = zapcore.NewNopCore()
-		return
-	}
-	c := zapcore.NewCore(
-		cl.encoder,
-		zapcore.AddSync(cl.writer),
-		cl.levelEnabler,
-	)
-	if cl.Sampling != nil {
-		if cl.Sampling.Interval == 0 {
-			cl.Sampling.Interval = 1 * time.Second
-		}
-		if cl.Sampling.First == 0 {
-			cl.Sampling.First = 100
-		}
-		if cl.Sampling.Thereafter == 0 {
-			cl.Sampling.Thereafter = 100
-		}
-		c = zapcore.NewSampler(c, cl.Sampling.Interval,
-			cl.Sampling.First, cl.Sampling.Thereafter)
-	}
-	cl.core = c
-}
-
-func (cl *CustomLog) matchesModule(moduleID string) bool {
-	return cl.loggerAllowed(string(moduleID), true)
-}
-
-// loggerAllowed returns true if name is allowed to emit
-// to cl. isModule should be true if name is the name of
-// a module and you want to see if ANY of that module's
-// logs would be permitted.
-func (cl *CustomLog) loggerAllowed(name string, isModule bool) bool {
-	// accept all loggers by default
-	if len(cl.Include) == 0 && len(cl.Exclude) == 0 {
-		return true
-	}
-
-	// append a dot so that partial names don't match
-	// (i.e. we don't want "foo.b" to match "foo.bar"); we
-	// will also have to append a dot when we do HasPrefix
-	// below to compensate for when when namespaces are equal
-	if name != "" && name != "*" && name != "." {
-		name += "."
-	}
-
-	var longestAccept, longestReject int
-
-	if len(cl.Include) > 0 {
-		for _, namespace := range cl.Include {
-			var hasPrefix bool
-			if isModule {
-				hasPrefix = strings.HasPrefix(namespace+".", name)
-			} else {
-				hasPrefix = strings.HasPrefix(name, namespace+".")
-			}
-			if hasPrefix && len(namespace) > longestAccept {
-				longestAccept = len(namespace)
-			}
-		}
-		// the include list was populated, meaning that
-		// a match in this list is absolutely required
-		// if we are to accept the entry
-		if longestAccept == 0 {
-			return false
-		}
-	}
-
-	if len(cl.Exclude) > 0 {
-		for _, namespace := range cl.Exclude {
-			// * == all logs emitted by modules
-			// . == all logs emitted by core
-			if (namespace == "*" && name != ".") ||
-				(namespace == "." && name == ".") {
-				return false
-			}
-			if strings.HasPrefix(name, namespace+".") &&
-				len(namespace) > longestReject {
-				longestReject = len(namespace)
-			}
-		}
-		// the reject list is populated, so we have to
-		// reject this entry if its match is better
-		// than the best from the accept list
-		if longestReject > longestAccept {
-			return false
-		}
-	}
-
-	return (longestAccept > longestReject) ||
-		(len(cl.Include) == 0 && longestReject == 0)
-}
-
-// filteringCore filters log entries based on logger name,
-// according to the rules of a CustomLog.
-type filteringCore struct {
-	zapcore.Core
-	cl *CustomLog
-}
-
-// With properly wraps With.
-func (fc *filteringCore) With(fields []zapcore.Field) zapcore.Core {
-	return &filteringCore{
-		Core: fc.Core.With(fields),
-		cl:   fc.cl,
-	}
-}
-
-// Check only allows the log entry if its logger name
-// is allowed from the include/exclude rules of fc.cl.
-func (fc *filteringCore) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry {
-	if fc.cl.loggerAllowed(e.LoggerName, false) {
-		return fc.Core.Check(e, ce)
-	}
-	return ce
-}
-
-// LogSampling configures log entry sampling.
-type LogSampling struct {
-	// The window over which to conduct sampling.
-	Interval time.Duration `json:"interval,omitempty"`
-
-	// Log this many entries within a given level and
-	// message for each interval.
-	First int `json:"first,omitempty"`
-
-	// If more entries with the same level and message
-	// are seen during the same interval, keep one in
-	// this many entries until the end of the interval.
-	Thereafter int `json:"thereafter,omitempty"`
-}
-
-type (
-	// StdoutWriter writes logs to standard out.
-	StdoutWriter struct{}
-
-	// StderrWriter writes logs to standard error.
-	StderrWriter struct{}
-
-	// DiscardWriter discards all writes.
-	DiscardWriter struct{}
-)
-
-// CaddyModule returns the Caddy module information.
-func (StdoutWriter) CaddyModule() ModuleInfo {
-	return ModuleInfo{
-		ID:  "caddy.logging.writers.stdout",
-		New: func() Module { return new(StdoutWriter) },
-	}
-}
-
-// CaddyModule returns the Caddy module information.
-func (StderrWriter) CaddyModule() ModuleInfo {
-	return ModuleInfo{
-		ID:  "caddy.logging.writers.stderr",
-		New: func() Module { return new(StderrWriter) },
-	}
-}
-
-// CaddyModule returns the Caddy module information.
-func (DiscardWriter) CaddyModule() ModuleInfo {
-	return ModuleInfo{
-		ID:  "caddy.logging.writers.discard",
-		New: func() Module { return new(DiscardWriter) },
-	}
-}
-
-func (StdoutWriter) String() string  { return "stdout" }
-func (StderrWriter) String() string  { return "stderr" }
-func (DiscardWriter) String() string { return "discard" }
-
-// WriterKey returns a unique key representing stdout.
-func (StdoutWriter) WriterKey() string { return "std:out" }
-
-// WriterKey returns a unique key representing stderr.
-func (StderrWriter) WriterKey() string { return "std:err" }
-
-// WriterKey returns a unique key representing discard.
-func (DiscardWriter) WriterKey() string { return "discard" }
-
-// OpenWriter returns os.Stdout that can't be closed.
-func (StdoutWriter) OpenWriter() (io.WriteCloser, error) {
-	return notClosable{os.Stdout}, nil
-}
-
-// OpenWriter returns os.Stderr that can't be closed.
-func (StderrWriter) OpenWriter() (io.WriteCloser, error) {
-	return notClosable{os.Stderr}, nil
-}
-
-// OpenWriter returns ioutil.Discard that can't be closed.
-func (DiscardWriter) OpenWriter() (io.WriteCloser, error) {
-	return notClosable{ioutil.Discard}, nil
-}
-
-// notClosable is an io.WriteCloser that can't be closed.
-type notClosable struct{ io.Writer }
-
-func (fc notClosable) Close() error { return nil }
-
-type defaultCustomLog struct {
-	*CustomLog
-	logger *zap.Logger
-}
-
-// newDefaultProductionLog configures a custom log that is
-// intended for use by default if no other log is specified
-// in a config. It writes to stderr, uses the console encoder,
-// and enables INFO-level logs and higher.
-func newDefaultProductionLog() (*defaultCustomLog, error) {
-	cl := new(CustomLog)
-	cl.writerOpener = StderrWriter{}
-	var err error
-	cl.writer, err = cl.writerOpener.OpenWriter()
-	if err != nil {
-		return nil, err
-	}
-	cl.encoder = newDefaultProductionLogEncoder()
-	cl.levelEnabler = zapcore.InfoLevel
-
-	cl.buildCore()
-
-	return &defaultCustomLog{
-		CustomLog: cl,
-		logger:    zap.New(cl.core),
-	}, nil
-}
-
-func newDefaultProductionLogEncoder() zapcore.Encoder {
-	encCfg := zap.NewProductionEncoderConfig()
-	if terminal.IsTerminal(int(os.Stdout.Fd())) {
-		// if interactive terminal, make output more human-readable by default
-		encCfg.EncodeTime = func(ts time.Time, encoder zapcore.PrimitiveArrayEncoder) {
-			encoder.AppendString(ts.UTC().Format("2006/01/02 15:04:05.000"))
-		}
-		encCfg.EncodeLevel = zapcore.CapitalColorLevelEncoder
-		return zapcore.NewConsoleEncoder(encCfg)
-	}
-	return zapcore.NewJSONEncoder(encCfg)
-}
-
-// Log returns the current default logger.
-func Log() *zap.Logger {
-	defaultLoggerMu.RLock()
-	defer defaultLoggerMu.RUnlock()
-	return defaultLogger.logger
-}
-
-var (
-	defaultLogger, _ = newDefaultProductionLog()
-	defaultLoggerMu  sync.RWMutex
-)
-
-var writers = NewUsagePool()
-
-// Interface guards
-var (
-	_ io.WriteCloser = (*notClosable)(nil)
-	_ WriterOpener   = (*StdoutWriter)(nil)
-	_ WriterOpener   = (*StderrWriter)(nil)
-)

main.go

@@ -0,0 +1,175 @@
+package main
+
+import (
+	"bytes"
+	"flag"
+	"fmt"
+	"io/ioutil"
+	"log"
+	"os"
+	"os/exec"
+	"path"
+	"runtime"
+	"strconv"
+	"strings"
+
+	"github.com/mholt/caddy/app"
+	"github.com/mholt/caddy/config"
+	"github.com/mholt/caddy/server"
+)
+
+var (
+	conf    string
+	cpu     string
+	version bool
+)
+
+func init() {
+	flag.StringVar(&conf, "conf", "", "Configuration file to use (default="+config.DefaultConfigFile+")")
+	flag.BoolVar(&app.Http2, "http2", true, "Enable HTTP/2 support") // TODO: temporary flag until http2 merged into std lib
+	flag.BoolVar(&app.Quiet, "quiet", false, "Quiet mode (no initialization output)")
+	flag.StringVar(&cpu, "cpu", "100%", "CPU cap")
+	flag.StringVar(&config.Root, "root", config.DefaultRoot, "Root path to default site")
+	flag.StringVar(&config.Host, "host", config.DefaultHost, "Default host")
+	flag.StringVar(&config.Port, "port", config.DefaultPort, "Default port")
+	flag.BoolVar(&version, "version", false, "Show version")
+}
+
+func main() {
+	flag.Parse()
+
+	if version {
+		fmt.Printf("%s %s\n", app.Name, app.Version)
+		os.Exit(0)
+	}
+
+	// Set CPU cap
+	err := app.SetCPU(cpu)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Load config from file
+	allConfigs, err := loadConfigs()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Group by address (virtual hosts)
+	addresses, err := config.ArrangeBindings(allConfigs)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// Start each server with its one or more configurations
+	for addr, configs := range addresses {
+		s, err := server.New(addr.String(), configs, configs[0].TLS.Enabled)
+		if err != nil {
+			log.Fatal(err)
+		}
+		s.HTTP2 = app.Http2 // TODO: This setting is temporary
+		app.Wg.Add(1)
+		go func(s *server.Server) {
+			defer app.Wg.Done()
+			err := s.Serve()
+			if err != nil {
+				log.Fatal(err) // kill whole process to avoid a half-alive zombie server
+			}
+		}(s)
+
+		app.Servers = append(app.Servers, s)
+	}
+
+	// Show initialization output
+	if !app.Quiet {
+		var checkedFdLimit bool
+		for addr, configs := range addresses {
+			for _, conf := range configs {
+				// Print address of site
+				fmt.Println(conf.Address())
+
+				// Note if non-localhost site resolves to loopback interface
+				if addr.IP.IsLoopback() && !isLocalhost(conf.Host) {
+					fmt.Printf("Notice: %s is only accessible on this machine (%s)\n",
+						conf.Host, addr.IP.String())
+				}
+			}
+
+			if !checkedFdLimit && !addr.IP.IsLoopback() {
+				checkFdlimit()
+				checkedFdLimit = true
+			}
+		}
+	}
+
+	// Wait for all listeners to stop
+	app.Wg.Wait()
+}
+
+// checkFdlimit issues a warning if the OS max file descriptors is below a recommended minimum.
+func checkFdlimit() {
+	const min = 4096
+
+	// Warn if ulimit is too low for production sites
+	if runtime.GOOS == "linux" || runtime.GOOS == "darwin" {
+		out, err := exec.Command("sh", "-c", "ulimit -n").Output() // use sh because ulimit isn't in Linux $PATH
+		if err == nil {
+			// Note that an error here need not be reported
+			lim, err := strconv.Atoi(string(bytes.TrimSpace(out)))
+			if err == nil && lim < min {
+				fmt.Printf("Warning: File descriptor limit %d is too low for production sites.\nAt least %d is recommended. Set with \"ulimit -n %d\".\n", lim, min, min)
+			}
+		}
+	}
+}
+
+// isLocalhost returns true if the string looks explicitly like a localhost address.
+func isLocalhost(s string) bool {
+	return s == "localhost" || s == "::1" || strings.HasPrefix(s, "127.")
+}
+
+// loadConfigs loads configuration from a file or stdin (piped).
+// Configuration is obtained from one of three sources, tried
+// in this order: 1. -conf flag, 2. stdin, 3. Caddyfile.
+// If none of those are available, a default configuration is
+// loaded.
+func loadConfigs() ([]server.Config, error) {
+	// -conf flag
+	if conf != "" {
+		file, err := os.Open(conf)
+		if err != nil {
+			return []server.Config{}, err
+		}
+		defer file.Close()
+		return config.Load(path.Base(conf), file)
+	}
+
+	// stdin
+	fi, err := os.Stdin.Stat()
+	if err == nil && fi.Mode()&os.ModeCharDevice == 0 {
+		// Note that a non-nil error is not a problem. Windows
+		// will not create a stdin if there is no pipe, which
+		// produces an error when calling Stat(). But Unix will
+		// make one either way, which is why we also check that
+		// bitmask.
+		confBody, err := ioutil.ReadAll(os.Stdin)
+		if err != nil {
+			log.Fatal(err)
+		}
+		if len(confBody) > 0 {
+			return config.Load("stdin", bytes.NewReader(confBody))
+		}
+	}
+
+	// Caddyfile
+	file, err := os.Open(config.DefaultConfigFile)
+	if err != nil {
+		if os.IsNotExist(err) {
+			return []server.Config{config.Default()}, nil
+		}
+		return []server.Config{}, err
+	}
+	defer file.Close()
+
+	return config.Load(config.DefaultConfigFile, file)
+}