scriptoriumadmin/featurebase
1
0
Fork 0
mirror of https://github.com/featurebasedb/featurebase.git synced 2026-08-28 10:54:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor AddAuthToken to fallback to userinfo

Browse source 
This commit addresses a bug in https://molecula.atlassian.net/browse/SUP-200 where
the Authorization header was not being set correctly when the token was passed via
"userinfo" in the context and not "token".

Now, we prefix the token with "Bearer " when the token comes from userinfo.

This commit also adds a unit test for this function, and simplifies logic. It also
fixes a test that didn't quite test the behavior we wanted.
This commit is contained in:
reesporte 2022-03-30 12:45:29 -05:00
parent 23d8282663
commit f529e723e7
3 changed files with 45 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
api_test.go
View file

@ -1475,7 +1475,6 @@ func makeUser(t *testing.T, groups []authn.Group, name, secret string) *authn.Us
if err != nil {
t.Fatalf("signing string %v", err)
}
validToken = "Bearer " + validToken
return &authn.UserInfo{
UserID: "fake" + name,
@ -1520,7 +1519,7 @@ admin: "ac97c9e2-346b-42a2-b6da-18bcb61a32fe"`
return
}
g := []authn.Group{}
switch token[0] {
switch strings.TrimPrefix(token[0], "Bearer ") {
case adminUser.Token:
g = adminUser.Groups
case readUser.Token:

15
internal_client.go
View file

@ -144,10 +144,15 @@ func NewInternalClientFromURI(defaultURI *pnet.URI, remoteClient *http.Client, o
return ic
}
// AddAuthToken checks in a couple spots for our authorization token and adds it to
// the Authorization Header in the request if it finds it.
func AddAuthToken(ctx context.Context, req *http.Request) *http.Request {
token, ok := ctx.Value("token").(string)
if ok && token != "" {
if token, ok := ctx.Value("token").(string); ok && token != "" {
// the "token" value should be prefixed with "Bearer"
req.Header.Set("Authorization", token)
} else if uinfo := ctx.Value("userinfo"); uinfo != nil {
// UserInfo.Token is not prefixed with "Bearer"
req.Header.Set("Authorization", "Bearer "+uinfo.(*authn.UserInfo).Token)
}
return req
}
@ -606,12 +611,6 @@ func (c *InternalClient) QueryNode(ctx context.Context, uri *pnet.URI, index str
return nil, errors.Wrap(err, "creating request")
}
uinfo := ctx.Value("userinfo")
if uinfo != nil {
token := uinfo.(*authn.UserInfo).Token
req.Header.Set("Authorization", token)
}
req = AddAuthToken(ctx, req)
req.Header.Set("Content-Length", strconv.Itoa(len(buf)))

37
internal_client_test.go
View file

@ -7,6 +7,7 @@ import (
"context"
"encoding/hex"
"fmt"
"net/http"
gohttp "net/http"
"reflect"
"strings"
@ -15,6 +16,7 @@ import (
"github.com/davecgh/go-spew/spew"
pilosa "github.com/molecula/featurebase/v3"
"github.com/molecula/featurebase/v3/authn"
"github.com/molecula/featurebase/v3/encoding/proto"
"github.com/molecula/featurebase/v3/pql"
"github.com/molecula/featurebase/v3/server"
@ -1568,3 +1570,38 @@ func TestClient_ImportRoaringExists(t *testing.T) {
}
}
func TestAddAuthToken(t *testing.T) {
t.Run("none", func(t *testing.T) {
req, err := http.NewRequest("GET", "dontmatternone", strings.NewReader("this doesn't matter"))
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
pilosa.AddAuthToken(context.Background(), req)
if req.Header.Get("Authorization") != "" {
t.Fatalf("Authorization header set when it should be empty")
}
})
t.Run("userinfo", func(t *testing.T) {
req, err := http.NewRequest("GET", "dontmatternone", strings.NewReader("this doesn't matter"))
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
uinfo := &authn.UserInfo{Token: "ayo"}
pilosa.AddAuthToken(context.WithValue(context.Background(), "userinfo", uinfo), req)
if got := req.Header.Get("Authorization"); got != "Bearer "+uinfo.Token {
t.Fatalf("got '%v', expected 'Bearer %v'", got, uinfo.Token)
}
})
t.Run("token", func(t *testing.T) {
req, err := http.NewRequest("GET", "dontmatternone", strings.NewReader("this doesn't matter"))
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
tok := "Bearer thisisatoken"
pilosa.AddAuthToken(context.WithValue(context.Background(), "token", tok), req)
if got := req.Header.Get("Authorization"); got != tok {
t.Fatalf("got '%v', expected '%v'", got, tok)
}
})
}