mirror of
https://github.com/go-acme/lego.git
synced 2024-12-05 20:02:38 +02:00
a1585a7b9a
* refactor: create log.Infof and log.Warnf * refactor: review DNS providers. - use one `http.Client` by provider instead of one client by request - use the same receiver name `d` for all `DNSProvider` - use `http.MethodXXX` * refactor: logger init.
211 lines
6.3 KiB
Go
211 lines
6.3 KiB
Go
package acme
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
func TestHTTPHeadUserAgent(t *testing.T) {
|
|
var ua, method string
|
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
ua = r.Header.Get("User-Agent")
|
|
method = r.Method
|
|
}))
|
|
defer ts.Close()
|
|
|
|
_, err := httpHead(ts.URL)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if method != http.MethodHead {
|
|
t.Errorf("Expected method to be HEAD, got %s", method)
|
|
}
|
|
if !strings.Contains(ua, ourUserAgent) {
|
|
t.Errorf("Expected User-Agent to contain '%s', got: '%s'", ourUserAgent, ua)
|
|
}
|
|
}
|
|
|
|
func TestHTTPGetUserAgent(t *testing.T) {
|
|
var ua, method string
|
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
ua = r.Header.Get("User-Agent")
|
|
method = r.Method
|
|
}))
|
|
defer ts.Close()
|
|
|
|
res, err := httpGet(ts.URL)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
res.Body.Close()
|
|
|
|
if method != http.MethodGet {
|
|
t.Errorf("Expected method to be GET, got %s", method)
|
|
}
|
|
if !strings.Contains(ua, ourUserAgent) {
|
|
t.Errorf("Expected User-Agent to contain '%s', got: '%s'", ourUserAgent, ua)
|
|
}
|
|
}
|
|
|
|
func TestHTTPPostUserAgent(t *testing.T) {
|
|
var ua, method string
|
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
ua = r.Header.Get("User-Agent")
|
|
method = r.Method
|
|
}))
|
|
defer ts.Close()
|
|
|
|
res, err := httpPost(ts.URL, "text/plain", strings.NewReader("falalalala"))
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
res.Body.Close()
|
|
|
|
if method != http.MethodPost {
|
|
t.Errorf("Expected method to be POST, got %s", method)
|
|
}
|
|
if !strings.Contains(ua, ourUserAgent) {
|
|
t.Errorf("Expected User-Agent to contain '%s', got: '%s'", ourUserAgent, ua)
|
|
}
|
|
}
|
|
|
|
func TestUserAgent(t *testing.T) {
|
|
ua := userAgent()
|
|
|
|
if !strings.Contains(ua, defaultGoUserAgent) {
|
|
t.Errorf("Expected UA to contain %s, got '%s'", defaultGoUserAgent, ua)
|
|
}
|
|
if !strings.Contains(ua, ourUserAgent) {
|
|
t.Errorf("Expected UA to contain %s, got '%s'", ourUserAgent, ua)
|
|
}
|
|
if strings.HasSuffix(ua, " ") {
|
|
t.Errorf("UA should not have trailing spaces; got '%s'", ua)
|
|
}
|
|
|
|
// customize the UA by appending a value
|
|
UserAgent = "MyApp/1.2.3"
|
|
ua = userAgent()
|
|
if !strings.Contains(ua, defaultGoUserAgent) {
|
|
t.Errorf("Expected UA to contain %s, got '%s'", defaultGoUserAgent, ua)
|
|
}
|
|
if !strings.Contains(ua, ourUserAgent) {
|
|
t.Errorf("Expected UA to contain %s, got '%s'", ourUserAgent, ua)
|
|
}
|
|
if !strings.Contains(ua, UserAgent) {
|
|
t.Errorf("Expected custom UA to contain %s, got '%s'", UserAgent, ua)
|
|
}
|
|
}
|
|
|
|
// TestInitCertPool tests the http.go initCertPool function for customizing the
|
|
// HTTP Client *x509.CertPool with an environment variable.
|
|
func TestInitCertPool(t *testing.T) {
|
|
// writeTemp creates a temp file with the given contents & prefix and returns
|
|
// the file path. If an error occurs, t.Fatalf is called to end the test run.
|
|
writeTemp := func(t *testing.T, contents, prefix string) string {
|
|
t.Helper()
|
|
tmpFile, err := ioutil.TempFile("", prefix)
|
|
if err != nil {
|
|
t.Fatalf("Unable to create tempfile: %v", err)
|
|
}
|
|
err = ioutil.WriteFile(tmpFile.Name(), []byte(contents), 0700)
|
|
if err != nil {
|
|
t.Fatalf("Unable to write tempfile contents: %v", err)
|
|
}
|
|
return tmpFile.Name()
|
|
}
|
|
|
|
invalidFileContents := "not a certificate"
|
|
invalidFile := writeTemp(t, invalidFileContents, "invalid.pem")
|
|
|
|
// validFileContents is lifted from Pebble[0]. Generate your own CA cert with
|
|
// MiniCA[1].
|
|
// [0]: https://github.com/letsencrypt/pebble/blob/de6fa233ea1f283eeb9751d42c8e1ae72718c44e/test/certs/pebble.minica.pem
|
|
// [1]: https://github.com/jsha/minica
|
|
validFileContents := `
|
|
-----BEGIN CERTIFICATE-----
|
|
MIIDCTCCAfGgAwIBAgIIJOLbes8sTr4wDQYJKoZIhvcNAQELBQAwIDEeMBwGA1UE
|
|
AxMVbWluaWNhIHJvb3QgY2EgMjRlMmRiMCAXDTE3MTIwNjE5NDIxMFoYDzIxMTcx
|
|
MjA2MTk0MjEwWjAgMR4wHAYDVQQDExVtaW5pY2Egcm9vdCBjYSAyNGUyZGIwggEi
|
|
MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC5WgZNoVJandj43kkLyU50vzCZ
|
|
alozvdRo3OFiKoDtmqKPNWRNO2hC9AUNxTDJco51Yc42u/WV3fPbbhSznTiOOVtn
|
|
Ajm6iq4I5nZYltGGZetGDOQWr78y2gWY+SG078MuOO2hyDIiKtVc3xiXYA+8Hluu
|
|
9F8KbqSS1h55yxZ9b87eKR+B0zu2ahzBCIHKmKWgc6N13l7aDxxY3D6uq8gtJRU0
|
|
toumyLbdzGcupVvjbjDP11nl07RESDWBLG1/g3ktJvqIa4BWgU2HMh4rND6y8OD3
|
|
Hy3H8MY6CElL+MOCbFJjWqhtOxeFyZZV9q3kYnk9CAuQJKMEGuN4GU6tzhW1AgMB
|
|
AAGjRTBDMA4GA1UdDwEB/wQEAwIChDAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYB
|
|
BQUHAwIwEgYDVR0TAQH/BAgwBgEB/wIBADANBgkqhkiG9w0BAQsFAAOCAQEAF85v
|
|
d40HK1ouDAtWeO1PbnWfGEmC5Xa478s9ddOd9Clvp2McYzNlAFfM7kdcj6xeiNhF
|
|
WPIfaGAi/QdURSL/6C1KsVDqlFBlTs9zYfh2g0UXGvJtj1maeih7zxFLvet+fqll
|
|
xseM4P9EVJaQxwuK/F78YBt0tCNfivC6JNZMgxKF59h0FBpH70ytUSHXdz7FKwix
|
|
Mfn3qEb9BXSk0Q3prNV5sOV3vgjEtB4THfDxSz9z3+DepVnW3vbbqwEbkXdk3j82
|
|
2muVldgOUgTwK8eT+XdofVdntzU/kzygSAtAQwLJfn51fS1GvEcYGBc1bDryIqmF
|
|
p9BI7gVKtWSZYegicA==
|
|
-----END CERTIFICATE-----
|
|
`
|
|
validFile := writeTemp(t, validFileContents, "valid.pem")
|
|
|
|
testCases := []struct {
|
|
Name string
|
|
EnvVar string
|
|
ExpectPanic bool
|
|
ExpectNil bool
|
|
}{
|
|
// Setting the env var to a file that doesn't exist should panic
|
|
{
|
|
Name: "Env var with missing file",
|
|
EnvVar: "not.a.real.file.pem",
|
|
ExpectPanic: true,
|
|
},
|
|
// Setting the env var to a file that contains invalid content should panic
|
|
{
|
|
Name: "Env var with invalid content",
|
|
EnvVar: invalidFile,
|
|
ExpectPanic: true,
|
|
},
|
|
// Setting the env var to the empty string should not panic and should
|
|
// return nil
|
|
{
|
|
Name: "No env var",
|
|
EnvVar: "",
|
|
ExpectPanic: false,
|
|
ExpectNil: true,
|
|
},
|
|
// Setting the env var to a file that contains valid content should not
|
|
// panic and should not return nil
|
|
{
|
|
Name: "Env var with valid content",
|
|
EnvVar: validFile,
|
|
ExpectPanic: false,
|
|
ExpectNil: false,
|
|
},
|
|
}
|
|
|
|
for _, tc := range testCases {
|
|
t.Run(tc.Name, func(t *testing.T) {
|
|
os.Setenv(caCertificatesEnvVar, tc.EnvVar)
|
|
defer os.Setenv(caCertificatesEnvVar, "")
|
|
|
|
defer func() {
|
|
if r := recover(); r == nil && tc.ExpectPanic {
|
|
t.Errorf("expected initCertPool() to panic, it did not")
|
|
} else if r != nil && !tc.ExpectPanic {
|
|
t.Errorf("expected initCertPool() to not panic, but it did")
|
|
}
|
|
}()
|
|
|
|
result := initCertPool()
|
|
|
|
if result == nil && !tc.ExpectNil {
|
|
t.Errorf("initCertPool() returned nil, expected non-nil")
|
|
} else if result != nil && tc.ExpectNil {
|
|
t.Errorf("initCertPool() returned non-nil, expected nil")
|
|
}
|
|
})
|
|
}
|
|
}
|