trenker/simple-rsa

Easy to use and integrate API for using RSA encrypted values during HTTP communication.

dev-master 2015-12-05 17:32 UTC

Requires

• php: >=5.3.0
• phpseclib/phpseclib: dev-master

Suggests

• ext-openssl: Install the OpenSSL extension for MUCH faster operations.

BSD 3-Clause License

• Georg Großberger

README

A simple framework for RSA encryption of form field values in browser - server communication using Javascript and PHP.

Useage

Requirements

You will need a server with PHP 5.3 installed and a web browser that does not choke on more complicated javascript code.

Installation

Install via composer

composer install trenker/simple-rsa

Now you can create a key pair like this:

require 'vendor/autoload.php';

$key = \RSA\KeyPair::createNew();

On the client side, include the rsa.js file (or the rsa.min.js file if you want to keep it small).

<script type="text/javascript" src="javascript/rsa.js"></script>

You can autoload the rsa scripts using the JavascriptHelper::getFrontendUrl function

<script type="text/javascript" src="<?= \RSA\JavascriptHelper::getFrontendUrl(); ?>"></script>

This will publish the the minified script to an accessible location. By default it is DOCUMENT_ROOT/scripts/rsa.min.MTIME_TIMESTAMP.js. This can easily be adjusted using the arguments or the function. Please take a look into the source file for details

After the script tag, that loads the rsa.js file you can use $key->toJavascript(); function to create a code snippet that takes care of setting the values and creating an instance. eg:

<script type="text/javascript">
	<?php echo $key->toJavascript(); ?>

	// Now we can use it
	// by default the RSAKey object lives in the "rsaEncrypter" variable

	var cipherText = rsaEncrypter.encrypt("Something private");
</script>

For a full example see the demo/index.php file

License

This one is provided under the terms of the GPL v3. See the FSF GPL website for details.

Credits

This library includes the following tools:

• RSA and ECC in JavaScript toolset, (c) 2005 by Tom Wu, released under a BSD license
• phpseclib released under a MIT License