PHP Classes
elePHPant
Icontem

File: build/phpdox/xml/classes/cymapgt_core_application_authentication_UserCredential_services_UserCredentialPasswordLoginService.xml

Recommend this page to a friend!
  Classes of Cyril Ogana  >  PHP User Credentials  >  build/phpdox/xml/classes/cymapgt_core_application_authentication_UserCredential_services_UserCredentialPasswordLoginService.xml  >  Download  
File: build/phpdox/xml/classes/cymapgt_core_application_authentication_UserCredential_services_UserCredentialPasswordLoginService.xml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: PHP User Credentials
Implement password authentication policies
Author: By
Last change:
Date: 3 years ago
Size: 20,018 bytes
 

 

Contents

Class file image Download
<?xml version="1.0" encoding="UTF-8"?>
<class xmlns="http://xml.phpdox.net/src" full="cymapgt\core\application\authentication\UserCredential\services\UserCredentialPasswordLoginService" namespace="cymapgt\core\application\authentication\UserCredential\services" name="UserCredentialPasswordLoginService" abstract="false" final="false" start="23" end="249">
  <file path="/home/rhossis/NetBeansProjects/cymapgt/core/application/authentication/UserCredential/src/services" file="UserCredentialPasswordLoginService.php" realpath="/home/rhossis/NetBeansProjects/cymapgt/core/application/authentication/UserCredential/src/services/UserCredentialPasswordLoginService.php" size="7770" time="2015-07-18T02:42:32+03:00" unixtime="1437176552" sha1="5a4d365495f9d75908c51dd545286ce438fa145b" relative="services/UserCredentialPasswordLoginService.php"/>
  <docblock>
    <description compact="UserCredentialPasswordLoginService This service creates password hashes using the BCRYPT cipher"/>
    <category/>
    <package value="cymapgt.core.application.authentication.UserCredential.services"/>
    <copyright value="Copyright (c) 2014 Cymap"/>
    <author value="Cyril Ogana &lt;cogana@gmail.com&gt;"/>
    <abstract>The objectives of the service are
 - Create password hash
 - Verify password for log in authentication
 @TODO provide ability to use AES to encrypt the hash</abstract>
  </docblock>
  <implements full="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="UserCredentialAuthenticationInterface"/>
  <member name="_usePasswordFlag" type="{unknown}" default="true" visibility="private" line="26"/>
  <member name="_multiFactorFlag" type="{unknown}" default="false" visibility="private" line="27"/>
  <member name="_inputPassword" type="string" default="''" visibility="private" line="30"/>
  <member name="_currentUsername" type="string" default="''" visibility="private" line="31"/>
  <member name="_currentPassword" type="string" default="''" visibility="private" line="32"/>
  <member name="_multiFactorHandler" type="{unknown}" default="null" visibility="private" line="35"/>
  <member name="_multiFactorStages" type="array" visibility="private" line="36"/>
  <constructor name="__construct" start="39" end="41" abstract="false" final="false" static="false" visibility="public"/>
  <method name="setUsePassword" start="52" end="55" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setUserPassword() - Specify whether the method uses password                              (set e.g. user log in, lDAP, 2 FACTOR (step 1) Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13"/>
      <param description="- if true, is using password" type="object" variable="$flag">
        <type full="cymapgt\core\application\authentication\UserCredential\services\bool" namespace="cymapgt\core\application\authentication\UserCredential\services" name="bool"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="flag" byreference="false" type="{unknown}"/>
  </method>
  <method name="getUsePassword" start="66" end="68" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getUsePassword() - Return the use password flag">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <return type="object">
        <type full="cymapgt\core\application\authentication\UserCredential\services\bool" namespace="cymapgt\core\application\authentication\UserCredential\services" name="bool"/>
      </return>
      <access value="public"/>
    </docblock>
  </method>
  <method name="setPassword" start="79" end="81" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setPassword() - Set the user password, and hash it">Cyril Ogana &lt;cogana@gmail.com&gt;- 2014-02-13</description>
      <param description="- the user password in raw text" type="object" variable="$password">
        <type full="cymapgt\core\application\authentication\UserCredential\services\bool" namespace="cymapgt\core\application\authentication\UserCredential\services" name="bool"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="password" byreference="false" type="{unknown}"/>
  </method>
  <method name="getPassword" start="94" end="100" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getPassword()  - Return the hashed user password">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="flag if true, return unhashed" variable="$unhashed" type="object">
        <type full="cymapgt\core\application\authentication\UserCredential\services\-" namespace="cymapgt\core\application\authentication\UserCredential\services" name="-"/>
      </param>
      <return description="- the hashed password" type="mixed"/>
      <access value="public"/>
    </docblock>
    <parameter name="unhashed" byreference="false" type="{unknown}" default="false"/>
  </method>
  <method name="setMultiFactor" start="111" end="113" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setMultiFactor($flag) - Set whether this service uses multi factor auth">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- if true, is a multi factor auth service" type="object" variable="$flag">
        <type full="cymapgt\core\application\authentication\UserCredential\services\bool" namespace="cymapgt\core\application\authentication\UserCredential\services" name="bool"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="flag" byreference="false" type="{unknown}"/>
  </method>
  <method name="setMultiFactorHandler" start="126" end="128" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setMultiFactorHandler - Provide namespace of the multi factor handler service,                                  which has to implement the interface                                  cymapgt\core\application\authentication\abstractclass\UserCredentialAuthenticationMultiFactorInterface">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- The namespace of the multi factor handler service" type="string" variable="$handler"/>
      <access value="public"/>
    </docblock>
    <parameter name="handler" byreference="false" type="{unknown}"/>
  </method>
  <method name="getMultiFactorHandler" start="140" end="142" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getMultiFactorHandler - Return an instance of the multi factor handler service                                  to use ofr this authentication session">Cyril Ogana &lt;cogana@gmail.com &gt; - 2014-02-13</description>
      <return type="object"/>
      <access value="public"/>
    </docblock>
  </method>
  <method name="setMultiFactorStages" start="154" end="156" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setMultiFactorStages - in an array, configure the steps of the multifactor login, passing                                 numeric stage names, types and handler calls">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- The stages of the log in session" type="object" variable="$stages">
        <type full="cymapgt\core\application\authentication\UserCredential\services\Array" namespace="cymapgt\core\application\authentication\UserCredential\services" name="Array"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="stages" byreference="false" type="array"/>
  </method>
  <method name="getMultiFactorStages" start="167" end="169" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getMultiFactorStages - return the multi factor stages array">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <return type="array"/>
      <access value="public"/>
    </docblock>
  </method>
  <method name="initialize" start="178" end="185" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function initialize() - initialize the service, bootstrap before any processing">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <access value="public"/>
    </docblock>
  </method>
  <method name="authenticate" start="194" end="196" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function authenticate() - authenticate the user after initialization">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <access value="public"/>
    </docblock>
  </method>
  <method name="setCurrentUsername" start="207" end="209" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setCurrentUsername($username) - set the current username">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- The current username" type="string" variable="$username"/>
      <access value="public"/>
    </docblock>
    <parameter name="username" byreference="false" type="{unknown}"/>
  </method>
  <method name="getCurrentUsername" start="220" end="222" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getCurrentUsername() - get the current username">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-14</description>
      <return description="- Return the current username" type="string"/>
      <access value="public"/>
    </docblock>
  </method>
  <method name="setCurrentPassword" start="233" end="235" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setCurrentPassword() - set the current password">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-14</description>
      <param description="- The current password hash" type="mixed" variable="$password"/>
      <access value="public"/>
    </docblock>
    <parameter name="password" byreference="false" type="{unknown}"/>
  </method>
  <method name="getCurrentPassword" start="246" end="248" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getCurrentPassword() - return the current password (hashed)">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-14</description>
      <return description="- The hashed password" type="mixed"/>
      <access value="public"/>
    </docblock>
  </method>
  <interface full="cymapgt\core\application\authentication\UserCredential\abstractclass\UserCredentialAuthenticationInterface" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="UserCredentialAuthenticationInterface">
    <method name="setUsePassword" start="31" end="31" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setUsePassword() - Specify whether the method uses password                              (set e.g. user log in, lDAP, 2 FACTOR (step 1) Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13"/>
      <param description="- if true, is using password" type="object" variable="$flag">
        <type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="flag" byreference="false" type="{unknown}"/>
  </method>
    <method name="getUsePassword" start="42" end="42" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getUsePassword() - Return the use password flag">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <return type="object">
        <type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
      </return>
      <access value="public"/>
    </docblock>
  </method>
    <method name="setPassword" start="53" end="53" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setPassword() - Set the user password, and hash it">Cyril Ogana &lt;cogana@gmail.com&gt;- 2014-02-13</description>
      <param description="- the user password in raw text" type="object" variable="$password">
        <type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="password" byreference="false" type="{unknown}"/>
  </method>
    <method name="getPassword" start="66" end="66" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getPassword()  - Return the hashed user password">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="if true, return unhashed" variable="$unhashed" type="object">
        <type full="cymapgt\core\application\authentication\UserCredential\abstractclass\-" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="-"/>
      </param>
      <return description="- the hashed password" type="mixed"/>
      <access value="public"/>
    </docblock>
    <parameter name="unhashed" byreference="false" type="{unknown}" default="false"/>
  </method>
    <method name="setMultiFactor" start="77" end="77" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setMultiFactor($flag) - Set whether this service uses multi factor auth">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- if true, is a multi factor auth service" type="object" variable="$flag">
        <type full="cymapgt\core\application\authentication\UserCredential\abstractclass\bool" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="bool"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="flag" byreference="false" type="{unknown}"/>
  </method>
    <method name="setMultiFactorHandler" start="90" end="90" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setMultiFactorHandler - Provide namespace of the multi factor handler service,                                  which has to implement the interface                                  cymapgt\core\application\authentication\abstractclass\UserCredentialAuthenticationMultiFactorInterface">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- The namespace of the multi factor handler service" type="string" variable="$handler"/>
      <access value="public"/>
    </docblock>
    <parameter name="handler" byreference="false" type="{unknown}"/>
  </method>
    <method name="getMultiFactorHandler" start="102" end="102" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getMultiFactorHandler - Return an instance of the multi factor handler service                                  to use ofr this authentication session">Cyril Ogana &lt;cogana@gmail.com &gt; - 2014-02-13</description>
      <return type="object"/>
      <access value="public"/>
    </docblock>
  </method>
    <method name="setMultiFactorStages" start="114" end="114" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setMultiFactorStages - in an array, configure the steps of the multifactor login, passing                                 numeric stage names, types and handler calls">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- The stages of the log in session" type="object" variable="$stages">
        <type full="cymapgt\core\application\authentication\UserCredential\abstractclass\Array" namespace="cymapgt\core\application\authentication\UserCredential\abstractclass" name="Array"/>
      </param>
      <access value="public"/>
    </docblock>
    <parameter name="stages" byreference="false" type="array"/>
  </method>
    <method name="getMultiFactorStages" start="125" end="125" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getMultiFactorStages - return the multi factor stages array">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <return type="array"/>
      <access value="public"/>
    </docblock>
  </method>
    <method name="initialize" start="134" end="134" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function initialize() - initialize the service, bootstrap before any processing">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <access value="public"/>
    </docblock>
  </method>
    <method name="authenticate" start="143" end="143" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function authenticate() - authenticate the user after initialization">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <access value="public"/>
    </docblock>
  </method>
    <method name="setCurrentUsername" start="154" end="154" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setCurrentUsername($username) - set the current username">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-13</description>
      <param description="- The current username" type="string" variable="$username"/>
      <access value="public"/>
    </docblock>
    <parameter name="username" byreference="false" type="{unknown}"/>
  </method>
    <method name="getCurrentUsername" start="165" end="165" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getCurrentUsername() - get the current username">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-14</description>
      <return description="- Return the current username" type="string"/>
      <access value="public"/>
    </docblock>
  </method>
    <method name="setCurrentPassword" start="176" end="176" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function setCurrentPassword() - set the current password">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-14</description>
      <param description="- The current password hash" type="mixed" variable="$password"/>
      <access value="public"/>
    </docblock>
    <parameter name="password" byreference="false" type="{unknown}"/>
  </method>
    <method name="getCurrentPassword" start="187" end="187" abstract="false" final="false" static="false" visibility="public">
    <docblock>
      <description compact="function getCurrentPassword() - return the current password (hashed)">Cyril Ogana &lt;cogana@gmail.com&gt; - 2014-02-14</description>
      <return description="- The hashed password" type="mixed"/>
      <access value="public"/>
    </docblock>
  </method>
  </interface>
</class>