Add support for autodns #957

kolaente · 2019-08-30T14:15:54Z

This pr adds support for autodns based on https://help.internetx.com/display/APIJSONEN

Closes #501

Checklist

rm -rf .lego

./lego -m your@email.com --dns YOUR_PROVIDER_NAME -d *.example.com -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

Note the wildcard domain is important.

cmd/zz_gen_cmd_dnshelp.go

providers/dns/autodns/autodns.go

ldez · 2019-08-30T16:27:44Z

Hello, in order for a PR adding a DNS provider to be accepted, you have to:

add a description to your PR
be able to maintain this provider
have a homogeneous design with the other providers
add tests (units)

make test

add tests ("live")

lego/providers/dns/cloudflare/cloudflare_test.go

Lines 125 to 151 in c938de6

    
           func TestLivePresent(t *testing.T) { 
        
           	if !envTest.IsLiveTest() { 
        
           		t.Skip("skipping live test") 
        
           	} 
        
           	envTest.RestoreEnv() 
        
           	provider, err := NewDNSProvider() 
        
           	require.NoError(t, err) 
        
           	err = provider.Present(envTest.GetDomain(), "", "123d==") 
        
           	require.NoError(t, err) 
        
           } 
        
           func TestLiveCleanUp(t *testing.T) { 
        
           	if !envTest.IsLiveTest() { 
        
           		t.Skip("skipping live test") 
        
           	} 
        
           	envTest.RestoreEnv() 
        
           	provider, err := NewDNSProvider() 
        
           	require.NoError(t, err) 
        
           	time.Sleep(2 * time.Second) 
        
           	err = provider.CleanUp(envTest.GetDomain(), "", "123d==") 
        
           	require.NoError(t, err) 
        
           }

make test

add the provider to the readme.md
add a provider descriptor
generate CLI help and documentation

make generate-dns

be able to do: (and put the output of this command to a comment in your PR)

rm -rf .lego

./lego -m your@email.com --dns YOUR_PROVIDER_NAME -d *.example.com -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

Note the wildcard domain is important.

pass the linter (golangci-lint must be installed):

make checks

do go mod tidy

kolaente · 2019-09-02T06:43:03Z

@ldez I updated the original description of the pr with your checklist, in order to be able to edit it.

kolaente · 2019-09-02T06:44:30Z

I also go a response about the _stream api endpoint from the autodns guys, they could reproduce it and are investigating why it did not work - they'll get back to me, I'll update here.

ldez

Could you add:

lego/providers/dns/cloudflare/cloudflare.go

Lines 101 to 105 in a5a2918

    
           // Timeout returns the timeout and interval to use when checking for DNS propagation. 
        
           // Adjusting here to cope with spikes in propagation times. 
        
           func (d *DNSProvider) Timeout() (timeout, interval time.Duration) { 
        
           	return d.config.PropagationTimeout, d.config.PollingInterval 
        
           }

Could you add more unit tests:

lego/providers/dns/auroradns/auroradns_test.go

