jojo/routers/api/actions/id_token.go
Mathieu Fenniak bdd2a1def7 fix: prevent actions workflows from generating OIDC tokens if not authorized in workflow (#12030)
When using Forgejo's `enable-openid-connect: true`, a URL is generated into the actions under `$ACTIONS_ID_TOKEN_REQUEST_URL` that can be used to generate a JWT for accessing third-party resources authenticated as the action executing in this server on this repo.  However, the endpoint of that url (`.../idtoken`) had unintentionally missed a `return` on an internal server error, and was missing a check that the action actually had `enable-openid-connect: true` on it.  As a result, it was possible to generate a JWT for accessing third-party resources from an action that wasn't expected to be generating JWTs.

In terms of real-world vulnerability, the most likely risk is that the JWT could be generated from a forked pull request.  By not using the `$ACTIONS_ID_TOKEN_REQUEST_URL` and instead going directly to the `.../idtoken` endpoint, and parsing a generated JWT response that will be mixed with an error response, it's possible to retrieve a JWT in a forked pull request.  It would require a slight misconfiguration on a third-party system to allow that JWT access, but it's a plausible risk.

As this is a feature in Forgejo 15 that hasn't been released, it will be fixed in-public.

## Checklist

The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. All work and communication must conform to Forgejo's [AI Agreement](https://codeberg.org/forgejo/governance/src/branch/main/AIAgreement.md). 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 for Go changes

(can be removed for JavaScript changes)

- I added test coverage for Go changes...
  - [ ] in their respective `*_test.go` for unit tests.
  - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server.
- I ran...
  - [x] `make pr-go` before pushing

### Documentation

- [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change.
- [x] I did not document these changes and I do not expect someone else to do it.

### Release notes

- [ ] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change.
- [x] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change.
    - Feature is not yet released.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/12030
Reviewed-by: Andreas Ahlenstorf <aahlenst@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
2026-04-08 15:42:39 +02:00

157 lines
5 KiB
Go

// Copyright 2025 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: GPL-3.0-or-later
package actions
import (
"fmt"
"net/http"
"slices"
"strings"
"time"
"forgejo.org/models/actions"
"forgejo.org/modules/json"
"forgejo.org/modules/log"
"forgejo.org/modules/setting"
"forgejo.org/modules/timeutil"
"forgejo.org/modules/web"
web_types "forgejo.org/modules/web/types"
actions_service "forgejo.org/services/actions"
"forgejo.org/services/context"
"github.com/golang-jwt/jwt/v5"
)
const idTokenRouteBase = "/_apis/pipelines/workflows/{run_id}/idtoken"
type idTokenContextKeyType struct{}
var idTokenContextKey = idTokenContextKeyType{}
type IDTokenContext struct {
*context.Base
Audience string
AuthorizationTokenClaims *actions_service.AuthorizationTokenClaims
IDTokenCustomClaims *actions_service.IDTokenCustomClaims
}
func init() {
web.RegisterResponseStatusProvider[*IDTokenContext](func(req *http.Request) web_types.ResponseStatusProvider {
return req.Context().Value(idTokenContextKey).(*IDTokenContext)
})
}
func IDTokenContexter() func(next http.Handler) http.Handler {
return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(resp http.ResponseWriter, req *http.Request) {
base, baseCleanUp := context.NewBaseContext(resp, req)
defer baseCleanUp()
ctx := &IDTokenContext{Base: base}
ctx.AppendContextValue(idTokenContextKey, ctx)
// action task call server api with Bearer ACTIONS_ID_TOKEN_REQUEST_TOKEN
// we should verify the ACTIONS_ID_TOKEN_REQUEST_TOKEN
authHeader := req.Header.Get("Authorization")
if len(authHeader) == 0 || !strings.HasPrefix(strings.ToLower(authHeader), "bearer ") {
ctx.Error(http.StatusUnauthorized, "Bad authorization header")
return
}
// Require using new act_runner that uses jwt to authenticate
authorizationTokenClaims, err := actions_service.ParseAuthorizationTokenClaims(req)
if err != nil {
log.Error("Error runner api parsing authorization token: %v", err)
ctx.Error(http.StatusInternalServerError, "Error runner api parsing authorization token")
return
}
customClaims := &actions_service.IDTokenCustomClaims{}
err = json.Unmarshal([]byte(authorizationTokenClaims.OIDCExtra), customClaims)
if err != nil {
log.Error("Error runner api parsing custom claims: %v", err)
ctx.Error(http.StatusInternalServerError, "Error runner api parsing custom claims")
return
}
task, err := actions.GetTaskByID(req.Context(), authorizationTokenClaims.TaskID)
if err != nil {
log.Error("Error runner api getting task by ID: %v", err)
ctx.Error(http.StatusInternalServerError, "Error runner api getting task by ID")
return
}
if task.Status != actions.StatusRunning {
log.Error("Error runner api getting task: task is not running")
ctx.Error(http.StatusInternalServerError, "Error runner api getting task: task is not running")
return
}
err = task.LoadAttributes(req.Context())
if err != nil {
log.Error("Error runner api getting task attributes: %v", err)
ctx.Error(http.StatusInternalServerError, "Error runner api getting task attributes")
return
}
runID := ctx.ParamsInt64("run_id")
if task.Job.RunID != runID {
log.Error("Error runID not match" + fmt.Sprint(task.Job.RunID) + " " + fmt.Sprint(runID))
ctx.Error(http.StatusBadRequest, "run-id does not match")
return
}
generateIDTokenScp := fmt.Sprintf("generate_id_token:%d:%d", task.Job.RunID, task.Job.ID)
scp := strings.Split(authorizationTokenClaims.Scp, " ")
if !slices.Contains(scp, generateIDTokenScp) {
ctx.Error(http.StatusForbidden, "missing scp generate_id_token")
return
}
audience := req.URL.Query().Get("audience")
if audience == "" {
// Default to organization that owns the repo if no audience is provided
audience = setting.AppURL + customClaims.RepositoryOwner
}
ctx.AuthorizationTokenClaims = authorizationTokenClaims
ctx.IDTokenCustomClaims = customClaims
ctx.Audience = audience
next.ServeHTTP(ctx.Resp, ctx.Req)
})
}
}
func generateIDToken(ctx *IDTokenContext) {
expirationDate := timeutil.TimeStampNow().Add(setting.Actions.IDTokenExpirationTime)
var claims jwt.MapClaims
inrec, _ := json.Marshal(ctx.IDTokenCustomClaims)
err := json.Unmarshal(inrec, &claims)
if err != nil {
ctx.Error(http.StatusInternalServerError, "Error generating token")
}
now := time.Now()
claims["sub"] = ctx.AuthorizationTokenClaims.OIDCSub
claims["aud"] = ctx.Audience
claims["exp"] = jwt.NewNumericDate(expirationDate.AsTime())
claims["iat"] = jwt.NewNumericDate(now)
claims["nbf"] = jwt.NewNumericDate(now)
claims["iss"] = strings.TrimSuffix(setting.AppURL, "/") + "/api/actions"
signedToken, err := jwtSigningKey.JWT(claims)
if err != nil {
ctx.Error(http.StatusInternalServerError, "Error signing token")
}
resp := IDTokenResponse{
Value: signedToken,
}
ctx.JSON(http.StatusOK, resp)
}
type IDTokenResponse struct {
Value string `json:"value"`
}