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

Public Member Functions

 __construct ($user, $service, $method)
 
 getMethodName ()
 
 getServiceName ()
 
 getUserName ()
 
 serialize (\fpoirotte\Pssht\Wire\Encoder $encoder)
 

Static Public Member Functions

static getMessageId ()
 
static unserialize (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Static Protected Member Functions

static unserializeSub (\fpoirotte\Pssht\Wire\Decoder $decoder)
 

Protected Attributes

 $method
 Authentication method.
 
 $service
 Service to start after authentication.
 
 $user
 User being authenticated.
 

Detailed Description

Abstract SSH_MSG_USERAUTH_REQUEST message (RFC 4252).

Definition at line 19 of file Base.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::__construct (   $user,
  $service,
  $method 
)

Construct a new user authentication request.

Parameters
string$userUser to authenticate as.
string$serviceService to run after authentication.
string$methodAuthentication method to use.

Definition at line 42 of file Base.php.

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

Member Function Documentation

static fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::getMessageId ( )
static
fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::getMethodName ( )

Authentication method to use.

Return values
stringAuthentication method to use.

Definition at line 136 of file Base.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$method.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::getServiceName ( )

Return the name of the service to start after authentication.

Return values
stringService to start after authentication.

Definition at line 125 of file Base.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$service.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::getUserName ( )

Return the name of the user requesting authentication.

Return values
stringUser requesting authentication.

Definition at line 113 of file Base.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$user.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::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 64 of file Base.php.

static fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::unserialize ( \fpoirotte\Pssht\Wire\Decoder  $decoder)
staticfinal

Unserialize some data into a message.

Parameters
fpoirotte::Pssht::Wire::Decoder$decoderDecoder to use to perform unserialization.
Return values
MessageInterfaceUnserialized message.

Implements fpoirotte\Pssht\Messages\MessageInterface.

Definition at line 93 of file Base.php.

static fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base::unserializeSub ( \fpoirotte\Pssht\Wire\Decoder  $decoder)
staticprotected

Unserialize the sub-message.

Parameters
fpoirotte::Pssht::Wire::Decoder$decoderDecoder to use during unserialization.
Return values
arrayArray of unserialized data forming the sub-message.
Note
This method MUST be redefined by subclasses. The default implementation simply throws an exception.

(PHPMD.UnusedFormalParameter)

Definition at line 88 of file Base.php.


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