From b69fca14e76a2f5db0cd0924fe5e7056e94771b1 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 26 Feb 2013 15:49:37 -0800 Subject: initial doco --- doc/html/auth_8php.html | 230 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 230 insertions(+) create mode 100644 doc/html/auth_8php.html (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html new file mode 100644 index 000000000..a73733d30 --- /dev/null +++ b/doc/html/auth_8php.html @@ -0,0 +1,230 @@ + + + + + + +The Red Project: include/auth.php File Reference + + + + + + + + + + + + + +
+
+ + + + + + + +
+
The Red Project +
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Functions | +Variables
+
+
auth.php File Reference
+
+
+ + + + + + + + +

+Functions

 nuke_session ()
 
 account_verify_password ($email, $pass)
 
if((x($_POST,'auth-params'))&&$_POST['auth-params']===
+'login') 		new_cookie ($time)
 
+ + + +

+Variables

if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
+'login'))) 		else
 
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
account_verify_password ( $email,
 $pass 
)
+
+

Verify login credentials

+

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().

+ +
+
+ +
+
+ + + + + + + + +
if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') new_cookie ( $time)
+
+ +

Referenced by nuke_session().

+ +
+
+ +
+
+ + + + + + + +
nuke_session ()
+
+ +

Referenced by api_account_logout().

+ +
+
+

Variable Documentation

+ +
+
+ + + + +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
+
+Initial value:
{
+
+
if(isset($_SESSION)) {
+
nuke_session();
+
}
+
+
if((x($_POST,'password')) && strlen($_POST['password']))
+
$encrypted = hash('whirlpool',trim($_POST['password']))
+
+
+
+
+
+ + + + -- cgit v1.2.3