mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-03-27 10:23:05 -04:00
Add support for OIDC workload identity federation.
Add ID_TOKEN_SIGNING_ALGORITHM, ID_TOKEN_SIGNING_PRIVATE_KEY_FILE, and
ID_TOKEN_EXPIRATION_TIME settings to settings.actions to allow for admin
configuration of this functionality.
Add OIDC endpoints (/.well-known/openid-configuration and /.well-known/keys)
underneath the "/api/actions" route.
Add a token generation endpoint (/_apis/pipelines/workflows/{run_id}/idtoken)
underneath the "/api/actions" route.
Depends on: https://code.forgejo.org/forgejo/runner/pulls/1232
Docs PR: https://codeberg.org/forgejo/docs/pulls/1667
Signed-off-by: Mario Minardi <mminardi@shaw.ca>
## Checklist
The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org).
### Tests
- I added test coverage for Go changes...
- [x] in their respective `*_test.go` for unit tests.
- [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I added test coverage for JavaScript changes...
- [ ] in `web_src/js/*.test.js` if it can be unit tested.
- [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)).
### Documentation
- [x] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [ ] I did not document these changes and I do not expect someone else to do it.
### Release notes
- [ ] I do not want this change to show in the release notes.
- [ ] I want the title to show in the release notes with a link to this pull request.
- [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title.
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10481
Reviewed-by: Mathieu Fenniak <mfenniak@noreply.codeberg.org>
Co-authored-by: Mario Minardi <mminardi@shaw.ca>
Co-committed-by: Mario Minardi <mminardi@shaw.ca>
113 lines
3.6 KiB
Go
113 lines
3.6 KiB
Go
// Copyright 2024 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package auth
|
|
|
|
import (
|
|
"net/http"
|
|
"testing"
|
|
|
|
actions_model "forgejo.org/models/actions"
|
|
"forgejo.org/models/auth"
|
|
"forgejo.org/models/unittest"
|
|
user_model "forgejo.org/models/user"
|
|
"forgejo.org/modules/web/middleware"
|
|
"forgejo.org/services/actions"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestUserIDFromToken(t *testing.T) {
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
|
|
t.Run("Actions JWT", func(t *testing.T) {
|
|
const RunningTaskID = 47
|
|
task := &actions_model.ActionTask{
|
|
ID: RunningTaskID,
|
|
Job: &actions_model.ActionRunJob{
|
|
ID: 2,
|
|
RunID: 1,
|
|
},
|
|
}
|
|
token, err := actions.CreateAuthorizationToken(task, map[string]any{}, false)
|
|
require.NoError(t, err)
|
|
|
|
ds := make(middleware.ContextData)
|
|
|
|
o := OAuth2{}
|
|
uid, err := o.userIDFromToken(t.Context(), token, ds)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, int64(user_model.ActionsUserID), uid)
|
|
assert.Equal(t, true, ds["IsActionsToken"])
|
|
assert.Equal(t, ds["ActionsTaskID"], int64(RunningTaskID))
|
|
})
|
|
|
|
t.Run("Actions error-JWT", func(t *testing.T) {
|
|
cases := map[string]struct {
|
|
Token string
|
|
Error error
|
|
}{
|
|
"Empty": {"", auth.ErrAccessTokenEmpty{}},
|
|
"To short": {"abc", auth.ErrAccessTokenNotExist{Token: "abc"}},
|
|
}
|
|
|
|
ds := make(middleware.ContextData)
|
|
o := OAuth2{}
|
|
for name, c := range cases {
|
|
t.Run(name, func(t *testing.T) {
|
|
uid, err := o.userIDFromToken(t.Context(), c.Token, ds)
|
|
require.ErrorIs(t, err, c.Error)
|
|
assert.Equal(t, int64(0), uid)
|
|
})
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestCheckTaskIsRunning(t *testing.T) {
|
|
require.NoError(t, unittest.PrepareTestDatabase())
|
|
cases := map[string]struct {
|
|
TaskID int64
|
|
Expected bool
|
|
}{
|
|
"Running": {TaskID: 47, Expected: true},
|
|
"Missing": {TaskID: 1, Expected: false},
|
|
"Cancelled": {TaskID: 46, Expected: false},
|
|
}
|
|
|
|
for name := range cases {
|
|
c := cases[name]
|
|
t.Run(name, func(t *testing.T) {
|
|
actual := CheckTaskIsRunning(t.Context(), c.TaskID)
|
|
assert.Equal(t, c.Expected, actual)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestParseToken(t *testing.T) {
|
|
cases := map[string]struct {
|
|
Header string
|
|
ExpectedToken string
|
|
Expected bool
|
|
}{
|
|
"Token Uppercase": {Header: "Token 1234567890123456789012345687901325467890", ExpectedToken: "1234567890123456789012345687901325467890", Expected: true},
|
|
"Token Lowercase": {Header: "token 1234567890123456789012345687901325467890", ExpectedToken: "1234567890123456789012345687901325467890", Expected: true},
|
|
"Token Unicode": {Header: "to\u212Aen 1234567890123456789012345687901325467890", ExpectedToken: "", Expected: false},
|
|
"Bearer Uppercase": {Header: "Bearer 1234567890123456789012345687901325467890", ExpectedToken: "1234567890123456789012345687901325467890", Expected: true},
|
|
"Bearer Lowercase": {Header: "bearer 1234567890123456789012345687901325467890", ExpectedToken: "1234567890123456789012345687901325467890", Expected: true},
|
|
"Missing type": {Header: "1234567890123456789012345687901325467890", ExpectedToken: "", Expected: false},
|
|
"Three Parts": {Header: "abc 1234567890 test", ExpectedToken: "", Expected: false},
|
|
"Token Three Parts": {Header: "Token 1234567890 test", ExpectedToken: "", Expected: false},
|
|
}
|
|
|
|
for name := range cases {
|
|
c := cases[name]
|
|
t.Run(name, func(t *testing.T) {
|
|
req, _ := http.NewRequest("GET", "/", nil)
|
|
req.Header.Add("Authorization", c.Header)
|
|
ActualToken, ActualSuccess := parseToken(req)
|
|
assert.Equal(t, c.ExpectedToken, ActualToken)
|
|
assert.Equal(t, c.Expected, ActualSuccess)
|
|
})
|
|
}
|
|
}
|