Merge pull request #4 from neighbourhoodie/v3-to-v4-updates

V3 to v4 updates

Author: terrafrost

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: phpseclib3 Tests
+name: Rector rules Tests
 
 on: [push]
 
@@ -25,5 +25,8 @@ jobs:
       - name: Install dependencies
         run: composer install --no-interaction --prefer-dist
 
-      - name: Run Rector tests
-        run: vendor/bin/phpunit tests
+      - name: Run Rector tests for 2-to-3 upgrade
+        run: vendor/bin/phpunit tests --filter V2toV3
+
+      - name: Run Rector tests for 3-to-4 upgrade
+        run: vendor/bin/phpunit tests --filter V3toV4

README.md

@@ -1,23 +1,29 @@
 # rector_rules
 
-Rector rules to upgrade a phpseclib v2.0 install to phpseclib v3.0
+Rector rules to upgrade a phpseclib v2.0 install to phpseclib v3.0 or
+to upgrade a phpseclib v3.0 install to phpseclib v4.0.
 
 ## Overview
 
-You can use [phpseclib2_compat](https://github.com/phpseclib/phpseclib2_compat) to make all your phpseclib v2.0 calls use phpseclib v3.0, internally, under the hood, or you can use this [Rector](https://getrector.com/) rule to upgrade your phpseclib v2.0 calls to phpseclib v3.0 calls.
+You can use [phpseclib2_compat](https://github.com/phpseclib/phpseclib2_compat) to make all your phpseclib v2.0 calls use phpseclib v3.0, internally, under the hood.
+Or you can use this [Rector](https://getrector.com/) rule to upgrade your
+phpseclib v2.0 calls to phpseclib v3.0 calls or your
+phpseclib v3.0 calls to your phpseclib v4.0 calls.
 
 ## Installation
 
 With [Composer](https://getcomposer.org/):
 
-```
+```bash
 composer require phpseclib/rector_rules:~1.0
 ```
 
 ## Usage
 
 Create a rector.php file with the following contents:
 
+### v2 to v3 upgrade
+
 ```php
 <?php
 use Rector\Config\RectorConfig;
@@ -26,6 +32,20 @@ use phpseclib\rectorRules\Set\V2toV3Set;
 return RectorConfig::configure()
     ->withSets([V2toV3Set::PATH]);
 ```
+
+### v3 to v4 upgrade
+
+```php
+<?php
+use Rector\Config\RectorConfig;
+use phpseclib\rectorRules\Set\V3toV4Set;
+
+return RectorConfig::configure()
+    ->withSets([V3toV4Set::PATH]);
+```
+
+### Refactor
+
 In the same directory where you created that file you can then run Rector by doing either of these commands:
 
 ```
@@ -38,13 +58,18 @@ The files in the `src/` directory will either be full on modified or (in the cas
 
 To run all Retor tests, run
 
-```
+```bash
 vendor/bin/phpunit tests
 ```
 
+To run all tests of a ruleset, add the name of it, like
+```bash
+vendor/bin/phpunit tests --filter V2toV3
+```
+
 To run all tests of a single rector rule, add --filter to the test command.
 
-```
+```bash
 vendor/bin/phpunit tests --filter CustomRectorTest
 ```
 
@@ -59,7 +84,7 @@ A. `test_fixture.php.inc` - The Code Should Change
 ```php
 <code before>
 -----
-<code after>'
+<code after>
 ```
 
 B. `skip_rule_test_fixture.php.inc` - The Code Should Be Skipped
@@ -70,165 +95,4 @@ B. `skip_rule_test_fixture.php.inc` - The Code Should Be Skipped
 
 ## 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
-```php
-use phpseclib\Crypt\RSA;
-
-$rsa = new RSA();
-$rsa->loadKey('...');
-```
-with
-
-```php
-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 | RSA::ENCYRPTION_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:
-
-```sh
-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
-```php
-use phpseclib\Crypt\RSA;
-
-$rsa = new RSA();
-extract($rsa->createKey(2048));
-```
-
-with
-
-```php
-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
-```php
-use phpseclib\Crypt\Hash;
-
-$hash = new Hash('sha512/224');
-echo $hash->getLength();
-```
-with
-```php
-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
-```php
-use phpseclib\Net\SFTP;
-
-$sftp = new SFTP('...');
-$sftp->login('username', 'password');
-echo $sftp->size('/path/to/filename.ext');
-```
-
-with
-
-```php
-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:
-
-```php
-$cipher = new AES(AES::MODE_CTR);
-```
-
-In phpseclib v3 that's been replaced with strings. eg.
-
-```php
-$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');              |
+Details of the rules are in separate Readme files for [phpseclib v2.0 to phpseclib v3.0](./src/Rector/V2toV3/README.md) and [phpseclib v3.0 to phpseclib v4.0](./src/Rector/V3toV4/README.md).

config/v3-to-v4.php

@@ -0,0 +1,14 @@
+<?php
+use Rector\Config\RectorConfig;
+
+use phpseclib\rectorRules\Rector\V3toV4\X509NodeVisitor;
+use phpseclib\rectorRules\Rector\V3toV4\X509;
+
+return RectorConfig::configure()
+  ->registerDecoratingNodeVisitor(X509NodeVisitor::class)
+  ->withRules([
+    X509::class,
+  ])
+  ->withPreparedSets(
+    codingStyle: true,
+  );

rector.php

@@ -4,6 +4,8 @@
 
 use Rector\Config\RectorConfig;
 use phpseclib\rectorRules\Set\V2toV3Set;
+use phpseclib\rectorRules\Set\V3toV4Set;
 
 return RectorConfig::configure()
-    ->withSets([V2toV3Set::PATH]);
+    // ->withSets([V2toV3Set::PATH]);
+    ->withSets([V3toV4Set::PATH]);