validate_auth

March 26, 2020

Name

validate_auth

Synopsis

#include "hooks/core/validate_auth.h"

| int **validate_auth** ( | closure, |   |
|   | c, |   |
|   | auth_info, |   |
|   | auth_status); |   |

void * <var class="pdparam">closure</var>;
validate_context * <var class="pdparam">c</var>;
struct ec_auth_info * <var class="pdparam">auth_info</var>;
int <var class="pdparam">auth_status</var>;

| int **has_core_validate_auth_hook** ( | ); |   |

| void **register_core_validate_auth_hook_first** ( | hook, |   |
|   | closure); |   |

ec_hook_core_validate_auth_func_t <var class="pdparam">hook</var>;
void *<var class="pdparam">closure</var>;

| void **register_core_validate_auth_hook_last** ( | hook, |   |
|   | closure); |   |

ec_hook_core_validate_auth_func_t <var class="pdparam">hook</var>;
void *<var class="pdparam">closure</var>;

| int **call_core_validate_auth_hook** ( | c, |   |
|   | auth_info, |   |
|   | auth_status); |   |

validate_context * <var class="pdparam">c</var>;
struct ec_auth_info * <var class="pdparam">auth_info</var>;
int <var class="pdparam">auth_status</var>;

Description

**Configuration Change. ** This hook is available as of version 3.1.

This hook allows a module to perform an action in response to an SMTP AUTH event. The validate context will contain an "auth_status" key, containing either "fail," "pass," or "error" depending on whether authentication failed, succeeded, or encountered an internal error, respectively. Additionally, an "auth_user" key may exist containing the user name: the DIGEST-MD5 authentication method may fail an authentication attempt before the username is known. An "auth_name" key is also provided, describing what form of authentication was attempted (e.g. PLAIN, LOGIN, CRAM-MD5, DIGEST-MD5).