octoleo/phpseclib
1
0
Fork 0
mirror of https://github.com/phpseclib/phpseclib.git synced 2024-11-05 21:17:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed lots of phpdoc typos

Browse Source
This commit is contained in:
Graham Campbell 2015-09-02 00:37:54 +01:00
parent 5890f3da98
commit cd0e10cf9d
22 changed files with 1255 additions and 1255 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
phpseclib/Crypt/AES.php
View File

@ -124,7 +124,7 @@ class Crypt_AES extends Crypt_Rijndael
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'AES';
@ -136,7 +136,7 @@ class Crypt_AES extends Crypt_Rijndael
*
* @see Crypt_Rijndael::setBlockLength()
* @access public
* @param Integer $length
* @param int $length
*/
function setBlockLength($length)
{
@ -151,7 +151,7 @@ class Crypt_AES extends Crypt_Rijndael
*
* @see Crypt_Rijndael:setKeyLength()
* @access public
* @param Integer $length
* @param int $length
*/
function setKeyLength($length)
{
@ -173,7 +173,7 @@ class Crypt_AES extends Crypt_Rijndael
* @see Crypt_Rijndael:setKey()
* @see setKeyLength()
* @access public
* @param String $key
* @param string $key
*/
function setKey($key)
{

136
phpseclib/Crypt/Base.php
View File

@ -128,7 +128,7 @@ class Crypt_Base
* The Encryption Mode
*
* @see Crypt_Base::Crypt_Base()
* @var Integer
* @var int
* @access private
*/
var $mode;
@ -136,7 +136,7 @@ class Crypt_Base
/**
* The Block Length of the block cipher
*
* @var Integer
* @var int
* @access private
*/
var $block_size = 16;
@ -145,7 +145,7 @@ class Crypt_Base
* The Key
*
* @see Crypt_Base::setKey()
* @var String
* @var string
* @access private
*/
var $key = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
@ -154,7 +154,7 @@ class Crypt_Base
* The Initialization Vector
*
* @see Crypt_Base::setIV()
* @var String
* @var string
* @access private
*/
var $iv;
@ -164,7 +164,7 @@ class Crypt_Base
*
* @see Crypt_Base::enableContinuousBuffer()
* @see Crypt_Base::_clearBuffers()
* @var String
* @var string
* @access private
*/
var $encryptIV;
@ -174,7 +174,7 @@ class Crypt_Base
*
* @see Crypt_Base::enableContinuousBuffer()
* @see Crypt_Base::_clearBuffers()
* @var String
* @var string
* @access private
*/
var $decryptIV;
@ -183,7 +183,7 @@ class Crypt_Base
* Continuous Buffer status
*
* @see Crypt_Base::enableContinuousBuffer()
* @var Boolean
* @var bool
* @access private
*/
var $continuousBuffer = false;
@ -193,7 +193,7 @@ class Crypt_Base
*
* @see Crypt_Base::encrypt()
* @see Crypt_Base::_clearBuffers()
* @var Array
* @var array
* @access private
*/
var $enbuffer;
@ -203,7 +203,7 @@ class Crypt_Base
*
* @see Crypt_Base::decrypt()
* @see Crypt_Base::_clearBuffers()
* @var Array
* @var array
* @access private
*/
var $debuffer;
@ -215,7 +215,7 @@ class Crypt_Base
* Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
*
* @see Crypt_Base::encrypt()
* @var Resource
* @var resource
* @access private
*/
var $enmcrypt;
@ -227,7 +227,7 @@ class Crypt_Base
* Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
*
* @see Crypt_Base::decrypt()
* @var Resource
* @var resource
* @access private
*/
var $demcrypt;
@ -237,7 +237,7 @@ class Crypt_Base
*
* @see Crypt_Twofish::setKey()
* @see Crypt_Twofish::setIV()
* @var Boolean
* @var bool
* @access private
*/
var $enchanged = true;
@ -247,7 +247,7 @@ class Crypt_Base
*
* @see Crypt_Twofish::setKey()
* @see Crypt_Twofish::setIV()
* @var Boolean
* @var bool
* @access private
*/
var $dechanged = true;
@ -266,7 +266,7 @@ class Crypt_Base
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @see Crypt_Base::_setupMcrypt()
* @var Resource
* @var resource
* @access private
*/
var $ecb;
@ -288,7 +288,7 @@ class Crypt_Base
* on its internaly Key-expanding algorithm.
*
* @see Crypt_Base::encrypt()
* @var Integer
* @var int
* @access private
*/
var $cfb_init_len = 600;
@ -299,7 +299,7 @@ class Crypt_Base
* @see setKey()
* @see setIV()
* @see disableContinuousBuffer()
* @var Boolean
* @var bool
* @access private
*/
var $changed = true;
@ -308,7 +308,7 @@ class Crypt_Base
* Padding status
*
* @see Crypt_Base::enablePadding()
* @var Boolean
* @var bool
* @access private
*/
var $padding = true;
@ -317,7 +317,7 @@ class Crypt_Base
* Is the mode one that is paddable?
*
* @see Crypt_Base::Crypt_Base()
* @var Boolean
* @var bool
* @access private
*/
var $paddable = false;
@ -334,7 +334,7 @@ class Crypt_Base
* @see Crypt_Base::_setEngine()
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @var Integer
* @var int
* @access private
*/
var $engine;
@ -344,7 +344,7 @@ class Crypt_Base
*
* @see Crypt_Base::_setEngine()
* @see Crypt_Base::setPreferredEngine()
* @var Integer
* @var int
* @access private
*/
var $preferredEngine;
@ -357,7 +357,7 @@ class Crypt_Base
* @link http://www.php.net/mcrypt_module_open
* @link http://www.php.net/mcrypt_list_algorithms
* @see Crypt_Base::_setupMcrypt()
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt;
@ -368,7 +368,7 @@ class Crypt_Base
* Only used if $engine == CRYPT_ENGINE_OPENSSL
*
* @link http://www.php.net/openssl-get-cipher-methods
* @var String
* @var string
* @access private
*/
var $cipher_name_openssl;
@ -380,7 +380,7 @@ class Crypt_Base
* it can still be emulated with ECB mode.
*
* @link http://www.php.net/openssl-get-cipher-methods
* @var String
* @var string
* @access private
*/
var $cipher_name_openssl_ecb;
@ -389,7 +389,7 @@ class Crypt_Base
* The default password key_size used by setPassword()
*
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 32;
@ -398,7 +398,7 @@ class Crypt_Base
* The default salt used by setPassword()
*
* @see Crypt_Base::setPassword()
* @var String
* @var string
* @access private
*/
var $password_default_salt = 'phpseclib/salt';
@ -421,7 +421,7 @@ class Crypt_Base
* $aes = new Crypt_AES(CRYPT_MODE_CFB); // identical
*
* @see Crypt_Base::Crypt_Base()
* @var String
* @var string
* @access private
*/
var $const_namespace;
@ -456,7 +456,7 @@ class Crypt_Base
* If OpenSSL can be used in ECB but not in CTR we can emulate CTR
*
* @see Crypt_Base::_openssl_ctr_process()
* @var Boolean
* @var bool
* @access private
*/
var $openssl_emulate_ctr = false;
@ -491,7 +491,7 @@ class Crypt_Base
*
* If not explicitly set, CRYPT_MODE_CBC will be used.
*
* @param Integer $mode
* @param int $mode
* @access public
*/
function Crypt_Base($mode = CRYPT_MODE_CBC)
@ -529,7 +529,7 @@ class Crypt_Base
* to be all zero's.
*
* @access public
* @param String $iv
* @param string $iv
* @internal Can be overwritten by a sub class, but does not have to be
*/
function setIV($iv)
@ -553,7 +553,7 @@ class Crypt_Base
* If the key is not explicitly set, it'll be assumed to be all null bytes.
*
* @access public
* @param String $key
* @param string $key
* @internal Could, but not must, extend by the child Crypt_* class
*/
function setKey($key)
@ -573,9 +573,9 @@ class Crypt_Base
* Where $hash (default = sha1) currently supports the following hashes: see: Crypt/Hash.php
*
* @see Crypt/Hash.php
* @param String $password
* @param String $method
* @return Boolean
* @param string $password
* @param string $method
* @return bool
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
@ -672,8 +672,8 @@ class Crypt_Base
*
* @see Crypt_Base::decrypt()
* @access public
* @param String $plaintext
* @return String $ciphertext
* @param string $plaintext
* @return string $ciphertext
* @internal Could, but not must, extend by the child Crypt_* class
*/
function encrypt($plaintext)
@ -970,8 +970,8 @@ class Crypt_Base
*
* @see Crypt_Base::encrypt()
* @access public
* @param String $ciphertext
* @return String $plaintext
* @param string $ciphertext
* @return string $plaintext
* @internal Could, but not must, extend by the child Crypt_* class
*/
function decrypt($ciphertext)
@ -1261,10 +1261,10 @@ class Crypt_Base
*
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @param String $plaintext
* @param String $encryptIV
* @param Array $buffer
* @return String
* @param string $plaintext
* @param string $encryptIV
* @param array $buffer
* @return string
* @access private
*/
function _openssl_ctr_process($plaintext, &$encryptIV, &$buffer)
@ -1355,10 +1355,10 @@ class Crypt_Base
*
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @param String $plaintext
* @param String $encryptIV
* @param Array $buffer
* @return String
* @param string $plaintext
* @param string $encryptIV
* @param array $buffer
* @return string
* @access private
*/
function _openssl_ofb_process($plaintext, &$encryptIV, &$buffer)
@ -1404,7 +1404,7 @@ class Crypt_Base
*
* May need to be overwritten by classes extending this one in some cases
*
* @return Integer
* @return int
* @access private
*/
function _openssl_translate_mode()
@ -1531,9 +1531,9 @@ class Crypt_Base
* Test for engine validity
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -1598,7 +1598,7 @@ class Crypt_Base
* If the preferred crypt engine is not available the fastest available one will be used
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $engine
* @param int $engine
* @access public
*/
function setPreferredEngine($engine)
@ -1673,8 +1673,8 @@ class Crypt_Base
* Encrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
* @internal Must be extended by the child Crypt_* class
*/
function _encryptBlock($in)
@ -1686,8 +1686,8 @@ class Crypt_Base
* Decrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
* @internal Must be extended by the child Crypt_* class
*/
function _decryptBlock($in)
@ -1809,9 +1809,9 @@ class Crypt_Base
* and padding will, hence forth, be enabled.
*
* @see Crypt_Base::_unpad()
* @param String $text
* @param string $text
* @access private
* @return String
* @return string
*/
function _pad($text)
{
@ -1838,9 +1838,9 @@ class Crypt_Base
* and false will be returned.
*
* @see Crypt_Base::_pad()
* @param String $text
* @param string $text
* @access private
* @return String
* @return string
*/
function _unpad($text)
{
@ -1881,10 +1881,10 @@ class Crypt_Base
*
* Inspired by array_shift
*
* @param String $string
* @param Integer $index
* @param string $string
* @param int $index
* @access private
* @return String
* @return string
*/
function _string_shift(&$string, $index = 1)
{
@ -1898,10 +1898,10 @@ class Crypt_Base
*
* Inspired by array_pop
*
* @param String $string
* @param Integer $index
* @param string $string
* @param int $index
* @access private
* @return String
* @return string
*/
function _string_pop(&$string, $index = 1)
{
@ -1915,7 +1915,7 @@ class Crypt_Base
*
* @see Crypt_Base::decrypt()
* @see Crypt_Base::encrypt()
* @param String $var
* @param string $var
* @access private
*/
function _increment_str(&$var)
@ -2125,9 +2125,9 @@ class Crypt_Base
* @see Crypt_Base::_setupInlineCrypt()
* @see Crypt_Base::encrypt()
* @see Crypt_Base::decrypt()
* @param Array $cipher_code
* @param array $cipher_code
* @access private
* @return String (the name of the created callback function)
* @return string (the name of the created callback function)
*/
function _createInlineCryptFunction($cipher_code)
{
@ -2494,7 +2494,7 @@ class Crypt_Base
* for which $mode the lambda function was created.
*
* @access private
* @return Array &$functions
* @return array &$functions
*/
function &_getLambdaFunctions()
{
@ -2508,7 +2508,7 @@ class Crypt_Base
* @see _setupInlineCrypt()
* @access private
* @param $bytes
* @return String
* @return string
*/
function _hashInlineCryptFunction($bytes)
{

26
phpseclib/Crypt/Blowfish.php
View File

@ -115,7 +115,7 @@ class Crypt_Blowfish extends Crypt_Base
* Block Length of the cipher
*
* @see Crypt_Base::block_size
* @var Integer
* @var int
* @access private
*/
var $block_size = 8;
@ -125,7 +125,7 @@ class Crypt_Blowfish extends Crypt_Base
*
* @see Crypt_Base::password_key_size
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 56;
@ -134,7 +134,7 @@ class Crypt_Blowfish extends Crypt_Base
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'BLOWFISH';
@ -143,7 +143,7 @@ class Crypt_Blowfish extends Crypt_Base
* The mcrypt specific name of the cipher
*
* @see Crypt_Base::cipher_name_mcrypt
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'blowfish';
@ -152,7 +152,7 @@ class Crypt_Blowfish extends Crypt_Base
* Optimizing value while CFB-encrypting
*
* @see Crypt_Base::cfb_init_len
* @var Integer
* @var int
* @access private
*/
var $cfb_init_len = 500;
@ -348,7 +348,7 @@ class Crypt_Blowfish extends Crypt_Base
/**
* Holds the last used key
*
* @var Array
* @var array
* @access private
*/
var $kl;
@ -366,7 +366,7 @@ class Crypt_Blowfish extends Crypt_Base
*
* @access public
* @see Crypt_Base::setKey()
* @param String $key
* @param string $key
*/
function setKey($key)
{
@ -387,9 +387,9 @@ class Crypt_Blowfish extends Crypt_Base
* This is mainly just a wrapper to set things up for Crypt_Base::isValidEngine()
*
* @see Crypt_Base::isValidEngine()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -464,8 +464,8 @@ class Crypt_Blowfish extends Crypt_Base
* Encrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
@ -500,8 +500,8 @@ class Crypt_Blowfish extends Crypt_Base
* Decrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _decryptBlock($in)
{

62
phpseclib/Crypt/DES.php
View File

@ -134,7 +134,7 @@ class Crypt_DES extends Crypt_Base
* Block Length of the cipher
*
* @see Crypt_Base::block_size
* @var Integer
* @var int
* @access private
*/
var $block_size = 8;
@ -144,7 +144,7 @@ class Crypt_DES extends Crypt_Base
*
* @see Crypt_Base::key
* @see setKey()
* @var String
* @var string
* @access private
*/
var $key = "\0\0\0\0\0\0\0\0";
@ -154,7 +154,7 @@ class Crypt_DES extends Crypt_Base
*
* @see Crypt_Base::password_key_size
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 8;
@ -163,7 +163,7 @@ class Crypt_DES extends Crypt_Base
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'DES';
@ -172,7 +172,7 @@ class Crypt_DES extends Crypt_Base
* The mcrypt specific name of the cipher
*
* @see Crypt_Base::cipher_name_mcrypt
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'des';
@ -181,7 +181,7 @@ class Crypt_DES extends Crypt_Base
* The OpenSSL names of the cipher / modes
*
* @see Crypt_Base::openssl_mode_names
* @var Array
* @var array
* @access private
*/
var $openssl_mode_names = array(
@ -196,7 +196,7 @@ class Crypt_DES extends Crypt_Base
* Optimizing value while CFB-encrypting
*
* @see Crypt_Base::cfb_init_len
* @var Integer
* @var int
* @access private
*/
var $cfb_init_len = 500;
@ -208,7 +208,7 @@ class Crypt_DES extends Crypt_Base
*
* @see Crypt_DES::_setupKey()
* @see Crypt_DES::_processBlock()
* @var Integer
* @var int
* @access private
*/
var $des_rounds = 1;
@ -217,7 +217,7 @@ class Crypt_DES extends Crypt_Base
* max possible size of $key
*
* @see Crypt_DES::setKey()
* @var String
* @var string
* @access private
*/
var $key_size_max = 8;
@ -226,7 +226,7 @@ class Crypt_DES extends Crypt_Base
* The Key Schedule
*
* @see Crypt_DES::_setupKey()
* @var Array
* @var array
* @access private
*/
var $keys;
@ -240,7 +240,7 @@ class Crypt_DES extends Crypt_Base
*
* @see Crypt_DES::_processBlock()
* @see Crypt_DES::_setupKey()
* @var Array
* @var array
* @access private
*/
var $shuffle = array(
@ -379,7 +379,7 @@ class Crypt_DES extends Crypt_Base
*
* Indexing this table with each source byte performs the initial bit permutation.
*
* @var Array
* @var array
* @access private
*/
var $ipmap = array(
@ -421,7 +421,7 @@ class Crypt_DES extends Crypt_Base
* Inverse IP mapping helper table.
* Indexing this table with a byte value reverses the bit order.
*
* @var Array
* @var array
* @access private
*/
var $invipmap = array(
@ -465,7 +465,7 @@ class Crypt_DES extends Crypt_Base
* Each box ($sbox1-$sbox8) has been vectorized, then each value pre-permuted using the
* P table: concatenation can then be replaced by exclusive ORs.
*
* @var Array
* @var array
* @access private
*/
var $sbox1 = array(
@ -490,7 +490,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box2
*
* @var Array
* @var array
* @access private
*/
var $sbox2 = array(
@ -515,7 +515,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box3
*
* @var Array
* @var array
* @access private
*/
var $sbox3 = array(
@ -540,7 +540,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box4
*
* @var Array
* @var array
* @access private
*/
var $sbox4 = array(
@ -565,7 +565,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box5
*
* @var Array
* @var array
* @access private
*/
var $sbox5 = array(
@ -590,7 +590,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box6
*
* @var Array
* @var array
* @access private
*/
var $sbox6 = array(
@ -615,7 +615,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box7
*
* @var Array
* @var array
* @access private
*/
var $sbox7 = array(
@ -640,7 +640,7 @@ class Crypt_DES extends Crypt_Base
/**
* Pre-permuted S-box8
*
* @var Array
* @var array
* @access private
*/
var $sbox8 = array(
@ -668,9 +668,9 @@ class Crypt_DES extends Crypt_Base
* This is mainly just a wrapper to set things up for Crypt_Base::isValidEngine()
*
* @see Crypt_Base::isValidEngine()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -697,7 +697,7 @@ class Crypt_DES extends Crypt_Base
*
* @see Crypt_Base::setKey()
* @access public
* @param String $key
* @param string $key
*/
function setKey($key)
{
@ -718,8 +718,8 @@ class Crypt_DES extends Crypt_Base
* @see Crypt_Base::encrypt()
* @see Crypt_DES::encrypt()
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
@ -733,8 +733,8 @@ class Crypt_DES extends Crypt_Base
* @see Crypt_Base::decrypt()
* @see Crypt_DES::decrypt()
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
@ -751,9 +751,9 @@ class Crypt_DES extends Crypt_Base
* @see Crypt_DES::_encryptBlock()
* @see Crypt_DES::_decryptBlock()
* @access private
* @param String $block
* @param Integer $mode
* @return String
* @param string $block
* @param int $mode
* @return string
*/
function _processBlock($block, $mode)
{

64
phpseclib/Crypt/Hash.php
View File

@ -85,7 +85,7 @@ class Crypt_Hash
* Hash Parameter
*
* @see Crypt_Hash::setHash()
* @var Integer
* @var int
* @access private
*/
var $hashParam;
@ -94,7 +94,7 @@ class Crypt_Hash
* Byte-length of compression blocks / key (Internal HMAC)
*
* @see Crypt_Hash::setAlgorithm()
* @var Integer
* @var int
* @access private
*/
var $b;
@ -103,7 +103,7 @@ class Crypt_Hash
* Byte-length of hash output (Internal HMAC)
*
* @see Crypt_Hash::setHash()
* @var Integer
* @var int
* @access private
*/
var $l = false;
@ -112,7 +112,7 @@ class Crypt_Hash
* Hash Algorithm
*
* @see Crypt_Hash::setHash()
* @var String
* @var string
* @access private
*/
var $hash;
@ -121,7 +121,7 @@ class Crypt_Hash
* Key
*
* @see Crypt_Hash::setKey()
* @var String
* @var string
* @access private
*/
var $key = false;
@ -130,7 +130,7 @@ class Crypt_Hash
* Outer XOR (Internal HMAC)
*
* @see Crypt_Hash::setKey()
* @var String
* @var string
* @access private
*/
var $opad;
@ -139,7 +139,7 @@ class Crypt_Hash
* Inner XOR (Internal HMAC)
*
* @see Crypt_Hash::setKey()
* @var String
* @var string
* @access private
*/
var $ipad;
@ -147,7 +147,7 @@ class Crypt_Hash
/**
* Default Constructor.
*
* @param String $hash
* @param string $hash
* @return Crypt_Hash
* @access public
*/
@ -175,7 +175,7 @@ class Crypt_Hash
* Keys can be of any length.
*
* @access public
* @param String $key
* @param string $key
*/
function setKey($key = false)
{
@ -188,7 +188,7 @@ class Crypt_Hash
* As set by the constructor or by the setHash() method.
*
* @access public
* @return String
* @return string
*/
function getHash()
{
@ -199,7 +199,7 @@ class Crypt_Hash
* Sets the hash function.
*
* @access public
* @param String $hash
* @param string $hash
*/
function setHash($hash)
{
@ -306,8 +306,8 @@ class Crypt_Hash
* Compute the HMAC.
*
* @access public
* @param String $text
* @return String
* @param string $text
* @return string
*/
function hash($text)
{
@ -356,7 +356,7 @@ class Crypt_Hash
* Returns the hash length (in bytes)
*
* @access public
* @return Integer
* @return int
*/
function getLength()
{
@ -367,7 +367,7 @@ class Crypt_Hash
* Wrapper for MD5
*
* @access private
* @param String $m
* @param string $m
*/
function _md5($m)
{
@ -378,7 +378,7 @@ class Crypt_Hash
* Wrapper for SHA1
*
* @access private
* @param String $m
* @param string $m
*/
function _sha1($m)
{
@ -391,7 +391,7 @@ class Crypt_Hash
* See {@link http://tools.ietf.org/html/rfc1319 RFC1319}.
*
* @access private
* @param String $m
* @param string $m
*/
function _md2($m)
{
@ -467,7 +467,7 @@ class Crypt_Hash
* See {@link http://en.wikipedia.org/wiki/SHA_hash_functions#SHA-256_.28a_SHA-2_variant.29_pseudocode SHA-256 (a SHA-2 variant) pseudocode - Wikipedia}.
*
* @access private
* @param String $m
* @param string $m
*/
function _sha256($m)
{
@ -574,7 +574,7 @@ class Crypt_Hash
* Pure-PHP implementation of SHA384 and SHA512
*
* @access private
* @param String $m
* @param string $m
*/
function _sha512($m)
{
@ -757,10 +757,10 @@ class Crypt_Hash
* Right Rotate
*
* @access private
* @param Integer $int
* @param Integer $amt
* @param int $int
* @param int $amt
* @see _sha256()
* @return Integer
* @return int
*/
function _rightRotate($int, $amt)
{
@ -773,10 +773,10 @@ class Crypt_Hash
* Right Shift
*
* @access private
* @param Integer $int
* @param Integer $amt
* @param int $int
* @param int $amt
* @see _sha256()
* @return Integer
* @return int
*/
function _rightShift($int, $amt)
{
@ -788,9 +788,9 @@ class Crypt_Hash
* Not
*
* @access private
* @param Integer $int
* @param int $int
* @see _sha256()
* @return Integer
* @return int
*/
function _not($int)
{
@ -803,8 +803,8 @@ class Crypt_Hash
* _sha256() adds multiple unsigned 32-bit integers. Since PHP doesn't support unsigned integers and since the
* possibility of overflow exists, care has to be taken. Math_BigInteger() could be used but this should be faster.
*
* @param Integer $...
* @return Integer
* @param int $...
* @return int
* @see _sha256()
* @access private
*/
@ -829,9 +829,9 @@ class Crypt_Hash
*
* Inspired by array_shift
*
* @param String $string
* @param Integer $index
* @return String
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)

52
phpseclib/Crypt/RC2.php
View File

@ -111,7 +111,7 @@ class Crypt_RC2 extends Crypt_Base
* Block Length of the cipher
*
* @see Crypt_Base::block_size
* @var Integer
* @var int
* @access private
*/
var $block_size = 8;
@ -121,7 +121,7 @@ class Crypt_RC2 extends Crypt_Base
*
* @see Crypt_Base::key
* @see setKey()
* @var String
* @var string
* @access private
*/
var $key;
@ -133,7 +133,7 @@ class Crypt_RC2 extends Crypt_Base
* @see setKey()
* @see encrypt()
* @see decrypt()
* @var String
* @var string
* @access private
*/
var $orig_key;
@ -143,7 +143,7 @@ class Crypt_RC2 extends Crypt_Base
*
* @see Crypt_Base::password_key_size
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 16; // = 128 bits
@ -152,7 +152,7 @@ class Crypt_RC2 extends Crypt_Base
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'RC2';
@ -161,7 +161,7 @@ class Crypt_RC2 extends Crypt_Base
* The mcrypt specific name of the cipher
*
* @see Crypt_Base::cipher_name_mcrypt
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'rc2';
@ -170,7 +170,7 @@ class Crypt_RC2 extends Crypt_Base
* Optimizing value while CFB-encrypting
*
* @see Crypt_Base::cfb_init_len
* @var Integer
* @var int
* @access private
*/
var $cfb_init_len = 500;
@ -180,7 +180,7 @@ class Crypt_RC2 extends Crypt_Base
*
* @see Crypt_RC2::setKeyLength()
* @see Crypt_RC2::setKey()
* @var Integer
* @var int
* @access private
* @internal Should be in range [1..1024].
* @internal Changing this value after setting the key has no effect.
@ -192,7 +192,7 @@ class Crypt_RC2 extends Crypt_Base
*
* @see Crypt_RC2::isValidEnine()
* @see Crypt_RC2::setKey()
* @var Integer
* @var int
* @access private
* @internal Should be in range [1..1024].
*/
@ -202,7 +202,7 @@ class Crypt_RC2 extends Crypt_Base
* The Key Schedule
*
* @see Crypt_RC2::_setupKey()
* @var Array
* @var array
* @access private
*/
var $keys;
@ -212,7 +212,7 @@ class Crypt_RC2 extends Crypt_Base
* Twice the same 256-value sequence to save a modulus in key expansion.
*
* @see Crypt_RC2::setKey()
* @var Array
* @var array
* @access private
*/
var $pitable = array(
@ -286,7 +286,7 @@ class Crypt_RC2 extends Crypt_Base
* Inverse key expansion randomization table.
*
* @see Crypt_RC2::setKey()
* @var Array
* @var array
* @access private
*/
var $invpitable = array(
@ -344,7 +344,7 @@ class Crypt_RC2 extends Crypt_Base
* If not explicitly set, CRYPT_RC2_MODE_CBC will be used.
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $mode
* @param int $mode
* @access public
*/
function Crypt_RC2($mode = CRYPT_RC2_MODE_CBC)
@ -358,9 +358,9 @@ class Crypt_RC2 extends Crypt_Base
* This is mainly just a wrapper to set things up for Crypt_Base::isValidEngine()
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -384,7 +384,7 @@ class Crypt_RC2 extends Crypt_Base
* Crypt_RC2::setKey() call.
*
* @access public
* @param Integer $length in bits
* @param int $length in bits
*/
function setKeyLength($length)
{
@ -406,8 +406,8 @@ class Crypt_RC2 extends Crypt_Base
*
* @see Crypt_Base::setKey()
* @access public
* @param String $key
* @param Integer $t1 optional Effective key length in bits.
* @param string $key
* @param int $t1 optional Effective key length in bits.
*/
function setKey($key, $t1 = 0)
{
@ -458,8 +458,8 @@ class Crypt_RC2 extends Crypt_Base
*
* @see decrypt()
* @access public
* @param String $plaintext
* @return String $ciphertext
* @param string $plaintext
* @return string $ciphertext
*/
function encrypt($plaintext)
{
@ -481,8 +481,8 @@ class Crypt_RC2 extends Crypt_Base
*
* @see encrypt()
* @access public
* @param String $ciphertext
* @return String $plaintext
* @param string $ciphertext
* @return string $plaintext
*/
function decrypt($ciphertext)
{
@ -503,8 +503,8 @@ class Crypt_RC2 extends Crypt_Base
* @see Crypt_Base::_encryptBlock()
* @see Crypt_Base::encrypt()
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
@ -548,8 +548,8 @@ class Crypt_RC2 extends Crypt_Base
* @see Crypt_Base::_decryptBlock()
* @see Crypt_Base::decrypt()
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _decryptBlock($in)
{

34
phpseclib/Crypt/RC4.php
View File

@ -93,7 +93,7 @@ class Crypt_RC4 extends Crypt_Base
* so we the block_size to 0
*
* @see Crypt_Base::block_size
* @var Integer
* @var int
* @access private
*/
var $block_size = 0;
@ -103,7 +103,7 @@ class Crypt_RC4 extends Crypt_Base
*
* @see Crypt_Base::password_key_size
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 128; // = 1024 bits
@ -112,7 +112,7 @@ class Crypt_RC4 extends Crypt_Base
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'RC4';
@ -121,7 +121,7 @@ class Crypt_RC4 extends Crypt_Base
* The mcrypt specific name of the cipher
*
* @see Crypt_Base::cipher_name_mcrypt
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'arcfour';
@ -139,7 +139,7 @@ class Crypt_RC4 extends Crypt_Base
* The Key
*
* @see Crypt_RC4::setKey()
* @var String
* @var string
* @access private
*/
var $key = "\0";
@ -148,7 +148,7 @@ class Crypt_RC4 extends Crypt_Base
* The Key Stream for decryption and encryption
*
* @see Crypt_RC4::setKey()
* @var Array
* @var array
* @access private
*/
var $stream;
@ -173,9 +173,9 @@ class Crypt_RC4 extends Crypt_Base
* This is mainly just a wrapper to set things up for Crypt_Base::isValidEngine()
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -214,7 +214,7 @@ class Crypt_RC4 extends Crypt_Base
* {@link http://www.rsa.com/rsalabs/node.asp?id=2009 http://www.rsa.com/rsalabs/node.asp?id=2009}
* {@link http://en.wikipedia.org/wiki/Related_key_attack http://en.wikipedia.org/wiki/Related_key_attack}
*
* @param String $iv
* @param string $iv
* @see Crypt_RC4::setKey()
* @access public
*/
@ -230,7 +230,7 @@ class Crypt_RC4 extends Crypt_Base
*
* @access public
* @see Crypt_Base::setKey()
* @param String $key
* @param string $key
*/
function setKey($key)
{
@ -243,8 +243,8 @@ class Crypt_RC4 extends Crypt_Base
* @see Crypt_Base::decrypt()
* @see Crypt_RC4::_crypt()
* @access public
* @param String $plaintext
* @return String $ciphertext
* @param string $plaintext
* @return string $ciphertext
*/
function encrypt($plaintext)
{
@ -263,8 +263,8 @@ class Crypt_RC4 extends Crypt_Base
* @see Crypt_Base::encrypt()
* @see Crypt_RC4::_crypt()
* @access public
* @param String $ciphertext
* @return String $plaintext
* @param string $ciphertext
* @return string $plaintext
*/
function decrypt($ciphertext)
{
@ -308,9 +308,9 @@ class Crypt_RC4 extends Crypt_Base
* @see Crypt_RC4::encrypt()
* @see Crypt_RC4::decrypt()
* @access private
* @param String $text
* @param Integer $mode
* @return String $text
* @param string $text
* @param int $mode
* @return string $text
*/
function _crypt($text, $mode)
{

242
phpseclib/Crypt/RSA.php
View File

@ -282,7 +282,7 @@ class Crypt_RSA
/**
* Precomputed Zero
*
* @var Array
* @var array
* @access private
*/
var $zero;
@ -290,7 +290,7 @@ class Crypt_RSA
/**
* Precomputed One
*
* @var Array
* @var array
* @access private
*/
var $one;
@ -298,7 +298,7 @@ class Crypt_RSA
/**
* Private Key Format
*
* @var Integer
* @var int
* @access private
*/
var $privateKeyFormat = CRYPT_RSA_PRIVATE_FORMAT_PKCS1;
@ -306,7 +306,7 @@ class Crypt_RSA
/**
* Public Key Format
*
* @var Integer
* @var int
* @access public
*/
var $publicKeyFormat = CRYPT_RSA_PUBLIC_FORMAT_PKCS8;
@ -338,7 +338,7 @@ class Crypt_RSA
/**
* Primes for Chinese Remainder Theorem (ie. p and q)
*
* @var Array
* @var array
* @access private
*/
var $primes;
@ -346,7 +346,7 @@ class Crypt_RSA
/**
* Exponents for Chinese Remainder Theorem (ie. dP and dQ)
*
* @var Array
* @var array
* @access private
*/
var $exponents;
@ -354,7 +354,7 @@ class Crypt_RSA
/**
* Coefficients for Chinese Remainder Theorem (ie. qInv)
*
* @var Array
* @var array
* @access private
*/
var $coefficients;
@ -362,7 +362,7 @@ class Crypt_RSA
/**
* Hash name
*
* @var String
* @var string
* @access private
*/
var $hashName;
@ -378,7 +378,7 @@ class Crypt_RSA
/**
* Length of hash function output
*
* @var Integer
* @var int
* @access private
*/
var $hLen;
@ -386,7 +386,7 @@ class Crypt_RSA
/**
* Length of salt
*
* @var Integer
* @var int
* @access private
*/
var $sLen;
@ -402,7 +402,7 @@ class Crypt_RSA
/**
* Length of MGF hash function output
*
* @var Integer
* @var int
* @access private
*/
var $mgfHLen;
@ -410,7 +410,7 @@ class Crypt_RSA
/**
* Encryption mode
*
* @var Integer
* @var int
* @access private
*/
var $encryptionMode = CRYPT_RSA_ENCRYPTION_OAEP;
@ -418,7 +418,7 @@ class Crypt_RSA
/**
* Signature mode
*
* @var Integer
* @var int
* @access private
*/
var $signatureMode = CRYPT_RSA_SIGNATURE_PSS;
@ -426,7 +426,7 @@ class Crypt_RSA
/**
* Public Exponent
*
* @var Mixed
* @var mixed
* @access private
*/
var $publicExponent = false;
@ -434,7 +434,7 @@ class Crypt_RSA
/**
* Password
*
* @var String
* @var string
* @access private
*/
var $password = false;
@ -446,7 +446,7 @@ class Crypt_RSA
* because PHP's XML Parser functions work on PHP4 whereas PHP's DOM functions - although surperior - don't.
*
* @see Crypt_RSA::_start_element_handler()
* @var Array
* @var array
* @access private
*/
var $components = array();
@ -458,7 +458,7 @@ class Crypt_RSA
*
* @see Crypt_RSA::_character_handler()
* @see Crypt_RSA::_stop_element_handler()
* @var Mixed
* @var mixed
* @access private
*/
var $current;
@ -468,7 +468,7 @@ class Crypt_RSA
*
* Set to null to use system configuration file.
* @see Crypt_RSA::createKey()
* @var Mixed
* @var mixed
* @Access public
*/
var $configFile;
@ -476,7 +476,7 @@ class Crypt_RSA
/**
* Public key comment field.
*
* @var String
* @var string
* @access private
*/
var $comment = 'phpseclib-generated-key';
@ -571,8 +571,8 @@ class Crypt_RSA
* Will need to be passed back to Crypt_RSA::createKey() as the third parameter for further processing.
*
* @access public
* @param Integer $bits
* @param Integer $timeout
* @param int $bits
* @param int $timeout
* @param Math_BigInteger $p
*/
function createKey($bits = 1024, $timeout = false, $partial = array())
@ -752,8 +752,8 @@ class Crypt_RSA
*
* @access private
* @see setPrivateKeyFormat()
* @param String $RSAPrivateKey
* @return String
* @param string $RSAPrivateKey
* @return string
*/
function _convertPrivateKey($n, $e, $d, $primes, $exponents, $coefficients)
{
@ -993,8 +993,8 @@ class Crypt_RSA
*
* @access private
* @see setPublicKeyFormat()
* @param String $RSAPrivateKey
* @return String
* @param string $RSAPrivateKey
* @return string
*/
function _convertPublicKey($n, $e)
{
@ -1072,9 +1072,9 @@ class Crypt_RSA
* @access private
* @see _convertPublicKey()
* @see _convertPrivateKey()
* @param String $key
* @param Integer $type
* @return Array
* @param string $key
* @param int $type
* @return array
*/
function _parseKey($key, $type)
{
@ -1490,7 +1490,7 @@ class Crypt_RSA
* More specifically, this returns the size of the modulo in bits.
*
* @access public
* @return Integer
* @return int
*/
function getSize()
{
@ -1503,9 +1503,9 @@ class Crypt_RSA
* Called by xml_set_element_handler()
*
* @access private
* @param Resource $parser
* @param String $name
* @param Array $attribs
* @param resource $parser
* @param string $name
* @param array $attribs
*/
function _start_element_handler($parser, $name, $attribs)
{
@ -1544,8 +1544,8 @@ class Crypt_RSA
* Called by xml_set_element_handler()
*
* @access private
* @param Resource $parser
* @param String $name
* @param resource $parser
* @param string $name
*/
function _stop_element_handler($parser, $name)
{
@ -1561,8 +1561,8 @@ class Crypt_RSA
* Called by xml_set_character_data_handler()
*
* @access private
* @param Resource $parser
* @param String $data
* @param resource $parser
* @param string $data
*/
function _data_handler($parser, $data)
{
@ -1578,8 +1578,8 @@ class Crypt_RSA
* Returns true on success and false on failure (ie. an incorrect password was provided or the key was malformed)
*
* @access public
* @param String $key
* @param Integer $type optional
* @param string $key
* @param int $type optional
*/
function loadKey($key, $type = false)
{
@ -1696,7 +1696,7 @@ class Crypt_RSA
* @see createKey()
* @see loadKey()
* @access public
* @param String $password
* @param string $password
*/
function setPassword($password = false)
{
@ -1720,9 +1720,9 @@ class Crypt_RSA
*
* @see getPublicKey()
* @access public
* @param String $key optional
* @param Integer $type optional
* @return Boolean
* @param string $key optional
* @param int $type optional
* @return bool
*/
function setPublicKey($key = false, $type = false)
{
@ -1780,9 +1780,9 @@ class Crypt_RSA
*
* @see getPublicKey()
* @access public
* @param String $key optional
* @param Integer $type optional
* @return Boolean
* @param string $key optional
* @param int $type optional
* @return bool
*/
function setPrivateKey($key = false, $type = false)
{
@ -1811,8 +1811,8 @@ class Crypt_RSA
*
* @see getPublicKey()
* @access public
* @param String $key
* @param Integer $type optional
* @param string $key
* @param int $type optional
*/
function getPublicKey($type = CRYPT_RSA_PUBLIC_FORMAT_PKCS8)
{
@ -1835,7 +1835,7 @@ class Crypt_RSA
* Example output (md5): "c1:b1:30:29:d7:b8:de:6c:97:77:10:d7:46:41:63:87" (as specified by RFC 4716)
*
* @access public
* @param String $algorithm The hashing algorithm to be used. Valid options are 'md5' and 'sha256'. False is returned
* @param string $algorithm The hashing algorithm to be used. Valid options are 'md5' and 'sha256'. False is returned
* for invalid values.
*/
public function getPublicKeyFingerprint($algorithm = 'md5')
@ -1869,8 +1869,8 @@ class Crypt_RSA
*
* @see getPublicKey()
* @access public
* @param String $key
* @param Integer $type optional
* @param string $key
* @param int $type optional
*/
function getPrivateKey($type = CRYPT_RSA_PUBLIC_FORMAT_PKCS1)
{
@ -1893,8 +1893,8 @@ class Crypt_RSA
*
* @see getPrivateKey()
* @access private
* @param String $key
* @param Integer $type optional
* @param string $key
* @param int $type optional
*/
function _getPrivatePublicKey($mode = CRYPT_RSA_PUBLIC_FORMAT_PKCS8)
{
@ -1940,8 +1940,8 @@ class Crypt_RSA
* Generates the smallest and largest numbers requiring $bits bits
*
* @access private
* @param Integer $bits
* @return Array
* @param int $bits
* @return array
*/
function _generateMinMax($bits)
{
@ -1969,8 +1969,8 @@ class Crypt_RSA
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @access private
* @param String $string
* @return Integer
* @param string $string
* @return int
*/
function _decodeLength(&$string)
{
@ -1990,8 +1990,8 @@ class Crypt_RSA
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @access private
* @param Integer $length
* @return String
* @param int $length
* @return string
*/
function _encodeLength($length)
{
@ -2008,9 +2008,9 @@ class Crypt_RSA
*
* Inspired by array_shift
*
* @param String $string
* @param Integer $index
* @return String
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
@ -2025,7 +2025,7 @@ class Crypt_RSA
*
* @see createKey()
* @access public
* @param Integer $format
* @param int $format
*/
function setPrivateKeyFormat($format)
{
@ -2037,7 +2037,7 @@ class Crypt_RSA
*
* @see createKey()
* @access public
* @param Integer $format
* @param int $format
*/
function setPublicKeyFormat($format)
{
@ -2051,7 +2051,7 @@ class Crypt_RSA
* decryption. If $hash isn't supported, sha1 is used.
*
* @access public
* @param String $hash
* @param string $hash
*/
function setHash($hash)
{
@ -2080,7 +2080,7 @@ class Crypt_RSA
* best if Hash and MGFHash are set to the same thing this is not a requirement.
*
* @access public
* @param String $hash
* @param string $hash
*/
function setMGFHash($hash)
{
@ -2109,7 +2109,7 @@ class Crypt_RSA
* of the hash function Hash) and 0.
*
* @access public
* @param Integer $format
* @param int $format
*/
function setSaltLength($sLen)
{
@ -2123,8 +2123,8 @@ class Crypt_RSA
*
* @access private
* @param Math_BigInteger $x
* @param Integer $xLen
* @return String
* @param int $xLen
* @return string
*/
function _i2osp($x, $xLen)
{
@ -2142,7 +2142,7 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-4.2 RFC3447#section-4.2}.
*
* @access private
* @param String $x
* @param string $x
* @return Math_BigInteger
*/
function _os2ip($x)
@ -2236,7 +2236,7 @@ class Crypt_RSA
* @access private
* @param Math_BigInteger $x
* @param Math_BigInteger $r
* @param Integer $i
* @param int $i
* @return Math_BigInteger
*/
function _blind($x, $r, $i)
@ -2261,9 +2261,9 @@ class Crypt_RSA
* Thanks for the heads up singpolyma!
*
* @access private
* @param String $x
* @param String $y
* @return Boolean
* @param string $x
* @param string $y
* @return bool
*/
function _equals($x, $y)
{
@ -2357,9 +2357,9 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#appendix-B.2.1 RFC3447#appendix-B.2.1}.
*
* @access private
* @param String $mgfSeed
* @param Integer $mgfLen
* @return String
* @param string $mgfSeed
* @param int $mgfLen
* @return string
*/
function _mgf1($mgfSeed, $maskLen)
{
@ -2382,9 +2382,9 @@ class Crypt_RSA
* {http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding OAES}.
*
* @access private
* @param String $m
* @param String $l
* @return String
* @param string $m
* @param string $l
* @return string
*/
function _rsaes_oaep_encrypt($m, $l = '')
{
@ -2445,9 +2445,9 @@ class Crypt_RSA
* this document.
*
* @access private
* @param String $c
* @param String $l
* @return String
* @param string $c
* @param string $l
* @return string
*/
function _rsaes_oaep_decrypt($c, $l = '')
{
@ -2504,8 +2504,8 @@ class Crypt_RSA
* Doesn't use padding and is not recommended.
*
* @access private
* @param String $m
* @return String
* @param string $m
* @return string
*/
function _raw_encrypt($m)
{
@ -2520,8 +2520,8 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-7.2.1 RFC3447#section-7.2.1}.
*
* @access private
* @param String $m
* @return String
* @param string $m
* @return string
*/
function _rsaes_pkcs1_v1_5_encrypt($m)
{
@ -2579,8 +2579,8 @@ class Crypt_RSA
* not private key encrypted ciphertext's.
*
* @access private
* @param String $c
* @return String
* @param string $c
* @return string
*/
function _rsaes_pkcs1_v1_5_decrypt($c)
{
@ -2628,8 +2628,8 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-9.1.1 RFC3447#section-9.1.1}.
*
* @access private
* @param String $m
* @param Integer $emBits
* @param string $m
* @param int $emBits
*/
function _emsa_pss_encode($m, $emBits)
{
@ -2664,10 +2664,10 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-9.1.2 RFC3447#section-9.1.2}.
*
* @access private
* @param String $m
* @param String $em
* @param Integer $emBits
* @return String
* @param string $m
* @param string $em
* @param int $emBits
* @return string
*/
function _emsa_pss_verify($m, $em, $emBits)
{
@ -2711,8 +2711,8 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-8.1.1 RFC3447#section-8.1.1}.
*
* @access private
* @param String $m
* @return String
* @param string $m
* @return string
*/
function _rsassa_pss_sign($m)
{
@ -2737,9 +2737,9 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-8.1.2 RFC3447#section-8.1.2}.
*
* @access private
* @param String $m
* @param String $s
* @return String
* @param string $m
* @param string $s
* @return string
*/
function _rsassa_pss_verify($m, $s)
{
@ -2777,9 +2777,9 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-9.2 RFC3447#section-9.2}.
*
* @access private
* @param String $m
* @param Integer $emLen
* @return String
* @param string $m
* @param int $emLen
* @return string
*/
function _emsa_pkcs1_v1_5_encode($m, $emLen)
{
@ -2829,8 +2829,8 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-8.2.1 RFC3447#section-8.2.1}.
*
* @access private
* @param String $m
* @return String
* @param string $m
* @return string
*/
function _rsassa_pkcs1_v1_5_sign($m)
{
@ -2859,8 +2859,8 @@ class Crypt_RSA
* See {@link http://tools.ietf.org/html/rfc3447#section-8.2.2 RFC3447#section-8.2.2}.
*
* @access private
* @param String $m
* @return String
* @param string $m
* @return string
*/
function _rsassa_pkcs1_v1_5_verify($m, $s)
{
@ -2903,7 +2903,7 @@ class Crypt_RSA
* Valid values include CRYPT_RSA_ENCRYPTION_OAEP and CRYPT_RSA_ENCRYPTION_PKCS1.
*
* @access public
* @param Integer $mode
* @param int $mode
*/
function setEncryptionMode($mode)
{
@ -2916,7 +2916,7 @@ class Crypt_RSA
* Valid values include CRYPT_RSA_SIGNATURE_PSS and CRYPT_RSA_SIGNATURE_PKCS1
*
* @access public
* @param Integer $mode
* @param int $mode
*/
function setSignatureMode($mode)
{
@ -2927,7 +2927,7 @@ class Crypt_RSA
* Set public key comment.
*
* @access public
* @param String $comment
* @param string $comment
*/
function setComment($comment)
{
@ -2938,7 +2938,7 @@ class Crypt_RSA
* Get public key comment.
*
* @access public
* @return String
* @return string
*/
function getComment()
{
@ -2954,8 +2954,8 @@ class Crypt_RSA
*
* @see decrypt()
* @access public
* @param String $plaintext
* @return String
* @param string $plaintext
* @return string
*/
function encrypt($plaintext)
{
@ -3000,8 +3000,8 @@ class Crypt_RSA
*
* @see encrypt()
* @access public
* @param String $plaintext
* @return String
* @param string $plaintext
* @return string
*/
function decrypt($ciphertext)
{
@ -3042,8 +3042,8 @@ class Crypt_RSA
*
* @see verify()
* @access public
* @param String $message
* @return String
* @param string $message
* @return string
*/
function sign($message)
{
@ -3065,9 +3065,9 @@ class Crypt_RSA
*
* @see sign()
* @access public
* @param String $message
* @param String $signature
* @return Boolean
* @param string $message
* @param string $signature
* @return bool
*/
function verify($message, $signature)
{
@ -3088,8 +3088,8 @@ class Crypt_RSA
* Extract raw BER from Base64 encoding
*
* @access private
* @param String $str
* @return String
* @param string $str
* @return string
*/
function _extractBER($str)
{

4
phpseclib/Crypt/Random.php
View File

@ -61,8 +61,8 @@ if (!function_exists('crypt_random_string')) {
* microoptimizations because this function has the potential of being called a huge number of times.
* eg. for RSA key generation.
*
* @param Integer $length
* @return String
* @param int $length
* @return string
* @access public
*/
function crypt_random_string($length)

52
phpseclib/Crypt/Rijndael.php
View File

@ -132,7 +132,7 @@ class Crypt_Rijndael extends Crypt_Base
*
* @see Crypt_Base::password_key_size
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 16;
@ -141,7 +141,7 @@ class Crypt_Rijndael extends Crypt_Base
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'RIJNDAEL';
@ -157,7 +157,7 @@ class Crypt_Rijndael extends Crypt_Base
* @see Crypt_Base::cipher_name_mcrypt
* @see Crypt_Base::engine
* @see isValidEngine()
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'rijndael-128';
@ -167,7 +167,7 @@ class Crypt_Rijndael extends Crypt_Base
*
* @see Crypt_Base::password_default_salt
* @see Crypt_Base::setPassword()
* @var String
* @var string
* @access private
*/
var $password_default_salt = 'phpseclib';
@ -176,7 +176,7 @@ class Crypt_Rijndael extends Crypt_Base
* Has the key length explicitly been set or should it be derived from the key, itself?
*
* @see setKeyLength()
* @var Boolean
* @var bool
* @access private
*/
var $explicit_key_length = false;
@ -185,7 +185,7 @@ class Crypt_Rijndael extends Crypt_Base
* The Key Schedule
*
* @see _setup()
* @var Array
* @var array
* @access private
*/
var $w;
@ -194,7 +194,7 @@ class Crypt_Rijndael extends Crypt_Base
* The Inverse Key Schedule
*
* @see _setup()
* @var Array
* @var array
* @access private
*/
var $dw;
@ -203,7 +203,7 @@ class Crypt_Rijndael extends Crypt_Base
* The Block Length divided by 32
*
* @see setBlockLength()
* @var Integer
* @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
* because the encryption / decryption / key schedule creation requires this number and not $block_size. We could
@ -216,7 +216,7 @@ class Crypt_Rijndael extends Crypt_Base
* The Key Length
*
* @see setKeyLength()
* @var Integer
* @var int
* @access private
* @internal The max value is 256 / 8 = 32, the min value is 128 / 8 = 16. Exists in conjunction with $Nk
* because the encryption / decryption / key schedule creation requires this number and not $key_size. We could
@ -229,7 +229,7 @@ class Crypt_Rijndael extends Crypt_Base
* The Key Length divided by 32
*
* @see setKeyLength()
* @var Integer
* @var int
* @access private
* @internal The max value is 256 / 32 = 8, the min value is 128 / 32 = 4
*/
@ -238,7 +238,7 @@ class Crypt_Rijndael extends Crypt_Base
/**
* The Number of Rounds
*
* @var Integer
* @var int
* @access private
* @internal The max value is 14, the min value is 10.
*/
@ -247,7 +247,7 @@ class Crypt_Rijndael extends Crypt_Base
/**
* Shift offsets
*
* @var Array
* @var array
* @access private
*/
var $c;
@ -255,7 +255,7 @@ class Crypt_Rijndael extends Crypt_Base
/**
* Holds the last used key- and block_size information
*
* @var Array
* @var array
* @access private
*/
var $kl;
@ -280,7 +280,7 @@ class Crypt_Rijndael extends Crypt_Base
* If not explictly set, CRYPT_RIJNDAEL_MODE_CBC will be used.
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $mode
* @param int $mode
* @access public
*/
function Crypt_Rijndael($mode = CRYPT_RIJNDAEL_MODE_CBC)
@ -303,7 +303,7 @@ class Crypt_Rijndael extends Crypt_Base
* @see Crypt_Base:setKey()
* @see setKeyLength()
* @access public
* @param String $key
* @param string $key
*/
function setKey($key)
{
@ -347,7 +347,7 @@ class Crypt_Rijndael extends Crypt_Base
* This results then in slower encryption.
*
* @access public
* @param Integer $length
* @param int $length
*/
function setKeyLength($length)
{
@ -380,7 +380,7 @@ class Crypt_Rijndael extends Crypt_Base
* 128. If the length is greater than 128 and invalid, it will be rounded down to the closest valid amount.
*
* @access public
* @param Integer $length
* @param int $length
*/
function setBlockLength($length)
{
@ -402,9 +402,9 @@ class Crypt_Rijndael extends Crypt_Base
* This is mainly just a wrapper to set things up for Crypt_Base::isValidEngine()
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -443,8 +443,8 @@ class Crypt_Rijndael extends Crypt_Base
* Encrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
@ -544,8 +544,8 @@ class Crypt_Rijndael extends Crypt_Base
* Decrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
@ -749,7 +749,7 @@ class Crypt_Rijndael extends Crypt_Base
* Performs S-Box substitutions
*
* @access private
* @param Integer $word
* @param int $word
*/
function _subWord($word)
{
@ -771,7 +771,7 @@ class Crypt_Rijndael extends Crypt_Base
* @see Crypt_Rijndael:_setupInlineCrypt()
* @see Crypt_Rijndael:_subWord()
* @access private
* @return Array &$tables
* @return array &$tables
*/
function &_getTables()
{
@ -860,7 +860,7 @@ class Crypt_Rijndael extends Crypt_Base
* @see Crypt_Rijndael:_setupInlineCrypt()
* @see Crypt_Rijndael:_setupKey()
* @access private
* @return Array &$tables
* @return array &$tables
*/
function &_getInvTables()
{

38
phpseclib/Crypt/TripleDES.php
View File

@ -100,7 +100,7 @@ class Crypt_TripleDES extends Crypt_DES
* @see Crypt_DES::password_key_size
* @see Crypt_Base::password_key_size
* @see Crypt_Base::setPassword()
* @var Integer
* @var int
* @access private
*/
var $password_key_size = 24;
@ -110,7 +110,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_Base::password_default_salt
* @see Crypt_Base::setPassword()
* @var String
* @var string
* @access private
*/
var $password_default_salt = 'phpseclib';
@ -120,7 +120,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_DES::const_namespace
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'DES';
@ -130,7 +130,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_DES::cipher_name_mcrypt
* @see Crypt_Base::cipher_name_mcrypt
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'tripledes';
@ -139,7 +139,7 @@ class Crypt_TripleDES extends Crypt_DES
* Optimizing value while CFB-encrypting
*
* @see Crypt_Base::cfb_init_len
* @var Integer
* @var int
* @access private
*/
var $cfb_init_len = 750;
@ -149,7 +149,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_TripleDES::setKey()
* @see Crypt_DES::setKey()
* @var String
* @var string
* @access private
*/
var $key_size_max = 24;
@ -157,7 +157,7 @@ class Crypt_TripleDES extends Crypt_DES
/**
* Internal flag whether using CRYPT_DES_MODE_3CBC or not
*
* @var Boolean
* @var bool
* @access private
*/
var $mode_3cbc;
@ -167,7 +167,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* Used only if $mode_3cbc === true
*
* @var Array
* @var array
* @access private
*/
var $des;
@ -195,7 +195,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_DES::Crypt_DES()
* @see Crypt_Base::Crypt_Base()
* @param Integer $mode
* @param int $mode
* @access public
*/
function Crypt_TripleDES($mode = CRYPT_MODE_CBC)
@ -231,9 +231,9 @@ class Crypt_TripleDES extends Crypt_DES
* This is mainly just a wrapper to set things up for Crypt_Base::isValidEngine()
*
* @see Crypt_Base::Crypt_Base()
* @param Integer $engine
* @param int $engine
* @access public
* @return Boolean
* @return bool
*/
function isValidEngine($engine)
{
@ -254,7 +254,7 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_Base::setIV()
* @access public
* @param String $iv
* @param string $iv
*/
function setIV($iv)
{
@ -279,7 +279,7 @@ class Crypt_TripleDES extends Crypt_DES
* @access public
* @see Crypt_DES::setKey()
* @see Crypt_Base::setKey()
* @param String $key
* @param string $key
*/
function setKey($key)
{
@ -310,8 +310,8 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_Base::encrypt()
* @access public
* @param String $plaintext
* @return String $cipertext
* @param string $plaintext
* @return string $cipertext
*/
function encrypt($plaintext)
{
@ -337,8 +337,8 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_Base::decrypt()
* @access public
* @param String $ciphertext
* @return String $plaintext
* @param string $ciphertext
* @return string $plaintext
*/
function decrypt($ciphertext)
{
@ -464,9 +464,9 @@ class Crypt_TripleDES extends Crypt_DES
*
* @see Crypt_Base::Crypt_Base()
* @see Crypt_Base::setPreferredEngine()
* @param Integer $engine
* @param int $engine
* @access public
* @return Integer
* @return int
*/
function setPreferredEngine($engine)
{

46
phpseclib/Crypt/Twofish.php
View File

@ -115,7 +115,7 @@ class Crypt_Twofish extends Crypt_Base
* The namespace used by the cipher for its constants.
*
* @see Crypt_Base::const_namespace
* @var String
* @var string
* @access private
*/
var $const_namespace = 'TWOFISH';
@ -124,7 +124,7 @@ class Crypt_Twofish extends Crypt_Base
* The mcrypt specific name of the cipher
*
* @see Crypt_Base::cipher_name_mcrypt
* @var String
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'twofish';
@ -133,7 +133,7 @@ class Crypt_Twofish extends Crypt_Base
* Optimizing value while CFB-encrypting
*
* @see Crypt_Base::cfb_init_len
* @var Integer
* @var int
* @access private
*/
var $cfb_init_len = 800;
@ -141,7 +141,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* Q-Table
*
* @var Array
* @var array
* @access private
*/
var $q0 = array (
@ -182,7 +182,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* Q-Table
*
* @var Array
* @var array
* @access private
*/
var $q1 = array (
@ -223,7 +223,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* M-Table
*
* @var Array
* @var array
* @access private
*/
var $m0 = array (
@ -264,7 +264,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* M-Table
*
* @var Array
* @var array
* @access private
*/
var $m1 = array (
@ -305,7 +305,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* M-Table
*
* @var Array
* @var array
* @access private
*/
var $m2 = array (
@ -346,7 +346,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* M-Table
*
* @var Array
* @var array
* @access private
*/
var $m3 = array (
@ -387,7 +387,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* The Key Schedule Array
*
* @var Array
* @var array
* @access private
*/
var $K = array();
@ -395,7 +395,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* The Key depended S-Table 0
*
* @var Array
* @var array
* @access private
*/
var $S0 = array();
@ -403,7 +403,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* The Key depended S-Table 1
*
* @var Array
* @var array
* @access private
*/
var $S1 = array();
@ -411,7 +411,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* The Key depended S-Table 2
*
* @var Array
* @var array
* @access private
*/
var $S2 = array();
@ -419,7 +419,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* The Key depended S-Table 3
*
* @var Array
* @var array
* @access private
*/
var $S3 = array();
@ -427,7 +427,7 @@ class Crypt_Twofish extends Crypt_Base
/**
* Holds the last used key
*
* @var Array
* @var array
* @access private
*/
var $kl;
@ -443,7 +443,7 @@ class Crypt_Twofish extends Crypt_Base
*
* @access public
* @see Crypt_Base::setKey()
* @param String $key
* @param string $key
*/
function setKey($key)
{
@ -575,9 +575,9 @@ class Crypt_Twofish extends Crypt_Base
* _mdsrem function using by the twofish cipher algorithm
*
* @access private
* @param String $A
* @param String $B
* @return Array
* @param string $A
* @param string $B
* @return array
*/
function _mdsrem($A, $B)
{
@ -623,8 +623,8 @@ class Crypt_Twofish extends Crypt_Base
* Encrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
@ -679,8 +679,8 @@ class Crypt_Twofish extends Crypt_Base
* Decrypts a block
*
* @access private
* @param String $in
* @return String
* @param string $in
* @return string
*/
function _decryptBlock($in)
{

52
phpseclib/File/ANSI.php
View File

@ -48,7 +48,7 @@ class File_ANSI
/**
* Max Width
*
* @var Integer
* @var int
* @access private
*/
var $max_x;
@ -56,7 +56,7 @@ class File_ANSI
/**
* Max Height
*
* @var Integer
* @var int
* @access private
*/
var $max_y;
@ -64,7 +64,7 @@ class File_ANSI
/**
* Max History
*
* @var Integer
* @var int
* @access private
*/
var $max_history;
@ -72,7 +72,7 @@ class File_ANSI
/**
* History
*
* @var Array
* @var array
* @access private
*/
var $history;
@ -80,7 +80,7 @@ class File_ANSI
/**
* History Attributes
*
* @var Array
* @var array
* @access private
*/
var $history_attrs;
@ -88,7 +88,7 @@ class File_ANSI
/**
* Current Column
*
* @var Integer
* @var int
* @access private
*/
var $x;
@ -96,7 +96,7 @@ class File_ANSI
/**
* Current Row
*
* @var Integer
* @var int
* @access private
*/
var $y;
@ -104,7 +104,7 @@ class File_ANSI
/**
* Old Column
*
* @var Integer
* @var int
* @access private
*/
var $old_x;
@ -112,7 +112,7 @@ class File_ANSI
/**
* Old Row
*
* @var Integer
* @var int
* @access private
*/
var $old_y;
@ -120,7 +120,7 @@ class File_ANSI
/**
* An empty attribute cell
*
* @var Object
* @var object
* @access private
*/
var $base_attr_cell;
@ -128,7 +128,7 @@ class File_ANSI
/**
* The current attribute cell
*
* @var Object
* @var object
* @access private
*/
var $attr_cell;
@ -136,7 +136,7 @@ class File_ANSI
/**
* An empty attribute row
*
* @var Array
* @var array
* @access private
*/
var $attr_row;
@ -144,7 +144,7 @@ class File_ANSI
/**
* The current screen text
*
* @var Array
* @var array
* @access private
*/
var $screen;
@ -152,7 +152,7 @@ class File_ANSI
/**
* The current screen attributes
*
* @var Array
* @var array
* @access private
*/
var $attrs;
@ -160,7 +160,7 @@ class File_ANSI
/**
* Current ANSI code
*
* @var String
* @var string
* @access private
*/
var $ansi;
@ -168,7 +168,7 @@ class File_ANSI
/**
* Tokenization
*
* @var Array
* @var array
* @access private
*/
var $tokenization;
@ -200,8 +200,8 @@ class File_ANSI
*
* Resets the screen as well
*
* @param Integer $x
* @param Integer $y
* @param int $x
* @param int $y
* @access public
*/
function setDimensions($x, $y)
@ -219,8 +219,8 @@ class File_ANSI
/**
* Set the number of lines that should be logged past the terminal height
*
* @param Integer $x
* @param Integer $y
* @param int $x
* @param int $y
* @access public
*/
function setHistory($history)
@ -231,7 +231,7 @@ class File_ANSI
/**
* Load a string
*
* @param String $source
* @param string $source
* @access public
*/
function loadString($source)
@ -243,7 +243,7 @@ class File_ANSI
/**
* Appdend a string
*
* @param String $source
* @param string $source
* @access public
*/
function appendString($source)
@ -474,7 +474,7 @@ class File_ANSI
* Returns the current coordinate without preformating
*
* @access private
* @return String
* @return string
*/
function _processCoordinate($last_attr, $cur_attr, $char)
{
@ -531,7 +531,7 @@ class File_ANSI
* Returns the current screen without preformating
*
* @access private
* @return String
* @return string
*/
function _getScreen()
{
@ -555,7 +555,7 @@ class File_ANSI
* Returns the current screen
*
* @access public
* @return String
* @return string
*/
function getScreen()
{
@ -566,7 +566,7 @@ class File_ANSI
* Returns the current screen and the x previous lines
*
* @access public
* @return String
* @return string
*/
function getHistory()
{

80
phpseclib/File/ASN1.php
View File

@ -119,7 +119,7 @@ class File_ASN1_Element
/**
* Raw element value
*
* @var String
* @var string
* @access private
*/
var $element;
@ -127,7 +127,7 @@ class File_ASN1_Element
/**
* Constructor
*
* @param String $encoded
* @param string $encoded
* @return File_ASN1_Element
* @access public
*/
@ -149,7 +149,7 @@ class File_ASN1
/**
* ASN.1 object identifier
*
* @var Array
* @var array
* @access private
* @link http://en.wikipedia.org/wiki/Object_identifier
*/
@ -158,7 +158,7 @@ class File_ASN1
/**
* Default date format
*
* @var String
* @var string
* @access private
* @link http://php.net/class.datetime
*/
@ -167,7 +167,7 @@ class File_ASN1
/**
* Default date format
*
* @var Array
* @var array
* @access private
* @see File_ASN1::setTimeFormat()
* @see File_ASN1::asn1map()
@ -180,7 +180,7 @@ class File_ASN1
*
* If the mapping type is FILE_ASN1_TYPE_ANY what do we actually encode it as?
*
* @var Array
* @var array
* @access private
* @see File_ASN1::_encode_der()
*/
@ -193,7 +193,7 @@ class File_ASN1
* Unambiguous types get the direct mapping (int/real/bool).
* Others are mapped as a choice, with an extra indexing level.
*
* @var Array
* @var array
* @access public
*/
var $ANYmap = array(
@ -227,7 +227,7 @@ class File_ASN1
* Non-convertable types are absent from this table.
* size == 0 indicates variable length encoding.
*
* @var Array
* @var array
* @access public
*/
var $stringTypeSize = array(
@ -261,8 +261,8 @@ class File_ASN1
*
* Serves a similar purpose to openssl's asn1parse
*
* @param String $encoded
* @return Array
* @param string $encoded
* @return array
* @access public
*/
function decodeBER($encoded)
@ -283,9 +283,9 @@ class File_ASN1
* $encoded is passed by reference for the recursive calls done for FILE_ASN1_TYPE_BIT_STRING and
* FILE_ASN1_TYPE_OCTET_STRING. In those cases, the indefinite length is used.
*
* @param String $encoded
* @param Integer $start
* @return Array
* @param string $encoded
* @param int $start
* @return array
* @access private
*/
function _decode_ber($encoded, $start = 0)
@ -543,10 +543,10 @@ class File_ASN1
*
* "Special" mappings may be applied on a per tag-name basis via $special.
*
* @param Array $decoded
* @param Array $mapping
* @param Array $special
* @return Array
* @param array $decoded
* @param array $mapping
* @param array $special
* @return array
* @access public
*/
function asn1map($decoded, $mapping, $special = array())
@ -835,10 +835,10 @@ class File_ASN1
*
* "Special" mappings can be applied via $special.
*
* @param String $source
* @param String $mapping
* @param Integer $idx
* @return String
* @param string $source
* @param string $mapping
* @param int $idx
* @return string
* @access public
*/
function encodeDER($source, $mapping, $special = array())
@ -850,10 +850,10 @@ class File_ASN1
/**
* ASN.1 Encode (Helper function)
*
* @param String $source
* @param String $mapping
* @param Integer $idx
* @return String
* @param string $source
* @param string $mapping
* @param int $idx
* @return string
* @access private
*/
function _encode_der($source, $mapping, $idx = null, $special = array())
@ -1150,8 +1150,8 @@ class File_ASN1
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @access private
* @param Integer $length
* @return String
* @param int $length
* @return string
*/
function _encodeLength($length)
{
@ -1169,9 +1169,9 @@ class File_ASN1
* Called by _decode_ber() and in the case of implicit tags asn1map().
*
* @access private
* @param String $content
* @param Integer $tag
* @return String
* @param string $content
* @param int $tag
* @return string
*/
function _decodeTime($content, $tag)
{
@ -1218,7 +1218,7 @@ class File_ASN1
* Sets the time / date format for asn1map().
*
* @access public
* @param String $format
* @param string $format
*/
function setTimeFormat($format)
{
@ -1231,7 +1231,7 @@ class File_ASN1
* Load the relevant OIDs for a particular ASN.1 semantic mapping.
*
* @access public
* @param Array $oids
* @param array $oids
*/
function loadOIDs($oids)
{
@ -1244,7 +1244,7 @@ class File_ASN1
* See File_X509, etc, for an example.
*
* @access public
* @param Array $filters
* @param array $filters
*/
function loadFilters($filters)
{
@ -1256,9 +1256,9 @@ class File_ASN1
*
* Inspired by array_shift
*
* @param String $string
* @param Integer $index
* @return String
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
@ -1274,10 +1274,10 @@ class File_ASN1
* This is a lazy conversion, dealing only with character size.
* No real conversion table is used.
*
* @param String $in
* @param Integer $from
* @param Integer $to
* @return String
* @param string $in
* @param int $from
* @param int $to
* @return string
* @access public
*/
function convert($in, $from = FILE_ASN1_TYPE_UTF8_STRING, $to = FILE_ASN1_TYPE_UTF8_STRING)

396
phpseclib/File/X509.php
View File

@ -132,7 +132,7 @@ class File_X509
/**
* ASN.1 syntax for X.509 certificates
*
* @var Array
* @var array
* @access private
*/
var $Certificate;
@ -181,7 +181,7 @@ class File_X509
/**
* ASN.1 syntax for Certificate Signing Requests (RFC2986)
*
* @var Array
* @var array
* @access private
*/
var $CertificationRequest;
@ -189,7 +189,7 @@ class File_X509
/**
* ASN.1 syntax for Certificate Revocation Lists (RFC5280)
*
* @var Array
* @var array
* @access private
*/
var $CertificateList;
@ -197,7 +197,7 @@ class File_X509
/**
* Distinguished Name
*
* @var Array
* @var array
* @access private
*/
var $dn;
@ -205,7 +205,7 @@ class File_X509
/**
* Public key
*
* @var String
* @var string
* @access private
*/
var $publicKey;
@ -213,7 +213,7 @@ class File_X509
/**
* Private key
*
* @var String
* @var string
* @access private
*/
var $privateKey;
@ -221,7 +221,7 @@ class File_X509
/**
* Object identifiers for X.509 certificates
*
* @var Array
* @var array
* @access private
* @link http://en.wikipedia.org/wiki/Object_identifier
*/
@ -230,7 +230,7 @@ class File_X509
/**
* The certificate authorities
*
* @var Array
* @var array
* @access private
*/
var $CAs;
@ -238,7 +238,7 @@ class File_X509
/**
* The currently loaded certificate
*
* @var Array
* @var array
* @access private
*/
var $currentCert;
@ -249,7 +249,7 @@ class File_X509
* There's no guarantee File_X509 is going to reencode an X.509 cert in the same way it was originally
* encoded so we take save the portion of the original cert that the signature would have made for.
*
* @var String
* @var string
* @access private
*/
var $signatureSubject;
@ -257,7 +257,7 @@ class File_X509
/**
* Certificate Start Date
*
* @var String
* @var string
* @access private
*/
var $startDate;
@ -265,7 +265,7 @@ class File_X509
/**
* Certificate End Date
*
* @var String
* @var string
* @access private
*/
var $endDate;
@ -273,7 +273,7 @@ class File_X509
/**
* Serial Number
*
* @var String
* @var string
* @access private
*/
var $serialNumber;
@ -284,7 +284,7 @@ class File_X509
* See {@link http://tools.ietf.org/html/rfc5280#section-4.2.1.1 RFC5280#section-4.2.1.1} and
* {@link http://tools.ietf.org/html/rfc5280#section-4.2.1.2 RFC5280#section-4.2.1.2}.
*
* @var String
* @var string
* @access private
*/
var $currentKeyIdentifier;
@ -292,7 +292,7 @@ class File_X509
/**
* CA Flag
*
* @var Boolean
* @var bool
* @access private
*/
var $caFlag = false;
@ -300,7 +300,7 @@ class File_X509
/**
* SPKAC Challenge
*
* @var String
* @var string
* @access private
*/
var $challenge;
@ -1422,9 +1422,9 @@ class File_X509
*
* Returns an associative array describing the X.509 cert or a false if the cert failed to load
*
* @param String $cert
* @param string $cert
* @access public
* @return Mixed
* @return mixed
*/
function loadX509($cert)
{
@ -1484,10 +1484,10 @@ class File_X509
/**
* Save X.509 certificate
*
* @param Array $cert
* @param Integer $format optional
* @param array $cert
* @param int $format optional
* @access public
* @return String
* @return string
*/
function saveX509($cert, $format = FILE_X509_FORMAT_PEM)
{
@ -1560,9 +1560,9 @@ class File_X509
* Map extension values from octet string to extension-specific internal
* format.
*
* @param Array ref $root
* @param String $path
* @param Object $asn1
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapInExtensions(&$root, $path, $asn1)
@ -1610,9 +1610,9 @@ class File_X509
* Map extension values from extension-specific internal format to
* octet string.
*
* @param Array ref $root
* @param String $path
* @param Object $asn1
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapOutExtensions(&$root, $path, $asn1)
@ -1676,9 +1676,9 @@ class File_X509
* Map attribute values from ANY type to attribute-specific internal
* format.
*
* @param Array ref $root
* @param String $path
* @param Object $asn1
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapInAttributes(&$root, $path, $asn1)
@ -1717,9 +1717,9 @@ class File_X509
* Map attribute values from attribute-specific internal format to
* ANY type.
*
* @param Array ref $root
* @param String $path
* @param Object $asn1
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapOutAttributes(&$root, $path, $asn1)
@ -1759,9 +1759,9 @@ class File_X509
/**
* Associate an extension ID to an extension mapping
*
* @param String $extnId
* @param string $extnId
* @access private
* @return Mixed
* @return mixed
*/
function _getMapping($extnId)
{
@ -1855,9 +1855,9 @@ class File_X509
/**
* Load an X.509 certificate as a certificate authority
*
* @param String $cert
* @param string $cert
* @access public
* @return Boolean
* @return bool
*/
function loadCA($cert)
{
@ -1922,9 +1922,9 @@ class File_X509
* component or component fragment. E.g., *.a.com matches foo.a.com but
* not bar.foo.a.com. f*.com matches foo.com but not bar.com.
*
* @param String $url
* @param string $url
* @access public
* @return Boolean
* @return bool
*/
function validateURL($url)
{
@ -1980,7 +1980,7 @@ class File_X509
*
* If $date isn't defined it is assumed to be the current date.
*
* @param Integer $date optional
* @param int $date optional
* @access public
*/
function validateDate($date = null)
@ -2019,9 +2019,9 @@ class File_X509
*
* The behavior of this function is inspired by {@link http://php.net/openssl-verify openssl_verify}.
*
* @param Boolean $caonly optional
* @param bool $caonly optional
* @access public
* @return Mixed
* @return mixed
*/
function validateSignature($caonly = true)
{
@ -2129,13 +2129,13 @@ class File_X509
*
* Returns true if the signature is verified, false if it is not correct or null on error
*
* @param String $publicKeyAlgorithm
* @param String $publicKey
* @param String $signatureAlgorithm
* @param String $signature
* @param String $signatureSubject
* @param string $publicKeyAlgorithm
* @param string $publicKey
* @param string $signatureAlgorithm
* @param string $signature
* @param string $signatureSubject
* @access private
* @return Integer
* @return int
*/
function _validateSignature($publicKeyAlgorithm, $publicKey, $signatureAlgorithm, $signature, $signatureSubject)
{
@ -2177,10 +2177,10 @@ class File_X509
*
* Reformats a public key to a format supported by phpseclib (if applicable)
*
* @param String $algorithm
* @param String $key
* @param string $algorithm
* @param string $key
* @access private
* @return String
* @return string
*/
function _reformatKey($algorithm, $key)
{
@ -2203,9 +2203,9 @@ class File_X509
*
* Takes in a base64 encoded "blob" and returns a human readable IP address
*
* @param String $ip
* @param string $ip
* @access private
* @return String
* @return string
*/
function _decodeIP($ip)
{
@ -2219,9 +2219,9 @@ class File_X509
*
* Takes a human readable IP address into a base64-encoded "blob"
*
* @param String $ip
* @param string $ip
* @access private
* @return String
* @return string
*/
function _encodeIP($ip)
{
@ -2231,9 +2231,9 @@ class File_X509
/**
* "Normalizes" a Distinguished Name property
*
* @param String $propName
* @param string $propName
* @access private
* @return Mixed
* @return mixed
*/
function _translateDNProp($propName)
{
@ -2320,11 +2320,11 @@ class File_X509
/**
* Set a Distinguished Name property
*
* @param String $propName
* @param Mixed $propValue
* @param String $type optional
* @param string $propName
* @param mixed $propValue
* @param string $type optional
* @access public
* @return Boolean
* @return bool
*/
function setDNProp($propName, $propValue, $type = 'utf8String')
{
@ -2354,7 +2354,7 @@ class File_X509
/**
* Remove Distinguished Name properties
*
* @param String $propName
* @param string $propName
* @access public
*/
function removeDNProp($propName)
@ -2381,10 +2381,10 @@ class File_X509
/**
* Get Distinguished Name properties
*
* @param String $propName
* @param Array $dn optional
* @param Boolean $withType optional
* @return Mixed
* @param string $propName
* @param array $dn optional
* @param bool $withType optional
* @return mixed
* @access public
*/
function getDNProp($propName, $dn = null, $withType = false)
@ -2432,11 +2432,11 @@ class File_X509
/**
* Set a Distinguished Name
*
* @param Mixed $dn
* @param Boolean $merge optional
* @param String $type optional
* @param mixed $dn
* @param bool $merge optional
* @param string $type optional
* @access public
* @return Boolean
* @return bool
*/
function setDN($dn, $merge = false, $type = 'utf8String')
{
@ -2475,10 +2475,10 @@ class File_X509
/**
* Get the Distinguished Name for a certificates subject
*
* @param Mixed $format optional
* @param Array $dn optional
* @param mixed $format optional
* @param array $dn optional
* @access public
* @return Boolean
* @return bool
*/
function getDN($format = FILE_X509_DN_ARRAY, $dn = null)
{
@ -2621,9 +2621,9 @@ class File_X509
/**
* Get the Distinguished Name for a certificate/crl issuer
*
* @param Integer $format optional
* @param int $format optional
* @access public
* @return Mixed
* @return mixed
*/
function getIssuerDN($format = FILE_X509_DN_ARRAY)
{
@ -2643,9 +2643,9 @@ class File_X509
* Get the Distinguished Name for a certificate/csr subject
* Alias of getDN()
*
* @param Integer $format optional
* @param int $format optional
* @access public
* @return Mixed
* @return mixed
*/
function getSubjectDN($format = FILE_X509_DN_ARRAY)
{
@ -2666,10 +2666,10 @@ class File_X509
/**
* Get an individual Distinguished Name property for a certificate/crl issuer
*
* @param String $propName
* @param Boolean $withType optional
* @param string $propName
* @param bool $withType optional
* @access public
* @return Mixed
* @return mixed
*/
function getIssuerDNProp($propName, $withType = false)
{
@ -2688,10 +2688,10 @@ class File_X509
/**
* Get an individual Distinguished Name property for a certificate/csr subject
*
* @param String $propName
* @param Boolean $withType optional
* @param string $propName
* @param bool $withType optional
* @access public
* @return Mixed
* @return mixed
*/
function getSubjectDNProp($propName, $withType = false)
{
@ -2713,7 +2713,7 @@ class File_X509
* Get the certificate chain for the current cert
*
* @access public
* @return Mixed
* @return mixed
*/
function getChain()
{
@ -2759,9 +2759,9 @@ class File_X509
*
* Key needs to be a Crypt_RSA object
*
* @param Object $key
* @param object $key
* @access public
* @return Boolean
* @return bool
*/
function setPublicKey($key)
{
@ -2774,7 +2774,7 @@ class File_X509
*
* Key needs to be a Crypt_RSA object
*
* @param Object $key
* @param object $key
* @access public
*/
function setPrivateKey($key)
@ -2787,7 +2787,7 @@ class File_X509
*
* Used for SPKAC CSR's
*
* @param String $challenge
* @param string $challenge
* @access public
*/
function setChallenge($challenge)
@ -2801,7 +2801,7 @@ class File_X509
* Returns a Crypt_RSA object or a false.
*
* @access public
* @return Mixed
* @return mixed
*/
function getPublicKey()
{
@ -2842,9 +2842,9 @@ class File_X509
/**
* Load a Certificate Signing Request
*
* @param String $csr
* @param string $csr
* @access public
* @return Mixed
* @return mixed
*/
function loadCSR($csr)
{
@ -2918,10 +2918,10 @@ class File_X509
/**
* Save CSR request
*
* @param Array $csr
* @param Integer $format optional
* @param array $csr
* @param int $format optional
* @access public
* @return String
* @return string
*/
function saveCSR($csr, $format = FILE_X509_FORMAT_PEM)
{
@ -2970,9 +2970,9 @@ class File_X509
*
* https://developer.mozilla.org/en-US/docs/HTML/Element/keygen
*
* @param String $csr
* @param string $csr
* @access public
* @return Mixed
* @return mixed
*/
function loadSPKAC($spkac)
{
@ -3044,10 +3044,10 @@ class File_X509
/**
* Save a SPKAC CSR request
*
* @param Array $csr
* @param Integer $format optional
* @param array $csr
* @param int $format optional
* @access public
* @return String
* @return string
*/
function saveSPKAC($spkac, $format = FILE_X509_FORMAT_PEM)
{
@ -3087,9 +3087,9 @@ class File_X509
/**
* Load a Certificate Revocation List
*
* @param String $crl
* @param string $crl
* @access public
* @return Mixed
* @return mixed
*/
function loadCRL($crl)
{
@ -3142,10 +3142,10 @@ class File_X509
/**
* Save Certificate Revocation List.
*
* @param Array $crl
* @param Integer $format optional
* @param array $crl
* @param int $format optional
* @access public
* @return String
* @return string
*/
function saveCRL($crl, $format = FILE_X509_FORMAT_PEM)
{
@ -3204,9 +3204,9 @@ class File_X509
* - 5.1.2.6 Revoked Certificates
* by choosing utcTime iff year of date given is before 2050 and generalTime else.
*
* @param String $date in format date('D, d M Y H:i:s O')
* @param string $date in format date('D, d M Y H:i:s O')
* @access private
* @return Array
* @return array
*/
function _timeField($date)
{
@ -3227,9 +3227,9 @@ class File_X509
*
* @param File_X509 $issuer
* @param File_X509 $subject
* @param String $signatureAlgorithm optional
* @param string $signatureAlgorithm optional
* @access public
* @return Mixed
* @return mixed
*/
function sign($issuer, $subject, $signatureAlgorithm = 'sha1WithRSAEncryption')
{
@ -3411,7 +3411,7 @@ class File_X509
* Sign a CSR
*
* @access public
* @return Mixed
* @return mixed
*/
function signCSR($signatureAlgorithm = 'sha1WithRSAEncryption')
{
@ -3469,7 +3469,7 @@ class File_X509
* Sign a SPKAC
*
* @access public
* @return Mixed
* @return mixed
*/
function signSPKAC($signatureAlgorithm = 'sha1WithRSAEncryption')
{
@ -3537,9 +3537,9 @@ class File_X509
*
* @param File_X509 $issuer
* @param File_X509 $crl
* @param String $signatureAlgorithm optional
* @param string $signatureAlgorithm optional
* @access public
* @return Mixed
* @return mixed
*/
function signCRL($issuer, $crl, $signatureAlgorithm = 'sha1WithRSAEncryption')
{
@ -3664,11 +3664,11 @@ class File_X509
/**
* X.509 certificate signing helper function.
*
* @param Object $key
* @param object $key
* @param File_X509 $subject
* @param String $signatureAlgorithm
* @param string $signatureAlgorithm
* @access public
* @return Mixed
* @return mixed
*/
function _sign($key, $signatureAlgorithm)
{
@ -3696,7 +3696,7 @@ class File_X509
/**
* Set certificate start date
*
* @param String $date
* @param string $date
* @access public
*/
function setStartDate($date)
@ -3707,7 +3707,7 @@ class File_X509
/**
* Set certificate end date
*
* @param String $date
* @param string $date
* @access public
*/
function setEndDate($date)
@ -3732,7 +3732,7 @@ class File_X509
/**
* Set Serial Number
*
* @param String $serial
* @param string $serial
* @param $base optional
* @access public
*/
@ -3755,8 +3755,8 @@ class File_X509
* Get a reference to a subarray
*
* @param array $root
* @param String $path absolute path with / as component separator
* @param Boolean $create optional
* @param string $path absolute path with / as component separator
* @param bool $create optional
* @access private
* @return array item ref or false
*/
@ -3791,8 +3791,8 @@ class File_X509
* Get a reference to an extension subarray
*
* @param array $root
* @param String $path optional absolute path with / as component separator
* @param Boolean $create optional
* @param string $path optional absolute path with / as component separator
* @param bool $create optional
* @access private
* @return array ref or false
*/
@ -3845,10 +3845,10 @@ class File_X509
/**
* Remove an Extension
*
* @param String $id
* @param String $path optional
* @param string $id
* @param string $path optional
* @access private
* @return Boolean
* @return bool
*/
function _removeExtension($id, $path = null)
{
@ -3875,11 +3875,11 @@ class File_X509
*
* Returns the extension if it exists and false if not
*
* @param String $id
* @param Array $cert optional
* @param String $path optional
* @param string $id
* @param array $cert optional
* @param string $path optional
* @access private
* @return Mixed
* @return mixed
*/
function _getExtension($id, $cert = null, $path = null)
{
@ -3902,9 +3902,9 @@ class File_X509
* Returns a list of all extensions in use
*
* @param array $cert optional
* @param String $path optional
* @param string $path optional
* @access private
* @return Array
* @return array
*/
function _getExtensions($cert = null, $path = null)
{
@ -3923,13 +3923,13 @@ class File_X509
/**
* Set an Extension
*
* @param String $id
* @param Mixed $value
* @param Boolean $critical optional
* @param Boolean $replace optional
* @param String $path optional
* @param string $id
* @param mixed $value
* @param bool $critical optional
* @param bool $replace optional
* @param string $path optional
* @access private
* @return Boolean
* @return bool
*/
function _setExtension($id, $value, $critical = false, $replace = true, $path = null)
{
@ -3959,9 +3959,9 @@ class File_X509
/**
* Remove a certificate, CSR or CRL Extension
*
* @param String $id
* @param string $id
* @access public
* @return Boolean
* @return bool
*/
function removeExtension($id)
{
@ -3973,10 +3973,10 @@ class File_X509
*
* Returns the extension if it exists and false if not
*
* @param String $id
* @param Array $cert optional
* @param string $id
* @param array $cert optional
* @access public
* @return Mixed
* @return mixed
*/
function getExtension($id, $cert = null)
{
@ -3988,7 +3988,7 @@ class File_X509
*
* @param array $cert optional
* @access public
* @return Array
* @return array
*/
function getExtensions($cert = null)
{
@ -3998,12 +3998,12 @@ class File_X509
/**
* Set a certificate, CSR or CRL Extension
*
* @param String $id
* @param Mixed $value
* @param Boolean $critical optional
* @param Boolean $replace optional
* @param string $id
* @param mixed $value
* @param bool $critical optional
* @param bool $replace optional
* @access public
* @return Boolean
* @return bool
*/
function setExtension($id, $value, $critical = false, $replace = true)
{
@ -4013,10 +4013,10 @@ class File_X509
/**
* Remove a CSR attribute.
*
* @param String $id
* @param Integer $disposition optional
* @param string $id
* @param int $disposition optional
* @access public
* @return Boolean
* @return bool
*/
function removeAttribute($id, $disposition = FILE_X509_ATTR_ALL)
{
@ -4063,11 +4063,11 @@ class File_X509
*
* Returns the attribute if it exists and false if not
*
* @param String $id
* @param Integer $disposition optional
* @param Array $csr optional
* @param string $id
* @param int $disposition optional
* @param array $csr optional
* @access public
* @return Mixed
* @return mixed
*/
function getAttribute($id, $disposition = FILE_X509_ATTR_ALL, $csr = null)
{
@ -4107,7 +4107,7 @@ class File_X509
*
* @param array $csr optional
* @access public
* @return Array
* @return array
*/
function getAttributes($csr = null)
{
@ -4130,11 +4130,11 @@ class File_X509
/**
* Set a CSR attribute
*
* @param String $id
* @param Mixed $value
* @param Boolean $disposition optional
* @param string $id
* @param mixed $value
* @param bool $disposition optional
* @access public
* @return Boolean
* @return bool
*/
function setAttribute($id, $value, $disposition = FILE_X509_ATTR_ALL)
{
@ -4188,7 +4188,7 @@ class File_X509
*
* This is used by the id-ce-authorityKeyIdentifier and the id-ce-subjectKeyIdentifier extensions.
*
* @param String $value
* @param string $value
* @access public
*/
function setKeyIdentifier($value)
@ -4213,10 +4213,10 @@ class File_X509
* - File_ASN1_Element object
* - PEM or DER string
*
* @param Mixed $key optional
* @param Integer $method optional
* @param mixed $key optional
* @param int $method optional
* @access public
* @return String binary key identifier
* @return string binary key identifier
*/
function computeKeyIdentifier($key = null, $method = 1)
{
@ -4296,7 +4296,7 @@ class File_X509
* Format a public key as appropriate
*
* @access private
* @return Array
* @return array
*/
function _formatSubjectPublicKey()
{
@ -4322,7 +4322,7 @@ class File_X509
* Set the domain name's which the cert is to be valid for
*
* @access public
* @return Array
* @return array
*/
function setDomain()
{
@ -4335,7 +4335,7 @@ class File_X509
* Set the IP Addresses's which the cert is to be valid for
*
* @access public
* @param String $ipAddress optional
* @param string $ipAddress optional
*/
function setIPAddress()
{
@ -4352,8 +4352,8 @@ class File_X509
* Helper function to build domain array
*
* @access private
* @param String $domain
* @return Array
* @param string $domain
* @return array
*/
function _dnsName($domain)
{
@ -4366,8 +4366,8 @@ class File_X509
* (IPv6 is not currently supported)
*
* @access private
* @param String $address
* @return Array
* @param string $address
* @return array
*/
function _iPAddress($address)
{
@ -4378,10 +4378,10 @@ class File_X509
* Get the index of a revoked certificate.
*
* @param array $rclist
* @param String $serial
* @param Boolean $create optional
* @param string $serial
* @param bool $create optional
* @access private
* @return Integer or false
* @return int or false
*/
function _revokedCertificate(&$rclist, $serial, $create = false)
{
@ -4406,10 +4406,10 @@ class File_X509
/**
* Revoke a certificate.
*
* @param String $serial
* @param String $date optional
* @param string $serial
* @param string $date optional
* @access public
* @return Boolean
* @return bool
*/
function revoke($serial, $date = null)
{
@ -4433,9 +4433,9 @@ class File_X509
/**
* Unrevoke a certificate.
*
* @param String $serial
* @param string $serial
* @access public
* @return Boolean
* @return bool
*/
function unrevoke($serial)
{
@ -4453,9 +4453,9 @@ class File_X509
/**
* Get a revoked certificate.
*
* @param String $serial
* @param string $serial
* @access public
* @return Mixed
* @return mixed
*/
function getRevoked($serial)
{
@ -4499,10 +4499,10 @@ class File_X509
/**
* Remove a Revoked Certificate Extension
*
* @param String $serial
* @param String $id
* @param string $serial
* @param string $id
* @access public
* @return Boolean
* @return bool
*/
function removeRevokedCertificateExtension($serial, $id)
{
@ -4520,11 +4520,11 @@ class File_X509
*
* Returns the extension if it exists and false if not
*
* @param String $serial
* @param String $id
* @param Array $crl optional
* @param string $serial
* @param string $id
* @param array $crl optional
* @access public
* @return Mixed
* @return mixed
*/
function getRevokedCertificateExtension($serial, $id, $crl = null)
{
@ -4544,10 +4544,10 @@ class File_X509
/**
* Returns a list of all extensions in use for a given revoked certificate
*
* @param String $serial
* @param string $serial
* @param array $crl optional
* @access public
* @return Array
* @return array
*/
function getRevokedCertificateExtensions($serial, $crl = null)
{
@ -4567,13 +4567,13 @@ class File_X509
/**
* Set a Revoked Certificate Extension
*
* @param String $serial
* @param String $id
* @param Mixed $value
* @param Boolean $critical optional
* @param Boolean $replace optional
* @param string $serial
* @param string $id
* @param mixed $value
* @param bool $critical optional
* @param bool $replace optional
* @access public
* @return Boolean
* @return bool
*/
function setRevokedCertificateExtension($serial, $id, $value, $critical = false, $replace = true)
{
@ -4592,8 +4592,8 @@ class File_X509
* Extract raw BER from Base64 encoding
*
* @access private
* @param String $str
* @return String
* @param string $str
* @return string
*/
function _extractBER($str)
{

232
phpseclib/Math/BigInteger.php
View File

@ -178,7 +178,7 @@ class Math_BigInteger
/**
* Holds the BigInteger's value.
*
* @var Array
* @var array
* @access private
*/
var $value;
@ -186,7 +186,7 @@ class Math_BigInteger
/**
* Holds the BigInteger's magnitude.
*
* @var Boolean
* @var bool
* @access private
*/
var $is_negative = false;
@ -224,7 +224,7 @@ class Math_BigInteger
*
* @see __sleep()
* @see __wakeup()
* @var String
* @var string
* @access private
*/
var $hex;
@ -247,7 +247,7 @@ class Math_BigInteger
* </code>
*
* @param $x base-10 number or base-$base number if $base set.
* @param integer $base
* @param int $base
* @return Math_BigInteger
* @access public
*/
@ -524,8 +524,8 @@ class Math_BigInteger
* ?>
* </code>
*
* @param Boolean $twos_compliment
* @return String
* @param bool $twos_compliment
* @return string
* @access public
* @internal Converts a base-2**26 number to base-2**8
*/
@ -621,8 +621,8 @@ class Math_BigInteger
* ?>
* </code>
*
* @param Boolean $twos_compliment
* @return String
* @param bool $twos_compliment
* @return string
* @access public
* @internal Converts a base-2**26 number to base-2**8
*/
@ -648,8 +648,8 @@ class Math_BigInteger
* ?>
* </code>
*
* @param Boolean $twos_compliment
* @return String
* @param bool $twos_compliment
* @return string
* @access public
* @internal Converts a base-2**26 number to base-2**2
*/
@ -686,7 +686,7 @@ class Math_BigInteger
* ?>
* </code>
*
* @return String
* @return string
* @access public
* @internal Converts a base-2**26 number to base-10**7 (which is pretty much base-10)
*/
@ -874,11 +874,11 @@ class Math_BigInteger
/**
* Performs addition.
*
* @param Array $x_value
* @param Boolean $x_negative
* @param Array $y_value
* @param Boolean $y_negative
* @return Array
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return array
* @access private
*/
function _add($x_value, $x_negative, $y_value, $y_negative)
@ -1005,11 +1005,11 @@ class Math_BigInteger
/**
* Performs subtraction.
*
* @param Array $x_value
* @param Boolean $x_negative
* @param Array $y_value
* @param Boolean $y_negative
* @return Array
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return array
* @access private
*/
function _subtract($x_value, $x_negative, $y_value, $y_negative)
@ -1140,11 +1140,11 @@ class Math_BigInteger
/**
* Performs multiplication.
*
* @param Array $x_value
* @param Boolean $x_negative
* @param Array $y_value
* @param Boolean $y_negative
* @return Array
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return array
* @access private
*/
function _multiply($x_value, $x_negative, $y_value, $y_negative)
@ -1179,9 +1179,9 @@ class Math_BigInteger
*
* Modeled after 'multiply' in MutableBigInteger.java.
*
* @param Array $x_value
* @param Array $y_value
* @return Array
* @param array $x_value
* @param array $y_value
* @return array
* @access private
*/
function _regularMultiply($x_value, $y_value)
@ -1243,9 +1243,9 @@ class Math_BigInteger
* See {@link http://en.wikipedia.org/wiki/Karatsuba_algorithm Karatsuba algorithm} and
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=120 MPM 5.2.3}.
*
* @param Array $x_value
* @param Array $y_value
* @return Array
* @param array $x_value
* @param array $y_value
* @return array
* @access private
*/
function _karatsuba($x_value, $y_value)
@ -1282,8 +1282,8 @@ class Math_BigInteger
/**
* Performs squaring
*
* @param Array $x
* @return Array
* @param array $x
* @return array
* @access private
*/
function _square($x = false)
@ -1300,8 +1300,8 @@ class Math_BigInteger
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=7 HAC 14.2.4} /
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=141 MPM 5.3} for more information.
*
* @param Array $value
* @return Array
* @param array $value
* @return array
* @access private
*/
function _baseSquare($value)
@ -1339,8 +1339,8 @@ class Math_BigInteger
* See {@link http://en.wikipedia.org/wiki/Karatsuba_algorithm Karatsuba algorithm} and
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=151 MPM 5.3.4}.
*
* @param Array $value
* @return Array
* @param array $value
* @return array
* @access private
*/
function _karatsubaSquare($value)
@ -1396,7 +1396,7 @@ class Math_BigInteger
* </code>
*
* @param Math_BigInteger $y
* @return Array
* @return array
* @access public
* @internal This function is based off of {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=9 HAC 14.20}.
*/
@ -1576,9 +1576,9 @@ class Math_BigInteger
*
* abc / x = a00 / x + b0 / x + c / x
*
* @param Array $dividend
* @param Array $divisor
* @return Array
* @param array $dividend
* @param array $divisor
* @return array
* @access private
*/
function _divide_digit($dividend, $divisor)
@ -1803,7 +1803,7 @@ class Math_BigInteger
*
* @param Math_BigInteger $e
* @param Math_BigInteger $n
* @param Integer $mode
* @param int $mode
* @return Math_BigInteger
* @access private
*/
@ -1878,10 +1878,10 @@ class Math_BigInteger
*
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $n
* @param Integer $mode
* @return Array
* @param array $x
* @param array $n
* @param int $mode
* @return array
*/
function _reduce($x, $n, $mode)
{
@ -1915,10 +1915,10 @@ class Math_BigInteger
*
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $n
* @param Integer $mode
* @return Array
* @param array $x
* @param array $n
* @param int $mode
* @return array
*/
function _prepareReduce($x, $n, $mode)
{
@ -1933,11 +1933,11 @@ class Math_BigInteger
*
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $y
* @param Array $n
* @param Integer $mode
* @return Array
* @param array $x
* @param array $y
* @param array $n
* @param int $mode
* @return array
*/
function _multiplyReduce($x, $y, $n, $mode)
{
@ -1953,10 +1953,10 @@ class Math_BigInteger
*
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $n
* @param Integer $mode
* @return Array
* @param array $x
* @param array $n
* @param int $mode
* @return array
*/
function _squareReduce($x, $n, $mode)
{
@ -2004,9 +2004,9 @@ class Math_BigInteger
*
* @see _slidingWindow()
* @access private
* @param Array $n
* @param Array $m
* @return Array
* @param array $n
* @param array $m
* @return array
*/
function _barrett($n, $m)
{
@ -2101,9 +2101,9 @@ class Math_BigInteger
*
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $n
* @return Array
* @param array $x
* @param array $n
* @return array
*/
function _regularBarrett($x, $n)
{
@ -2171,12 +2171,12 @@ class Math_BigInteger
* If you're going to be doing array_slice($product->value, 0, $stop), some cycles can be saved.
*
* @see _regularBarrett()
* @param Array $x_value
* @param Boolean $x_negative
* @param Array $y_value
* @param Boolean $y_negative
* @param Integer $stop
* @return Array
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @param int $stop
* @return array
* @access private
*/
function _multiplyLower($x_value, $x_negative, $y_value, $y_negative, $stop)
@ -2254,9 +2254,9 @@ class Math_BigInteger
* @see _prepMontgomery()
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $n
* @return Array
* @param array $x
* @param array $n
* @return array
*/
function _montgomery($x, $n)
{
@ -2301,10 +2301,10 @@ class Math_BigInteger
* @see _prepMontgomery()
* @see _montgomery()
* @access private
* @param Array $x
* @param Array $y
* @param Array $m
* @return Array
* @param array $x
* @param array $y
* @param array $m
* @return array
*/
function _montgomeryMultiply($x, $y, $m)
{
@ -2353,9 +2353,9 @@ class Math_BigInteger
* @see _montgomery()
* @see _slidingWindow()
* @access private
* @param Array $x
* @param Array $n
* @return Array
* @param array $x
* @param array $n
* @return array
*/
function _prepMontgomery($x, $n)
{
@ -2391,8 +2391,8 @@ class Math_BigInteger
*
* @see _montgomery()
* @access private
* @param Array $x
* @return Integer
* @param array $x
* @return int
*/
function _modInverse67108864($x) // 2**26 == 67,108,864
{
@ -2674,7 +2674,7 @@ class Math_BigInteger
* Note how the same comparison operator is used. If you want to test for equality, use $x->equals($y).
*
* @param Math_BigInteger $y
* @return Integer < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @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()
* @internal Could return $this->subtract($x), but that's not as fast as what we do do.
@ -2694,11 +2694,11 @@ class Math_BigInteger
/**
* Compares two numbers.
*
* @param Array $x_value
* @param Boolean $x_negative
* @param Array $y_value
* @param Boolean $y_negative
* @return Integer
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return int
* @see compare()
* @access private
*/
@ -2733,7 +2733,7 @@ class Math_BigInteger
* If you need to see if one number is greater than or less than another number, use Math_BigInteger::compare()
*
* @param Math_BigInteger $x
* @return Boolean
* @return bool
* @access public
* @see compare()
*/
@ -2753,7 +2753,7 @@ class Math_BigInteger
* Some bitwise operations give different results depending on the precision being used. Examples include left
* shift, not, and rotates.
*
* @param Integer $bits
* @param int $bits
* @access public
*/
function setPrecision($bits)
@ -2931,7 +2931,7 @@ class Math_BigInteger
*
* Shifts BigInteger's by $shift bits, effectively dividing by 2**$shift.
*
* @param Integer $shift
* @param int $shift
* @return Math_BigInteger
* @access public
* @internal The only version that yields any speed increases is the internal version.
@ -2969,7 +2969,7 @@ class Math_BigInteger
*
* Shifts BigInteger's by $shift bits, effectively multiplying by 2**$shift.
*
* @param Integer $shift
* @param int $shift
* @return Math_BigInteger
* @access public
* @internal The only version that yields any speed increases is the internal version.
@ -3007,7 +3007,7 @@ class Math_BigInteger
*
* Instead of the top x bits being dropped they're appended to the shifted bit string.
*
* @param Integer $shift
* @param int $shift
* @return Math_BigInteger
* @access public
*/
@ -3052,7 +3052,7 @@ class Math_BigInteger
*
* Instead of the bottom x bits being dropped they're prepended to the shifted bit string.
*
* @param Integer $shift
* @param int $shift
* @return Math_BigInteger
* @access public
*/
@ -3066,7 +3066,7 @@ class Math_BigInteger
*
* This function is deprecated.
*
* @param String $generator
* @param string $generator
* @access public
*/
function setRandomGenerator($generator)
@ -3078,7 +3078,7 @@ class Math_BigInteger
*
* Byte length is equal to $length. Uses crypt_random if it's loaded and mt_rand if it's not.
*
* @param Integer $length
* @param int $length
* @return Math_BigInteger
* @access private
*/
@ -3195,8 +3195,8 @@ class Math_BigInteger
*
* @param Math_BigInteger $arg1
* @param Math_BigInteger $arg2
* @param Integer $timeout
* @return Mixed
* @param int $timeout
* @return mixed
* @access public
* @internal See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=15 HAC 4.44}.
*/
@ -3324,7 +3324,7 @@ class Math_BigInteger
* on a website instead of just one.
*
* @param Math_BigInteger $t
* @return Boolean
* @return bool
* @access public
* @internal Uses the
* {@link http://en.wikipedia.org/wiki/Miller%E2%80%93Rabin_primality_test Miller-Rabin primality test}. See
@ -3476,7 +3476,7 @@ class Math_BigInteger
*
* Shifts BigInteger's by $shift bits.
*
* @param Integer $shift
* @param int $shift
* @access private
*/
function _lshift($shift)
@ -3511,7 +3511,7 @@ class Math_BigInteger
*
* Shifts BigInteger's by $shift bits.
*
* @param Integer $shift
* @param int $shift
* @access private
*/
function _rshift($shift)
@ -3595,7 +3595,7 @@ class Math_BigInteger
*
* Removes leading zeros
*
* @param Array $value
* @param array $value
* @return Math_BigInteger
* @access private
*/
@ -3616,7 +3616,7 @@ class Math_BigInteger
*
* @param $input Array
* @param $multiplier mixed
* @return Array
* @return array
* @access private
*/
function _array_repeat($input, $multiplier)
@ -3631,7 +3631,7 @@ class Math_BigInteger
*
* @param $x String
* @param $shift Integer
* @return String
* @return string
* @access private
*/
function _base256_lshift(&$x, $shift)
@ -3660,7 +3660,7 @@ class Math_BigInteger
*
* @param $x String
* @param $shift Integer
* @return String
* @return string
* @access private
*/
function _base256_rshift(&$x, $shift)
@ -3700,8 +3700,8 @@ class Math_BigInteger
/**
* Converts 32-bit integers to bytes.
*
* @param Integer $x
* @return String
* @param int $x
* @return string
* @access private
*/
function _int2bytes($x)
@ -3712,8 +3712,8 @@ class Math_BigInteger
/**
* Converts bytes to 32-bit integers
*
* @param String $x
* @return Integer
* @param string $x
* @return int
* @access private
*/
function _bytes2int($x)
@ -3729,8 +3729,8 @@ class Math_BigInteger
*
* @see modPow()
* @access private
* @param Integer $length
* @return String
* @param int $length
* @return string
*/
function _encodeASN1Length($length)
{
@ -3751,9 +3751,9 @@ class Math_BigInteger
* we'll guarantee that the dividend is divisible by first subtracting the remainder.
*
* @access private
* @param Integer $x
* @param Integer $y
* @return Integer
* @param int $x
* @param int $y
* @return int
*/
function _safe_divide($x, $y)
{

32
phpseclib/Net/SCP.php
View File

@ -90,7 +90,7 @@ class Net_SCP
/**
* SSH Object
*
* @var Object
* @var object
* @access private
*/
var $ssh;
@ -98,7 +98,7 @@ class Net_SCP
/**
* Packet Size
*
* @var Integer
* @var int
* @access private
*/
var $packet_size;
@ -106,7 +106,7 @@ class Net_SCP
/**
* Mode
*
* @var Integer
* @var int
* @access private
*/
var $mode;
@ -116,9 +116,9 @@ class Net_SCP
*
* Connects to an SSH server
*
* @param String $host
* @param Integer $port
* @param Integer $timeout
* @param string $host
* @param int $port
* @param int $timeout
* @return Net_SCP
* @access public
*/
@ -157,11 +157,11 @@ class Net_SCP
* Currently, only binary mode is supported. As such, if the line endings need to be adjusted, you will need to take
* care of that, yourself.
*
* @param String $remote_file
* @param String $data
* @param Integer $mode
* @param Callable $callback
* @return Boolean
* @param string $remote_file
* @param string $data
* @param int $mode
* @param callable $callback
* @return bool
* @access public
*/
function put($remote_file, $data, $mode = NET_SCP_STRING, $callback = null)
@ -233,9 +233,9 @@ class Net_SCP
* the operation was unsuccessful. If $local_file is defined, returns true or false depending on the success of the
* operation
*
* @param String $remote_file
* @param String $local_file
* @return Mixed
* @param string $remote_file
* @param string $local_file
* @return mixed
* @access public
*/
function get($remote_file, $local_file = false)
@ -291,7 +291,7 @@ class Net_SCP
/**
* Sends a packet to an SSH server
*
* @param String $data
* @param string $data
* @access private
*/
function _send($data)
@ -309,7 +309,7 @@ class Net_SCP
/**
* Receives a packet from an SSH server
*
* @return String
* @return string
* @access private
*/
function _receive()

336
phpseclib/Net/SFTP.php
View File

@ -130,7 +130,7 @@ class Net_SFTP extends Net_SSH2
* Packet Types
*
* @see Net_SFTP::Net_SFTP()
* @var Array
* @var array
* @access private
*/
var $packet_types = array();
@ -139,7 +139,7 @@ class Net_SFTP extends Net_SSH2
* Status Codes
*
* @see Net_SFTP::Net_SFTP()
* @var Array
* @var array
* @access private
*/
var $status_codes = array();
@ -150,7 +150,7 @@ class Net_SFTP extends Net_SSH2
* The request ID exists in the off chance that a packet is sent out-of-order. Of course, this library doesn't support
* concurrent actions, so it's somewhat academic, here.
*
* @var Integer
* @var int
* @see Net_SFTP::_send_sftp_packet()
* @access private
*/
@ -162,7 +162,7 @@ class Net_SFTP extends Net_SSH2
* The request ID exists in the off chance that a packet is sent out-of-order. Of course, this library doesn't support
* concurrent actions, so it's somewhat academic, here.
*
* @var Integer
* @var int
* @see Net_SFTP::_get_sftp_packet()
* @access private
*/
@ -171,7 +171,7 @@ class Net_SFTP extends Net_SSH2
/**
* Packet Buffer
*
* @var String
* @var string
* @see Net_SFTP::_get_sftp_packet()
* @access private
*/
@ -180,7 +180,7 @@ class Net_SFTP extends Net_SSH2
/**
* Extensions supported by the server
*
* @var Array
* @var array
* @see Net_SFTP::_initChannel()
* @access private
*/
@ -189,7 +189,7 @@ class Net_SFTP extends Net_SSH2
/**
* Server SFTP version
*
* @var Integer
* @var int
* @see Net_SFTP::_initChannel()
* @access private
*/
@ -198,7 +198,7 @@ class Net_SFTP extends Net_SSH2
/**
* Current working directory
*
* @var String
* @var string
* @see Net_SFTP::_realpath()
* @see Net_SFTP::chdir()
* @access private
@ -209,7 +209,7 @@ class Net_SFTP extends Net_SSH2
* Packet Type Log
*
* @see Net_SFTP::getLog()
* @var Array
* @var array
* @access private
*/
var $packet_type_log = array();
@ -218,7 +218,7 @@ class Net_SFTP extends Net_SSH2
* Packet Log
*
* @see Net_SFTP::getLog()
* @var Array
* @var array
* @access private
*/
var $packet_log = array();
@ -228,7 +228,7 @@ class Net_SFTP extends Net_SSH2
*
* @see Net_SFTP::getSFTPErrors()
* @see Net_SFTP::getLastSFTPError()
* @var String
* @var string
* @access private
*/
var $sftp_errors = array();
@ -242,7 +242,7 @@ class Net_SFTP extends Net_SSH2
* @see Net_SFTP::_update_stat_cache()
* @see Net_SFTP::_remove_from_stat_cache()
* @see Net_SFTP::_query_stat_cache()
* @var Array
* @var array
* @access private
*/
var $stat_cache = array();
@ -252,7 +252,7 @@ class Net_SFTP extends Net_SSH2
*
* @see Net_SFTP::Net_SFTP()
* @see Net_SFTP::get()
* @var Array
* @var array
* @access private
*/
var $max_sftp_packet;
@ -262,7 +262,7 @@ class Net_SFTP extends Net_SSH2
*
* @see Net_SFTP::disableStatCache()
* @see Net_SFTP::enableStatCache()
* @var Boolean
* @var bool
* @access private
*/
var $use_stat_cache = true;
@ -272,7 +272,7 @@ class Net_SFTP extends Net_SSH2
*
* @see Net_SFTP::_comparator()
* @see Net_SFTP::setListOrder()
* @var Array
* @var array
* @access private
*/
var $sortOptions = array();
@ -282,9 +282,9 @@ class Net_SFTP extends Net_SSH2
*
* Connects to an SFTP server
*
* @param String $host
* @param Integer $port
* @param Integer $timeout
* @param string $host
* @param int $port
* @param int $timeout
* @return Net_SFTP
* @access public
*/
@ -420,9 +420,9 @@ class Net_SFTP extends Net_SSH2
/**
* Login
*
* @param String $username
* @param String $password
* @return Boolean
* @param string $username
* @param string $password
* @return bool
* @access public
*/
function login($username)
@ -610,7 +610,7 @@ class Net_SFTP extends Net_SSH2
/**
* Returns the current directory name
*
* @return Mixed
* @return mixed
* @access public
*/
function pwd()
@ -621,8 +621,8 @@ class Net_SFTP extends Net_SSH2
/**
* Logs errors
*
* @param String $response
* @param Integer $status
* @param string $response
* @param int $status
* @access public
*/
function _logError($response, $status = -1)
@ -648,8 +648,8 @@ class Net_SFTP extends Net_SSH2
* the absolute (canonicalized) path.
*
* @see Net_SFTP::chdir()
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access private
*/
function _realpath($path)
@ -704,8 +704,8 @@ class Net_SFTP extends Net_SSH2
/**
* Changes the current directory
*
* @param String $dir
* @return Boolean
* @param string $dir
* @return bool
* @access public
*/
function chdir($dir)
@ -766,9 +766,9 @@ class Net_SFTP extends Net_SSH2
/**
* Returns a list of files in the given directory
*
* @param String $dir
* @param Boolean $recursive
* @return Mixed
* @param string $dir
* @param bool $recursive
* @return mixed
* @access public
*/
function nlist($dir = '.', $recursive = false)
@ -779,10 +779,10 @@ class Net_SFTP extends Net_SSH2
/**
* Helper method for nlist
*
* @param String $dir
* @param Boolean $recursive
* @param String $relativeDir
* @return Mixed
* @param string $dir
* @param bool $recursive
* @param string $relativeDir
* @return mixed
* @access private
*/
function _nlist_helper($dir, $recursive, $relativeDir)
@ -815,9 +815,9 @@ class Net_SFTP extends Net_SSH2
/**
* Returns a detailed list of files in the given directory
*
* @param String $dir
* @param Boolean $recursive
* @return Mixed
* @param string $dir
* @param bool $recursive
* @return mixed
* @access public
*/
function rawlist($dir = '.', $recursive = false)
@ -849,9 +849,9 @@ class Net_SFTP extends Net_SSH2
/**
* Reads a list, be it detailed or not, of files in the given directory
*
* @param String $dir
* @param Boolean $raw
* @return Mixed
* @param string $dir
* @param bool $raw
* @return mixed
* @access private
*/
function _list($dir, $raw = true)
@ -959,9 +959,9 @@ class Net_SFTP extends Net_SSH2
*
* Intended for use with uasort()
*
* @param Array $a
* @param Array $b
* @return Integer
* @param array $a
* @param array $b
* @return int
* @access private
*/
function _comparator($a, $b)
@ -1059,8 +1059,8 @@ class Net_SFTP extends Net_SSH2
*
* Files larger than 4GB will show up as being exactly 4GB.
*
* @param String $filename
* @return Mixed
* @param string $filename
* @return mixed
* @access public
*/
function size($filename)
@ -1079,8 +1079,8 @@ class Net_SFTP extends Net_SSH2
/**
* Save files / directories to cache
*
* @param String $path
* @param Mixed $value
* @param string $path
* @param mixed $value
* @access private
*/
function _update_stat_cache($path, $value)
@ -1123,8 +1123,8 @@ class Net_SFTP extends Net_SSH2
/**
* Remove files / directories from cache
*
* @param String $path
* @return Boolean
* @param string $path
* @return bool
* @access private
*/
function _remove_from_stat_cache($path)
@ -1150,8 +1150,8 @@ class Net_SFTP extends Net_SSH2
*
* Mainly used by file_exists
*
* @param String $dir
* @return Mixed
* @param string $dir
* @return mixed
* @access private
*/
function _query_stat_cache($path)
@ -1173,8 +1173,8 @@ class Net_SFTP extends Net_SSH2
*
* Returns an array on success and false otherwise.
*
* @param String $filename
* @return Mixed
* @param string $filename
* @return mixed
* @access public
*/
function stat($filename)
@ -1230,8 +1230,8 @@ class Net_SFTP extends Net_SSH2
*
* Returns an array on success and false otherwise.
*
* @param String $filename
* @return Mixed
* @param string $filename
* @return mixed
* @access public
*/
function lstat($filename)
@ -1296,9 +1296,9 @@ class Net_SFTP extends Net_SSH2
* Determines information without calling Net_SFTP::_realpath().
* The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.
*
* @param String $filename
* @param Integer $type
* @return Mixed
* @param string $filename
* @param int $type
* @return mixed
* @access private
*/
function _stat($filename, $type)
@ -1325,9 +1325,9 @@ class Net_SFTP extends Net_SSH2
/**
* Truncates a file to a given length
*
* @param String $filename
* @param Integer $new_size
* @return Boolean
* @param string $filename
* @param int $new_size
* @return bool
* @access public
*/
function truncate($filename, $new_size)
@ -1342,10 +1342,10 @@ class Net_SFTP extends Net_SSH2
*
* If the file does not exist, it will be created.
*
* @param String $filename
* @param Integer $time
* @param Integer $atime
* @return Boolean
* @param string $filename
* @param int $time
* @param int $atime
* @return bool
* @access public
*/
function touch($filename, $time = null, $atime = null)
@ -1393,10 +1393,10 @@ class Net_SFTP extends Net_SSH2
*
* Returns true on success or false on error.
*
* @param String $filename
* @param Integer $uid
* @param Boolean $recursive
* @return Boolean
* @param string $filename
* @param int $uid
* @param bool $recursive
* @return bool
* @access public
*/
function chown($filename, $uid, $recursive = false)
@ -1413,10 +1413,10 @@ class Net_SFTP extends Net_SSH2
*
* Returns true on success or false on error.
*
* @param String $filename
* @param Integer $gid
* @param Boolean $recursive
* @return Boolean
* @param string $filename
* @param int $gid
* @param bool $recursive
* @return bool
* @access public
*/
function chgrp($filename, $gid, $recursive = false)
@ -1432,10 +1432,10 @@ class Net_SFTP extends Net_SSH2
* Returns the new file permissions on success or false on error.
* If $recursive is true than this just returns true or false.
*
* @param Integer $mode
* @param String $filename
* @param Boolean $recursive
* @return Mixed
* @param int $mode
* @param string $filename
* @param bool $recursive
* @return mixed
* @access public
*/
function chmod($mode, $filename, $recursive = false)
@ -1479,10 +1479,10 @@ class Net_SFTP extends Net_SSH2
/**
* Sets information about a file
*
* @param String $filename
* @param String $attr
* @param Boolean $recursive
* @return Boolean
* @param string $filename
* @param string $attr
* @param bool $recursive
* @return bool
* @access private
*/
function _setstat($filename, $attr, $recursive)
@ -1538,10 +1538,10 @@ class Net_SFTP extends Net_SSH2
*
* Minimizes directory lookups and SSH_FXP_STATUS requests for speed.
*
* @param String $path
* @param String $attr
* @param Integer $i
* @return Boolean
* @param string $path
* @param string $attr
* @param int $i
* @return bool
* @access private
*/
function _setstat_recursive($path, $attr, &$i)
@ -1608,8 +1608,8 @@ class Net_SFTP extends Net_SSH2
/**
* Return the target of a symbolic link
*
* @param String $link
* @return Mixed
* @param string $link
* @return mixed
* @access public
*/
function readlink($link)
@ -1651,9 +1651,9 @@ class Net_SFTP extends Net_SSH2
*
* symlink() creates a symbolic link to the existing target with the specified name link.
*
* @param String $target
* @param String $link
* @return Boolean
* @param string $target
* @param string $link
* @return bool
* @access public
*/
function symlink($target, $link)
@ -1688,8 +1688,8 @@ class Net_SFTP extends Net_SSH2
/**
* Creates a directory.
*
* @param String $dir
* @return Boolean
* @param string $dir
* @return bool
* @access public
*/
function mkdir($dir, $mode = -1, $recursive = false)
@ -1723,8 +1723,8 @@ class Net_SFTP extends Net_SSH2
/**
* Helper function for directory creation
*
* @param String $dir
* @return Boolean
* @param string $dir
* @return bool
* @access private
*/
function _mkdir_helper($dir, $attr)
@ -1751,8 +1751,8 @@ class Net_SFTP extends Net_SSH2
/**
* Removes a directory.
*
* @param String $dir
* @return Boolean
* @param string $dir
* @return bool
* @access public
*/
function rmdir($dir)
@ -1829,13 +1829,13 @@ class Net_SFTP extends Net_SSH2
*
* Setting $local_start to > 0 or $mode | NET_SFTP_RESUME_START doesn't do anything unless $mode | NET_SFTP_LOCAL_FILE.
*
* @param String $remote_file
* @param String|resource $data
* @param Integer $mode
* @param Integer $start
* @param Integer $local_start
* @param string $remote_file
* @param string|resource $data
* @param int $mode
* @param int $start
* @param int $local_start
* @param callable|null $progressCallback
* @return Boolean
* @return bool
* @access public
* @internal ASCII mode for SFTPv4/5/6 can be supported by adding a new function - Net_SFTP::setMode().
*/
@ -1989,8 +1989,8 @@ class Net_SFTP extends Net_SSH2
* Sending an SSH_FXP_WRITE packet and immediately reading its response isn't as efficient as blindly sending out $i
* SSH_FXP_WRITEs, in succession, and then reading $i responses.
*
* @param Integer $i
* @return Boolean
* @param int $i
* @return bool
* @access private
*/
function _read_put_responses($i)
@ -2015,8 +2015,8 @@ class Net_SFTP extends Net_SSH2
/**
* Close handle
*
* @param String $handle
* @return Boolean
* @param string $handle
* @return bool
* @access private
*/
function _close_handle($handle)
@ -2051,11 +2051,11 @@ class Net_SFTP extends Net_SSH2
*
* $offset and $length can be used to download files in chunks.
*
* @param String $remote_file
* @param String $local_file
* @param Integer $offset
* @param Integer $length
* @return Mixed
* @param string $remote_file
* @param string $local_file
* @param int $offset
* @param int $length
* @return mixed
* @access public
*/
function get($remote_file, $local_file = false, $offset = 0, $length = -1)
@ -2167,9 +2167,9 @@ class Net_SFTP extends Net_SSH2
/**
* Deletes a file on the SFTP server.
*
* @param String $path
* @param Boolean $recursive
* @return Boolean
* @param string $path
* @param bool $recursive
* @return bool
* @access public
*/
function delete($path, $recursive = true)
@ -2217,9 +2217,9 @@ class Net_SFTP extends Net_SSH2
*
* Minimizes directory lookups and SSH_FXP_STATUS requests for speed.
*
* @param String $path
* @param Integer $i
* @return Boolean
* @param string $path
* @param int $i
* @return bool
* @access private
*/
function _delete_recursive($path, &$i)
@ -2284,8 +2284,8 @@ class Net_SFTP extends Net_SSH2
/**
* Checks whether a file or directory exists
*
* @param String $path
* @return Boolean
* @param string $path
* @return bool
* @access public
*/
function file_exists($path)
@ -2307,8 +2307,8 @@ class Net_SFTP extends Net_SSH2
/**
* Tells whether the filename is a directory
*
* @param String $path
* @return Boolean
* @param string $path
* @return bool
* @access public
*/
function is_dir($path)
@ -2323,8 +2323,8 @@ class Net_SFTP extends Net_SSH2
/**
* Tells whether the filename is a regular file
*
* @param String $path
* @return Boolean
* @param string $path
* @return bool
* @access public
*/
function is_file($path)
@ -2339,8 +2339,8 @@ class Net_SFTP extends Net_SSH2
/**
* Tells whether the filename is a symbolic link
*
* @param String $path
* @return Boolean
* @param string $path
* @return bool
* @access public
*/
function is_link($path)
@ -2355,8 +2355,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets last access time of file
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function fileatime($path)
@ -2367,8 +2367,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets file modification time
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function filemtime($path)
@ -2379,8 +2379,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets file permissions
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function fileperms($path)
@ -2391,8 +2391,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets file owner
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function fileowner($path)
@ -2403,8 +2403,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets file group
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function filegroup($path)
@ -2415,8 +2415,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets file size
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function filesize($path)
@ -2427,8 +2427,8 @@ class Net_SFTP extends Net_SSH2
/**
* Gets file type
*
* @param String $path
* @return Mixed
* @param string $path
* @return mixed
* @access public
*/
function filetype($path)
@ -2461,9 +2461,9 @@ class Net_SFTP extends Net_SSH2
*
* Uses cache if appropriate.
*
* @param String $path
* @param String $prop
* @return Mixed
* @param string $path
* @param string $prop
* @return mixed
* @access private
*/
function _get_stat_cache_prop($path, $prop)
@ -2476,9 +2476,9 @@ class Net_SFTP extends Net_SSH2
*
* Uses cache if appropriate.
*
* @param String $path
* @param String $prop
* @return Mixed
* @param string $path
* @param string $prop
* @return mixed
* @access private
*/
function _get_lstat_cache_prop($path, $prop)
@ -2491,9 +2491,9 @@ class Net_SFTP extends Net_SSH2
*
* Uses cache if appropriate.
*
* @param String $path
* @param String $prop
* @return Mixed
* @param string $path
* @param string $prop
* @return mixed
* @access private
*/
function _get_xstat_cache_prop($path, $prop, $type)
@ -2520,9 +2520,9 @@ class Net_SFTP extends Net_SSH2
/**
* Renames a file or a directory on the SFTP server
*
* @param String $oldname
* @param String $newname
* @return Boolean
* @param string $oldname
* @param string $newname
* @return bool
* @access public
*/
function rename($oldname, $newname)
@ -2570,8 +2570,8 @@ class Net_SFTP extends Net_SSH2
*
* See '7. File Attributes' of draft-ietf-secsh-filexfer-13 for more info.
*
* @param String $response
* @return Array
* @param string $response
* @return array
* @access private
*/
function _parseAttributes(&$response)
@ -2624,8 +2624,8 @@ class Net_SFTP extends Net_SSH2
*
* Quoting the SFTP RFC, "Implementations MUST NOT send bits that are not defined" but they seem to anyway
*
* @param Integer $mode
* @return Integer
* @param int $mode
* @return int
* @access private
*/
function _parseMode($mode)
@ -2671,8 +2671,8 @@ class Net_SFTP extends Net_SSH2
*
* If the longname is in an unrecognized format bool(false) is returned.
*
* @param String $longname
* @return Mixed
* @param string $longname
* @return mixed
* @access private
*/
function _parseLongname($longname)
@ -2700,11 +2700,11 @@ class Net_SFTP extends Net_SSH2
*
* See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.
*
* @param Integer $type
* @param String $data
* @param int $type
* @param string $data
* @see Net_SFTP::_get_sftp_packet()
* @see Net_SSH2::_send_channel_packet()
* @return Boolean
* @return bool
* @access private
*/
function _send_sftp_packet($type, $data)
@ -2745,7 +2745,7 @@ class Net_SFTP extends Net_SSH2
* messages containing one SFTP packet.
*
* @see Net_SFTP::_send_sftp_packet()
* @return String
* @return string
* @access private
*/
function _get_sftp_packet()
@ -2817,7 +2817,7 @@ class Net_SFTP extends Net_SSH2
* Returns a string if NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX, an array if NET_SFTP_LOGGING == NET_SFTP_LOG_SIMPLE and false if !defined('NET_SFTP_LOGGING')
*
* @access public
* @return String or Array
* @return string or Array
*/
function getSFTPLog()
{
@ -2838,7 +2838,7 @@ class Net_SFTP extends Net_SSH2
/**
* Returns all errors
*
* @return String
* @return string
* @access public
*/
function getSFTPErrors()
@ -2849,7 +2849,7 @@ class Net_SFTP extends Net_SSH2
/**
* Returns the last error
*
* @return String
* @return string
* @access public
*/
function getLastSFTPError()
@ -2860,7 +2860,7 @@ class Net_SFTP extends Net_SSH2
/**
* Get supported SFTP versions
*
* @return Array
* @return array
* @access public
*/
function getSupportedVersions()
@ -2875,8 +2875,8 @@ class Net_SFTP extends Net_SSH2
/**
* Disconnect
*
* @param Integer $reason
* @return Boolean
* @param int $reason
* @return bool
* @access private
*/
function _disconnect($reason)

138
phpseclib/Net/SFTP/Stream.php
View File

@ -47,14 +47,14 @@ class Net_SFTP_Stream
*
* Rather than re-create the connection we re-use instances if possible
*
* @var Array
* @var array
*/
static $instances;
/**
* SFTP instance
*
* @var Object
* @var object
* @access private
*/
var $sftp;
@ -62,7 +62,7 @@ class Net_SFTP_Stream
/**
* Path
*
* @var String
* @var string
* @access private
*/
var $path;
@ -70,7 +70,7 @@ class Net_SFTP_Stream
/**
* Mode
*
* @var String
* @var string
* @access private
*/
var $mode;
@ -78,7 +78,7 @@ class Net_SFTP_Stream
/**
* Position
*
* @var Integer
* @var int
* @access private
*/
var $pos;
@ -86,7 +86,7 @@ class Net_SFTP_Stream
/**
* Size
*
* @var Integer
* @var int
* @access private
*/
var $size;
@ -94,7 +94,7 @@ class Net_SFTP_Stream
/**
* Directory entries
*
* @var Array
* @var array
* @access private
*/
var $entries;
@ -102,7 +102,7 @@ class Net_SFTP_Stream
/**
* EOF flag
*
* @var Boolean
* @var bool
* @access private
*/
var $eof;
@ -112,7 +112,7 @@ class Net_SFTP_Stream
*
* Technically this needs to be publically accessible so PHP can set it directly
*
* @var Resource
* @var resource
* @access public
*/
var $context;
@ -120,7 +120,7 @@ class Net_SFTP_Stream
/**
* Notification callback function
*
* @var Callable
* @var callable
* @access public
*/
var $notification;
@ -128,8 +128,8 @@ class Net_SFTP_Stream
/**
* Registers this class as a URL wrapper.
*
* @param String $protocol The wrapper name to be registered.
* @return Boolean True on success, false otherwise.
* @param string $protocol The wrapper name to be registered.
* @return bool True on success, false otherwise.
* @access public
*/
static function register($protocol = 'sftp')
@ -165,8 +165,8 @@ class Net_SFTP_Stream
* If "notification" is set as a context parameter the message code for successful login is
* NET_SSH2_MSG_USERAUTH_SUCCESS. For a failed login it's NET_SSH2_MSG_USERAUTH_FAILURE.
*
* @param String $path
* @return String
* @param string $path
* @return string
* @access private
*/
function _parse_path($path)
@ -257,11 +257,11 @@ class Net_SFTP_Stream
/**
* Opens file or URL
*
* @param String $path
* @param String $mode
* @param Integer $options
* @param String $opened_path
* @return Boolean
* @param string $path
* @param string $mode
* @param int $options
* @param string $opened_path
* @return bool
* @access public
*/
function _stream_open($path, $mode, $options, &$opened_path)
@ -302,8 +302,8 @@ class Net_SFTP_Stream
/**
* Read from stream
*
* @param Integer $count
* @return Mixed
* @param int $count
* @return mixed
* @access public
*/
function _stream_read($count)
@ -344,8 +344,8 @@ class Net_SFTP_Stream
/**
* Write to stream
*
* @param String $data
* @return Mixed
* @param string $data
* @return mixed
* @access public
*/
function _stream_write($data)
@ -379,7 +379,7 @@ class Net_SFTP_Stream
/**
* Retrieve the current position of a stream
*
* @return Integer
* @return int
* @access public
*/
function _stream_tell()
@ -397,7 +397,7 @@ class Net_SFTP_Stream
* will return false. do fread($fp, 1) and feof() will then return true. do fseek($fp, 10) on ablank file and feof()
* will return false. do fread($fp, 1) and feof() will then return true.
*
* @return Boolean
* @return bool
* @access public
*/
function _stream_eof()
@ -408,9 +408,9 @@ class Net_SFTP_Stream
/**
* Seeks to specific location in a stream
*
* @param Integer $offset
* @param Integer $whence
* @return Boolean
* @param int $offset
* @param int $whence
* @return bool
* @access public
*/
function _stream_seek($offset, $whence)
@ -436,10 +436,10 @@ class Net_SFTP_Stream
/**
* Change stream options
*
* @param String $path
* @param Integer $option
* @param Mixed $var
* @return Boolean
* @param string $path
* @param int $option
* @param mixed $var
* @return bool
* @access public
*/
function _stream_metadata($path, $option, $var)
@ -470,8 +470,8 @@ class Net_SFTP_Stream
/**
* Retrieve the underlaying resource
*
* @param Integer $cast_as
* @return Resource
* @param int $cast_as
* @return resource
* @access public
*/
function _stream_cast($cast_as)
@ -482,8 +482,8 @@ class Net_SFTP_Stream
/**
* Advisory file locking
*
* @param Integer $operation
* @return Boolean
* @param int $operation
* @return bool
* @access public
*/
function _stream_lock($operation)
@ -498,9 +498,9 @@ class Net_SFTP_Stream
* If newname exists, it will be overwritten. This is a departure from what Net_SFTP
* does.
*
* @param String $path_from
* @param String $path_to
* @return Boolean
* @param string $path_from
* @param string $path_to
* @return bool
* @access public
*/
function _rename($path_from, $path_to)
@ -550,9 +550,9 @@ class Net_SFTP_Stream
* string longname
* ATTRS attrs
*
* @param String $path
* @param Integer $options
* @return Boolean
* @param string $path
* @param int $options
* @return bool
* @access public
*/
function _dir_opendir($path, $options)
@ -569,7 +569,7 @@ class Net_SFTP_Stream
/**
* Read entry from directory handle
*
* @return Mixed
* @return mixed
* @access public
*/
function _dir_readdir()
@ -583,7 +583,7 @@ class Net_SFTP_Stream
/**
* Rewind directory handle
*
* @return Boolean
* @return bool
* @access public
*/
function _dir_rewinddir()
@ -595,7 +595,7 @@ class Net_SFTP_Stream
/**
* Close directory handle
*
* @return Boolean
* @return bool
* @access public
*/
function _dir_closedir()
@ -608,10 +608,10 @@ class Net_SFTP_Stream
*
* Only valid $options is STREAM_MKDIR_RECURSIVE
*
* @param String $path
* @param Integer $mode
* @param Integer $options
* @return Boolean
* @param string $path
* @param int $mode
* @param int $options
* @return bool
* @access public
*/
function _mkdir($path, $mode, $options)
@ -632,10 +632,10 @@ class Net_SFTP_Stream
* STREAM_MKDIR_RECURSIVE is supposed to be set. Also, when I try it out with rmdir() I get 8 as
* $options. What does 8 correspond to?
*
* @param String $path
* @param Integer $mode
* @param Integer $options
* @return Boolean
* @param string $path
* @param int $mode
* @param int $options
* @return bool
* @access public
*/
function _rmdir($path, $options)
@ -653,7 +653,7 @@ class Net_SFTP_Stream
*
* See <http://php.net/fflush>. Always returns true because Net_SFTP doesn't cache stuff before writing
*
* @return Boolean
* @return bool
* @access public
*/
function _stream_flush()
@ -664,7 +664,7 @@ class Net_SFTP_Stream
/**
* Retrieve information about a file resource
*
* @return Mixed
* @return mixed
* @access public
*/
function _stream_stat()
@ -679,8 +679,8 @@ class Net_SFTP_Stream
/**
* Delete a file
*
* @param String $path
* @return Boolean
* @param string $path
* @return bool
* @access public
*/
function _unlink($path)
@ -700,9 +700,9 @@ class Net_SFTP_Stream
* might be worthwhile to reconstruct bits 12-16 (ie. the file type) if mode doesn't have them but we'll
* cross that bridge when and if it's reached
*
* @param String $path
* @param Integer $flags
* @return Mixed
* @param string $path
* @param int $flags
* @return mixed
* @access public
*/
function _url_stat($path, $flags)
@ -723,8 +723,8 @@ class Net_SFTP_Stream
/**
* Truncate stream
*
* @param Integer $new_size
* @return Boolean
* @param int $new_size
* @return bool
* @access public
*/
function _stream_truncate($new_size)
@ -745,10 +745,10 @@ class Net_SFTP_Stream
* STREAM_OPTION_WRITE_BUFFER isn't supported for the same reason stream_flush isn't.
* The other two aren't supported because of limitations in Net_SFTP.
*
* @param Integer $option
* @param Integer $arg1
* @param Integer $arg2
* @return Boolean
* @param int $option
* @param int $arg1
* @param int $arg2
* @return bool
* @access public
*/
function _stream_set_option($option, $arg1, $arg2)
@ -775,9 +775,9 @@ class Net_SFTP_Stream
* If NET_SFTP_STREAM_LOGGING is defined all calls will be output on the screen and then (regardless of whether or not
* NET_SFTP_STREAM_LOGGING is enabled) the parameters will be passed through to the appropriate method.
*
* @param String
* @param Array
* @return Mixed
* @param string
* @param array
* @return mixed
* @access public
*/
function __call($name, $arguments)

144
phpseclib/Net/SSH1.php
View File

@ -235,7 +235,7 @@ class Net_SSH1
/**
* The SSH identifier
*
* @var String
* @var string
* @access private
*/
var $identifier = 'SSH-1.5-phpseclib';
@ -243,7 +243,7 @@ class Net_SSH1
/**
* The Socket Object
*
* @var Object
* @var object
* @access private
*/
var $fsock;
@ -251,7 +251,7 @@ class Net_SSH1
/**
* The cryptography object
*
* @var Object
* @var object
* @access private
*/
var $crypto = false;
@ -262,7 +262,7 @@ class Net_SSH1
* The bits that are set represent functions that have been called already. This is used to determine
* if a requisite function has been successfully executed. If not, an error should be thrown.
*
* @var Integer
* @var int
* @access private
*/
var $bitmap = 0;
@ -273,7 +273,7 @@ class Net_SSH1
* Logged for debug purposes
*
* @see Net_SSH1::getServerKeyPublicExponent()
* @var String
* @var string
* @access private
*/
var $server_key_public_exponent;
@ -284,7 +284,7 @@ class Net_SSH1
* Logged for debug purposes
*
* @see Net_SSH1::getServerKeyPublicModulus()
* @var String
* @var string
* @access private
*/
var $server_key_public_modulus;
@ -295,7 +295,7 @@ class Net_SSH1
* Logged for debug purposes
*
* @see Net_SSH1::getHostKeyPublicExponent()
* @var String
* @var string
* @access private
*/
var $host_key_public_exponent;
@ -306,7 +306,7 @@ class Net_SSH1
* Logged for debug purposes
*
* @see Net_SSH1::getHostKeyPublicModulus()
* @var String
* @var string
* @access private
*/
var $host_key_public_modulus;
@ -317,7 +317,7 @@ class Net_SSH1
* Logged for debug purposes
*
* @see Net_SSH1::getSupportedCiphers()
* @var Array
* @var array
* @access private
*/
var $supported_ciphers = array(
@ -336,7 +336,7 @@ class Net_SSH1
* Logged for debug purposes
*
* @see Net_SSH1::getSupportedAuthentications()
* @var Array
* @var array
* @access private
*/
var $supported_authentications = array(
@ -350,7 +350,7 @@ class Net_SSH1
* Server Identification
*
* @see Net_SSH1::getServerIdentification()
* @var String
* @var string
* @access private
*/
var $server_identification = '';
@ -359,7 +359,7 @@ class Net_SSH1
* Protocol Flags
*
* @see Net_SSH1::Net_SSH1()
* @var Array
* @var array
* @access private
*/
var $protocol_flags = array();
@ -368,7 +368,7 @@ class Net_SSH1
* Protocol Flag Log
*
* @see Net_SSH1::getLog()
* @var Array
* @var array
* @access private
*/
var $protocol_flag_log = array();
@ -377,7 +377,7 @@ class Net_SSH1
* Message Log
*
* @see Net_SSH1::getLog()
* @var Array
* @var array
* @access private
*/
var $message_log = array();
@ -386,7 +386,7 @@ class Net_SSH1
* Real-time log file pointer
*
* @see Net_SSH1::_append_log()
* @var Resource
* @var resource
* @access private
*/
var $realtime_log_file;
@ -395,7 +395,7 @@ class Net_SSH1
* Real-time log file size
*
* @see Net_SSH1::_append_log()
* @var Integer
* @var int
* @access private
*/
var $realtime_log_size;
@ -404,7 +404,7 @@ class Net_SSH1
* Real-time log file wrap boolean
*
* @see Net_SSH1::_append_log()
* @var Boolean
* @var bool
* @access private
*/
var $realtime_log_wrap;
@ -413,7 +413,7 @@ class Net_SSH1
* Interactive Buffer
*
* @see Net_SSH1::read()
* @var Array
* @var array
* @access private
*/
var $interactiveBuffer = '';
@ -463,7 +463,7 @@ class Net_SSH1
*
* @see Net_SSH1::Net_SSH1()
* @see Net_SSH1::_connect()
* @var String
* @var string
* @access private
*/
var $host;
@ -473,7 +473,7 @@ class Net_SSH1
*
* @see Net_SSH1::Net_SSH1()
* @see Net_SSH1::_connect()
* @var Integer
* @var int
* @access private
*/
var $port;
@ -488,7 +488,7 @@ class Net_SSH1
*
* @see Net_SSH1::Net_SSH1()
* @see Net_SSH1::_connect()
* @var Integer
* @var int
* @access private
*/
var $connectionTimeout;
@ -498,7 +498,7 @@ class Net_SSH1
*
* @see Net_SSH1::Net_SSH1()
* @see Net_SSH1::_connect()
* @var Integer
* @var int
* @access private
*/
var $cipher;
@ -508,10 +508,10 @@ class Net_SSH1
*
* Connects to an SSHv1 server
*
* @param String $host
* @param Integer $port
* @param Integer $timeout
* @param Integer $cipher
* @param string $host
* @param int $port
* @param int $timeout
* @param int $cipher
* @return Net_SSH1
* @access public
*/
@ -560,7 +560,7 @@ class Net_SSH1
/**
* Connect to an SSHv1 server
*
* @return Boolean
* @return bool
* @access private
*/
function _connect()
@ -727,9 +727,9 @@ class Net_SSH1
/**
* Login
*
* @param String $username
* @param String $password
* @return Boolean
* @param string $username
* @param string $password
* @return bool
* @access public
*/
function login($username, $password = '')
@ -800,7 +800,7 @@ class Net_SSH1
* $ssh->exec('ping 127.0.0.1'); on a Linux host will never return and will run indefinitely. setTimeout() makes it so it'll timeout.
* Setting $timeout to false or 0 will mean there is no timeout.
*
* @param Mixed $timeout
* @param mixed $timeout
*/
function setTimeout($timeout)
{
@ -823,7 +823,7 @@ class Net_SSH1
*
* @see Net_SSH1::interactiveRead()
* @see Net_SSH1::interactiveWrite()
* @param String $cmd
* @param string $cmd
* @return mixed
* @access public
*/
@ -873,7 +873,7 @@ class Net_SSH1
*
* @see Net_SSH1::interactiveRead()
* @see Net_SSH1::interactiveWrite()
* @return Boolean
* @return bool
* @access private
*/
function _initShell()
@ -916,8 +916,8 @@ class Net_SSH1
* Inputs a command into an interactive shell.
*
* @see Net_SSH1::interactiveWrite()
* @param String $cmd
* @return Boolean
* @param string $cmd
* @return bool
* @access public
*/
function write($cmd)
@ -932,9 +932,9 @@ class Net_SSH1
* a regular expression.
*
* @see Net_SSH1::write()
* @param String $expect
* @param Integer $mode
* @return Boolean
* @param string $expect
* @param int $mode
* @return bool
* @access public
*/
function read($expect, $mode = NET_SSH1_READ_SIMPLE)
@ -972,8 +972,8 @@ class Net_SSH1
* Inputs a command into an interactive shell.
*
* @see Net_SSH1::interactiveRead()
* @param String $cmd
* @return Boolean
* @param string $cmd
* @return bool
* @access public
*/
function interactiveWrite($cmd)
@ -1008,7 +1008,7 @@ class Net_SSH1
* there's not going to be much recourse.
*
* @see Net_SSH1::interactiveRead()
* @return String
* @return string
* @access public
*/
function interactiveRead()
@ -1059,7 +1059,7 @@ class Net_SSH1
/**
* Disconnect
*
* @param String $msg
* @param string $msg
* @access private
*/
function _disconnect($msg = 'Client Quit')
@ -1097,7 +1097,7 @@ class Net_SSH1
* http://www.securiteam.com/securitynews/5LP042K3FY.html
*
* @see Net_SSH1::_send_binary_packet()
* @return Array
* @return array
* @access private
*/
function _get_binary_packet()
@ -1173,8 +1173,8 @@ class Net_SSH1
* Returns true on success, false on failure.
*
* @see Net_SSH1::_get_binary_packet()
* @param String $data
* @return Boolean
* @param string $data
* @return bool
* @access private
*/
function _send_binary_packet($data)
@ -1221,8 +1221,8 @@ class Net_SSH1
*
* @see Net_SSH1::_get_binary_packet()
* @see Net_SSH1::_send_binary_packet()
* @param String $data
* @return Integer
* @param string $data
* @return int
* @access private
*/
function _crc($data)
@ -1317,9 +1317,9 @@ class Net_SSH1
*
* Inspired by array_shift
*
* @param String $string
* @param Integer $index
* @return String
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
@ -1338,7 +1338,7 @@ class Net_SSH1
*
* @see Net_SSH1::Net_SSH1()
* @param Math_BigInteger $m
* @param Array $key
* @param array $key
* @return Math_BigInteger
* @access private
*/
@ -1391,7 +1391,7 @@ class Net_SSH1
* named constants from it, using the value as the name of the constant and the index as the value of the constant.
* If any of the constants that would be defined already exists, none of the constants will be defined.
*
* @param Array $array
* @param array $array
* @access private
*/
function _define_array()
@ -1414,7 +1414,7 @@ class Net_SSH1
* Returns a string if NET_SSH1_LOGGING == NET_SSH1_LOG_COMPLEX, an array if NET_SSH1_LOGGING == NET_SSH1_LOG_SIMPLE and false if !defined('NET_SSH1_LOGGING')
*
* @access public
* @return String or Array
* @return string or Array
*/
function getLog()
{
@ -1437,10 +1437,10 @@ class Net_SSH1
/**
* Formats a log for printing
*
* @param Array $message_log
* @param Array $message_number_log
* @param array $message_log
* @param array $message_number_log
* @access private
* @return String
* @return string
*/
function _format_log($message_log, $message_number_log)
{
@ -1473,9 +1473,9 @@ class Net_SSH1
*
* For use with preg_replace_callback()
*
* @param Array $matches
* @param array $matches
* @access private
* @return String
* @return string
*/
function _format_log_helper($matches)
{
@ -1488,8 +1488,8 @@ class Net_SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param Boolean $raw_output
* @return String
* @param bool $raw_output
* @return string
* @access public
*/
function getServerKeyPublicExponent($raw_output = false)
@ -1503,8 +1503,8 @@ class Net_SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param Boolean $raw_output
* @return String
* @param bool $raw_output
* @return string
* @access public
*/
function getServerKeyPublicModulus($raw_output = false)
@ -1518,8 +1518,8 @@ class Net_SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param Boolean $raw_output
* @return String
* @param bool $raw_output
* @return string
* @access public
*/
function getHostKeyPublicExponent($raw_output = false)
@ -1533,8 +1533,8 @@ class Net_SSH1
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param Boolean $raw_output
* @return String
* @param bool $raw_output
* @return string
* @access public
*/
function getHostKeyPublicModulus($raw_output = false)
@ -1549,8 +1549,8 @@ class Net_SSH1
* is set to true, returns, instead, an array of constants. ie. instead of array('Triple-DES in CBC mode'), you'll
* get array(NET_SSH1_CIPHER_3DES).
*
* @param Boolean $raw_output
* @return Array
* @param bool $raw_output
* @return array
* @access public
*/
function getSupportedCiphers($raw_output = false)
@ -1565,8 +1565,8 @@ class Net_SSH1
* is set to true, returns, instead, an array of constants. ie. instead of array('password authentication'), you'll
* get array(NET_SSH1_AUTH_PASSWORD).
*
* @param Boolean $raw_output
* @return Array
* @param bool $raw_output
* @return array
* @access public
*/
function getSupportedAuthentications($raw_output = false)
@ -1577,7 +1577,7 @@ class Net_SSH1
/**
* Return the server identification.
*
* @return String
* @return string
* @access public
*/
function getServerIdentification()
@ -1590,7 +1590,7 @@ class Net_SSH1
*
* Makes sure that only the last 1MB worth of packets will be logged
*
* @param String $data
* @param string $data
* @access private
*/
function _append_log($protocol_flags, $message)

308
phpseclib/Net/SSH2.php
View File

File diff suppressed because it is too large Load Diff

28
phpseclib/System/SSH/Agent.php
View File

@ -108,7 +108,7 @@ class System_SSH_Agent_Identity
/**
* Key Blob
*
* @var String
* @var string
* @access private
* @see System_SSH_Agent_Identity::sign()
*/
@ -117,7 +117,7 @@ class System_SSH_Agent_Identity
/**
* Socket Resource
*
* @var Resource
* @var resource
* @access private
* @see System_SSH_Agent_Identity::sign()
*/
@ -126,7 +126,7 @@ class System_SSH_Agent_Identity
/**
* Default Constructor.
*
* @param Resource $fsock
* @param resource $fsock
* @return System_SSH_Agent_Identity
* @access private
*/
@ -155,7 +155,7 @@ class System_SSH_Agent_Identity
* Called by System_SSH_Agent::requestIdentities(). The key blob could be extracted from $this->key
* but this saves a small amount of computation.
*
* @param String $key_blob
* @param string $key_blob
* @access private
*/
function setPublicKeyBlob($key_blob)
@ -168,8 +168,8 @@ class System_SSH_Agent_Identity
*
* Wrapper for $this->key->getPublicKey()
*
* @param Integer $format optional
* @return Mixed
* @param int $format optional
* @return mixed
* @access public
*/
function getPublicKey($format = null)
@ -183,7 +183,7 @@ class System_SSH_Agent_Identity
* Doesn't do anything as ssh-agent doesn't let you pick and choose the signature mode. ie.
* ssh-agent's only supported mode is CRYPT_RSA_SIGNATURE_PKCS1
*
* @param Integer $mode
* @param int $mode
* @access public
*/
function setSignatureMode($mode)
@ -195,8 +195,8 @@ class System_SSH_Agent_Identity
*
* See "2.6.2 Protocol 2 private key signature request"
*
* @param String $message
* @return String
* @param string $message
* @return string
* @access public
*/
function sign($message)
@ -235,7 +235,7 @@ class System_SSH_Agent
/**
* Socket Resource
*
* @var Resource
* @var resource
* @access private
*/
var $fsock;
@ -295,7 +295,7 @@ class System_SSH_Agent
* See "2.5.2 Requesting a list of protocol 2 keys"
* Returns an array containing zero or more System_SSH_Agent_Identity objects
*
* @return Array
* @return array
* @access public
*/
function requestIdentities()
@ -354,7 +354,7 @@ class System_SSH_Agent
* be requested when a channel is opened
*
* @param Net_SSH2 $ssh
* @return Boolean
* @return bool
* @access public
*/
function startSSHForwarding($ssh)
@ -368,7 +368,7 @@ class System_SSH_Agent
* Request agent forwarding of remote server
*
* @param Net_SSH2 $ssh
* @return Boolean
* @return bool
* @access private
*/
function _request_forwarding($ssh)
@ -424,7 +424,7 @@ class System_SSH_Agent
/**
* Forward data to SSH Agent and return data reply
*
* @param String $data
* @param string $data
* @return data from SSH Agent
* @access private
*/