Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
RSAKey Class Reference

RSA public/private key-pair encryption class. More...

Public Member Functions

 RSAKey ()
 Creates a null key object. More...
 
 RSAKey (const String &stringRepresentation)
 Loads a key from an encoded string representation. More...
 
 ~RSAKey ()
 Destructor. More...
 
bool operator== (const RSAKey &other) const noexcept
 
bool operator!= (const RSAKey &other) const noexcept
 
String toString () const
 Turns the key into a string representation. More...
 
bool isValid () const noexcept
 Returns true if the object is a valid key, or false if it was created by the default constructor. More...
 
bool applyToValue (BigInteger &value) const
 Encodes or decodes a value. More...
 

Static Public Member Functions

static void createKeyPair (RSAKey &publicKey, RSAKey &privateKey, int numBits, const int *randomSeeds=nullptr, int numRandomSeeds=0)
 Creates a public/private key-pair. More...
 

Protected Attributes

BigInteger part1
 
BigInteger part2
 

Detailed Description

RSA public/private key-pair encryption class.

An object of this type makes up one half of a public/private RSA key pair. Use the createKeyPair() method to create a matching pair for encoding/decoding.

If you need to use this class in conjunction with a compatible enc/decryption algorithm on a webserver, you can achieve the same thing in PHP like this:

include ('Math/BigInteger.php'); // get this from: phpseclib.sourceforge.net
function applyToValue ($message, $key_part1, $key_part2)
{
$result = new Math_BigInteger();
$zero = new Math_BigInteger();
$value = new Math_BigInteger (strrev ($message), 256);
$part1 = new Math_BigInteger ($key_part1, 16);
$part2 = new Math_BigInteger ($key_part2, 16);
while (! $value->equals ($zero))
{
$result = $result->multiply ($part2);
list ($value, $remainder) = $value->divide ($part2);
$result = $result->add ($remainder->modPow ($part1, $part2));
}
return strrev ($result->toBytes());
}

..or in Java with something like this:

public class RSAKey
{
static BigInteger applyToValue (BigInteger value, String key_part1, String key_part2)
{
BigInteger result = BigInteger.ZERO;
BigInteger part1 = new BigInteger (key_part1, 16);
BigInteger part2 = new BigInteger (key_part2, 16);
if (part1.equals (BigInteger.ZERO) || part2.equals (BigInteger.ZERO)
|| value.compareTo (BigInteger.ZERO) <= 0)
return result;
while (! value.equals (BigInteger.ZERO))
{
result = result.multiply (part2);
BigInteger[] div = value.divideAndRemainder (part2);
value = div[0];
result = result.add (div[1].modPow (part1, part2));
}
return result;
}
}

Disclaimer: neither of the code snippets above are tested! Please let me know if you have any corrections for them!

Constructor & Destructor Documentation

◆ RSAKey() [1/2]

RSAKey::RSAKey ( )

Creates a null key object.

Initialise a pair of objects for use with the createKeyPair() method.

◆ RSAKey() [2/2]

RSAKey::RSAKey ( const String stringRepresentation)
explicit

Loads a key from an encoded string representation.

This reloads a key from a string created by the toString() method.

◆ ~RSAKey()

RSAKey::~RSAKey ( )

Destructor.

Member Function Documentation

◆ operator==()

bool RSAKey::operator== ( const RSAKey other) const
noexcept

◆ operator!=()

bool RSAKey::operator!= ( const RSAKey other) const
noexcept

◆ toString()

String RSAKey::toString ( ) const

Turns the key into a string representation.

This can be reloaded using the constructor that takes a string.

◆ isValid()

bool RSAKey::isValid ( ) const
noexcept

Returns true if the object is a valid key, or false if it was created by the default constructor.

◆ applyToValue()

bool RSAKey::applyToValue ( BigInteger value) const

Encodes or decodes a value.

Call this on the public key object to encode some data, then use the matching private key object to decode it.

Returns false if the operation couldn't be completed, e.g. if this key hasn't been initialised correctly.

NOTE: This method dumbly applies this key to this data. If you encode some data and then try to decode it with a key that doesn't match, this method will still happily do its job and return true, but the result won't be what you were expecting. It's your responsibility to check that the result is what you wanted.

◆ createKeyPair()

static void RSAKey::createKeyPair ( RSAKey publicKey,
RSAKey privateKey,
int  numBits,
const int *  randomSeeds = nullptr,
int  numRandomSeeds = 0 
)
static

Creates a public/private key-pair.

Each key will perform one-way encryption that can only be reversed by using the other key.

The numBits parameter specifies the size of key, e.g. 128, 256, 512 bit. Bigger sizes are more secure, but this method will take longer to execute.

The randomSeeds parameter lets you optionally pass it a set of values with which to seed the random number generation, improving the security of the keys generated. If you supply these, make sure you provide more than 2 values, and the more your provide, the better the security.

Member Data Documentation

◆ part1

BigInteger RSAKey::part1
protected

◆ part2

BigInteger RSAKey::part2
protected

The documentation for this class was generated from the following file: