Skip to content

Commit

Permalink
Clean up tests, add loadSecretKey methods
Browse files Browse the repository at this point in the history
  • Loading branch information
@paragonie-scott
paragonie-scott committed Nov 14, 2015
1 parent 337cd77 commit 8688f2c
Show file tree
Hide file tree
Showing 5 changed files with 138 additions and 18 deletions.
44 changes: 40 additions & 4 deletions src/KeyFactory.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ public static function loadEncryptionKey($filePath)
* Load, specifically, an encryption public key from a file
*
* @param string $filePath
* @return EncryptionKey
* @return EncryptionPublicKey
*/
public static function loadEncryptionPublicKey($filePath)
{
Expand All @@ -235,11 +235,29 @@ public static function loadEncryptionPublicKey($filePath)
);
}

/**
* Load, specifically, an encryption public key from a file
*
* @param string $filePath
* @return EncryptionSecretKey
*/
public static function loadEncryptionSecretKey($filePath)
{
if (!\is_readable($filePath)) {
throw new Alerts\CannotPerformOperation(
'Cannot read keyfile: '. $filePath
);
}
return new EncryptionSecretKey(
self::loadKeyFile($filePath)
);
}

/**
* Load, specifically, a signature public key from a file
*
* @param string $filePath
* @return EncryptionKey
* @return SignaturePublicKey
*/
public static function loadSignaturePublicKey($filePath)
{
Expand All @@ -253,11 +271,29 @@ public static function loadSignaturePublicKey($filePath)
);
}

/**
* Load, specifically, a signature secret key from a file
*
* @param string $filePath
* @return SignatureSecretKey
*/
public static function loadSignatureSecretKey($filePath)
{
if (!\is_readable($filePath)) {
throw new Alerts\CannotPerformOperation(
'Cannot read keyfile: '. $filePath
);
}
return new SignatureSecretKey(
self::loadKeyFile($filePath)
);
}

/**
* Load an asymmetric encryption key pair from a file
*
* @param string $filePath
* @return EncryptionKey
* @return EncryptionKeyPair
*/
public static function loadEncryptionKeyPair($filePath)
{
Expand All @@ -277,7 +313,7 @@ public static function loadEncryptionKeyPair($filePath)
* Load an asymmetric signature key pair from a file
*
* @param string $filePath
* @return EncryptionKey
* @return SignatureKeyPair
*/
public static function loadSignatureKeyPair($filePath)
{
Expand Down
10 changes: 6 additions & 4 deletions test/unit/AsymmetricTest.php
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
<?php
use \ParagonIE\Halite\Asymmetric\Crypto as Asymmetric;
use \ParagonIE\Halite\Alerts as CryptoException;
use \ParagonIE\Halite\Key;
use \ParagonIE\Halite\KeyPair;
use \ParagonIE\Halite\KeyFactory;
use \ParagonIE\Halite\Asymmetric\EncryptionPublicKey;
use \ParagonIE\Halite\Asymmetric\EncryptionSecretKey;
Expand Down Expand Up @@ -58,7 +56,9 @@ public function testEncryptFail()
true
);
$this->assertEquals($plain, $message);
throw new \Exception('ERROR: THIS SHOULD ALWAYS FAIL');
$this->fail(
'This should have thrown an InvalidMessage exception!'
);
} catch (CryptoException\InvalidMessage $e) {
$this->assertTrue($e instanceof CryptoException\InvalidMessage);
}
Expand Down Expand Up @@ -125,7 +125,9 @@ public function testSealFail()
try {
$opened = Asymmetric::unseal($sealed, $alice->getSecretKey(), true);
$this->assertEquals($opened, $message);
throw new Exception('ERROR: THIS SHOULD ALWAYS FAIL');
$this->fail(
'This should have thrown an InvalidMessage exception!'
);
} catch (CryptoException\InvalidKey $e) {
$this->assertTrue($e instanceof CryptoException\InvalidKey);
} catch (CryptoException\InvalidMessage $e) {
Expand Down
20 changes: 17 additions & 3 deletions test/unit/FileTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ public function testEncrypt()
\hash_file('sha256', __DIR__.'/tmp/paragon_avatar.png'),
\hash_file('sha256', __DIR__.'/tmp/paragon_avatar.decrypted.png')
);
\unlink(__DIR__.'/tmp/paragon_avatar.encrypted.png');
\unlink(__DIR__.'/tmp/paragon_avatar.decrypted.png');
}

public function testEncryptFail()
Expand All @@ -63,9 +65,13 @@ public function testEncryptFail()
__DIR__.'/tmp/paragon_avatar.decrypt_fail.png',
$key
);
throw new \Exception('ERROR: THIS SHOULD ALWAYS FAIL');
$this->fail(
'This should have thrown an InvalidMessage exception!'
);
} catch (CryptoException\InvalidMessage $e) {
$this->assertTrue($e instanceof CryptoException\InvalidMessage);
\unlink(__DIR__.'/tmp/paragon_avatar.encrypt_fail.png');
\unlink(__DIR__.'/tmp/paragon_avatar.decrypt_fail.png');
}
}

Expand Down Expand Up @@ -96,6 +102,9 @@ public function testSeal()
\hash_file('sha256', __DIR__.'/tmp/paragon_avatar.png'),
\hash_file('sha256', __DIR__.'/tmp/paragon_avatar.opened.png')
);

