Skip to content

fix: print TLS connection information before HTTP request headers #36

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.

Sign up for GitHub

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

Open
AdamMagued wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: print TLS connection information before HTTP request headers #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f069466
fix: print TLS connection information before HTTP request headers
AdamMagued Oct 2, 2026
91a95a4
test: remove deprecated DualStack dialer option to satisfy staticchec…
AdamMagued Oct 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1762,6 +1762,52 @@ func TestOutgoingTLS(t *testing.T) {
testBody(t, resp.Body, []byte("Hello, world!"))
}

func TestOutgoingTLSPrintOrder(t *testing.T) {
t.Parallel()
for _, flusher := range []Flusher{NoBuffer, OnReady, OnEnd} {
ts := httptest.NewTLSServer(&helloHandler{})
defer ts.Close()

logger := &Logger{
TLS: true,
RequestHeader: true,
RequestBody: true,
ResponseHeader: true,
ResponseBody: true,
}
logger.SetFlusher(flusher)
var buf bytes.Buffer
logger.SetOutput(&buf)
client := ts.Client()
client.Transport = logger.RoundTripper(client.Transport)

req, err := http.NewRequest(http.MethodGet, ts.URL, nil)
if err != nil {
t.Fatalf("cannot create request: %v", err)
}
req.Host = "example.com"
resp, err := client.Do(req)
if err != nil {
t.Fatalf("cannot connect to server: %v", err)
}
resp.Body.Close()

got := buf.String()
tlsIdx := strings.Index(got, "* TLS connection using ")
reqIdx := strings.Index(got, "> GET / HTTP/1.1")
respIdx := strings.Index(got, "< HTTP/1.1 200 OK")
if tlsIdx == -1 || reqIdx == -1 || respIdx == -1 {
t.Fatalf("flusher %v: missing expected log sections in output:\n%s", flusher, got)
}
if tlsIdx >= reqIdx {
t.Errorf("flusher %v: TLS info at index %d should appear before request header at index %d", flusher, tlsIdx, reqIdx)
}
if reqIdx >= respIdx {
t.Errorf("flusher %v: request header at index %d should appear before response header at index %d", flusher, reqIdx, respIdx)
}
}
}

func TestOutgoingTLSIPSAN(t *testing.T) {
t.Parallel()
ts := httptest.NewTLSServer(&helloHandler{})
Expand Down
25 changes: 18 additions & 7 deletions httpretty.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,6 @@ type Logger struct {
Time bool

// TLS information, such as certificates and ciphers.
// BUG(henvic): Currently, the TLS information prints after the response header, although it
// should be printed before the request header.
TLS bool

// RequestHeader set by the client or received from the server.
Expand Down Expand Up @@ -311,18 +309,31 @@ func (r roundTripper) RoundTrip(req *http.Request) (resp *http.Response, err err
// please remember http.Request.TLS is ignored by the HTTP client.
p.printOutgoingClientTLS(tlsClientConfig)
}
p.printRequest(req)
var reqP printer
if l.TLS {
reqP = printer{
logger: l,
flusher: OnEnd,
}
reqP.printRequest(req)
} else {
p.printRequest(req)
}
defer func() {
if l.TLS {
if resp != nil {
p.printTLSInfo(resp.TLS, false)
p.printTLSServer(req.Host, resp.TLS)
}
p.print(reqP.buf.String())
p.maybeOnReady()
}
if err != nil {
p.printf("* %s\n", p.format(color.FgRed, err.Error()))
if resp == nil {
return
}
}
if l.TLS {
p.printTLSInfo(resp.TLS, false)
p.printTLSServer(req.Host, resp.TLS)
}
p.printResponse(resp)
}()
return tripper.RoundTrip(req)
Expand Down
1 change: 0 additions & 1 deletion httpretty_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,6 @@ func newTransport() *http.Transport {
DialContext: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
DualStack: true,
}).DialContext,
ForceAttemptHTTP2: true,
MaxIdleConns: 100,
Expand Down
30 changes: 15 additions & 15 deletions testdata/log.txtar
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -540,9 +540,6 @@ form received
\* start date: Sat Jan 25 20:12:36 UTC 2020
\* expire date: Mon Jan 1 20:12:36 UTC 2120
\* issuer: CN=User,OU=User,O=Client,L=Rotterdam,ST=Zuid-Holland,C=NL
> GET /mutual-tls-test HTTP/1\.1
> Host: localhost:%s

\* TLS connection using TLS \d+\.\d+ / \w+
\* ALPN: h2 accepted
\* Server certificate:
Expand All @@ -552,6 +549,9 @@ form received
\* subjectAltName: "localhost" matches cert's "localhost"
\* issuer: CN=localhost,OU=Cloud,O=Plifk,L=Carmel-by-the-Sea,ST=California,C=US
\* TLS certificate verify ok\.
> GET /mutual-tls-test HTTP/1\.1
> Host: localhost:%s

< HTTP/2\.0 200 OK
< Content-Length: 13
< Content-Type: text/plain; charset=utf-8
Expand Down Expand Up @@ -740,10 +740,6 @@ Hello, world!
Hello, world!
-- TestOutgoingTLS --
^\* Request to %s
> GET / HTTP/1\.1
> Host: example\.com
> User-Agent: Robot/0\.1 crawler@example\.com

\* TLS connection using TLS \d+\.\d+ / \w+
\* Server certificate:
\* subject: O=Acme Co
Expand All @@ -752,6 +748,10 @@ Hello, world!
\* subjectAltName: "example\.com" matches cert's "example\.com"
\* issuer: O=Acme Co
\* TLS certificate verify ok\.
> GET / HTTP/1\.1
> Host: example\.com
> User-Agent: Robot/0\.1 crawler@example\.com

< HTTP/1\.1 200 OK
< Content-Length: 13
< Content-Type: text/plain; charset=utf-8
Expand All @@ -771,10 +771,6 @@ Hello, world!
* remote error: tls: %s
-- TestOutgoingTLSIPSAN --
^\* Request to %s
> GET / HTTP/1\.1
> Host: 127\.0\.0\.1
> User-Agent: Robot/0\.1 crawler@example\.com

\* TLS connection using TLS \d+\.\d+ / \w+
\* Server certificate:
\* subject: O=Acme Co
Expand All @@ -783,6 +779,10 @@ Hello, world!
\* subjectAltName: "127\.0\.0\.1" matches cert's IP address!
\* issuer: O=Acme Co
\* TLS certificate verify ok\.
> GET / HTTP/1\.1
> Host: 127\.0\.0\.1
> User-Agent: Robot/0\.1 crawler@example\.com

< HTTP/1\.1 200 OK
< Content-Length: 13
< Content-Type: text/plain; charset=utf-8
Expand All @@ -791,10 +791,6 @@ Hello, world!
-- TestOutgoingTLSInsecureSkipVerify --
^\* Request to %s
\* Skipping TLS verification: connection is susceptible to man-in-the-middle attacks\.
> GET / HTTP/1\.1
> Host: example\.com
> User-Agent: Robot/0\.1 crawler@example\.com

\* TLS connection using TLS \d+\.\d+ / \w+ \(insecure=true\)
\* Server certificate:
\* subject: O=Acme Co
Expand All @@ -803,6 +799,10 @@ Hello, world!
\* subjectAltName: "example\.com" matches cert's "example\.com"
\* issuer: O=Acme Co
\* TLS certificate verify ok\.
> GET / HTTP/1\.1
> Host: example\.com
> User-Agent: Robot/0\.1 crawler@example\.com

< HTTP/1\.1 200 OK
< Content-Length: 13
< Content-Type: text/plain; charset=utf-8
Expand Down