octoleo/phpseclib
1
0
Fork 0
mirror of https://github.com/phpseclib/phpseclib.git synced 2024-12-24 02:55:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed some phpdocs

Browse Source
This commit is contained in:
Graham Campbell 2015-03-29 17:07:17 +01:00
parent f960410b77
commit e50cbacd4e
19 changed files with 144 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
phpseclib/Crypt/Base.php
View File

@ -91,7 +91,6 @@ define('CRYPT_MODE_CFB', 3);
define('CRYPT_MODE_OFB', 4);
/**
* Encrypt / decrypt using streaming mode.
*
*/
define('CRYPT_MODE_STREAM', 5);
/**#@-*/

4
phpseclib/Crypt/Blowfish.php
View File

@ -340,7 +340,7 @@ class Crypt_Blowfish extends Crypt_Base
/**
* P-Array consists of 18 32-bit subkeys
*
* @var array $parray
* @var array
* @access private
*/
var $parray = array(
@ -354,7 +354,7 @@ class Crypt_Blowfish extends Crypt_Base
*
* Holds the expanded key [p] and the key-depended s-boxes [sb]
*
* @var array $bctx
* @var array
* @access private
*/
var $bctx;

1
phpseclib/Crypt/Rijndael.php
View File

@ -223,7 +223,6 @@ class Crypt_Rijndael extends Crypt_Base
* because the encryption / decryption / key schedule creation requires this number and not $block_size. We could
* derive this from $block_size or vice versa, but that'd mean we'd have to do multiple shift operations, so in lieu
* of that, we'll just precompute it once.
*
*/
var $Nb = 4;

2
phpseclib/Net/SCP.php
View File

@ -17,7 +17,7 @@
* if (!$ssh->login('username', 'password')) {
* exit('bad login');
* }
*
* $scp = new Net_SCP($ssh);
* $scp->put('abcd', str_repeat('x', 1024*1024));
* ?>

8
tests/Functional/Net/SFTPLargeFileTest.php
View File

@ -51,10 +51,10 @@ class Functional_Net_SFTPLargeFileTest extends PhpseclibFunctionalTestCase
}
/**
* @group github298
* @group github455
* @group github457
*/
* @group github298
* @group github455
* @group github457
*/
public function testPutSizeLocalFile()
{
$tmp_filename = $this->createTempFile(128, 1024 * 1024);

92
tests/Functional/Net/SFTPUserStoryTest.php
View File

@ -35,8 +35,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testConstructor
*/
* @depends testConstructor
*/
public function testPasswordLogin($sftp)
{
$username = $this->getEnv('SSH_USERNAME');
@ -50,8 +50,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testPasswordLogin
*/
* @depends testPasswordLogin
*/
public function testPwdHome($sftp)
{
$this->assertEquals(
@ -64,8 +64,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testPwdHome
*/
* @depends testPwdHome
*/
public function testMkDirScratch($sftp)
{
$dirname = self::$scratchDir;
@ -86,8 +86,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testMkDirScratch
*/
* @depends testMkDirScratch
*/
public function testChDirScratch($sftp)
{
$this->assertTrue(
@ -119,8 +119,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testChDirScratch
*/
* @depends testChDirScratch
*/
public function testStatOnDir($sftp)
{
$this->assertNotSame(
@ -133,8 +133,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testStatOnDir
*/
* @depends testStatOnDir
*/
public function testPutSizeGetFile($sftp)
{
$this->assertTrue(
@ -158,8 +158,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testPutSizeGetFile
*/
* @depends testPutSizeGetFile
*/
public function testTouch($sftp)
{
$this->assertTrue(
@ -176,8 +176,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testTouch
*/
* @depends testTouch
*/
public function testTruncate($sftp)
{
$this->assertTrue(
@ -200,8 +200,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testTruncate
*/
* @depends testTruncate
*/
public function testChDirOnFile($sftp)
{
$this->assertFalse(
@ -213,8 +213,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testChDirOnFile
*/
* @depends testChDirOnFile
*/
public function testFileExistsIsFileIsDirFile($sftp)
{
$this->assertTrue(
@ -236,8 +236,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testFileExistsIsFileIsDirFile
*/
* @depends testFileExistsIsFileIsDirFile
*/
public function testFileExistsIsFileIsDirFileNonexistent($sftp)
{
$this->assertFalse(
@ -259,8 +259,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testFileExistsIsFileIsDirFileNonexistent
*/
* @depends testFileExistsIsFileIsDirFileNonexistent
*/
public function testSortOrder($sftp)
{
$this->assertTrue(
@ -311,8 +311,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testSortOrder
*/
* @depends testSortOrder
*/
public function testResourceXfer($sftp)
{
$fp = fopen('res.txt', 'w+');
@ -331,8 +331,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testResourceXfer
*/
* @depends testResourceXfer
*/
public function testSymlink($sftp)
{
$this->assertTrue(
@ -344,8 +344,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testSymlink
*/
* @depends testSymlink
*/
public function testReadlink($sftp)
{
$this->assertInternalType('string', $sftp->readlink('symlink'),
@ -356,10 +356,10 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* on older versions this would result in a fatal error
* @depends testReadlink
* @group github402
*/
* on older versions this would result in a fatal error
* @depends testReadlink
* @group github402
*/
public function testStatcacheFix($sftp)
{
// Name used for both directory and file.
@ -381,8 +381,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testStatcacheFix
*/
* @depends testStatcacheFix
*/
public function testChDirUpHome($sftp)
{
$this->assertTrue(
@ -400,8 +400,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testChDirUpHome
*/
* @depends testChDirUpHome
*/
public function testFileExistsIsFileIsDirDir($sftp)
{
$this->assertTrue(
@ -423,8 +423,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testFileExistsIsFileIsDirDir
*/
* @depends testFileExistsIsFileIsDirDir
*/
public function testTruncateLargeFile($sftp)
{
$filesize = (4 * 1024 + 16) * 1024 * 1024;
@ -437,8 +437,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testTruncateLargeFile
*/
* @depends testTruncateLargeFile
*/
public function testRmDirScratch($sftp)
{
$this->assertFalse(
@ -451,8 +451,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testRmDirScratch
*/
* @depends testRmDirScratch
*/
public function testDeleteRecursiveScratch($sftp)
{
$this->assertTrue(
@ -465,8 +465,8 @@ class Functional_Net_SFTPUserStoryTest extends PhpseclibFunctionalTestCase
}
/**
* @depends testDeleteRecursiveScratch
*/
* @depends testDeleteRecursiveScratch
*/
public function testRmDirScratchNonexistent($sftp)
{
$this->assertFalse(

18
tests/Functional/Net/SSH2Test.php
View File

@ -21,10 +21,10 @@ class Functional_Net_SSH2Test extends PhpseclibFunctionalTestCase
}
/**
* @depends testConstructor
* @group github408
* @group github412
*/
* @depends testConstructor
* @group github408
* @group github412
*/
public function testPreLogin($ssh)
{
$this->assertFalse(
@ -51,8 +51,8 @@ class Functional_Net_SSH2Test extends PhpseclibFunctionalTestCase
}
/**
* @depends testPreLogin
*/
* @depends testPreLogin
*/
public function testPasswordLogin($ssh)
{
$username = $this->getEnv('SSH_USERNAME');
@ -66,9 +66,9 @@ class Functional_Net_SSH2Test extends PhpseclibFunctionalTestCase
}
/**
* @depends testPasswordLogin
* @group github280
*/
* @depends testPasswordLogin
* @group github280
*/
public function testExecWithMethodCallback($ssh)
{
$callbackObject = $this->getMock('stdClass', array('callbackMethod'));

18
tests/PhpseclibFunctionalTestCase.php
View File

@ -33,11 +33,11 @@ abstract class PhpseclibFunctionalTestCase extends PhpseclibTestCase
}
/**
* @param string $variable
* @param string|null $message
*
* @return null
*/
* @param string $variable
* @param string|null $message
*
* @return null
*/
protected function requireEnv($variable, $message = null)
{
if ($this->_getEnv($variable) === false) {
@ -50,10 +50,10 @@ abstract class PhpseclibFunctionalTestCase extends PhpseclibTestCase
}
/**
* @param string $variable
*
* @return string
*/
* @param string $variable
*
* @return string
*/
protected function getEnv($variable)
{
$this->requireEnv($variable);

40
tests/PhpseclibTestCase.php
View File

@ -20,17 +20,17 @@ abstract class PhpseclibTestCase extends PHPUnit_Framework_TestCase
}
/**
* Creates a temporary file on the local filesystem and returns its path.
* The $number_of_writes and $bytes_per_write parameters can be used to
* write $number_of_writes * $bytes_per_write times the character 'a' to the
* temporary file. All files created using this method will be deleted from
* the filesystem on tearDown(), i.e. after each test method was run.
*
* @param int $number_of_writes
* @param int $bytes_per_write
*
* @return string
*/
* Creates a temporary file on the local filesystem and returns its path.
* The $number_of_writes and $bytes_per_write parameters can be used to
* write $number_of_writes * $bytes_per_write times the character 'a' to the
* temporary file. All files created using this method will be deleted from
* the filesystem on tearDown(), i.e. after each test method was run.
*
* @param int $number_of_writes
* @param int $bytes_per_write
*
* @return string
*/
protected function createTempFile($number_of_writes = 0, $bytes_per_write = 0)
{
$filename = tempnam(sys_get_temp_dir(), 'phpseclib-test-');
@ -48,11 +48,11 @@ abstract class PhpseclibTestCase extends PHPUnit_Framework_TestCase
}
/**
* @param string $constant
* @param mixed $expected
*
* @return null
*/
* @param string $constant
* @param mixed $expected
*
* @return null
*/
static protected function ensureConstant($constant, $expected)
{
if (defined($constant)) {
@ -82,10 +82,10 @@ abstract class PhpseclibTestCase extends PHPUnit_Framework_TestCase
}
/**
* @param string $filename
*
* @return null
*/
* @param string $filename
*
* @return null
*/
static protected function reRequireFile($filename)
{
if (function_exists('runkit_import')) {

20
tests/Unit/Crypt/AES/TestCase.php
View File

@ -18,10 +18,10 @@ abstract class Unit_Crypt_AES_TestCase extends PhpseclibTestCase
}
/**
* Produces all combinations of test values.
*
* @return array
*/
* Produces all combinations of test values.
*
* @return array
*/
public function continuousBufferCombos()
{
$modes = array(
@ -59,8 +59,8 @@ abstract class Unit_Crypt_AES_TestCase extends PhpseclibTestCase
}
/**
* @dataProvider continuousBufferCombos
*/
* @dataProvider continuousBufferCombos
*/
public function testEncryptDecryptWithContinuousBuffer($mode, $plaintext, $iv, $key)
{
$aes = new Crypt_AES(constant($mode));
@ -77,8 +77,8 @@ abstract class Unit_Crypt_AES_TestCase extends PhpseclibTestCase
}
/**
* @group github451
*/
* @group github451
*/
public function testKeyPaddingRijndael()
{
// this test case is from the following URL:
@ -92,8 +92,8 @@ abstract class Unit_Crypt_AES_TestCase extends PhpseclibTestCase
}
/**
* @group github451
*/
* @group github451
*/
public function testKeyPaddingAES()
{
// same as the above - just with a different ciphertext

8
tests/Unit/Crypt/Hash/MD5Test.php
View File

@ -13,8 +13,8 @@ class Unit_Crypt_Hash_MD5Test extends Unit_Crypt_Hash_TestCase
}
/**
* @dataProvider hashData()
*/
* @dataProvider hashData()
*/
public function testHash($message, $result)
{
$this->assertHashesTo($this->getInstance(), $message, $result);
@ -30,8 +30,8 @@ class Unit_Crypt_Hash_MD5Test extends Unit_Crypt_Hash_TestCase
}
/**
* @dataProvider hmacData()
*/
* @dataProvider hmacData()
*/
public function testHMAC($key, $message, $result)
{
$this->assertHMACsTo($this->getInstance(), $key, $message, $result);

8
tests/Unit/Crypt/Hash/SHA256Test.php
View File

@ -13,8 +13,8 @@ class Unit_Crypt_Hash_SHA256Test extends Unit_Crypt_Hash_TestCase
}
/**
* @dataProvider hashData()
*/
* @dataProvider hashData()
*/
public function testHash($message, $result)
{
$this->assertHashesTo($this->getInstance(), $message, $result);
@ -39,8 +39,8 @@ class Unit_Crypt_Hash_SHA256Test extends Unit_Crypt_Hash_TestCase
}
/**
* @dataProvider hmacData()
*/
* @dataProvider hmacData()
*/
public function testHMAC($key, $message, $result)
{
$this->assertHMACsTo($this->getInstance(), $key, $message, $result);

8
tests/Unit/Crypt/Hash/SHA256_96Test.php
View File

@ -13,16 +13,16 @@ class Unit_Crypt_Hash_SHA256_96Test extends Unit_Crypt_Hash_SHA256Test
}
/**
* @dataProvider hashData()
*/
* @dataProvider hashData()
*/
public function testHash($message, $longResult)
{
parent::testHash($message, substr($longResult, 0, 24));
}
/**
* @dataProvider hmacData()
*/
* @dataProvider hmacData()
*/
public function testHMAC($key, $message, $longResult)
{
parent::testHMAC($key, $message, substr($longResult, 0, 24));

8
tests/Unit/Crypt/Hash/SHA512Test.php
View File

@ -13,8 +13,8 @@ class Unit_Crypt_Hash_SHA512Test extends Unit_Crypt_Hash_TestCase
}
/**
* @dataProvider hashData()
*/
* @dataProvider hashData()
*/
public function testHash($message, $result)
{
$this->assertHashesTo($this->getInstance(), $message, $result);
@ -39,8 +39,8 @@ class Unit_Crypt_Hash_SHA512Test extends Unit_Crypt_Hash_TestCase
}
/**
* @dataProvider hmacData()
*/
* @dataProvider hmacData()
*/
public function testHMAC($key, $message, $result)
{
$this->assertHMACsTo($this->getInstance(), $key, $message, $result);

8
tests/Unit/Crypt/Hash/SHA512_96Test.php
View File

@ -13,16 +13,16 @@ class Unit_Crypt_Hash_SHA512_96Test extends Unit_Crypt_Hash_SHA512Test
}
/**
* @dataProvider hashData()
*/
* @dataProvider hashData()
*/
public function testHash($message, $longResult)
{
parent::testHash($message, substr($longResult, 0, 24));
}
/**
* @dataProvider hmacData()
*/
* @dataProvider hmacData()
*/
public function testHMAC($key, $message, $longResult)
{
parent::testHMAC($key, $message, substr($longResult, 0, 24));

12
tests/Unit/Crypt/RSA/LoadKeyTest.php
View File

@ -261,10 +261,10 @@ Ao8eayMp6FcvNucIpUndo1X8dKMv3Y26ZQIDAQAB
}
/**
* make phpseclib generated XML keys be unsigned. this may need to be reverted
* if it is later learned that XML keys are, in fact, supposed to be signed
* @group github468
*/
* make phpseclib generated XML keys be unsigned. this may need to be reverted
* if it is later learned that XML keys are, in fact, supposed to be signed
* @group github468
*/
public function testUnsignedXML()
{
$rsa = new Crypt_RSA();
@ -282,8 +282,8 @@ Ao8eayMp6FcvNucIpUndo1X8dKMv3Y26ZQIDAQAB
}
/**
* @group github468
*/
* @group github468
*/
public function testSignedPKCS1()
{
$rsa = new Crypt_RSA();

6
tests/Unit/Crypt/RandomTest.php
View File

@ -27,9 +27,9 @@ class Unit_Crypt_RandomTest extends PhpseclibTestCase
}
/**
* Takes a set of random values of length 128 bits and asserts all taken
* values are unique.
*/
* Takes a set of random values of length 128 bits and asserts all taken
* values are unique.
*/
public function testStringUniqueness()
{
$values = array();

24
tests/Unit/File/ASN1Test.php
View File

@ -10,9 +10,9 @@ require_once 'File/ASN1.php';
class Unit_File_ASN1Test extends PhpseclibTestCase
{
/**
* on older versions of File_ASN1 this would yield a PHP Warning
* @group github275
*/
* on older versions of File_ASN1 this would yield a PHP Warning
* @group github275
*/
public function testAnyString()
{
$KDC_REP = array(
@ -83,9 +83,9 @@ class Unit_File_ASN1Test extends PhpseclibTestCase
}
/**
* on older versions of File_ASN1 this would produce a null instead of an array
* @group github275
*/
* on older versions of File_ASN1 this would produce a null instead of an array
* @group github275
*/
public function testIncorrectString()
{
$PA_DATA = array(
@ -235,8 +235,8 @@ class Unit_File_ASN1Test extends PhpseclibTestCase
}
/**
* older versions of File_ASN1 didn't handle indefinite length tags very well
*/
* older versions of File_ASN1 didn't handle indefinite length tags very well
*/
public function testIndefiniteLength()
{
$asn1 = new File_ASN1();
@ -270,8 +270,8 @@ class Unit_File_ASN1Test extends PhpseclibTestCase
}
/**
* @group github477
*/
* @group github477
*/
public function testContextSpecificNonConstructed()
{
$asn1 = new File_ASN1();
@ -280,8 +280,8 @@ class Unit_File_ASN1Test extends PhpseclibTestCase
}
/**
* @group github602
*/
* @group github602
*/
public function testEmptyContextTag()
{
$asn1 = new File_ASN1();

4
tests/Unit/Math/BigInteger/TestCase.php
View File

@ -295,8 +295,8 @@ abstract class Unit_Math_BigInteger_TestCase extends PhpseclibTestCase
}
/**
* @group github279
*/
* @group github279
*/
public function testDiffieHellmanKeyAgreement()
{
if (getenv('TRAVIS') && PHP_VERSION === '5.3.3'