Packages
ash_authentication
4.14.1
5.0.0-rc.12
5.0.0-rc.11
5.0.0-rc.10
5.0.0-rc.9
5.0.0-rc.8
5.0.0-rc.7
5.0.0-rc.6
5.0.0-rc.5
5.0.0-rc.4
5.0.0-rc.3
5.0.0-rc.2
5.0.0-rc.1
5.0.0-rc.0
4.14.1
4.14.0
4.13.7
4.13.6
4.13.5
4.13.4
4.13.3
4.13.2
retired
4.13.1
retired
4.13.0
4.12.0
4.11.0
4.10.0
4.9.9
4.9.8
4.9.7
4.9.6
4.9.5
4.9.4
4.9.3
4.9.2
4.9.1
4.9.0
4.8.7
4.8.6
4.8.5
4.8.3
4.8.2
4.8.1
4.8.0
4.7.6
4.7.5
4.7.4
4.7.3
4.7.2
4.7.1
4.7.0
4.6.4
4.6.3
4.6.2
4.6.1
4.6.0
4.5.6
4.5.5
4.5.4
4.5.3
4.5.2
4.5.1
4.5.0
4.4.9
4.4.8
4.4.7
4.4.6
4.4.5
4.4.4
4.4.3
4.4.2
4.4.1
4.4.0
4.3.12
4.3.11
4.3.10
4.3.9
4.3.8
4.3.7
4.3.6
4.3.5
4.3.4
4.3.3
4.3.2
4.3.1
4.3.0
4.2.7
4.2.6
4.2.5
4.2.4
4.2.3
4.2.2
4.2.1
4.2.0
4.1.0
4.0.4
4.0.3
4.0.2
4.0.1
4.0.0
4.0.0-rc.6
4.0.0-rc.5
4.0.0-rc.3
4.0.0-rc.2
4.0.0-rc.1
4.0.0-rc.0
3.12.4
3.12.3
3.12.2
3.12.1
3.12.0
3.11.16
3.11.15
3.11.14
3.11.13
3.11.12
3.11.11
3.11.10
3.11.9
3.11.8
3.11.7
3.11.6
3.11.5
3.11.4
3.11.3
3.11.2
3.11.1
3.11.0
3.10.8
3.10.7
3.10.6
3.10.5
3.10.4
3.10.3
3.10.2
3.10.1
3.10.0
3.9.6
3.9.5
3.9.4
3.9.3
3.9.2
3.9.1
3.9.0
3.8.0
3.7.9
3.7.8
3.7.6
3.7.5
3.7.4
3.7.3
3.7.2
3.7.1
3.7.0
3.6.1
3.6.0
3.5.3
3.5.2
3.5.1
3.5.0
3.3.1
3.3.0
3.2.2
3.2.1
3.2.0
3.1.0
3.0.3
Authentication extension for the Ash Framework.
Current section
Files
Jump to
Current section
Files
lib/ash_authentication/add_ons/audit_log/dsl.ex
# SPDX-FileCopyrightText: 2022 Alembic Pty Ltd
#
# SPDX-License-Identifier: MIT
defmodule AshAuthentication.AddOn.AuditLog.Dsl do
@moduledoc """
Defines the Spark DSL entity for this add on.
"""
alias AshAuthentication.AddOn.AuditLog
@doc false
@spec dsl :: map
def dsl do
%Spark.Dsl.Entity{
name: :audit_log,
describe: """
Adds automatic audit logging for authentication events.
The audit log add-on records all authentication-related events (sign in, registration, password reset, etc.)
to a dedicated audit log resource. This provides a comprehensive security trail that can be used for
compliance, security monitoring, and user activity analysis.
Events are batched for performance and automatically expire based on configured retention periods.
Sensitive fields are filtered by default but can be explicitly included when necessary.
IP addresses can be transformed for privacy compliance using hashing, truncation, or exclusion.
""",
examples: [
"""
audit_log do
audit_log_resource MyApp.Accounts.AuditLog
include_strategies [:password, :oauth2]
exclude_actions [:sign_in_with_token]
ip_privacy_mode :truncate
ipv4_truncation_mask 24
ipv6_truncation_mask 48
end
"""
],
args: [{:optional, :name, :audit_log}],
target: AuditLog,
schema: [
name: [
type: :atom,
doc: "Uniquely identifies the add-on.",
required: true
],
audit_log_resource: [
type: {:spark, Ash.Resource},
doc: "The name of the Audit Log resource.",
required: true
],
include_strategies: [
doc: "Explicitly allow events from the named strategies.",
default: [:*]
],
include_actions: [
doc: "Explicitly allow events from the named actions.",
default: [:*]
],
exclude_strategies: [
type: {:wrap_list, :atom},
doc: "Explicitly ignore events from the named strategies.",
default: []
],
exclude_actions: [
type: {:wrap_list, :atom},
doc: "Explicitly ignore events from the named actions.",
default: []
],
include_fields: [
type: {:wrap_list, :atom},
required: false,
default: [],
doc:
"Explicitly include named attributes and arguments in the audit log regardless of their sensitivity setting."
],
ip_privacy_mode: [
type: {:in, [:none, :hash, :truncate, :exclude]},
required: false,
default: :none,
doc:
"How to handle IP addresses for privacy - :none (store as-is), :hash (SHA256), :truncate (network prefix), or :exclude (don't store)."
],
ipv4_truncation_mask: [
type: :pos_integer,
required: false,
default: 24,
doc: "IPv4 network mask bits for truncation (0-32). Default 24 keeps first 3 octets."
],
ipv6_truncation_mask: [
type: :pos_integer,
required: false,
default: 48,
doc:
"IPv6 network prefix bits for truncation (0-128). Default 48 keeps first 3 segments."
]
]
}
end
end