Skip to content

Update RSA for compatibility with javascript #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Exceptions/DecryptException.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

class DecryptException extends \Exception
{
public function __construct(string $message = "Cannot decrypt text", int $code = 0, Throwable $previous = null)
public function __construct(string $message = "Cannot decrypt text", int $code = 0, ?Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
}
Expand Down
73 changes: 52 additions & 21 deletions src/RSAParameters.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
{
private string $privateKey;
private string $publicKey;
private string $passphrase;
private ?string $passphrase = 'test_passphrase';

Check failure on line 11 in src/RSAParameters.php

View workflow job for this annotation

GitHub Actions / stan

Property MayMeow\Cryptography\RSAParameters::$passphrase (string|null) is never assigned null so it can be removed from the property type.

protected array $config = [

Check failure on line 13 in src/RSAParameters.php

View workflow job for this annotation

GitHub Actions / stan

Property MayMeow\Cryptography\RSAParameters::$config type has no value type specified in iterable type array.
'digest_alg' => 'sha512',
'digest_alg' => 'sha256',
'private_key_bits' => 4096,
'private_key_type' => OPENSSL_KEYTYPE_RSA,
];
Expand All @@ -31,15 +31,9 @@
{
$keys = openssl_pkey_new($this->config);

if ($passphrase != null) {
$this->passphrase = $passphrase;
} else {
$this->passphrase = (string)rand(100000, 999999);
}

if ($keys) {
openssl_pkey_export($keys, $private, $passphrase, $configArgs);
$this->privateKey = $private;
openssl_pkey_export($keys, $private);
$this->privateKey = $this->encryptPrivateKey(privateKey: $private);

$pub = openssl_pkey_get_details($keys);

Expand All @@ -51,22 +45,40 @@
return $this;
}

private function encryptPrivateKey(string $privateKey, string $salt = 'salt'): string
{
$aes = new AESCryptoServiceProvider();
$aes->generateIV();
$k = new CryptoKey();
$key = $k->getCryptographicKey($this->passphrase, $salt);
$aes->setKey($key);

return $aes->encrypt($privateKey);
}

private function decryptPrivateKey(string $privateKey, string $salt = 'salt'): string
{
$aes = new AESCryptoServiceProvider();
$k = new CryptoKey();
$key = $k->getCryptographicKey($this->passphrase, $salt);
$aes->setKey($key);

return $aes->decrypt($privateKey);
}

/**
* Returns Decrypted Key
*
* @return string|\OpenSSLAsymmetricKey
* @throws DecryptPrivateKeyException
*/
public function getPrivateKey(): \OpenSSLAsymmetricKey|string
public function getPrivateKey(string $salt = 'salt', bool $encrypted = false): \OpenSSLAsymmetricKey|string
{
if ($this->passphrase != null && $this->privateKey != null) {
$privateKeyResource = openssl_pkey_get_private($this->privateKey, $this->passphrase);

if ($privateKeyResource == false) {
throw new DecryptPrivateKeyException();
}

return $privateKeyResource;
if (!$encrypted) {
return $this->decryptPrivateKey(
privateKey: $this->privateKey,
salt: $salt
);
}

return $this->privateKey;
Expand All @@ -78,7 +90,7 @@
* @param string $privateKey
* @param string $passphrase
*/
public function setPrivateKey(string $privateKey, string $passphrase): void
public function setPrivateKey(string $privateKey, string $passphrase, string $salt = 'salt'): void
{
$this->passphrase = $passphrase;
$this->privateKey = $privateKey;
Expand Down Expand Up @@ -109,7 +121,7 @@
*
* @return string
*/
public function getPassphrase(): string
public function getPassphrase(): ?string
{
return $this->passphrase;
}
Expand Down Expand Up @@ -142,4 +154,23 @@
{
$this->config = $config;
}

/**
* Returns the fingerprint of the public key.
*
* @param bool $md5 Whether to return the MD5 fingerprint instead of SHA-256.
* @return string The fingerprint of the public key.
*/
public function getFingerprint(bool $md5 = false): string
{
$derData = preg_replace('/-----.*?-----/', '', base64_decode($this->publicKey));
$derData = preg_replace('/\s+/', '', $derData);
$derData = base64_decode($derData);

if ($md5) {
return implode(':', str_split(hash('md5', $derData), 2));
}

return hash('sha256', $derData);
}
}
7 changes: 1 addition & 6 deletions src/Tools/RsaParametersWriter.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ public function __construct(RSAParametersLocatorInterface $locator)
public function write(RSAParameters $RSAParameters): void
{
file_put_contents($this->locator->locatePublicKey(), $RSAParameters->getPublicKey());
file_put_contents($this->locator->locatePrivateKey(), $RSAParameters->getPrivateKey(encrypted: true));
file_put_contents($this->locator->locatePassphrase(), $RSAParameters->getPassphrase());

openssl_pkey_export_to_file(
$RSAParameters->getPrivateKey(),
$this->locator->locatePrivateKey(),
$RSAParameters->getPassphrase()
);
}
}
3 changes: 2 additions & 1 deletion tests/RSAParametersTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@ public function canExportKeysAndImportToFile() : void
$reader = new RsaParametersReader($locator);
$parameters2 = $reader->read();


// create new instance of RSA CSP with imported parameters
$csp2 = new RSACryptoServiceProvider();
$csp2->setParameters($parameters2);

// Check if imported parameters are same as parameters that was exported
$this->assertEquals($text, $csp2->decrypt($encryptedText));
}
}
}
Loading