From 26105b53d4ce5fcbacfe8d10d540121a89849d34 Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 19 Dec 2014 00:29:10 -0800 Subject: doc updates --- doc/html/auth_8php.html | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 644e47434..9145b5ef3 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -122,6 +122,9 @@ Functions account_verify_password ($email, $pass) Verify login credentials. More...
+ log_failed_login ($errormsg) + Log failed logins to a separate auth log. More...
+ if((x($_POST, 'auth-params'))&&$_POST['auth-params']===
'login') match_openid ($authid) Returns the channel_id for a given openid_identity. More...
@@ -164,6 +167,7 @@ Variables

Verify login credentials.

If system authlog is set a log entry will be added for failed login attempts.

Parameters

@@ -172,10 +176,37 @@ Variables

Returns: array|null Returns account record on success, null on failure.

A plugin indicates successful login by setting 'authenticated' to non-zero value and returning a user record Plugins should never set 'authenticated' except to indicate success - as hooks may be chained and later plugins should not interfere with an earlier one that succeeded.

Referenced by api_login(), removeaccount_post(), removeme_post(), and RedMatrix\RedDAV\RedBasicAuth\validateUserPass().

+ + + +

string $email The email address to verify.

+ + + + + + + +

log_failed_login ( $errormsg )

+ +

Log failed logins to a separate auth log.

Can be used to reduce overhead for server side intrusion prevention, like parse the authlog file with something like fail2ban, OSSEC, etc.

Parameters

+ + +

string $errormsg Error message to display for failed login.

+ +

Referenced by account_verify_password(), and RedMatrix\RedDAV\RedBasicAuth\validateUserPass().

-- cgit v1.2.3