-
-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support for local server as dns provider #1621
Open
paragor
wants to merge
1
commit into
go-acme:master
Choose a base branch
from
paragor:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: "Local" | ||
| date: 2019-03-03T16:39:46+01:00 | ||
| draft: false | ||
| slug: local | ||
| --- | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/local/local.toml --> | ||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
|
|
||
| Since: v0.0.1 | ||
| Setup local udp dns server that can serve forawrded requests from main dns server | ||
|
|
||
|
|
||
| <!--more--> | ||
|
|
||
| - Code: `local` | ||
|
|
||
| Here is an example bash command using the Local provider: | ||
|
|
||
| ```bash | ||
| LOCAL_LISTEN=:5353 \ | ||
| lego --email myemail@example.com --dns local --domains my.example.org run | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Credentials | ||
|
|
||
| | Environment Variable Name | Description | | ||
| |-----------------------|-------------| | ||
| | `LOCAL_LISTEN` | Listen udp dns-server address | | ||
|
|
||
| The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. | ||
| More information [here](/lego/dns/#configuration-and-credentials). | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/local/local.toml --> | ||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package localserver | ||
|
|
||
| import ( | ||
| "errors" | ||
| "log" | ||
| "net" | ||
| "net/netip" | ||
| "os" | ||
|
|
||
| "github.com/go-acme/lego/v4/challenge/dns01" | ||
| "github.com/miekg/dns" | ||
| ) | ||
|
|
||
| // Environment variables names. | ||
| const ( | ||
| envNamespace = "LOCALSERVER_" | ||
|
|
||
| EnvListen = envNamespace + "LISTEN" | ||
| ) | ||
|
|
||
| type DNSProvider struct { | ||
| addr string | ||
| server *dns.Server | ||
| } | ||
|
|
||
| func NewDNSProvider() (*DNSProvider, error) { | ||
| addr := os.Getenv(EnvListen) | ||
| if addr == "" { | ||
| return nil, errors.New("localserver: listen addr is nil") | ||
| } | ||
| _, err := netip.ParseAddrPort(addr) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &DNSProvider{addr: addr}, nil | ||
| } | ||
|
|
||
| func (s *DNSProvider) Present(domain, token, keyAuth string) error { | ||
| addr, err := netip.ParseAddrPort(s.addr) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| conn, err := net.ListenUDP("udp", net.UDPAddrFromAddrPort(addr)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| fqdn, value := dns01.GetRecord(domain, keyAuth) | ||
| handler := &dnsHandler{acmeResponse: value, fqdn: fqdn} | ||
| s.server = &dns.Server{Handler: handler, PacketConn: conn} | ||
|
|
||
| startCh := make(chan struct{}, 1) | ||
| errCh := make(chan error, 1) | ||
| s.server.NotifyStartedFunc = func() { | ||
| startCh <- struct{}{} | ||
| } | ||
| go func() { | ||
| err := s.server.ActivateAndServe() | ||
| if err != nil { | ||
| errCh <- err | ||
| return | ||
| } | ||
| }() | ||
| select { | ||
| case err := <-errCh: | ||
| return err | ||
| case <-startCh: | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (s *DNSProvider) CleanUp(domain, token, keyAuth string) error { | ||
| if s.server == nil { | ||
| return errors.New("dns server is not running") | ||
| } | ||
| err := s.server.Shutdown() | ||
| s.server = nil | ||
| return err | ||
| } | ||
|
|
||
| type dnsHandler struct { | ||
| acmeResponse string | ||
| fqdn string | ||
| } | ||
|
|
||
| func (h *dnsHandler) ServeDNS(w dns.ResponseWriter, r *dns.Msg) { | ||
| m := new(dns.Msg) | ||
| m.SetReply(r) | ||
| m.Authoritative = true | ||
| m.RecursionAvailable = false | ||
| question := r.Question[0] | ||
| if question.Name == h.fqdn && question.Qtype == dns.TypeTXT { | ||
| m.Answer = append(m.Answer, &dns.TXT{ | ||
| Hdr: dns.RR_Header{ | ||
| Name: question.Name, | ||
| Rrtype: dns.TypeTXT, | ||
| Class: dns.ClassINET, | ||
| }, | ||
| Txt: []string{h.acmeResponse}, | ||
| }) | ||
| log.Printf("localserver dns response: found, request: %#v\n", question) | ||
| } else { | ||
| m.Rcode = dns.RcodeNameError | ||
| log.Printf("localserver dns response: not found, request: %#v\n", question) | ||
| } | ||
| if err := w.WriteMsg(m); err != nil { | ||
| log.Println(err.Error()) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| Name = "Localserver" | ||
| Description = '''Setup localserver udp dns server that can serve forawrded requests from main dns server''' | ||
| Code = "localserver" | ||
| Since = "v0.0.1" | ||
|
|
||
| Example = ''' | ||
| LOCALSERVER_LISTEN=0.0.0.0:5353 \ | ||
| lego --email myemail@example.com --dns localserver --domains my.example.org run | ||
| ''' | ||
|
|
||
| [Configuration] | ||
| [Configuration.Credentials] | ||
| LOCALSERVER_LISTEN = "Listen udp dns-server address" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package localserver | ||
|
|
||
| import ( | ||
| "github.com/go-acme/lego/v4/challenge/dns01" | ||
| "github.com/miekg/dns" | ||
| "github.com/stretchr/testify/assert" | ||
| "testing" | ||
|
|
||
| "github.com/go-acme/lego/v4/platform/tester" | ||
| ) | ||
|
|
||
| var envTest = tester.NewEnvTest(EnvListen) | ||
| var listenAddr = "127.0.0.1:5352" | ||
|
|
||
| func TestDnsProvider(t *testing.T) { | ||
| envTest.Apply(map[string]string{EnvListen: listenAddr}) | ||
| provider, err := NewDNSProvider() | ||
| assert.Nil(t, err) | ||
|
|
||
| domain := "foo.com" | ||
| keyAuth := "12d==" | ||
|
|
||
| fqdn, txtExpectedValue := dns01.GetRecord(domain, keyAuth) | ||
| err = provider.Present(domain, "", keyAuth) | ||
| assert.Nil(t, err) | ||
|
|
||
| r, err := makeDnsQuery(fqdn, dns.TypeTXT, listenAddr) | ||
| assert.Nil(t, err) | ||
| assert.Equal(t, txtExpectedValue, r.Answer[0].(*dns.TXT).Txt[0]) | ||
|
|
||
| r, err = makeDnsQuery("bar.com.", dns.TypeTXT, listenAddr) | ||
| assert.Nil(t, err) | ||
| assert.Equal(t, dns.RcodeNameError, r.MsgHdr.Rcode) | ||
|
|
||
| err = provider.CleanUp(domain, "", keyAuth) | ||
| assert.Nil(t, err) | ||
| } | ||
|
|
||
| func makeDnsQuery(fqdn string, dnsType uint16, dnsServer string) (*dns.Msg, error) { | ||
| c := new(dns.Client) | ||
| m := new(dns.Msg) | ||
| m.SetQuestion(fqdn, dnsType) | ||
| r, _, err := c.Exchange(m, dnsServer) | ||
| return r, err | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.