perf(actions): cache successful runner token verification (#39934) (#39959)

Backport of https://github.com/go-gitea/gitea/pull/39934 to release/v28.

Runner token verification (PBKDF2) dominated CPU on instances with many
runners. Successful verifications are now cached in a dedicated LRU.
Conflict resolved by keeping v28's connect v1 interceptor and adding
only the cache.

_Backport prepared with Codet._

Co-authored-by: silverwind <me@silverwind.io>
This commit is contained in:
Lunny Xiaoandsilverwind authored and GitHub committed 2026-10-23 02:36:43 -07:00
1 parent 2b0aa6cfd2
commit b140311d54
2 files changed
+45 -1

No files matched your search

+19 -1
View File
@@ -5,6 +5,7 @@ package runner
import ( import (
"context" "context"
"crypto/sha256"
"errors" "errors"
"strings" "strings"
"time" "time"
@@ -17,6 +18,7 @@ import (
"gitea.dev/modules/util" "gitea.dev/modules/util"
"connectrpc.com/connect" "connectrpc.com/connect"
lru "github.com/hashicorp/golang-lru/v2"
"google.golang.org/grpc/codes" "google.golang.org/grpc/codes"
"google.golang.org/grpc/status" "google.golang.org/grpc/status"
) )
@@ -26,6 +28,10 @@ const (
tokenHeaderKey = protocol.TokenHeader tokenHeaderKey = protocol.TokenHeader
) )
type runnerTokenHash struct{ salt, hash string }
var verifiedRunnerTokens, _ = lru.New[runnerTokenHash, [sha256.Size]byte](10000) // not auth_model.TokenCache, whose small default size thrashes once more runners poll in turn
var withRunner = connect.WithInterceptors(connect.UnaryInterceptorFunc(func(unaryFunc connect.UnaryFunc) connect.UnaryFunc { var withRunner = connect.WithInterceptors(connect.UnaryInterceptorFunc(func(unaryFunc connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, request connect.AnyRequest) (connect.AnyResponse, error) { return func(ctx context.Context, request connect.AnyRequest) (connect.AnyResponse, error) {
methodName := getMethodName(request) methodName := getMethodName(request)
@@ -42,7 +48,7 @@ var withRunner = connect.WithInterceptors(connect.UnaryInterceptorFunc(func(unar
} }
return nil, status.Error(codes.Internal, err.Error()) return nil, status.Error(codes.Internal, err.Error())
} }
if !util.CryptoConstTimeEqual(runner.TokenHash, auth_model.HashToken(token, runner.TokenSalt)) { if !verifyRunnerToken(runner, token) {
return nil, status.Error(codes.Unauthenticated, "unregistered runner") return nil, status.Error(codes.Unauthenticated, "unregistered runner")
} }
@@ -73,6 +79,18 @@ var withRunner = connect.WithInterceptors(connect.UnaryInterceptorFunc(func(unar
} }
})) }))
func verifyRunnerToken(runner *actions_model.ActionRunner, token string) bool {
key, digest := runnerTokenHash{runner.TokenSalt, runner.TokenHash}, sha256.Sum256([]byte(token))
if cached, ok := verifiedRunnerTokens.Get(key); ok && util.CryptoConstTimeEqual(cached[:], digest[:]) {
return true
}
if !util.CryptoConstTimeEqual(runner.TokenHash, auth_model.HashToken(token, runner.TokenSalt)) {
return false
}
verifiedRunnerTokens.Add(key, digest)
return true
}
func getMethodName(req connect.AnyRequest) string { func getMethodName(req connect.AnyRequest) string {
splits := strings.Split(req.Spec().Procedure, "/") splits := strings.Split(req.Spec().Procedure, "/")
if len(splits) > 0 { if len(splits) > 0 {
@@ -0,0 +1,26 @@
// Copyright 2026 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package runner
import (
"crypto/sha256"
"testing"
actions_model "gitea.dev/models/actions"
auth_model "gitea.dev/models/auth"
"github.com/stretchr/testify/assert"
)
func TestVerifyRunnerToken(t *testing.T) {
verifiedRunnerTokens.Purge()
runner := &actions_model.ActionRunner{TokenSalt: "salt", TokenHash: auth_model.HashToken("token", "salt")}
assert.True(t, verifyRunnerToken(runner, "token"))
assert.True(t, verifyRunnerToken(runner, "token"))
assert.False(t, verifyRunnerToken(runner, "wrong"))
other := &actions_model.ActionRunner{TokenSalt: "salt", TokenHash: auth_model.HashToken("other", "salt")}
assert.False(t, verifyRunnerToken(other, "token"))
assert.Equal(t, [][sha256.Size]byte{sha256.Sum256([]byte("token"))}, verifiedRunnerTokens.Values())
}