Packages

ash_policy_authorizer

0.6.0
0.16.5 retired 0.16.4-rc.1 0.16.4-rc.0 0.16.3 0.16.3-rc.0 retired 0.16.2 0.16.1-rc1 0.16.1-rc0 0.16.0 0.15.0 0.14.6 0.14.5 0.14.4 0.14.3 0.14.2 0.14.1 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.1 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.6 0.1.4 0.1.1

A policy based authorizer for the Ash Framework

HexDocs

Current section

Files

Jump to
Readme
31 Versions
1 Dependency
Dependants
Files
Activity
ash_policy_authorizer lib ash_policy_authorizer check.ex
Raw

lib/ash_policy_authorizer/check.ex 

defmodule AshPolicyAuthorizer.Check do

  @moduledoc """

  A behaviour for declaring checks, which can be used to easily construct

  authorization rules.

  """



  @type options :: Keyword.t()

  @type authorizer :: AshPolicyAuthorizer.Authorizer.t()

  @type check_type :: :simple | :filter | :manual



  @callback strict_check(Ash.actor(), authorizer(), options) :: {:ok, boolean | :unknown}

  @callback auto_filter(Ash.actor(), authorizer(), options()) :: Keyword.t()

  @callback check(Ash.actor(), list(Ash.record()), map, options) ::

              {:ok, list(Ash.record()) | boolean} | {:error, Ash.error()}

  @callback describe(options()) :: String.t()

  @callback type() :: check_type()

  @optional_callbacks check: 4, auto_filter: 3



  def defines_check?(module) do

    :erlang.function_exported(module, :check, 4)

  end



  def defines_auto_filter?(module) do

    :erlang.function_exported(module, :auto_filter, 3)

  end



  defmacro __using__(_opts) do

    quote do

      @behaviour AshPolicyAuthorizer.Check



      def type, do: :manual

    end

  end

end