first set of corpuses

.github/CONTRIBUTING.md

@@ -1,184 +0,0 @@
-Contributing to Caddy
-=====================
-
-Welcome! Thank you for choosing to be a part of our community. Caddy wouldn't be great without your involvement!
-
-For starters, we invite you to join [the Caddy forum](https://caddy.community) where you can hang out with other Caddy users and developers.
-
-## Common Tasks
-
-- [Contributing code](#contributing-code)
-- [Writing a Caddy module](#writing-a-caddy-module)
-- [Asking or answering questions for help using Caddy](#getting-help-using-caddy)
-- [Reporting a bug](#reporting-bugs)
-- [Suggesting an enhancement or a new feature](#suggesting-features)
-- [Improving documentation](#improving-documentation)
-
-Other menu items:
-
-- [Values](#values)
-- [Coordinated Disclosure](#coordinated-disclosure)
-- [Thank You](#thank-you)
-
-
-### Contributing code
-
-You can have a huge impact on the project by helping with its code. To contribute code to Caddy, open a [pull request](https://github.com/caddyserver/caddy/pulls) (PR). If you're new to our community, that's okay: **we gladly welcome pull requests from anyone, regardless of your native language or coding experience.** You can get familiar with Caddy's code base by using [code search at Sourcegraph](https://sourcegraph.com/github.com/caddyserver/caddy/-/search).
-
-We hold contributions to a high standard for quality :bowtie:, so don't be surprised if we ask for revisions—even if it seems small or insignificant. Please don't take it personally. :blue_heart: If your change is on the right track, we can guide you to make it mergable.
-
-Here are some of the expectations we have of contributors:
-
-- **Open an issue to propose your change first.** This way we can avoid confusion, coordinate what everyone is working on, and ensure that any changes are in-line with the project's goals and the best interests of its users. We can also discuss the best possible implementation. If there's already an issue about it, comment on the existing issue to claim it.
-
-- **Keep pull requests small.** Smaller PRs are more likely to be merged because they are easier to review! We might ask you to break up large PRs into smaller ones. [An example of what we want to avoid.](https://twitter.com/iamdevloper/status/397664295875805184)
-
-- **Keep related commits together in a PR.** We do want pull requests to be small, but you should also keep multiple related commits in the same PR if they rely on each other.
-
-- **Write tests.** Tests are essential! Written properly, they ensure your change works, and that other changes in the future won't break your change. CI checks should pass.
-
-- **Benchmarks should be included for optimizations.** Optimizations sometimes make code harder to read or have changes that are less than obvious. They should be proven with benchmarks or profiling.
-
-- **[Squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) insignificant commits.** Every commit should be significant. Commits which merely rewrite a comment or fix a typo can be combined into another commit that has more substance. Interactive rebase can do this, or a simpler way is `git reset --soft <diverging-commit>` then `git commit -s`.
-
-- **Own your contributions.** Caddy is a growing project, and it's much better when individual contributors help maintain their change after it is merged.
-
-- **Use comments properly.** We expect good godoc comments for package-level functions, types, and values. Comments are also useful whenever the purpose for a line of code is not obvious.
-
-We often grant [collaborator status](#collaborator-instructions) to contributors who author one or more significant, high-quality PRs that are merged into the code base!
-
-
-#### HOW TO MAKE A PULL REQUEST TO CADDY
-
-Contributing to Go projects on GitHub is fun and easy. We recommend the following workflow:
-
-1. [Fork this repo](https://github.com/caddyserver/caddy). This makes a copy of the code you can write to.
-
-2. If you don't already have this repo (caddyserver/caddy.git) repo on your computer, get it with `go get github.com/caddyserver/caddy/v2`.
-
-3. Tell git that it can push the caddyserver/caddy.git repo to your fork by adding a remote: `git remote add myfork https://github.com/<your-username>/caddy.git`
-
-4. Make your changes in the caddyserver/caddy.git repo on your computer.
-
-5. Push your changes to your fork: `git push myfork`
-
-6. [Create a pull request](https://github.com/caddyserver/caddy/pull/new/master) to merge your changes into caddyserver/caddy @ master. (Click "compare across forks" and change the head fork.)
-
-This workflow is nice because you don't have to change import paths. You can get fancier by using different branches if you want.
-
-
-### Writing a Caddy module
-
-Caddy can do more with modules! Anyone can write one. Caddy modules are Go libraries that get compiled into Caddy, extending its feature set. They can add directives to the Caddyfile, add new configuration adapters, and even implement new server types (e.g. HTTP, DNS).
-
-[Learn how to write a module here](https://caddyserver.com/docs/extending-caddy). You should also share and discuss your module idea [on the forums](https://caddy.community) to have people test it out. We don't use the Caddy issue tracker for third-party modules.
-
-
-### Getting help using Caddy
-
-If you have a question about using Caddy, [ask on our forum](https://caddy.community)! There will be more people there who can help you than just the Caddy developers who follow our issue tracker. Issues are not the place for usage questions.
-
-Many people on the forums could benefit from your experience and expertise, too. Once you've been helped, consider giving back by answering other people's questions and participating in other discussions.
-
-
-### Reporting bugs
-
-Like every software, Caddy has its flaws. If you find one, [search the issues](https://github.com/caddyserver/caddy/issues) to see if it has already been reported. If not, [open a new issue](https://github.com/caddyserver/caddy/issues/new) and describe the bug, and somebody will look into it! (This repository is only for Caddy and its standard modules.)
-
-**You can help stop bugs in their tracks!** Speed up the patch by identifying the bug in the code. This can sometimes be done by adding `fmt.Println()` statements (or similar) in relevant code paths to narrow down where the problem may be. It's a good way to [introduce yourself to the Go language](https://tour.golang.org), too.
-
-Please follow the issue template so we have all the needed information. Unredacted&mdash;yes, actual values matter. We need to be able to repeat the bug using your instructions. Please simplify the issue as much as possible. The burden is on you to convince us that it is actually a bug in Caddy. This is easiest to do when you write clear, concise instructions so we can reproduce the behavior (even if it seems obvious). The more detailed and specific you are, the faster we will be able to help you!
-
-We suggest reading [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html).
-
-Please be kind. :smile: Remember that Caddy comes at no cost to you, and you're getting free support when we fix your issues. If we helped you, please consider helping someone else!
-
-#### Bug reporting expectations
-
-Maintainers---or more generally, developers---need three things to act on bugs:
-
-1. To agree or be convinced that it's a bug (reporter's responsibility).
-	- A bug is undesired or surprising behavior which violates documentation or the spec.
-
-2. To be able to understand what is happening (mostly reporter's responsibility).
-	- If the reporter can provide satisfactory instructions such that a developer can reproduce the bug, the developer will likely be able to understand the bug, write a test case, and implement a fix.
-	- Otherwise, the burden is on the reporter to test possible solutions. This is discouraged because it loosens the feedback loop, slows down debugging efforts, obscures the true nature of the problem from the developers, and is unlikely to result in new test cases.
-
-3. A solution, or ideas toward a solution (mostly maintainer's responsibility).
-	- Sometimes the best solution is a documentation change.
-	- Usually the developers have the best domain knowledge for inventing a solution, but reporters may have ideas or preferences for how they would like the software to work.
-	- Security, correctness, and project goals/vision all take priority over a user's preferences.
-	- It's simply good business to yield a solution that satisfies the users, and it's even better business to leave them impressed.
-
-Thus, at the very least, the reporter is expected to:
-
-1. Convince the reader that it's a bug (if it's not obvious).
-2. Reduce the problem down to the minimum specific steps required to reproduce it.
-
-The maintainer is usually able to do the rest; but of course the reporter may invest additional effort to speed up the process.
-
-
-
-### Suggesting features
-
-First, [search to see if your feature has already been requested](https://github.com/caddyserver/caddy/issues). If it has, you can add a :+1: reaction to vote for it. If your feature idea is new, open an issue to request the feature. Please describe your idea thoroughly so that we know how to implement it! Really vague requests may not be helpful or actionable and, without clarification, will have to be closed.
-
-While we really do value your requests and implement many of them, not all features are a good fit for Caddy. Most of those [make good modules](#writing-a-caddy-module), which can be made by anyone! But if a feature is not in the best interest of the Caddy project or its users in general, we may politely decline to implement it into Caddy core.
-
-
-### Improving documentation
-
-Caddy's documentation is available at [https://caddyserver.com/docs](https://caddyserver.com/docs) and its source is in the [website repo](https://github.com/caddyserver/website). If you would like to make a fix to the docs, please submit an issue there describing the change to make.
-
-Note that third-party module documentation is not hosted by the Caddy website, other than basic usage examples. They are managed by the individual module authors, and you will have to contact them to change their documentation.
-
-
-
-## Collaborator Instructions
-
-Collaborators have push rights to the repository. We grant this permission after one or more successful, high-quality PRs are merged! We thank them for their help.The expectations we have of collaborators are:
-
-- **Help review pull requests.** Be meticulous, but also kind. We love our contributors, but we critique the contribution to make it better. Multiple, thorough reviews make for the best contributions! Here are some questions to consider:
-	- Can the change be made more elegant?
-	- Is this a maintenance burden?
-	- What assumptions does the code make?
-	- Is it well-tested?
-	- Is the change a good fit for the project?
-	- Does it actually fix the problem or is it creating a special case instead?
-	- Does the change incur any new dependencies? (Avoid these!)
-
-- **Answer issues.** If every collaborator helped out with issues, we could count the number of open issues on two hands. This means getting involved in the discussion, investigating the code, and yes, debugging it. It's fun. Really! :smile: Please, please help with open issues. Granted, some issues need to be done before others. And of course some are larger than others: you don't have to do it all yourself. Work with other collaborators as a team!
-
-- **Do not merge pull requests until they have been approved by one or two other collaborators.** If a project owner approves the PR, it can be merged (as long as the conversation has finished too).
-
-- **Prefer squashed commits over a messy merge.** If there are many little commits, please [squash the commits](https://stackoverflow.com/a/11732910/1048862) so we don't clutter the commit history.
-
-- **Don't accept new dependencies lightly.** Dependencies can make the world crash and burn, but they are sometimes necessary. Choose carefully. Extremely small dependencies (a few lines of code) can be inlined. The rest may not be needed. For those that are, Caddy uses [go modules](https://github.com/golang/go/wiki/Modules). All external dependencies must be installed as modules, and _Caddy must not export any types defined by those dependencies_. Check this diligently!
-
-- **Be extra careful in some areas of the code.** There are some critical areas in the Caddy code base that we review extra meticulously: the `caddyhttp` and `caddytls` packages especially.
-
-- **Make sure tests test the actual thing.** Double-check that the tests fail without the change, and pass with it. It's important that they assert what they're purported to assert.
-
-- **Recommended reading**
-	- [CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) for an idea of what we look for in good, clean Go code
-	- [Linus Torvalds describes a good commit message](https://gist.github.com/matthewhudson/1475276)
-	- [Best Practices for Maintainers](https://opensource.guide/best-practices/)
-	- [Shrinking Code Review](https://alexgaynor.net/2015/dec/29/shrinking-code-review/)
-
-
-
-## Values
-
-- A person is always more important than code. People don't like being handled "efficiently". But we can still process issues and pull requests efficiently while being kind, patient, and considerate.
-
-- The ends justify the means, if the means are good. A good tree won't produce bad fruit. But if we cut corners or are hasty in our process, the end result will not be good.
-
-
-## Security Policy
-
-If you think you've found a security vulnerability, please refer to our [Security Policy](https://github.com/caddyserver/caddy/security/policy) document.
-
-
-## Thank you
-
-Thanks for your help! Caddy would not be what it is today without your contributions.

.github/FUNDING.yml

@@ -1,12 +0,0 @@
-# These are supported funding model platforms
-
-github: [mholt] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-otechie: # Replace with a single Otechie username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/SECURITY.md

@@ -1,27 +0,0 @@
-# Security Policy
-
-The Caddy project would like to make sure that it stays on top of all practically-exploitable vulnerabilities.
-
-Some security problems are more the result of interplay between different components of the Web, rather than a vulnerability in the web server itself. Please report only vulnerabilities in the web server itself, as we cannot coerce the rest of the Web to be fixed (for example, we do not consider IP spoofing or BGP hijacks a vulnerability in the Caddy web server).
-
-Please note that we consider publicly-registered domain names to be public information. This necessary in order to maintain the integrity of certificate transparency, public DNS, and other public trust systems.
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 2.x     | :white_check_mark: |
-| 1.x     | :white_check_mark: (deprecating soon) |
-| < 1.x   | :x:                |
-
-## Reporting a Vulnerability
-
-Please email Matt Holt (the author) directly: matt [at] lightcodelabs [dot com].
-
-We'll need enough information to verify the bug and make a patch. It will speed things up if you suggest a working patch, such as a code diff, and explain why and how it works. Reports that are not actionable, do not contain enough information, are too pushy/demanding, or are not able to convince us that it is a viable and practical attack on the web server itself may be deferred to a later time or possibly ignored, resources permitting. Priority will be given to credible, responsible reports that are constructive, specific, and actionable. Thank you for understanding.
-
-Please also understand that due to our nature as an open source project, we do not have a budget to award security bounties. We can only thank you.
-
-If your report is valid and a patch is released, we will not reveal your identity by default. If you wish to be credited, please give us the name to use.
-
-Thanks for responsibly helping Caddy&mdash;and thousands of websites&mdash;be more secure!

.github/workflows/ci.yml

@@ -1,174 +0,0 @@
-# Used as inspiration: https://github.com/mvdan/github-actions-golang
-
-name: Cross-Platform
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-
-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)"
-        echo "::set-output name=go_cache::$(go env GOCACHE)"
-
-    - name: Cache the build cache
-      uses: actions/cache@v1
-      with:
-        path: ${{ steps.vars.outputs.go_cache }}
-        key: ${{ runner.os }}-go-ci-${{ hashFiles('**/go.sum') }}
-        restore-keys: |
-          ${{ runner.os }}-go-ci
-
-    - 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 -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" -short -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
-
-  s390x-test:
-    name: test (s390x on IBM Z)
-    runs-on: ubuntu-latest
-    if: github.event.pull_request.head.repo.full_name == github.repository
-    steps:
-      - name: Checkout code into the Go module directory
-        uses: actions/checkout@v2
-      - name: Run Tests
-        run: |
-          mkdir -p ~/.ssh && echo -e "${SSH_KEY//_/\\n}" > ~/.ssh/id_ecdsa && chmod og-rwx ~/.ssh/id_ecdsa
-
-          # short sha is enough?
-          short_sha=$(git rev-parse --short HEAD)
-
-          # The environment is fresh, so there's no point in keeping accepting and adding the key.
-          rsync -arz -e "ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null" --progress --delete --exclude '.git' . caddy-ci@ci-s390x.caddyserver.com:/var/tmp/"$short_sha"
-          ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -t caddy-ci@ci-s390x.caddyserver.com "cd /var/tmp/$short_sha; CGO_ENABLED=0 /usr/local/go/bin/go test -v ./..."
-          test_result=$?
-
-          # There's no need leaving the files around
-          ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null caddy-ci@ci-s390x.caddyserver.com "rm -rf /var/tmp/'$short_sha'"
-
-          echo "Test exit code: $test_result"
-          exit $test_result
-        env:
-          SSH_KEY: ${{ secrets.S390X_SSH_KEY }}
-
-  # 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 }}
-
-  goreleaser-check:
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout
-        uses: actions/checkout@v2
-      - uses: goreleaser/goreleaser-action@v1
-        with:
-          version: latest
-          args: check
-        env:
-          TAG: ${{ steps.vars.outputs.version_tag }}

.github/workflows/fuzzing.yml

@@ -1,73 +0,0 @@
-name: Fuzzing
-
-on:
-  # 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: |
-
-        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 }}
-        SYSTEM_PULLREQUEST_SOURCEBRANCH: ${{ github.ref }}
-        BUILD_SOURCEVERSION: ${{ github.sha }}
-      run: |
-        # debug
-        echo "PR Source Branch: $SYSTEM_PULLREQUEST_SOURCEBRANCH"
-        echo "Source version: $BUILD_SOURCEVERSION"
-
-        declare -A fuzzers_funcs=(\
-          ["./caddyconfig/httpcaddyfile/addresses_fuzz.go"]="FuzzParseAddress" \
-          ["./listeners_fuzz.go"]="FuzzParseNetworkAddress" \
-          ["./replacer_fuzz.go"]="FuzzReplacer" \
-        )
-
-        declare -A fuzzers_targets=(\
-          ["./caddyconfig/httpcaddyfile/addresses_fuzz.go"]="parse-address" \
-          ["./listeners_fuzz.go"]="parse-network-address" \
-          ["./replacer_fuzz.go"]="replacer" \
-        )
-
-        fuzz_type="fuzzing"
-
-        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]}" -o "$FUZZER_DIRECTORY/${fuzzers_targets[$f]}.zip" "$FUZZER_DIRECTORY"
-          
-          fuzzit create job --engine go-fuzz caddyserver/"${fuzzers_targets[$f]}" "$FUZZER_DIRECTORY"/"${fuzzers_targets[$f]}.zip" --api-key "${FUZZIT_API_KEY}" --type "${fuzz_type}" --branch "${SYSTEM_PULLREQUEST_SOURCEBRANCH}" --revision "${BUILD_SOURCEVERSION}"
-          
-          echo "Completed $f"
-        done

.github/workflows/release.yml

@@ -1,83 +0,0 @@
-name: Release
-
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-
-jobs:
-  release:
-    name: Release
-    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
-
-    # So GoReleaser can generate the changelog properly
-    - name: Unshallowify the repo clone
-      run: git fetch --prune --unshallow
-
-    # https://github.community/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027
-    - 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
-        echo "::set-output name=version_tag::${GITHUB_REF/refs\/tags\//}"
-        echo "::set-output name=short_sha::$(git rev-parse --short HEAD)"
-        echo "::set-output name=go_cache::$(go env GOCACHE)"
-
-        # Parse semver
-        TAG=${GITHUB_REF/refs\/tags\//}
-        SEMVER_RE='[^0-9]*\([0-9]*\)[.]\([0-9]*\)[.]\([0-9]*\)\([0-9A-Za-z\.-]*\)'
-        TAG_MAJOR=`echo ${TAG#v} | sed -e "s#$SEMVER_RE#\1#"`
-        TAG_MINOR=`echo ${TAG#v} | sed -e "s#$SEMVER_RE#\2#"`
-        TAG_PATCH=`echo ${TAG#v} | sed -e "s#$SEMVER_RE#\3#"`
-        TAG_SPECIAL=`echo ${TAG#v} | sed -e "s#$SEMVER_RE#\4#"`
-        echo "::set-output name=tag_major::${TAG_MAJOR}"
-        echo "::set-output name=tag_minor::${TAG_MINOR}"
-        echo "::set-output name=tag_patch::${TAG_PATCH}"
-        echo "::set-output name=tag_special::${TAG_SPECIAL}"
-
-    - name: Cache the build cache
-      uses: actions/cache@v1
-      with:
-        path: ${{ steps.vars.outputs.go_cache }}
-        key: ${{ runner.os }}-go-release-${{ hashFiles('**/go.sum') }}
-        restore-keys: |
-          ${{ runner.os }}-go-release
-
-    # GoReleaser will take care of publishing those artifacts into the release
-    - name: Run GoReleaser
-      uses: goreleaser/goreleaser-action@v1
-      with:
-        version: latest
-        args: release --rm-dist
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        TAG: ${{ steps.vars.outputs.version_tag }}
-
-    # Only publish on non-special tags (e.g. non-beta)
-    - name: Publish .deb to Gemfury
-      if: ${{ steps.vars.outputs.tag_special == '' }}
-      env:
-        GEMFURY_PUSH_TOKEN: ${{ secrets.GEMFURY_PUSH_TOKEN }}
-      run: |
-        for filename in dist/*.deb; do
-          curl -F package=@"$filename" https://${GEMFURY_PUSH_TOKEN}:@push.fury.io/caddy/
-        done
-

.github/workflows/release_published.yml

@@ -1,34 +0,0 @@
-name: Release Published
-
-# Event payload: https://developer.github.com/webhooks/event-payloads/#release
-on:
-  release:
-    types: [published]
-
-jobs:
-  release:
-    name: Release Published
-    strategy:
-      matrix:
-        os: [ ubuntu-latest ]
-    runs-on: ${{ matrix.os }}
-
-    steps:
-
-    # See https://github.com/peter-evans/repository-dispatch
-    - name: Trigger event on caddyserver/dist
-      uses: peter-evans/repository-dispatch@v1
-      with:
-        token: ${{ secrets.REPO_DISPATCH_TOKEN }}
-        repository: caddyserver/dist
-        event-type: release-tagged
-        client-payload: '{"tag": "${{ github.release.tag_name }}"}'
-
-    - name: Trigger event on caddyserver/caddy-docker
-      uses: peter-evans/repository-dispatch@v1
-      with:
-        token: ${{ secrets.REPO_DISPATCH_TOKEN }}
-        repository: caddyserver/caddy-docker
-        event-type: release-tagged
-        client-payload: '{"tag": "${{ github.release.tag_name }}"}'
-

.gitignore

@@ -1,23 +0,0 @@
-_gitignore/
-*.log
-Caddyfile
-!caddyfile/
-
-# artifacts from pprof tooling
-*.prof
-*.test
-
-# build artifacts
-cmd/caddy/caddy
-cmd/caddy/caddy.exe
-
-# mac specific
-.DS_Store
-
-# go modules
-vendor
-
-# goreleaser artifacts
-dist
-caddy-build
-caddy-dist

.golangci.yml

@@ -1,51 +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
-    - prealloc
-    - unconvert
-    - 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

.goreleaser.yml

@@ -1,116 +0,0 @@
-before:
-  hooks:
-    # The build is done in this particular way to build Caddy in a designated directory named in .gitignore.
-    # This is so we can run goreleaser on tag without Git complaining of being dirty. The main.go in cmd/caddy directory 
-    # cannot be built within that directory due to changes necessary for the build causing Git to be dirty, which
-    # subsequently causes gorleaser to refuse running.
-    - mkdir -p caddy-build
-    - cp cmd/caddy/main.go caddy-build/main.go
-    - cp ./go.mod caddy-build/go.mod
-    - sed -i.bkp 's|github.com/caddyserver/caddy/v2|caddy|g' ./caddy-build/go.mod
-    # GoReleaser doesn't seem to offer {{.Tag}} at this stage, so we have to embed it into the env
-    # so we run: TAG=$(git describe --abbrev=0) goreleaser release --rm-dist --skip-publish --skip-validate
-    - go mod edit -require=github.com/caddyserver/caddy/v2@{{.Env.TAG}} ./caddy-build/go.mod
-    - git clone --depth 1 https://github.com/caddyserver/dist caddy-dist
-    - go mod download
-
-builds:
-- env:
-  - CGO_ENABLED=0
-  - GO111MODULE=on
-  main: main.go
-  dir: ./caddy-build
-  binary: caddy
-  goos:
-  - darwin
-  - linux
-  - windows
-  - freebsd
-  goarch:
-  - amd64
-  - arm
-  - arm64
-  - s390x
-  - ppc64le
-  goarm:
-  - 5
-  - 6
-  - 7
-  ignore:
-    - goos: darwin
-      goarch: arm
-    - goos: darwin
-      goarch: ppc64le
-    - goos: darwin
-      goarch: s390x
-    - goos: windows
-      goarch: ppc64le
-    - goos: windows
-      goarch: s390x
-    - goos: freebsd
-      goarch: ppc64le
-    - goos: freebsd
-      goarch: s390x
-    - goos: freebsd
-      goarch: arm
-      goarm: 5
-  flags:
-  - -trimpath
-  ldflags:
-  - -s -w
-
-archives:
-  - format_overrides:
-      - goos: windows
-        format: zip
-    replacements:
-      darwin: mac
-checksum:
-  algorithm: sha512
-
-nfpms:
-  - id: default
-    package_name: caddy
-
-    vendor: Light Code Labs
-    homepage: https://caddyserver.com
-    maintainer: Matthew Holt <mholt@users.noreply.github.com>
-    description: |
-      Powerful, enterprise-ready, open source web server with automatic HTTPS written in Go
-    license: Apache 2.0
-
-    formats:
-      - deb
-      # - rpm
-
-    bindir: /usr/bin
-    files:
-      ./caddy-dist/init/caddy.service: /lib/systemd/system/caddy.service
-      ./caddy-dist/init/caddy-api.service: /lib/systemd/system/caddy-api.service
-      ./caddy-dist/welcome/index.html: /usr/share/caddy/index.html
-      ./caddy-dist/scripts/completions/bash-completion: /etc/bash_completion.d/caddy
-    config_files:
-      ./caddy-dist/config/Caddyfile: /etc/caddy/Caddyfile
-
-    scripts:
-      postinstall: ./caddy-dist/scripts/postinstall.sh
-      preremove: ./caddy-dist/scripts/preremove.sh
-      postremove: ./caddy-dist/scripts/postremove.sh
-
-
-release:
-  github:
-    owner: caddyserver
-    name: caddy
-  draft: true
-  prerelease: auto
-
-changelog:
-  sort: asc
-  filters:
-    exclude:
-    - '^chore:'
-    - '^ci:'
-    - '^docs?:'
-    - '^tests?:'
-    - '^\w+\s+' # a hack to remove commit messages without colons thus don't correspond to a package

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>

LICENSE

@@ -1,202 +0,0 @@
-
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   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 "[]"
-      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
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   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.
-   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.

README.md

@@ -1,152 +0,0 @@
-<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"></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
-
-- [Features](#features)
-- [Build from source](#build-from-source)
-	- [For development](#for-development)
-	- [With version information and/or plugins](#with-version-information-andor-plugins)
-- [Quick start](#quick-start)
-- [Overview](#overview)
-- [Full documentation](#full-documentation)
-- [Getting help](#getting-help)
-- [About](#about)
-
-<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>
-
-
-## Features
-
-- **Easy configuration** with the [Caddyfile](https://caddyserver.com/docs/caddyfile)
-- **Powerful configuration** with its [native JSON config](https://caddyserver.com/docs/json/)
-- **Dynamic configuration** with the [JSON API](https://caddyserver.com/docs/api)
-- [**Config adapters**](https://caddyserver.com/docs/config-adapters) if you don't like JSON
-- **Automatic HTTPS** by default
-	- [Let's Encrypt](https://letsencrypt.org) for public sites
-	- Fully-managed local CA for internal names & IPs
-	- Can coordinate with other Caddy instances in a cluster
-- **Stays up when other servers go down** due to TLS/OCSP/certificate-related issues
-- **HTTP/1.1, HTTP/2, and experimental HTTP/3** support
-- **Highly extensible** [modular architecture](https://caddyserver.com/docs/architecture) lets Caddy do anything without bloat
-- **Runs anywhere** with **no external dependencies** (not even libc)
-- Written in Go, a language with higher **memory safety guarantees** than other servers
-- Actually **fun to use**
-- So, so much more to discover
-
-
-
-## Build from source
-
-Requirements:
-
-- [Go 1.14 or newer](https://golang.org/dl/)
-
-### For development
- 
-```bash
-$ git clone "https://github.com/caddyserver/caddy.git"
-$ cd caddy/cmd/caddy/
-$ go build
-```
-
-_**Note:** These steps [will not embed proper version information](https://github.com/golang/go/issues/29228). For that, please follow the instructions below._
-
-### With version information and/or plugins
-
-Using [our builder tool](https://github.com/caddyserver/xcaddy)...
-
-```
-$ xcaddy build
-```
-
-...the following steps are automated:
-
-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/master/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. (Optional) Pin Caddy version: `go get github.com/caddyserver/caddy/v2@TAG` replacing `TAG` with a git tag or commit.
-6. (Optional) Add plugins by adding their import: `_ "IMPORT_PATH"`
-7. Compile: `go build`
-
-
-
-
-## 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.**
-
-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. 🙂
-
-
-
-
-## Overview
-
-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.
-
-
-## 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](https://github.com/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)_

admin.go

@@ -1,838 +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"
-	"io/ioutil"
-	"net"
-	"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/hosts for API requests. Only needed
-	// if accessing the admin endpoint from a host different from the
-	// socket's network interface or 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() (NetworkAddress, error) {
-	input := admin.Listen
-	if input == "" {
-		input = DefaultAdminListen
-	}
-	listenAddr, err := ParseNetworkAddress(input)
-	if err != nil {
-		return NetworkAddress{}, fmt.Errorf("parsing admin listener address: %v", err)
-	}
-	if listenAddr.PortRangeSize() != 1 {
-		return NetworkAddress{}, fmt.Errorf("admin endpoint must have exactly one address; cannot listen on %v", listenAddr)
-	}
-	return listenAddr, 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(addr NetworkAddress) adminHandler {
-	muxWrap := adminHandler{
-		enforceOrigin:  admin.EnforceOrigin,
-		enforceHost:    !addr.isWildcardInterface(),
-		allowedOrigins: admin.allowedOrigins(addr),
-		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 for non-unix-socket endpoints, but whatever.
-func (admin AdminConfig) allowedOrigins(addr NetworkAddress) []string {
-	uniqueOrigins := make(map[string]struct{})
-	for _, o := range admin.Origins {
-		uniqueOrigins[o] = struct{}{}
-	}
-	if admin.Origins == nil {
-		if addr.isLoopback() {
-			if addr.IsUnixNetwork() {
-				// RFC 2616, Section 14.26:
-				// "A client MUST include a Host header field in all HTTP/1.1 request
-				// messages. If the requested URI does not include an Internet host
-				// name for the service being requested, then the Host header field MUST
-				// be given with an empty value."
-				uniqueOrigins[""] = struct{}{}
-			} else {
-				uniqueOrigins[net.JoinHostPort("localhost", addr.port())] = struct{}{}
-				uniqueOrigins[net.JoinHostPort("::1", addr.port())] = struct{}{}
-				uniqueOrigins[net.JoinHostPort("127.0.0.1", addr.port())] = struct{}{}
-			}
-		}
-		if !addr.IsUnixNetwork() {
-			uniqueOrigins[addr.JoinHostPort(0)] = struct{}{}
-		}
-	}
-	allowed := make([]string, 0, len(uniqueOrigins))
-	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
-	addr, err := adminConfig.listenAddr()
-	if err != nil {
-		return err
-	}
-
-	handler := adminConfig.newAdminHandler(addr)
-
-	ln, err := Listen(addr.Network, addr.JoinHostPort(0))
-	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.String()),
-		zap.Bool("enforce_origin", adminConfig.EnforceOrigin),
-		zap.Strings("origins", handler.allowedOrigins))
-
-	if !handler.enforceHost {
-		Log().Named("admin").Warn("admin endpoint on open interface; host checking disabled",
-			zap.String("address", addr.String()))
-	}
-
-	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
-	enforceHost    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("host", r.Host),
-		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 strings.Contains(r.Header.Get("Upgrade"), "websocket") {
-		// I've never been able demonstrate a vulnerability myself, but apparently
-		// WebSocket connections originating from browsers aren't subject to CORS
-		// restrictions, so we'll just be on the safe side
-		h.handleError(w, r, fmt.Errorf("websocket connections aren't allowed"))
-		return
-	}
-
-	if h.enforceHost {
-		// DNS rebinding mitigation
-		err := h.checkHost(r)
-		if err != nil {
-			h.handleError(w, r, err)
-			return
-		}
-	}
-
-	if h.enforceOrigin {
-		// 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))
-	}
-	if adminServer != nil {
-		// use goroutine so that we can finish responding to API request
-		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"),
-		}
-	}
-	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,
-	}
-)
-
-// PIDFile writes a pidfile to the file at filename. It
-// will get deleted before the process gracefully exits.
-func PIDFile(filename string) error {
-	pid := []byte(strconv.Itoa(os.Getpid()) + "\n")
-	err := ioutil.WriteFile(filename, pid, 0644)
-	if err != nil {
-		return err
-	}
-	pidfile = filename
-	return nil
-}
-
-// 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*:\s*(-?[0-9]+(\.[0-9]+)?|(?U)".*")\s*,?`)
-
-// pidfile is the name of the pidfile, if any.
-var pidfile string
-
-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)
-	}
-}

caddy.go

@@ -1,601 +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 = DefaultStorage
-		}
-		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()
-	if pidfile != "" {
-		os.Remove(pidfile)
-	}
-	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`, `h`, and `d`.
-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 = ParseDuration(strings.Trim(string(b), `"`))
-	} else {
-		err = json.Unmarshal(b, &dur)
-	}
-	*d = Duration(dur)
-	return err
-}
-
-// ParseDuration parses a duration string, adding
-// support for the "d" unit meaning number of days,
-// where a day is assumed to be 24h.
-func ParseDuration(s string) (time.Duration, error) {
-	var inNumber bool
-	var numStart int
-	for i := 0; i < len(s); i++ {
-		ch := s[i]
-		if ch == 'd' {
-			daysStr := s[numStart:i]
-			days, err := strconv.ParseFloat(daysStr, 64)
-			if err != nil {
-				return 0, err
-			}
-			hours := days * 24.0
-			hoursStr := strconv.FormatFloat(hours, 'f', -1, 64)
-			s = s[:numStart] + hoursStr + "h" + s[i+1:]
-			i--
-			continue
-		}
-		if !inNumber {
-			numStart = i
-		}
-		inNumber = (ch >= '0' && ch <= '9') || ch == '.' || ch == '-' || ch == '+'
-	}
-	return time.ParseDuration(s)
-}
-
-// 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"

caddy_test.go

@@ -1,74 +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 (
-	"testing"
-	"time"
-)
-
-func TestParseDuration(t *testing.T) {
-	const day = 24 * time.Hour
-	for i, tc := range []struct {
-		input  string
-		expect time.Duration
-	}{
-		{
-			input:  "3h",
-			expect: 3 * time.Hour,
-		},
-		{
-			input:  "1d",
-			expect: day,
-		},
-		{
-			input:  "1d30m",
-			expect: day + 30*time.Minute,
-		},
-		{
-			input:  "1m2d",
-			expect: time.Minute + day*2,
-		},
-		{
-			input:  "1m2d30s",
-			expect: time.Minute + day*2 + 30*time.Second,
-		},
-		{
-			input:  "1d2d",
-			expect: 3 * day,
-		},
-		{
-			input:  "1.5d",
-			expect: time.Duration(1.5 * float64(day)),
-		},
-		{
-			input:  "4m1.25d",
-			expect: 4*time.Minute + time.Duration(1.25*float64(day)),
-		},
-		{
-			input:  "-1.25d12h",
-			expect: time.Duration(-1.25*float64(day)) - 12*time.Hour,
-		},
-	} {
-		actual, err := ParseDuration(tc.input)
-		if err != nil {
-			t.Errorf("Test %d ('%s'): Got error: %v", i, tc.input, err)
-			continue
-		}
-		if actual != tc.expect {
-			t.Errorf("Test %d ('%s'): Expected=%s Actual=%s", i, tc.input, tc.expect, actual)
-		}
-	}
-}

caddyconfig/caddyfile/adapter.go

@@ -1,91 +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.
-// Implementations must be able to support
-// multiple segments (instances of their
-// directive or batch of tokens); typically
-// this means wrapping all token logic in
-// a loop: `for d.Next() { ... }`.
-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,396 +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"
-	"io"
-	"log"
-	"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,
-	}
-}
-
-// NewTestDispenser parses input into tokens and creates a new
-// Dispenser for test purposes only; any errors are fatal.
-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)
-}
-
-// 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/dispenser_test.go

@@ -1,306 +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 (
-	"reflect"
-	"strings"
-	"testing"
-)
-
-func TestDispenser_Val_Next(t *testing.T) {
-	input := `host:port
-			  dir1 arg1
-			  dir2 arg2 arg3
-			  dir3`
-	d := NewTestDispenser(input)
-
-	if val := d.Val(); val != "" {
-		t.Fatalf("Val(): Should return empty string when no token loaded; got '%s'", val)
-	}
-
-	assertNext := func(shouldLoad bool, expectedCursor int, expectedVal string) {
-		if loaded := d.Next(); loaded != shouldLoad {
-			t.Errorf("Next(): Expected %v but got %v instead (val '%s')", shouldLoad, loaded, d.Val())
-		}
-		if d.cursor != expectedCursor {
-			t.Errorf("Expected cursor to be %d, but was %d", expectedCursor, d.cursor)
-		}
-		if d.nesting != 0 {
-			t.Errorf("Nesting should be 0, was %d instead", d.nesting)
-		}
-		if val := d.Val(); val != expectedVal {
-			t.Errorf("Val(): Expected '%s' but got '%s'", expectedVal, val)
-		}
-	}
-
-	assertNext(true, 0, "host:port")
-	assertNext(true, 1, "dir1")
-	assertNext(true, 2, "arg1")
-	assertNext(true, 3, "dir2")
-	assertNext(true, 4, "arg2")
-	assertNext(true, 5, "arg3")
-	assertNext(true, 6, "dir3")
-	// Note: This next test simply asserts existing behavior.
-	// If desired, we may wish to empty the token value after
-	// reading past the EOF. Open an issue if you want this change.
-	assertNext(false, 6, "dir3")
-}
-
-func TestDispenser_NextArg(t *testing.T) {
-	input := `dir1 arg1
-			  dir2 arg2 arg3
-			  dir3`
-	d := NewTestDispenser(input)
-
-	assertNext := func(shouldLoad bool, expectedVal string, expectedCursor int) {
-		if d.Next() != shouldLoad {
-			t.Errorf("Next(): Should load token but got false instead (val: '%s')", d.Val())
-		}
-		if d.cursor != expectedCursor {
-			t.Errorf("Next(): Expected cursor to be at %d, but it was %d", expectedCursor, d.cursor)
-		}
-		if val := d.Val(); val != expectedVal {
-			t.Errorf("Val(): Expected '%s' but got '%s'", expectedVal, val)
-		}
-	}
-
-	assertNextArg := func(expectedVal string, loadAnother bool, expectedCursor int) {
-		if !d.NextArg() {
-			t.Error("NextArg(): Should load next argument but got false instead")
-		}
-		if d.cursor != expectedCursor {
-			t.Errorf("NextArg(): Expected cursor to be at %d, but it was %d", expectedCursor, d.cursor)
-		}
-		if val := d.Val(); val != expectedVal {
-			t.Errorf("Val(): Expected '%s' but got '%s'", expectedVal, val)
-		}
-		if !loadAnother {
-			if d.NextArg() {
-				t.Fatalf("NextArg(): Should NOT load another argument, but got true instead (val: '%s')", d.Val())
-			}
-			if d.cursor != expectedCursor {
-				t.Errorf("NextArg(): Expected cursor to remain at %d, but it was %d", expectedCursor, d.cursor)
-			}
-		}
-	}
-
-	assertNext(true, "dir1", 0)
-	assertNextArg("arg1", false, 1)
-	assertNext(true, "dir2", 2)
-	assertNextArg("arg2", true, 3)
-	assertNextArg("arg3", false, 4)
-	assertNext(true, "dir3", 5)
-	assertNext(false, "dir3", 5)
-}
-
-func TestDispenser_NextLine(t *testing.T) {
-	input := `host:port
-			  dir1 arg1
-			  dir2 arg2 arg3`
-	d := NewTestDispenser(input)
-
-	assertNextLine := func(shouldLoad bool, expectedVal string, expectedCursor int) {
-		if d.NextLine() != shouldLoad {
-			t.Errorf("NextLine(): Should load token but got false instead (val: '%s')", d.Val())
-		}
-		if d.cursor != expectedCursor {
-			t.Errorf("NextLine(): Expected cursor to be %d, instead was %d", expectedCursor, d.cursor)
-		}
-		if val := d.Val(); val != expectedVal {
-			t.Errorf("Val(): Expected '%s' but got '%s'", expectedVal, val)
-		}
-	}
-
-	assertNextLine(true, "host:port", 0)
-	assertNextLine(true, "dir1", 1)
-	assertNextLine(false, "dir1", 1)
-	d.Next() // arg1
-	assertNextLine(true, "dir2", 3)
-	assertNextLine(false, "dir2", 3)
-	d.Next() // arg2
-	assertNextLine(false, "arg2", 4)
-	d.Next() // arg3
-	assertNextLine(false, "arg3", 5)
-}
-
-func TestDispenser_NextBlock(t *testing.T) {
-	input := `foobar1 {
-			  	sub1 arg1
-			  	sub2
-			  }
-			  foobar2 {
-			  }`
-	d := NewTestDispenser(input)
-
-	assertNextBlock := func(shouldLoad bool, expectedCursor, expectedNesting int) {
-		if loaded := d.NextBlock(0); loaded != shouldLoad {
-			t.Errorf("NextBlock(): Should return %v but got %v", shouldLoad, loaded)
-		}
-		if d.cursor != expectedCursor {
-			t.Errorf("NextBlock(): Expected cursor to be %d, was %d", expectedCursor, d.cursor)
-		}
-		if d.nesting != expectedNesting {
-			t.Errorf("NextBlock(): Nesting should be %d, not %d", expectedNesting, d.nesting)
-		}
-	}
-
-	assertNextBlock(false, -1, 0)
-	d.Next() // foobar1
-	assertNextBlock(true, 2, 1)
-	assertNextBlock(true, 3, 1)
-	assertNextBlock(true, 4, 1)
-	assertNextBlock(false, 5, 0)
-	d.Next()                     // foobar2
-	assertNextBlock(false, 8, 0) // empty block is as if it didn't exist
-}
-
-func TestDispenser_Args(t *testing.T) {
-	var s1, s2, s3 string
-	input := `dir1 arg1 arg2 arg3
-			  dir2 arg4 arg5
-			  dir3 arg6 arg7
-			  dir4`
-	d := NewTestDispenser(input)
-
-	d.Next() // dir1
-
-	// As many strings as arguments
-	if all := d.Args(&s1, &s2, &s3); !all {
-		t.Error("Args(): Expected true, got false")
-	}
-	if s1 != "arg1" {
-		t.Errorf("Args(): Expected s1 to be 'arg1', got '%s'", s1)
-	}
-	if s2 != "arg2" {
-		t.Errorf("Args(): Expected s2 to be 'arg2', got '%s'", s2)
-	}
-	if s3 != "arg3" {
-		t.Errorf("Args(): Expected s3 to be 'arg3', got '%s'", s3)
-	}
-
-	d.Next() // dir2
-
-	// More strings than arguments
-	if all := d.Args(&s1, &s2, &s3); all {
-		t.Error("Args(): Expected false, got true")
-	}
-	if s1 != "arg4" {
-		t.Errorf("Args(): Expected s1 to be 'arg4', got '%s'", s1)
-	}
-	if s2 != "arg5" {
-		t.Errorf("Args(): Expected s2 to be 'arg5', got '%s'", s2)
-	}
-	if s3 != "arg3" {
-		t.Errorf("Args(): Expected s3 to be unchanged ('arg3'), instead got '%s'", s3)
-	}
-
-	// (quick cursor check just for kicks and giggles)
-	if d.cursor != 6 {
-		t.Errorf("Cursor should be 6, but is %d", d.cursor)
-	}
-
-	d.Next() // dir3
-
-	// More arguments than strings
-	if all := d.Args(&s1); !all {
-		t.Error("Args(): Expected true, got false")
-	}
-	if s1 != "arg6" {
-		t.Errorf("Args(): Expected s1 to be 'arg6', got '%s'", s1)
-	}
-
-	d.Next() // dir4
-
-	// No arguments or strings
-	if all := d.Args(); !all {
-		t.Error("Args(): Expected true, got false")
-	}
-
-	// No arguments but at least one string
-	if all := d.Args(&s1); all {
-		t.Error("Args(): Expected false, got true")
-	}
-}
-
-func TestDispenser_RemainingArgs(t *testing.T) {
-	input := `dir1 arg1 arg2 arg3
-			  dir2 arg4 arg5
-			  dir3 arg6 { arg7
-			  dir4`
-	d := NewTestDispenser(input)
-
-	d.Next() // dir1
-
-	args := d.RemainingArgs()
-	if expected := []string{"arg1", "arg2", "arg3"}; !reflect.DeepEqual(args, expected) {
-		t.Errorf("RemainingArgs(): Expected %v, got %v", expected, args)
-	}
-
-	d.Next() // dir2
-
-	args = d.RemainingArgs()
-	if expected := []string{"arg4", "arg5"}; !reflect.DeepEqual(args, expected) {
-		t.Errorf("RemainingArgs(): Expected %v, got %v", expected, args)
-	}
-
-	d.Next() // dir3
-
-	args = d.RemainingArgs()
-	if expected := []string{"arg6"}; !reflect.DeepEqual(args, expected) {
-		t.Errorf("RemainingArgs(): Expected %v, got %v", expected, args)
-	}
-
-	d.Next() // {
-	d.Next() // arg7
-	d.Next() // dir4
-
-	args = d.RemainingArgs()
-	if len(args) != 0 {
-		t.Errorf("RemainingArgs(): Expected %v, got %v", []string{}, args)
-	}
-}
-
-func TestDispenser_ArgErr_Err(t *testing.T) {
-	input := `dir1 {
-			  }
-			  dir2 arg1 arg2`
-	d := NewTestDispenser(input)
-
-	d.cursor = 1 // {
-
-	if err := d.ArgErr(); err == nil || !strings.Contains(err.Error(), "{") {
-		t.Errorf("ArgErr(): Expected an error message with { in it, but got '%v'", err)
-	}
-
-	d.cursor = 5 // arg2
-
-	if err := d.ArgErr(); err == nil || !strings.Contains(err.Error(), "arg2") {
-		t.Errorf("ArgErr(): Expected an error message with 'arg2' in it; got '%v'", err)
-	}
-
-	err := d.Err("foobar")
-	if err == nil {
-		t.Fatalf("Err(): Expected an error, got nil")
-	}
-
-	if !strings.Contains(err.Error(), "Testfile:3") {
-		t.Errorf("Expected error message with filename:line in it; got '%v'", err)
-	}
-
-	if !strings.Contains(err.Error(), "foobar") {
-		t.Errorf("Expected error message with custom message in it ('foobar'); got '%v'", err)
-	}
-}

caddyconfig/caddyfile/formatter.go

@@ -1,213 +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 the input Caddyfile to a standard, nice-looking
-// appearance. It works by reading each rune of the input and taking
-// control over all the bracing and whitespace that is written; otherwise,
-// words, comments, placeholders, and escaped characters are all treated
-// literally and written as they appear in the input.
-func Format(input []byte) []byte {
-	input = bytes.TrimSpace(input)
-
-	out := new(bytes.Buffer)
-	rdr := bytes.NewReader(input)
-
-	var (
-		last rune // the last character that was written to the result
-
-		space           = true // whether current/previous character was whitespace (beginning of input counts as space)
-		beginningOfLine = true // whether we are at beginning of line
-
-		openBrace        bool // whether current word/token is or started with open curly brace
-		openBraceWritten bool // if openBrace, whether that brace was written or not
-		openBraceSpace   bool // whether there was a non-newline space before open brace
-
-		newLines int // count of newlines consumed
-
-		comment bool // whether we're in a comment
-		quoted  bool // whether we're in a quoted segment
-		escaped bool // whether current char is escaped
-
-		nesting int // indentation level
-	)
-
-	write := func(ch rune) {
-		out.WriteRune(ch)
-		last = ch
-	}
-
-	indent := func() {
-		for tabs := nesting; tabs > 0; tabs-- {
-			write('\t')
-		}
-	}
-
-	nextLine := func() {
-		write('\n')
-		beginningOfLine = true
-	}
-
-	for {
-		ch, _, err := rdr.ReadRune()
-		if err != nil {
-			if err == io.EOF {
-				break
-			}
-			panic(err)
-		}
-
-		if comment {
-			if ch == '\n' {
-				comment = false
-			} else {
-				write(ch)
-				continue
-			}
-		}
-
-		if !escaped && ch == '\\' {
-			if space {
-				write(' ')
-				space = false
-			}
-			write(ch)
-			escaped = true
-			continue
-		}
-
-		if escaped {
-			write(ch)
-			escaped = false
-			continue
-		}
-
-		if quoted {
-			if ch == '"' {
-				quoted = false
-			}
-			write(ch)
-			continue
-		}
-
-		if space && ch == '"' {
-			quoted = true
-		}
-
-		if unicode.IsSpace(ch) {
-			space = true
-			if ch == '\n' {
-				newLines++
-			}
-			continue
-		}
-		spacePrior := space
-		space = false
-
-		//////////////////////////////////////////////////////////
-		// I find it helpful to think of the formatting loop in two
-		// main sections; by the time we reach this point, we
-		// know we are in a "regular" part of the file: we know
-		// the character is not a space, not in a literal segment
-		// like a comment or quoted, it's not escaped, etc.
-		//////////////////////////////////////////////////////////
-
-		if ch == '#' {
-			comment = true
-		}
-
-		if openBrace && spacePrior && !openBraceWritten {
-			if nesting == 0 && last == '}' {
-				nextLine()
-				nextLine()
-			}
-
-			openBrace = false
-			if beginningOfLine {
-				indent()
-			} else if !openBraceSpace {
-				write(' ')
-			}
-			write('{')
-			openBraceWritten = true
-			nextLine()
-			newLines = 0
-			nesting++
-		}
-
-		switch {
-		case ch == '{':
-			openBrace = true
-			openBraceWritten = false
-			openBraceSpace = spacePrior && !beginningOfLine
-			if openBraceSpace {
-				write(' ')
-			}
-			continue
-
-		case ch == '}' && (spacePrior || !openBrace):
-			if last != '\n' {
-				nextLine()
-			}
-			if nesting > 0 {
-				nesting--
-			}
-			indent()
-			write('}')
-			newLines = 0
-			continue
-		}
-
-		if newLines > 2 {
-			newLines = 2
-		}
-		for i := 0; i < newLines; i++ {
-			nextLine()
-		}
-		newLines = 0
-		if beginningOfLine {
-			indent()
-		}
-		if nesting == 0 && last == '}' && beginningOfLine {
-			nextLine()
-			nextLine()
-		}
-
-		if !beginningOfLine && spacePrior {
-			write(' ')
-		}
-
-		if openBrace && !openBraceWritten {
-			write('{')
-			openBraceWritten = true
-		}
-		write(ch)
-
-		beginningOfLine = false
-	}
-
-	// the Caddyfile does not need any leading or trailing spaces, but...
-	trimmedResult := bytes.TrimSpace(out.Bytes())
-
-	// ...Caddyfiles should, however, end with a newline because
-	// newlines are significant to the syntax of the file
-	return append(trimmedResult, '\n')
-}

caddyconfig/caddyfile/formatter_test.go

@@ -1,327 +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 (
-	"strings"
-	"testing"
-)
-
-func TestFormatter(t *testing.T) {
-	for i, tc := range []struct {
-		description string
-		input       string
-		expect      string
-	}{
-		{
-			description: "very simple",
-			input: `abc   def
-	g hi jkl
-mn`,
-			expect: `abc def
-g hi jkl
-mn`,
-		},
-		{
-			description: "basic indentation, line breaks, and nesting",
-			input: `  a
-b
-
-	c {
-		d
-}
-
-e { f
-}
-
-
-
-g {
-h {
-i
-}
-}
-
-j { k {
-l
-}
-}
-
-m {
-	n { o
-	}
-	p { q r
-s }
-}
-
-	{
-{ t
-		u
-
-	v
-
-w
-}
-}`,
-			expect: `a
-b
-
-c {
-	d
-}
-
-e {
-	f
-}
-
-g {
-	h {
-		i
-	}
-}
-
-j {
-	k {
-		l
-	}
-}
-
-m {
-	n {
-		o
-	}
-	p {
-		q r
-		s
-	}
-}
-
-{
-	{
-		t
-		u
-
-		v
-
-		w
-	}
-}`,
-		},
-		{
-			description: "block spacing",
-			input: `a{
-	b
-}
-
-c{ d
-}`,
-			expect: `a {
-	b
-}
-
-c {
-	d
-}`,
-		},
-		{
-			description: "advanced spacing",
-			input: `abc {
-	def
-}ghi{
-	jkl mno
-pqr}`,
-			expect: `abc {
-	def
-}
-
-ghi {
-	jkl mno
-	pqr
-}`,
-		},
-		{
-			description: "env var placeholders",
-			input: `{$A}
-
-b {
-{$C}
-}
-
-d { {$E}
-}
-
-{ {$F}
-}
-`,
-			expect: `{$A}
-
-b {
-	{$C}
-}
-
-d {
-	{$E}
-}
-
-{
-	{$F}
-}`,
-		},
-		{
-			description: "comments",
-			input: `#a "\n"
-
- #b {
-	c
-}
-
-d {
-e#f
-# g
-}
-
-h { # i
-}`,
-			expect: `#a "\n"
-
-#b {
-c
-}
-
-d {
-	e#f
-	# g
-}
-
-h {
-	# i
-}`,
-		},
-		{
-			description: "quotes and escaping",
-			input: `"a \"b\" "#c
-	d
-
-e {
-"f"
-}
-
-g { "h"
-}
-
-i {
-	"foo
-bar"
-}
-
-j {
-"\"k\" l m"
-}`,
-			expect: `"a \"b\" "#c
-d
-
-e {
-	"f"
-}
-
-g {
-	"h"
-}
-
-i {
-	"foo
-bar"
-}
-
-j {
-	"\"k\" l m"
-}`,
-		},
-		{
-			description: "bad nesting (too many open)",
-			input: `a
-{
-	{
-}`,
-			expect: `a {
-	{
-	}
-`,
-		},
-		{
-			description: "bad nesting (too many close)",
-			input: `a
-{
-	{
-}}}`,
-			expect: `a {
-	{
-	}
-}
-}
-`,
-		},
-		{
-			description: "json",
-			input: `foo
-bar      "{\"key\":34}"
-`,
-			expect: `foo
-bar "{\"key\":34}"`,
-		},
-		{
-			description: "escaping after spaces",
-			input:       `foo \"literal\"`,
-			expect:      `foo \"literal\"`,
-		},
-		{
-			description: "simple placeholders as standalone tokens",
-			input:       `foo {bar}`,
-			expect:      `foo {bar}`,
-		},
-		{
-			description: "simple placeholders within tokens",
-			input:       `foo{bar} foo{bar}baz`,
-			expect:      `foo{bar} foo{bar}baz`,
-		},
-		{
-			description: "placeholders and malformed braces",
-			input:       `foo{bar} foo{ bar}baz`,
-			expect: `foo{bar} foo {
-	bar
-}
-
-baz`,
-		},
-		{
-			description: "hash within string is not a comment",
-			input:       `redir / /some/#/path`,
-			expect:      `redir / /some/#/path`,
-		},
-	} {
-		// the formatter should output a trailing newline,
-		// even if the tests aren't written to expect that
-		if !strings.HasSuffix(tc.expect, "\n") {
-			tc.expect += "\n"
-		}
-
-		actual := Format([]byte(tc.input))
-
-		if string(actual) != tc.expect {
-			t.Errorf("\n[TEST %d: %s]\n====== EXPECTED ======\n%s\n====== ACTUAL ======\n%s^^^^^^^^^^^^^^^^^^^^^",
-				i, tc.description, string(tc.expect), string(actual))
-		}
-	}
-}

caddyconfig/caddyfile/lexer.go

@@ -1,170 +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 (
-	"bufio"
-	"io"
-	"unicode"
-)
-
-type (
-	// lexer is a utility which can get values, token by
-	// token, from a Reader. A token is a word, and tokens
-	// 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
-	}
-
-	// Token represents a single parsable unit.
-	Token struct {
-		File string
-		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
-}
-
-// next loads the next token into the lexer.
-// A token is delimited by whitespace, unless
-// the token starts with a quotes character (")
-// in which case the token goes until the closing
-// quotes (the enclosing quotes are not included).
-// Inside quoted strings, quotes may be escaped
-// with a preceding \ character. No other chars
-// may be escaped. The rest of the line is skipped
-// if a "#" character is read in. Returns true if
-// a token was loaded; false otherwise.
-func (l *lexer) next() bool {
-	var val []rune
-	var comment, quoted, btQuoted, escaped bool
-
-	makeToken := func() bool {
-		l.token.Text = string(val)
-		return true
-	}
-
-	for {
-		ch, _, err := l.reader.ReadRune()
-		if err != nil {
-			if len(val) > 0 {
-				return makeToken()
-			}
-			if err == io.EOF {
-				return false
-			}
-			panic(err)
-		}
-
-		if !escaped && !btQuoted && ch == '\\' {
-			escaped = true
-			continue
-		}
-
-		if quoted || btQuoted {
-			if quoted && escaped {
-				// all is literal in quoted area,
-				// so only escape quotes
-				if ch != '"' {
-					val = append(val, '\\')
-				}
-				escaped = false
-			} else {
-				if quoted && ch == '"' {
-					return makeToken()
-				}
-				if btQuoted && ch == '`' {
-					return makeToken()
-				}
-			}
-			if ch == '\n' {
-				l.line += 1 + l.skippedLines
-				l.skippedLines = 0
-			}
-			val = append(val, ch)
-			continue
-		}
-
-		if unicode.IsSpace(ch) {
-			if ch == '\r' {
-				continue
-			}
-			if ch == '\n' {
-				if escaped {
-					l.skippedLines++
-					escaped = false
-				} else {
-					l.line += 1 + l.skippedLines
-					l.skippedLines = 0
-				}
-				comment = false
-			}
-			if len(val) > 0 {
-				return makeToken()
-			}
-			continue
-		}
-
-		if ch == '#' && len(val) == 0 {
-			comment = true
-		}
-		if comment {
-			continue
-		}
-
-		if len(val) == 0 {
-			l.token = Token{Line: l.line}
-			if ch == '"' {
-				quoted = true
-				continue
-			}
-			if ch == '`' {
-				btQuoted = true
-				continue
-			}
-		}
-
-		if escaped {
-			val = append(val, '\\')
-			escaped = false
-		}
-
-		val = append(val, ch)
-	}
-}

caddyconfig/caddyfile/lexer_test.go

@@ -1,290 +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: `host:123 {
-						# hash inside string is not a comment
-						redir / /some/#/path
-					}`,
-			expected: []Token{
-				{Line: 1, Text: "host:123"},
-				{Line: 1, Text: "{"},
-				{Line: 3, Text: "redir"},
-				{Line: 3, Text: "/"},
-				{Line: 3, Text: "/some/#/path"},
-				{Line: 4, Text: "}"},
-			},
-		},
-		{
-			input: "# comment at beginning of file\n# comment at beginning of line\nhost:123",
-			expected: []Token{
-				{Line: 3, Text: "host:123"},
-			},
-		},
-		{
-			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"},
-			},
-		},
-		{
-			input: "simple `backtick quoted` string",
-			expected: []Token{
-				{Line: 1, Text: `simple`},
-				{Line: 1, Text: `backtick quoted`},
-				{Line: 1, Text: `string`},
-			},
-		},
-		{
-			input: "multiline `backtick\nquoted\n` string",
-			expected: []Token{
-				{Line: 1, Text: `multiline`},
-				{Line: 1, Text: "backtick\nquoted\n"},
-				{Line: 3, Text: `string`},
-			},
-		},
-		{
-			input: "nested `\"quotes inside\" backticks` string",
-			expected: []Token{
-				{Line: 1, Text: `nested`},
-				{Line: 1, Text: `"quotes inside" backticks`},
-				{Line: 1, Text: `string`},
-			},
-		},
-		{
-			input: "reverse-nested \"`backticks` inside\" quotes",
-			expected: []Token{
-				{Line: 1, Text: `reverse-nested`},
-				{Line: 1, Text: "`backticks` inside"},
-				{Line: 1, Text: `quotes`},
-			},
-		},
-	}
-
-	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,557 +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"
-	"strconv"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-)
-
-// 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")
-	}
-
-	// grab remaining args as placeholder replacements
-	args := p.RemainingArgs()
-
-	// add args to the replacer
-	repl := caddy.NewReplacer()
-	for index, arg := range args {
-		repl.Set("args."+strconv.Itoa(index), arg)
-	}
-
-	// splice out the import directive and its arguments
-	// (2 tokens, plus the length of args)
-	tokensBefore := p.tokens[:p.cursor-1-len(args)]
-	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...)
-		}
-	}
-
-	// copy the tokens so we don't overwrite p.definedSnippets
-	tokensCopy := make([]Token, len(importedTokens))
-	copy(tokensCopy, importedTokens)
-
-	// run the argument replacer on the tokens
-	for index, token := range tokensCopy {
-		token.Text = repl.ReplaceKnown(token.Text, "")
-		tokensCopy[index] = token
-	}
-
-	// 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(tokensCopy, tokensAfter...)...)
-	p.cursor -= len(args) + 1
-
-	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_test.go

@@ -1,666 +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/not_found.txt`, true, []string{}, []int{}},
-
-		{`""`, false, []string{}, []int{}},
-
-		{``, false, []string{}, []int{}},
-
-		// import with args
-		{`import testdata/import_args0.txt a`, false, []string{"a"}, []int{}},
-		{`import testdata/import_args1.txt a b`, false, []string{"a", "b"}, []int{}},
-		{`import testdata/import_args*.txt a b`, false, []string{"a"}, []int{2}},
-
-		// 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)
-		}
-
-		// t.Logf("%+v\n", result)
-		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)
-	}
-	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)
-	}
-	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)
-	}
-	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_args0.txt

@@ -1 +0,0 @@
-{args.0}

caddyconfig/caddyfile/testdata/import_args1.txt

@@ -1 +0,0 @@
-{args.0} {args.1}

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
-// with an added key named fieldName with the value fieldVal. This is useful
-// for encoding module values where the module name has to be described within
-// the object by a certain key; for example, `"handler": "file_server"` for a
-// file server HTTP handler (fieldName="handler" and fieldVal="file_server").
-// The val parameter must encode into a map[string]interface{} (i.e. it must be
-// a struct or map). Any errors are converted into warnings.
-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. It panics if the
-// adapter cannot be registered successfully.
-func RegisterAdapter(name string, adapter Adapter) {
-	if _, ok := configAdapters[name]; ok {
-		panic(fmt.Errorf("%s: already registered", name))
-	}
-	configAdapters[name] = adapter
-	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,392 +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"
-	"unicode"
-
-	"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 {
-			// parse keys so that we only have to do it once
-			parsedKeys := make([]Address, 0, len(keys))
-			for _, key := range keys {
-				addr, err := ParseAddress(key)
-				if err != nil {
-					return nil, fmt.Errorf("parsing key '%s': %v", key, err)
-				}
-				parsedKeys = append(parsedKeys, addr.Normalize())
-			}
-			sbmap[addr] = append(sbmap[addr], serverBlock{
-				block: caddyfile.ServerBlock{
-					Keys:     keys,
-					Segments: sblock.block.Segments,
-				},
-				pile: sblock.pile,
-				keys: parsedKeys,
-			})
-		}
-	}
-
-	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 {
-	sbaddrs := make([]sbAddrAssociation, 0, len(addrToServerBlocks))
-	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(caddyhttp.DefaultHTTPPort), strconv.Itoa(caddyhttp.DefaultHTTPSPort)
-	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
-	lnHosts := make([]string, 0, len(sblock.pile))
-	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
-	listenersList := make([]string, 0, len(listeners))
-	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:   lowerExceptPlaceholders(a.Scheme),
-		Host:     lowerExceptPlaceholders(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
-}
-
-// lowerExceptPlaceholders lowercases s except within
-// placeholders (substrings in non-escaped '{ }' spans).
-// See https://github.com/caddyserver/caddy/issues/3264
-func lowerExceptPlaceholders(s string) string {
-	var sb strings.Builder
-	var escaped, inPlaceholder bool
-	for _, ch := range s {
-		if ch == '\\' && !escaped {
-			escaped = true
-			sb.WriteRune(ch)
-			continue
-		}
-		if ch == '{' && !escaped {
-			inPlaceholder = true
-		}
-		if ch == '}' && inPlaceholder && !escaped {
-			inPlaceholder = false
-		}
-		if inPlaceholder {
-			sb.WriteRune(ch)
-		} else {
-			sb.WriteRune(unicode.ToLower(ch))
-		}
-		escaped = false
-	}
-	return sb.String()
-}

caddyconfig/httpcaddyfile/addresses_fuzz.go

@@ -1,28 +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
-
-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,183 +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:  "example.com",
-			expect: "example.com",
-		},
-		{
-			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:  "sub.{env.MY_DOMAIN}",
-			expect: "sub.{env.MY_DOMAIN}",
-		},
-		{
-			input:  "sub.ExAmPle",
-			expect: "sub.example",
-		},
-		{
-			input:  "sub.\\{env.MY_DOMAIN\\}",
-			expect: "sub.\\{env.my_domain\\}",
-		},
-		{
-			input:  "sub.{env.MY_DOMAIN}.com",
-			expect: "sub.{env.MY_DOMAIN}.com",
-		},
-		{
-			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: Input '%s': Expected '%s' but got '%s'", i, tc.input, tc.expect, actual)
-		}
-
-	}
-}

caddyconfig/httpcaddyfile/builtins.go

@@ -1,635 +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/base64"
-	"encoding/pem"
-	"fmt"
-	"html"
-	"io/ioutil"
-	"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...>
-//         client_auth {
-//             mode                   [request|require|verify_if_given|require_and_verify]
-//             trusted_ca_cert        <base64_der>
-//             trusted_ca_cert_file   <filename>
-//             trusted_leaf_cert      <base64_der>
-//             trusted_leaf_cert_file <filename>
-//         }
-//         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 certSelector caddytls.CustomCertSelectionPolicy
-	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.AnyTag = append(certSelector.AnyTag, tag)
-
-		default:
-			return nil, h.ArgErr()
-		}
-
-		var hasBlock bool
-		for nesting := h.Nesting(); h.NextBlock(nesting); {
-			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 !caddytls.CipherSuiteNameSupported(h.Val()) {
-						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 "client_auth":
-				cp.ClientAuthentication = &caddytls.ClientAuthentication{}
-				for nesting := h.Nesting(); h.NextBlock(nesting); {
-					subdir := h.Val()
-					switch subdir {
-					case "mode":
-						if !h.Args(&cp.ClientAuthentication.Mode) {
-							return nil, h.ArgErr()
-						}
-						if h.NextArg() {
-							return nil, h.ArgErr()
-						}
-
-					case "trusted_ca_cert",
-						"trusted_leaf_cert":
-						if !h.NextArg() {
-							return nil, h.ArgErr()
-						}
-						if subdir == "trusted_ca_cert" {
-							cp.ClientAuthentication.TrustedCACerts = append(cp.ClientAuthentication.TrustedCACerts, h.Val())
-						} else {
-							cp.ClientAuthentication.TrustedLeafCerts = append(cp.ClientAuthentication.TrustedLeafCerts, h.Val())
-						}
-
-					case "trusted_ca_cert_file",
-						"trusted_leaf_cert_file":
-						if !h.NextArg() {
-							return nil, h.ArgErr()
-						}
-						filename := h.Val()
-						certDataPEM, err := ioutil.ReadFile(filename)
-						if err != nil {
-							return nil, err
-						}
-						block, _ := pem.Decode(certDataPEM)
-						if block == nil || block.Type != "CERTIFICATE" {
-							return nil, h.Errf("no CERTIFICATE pem block found in %s", h.Val())
-						}
-						if subdir == "trusted_ca_cert_file" {
-							cp.ClientAuthentication.TrustedCACerts = append(cp.ClientAuthentication.TrustedCACerts,
-								base64.StdEncoding.EncodeToString(block.Bytes))
-						} else {
-							cp.ClientAuthentication.TrustedLeafCerts = append(cp.ClientAuthentication.TrustedLeafCerts,
-								base64.StdEncoding.EncodeToString(block.Bytes))
-						}
-
-					default:
-						return nil, h.Errf("unknown subdirective for client_auth: %s", subdir)
-					}
-				}
-
-			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.NextArg() {
-					return nil, h.ArgErr()
-				}
-				provName := h.Val()
-				if acmeIssuer == nil {
-					acmeIssuer = new(caddytls.ACMEIssuer)
-				}
-				if acmeIssuer.Challenges == nil {
-					acmeIssuer.Challenges = new(caddytls.ChallengesConfig)
-					acmeIssuer.Challenges.DNS = new(caddytls.DNSChallengeConfig)
-				}
-				dnsProvModule, err := caddy.GetModule("dns.providers." + provName)
-				if err != nil {
-					return nil, h.Errf("getting DNS provider module named '%s': %v", provName, err)
-				}
-				dnsProvModuleInstance := dnsProvModule.New()
-				if unm, ok := dnsProvModuleInstance.(caddyfile.Unmarshaler); ok {
-					err = unm.UnmarshalCaddyfile(h.NewFromNextSegment())
-					if err != nil {
-						return nil, err
-					}
-				}
-				acmeIssuer.Challenges.DNS.ProviderRaw = caddyconfig.JSONModuleObject(dnsProvModuleInstance, "name", 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.cert_loader",
-			Value: fileLoader,
-		})
-	}
-	if len(folderLoader) > 0 {
-		configVals = append(configVals, ConfigValue{
-			Class: "tls.cert_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,
-		})
-	}
-
-	// custom certificate selection
-	if len(certSelector.AnyTag) > 0 {
-		cp.CertSelection = &certSelector
-	}
-
-	// 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() {
-		// log does not currently support any arguments
-		if h.NextArg() {
-			return nil, h.ArgErr()
-		}
-
-		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/builtins_test.go

@@ -1,62 +0,0 @@
-package httpcaddyfile
-
-import (
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	_ "github.com/caddyserver/caddy/v2/modules/logging"
-)
-
-func TestLogDirectiveSyntax(t *testing.T) {
-	for i, tc := range []struct {
-		input       string
-		expectWarn  bool
-		expectError bool
-	}{
-		{
-			input: `:8080 {
-				log
-			}
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `:8080 {
-				log {
-					output file foo.log
-				}
-			}
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `:8080 {
-				log /foo {
-					output file foo.log
-				}
-			}
-			`,
-			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/directives.go

@@ -1,479 +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"
-	"net"
-	"sort"
-	"strconv"
-	"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.
-//
-// The root directive goes first in case rewrites or
-// redirects depend on existence of files, i.e. the
-// file matcher, which must know the root first.
-//
-// The header directive goes second so that headers
-// can be manipulated before doing redirects.
-var directiveOrder = []string{
-	"root",
-
-	"header",
-
-	"redir",
-	"rewrite",
-
-	// URI manipulation
-	"uri",
-	"try_files",
-
-	// middleware handlers; some wrap responses
-	"basicauth",
-	"request_header",
-	"encode",
-	"templates",
-
-	// special routing directives
-	"handle",
-	"handle_path",
-	"route",
-
-	// handlers that typically respond to requests
-	"respond",
-	"reverse_proxy",
-	"php_fastcgi",
-	"file_server",
-	"acme_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
-	})
-}
-
-// RegisterGlobalOption registers a unique global option opt with
-// an associated unmarshaling (setup) function. When the global
-// option opt is encountered in a Caddyfile, setupFunc will be
-// called to unmarshal its tokens.
-func RegisterGlobalOption(opt string, setupFunc UnmarshalGlobalFunc) {
-	if _, ok := registeredGlobalOptions[opt]; ok {
-		panic("global option " + opt + " already registered")
-	}
-	registeredGlobalOptions[opt] = setupFunc
-}
-
-// 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}}
-}
-
-// 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)
-}
-
-// 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
-	}
-
-	sort.SliceStable(routes, func(i, j int) bool {
-		// if the directives are different, just use the established directive order
-		iDir, jDir := routes[i].directive, routes[j].directive
-		if iDir != jDir {
-			return dirPositions[iDir] < dirPositions[jDir]
-		}
-
-		// directives are the same; sub-sort by path matcher length if there's
-		// only one matcher set and one path (this is a very common case and
-		// usually -- but not always -- helpful/expected, oh well; user can
-		// always take manual control of order using handler or route blocks)
-		iRoute, ok := routes[i].Value.(caddyhttp.Route)
-		if !ok {
-			return false
-		}
-		jRoute, ok := routes[j].Value.(caddyhttp.Route)
-		if !ok {
-			return false
-		}
-
-		// decode the path matchers, if there is just one of them
-		var iPM, jPM caddyhttp.MatchPath
-		if len(iRoute.MatcherSetsRaw) == 1 {
-			_ = json.Unmarshal(iRoute.MatcherSetsRaw[0]["path"], &iPM)
-		}
-		if len(jRoute.MatcherSetsRaw) == 1 {
-			_ = json.Unmarshal(jRoute.MatcherSetsRaw[0]["path"], &jPM)
-		}
-
-		// sort by longer path (more specific) first; missing path
-		// matchers or multi-matchers are treated as zero-length paths
-		var iPathLen, jPathLen int
-		if len(iPM) > 0 {
-			iPathLen = len(iPM[0])
-		}
-		if len(jPM) > 0 {
-			jPathLen = len(jPM[0])
-		}
-		return iPathLen > jPathLen
-	})
-}
-
-// serverBlock pairs a Caddyfile server block with
-// a "pile" of config values, keyed by class name,
-// as well as its parsed keys for convenience.
-type serverBlock struct {
-	block caddyfile.ServerBlock
-	pile  map[string][]ConfigValue // config values obtained from directives
-	keys  []Address
-}
-
-// hostsFromKeys returns a list of all the non-empty hostnames found in
-// the keys of the server block sb. If logger mode is false, a key with
-// an empty hostname portion will return an empty slice, since that
-// server block is interpreted to effectively match all hosts. An empty
-// string is never added to the slice.
-//
-// If loggerMode is true, then the non-standard ports of keys will be
-// joined to the hostnames. This is to effectively match the Host
-// header of requests that come in for that key.
-//
-// The resulting slice is not sorted but will never have duplicates.
-func (sb serverBlock) hostsFromKeys(loggerMode bool) []string {
-	// ensure each entry in our list is unique
-	hostMap := make(map[string]struct{})
-	for _, addr := range sb.keys {
-		if addr.Host == "" {
-			if !loggerMode {
-				// server block contains a key like ":443", i.e. the host portion
-				// is empty / catch-all, which means to match all hosts
-				return []string{}
-			}
-			// never append an empty string
-			continue
-		}
-		if loggerMode &&
-			addr.Port != "" &&
-			addr.Port != strconv.Itoa(caddyhttp.DefaultHTTPPort) &&
-			addr.Port != strconv.Itoa(caddyhttp.DefaultHTTPSPort) {
-			hostMap[net.JoinHostPort(addr.Host, addr.Port)] = struct{}{}
-		} else {
-			hostMap[addr.Host] = struct{}{}
-		}
-	}
-
-	// convert map to slice
-	sblockHosts := make([]string, 0, len(hostMap))
-	for host := range hostMap {
-		sblockHosts = append(sblockHosts, host)
-	}
-
-	return sblockHosts
-}
-
-// hasHostCatchAllKey returns true if sb has a key that
-// omits a host portion, i.e. it "catches all" hosts.
-func (sb serverBlock) hasHostCatchAllKey() bool {
-	for _, addr := range sb.keys {
-		if addr.Host == "" {
-			return true
-		}
-	}
-	return false
-}
-
-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)
-
-	// UnmarshalGlobalFunc is a function which can unmarshal Caddyfile
-	// tokens into a global option config value using a Helper type.
-	// These are passed in a call to RegisterGlobalOption.
-	UnmarshalGlobalFunc func(d *caddyfile.Dispenser) (interface{}, error)
-)
-
-var registeredDirectives = make(map[string]UnmarshalFunc)
-
-var registeredGlobalOptions = make(map[string]UnmarshalGlobalFunc)

caddyconfig/httpcaddyfile/directives_test.go

@@ -1,94 +0,0 @@
-package httpcaddyfile
-
-import (
-	"reflect"
-	"sort"
-	"testing"
-)
-
-func TestHostsFromKeys(t *testing.T) {
-	for i, tc := range []struct {
-		keys             []Address
-		expectNormalMode []string
-		expectLoggerMode []string
-	}{
-		{
-			[]Address{
-				{Original: "foo", Host: "foo"},
-			},
-			[]string{"foo"},
-			[]string{"foo"},
-		},
-		{
-			[]Address{
-				{Original: "foo", Host: "foo"},
-				{Original: "bar", Host: "bar"},
-			},
-			[]string{"bar", "foo"},
-			[]string{"bar", "foo"},
-		},
-		{
-			[]Address{
-				{Original: ":2015", Port: "2015"},
-			},
-			[]string{}, []string{},
-		},
-		{
-			[]Address{
-				{Original: ":443", Port: "443"},
-			},
-			[]string{}, []string{},
-		},
-		{
-			[]Address{
-				{Original: "foo", Host: "foo"},
-				{Original: ":2015", Port: "2015"},
-			},
-			[]string{}, []string{"foo"},
-		},
-		{
-			[]Address{
-				{Original: "example.com:2015", Host: "example.com", Port: "2015"},
-			},
-			[]string{"example.com"},
-			[]string{"example.com:2015"},
-		},
-		{
-			[]Address{
-				{Original: "example.com:80", Host: "example.com", Port: "80"},
-			},
-			[]string{"example.com"},
-			[]string{"example.com"},
-		},
-		{
-			[]Address{
-				{Original: "https://:2015/foo", Scheme: "https", Port: "2015", Path: "/foo"},
-			},
-			[]string{},
-			[]string{},
-		},
-		{
-			[]Address{
-				{Original: "https://example.com:2015/foo", Scheme: "https", Host: "example.com", Port: "2015", Path: "/foo"},
-			},
-			[]string{"example.com"},
-			[]string{"example.com:2015"},
-		},
-	} {
-		sb := serverBlock{keys: tc.keys}
-
-		// test in normal mode
-		actual := sb.hostsFromKeys(false)
-		sort.Strings(actual)
-		if !reflect.DeepEqual(tc.expectNormalMode, actual) {
-			t.Errorf("Test %d (loggerMode=false): Expected: %v Actual: %v", i, tc.expectNormalMode, actual)
-		}
-
-		// test in logger mode
-		actual = sb.hostsFromKeys(true)
-		sort.Strings(actual)
-		if !reflect.DeepEqual(tc.expectLoggerMode, actual) {
-			t.Errorf("Test %d (loggerMode=true): Expected: %v Actual: %v", i, tc.expectLoggerMode, actual)
-		}
-	}
-}

caddyconfig/httpcaddyfile/httptype_test.go

@@ -1,185 +0,0 @@
-package httpcaddyfile
-
-import (
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-)
-
-func TestMatcherSyntax(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,
-		},
-		{
-			input: `http://localhost
-			@debug {
-				not {
-					path /somepath*
-				}
-			}
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `http://localhost
-			@debug {
-				not path /somepath*
-			}
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `http://localhost
-			@debug not path /somepath*
-			`,
-			expectWarn:  false,
-			expectError: false,
-		},
-		{
-			input: `@matcher {
-				path /matcher-not-allowed/outside-of-site-block/*
-			}
-			http://localhost
-			`,
-			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,311 +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"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-)
-
-func init() {
-	RegisterGlobalOption("debug", parseOptTrue)
-	RegisterGlobalOption("http_port", parseOptHTTPPort)
-	RegisterGlobalOption("https_port", parseOptHTTPSPort)
-	RegisterGlobalOption("default_sni", parseOptSingleString)
-	RegisterGlobalOption("order", parseOptOrder)
-	RegisterGlobalOption("experimental_http3", parseOptTrue)
-	RegisterGlobalOption("storage", parseOptStorage)
-	RegisterGlobalOption("acme_ca", parseOptSingleString)
-	RegisterGlobalOption("acme_ca_root", parseOptSingleString)
-	RegisterGlobalOption("acme_dns", parseOptSingleString)
-	RegisterGlobalOption("acme_eab", parseOptACMEEAB)
-	RegisterGlobalOption("email", parseOptSingleString)
-	RegisterGlobalOption("admin", parseOptAdmin)
-	RegisterGlobalOption("on_demand_tls", parseOptOnDemand)
-	RegisterGlobalOption("local_certs", parseOptTrue)
-	RegisterGlobalOption("key_type", parseOptSingleString)
-	RegisterGlobalOption("auto_https", parseOptAutoHTTPS)
-}
-
-func parseOptTrue(d *caddyfile.Dispenser) (interface{}, error) {
-	return true, nil
-}
-
-func parseOptHTTPPort(d *caddyfile.Dispenser) (interface{}, 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) (interface{}, 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 parseOptOrder(d *caddyfile.Dispenser) (interface{}, 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) (interface{}, error) {
-	if !d.Next() { // consume option name
-		return nil, d.ArgErr()
-	}
-	if !d.Next() { // get storage module name
-		return nil, d.ArgErr()
-	}
-	modName := d.Val()
-	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 parseOptACMEEAB(d *caddyfile.Dispenser) (interface{}, error) {
-	eab := new(caddytls.ExternalAccountBinding)
-	for d.Next() {
-		if d.NextArg() {
-			return nil, d.ArgErr()
-		}
-		for nesting := d.Nesting(); d.NextBlock(nesting); {
-			switch d.Val() {
-			case "key_id":
-				if !d.NextArg() {
-					return nil, d.ArgErr()
-				}
-				eab.KeyID = d.Val()
-
-			case "hmac":
-				if !d.NextArg() {
-					return nil, d.ArgErr()
-				}
-				eab.HMAC = d.Val()
-
-			default:
-				return nil, d.Errf("unrecognized parameter '%s'", d.Val())
-			}
-		}
-	}
-	return eab, nil
-}
-
-func parseOptSingleString(d *caddyfile.Dispenser) (interface{}, 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) (interface{}, 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) (interface{}, 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 := caddy.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
-}
-
-func parseOptAutoHTTPS(d *caddyfile.Dispenser) (interface{}, error) {
-	d.Next() // consume parameter name
-	if !d.Next() {
-		return "", d.ArgErr()
-	}
-	val := d.Val()
-	if d.Next() {
-		return "", d.ArgErr()
-	}
-	if val != "off" && val != "disable_redirects" {
-		return "", d.Errf("auto_https must be either 'off' or 'disable_redirects'")
-	}
-	return val, nil
-}

caddyconfig/httpcaddyfile/tlsapp.go

@@ -1,461 +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"
-	"encoding/json"
-	"fmt"
-	"reflect"
-	"sort"
-	"strconv"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/caddy/v2/modules/caddyhttp"
-	"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
-
-	httpsPort := strconv.Itoa(caddyhttp.DefaultHTTPSPort)
-	if hsp, ok := options["https_port"].(int); ok {
-		httpsPort = strconv.Itoa(hsp)
-	}
-
-	// count how many server blocks have a TLS-enabled 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 serverBlocksWithTLSHostlessKey int
-	hostsSharedWithHostlessKey := make(map[string]struct{})
-	for _, pair := range pairings {
-		for _, sb := range pair.serverBlocks {
-			for _, addr := range sb.keys {
-				if addr.Host == "" {
-					// this address has no hostname, but if it's explicitly set
-					// to HTTPS, then we need to count it as being TLS-enabled
-					if addr.Scheme == "https" || addr.Port == httpsPort {
-						serverBlocksWithTLSHostlessKey++
-					}
-					// this server block has a hostless key, now
-					// go through and add all the hosts to the set
-					for _, otherAddr := range sb.keys {
-						if otherAddr.Original == addr.Original {
-							continue
-						}
-						if otherAddr.Host != "" {
-							hostsSharedWithHostlessKey[otherAddr.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 := sblock.hostsFromKeys(false)
-			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
-						}
-					}
-					if ap == catchAllAP && !reflect.DeepEqual(ap.Issuer, issuer) {
-						return nil, warnings, fmt.Errorf("automation policy from site block is also default/catch-all policy because of key without hostname, and the two are in conflict: %#v != %#v", ap.Issuer, issuer)
-					}
-					ap.Issuer = issuer
-				}
-			}
-
-			// custom bind host
-			for _, cfgVal := range sblock.pile["bind"] {
-				// either an existing issuer is already configured (and thus, ap is not
-				// nil), or we need to configure an issuer, so we need ap to be non-nil
-				if ap == nil {
-					ap, err = newBaseAutomationPolicy(options, warnings, true)
-					if err != nil {
-						return nil, warnings, err
-					}
-				}
-
-				// if an issuer was already configured and it is NOT an ACME
-				// issuer, skip, since we intend to adjust only ACME issuers
-				var acmeIssuer *caddytls.ACMEIssuer
-				if ap.Issuer != nil {
-					var ok bool
-					if acmeIssuer, ok = ap.Issuer.(*caddytls.ACMEIssuer); !ok {
-						break
-					}
-				}
-
-				// proceed to configure the ACME issuer's bind host, without
-				// overwriting any existing settings
-				if acmeIssuer == nil {
-					acmeIssuer = new(caddytls.ACMEIssuer)
-				}
-				if acmeIssuer.Challenges == nil {
-					acmeIssuer.Challenges = new(caddytls.ChallengesConfig)
-				}
-				if acmeIssuer.Challenges.BindHost == "" {
-					// only binding to one host is supported
-					var bindHost string
-					if bindHosts, ok := cfgVal.Value.([]string); ok && len(bindHosts) > 0 {
-						bindHost = bindHosts[0]
-					}
-					acmeIssuer.Challenges.BindHost = bindHost
-				}
-				ap.Issuer = acmeIssuer // we'll encode it later
-			}
-
-			if ap != nil {
-				if ap.Issuer != nil {
-					// encode issuer now that it's all set up
-					issuerName := ap.Issuer.(caddy.Module).CaddyModule().ID.Name()
-					ap.IssuerRaw = caddyconfig.JSONModuleObject(ap.Issuer, "module", issuerName, &warnings)
-				}
-
-				// 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 serverBlocksWithTLSHostlessKey > 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 TLS-enabled 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.cert_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(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 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; we also need
-	// to make sure that any of these names which are internal-only
-	// get internal certificates by default rather than ACME
-	var al caddytls.AutomateLoader
-	internalAP := &caddytls.AutomationPolicy{
-		IssuerRaw: json.RawMessage(`{"module":"internal"}`),
-	}
-	for h := range hostsSharedWithHostlessKey {
-		al = append(al, h)
-		if !certmagic.SubjectQualifiesForPublicCert(h) {
-			internalAP.Subjects = append(internalAP.Subjects, h)
-		}
-	}
-	if len(al) > 0 {
-		tlsApp.CertificatesRaw["automate"] = caddyconfig.JSON(al, &warnings)
-	}
-	if len(internalAP.Subjects) > 0 {
-		if tlsApp.Automation == nil {
-			tlsApp.Automation = new(caddytls.AutomationConfig)
-		}
-		tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, internalAP)
-	}
-
-	// if there is a global/catch-all automation policy, ensure it goes last
-	if catchAllAP != nil {
-		// first, encode its issuer, if there is one
-		if catchAllAP.Issuer != nil {
-			issuerName := catchAllAP.Issuer.(caddy.Module).CaddyModule().ID.Name()
-			catchAllAP.IssuerRaw = caddyconfig.JSONModuleObject(catchAllAP.Issuer, "module", issuerName, &warnings)
-		}
-
-		// then append it to the end of the policies list
-		if tlsApp.Automation == nil {
-			tlsApp.Automation = new(caddytls.AutomationConfig)
-		}
-		tlsApp.Automation.Policies = append(tlsApp.Automation.Policies, catchAllAP)
-	}
-
-	// 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"]
-	acmeCARoot, hasACMECARoot := options["acme_ca_root"]
-	acmeDNS, hasACMEDNS := options["acme_dns"]
-	acmeEAB, hasACMEEAB := options["acme_eab"]
-
-	email, hasEmail := options["email"]
-	localCerts, hasLocalCerts := options["local_certs"]
-	keyType, hasKeyType := options["key_type"]
-
-	hasGlobalAutomationOpts := hasACMECA || hasACMECARoot || hasACMEDNS || hasACMEEAB || hasEmail || hasLocalCerts || hasKeyType
-
-	// 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.Issuer = new(caddytls.InternalIssuer) // we'll encode it later
-	} 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("dns.providers." + provName)
-			if err != nil {
-				return nil, fmt.Errorf("getting DNS provider module named '%s': %v", provName, err)
-			}
-			mgr.Challenges = &caddytls.ChallengesConfig{
-				DNS: &caddytls.DNSChallengeConfig{
-					ProviderRaw: caddyconfig.JSONModuleObject(dnsProvModule.New(), "name", provName, &warnings),
-				},
-			}
-		}
-		if acmeCARoot != nil {
-			mgr.TrustedRootsPEMFiles = []string{acmeCARoot.(string)}
-		}
-		if acmeEAB != nil {
-			mgr.ExternalAccount = acmeEAB.(*caddytls.ExternalAccountBinding)
-		}
-		if keyType != nil {
-			ap.KeyType = keyType.(string)
-		}
-		ap.Issuer = mgr // we'll encode it later
-	}
-
-	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 {
-				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/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.ca.cer

@@ -1,20 +0,0 @@
------BEGIN CERTIFICATE-----
-MIIDSzCCAjOgAwIBAgIUfIRObjWNUA4jxQ/0x8BOCvE2Vw4wDQYJKoZIhvcNAQEL
-BQAwFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwHhcNMTkwODI4MTYyNTU5WhcNMjkw
-ODI1MTYyNTU5WjAWMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTCCASIwDQYJKoZIhvcN
-AQEBBQADggEPADCCAQoCggEBAK5m5elxhQfMp/3aVJ4JnpN9PUSz6LlP6LePAPFU
-7gqohVVFVtDkChJAG3FNkNQNlieVTja/bgH9IcC6oKbROwdY1h0MvNV8AHHigvl0
-3WuJD8g2ReVFXXwsnrPmKXCFzQyMI6TYk3m2gYrXsZOU1GLnfMRC3KAMRgE2F45t
-wOs9hqG169YJ6mM2eQjzjCHWI6S2/iUYvYxRkCOlYUbLsMD/AhgAf1plzg6LPqNx
-tdlwxZnA0ytgkmhK67HtzJu0+ovUCsMv0RwcMhsEo9T8nyFAGt9XLZ63X5WpBCTU
-ApaAUhnG0XnerjmUWb6eUWw4zev54sEfY5F3x002iQaW6cECAwEAAaOBkDCBjTAd
-BgNVHQ4EFgQU4CBUbZsS2GaNIkGRz/cBsD5ivjswUQYDVR0jBEowSIAU4CBUbZsS
-2GaNIkGRz/cBsD5ivjuhGqQYMBYxFDASBgNVBAMMC0Vhc3ktUlNBIENBghR8hE5u
-NY1QDiPFD/THwE4K8TZXDjAMBgNVHRMEBTADAQH/MAsGA1UdDwQEAwIBBjANBgkq
-hkiG9w0BAQsFAAOCAQEAKB3V4HIzoiO/Ch6WMj9bLJ2FGbpkMrcb/Eq01hT5zcfK
-D66lVS1MlK+cRL446Z2b2KDP1oFyVs+qmrmtdwrWgD+nfe2sBmmIHo9m9KygMkEO
-fG3MghGTEcS+0cTKEcoHYWYyOqQh6jnedXY8Cdm4GM1hAc9MiL3/sqV8YCVSLNnk
-oNysmr06/rZ0MCUZPGUtRmfd0heWhrfzAKw2HLgX+RAmpOE2MZqWcjvqKGyaRiaZ
-ks4nJkP6521aC2Lgp0HhCz1j8/uQ5ldoDszCnu/iro0NAsNtudTMD+YoLQxLqdle
-Ih6CW+illc2VdXwj7mn6J04yns9jfE2jRjW/yTLFuQ==
------END CERTIFICATE-----

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,504 +0,0 @@
-package caddytest
-
-import (
-	"bytes"
-	"context"
-	"crypto/tls"
-	"encoding/json"
-	"errors"
-	"fmt"
-	"io/ioutil"
-	"log"
-	"net"
-	"net/http"
-	"net/http/cookiejar"
-	"os"
-	"path"
-	"regexp"
-	"runtime"
-	"strings"
-	"testing"
-	"time"
-
-	"github.com/aryann/difflib"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	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
-	// TestRequestTimeout is the time to wait for a http request to
-	TestRequestTimeout time.Duration
-	// LoadRequestTimeout is the time to wait for the config to be loaded against the caddy server
-	LoadRequestTimeout time.Duration
-}
-
-// Default testing values
-var Default = Defaults{
-	AdminPort:          2019,
-	Certifcates:        []string{"/caddy.localhost.crt", "/caddy.localhost.key"},
-	TestRequestTimeout: 5 * time.Second,
-	LoadRequestTimeout: 5 * time.Second,
-}
-
-var (
-	matchKey  = regexp.MustCompile(`(/[\w\d\.]+\.key)`)
-	matchCert = regexp.MustCompile(`(/[\w\d\.]+\.crt)`)
-)
-
-// Tester represents an instance of a test client.
-type Tester struct {
-	Client       *http.Client
-	configLoaded bool
-	t            *testing.T
-}
-
-// NewTester will create a new testing client with an attached cookie jar
-func NewTester(t *testing.T) *Tester {
-
-	jar, err := cookiejar.New(nil)
-	if err != nil {
-		t.Fatalf("failed to create cookiejar: %s", err)
-	}
-
-	return &Tester{
-		Client: &http.Client{
-			Transport: CreateTestingTransport(),
-			Jar:       jar,
-			Timeout:   Default.TestRequestTimeout,
-		},
-		configLoaded: false,
-		t:            t,
-	}
-}
-
-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 (tc *Tester) InitServer(rawConfig string, configType string) {
-
-	if err := tc.initServer(rawConfig, configType); err != nil {
-		tc.t.Logf("failed to load config: %s", err)
-		tc.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 (tc *Tester) initServer(rawConfig string, configType string) error {
-
-	if testing.Short() {
-		tc.t.SkipNow()
-		return nil
-	}
-
-	err := validateTestPrerequisites()
-	if err != nil {
-		tc.t.Skipf("skipping tests as failed integration prerequisites. %s", err)
-		return nil
-	}
-
-	tc.t.Cleanup(func() {
-		if tc.t.Failed() && tc.configLoaded {
-
-			res, err := http.Get(fmt.Sprintf("http://localhost:%d/config/", Default.AdminPort))
-			if err != nil {
-				tc.t.Log("unable to read the current config")
-				return
-			}
-			defer res.Body.Close()
-			body, err := ioutil.ReadAll(res.Body)
-
-			var out bytes.Buffer
-			json.Indent(&out, body, "", "  ")
-			tc.t.Logf("----------- failed with config -----------\n%s", out.String())
-		}
-	})
-
-	rawConfig = prependCaddyFilePath(rawConfig)
-	client := &http.Client{
-		Timeout: Default.LoadRequestTimeout,
-	}
-	start := time.Now()
-	req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/load", Default.AdminPort), strings.NewReader(rawConfig))
-	if err != nil {
-		tc.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 {
-		tc.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 {
-		tc.t.Errorf("unable to read response. %s", err)
-		return err
-	}
-
-	if res.StatusCode != 200 {
-		return configLoadError{Response: string(body)}
-	}
-
-	tc.configLoaded = true
-	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: Default.LoadRequestTimeout,
-	}
-	_, 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
-}
-
-// CreateTestingTransport 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) {
-
-	tc := NewTester(t)
-
-	err := tc.initServer(rawConfig, configType)
-	if !strings.Contains(err.Error(), expectedError) {
-		t.Errorf("expected error \"%s\" but got \"%s\"", expectedError, err.Error())
-	}
-}
-
-// AssertRedirect makes a request and asserts the redirection happens
-func (tc *Tester) AssertRedirect(requestURI string, expectedToLocation string, expectedStatusCode int) *http.Response {
-
-	redirectPolicyFunc := func(req *http.Request, via []*http.Request) error {
-		return http.ErrUseLastResponse
-	}
-
-	// using the existing client, we override the check redirect policy for this test
-	old := tc.Client.CheckRedirect
-	tc.Client.CheckRedirect = redirectPolicyFunc
-	defer func() { tc.Client.CheckRedirect = old }()
-
-	resp, err := tc.Client.Get(requestURI)
-	if err != nil {
-		tc.t.Errorf("failed to call server %s", err)
-		return nil
-	}
-
-	if expectedStatusCode != resp.StatusCode {
-		tc.t.Errorf("requesting \"%s\" expected status code: %d but got %d", requestURI, expectedStatusCode, resp.StatusCode)
-	}
-
-	loc, err := resp.Location()
-	if err != nil {
-		tc.t.Errorf("requesting \"%s\" expected location: \"%s\" but got error: %s", requestURI, expectedToLocation, err)
-	}
-
-	if expectedToLocation != loc.String() {
-		tc.t.Errorf("requesting \"%s\" expected location: \"%s\" but got \"%s\"", requestURI, expectedToLocation, loc.String())
-	}
-
-	return resp
-}
-
-// CompareAdapt adapts a config and then compares it against an expected result
-func CompareAdapt(t *testing.T, rawConfig string, adapterName string, expectedResponse string) bool {
-
-	cfgAdapter := caddyconfig.GetAdapter(adapterName)
-	if cfgAdapter == nil {
-		t.Logf("unrecognized config adapter '%s'", adapterName)
-		return false
-	}
-
-	options := make(map[string]interface{})
-	options["pretty"] = "true"
-
-	result, warnings, err := cfgAdapter.Adapt([]byte(rawConfig), options)
-	if err != nil {
-		t.Logf("adapting config using %s adapter: %v", adapterName, err)
-		return false
-	}
-
-	if len(warnings) > 0 {
-		for _, w := range warnings {
-			t.Logf("warning: directive: %s : %s", w.Directive, w.Message)
-		}
-	}
-
-	diff := difflib.Diff(
-		strings.Split(expectedResponse, "\n"),
-		strings.Split(string(result), "\n"))
-
-	// scan for failure
-	failed := false
-	for _, d := range diff {
-		if d.Delta != difflib.Common {
-			failed = true
-			break
-		}
-	}
-
-	if failed {
-		for _, d := range diff {
-			switch d.Delta {
-			case difflib.Common:
-				fmt.Printf("  %s\n", d.Payload)
-			case difflib.LeftOnly:
-				fmt.Printf(" - %s\n", d.Payload)
-			case difflib.RightOnly:
-				fmt.Printf(" + %s\n", d.Payload)
-			}
-		}
-		return false
-	}
-	return true
-}
-
-// AssertAdapt adapts a config and then tests it against an expected result
-func AssertAdapt(t *testing.T, rawConfig string, adapterName string, expectedResponse string) {
-	ok := CompareAdapt(t, rawConfig, adapterName, expectedResponse)
-	if !ok {
-		t.Fail()
-	}
-}
-
-// Generic request functions
-
-func applyHeaders(t *testing.T, req *http.Request, requestHeaders []string) {
-	requestContentType := ""
-	for _, requestHeader := range requestHeaders {
-		arr := strings.SplitAfterN(requestHeader, ":", 2)
-		k := strings.TrimRight(arr[0], ":")
-		v := strings.TrimSpace(arr[1])
-		if k == "Content-Type" {
-			requestContentType = v
-		}
-		t.Logf("Request header: %s => %s", k, v)
-		req.Header.Set(k, v)
-	}
-
-	if requestContentType == "" {
-		t.Logf("Content-Type header not provided")
-	}
-}
-
-// AssertResponseCode will execute the request and verify the status code, returns a response for additional assertions
-func (tc *Tester) AssertResponseCode(req *http.Request, expectedStatusCode int) *http.Response {
-
-	resp, err := tc.Client.Do(req)
-	if err != nil {
-		tc.t.Fatalf("failed to call server %s", err)
-	}
-
-	if expectedStatusCode != resp.StatusCode {
-		tc.t.Errorf("requesting \"%s\" expected status code: %d but got %d", req.RequestURI, expectedStatusCode, resp.StatusCode)
-	}
-
-	return resp
-}
-
-// AssertResponse request a URI and assert the status code and the body contains a string
-func (tc *Tester) AssertResponse(req *http.Request, expectedStatusCode int, expectedBody string) (*http.Response, string) {
-
-	resp := tc.AssertResponseCode(req, expectedStatusCode)
-
-	defer resp.Body.Close()
-	bytes, err := ioutil.ReadAll(resp.Body)
-	if err != nil {
-		tc.t.Fatalf("unable to read the response body %s", err)
-	}
-
-	body := string(bytes)
-
-	if !strings.Contains(body, expectedBody) {
-		tc.t.Errorf("requesting \"%s\" expected response body \"%s\" but got \"%s\"", req.RequestURI, expectedBody, body)
-	}
-
-	return resp, body
-}
-
-// Verb specific test functions
-
-// AssertGetResponse GET a URI and expect a statusCode and body text
-func (tc *Tester) AssertGetResponse(requestURI string, expectedStatusCode int, expectedBody string) (*http.Response, string) {
-
-	req, err := http.NewRequest("GET", requestURI, nil)
-	if err != nil {
-		tc.t.Fatalf("unable to create request %s", err)
-	}
-
-	return tc.AssertResponse(req, expectedStatusCode, expectedBody)
-}
-
-// AssertDeleteResponse request a URI and expect a statusCode and body text
-func (tc *Tester) AssertDeleteResponse(requestURI string, expectedStatusCode int, expectedBody string) (*http.Response, string) {
-
-	req, err := http.NewRequest("DELETE", requestURI, nil)
-	if err != nil {
-		tc.t.Fatalf("unable to create request %s", err)
-	}
-
-	return tc.AssertResponse(req, expectedStatusCode, expectedBody)
-}
-
-// AssertPostResponseBody POST to a URI and assert the response code and body
-func (tc *Tester) AssertPostResponseBody(requestURI string, requestHeaders []string, requestBody *bytes.Buffer, expectedStatusCode int, expectedBody string) (*http.Response, string) {
-
-	req, err := http.NewRequest("POST", requestURI, requestBody)
-	if err != nil {
-		tc.t.Errorf("failed to create request %s", err)
-		return nil, ""
-	}
-
-	applyHeaders(tc.t, req, requestHeaders)
-
-	return tc.AssertResponse(req, expectedStatusCode, expectedBody)
-}
-
-// AssertPutResponseBody PUT to a URI and assert the response code and body
-func (tc *Tester) AssertPutResponseBody(requestURI string, requestHeaders []string, requestBody *bytes.Buffer, expectedStatusCode int, expectedBody string) (*http.Response, string) {
-
-	req, err := http.NewRequest("PUT", requestURI, requestBody)
-	if err != nil {
-		tc.t.Errorf("failed to create request %s", err)
-		return nil, ""
-	}
-
-	applyHeaders(tc.t, req, requestHeaders)
-
-	return tc.AssertResponse(req, expectedStatusCode, expectedBody)
-}
-
-// AssertPatchResponseBody PATCH to a URI and assert the response code and body
-func (tc *Tester) AssertPatchResponseBody(requestURI string, requestHeaders []string, requestBody *bytes.Buffer, expectedStatusCode int, expectedBody string) (*http.Response, string) {
-
-	req, err := http.NewRequest("PATCH", requestURI, requestBody)
-	if err != nil {
-		tc.t.Errorf("failed to create request %s", err)
-		return nil, ""
-	}
-
-	applyHeaders(tc.t, req, requestHeaders)
-
-	return tc.AssertResponse(req, expectedStatusCode, expectedBody)
-}

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_adapt/auto_https_disable_redirects.txt

@@ -1,34 +0,0 @@
-{
-	auto_https disable_redirects
-}
-
-localhost
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"localhost"
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"automatic_https": {
-						"disable_redirects": true
-					}
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/auto_https_off.txt

@@ -1,37 +0,0 @@
-{
-	auto_https off
-}
-
-localhost
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"localhost"
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"tls_connection_policies": [
-						{}
-					],
-					"automatic_https": {
-						"disable": true
-					}
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/global_options.txt

@@ -1,72 +0,0 @@
-{
-	debug
-	http_port 8080
-	https_port 8443
-	default_sni localhost
-	order root first
-	storage file_system {
-		root /data
-	}
-	acme_ca https://example.com
-	acme_ca_root /path/to/ca.crt
-
-	email test@example.com
-	admin off
-	on_demand_tls {
-		ask https://example.com
-		interval 30s
-		burst 20
-	}
-	local_certs
-	key_type ed25519
-}
-
-:80
-----------
-{
-	"admin": {
-		"disabled": true
-	},
-	"logging": {
-		"logs": {
-			"default": {
-				"level": "DEBUG"
-			}
-		}
-	},
-	"storage": {
-		"module": "file_system",
-		"root": "/data"
-	},
-	"apps": {
-		"http": {
-			"http_port": 8080,
-			"https_port": 8443,
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					]
-				}
-			}
-		},
-		"tls": {
-			"automation": {
-				"policies": [
-					{
-						"issuer": {
-							"module": "internal"
-						}
-					}
-				],
-				"on_demand": {
-					"rate_limit": {
-						"interval": 30000000000,
-						"burst": 20
-					},
-					"ask": "https://example.com"
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/global_options_acme.txt

@@ -1,85 +0,0 @@
-{
-	debug
-	http_port 8080
-	https_port 8443
-	default_sni localhost
-	order root first
-	storage file_system {
-		root /data
-	}
-	acme_ca https://example.com
-	acme_eab {
-		key_id 4K2scIVbBpNd-78scadB2g
-		hmac   abcdefghijklmnopqrstuvwx-abcdefghijklnopqrstuvwxyz12ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefgh
-	}
-	acme_ca_root /path/to/ca.crt
-	email test@example.com
-	admin off
-	on_demand_tls {
-		ask https://example.com
-		interval 30s
-		burst 20
-	}
-
-	key_type ed25519
-}
-
-:80
-----------
-{
-	"admin": {
-		"disabled": true
-	},
-	"logging": {
-		"logs": {
-			"default": {
-				"level": "DEBUG"
-			}
-		}
-	},
-	"storage": {
-		"module": "file_system",
-		"root": "/data"
-	},
-	"apps": {
-		"http": {
-			"http_port": 8080,
-			"https_port": 8443,
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					]
-				}
-			}
-		},
-		"tls": {
-			"automation": {
-				"policies": [
-					{
-						"issuer": {
-							"ca": "https://example.com",
-							"email": "test@example.com",
-							"external_account": {
-								"hmac": "abcdefghijklmnopqrstuvwx-abcdefghijklnopqrstuvwxyz12ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefgh",
-								"key_id": "4K2scIVbBpNd-78scadB2g"
-							},
-							"module": "acme",
-							"trusted_roots_pem_files": [
-								"/path/to/ca.crt"
-							]
-						},
-						"key_type": "ed25519"
-					}
-				],
-				"on_demand": {
-					"rate_limit": {
-						"interval": 30000000000,
-						"burst": 20
-					},
-					"ask": "https://example.com"
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/handle_path.txt

@@ -1,52 +0,0 @@
-:80
-handle_path /api/v1/* {
-	respond "API v1"
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"path": [
-										"/api/v1/*"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"handler": "rewrite",
-													"strip_path_prefix": "/api/v1"
-												}
-											]
-										},
-										{
-											"handle": [
-												{
-													"body": "API v1",
-													"handler": "static_response"
-												}
-											]
-										}
-									]
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/http_only_on_any_address.txt

@@ -1,37 +0,0 @@
-:80 {
-	respond /version 200 {
-		body "hello from localhost"
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"path": [
-										"/version"
-									]
-								}
-							],
-							"handle": [
-								{
-									"body": "hello from localhost",
-									"handler": "static_response",
-									"status_code": 200
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/http_only_on_domain.txt

@@ -1,59 +0,0 @@
-http://a.caddy.localhost {
-	respond /version 200 {
-		body "hello from localhost"
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"a.caddy.localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "hello from localhost",
-													"handler": "static_response",
-													"status_code": 200
-												}
-											],
-											"match": [
-												{
-													"path": [
-														"/version"
-													]
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"automatic_https": {
-						"skip": [
-							"a.caddy.localhost"
-						]
-					}
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/http_only_on_localhost.txt

@@ -1,54 +0,0 @@
-localhost:80 {
-	respond /version 200 {
-		body "hello from localhost"
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "hello from localhost",
-													"handler": "static_response",
-													"status_code": 200
-												}
-											],
-											"match": [
-												{
-													"path": [
-														"/version"
-													]
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/http_only_on_non_standard_port.txt

@@ -1,59 +0,0 @@
-http://a.caddy.localhost:81 {
-	respond /version 200 {
-		body "hello from localhost"
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":81"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"a.caddy.localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "hello from localhost",
-													"handler": "static_response",
-													"status_code": 200
-												}
-											],
-											"match": [
-												{
-													"path": [
-														"/version"
-													]
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"automatic_https": {
-						"skip": [
-							"a.caddy.localhost"
-						]
-					}
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/https_on_domain.txt

@@ -1,54 +0,0 @@
-a.caddy.localhost {
-	respond /version 200 {
-		body "hello from localhost"
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"a.caddy.localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "hello from localhost",
-													"handler": "static_response",
-													"status_code": 200
-												}
-											],
-											"match": [
-												{
-													"path": [
-														"/version"
-													]
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/import_args_file.txt

@@ -1,49 +0,0 @@
-example.com
-
-import testdata/import_respond.txt Groot Rocket
-import testdata/import_respond.txt you "the confused man"
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"example.com"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "'I am Groot', hears Rocket",
-													"handler": "static_response"
-												},
-												{
-													"body": "'I am you', hears the confused man",
-													"handler": "static_response"
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/import_args_snippet.txt

@@ -1,83 +0,0 @@
-(logging) {
-	log {
-		output file /var/log/caddy/{args.0}.access.log
-	}
-}
-
-a.example.com {
-	import logging a.example.com
-}
-
-b.example.com {
-	import logging b.example.com
-}
-----------
-{
-	"logging": {
-		"logs": {
-			"default": {
-				"exclude": [
-					"http.log.access.log0",
-					"http.log.access.log1"
-				]
-			},
-			"log0": {
-				"writer": {
-					"filename": "/var/log/caddy/a.example.com.access.log",
-					"output": "file"
-				},
-				"include": [
-					"http.log.access.log0"
-				]
-			},
-			"log1": {
-				"writer": {
-					"filename": "/var/log/caddy/b.example.com.access.log",
-					"output": "file"
-				},
-				"include": [
-					"http.log.access.log1"
-				]
-			}
-		}
-	},
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"a.example.com"
-									]
-								}
-							],
-							"terminal": true
-						},
-						{
-							"match": [
-								{
-									"host": [
-										"b.example.com"
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"logs": {
-						"logger_names": {
-							"a.example.com": "log0",
-							"b.example.com": "log1"
-						}
-					}
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/log_roll_days.txt

@@ -1,47 +0,0 @@
-:80
-
-log {
-	output file /var/log/access.log {
-		roll_size 1gb
-		roll_keep 5
-		roll_keep_for 90d
-	}
-}
-----------
-{
-	"logging": {
-		"logs": {
-			"default": {
-				"exclude": [
-					"http.log.access.log0"
-				]
-			},
-			"log0": {
-				"writer": {
-					"filename": "/var/log/access.log",
-					"output": "file",
-					"roll_keep": 5,
-					"roll_keep_days": 90,
-					"roll_size_mb": 954
-				},
-				"include": [
-					"http.log.access.log0"
-				]
-			}
-		}
-	},
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"logs": {
-						"default_logger_name": "log0"
-					}
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/matcher_syntax.txt

@@ -1,77 +0,0 @@
-:80 {
-	@matcher {
-		method GET
-	}
-	respond @matcher "get"
-
-	@matcher2 method POST
-	respond @matcher2 "post"
-
-	@matcher3 not method PUT
-	respond @matcher3 "not put"
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"method": [
-										"GET"
-									]
-								}
-							],
-							"handle": [
-								{
-									"body": "get",
-									"handler": "static_response"
-								}
-							]
-						},
-						{
-							"match": [
-								{
-									"method": [
-										"POST"
-									]
-								}
-							],
-							"handle": [
-								{
-									"body": "post",
-									"handler": "static_response"
-								}
-							]
-						},
-						{
-							"match": [
-								{
-									"not": [
-										{
-											"method": [
-												"PUT"
-											]
-										}
-									]
-								}
-							],
-							"handle": [
-								{
-									"body": "not put",
-									"handler": "static_response"
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/not_block_merging.txt

@@ -1,49 +0,0 @@
-:80
-
-@test {
-	not {
-		header Abc "123"
-		header Bcd "123"
-	}
-}
-respond @test 403
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"not": [
-										{
-											"header": {
-												"Abc": [
-													"123"
-												],
-												"Bcd": [
-													"123"
-												]
-											}
-										}
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "static_response",
-									"status_code": 403
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/php_fastcgi_index_off.txt

@@ -1,66 +0,0 @@
-:8884
-
-php_fastcgi localhost:9000 {
-    # some php_fastcgi-specific subdirectives
-    split .php .php5
-    env VAR1 value1
-    env VAR2 value2
-    root /var/www
-    index off
-
-    # passed through to reverse_proxy (directive order doesn't matter!)
-    lb_policy random
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":8884"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"path": [
-										"*.php",
-										"*.php5"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "reverse_proxy",
-									"load_balancing": {
-										"selection_policy": {
-											"policy": "random"
-										}
-									},
-									"transport": {
-										"env": {
-											"VAR1": "value1",
-											"VAR2": "value2"
-										},
-										"protocol": "fastcgi",
-										"root": "/var/www",
-										"split_path": [
-											".php",
-											".php5"
-										]
-									},
-									"upstreams": [
-										{
-											"dial": "localhost:9000"
-										}
-									]
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/php_fastcgi_matcher.txt

@@ -1,112 +0,0 @@
-:8884
-
-@api host example.com
-php_fastcgi @api localhost:9000
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":8884"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"example.com"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"handler": "static_response",
-													"headers": {
-														"Location": [
-															"{http.request.uri.path}/"
-														]
-													},
-													"status_code": 308
-												}
-											],
-											"match": [
-												{
-													"file": {
-														"try_files": [
-															"{http.request.uri.path}/index.php"
-														]
-													},
-													"not": [
-														{
-															"path": [
-																"*/"
-															]
-														}
-													]
-												}
-											]
-										},
-										{
-											"handle": [
-												{
-													"handler": "rewrite",
-													"uri": "{http.matchers.file.relative}"
-												}
-											],
-											"match": [
-												{
-													"file": {
-														"split_path": [
-															".php"
-														],
-														"try_files": [
-															"{http.request.uri.path}",
-															"{http.request.uri.path}/index.php",
-															"index.php"
-														]
-													}
-												}
-											]
-										},
-										{
-											"handle": [
-												{
-													"handler": "reverse_proxy",
-													"transport": {
-														"protocol": "fastcgi",
-														"split_path": [
-															".php"
-														]
-													},
-													"upstreams": [
-														{
-															"dial": "localhost:9000"
-														}
-													]
-												}
-											],
-											"match": [
-												{
-													"path": [
-														"*.php"
-													]
-												}
-											]
-										}
-									]
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/php_fastcgi_subdirectives.txt

@@ -1,118 +0,0 @@
-:8884
-
-php_fastcgi localhost:9000 {
-    # some php_fastcgi-specific subdirectives
-    split .php .php5
-    env VAR1 value1
-    env VAR2 value2
-    root /var/www
-    index index.php5
-
-    # passed through to reverse_proxy (directive order doesn't matter!)
-    lb_policy random
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":8884"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"file": {
-										"try_files": [
-											"{http.request.uri.path}/index.php5"
-										]
-									},
-									"not": [
-										{
-											"path": [
-												"*/"
-											]
-										}
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "static_response",
-									"headers": {
-										"Location": [
-											"{http.request.uri.path}/"
-										]
-									},
-									"status_code": 308
-								}
-							]
-						},
-						{
-							"match": [
-								{
-									"file": {
-										"try_files": [
-											"{http.request.uri.path}",
-											"{http.request.uri.path}/index.php5",
-											"index.php5"
-										],
-										"split_path": [
-											".php",
-											".php5"
-										]
-									}
-								}
-							],
-							"handle": [
-								{
-									"handler": "rewrite",
-									"uri": "{http.matchers.file.relative}"
-								}
-							]
-						},
-						{
-							"match": [
-								{
-									"path": [
-										"*.php",
-										"*.php5"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "reverse_proxy",
-									"load_balancing": {
-										"selection_policy": {
-											"policy": "random"
-										}
-									},
-									"transport": {
-										"env": {
-											"VAR1": "value1",
-											"VAR2": "value2"
-										},
-										"protocol": "fastcgi",
-										"root": "/var/www",
-										"split_path": [
-											".php",
-											".php5"
-										]
-									},
-									"upstreams": [
-										{
-											"dial": "localhost:9000"
-										}
-									]
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/shorthand_parameterized_placeholders.txt

@@ -1,43 +0,0 @@
-localhost:80
-respond * "{header.content-type} {labels.0} {query.p} {path.0} {re.name.0}"
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "{http.request.header.content-type} {http.request.host.labels.0} {http.request.uri.query.p} {http.request.uri.path.0} {http.regexp.name.0}",
-													"handler": "static_response"
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/tls_client_auth_cert_file.txt

@@ -1,66 +0,0 @@
-localhost
-
-respond "hello from localhost"
-tls {
-	client_auth {
-		mode request 
-		trusted_ca_cert_file ../caddy.ca.cer
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "hello from localhost",
-													"handler": "static_response"
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"tls_connection_policies": [
-						{
-							"match": {
-								"sni": [
-									"localhost"
-								]
-							},
-							"client_authentication": {
-								"trusted_ca_certs": [
-									"MIIDSzCCAjOgAwIBAgIUfIRObjWNUA4jxQ/0x8BOCvE2Vw4wDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwHhcNMTkwODI4MTYyNTU5WhcNMjkwODI1MTYyNTU5WjAWMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5m5elxhQfMp/3aVJ4JnpN9PUSz6LlP6LePAPFU7gqohVVFVtDkChJAG3FNkNQNlieVTja/bgH9IcC6oKbROwdY1h0MvNV8AHHigvl03WuJD8g2ReVFXXwsnrPmKXCFzQyMI6TYk3m2gYrXsZOU1GLnfMRC3KAMRgE2F45twOs9hqG169YJ6mM2eQjzjCHWI6S2/iUYvYxRkCOlYUbLsMD/AhgAf1plzg6LPqNxtdlwxZnA0ytgkmhK67HtzJu0+ovUCsMv0RwcMhsEo9T8nyFAGt9XLZ63X5WpBCTUApaAUhnG0XnerjmUWb6eUWw4zev54sEfY5F3x002iQaW6cECAwEAAaOBkDCBjTAdBgNVHQ4EFgQU4CBUbZsS2GaNIkGRz/cBsD5ivjswUQYDVR0jBEowSIAU4CBUbZsS2GaNIkGRz/cBsD5ivjuhGqQYMBYxFDASBgNVBAMMC0Vhc3ktUlNBIENBghR8hE5uNY1QDiPFD/THwE4K8TZXDjAMBgNVHRMEBTADAQH/MAsGA1UdDwQEAwIBBjANBgkqhkiG9w0BAQsFAAOCAQEAKB3V4HIzoiO/Ch6WMj9bLJ2FGbpkMrcb/Eq01hT5zcfKD66lVS1MlK+cRL446Z2b2KDP1oFyVs+qmrmtdwrWgD+nfe2sBmmIHo9m9KygMkEOfG3MghGTEcS+0cTKEcoHYWYyOqQh6jnedXY8Cdm4GM1hAc9MiL3/sqV8YCVSLNnkoNysmr06/rZ0MCUZPGUtRmfd0heWhrfzAKw2HLgX+RAmpOE2MZqWcjvqKGyaRiaZks4nJkP6521aC2Lgp0HhCz1j8/uQ5ldoDszCnu/iro0NAsNtudTMD+YoLQxLqdleIh6CW+illc2VdXwj7mn6J04yns9jfE2jRjW/yTLFuQ=="
-								],
-								"mode": "request"
-							}
-						},
-						{}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt/tls_client_auth_inline_cert.txt

@@ -1,66 +0,0 @@
-localhost
-
-respond "hello from localhost"
-tls {
-	client_auth {
-		mode request 
-		trusted_ca_cert MIIDSzCCAjOgAwIBAgIUfIRObjWNUA4jxQ/0x8BOCvE2Vw4wDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwHhcNMTkwODI4MTYyNTU5WhcNMjkwODI1MTYyNTU5WjAWMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5m5elxhQfMp/3aVJ4JnpN9PUSz6LlP6LePAPFU7gqohVVFVtDkChJAG3FNkNQNlieVTja/bgH9IcC6oKbROwdY1h0MvNV8AHHigvl03WuJD8g2ReVFXXwsnrPmKXCFzQyMI6TYk3m2gYrXsZOU1GLnfMRC3KAMRgE2F45twOs9hqG169YJ6mM2eQjzjCHWI6S2/iUYvYxRkCOlYUbLsMD/AhgAf1plzg6LPqNxtdlwxZnA0ytgkmhK67HtzJu0+ovUCsMv0RwcMhsEo9T8nyFAGt9XLZ63X5WpBCTUApaAUhnG0XnerjmUWb6eUWw4zev54sEfY5F3x002iQaW6cECAwEAAaOBkDCBjTAdBgNVHQ4EFgQU4CBUbZsS2GaNIkGRz/cBsD5ivjswUQYDVR0jBEowSIAU4CBUbZsS2GaNIkGRz/cBsD5ivjuhGqQYMBYxFDASBgNVBAMMC0Vhc3ktUlNBIENBghR8hE5uNY1QDiPFD/THwE4K8TZXDjAMBgNVHRMEBTADAQH/MAsGA1UdDwQEAwIBBjANBgkqhkiG9w0BAQsFAAOCAQEAKB3V4HIzoiO/Ch6WMj9bLJ2FGbpkMrcb/Eq01hT5zcfKD66lVS1MlK+cRL446Z2b2KDP1oFyVs+qmrmtdwrWgD+nfe2sBmmIHo9m9KygMkEOfG3MghGTEcS+0cTKEcoHYWYyOqQh6jnedXY8Cdm4GM1hAc9MiL3/sqV8YCVSLNnkoNysmr06/rZ0MCUZPGUtRmfd0heWhrfzAKw2HLgX+RAmpOE2MZqWcjvqKGyaRiaZks4nJkP6521aC2Lgp0HhCz1j8/uQ5ldoDszCnu/iro0NAsNtudTMD+YoLQxLqdleIh6CW+illc2VdXwj7mn6J04yns9jfE2jRjW/yTLFuQ== 
-	}
-}
-----------
-{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":443"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"host": [
-										"localhost"
-									]
-								}
-							],
-							"handle": [
-								{
-									"handler": "subroute",
-									"routes": [
-										{
-											"handle": [
-												{
-													"body": "hello from localhost",
-													"handler": "static_response"
-												}
-											]
-										}
-									]
-								}
-							],
-							"terminal": true
-						}
-					],
-					"tls_connection_policies": [
-						{
-							"match": {
-								"sni": [
-									"localhost"
-								]
-							},
-							"client_authentication": {
-								"trusted_ca_certs": [
-									"MIIDSzCCAjOgAwIBAgIUfIRObjWNUA4jxQ/0x8BOCvE2Vw4wDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwHhcNMTkwODI4MTYyNTU5WhcNMjkwODI1MTYyNTU5WjAWMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK5m5elxhQfMp/3aVJ4JnpN9PUSz6LlP6LePAPFU7gqohVVFVtDkChJAG3FNkNQNlieVTja/bgH9IcC6oKbROwdY1h0MvNV8AHHigvl03WuJD8g2ReVFXXwsnrPmKXCFzQyMI6TYk3m2gYrXsZOU1GLnfMRC3KAMRgE2F45twOs9hqG169YJ6mM2eQjzjCHWI6S2/iUYvYxRkCOlYUbLsMD/AhgAf1plzg6LPqNxtdlwxZnA0ytgkmhK67HtzJu0+ovUCsMv0RwcMhsEo9T8nyFAGt9XLZ63X5WpBCTUApaAUhnG0XnerjmUWb6eUWw4zev54sEfY5F3x002iQaW6cECAwEAAaOBkDCBjTAdBgNVHQ4EFgQU4CBUbZsS2GaNIkGRz/cBsD5ivjswUQYDVR0jBEowSIAU4CBUbZsS2GaNIkGRz/cBsD5ivjuhGqQYMBYxFDASBgNVBAMMC0Vhc3ktUlNBIENBghR8hE5uNY1QDiPFD/THwE4K8TZXDjAMBgNVHRMEBTADAQH/MAsGA1UdDwQEAwIBBjANBgkqhkiG9w0BAQsFAAOCAQEAKB3V4HIzoiO/Ch6WMj9bLJ2FGbpkMrcb/Eq01hT5zcfKD66lVS1MlK+cRL446Z2b2KDP1oFyVs+qmrmtdwrWgD+nfe2sBmmIHo9m9KygMkEOfG3MghGTEcS+0cTKEcoHYWYyOqQh6jnedXY8Cdm4GM1hAc9MiL3/sqV8YCVSLNnkoNysmr06/rZ0MCUZPGUtRmfd0heWhrfzAKw2HLgX+RAmpOE2MZqWcjvqKGyaRiaZks4nJkP6521aC2Lgp0HhCz1j8/uQ5ldoDszCnu/iro0NAsNtudTMD+YoLQxLqdleIh6CW+illc2VdXwj7mn6J04yns9jfE2jRjW/yTLFuQ=="
-								],
-								"mode": "request"
-							}
-						},
-						{}
-					]
-				}
-			}
-		}
-	}
-}

caddytest/integration/caddyfile_adapt_test.go

@@ -1,47 +0,0 @@
-package integration
-
-import (
-	"io/ioutil"
-	"regexp"
-	"strings"
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddytest"
-)
-
-func TestCaddyfileAdaptToJSON(t *testing.T) {
-	// load the list of test files from the dir
-	files, err := ioutil.ReadDir("./caddyfile_adapt")
-	if err != nil {
-		t.Errorf("failed to read caddyfile_adapt dir: %s", err)
-	}
-
-	// prep a regexp to fix strings on windows
-	winNewlines := regexp.MustCompile(`\r?\n`)
-
-	for _, f := range files {
-		if f.IsDir() {
-			continue
-		}
-
-		// read the test file
-		filename := f.Name()
-		data, err := ioutil.ReadFile("./caddyfile_adapt/" + filename)
-		if err != nil {
-			t.Errorf("failed to read %s dir: %s", filename, err)
-		}
-
-		// split the Caddyfile (first) and JSON (second) parts
-		parts := strings.Split(string(data), "----------")
-		caddyfile, json := strings.TrimSpace(parts[0]), strings.TrimSpace(parts[1])
-
-		// replace windows newlines in the json with unix newlines
-		json = winNewlines.ReplaceAllString(json, "\n")
-
-		// run the test
-		ok := caddytest.CompareAdapt(t, caddyfile, "caddyfile", json)
-		if !ok {
-			t.Errorf("failed to adapt %s", filename)
-		}
-	}
-}

caddytest/integration/caddyfile_test.go

@@ -1,103 +0,0 @@
-package integration
-
-import (
-	"net/http"
-	"net/url"
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddytest"
-)
-
-func TestRespond(t *testing.T) {
-
-	// arrange
-	tester := caddytest.NewTester(t)
-	tester.InitServer(` 
-  {
-    http_port     9080
-    https_port    9443
-  }
-  
-  localhost:9080 {
-    respond /version 200 {
-      body "hello from localhost"
-    }	
-    }
-  `, "caddyfile")
-
-	// act and assert
-	tester.AssertGetResponse("http://localhost:9080/version", 200, "hello from localhost")
-}
-
-func TestRedirect(t *testing.T) {
-
-	// arrange
-	tester := caddytest.NewTester(t)
-	tester.InitServer(`
-  {
-    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
-	tester.AssertRedirect("http://localhost:9080/", "http://localhost:9080/hello", 301)
-
-	// follow redirect
-	tester.AssertGetResponse("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")
-}
-
-func TestReadCookie(t *testing.T) {
-
-	localhost, _ := url.Parse("http://localhost")
-	cookie := http.Cookie{
-		Name:  "clientname",
-		Value: "caddytest",
-	}
-
-	// arrange
-	tester := caddytest.NewTester(t)
-	tester.Client.Jar.SetCookies(localhost, []*http.Cookie{&cookie})
-	tester.InitServer(` 
-  {
-    http_port     9080
-    https_port    9443
-  }
-  
-  localhost:9080 {
-    templates {
-      root testdata
-    }
-    file_server {
-      root testdata
-    }
-  }
-  `, "caddyfile")
-
-	// act and assert
-	tester.AssertGetResponse("http://localhost:9080/cookie.html", 200, "<h2>Cookie.ClientName caddytest</h2>")
-}

caddytest/integration/sni_test.go

@@ -1,320 +0,0 @@
-package integration
-
-import (
-	"testing"
-
-	"github.com/caddyserver/caddy/v2/caddytest"
-)
-
-func TestDefaultSNI(t *testing.T) {
-
-	// arrange
-	tester := caddytest.NewTester(t)
-	tester.InitServer(`{
-    "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": {
-                  "any_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
-	tester.AssertGetResponse("https://127.0.0.1:9443/version", 200, "hello from a")
-}
-
-func TestDefaultSNIWithNamedHostAndExplicitIP(t *testing.T) {
-
-	// arrange
-	tester := caddytest.NewTester(t)
-	tester.InitServer(` 
-  {
-    "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": {
-                  "any_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
-	tester.AssertGetResponse("https://127.0.0.1:9443/version", 200, "hello from a")
-}
-
-func TestDefaultSNIWithPortMappingOnly(t *testing.T) {
-
-	// arrange
-	tester := caddytest.NewTester(t)
-	tester.InitServer(` 
-  {
-    "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": {
-                  "any_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
-	tester.AssertGetResponse("https://127.0.0.1:9443/version", 200, "hello from a")
-}
-
-func TestHttpOnlyOnDomainWithSNI(t *testing.T) {
-	caddytest.AssertAdapt(t, `
-	{
-		default_sni a.caddy.localhost
-	}
-	:80 {
-		respond /version 200 {
-			body "hello from localhost"
-		}
-	}
-	`, "caddyfile", `{
-	"apps": {
-		"http": {
-			"servers": {
-				"srv0": {
-					"listen": [
-						":80"
-					],
-					"routes": [
-						{
-							"match": [
-								{
-									"path": [
-										"/version"
-									]
-								}
-							],
-							"handle": [
-								{
-									"body": "hello from localhost",
-									"handler": "static_response",
-									"status_code": 200
-								}
-							]
-						}
-					]
-				}
-			}
-		}
-	}
-}`)
-}

caddytest/integration/testdata/cookie.html

@@ -1 +0,0 @@
-<h2>Cookie.ClientName {{.Cookie "clientname"}}</h2>

caddytest/integration/testdata/import_respond.txt

@@ -1 +0,0 @@
-respond "'I am {args.0}', hears {args.1}"

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,693 +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"
-	"context"
-	"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"
-	"go.uber.org/zap"
-)
-
-func cmdStart(fl Flags) (int, error) {
-	startCmdConfigFlag := fl.String("config")
-	startCmdConfigAdapterFlag := fl.String("adapter")
-	startCmdPidfileFlag := fl.String("pidfile")
-	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")
-	}
-	if startCmdPidfileFlag != "" {
-		cmd.Args = append(cmd.Args, "--pidfile", startCmdPidfileFlag)
-	}
-	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) {
-	caddy.TrapSignals()
-
-	runCmdConfigFlag := fl.String("config")
-	runCmdConfigAdapterFlag := fl.String("adapter")
-	runCmdResumeFlag := fl.Bool("resume")
-	runCmdLoadEnvfileFlag := fl.String("envfile")
-	runCmdPrintEnvFlag := fl.Bool("environ")
-	runCmdWatchFlag := fl.Bool("watch")
-	runCmdPidfileFlag := fl.String("pidfile")
-	runCmdPingbackFlag := fl.String("pingback")
-
-	// load all additional envs as soon as possible
-	if runCmdLoadEnvfileFlag != "" {
-		if err := loadEnvFromFile(runCmdLoadEnvfileFlag); err != nil {
-			return caddy.ExitCodeFailedStartup,
-				fmt.Errorf("loading additional environment variables: %v", err)
-		}
-	}
-
-	// 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 {
-			if runCmdConfigFlag == "" {
-				caddy.Log().Info("resuming from last configuration",
-					zap.String("autosave_file", caddy.ConfigAutosavePath))
-			} else {
-				// if they also specified a config file, user should be aware that we're not
-				// using it (doing so could lead to data/config loss by overwriting!)
-				caddy.Log().Warn("--config and --resume flags were used together; ignoring --config and 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
-		}
-	}
-
-	// 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)
-	}
-
-	// create pidfile
-	if runCmdPidfileFlag != "" {
-		err := caddy.PIDFile(runCmdPidfileFlag)
-		if err != nil {
-			caddy.Log().Error("unable to write PID file",
-				zap.String("pidfile", runCmdPidfileFlag),
-				zap.Error(err))
-		}
-	}
-
-	// 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")
-
-	err := apiRequest(stopCmdAddrFlag, http.MethodPost, "/stop", nil)
-	if err != nil {
-		caddy.Log().Warn("failed using API to stop instance", 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; use flag if specified
-	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
-	}
-
-	err = apiRequest(adminAddr, http.MethodPost, "/load", bytes.NewReader(config))
-	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
-}
-
-// apiRequest makes an API request to the endpoint adminAddr with the
-// given HTTP method and request URI. If body is non-nil, it will be
-// assumed to be Content-Type application/json.
-func apiRequest(adminAddr, method, uri string, body io.Reader) error {
-	// parse the admin address
-	if adminAddr == "" {
-		adminAddr = caddy.DefaultAdminListen
-	}
-	parsedAddr, err := caddy.ParseNetworkAddress(adminAddr)
-	if err != nil || parsedAddr.PortRangeSize() > 1 {
-		return fmt.Errorf("invalid admin address %s: %v", adminAddr, err)
-	}
-	origin := parsedAddr.JoinHostPort(0)
-	if parsedAddr.IsUnixNetwork() {
-		origin = "unixsocket" // hack so that http.NewRequest() is happy
-	}
-
-	// form the request
-	req, err := http.NewRequest(method, "http://"+origin+uri, body)
-	if err != nil {
-		return fmt.Errorf("making request: %v", err)
-	}
-	if parsedAddr.IsUnixNetwork() {
-		// When listening on a unix socket, the admin endpoint doesn't
-		// accept any Host header because there is no host:port for
-		// a unix socket's address. The server's host check is fairly
-		// strict for security reasons, so we don't allow just any
-		// Host header. For unix sockets, the Host header must be
-		// empty. Unfortunately, Go makes it impossible to make HTTP
-		// requests with an empty Host header... except with this one
-		// weird trick. (Hopefully they don't fix it. It's already
-		// hard enough to use HTTP over unix sockets.)
-		//
-		// An equivalent curl command would be something like:
-		// $ curl --unix-socket caddy.sock http:/:$REQUEST_URI
-		req.URL.Host = " "
-		req.Host = ""
-	} else {
-		req.Header.Set("Origin", origin)
-	}
-	if body != nil {
-		req.Header.Set("Content-Type", "application/json")
-	}
-
-	// make an HTTP client that dials our network type, since admin
-	// endpoints aren't always TCP, which is what the default transport
-	// expects; reuse is not of particular concern here
-	client := http.Client{
-		Transport: &http.Transport{
-			DialContext: func(_ context.Context, _, _ string) (net.Conn, error) {
-				return net.Dial(parsedAddr.Network, parsedAddr.JoinHostPort(0))
-			},
-		},
-	}
-
-	resp, err := client.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,310 +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
-
-	// Func 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] [--pidfile <file>]",
-		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.String("pidfile", "", "Path of file to which to write process ID")
-			fs.Bool("watch", false, "Reload changed config file automatically")
-			return fs
-		}(),
-	})
-
-	RegisterCommand(Command{
-		Name:  "run",
-		Func:  cmdRun,
-		Usage: "[--config <path> [--adapter <name>]] [--envfile <path>] [--environ] [--resume] [--watch] [--pidfile <fil>]",
-		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 --envfile is specified, an environment file with environment variables in
-the KEY=VALUE format will be loaded into the Caddy process.
-
-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.String("envfile", "", "Environment file to load")
-			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("pidfile", "", "Path of file to which to write process ID")
-			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,495 +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 (
-	"bufio"
-	"bytes"
-	"flag"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"log"
-	"net"
-	"os"
-	"path/filepath"
-	"runtime"
-	"runtime/debug"
-	"strconv"
-	"strings"
-	"time"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/caddyconfig"
-	"github.com/caddyserver/certmagic"
-	"go.uber.org/zap"
-)
-
-func init() {
-	// set a fitting User-Agent for ACME requests
-	goModule := caddy.GoModule()
-	cleanModVersion := strings.TrimPrefix(goModule.Version, "v")
-	certmagic.UserAgent = "Caddy/" + cleanModVersion
-
-	// by using Caddy, user indicates agreement to CA terms
-	// (very important, or ACME account creation will fail!)
-	certmagic.DefaultACME.Agreed = true
-}
-
-// Main implements the main function of the caddy command.
-// Call this if Caddy is to be the main() if your program.
-func Main() {
-	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) {
-	defer func() {
-		if err := recover(); err != nil {
-			log.Printf("[PANIC] watching config file: %v\n%s", err, debug.Stack())
-		}
-	}()
-
-	// 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, _ := caddy.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 loadEnvFromFile(envFile string) error {
-	file, err := os.Open(envFile)
-	if err != nil {
-		return fmt.Errorf("reading environment file: %v", err)
-	}
-	defer file.Close()
-
-	envMap, err := parseEnvFile(file)
-	if err != nil {
-		return fmt.Errorf("parsing environment file: %v", err)
-	}
-
-	for k, v := range envMap {
-		if err := os.Setenv(k, v); err != nil {
-			return fmt.Errorf("setting environment variables: %v", err)
-		}
-	}
-
-	return nil
-}
-
-func parseEnvFile(envInput io.Reader) (map[string]string, error) {
-	envMap := make(map[string]string)
-
-	scanner := bufio.NewScanner(envInput)
-	var line string
-	lineNumber := 0
-
-	for scanner.Scan() {
-		line = strings.TrimSpace(scanner.Text())
-		lineNumber++
-
-		// skip lines starting with comment
-		if strings.HasPrefix(line, "#") {
-			continue
-		}
-
-		// skip empty line
-		if len(line) == 0 {
-			continue
-		}
-
-		fields := strings.SplitN(line, "=", 2)
-		if len(fields) != 2 {
-			return nil, fmt.Errorf("can't parse line %d; line should be in KEY=VALUE format", lineNumber)
-		}
-
-		if strings.Contains(fields[0], " ") {
-			return nil, fmt.Errorf("bad key on line %d: contains whitespace", lineNumber)
-		}
-
-		key := fields[0]
-		val := fields[1]
-
-		if key == "" {
-			return nil, fmt.Errorf("missing or empty key on line %d", lineNumber)
-		}
-		envMap[key] = val
-	}
-
-	if err := scanner.Err(); err != nil {
-		return nil, err
-	}
-
-	return envMap, nil
-}
-
-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
-}

context.go

@@ -1,434 +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{}
-//    [][]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 typ.Elem().Kind() == reflect.Slice && isJSONRawMessage(typ.Elem().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++ {
-				innerVal := val.Index(i)
-				var allInner []interface{}
-				for j := 0; j < innerVal.Len(); j++ {
-					innerInnerVal, err := ctx.loadModuleInline(inlineModuleKey, moduleNamespace, innerVal.Index(j).Interface().(json.RawMessage))
-					if err != nil {
-						return nil, fmt.Errorf("position %d: %v", j, err)
-					}
-					allInner = append(allInner, innerInnerVal)
-				}
-				all = append(all, allInner)
-			}
-			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,35 +0,0 @@
-module github.com/caddyserver/caddy/v2
-
-go 1.14
-
-require (
-	github.com/Masterminds/sprig/v3 v3.1.0
-	github.com/alecthomas/chroma v0.7.4-0.20200517063913-500529fd43c1
-	github.com/aryann/difflib v0.0.0-20170710044230-e206f873d14a
-	github.com/caddyserver/certmagic v0.11.2
-	github.com/dustin/go-humanize v1.0.1-0.20200219035652-afde56e7acac
-	github.com/go-acme/lego/v3 v3.7.0
-	github.com/go-chi/chi v4.1.2+incompatible
-	github.com/gogo/protobuf v1.3.1
-	github.com/golang/protobuf v1.4.2
-	github.com/google/cel-go v0.5.1
-	github.com/jsternberg/zap-logfmt v1.2.0
-	github.com/klauspost/compress v1.10.10
-	github.com/klauspost/cpuid v1.3.0
-	github.com/libdns/libdns v0.0.0-20200501023120-186724ffc821
-	github.com/lucas-clemente/quic-go v0.17.1
-	github.com/naoina/go-stringutil v0.1.0 // indirect
-	github.com/naoina/toml v0.1.1
-	github.com/smallstep/certificates v0.15.0-rc.1.0.20200506212953-e855707dc274
-	github.com/smallstep/cli v0.14.4
-	github.com/smallstep/nosql v0.3.1
-	github.com/smallstep/truststore v0.9.5
-	github.com/yuin/goldmark v1.1.32
-	github.com/yuin/goldmark-highlighting v0.0.0-20200307114337-60d527fdb691
-	go.uber.org/zap v1.15.0
-	golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9
-	golang.org/x/net v0.0.0-20200625001655-4c5254603344
-	google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013
-	gopkg.in/natefinch/lumberjack.v2 v2.0.0
-	gopkg.in/yaml.v2 v2.3.0
-)

listeners.go

@@ -1,434 +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
-}
-
-// NetworkAddress 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 NetworkAddress struct {
-	Network   string
-	Host      string
-	StartPort uint
-	EndPort   uint
-}
-
-// IsUnixNetwork returns true if na.Network is
-// unix, unixgram, or unixpacket.
-func (na NetworkAddress) IsUnixNetwork() bool {
-	return isUnixNetwork(na.Network)
-}
-
-// JoinHostPort is like net.JoinHostPort, but where the port
-// is StartPort + offset.
-func (na NetworkAddress) JoinHostPort(offset uint) string {
-	if na.IsUnixNetwork() {
-		return na.Host
-	}
-	return net.JoinHostPort(na.Host, strconv.Itoa(int(na.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 (na NetworkAddress) PortRangeSize() uint {
-	return (na.EndPort - na.StartPort) + 1
-}
-
-func (na NetworkAddress) isLoopback() bool {
-	if na.IsUnixNetwork() {
-		return true
-	}
-	if na.Host == "localhost" {
-		return true
-	}
-	if ip := net.ParseIP(na.Host); ip != nil {
-		return ip.IsLoopback()
-	}
-	return false
-}
-
-func (na NetworkAddress) isWildcardInterface() bool {
-	if na.Host == "" {
-		return true
-	}
-	if ip := net.ParseIP(na.Host); ip != nil {
-		return ip.IsUnspecified()
-	}
-	return false
-}
-
-func (na NetworkAddress) port() string {
-	if na.StartPort == na.EndPort {
-		return strconv.FormatUint(uint64(na.StartPort), 10)
-	}
-	return fmt.Sprintf("%d-%d", na.StartPort, na.EndPort)
-}
-
-// String reconstructs the address string to the form expected
-// by ParseNetworkAddress(). If the address is a unix socket,
-// any non-zero port will be dropped.
-func (na NetworkAddress) String() string {
-	return JoinNetworkAddress(na.Network, na.Host, na.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) (NetworkAddress, error) {
-	var host, port string
-	network, host, port, err := SplitNetworkAddress(addr)
-	if network == "" {
-		network = "tcp"
-	}
-	if err != nil {
-		return NetworkAddress{}, err
-	}
-	if isUnixNetwork(network) {
-		return NetworkAddress{
-			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 NetworkAddress{}, fmt.Errorf("invalid start port: %v", err)
-	}
-	end, err = strconv.ParseUint(ports[1], 10, 16)
-	if err != nil {
-		return NetworkAddress{}, fmt.Errorf("invalid end port: %v", err)
-	}
-	if end < start {
-		return NetworkAddress{}, fmt.Errorf("end port must not be less than start port")
-	}
-	if (end - start) > maxPortSpan {
-		return NetworkAddress{}, fmt.Errorf("port range exceeds %d ports", maxPortSpan)
-	}
-	return NetworkAddress{
-		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 == "") || isUnixNetwork(network) {
-		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,25 +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
-
-package caddy
-
-func FuzzParseNetworkAddress(data []byte) int {
-	_, err := ParseNetworkAddress(string(data))
-	if err != nil {
-		return 0
-	}
-	return 1
-}

listeners_test.go

@@ -1,309 +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: "unix", host: "/foo/bar", port: "0",
-			expect: "unix//foo/bar",
-		},
-		{
-			network: "unix", host: "/foo/bar", port: "1234",
-			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 NetworkAddress
-		expectErr  bool
-	}{
-		{
-			input:     "",
-			expectErr: true,
-		},
-		{
-			input:     ":",
-			expectErr: true,
-		},
-		{
-			input: ":1234",
-			expectAddr: NetworkAddress{
-				Network:   "tcp",
-				Host:      "",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "tcp/:1234",
-			expectAddr: NetworkAddress{
-				Network:   "tcp",
-				Host:      "",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "tcp6/:1234",
-			expectAddr: NetworkAddress{
-				Network:   "tcp6",
-				Host:      "",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "tcp4/localhost:1234",
-			expectAddr: NetworkAddress{
-				Network:   "tcp4",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input: "unix//foo/bar",
-			expectAddr: NetworkAddress{
-				Network: "unix",
-				Host:    "/foo/bar",
-			},
-		},
-		{
-			input: "localhost:1234-1234",
-			expectAddr: NetworkAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-		},
-		{
-			input:     "localhost:2-1",
-			expectErr: true,
-		},
-		{
-			input: "localhost:0",
-			expectAddr: NetworkAddress{
-				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     NetworkAddress
-		offset uint
-		expect string
-	}{
-		{
-			pa: NetworkAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1234,
-			},
-			expect: "localhost:1234",
-		},
-		{
-			pa: NetworkAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1235,
-			},
-			expect: "localhost:1234",
-		},
-		{
-			pa: NetworkAddress{
-				Network:   "tcp",
-				Host:      "localhost",
-				StartPort: 1234,
-				EndPort:   1235,
-			},
-			offset: 1,
-			expect: "localhost:1235",
-		},
-		{
-			pa: NetworkAddress{
-				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,705 +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(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.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)
-	}
-
-	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 {
-		// only allow colorized output if this log is going to stdout or stderr
-		var colorize bool
-		switch cl.writerOpener.(type) {
-		case StdoutWriter, StderrWriter,
-			*StdoutWriter, *StderrWriter:
-			colorize = true
-		}
-		cl.encoder = newDefaultProductionLogEncoder(colorize)
-	}
-
-	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(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(true)
-	cl.levelEnabler = zapcore.InfoLevel
-
-	cl.buildCore()
-
-	return &defaultCustomLog{
-		CustomLog: cl,
-		logger:    zap.New(cl.core),
-	}, nil
-}
-
-func newDefaultProductionLogEncoder(colorize bool) 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"))
-		}
-		if colorize {
-			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)
-)

modules.go

@@ -1,366 +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"
-	"encoding/json"
-	"fmt"
-	"reflect"
-	"sort"
-	"strings"
-	"sync"
-)
-
-// Module is a type that is used as a Caddy module. In
-// addition to this interface, most modules will implement
-// some interface expected by their host module in order
-// to be useful. To learn which interface(s) to implement,
-// see the documentation for the host module. At a bare
-// minimum, this interface, when implemented, only provides
-// the module's ID and constructor function.
-//
-// Modules will often implement additional interfaces
-// including Provisioner, Validator, and CleanerUpper.
-// If a module implements these interfaces, their
-// methods are called during the module's lifespan.
-//
-// When a module is loaded by a host module, the following
-// happens: 1) ModuleInfo.New() is called to get a new
-// instance of the module. 2) The module's configuration is
-// unmarshaled into that instance. 3) If the module is a
-// Provisioner, the Provision() method is called. 4) If the
-// module is a Validator, the Validate() method is called.
-// 5) The module will probably be type-asserted from
-// interface{} to some other, more useful interface expected
-// by the host module. For example, HTTP handler modules are
-// type-asserted as caddyhttp.MiddlewareHandler values.
-// 6) When a module's containing Context is canceled, if it is
-// a CleanerUpper, its Cleanup() method is called.
-type Module interface {
-	// This method indicates that the type is a Caddy
-	// module. The returned ModuleInfo must have both
-	// a name and a constructor function. This method
-	// must not have any side-effects.
-	CaddyModule() ModuleInfo
-}
-
-// ModuleInfo represents a registered Caddy module.
-type ModuleInfo struct {
-	// ID is the "full name" of the module. It
-	// must be unique and properly namespaced.
-	ID ModuleID
-
-	// New returns a pointer to a new, empty
-	// instance of the module's type. This
-	// method must not have any side-effects,
-	// and no other initialization should
-	// occur within it. Any initialization
-	// of the returned value should be done
-	// in a Provision() method (see the
-	// Provisioner interface).
-	New func() Module
-}
-
-// ModuleID is a string that uniquely identifies a Caddy module. A
-// module ID is lightly structured. It consists of dot-separated
-// labels which form a simple hierarchy from left to right. The last
-// label is the module name, and the labels before that constitute
-// the namespace (or scope).
-//
-// Thus, a module ID has the form: <namespace>.<name>
-//
-// An ID with no dot has the empty namespace, which is appropriate
-// for app modules (these are "top-level" modules that Caddy core
-// loads and runs).
-//
-// Module IDs should be lowercase and use underscores (_) instead of
-// spaces.
-//
-// Examples of valid IDs:
-// - http
-// - http.handlers.file_server
-// - caddy.logging.encoders.json
-type ModuleID string
-
-// Namespace returns the namespace (or scope) portion of a module ID,
-// which is all but the last label of the ID. If the ID has only one
-// label, then the namespace is empty.
-func (id ModuleID) Namespace() string {
-	lastDot := strings.LastIndex(string(id), ".")
-	if lastDot < 0 {
-		return ""
-	}
-	return string(id)[:lastDot]
-}
-
-// Name returns the Name (last element) of a module ID.
-func (id ModuleID) Name() string {
-	if id == "" {
-		return ""
-	}
-	parts := strings.Split(string(id), ".")
-	return parts[len(parts)-1]
-}
-
-func (mi ModuleInfo) String() string { return string(mi.ID) }
-
-// ModuleMap is a map that can contain multiple modules,
-// where the map key is the module's name. (The namespace
-// is usually read from an associated field's struct tag.)
-// Because the module's name is given as the key in a
-// module map, the name does not have to be given in the
-// json.RawMessage.
-type ModuleMap map[string]json.RawMessage
-
-// RegisterModule registers a module by receiving a
-// plain/empty value of the module. For registration to
-// be properly recorded, this should be called in the
-// init phase of runtime. Typically, the module package
-// will do this as a side-effect of being imported.
-// This function panics if the module's info is
-// incomplete or invalid, or if the module is already
-// registered.
-func RegisterModule(instance Module) {
-	mod := instance.CaddyModule()
-
-	if mod.ID == "" {
-		panic("module ID missing")
-	}
-	if mod.ID == "caddy" || mod.ID == "admin" {
-		panic(fmt.Sprintf("module ID '%s' is reserved", mod.ID))
-	}
-	if mod.New == nil {
-		panic("missing ModuleInfo.New")
-	}
-	if val := mod.New(); val == nil {
-		panic("ModuleInfo.New must return a non-nil module instance")
-	}
-
-	modulesMu.Lock()
-	defer modulesMu.Unlock()
-
-	if _, ok := modules[string(mod.ID)]; ok {
-		panic(fmt.Sprintf("module already registered: %s", mod.ID))
-	}
-	modules[string(mod.ID)] = mod
-}
-
-// GetModule returns module information from its ID (full name).
-func GetModule(name string) (ModuleInfo, error) {
-	modulesMu.RLock()
-	defer modulesMu.RUnlock()
-	m, ok := modules[name]
-	if !ok {
-		return ModuleInfo{}, fmt.Errorf("module not registered: %s", name)
-	}
-	return m, nil
-}
-
-// GetModuleName returns a module's name (the last label of its ID)
-// from an instance of its value. If the value is not a module, an
-// empty string will be returned.
-func GetModuleName(instance interface{}) string {
-	var name string
-	if mod, ok := instance.(Module); ok {
-		name = mod.CaddyModule().ID.Name()
-	}
-	return name
-}
-
-// GetModuleID returns a module's ID from an instance of its value.
-// If the value is not a module, an empty string will be returned.
-func GetModuleID(instance interface{}) string {
-	var id string
-	if mod, ok := instance.(Module); ok {
-		id = string(mod.CaddyModule().ID)
-	}
-	return id
-}
-
-// GetModules returns all modules in the given scope/namespace.
-// For example, a scope of "foo" returns modules named "foo.bar",
-// "foo.loo", but not "bar", "foo.bar.loo", etc. An empty scope
-// returns top-level modules, for example "foo" or "bar". Partial
-// scopes are not matched (i.e. scope "foo.ba" does not match
-// name "foo.bar").
-//
-// Because modules are registered to a map under the hood, the
-// returned slice will be sorted to keep it deterministic.
-func GetModules(scope string) []ModuleInfo {
-	modulesMu.RLock()
-	defer modulesMu.RUnlock()
-
-	scopeParts := strings.Split(scope, ".")
-
-	// handle the special case of an empty scope, which
-	// should match only the top-level modules
-	if scope == "" {
-		scopeParts = []string{}
-	}
-
-	var mods []ModuleInfo
-iterateModules:
-	for id, m := range modules {
-		modParts := strings.Split(id, ".")
-
-		// match only the next level of nesting
-		if len(modParts) != len(scopeParts)+1 {
-			continue
-		}
-
-		// specified parts must be exact matches
-		for i := range scopeParts {
-			if modParts[i] != scopeParts[i] {
-				continue iterateModules
-			}
-		}
-
-		mods = append(mods, m)
-	}
-
-	// make return value deterministic
-	sort.Slice(mods, func(i, j int) bool {
-		return mods[i].ID < mods[j].ID
-	})
-
-	return mods
-}
-
-// Modules returns the names of all registered modules
-// in ascending lexicographical order.
-func Modules() []string {
-	modulesMu.RLock()
-	defer modulesMu.RUnlock()
-
-	names := make([]string, 0, len(modules))
-	for name := range modules {
-		names = append(names, name)
-	}
-
-	sort.Strings(names)
-
-	return names
-}
-
-// getModuleNameInline loads the string value from raw of moduleNameKey,
-// where raw must be a JSON encoding of a map. It returns that value,
-// along with the result of removing that key from raw.
-func getModuleNameInline(moduleNameKey string, raw json.RawMessage) (string, json.RawMessage, error) {
-	var tmp map[string]interface{}
-	err := json.Unmarshal(raw, &tmp)
-	if err != nil {
-		return "", nil, err
-	}
-
-	moduleName, ok := tmp[moduleNameKey].(string)
-	if !ok || moduleName == "" {
-		return "", nil, fmt.Errorf("module name not specified with key '%s' in %+v", moduleNameKey, tmp)
-	}
-
-	// remove key from the object, otherwise decoding it later
-	// will yield an error because the struct won't recognize it
-	// (this is only needed because we strictly enforce that
-	// all keys are recognized when loading modules)
-	delete(tmp, moduleNameKey)
-	result, err := json.Marshal(tmp)
-	if err != nil {
-		return "", nil, fmt.Errorf("re-encoding module configuration: %v", err)
-	}
-
-	return moduleName, result, nil
-}
-
-// Provisioner is implemented by modules which may need to perform
-// some additional "setup" steps immediately after being loaded.
-// Provisioning should be fast (imperceptible running time). If
-// any side-effects result in the execution of this function (e.g.
-// creating global state, any other allocations which require
-// garbage collection, opening files, starting goroutines etc.),
-// be sure to clean up properly by implementing the CleanerUpper
-// interface to avoid leaking resources.
-type Provisioner interface {
-	Provision(Context) error
-}
-
-// Validator is implemented by modules which can verify that their
-// configurations are valid. This method will be called after
-// Provision() (if implemented). Validation should always be fast
-// (imperceptible running time) and an error must be returned if
-// the module's configuration is invalid.
-type Validator interface {
-	Validate() error
-}
-
-// CleanerUpper is implemented by modules which may have side-effects
-// such as opened files, spawned goroutines, or allocated some sort
-// of non-stack state when they were provisioned. This method should
-// deallocate/cleanup those resources to prevent memory leaks. Cleanup
-// should be fast and efficient. Cleanup should work even if Provision
-// returns an error, to allow cleaning up from partial provisionings.
-type CleanerUpper interface {
-	Cleanup() error
-}
-
-// ParseStructTag parses a caddy struct tag into its keys and values.
-// It is very simple. The expected syntax is:
-// `caddy:"key1=val1 key2=val2 ..."`
-func ParseStructTag(tag string) (map[string]string, error) {
-	results := make(map[string]string)
-	pairs := strings.Split(tag, " ")
-	for i, pair := range pairs {
-		if pair == "" {
-			continue
-		}
-		parts := strings.SplitN(pair, "=", 2)
-		if len(parts) != 2 {
-			return nil, fmt.Errorf("missing key in '%s' (pair %d)", pair, i)
-		}
-		results[parts[0]] = parts[1]
-	}
-	return results, nil
-}
-
-// strictUnmarshalJSON is like json.Unmarshal but returns an error
-// if any of the fields are unrecognized. Useful when decoding
-// module configurations, where you want to be more sure they're
-// correct.
-func strictUnmarshalJSON(data []byte, v interface{}) error {
-	dec := json.NewDecoder(bytes.NewReader(data))
-	dec.DisallowUnknownFields()
-	return dec.Decode(v)
-}
-
-// isJSONRawMessage returns true if the type is encoding/json.RawMessage.
-func isJSONRawMessage(typ reflect.Type) bool {
-	return typ.PkgPath() == "encoding/json" && typ.Name() == "RawMessage"
-}
-
-// isModuleMapType returns true if the type is map[string]json.RawMessage.
-// It assumes that the string key is the module name, but this is not
-// always the case. To know for sure, this function must return true, but
-// also the struct tag where this type appears must NOT define an inline_key
-// attribute, which would mean that the module names appear inline with the
-// values, not in the key.
-func isModuleMapType(typ reflect.Type) bool {
-	return typ.Kind() == reflect.Map &&
-		typ.Key().Kind() == reflect.String &&
-		isJSONRawMessage(typ.Elem())
-}
-
-var (
-	modules   = make(map[string]ModuleInfo)
-	modulesMu sync.RWMutex
-)

modules/caddyhttp/app.go

@@ -1,455 +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 caddyhttp
-
-import (
-	"context"
-	"crypto/tls"
-	"fmt"
-	"net"
-	"net/http"
-	"strconv"
-	"time"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-	"github.com/lucas-clemente/quic-go/http3"
-	"go.uber.org/zap"
-	"golang.org/x/net/http2"
-	"golang.org/x/net/http2/h2c"
-)
-
-func init() {
-	caddy.RegisterModule(App{})
-}
-
-// App is a robust, production-ready HTTP server.
-//
-// HTTPS is enabled by default if host matchers with qualifying names are used
-// in any of routes; certificates are automatically provisioned and renewed.
-// Additionally, automatic HTTPS will also enable HTTPS for servers that listen
-// only on the HTTPS port but which do not have any TLS connection policies
-// defined by adding a good, default TLS connection policy.
-//
-// In HTTP routes, additional placeholders are available (replace any `*`):
-//
-// Placeholder | Description
-// ------------|---------------
-// `{http.request.cookie.*}` | HTTP request cookie
-// `{http.request.header.*}` | Specific request header field
-// `{http.request.host.labels.*}` | Request host labels (0-based from right); e.g. for foo.example.com: 0=com, 1=example, 2=foo
-// `{http.request.host}` | The host part of the request's Host header
-// `{http.request.hostport}` | The host and port from the request's Host header
-// `{http.request.method}` | The request method
-// `{http.request.orig_method}` | The request's original method
-// `{http.request.orig_uri.path.dir}` | The request's original directory
-// `{http.request.orig_uri.path.file}` | The request's original filename
-// `{http.request.orig_uri.path}` | The request's original path
-// `{http.request.orig_uri.query}` | The request's original query string (without `?`)
-// `{http.request.orig_uri}` | The request's original URI
-// `{http.request.port}` | The port part of the request's Host header
-// `{http.request.proto}` | The protocol of the request
-// `{http.request.remote.host}` | The host part of the remote client's address
-// `{http.request.remote.port}` | The port part of the remote client's address
-// `{http.request.remote}` | The address of the remote client
-// `{http.request.scheme}` | The request scheme
-// `{http.request.tls.version}` | The TLS version name
-// `{http.request.tls.cipher_suite}` | The TLS cipher suite
-// `{http.request.tls.resumed}` | The TLS connection resumed a previous connection
-// `{http.request.tls.proto}` | The negotiated next protocol
-// `{http.request.tls.proto_mutual}` | The negotiated next protocol was advertised by the server
-// `{http.request.tls.server_name}` | The server name requested by the client, if any
-// `{http.request.tls.client.fingerprint}` | The SHA256 checksum of the client certificate
-// `{http.request.tls.client.public_key}` | The public key of the client certificate.
-// `{http.request.tls.client.public_key_sha256}` | The SHA256 checksum of the client's public key.
-// `{http.request.tls.client.issuer}` | The issuer DN of the client certificate
-// `{http.request.tls.client.serial}` | The serial number of the client certificate
-// `{http.request.tls.client.subject}` | The subject DN of the client certificate
-// `{http.request.tls.client.san.dns_names.*}` | SAN DNS names(index optional)
-// `{http.request.tls.client.san.emails.*}` | SAN email addresses (index optional)
-// `{http.request.tls.client.san.ips.*}` | SAN IP addresses (index optional)
-// `{http.request.tls.client.san.uris.*}` | SAN URIs (index optional)
-// `{http.request.uri.path.*}` | Parts of the path, split by `/` (0-based from left)
-// `{http.request.uri.path.dir}` | The directory, excluding leaf filename
-// `{http.request.uri.path.file}` | The filename of the path, excluding directory
-// `{http.request.uri.path}` | The path component of the request URI
-// `{http.request.uri.query.*}` | Individual query string value
-// `{http.request.uri.query}` | The query string (without `?`)
-// `{http.request.uri}` | The full request URI
-// `{http.response.header.*}` | Specific response header field
-// `{http.vars.*}` | Custom variables in the HTTP handler chain
-type App struct {
-	// HTTPPort specifies the port to use for HTTP (as opposed to HTTPS),
-	// which is used when setting up HTTP->HTTPS redirects or ACME HTTP
-	// challenge solvers. Default: 80.
-	HTTPPort int `json:"http_port,omitempty"`
-
-	// HTTPSPort specifies the port to use for HTTPS, which is used when
-	// solving the ACME TLS-ALPN challenges, or whenever HTTPS is needed
-	// but no specific port number is given. Default: 443.
-	HTTPSPort int `json:"https_port,omitempty"`
-
-	// GracePeriod is how long to wait for active connections when shutting
-	// down the server. Once the grace period is over, connections will
-	// be forcefully closed.
-	GracePeriod caddy.Duration `json:"grace_period,omitempty"`
-
-	// Servers is the list of servers, keyed by arbitrary names chosen
-	// at your discretion for your own convenience; the keys do not
-	// affect functionality.
-	Servers map[string]*Server `json:"servers,omitempty"`
-
-	servers     []*http.Server
-	h3servers   []*http3.Server
-	h3listeners []net.PacketConn
-
-	ctx    caddy.Context
-	logger *zap.Logger
-	tlsApp *caddytls.TLS
-
-	// used temporarily between phases 1 and 2 of auto HTTPS
-	allCertDomains []string
-}
-
-// CaddyModule returns the Caddy module information.
-func (App) CaddyModule() caddy.ModuleInfo {
-	return caddy.ModuleInfo{
-		ID:  "http",
-		New: func() caddy.Module { return new(App) },
-	}
-}
-
-// Provision sets up the app.
-func (app *App) Provision(ctx caddy.Context) error {
-	// store some references
-	tlsAppIface, err := ctx.App("tls")
-	if err != nil {
-		return fmt.Errorf("getting tls app: %v", err)
-	}
-	app.tlsApp = tlsAppIface.(*caddytls.TLS)
-	app.ctx = ctx
-	app.logger = ctx.Logger(app)
-
-	repl := caddy.NewReplacer()
-
-	// this provisions the matchers for each route,
-	// and prepares auto HTTP->HTTPS redirects, and
-	// is required before we provision each server
-	err = app.automaticHTTPSPhase1(ctx, repl)
-	if err != nil {
-		return err
-	}
-
-	// prepare each server
-	for srvName, srv := range app.Servers {
-		srv.tlsApp = app.tlsApp
-		srv.logger = app.logger.Named("log")
-		srv.errorLogger = app.logger.Named("log.error")
-
-		// only enable access logs if configured
-		if srv.Logs != nil {
-			srv.accessLogger = app.logger.Named("log.access")
-		}
-
-		// if not explicitly configured by the user, disallow TLS
-		// client auth bypass (domain fronting) which could
-		// otherwise be exploited by sending an unprotected SNI
-		// value during a TLS handshake, then putting a protected
-		// domain in the Host header after establishing connection;
-		// this is a safe default, but we allow users to override
-		// it for example in the case of running a proxy where
-		// domain fronting is desired and access is not restricted
-		// based on hostname
-		if srv.StrictSNIHost == nil && srv.hasTLSClientAuth() {
-			app.logger.Info("enabling strict SNI-Host matching because TLS client auth is configured",
-				zap.String("server_name", srvName),
-			)
-			trueBool := true
-			srv.StrictSNIHost = &trueBool
-		}
-
-		// process each listener address
-		for i := range srv.Listen {
-			lnOut, err := repl.ReplaceOrErr(srv.Listen[i], true, true)
-			if err != nil {
-				return fmt.Errorf("server %s, listener %d: %v",
-					srvName, i, err)
-			}
-			srv.Listen[i] = lnOut
-		}
-
-		// set up each listener modifier
-		if srv.ListenerWrappersRaw != nil {
-			vals, err := ctx.LoadModule(srv, "ListenerWrappersRaw")
-			if err != nil {
-				return fmt.Errorf("loading listener wrapper modules: %v", err)
-			}
-			var hasTLSPlaceholder bool
-			for i, val := range vals.([]interface{}) {
-				if _, ok := val.(*tlsPlaceholderWrapper); ok {
-					if i == 0 {
-						// putting the tls placeholder wrapper first is nonsensical because
-						// that is the default, implicit setting: without it, all wrappers
-						// will go after the TLS listener anyway
-						return fmt.Errorf("it is unnecessary to specify the TLS listener wrapper in the first position because that is the default")
-					}
-					if hasTLSPlaceholder {
-						return fmt.Errorf("TLS listener wrapper can only be specified once")
-					}
-					hasTLSPlaceholder = true
-				}
-				srv.listenerWrappers = append(srv.listenerWrappers, val.(caddy.ListenerWrapper))
-			}
-			// if any wrappers were configured but the TLS placeholder wrapper is
-			// absent, prepend it so all defined wrappers come after the TLS
-			// handshake; this simplifies logic when starting the server, since we
-			// can simply assume the TLS placeholder will always be there
-			if !hasTLSPlaceholder && len(srv.listenerWrappers) > 0 {
-				srv.listenerWrappers = append([]caddy.ListenerWrapper{new(tlsPlaceholderWrapper)}, srv.listenerWrappers...)
-			}
-		}
-
-		// pre-compile the primary handler chain, and be sure to wrap it in our
-		// route handler so that important security checks are done, etc.
-		primaryRoute := emptyHandler
-		if srv.Routes != nil {
-			err := srv.Routes.ProvisionHandlers(ctx)
-			if err != nil {
-				return fmt.Errorf("server %s: setting up route handlers: %v", srvName, err)
-			}
-			primaryRoute = srv.Routes.Compile(emptyHandler)
-		}
-		srv.primaryHandlerChain = srv.wrapPrimaryRoute(primaryRoute)
-
-		// pre-compile the error handler chain
-		if srv.Errors != nil {
-			err := srv.Errors.Routes.Provision(ctx)
-			if err != nil {
-				return fmt.Errorf("server %s: setting up server error handling routes: %v", srvName, err)
-			}
-			srv.errorHandlerChain = srv.Errors.Routes.Compile(errorEmptyHandler)
-		}
-
-		// prepare the TLS connection policies
-		err = srv.TLSConnPolicies.Provision(ctx)
-		if err != nil {
-			return fmt.Errorf("server %s: setting up TLS connection policies: %v", srvName, err)
-		}
-	}
-
-	return nil
-}
-
-// Validate ensures the app's configuration is valid.
-func (app *App) Validate() error {
-	// each server must use distinct listener addresses
-	lnAddrs := make(map[string]string)
-	for srvName, srv := range app.Servers {
-		for _, addr := range srv.Listen {
-			listenAddr, err := caddy.ParseNetworkAddress(addr)
-			if err != nil {
-				return fmt.Errorf("invalid listener address '%s': %v", addr, err)
-			}
-			// check that every address in the port range is unique to this server;
-			// we do not use <= here because PortRangeSize() adds 1 to EndPort for us
-			for i := uint(0); i < listenAddr.PortRangeSize(); i++ {
-				addr := caddy.JoinNetworkAddress(listenAddr.Network, listenAddr.Host, strconv.Itoa(int(listenAddr.StartPort+i)))
-				if sn, ok := lnAddrs[addr]; ok {
-					return fmt.Errorf("server %s: listener address repeated: %s (already claimed by server '%s')", srvName, addr, sn)
-				}
-				lnAddrs[addr] = srvName
-			}
-		}
-	}
-
-	return nil
-}
-
-// Start runs the app. It finishes automatic HTTPS if enabled,
-// including management of certificates.
-func (app *App) Start() error {
-	for srvName, srv := range app.Servers {
-		s := &http.Server{
-			ReadTimeout:       time.Duration(srv.ReadTimeout),
-			ReadHeaderTimeout: time.Duration(srv.ReadHeaderTimeout),
-			WriteTimeout:      time.Duration(srv.WriteTimeout),
-			IdleTimeout:       time.Duration(srv.IdleTimeout),
-			MaxHeaderBytes:    srv.MaxHeaderBytes,
-			Handler:           srv,
-		}
-
-		// enable h2c if configured
-		if srv.AllowH2C {
-			h2server := &http2.Server{
-				IdleTimeout: time.Duration(srv.IdleTimeout),
-			}
-			s.Handler = h2c.NewHandler(srv, h2server)
-		}
-
-		for _, lnAddr := range srv.Listen {
-			listenAddr, err := caddy.ParseNetworkAddress(lnAddr)
-			if err != nil {
-				return fmt.Errorf("%s: parsing listen address '%s': %v", srvName, lnAddr, err)
-			}
-			for portOffset := uint(0); portOffset < listenAddr.PortRangeSize(); portOffset++ {
-				// create the listener for this socket
-				hostport := listenAddr.JoinHostPort(portOffset)
-				ln, err := caddy.Listen(listenAddr.Network, hostport)
-				if err != nil {
-					return fmt.Errorf("%s: listening on %s: %v", listenAddr.Network, hostport, err)
-				}
-
-				// wrap listener before TLS (up to the TLS placeholder wrapper)
-				var lnWrapperIdx int
-				for i, lnWrapper := range srv.listenerWrappers {
-					if _, ok := lnWrapper.(*tlsPlaceholderWrapper); ok {
-						lnWrapperIdx = i + 1 // mark the next wrapper's spot
-						break
-					}
-					ln = lnWrapper.WrapListener(ln)
-				}
-
-				// enable TLS if there is a policy and if this is not the HTTP port
-				useTLS := len(srv.TLSConnPolicies) > 0 && int(listenAddr.StartPort+portOffset) != app.httpPort()
-				if useTLS {
-					// create TLS listener
-					tlsCfg := srv.TLSConnPolicies.TLSConfig(app.ctx)
-					ln = tls.NewListener(ln, tlsCfg)
-
-					/////////
-					// TODO: HTTP/3 support is experimental for now
-					if srv.ExperimentalHTTP3 {
-						app.logger.Info("enabling experimental HTTP/3 listener",
-							zap.String("addr", hostport),
-						)
-						h3ln, err := caddy.ListenPacket("udp", hostport)
-						if err != nil {
-							return fmt.Errorf("getting HTTP/3 UDP listener: %v", err)
-						}
-						h3srv := &http3.Server{
-							Server: &http.Server{
-								Addr:      hostport,
-								Handler:   srv,
-								TLSConfig: tlsCfg,
-							},
-						}
-						go h3srv.Serve(h3ln)
-						app.h3servers = append(app.h3servers, h3srv)
-						app.h3listeners = append(app.h3listeners, h3ln)
-						srv.h3server = h3srv
-					}
-					/////////
-				}
-
-				// finish wrapping listener where we left off before TLS
-				for i := lnWrapperIdx; i < len(srv.listenerWrappers); i++ {
-					ln = srv.listenerWrappers[i].WrapListener(ln)
-				}
-
-				// if binding to port 0, the OS chooses a port for us;
-				// but the user won't know the port unless we print it
-				if listenAddr.StartPort == 0 && listenAddr.EndPort == 0 {
-					app.logger.Info("port 0 listener",
-						zap.String("input_address", lnAddr),
-						zap.String("actual_address", ln.Addr().String()),
-					)
-				}
-
-				app.logger.Debug("starting server loop",
-					zap.String("address", ln.Addr().String()),
-					zap.Bool("http3", srv.ExperimentalHTTP3),
-					zap.Bool("tls", useTLS),
-				)
-
-				go s.Serve(ln)
-				app.servers = append(app.servers, s)
-			}
-		}
-	}
-
-	// finish automatic HTTPS by finally beginning
-	// certificate management
-	err := app.automaticHTTPSPhase2()
-	if err != nil {
-		return fmt.Errorf("finalizing automatic HTTPS: %v", err)
-	}
-
-	return nil
-}
-
-// Stop gracefully shuts down the HTTP server.
-func (app *App) Stop() error {
-	ctx := context.Background()
-	if app.GracePeriod > 0 {
-		var cancel context.CancelFunc
-		ctx, cancel = context.WithTimeout(ctx, time.Duration(app.GracePeriod))
-		defer cancel()
-	}
-	for _, s := range app.servers {
-		err := s.Shutdown(ctx)
-		if err != nil {
-			return err
-		}
-	}
-
-	// close the http3 servers; it's unclear whether the bug reported in
-	// https://github.com/caddyserver/caddy/pull/2727#issuecomment-526856566
-	// was ever truly fixed, since it seemed racey/nondeterministic; but
-	// recent tests in 2020 were unable to replicate the issue again after
-	// repeated attempts (the bug manifested after a config reload; i.e.
-	// reusing a http3 server or listener was problematic), but it seems
-	// to be working fine now
-	for _, s := range app.h3servers {
-		// TODO: CloseGracefully, once implemented upstream
-		// (see https://github.com/lucas-clemente/quic-go/issues/2103)
-		err := s.Close()
-		if err != nil {
-			return err
-		}
-	}
-
-	// closing an http3.Server does not close their underlying listeners
-	// since apparently the listener can be used both by servers and
-	// clients at the same time; so we need to manually call Close()
-	// on the underlying h3 listeners (see lucas-clemente/quic-go#2103)
-	for _, pc := range app.h3listeners {
-		err := pc.Close()
-		if err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
-func (app *App) httpPort() int {
-	if app.HTTPPort == 0 {
-		return DefaultHTTPPort
-	}
-	return app.HTTPPort
-}
-
-func (app *App) httpsPort() int {
-	if app.HTTPSPort == 0 {
-		return DefaultHTTPSPort
-	}
-	return app.HTTPSPort
-}
-
-// Interface guards
-var (
-	_ caddy.App         = (*App)(nil)
-	_ caddy.Provisioner = (*App)(nil)
-	_ caddy.Validator   = (*App)(nil)
-)

modules/caddyhttp/autohttps.go

@@ -1,632 +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 caddyhttp
-
-import (
-	"fmt"
-	"net/http"
-	"strconv"
-	"strings"
-
-	"github.com/caddyserver/caddy/v2"
-	"github.com/caddyserver/caddy/v2/modules/caddytls"
-	"github.com/caddyserver/certmagic"
-	"go.uber.org/zap"
-)
-
-// AutoHTTPSConfig is used to disable automatic HTTPS
-// or certain aspects of it for a specific server.
-// HTTPS is enabled automatically and by default when
-// qualifying hostnames are available from the config.
-type AutoHTTPSConfig struct {
-	// If true, automatic HTTPS will be entirely disabled.
-	Disabled bool `json:"disable,omitempty"`
-
-	// If true, only automatic HTTP->HTTPS redirects will
-	// be disabled.
-	DisableRedir bool `json:"disable_redirects,omitempty"`
-
-	// Hosts/domain names listed here will not be included
-	// in automatic HTTPS (they will not have certificates
-	// loaded nor redirects applied).
-	Skip []string `json:"skip,omitempty"`
-
-	// Hosts/domain names listed here will still be enabled
-	// for automatic HTTPS (unless in the Skip list), except
-	// that certificates will not be provisioned and managed
-	// for these names.
-	SkipCerts []string `json:"skip_certificates,omitempty"`
-
-	// By default, automatic HTTPS will obtain and renew
-	// certificates for qualifying hostnames. However, if
-	// a certificate with a matching SAN is already loaded
-	// into the cache, certificate management will not be
-	// enabled. To force automated certificate management
-	// regardless of loaded certificates, set this to true.
-	IgnoreLoadedCerts bool `json:"ignore_loaded_certificates,omitempty"`
-}
-
-// Skipped returns true if name is in skipSlice, which
-// should be either the Skip or SkipCerts field on ahc.
-func (ahc AutoHTTPSConfig) Skipped(name string, skipSlice []string) bool {
-	for _, n := range skipSlice {
-		if name == n {
-			return true
-		}
-	}
-	return false
-}
-
-// automaticHTTPSPhase1 provisions all route matchers, determines
-// which domain names found in the routes qualify for automatic
-// HTTPS, and sets up HTTP->HTTPS redirects. This phase must occur
-// at the beginning of provisioning, because it may add routes and
-// even servers to the app, which still need to be set up with the
-// rest of them during provisioning.
-func (app *App) automaticHTTPSPhase1(ctx caddy.Context, repl *caddy.Replacer) error {
-	// this map acts as a set to store the domain names
-	// for which we will manage certificates automatically
-	uniqueDomainsForCerts := make(map[string]struct{})
-
-	// this maps domain names for automatic HTTP->HTTPS
-	// redirects to their destination server addresses
-	// (there might be more than 1 if bind is used; see
-	// https://github.com/caddyserver/caddy/issues/3443)
-	redirDomains := make(map[string][]caddy.NetworkAddress)
-
-	for srvName, srv := range app.Servers {
-		// as a prerequisite, provision route matchers; this is
-		// required for all routes on all servers, and must be
-		// done before we attempt to do phase 1 of auto HTTPS,
-		// since we have to access the decoded host matchers the
-		// handlers will be provisioned later
-		if srv.Routes != nil {
-			err := srv.Routes.ProvisionMatchers(ctx)
-			if err != nil {
-				return fmt.Errorf("server %s: setting up route matchers: %v", srvName, err)
-			}
-		}
-
-		// prepare for automatic HTTPS
-		if srv.AutoHTTPS == nil {
-			srv.AutoHTTPS = new(AutoHTTPSConfig)
-		}
-		if srv.AutoHTTPS.Disabled {
-			continue
-		}
-
-		// skip if all listeners use the HTTP port
-		if !srv.listenersUseAnyPortOtherThan(app.httpPort()) {
-			app.logger.Info("server is listening only on the HTTP port, so no automatic HTTPS will be applied to this server",
-				zap.String("server_name", srvName),
-				zap.Int("http_port", app.httpPort()),
-			)
-			srv.AutoHTTPS.Disabled = true
-			continue
-		}
-
-		// if all listeners are on the HTTPS port, make sure
-		// there is at least one TLS connection policy; it
-		// should be obvious that they want to use TLS without
-		// needing to specify one empty policy to enable it
-		if srv.TLSConnPolicies == nil &&
-			!srv.listenersUseAnyPortOtherThan(app.httpsPort()) {
-			app.logger.Info("server is listening only on the HTTPS port but has no TLS connection policies; adding one to enable TLS",
-				zap.String("server_name", srvName),
-				zap.Int("https_port", app.httpsPort()),
-			)
-			srv.TLSConnPolicies = caddytls.ConnectionPolicies{new(caddytls.ConnectionPolicy)}
-		}
-
-		// find all qualifying domain names (deduplicated) in this server
-		// (this is where we need the provisioned, decoded request matchers)
-		serverDomainSet := make(map[string]struct{})
-		for routeIdx, route := range srv.Routes {
-			for matcherSetIdx, matcherSet := range route.MatcherSets {
-				for matcherIdx, m := range matcherSet {
-					if hm, ok := m.(*MatchHost); ok {
-						for hostMatcherIdx, d := range *hm {
-							var err error
-							d, err = repl.ReplaceOrErr(d, true, false)
-							if err != nil {
-								return fmt.Errorf("%s: route %d, matcher set %d, matcher %d, host matcher %d: %v",
-									srvName, routeIdx, matcherSetIdx, matcherIdx, hostMatcherIdx, err)
-							}
-							if !srv.AutoHTTPS.Skipped(d, srv.AutoHTTPS.Skip) {
-								serverDomainSet[d] = struct{}{}
-							}
-						}
-					}
-				}
-			}
-		}
-
-		// nothing more to do here if there are no domains that qualify for
-		// automatic HTTPS and there are no explicit TLS connection policies:
-		// if there is at least one domain but no TLS conn policy (F&&T), we'll
-		// add one below; if there are no domains but at least one TLS conn
-		// policy (meaning TLS is enabled) (T&&F), it could be a catch-all with
-		// on-demand TLS -- and in that case we would still need HTTP->HTTPS
-		// redirects, which we set up below; hence these two conditions
-		if len(serverDomainSet) == 0 && len(srv.TLSConnPolicies) == 0 {
-			continue
-		}
-
-		// for all the hostnames we found, filter them so we have
-		// a deduplicated list of names for which to obtain certs
-		for d := range serverDomainSet {
-			if certmagic.SubjectQualifiesForCert(d) &&
-				!srv.AutoHTTPS.Skipped(d, srv.AutoHTTPS.SkipCerts) {
-				// if a certificate for this name is already loaded,
-				// don't obtain another one for it, unless we are
-				// supposed to ignore loaded certificates
-				if !srv.AutoHTTPS.IgnoreLoadedCerts &&
-					len(app.tlsApp.AllMatchingCertificates(d)) > 0 {
-					app.logger.Info("skipping automatic certificate management because one or more matching certificates are already loaded",
-						zap.String("domain", d),
-						zap.String("server_name", srvName),
-					)
-					continue
-				}
-
-				// most clients don't accept wildcards like *.tld... we
-				// can handle that, but as a courtesy, warn the user
-				if strings.Contains(d, "*") &&
-					strings.Count(strings.Trim(d, "."), ".") == 1 {
-					app.logger.Warn("most clients do not trust second-level wildcard certificates (*.tld)",
-						zap.String("domain", d))
-				}
-
-				uniqueDomainsForCerts[d] = struct{}{}
-			}
-		}
-
-		// tell the server to use TLS if it is not already doing so
-		if srv.TLSConnPolicies == nil {
-			srv.TLSConnPolicies = caddytls.ConnectionPolicies{new(caddytls.ConnectionPolicy)}
-		}
-
-		// nothing left to do if auto redirects are disabled
-		if srv.AutoHTTPS.DisableRedir {
-			continue
-		}
-
-		app.logger.Info("enabling automatic HTTP->HTTPS redirects",
-			zap.String("server_name", srvName),
-		)
-
-		// create HTTP->HTTPS redirects
-		for _, addr := range srv.Listen {
-			// figure out the address we will redirect to...
-			addr, err := caddy.ParseNetworkAddress(addr)
-			if err != nil {
-				return fmt.Errorf("%s: invalid listener address: %v", srvName, addr)
-			}
-
-			// this address might not have a hostname, i.e. might be a
-			// catch-all address for a particular port; we need to keep
-			// track if it is, so we can set up redirects for it anyway
-			// (e.g. the user might have enabled on-demand TLS); we use
-			// an empty string to indicate a catch-all, which we have to
-			// treat special later
-			if len(serverDomainSet) == 0 {
-				redirDomains[""] = append(redirDomains[""], addr)
-				continue
-			}
-
-			// ...and associate it with each domain in this server
-			for d := range serverDomainSet {
-				// if this domain is used on more than one HTTPS-enabled
-				// port, we'll have to choose one, so prefer the HTTPS port
-				if _, ok := redirDomains[d]; !ok ||
-					addr.StartPort == uint(app.httpsPort()) {
-					redirDomains[d] = append(redirDomains[d], addr)
-				}
-			}
-		}
-	}
-
-	// we now have a list of all the unique names for which we need certs;
-	// turn the set into a slice so that phase 2 can use it
-	app.allCertDomains = make([]string, 0, len(uniqueDomainsForCerts))
-	var internal, external []string
-uniqueDomainsLoop:
-	for d := range uniqueDomainsForCerts {
-		// whether or not there is already an automation policy for this
-		// name, we should add it to the list to manage a cert for it
-		app.allCertDomains = append(app.allCertDomains, d)
-
-		// some names we've found might already have automation policies
-		// explicitly specified for them; we should exclude those from
-		// our hidden/implicit policy, since applying a name to more than
-		// one automation policy would be confusing and an error
-		if app.tlsApp.Automation != nil {
-			for _, ap := range app.tlsApp.Automation.Policies {
-				for _, apHost := range ap.Subjects {
-					if apHost == d {
-						continue uniqueDomainsLoop
-					}
-				}
-			}
-		}
-
-		// if no automation policy exists for the name yet, we
-		// will associate it with an implicit one
-		if certmagic.SubjectQualifiesForPublicCert(d) {
-			external = append(external, d)
-		} else {
-			internal = append(internal, d)
-		}
-	}
-
-	// ensure there is an automation policy to handle these certs
-	err := app.createAutomationPolicies(ctx, external, internal)
-	if err != nil {
-		return err
-	}
-
-	// we need to reduce the mapping, i.e. group domains by address
-	// since new routes are appended to servers by their address
-	domainsByAddr := make(map[string][]string)
-	for domain, addrs := range redirDomains {
-		for _, addr := range addrs {
-			addrStr := addr.String()
-			domainsByAddr[addrStr] = append(domainsByAddr[addrStr], domain)
-		}
-	}
-
-	// these keep track of the redirect server address(es)
-	// and the routes for those servers which actually
-	// respond with the redirects
-	redirServerAddrs := make(map[string]struct{})
-	redirServers := make(map[string][]Route)
-	var redirRoutes RouteList
-
-	for addrStr, domains := range domainsByAddr {
-		// build the matcher set for this redirect route; (note that we happen
-		// to bypass Provision and Validate steps for these matcher modules)
-		matcherSet := MatcherSet{MatchProtocol("http")}
-		// match on known domain names, unless it's our special case of a
-		// catch-all which is an empty string (common among catch-all sites
-		// that enable on-demand TLS for yet-unknown domain names)
-		if !(len(domains) == 1 && domains[0] == "") {
-			matcherSet = append(matcherSet, MatchHost(domains))
-		}
-
-		// build the address to which to redirect
-		addr, err := caddy.ParseNetworkAddress(addrStr)
-		if err != nil {
-			return err
-		}
-		redirTo := "https://{http.request.host}"
-		if addr.StartPort != uint(app.httpsPort()) {
-			redirTo += ":" + strconv.Itoa(int(addr.StartPort))
-		}
-		redirTo += "{http.request.uri}"
-
-		// build the route
-		redirRoute := Route{
-			MatcherSets: []MatcherSet{matcherSet},
-			Handlers: []MiddlewareHandler{
-				StaticResponse{
-					StatusCode: WeakString(strconv.Itoa(http.StatusPermanentRedirect)),
-					Headers: http.Header{
-						"Location":   []string{redirTo},
-						"Connection": []string{"close"},
-					},
-					Close: true,
-				},
-			},
-		}
-
-		// use the network/host information from the address,
-		// but change the port to the HTTP port then rebuild
-		redirAddr := addr
-		redirAddr.StartPort = uint(app.httpPort())
-		redirAddr.EndPort = redirAddr.StartPort
-		redirAddrStr := redirAddr.String()
-
-		redirServers[redirAddrStr] = append(redirServers[redirAddrStr], redirRoute)
-	}
-
-	// on-demand TLS means that hostnames may be used which are not
-	// explicitly defined in the config, and we still need to redirect
-	// those; so we can append a single catch-all route (notice there
-	// is no Host matcher) after the other redirect routes which will
-	// allow us to handle unexpected/new hostnames... however, it's
-	// not entirely clear what the redirect destination should be,
-	// so I'm going to just hard-code the app's HTTPS port and call
-	// it good for now...
-	// TODO: This implies that all plaintext requests will be blindly
-	// redirected to their HTTPS equivalent, even if this server
-	// doesn't handle that hostname at all; I don't think this is a
-	// bad thing, and it also obscures the actual hostnames that this
-	// server is configured to match on, which may be desirable, but
-	// it's not something that should be relied on. We can change this
-	// if we want to.
-	appendCatchAll := func(routes []Route) []Route {
-		redirTo := "https://{http.request.host}"
-		if app.httpsPort() != DefaultHTTPSPort {
-			redirTo += ":" + strconv.Itoa(app.httpsPort())
-		}
-		redirTo += "{http.request.uri}"
-		routes = append(routes, Route{
-			MatcherSets: []MatcherSet{{MatchProtocol("http")}},
-			Handlers: []MiddlewareHandler{
-				StaticResponse{
-					StatusCode: WeakString(strconv.Itoa(http.StatusPermanentRedirect)),
-					Headers: http.Header{
-						"Location":   []string{redirTo},
-						"Connection": []string{"close"},
-					},
-					Close: true,
-				},
-			},
-		})
-		return routes
-	}
-
-redirServersLoop:
-	for redirServerAddr, routes := range redirServers {
-		// for each redirect listener, see if there's already a
-		// server configured to listen on that exact address; if so,
-		// simply add the redirect route to the end of its route
-		// list; otherwise, we'll create a new server for all the
-		// listener addresses that are unused and serve the
-		// remaining redirects from it
-		for srvName, srv := range app.Servers {
-			if srv.hasListenerAddress(redirServerAddr) {
-				// user has configured a server for the same address
-				// that the redirect runs from; simply append our
-				// redirect route to the existing routes, with a
-				// caveat that their config might override ours
-				app.logger.Warn("user server is listening on same interface as automatic HTTP->HTTPS redirects; user-configured routes might override these redirects",
-					zap.String("server_name", srvName),
-					zap.String("interface", redirServerAddr),
-				)
-				srv.Routes = append(srv.Routes, appendCatchAll(routes)...)
-				continue redirServersLoop
-			}
-		}
-
-		// no server with this listener address exists;
-		// save this address and route for custom server
-		redirServerAddrs[redirServerAddr] = struct{}{}
-		redirRoutes = append(redirRoutes, routes...)
-	}
-
-	// if there are routes remaining which do not belong
-	// in any existing server, make our own to serve the
-	// rest of the redirects
-	if len(redirServerAddrs) > 0 {
-		redirServerAddrsList := make([]string, 0, len(redirServerAddrs))
-		for a := range redirServerAddrs {
-			redirServerAddrsList = append(redirServerAddrsList, a)
-		}
-		app.Servers["remaining_auto_https_redirects"] = &Server{
-			Listen: redirServerAddrsList,
-			Routes: appendCatchAll(redirRoutes),
-		}
-	}
-
-	return nil
-}
-
-// createAutomationPolicy ensures that automated certificates for this
-// app are managed properly. This adds up to two automation policies:
-// one for the public names, and one for the internal names. If a catch-all
-// automation policy exists, it will be shallow-copied and used as the
-// base for the new ones (this is important for preserving behavior the
-// user intends to be "defaults").
-func (app *App) createAutomationPolicies(ctx caddy.Context, publicNames, internalNames []string) error {
-	// before we begin, loop through the existing automation policies
-	// and, for any ACMEIssuers we find, make sure they're filled in
-	// with default values that might be specified in our HTTP app; also
-	// look for a base (or "catch-all" / default) automation policy,
-	// which we're going to essentially require, to make sure it has
-	// those defaults, too
-	var basePolicy *caddytls.AutomationPolicy
-	var foundBasePolicy bool
-	if app.tlsApp.Automation == nil {
-		// we will expect this to not be nil from now on
-		app.tlsApp.Automation = new(caddytls.AutomationConfig)
-	}
-	for _, ap := range app.tlsApp.Automation.Policies {
-		// set up default issuer -- honestly, this is only
-		// really necessary because the HTTP app is opinionated
-		// and has settings which could be inferred as new
-		// defaults for the ACMEIssuer in the TLS app
-		if ap.Issuer == nil {
-			ap.Issuer = new(caddytls.ACMEIssuer)
-		}
-		if acmeIssuer, ok := ap.Issuer.(*caddytls.ACMEIssuer); ok {
-			err := app.fillInACMEIssuer(acmeIssuer)
-			if err != nil {
-				return err
-			}
-		}
-
-		// while we're here, is this the catch-all/base policy?
-		if !foundBasePolicy && len(ap.Subjects) == 0 {
-			basePolicy = ap
-			foundBasePolicy = true
-		}
-	}
-
-	if basePolicy == nil {
-		// no base policy found, we will make one!
-		basePolicy = new(caddytls.AutomationPolicy)
-	}
-
-	// if the basePolicy has an existing ACMEIssuer, let's
-	// use it, otherwise we'll make one
-	baseACMEIssuer, _ := basePolicy.Issuer.(*caddytls.ACMEIssuer)
-	if baseACMEIssuer == nil {
-		// note that this happens if basePolicy.Issuer is nil
-		// OR if it is not nil but is not an ACMEIssuer
-		baseACMEIssuer = new(caddytls.ACMEIssuer)
-	}
-
-	// if there was a base policy to begin with, we already
-	// filled in its issuer's defaults; if there wasn't, we
-	// stil need to do that
-	if !foundBasePolicy {
-		err := app.fillInACMEIssuer(baseACMEIssuer)
-		if err != nil {
-			return err
-		}
-	}
-
-	// never overwrite any other issuer that might already be configured
-	if basePolicy.Issuer == nil {
-		basePolicy.Issuer = baseACMEIssuer
-	}
-
-	if !foundBasePolicy {
-		// there was no base policy to begin with, so add
-		// our base/catch-all policy - this will serve the
-		// public-looking names as well as any other names
-		// that don't match any other policy
-		app.tlsApp.AddAutomationPolicy(basePolicy)
-	} else {
-		// a base policy already existed; we might have
-		// changed it, so re-provision it
-		err := basePolicy.Provision(app.tlsApp)
-		if err != nil {
-			return err
-		}
-	}
-
-	// public names will be taken care of by the base (catch-all)
-	// policy, which we've ensured exists if not already specified;
-	// internal names, however, need to be handled by an internal
-	// issuer, which we need to make a new policy for, scoped to
-	// just those names (yes, this logic is a bit asymmetric, but
-	// it works, because our assumed/natural default issuer is an
-	// ACME issuer)
-	if len(internalNames) > 0 {
-		internalIssuer := new(caddytls.InternalIssuer)
-
-		// shallow-copy the base policy; we want to inherit
-		// from it, not replace it... this takes two lines to
-		// overrule compiler optimizations
-		policyCopy := *basePolicy
-		newPolicy := &policyCopy
-
-		// very important to provision the issuer, since we
-		// are bypassing the JSON-unmarshaling step
-		if err := internalIssuer.Provision(ctx); err != nil {
-			return err
-		}
-
-		// this policy should apply only to the given names
-		// and should use our issuer -- yes, this overrides
-		// any issuer that may have been set in the base
-		// policy, but we do this because these names do not
-		// already have a policy associated with them, which
-		// is easy to do; consider the case of a Caddyfile
-		// that has only "localhost" as a name, but sets the
-		// default/global ACME CA to the Let's Encrypt staging
-		// endpoint... they probably don't intend to change the
-		// fundamental set of names that setting applies to,
-		// rather they just want to change the CA for the set
-		// of names that would normally use the production API;
-		// anyway, that gets into the weeds a bit...
-		newPolicy.Subjects = internalNames
-		newPolicy.Issuer = internalIssuer
-
-		err := app.tlsApp.AddAutomationPolicy(newPolicy)
-		if err != nil {
-			return err
-		}
-	}
-
-	// we just changed a lot of stuff, so double-check that it's all good
-	err := app.tlsApp.Validate()
-	if err != nil {
-		return err
-	}
-
-	return nil
-}
-
-// fillInACMEIssuer fills in default values into acmeIssuer that
-// are defined in app; these values at time of writing are just
-// app.HTTPPort and app.HTTPSPort, which are used by ACMEIssuer.
-// Sure, we could just use the global/CertMagic defaults, but if
-// a user has configured those ports in the HTTP app, it makes
-// sense to use them in the TLS app too, even if they forgot (or
-// were too lazy, like me) to set it in each automation policy
-// that uses it -- this just makes things a little less tedious
-// for the user, so they don't have to repeat those ports in
-// potentially many places. This function never steps on existing
-// config values. If any changes are made, acmeIssuer is
-// reprovisioned. acmeIssuer must not be nil.
-func (app *App) fillInACMEIssuer(acmeIssuer *caddytls.ACMEIssuer) error {
-	if app.HTTPPort > 0 || app.HTTPSPort > 0 {
-		if acmeIssuer.Challenges == nil {
-			acmeIssuer.Challenges = new(caddytls.ChallengesConfig)
-		}
-	}
-	if app.HTTPPort > 0 {
-		if acmeIssuer.Challenges.HTTP == nil {
-			acmeIssuer.Challenges.HTTP = new(caddytls.HTTPChallengeConfig)
-		}
-		// don't overwrite existing explicit config
-		if acmeIssuer.Challenges.HTTP.AlternatePort == 0 {
-			acmeIssuer.Challenges.HTTP.AlternatePort = app.HTTPPort
-		}
-	}
-	if app.HTTPSPort > 0 {
-		if acmeIssuer.Challenges.TLSALPN == nil {
-			acmeIssuer.Challenges.TLSALPN = new(caddytls.TLSALPNChallengeConfig)
-		}
-		// don't overwrite existing explicit config
-		if acmeIssuer.Challenges.TLSALPN.AlternatePort == 0 {
-			acmeIssuer.Challenges.TLSALPN.AlternatePort = app.HTTPSPort
-		}
-	}
-	// we must provision all ACME issuers, even if nothing
-	// was changed, because we don't know if they are new
-	// and haven't been provisioned yet; if an ACME issuer
-	// never gets provisioned, its Agree field stays false,
-	// which leads to, um, problems later on
-	return acmeIssuer.Provision(app.ctx)
-}
-
-// automaticHTTPSPhase2 begins certificate management for
-// all names in the qualifying domain set for each server.
-// This phase must occur after provisioning and at the end
-// of app start, after all the servers have been started.
-// Doing this last ensures that there won't be any race
-// for listeners on the HTTP or HTTPS ports when management
-// is async (if CertMagic's solvers bind to those ports
-// first, then our servers would fail to bind to them,
-// which would be bad, since CertMagic's bindings are
-// temporary and don't serve the user's sites!).
-func (app *App) automaticHTTPSPhase2() error {
-	if len(app.allCertDomains) == 0 {
-		return nil
-	}
-	app.logger.Info("enabling automatic TLS certificate management",
-		zap.Strings("domains", app.allCertDomains),
-	)
-	err := app.tlsApp.Manage(app.allCertDomains)
-	if err != nil {
-		return fmt.Errorf("managing certificates for %v: %s", app.allCertDomains, err)
-	}
-	app.allCertDomains = nil // no longer needed; allow GC to deallocate
-	return nil
-}