Lines 37 to 147 in a5a2918

    
           func TestNewDNSProvider(t *testing.T) { 
        
           	testCases := []struct { 
        
           		desc     string 
        
           		envVars  map[string]string 
        
           		expected string 
        
           	}{ 
        
           		{ 
        
           			desc: "success", 
        
           			envVars: map[string]string{ 
        
           				"AURORA_USER_ID": "123", 
        
           				"AURORA_KEY":     "456", 
        
           			}, 
        
           		}, 
        
           		{ 
        
           			desc: "missing credentials", 
        
           			envVars: map[string]string{ 
        
           				"AURORA_USER_ID": "", 
        
           				"AURORA_KEY":     "", 
        
           			}, 
        
           			expected: "aurora: some credentials information are missing: AURORA_USER_ID,AURORA_KEY", 
        
           		}, 
        
           		{ 
        
           			desc: "missing user id", 
        
           			envVars: map[string]string{ 
        
           				"AURORA_USER_ID": "", 
        
           				"AURORA_KEY":     "456", 
        
           			}, 
        
           			expected: "aurora: some credentials information are missing: AURORA_USER_ID", 
        
           		}, 
        
           		{ 
        
           			desc: "missing key", 
        
           			envVars: map[string]string{ 
        
           				"AURORA_USER_ID": "123", 
        
           				"AURORA_KEY":     "", 
        
           			}, 
        
           			expected: "aurora: some credentials information are missing: AURORA_KEY", 
        
           		}, 
        
           	} 
        
           	for _, test := range testCases { 
        
           		t.Run(test.desc, func(t *testing.T) { 
        
           			defer envTest.RestoreEnv() 
        
           			envTest.ClearEnv() 
        
           			envTest.Apply(test.envVars) 
        
           			p, err := NewDNSProvider() 
        
           			if len(test.expected) == 0 { 
        
           				require.NoError(t, err) 
        
           				require.NotNil(t, p) 
        
           				require.NotNil(t, p.config) 
        
           				require.NotNil(t, p.client) 
        
           			} else { 
        
           				require.EqualError(t, err, test.expected) 
        
           			} 
        
           		}) 
        
           	} 
        
           } 
        
           func TestNewDNSProviderConfig(t *testing.T) { 
        
           	testCases := []struct { 
        
           		desc     string 
        
           		userID   string 
        
           		key      string 
        
           		expected string 
        
           	}{ 
        
           		{ 
        
           			desc:   "success", 
        
           			userID: "123", 
        
           			key:    "456", 
        
           		}, 
        
           		{ 
        
           			desc:     "missing credentials", 
        
           			userID:   "", 
        
           			key:      "", 
        
           			expected: "aurora: some credentials information are missing", 
        
           		}, 
        
           		{ 
        
           			desc:     "missing user id", 
        
           			userID:   "", 
        
           			key:      "456", 
        
           			expected: "aurora: some credentials information are missing", 
        
           		}, 
        
           		{ 
        
           			desc:     "missing key", 
        
           			userID:   "123", 
        
           			key:      "", 
        
           			expected: "aurora: some credentials information are missing", 
        
           		}, 
        
           	} 
        
           	for _, test := range testCases { 
        
           		t.Run(test.desc, func(t *testing.T) { 
        
           			config := NewDefaultConfig() 
        
           			config.UserID = test.userID 
        
           			config.Key = test.key 
        
           			p, err := NewDNSProviderConfig(config) 
        
           			if len(test.expected) == 0 { 
        
           				require.NoError(t, err) 
        
           				require.NotNil(t, p) 
        
           				require.NotNil(t, p.config) 
        
           				require.NotNil(t, p.client) 
        
           			} else { 
        
           				require.EqualError(t, err, test.expected) 
        
           			} 
        
           		}) 
        
           	} 
        
           }

providers/dns/autodns/autodns.toml

providers/dns/autodns/autodns.go

kolaente · 2019-09-02T07:47:30Z

@ldez When implementing Timeout(), should I make it configurable?

Edit: Timeout is now implemented, configurable.

kolaente · 2019-10-25T13:44:22Z

CI passes now.

kolaente · 2019-10-25T13:45:15Z

@ldez What else needs to be done to get this PR merged?

ldez · 2019-10-25T15:43:43Z

Could you run:

./lego -m your@email.com --dns autodns -d *.example.com -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

Note, there are 2 domains -d *.example.com -d example.com

kolaente · 2019-10-28T07:57:46Z

@ldez I've updated the comment.

ldez · 2019-10-30T21:29:48Z

I'm annoyed because there is a bug with GitHub (I contacted them on this topic) that prevents me from editing your PR because your fork is in an organization.

So there are 3 solutions:

