calumgrant / SecureRandom

Secure random number generation in C#

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SecureRandom

SecureRandom is a drop-in replacement for System.Random that produces unbiased, cryptographically secure random numbers, and unbiased, cryptographically secure shuffles.

This combines the convenience of System.Random with the security of System.Security.Cryptography.RNGCryptoServiceProvider.

SecureRandom uses a (possibly novel) algorithm for entropy conversion, that reads hardware entropy from RNGCryptoServiceProvider (or some other entropy source), and converts it to a different base, whilst losing a minimum amount of entropy in the process.

Usage

The class Entropy.SecureRandom is a drop-in replacement for System.Random. For example,

using Entropy;

void Main()
{
    using var random = new SecureRandom();
    
    // 100 cryptographically secure dice rolls
    for (int i=0; i<100; ++i)
        Console.WriteLine($"You rolled a {random.Next(1,7)}");
    
    // Cryptographically secure random shuffle
    var deck = new int[52];
    random.Shuffle(deck);
}

Installation

SecureRandom is available as a nuget package, and can be found using the package SecureRandom. For example,

dotnet add package SecureRandom --version 1.0.1

Building

Checkout the code into a directory using

git clone https://github.com/calumgrant/SecureRandom

then build the code using

dotnet build

Tests can be run using

dotnet test

Theoretical background

Motivation

This algorithm solves the fundamental problem "how do you shuffle a deck of cards using a string of binary entropy."

The fundamental problem is that the entropy from sources such as RNGCryptoServiceProvider only produce arrays of bytes, and need to be converted into other forms before they can be used. This is extremely inconvenient, error-prone, and potentially inefficient. See for example System.Security.Cryptography.RNGCryptoServiceProvider which attempts to convert bytes into dice rolls.

It is important that the resulting numbers are unbiased, and when shuffling an array (such as a deck of cards), that the resulting array is "perfectly shuffled" meaning that all permutations are equally likely.

The theoretical guarantee offered by SecureRandom is that if the input entropy is unbiased, then the generated random numbers (and shuffles) are unbiased.

It is desirable to minimise the number of bytes read from the input stream, because hardware entropy can be slow to generate, and because it is unsatisfactory from a theoretical perspective to read too much data from the input source.

Implementation

In order to work with entropy, we store randomness in an "entropy buffer" consisting of a uniform random number value in the range [0, size). The number of bits of entropy stored in this buffer is lg(size). If size is a 64-bit ulong, then the buffer can store up to 64 bits of entropy.

In order to extract some entropy from the buffer, we can perform the following operations on an entropy buffer:

  • Factor: If size = n*m, then we can factor the entropy buffer into two smaller entropy buffers of size n and m.
    value1 = value / m;
    value2 = value % m;
  • Split: If size = a+b, then we can spend up to 1 bit of entropy in order to produce an entropy buffer of size a or size b.
    if (value<a)
    {
        size = a;
    }
    else
    {
        value -= a;
        size = b;
    }

The other "trick" SecureRandom uses is to ensure that we resize the entropy buffer very slighty, which means that split operation loses a negligible quantity of entropy in practise. Exercise to the reader: prove that the quantity of entropy lost by Split is given by the binary entropy function.

The algorithm used by SecureRandom is to

  1. Ensure a large entropy buffer by reading as much data as possible from the entropy source into value.
  2. Resize the buffer using split such that size = n*m.
  3. Factor the buffer into the result value%n and the residue value/n.

The efficency of this algorithm is extremely good, since the split operation loses very little entropy on average.

About

Secure random number generation in C#

License:Apache License 2.0


Languages

Language:C# 100.0%