mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-10-31 22:18:52 +00:00
move http request signing to transport
This commit is contained in:
parent
f05874be30
commit
a434830f24
5 changed files with 89 additions and 14 deletions
|
@ -19,6 +19,7 @@ package gtscontext
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
|
||||||
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
||||||
|
@ -42,6 +43,7 @@ const (
|
||||||
httpSigKey
|
httpSigKey
|
||||||
httpSigPubKeyIDKey
|
httpSigPubKeyIDKey
|
||||||
dryRunKey
|
dryRunKey
|
||||||
|
httpClientSignFnKey
|
||||||
)
|
)
|
||||||
|
|
||||||
// DryRun returns whether the "dryrun" context key has been set. This can be
|
// DryRun returns whether the "dryrun" context key has been set. This can be
|
||||||
|
@ -127,6 +129,15 @@ func SetOtherIRIs(ctx context.Context, iris []*url.URL) context.Context {
|
||||||
return context.WithValue(ctx, otherIRIsKey, iris)
|
return context.WithValue(ctx, otherIRIsKey, iris)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func HTTPClientSignFunc(ctx context.Context) func(*http.Request) error {
|
||||||
|
fn, _ := ctx.Value(httpClientSignFnKey).(func(*http.Request) error)
|
||||||
|
return fn
|
||||||
|
}
|
||||||
|
|
||||||
|
func SetHTTPClientSignFunc(ctx context.Context, fn func(*http.Request) error) context.Context {
|
||||||
|
return context.WithValue(ctx, httpClientSignFnKey, fn)
|
||||||
|
}
|
||||||
|
|
||||||
// HTTPSignatureVerifier returns an http signature verifier for the current ActivityPub
|
// HTTPSignatureVerifier returns an http signature verifier for the current ActivityPub
|
||||||
// request chain. This verifier can be called to authenticate the current request.
|
// request chain. This verifier can be called to authenticate the current request.
|
||||||
func HTTPSignatureVerifier(ctx context.Context) httpsig.VerifierWithOptions {
|
func HTTPSignatureVerifier(ctx context.Context) httpsig.VerifierWithOptions {
|
||||||
|
|
|
@ -17,12 +17,45 @@
|
||||||
|
|
||||||
package httpclient
|
package httpclient
|
||||||
|
|
||||||
import "net/http"
|
import (
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"codeberg.org/gruf/go-byteutil"
|
||||||
|
"github.com/superseriousbusiness/gotosocial/internal/gtscontext"
|
||||||
|
)
|
||||||
|
|
||||||
// SignFunc is a function signature that provides request signing.
|
// SignFunc is a function signature that provides request signing.
|
||||||
type SignFunc func(r *http.Request) error
|
type SignFunc func(r *http.Request) error
|
||||||
|
|
||||||
type SigningClient interface {
|
// signingtransport wraps an http.Transport{}
|
||||||
Do(r *http.Request) (*http.Response, error)
|
// (RoundTripper implementer) to check request
|
||||||
DoSigned(r *http.Request, sign SignFunc) (*http.Response, error)
|
// context for a signing function and using for
|
||||||
|
// all subsequent trips through RoundTrip().
|
||||||
|
type signingtransport struct {
|
||||||
|
http.Transport // underlying transport
|
||||||
|
}
|
||||||
|
|
||||||
|
func (t *signingtransport) RoundTrip(r *http.Request) (*http.Response, error) {
|
||||||
|
if sign := gtscontext.HTTPClientSignFunc(r.Context()); sign != nil {
|
||||||
|
// Reset signing header fields
|
||||||
|
now := time.Now().UTC()
|
||||||
|
r.Header.Set("Date", now.Format("Mon, 02 Jan 2006 15:04:05")+" GMT")
|
||||||
|
r.Header.Del("Signature")
|
||||||
|
r.Header.Del("Digest")
|
||||||
|
|
||||||
|
// Rewind body reader and content-length if set.
|
||||||
|
if rc, ok := r.Body.(*byteutil.ReadNopCloser); ok {
|
||||||
|
rc.Rewind() // set len AFTER rewind
|
||||||
|
r.ContentLength = int64(rc.Len())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sign the outgoing request.
|
||||||
|
if err := sign(r); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pass to underlying transport.
|
||||||
|
return t.Transport.RoundTrip(r)
|
||||||
}
|
}
|
||||||
|
|
|
@ -37,7 +37,6 @@ import (
|
||||||
"github.com/superseriousbusiness/gotosocial/internal/config"
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
||||||
"github.com/superseriousbusiness/gotosocial/internal/db"
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
||||||
"github.com/superseriousbusiness/gotosocial/internal/federation/federatingdb"
|
"github.com/superseriousbusiness/gotosocial/internal/federation/federatingdb"
|
||||||
"github.com/superseriousbusiness/gotosocial/internal/httpclient"
|
|
||||||
"github.com/superseriousbusiness/gotosocial/internal/state"
|
"github.com/superseriousbusiness/gotosocial/internal/state"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -54,14 +53,14 @@ type controller struct {
|
||||||
state *state.State
|
state *state.State
|
||||||
fedDB federatingdb.DB
|
fedDB federatingdb.DB
|
||||||
clock pub.Clock
|
clock pub.Clock
|
||||||
client httpclient.SigningClient
|
client pub.HttpClient
|
||||||
trspCache cache.TTLCache[string, *transport]
|
trspCache cache.TTLCache[string, *transport]
|
||||||
userAgent string
|
userAgent string
|
||||||
senders int // no. concurrent batch delivery routines.
|
senders int // no. concurrent batch delivery routines.
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewController returns an implementation of the Controller interface for creating new transports
|
// NewController returns an implementation of the Controller interface for creating new transports
|
||||||
func NewController(state *state.State, federatingDB federatingdb.DB, clock pub.Clock, client httpclient.SigningClient) Controller {
|
func NewController(state *state.State, federatingDB federatingdb.DB, clock pub.Clock, client pub.HttpClient) Controller {
|
||||||
var (
|
var (
|
||||||
host = config.GetHost()
|
host = config.GetHost()
|
||||||
proto = config.GetProtocol()
|
proto = config.GetProtocol()
|
||||||
|
|
|
@ -93,30 +93,61 @@ func (t *transport) GET(r *http.Request) (*http.Response, error) {
|
||||||
if r.Method != http.MethodGet {
|
if r.Method != http.MethodGet {
|
||||||
return nil, errors.New("must be GET request")
|
return nil, errors.New("must be GET request")
|
||||||
}
|
}
|
||||||
ctx := r.Context() // extract, set pubkey ID.
|
|
||||||
|
// Prepare HTTP GET signing func with opts.
|
||||||
|
sign := t.signGET(httpsig.SignatureOption{
|
||||||
|
ExcludeQueryStringFromPathPseudoHeader: false,
|
||||||
|
})
|
||||||
|
|
||||||
|
ctx := r.Context() // update with signing details.
|
||||||
ctx = gtscontext.SetOutgoingPublicKeyID(ctx, t.pubKeyID)
|
ctx = gtscontext.SetOutgoingPublicKeyID(ctx, t.pubKeyID)
|
||||||
|
ctx = gtscontext.SetHTTPClientSignFunc(ctx, sign)
|
||||||
r = r.WithContext(ctx) // replace request ctx.
|
r = r.WithContext(ctx) // replace request ctx.
|
||||||
|
|
||||||
|
// Set our predefined controller user-agent.
|
||||||
r.Header.Set("User-Agent", t.controller.userAgent)
|
r.Header.Set("User-Agent", t.controller.userAgent)
|
||||||
|
|
||||||
resp, err := t.controller.client.DoSigned(r, t.signGET(httpsig.SignatureOption{ExcludeQueryStringFromPathPseudoHeader: false}))
|
// Pass to underlying HTTP client.
|
||||||
|
resp, err := t.controller.client.Do(r)
|
||||||
if err != nil || resp.StatusCode != http.StatusUnauthorized {
|
if err != nil || resp.StatusCode != http.StatusUnauthorized {
|
||||||
return resp, err
|
return resp, err
|
||||||
}
|
}
|
||||||
|
|
||||||
// try again without the path included in the HTTP signature for better compatibility
|
// Ignore this response.
|
||||||
_ = resp.Body.Close()
|
_ = resp.Body.Close()
|
||||||
return t.controller.client.DoSigned(r, t.signGET(httpsig.SignatureOption{ExcludeQueryStringFromPathPseudoHeader: true}))
|
|
||||||
|
// Try again without the path included in
|
||||||
|
// the HTTP signature for better compatibility.
|
||||||
|
sign = t.signGET(httpsig.SignatureOption{
|
||||||
|
ExcludeQueryStringFromPathPseudoHeader: true,
|
||||||
|
})
|
||||||
|
|
||||||
|
ctx = r.Context() // update with signing details.
|
||||||
|
ctx = gtscontext.SetHTTPClientSignFunc(ctx, sign)
|
||||||
|
r = r.WithContext(ctx) // replace request ctx.
|
||||||
|
|
||||||
|
// Pass to underlying HTTP client.
|
||||||
|
return t.controller.client.Do(r)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *transport) POST(r *http.Request, body []byte) (*http.Response, error) {
|
func (t *transport) POST(r *http.Request, body []byte) (*http.Response, error) {
|
||||||
if r.Method != http.MethodPost {
|
if r.Method != http.MethodPost {
|
||||||
return nil, errors.New("must be POST request")
|
return nil, errors.New("must be POST request")
|
||||||
}
|
}
|
||||||
ctx := r.Context() // extract, set pubkey ID.
|
|
||||||
|
// Prepare POST signer.
|
||||||
|
sign := t.signPOST(body)
|
||||||
|
|
||||||
|
ctx := r.Context() // update with signing details.
|
||||||
ctx = gtscontext.SetOutgoingPublicKeyID(ctx, t.pubKeyID)
|
ctx = gtscontext.SetOutgoingPublicKeyID(ctx, t.pubKeyID)
|
||||||
|
ctx = gtscontext.SetHTTPClientSignFunc(ctx, sign)
|
||||||
r = r.WithContext(ctx) // replace request ctx.
|
r = r.WithContext(ctx) // replace request ctx.
|
||||||
|
|
||||||
|
// Set our predefined controller user-agent.
|
||||||
r.Header.Set("User-Agent", t.controller.userAgent)
|
r.Header.Set("User-Agent", t.controller.userAgent)
|
||||||
return t.controller.client.DoSigned(r, t.signPOST(body))
|
|
||||||
|
// Pass to underlying HTTP client.
|
||||||
|
return t.controller.client.Do(r)
|
||||||
}
|
}
|
||||||
|
|
||||||
// signGET will safely sign an HTTP GET request.
|
// signGET will safely sign an HTTP GET request.
|
||||||
|
|
|
@ -26,6 +26,7 @@ import (
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
|
|
||||||
|
"github.com/superseriousbusiness/activity/pub"
|
||||||
"github.com/superseriousbusiness/activity/streams"
|
"github.com/superseriousbusiness/activity/streams"
|
||||||
"github.com/superseriousbusiness/activity/streams/vocab"
|
"github.com/superseriousbusiness/activity/streams/vocab"
|
||||||
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
|
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
|
||||||
|
@ -51,7 +52,7 @@ const (
|
||||||
// Unlike the other test interfaces provided in this package, you'll probably want to call this function
|
// Unlike the other test interfaces provided in this package, you'll probably want to call this function
|
||||||
// PER TEST rather than per suite, so that the do function can be set on a test by test (or even more granular)
|
// PER TEST rather than per suite, so that the do function can be set on a test by test (or even more granular)
|
||||||
// basis.
|
// basis.
|
||||||
func NewTestTransportController(state *state.State, client httpclient.SigningClient) transport.Controller {
|
func NewTestTransportController(state *state.State, client pub.HttpClient) transport.Controller {
|
||||||
return transport.NewController(state, NewTestFederatingDB(state), &federation.Clock{}, client)
|
return transport.NewController(state, NewTestFederatingDB(state), &federation.Clock{}, client)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue