pax_global_header00006660000000000000000000000064151431221530014507gustar00rootroot0000000000000052 comment=5d4b9350d15fcf45ac2dfb59544f17137a065a9e challtestsrv-1.4.2/000077500000000000000000000000001514312215300142315ustar00rootroot00000000000000challtestsrv-1.4.2/.gitignore000066400000000000000000000003001514312215300162120ustar00rootroot00000000000000# Binaries for programs and plugins *.exe *.exe~ *.dll *.so *.dylib # Test binary, build with `go test -c` *.test # Output of the go coverage tool, specifically when used with LiteIDE *.out challtestsrv-1.4.2/.golangci.yaml000066400000000000000000000023561514312215300167640ustar00rootroot00000000000000version: "2" linters: enable: - asasalint - asciicheck - bidichk - bodyclose - containedctx - copyloopvar - decorder - dogsled - dupword - durationcheck - errchkjson - errorlint - forcetypeassert - ginkgolinter - gocheckcompilerdirectives - gocognit - goconst - gocyclo - goheader - gomoddirectives - gomodguard - goprintffuncname - importas - inamedparam - ireturn - loggercheck - makezero - mirror - misspell - nakedret - nolintlint - nonamedreturns - nosprintfhostport - perfsprint - predeclared - reassign - revive - tagalign - testableexamples - testifylint - thelper - unconvert - unparam - usestdlibvars - usetesting - wastedassign settings: gocyclo: min-complexity: 25 misspell: locale: US exclusions: generated: lax presets: - comments - common-false-positives - legacy - std-error-handling issues: max-issues-per-linter: 0 max-same-issues: 0 formatters: enable: - gofmt - gofumpt - goimports exclusions: generated: lax paths: - third_party$ - builtin$ - examples$ challtestsrv-1.4.2/.travis.yml000066400000000000000000000017551514312215300163520ustar00rootroot00000000000000language: go go: - "stable" cache: directories: - $GOPATH/pkg/mod # Override the base install phase so that the project can be installed using # `-mod=vendor` to use the vendored dependencies install: # Install `golangci-lint` using their installer script - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.29.0 # Install `cover` and `goveralls` without `GO111MODULE` enabled so that we # don't download project dependencies and just put the tools in $GOPATH/bin - GO111MODULE=off go get golang.org/x/tools/cmd/cover - GO111MODULE=off go get github.com/mattn/goveralls - go mod tidy - git diff --exit-code go.mod - git diff --exit-code go.sum - go mod download - go mod vendor - go install -mod=vendor -v -race ./... script: - set -e - golangci-lint run - go test -mod=vendor -v -race -covermode=atomic -coverprofile=coverage.out ./... - goveralls -coverprofile=coverage.out -service=travis-ci challtestsrv-1.4.2/CODE_OF_CONDUCT.md000066400000000000000000000002421514312215300170260ustar00rootroot00000000000000# Contributor Code of Conduct The contributor code of conduct is available for reference [on the community forum](https://community.letsencrypt.org/guidelines). challtestsrv-1.4.2/LICENSE000066400000000000000000000405251514312215300152440ustar00rootroot00000000000000Mozilla Public License Version 2.0 ================================== 1. Definitions -------------- 1.1. "Contributor" means each individual or legal entity that creates, contributes to the creation of, or owns Covered Software. 1.2. "Contributor Version" means the combination of the Contributions of others (if any) used by a Contributor and that particular Contributor's Contribution. 1.3. "Contribution" means Covered Software of a particular Contributor. 1.4. "Covered Software" means Source Code Form to which the initial Contributor has attached the notice in Exhibit A, the Executable Form of such Source Code Form, and Modifications of such Source Code Form, in each case including portions thereof. 1.5. "Incompatible With Secondary Licenses" means (a) that the initial Contributor has attached the notice described in Exhibit B to the Covered Software; or (b) that the Covered Software was made available under the terms of version 1.1 or earlier of the License, but not also under the terms of a Secondary License. 1.6. "Executable Form" means any form of the work other than Source Code Form. 1.7. "Larger Work" means a work that combines Covered Software with other material, in a separate file or files, that is not Covered Software. 1.8. "License" means this document. 1.9. "Licensable" means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently, any and all of the rights conveyed by this License. 1.10. "Modifications" means any of the following: (a) any file in Source Code Form that results from an addition to, deletion from, or modification of the contents of Covered Software; or (b) any new file in Source Code Form that contains any Covered Software. 1.11. "Patent Claims" of a Contributor means any patent claim(s), including without limitation, method, process, and apparatus claims, in any patent Licensable by such Contributor that would be infringed, but for the grant of the License, by the making, using, selling, offering for sale, having made, import, or transfer of either its Contributions or its Contributor Version. 1.12. "Secondary License" means either the GNU General Public License, Version 2.0, the GNU Lesser General Public License, Version 2.1, the GNU Affero General Public License, Version 3.0, or any later versions of those licenses. 1.13. "Source Code Form" means the form of the work preferred for making modifications. 1.14. "You" (or "Your") means an individual or a legal entity exercising rights under this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with You. For purposes of this definition, "control" means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity. 2. License Grants and Conditions -------------------------------- 2.1. Grants Each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license: (a) under intellectual property rights (other than patent or trademark) Licensable by such Contributor to use, reproduce, make available, modify, display, perform, distribute, and otherwise exploit its Contributions, either on an unmodified basis, with Modifications, or as part of a Larger Work; and (b) under Patent Claims of such Contributor to make, use, sell, offer for sale, have made, import, and otherwise transfer either its Contributions or its Contributor Version. 2.2. Effective Date The licenses granted in Section 2.1 with respect to any Contribution become effective for each Contribution on the date the Contributor first distributes such Contribution. 2.3. Limitations on Grant Scope The licenses granted in this Section 2 are the only rights granted under this License. No additional rights or licenses will be implied from the distribution or licensing of Covered Software under this License. Notwithstanding Section 2.1(b) above, no patent license is granted by a Contributor: (a) for any code that a Contributor has removed from Covered Software; or (b) for infringements caused by: (i) Your and any other third party's modifications of Covered Software, or (ii) the combination of its Contributions with other software (except as part of its Contributor Version); or (c) under Patent Claims infringed by Covered Software in the absence of its Contributions. This License does not grant any rights in the trademarks, service marks, or logos of any Contributor (except as may be necessary to comply with the notice requirements in Section 3.4). 2.4. Subsequent Licenses No Contributor makes additional grants as a result of Your choice to distribute the Covered Software under a subsequent version of this License (see Section 10.2) or under the terms of a Secondary License (if permitted under the terms of Section 3.3). 2.5. Representation Each Contributor represents that the Contributor believes its Contributions are its original creation(s) or it has sufficient rights to grant the rights to its Contributions conveyed by this License. 2.6. Fair Use This License is not intended to limit any rights You have under applicable copyright doctrines of fair use, fair dealing, or other equivalents. 2.7. Conditions Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in Section 2.1. 3. Responsibilities ------------------- 3.1. Distribution of Source Form All distribution of Covered Software in Source Code Form, including any Modifications that You create or to which You contribute, must be under the terms of this License. You must inform recipients that the Source Code Form of the Covered Software is governed by the terms of this License, and how they can obtain a copy of this License. You may not attempt to alter or restrict the recipients' rights in the Source Code Form. 3.2. Distribution of Executable Form If You distribute Covered Software in Executable Form then: (a) such Covered Software must also be made available in Source Code Form, as described in Section 3.1, and You must inform recipients of the Executable Form how they can obtain a copy of such Source Code Form by reasonable means in a timely manner, at a charge no more than the cost of distribution to the recipient; and (b) You may distribute such Executable Form under the terms of this License, or sublicense it under different terms, provided that the license for the Executable Form does not attempt to limit or alter the recipients' rights in the Source Code Form under this License. 3.3. Distribution of a Larger Work You may create and distribute a Larger Work under terms of Your choice, provided that You also comply with the requirements of this License for the Covered Software. If the Larger Work is a combination of Covered Software with a work governed by one or more Secondary Licenses, and the Covered Software is not Incompatible With Secondary Licenses, this License permits You to additionally distribute such Covered Software under the terms of such Secondary License(s), so that the recipient of the Larger Work may, at their option, further distribute the Covered Software under the terms of either this License or such Secondary License(s). 3.4. Notices You may not remove or alter the substance of any license notices (including copyright notices, patent notices, disclaimers of warranty, or limitations of liability) contained within the Source Code Form of the Covered Software, except that You may alter any license notices to the extent required to remedy known factual inaccuracies. 3.5. Application of Additional Terms You may choose to offer, and to charge a fee for, warranty, support, indemnity or liability obligations to one or more recipients of Covered Software. However, You may do so only on Your own behalf, and not on behalf of any Contributor. You must make it absolutely clear that any such warranty, support, indemnity, or liability obligation is offered by You alone, and You hereby agree to indemnify every Contributor for any liability incurred by such Contributor as a result of warranty, support, indemnity or liability terms You offer. You may include additional disclaimers of warranty and limitations of liability specific to any jurisdiction. 4. Inability to Comply Due to Statute or Regulation --------------------------------------------------- If it is impossible for You to comply with any of the terms of this License with respect to some or all of the Covered Software due to statute, judicial order, or regulation then You must: (a) comply with the terms of this License to the maximum extent possible; and (b) describe the limitations and the code they affect. Such description must be placed in a text file included with all distributions of the Covered Software under this License. Except to the extent prohibited by statute or regulation, such description must be sufficiently detailed for a recipient of ordinary skill to be able to understand it. 5. Termination -------------- 5.1. The rights granted under this License will terminate automatically if You fail to comply with any of its terms. However, if You become compliant, then the rights granted under this License from a particular Contributor are reinstated (a) provisionally, unless and until such Contributor explicitly and finally terminates Your grants, and (b) on an ongoing basis, if such Contributor fails to notify You of the non-compliance by some reasonable means prior to 60 days after You have come back into compliance. Moreover, Your grants from a particular Contributor are reinstated on an ongoing basis if such Contributor notifies You of the non-compliance by some reasonable means, this is the first time You have received notice of non-compliance with this License from such Contributor, and You become compliant prior to 30 days after Your receipt of the notice. 5.2. If You initiate litigation against any entity by asserting a patent infringement claim (excluding declaratory judgment actions, counter-claims, and cross-claims) alleging that a Contributor Version directly or indirectly infringes any patent, then the rights granted to You by any and all Contributors for the Covered Software under Section 2.1 of this License shall terminate. 5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user license agreements (excluding distributors and resellers) which have been validly granted by You or Your distributors under this License prior to termination shall survive termination. ************************************************************************ * * * 6. Disclaimer of Warranty * * ------------------------- * * * * Covered Software is provided under this License on an "as is" * * basis, without warranty of any kind, either expressed, implied, or * * statutory, including, without limitation, warranties that the * * Covered Software is free of defects, merchantable, fit for a * * particular purpose or non-infringing. The entire risk as to the * * quality and performance of the Covered Software is with You. * * Should any Covered Software prove defective in any respect, You * * (not any Contributor) assume the cost of any necessary servicing, * * repair, or correction. This disclaimer of warranty constitutes an * * essential part of this License. No use of any Covered Software is * * authorized under this License except under this disclaimer. * * * ************************************************************************ ************************************************************************ * * * 7. Limitation of Liability * * -------------------------- * * * * Under no circumstances and under no legal theory, whether tort * * (including negligence), contract, or otherwise, shall any * * Contributor, or anyone who distributes Covered Software as * * permitted above, be liable to You for any direct, indirect, * * special, incidental, or consequential damages of any character * * including, without limitation, damages for lost profits, loss of * * goodwill, work stoppage, computer failure or malfunction, or any * * and all other commercial damages or losses, even if such party * * shall have been informed of the possibility of such damages. This * * limitation of liability shall not apply to liability for death or * * personal injury resulting from such party's negligence to the * * extent applicable law prohibits such limitation. Some * * jurisdictions do not allow the exclusion or limitation of * * incidental or consequential damages, so this exclusion and * * limitation may not apply to You. * * * ************************************************************************ 8. Litigation ------------- Any litigation relating to this License may be brought only in the courts of a jurisdiction where the defendant maintains its principal place of business and such litigation shall be governed by laws of that jurisdiction, without reference to its conflict-of-law provisions. Nothing in this Section shall prevent a party's ability to bring cross-claims or counter-claims. 9. Miscellaneous ---------------- This License represents the complete agreement concerning the subject matter hereof. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. Any law or regulation which provides that the language of a contract shall be construed against the drafter shall not be used to construe this License against a Contributor. 10. Versions of the License --------------------------- 10.1. New Versions Mozilla Foundation is the license steward. Except as provided in Section 10.3, no one other than the license steward has the right to modify or publish new versions of this License. Each version will be given a distinguishing version number. 10.2. Effect of New Versions You may distribute the Covered Software under the terms of the version of the License under which You originally received the Covered Software, or under the terms of any subsequent version published by the license steward. 10.3. Modified Versions If you create software not governed by this License, and you want to create a new license for such software, you may create and use a modified version of this License if you rename the license and remove any references to the name of the license steward (except to note that such modified license differs from this License). 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses If You choose to distribute Source Code Form that is Incompatible With Secondary Licenses under the terms of this version of the License, the notice described in Exhibit B of this License must be attached. Exhibit A - Source Code Form License Notice ------------------------------------------- This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/. If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice. You may add additional accurate notices of copyright ownership. Exhibit B - "Incompatible With Secondary Licenses" Notice --------------------------------------------------------- This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0. challtestsrv-1.4.2/README.md000066400000000000000000000056141514312215300155160ustar00rootroot00000000000000# Challenge Test Server [![Build Status](https://travis-ci.org/letsencrypt/challtestsrv.svg?branch=master)](https://travis-ci.org/letsencrypt/challtestsrv) [![Coverage Status](https://coveralls.io/repos/github/letsencrypt/challtestsrv/badge.svg)](https://coveralls.io/github/letsencrypt/challtestsrv) [![Go Report Card](https://goreportcard.com/badge/github.com/letsencrypt/challtestsrv)](https://goreportcard.com/report/github.com/letsencrypt/challtestsrv) [![GolangCI](https://golangci.com/badges/github.com/letsencrypt/challtestsrv.svg)](https://golangci.com/r/github.com/letsencrypt/challtestsrv) The `challtestsrv` package offers a library that can be used by test code to respond to HTTP-01, DNS-01, and TLS-ALPN-01 ACME challenges. The `challtestsrv` package can also be used as a DNS server letting developers configure `A`, `AAAA`, `CNAME`, and `CAA` DNS data for specific hostnames. The DNS server will resolve up to one level of `CNAME` aliasing for accepted DNS request types. **Important note: The `challtestsrv` library is for TEST USAGE ONLY. It is trivially insecure, offering no authentication. Only use `challtestsrv` in a controlled test environment.** For example this package is used by the Boulder [`load-generator`](https://github.com/letsencrypt/boulder/tree/9e39680e3f78c410e2d780a7badfe200a31698eb/test/load-generator) command to manage its own in-process HTTP-01 challenge server. ### Usage Create a challenge server responding to HTTP-01 challenges on ":8888" and DNS-01 challenges on ":9999" and "10.0.0.1:9998": ``` import "github.com/letsencrypt/challtestsrv" challSrv, err := challtestsrv.New(challtestsrv.Config{ HTTPOneAddrs: []string{":8888"}, DNSAddrs: []string{":9999", "10.0.0.1:9998"}, }) if err != nil { panic(err) } ``` Run the Challenge server and subservers: ``` // Start the Challenge server in its own Go routine go challSrv.Run() ``` Add an HTTP-01 response for the token `"aaa"` and the value `"bbb"`, defer cleaning it up again: ``` challSrv.AddHTTPOneChallenge("aaa", "bbb") defer challSrv.DeleteHTTPOneChallenge("aaa") ``` Add a DNS TXT response for the host `"_acme-challenge.example.com."` and the value `"bbb"`, defer cleaning it up again: ``` challSrv.AddDNSTXTRecord("_acme-challenge.example.com.", "bbb") defer challSrv.DeleteDNSTXTRecord("_acme-challenge.example.com.") ``` Get the history of HTTP requests processed by the challenge server for the host "example.com": ``` requestHistory := challSrv.RequestHistory("example.com", challtestsrv.HTTPRequestEventType) ``` Clear the history of HTTP requests processed by the challenge server for the host "example.com": ``` challSrv.ClearRequestHistory("example.com", challtestsrv.HTTPRequestEventType) ``` Stop the Challenge server and subservers: ``` // Shutdown the Challenge server challSrv.Shutdown() ``` For more information on the package API see Godocs and the associated package sourcecode. challtestsrv-1.4.2/challenge-servers.go000066400000000000000000000155771514312215300202100ustar00rootroot00000000000000// Package challtestsrv provides a trivially insecure acme challenge response // server for rapidly testing HTTP-01, DNS-01 and TLS-ALPN-01 challenge types. package challtestsrv import ( "errors" "log" "net/http" "os" "strings" "sync" ) const ( // Default to using localhost for both A and AAAA queries that don't match // a host in the dnsData maps. defaultIPv4 = "127.0.0.1" defaultIPv6 = "::1" ) // challengeServers offer common functionality to start up and shutdown. type challengeServer interface { ListenAndServe() error Shutdown() error } // ChallSrv is a multi-purpose challenge server. Each ChallSrv may have one or // more ACME challenges it provides servers for. It is safe to use concurrently. type ChallSrv struct { log *log.Logger // servers are the individual challenge server listeners started in New() and // closed in Shutdown(). servers []challengeServer // challMu is a RWMutex used to control concurrent updates to the challenge // response data maps below. challMu sync.RWMutex // requestHistory is a map from hostname to a map of event type to a list of // sequential request events requestHistory map[string]map[RequestEventType][]RequestEvent // httpOne is a map of token values to key authorizations used for HTTP-01 // responses. httpOne map[string]string // dnsData is the data used to respond to all DNS queries. dnsData dnsData // tlsALPNOne is a map of token values to key authorizations used for TLS-ALPN-01 // responses. tlsALPNOne map[string]string // redirects is a map of paths to URLs. HTTP challenge servers respond to // requests for these paths with a 301 to the corresponding URL. redirects map[string]string } // dnsData holds the data used to respond to all DNS queries. type dnsData struct { // The IPv4 address used for all A record responses that don't match a host in // aRecords. defaultIPv4 string // The IPv6 address used for all AAAA record responses that don't match a host // in aaaaRecords. defaultIPv6 string // A map of host to IPv4 addresses in string form for A record responses. aRecords map[string][]string // A map of host to IPv6 addresses in string form for AAAA record responses. aaaaRecords map[string][]string // A map of host to TXT records. txtRecords map[string][]string // A map of host to CAA policies for CAA responses. caaRecords map[string][]CAAPolicy // A map of host to CNAME records. cnameRecords map[string]string // A map of hostnames that should receive a SERVFAIL response for all queries. servFailRecords map[string]bool } // Config holds challenge server configuration type Config struct { Log *log.Logger // HTTPOneAddrs are the HTTP-01 challenge server bind addresses/ports HTTPOneAddrs []string // HTTPSOneAddrs are the HTTPS HTTP-01 challenge server bind addresses/ports HTTPSOneAddrs []string // DOHAddrs are the DNS over HTTPS (DoH) server bind addresses/ports DOHAddrs []string // DNSAddrs are the DNS over UDP/TCP server bind addresses/ports DNSAddrs []string // TLSALPNOneAddrs are the TLS-ALPN-01 challenge server bind addresses/ports TLSALPNOneAddrs []string // DOHCert is required if DOHAddrs is nonempty. DOHCert string // DOHCertKey is required if DOHAddrs is nonempty. DOHCertKey string } // validate checks that a challenge server Config is valid. To be valid it must // specify a bind address for at least one challenge type. If there is no // configured log in the config a default is provided. func (c *Config) validate() error { // There needs to be at least one challenge type with a bind address if len(c.HTTPOneAddrs) < 1 && len(c.HTTPSOneAddrs) < 1 && len(c.DNSAddrs) < 1 && len(c.DOHAddrs) < 1 && len(c.TLSALPNOneAddrs) < 1 { return errors.New( "config must specify at least one HTTPOneAddrs entry, one HTTPSOneAddr " + "entry, one DOHAddrs, one DNSAddrs entry, or one TLSALPNOneAddrs entry") } // If there is no configured log make a default with a prefix if c.Log == nil { c.Log = log.New(os.Stdout, "challtestsrv - ", log.LstdFlags) } return nil } // New constructs and returns a new ChallSrv instance with the given Config. func New(config Config) (*ChallSrv, error) { // Validate the provided configuration if err := config.validate(); err != nil { return nil, err } challSrv := &ChallSrv{ log: config.Log, requestHistory: make(map[string]map[RequestEventType][]RequestEvent), httpOne: make(map[string]string), tlsALPNOne: make(map[string]string), redirects: make(map[string]string), dnsData: dnsData{ defaultIPv4: defaultIPv4, defaultIPv6: defaultIPv6, aRecords: make(map[string][]string), aaaaRecords: make(map[string][]string), txtRecords: make(map[string][]string), caaRecords: make(map[string][]CAAPolicy), cnameRecords: make(map[string]string), servFailRecords: make(map[string]bool), }, } // If there are HTTP-01 addresses configured, create HTTP-01 servers with // HTTPS disabled. for _, address := range config.HTTPOneAddrs { challSrv.log.Printf("Creating HTTP-01 challenge server on %s\n", address) challSrv.servers = append(challSrv.servers, httpOneServer(address, challSrv, false)) } // If there are HTTPS HTTP-01 addresses configured, create HTTP-01 servers // with HTTPS enabled. for _, address := range config.HTTPSOneAddrs { challSrv.log.Printf("Creating HTTPS HTTP-01 challenge server on %s\n", address) challSrv.servers = append(challSrv.servers, httpOneServer(address, challSrv, true)) } // If there are DNS addresses configured, create DNS servers for _, address := range config.DNSAddrs { challSrv.log.Printf("Creating TCP and UDP DNS server on %s\n", address) challSrv.servers = append(challSrv.servers, dnsServer(address, challSrv.dnsHandler)...) } for _, address := range config.DOHAddrs { challSrv.log.Printf("Creating DoH server on %s\n", address) s := dohServer(address, config.DOHCert, config.DOHCertKey, http.HandlerFunc(challSrv.dohHandler)) challSrv.servers = append(challSrv.servers, s) } // If there are TLS-ALPN-01 addresses configured, create TLS-ALPN-01 servers for _, address := range config.TLSALPNOneAddrs { challSrv.log.Printf("Creating TLS-ALPN-01 challenge server on %s\n", address) challSrv.servers = append(challSrv.servers, tlsALPNOneServer(address, challSrv)) } return challSrv, nil } // Run starts each of the ChallSrv's challengeServers. func (s *ChallSrv) Run() { s.log.Printf("Starting challenge servers") // Start each server in their own dedicated Go routine for _, srv := range s.servers { go func(srv challengeServer) { err := srv.ListenAndServe() if err != nil && !strings.Contains(err.Error(), "Server closed") { s.log.Print(err) } }(srv) } } // Shutdown gracefully stops each of the ChallSrv's challengeServers. func (s *ChallSrv) Shutdown() { for _, srv := range s.servers { if err := srv.Shutdown(); err != nil { s.log.Printf("err in Shutdown(): %s\n", err.Error()) } } } challtestsrv-1.4.2/dns.go000066400000000000000000000364201514312215300153510ustar00rootroot00000000000000package challtestsrv import ( "context" "fmt" "io" "net" "net/http" "time" "github.com/miekg/dns" ) // SetDefaultDNSIPv4 sets the default IPv4 address used for A query responses // that don't match hosts added with AddDNSARecord. Use "" to disable default // A query responses. func (s *ChallSrv) SetDefaultDNSIPv4(addr string) { s.challMu.Lock() defer s.challMu.Unlock() s.dnsData.defaultIPv4 = addr } // SetDefaultDNSIPv6 sets the default IPv6 address used for AAAA query responses // that don't match hosts added with AddDNSAAAARecord. Use "" to disable default // AAAA query responses. func (s *ChallSrv) SetDefaultDNSIPv6(addr string) { s.challMu.Lock() defer s.challMu.Unlock() s.dnsData.defaultIPv6 = addr } // GetDefaultDNSIPv4 gets the default IPv4 address used for A query responses // (in string form), or an empty string if no default is being used. func (s *ChallSrv) GetDefaultDNSIPv4() string { s.challMu.RLock() defer s.challMu.RUnlock() return s.dnsData.defaultIPv4 } // GetDefaultDNSIPv6 gets the default IPv6 address used for AAAA query responses // (in string form), or an empty string if no default is being used. func (s *ChallSrv) GetDefaultDNSIPv6() string { s.challMu.RLock() defer s.challMu.RUnlock() return s.dnsData.defaultIPv6 } // AddDNSCNAMERecord sets a CNAME record that will be used like an alias when // querying for other DNS records for the given host. func (s *ChallSrv) AddDNSCNAMERecord(host string, value string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) value = dns.Fqdn(value) s.dnsData.cnameRecords[host] = value } // GetDNSCNAMERecord returns a target host if a CNAME is set for the querying // host and an empty string otherwise. func (s *ChallSrv) GetDNSCNAMERecord(host string) string { s.challMu.RLock() host = dns.Fqdn(host) defer s.challMu.RUnlock() return s.dnsData.cnameRecords[host] } // DeleteDNSCAMERecord deletes any CNAME alias set for the given host. func (s *ChallSrv) DeleteDNSCNAMERecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) delete(s.dnsData.cnameRecords, host) } // AddDNSTXTRecord adds a TXT record for the given host with the given content. func (s *ChallSrv) AddDNSTXTRecord(host, content string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) s.dnsData.txtRecords[host] = append(s.dnsData.txtRecords[host], content) } // GetDNSTXTRecords returns a slice of TXT record values for the given host. If // the host does not exist in the TXT record data then nil is returned. func (s *ChallSrv) GetDNSTXTRecords(host string) []string { s.challMu.RLock() defer s.challMu.RUnlock() return s.dnsData.txtRecords[dns.Fqdn(host)] } // DeleteDNSTXTRecord deletes all TXT records for the given host. func (s *ChallSrv) DeleteDNSTXTRecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() delete(s.dnsData.txtRecords, dns.Fqdn(host)) } // AddDNSARecord adds IPv4 addresses that will be returned when querying for // A records for the given host. func (s *ChallSrv) AddDNSARecord(host string, addresses []string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) s.dnsData.aRecords[host] = append(s.dnsData.aRecords[host], addresses...) } // DeleteDNSARecord deletes any IPv4 addresses that will be returned when // querying for A records for the given host.record for the given host. func (s *ChallSrv) DeleteDNSARecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) delete(s.dnsData.aRecords, host) } // GetDNSARecord returns a slice of IPv4 addresses (in string form) that will be // returned when querying for A records for the given host. func (s *ChallSrv) GetDNSARecord(host string) []string { s.challMu.RLock() host = dns.Fqdn(host) defer s.challMu.RUnlock() return s.dnsData.aRecords[host] } // AddDNSAAAARecord adds IPv6 addresses that will be returned when querying for // AAAA records for the given host. func (s *ChallSrv) AddDNSAAAARecord(host string, addresses []string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) s.dnsData.aaaaRecords[host] = append(s.dnsData.aaaaRecords[host], addresses...) } // DeleteDNSAAAARecord deletes any IPv6 addresses that will be returned when // querying for A records for the given host. func (s *ChallSrv) DeleteDNSAAAARecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) delete(s.dnsData.aaaaRecords, host) } // GetDNSAAAARecord returns a slice of IPv6 addresses (in string form) that will // be returned when querying for A records for the given host. func (s *ChallSrv) GetDNSAAAARecord(host string) []string { s.challMu.RLock() defer s.challMu.RUnlock() host = dns.Fqdn(host) return s.dnsData.aaaaRecords[host] } // CAAPolicy holds a tag and a value for a CAA policy record. See // https://tools.ietf.org/html/rfc6844 type CAAPolicy struct { Tag string Value string } // AddDNSCAARecord adds CAA records that will be returned when querying // CAA for the given host. func (s *ChallSrv) AddDNSCAARecord(host string, policies []CAAPolicy) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) s.dnsData.caaRecords[host] = append(s.dnsData.caaRecords[host], policies...) } // DeleteDNSCAARecord deletes any CAA policies that will be returned when // querying CAA for the given host. func (s *ChallSrv) DeleteDNSCAARecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) delete(s.dnsData.caaRecords, host) } // GetDNSCAARecord returns a slice of CAA policy records that will // be returned when querying CAA for the given host. func (s *ChallSrv) GetDNSCAARecord(host string) []CAAPolicy { s.challMu.RLock() defer s.challMu.RUnlock() host = dns.Fqdn(host) return s.dnsData.caaRecords[host] } // AddDNSServFailRecord configures the chall srv to return SERVFAIL responses // for all queries for the given host. func (s *ChallSrv) AddDNSServFailRecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) s.dnsData.servFailRecords[host] = true } // DeleteDNSServFailRecord configures the chall srv to no longer return SERVFAIL // responses for all queries for the given host. func (s *ChallSrv) DeleteDNSServFailRecord(host string) { s.challMu.Lock() defer s.challMu.Unlock() host = dns.Fqdn(host) delete(s.dnsData.servFailRecords, host) } // GetDNSServFailRecord returns true when the chall srv has been configured with // AddDNSServFailRecord to return SERVFAIL for all queries to the given host. func (s *ChallSrv) GetDNSServFailRecord(host string) bool { s.challMu.RLock() defer s.challMu.RUnlock() host = dns.Fqdn(host) return s.dnsData.servFailRecords[host] } // dnsAnswerFunc is a function that accepts a DNS question and returns one or // more RRs for the response. type dnsAnswerFunc func(question dns.Question) []dns.RR // cnameAnswers is a dnsAnswerFunc that creates CNAME RR's for the given question // using the ChallSrv's DNS records. If there is no CNAME record for the // given hostname in the question no RR's will be returned. func (s *ChallSrv) cnameAnswers(q dns.Question) []dns.RR { var records []dns.RR if value := s.GetDNSCNAMERecord(q.Name); value != "" { record := &dns.CNAME{ Hdr: dns.RR_Header{ Name: q.Name, Rrtype: dns.TypeCNAME, Class: dns.ClassINET, }, Target: value, } records = append(records, record) } return records } // txtAnswers is a dnsAnswerFunc that creates TXT RR's for the given question // using the ChallSrv's DNS records. If there is no TXT record for the // given hostname in the question no RR's will be returned. func (s *ChallSrv) txtAnswers(q dns.Question) []dns.RR { var records []dns.RR values := s.GetDNSTXTRecords(q.Name) for _, resp := range values { record := &dns.TXT{ Hdr: dns.RR_Header{ Name: q.Name, Rrtype: dns.TypeTXT, Class: dns.ClassINET, }, Txt: splitTXTRecordValue(resp), } records = append(records, record) } return records } // splitTXTRecordValue splits a TXT value into RFC 1035 // chunks of at most 255 octets so long TXT values can be represented as // multiple strings in one RR. func splitTXTRecordValue(value string) []string { const maxTXTStringOctets = 255 if len(value) <= maxTXTStringOctets { return []string{value} } var chunks []string for len(value) > maxTXTStringOctets { chunks = append(chunks, value[:maxTXTStringOctets]) value = value[maxTXTStringOctets:] } if len(value) > 0 { chunks = append(chunks, value) } return chunks } // aAnswers is a dnsAnswerFunc that creates A RR's for the given question using // the ChallSrv's DNS records. If there is not a IPv4 A record added // for the given hostname in the question the default IPv4 address will be used // for the response. func (s *ChallSrv) aAnswers(q dns.Question) []dns.RR { var records []dns.RR // Don't answer any questions for IP addresses with a fakeDNS response. // These queries are invalid! if ip := net.ParseIP(q.Name); ip != nil { return records } values := s.GetDNSARecord(q.Name) if defaultIPv4 := s.GetDefaultDNSIPv4(); len(values) == 0 && defaultIPv4 != "" { values = []string{defaultIPv4} } for _, resp := range values { ipAddr := net.ParseIP(resp) if ipAddr == nil || ipAddr.To4() == nil { // If the DNS records aren't a valid IPv4 address, don't use them. continue } record := &dns.A{ Hdr: dns.RR_Header{ Name: q.Name, Rrtype: dns.TypeA, Class: dns.ClassINET, }, A: ipAddr, } records = append(records, record) } return records } // aaaaAnswers is a dnsAnswerFunc that creates AAAA RR's for the given question // using the ChallSrv's DNS records. If there is not an IPv6 AAAA record // added for the given hostname in the question the default IPv6 address will be // used for the response. func (s *ChallSrv) aaaaAnswers(q dns.Question) []dns.RR { var records []dns.RR values := s.GetDNSAAAARecord(q.Name) if defaultIPv6 := s.GetDefaultDNSIPv6(); len(values) == 0 && defaultIPv6 != "" { values = []string{defaultIPv6} } for _, resp := range values { ipAddr := net.ParseIP(resp) if ipAddr == nil || ipAddr.To4() != nil { // If the DNS records aren't a valid IPv6 address, don't use them. continue } record := &dns.AAAA{ Hdr: dns.RR_Header{ Name: q.Name, Rrtype: dns.TypeAAAA, Class: dns.ClassINET, }, AAAA: ipAddr, } records = append(records, record) } return records } // caaAnswers is a dnsAnswerFunc that creates CAA RR's for the given question // using the ChallSrv's DNS records. If there is not a CAA record // added for the given hostname in the question no RRs will be returned. func (s *ChallSrv) caaAnswers(q dns.Question) []dns.RR { var records []dns.RR values := s.GetDNSCAARecord(q.Name) for _, resp := range values { record := &dns.CAA{ Hdr: dns.RR_Header{ Name: q.Name, Rrtype: dns.TypeCAA, Class: dns.ClassINET, }, Tag: resp.Tag, Value: resp.Value, } records = append(records, record) } return records } type writeMsg interface { WriteMsg(m *dns.Msg) error } type dnsToHTTPWriter struct { http.ResponseWriter } func (d *dnsToHTTPWriter) WriteMsg(m *dns.Msg) error { d.Header().Set("Content-Type", "application/dns-message") d.WriteHeader(http.StatusOK) b, err := m.Pack() if err != nil { return err } _, err = d.Write(b) return err } // dohHandler handles a DoH request by POST only. func (s *ChallSrv) dohHandler(w http.ResponseWriter, r *http.Request) { if r.Method != http.MethodPost { w.WriteHeader(http.StatusMethodNotAllowed) return } body, err := io.ReadAll(r.Body) if err != nil { w.WriteHeader(http.StatusInternalServerError) return } msg := new(dns.Msg) err = msg.Unpack(body) if err != nil { w.WriteHeader(http.StatusBadRequest) fmt.Fprintln(w, err) return } s.dnsHandlerInner(&dnsToHTTPWriter{w}, msg, r.Header.Get("User-Agent")) } // dnsHandler is a miekg/dns handler that can process a dns.Msg request and // write a response to the provided dns.ResponseWriter. TXT, A, AAAA, CNAME, // and CAA queries types are supported and answered using the ChallSrv's DNS // records. A host that is aliased by a CNAME record will follow that alias // one level and return the requested record types for that alias' target func (s *ChallSrv) dnsHandler(w dns.ResponseWriter, r *dns.Msg) { s.dnsHandlerInner(w, r, "") } // newDefaultSOA returns a DNS SOA record with sensible default values. func newDefaultSOA() *dns.SOA { return &dns.SOA{ Hdr: dns.RR_Header{ Name: "challtestsrv.invalid.", Rrtype: dns.TypeSOA, Class: dns.ClassINET, }, Ns: "ns.challtestsrv.invalid.", Mbox: "master.challtestsrv.invalid.", Serial: 1, Refresh: 1, Retry: 1, Expire: 1, Minttl: 1, } } func (s *ChallSrv) dnsHandlerInner(w writeMsg, r *dns.Msg, userAgent string) { m := new(dns.Msg) m.SetReply(r) m.Compress = false // For each question, add answers based on the type of question for _, q := range r.Question { s.AddRequestEvent(DNSRequestEvent{ Question: q, UserAgent: userAgent, }) // If there is a ServFail record set then ignore the question and set the // SERVFAIL rcode and continue. if s.GetDNSServFailRecord(q.Name) { m.SetRcode(r, dns.RcodeServerFailure) continue } // If a CNAME exists for the question include the CNAME record and modify // the question to instead lookup based on that CNAME's target if cname := s.GetDNSCNAMERecord(q.Name); cname != "" { cnameRecords := s.cnameAnswers(q) m.Answer = append(m.Answer, cnameRecords...) q = dns.Question{Name: cname, Qtype: q.Qtype} } var answerFunc dnsAnswerFunc switch q.Qtype { case dns.TypeCNAME: answerFunc = s.cnameAnswers case dns.TypeTXT: answerFunc = s.txtAnswers case dns.TypeA: answerFunc = s.aAnswers case dns.TypeAAAA: answerFunc = s.aaaaAnswers case dns.TypeCAA: answerFunc = s.caaAnswers default: m.SetRcode(r, dns.RcodeNotImplemented) } if answerFunc == nil { break } if records := answerFunc(q); len(records) > 0 { m.Answer = append(m.Answer, records...) } } m.Ns = append(m.Ns, newDefaultSOA()) _ = w.WriteMsg(m) } type dnsHandler func(dns.ResponseWriter, *dns.Msg) // dnsServer creates a DNS server that registers the provided handler with the // `miekg/dns` package. Because the DNS server runs both a UDP and a TCP // listener, two `server` objects are returned. func dnsServer(address string, handler dnsHandler) []challengeServer { // Register the dnsHandler dns.HandleFunc(".", handler) // Create a UDP DNS server udpServer := &dns.Server{ Addr: address, Net: "udp", ReadTimeout: time.Second, WriteTimeout: time.Second, } // Create a TCP DNS server tcpServer := &dns.Server{ Addr: address, Net: "tcp", ReadTimeout: time.Second, WriteTimeout: time.Second, } return []challengeServer{udpServer, tcpServer} } type doh struct { *http.Server tlsCert, tlsCertKey string } func (s *doh) Shutdown() error { return s.Server.Shutdown(context.Background()) } func (s *doh) ListenAndServe() error { return s.ListenAndServeTLS(s.tlsCert, s.tlsCertKey) } // dohServer creates a DNS-over-HTTPS server backed by the provided handler. func dohServer(address string, tlsCert, tlsCertKey string, handler http.Handler) *doh { return &doh{ &http.Server{ Handler: handler, Addr: address, ReadTimeout: time.Second, WriteTimeout: time.Second, }, tlsCert, tlsCertKey, } } challtestsrv-1.4.2/event.go000066400000000000000000000073541514312215300157120ustar00rootroot00000000000000package challtestsrv import ( "net" "strings" "github.com/miekg/dns" ) // RequestEventType indicates what type of event occurred. type RequestEventType int const ( // HTTP requests HTTPRequestEventType RequestEventType = iota // DNS requests DNSRequestEventType // TLS-ALPN-01 requests TLSALPNRequestEventType ) // A RequestEvent is anything that can identify its RequestEventType and a key // for storing the request event in the history. type RequestEvent interface { Type() RequestEventType Key() string } // HTTPRequestEvent corresponds to an HTTP request received by a httpOneServer. // It implements the RequestEvent interface. type HTTPRequestEvent struct { // The full request URL (path and query arguments) URL string // The Host header from the request Host string // Whether the request was received over HTTPS or HTTP HTTPS bool // The ServerName from the ClientHello. May be empty if there was no SNI or if // the request was not HTTPS ServerName string // The User-Agent header from the request UserAgent string } // HTTPRequestEvents always have type HTTPRequestEventType func (e HTTPRequestEvent) Type() RequestEventType { return HTTPRequestEventType } // HTTPRequestEvents use the HTTP Host as the storage key. Any explicit port // will be removed. func (e HTTPRequestEvent) Key() string { if h, _, err := net.SplitHostPort(e.Host); err == nil { return h } return e.Host } // DNSRequestEvent corresponds to a DNS request received by a dnsServer. It // implements the RequestEvent interface. type DNSRequestEvent struct { // The DNS question received. Question dns.Question // The User-Agent header from the request, may be empty // if the request was not over DoH. UserAgent string } // DNSRequestEvents always have type DNSRequestEventType func (e DNSRequestEvent) Type() RequestEventType { return DNSRequestEventType } // DNSRequestEvents use the Question Name as the storage key. Any trailing `.` // in the question name is removed. func (e DNSRequestEvent) Key() string { return strings.TrimSuffix(e.Question.Name, ".") } // TLSALPNRequestEvent corresponds to a TLS request received by // a tlsALPNOneServer. It implements the RequestEvent interface. type TLSALPNRequestEvent struct { // ServerName from the TLS Client Hello. ServerName string // SupportedProtos from the TLS Client Hello. SupportedProtos []string } // TLSALPNRequestEvents always have type TLSALPNRequestEventType func (e TLSALPNRequestEvent) Type() RequestEventType { return TLSALPNRequestEventType } // TLSALPNRequestEvents use the SNI value as the storage key func (e TLSALPNRequestEvent) Key() string { return e.ServerName } // AddRequestEvent adds a RequestEvent to the server's request history. It is // appeneded to a list of RequestEvents indexed by the event's Type(). func (s *ChallSrv) AddRequestEvent(event RequestEvent) { s.challMu.Lock() defer s.challMu.Unlock() typ := event.Type() host := event.Key() if s.requestHistory[host] == nil { s.requestHistory[host] = make(map[RequestEventType][]RequestEvent) } s.requestHistory[host][typ] = append(s.requestHistory[host][typ], event) } // RequestHistory returns the server's request history for the given hostname // and event type. func (s *ChallSrv) RequestHistory(hostname string, typ RequestEventType) []RequestEvent { s.challMu.RLock() defer s.challMu.RUnlock() if hostEvents, ok := s.requestHistory[hostname]; ok { return hostEvents[typ] } return []RequestEvent{} } // ClearRequestHistory clears the server's request history for the given // hostname and event type. func (s *ChallSrv) ClearRequestHistory(hostname string, typ RequestEventType) { s.challMu.Lock() defer s.challMu.Unlock() if hostEvents, ok := s.requestHistory[hostname]; ok { hostEvents[typ] = []RequestEvent{} } } challtestsrv-1.4.2/go.mod000066400000000000000000000004471514312215300153440ustar00rootroot00000000000000module github.com/letsencrypt/challtestsrv go 1.24 require github.com/miekg/dns v1.1.62 require ( golang.org/x/mod v0.18.0 // indirect golang.org/x/net v0.27.0 // indirect golang.org/x/sync v0.7.0 // indirect golang.org/x/sys v0.22.0 // indirect golang.org/x/tools v0.22.0 // indirect ) challtestsrv-1.4.2/go.sum000066400000000000000000000016421514312215300153670ustar00rootroot00000000000000github.com/miekg/dns v1.1.62 h1:cN8OuEF1/x5Rq6Np+h1epln8OiyPWV+lROx9LxcGgIQ= github.com/miekg/dns v1.1.62/go.mod h1:mvDlcItzm+br7MToIKqkglaGhlFMHJ9DTNNWONWXbNQ= golang.org/x/mod v0.18.0 h1:5+9lSbEzPSdWkH32vYPBwEpX8KwDbM52Ud9xBUvNlb0= golang.org/x/mod v0.18.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/net v0.27.0 h1:5K3Njcw06/l2y9vpGCSdcxWOYHOUk3dVNGDXN+FvAys= golang.org/x/net v0.27.0/go.mod h1:dDi0PyhWNoiUOrAS8uXv/vnScO4wnHQO4mj9fn/RytE= golang.org/x/sync v0.7.0 h1:YsImfSBoP9QPYL0xyKJPq0gcaJdG3rInoqxTWbfQu9M= golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/tools v0.22.0 h1:gqSGLZqv+AI9lIQzniJ0nZDRG5GBPsSi+DRNHWNz6yA= golang.org/x/tools v0.22.0/go.mod h1:aCwcsjqvq7Yqt6TNyX7QMU2enbQ/Gt0bo6krSeEri+c= challtestsrv-1.4.2/httpone.go000066400000000000000000000151551514312215300162500ustar00rootroot00000000000000package challtestsrv import ( "context" "crypto/ecdsa" "crypto/elliptic" "crypto/rand" "crypto/tls" "crypto/x509" "crypto/x509/pkix" "fmt" "math" "math/big" "net/http" "strings" "time" ) // wellKnownPath is the IANA registered ACME HTTP-01 challenge path. See // https://tools.ietf.org/html/draft-ietf-acme-acme-16#section-9.2 const wellKnownPath = "/.well-known/acme-challenge/" // cert is a self-signed certificate issued at startup for the HTTPS HTTP-01 // server. var cert = selfSignedCert() // selfSignedCert issues a self-signed CA certificate to use as the leaf // certificate for an HTTPS server serving HTTP-01 challenges. This certificate // will not be trusted by normal TLS clients but HTTP-01 redirects to HTTPS will // ignore certificate validation. func selfSignedCert() tls.Certificate { key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) if err != nil { panic(fmt.Sprintf("Unable to generate HTTPS ECDSA key: %v", err)) } serial, err := rand.Int(rand.Reader, big.NewInt(math.MaxInt64)) if err != nil { panic(fmt.Sprintf("Unable to generate HTTPS cert serial number: %v", err)) } template := &x509.Certificate{ Subject: pkix.Name{ CommonName: "challenge test server", }, SerialNumber: serial, NotBefore: time.Now().Add(-time.Hour), NotAfter: time.Now().AddDate(1, 0, 0), KeyUsage: x509.KeyUsageDigitalSignature | x509.KeyUsageCertSign, ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth, x509.ExtKeyUsageClientAuth}, BasicConstraintsValid: true, IsCA: true, } der, err := x509.CreateCertificate(rand.Reader, template, template, key.Public(), key) if err != nil { panic(fmt.Sprintf("Unable to issue HTTPS cert: %v", err)) } return tls.Certificate{ Certificate: [][]byte{der}, PrivateKey: key, } } // AddHTTPOneChallenge adds a new HTTP-01 challenge for the given token and // content. func (s *ChallSrv) AddHTTPOneChallenge(token, content string) { s.challMu.Lock() defer s.challMu.Unlock() s.httpOne[token] = content } // DeleteHTTPOneChallenge deletes a given HTTP-01 challenge token. func (s *ChallSrv) DeleteHTTPOneChallenge(token string) { s.challMu.Lock() defer s.challMu.Unlock() delete(s.httpOne, token) } // GetHTTPOneChallenge returns the HTTP-01 challenge content for the given token // (if it exists) and a true bool. If the token does not exist then an empty // string and a false bool are returned. func (s *ChallSrv) GetHTTPOneChallenge(token string) (string, bool) { s.challMu.RLock() defer s.challMu.RUnlock() content, present := s.httpOne[token] return content, present } // AddHTTPRedirect adds a redirect for the given path to the given URL. func (s *ChallSrv) AddHTTPRedirect(path, targetURL string) { s.challMu.Lock() defer s.challMu.Unlock() s.redirects[path] = targetURL } // DeleteHTTPRedirect deletes a redirect for the given path. func (s *ChallSrv) DeleteHTTPRedirect(path string) { s.challMu.Lock() defer s.challMu.Unlock() delete(s.redirects, path) } // GetHTTPRedirect returns the redirect target for the given path // (if it exists) and a true bool. If the path does not have a redirect target // then an empty string and a false bool are returned. func (s *ChallSrv) GetHTTPRedirect(path string) (string, bool) { s.challMu.RLock() defer s.challMu.RUnlock() targetURL, present := s.redirects[path] return targetURL, present } // ServeHTTP handles an HTTP request. If the request path has the ACME HTTP-01 // challenge well known prefix as a prefix and the token specified is known, // then the challenge response contents are returned. func (s *ChallSrv) ServeHTTP(w http.ResponseWriter, r *http.Request) { requestPath := r.URL.Path serverName := "" if r.TLS != nil { serverName = r.TLS.ServerName } s.AddRequestEvent(HTTPRequestEvent{ URL: r.URL.String(), Host: r.Host, HTTPS: r.TLS != nil, ServerName: serverName, UserAgent: r.Header.Get("User-Agent"), }) // If the request was not over HTTPS and we have a redirect, serve it. // Redirects are ignored over HTTPS so we can easily do an HTTP->HTTPS // redirect for a token path without creating a loop. if redirectTarget, found := s.GetHTTPRedirect(requestPath); found && r.TLS == nil { http.Redirect(w, r, redirectTarget, http.StatusFound) return } if strings.HasPrefix(requestPath, wellKnownPath) { token := requestPath[len(wellKnownPath):] if auth, found := s.GetHTTPOneChallenge(token); found { fmt.Fprintf(w, "%s", auth) } } } // challHTTPServer is a *http.Server that has a Shutdown() func that doesn't // take a context argument. This lets us treat the HTTP server the same as the // DNS-01 servers (which use a `dns.Server` that has `Shutdown()` with no // context arg) by having an http.Server that implements the challengeServer // interface. type challHTTPServer struct { *http.Server } // ListenAndServe for a challHTTPServer will call the underlying http.Server's // ListenAndServeTLS if the server has a non-nil TLSConfig, otherwise it will // use the underlying http.Server's ListenAndServe(). This allows for // a challHTTPServer to be both a normal HTTP based HTTP-01 challenge response // server in one configuration (nil TLSConfig) and an HTTPS based HTTP-01 // challenge response server useful for redirect targets in another // configuration. func (c challHTTPServer) ListenAndServe() error { if c.TLSConfig != nil { // This will use the certificate and key from TLSConfig. return c.ListenAndServeTLS("", "") } // Otherwise use HTTP return c.Server.ListenAndServe() } func (c challHTTPServer) Shutdown() error { return c.Server.Shutdown(context.Background()) } // httpOneServer creates an ACME HTTP-01 challenge server. The // server's handler will return configured HTTP-01 challenge responses for // tokens that have been added to the challenge server. If HTTPS is true the // resulting challengeServer will run a HTTPS server with a self-signed // certificate useful for HTTP-01 -> HTTPS HTTP-01 redirect responses. If HTTPS // is false the resulting challengeServer will run an HTTP server. func httpOneServer(address string, handler http.Handler, https bool) challHTTPServer { // If HTTPS is requested build a TLS Config that uses the self-signed // certificate generated at startup. var tlsConfig *tls.Config if https { tlsConfig = &tls.Config{ Certificates: []tls.Certificate{cert}, } } // Create an HTTP Server for HTTP-01 challenges srv := &http.Server{ Addr: address, Handler: handler, ReadTimeout: 5 * time.Second, WriteTimeout: 5 * time.Second, TLSConfig: tlsConfig, } srv.SetKeepAlivesEnabled(false) return challHTTPServer{srv} } challtestsrv-1.4.2/tlsalpnone.go000066400000000000000000000070511514312215300167420ustar00rootroot00000000000000package challtestsrv import ( "context" "crypto/ecdsa" "crypto/elliptic" "crypto/rand" "crypto/sha256" "crypto/tls" "crypto/x509" "crypto/x509/pkix" "encoding/asn1" "fmt" "math/big" "net/http" "time" ) // ALPN protocol ID for TLS-ALPN-01 challenge // https://tools.ietf.org/html/draft-ietf-acme-tls-alpn-01#section-5.2 const ACMETLS1Protocol = "acme-tls/1" // IDPeAcmeIdentifier is the identifier defined in // https://tools.ietf.org/html/draft-ietf-acme-tls-alpn-04#section-5.1 // id-pe OID + 31 (acmeIdentifier) var IDPeAcmeIdentifier = asn1.ObjectIdentifier{1, 3, 6, 1, 5, 5, 7, 1, 31} // AddTLSALPNChallenge adds a new TLS-ALPN-01 key authorization for the given host func (s *ChallSrv) AddTLSALPNChallenge(host, content string) { s.challMu.Lock() defer s.challMu.Unlock() s.tlsALPNOne[host] = content } // DeleteTLSALPNChallenge deletes the key authorization for a given host func (s *ChallSrv) DeleteTLSALPNChallenge(host string) { s.challMu.Lock() defer s.challMu.Unlock() delete(s.tlsALPNOne, host) } // GetTLSALPNChallenge checks the s.tlsALPNOne map for the given host. // If it is present it returns the key authorization and true, if not // it returns an empty string and false. func (s *ChallSrv) GetTLSALPNChallenge(host string) (string, bool) { s.challMu.RLock() defer s.challMu.RUnlock() content, present := s.tlsALPNOne[host] return content, present } func (s *ChallSrv) ServeChallengeCertFunc(k *ecdsa.PrivateKey) func(*tls.ClientHelloInfo) (*tls.Certificate, error) { return func(hello *tls.ClientHelloInfo) (*tls.Certificate, error) { s.AddRequestEvent(TLSALPNRequestEvent{ ServerName: hello.ServerName, SupportedProtos: hello.SupportedProtos, }) if len(hello.SupportedProtos) != 1 || hello.SupportedProtos[0] != ACMETLS1Protocol { return nil, fmt.Errorf( "ALPN failed, ClientHelloInfo.SupportedProtos: %s", hello.SupportedProtos) } ka, found := s.GetTLSALPNChallenge(hello.ServerName) if !found { return nil, fmt.Errorf("unknown ClientHelloInfo.ServerName: %s", hello.ServerName) } kaHash := sha256.Sum256([]byte(ka)) extValue, err := asn1.Marshal(kaHash[:]) if err != nil { return nil, fmt.Errorf("failed marshaling hash OCTET STRING: %w", err) } certTmpl := x509.Certificate{ SerialNumber: big.NewInt(1729), DNSNames: []string{hello.ServerName}, ExtraExtensions: []pkix.Extension{ { Id: IDPeAcmeIdentifier, Critical: true, Value: extValue, }, }, } certBytes, err := x509.CreateCertificate(rand.Reader, &certTmpl, &certTmpl, k.Public(), k) if err != nil { return nil, fmt.Errorf("failed creating challenge certificate: %w", err) } return &tls.Certificate{ Certificate: [][]byte{certBytes}, PrivateKey: k, }, nil } } type challTLSServer struct { *http.Server } func (c challTLSServer) Shutdown() error { return c.Server.Shutdown(context.Background()) } func (c challTLSServer) ListenAndServe() error { // Since we set TLSConfig.GetCertificate, the certfile and keyFile arguments // are ignored and we leave them blank. return c.ListenAndServeTLS("", "") } func tlsALPNOneServer(address string, challSrv *ChallSrv) challTLSServer { key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader) if err != nil { panic(err) } srv := &http.Server{ Addr: address, ReadTimeout: 5 * time.Second, WriteTimeout: 5 * time.Second, TLSConfig: &tls.Config{ NextProtos: []string{ACMETLS1Protocol}, GetCertificate: challSrv.ServeChallengeCertFunc(key), }, } srv.SetKeepAlivesEnabled(false) return challTLSServer{srv} }