Aidbox
Search…
Debug
Access control debug tools available in Aidbox
Aidbox offers multiple ways to debug access policies:

There is a special query-string parameter __debug=policy you can pass to every Aidbox request. It will toggle debug mode for Request Authorization Layer, and in this mode instead of actual response client will get an object containing:
  • full request object;
  • an array of existing AccessPolicies;
  • evaluation result for every AccessPolicy (under AccessPolicy.evalResult).
Define AIDBOX_DEV_MODE to enable __debug parameter

For requests with the x-debug: policy header, details of access policy evaluation will be logged.
GET /Patient
x-debug: policy
​
# in aidbox logs
# :auth/trace-policy {:access-policy-id :policy-1, :policy-type "sql", ...
# :auth/trace-policy {:access-policy-id :policy-2, :policy-type "json-schema",...

su header allows to switch user on behalf of whom request is executed. Use su=<user/client id> to check how access control works for that user.
su header functionality can be enabled with box_debug_su_enable env
Example
box_debug_su_enable=true
su header is only available to admin users, who have at least one AccessPolicy with engine = allow linked to them.

# Request as an admin:
GET /fhir/Patient
​
# Response:
Status: 200
# Request on behalf of `myid` User who has no access to Patient search:
GET /fhir/Patient
su: myid
​
# Response
Status: 403

You can use a special operation POST /auth/test-policy to design policy without creating an AccessPolicy resource and for different users and clients. Post on the /auth/test-policy with a simulated request attribute (you can provide existing user-id and client-id — Aidbox will find and populate request) and temporal policy in the policy attribute. If you want to test JWT auth, put your token in the headers.authorization with the Bearer prefix — the token will be parsed and its claims appear in the request.jwt. JWT in a header is parsed but not validated. This allows you to test JWT policy without TokenIntrospector registration.
The response contains a result of evaluated policy.
POST /auth/test-policy
​
-- simulate request document
request:
uri: '/Patient'
request-method: get
headers:
authorization: Bearer <your-jwt>
user:
data: {role: 'admin'}
-- or
-- user-id: 'user-1' -- aidbox will find user in database
client:
id: basic
grant_types: ['basic']
-- or
-- client-id: 'client-1' -- aidbox will find client in database
policy:
engine: sql
sql:
query: 'SELECT {{user.role}} FROM {{!params.resource/type}}'
​
-- response
​
request:
uri: /Patient
request-method: get
user: {role: admin}
params: {resource/type: Patient}
#jwt: ...jwt-claims
operation:
request:
- get
- {name: resource/type}
action: proto.operations/search
module: proto
id: Search
-- original policy
policy:
engine: sql
sql: {query: 'SELECT {{user.role}} FROM {{!params.resource/type}}'}
-- result of policy evaluation
result:
eval-result: false
query: ['SELECT ? FROM "patient"', admin]
Copy link
Edit on GitHub
On this page
__debug query-string parameter
x-debug: policy request header
su request header
/auth/test-policy Operation