\unlink(__DIR__.'/tmp/paragon_avatar.sealed.png');
\unlink(__DIR__.'/tmp/paragon_avatar.opened.png');
}

public function testSealFail()
Expand All @@ -122,12 +131,16 @@ public function testSealFail()
try {
File::unsealFile(
__DIR__.'/tmp/paragon_avatar.seal_fail.png',
__DIR__.'/tmp/paragon_avatar.opened.png',
__DIR__.'/tmp/paragon_avatar.open_fail.png',
$secretkey
);
throw new \Exception('ERROR: THIS SHOULD ALWAYS FAIL');
$this->fail(
'This should have thrown an InvalidMessage exception!'
);
} catch (CryptoException\InvalidMessage $e) {
$this->assertTrue($e instanceof CryptoException\InvalidMessage);
\unlink(__DIR__.'/tmp/paragon_avatar.seal_fail.png');
\unlink(__DIR__.'/tmp/paragon_avatar.open_fail.png');
}
}

Expand Down Expand Up @@ -169,5 +182,6 @@ public function testChecksum()
$hash,
$file
);
\unlink(__DIR__.'/tmp/garbage.dat');
}
}
78 changes: 72 additions & 6 deletions test/unit/KeyTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
use \ParagonIE\Halite\Key;
use \ParagonIE\Halite\KeyFactory;
use \ParagonIE\Halite\Asymmetric\Crypto as Asymmetric;
use \ParagonIE\Halite\Asymmetric\SecretKey as ASecretKey;
use \ParagonIE\Halite\Asymmetric\PublicKey as APublicKey;
use \ParagonIE\Halite\Asymmetric\EncryptionPublicKey;
use \ParagonIE\Halite\Asymmetric\EncryptionSecretKey;
use \ParagonIE\Halite\Asymmetric\SignaturePublicKey;
use \ParagonIE\Halite\Asymmetric\SignatureSecretKey;
use \ParagonIE\Halite\Symmetric\AuthenticationKey;
use \ParagonIE\Halite\Symmetric\EncryptionKey;

/**
* @backupGlobals disabled
Expand Down Expand Up @@ -43,14 +47,13 @@ public function testDeriveSigningKey()
$keypair = KeyFactory::deriveSignatureKeyPair(
'apple',
"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f".
"\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f",
Key::CRYPTO_SIGN
"\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"
);
$sign_secret = $keypair->getSecretKey();
$sign_public = $keypair->getPublicKey();

$this->assertTrue($sign_secret instanceof ASecretKey);
$this->assertTrue($sign_public instanceof APublicKey);
$this->assertTrue($sign_secret instanceof SignatureSecretKey);
$this->assertTrue($sign_public instanceof SignaturePublicKey);

// Can this be used?
$message = 'This is a test message';
Expand Down Expand Up @@ -114,6 +117,69 @@ public function testKeyTypes()
$this->assertFalse($sign_public->isSecretKey());
$this->assertTrue($sign_public->isSigningKey());
$this->assertTrue($sign_public->isPublicKey());
}

public function testEncKeyStorage()
{
$enc_keypair = KeyFactory::deriveEncryptionKeyPair(
'apple',
"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f".
"\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"
);
$enc_secret = $enc_keypair->getSecretKey();
$enc_public = $enc_keypair->getPublicKey();

$file_secret = \tempnam(__DIR__.'/tmp', 'key');
$file_public = \tempnam(__DIR__.'/tmp', 'key');

$this->assertTrue(
KeyFactory::save($enc_secret, $file_secret) !== false
);
$this->assertTrue(
KeyFactory::save($enc_public, $file_public) !== false
);

$load_public = KeyFactory::loadEncryptionPublicKey($file_public);
$this->assertTrue(
$load_public instanceof EncryptionPublicKey
);
$this->assertTrue(
\hash_equals($enc_public->get(), $load_public->get())
);

\unlink($file_secret);
\unlink($file_public);
}

public function testSignKeyStorage()
{
$sign_keypair = KeyFactory::deriveSignatureKeyPair(
'apple',
"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f".
"\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f"
);
$sign_secret = $sign_keypair->getSecretKey();
$sign_public = $sign_keypair->getPublicKey();

$file_secret = \tempnam(__DIR__.'/tmp', 'key');
$file_public = \tempnam(__DIR__.'/tmp', 'key');

$this->assertTrue(
KeyFactory::save($sign_secret, $file_secret) !== false
);
$this->assertTrue(
KeyFactory::save($sign_public, $file_public) !== false
);

$load_public = KeyFactory::loadSignaturePublicKey($file_public);
$this->assertTrue(
$load_public instanceof SignaturePublicKey
);
$this->assertTrue(
\hash_equals($sign_public->get(), $load_public->get())
);

\unlink($file_secret);
\unlink($file_public);
}
}
4 changes: 3 additions & 1 deletion test/unit/SymmetricTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ public function testEncryptFail()
try {
$plain = Symmetric::decrypt($message, $key, true);
$this->assertEquals($plain, $message);
throw new Exception('ERROR: THIS SHOULD ALWAYS FAIL');
$this->fail(
'This should have thrown an InvalidMessage exception!'
);
} catch (CryptoException\InvalidMessage $e) {
$this->assertTrue($e instanceof CryptoException\InvalidMessage);
}
Expand Down

0 comments on commit 8688f2c

Please sign in to comment.