RESTrict Framework

Please see https://restrictframework.io for the most up-to-date documentation.

TODO

• TODO: Change Ref -> Self visitor to skip data section
• TODO: Write visitor to check Self in data section
• TODO: Allow stars in security sections
• TODO: Update visitors.MatchRelDeclared...#visit_rel to search mods, too, for built-in resources
• TODO: Update visitors.MatchOverridenResource...#visit_resource to search mods, too, for built-in resources
• TODO: Consider allowing modification of restrict resources in ResolveModifyTypeVisitor

NOTES

Compiler pipeline steps:

1. Check for duplicate field and resource names
2. Replace refs with func params
3. Replace refs with selfs
4. Resolve declared types
   1. Resolve data constrained field type (res: type)
   2. Resolve rel type (res: bridge, restrict resource, or collection)
   3. Resolve create type (res: bridge or restrict resource)
   4. Resolve base resource type (base: bridge)
5. Resolve inherited fields
6. Resolve inherited rels
7. Resolve inherited effects
8. Resolve inherited security
9. Resolve inherited workflows
10. Resolve used resources
11. Resolve global names
12. Resolve func referenced function (res: function)
13. Resolve computed types of expressions
    1. Resolve effect field type (res: type or bridge)
    2. Resolve value type (res: type)
    3. Resolve selves type (res: bridge)
    4. Resolve self types (path_res: [bridge, ..., type])
    5. Resolve literal types (res: type)
    6. Resolve tagged literal types (res: type)
    7. Resolve modify type (res: bridge)
    8. Resolve ref type from globals (path_res: type: bridge, ..., type)
14. Check for cycles
15. Resolve data computed field type (func_res: type)
16. Resolve remaining self values
17. Resolve func return type and make sure it matches expected type
    1. Check data constraint (bool)
    2. Check security rule (bool)
    3. Check effect (func_res matches res for referenced field)
18. Compile funcs (compiled)
19. Compile resources

Expresison types

• Data constraints can include literals, functions, self, selves, tagged literals, and value
• Data computed fields can include literals, functions, refs, self, selves, and tagged literals
• Effects can include all create, literals, functions, modify, refs, self, selves, and tagged literals
• Security can include literals, functions, refs, self, and tagged literals
• Workflows can include literals, refs, self, selves, and tagged literals