auth: clone the client request body before roundtripping (#597)
RoundTrippers may read and close the body, so be careful to clone before roundtripping during client oauth, as the request may be issued multiple times. Fixes #590
This commit is contained in:
parent
f01e7faaf5
commit
1a907bcd6f
2 changed files with 83 additions and 1 deletions
|
|
@ -7,8 +7,10 @@
|
||||||
package auth
|
package auth
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
|
|
@ -67,6 +69,28 @@ func (t *HTTPTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
base := t.opts.Base
|
base := t.opts.Base
|
||||||
t.mu.Unlock()
|
t.mu.Unlock()
|
||||||
|
|
||||||
|
var (
|
||||||
|
// If haveBody is set, the request has a nontrivial body, and we need avoid
|
||||||
|
// reading (or closing) it multiple times. In that case, bodyBytes is its
|
||||||
|
// content.
|
||||||
|
haveBody bool
|
||||||
|
bodyBytes []byte
|
||||||
|
)
|
||||||
|
if req.Body != nil && req.Body != http.NoBody {
|
||||||
|
// if we're setting Body, we must mutate first.
|
||||||
|
req = req.Clone(req.Context())
|
||||||
|
haveBody = true
|
||||||
|
var err error
|
||||||
|
bodyBytes, err = io.ReadAll(req.Body)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
// Now that we've read the request body, http.RoundTripper requires that we
|
||||||
|
// close it.
|
||||||
|
req.Body.Close() // ignore error
|
||||||
|
req.Body = io.NopCloser(bytes.NewReader(bodyBytes))
|
||||||
|
}
|
||||||
|
|
||||||
resp, err := base.RoundTrip(req)
|
resp, err := base.RoundTrip(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
|
|
@ -97,7 +121,15 @@ func (t *HTTPTransport) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||||
}
|
}
|
||||||
t.opts.Base = &oauth2.Transport{Base: t.opts.Base, Source: ts}
|
t.opts.Base = &oauth2.Transport{Base: t.opts.Base, Source: ts}
|
||||||
}
|
}
|
||||||
return t.opts.Base.RoundTrip(req.Clone(req.Context()))
|
|
||||||
|
// If we don't have a body, the request is reusable, though it will be cloned
|
||||||
|
// by the base. However, if we've had to read the body, we must clone.
|
||||||
|
if haveBody {
|
||||||
|
req = req.Clone(req.Context())
|
||||||
|
req.Body = io.NopCloser(bytes.NewReader(bodyBytes))
|
||||||
|
}
|
||||||
|
|
||||||
|
return t.opts.Base.RoundTrip(req)
|
||||||
}
|
}
|
||||||
|
|
||||||
func extractResourceMetadataURL(authHeaders []string) string {
|
func extractResourceMetadataURL(authHeaders []string) string {
|
||||||
|
|
|
||||||
|
|
@ -10,13 +10,24 @@ import (
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"golang.org/x/oauth2"
|
"golang.org/x/oauth2"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// A basicReader is an io.Reader to be used as a non-rereadable request body.
|
||||||
|
//
|
||||||
|
// net/http has special handling for strings.Reader that we want to avoid.
|
||||||
|
type basicReader struct {
|
||||||
|
r *strings.Reader
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *basicReader) Read(p []byte) (n int, err error) { return r.r.Read(p) }
|
||||||
|
|
||||||
// TestHTTPTransport validates the OAuth HTTPTransport.
|
// TestHTTPTransport validates the OAuth HTTPTransport.
|
||||||
func TestHTTPTransport(t *testing.T) {
|
func TestHTTPTransport(t *testing.T) {
|
||||||
const testToken = "test-token-123"
|
const testToken = "test-token-123"
|
||||||
|
|
@ -27,6 +38,20 @@ func TestHTTPTransport(t *testing.T) {
|
||||||
|
|
||||||
// authServer simulates a resource that requires OAuth.
|
// authServer simulates a resource that requires OAuth.
|
||||||
authServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
authServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.Method == http.MethodPost {
|
||||||
|
// Ensure that the body was properly cloned, by reading it completely.
|
||||||
|
// If the body is not cloned, reading it the second time may yield no
|
||||||
|
// bytes.
|
||||||
|
body, err := io.ReadAll(r.Body)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, err.Error(), http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if len(body) == 0 {
|
||||||
|
http.Error(w, "empty body", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
authHeader := r.Header.Get("Authorization")
|
authHeader := r.Header.Get("Authorization")
|
||||||
if authHeader == fmt.Sprintf("Bearer %s", testToken) {
|
if authHeader == fmt.Sprintf("Bearer %s", testToken) {
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
|
|
@ -82,6 +107,31 @@ func TestHTTPTransport(t *testing.T) {
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
t.Run("request body is cloned", func(t *testing.T) {
|
||||||
|
handler := func(ctx context.Context, args OAuthHandlerArgs) (oauth2.TokenSource, error) {
|
||||||
|
if args.ResourceMetadataURL != "http://metadata.example.com" {
|
||||||
|
t.Errorf("handler got metadata URL %q, want %q", args.ResourceMetadataURL, "http://metadata.example.com")
|
||||||
|
}
|
||||||
|
return fakeTokenSource, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
transport, err := NewHTTPTransport(handler, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("NewHTTPTransport() failed: %v", err)
|
||||||
|
}
|
||||||
|
client := &http.Client{Transport: transport}
|
||||||
|
|
||||||
|
resp, err := client.Post(authServer.URL, "application/json", &basicReader{strings.NewReader("{}")})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("client.Post() failed: %v", err)
|
||||||
|
}
|
||||||
|
defer resp.Body.Close()
|
||||||
|
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Errorf("got status %d, want %d", resp.StatusCode, http.StatusOK)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
t.Run("handler returns error", func(t *testing.T) {
|
t.Run("handler returns error", func(t *testing.T) {
|
||||||
handlerErr := errors.New("user rejected auth")
|
handlerErr := errors.New("user rejected auth")
|
||||||
handler := func(ctx context.Context, args OAuthHandlerArgs) (oauth2.TokenSource, error) {
|
handler := func(ctx context.Context, args OAuthHandlerArgs) (oauth2.TokenSource, error) {
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue