Skip to content

OIDC Server #941

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
jmattheis wants to merge 20 commits into
base: master
Choose a base branch
from
Open

OIDC Server #941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
86df116
fix: simplify authentication handling
jmattheis Mar 22, 2026
e7234fd
fix: docs indention
jmattheis Mar 22, 2026
0efef49
fix: read token from cookie
jmattheis Mar 22, 2026
1774781
feat: implement /auth/local/{login,logout}
jmattheis Mar 22, 2026
862fa3b
fix: use cookie login in UI
jmattheis Mar 22, 2026
9a51dd7
fix: make secure cookie configurable
jmattheis Mar 22, 2026
e072c64
feat: oidc
jmattheis Mar 22, 2026
c92b130
fix: update example config to be in sync with website
jmattheis Mar 22, 2026
9ca2623
fix: add /gotifyconfig endpoint
jmattheis Mar 28, 2026
7f6810e
feat: add external oidc flow
jmattheis Mar 28, 2026
83895b5
fix: increase api version
jmattheis Mar 28, 2026
44bda75
test: oidc tests
jmattheis Mar 28, 2026
c463d98
test: oidc dex + authelia
jmattheis Mar 28, 2026
bb0b605
fix: don't store client name in state
jmattheis Apr 3, 2026
bbce330
fix: add decay map
jmattheis Apr 5, 2026
a22ec0b
fix: use decay map
jmattheis Apr 5, 2026
6af637b
fix: add client source to api
jmattheis Apr 5, 2026
292eb31
fixup! fix: add client source to api
jmattheis Apr 5, 2026
866d645
fixup! fix: add client source to api
jmattheis Apr 5, 2026
96ccac6
fixup! fix: add client source to api
jmattheis Apr 5, 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
9 changes: 9 additions & 0 deletions api/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ type ClientParams struct {
// required: true
// example: My Client
Name string `form:"name" query:"name" json:"name" binding:"required"`
// The client source. Default api.
//
// example: api
Source string `form:"source" query:"source" json:"source"`
}

// UpdateClient updates a client by its id.
Expand Down Expand Up @@ -143,6 +147,11 @@ func (a *ClientAPI) CreateClient(ctx *gin.Context) {
Name: clientParams.Name,
Token: auth.GenerateNotExistingToken(generateClientToken, a.clientExists),
UserID: auth.GetUserID(ctx),
Source: model.ClientSourceApi,
}

if clientParams.Source != "" {
client.Source = clientParams.Source
}

if success := successOrAbort(ctx, 500, a.DB.CreateClient(&client)); !success {
Expand Down
15 changes: 8 additions & 7 deletions api/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,19 @@ func (s *ClientSuite) AfterTest(suiteName, testName string) {
}

func (s *ClientSuite) Test_ensureClientHasCorrectJsonRepresentation() {
actual := &model.Client{ID: 1, UserID: 2, Token: "Casdasfgeeg", Name: "myclient"}
test.JSONEquals(s.T(), actual, `{"id":1,"token":"Casdasfgeeg","name":"myclient","lastUsed":null}`)
actual := &model.Client{ID: 1, UserID: 2, Token: "Casdasfgeeg", Source: model.ClientSourceApi, Name: "myclient"}
test.JSONEquals(s.T(), actual, `{"id":1,"token":"Casdasfgeeg","name":"myclient","source":"api","lastUsed":null}`)
}

func (s *ClientSuite) Test_CreateClient_mapAllParameters() {
s.db.User(5)

test.WithUser(s.ctx, 5)
s.withFormData("name=custom_name&description=description_text")
s.withFormData("name=custom_name&description=description_text&source=custom")

s.a.CreateClient(s.ctx)

expected := &model.Client{ID: 1, Token: firstClientToken, UserID: 5, Name: "custom_name"}
expected := &model.Client{ID: 1, Token: firstClientToken, UserID: 5, Name: "custom_name", Source: "custom"}
assert.Equal(s.T(), 200, s.recorder.Code)
if clients, err := s.db.GetClientsByUser(5); assert.NoError(s.T(), err) {
assert.Contains(s.T(), clients, expected)
Expand All @@ -83,7 +83,7 @@ func (s *ClientSuite) Test_CreateClient_ignoresReadOnlyPropertiesInParams() {
s.withFormData("name=myclient&ID=45&Token=12341234&UserID=333")

s.a.CreateClient(s.ctx)
expected := &model.Client{ID: 1, UserID: 5, Token: firstClientToken, Name: "myclient"}
expected := &model.Client{ID: 1, UserID: 5, Token: firstClientToken, Name: "myclient", Source: model.ClientSourceApi}

assert.Equal(s.T(), 200, s.recorder.Code)
if clients, err := s.db.GetClientsByUser(5); assert.NoError(s.T(), err) {
Expand Down Expand Up @@ -127,7 +127,7 @@ func (s *ClientSuite) Test_CreateClient_returnsClientWithID() {

s.a.CreateClient(s.ctx)

expected := &model.Client{ID: 1, Token: firstClientToken, Name: "custom_name", UserID: 5}
expected := &model.Client{ID: 1, Token: firstClientToken, Name: "custom_name", UserID: 5, Source: model.ClientSourceApi}
assert.Equal(s.T(), 200, s.recorder.Code)
test.BodyEquals(s.T(), expected, s.recorder)
}
Expand All @@ -140,7 +140,7 @@ func (s *ClientSuite) Test_CreateClient_withExistingToken() {

s.a.CreateClient(s.ctx)

expected := &model.Client{ID: 2, Token: secondClientToken, Name: "custom_name", UserID: 5}
expected := &model.Client{ID: 2, Token: secondClientToken, Name: "custom_name", UserID: 5, Source: model.ClientSourceApi}
assert.Equal(s.T(), 200, s.recorder.Code)
test.BodyEquals(s.T(), expected, s.recorder)
}
Expand Down Expand Up @@ -200,6 +200,7 @@ func (s *ClientSuite) Test_UpdateClient_expectSuccess() {
Token: firstClientToken,
UserID: 5,
Name: "firefox",
Source: model.ClientSourceApi,
}

assert.Equal(s.T(), 200, s.recorder.Code)
Expand Down
2 changes: 1 addition & 1 deletion api/health.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type HealthAPI struct {
}
Copy link
Copy Markdown
Member Author

@jmattheis jmattheis Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eternal-flame-AD sorry this is kinda big, but would you mind having a look at this? Don't worry about declining if you don't want to review this, or don't have the time. I don't want to burden you with this :D.

Anyway, my plan is to create a snapshot docker build in the coming days and then let the people in #433 try out the functionality to improve the user-guide and find possible bugs with special IdP servers. So there is no rush reviewing this.

Copy link
Copy Markdown
Member

@eternal-flame-AD eternal-flame-AD Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I can look at this tonight first to see if there are large architectural/security changes needed and we can do a final round for final check and nitpicks after the code settles. Probably won't review Android though because I'm not very familar with android dev.

Copy link
Copy Markdown
Member Author

@jmattheis jmattheis Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome thanks!


// Health returns health information.
// swagger:operation GET /health health getHealth
// swagger:operation GET /health info getHealth
//
// Get health information.
//
Expand Down
Loading
Loading