Skip to content
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.

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

deduplicate edges when conditions exist and add conditions to the edges #422

Merged
merged 6 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
3 changes: 2 additions & 1 deletion pkg/go/graph/graph.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ func (g *AuthorizationModelGraph) Reversed() (*AuthorizationModelGraph, error) {
if !ok {
return nil, fmt.Errorf("%w: could not cast to AuthorizationModelEdge", ErrBuildingGraph)
}
graphBuilder.AddEdge(nextLine.To(), nextLine.From(), casted.edgeType, casted.conditionedOn)
newEdge := graphBuilder.AddEdge(nextLine.To(), nextLine.From(), casted.edgeType, casted.tuplesetRelation, "")
newEdge.conditions = casted.conditions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not graphBuilder.AddEdge(nextLine.To(), nextLine.From(), casted.edgeType, casted.tuplesetRelation, casted.conditions) ?

}
}

Expand Down
109 changes: 77 additions & 32 deletions pkg/go/graph/graph_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func parseModel(model *openfgav1.AuthorizationModel) (*multi.DirectedGraph, Node
})

for _, typeDef := range sortedTypeDefs {
graphBuilder.GetOrAddNode(typeDef.GetType(), typeDef.GetType(), SpecificType)
graphBuilder.getOrAddNode(typeDef.GetType(), typeDef.GetType(), SpecificType)

// sort relations by name to guarantee stable output
sortedRelations := make([]string, 0, len(typeDef.GetRelations()))
Expand All @@ -58,7 +58,7 @@ func parseModel(model *openfgav1.AuthorizationModel) (*multi.DirectedGraph, Node

for _, relation := range sortedRelations {
uniqueLabel := fmt.Sprintf("%s#%s", typeDef.GetType(), relation)
parentNode := graphBuilder.GetOrAddNode(uniqueLabel, uniqueLabel, SpecificTypeAndRelation)
parentNode := graphBuilder.getOrAddNode(uniqueLabel, uniqueLabel, SpecificTypeAndRelation)
rewrite := typeDef.GetRelations()[relation]
checkRewrite(graphBuilder, parentNode, model, rewrite, typeDef, relation)
}
Expand Down Expand Up @@ -107,17 +107,17 @@ func checkRewrite(graphBuilder *AuthorizationModelGraphBuilder, parentNode *Auth
}

operatorNode := fmt.Sprintf("%s:%s", operator, ulid.Make().String())
operatorNodeParent := graphBuilder.GetOrAddNode(operatorNode, operator, OperatorNode)
operatorNodeParent := graphBuilder.getOrAddNode(operatorNode, operator, OperatorNode)

// add one edge "operator" -> "relation that defined the operator"
// Note: if this is a composition of operators, operationNode will be nil and this edge won't be added.
graphBuilder.AddEdge(operatorNodeParent, parentNode, RewriteEdge, "")
graphBuilder.AddEdge(operatorNodeParent, parentNode, RewriteEdge, "", "")
for _, child := range children {
checkRewrite(graphBuilder, operatorNodeParent, model, child, typeDef, relation)
}
}

func parseThis(graphBuilder *AuthorizationModelGraphBuilder, parentNode graph.Node, typeDef *openfgav1.TypeDefinition, relation string) {
func parseThis(graphBuilder *AuthorizationModelGraphBuilder, parentNode graph.Node, typeDef *openfgav1.TypeDefinition, relation string) error {
directlyRelated := make([]*openfgav1.RelationReference, 0)
var curNode *AuthorizationModelNode

Expand All @@ -129,45 +129,45 @@ func parseThis(graphBuilder *AuthorizationModelGraphBuilder, parentNode graph.No
if directlyRelatedDef.GetRelationOrWildcard() == nil {
// direct assignment to concrete type
assignableType := directlyRelatedDef.GetType()
curNode = graphBuilder.GetOrAddNode(assignableType, assignableType, SpecificType)
curNode = graphBuilder.getOrAddNode(assignableType, assignableType, SpecificType)
}

if directlyRelatedDef.GetWildcard() != nil {
// direct assignment to wildcard
assignableWildcard := directlyRelatedDef.GetType() + ":*"
curNode = graphBuilder.GetOrAddNode(assignableWildcard, assignableWildcard, SpecificTypeWildcard)
curNode = graphBuilder.getOrAddNode(assignableWildcard, assignableWildcard, SpecificTypeWildcard)
}

if directlyRelatedDef.GetRelation() != "" {
// direct assignment to userset
assignableUserset := directlyRelatedDef.GetType() + "#" + directlyRelatedDef.GetRelation()
curNode = graphBuilder.GetOrAddNode(assignableUserset, assignableUserset, SpecificTypeAndRelation)
curNode = graphBuilder.getOrAddNode(assignableUserset, assignableUserset, SpecificTypeAndRelation)
}

if graphBuilder.HasEdge(curNode, parentNode, DirectEdge, "") {
// de-dup types that are conditioned, e.g. if define viewer: [user, user with condX]
// we only draw one edge from user to x#viewer
continue
// de-dup types that are conditioned, e.g. if define viewer: [user, user with condX]
// we only draw one edge from user to x#viewer, but with two conditions: none and condX
_, err := graphBuilder.upsertEdge(curNode, parentNode, DirectEdge, "", directlyRelatedDef.Condition)
if err != nil {
return err
}

graphBuilder.AddEdge(curNode, parentNode, DirectEdge, "")
}
return nil
}

func parseComputed(graphBuilder *AuthorizationModelGraphBuilder, parentNode *AuthorizationModelNode, typeDef *openfgav1.TypeDefinition, relation string) {
nodeType := RewriteEdge
// e.g. define x: y. Here y is the rewritten relation
rewrittenNodeName := fmt.Sprintf("%s#%s", typeDef.GetType(), relation)
newNode := graphBuilder.GetOrAddNode(rewrittenNodeName, rewrittenNodeName, SpecificTypeAndRelation)
newNode := graphBuilder.getOrAddNode(rewrittenNodeName, rewrittenNodeName, SpecificTypeAndRelation)
// new edge from y to x

if parentNode.nodeType == SpecificTypeAndRelation && newNode.nodeType == SpecificTypeAndRelation {
nodeType = ComputedEdge
}
graphBuilder.AddEdge(newNode, parentNode, nodeType, "")
graphBuilder.AddEdge(newNode, parentNode, nodeType, "", "")
}

func parseTupleToUserset(graphBuilder *AuthorizationModelGraphBuilder, parentNode graph.Node, model *openfgav1.AuthorizationModel, typeDef *openfgav1.TypeDefinition, rewrite *openfgav1.TupleToUserset) {
func parseTupleToUserset(graphBuilder *AuthorizationModelGraphBuilder, parentNode graph.Node, model *openfgav1.AuthorizationModel, typeDef *openfgav1.TypeDefinition, rewrite *openfgav1.TupleToUserset) error {
// e.g. define viewer: admin from parent
// "parent" is the tupleset
tuplesetRelation := rewrite.GetTupleset().GetRelation()
Expand All @@ -181,23 +181,35 @@ func parseTupleToUserset(graphBuilder *AuthorizationModelGraphBuilder, parentNod
}

for _, relatedType := range directlyRelated {

tuplesetType := relatedType.GetType()

if !typeAndRelationExists(model, tuplesetType, computedRelation) {
continue
}

rewrittenNodeName := fmt.Sprintf("%s#%s", tuplesetType, computedRelation)
nodeSource := graphBuilder.GetOrAddNode(rewrittenNodeName, rewrittenNodeName, SpecificTypeAndRelation)
conditionedOnNodeName := fmt.Sprintf("%s#%s", typeDef.GetType(), tuplesetRelation)
nodeSource := graphBuilder.getOrAddNode(rewrittenNodeName, rewrittenNodeName, SpecificTypeAndRelation)
typeTuplesetRelation := fmt.Sprintf("%s#%s", typeDef.GetType(), tuplesetRelation)

// new edge from "xxx#admin" to "yyy#viewer" conditioned on "yyy#parent"
graphBuilder.AddEdge(nodeSource, parentNode, TTUEdge, conditionedOnNodeName)
ok, err := graphBuilder.hasEdge(nodeSource, parentNode, TTUEdge, typeTuplesetRelation)
if err != nil {
return err
}
if ok {
// de-dup types that are conditioned, e.g. if define viewer: [user, user with condX]
// we only draw one edge from user to x#viewer
continue
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to call upsert? Otherwise, will be lose the condition?

}

// new edge from "xxx#admin" to "yyy#viewer" tuplesetRelation on "yyy#parent"
graphBuilder.upsertEdge(nodeSource, parentNode, TTUEdge, typeTuplesetRelation, relatedType.GetCondition())
}
return nil
}

func (g *AuthorizationModelGraphBuilder) GetOrAddNode(uniqueLabel, label string, nodeType NodeType) *AuthorizationModelNode {
if existingNode := g.GetNodeFor(uniqueLabel); existingNode != nil {
func (g *AuthorizationModelGraphBuilder) getOrAddNode(uniqueLabel, label string, nodeType NodeType) *AuthorizationModelNode {
if existingNode := g.getNodeByLabel(uniqueLabel); existingNode != nil {
return existingNode
}

Expand All @@ -215,7 +227,7 @@ func (g *AuthorizationModelGraphBuilder) GetOrAddNode(uniqueLabel, label string,
return newNode
}

func (g *AuthorizationModelGraphBuilder) GetNodeFor(uniqueLabel string) *AuthorizationModelNode {
func (g *AuthorizationModelGraphBuilder) getNodeByLabel(uniqueLabel string) *AuthorizationModelNode {
id, ok := g.ids[uniqueLabel]
if !ok {
return nil
Expand All @@ -229,36 +241,69 @@ func (g *AuthorizationModelGraphBuilder) GetNodeFor(uniqueLabel string) *Authori
return authModelNode
}

func (g *AuthorizationModelGraphBuilder) AddEdge(from, to graph.Node, edgeType EdgeType, conditionedOn string) *AuthorizationModelEdge {
func (g *AuthorizationModelGraphBuilder) AddEdge(from, to graph.Node, edgeType EdgeType, tuplesetRelation string, condition string) *AuthorizationModelEdge {
if from == nil || to == nil {
return nil
}
if len(condition) == 0 {
condition = NoCond
}
conditions := []string{condition}

l := g.NewLine(from, to)
newLine := &AuthorizationModelEdge{Line: l, edgeType: edgeType, conditionedOn: conditionedOn}
newLine := &AuthorizationModelEdge{Line: l, edgeType: edgeType, tuplesetRelation: tuplesetRelation, conditions: conditions}
g.SetLine(newLine)

return newLine
}

func (g *AuthorizationModelGraphBuilder) HasEdge(from, to graph.Node, edgeType EdgeType, conditionedOn string) bool {
func (g *AuthorizationModelGraphBuilder) upsertEdge(from, to graph.Node, edgeType EdgeType, tuplesetRelation string, condition string) (*AuthorizationModelEdge, error) {
if from == nil || to == nil {
return false
return nil, nil
}

iter := g.Lines(from.ID(), to.ID())
for iter.Next() {
l := iter.Line()
edge, ok := l.(*AuthorizationModelEdge)
if !ok {
return false
// if it is not a valid AuthorizationModelEdge then return error
return nil, ErrBuildingGraph
}
if edge.edgeType == edgeType && edge.conditionedOn == conditionedOn {
return true
if edge.edgeType == edgeType && edge.tuplesetRelation == tuplesetRelation {
for _, cond := range edge.conditions {
if cond == condition {
return edge, nil
}
}
edge.conditions = append(edge.conditions, condition)
return edge, nil
}
}

return false
return g.AddEdge(from, to, edgeType, tuplesetRelation, condition), nil

}

func (g *AuthorizationModelGraphBuilder) hasEdge(from, to graph.Node, edgeType EdgeType, tuplesetRelation string) (bool, error) {
if from == nil || to == nil {
return false, nil
}

iter := g.Lines(from.ID(), to.ID())
for iter.Next() {
l := iter.Line()
edge, ok := l.(*AuthorizationModelEdge)
if !ok {
// if it is not a valid AuthorizationModelEdge then return error
return false, ErrBuildingGraph
}
if edge.edgeType == edgeType && edge.tuplesetRelation == tuplesetRelation {
return true, nil
}
}

return false, nil
}

func typeAndRelationExists(model *openfgav1.AuthorizationModel, typeName, relation string) bool {
Expand Down
65 changes: 65 additions & 0 deletions pkg/go/graph/graph_builder_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,71 @@ rankdir=BT
2 -> 1 [label=direct];
4 -> 3 [headlabel="(document#parent)"];
5 -> 4 [label=direct];
}`,
},
`tuple_to_userset_conditional`: {
model: `
model
schema 1.1
type user
type document
relations
define parentt: [folder, folder with condX]
define viewer: admin from parentt
type folder
relations
define admin: [user]
condition condX (x:int) {
x > 0
}`,
expectedOutput: `digraph {
graph [
rankdir=BT
];
// Node definitions.
0 [label=document];
1 [label="document#parentt"];
2 [label=folder];
3 [label="document#viewer"];
4 [label="folder#admin"];
5 [label=user];
// Edge definitions.
2 -> 1 [label=direct];
4 -> 3 [headlabel="(document#parentt)"];
5 -> 4 [label=direct];
}`,
},
`userset_conditional`: {
model: `
model
schema 1.1
type folder
relations
define viewer: [group#member, group#member with condX]
type group
relations
define member: [user]
type user
condition condX (x:int) {
x > 0
}`,
expectedOutput: `digraph {
graph [
rankdir=BT
];
// Node definitions.
0 [label=folder];
1 [label="folder#viewer"];
2 [label="group#member"];
3 [label=group];
4 [label=user];
// Edge definitions.
2 -> 1 [label=direct];
4 -> 2 [label=direct];
}`,
},
`tuple_to_userset_recursive`: {
Expand Down
24 changes: 19 additions & 5 deletions pkg/go/graph/graph_edge.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ const (
RewriteEdge EdgeType = 1
TTUEdge EdgeType = 2
ComputedEdge EdgeType = 3
// when an edge does not have cond in the model, it will have a condition with value none.
// this is required to differentiate when an edge need to support condition and no condition
// like define rel1: [user, user with condX], in this case the edge will have [none, condX]
// or an edge needs to support only condition like define rel1: [user with condX], the edge will have [condX]
// in the case the edge does not have any condition like define rel1: [user], the edge will have [none]
NoCond string = "none"
)

type AuthorizationModelEdge struct {
Expand All @@ -21,7 +27,15 @@ type AuthorizationModelEdge struct {
edgeType EdgeType

// only when edgeType == TTUEdge
conditionedOn string
tuplesetRelation string

// conditions on the edge. This is a flattened graph with dedupx edges,
// if you have a node with multiple edges to another node will be deduplicate and instead
// only one edge but with multiple conditions,
// define rel1: [user, user with condX]
// then the node rel1 will have an edge pointing to the node user and with two conditions
// one that will be none and another one that will be condX
conditions []string
}

var _ encoding.Attributer = (*AuthorizationModelEdge)(nil)
Expand All @@ -30,12 +44,12 @@ func (n *AuthorizationModelEdge) EdgeType() EdgeType {
return n.edgeType
}

// ConditionedOn returns the TTU relation. For example, relation
// TuplesetRelation returns the TTU relation. For example, relation
// define viewer: viewer from parent
// gives the graph "document#viewer" -> "document#viewer" and the edge
// is conditioned on "document#parent".
func (n *AuthorizationModelEdge) ConditionedOn() string {
return n.conditionedOn
func (n *AuthorizationModelEdge) TuplesetRelation() string {
return n.tuplesetRelation
}

func (n *AuthorizationModelEdge) Attributes() []encoding.Attribute {
Expand All @@ -55,7 +69,7 @@ func (n *AuthorizationModelEdge) Attributes() []encoding.Attribute {
},
}
case TTUEdge:
headLabelAttrValue := n.conditionedOn
headLabelAttrValue := n.tuplesetRelation
if headLabelAttrValue == "" {
headLabelAttrValue = "missing"
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/go/graph/graph_edge_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ func TestEdgeConditionedOn(t *testing.T) {
edge, ok := edges.Line().(*AuthorizationModelEdge)
require.True(t, ok)

require.Equal(t, "document#parent", edge.ConditionedOn())
require.Equal(t, "document#parent", edge.TuplesetRelation())
}
7 changes: 5 additions & 2 deletions pkg/go/graph/weighted_graph.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,14 @@ func (wg *WeightedAuthorizationModelGraph) AddNode(uniqueLabel, label string, no
wg.nodes[uniqueLabel] = &WeightedAuthorizationModelNode{uniqueLabel: uniqueLabel, label: label, nodeType: nodeType, wildcards: wildcards}
}

func (wg *WeightedAuthorizationModelGraph) AddEdge(fromID, toID string, edgeType EdgeType, condition string) {
func (wg *WeightedAuthorizationModelGraph) AddEdge(fromID, toID string, edgeType EdgeType, tuplesetRelation string, conditions []string) {
wildcards := make([]string, 0)
fromNode := wg.nodes[fromID]
toNode := wg.nodes[toID]
edge := &WeightedAuthorizationModelEdge{from: fromNode, to: toNode, edgeType: edgeType, conditionedOn: condition, wildcards: wildcards}
if conditions == nil {
conditions = []string{NoCond}
}
edge := &WeightedAuthorizationModelEdge{from: fromNode, to: toNode, edgeType: edgeType, tuplesetRelation: tuplesetRelation, wildcards: wildcards, conditions: conditions}
wg.edges[fromID] = append(wg.edges[fromID], edge)
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/go/graph/weighted_graph_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func (wgb *WeightedAuthorizationModelGraphBuilder) Build(model *openfgav1.Author
if !ok {
return nil, fmt.Errorf("%w: could not cast %v to AuthorizationModelNode", ErrBuildingGraph, castedEdge.To())
}
wb.AddEdge(castedFromNode.uniqueLabel, castedToNode.uniqueLabel, castedEdge.edgeType, castedEdge.conditionedOn)
wb.AddEdge(castedFromNode.uniqueLabel, castedToNode.uniqueLabel, castedEdge.edgeType, castedEdge.tuplesetRelation, castedEdge.conditions)
}
}

Expand Down
Loading
Loading