# macaw_auth_ash v0.3.2 - Table of Contents

> A macaw_auth backend over AshAuthentication: a host's Ash user and token resources behind the Macaw.Auth contract, with an LDAP sign-in strategy.

## Pages

- [README](readme.md)
- [Changelog](changelog.md)

## Modules

- [Macaw.Auth.Ash](Macaw.Auth.Ash.md): A `Macaw.Auth` backend over AshAuthentication: a host's Ash user and
token resources behind the contract, so an Ash host gets Macaw's plugs,
LiveView hooks, steps and revocation push without a second user table.
- [Macaw.Auth.Ash.AnnounceRevocation](Macaw.Auth.Ash.AnnounceRevocation.md): Tells open pages of the tokens an update action revoked:
`Macaw.Auth.Ash.TokenResource` puts it on AshAuthentication's
`revoke_all_stored_for_subject`.
- [Macaw.Auth.Ash.Config](Macaw.Auth.Ash.Config.md): `Macaw.Auth.Ash`'s configuration, read from the application environment
and checked, so a fault names its key rather than failing a sign-in
somewhere deeper
- [Macaw.Auth.Ash.Notifier](Macaw.Auth.Ash.Notifier.md): Tells open pages of a revocation made through Ash, outside `Macaw.Auth`.
- [Macaw.Auth.Ash.Sessions](Macaw.Auth.Ash.Sessions.md): `Macaw.Auth.Ash`'s sessions, kept in the host's AshAuthentication token
resource.
- [Macaw.Auth.Ash.Strategy.Ldap](Macaw.Auth.Ash.Strategy.Ldap.md): A directory sign-in as an AshAuthentication strategy: macaw_auth's
`Macaw.Auth.Native.Source.Ldap` (its RFC 4514 and filter escaping, its
TLS rules with `allow_plaintext: false`, its group checks and role
mapping) on an Ash user resource, which it provisions at a user's first
sign-in.
- [Macaw.Auth.Ash.Strategy.Ldap.SignIn](Macaw.Auth.Ash.Strategy.Ldap.SignIn.md): The LDAP strategy's sign-in action (`sign_in_with_<name>`): runs
`Macaw.Auth.Ash.Strategy.Ldap.sign_in/4` and returns the user, with a
user token in its `:token` metadata when the resource has tokens, as
the password strategy's sign-in does (unless the action's context sets
`token_type` to anything but `:user`).
- [Macaw.Auth.Ash.TokenResource](Macaw.Auth.Ash.TokenResource.md): What `Macaw.Auth.Ash` adds to a host's AshAuthentication token resource