you give the rights on your repository (I do not feel very comfortable with this because it's a bit extreme as a solution)
I open a PR on your fork to edit your code. (a PR on PR, it's a bit weird)
you open a new PR by using a fork in your account. (I dislike this solution but it's a solution)

What do you prefer?

kolaente · 2019-10-30T21:32:12Z

@ldez what do you need the rights for?

I think none of these solutions are ideal, maybe the best is to open a PR to the fork.

ldez · 2019-10-30T21:43:48Z

I need the rights to apply some review fixes.

I opened a PR iMi-digital#1

Review 957

kolaente · 2019-10-31T09:28:58Z

@ldez Merged.

ldez

Thank you 👍

ldez · 2019-10-31T12:12:24Z

could you solve this:

golangci-lint run
providers/dns/autodns/client.go:16:2: `demoEndpoint` is unused (varcheck)
	demoEndpoint    = "https://api.demo.autodns.com/v1/"
	^
Makefile:39: recipe for target 'checks' failed

kolaente · 2019-11-01T07:18:42Z

@ldez Done.

kolaente · 2019-11-04T08:44:08Z

@ldez How do we proceed to get this in traefik? Should I send a pr after you released a new version of lego?

ldez · 2019-11-04T08:57:16Z

yes you have to wait for the next lego release.

kolaente · 2020-01-12T11:59:27Z

@rmoriz Could you open an issue?

klg added 6 commits August 30, 2019 10:27

Started adding autodns support

4b694ec

Autodns support roughly working

7c8d591

Fixed clearing all records when adding/removing the challenge record

1b8f676

Started adding tests

beedce7

Added more tests

570fc61

Implemented adding/removing of records using the stream api

83c3955

kolaente mentioned this pull request Aug 30, 2019

AutoDNS API Support? #501

Closed

klg added 2 commits August 30, 2019 16:22

Fixed lint

f209a5f

Fixed lint

3d32893

amenk approved these changes Aug 30, 2019

View reviewed changes

cmd/zz_gen_cmd_dnshelp.go Show resolved Hide resolved

providers/dns/autodns/autodns.go Outdated Show resolved Hide resolved

ldez added area/dnsprovider enhancement labels Aug 30, 2019

klg and others added 7 commits September 2, 2019 08:25

Updated readme

58b82de

Updated tests

38177e5

Added more config variables

e126098

make generate

b3d3840

Fixed lint

ba90111

Tidy go mod

fd8b474

Merge branch 'master' into feature/autodns

91dbe58

ldez requested changes Sep 2, 2019

View reviewed changes

providers/dns/autodns/autodns.toml Outdated Show resolved Hide resolved

providers/dns/autodns/autodns.toml Show resolved Hide resolved

providers/dns/autodns/autodns.go Outdated Show resolved Hide resolved

providers/dns/autodns/autodns.go Outdated Show resolved Hide resolved

klg added 6 commits September 3, 2019 08:20

Added timeouts

4492220

Added example

c8d9af3

Moved more stuff to default config

388d597

Added http timeout setting

b0058c4

Moved getting new dns provider config to own function

e2ece28

Fixed tests

5047429

Fixed lint

5c66aec

ldez changed the title ~~WIP: Add support for autodns~~ Add support for autodns Oct 25, 2019

ldez added the contrib/waiting-for-feedback label Oct 25, 2019

ldez removed the contrib/waiting-for-feedback label Oct 28, 2019

review quick review.

dc91e3f

Merge branch 'master' into feature/autodns

77ebb41

ldez added 2 commits October 30, 2019 22:32

review: add documentation.

73276e5

review: homogeneous unit tests with the other providers.

6653372

Merge pull request #1 from ldez/review/957

9f5c102

Review 957

ldez added this to the v3.2 milestone Oct 31, 2019

ldez approved these changes Oct 31, 2019

View reviewed changes

ldez added the contrib/waiting-for-correction label Oct 31, 2019

Fixed lint

d792fdc

ldez merged commit 46680f6 into go-acme:master Nov 1, 2019

kolaente deleted the feature/autodns branch November 1, 2019 12:57

ldez removed the contrib/waiting-for-correction label Nov 4, 2019

This comment has been minimized.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for autodns #957

Add support for autodns #957

kolaente commented Aug 30, 2019 •

edited

ldez commented Aug 30, 2019 •

edited

kolaente commented Sep 2, 2019 •

edited

kolaente commented Sep 2, 2019 •

edited

ldez left a comment

kolaente commented Sep 2, 2019 •

edited

kolaente commented Oct 25, 2019

kolaente commented Oct 25, 2019

ldez commented Oct 25, 2019

kolaente commented Oct 28, 2019

ldez commented Oct 30, 2019 •

edited

kolaente commented Oct 30, 2019 •

edited

ldez commented Oct 30, 2019

kolaente commented Oct 31, 2019

ldez left a comment

ldez commented Oct 31, 2019

kolaente commented Nov 1, 2019

kolaente commented Nov 4, 2019

ldez commented Nov 4, 2019

This comment has been minimized.

kolaente commented Jan 12, 2020

	// Timeout returns the timeout and interval to use when checking for DNS propagation.
	// Adjusting here to cope with spikes in propagation times.
	func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
	return d.config.PropagationTimeout, d.config.PollingInterval
	}

	func TestNewDNSProvider(t *testing.T) {
	testCases := []struct {
	desc string
	envVars map[string]string
	expected string
	}{
	{
	desc: "success",
	envVars: map[string]string{
	"AURORA_USER_ID": "123",
	"AURORA_KEY": "456",
	},
	},
	{
	desc: "missing credentials",
	envVars: map[string]string{
	"AURORA_USER_ID": "",
	"AURORA_KEY": "",
	},
	expected: "aurora: some credentials information are missing: AURORA_USER_ID,AURORA_KEY",
	},
	{
	desc: "missing user id",
	envVars: map[string]string{
	"AURORA_USER_ID": "",
	"AURORA_KEY": "456",
	},
	expected: "aurora: some credentials information are missing: AURORA_USER_ID",
	},
	{
	desc: "missing key",
	envVars: map[string]string{
	"AURORA_USER_ID": "123",
	"AURORA_KEY": "",
	},
	expected: "aurora: some credentials information are missing: AURORA_KEY",
	},
	}

	for _, test := range testCases {
	t.Run(test.desc, func(t *testing.T) {
	defer envTest.RestoreEnv()
	envTest.ClearEnv()

	envTest.Apply(test.envVars)

	p, err := NewDNSProvider()

	if len(test.expected) == 0 {
	require.NoError(t, err)
	require.NotNil(t, p)
	require.NotNil(t, p.config)
	require.NotNil(t, p.client)
	} else {
	require.EqualError(t, err, test.expected)
	}
	})
	}
	}

	func TestNewDNSProviderConfig(t *testing.T) {
	testCases := []struct {
	desc string
	userID string
	key string
	expected string
	}{
	{
	desc: "success",
	userID: "123",
	key: "456",
	},
	{
	desc: "missing credentials",
	userID: "",
	key: "",
	expected: "aurora: some credentials information are missing",
	},
	{
	desc: "missing user id",
	userID: "",
	key: "456",
	expected: "aurora: some credentials information are missing",
	},
	{
	desc: "missing key",
	userID: "123",
	key: "",
	expected: "aurora: some credentials information are missing",
	},
	}

	for _, test := range testCases {
	t.Run(test.desc, func(t *testing.T) {
	config := NewDefaultConfig()
	config.UserID = test.userID
	config.Key = test.key

	p, err := NewDNSProviderConfig(config)

	if len(test.expected) == 0 {
	require.NoError(t, err)
	require.NotNil(t, p)
	require.NotNil(t, p.config)
	require.NotNil(t, p.client)
	} else {
	require.EqualError(t, err, test.expected)
	}
	})
	}
	}

Add support for autodns #957

Add support for autodns #957

Conversation

kolaente commented Aug 30, 2019 • edited

Checklist

ldez commented Aug 30, 2019 • edited

kolaente commented Sep 2, 2019 • edited

kolaente commented Sep 2, 2019 • edited

ldez left a comment

Choose a reason for hiding this comment

kolaente commented Sep 2, 2019 • edited

kolaente commented Oct 25, 2019

kolaente commented Oct 25, 2019

ldez commented Oct 25, 2019

kolaente commented Oct 28, 2019

ldez commented Oct 30, 2019 • edited

kolaente commented Oct 30, 2019 • edited

ldez commented Oct 30, 2019

kolaente commented Oct 31, 2019

ldez left a comment

Choose a reason for hiding this comment

ldez commented Oct 31, 2019

kolaente commented Nov 1, 2019

kolaente commented Nov 4, 2019

ldez commented Nov 4, 2019

This comment has been minimized.

kolaente commented Jan 12, 2020

kolaente commented Aug 30, 2019 •

edited

ldez commented Aug 30, 2019 •

edited

kolaente commented Sep 2, 2019 •

edited

kolaente commented Sep 2, 2019 •

edited

kolaente commented Sep 2, 2019 •

edited

ldez commented Oct 30, 2019 •

edited

kolaente commented Oct 30, 2019 •

edited