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 From 0ee1e83a3c6bb48064789a622f5eb7331733cb64 Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 26 Feb 2013 16:04:28 -0800 Subject: small doco update --- doc/html/auth_8php.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index a73733d30..59799f6f4 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -221,7 +221,7 @@ Variables - - - - + -- cgit v1.2.3 From 9e22ec928b9534ea9db0d18bf685fb0d357fbad2 Mon Sep 17 00:00:00 2001 From: friendica Date: Thu, 18 Apr 2013 21:06:31 -0700 Subject: more umbilical cutting --- doc/html/auth_8php.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index a1b83ae79..0a6e9d033 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -28,7 +28,7 @@ - + -
The Red Project
-- cgit v1.2.3 From 946554ff4b03d81f32375832b8b50883a3ffeedf Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 10 May 2013 03:52:06 -0700 Subject: doc update --- doc/html/auth_8php.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 0a6e9d033..cec7dbb96 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -117,13 +117,13 @@ Functions
 
 account_verify_password ($email, $pass)
 
if((x($_POST,'auth-params'))&&$_POST['auth-params']===
+
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']!==
+
if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
'login'))) 		else
 
@@ -164,7 +164,7 @@ Variables
- + @@ -200,7 +200,7 @@ Variables
if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') new_cookie if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') new_cookie (   $time)
- +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) elseif ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
-- cgit v1.2.3 From 34526e82531c67995e25cf04abce0d927ce22ffd Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 10 May 2013 03:59:11 -0700 Subject: doc cleanup --- doc/html/auth_8php.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index cec7dbb96..e56b91f9c 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -4,7 +4,7 @@ -The Red Project: include/auth.php File Reference +The Red Matrix: include/auth.php File Reference @@ -30,7 +30,7 @@ Logo -
The Red Project +
The Red Matrix
-- cgit v1.2.3 From 5e4b9d7766ceffd19785f14443cc1b4d4f675d4e Mon Sep 17 00:00:00 2001 From: friendica Date: Tue, 14 May 2013 21:25:58 -0700 Subject: disable pcss when installing since modules don't yet work and pcss uses the view module, plus weekly doc update --- doc/html/auth_8php.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index e56b91f9c..46ed824ec 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -28,7 +28,7 @@ - + - -
The Red Matrix
-- cgit v1.2.3 From 5c1f959c1828066358ec868ffb953e88f16195c6 Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 24 May 2013 06:02:30 -0700 Subject: set default contact affinity back to 99 - we'll solve the other problem another way, this one is flawed --- doc/html/auth_8php.html | 21 --------------------- 1 file changed, 21 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 46ed824ec..9666c84f4 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -117,9 +117,6 @@ Functions
 
 account_verify_password ($email, $pass)
 
if((x($_POST,'auth-params'))&&$_POST['auth-params']===
-'login') 		new_cookie ($time)
 
@@ -157,24 +154,6 @@ Variables

Referenced by api_login().

- - - -
-
-

Variables

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

Referenced by nuke_session().

-
-- cgit v1.2.3 From 09950745c10912f9875eb4a63793ff7e85bb7974 Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 11 Oct 2013 20:43:53 -0700 Subject: doc updates --- doc/html/auth_8php.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 9666c84f4..220d244b3 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -120,7 +120,7 @@ Functions -

Variables

if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
+
if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
'login'))) 		else
 
@@ -179,7 +179,7 @@ Variables
- +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) elseif ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
-- cgit v1.2.3 From c36fc59df30735b88ab55884f4411dedd3886f20 Mon Sep 17 00:00:00 2001 From: friendica Date: Sat, 26 Oct 2013 01:27:19 -0700 Subject: doc updates --- doc/html/auth_8php.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 220d244b3..725b1156d 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -152,7 +152,7 @@ Variables

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

+

Referenced by api_login(), and RedBasicAuth\validateUserPass().

-- cgit v1.2.3 From f9a622c44ef5160942f1199dd86cfa749b79e7bc Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 15 Nov 2013 01:10:51 -0800 Subject: doc update --- doc/html/auth_8php.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 725b1156d..4a3100253 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -152,7 +152,7 @@ Variables

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(), and RedBasicAuth\validateUserPass().

+

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

