Skip to content

README.md

Latest commit

 

History

History
165 lines (115 loc) · 5.14 KB

README.md

File metadata and controls

165 lines (115 loc) · 5.14 KB

Rules for v2 to v3 Rector

Public Key Loader

This rule is for v2 -> v3 upgrade.

This rule helps to load unencrypted and encrypted public / private keys.

In v2 loadKey() returns true on success and false on failure. v2 only supports RSA keys and $rsa is not immutable. And in v3 PublicKeyLoader returns an immutable instance of either \phpseclib3\Crypt\Common\PublicKey or \phpseclib3\Crypt\Common\PrivateKey. An exception is thrown on failure.

It replaces

use phpseclib\Crypt\RSA;

$rsa = new RSA();
$rsa->loadKey('...');

with

use phpseclib3\Crypt\PublicKeyLoader;

$rsa = PublicKeyLoader::load('...');

When setPassword is used, $rsa->setPassword('password'); will be replaced with $rsa = PublicKeyLoader::load('...', $password);.

Additionally it replaces the following methods:

v2 v3
$rsa->getSize() $rsa->getLength()
$rsa->setHash('sha256'); $rsa = $rsa->withHash('sha256')
$rsa->setMGFHash('sha256'); $rsa = $rsa->withMGFHash('sha256')
$rsa->setSaltLength(10); $rsa = $rsa->withSaltLength(10)
$rsa->setSignatureMode(RSA::SIGNATURE_PKCS1); $rsa = $rsa->withPadding(RSA::SIGNATURE_PKCS1);
$rsa->setEncryptionMode(RSA::ENCRYPTION_PKCS1); $rsa = $rsa->withPadding(RSA::ENCYRPTION_PKCS1);
$rsa->setEncryptionMode(RSA::ENCRYPTION_PKCS1); $rsa->setSignatureMode(RSA::SIGNATURE_PKCS1); $rsa = $rsa->withPadding(RSA::SIGNATURE_PKCS1

Public Key Loader Chained

Does the same things as PublicKeyLoader, but chains the methods.

The chaining option writes everything into one line. You can format them by running:

vendor/bin/php-cs-fixer fix path/to/file.php --rules=binary_operator_spaces,method_chaining_indentation

Create Key

This rule is for v2 -> v3 upgrade.

It replaces

use phpseclib\Crypt\RSA;

$rsa = new RSA();
extract($rsa->createKey(2048));

with

use phpseclib3\Crypt\RSA;

$privateKey = RSA::createKey(2048);
$publicKey = $privateKey->getPublicKey();
$privateKey = (string) $privateKey;
$publicKey = (string) $publicKey;

In v2, $rsa->createKey() returns an array with 3x parameters: privatekey, publickey, partial. privatekey and public key are strings, partial can be ignored.

The above v3 example returns an immutable instance of phpseclib3\Crypt\Common\PrivateKey.

The public key can be extracted by: $rsa->getPublicKey().

HashLength

This rule is for v2 -> v3 upgrade.

In phpseclib v2 getLength would sometimes return the length in bits and sometimes it'd return the length in bytes in phpseclib v3 it was made consistent - getLength always returns the length in bits and getLengthInBytes always returns the length in bytes.

It replaces

use phpseclib\Crypt\Hash;

$hash = new Hash('sha512/224');
echo $hash->getLength();

with

use phpseclib3\Crypt\Hash;

$hash = new Hash('sha512/224');
echo $hash->getLengthInBytes();

SFTP File Size

This rule is for v2 -> v3 upgrade.

In phpseclib v2 you have filemtime, fileatime, fileowner but, instead of filesize, you just have size? phpseclib v3 fixes that.

It replaces

use phpseclib\Net\SFTP;

$sftp = new SFTP('...');
$sftp->login('username', 'password');
echo $sftp->size('/path/to/filename.ext');

with

use phpseclib3\Net\SFTP;

$sftp = new SFTP('...');
$sftp->login('username', 'password');
echo $sftp->filesize('/path/to/filename.ext');

Symmetric Key Constructor

This rule is for v2 -> v3 upgrade.

In phpseclib v2 you'd instantiate the constructor by doing stuff like this:

$cipher = new AES(AES::MODE_CTR);

In phpseclib v3 that's been replaced with strings. eg.

$cipher = new AES('ctr');

Also, in phpseclib v2, $cipher = new AES() was the same as $cipher = new AES(AES::MODE_CBC). In v3 it doesn't default to cbc - the mode needs to be explicitly defined.

This is true for all the classes that extend \phpseclib3\Crypt\Common\BlockCipher in v3:

v2 v3
$default = new DES(); $default = new DES('cbc');
$des = new DES(DES::MODE_CBC); $des = new DES('cbc');
$rijndael = new Rijndael(Rijndael::MODE_ECB); $rijndael = new Rijndael('ecb');
$tripleDES = new TripleDES(TripleDES::MODE_CTR); $tripleDES = new TripleDES('ctr');
$blowfish = new Blowfish(Blowfish::MODE_CFB); $blowfish = new Blowfish('cfb');
$twofish = new Twofish(Twofish::MODE_CFB8); $twofish = new Twofish('cfb8');
$rc2 = new RC2(RC2::MODE_OFB); $rc2 = new RC2('ofb');
$aes = new AES(AES::MODE_OFB8); $aes = new AES('ofb8');
$aes2 = new AES(AES::MODE_GCM); $aes2 = new AES('gcm');