Skip to content

Improve telemetry; clean-up Session middleware #42

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

Merged
VojtechVitek merged 2 commits into from
Jul 2, 2025
Merged

Improve telemetry; clean-up Session middleware #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ce8416
Improve telemetry; clean-up Session middleware
VojtechVitek Jul 2, 2025
7d869ce
Fix tests, unexport withProject*() methods
VojtechVitek Jul 2, 2025
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
12 changes: 4 additions & 8 deletions context.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,8 @@ func GetAccessKey(ctx context.Context) (string, bool) {
// Project ID
//

// WithProjectID adds the project to the context.
//
// TODO: Deprecate this in favor of Session middleware with a JWT token.
func WithProjectID(ctx context.Context, project uint64) context.Context {
// withProjectID adds the project to the context.
func withProjectID(ctx context.Context, project uint64) context.Context {
return context.WithValue(ctx, ctxKeyProjectID, project)
}

Expand All @@ -132,10 +130,8 @@ func GetProjectID(ctx context.Context) (uint64, bool) {
// Project
//

// WithProject adds the project to the context.
//
// TODO: Deprecate this in favor of Session middleware with a JWT token.
func WithProject(ctx context.Context, project any) context.Context {
// withProject adds the project to the context.
func withProject(ctx context.Context, project any) context.Context {
return context.WithValue(ctx, ctxKeyProject, project)
}

Expand Down
193 changes: 106 additions & 87 deletions middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func VerifyToken(cfg Options) func(next http.Handler) http.Handler {
if _auth != nil {
auth = _auth
}
ctx = WithProject(ctx, project)
ctx = withProject(ctx, project)
}

}
Expand Down Expand Up @@ -141,111 +141,123 @@ func Session(cfg Options) func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := r.Context()

// if a custom middleware already sets the session type, skip this middleware
if sessionType, ok := GetSessionType(ctx); ok {
httplog.SetAttrs(ctx, slog.String("sessionType", sessionType.String()))
// If a custom middleware already sets the session type, skip this middleware.
// This happens only in various tests and in node-gateway's specialKeyMiddleware.
if _, ok := GetSessionType(ctx); ok {
// Track this as a SpecialKey session for now.
// TODO: Remove once node-gateway SpecialKey support is gone.
httplog.SetAttrs(ctx, slog.String("sessionType", "SpecialKey"))
requestsCounter.Inc(sessionLabels{SessionType: "SpecialKey", RateLimited: "false"})

next.ServeHTTP(w, r)
return
}

_, claims, err := jwtauth.FromContext(ctx)
if err != nil || claims == nil {
cfg.ErrHandler(r, w, err)
return
}

var (
sessionType = proto.SessionType_Public
accessKey string
projectID uint64
)

for _, f := range cfg.AccessKeyFuncs {
if accessKey = f(r); accessKey != "" {
break
}
}
// Parse JWT claims.
serviceClaim, _ := claims["service"].(string)
accountClaim, _ := claims["account"].(string)
adminClaim, _ := claims["admin"].(bool)
projectClaim, _ := claims["project"].(float64) // Builder Admin API Secret Keys
projectIDClaim, _ := claims["project_id"].(float64) // API->WaaS authentication

_, claims, err := jwtauth.FromContext(ctx)
if err != nil {
cfg.ErrHandler(r, w, err)
return
if serviceClaim != "" {
sessionType = proto.SessionType_S2S

ctx = WithService(ctx, serviceClaim)
httplog.SetAttrs(ctx, slog.String("service", serviceClaim))
}
if claims != nil {
serviceClaim, _ := claims["service"].(string)
accountClaim, _ := claims["account"].(string)
adminClaim, _ := claims["admin"].(bool)

// - `project` claim is used in Builder Admin API Secret Keys (JWT used by third-party customers).
projectClaim, _ := claims["project"].(float64)

// - `project_id` claim is used by API->WaaS related authentication.
projectIDClaim, _ := claims["project_id"].(float64)

switch {
case serviceClaim != "":
ctx = WithService(ctx, serviceClaim)
sessionType = proto.SessionType_S2S

case accountClaim != "":
ctx = WithAccount(ctx, accountClaim)
sessionType = proto.SessionType_Wallet

if cfg.UserStore != nil {
user, isAdmin, err := cfg.UserStore.GetUser(ctx, accountClaim)
if err != nil {
cfg.ErrHandler(r, w, err)
return
}

if user != nil {
ctx = WithUser(ctx, user)
sessionType = proto.SessionType_User
if isAdmin {
sessionType = proto.SessionType_Admin
}
}
if accountClaim != "" {
sessionType = proto.SessionType_Wallet

ctx = WithAccount(ctx, accountClaim)
httplog.SetAttrs(ctx, slog.String("account", accountClaim))

if cfg.UserStore != nil {
user, isAdmin, err := cfg.UserStore.GetUser(ctx, accountClaim)
if err != nil {
cfg.ErrHandler(r, w, err)
return
}

if adminClaim {
sessionType = proto.SessionType_Admin
if user != nil {
ctx = WithUser(ctx, user)
sessionType = proto.SessionType_User
if isAdmin {
sessionType = proto.SessionType_Admin
}
}
}

if projectClaim > 0 {
projectID = uint64(projectClaim)
sessionType = max(sessionType, proto.SessionType_Project)
} else if projectIDClaim > 0 {
projectID = uint64(projectIDClaim)
sessionType = max(sessionType, proto.SessionType_Project)
if adminClaim {
sessionType = proto.SessionType_Admin
}
}

if projectID > 0 {
ctx = WithProjectID(ctx, projectID)
httplog.SetAttrs(ctx, slog.Uint64("projectId", projectID))
}
// `project` claim is used in Builder Admin API Secret Keys
if projectClaim > 0 {
sessionType = max(sessionType, proto.SessionType_Project)

// Restrict CORS for Builder Admin API Secret Keys.
// These keys are designed for backend service use by third-party customers, not for web apps.
if accountClaim != "" && projectClaim > 0 {
// Secret Keys are distinguished from Wallet JWTs or Builder session JWTs
// by the presence of both `project` and `account` claims. (As of Dec '24)
// Related discussion: https://github.com/0xsequence/issue-tracker/issues/3802.

origin := r.Header.Get("Origin")
if origin != "" {
err := proto.ErrSecretKeyCorsDisallowed.WithCausef("project_id: %v", projectID)

slog.ErrorContext(ctx, "CORS disallowed for Secret Key",
slog.Any("error", err),
slog.String("origin", origin),
slog.Uint64("project_id", projectID),
)

// TODO: Uncomment once we're confident it won't disrupt major customers.
// cfg.ErrHandler(r, w, err)
// return
}
projectID = uint64(projectClaim)
ctx = withProjectID(ctx, projectID)
httplog.SetAttrs(ctx, slog.Uint64("projectId", projectID))
}

// `project_id` claim is used in API->WaaS authentication.
if projectIDClaim > 0 {
sessionType = max(sessionType, proto.SessionType_Project)

projectID = uint64(projectIDClaim)
ctx = withProjectID(ctx, projectID)
httplog.SetAttrs(ctx, slog.Uint64("projectId", projectID))
}

// Restrict CORS for Builder Admin API Secret Keys.
// These keys are designed for backend service use by third-party customers, not for web apps.
if accountClaim != "" && projectClaim > 0 {
// Secret Keys are distinguished from Wallet JWTs or Builder session JWTs
// by the presence of both `project` and `account` claims. (As of Dec '24)
// Related discussion: https://github.com/0xsequence/issue-tracker/issues/3802.

origin := r.Header.Get("Origin")
if origin != "" {
err := proto.ErrSecretKeyCorsDisallowed.WithCausef("project_id: %v", projectID)

slog.ErrorContext(ctx, "CORS disallowed for Secret Key",
slog.Any("error", err),
slog.String("origin", origin),
slog.Uint64("project_id", projectID),
)

// TODO: Uncomment once we're confident it won't disrupt major customers.
// cfg.ErrHandler(r, w, err)
// return
}
}

if accessKey != "" {
ctx = WithAccessKey(ctx, accessKey)
sessionType = max(sessionType, proto.SessionType_AccessKey)
// Parse Access Key.
for _, f := range cfg.AccessKeyFuncs {
if accessKey := f(r); accessKey != "" {
sessionType = max(sessionType, proto.SessionType_AccessKey)

ctx = WithAccessKey(ctx, accessKey)
// TODO:
// projectID, _ = proto.GetProjectID(accessKey)
// ctx = withProjectIDy(ctx, projectID)
// httplog.SetAttrs(ctx, slog.Uint64("projectId", projectID))
break
}
}

ctx = WithSessionType(ctx, sessionType)
Expand All @@ -257,15 +269,22 @@ func Session(cfg Options) func(next http.Handler) http.Handler {
}

defer func() {
// Track requests by session type.
sessionTypeCounter.Inc(sessionLabels{
// Track all requests by session type.
requestsCounter.Inc(sessionLabels{
SessionType: sessionType.String(),
Status: strconv.Itoa(cmp.Or(ww.Status(), 200)),
RateLimited: strconv.FormatBool(ww.Status() == 429),
})

// Track internal S2S requests by service name.
if sessionType == proto.SessionType_S2S {
requestsServiceCounter.Inc(serviceLabels{
Service: serviceClaim,
})
}

// Track requests by project ID.
if projectID > 0 {
projectCounter.Inc(projectLabels{
requestsProjectCounter.Inc(projectLabels{
ProjectID: strconv.FormatUint(projectID, 10),
Status: strconv.Itoa(cmp.Or(ww.Status(), 200)),
})
Expand Down
12 changes: 9 additions & 3 deletions telemetry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,19 @@ import (
)

var (
sessionTypeCounter = metrics.CounterWith[sessionLabels]("authcontrol_requests_total", "Total number of requests by session type.")
projectCounter = metrics.CounterWith[projectLabels]("authcontrol_project_requests_total", "Total number of requests by project ID.")
// Prometheus metrics.
requestsCounter = metrics.CounterWith[sessionLabels]("authcontrol_requests_total", "Total number of requests by session type.")
requestsServiceCounter = metrics.CounterWith[serviceLabels]("authcontrol_requests_service_total", "Total number of requests by S2S service.")
requestsProjectCounter = metrics.CounterWith[projectLabels]("authcontrol_requests_project_total", "Total number of requests by project ID.")
)

type sessionLabels struct {
SessionType string `label:"session_type"`
Status string `label:"status"`
RateLimited string `label:"rate_limited"`
}

type serviceLabels struct {
Service string `label:"service"`
}

type projectLabels struct {
Expand Down