pssht  latest
SSH server library written in PHP
fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password Class Reference
+ Inheritance diagram for fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password:

Public Member Functions

 __construct ($user, $service, $method, $password, $newPassword=null)
 
 getNewPassword ()
 
 getPassword ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 
- Public Member Functions inherited from fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base
 __construct ($user, $service, $method)
 
 getMethodName ()
 
 getServiceName ()
 
 getUserName ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 

Static Protected Member Functions

static unserializeSub (\fpoirotte\Pssht\Wire\Decoder $decoder)
 
- Static Protected Member Functions inherited from fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base
static unserializeSub (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Protected Attributes

 $newPassword
 New password.
 
 $password
 Password for the given login.
 
- Protected Attributes inherited from fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base
 $method
 Authentication method.
 
 $service
 Service to start after authentication.
 
 $user
 User being authenticated.
 

Additional Inherited Members

- Static Public Member Functions inherited from fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base
static getMessageId ()
 
static unserialize (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Detailed Description

SSH_MSG_USERAUTH_REQUEST message (RFC 4252) for the "password" method.

Definition at line 18 of file Password.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password::__construct (   $user,
  $service,
  $method,
  $password,
  $newPassword = null 
)

Construct a new user authentication request.

Parameters
string$userUser to authenticate as.
string$serviceService to run after authentication.
string$methodAuthentication method to use.
string$passwordPassword for the given user.
string$newPassword(optional) Set the new password for the user to this value after authentication.
Note
Pssht does not support password changing. Therefore, the last argument to this method is ignored when given.

Definition at line 42 of file Password.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$method, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password\$newPassword, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password\$password, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$service, and fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$user.

Member Function Documentation

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password::getNewPassword ( )

Set the user's password to this new password after authentication success.

Return values
stringNew password for the user.

Definition at line 96 of file Password.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password\$newPassword.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password::getPassword ( )

Get the password given for authentication purposes.

Return values
stringPassword associated with the given user.

Definition at line 84 of file Password.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password\$password.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Password::serialize ( \fpoirotte\Pssht\Wire\Encoder  $encoder)

Serialize the message.

Parameters
fpoirotte::Pssht::Wire::Encoder$encoderEncoder to use to perform serialization.
Return values
MessageInterfaceReturns this message.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 57 of file Password.php.


The documentation for this class was generated from the following file: