A policy check: true when the actor was authenticated by a macaroon and every
phase: :authorize caveat that macaroon carries admits the action being authorized.
policies do
policy always() do
forbid_unless {AshVault.Checks.MacaroonAllows, macaroon: :api}
authorize_if actor_present()
end
endThe actor is the record returned by a verifying read (:<name>_by_token, or your
own action using AshVault.Macaroon.Preparations.Verify), which carries
__metadata__.macaroon. The check evaluates the authorize-phase caveats against an
AshVault.Macaroon.CheckContext whose :action and :subject are the action and
query/changeset being authorized.
Options
:macaroon— only accept this macaroon (any macaroon when omitted):when_absent— the answer for an actor without a verified macaroon:false(default) ortrue. Usetrueto let session-authenticated actors through aforbid_unless, while macaroon actors are held to their caveats.
Authorize-phase caveats are enforced only here
The verifying read runs phase: :verify checks. A phase: :authorize caveat is
enforced by this check and nowhere else: a resource whose policies never use it
does not restrict a macaroon actor by those caveats. A token holder — or a third
party handed an attenuated token — cannot tell which resources enforce them, so an
actions: ["read"] caveat is a promise only as good as your policy coverage.
AshVault.Verifiers.VerifyMacaroons warns when the declaring resource itself never
uses this check; require_authorize_enforcement? true on the macaroon refuses such
tokens unless the verifying caller asserts enforcement.
when_absent: true and reloaded actors
The macaroon lives in the actor's __metadata__. Anything that re-reads the actor —
Ash.reload/2, Ash.get/3, a session that stores only the id and loads the record
per request — returns a record without it, and with when_absent: true that
record passes as an actor that never used a macaroon: every authorize-phase caveat
silently stops applying. Keep the record the verifying read returned as the actor
(Ash.load/3 on it preserves metadata), or use the default when_absent: false on
resources only macaroon actors should reach.
Summary
Functions
Callback implementation for Ash.Policy.Check.eager_evaluate?/0.
Callback implementation for Ash.Policy.Check.init/1.
Callback implementation for Ash.Policy.Check.prefer_expanded_description?/0.
Callback implementation for Ash.Policy.Check.requires_original_data?/2.
Callback implementation for Ash.Policy.Check.strict_check/3.
Callback implementation for Ash.Policy.Check.type/0.
Functions
Callback implementation for Ash.Policy.Check.eager_evaluate?/0.
Callback implementation for Ash.Policy.Check.init/1.
Callback implementation for Ash.Policy.Check.prefer_expanded_description?/0.
Callback implementation for Ash.Policy.Check.requires_original_data?/2.
Callback implementation for Ash.Policy.Check.strict_check/3.
Callback implementation for Ash.Policy.Check.type/0.