Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

feat(authz): rule view FGA (#13251)

Nikhil Mantria2d281881c5b
diff --git a/docs/api/openapi.yml b/docs/api/openapi.yml
index 19ed17a0f8..2454bbcd38 100644
--- a/docs/api/openapi.yml
+++ b/docs/api/openapi.yml
@@ -25153,9 +25153,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - rule:list
- tokenizer:
- - VIEWER
+ - rule:list
summary: List rule saved views
tags:
- rules
@@ -25211,9 +25211,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - rule:list
- tokenizer:
- - VIEWER
+ - rule:list
summary: Create rule saved view
tags:
- rules
@@ -25265,9 +25265,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - rule:list
- tokenizer:
- - VIEWER
+ - rule:list
summary: Delete rule saved view
tags:
- rules
@@ -25334,9 +25334,9 @@ paths:
description: Internal Server Error
security:
- api_key:
- - VIEWER
+ - rule:list
- tokenizer:
- - VIEWER
+ - rule:list
summary: Update rule saved view
tags:
- rules
diff --git a/pkg/apiserver/signozapiserver/ruler.go b/pkg/apiserver/signozapiserver/ruler.go
index 7f566d0701..0fc3018b9f 100644
--- a/pkg/apiserver/signozapiserver/ruler.go
+++ b/pkg/apiserver/signozapiserver/ruler.go
@@ -149,61 +149,97 @@ func (provider *provider) addRulerRoutes(router *mux.Router) error {
return err
}
- if err := router.Handle("/api/v2/rule_views", handler.New(provider.authzMiddleware.ViewAccess(provider.rulerHandler.ListRuleViews), handler.OpenAPIDef{
- ID: "ListRuleViews",
- Tags: []string{"rules"},
- Summary: "List rule saved views",
- Description: "Returns every saved view in the calling user's org. Saved views are shared org-wide.",
- Response: new(ruletypes.ListableRuleViews),
- ResponseContentType: "application/json",
- SuccessStatusCode: http.StatusOK,
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodGet).GetError(); err != nil {
+ if err := router.Handle("/api/v2/rule_views", handler.New(
+ provider.authzMiddleware.CheckResources(provider.rulerHandler.ListRuleViews, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
+ handler.OpenAPIDef{
+ ID: "ListRuleViews",
+ Tags: []string{"rules"},
+ Summary: "List rule saved views",
+ Description: "Returns every saved view in the calling user's org. Saved views are shared org-wide.",
+ Response: new(ruletypes.ListableRuleViews),
+ ResponseContentType: "application/json",
+ SuccessStatusCode: http.StatusOK,
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceRule.Scope(coretypes.VerbList)}),
+ },
+ handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceRule,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryDataAccess,
+ Selector: coretypes.WildcardSelector,
+ }),
+ )).Methods(http.MethodGet).GetError(); err != nil {
return err
}
- if err := router.Handle("/api/v2/rule_views", handler.New(provider.authzMiddleware.ViewAccess(provider.rulerHandler.CreateRuleView), handler.OpenAPIDef{
- ID: "CreateRuleView",
- Tags: []string{"rules"},
- Summary: "Create rule saved view",
- Description: "Persists the calling user's rule listing state (query, states, sort, order) as a named, reusable view shared across the org.",
- Request: new(ruletypes.PostableRuleView),
- RequestContentType: "application/json",
- Response: new(ruletypes.RuleView),
- ResponseContentType: "application/json",
- SuccessStatusCode: http.StatusCreated,
- ErrorStatusCodes: []int{http.StatusBadRequest},
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPost).GetError(); err != nil {
+ if err := router.Handle("/api/v2/rule_views", handler.New(
+ provider.authzMiddleware.CheckResources(provider.rulerHandler.CreateRuleView, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
+ handler.OpenAPIDef{
+ ID: "CreateRuleView",
+ Tags: []string{"rules"},
+ Summary: "Create rule saved view",
+ Description: "Persists the calling user's rule listing state (query, states, sort, order) as a named, reusable view shared across the org.",
+ Request: new(ruletypes.PostableRuleView),
+ RequestContentType: "application/json",
+ Response: new(ruletypes.RuleView),
+ ResponseContentType: "application/json",
+ SuccessStatusCode: http.StatusCreated,
+ ErrorStatusCodes: []int{http.StatusBadRequest},
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceRule.Scope(coretypes.VerbList)}),
+ },
+ handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceRule,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryConfigurationChange,
+ Selector: coretypes.WildcardSelector,
+ }),
+ )).Methods(http.MethodPost).GetError(); err != nil {
return err
}
- if err := router.Handle("/api/v2/rule_views/{id}", handler.New(provider.authzMiddleware.ViewAccess(provider.rulerHandler.UpdateRuleView), handler.OpenAPIDef{
- ID: "UpdateRuleView",
- Tags: []string{"rules"},
- Summary: "Update rule saved view",
- Description: "Replaces a saved view's name and data. Saved views are shared org-wide.",
- Request: new(ruletypes.UpdatableRuleView),
- RequestContentType: "application/json",
- Response: new(ruletypes.RuleView),
- ResponseContentType: "application/json",
- SuccessStatusCode: http.StatusOK,
- ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusNotFound},
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodPut).GetError(); err != nil {
+ if err := router.Handle("/api/v2/rule_views/{id}", handler.New(
+ provider.authzMiddleware.CheckResources(provider.rulerHandler.UpdateRuleView, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
+ handler.OpenAPIDef{
+ ID: "UpdateRuleView",
+ Tags: []string{"rules"},
+ Summary: "Update rule saved view",
+ Description: "Replaces a saved view's name and data. Saved views are shared org-wide.",
+ Request: new(ruletypes.UpdatableRuleView),
+ RequestContentType: "application/json",
+ Response: new(ruletypes.RuleView),
+ ResponseContentType: "application/json",
+ SuccessStatusCode: http.StatusOK,
+ ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusNotFound},
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceRule.Scope(coretypes.VerbList)}),
+ },
+ handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceRule,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryConfigurationChange,
+ Selector: coretypes.WildcardSelector,
+ }),
+ )).Methods(http.MethodPut).GetError(); err != nil {
return err
}
- if err := router.Handle("/api/v2/rule_views/{id}", handler.New(provider.authzMiddleware.ViewAccess(provider.rulerHandler.DeleteRuleView), handler.OpenAPIDef{
- ID: "DeleteRuleView",
- Tags: []string{"rules"},
- Summary: "Delete rule saved view",
- Description: "Removes a saved view. Saved views are shared org-wide. Deleting a non-existent view returns 404.",
- ResponseContentType: "application/json",
- SuccessStatusCode: http.StatusNoContent,
- ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusNotFound},
- SecuritySchemes: newSecuritySchemes(types.RoleViewer),
- })).Methods(http.MethodDelete).GetError(); err != nil {
+ if err := router.Handle("/api/v2/rule_views/{id}", handler.New(
+ provider.authzMiddleware.CheckResources(provider.rulerHandler.DeleteRuleView, authtypes.SigNozAdminRoleName, authtypes.SigNozEditorRoleName, authtypes.SigNozViewerRoleName),
+ handler.OpenAPIDef{
+ ID: "DeleteRuleView",
+ Tags: []string{"rules"},
+ Summary: "Delete rule saved view",
+ Description: "Removes a saved view. Saved views are shared org-wide. Deleting a non-existent view returns 404.",
+ ResponseContentType: "application/json",
+ SuccessStatusCode: http.StatusNoContent,
+ ErrorStatusCodes: []int{http.StatusBadRequest, http.StatusNotFound},
+ SecuritySchemes: newScopedSecuritySchemes([]string{coretypes.ResourceMetaResourceRule.Scope(coretypes.VerbList)}),
+ },
+ handler.WithResourceDefs(handler.BasicResourceDef{
+ Resource: coretypes.ResourceMetaResourceRule,
+ Verb: coretypes.VerbList,
+ Category: coretypes.ActionCategoryConfigurationChange,
+ Selector: coretypes.WildcardSelector,
+ }),
+ )).Methods(http.MethodDelete).GetError(); err != nil {
return err
}
diff --git a/pkg/signoz/provider.go b/pkg/signoz/provider.go
index b110eb3810..d5b60decf9 100644
--- a/pkg/signoz/provider.go
+++ b/pkg/signoz/provider.go
@@ -270,6 +270,7 @@ func NewSQLMigrationProviderFactories(
sqlmigration.NewAddRoutePolicyTuplesFactory(sqlstore),
sqlmigration.NewRenameSavedViewDeprecatedTraceFieldsFactory(),
sqlmigration.NewAddDowntimeTuplesFactory(sqlstore),
+ sqlmigration.NewAddRuleTuplesFactory(sqlstore),
)
}
diff --git a/pkg/sqlmigration/143_add_rule_tuples.go b/pkg/sqlmigration/143_add_rule_tuples.go
new file mode 100644
index 0000000000..e4f58ad6c5
--- /dev/null
+++ b/pkg/sqlmigration/143_add_rule_tuples.go
@@ -0,0 +1,140 @@
+package sqlmigration
+
+import (
+ "context"
+ "database/sql"
+ "time"
+
+ "github.com/SigNoz/signoz/pkg/factory"
+ "github.com/SigNoz/signoz/pkg/sqlstore"
+ "github.com/SigNoz/signoz/pkg/types/authtypes"
+ "github.com/oklog/ulid/v2"
+ "github.com/uptrace/bun"
+ "github.com/uptrace/bun/dialect"
+ "github.com/uptrace/bun/migrate"
+)
+
+type addRuleTuples struct {
+ sqlstore sqlstore.SQLStore
+}
+
+func NewAddRuleTuplesFactory(sqlstore sqlstore.SQLStore) factory.ProviderFactory[SQLMigration, Config] {
+ return factory.NewProviderFactory(factory.MustNewName("add_rule_tuples"), func(ctx context.Context, ps factory.ProviderSettings, c Config) (SQLMigration, error) {
+ return &addRuleTuples{sqlstore: sqlstore}, nil
+ })
+}
+
+func (migration *addRuleTuples) Register(migrations *migrate.Migrations) error {
+ return migrations.Register(migration.Up, migration.Down)
+}
+
+func (migration *addRuleTuples) Up(ctx context.Context, db *bun.DB) error {
+ tx, err := db.BeginTx(ctx, nil)
+ if err != nil {
+ return err
+ }
+ defer func() { _ = tx.Rollback() }()
+
+ var storeID string
+ err = tx.QueryRowContext(ctx, `SELECT id FROM store WHERE name = ? LIMIT 1`, "signoz").Scan(&storeID)
+ if err != nil {
+ return err
+ }
+
+ var orgIDs []string
+ err = tx.NewSelect().
+ Table("organizations").
+ Column("id").
+ Scan(ctx, &orgIDs)
+ if err != nil && err != sql.ErrNoRows {
+ return err
+ }
+
+ isPG := migration.sqlstore.BunDB().Dialect().Name() == dialect.PG
+
+ crudVerbs := []string{"create", "read", "update", "delete", "list"}
+ readVerbs := []string{"read", "list"}
+
+ tuples := make([]migrationTuple, 0, 12)
+ for _, verb := range crudVerbs {
+ tuples = append(tuples,
+ migrationTuple{authtypes.SigNozAdminRoleName, "metaresource", "rule", verb},
+ migrationTuple{authtypes.SigNozEditorRoleName, "metaresource", "rule", verb},
+ )
+ }
+ for _, verb := range readVerbs {
+ tuples = append(tuples, migrationTuple{authtypes.SigNozViewerRoleName, "metaresource", "rule", verb})
+ }
+
+ for _, orgID := range orgIDs {
+ for _, tuple := range tuples {
+ entropy := ulid.DefaultEntropy()
+ now := time.Now().UTC()
+ tupleID := ulid.MustNew(ulid.Timestamp(now), entropy).String()
+
+ objectID := "organization/" + orgID + "/" + tuple.objectName + "/*"
+ roleSubject := "organization/" + orgID + "/role/" + tuple.roleName
+
+ if isPG {
+ user := "role:" + roleSubject + "#assignee"
+ result, err := tx.ExecContext(ctx, `
+ INSERT INTO tuple (store, object_type, object_id, relation, _user, user_type, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, object_type, object_id, relation, _user) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, user, "userset", tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ rowsAffected, err := result.RowsAffected()
+ if err != nil {
+ return err
+ }
+ if rowsAffected == 0 {
+ continue
+ }
+ _, err = tx.ExecContext(ctx, `
+ INSERT INTO changelog (store, object_type, object_id, relation, _user, operation, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, ulid, object_type) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, user, 0, tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ } else {
+ result, err := tx.ExecContext(ctx, `
+ INSERT INTO tuple (store, object_type, object_id, relation, user_object_type, user_object_id, user_relation, user_type, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, object_type, object_id, relation, user_object_type, user_object_id, user_relation) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, "role", roleSubject, "assignee", "userset", tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ rowsAffected, err := result.RowsAffected()
+ if err != nil {
+ return err
+ }
+ if rowsAffected == 0 {
+ continue
+ }
+ _, err = tx.ExecContext(ctx, `
+ INSERT INTO changelog (store, object_type, object_id, relation, user_object_type, user_object_id, user_relation, operation, ulid, inserted_at)
+ VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+ ON CONFLICT (store, ulid, object_type) DO NOTHING`,
+ storeID, tuple.objectType, objectID, tuple.relation, "role", roleSubject, "assignee", 0, tupleID, now,
+ )
+ if err != nil {
+ return err
+ }
+ }
+ }
+ }
+
+ return tx.Commit()
+}
+
+func (migration *addRuleTuples) Down(context.Context, *bun.DB) error {
+ return nil
+}
diff --git a/tests/integration/tests/ruler/08_authz.py b/tests/integration/tests/ruler/08_authz.py
index 9b45f71832..5ad455376a 100644
--- a/tests/integration/tests/ruler/08_authz.py
+++ b/tests/integration/tests/ruler/08_authz.py
@@ -16,6 +16,7 @@ from fixtures.types import Operation, SigNoz, TestContainerDocker
V2_RULES_URL = "/api/v2/rules"
V3_RULES_URL = "/api/v3/rules"
+RULE_VIEWS_URL = "/api/v2/rule_views"
DOWNTIME_URL = "/api/v1/downtime_schedules"
ROUTE_POLICIES_URL = "/api/v1/route_policies"
@@ -28,6 +29,7 @@ _ACTOR_PASSWORD = "password123Z$"
_ACTOR_ROLE_NAME = "alert-authz-actor"
_TARGET_RULE = "alert authz target"
+_VIEW_NAME = "alert-authz-view"
_DOWNTIME_NAME = "alert-authz-downtime"
_ACTOR_DOWNTIME_NAME = "alert-authz-actor-downtime"
_ROUTE_POLICY_NAME = "alert-authz-route-policy"
@@ -400,6 +402,45 @@ def test_viewer_allowed_on_downtime_reads_and_forbidden_on_writes(
assert response.status_code == HTTPStatus.NO_CONTENT, response.text
+def test_viewer_allowed_on_rule_views(
+ signoz: SigNoz,
+ create_user_admin: Operation, # pylint: disable=unused-argument
+ get_token: Callable[[str, str], str],
+):
+ token = get_token(_VIEWER_EMAIL, _VIEWER_PASSWORD)
+
+ response = requests.get(
+ signoz.self.host_configs["8080"].get(RULE_VIEWS_URL),
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.OK, response.text
+
+ response = requests.post(
+ signoz.self.host_configs["8080"].get(RULE_VIEWS_URL),
+ json={"name": _VIEW_NAME, "data": {"version": "v1", "sort": "updated_at", "order": "desc"}},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.CREATED, response.text
+ view_id = response.json()["data"]["id"]
+
+ response = requests.put(
+ signoz.self.host_configs["8080"].get(f"{RULE_VIEWS_URL}/{view_id}"),
+ json={"name": _VIEW_NAME, "data": {"version": "v1", "sort": "updated_at", "order": "asc"}},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.OK, response.text
+
+ response = requests.delete(
+ signoz.self.host_configs["8080"].get(f"{RULE_VIEWS_URL}/{view_id}"),
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.NO_CONTENT, response.text
+
+
def test_apply_license(
signoz: SigNoz,
create_user_admin: Operation, # pylint: disable=unused-argument
@@ -506,6 +547,37 @@ def test_downtime_managed_role_tuples_enforced_with_license(
assert response.status_code == HTTPStatus.NO_CONTENT, f"editor delete must pass on the migrated planned-maintenance delete tuple: {response.text}"
+def test_rule_view_managed_role_tuples_enforced_with_license(
+ signoz: SigNoz,
+ create_user_admin: Operation, # pylint: disable=unused-argument
+ get_token: Callable[[str, str], str],
+):
+ viewer_token = get_token(_VIEWER_EMAIL, _VIEWER_PASSWORD)
+
+ response = requests.get(
+ signoz.self.host_configs["8080"].get(RULE_VIEWS_URL),
+ headers={"Authorization": f"Bearer {viewer_token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.OK, f"viewer list must pass on the migrated rule list tuple: {response.text}"
+
+ response = requests.post(
+ signoz.self.host_configs["8080"].get(RULE_VIEWS_URL),
+ json={"name": _VIEW_NAME, "data": {"version": "v1", "sort": "updated_at", "order": "desc"}},
+ headers={"Authorization": f"Bearer {viewer_token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.CREATED, f"viewer create must pass, rule views are gated on rule list like dashboard views: {response.text}"
+ view_id = response.json()["data"]["id"]
+
+ response = requests.delete(
+ signoz.self.host_configs["8080"].get(f"{RULE_VIEWS_URL}/{view_id}"),
+ headers={"Authorization": f"Bearer {viewer_token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.NO_CONTENT, f"viewer delete must pass on the migrated rule list tuple: {response.text}"
+
+
def test_setup_channel_scoped_actor(
signoz: SigNoz,
create_user_admin: Operation, # pylint: disable=unused-argument
@@ -630,6 +702,29 @@ def test_route_policy_channel_changes_follow_channel_attach_and_detach(
assert response.status_code == HTTPStatus.NO_CONTENT, response.text
+def test_rule_views_forbidden_without_rule_list(
+ signoz: SigNoz,
+ create_user_admin: Operation, # pylint: disable=unused-argument
+ get_token: Callable[[str, str], str],
+):
+ token = get_token(_ACTOR_EMAIL, _ACTOR_PASSWORD)
+
+ response = requests.get(
+ signoz.self.host_configs["8080"].get(RULE_VIEWS_URL),
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.FORBIDDEN, response.text
+
+ response = requests.post(
+ signoz.self.host_configs["8080"].get(RULE_VIEWS_URL),
+ json={"name": _VIEW_NAME, "data": {"version": "v1", "sort": "updated_at", "order": "desc"}},
+ headers={"Authorization": f"Bearer {token}"},
+ timeout=5,
+ )
+ assert response.status_code == HTTPStatus.FORBIDDEN, response.text
+
+
def test_downtime_naming_rule_forbidden_without_rule_attach(
signoz: SigNoz,
create_user_admin: Operation, # pylint: disable=unused-argument