Merge pull request #50 from xenolf/better-challenge-errors

Better challenge errors

acme/error.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"strings"
 )
 
 const (
@@ -28,6 +29,27 @@ type TOSError struct {
 	RemoteError
 }
 
+type domainError struct {
+	Domain string
+	Error  error
+}
+
+type challengeError struct {
+	RemoteError
+	records []validationRecord
+}
+
+func (c challengeError) Error() string {
+
+	var errStr string
+	for _, validation := range c.records {
+		errStr = errStr + fmt.Sprintf("\tValidation for %s:%s\n\tResolved to:\n\t\t%s\n\tUsed: %s\n\n", 
+		validation.Hostname, validation.Port, strings.Join(validation.ResolvedAddresses, "\n\t\t"), validation.UsedAddress)
+	}
+
+	return fmt.Sprintf("%s\nError Detail:\n%s", c.RemoteError.Error(), errStr)
+}
+
 func handleHTTPError(resp *http.Response) error {
 	var errorDetail RemoteError
 	decoder := json.NewDecoder(resp.Body)
@@ -46,7 +68,6 @@ func handleHTTPError(resp *http.Response) error {
 	return errorDetail
 }
 
-type domainError struct {
-	Domain string
-	Error  error
+func handleChallengeError(chlng challenge) error {
+	return challengeError{chlng.Error, chlng.ValidationRecords}
 }

acme/http_challenge.go

@@ -80,7 +80,7 @@ Loop:
 		case "pending":
 			break
 		case "invalid":
-			return errors.New("The server could not validate our request.")
+			return handleChallengeError(challengeResponse)
 		default:
 			return errors.New("The server returned an unexpected state.")
 		}

acme/http_challenge_test.go

@@ -161,7 +161,7 @@ func TestHTTPInvalidServerState(t *testing.T) {
 	if err := solver.Solve(clientChallenge, "127.0.0.1"); err == nil {
 		t.Error("UNEXPECTED: Expected Solve to return an error but the error was nil.")
 	} else {
-		expectedError := "The server could not validate our request."
+		expectedError := "acme: Error 0 -  - \nError Detail:\n"
 		if err.Error() != expectedError {
 			t.Errorf("Expected error |%s| but instead got |%s|", expectedError, err.Error())
 		}

acme/messages.go

@@ -72,15 +72,25 @@ type identifier struct {
 	Value string `json:"value"`
 }
 
+type validationRecord struct {
+	URI               string   `json:"url,omitempty"`
+	Hostname          string   `json:"hostname,omitempty"`
+	Port              string   `json:"port,omitempty"`
+	ResolvedAddresses []string `json:"addressesResolved,omitempty"`
+	UsedAddress       string   `json:"addressUsed,omitempty"`
+}
+
 type challenge struct {
-	Resource         string `json:"resource,omitempty"`
-	Type             string `json:"type,omitempty"`
-	Status           string `json:"status,omitempty"`
-	URI              string `json:"uri,omitempty"`
-	Token            string `json:"token,omitempty"`
-	KeyAuthorization string `json:"keyAuthorization,omitempty"`
-	TLS              bool   `json:"tls,omitempty"`
-	Iterations       int    `json:"n,omitempty"`
+	Resource          string             `json:"resource,omitempty"`
+	Type              string             `json:"type,omitempty"`
+	Status            string             `json:"status,omitempty"`
+	URI               string             `json:"uri,omitempty"`
+	Token             string             `json:"token,omitempty"`
+	KeyAuthorization  string             `json:"keyAuthorization,omitempty"`
+	TLS               bool               `json:"tls,omitempty"`
+	Iterations        int                `json:"n,omitempty"`
+	Error             RemoteError        `json:"error,omitempty"`
+	ValidationRecords []validationRecord `json:"validationRecord,omitempty"`
 }
 
 type csrMessage struct {

acme/tls_sni_challenge.go

@@ -90,7 +90,7 @@ Loop:
 		case "pending":
 			break
 		case "invalid":
-			return errors.New("The server could not validate our request.")
+			return handleChallengeError(challengeResponse)
 		default:
 			return errors.New("The server returned an unexpected state.")
 		}
@@ -146,8 +146,8 @@ func (t *tlsSNIChallenge) startSNITLSServer(cert tls.Certificate) {
 	}
 	// Signal successfull start
 	t.start <- tlsListener
-	
+
 	http.Serve(tlsListener, nil)
-	
+
 	t.end <- nil
 }