Skip to content
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

Add authproxy preferred_username header #3950

Merged
merged 1 commit into from
Feb 1, 2025
Merged

Add authproxy preferred_username header #3950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 31 additions & 20 deletions connector/authproxy/authproxy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ import (
// Headers retrieved to fetch user's email and group can be configured
// with userHeader and groupHeader.
type Config struct {
UserIDHeader string `json:"userIDHeader"`
UserHeader string `json:"userHeader"`
EmailHeader string `json:"emailHeader"`
GroupHeader string `json:"groupHeader"`
Groups []string `json:"staticGroups"`
UserIDHeader string `json:"userIDHeader"`
UserHeader string `json:"userHeader"`
UserNameHeader string `json:"userNameHeader"`
EmailHeader string `json:"emailHeader"`
GroupHeader string `json:"groupHeader"`
Groups []string `json:"staticGroups"`
}

// Open returns an authentication strategy which requires no user interaction.
Expand All @@ -36,6 +37,10 @@ func (c *Config) Open(id string, logger *slog.Logger) (connector.Connector, erro
if userHeader == "" {
userHeader = "X-Remote-User"
}
userNameHeader := c.UserNameHeader
if userNameHeader == "" {
userNameHeader = "X-Remote-User-Name"
}
emailHeader := c.EmailHeader
if emailHeader == "" {
emailHeader = "X-Remote-User-Email"
Expand All @@ -46,26 +51,28 @@ func (c *Config) Open(id string, logger *slog.Logger) (connector.Connector, erro
}

return &callback{
userIDHeader: userIDHeader,
userHeader: userHeader,
emailHeader: emailHeader,
groupHeader: groupHeader,
groups: c.Groups,
logger: logger.With(slog.Group("connector", "type", "authproxy", "id", id)),
pathSuffix: "/" + id,
userIDHeader: userIDHeader,
userHeader: userHeader,
userNameHeader: userNameHeader,
emailHeader: emailHeader,
groupHeader: groupHeader,
groups: c.Groups,
logger: logger.With(slog.Group("connector", "type", "authproxy", "id", id)),
pathSuffix: "/" + id,
}, nil
}

// Callback is a connector which returns an identity with the HTTP header
// X-Remote-User as verified email.
type callback struct {
userIDHeader string
userHeader string
emailHeader string
groupHeader string
groups []string
logger *slog.Logger
pathSuffix string
userIDHeader string
userNameHeader string
userHeader string
emailHeader string
groupHeader string
groups []string
logger *slog.Logger
pathSuffix string
}

// LoginURL returns the URL to redirect the user to login with.
Expand All @@ -87,6 +94,10 @@ func (m *callback) HandleCallback(s connector.Scopes, r *http.Request) (connecto
if remoteUser == "" {
return connector.Identity{}, fmt.Errorf("required HTTP header %s is not set", m.userHeader)
}
remoteUserName := r.Header.Get(m.userNameHeader)
if remoteUserName == "" {
remoteUserName = remoteUser
}
remoteUserID := r.Header.Get(m.userIDHeader)
if remoteUserID == "" {
remoteUserID = remoteUser
Expand All @@ -107,7 +118,7 @@ func (m *callback) HandleCallback(s connector.Scopes, r *http.Request) (connecto
return connector.Identity{
UserID: remoteUserID,
Username: remoteUser,
PreferredUsername: remoteUser,
PreferredUsername: remoteUserName,
Email: remoteUserEmail,
EmailVerified: true,
Groups: groups,
Expand Down
40 changes: 22 additions & 18 deletions connector/authproxy/authproxy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,16 @@ import (
)

const (
testEmail = "[email protected]"
testGroup1 = "group1"
testGroup2 = "group2"
testGroup3 = "group 3"
testGroup4 = "group 4"
testStaticGroup1 = "static1"
testStaticGroup2 = "static 2"
testUsername = "testuser"
testUserID = "1234567890"
testEmail = "[email protected]"
testGroup1 = "group1"
testGroup2 = "group2"
testGroup3 = "group 3"
testGroup4 = "group 4"
testStaticGroup1 = "static1"
testStaticGroup2 = "static 2"
testUsername = "Test User"
testPreferredUsername = "testuser"
testUserID = "1234567890"
)

var logger = slog.New(slog.NewTextHandler(io.Discard, &slog.HandlerOptions{}))
Expand Down Expand Up @@ -49,31 +50,34 @@ func TestUser(t *testing.T) {

func TestExtraHeaders(t *testing.T) {
config := Config{
UserIDHeader: "X-Remote-User-Id",
UserHeader: "X-Remote-User",
EmailHeader: "X-Remote-User-Email",
UserIDHeader: "X-Remote-User-Id",
UserHeader: "X-Remote-User",
UserNameHeader: "X-Remote-User-Name",
EmailHeader: "X-Remote-User-Email",
}
conn := callback{
userHeader: config.UserHeader,
userIDHeader: config.UserIDHeader,
emailHeader: config.EmailHeader,
logger: logger,
pathSuffix: "/test",
userHeader: config.UserHeader,
userIDHeader: config.UserIDHeader,
userNameHeader: config.UserNameHeader,
emailHeader: config.EmailHeader,
logger: logger,
pathSuffix: "/test",
}

req, err := http.NewRequest("GET", "/", nil)
expectNil(t, err)
req.Header = map[string][]string{
"X-Remote-User-Id": {testUserID},
"X-Remote-User": {testUsername},
"X-Remote-User-Name": {testPreferredUsername},
"X-Remote-User-Email": {testEmail},
}

ident, err := conn.HandleCallback(connector.Scopes{OfflineAccess: true, Groups: true}, req)
expectNil(t, err)

expectEquals(t, ident.UserID, testUserID)
expectEquals(t, ident.PreferredUsername, testUsername)
expectEquals(t, ident.PreferredUsername, testPreferredUsername)
expectEquals(t, ident.Username, testUsername)
expectEquals(t, ident.Email, testEmail)
expectEquals(t, len(ident.Groups), 0)
Expand Down
Loading