octoleo/phpseclib
1
0
Fork 0
mirror of https://github.com/phpseclib/phpseclib.git synced 2024-06-01 08:00:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'phpdoc-master'

Browse Source 
Conflicts:
	phpseclib/Crypt/Base.php
	phpseclib/Crypt/DES.php
	phpseclib/Crypt/Rijndael.php
This commit is contained in:
terrafrost 2015-10-13 09:31:21 -05:00
commit 0e0bdf6210
16 changed files with 372 additions and 385 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
phpseclib/Crypt/AES.php
View File

@ -11,13 +11,13 @@
* just a wrapper to Rijndael.php you may consider using Rijndael.php instead of
* to save one include_once().
*
* If {@link \phpseclib\Crypt\AES::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
* {@link \phpseclib\Crypt\AES::setKey() setKey()}. ie. if the key is 128-bits, the key length will be 128-bits. If it's 136-bits
* it'll be null-padded to 192-bits and 192 bits will be the key length until {@link \phpseclib\Crypt\AES::setKey() setKey()}
* If {@link self::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
* {@link self::setKey() setKey()}. ie. if the key is 128-bits, the key length will be 128-bits. If it's 136-bits
* it'll be null-padded to 192-bits and 192 bits will be the key length until {@link self::setKey() setKey()}
* is called, again, at which point, it'll be recalculated.
*
* Since \phpseclib\Crypt\AES extends \phpseclib\Crypt\Rijndael, some functions are available to be called that, in the context of AES, don't
* make a whole lot of sense. {@link \phpseclib\Crypt\AES::setBlockLength() setBlockLength()}, for instance. Calling that function,
* make a whole lot of sense. {@link self::setBlockLength() setBlockLength()}, for instance. Calling that function,
* however possible, won't do anything (AES has a fixed block length whereas Rijndael has a variable one).
*
* Here's a short example of how to use this library:

156
phpseclib/Crypt/Base.php
View File

@ -120,7 +120,7 @@ abstract class Base
/**
* The Encryption Mode
*
* @see \phpseclib\Crypt\Base::__construct()
* @see self::__construct()
* @var int
* @access private
*/
@ -137,7 +137,7 @@ abstract class Base
/**
* The Key
*
* @see \phpseclib\Crypt\Base::setKey()
* @see self::setKey()
* @var string
* @access private
*/
@ -146,7 +146,7 @@ abstract class Base
/**
* The Initialization Vector
*
* @see \phpseclib\Crypt\Base::setIV()
* @see self::setIV()
* @var string
* @access private
*/
@ -155,8 +155,8 @@ abstract class Base
/**
* A "sliding" Initialization Vector
*
* @see \phpseclib\Crypt\Base::enableContinuousBuffer()
* @see \phpseclib\Crypt\Base::_clearBuffers()
* @see self::enableContinuousBuffer()
* @see self::_clearBuffers()
* @var string
* @access private
*/
@ -165,8 +165,8 @@ abstract class Base
/**
* A "sliding" Initialization Vector
*
* @see \phpseclib\Crypt\Base::enableContinuousBuffer()
* @see \phpseclib\Crypt\Base::_clearBuffers()
* @see self::enableContinuousBuffer()
* @see self::_clearBuffers()
* @var string
* @access private
*/
@ -175,7 +175,7 @@ abstract class Base
/**
* Continuous Buffer status
*
* @see \phpseclib\Crypt\Base::enableContinuousBuffer()
* @see self::enableContinuousBuffer()
* @var bool
* @access private
*/
@ -184,8 +184,8 @@ abstract class Base
/**
* Encryption buffer for CTR, OFB and CFB modes
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::_clearBuffers()
* @see self::encrypt()
* @see self::_clearBuffers()
* @var array
* @access private
*/
@ -194,8 +194,8 @@ abstract class Base
/**
* Decryption buffer for CTR, OFB and CFB modes
*
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\Base::_clearBuffers()
* @see self::decrypt()
* @see self::_clearBuffers()
* @var array
* @access private
*/
@ -207,7 +207,7 @@ abstract class Base
* The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
* Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see self::encrypt()
* @var resource
* @access private
*/
@ -219,7 +219,7 @@ abstract class Base
* The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
* Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
*
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::decrypt()
* @var resource
* @access private
*/
@ -256,9 +256,9 @@ abstract class Base
* use a separate ECB-mode mcrypt resource.
*
* @link http://phpseclib.sourceforge.net/cfb-demo.phps
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\Base::_setupMcrypt()
* @see self::encrypt()
* @see self::decrypt()
* @see self::_setupMcrypt()
* @var resource
* @access private
*/
@ -280,7 +280,7 @@ abstract class Base
* which, typically, depends on the complexity
* on its internaly Key-expanding algorithm.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see self::encrypt()
* @var int
* @access private
*/
@ -289,9 +289,9 @@ abstract class Base
/**
* Does internal cipher state need to be (re)initialized?
*
* @see setKey()
* @see setIV()
* @see disableContinuousBuffer()
* @see self::setKey()
* @see self::setIV()
* @see self::disableContinuousBuffer()
* @var bool
* @access private
*/
@ -300,7 +300,7 @@ abstract class Base
/**
* Padding status
*
* @see \phpseclib\Crypt\Base::enablePadding()
* @see self::enablePadding()
* @var bool
* @access private
*/
@ -309,7 +309,7 @@ abstract class Base
/**
* Is the mode one that is paddable?
*
* @see \phpseclib\Crypt\Base::__construct()
* @see self::__construct()
* @var bool
* @access private
*/
@ -324,9 +324,9 @@ abstract class Base
* - self::ENGINE_MCRYPT (fast, php-extension: mcrypt, extension_loaded('mcrypt') required)
* - self::ENGINE_INTERNAL (slower, pure php-engine, no php-extension required)
*
* @see \phpseclib\Crypt\Base::_setEngine()
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::_setEngine()
* @see self::encrypt()
* @see self::decrypt()
* @var int
* @access private
*/
@ -335,8 +335,8 @@ abstract class Base
/**
* Holds the preferred crypt engine
*
* @see \phpseclib\Crypt\Base::_setEngine()
* @see \phpseclib\Crypt\Base::setPreferredEngine()
* @see self::_setEngine()
* @see self::setPreferredEngine()
* @var int
* @access private
*/
@ -349,7 +349,7 @@ abstract class Base
*
* @link http://www.php.net/mcrypt_module_open
* @link http://www.php.net/mcrypt_list_algorithms
* @see \phpseclib\Crypt\Base::_setupMcrypt()
* @see self::_setupMcrypt()
* @var string
* @access private
*/
@ -358,7 +358,7 @@ abstract class Base
/**
* The openssl specific name of the cipher
*
* Only used if $engine == CRYPT_ENGINE_OPENSSL
* Only used if $engine == self::ENGINE_OPENSSL
*
* @link http://www.php.net/openssl-get-cipher-methods
* @var string
@ -381,7 +381,7 @@ abstract class Base
/**
* The default salt used by setPassword()
*
* @see \phpseclib\Crypt\Base::setPassword()
* @see self::setPassword()
* @var string
* @access private
*/
@ -393,10 +393,10 @@ abstract class Base
* Used by encrypt() / decrypt()
* only if $engine == self::ENGINE_INTERNAL
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @see \phpseclib\Crypt\Base::$use_inline_crypt
* @see self::encrypt()
* @see self::decrypt()
* @see self::_setupInlineCrypt()
* @see self::$use_inline_crypt
* @var Callback
* @access private
*/
@ -405,9 +405,9 @@ abstract class Base
/**
* Holds whether performance-optimized $inline_crypt() can/should be used.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\Base::inline_crypt
* @see self::encrypt()
* @see self::decrypt()
* @see self::inline_crypt
* @var mixed
* @access private
*/
@ -416,7 +416,7 @@ abstract class Base
/**
* If OpenSSL can be used in ECB but not in CTR we can emulate CTR
*
* @see \phpseclib\Crypt\Base::_openssl_ctr_process()
* @see self::_openssl_ctr_process()
* @var bool
* @access private
*/
@ -425,7 +425,7 @@ abstract class Base
/**
* Determines what options are passed to openssl_encrypt/decrypt
*
* @see \phpseclib\Crypt\Base::isValidEngine()
* @see self::isValidEngine()
* @var mixed
* @access private
*/
@ -466,8 +466,6 @@ abstract class Base
*
* - self::MODE_OFB
*
* (or the alias constants of the chosen cipher, for example for AES: CRYPT_AES_MODE_ECB or CRYPT_AES_MODE_CBC ...)
*
* If not explicitly set, self::MODE_CBC will be used.
*
* @param int $mode
@ -685,7 +683,7 @@ abstract class Base
* strlen($plaintext) will still need to be a multiple of the block size, however, arbitrary values can be added to make it that
* length.
*
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::decrypt()
* @access public
* @param string $plaintext
* @return string $ciphertext
@ -983,7 +981,7 @@ abstract class Base
* If strlen($ciphertext) is not a multiple of the block size, null bytes will be added to the end of the string until
* it is.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see self::encrypt()
* @access public
* @param string $ciphertext
* @return string $plaintext
@ -1270,12 +1268,12 @@ abstract class Base
* OpenSSL CTR Processor
*
* PHP's OpenSSL bindings do not operate in continuous mode so we'll wrap around it. Since the keystream
* for CTR is the same for both encrypting and decrypting this function is re-used by both Crypt_Base::encrypt()
* and Crypt_Base::decrypt(). Also, OpenSSL doesn't implement CTR for all of it's symmetric ciphers so this
* for CTR is the same for both encrypting and decrypting this function is re-used by both Base::encrypt()
* and Base::decrypt(). Also, OpenSSL doesn't implement CTR for all of it's symmetric ciphers so this
* function will emulate CTR with ECB when necesary.
*
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @see self::encrypt()
* @see self::decrypt()
* @param string $plaintext
* @param string $encryptIV
* @param array $buffer
@ -1365,11 +1363,11 @@ abstract class Base
* OpenSSL OFB Processor
*
* PHP's OpenSSL bindings do not operate in continuous mode so we'll wrap around it. Since the keystream
* for OFB is the same for both encrypting and decrypting this function is re-used by both Crypt_Base::encrypt()
* and Crypt_Base::decrypt().
* for OFB is the same for both encrypting and decrypting this function is re-used by both Base::encrypt()
* and Base::decrypt().
*
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @see self::encrypt()
* @see self::decrypt()
* @param string $plaintext
* @param string $encryptIV
* @param array $buffer
@ -1450,7 +1448,7 @@ abstract class Base
* away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is
* transmitted separately)
*
* @see \phpseclib\Crypt\Base::disablePadding()
* @see self::disablePadding()
* @access public
*/
function enablePadding()
@ -1461,7 +1459,7 @@ abstract class Base
/**
* Do not pad packets.
*
* @see \phpseclib\Crypt\Base::enablePadding()
* @see self::enablePadding()
* @access public
*/
function disablePadding()
@ -1503,7 +1501,7 @@ abstract class Base
* continuous buffers not be used. They do offer better security and are, in fact, sometimes required (SSH uses them),
* however, they are also less intuitive and more likely to cause you problems.
*
* @see \phpseclib\Crypt\Base::disableContinuousBuffer()
* @see self::disableContinuousBuffer()
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
@ -1523,7 +1521,7 @@ abstract class Base
*
* The default behavior.
*
* @see \phpseclib\Crypt\Base::enableContinuousBuffer()
* @see self::enableContinuousBuffer()
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
@ -1545,7 +1543,7 @@ abstract class Base
/**
* Test for engine validity
*
* @see \phpseclib\Crypt\Base::Crypt_Base()
* @see self::__construct()
* @param int $engine
* @access public
* @return bool
@ -1612,7 +1610,7 @@ abstract class Base
*
* If the preferred crypt engine is not available the fastest available one will be used
*
* @see \phpseclib\Crypt\Base::Crypt_Base()
* @see self::__construct()
* @param int $engine
* @access public
*/
@ -1634,7 +1632,7 @@ abstract class Base
/**
* Returns the engine currently being utilized
*
* @see \phpseclib\Crypt\Base::_setEngine()
* @see self::_setEngine()
* @access public
*/
function getEngine()
@ -1645,7 +1643,7 @@ abstract class Base
/**
* Sets the engine as appropriate
*
* @see \phpseclib\Crypt\Base::Crypt_Base()
* @see self::__construct()
* @access private
*/
function _setEngine()
@ -1713,7 +1711,7 @@ abstract class Base
*
* Note: Must extend by the child \phpseclib\Crypt\* class
*
* @see \phpseclib\Crypt\Base::_setup()
* @see self::_setup()
* @access private
*/
abstract function _setupKey();
@ -1735,9 +1733,9 @@ abstract class Base
*
* - First run of encrypt() / decrypt() with no init-settings
*
* @see setKey()
* @see setIV()
* @see disableContinuousBuffer()
* @see self::setKey()
* @see self::setIV()
* @see self::disableContinuousBuffer()
* @access private
* @internal _setup() is always called before en/decryption.
* @internal Could, but not must, extend by the child Crypt_* class
@ -1769,9 +1767,9 @@ abstract class Base
*
* - First run of encrypt() / decrypt()
*
* @see setKey()
* @see setIV()
* @see disableContinuousBuffer()
* @see self::setKey()
* @see self::setIV()
* @see self::disableContinuousBuffer()
* @access private
* @internal Could, but not must, extend by the child Crypt_* class
*/
@ -1816,7 +1814,7 @@ abstract class Base
* If padding is disabled and $text is not a multiple of the blocksize, the string will be padded regardless
* and padding will, hence forth, be enabled.
*
* @see \phpseclib\Crypt\Base::_unpad()
* @see self::_unpad()
* @param string $text
* @throws \LengthException if padding is disabled and the plaintext's length is not a multiple of the block size
* @access private
@ -1845,7 +1843,7 @@ abstract class Base
* If padding is enabled and the reported padding length is invalid the encryption key will be assumed to be wrong
* and false will be returned.
*
* @see \phpseclib\Crypt\Base::_pad()
* @see self::_pad()
* @param string $text
* @throws \LengthException if the ciphertext's length is not a multiple of the block size
* @access private
@ -1926,8 +1924,8 @@ abstract class Base
/**
* Increment the current string
*
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\Base::encrypt()
* @see self::decrypt()
* @see self::encrypt()
* @param string $var
* @access private
*/
@ -2013,10 +2011,10 @@ abstract class Base
* - The callback function should not use the 'return' statement, but en/decrypt'ing the content of $in only
*
*
* @see \phpseclib\Crypt\Base::_setup()
* @see \phpseclib\Crypt\Base::_createInlineCryptFunction()
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::_setup()
* @see self::_createInlineCryptFunction()
* @see self::encrypt()
* @see self::decrypt()
* @access private
* @internal If a Crypt_* class providing inline crypting it must extend _setupInlineCrypt()
*/
@ -2135,9 +2133,9 @@ abstract class Base
* );
* </code>
*
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::_setupInlineCrypt()
* @see self::encrypt()
* @see self::decrypt()
* @param array $cipher_code
* @access private
* @return string (the name of the created callback function)
@ -2518,7 +2516,7 @@ abstract class Base
/**
* Generates a digest from $bytes
*
* @see _setupInlineCrypt()
* @see self::_setupInlineCrypt()
* @access private
* @param $bytes
* @return string

2
phpseclib/Crypt/Blowfish.php
View File

@ -467,7 +467,7 @@ class Blowfish extends Base
$lambda_functions =& self::_getLambdaFunctions();
// We create max. 10 hi-optimized code for memory reason. Means: For each $key one ultra fast inline-crypt function.
// (Currently, for Crypt_Blowfish, one generated $lambda_function cost on php5.5@32bit ~100kb unfreeable mem and ~180kb on php5.5@64bit)
// (Currently, for Blowfish, one generated $lambda_function cost on php5.5@32bit ~100kb unfreeable mem and ~180kb on php5.5@64bit)
// After that, we'll still create very fast optimized code but not the hi-ultimative code, for each $mode one.
$gen_hi_opt_code = (bool)(count($lambda_functions) < 10);

24
phpseclib/Crypt/DES.php
View File

@ -124,8 +124,8 @@ class DES extends Base
*
* Used only if $engine == self::ENGINE_INTERNAL
*
* @see \phpseclib\Crypt\DES::_setupKey()
* @see \phpseclib\Crypt\DES::_processBlock()
* @see self::_setupKey()
* @see self::_processBlock()
* @var int
* @access private
*/
@ -134,7 +134,7 @@ class DES extends Base
/**
* max possible size of $key
*
* @see \phpseclib\Crypt\DES::setKey()
* @see self::setKey()
* @var string
* @access private
*/
@ -143,7 +143,7 @@ class DES extends Base
/**
* The Key Schedule
*
* @see \phpseclib\Crypt\DES::_setupKey()
* @see self::_setupKey()
* @var array
* @access private
*/
@ -156,8 +156,8 @@ class DES extends Base
* with each byte containing all bits in the same state as the
* corresponding bit in the index value.
*
* @see \phpseclib\Crypt\DES::_processBlock()
* @see \phpseclib\Crypt\DES::_setupKey()
* @see self::_processBlock()
* @see self::_setupKey()
* @var array
* @access private
*/
@ -634,7 +634,7 @@ class DES extends Base
*
* @see \phpseclib\Crypt\Base::_encryptBlock()
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\DES::encrypt()
* @see self::encrypt()
* @access private
* @param string $in
* @return string
@ -649,7 +649,7 @@ class DES extends Base
*
* @see \phpseclib\Crypt\Base::_decryptBlock()
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\DES::decrypt()
* @see self::decrypt()
* @access private
* @param string $in
* @return string
@ -666,8 +666,8 @@ class DES extends Base
* {@link http://en.wikipedia.org/wiki/Image:Feistel.png Feistel.png} to get a general
* idea of what this function does.
*
* @see \phpseclib\Crypt\DES::_encryptBlock()
* @see \phpseclib\Crypt\DES::_decryptBlock()
* @see self::_encryptBlock()
* @see self::_decryptBlock()
* @access private
* @param string $block
* @param int $mode
@ -1299,8 +1299,8 @@ class DES extends Base
$des_rounds = $this->des_rounds;
// We create max. 10 hi-optimized code for memory reason. Means: For each $key one ultra fast inline-crypt function.
// (Currently, for Crypt_DES, one generated $lambda_function cost on php5.5@32bit ~135kb unfreeable mem and ~230kb on php5.5@64bit)
// (Currently, for Crypt_TripleDES, one generated $lambda_function cost on php5.5@32bit ~240kb unfreeable mem and ~340kb on php5.5@64bit)
// (Currently, for DES, one generated $lambda_function cost on php5.5@32bit ~135kb unfreeable mem and ~230kb on php5.5@64bit)
// (Currently, for TripleDES, one generated $lambda_function cost on php5.5@32bit ~240kb unfreeable mem and ~340kb on php5.5@64bit)
// After that, we'll still create very fast optimized code but not the hi-ultimative code, for each $mode one
$gen_hi_opt_code = (bool)( count($lambda_functions) < 10 );

13
phpseclib/Crypt/Hash.php
View File

@ -5,9 +5,8 @@
* such as sha256-96. Any hash algorithm returned by hash_algos() (and
* truncated versions thereof) are supported.
*
* If {@link \phpseclib\Crypt\Hash::setKey() setKey()} is called,
* {@link \phpseclib\Crypt\Hash::hash() hash()} will return the HMAC as opposed
* to the hash.
* If {@link self::setKey() setKey()} is called, {@link self::hash() hash()} will
* return the HMAC as opposed to the hash.
*
* Here's a short example of how to use this library:
* <code>
@ -47,7 +46,7 @@ class Hash
/**
* Hash Parameter
*
* @see \phpseclib\Crypt\Hash::setHash()
* @see self::setHash()
* @var int
* @access private
*/
@ -56,7 +55,7 @@ class Hash
/**
* Byte-length of hash output (Internal HMAC)
*
* @see \phpseclib\Crypt\Hash::setHash()
* @see self::setHash()
* @var int
* @access private
*/
@ -65,7 +64,7 @@ class Hash
/**
* Hash Algorithm
*
* @see \phpseclib\Crypt\Hash::setHash()
* @see self::setHash()
* @var string
* @access private
*/
@ -74,7 +73,7 @@ class Hash
/**
* Key
*
* @see \phpseclib\Crypt\Hash::setKey()
* @see self::setKey()
* @var string
* @access private
*/

26
phpseclib/Crypt/RC2.php
View File

@ -58,7 +58,7 @@ class RC2 extends Base
* The Key
*
* @see \phpseclib\Crypt\Base::key
* @see setKey()
* @see self::setKey()
* @var string
* @access private
*/
@ -68,9 +68,9 @@ class RC2 extends Base
* The Original (unpadded) Key
*
* @see \phpseclib\Crypt\Base::key
* @see setKey()
* @see encrypt()
* @see decrypt()
* @see self::setKey()
* @see self::encrypt()
* @see self::decrypt()
* @var string
* @access private
*/
@ -115,8 +115,8 @@ class RC2 extends Base
/**
* The key length in bits.
*
* @see \phpseclib\Crypt\RC2::setKeyLength()
* @see \phpseclib\Crypt\RC2::setKey()
* @see self::setKeyLength()
* @see self::setKey()
* @var int
* @access private
* @internal Should be in range [1..1024].
@ -127,8 +127,8 @@ class RC2 extends Base
/**
* The key length in bits.
*
* @see \phpseclib\Crypt\RC2::isValidEnine()
* @see \phpseclib\Crypt\RC2::setKey()
* @see self::isValidEnine()
* @see self::setKey()
* @var int
* @access private
* @internal Should be in range [1..1024].
@ -138,7 +138,7 @@ class RC2 extends Base
/**
* The Key Schedule
*
* @see \phpseclib\Crypt\RC2::_setupKey()
* @see self::_setupKey()
* @var array
* @access private
*/
@ -148,7 +148,7 @@ class RC2 extends Base
* Key expansion randomization table.
* Twice the same 256-value sequence to save a modulus in key expansion.
*
* @see \phpseclib\Crypt\RC2::setKey()
* @see self::setKey()
* @var array
* @access private
*/
@ -222,7 +222,7 @@ class RC2 extends Base
/**
* Inverse key expansion randomization table.
*
* @see \phpseclib\Crypt\RC2::setKey()
* @see self::setKey()
* @var array
* @access private
*/
@ -377,7 +377,7 @@ class RC2 extends Base
*
* Mostly a wrapper for \phpseclib\Crypt\Base::encrypt, with some additional OpenSSL handling code
*
* @see decrypt()
* @see self::decrypt()
* @access public
* @param string $plaintext
* @return string $ciphertext
@ -400,7 +400,7 @@ class RC2 extends Base
*
* Mostly a wrapper for \phpseclib\Crypt\Base::decrypt, with some additional OpenSSL handling code
*
* @see encrypt()
* @see self::encrypt()
* @access public
* @param string $ciphertext
* @return string $plaintext

14
phpseclib/Crypt/RC4.php
View File

@ -105,7 +105,7 @@ class RC4 extends Base
/**
* The Key
*
* @see \phpseclib\Crypt\RC4::setKey()
* @see self::setKey()
* @var string
* @access private
*/
@ -114,7 +114,7 @@ class RC4 extends Base
/**
* The Key Stream for decryption and encryption
*
* @see \phpseclib\Crypt\RC4::setKey()
* @see self::setKey()
* @var array
* @access private
*/
@ -182,7 +182,7 @@ class RC4 extends Base
* {@link http://en.wikipedia.org/wiki/Related_key_attack http://en.wikipedia.org/wiki/Related_key_attack}
*
* @param string $iv
* @see \phpseclib\Crypt\RC4::setKey()
* @see self::setKey()
* @access public
*/
function setIV($iv)
@ -214,7 +214,7 @@ class RC4 extends Base
* Encrypts a message.
*
* @see \phpseclib\Crypt\Base::decrypt()
* @see \phpseclib\Crypt\RC4::_crypt()
* @see self::_crypt()
* @access public
* @param string $plaintext
* @return string $ciphertext
@ -234,7 +234,7 @@ class RC4 extends Base
* At least if the continuous buffer is disabled.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\RC4::_crypt()
* @see self::_crypt()
* @access public
* @param string $ciphertext
* @return string $plaintext
@ -299,8 +299,8 @@ class RC4 extends Base
/**
* Encrypts or decrypts a message.
*
* @see \phpseclib\Crypt\RC4::encrypt()
* @see \phpseclib\Crypt\RC4::decrypt()
* @see self::encrypt()
* @see self::decrypt()
* @access private
* @param string $text
* @param int $mode

64
phpseclib/Crypt/RSA.php
View File

@ -71,8 +71,8 @@ class RSA
{
/**#@+
* @access public
* @see \phpseclib\Crypt\RSA::encrypt()
* @see \phpseclib\Crypt\RSA::decrypt()
* @see self::encrypt()
* @see self::decrypt()
*/
/**
* Use {@link http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding Optimal Asymmetric Encryption Padding}
@ -80,8 +80,8 @@ class RSA
*
* Uses sha1 by default.
*
* @see \phpseclib\Crypt\RSA::setHash()
* @see \phpseclib\Crypt\RSA::setMGFHash()
* @see self::setHash()
* @see self::setMGFHash()
*/
const ENCRYPTION_OAEP = 1;
/**
@ -102,17 +102,17 @@ class RSA
/**#@+
* @access public
* @see \phpseclib\Crypt\RSA::sign()
* @see \phpseclib\Crypt\RSA::verify()
* @see \phpseclib\Crypt\RSA::setHash()
* @see self::sign()
* @see self::verify()
* @see self::setHash()
*/
/**
* Use the Probabilistic Signature Scheme for signing
*
* Uses sha1 by default.
*
* @see \phpseclib\Crypt\RSA::setSaltLength()
* @see \phpseclib\Crypt\RSA::setMGFHash()
* @see self::setSaltLength()
* @see self::setMGFHash()
*/
const SIGNATURE_PSS = 1;
/**
@ -415,7 +415,7 @@ class RSA
* For use with parsing XML formatted keys. PHP's XML Parser functions use utilized - instead of PHP's DOM functions -
* because PHP's XML Parser functions work on PHP4 whereas PHP's DOM functions - although surperior - don't.
*
* @see \phpseclib\Crypt\RSA::_start_element_handler()
* @see self::_start_element_handler()
* @var array
* @access private
*/
@ -426,8 +426,8 @@ class RSA
*
* For use with parsing XML formatted keys.
*
* @see \phpseclib\Crypt\RSA::_character_handler()
* @see \phpseclib\Crypt\RSA::_stop_element_handler()
* @see self::_character_handler()
* @see self::_stop_element_handler()
* @var mixed
* @access private
*/
@ -438,7 +438,7 @@ class RSA
*
* Set to null to use system configuration file.
*
* @see \phpseclib\Crypt\RSA::createKey()
* @see self::createKey()
* @var mixed
* @access public
*/
@ -742,7 +742,7 @@ class RSA
* Convert a private key to the appropriate format.
*
* @access private
* @see setPrivateKeyFormat()
* @see self::setPrivateKeyFormat()
* @param string $RSAPrivateKey
* @return string
*/
@ -971,7 +971,7 @@ class RSA
* Convert a public key to the appropriate format
*
* @access private
* @see setPublicKeyFormat()
* @see self::setPublicKeyFormat()
* @param string $RSAPrivateKey
* @return string
*/
@ -1049,8 +1049,8 @@ class RSA
* Break a public or private key down into its constituant components
*
* @access private
* @see _convertPublicKey()
* @see _convertPrivateKey()
* @see self::_convertPublicKey()
* @see self::_convertPrivateKey()
* @param string $key
* @param int $type
* @return array
@ -1649,8 +1649,8 @@ class RSA
* Private keys can be encrypted with a password. To unset the password, pass in the empty string or false.
* Or rather, pass in $password such that empty($password) && !is_string($password) is true.
*
* @see createKey()
* @see load()
* @see self::createKey()
* @see self::loadKey()
* @access public
* @param string $password
*/
@ -1674,7 +1674,7 @@ class RSA
*
* Returns true on success, false on failure
*
* @see getPublicKey()
* @see self::getPublicKey()
* @access public
* @param string $key optional
* @param int $type optional
@ -1734,7 +1734,7 @@ class RSA
*
* Returns true on success, false on failure
*
* @see getPublicKey()
* @see self::getPublicKey()
* @access public
* @param string $key optional
* @param int $type optional
@ -1765,7 +1765,7 @@ class RSA
* or if the public key was set via setPublicKey(). If the currently loaded key is supposed to be the public key this
* function won't return it since this library, for the most part, doesn't distinguish between public and private keys.
*
* @see getPublicKey()
* @see self::getPublicKey()
* @access public
* @param string $key
* @param int $type optional
@ -1793,6 +1793,7 @@ class RSA
* @access public
* @param string $algorithm The hashing algorithm to be used. Valid options are 'md5' and 'sha256'. False is returned
* for invalid values.
* @return mixed
*/
public function getPublicKeyFingerprint($algorithm = 'md5')
{
@ -1822,10 +1823,11 @@ class RSA
*
* The private key is only returned if the currently loaded key contains the constituent prime numbers.
*
* @see getPublicKey()
* @see self::getPublicKey()
* @access public
* @param string $key
* @param int $type optional
* @return mixed
*/
function getPrivateKey($type = self::PUBLIC_FORMAT_PKCS1)
{
@ -1846,7 +1848,7 @@ class RSA
* Returns the private key without the prime number constituants. Structurally identical to a public key that
* hasn't been set as the public key
*
* @see getPrivateKey()
* @see self::getPrivateKey()
* @access private
* @param string $key
* @param int $type optional
@ -1868,6 +1870,7 @@ class RSA
* __toString() magic method
*
* @access public
* @return string
*/
function __toString()
{
@ -1883,6 +1886,7 @@ class RSA
* __clone() magic method
*
* @access public
* @return Crypt_RSA
*/
function __clone()
{
@ -1978,7 +1982,7 @@ class RSA
/**
* Determines the private key format
*
* @see createKey()
* @see self::createKey()
* @access public
* @param int $format
*/
@ -1990,7 +1994,7 @@ class RSA
/**
* Determines the public key format
*
* @see createKey()
* @see self::createKey()
* @access public
* @param int $format
*/
@ -2897,7 +2901,7 @@ class RSA
* If $plaintext exceeds those limits it will be broken up so that it does and the resultant ciphertext's will
* be concatenated together.
*
* @see decrypt()
* @see self::decrypt()
* @access public
* @param string $plaintext
* @return string
@ -2943,7 +2947,7 @@ class RSA
/**
* Decryption
*
* @see encrypt()
* @see self::encrypt()
* @access public
* @param string $plaintext
* @return string
@ -2985,7 +2989,7 @@ class RSA
/**
* Create a signature
*
* @see verify()
* @see self::verify()
* @access public
* @param string $message
* @return string
@ -3008,7 +3012,7 @@ class RSA
/**
* Verifies a signature
*
* @see sign()
* @see self::sign()
* @access public
* @param string $message
* @param string $signature

32
phpseclib/Crypt/Rijndael.php
View File

@ -7,11 +7,11 @@
*
* PHP version 5
*
* If {@link \phpseclib\Crypt\Rijndael::setBlockLength() setBlockLength()} isn't called, it'll be assumed to be 128 bits. If
* {@link \phpseclib\Crypt\Rijndael::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
* {@link \phpseclib\Crypt\Rijndael::setKey() setKey()}. ie. if the key is 128-bits, the key length will be 128-bits. If it's
* If {@link self::setBlockLength() setBlockLength()} isn't called, it'll be assumed to be 128 bits. If
* {@link self::setKeyLength() setKeyLength()} isn't called, it'll be calculated from
* {@link self::setKey() setKey()}. ie. if the key is 128-bits, the key length will be 128-bits. If it's
* 136-bits it'll be null-padded to 192-bits and 192 bits will be the key length until
* {@link \phpseclib\Crypt\Rijndael::setKey() setKey()} is called, again, at which point, it'll be recalculated.
* {@link self::setKey() setKey()} is called, again, at which point, it'll be recalculated.
*
* Not all Rijndael implementations may support 160-bits or 224-bits as the block length / key length. mcrypt, for example,
* does not. AES, itself, only supports block lengths of 128 and key lengths of 128, 192, and 256.
@ -75,7 +75,7 @@ class Rijndael extends Base
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @see \phpseclib\Crypt\Base::engine
* @see isValidEngine()
* @see self::isValidEngine()
* @var string
* @access private
*/
@ -94,7 +94,7 @@ class Rijndael extends Base
/**
* The Key Schedule
*
* @see _setup()
* @see self::_setup()
* @var array
* @access private
*/
@ -103,7 +103,7 @@ class Rijndael extends Base
/**
* The Inverse Key Schedule
*
* @see _setup()
* @see self::_setup()
* @var array
* @access private
*/
@ -112,7 +112,7 @@ class Rijndael extends Base
/**
* The Block Length divided by 32
*
* @see setBlockLength()
* @see self::setBlockLength()
* @var int
* @access private
* @internal The max value is 256 / 32 = 8, the min value is 128 / 32 = 4. Exists in conjunction with $block_size
@ -125,7 +125,7 @@ class Rijndael extends Base
/**
* The Key Length (in bytes)
*
* @see setKeyLength()
* @see self::setKeyLength()
* @var int
* @access private
* @internal The max value is 256 / 8 = 32, the min value is 128 / 8 = 16. Exists in conjunction with $Nk
@ -138,7 +138,7 @@ class Rijndael extends Base
/**
* The Key Length divided by 32
*
* @see setKeyLength()
* @see self::setKeyLength()
* @var int
* @access private
* @internal The max value is 256 / 32 = 8, the min value is 128 / 32 = 4
@ -592,9 +592,9 @@ class Rijndael extends Base
/**
* Provides the mixColumns and sboxes tables
*
* @see \phpseclib\Crypt\Rijndael:_encryptBlock()
* @see \phpseclib\Crypt\Rijndael:_setupInlineCrypt()
* @see \phpseclib\Crypt\Rijndael:_subWord()
* @see self::_encryptBlock()
* @see self::_setupInlineCrypt()
* @see self::_subWord()
* @access private
* @return array &$tables
*/
@ -681,9 +681,9 @@ class Rijndael extends Base
/**
* Provides the inverse mixColumns and inverse sboxes tables
*
* @see \phpseclib\Crypt\Rijndael:_decryptBlock()
* @see \phpseclib\Crypt\Rijndael:_setupInlineCrypt()
* @see \phpseclib\Crypt\Rijndael:_setupKey()
* @see self::_decryptBlock()
* @see self::_setupInlineCrypt()
* @see self::_setupKey()
* @access private
* @return array &$tables
*/

7
phpseclib/Crypt/TripleDES.php
View File

@ -48,7 +48,6 @@ use phpseclib\Crypt\DES;
*/
class TripleDES extends DES
{
/**
* Encrypt / decrypt using inner chaining
*
@ -104,7 +103,7 @@ class TripleDES extends DES
/**
* max possible size of $key
*
* @see \phpseclib\Crypt\TripleDES::setKey()
* @see self::setKey()
* @see \phpseclib\Crypt\DES::setKey()
* @var string
* @access private
@ -375,7 +374,7 @@ class TripleDES extends DES
* however, they are also less intuitive and more likely to cause you problems.
*
* @see \phpseclib\Crypt\Base::enableContinuousBuffer()
* @see \phpseclib\Crypt\TripleDES::disableContinuousBuffer()
* @see self::disableContinuousBuffer()
* @access public
*/
function enableContinuousBuffer()
@ -394,7 +393,7 @@ class TripleDES extends DES
* The default behavior.
*
* @see \phpseclib\Crypt\Base::disableContinuousBuffer()
* @see \phpseclib\Crypt\TripleDES::enableContinuousBuffer()
* @see self::enableContinuousBuffer()
* @access public
*/
function disableContinuousBuffer()

6
phpseclib/File/ASN1.php
View File

@ -124,8 +124,8 @@ class ASN1
*
* @var array
* @access private
* @see \phpseclib\File\ASN1::setTimeFormat()
* @see \phpseclib\File\ASN1::asn1map()
* @see self::setTimeFormat()
* @see self::asn1map()
* @link http://php.net/class.datetime
*/
var $encoded;
@ -137,7 +137,7 @@ class ASN1
*
* @var array
* @access private
* @see \phpseclib\File\ASN1::_encode_der()
* @see self::_encode_der()
*/
var $filters;

69
phpseclib/Math/BigInteger.php
View File

@ -199,17 +199,10 @@ class BigInteger
*/
var $is_negative = false;
/**
* Random number generator function
*
* @access private
*/
var $generator = 'mt_rand';
/**
* Precision
*
* @see setPrecision()
* @see self::setPrecision()
* @access private
*/
var $precision = -1;
@ -217,7 +210,7 @@ class BigInteger
/**
* Precision Bitmask
*
* @see setPrecision()
* @see self::setPrecision()
* @access private
*/
var $bitmask = false;
@ -229,8 +222,8 @@ class BigInteger
* a variable that'll be serializable regardless of whether or not extensions are being used. Unlike $this->value,
* however, $this->hex is only calculated when $this->__sleep() is called.
*
* @see __sleep()
* @see __wakeup()
* @see self::__sleep()
* @see self::__wakeup()
* @var string
* @access private
*/
@ -729,7 +722,7 @@ class BigInteger
* {@link http://php.net/language.oop5.basic#51624}
*
* @access public
* @see __clone()
* @see self::__clone()
* @return \phpseclib\Math\BigInteger
*/
function copy()
@ -737,7 +730,6 @@ class BigInteger
$temp = new static();
$temp->value = $this->value;
$temp->is_negative = $this->is_negative;
$temp->generator = $this->generator;
$temp->precision = $this->precision;
$temp->bitmask = $this->bitmask;
return $temp;
@ -766,7 +758,7 @@ class BigInteger
* PHP5, call BigInteger::copy(), instead.
*
* @access public
* @see copy()
* @see self::copy()
* @return \phpseclib\Math\BigInteger
*/
function __clone()
@ -779,16 +771,13 @@ class BigInteger
*
* Will be called, automatically, when serialize() is called on a BigInteger object.
*
* @see __wakeup()
* @see self::__wakeup()
* @access public
*/
function __sleep()
{
$this->hex = $this->toHex(true);
$vars = array('hex');
if ($this->generator != 'mt_rand') {
$vars[] = 'generator';
}
if ($this->precision > 0) {
$vars[] = 'precision';
}
@ -800,7 +789,7 @@ class BigInteger
*
* Will be called, automatically, when unserialize() is called on a BigInteger object.
*
* @see __sleep()
* @see self::__sleep()
* @access public
*/
function __wakeup()
@ -1856,7 +1845,7 @@ class BigInteger
*
* For most $modes this will return the remainder.
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
@ -1893,7 +1882,7 @@ class BigInteger
/**
* Modular reduction preperation
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
@ -1911,7 +1900,7 @@ class BigInteger
/**
* Modular multiply
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $y
@ -1931,7 +1920,7 @@ class BigInteger
/**
* Modular square
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
@ -1952,7 +1941,7 @@ class BigInteger
* Calculates $x%$n, where $n = 2**$e, for some $e. Since this is basically the same as doing $x & ($n-1),
* we'll just use this function as a wrapper for doing that.
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param \phpseclib\Math\BigInteger
* @return \phpseclib\Math\BigInteger
@ -1982,7 +1971,7 @@ class BigInteger
* (x >> 1) + (x >> 1) != x / 2 + x / 2. If x is even, they're the same, but if x is odd, they're not. See the in-line
* comments for details.
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param array $n
* @param array $m
@ -2079,7 +2068,7 @@ class BigInteger
* For numbers with more than four digits BigInteger::_barrett() is faster. The difference between that and this
* is that this function does not fold the denominator into a smaller form.
*
* @see _slidingWindow()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
@ -2150,7 +2139,7 @@ class BigInteger
*
* If you're going to be doing array_slice($product->value, 0, $stop), some cycles can be saved.
*
* @see _regularBarrett()
* @see self::_regularBarrett()
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
@ -2231,8 +2220,8 @@ class BigInteger
* improved upon (basically, by using the comba method). gcd($n, 2) must be equal to one for this function
* to work correctly.
*
* @see _prepMontgomery()
* @see _slidingWindow()
* @see self::_prepMontgomery()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
@ -2278,8 +2267,8 @@ class BigInteger
* Interleaves the montgomery reduction and long multiplication algorithms together as described in
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=13 HAC 14.36}
*
* @see _prepMontgomery()
* @see _montgomery()
* @see self::_prepMontgomery()
* @see self::_montgomery()
* @access private
* @param array $x
* @param array $y
@ -2330,8 +2319,8 @@ class BigInteger
/**
* Prepare a number for use in Montgomery Modular Reductions
*
* @see _montgomery()
* @see _slidingWindow()
* @see self::_montgomery()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
@ -2369,7 +2358,7 @@ class BigInteger
*
* Thanks to Pedro Gimeno Fortea for input!
*
* @see _montgomery()
* @see self::_montgomery()
* @access private
* @param array $x
* @return int
@ -2650,7 +2639,7 @@ class BigInteger
* @param \phpseclib\Math\BigInteger $y
* @return int < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @access public
* @see equals()
* @see self::equals()
* @internal Could return $this->subtract($x), but that's not as fast as what we do do.
*/
function compare($y)
@ -2673,7 +2662,7 @@ class BigInteger
* @param array $y_value
* @param bool $y_negative
* @return int
* @see compare()
* @see self::compare()
* @access private
*/
function _compare($x_value, $x_negative, $y_value, $y_negative)
@ -2709,7 +2698,7 @@ class BigInteger
* @param \phpseclib\Math\BigInteger $x
* @return bool
* @access public
* @see compare()
* @see self::compare()
*/
function equals($x)
{
@ -3259,7 +3248,7 @@ class BigInteger
*
* If the current number is odd it'll be unchanged. If it's even, one will be added to it.
*
* @see randomPrime()
* @see self::randomPrime()
* @access private
*/
function _make_odd()
@ -3509,7 +3498,7 @@ class BigInteger
*
* @param \phpseclib\Math\BigInteger
* @return \phpseclib\Math\BigInteger
* @see _trim()
* @see self::_trim()
* @access private
*/
function _normalize($result)
@ -3689,7 +3678,7 @@ class BigInteger
*
* The ability to DER-encode integers is needed to create RSA public keys for use with OpenSSL
*
* @see modPow()
* @see self::modPow()
* @access private
* @param int $length
* @return string

52
phpseclib/Net/SFTP.php
View File

@ -91,7 +91,7 @@ class SFTP extends SSH2
/**
* Packet Types
*
* @see \phpseclib\Net\SFTP::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -100,7 +100,7 @@ class SFTP extends SSH2
/**
* Status Codes
*
* @see \phpseclib\Net\SFTP::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -113,7 +113,7 @@ class SFTP extends SSH2
* concurrent actions, so it's somewhat academic, here.
*
* @var int
* @see \phpseclib\Net\SFTP::_send_sftp_packet()
* @see self::_send_sftp_packet()
* @access private
*/
var $request_id = false;
@ -125,7 +125,7 @@ class SFTP extends SSH2
* concurrent actions, so it's somewhat academic, here.
*
* @var int
* @see \phpseclib\Net\SFTP::_get_sftp_packet()
* @see self::_get_sftp_packet()
* @access private
*/
var $packet_type = -1;
@ -134,7 +134,7 @@ class SFTP extends SSH2
* Packet Buffer
*
* @var string
* @see \phpseclib\Net\SFTP::_get_sftp_packet()
* @see self::_get_sftp_packet()
* @access private
*/
var $packet_buffer = '';
@ -143,7 +143,7 @@ class SFTP extends SSH2
* Extensions supported by the server
*
* @var array
* @see \phpseclib\Net\SFTP::_initChannel()
* @see self::_initChannel()
* @access private
*/
var $extensions = array();
@ -152,7 +152,7 @@ class SFTP extends SSH2
* Server SFTP version
*
* @var int
* @see \phpseclib\Net\SFTP::_initChannel()
* @see self::_initChannel()
* @access private
*/
var $version;
@ -161,8 +161,8 @@ class SFTP extends SSH2
* Current working directory
*
* @var string
* @see \phpseclib\Net\SFTP::_realpath()
* @see \phpseclib\Net\SFTP::chdir()
* @see self::_realpath()
* @see self::chdir()
* @access private
*/
var $pwd = false;
@ -170,7 +170,7 @@ class SFTP extends SSH2
/**
* Packet Type Log
*
* @see \phpseclib\Net\SFTP::getLog()
* @see self::getLog()
* @var array
* @access private
*/
@ -179,7 +179,7 @@ class SFTP extends SSH2
/**
* Packet Log
*
* @see \phpseclib\Net\SFTP::getLog()
* @see self::getLog()
* @var array
* @access private
*/
@ -188,8 +188,8 @@ class SFTP extends SSH2
/**
* Error information
*
* @see \phpseclib\Net\SFTP::getSFTPErrors()
* @see \phpseclib\Net\SFTP::getLastSFTPError()
* @see self::getSFTPErrors()
* @see self::getLastSFTPError()
* @var string
* @access private
*/
@ -201,9 +201,9 @@ class SFTP extends SSH2
* Rather than always having to open a directory and close it immediately there after to see if a file is a directory
* we'll cache the results.
*
* @see \phpseclib\Net\SFTP::_update_stat_cache()
* @see \phpseclib\Net\SFTP::_remove_from_stat_cache()
* @see \phpseclib\Net\SFTP::_query_stat_cache()
* @see self::_update_stat_cache()
* @see self::_remove_from_stat_cache()
* @see self::_query_stat_cache()
* @var array
* @access private
*/
@ -212,8 +212,8 @@ class SFTP extends SSH2
/**
* Max SFTP Packet Size
*
* @see \phpseclib\Net\SFTP::__construct()
* @see \phpseclib\Net\SFTP::get()
* @see self::__construct()
* @see self::get()
* @var array
* @access private
*/
@ -222,8 +222,8 @@ class SFTP extends SSH2
/**
* Stat Cache Flag
*
* @see \phpseclib\Net\SFTP::disableStatCache()
* @see \phpseclib\Net\SFTP::enableStatCache()
* @see self::disableStatCache()
* @see self::enableStatCache()
* @var bool
* @access private
*/
@ -232,8 +232,8 @@ class SFTP extends SSH2
/**
* Sort Options
*
* @see \phpseclib\Net\SFTP::_comparator()
* @see \phpseclib\Net\SFTP::setListOrder()
* @see self::_comparator()
* @see self::setListOrder()
* @var array
* @access private
*/
@ -609,7 +609,7 @@ class SFTP extends SSH2
* SFTP doesn't provide a mechanism by which the current working directory can be changed, so we'll emulate it. Returns
* the absolute (canonicalized) path.
*
* @see \phpseclib\Net\SFTP::chdir()
* @see self::chdir()
* @param string $path
* @throws \UnexpectedValueException on receipt of unexpected packets
* @return mixed
@ -2658,8 +2658,8 @@ class SFTP extends SSH2
*
* @param int $type
* @param string $data
* @see \phpseclib\Net\SFTP::_get_sftp_packet()
* @see \phpseclib\Net\SSH2::_send_channel_packet()
* @see self::_get_sftp_packet()
* @see self::_send_channel_packet()
* @return bool
* @access private
*/
@ -2700,7 +2700,7 @@ class SFTP extends SSH2
* There can be one SSH_MSG_CHANNEL_DATA messages containing two SFTP packets or there can be two SSH_MSG_CHANNEL_DATA
* messages containing one SFTP packet.
*
* @see \phpseclib\Net\SFTP::_send_sftp_packet()
* @see self::_send_sftp_packet()
* @return string
* @access private
*/

80
phpseclib/Net/SSH1.php
View File

@ -261,7 +261,7 @@ class SSH1
*
* Logged for debug purposes
*
* @see \phpseclib\Net\SSH1::getServerKeyPublicExponent()
* @see self::getServerKeyPublicExponent()
* @var string
* @access private
*/
@ -272,7 +272,7 @@ class SSH1
*
* Logged for debug purposes
*
* @see \phpseclib\Net\SSH1::getServerKeyPublicModulus()
* @see self::getServerKeyPublicModulus()
* @var string
* @access private
*/
@ -283,7 +283,7 @@ class SSH1
*
* Logged for debug purposes
*
* @see \phpseclib\Net\SSH1::getHostKeyPublicExponent()
* @see self::getHostKeyPublicExponent()
* @var string
* @access private
*/
@ -294,7 +294,7 @@ class SSH1
*
* Logged for debug purposes
*
* @see \phpseclib\Net\SSH1::getHostKeyPublicModulus()
* @see self::getHostKeyPublicModulus()
* @var string
* @access private
*/
@ -305,7 +305,7 @@ class SSH1
*
* Logged for debug purposes
*
* @see \phpseclib\Net\SSH1::getSupportedCiphers()
* @see self::getSupportedCiphers()
* @var array
* @access private
*/
@ -324,7 +324,7 @@ class SSH1
*
* Logged for debug purposes
*
* @see \phpseclib\Net\SSH1::getSupportedAuthentications()
* @see self::getSupportedAuthentications()
* @var array
* @access private
*/
@ -338,7 +338,7 @@ class SSH1
/**
* Server Identification
*
* @see \phpseclib\Net\SSH1::getServerIdentification()
* @see self::getServerIdentification()
* @var string
* @access private
*/
@ -347,7 +347,7 @@ class SSH1
/**
* Protocol Flags
*
* @see \phpseclib\Net\SSH1::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -356,7 +356,7 @@ class SSH1
/**
* Protocol Flag Log
*
* @see \phpseclib\Net\SSH1::getLog()
* @see self::getLog()
* @var array
* @access private
*/
@ -365,7 +365,7 @@ class SSH1
/**
* Message Log
*
* @see \phpseclib\Net\SSH1::getLog()
* @see self::getLog()
* @var array
* @access private
*/
@ -374,7 +374,7 @@ class SSH1
/**
* Real-time log file pointer
*
* @see \phpseclib\Net\SSH1::_append_log()
* @see self::_append_log()
* @var resource
* @access private
*/
@ -383,7 +383,7 @@ class SSH1
/**
* Real-time log file size
*
* @see \phpseclib\Net\SSH1::_append_log()
* @see self::_append_log()
* @var int
* @access private
*/
@ -392,7 +392,7 @@ class SSH1
/**
* Real-time log file wrap boolean
*
* @see \phpseclib\Net\SSH1::_append_log()
* @see self::_append_log()
* @var bool
* @access private
*/
@ -401,7 +401,7 @@ class SSH1
/**
* Interactive Buffer
*
* @see \phpseclib\Net\SSH1::read()
* @see self::read()
* @var array
* @access private
*/
@ -410,7 +410,7 @@ class SSH1
/**
* Timeout
*
* @see \phpseclib\Net\SSH1::setTimeout()
* @see self::setTimeout()
* @access private
*/
var $timeout;
@ -418,7 +418,7 @@ class SSH1
/**
* Current Timeout
*
* @see \phpseclib\Net\SSH1::_get_channel_packet()
* @see self::_get_channel_packet()
* @access private
*/
var $curTimeout;
@ -426,7 +426,7 @@ class SSH1
/**
* Log Boundary
*
* @see \phpseclib\Net\SSH1::_format_log
* @see self::_format_log()
* @access private
*/
var $log_boundary = ':';
@ -434,7 +434,7 @@ class SSH1
/**
* Log Long Width
*
* @see \phpseclib\Net\SSH1::_format_log
* @see self::_format_log()
* @access private
*/
var $log_long_width = 65;
@ -442,7 +442,7 @@ class SSH1
/**
* Log Short Width
*
* @see \phpseclib\Net\SSH1::_format_log
* @see self::_format_log()
* @access private
*/
var $log_short_width = 16;
@ -450,8 +450,8 @@ class SSH1
/**
* Hostname
*
* @see \phpseclib\Net\SSH1::__construct()
* @see \phpseclib\Net\SSH1::_connect()
* @see self::__construct()
* @see self::_connect()
* @var string
* @access private
*/
@ -460,8 +460,8 @@ class SSH1
/**
* Port Number
*
* @see \phpseclib\Net\SSH1::__construct()
* @see \phpseclib\Net\SSH1::_connect()
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
@ -475,8 +475,8 @@ class SSH1
* however, is non-optional. There will be a timeout, whether or not you set it. If you don't it'll be
* 10 seconds. It is used by fsockopen() in that function.
*
* @see \phpseclib\Net\SSH1::__construct()
* @see \phpseclib\Net\SSH1::_connect()
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
@ -485,8 +485,8 @@ class SSH1
/**
* Default cipher
*
* @see \phpseclib\Net\SSH1::__construct()
* @see \phpseclib\Net\SSH1::_connect()
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
@ -782,8 +782,8 @@ class SSH1
*
* Returns false on failure and the output, otherwise.
*
* @see \phpseclib\Net\SSH1::interactiveRead()
* @see \phpseclib\Net\SSH1::interactiveWrite()
* @see self::interactiveRead()
* @see self::interactiveWrite()
* @param string $cmd
* @return mixed
* @throws \RuntimeException on error sending command
@ -831,8 +831,8 @@ class SSH1
/**
* Creates an interactive shell
*
* @see \phpseclib\Net\SSH1::interactiveRead()
* @see \phpseclib\Net\SSH1::interactiveWrite()
* @see self::interactiveRead()
* @see self::interactiveWrite()
* @return bool
* @throws \UnexpectedValueException on receipt of unexpected packets
* @throws \RuntimeException on other errors
@ -874,7 +874,7 @@ class SSH1
/**
* Inputs a command into an interactive shell.
*
* @see \phpseclib\Net\SSH1::interactiveWrite()
* @see self::interactiveWrite()
* @param string $cmd
* @return bool
* @access public
@ -890,7 +890,7 @@ class SSH1
* $expect can take the form of a string literal or, if $mode == self::READ__REGEX,
* a regular expression.
*
* @see \phpseclib\Net\SSH1::write()
* @see self::write()
* @param string $expect
* @param int $mode
* @return bool
@ -929,7 +929,7 @@ class SSH1
/**
* Inputs a command into an interactive shell.
*
* @see \phpseclib\Net\SSH1::interactiveRead()
* @see self::interactiveRead()
* @param string $cmd
* @return bool
* @throws \RuntimeException on connection error
@ -963,7 +963,7 @@ class SSH1
* does not support ANSI escape sequences in Win32 Console applications", so if you're a Windows user,
* there's not going to be much recourse.
*
* @see \phpseclib\Net\SSH1::interactiveRead()
* @see self::interactiveRead()
* @return string
* @throws \RuntimeException on connection error
* @access public
@ -1051,7 +1051,7 @@ class SSH1
* Also, this function could be improved upon by adding detection for the following exploit:
* http://www.securiteam.com/securitynews/5LP042K3FY.html
*
* @see \phpseclib\Net\SSH1::_send_binary_packet()
* @see self::_send_binary_packet()
* @return array
* @access private
*/
@ -1127,7 +1127,7 @@ class SSH1
*
* Returns true on success, false on failure.
*
* @see \phpseclib\Net\SSH1::_get_binary_packet()
* @see self::_get_binary_packet()
* @param string $data
* @return bool
* @access private
@ -1174,8 +1174,8 @@ class SSH1
* we've reimplemented it. A more detailed discussion of the differences can be found after
* $crc_lookup_table's initialization.
*
* @see \phpseclib\Net\SSH1::_get_binary_packet()
* @see \phpseclib\Net\SSH1::_send_binary_packet()
* @see self::_get_binary_packet()
* @see self::_send_binary_packet()
* @param string $data
* @return int
* @access private
@ -1291,7 +1291,7 @@ class SSH1
* should be a number with the property that gcd($e, ($p - 1) * ($q - 1)) == 1. Could just make anything that
* calls this call modexp, instead, but I think this makes things clearer, maybe...
*
* @see \phpseclib\Net\SSH1::__construct()
* @see self::__construct()
* @param BigInteger $m
* @param array $key
* @return BigInteger

198
phpseclib/Net/SSH2.php
View File

@ -177,8 +177,8 @@ class SSH2
/**
* Error information
*
* @see \phpseclib\Net\SSH2::getErrors()
* @see \phpseclib\Net\SSH2::getLastError()
* @see self::getErrors()
* @see self::getLastError()
* @var string
* @access private
*/
@ -187,7 +187,7 @@ class SSH2
/**
* Server Identifier
*
* @see \phpseclib\Net\SSH2::getServerIdentification()
* @see self::getServerIdentification()
* @var array|false
* @access private
*/
@ -196,7 +196,7 @@ class SSH2
/**
* Key Exchange Algorithms
*
* @see \phpseclib\Net\SSH2::getKexAlgorithims()
* @see self::getKexAlgorithims()
* @var array|false
* @access private
*/
@ -205,7 +205,7 @@ class SSH2
/**
* Minimum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
*
* @see Net_SSH2::_key_exchange()
* @see self::_key_exchange()
* @var int
* @access private
*/
@ -214,7 +214,7 @@ class SSH2
/**
* Preferred Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
*
* @see Net_SSH2::_key_exchange()
* @see self::_key_exchange()
* @var int
* @access private
*/
@ -223,7 +223,7 @@ class SSH2
/**
* Maximum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
*
* @see Net_SSH2::_key_exchange()
* @see self::_key_exchange()
* @var int
* @access private
*/
@ -232,7 +232,7 @@ class SSH2
/**
* Server Host Key Algorithms
*
* @see \phpseclib\Net\SSH2::getServerHostKeyAlgorithms()
* @see self::getServerHostKeyAlgorithms()
* @var array|false
* @access private
*/
@ -241,7 +241,7 @@ class SSH2
/**
* Encryption Algorithms: Client to Server
*
* @see \phpseclib\Net\SSH2::getEncryptionAlgorithmsClient2Server()
* @see self::getEncryptionAlgorithmsClient2Server()
* @var array|false
* @access private
*/
@ -250,7 +250,7 @@ class SSH2
/**
* Encryption Algorithms: Server to Client
*
* @see \phpseclib\Net\SSH2::getEncryptionAlgorithmsServer2Client()
* @see self::getEncryptionAlgorithmsServer2Client()
* @var array|false
* @access private
*/
@ -259,7 +259,7 @@ class SSH2
/**
* MAC Algorithms: Client to Server
*
* @see \phpseclib\Net\SSH2::getMACAlgorithmsClient2Server()
* @see self::getMACAlgorithmsClient2Server()
* @var array|false
* @access private
*/
@ -268,7 +268,7 @@ class SSH2
/**
* MAC Algorithms: Server to Client
*
* @see \phpseclib\Net\SSH2::getMACAlgorithmsServer2Client()
* @see self::getMACAlgorithmsServer2Client()
* @var array|false
* @access private
*/
@ -277,7 +277,7 @@ class SSH2
/**
* Compression Algorithms: Client to Server
*
* @see \phpseclib\Net\SSH2::getCompressionAlgorithmsClient2Server()
* @see self::getCompressionAlgorithmsClient2Server()
* @var array|false
* @access private
*/
@ -286,7 +286,7 @@ class SSH2
/**
* Compression Algorithms: Server to Client
*
* @see \phpseclib\Net\SSH2::getCompressionAlgorithmsServer2Client()
* @see self::getCompressionAlgorithmsServer2Client()
* @var array|false
* @access private
*/
@ -295,7 +295,7 @@ class SSH2
/**
* Languages: Server to Client
*
* @see \phpseclib\Net\SSH2::getLanguagesServer2Client()
* @see self::getLanguagesServer2Client()
* @var array|false
* @access private
*/
@ -304,7 +304,7 @@ class SSH2
/**
* Languages: Client to Server
*
* @see \phpseclib\Net\SSH2::getLanguagesClient2Server()
* @see self::getLanguagesClient2Server()
* @var array|false
* @access private
*/
@ -320,8 +320,8 @@ class SSH2
*
* -- http://tools.ietf.org/html/rfc4253#section-6
*
* @see \phpseclib\Net\SSH2::__construct()
* @see \phpseclib\Net\SSH2::_send_binary_packet()
* @see self::__construct()
* @see self::_send_binary_packet()
* @var int
* @access private
*/
@ -330,8 +330,8 @@ class SSH2
/**
* Block Size for Client to Server Encryption
*
* @see \phpseclib\Net\SSH2::__construct()
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::__construct()
* @see self::_get_binary_packet()
* @var int
* @access private
*/
@ -340,7 +340,7 @@ class SSH2
/**
* Server to Client Encryption Object
*
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_get_binary_packet()
* @var object
* @access private
*/
@ -349,7 +349,7 @@ class SSH2
/**
* Client to Server Encryption Object
*
* @see \phpseclib\Net\SSH2::_send_binary_packet()
* @see self::_send_binary_packet()
* @var object
* @access private
*/
@ -358,7 +358,7 @@ class SSH2
/**
* Client to Server HMAC Object
*
* @see \phpseclib\Net\SSH2::_send_binary_packet()
* @see self::_send_binary_packet()
* @var object
* @access private
*/
@ -367,7 +367,7 @@ class SSH2
/**
* Server to Client HMAC Object
*
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_get_binary_packet()
* @var object
* @access private
*/
@ -380,7 +380,7 @@ class SSH2
* For the client to server side, the HMAC object will make the HMAC as long as it needs to be. All we need to do is
* append it.
*
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_get_binary_packet()
* @var int
* @access private
*/
@ -389,7 +389,7 @@ class SSH2
/**
* Server Public Host Key
*
* @see \phpseclib\Net\SSH2::getServerPublicHostKey()
* @see self::getServerPublicHostKey()
* @var string
* @access private
*/
@ -404,7 +404,7 @@ class SSH2
*
* -- http://tools.ietf.org/html/rfc4253#section-7.2
*
* @see \phpseclib\Net\SSH2::_key_exchange()
* @see self::_key_exchange()
* @var string
* @access private
*/
@ -415,7 +415,7 @@ class SSH2
*
* The current exchange hash
*
* @see \phpseclib\Net\SSH2::_key_exchange()
* @see self::_key_exchange()
* @var string
* @access private
*/
@ -424,7 +424,7 @@ class SSH2
/**
* Message Numbers
*
* @see \phpseclib\Net\SSH2::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -433,7 +433,7 @@ class SSH2
/**
* Disconnection Message 'reason codes' defined in RFC4253
*
* @see \phpseclib\Net\SSH2::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -442,7 +442,7 @@ class SSH2
/**
* SSH_MSG_CHANNEL_OPEN_FAILURE 'reason codes', defined in RFC4254
*
* @see \phpseclib\Net\SSH2::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -452,7 +452,7 @@ class SSH2
* Terminal Modes
*
* @link http://tools.ietf.org/html/rfc4254#section-8
* @see \phpseclib\Net\SSH2::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -462,7 +462,7 @@ class SSH2
* SSH_MSG_CHANNEL_EXTENDED_DATA's data_type_codes
*
* @link http://tools.ietf.org/html/rfc4254#section-5.2
* @see \phpseclib\Net\SSH2::__construct()
* @see self::__construct()
* @var array
* @access private
*/
@ -473,7 +473,7 @@ class SSH2
*
* See 'Section 6.4. Data Integrity' of rfc4253 for more info.
*
* @see \phpseclib\Net\SSH2::_send_binary_packet()
* @see self::_send_binary_packet()
* @var int
* @access private
*/
@ -484,7 +484,7 @@ class SSH2
*
* See 'Section 6.4. Data Integrity' of rfc4253 for more info.
*
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_get_binary_packet()
* @var int
* @access private
*/
@ -495,8 +495,8 @@ class SSH2
*
* Maps client channels to server channels
*
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @see \phpseclib\Net\SSH2::exec()
* @see self::_get_channel_packet()
* @see self::exec()
* @var array
* @access private
*/
@ -508,8 +508,8 @@ class SSH2
* If a client requests a packet from one channel but receives two packets from another those packets should
* be placed in a buffer
*
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @see \phpseclib\Net\SSH2::exec()
* @see self::_get_channel_packet()
* @see self::exec()
* @var array
* @access private
*/
@ -520,7 +520,7 @@ class SSH2
*
* Contains the type of the last sent message
*
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @see self::_get_channel_packet()
* @var array
* @access private
*/
@ -531,7 +531,7 @@ class SSH2
*
* Maximum packet size indexed by channel
*
* @see \phpseclib\Net\SSH2::_send_channel_packet()
* @see self::_send_channel_packet()
* @var array
* @access private
*/
@ -540,7 +540,7 @@ class SSH2
/**
* Message Number Log
*
* @see \phpseclib\Net\SSH2::getLog()
* @see self::getLog()
* @var array
* @access private
*/
@ -549,7 +549,7 @@ class SSH2
/**
* Message Log
*
* @see \phpseclib\Net\SSH2::getLog()
* @see self::getLog()
* @var array
* @access private
*/
@ -561,8 +561,8 @@ class SSH2
* Bytes the other party can send before it must wait for the window to be adjusted (0x7FFFFFFF = 2GB)
*
* @var int
* @see \phpseclib\Net\SSH2::_send_channel_packet()
* @see \phpseclib\Net\SSH2::exec()
* @see self::_send_channel_packet()
* @see self::exec()
* @access private
*/
var $window_size = 0x7FFFFFFF;
@ -572,7 +572,7 @@ class SSH2
*
* Window size indexed by channel
*
* @see \phpseclib\Net\SSH2::_send_channel_packet()
* @see self::_send_channel_packet()
* @var array
* @access private
*/
@ -583,7 +583,7 @@ class SSH2
*
* Window size indexed by channel
*
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @see self::_get_channel_packet()
* @var array
* @access private
*/
@ -594,7 +594,7 @@ class SSH2
*
* Verified against $this->session_id
*
* @see \phpseclib\Net\SSH2::getServerPublicHostKey()
* @see self::getServerPublicHostKey()
* @var string
* @access private
*/
@ -605,7 +605,7 @@ class SSH2
*
* ssh-rsa or ssh-dss.
*
* @see \phpseclib\Net\SSH2::getServerPublicHostKey()
* @see self::getServerPublicHostKey()
* @var string
* @access private
*/
@ -614,7 +614,7 @@ class SSH2
/**
* Interactive Buffer
*
* @see \phpseclib\Net\SSH2::read()
* @see self::read()
* @var array
* @access private
*/
@ -625,8 +625,8 @@ class SSH2
*
* Should never exceed self::LOG_MAX_SIZE
*
* @see \phpseclib\Net\SSH2::_send_binary_packet()
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_send_binary_packet()
* @see self::_get_binary_packet()
* @var int
* @access private
*/
@ -635,7 +635,7 @@ class SSH2
/**
* Timeout
*
* @see \phpseclib\Net\SSH2::setTimeout()
* @see self::setTimeout()
* @access private
*/
var $timeout;
@ -643,7 +643,7 @@ class SSH2
/**
* Current Timeout
*
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @see self::_get_channel_packet()
* @access private
*/
var $curTimeout;
@ -651,7 +651,7 @@ class SSH2
/**
* Real-time log file pointer
*
* @see \phpseclib\Net\SSH2::_append_log()
* @see self::_append_log()
* @var resource
* @access private
*/
@ -660,7 +660,7 @@ class SSH2
/**
* Real-time log file size
*
* @see \phpseclib\Net\SSH2::_append_log()
* @see self::_append_log()
* @var int
* @access private
*/
@ -669,7 +669,7 @@ class SSH2
/**
* Has the signature been validated?
*
* @see \phpseclib\Net\SSH2::getServerPublicHostKey()
* @see self::getServerPublicHostKey()
* @var bool
* @access private
*/
@ -678,7 +678,7 @@ class SSH2
/**
* Real-time log file wrap boolean
*
* @see \phpseclib\Net\SSH2::_append_log()
* @see self::_append_log()
* @access private
*/
var $realtime_log_wrap;
@ -686,7 +686,7 @@ class SSH2
/**
* Flag to suppress stderr from output
*
* @see \phpseclib\Net\SSH2::enableQuietMode()
* @see self::enableQuietMode()
* @access private
*/
var $quiet_mode = false;
@ -711,7 +711,7 @@ class SSH2
* Flag to request a PTY when using exec()
*
* @var bool
* @see \phpseclib\Net\SSH2::enablePTY()
* @see self::enablePTY()
* @access private
*/
var $request_pty = false;
@ -743,7 +743,7 @@ class SSH2
/**
* The Last Interactive Response
*
* @see \phpseclib\Net\SSH2::_keyboard_interactive_process()
* @see self::_keyboard_interactive_process()
* @var string
* @access private
*/
@ -752,7 +752,7 @@ class SSH2
/**
* Keyboard Interactive Request / Responses
*
* @see \phpseclib\Net\SSH2::_keyboard_interactive_process()
* @see self::_keyboard_interactive_process()
* @var array
* @access private
*/
@ -764,8 +764,8 @@ class SSH2
* Quoting from the RFC, "in some jurisdictions, sending a warning message before
* authentication may be relevant for getting legal protection."
*
* @see \phpseclib\Net\SSH2::_filter()
* @see \phpseclib\Net\SSH2::getBannerMessage()
* @see self::_filter()
* @see self::getBannerMessage()
* @var string
* @access private
*/
@ -774,7 +774,7 @@ class SSH2
/**
* Did read() timeout or return normally?
*
* @see \phpseclib\Net\SSH2::isTimeout()
* @see self::isTimeout()
* @var bool
* @access private
*/
@ -783,7 +783,7 @@ class SSH2
/**
* Log Boundary
*
* @see \phpseclib\Net\SSH2::_format_log()
* @see self::_format_log()
* @var string
* @access private
*/
@ -792,7 +792,7 @@ class SSH2
/**
* Log Long Width
*
* @see \phpseclib\Net\SSH2::_format_log()
* @see self::_format_log()
* @var int
* @access private
*/
@ -801,7 +801,7 @@ class SSH2
/**
* Log Short Width
*
* @see \phpseclib\Net\SSH2::_format_log()
* @see self::_format_log()
* @var int
* @access private
*/
@ -810,8 +810,8 @@ class SSH2
/**
* Hostname
*
* @see \phpseclib\Net\SSH2::__construct()
* @see \phpseclib\Net\SSH2::_connect()
* @see self::__construct()
* @see self::_connect()
* @var string
* @access private
*/
@ -820,8 +820,8 @@ class SSH2
/**
* Port Number
*
* @see \phpseclib\Net\SSH2::__construct()
* @see \phpseclib\Net\SSH2::_connect()
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
@ -830,9 +830,9 @@ class SSH2
/**
* Number of columns for terminal window size
*
* @see \phpseclib\Net\SSH2::getWindowColumns()
* @see \phpseclib\Net\SSH2::setWindowColumns()
* @see \phpseclib\Net\SSH2::setWindowSize()
* @see self::getWindowColumns()
* @see self::setWindowColumns()
* @see self::setWindowSize()
* @var int
* @access private
*/
@ -841,9 +841,9 @@ class SSH2
/**
* Number of columns for terminal window size
*
* @see \phpseclib\Net\SSH2::getWindowRows()
* @see \phpseclib\Net\SSH2::setWindowRows()
* @see \phpseclib\Net\SSH2::setWindowSize()
* @see self::getWindowRows()
* @see self::setWindowRows()
* @see self::setWindowSize()
* @var int
* @access private
*/
@ -852,8 +852,8 @@ class SSH2
/**
* Crypto Engine
*
* @see Net_SSH2::setCryptoEngine()
* @see Net_SSH2::_key_exchange()
* @see self::setCryptoEngine()
* @see self::_key_exchange()
* @var int
* @access private
*/
@ -883,7 +883,7 @@ class SSH2
* @param mixed $host
* @param int $port
* @param int $timeout
* @see \phpseclib\Net\SSH2::login()
* @see self::login()
* @return \phpseclib\Net\SSH2
* @access public
*/
@ -1852,7 +1852,7 @@ class SSH2
* @param mixed $password
* @param mixed $...
* @return bool
* @see _login
* @see self::_login()
* @access public
*/
function login($username)
@ -1868,7 +1868,7 @@ class SSH2
* @param mixed $password
* @param mixed $...
* @return bool
* @see _login_helper
* @see self::_login_helper()
* @access private
*/
function _login($username)
@ -2511,8 +2511,8 @@ class SSH2
/**
* Creates an interactive shell
*
* @see \phpseclib\Net\SSH2::read()
* @see \phpseclib\Net\SSH2::write()
* @see self::read()
* @see self::write()
* @return bool
* @throws \UnexpectedValueException on receipt of unexpected packets
* @throws \RuntimeException on other errors
@ -2616,8 +2616,8 @@ class SSH2
/**
* Return the channel to be used with read() / write()
*
* @see \phpseclib\Net\SSH2::read()
* @see \phpseclib\Net\SSH2::write()
* @see self::read()
* @see self::write()
* @return int
* @access public
*/
@ -2657,7 +2657,7 @@ class SSH2
* Returns when there's a match for $expect, which can take the form of a string literal or,
* if $mode == self::READ_REGEX, a regular expression.
*
* @see \phpseclib\Net\SSH2::write()
* @see self::write()
* @param string $expect
* @param int $mode
* @return string
@ -2702,7 +2702,7 @@ class SSH2
/**
* Inputs a command into an interactive shell.
*
* @see \phpseclib\Net\SSH2::read()
* @see self::read()
* @param string $cmd
* @return bool
* @throws \RuntimeException on connection error
@ -2730,7 +2730,7 @@ class SSH2
* returns that and then that that was passed into stopSubsystem() but that'll be saved for a future date and implemented
* if there's sufficient demand for such a feature.
*
* @see \phpseclib\Net\SSH2::stopSubsystem()
* @see self::stopSubsystem()
* @param string $subsystem
* @return bool
* @access public
@ -2793,7 +2793,7 @@ class SSH2
/**
* Stops a subsystem.
*
* @see \phpseclib\Net\SSH2::startSubsystem()
* @see self::startSubsystem()
* @return bool
* @access public
*/
@ -2871,7 +2871,7 @@ class SSH2
*
* See '6. Binary Packet Protocol' of rfc4253 for more info.
*
* @see \phpseclib\Net\SSH2::_send_binary_packet()
* @see self::_send_binary_packet()
* @return string
* @throws \RuntimeException on connection errors
* @access private
@ -2959,7 +2959,7 @@ class SSH2
*
* Because some binary packets need to be ignored...
*
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_get_binary_packet()
* @return string
* @access private
*/
@ -3108,9 +3108,8 @@ class SSH2
/**
* Returns whether Quiet Mode is enabled or not
*
* @see \phpseclib\Net\SSH2::enableQuietMode()
* @see \phpseclib\Net\SSH2::disableQuietMode()
*
* @see self::enableQuietMode()
* @see self::disableQuietMode()
* @access public
* @return bool
*/
@ -3142,9 +3141,8 @@ class SSH2
/**
* Returns whether request-pty is enabled or not
*
* @see \phpseclib\Net\SSH2::enablePTY()
* @see \phpseclib\Net\SSH2::disablePTY()
*
* @see self::enablePTY()
* @see self::disablePTY()
* @access public
* @return bool
*/
@ -3376,7 +3374,7 @@ class SSH2
*
* @param string $data
* @param string $logged
* @see \phpseclib\Net\SSH2::_get_binary_packet()
* @see self::_get_binary_packet()
* @return bool
* @access private
*/

6
phpseclib/System/SSH/Agent/Identity.php
View File

@ -38,7 +38,7 @@ class Identity
*
* @var \phpseclib\Crypt\RSA
* @access private
* @see \phpseclib\System\SSH\Agent\Identity::getPublicKey()
* @see self::getPublicKey()
*/
var $key;
@ -47,7 +47,7 @@ class Identity
*
* @var string
* @access private
* @see \phpseclib\System\SSH\Agent\Identity::sign()
* @see self::sign()
*/
var $key_blob;
@ -56,7 +56,7 @@ class Identity
*
* @var resource
* @access private
* @see \phpseclib\System\SSH\Agent\Identity::sign()
* @see self::sign()
*/
var $fsock;