Buddy-auth Api Documentation

Version: 2.2.0

buddy.auth.protocols

Main authentication and authorization abstractions defined as protocols.

IAuthentication

protocol

Protocol that defines unified workflow steps for all authentication backends.

members

-authenticate

(-authenticate _ request data)

Given a request and parsed data (from previous step), try to authenticate this data.

If this method returns not nil value, the request will be considered authenticated and the value will be attached to request under :identity attribute.

-parse

(-parse _ request)

Parse token from the request. If it returns nil the authenticate phase will be skipped and the handler will be called directly.

IAuthorization

protocol

Protocol that defines unified workflow steps for authorization exceptions.

members

-handle-unauthorized

(-handle-unauthorized _ request metadata)

This function is executed when a NotAuthorizedException exception is intercepted by authorization wrapper.

It should return a valid ring response.

IAuthorizationdError

protocol

Abstraction that allows the user to extend the exception based authorization system with own types.

members

-get-error-data

(-get-error-data _)

Get error information.