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

Public Member Functions

 __construct ($user, $service, $method, $algorithm, $key, $hostname, $remoteUser, $signature)
 
 getAlgorithm ()
 
 getHostname ()
 
 getKey ()
 
 getRemoteUser ()
 
 getSignature ()
 
 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

 $algorithm
 Public key algorithm in use (eg. "ssh-rsa" or "ssh-dss").
 
 $hostname
 Remote hostname.
 
 $key
 Key blob.
 
 $remoteUser
 Remote login.
 
 $signature
 Signature to prove key ownership.
 
- 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 "hostbased" method.

Definition at line 18 of file HostBased.php.

Constructor & Destructor Documentation

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased::__construct (   $user,
  $service,
  $method,
  $algorithm,
  $key,
  $hostname,
  $remoteUser,
  $signature 
)

Construct a new user authentication request.

Parameters
string$userUser to authenticate as.
string$serviceService to run after authentication.
string$methodAuthentication method to use.
string$algorithmPublic key algorithm to use.
string$keyKey blob.
string$hostnameHostname the user is connecting from.
string$remoteUserUser's login on the remote machine.
string$signatureSignature proving ownership of the key.

Definition at line 54 of file HostBased.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$algorithm, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$hostname, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$key, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$method, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$remoteUser, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$service, fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$signature, and fpoirotte\Pssht\Messages\USERAUTH\REQUEST\Base\$user.

Member Function Documentation

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased::getAlgorithm ( )

Get public key algorithm in use.

Return values
stringPublic key algorithm in use.

Definition at line 137 of file HostBased.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$algorithm.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased::getHostname ( )

Get the hostname of the remote machine the user is connecting from.

Return values
stringRemote hostname.

Definition at line 160 of file HostBased.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$hostname.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased::getKey ( )

Get the key blob.

Return values
stringKey blob.

Definition at line 148 of file HostBased.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$key.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased::getRemoteUser ( )

Get the login of the user on the remote machine.

Return values
stringRemote login.

Definition at line 171 of file HostBased.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$remoteUser.

fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased::getSignature ( )

Get the signature proving key ownership.

Return values
stringSignature proving key ownership.

Definition at line 182 of file HostBased.php.

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$signature.

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

References fpoirotte\Pssht\Messages\USERAUTH\REQUEST\HostBased\$algorithm.


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