phpseclib3_rector

Rector rules to upgrade a phpseclib v2.0 install to phpseclib v3.0

Overview

You can use phpseclib2_compat to make all your phpseclib v2.0 calls use phpseclib v3.0, internally, under the hood, or you can use this Rector rule to upgrade your phpseclib v2.0 calls to phpseclib v3.0 calls.

Installation

With Composer:

composer require phpseclib/phpseclib3_rector:~1.0

Usage

Create a rector.php file with the following contents:

<?php
use Rector\Config\RectorConfig;
use phpseclib\phpseclib3Rector\Set;

return RectorConfig::configure()
    ->withSets([Set::PATH]);

In the same directory where you created that file you can then run Rector by doing either of these commands:

vendor/bin/rector process src --dry-run
vendor/bin/rector process src

The files in the src/ directory will either be full on modified or (in the case of --dry-run) the changes that would be made will be previewed.

Running the tests

To run all Retor tests, run

vendor/bin/phpunit tests

To run all tests of a single rector rule, add --filter to the test command.

vendor/bin/phpunit tests --filter CustomRectorTest

Test Fixtures

Next to the test case, there is /Fixture directory. It contains many test fixture files that verified the Rector rule work correctly in all possible cases.

There are 2 fixture formats:

A. test_fixture.php.inc - The Code Should Change

<code before>
-----
<code after>'

B. skip_rule_test_fixture.php.inc - The Code Should Be Skipped

<code before>

Rules

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->withSaltLength(10)
$rsa->setSignatureMode(RSA::SIGNATURE_PKCS1);	$rsa->withPadding(RSA::SIGNATURE_PKCS1);
$rsa->setEncryptionMode(RSA::ENCRYPTION_PKCS1);	$rsa->withPadding(RSA::ENCYRPTION_PKCS1);
$rsa->setEncryptionMode(RSA::ENCRYPTION_PKCS1); $rsa->setSignatureMode(RSA::SIGNATURE_PKCS1);	$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');