Errors
When validating a permission or trying to process a permission or action that has an incorrect format we return or throw errors. To keep consistency across languages we define an error format in the specification and include error messages as part of the validation test suite.
Parsing the errors should not be required, this format is aimed at being helpful to log for internal debugging, but are probably not useful for your end users.
In cases where you are taking user input and saving a permission, you should use the validate_permission function to check
if the provided value is properly formatted.
You may also need to do extra processing to make sure the values defined in the permission logically make sense
in your system as a whole.
Formats: When getting an error processing it will mention whether the invalid data came from a action or permission.
When using the validation function we omit the permission or action as they are not given.
For permissions of ["blog/:15/read"], since : is not allowed in permissions.
Errors here are not in any particular order, but just as they are discovered or valiations written. In a lot of cases this will just reiterate the summary of the error but in some it will include variables from the respective permission or action.
100
Invalid character.
Scopie only allows letters, numbers, underscore _ and dashes - in literal blocks, any other character is invalid.
101
Variable inside array group.
Array blocks can not contain variables and must be the entire block on its own. This is so that variables are used more like namespaces or grouping specifiers and would conflict with array blocks that are one of a few actions or specific namespaces.
102
Wildcard in array.
Array blocks can not contain wildcards and must be the entire block on its own. Having a wildcard would override any array or literal value.
103
Super wildcard in array
Array blocks can not contain super wildcards and must be the entire block on its own. Having a super wildcard would override any array or literal value.
104
Variable key not found in dictionary.
A variable was referenced that does not exist in the variable map or dictionary.
vars = { "user": "tnt" }
projects/@project/repository/create
^ variable project does not exist
105
Super wildcard not in the last block
A super wildcard will auto match all future blocks, because of this any further blocks would be ignored.
106
Empty permission or action
Having an empty permission or action for the user doesn't actually make any sense for authorization and is likely caused by something else. We return an error here instead to hopefully catch this instead of silently denying.
107
Permission does not start with a grant
All permissions must specify the allow or deny grant as the prefix to the permission.