docs.rs failed to build pumpkin-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: pumpkin-2.0.1

Pumpkin

A cryptographically secure pseudo-random number generator for generating large prime.

What's up with the name?

Since I began writing this library around Halloween of 2015, I wanted to choose a name that was vaguely related to the holiday. Because "pumpkin" and "prime" both begin with the letter 'p', I decided to use that. And that's all there really is to it!

Purpose

pumpkin is a cryptographically-secure pseudo-random number generator, which is useful for generating large prime numbers for cryptography. In fact, pumpkin can ONLY be used to generate prime numbers. On the back-end, pumpkin uses the wonderful ramp library for storing the large numbers. pumpkin generates numbers very quickly, so you can be sure that your program will be performative. In our testing, primes were generated anywhere between 1s and 5s on average, though of course your mileage may vary.

Example

extern crate pumpkin;

use pumpkin::Prime;

fn main() {
    let p = Prime::new(2048); // Generate a new 2048-bit prime number
    let q = Prime::new(2048);
    let e = p * q;

    println("{}", e);

    /*
     * 75222035638256552797269351238215022250546763213674706... Some massive
     * 4096-bit number.
     */
}

Explanation

Primes are generated much the same way that large primes are generated by GnuPG:

Create a large candidate number of size based on the input given to the Prime::new() method. All Primes must be at least 2-bits long (thoug it wouldn't make much sense to be that small.
Divide the candidate number by the first 1,000 prime numbers.
Test the candidate number with Fermat's Little Theorem.
Finally, run five iterations of the Miller-Rabin Primality Test.

Primes are seeded by rand::OsRng, which receives its entropy via the operating system's own entropy source (such as /dev/urandom). Thus, because we can be confident that the generated candidate number is truly random (or as close to truly random as the user can hope), we don't need to do more than five iterations of the Miller-Rabin test to ensure primality.

Primes are simple "newtype" structs; that is, it is a tuple-like struct surrounding an Int type. Primes have all of the basic algebraic and logical operators implemented, thus allowing you to do any operation that you would require.

Contributing