initial commit

Author: terrafrost

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 phpseclib
+Copyright (c) 2025 terrafrost
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -0,0 +1,34 @@
+# phpseclib3_rector
+
+Rector rules to upgrade a phpseclib v2.0 install to phpseclib v3.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.
+
+## Installation
+
+With [Composer](https://getcomposer.org/):
+
+```
+composer require phpseclib/phpseclib2_rector:~1.0
+```
+## Usage
+
+Create a rector.php file with the following contents:
+
+```php
+<?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.

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "phpseclib/phpseclib3_rector",
+    "description": "Rector rules for upgrading from phpseclib v2 to phpseclib v3",
+    "type": "rector-extension",
+    "require": {
+        "rector/rector": "^2.0.0"
+    },
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "phpseclib\\phpseclib3Rector\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "terrafrost",
+            "email": "terrafrost@php.net"
+        }
+    ]
+}

src/RSAMethodRector.php

@@ -0,0 +1,97 @@
+<?php
+namespace phpseclib\phpseclib3Rector;
+
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Expr\NullsafeMethodCall;
+use PhpParser\Node\Expr\StaticCall;
+use PhpParser\Node\Name\FullyQualified;
+use Rector\Renaming\ValueObject\MethodCallRename;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/*
+This admittedly hackish technique is being employed to facilitate code re-use. RectorPHP defines its
+classes as final with private methods so inheritance isn't an option, without this hackish technique
+
+Composition isn't a great option, either, because I'd need to redefine autowire and the other public
+methods from AbstractRector. The problem with that is...  what if another parameter is added to
+autowire? I'd just assume minimize the time I need to spend maintaining the code - not maximize it.
+And plus, if a new parameter were added then it seems unlikely that the code would work on older
+versions of Rector. Extended AbstractRector isn't an option because enterNode() is declared final in
+AbstractRector and implementing RectorInterface is suboptimal because all the method implementations
+in AbstractRector would need to be copied and that kinda contradicts the goal is not duplicating code.
+*/
+$old = file_get_contents(__DIR__ . '\..\..\..\rector\rector\rules\Renaming\Rector\MethodCall\RenameMethodRector.php');
+$tokens = \PhpToken::tokenize($old);
+$tokens = array_slice($tokens, 1); // remove the <?php
+$new = '';
+foreach ($tokens as $token) {
+    switch ("$token") {
+        case 'final':
+            continue 2;
+        case 'RenameMethodRector':
+            $token = 'NewRenameMethodRector';
+            break;
+        case 'private':
+            $token = 'protected';
+    }
+    $new.= $token;
+}
+eval($new);
+
+class RSAMethodRector extends \Rector\Renaming\Rector\MethodCall\NewRenameMethodRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes() : array
+    {
+        return [MethodCall::class, NullsafeMethodCall::class];
+    }
+
+    /**
+     * @param \PhpParser\Node\Expr\StaticCall|\PhpParser\Node\Expr\MethodCall|\PhpParser\Node\Expr\NullsafeMethodCall $call
+     * @return \PhpParser\Node\Expr\ArrayDimFetch|null|\PhpParser\Node\Expr\MethodCall|\PhpParser\Node\Expr\StaticCall|\PhpParser\Node\Expr\NullsafeMethodCall
+     */
+    protected function refactorMethodCallAndStaticCall($call)
+    {
+        $this->methodCallRenames = [
+            new MethodCallRename('phpseclib\Crypt\RSA', 'loadKey', 'loadKey'),
+            new MethodCallRename('phpseclib\Crypt\RSA', 'createKey', 'createKey'),
+            new MethodCallRename('phpseclib\Crypt\RSA', 'setEncryptionMode', 'setEncryptionMode'),
+            new MethodCallRename('phpseclib\Crypt\RSA', 'setSignatureMode', 'setSignatureMode'),
+        ];
+        $call = parent::refactorMethodCallAndStaticCall($call);
+        if (is_null($call)) {
+            return null;
+        }
+        switch ($call->name) {
+            case 'loadKey':
+                return new StaticCall(
+                    new FullyQualified('phpseclib3\Crypt\PublicKeyLoader'),
+                    'loadKey',
+                    $call->args
+                );
+            case 'createKey':
+                return new StaticCall(
+                    new FullyQualified('phpseclib3\Crypt\RSA'),
+                    'createKey',
+                    $call->args
+                );
+            case 'setEncryptionMode':
+            case 'setSignatureMode':
+                $className = $call::CLASS;
+                $newCall = new $className($call->var, 'withPadding', $call->args);
+                return new Assign(
+                    $call->var,
+                    $newCall
+                );
+        }
+    }
+
+    public function getRuleDefinition() : RuleDefinition
+    {
+        return new RuleDefinition('Changes method call names for \phpseclib\Crypt\RSA', []);
+    }
+}

src/RSANewRector.php

@@ -0,0 +1,47 @@
+<?php
+namespace phpseclib\phpseclib3Rector;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Assign;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Stmt\Expression;
+use PhpParser\NodeVisitor;
+use PHPStan\Type\ObjectType;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+class RSANewRector extends AbstractRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Expression::class];
+    }
+
+    /**
+     * @param Expression $node
+     */
+    public function refactor(Node $node)
+    {        
+        if (! $node->expr instanceof Assign) {
+         	return null;   
+        }
+        
+        if (! $node->expr->expr instanceof New_) {
+         	return null;   
+        }
+        
+        if ($this->isObjectType($node->expr->expr->class, new ObjectType('phpseclib\Crypt\RSA'))) {
+            return NodeVisitor::REMOVE_NODE;
+        }
+        
+        return null;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Delete direct instantiations of \phpseclib\Crypt\RSA', []);
+    }
+}

src/Set.php

@@ -0,0 +1,26 @@
+<?php
+namespace phpseclib\phpseclib3Rector;
+
+use Rector\Config\RectorConfig;
+use Rector\Renaming\Rector\Name\RenameClassRector;
+
+if (!class_exists('\phpseclib\phpseclib3Rector\Set'))
+{
+    class Set
+    {
+        const PATH = __FILE__;
+    }
+}
+
+return RectorConfig::configure()
+    ->withRules([
+        RSAMethodRector::class,
+        RSANewRector::class,
+    ])
+    ->withConfiguredRule(RenameClassRector::class, [
+        'phpseclib\Crypt\RSA' => 'phpseclib3\Crypt\RSA',
+        'phpseclib\Net\SSH2' => 'phpseclib3\Net\SSH2',
+        'phpseclib\Net\SFTP' => 'phpseclib3\Net\SFTP',
+        'phpseclib\Math\BigInteger' => 'phpseclib3\Math\BigInteger',
+    ])
+    ->withImportNames(removeUnusedImports: true);