-- cgit v1.2.3 From 8cd9a2c3a944e804c72ef461df801116c6b44ac7 Mon Sep 17 00:00:00 2001 From: friendica Date: Thu, 28 Nov 2013 19:37:39 -0800 Subject: doc updates --- doc/html/auth_8php.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 4a3100253..79e1ce375 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -28,7 +28,7 @@ - +
The Red Matrix
-- cgit v1.2.3 From fb49647993fec8f52e69801ce92a9882a4c95b1a Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 7 Feb 2014 00:49:45 -0800 Subject: doc updates --- doc/html/auth_8php.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 79e1ce375..ab3e3e2a9 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -120,7 +120,7 @@ Functions
-

Variables

if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
+
if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
'login'))) 		else
 
@@ -179,7 +179,7 @@ Variables
- +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) elseif ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
-- cgit v1.2.3 From 0501bab7dc5982f94924e19192c1d523a45085aa Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 21 Feb 2014 23:51:43 -0800 Subject: doc update --- doc/html/auth_8php.html | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index ab3e3e2a9..0599457cf 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -117,6 +117,9 @@ Functions    account_verify_password ($email, $pass)   +if((x($_POST,'auth-params'))&&$_POST['auth-params']===
+'login') match_openid ($authid) +  @@ -154,6 +157,24 @@ Variables

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

+ + + +
+
+

Variables

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

Referenced by openid_content().

+
-- cgit v1.2.3 From 46f0de7120d0773f361e08298c99ef804330adff Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 28 Feb 2014 00:57:35 -0800 Subject: try to fix youtube mixed content warnings --- doc/html/auth_8php.html | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 0599457cf..1298d0826 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -117,13 +117,13 @@ Functions    account_verify_password ($email, $pass)   -if((x($_POST,'auth-params'))&&$_POST['auth-params']===
+if((x($_POST,'auth-params'))&&$_POST['auth-params']===
'login') match_openid ($authid)   -

Variables

if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
+
if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
'login'))) 		else
 
@@ -164,7 +164,7 @@ Variables
- + @@ -200,7 +200,7 @@ Variables
if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') match_openid if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') match_openid (   $authid)
- +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) elseif ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
@@ -210,9 +210,12 @@ Variables
nuke_session();
}
+
+
if((x($_POST,'password')) && strlen($_POST['password']))
$encrypted = hash('whirlpool',trim($_POST['password']))
-
+

Inline - not a function look for auth parameters or re-validate an existing session also handles logout

+ -- cgit v1.2.3 From 16c2aa042fade698ece5dcb67cde10ff8155bd65 Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 7 Mar 2014 14:30:24 -0800 Subject: doc update --- doc/html/auth_8php.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index 1298d0826..ef3142e60 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -117,13 +117,13 @@ Functions    account_verify_password ($email, $pass)   -if((x($_POST,'auth-params'))&&$_POST['auth-params']===
+if((x($_POST,'auth-params'))&&$_POST['auth-params']===
'login') match_openid ($authid)   -

Variables

if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
+
if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
'login'))) 		else
 
@@ -164,7 +164,7 @@ Variables
- + @@ -200,7 +200,7 @@ Variables
if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') match_openid if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') match_openid (   $authid)
- +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) elseif ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
-- cgit v1.2.3 From 074d2839c00aeb1400021e2cdbe432e87e0397b9 Mon Sep 17 00:00:00 2001 From: friendica Date: Sun, 16 Mar 2014 14:56:04 -0700 Subject: doc update --- doc/html/auth_8php.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'doc/html/auth_8php.html') diff --git a/doc/html/auth_8php.html b/doc/html/auth_8php.html index ef3142e60..eefab2c61 100644 --- a/doc/html/auth_8php.html +++ b/doc/html/auth_8php.html @@ -117,13 +117,13 @@ Functions    account_verify_password ($email, $pass)   -if((x($_POST,'auth-params'))&&$_POST['auth-params']===
+if((x($_POST,'auth-params'))&&$_POST['auth-params']===
'login') match_openid ($authid)   -

Variables

if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
+
if((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!==
'login'))) 		else
 
@@ -164,7 +164,7 @@ Variables
- + @@ -200,7 +200,7 @@ Variables
if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') match_openid if ((x($_POST,'auth-params'))&&$_POST['auth-params']=== 'login') match_openid (   $authid)
- +
if ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) elseif ((isset($_SESSION))&&(x($_SESSION,'authenticated'))&&((!(x($_POST,'auth-params')))||($_POST['auth-params']!== 'login'))) else
-- cgit v1.2.3