winscp/source/putty/sshrand.c

/*
 * sshrand.c: manage the global live PRNG instance.
 */

#include "putty.h"
#include "ssh.h"
#include "storage.h"
#include <assert.h>

/* Collect environmental noise every 5 minutes */
#define NOISE_REGULAR_INTERVAL (5*60*TICKSPERSEC)

int random_active = 0;

#ifdef FUZZING

/*
 * Special dummy version of the RNG for use when fuzzing.
 */
void random_add_noise(NoiseSourceId source, const void *noise, int length) { }
void random_ref(void) { }
void random_setup_custom(const ssh_hashalg *hash) { }
void random_unref(void) { }
void random_read(void *out, size_t size)
{
    memset(out, 0x45, size); /* Chosen by eight fair coin tosses */
}
void random_get_savedata(void **data, int *len) { }

#else /* !FUZZING */

/* Dummy structure for the sake of having something to expire_timer_context */
static struct random_timer_context { int dummy; } random_timer_ctx;

static prng *global_prng;
static unsigned long next_noise_collection;

void random_add_noise(NoiseSourceId source, const void *noise, int length)
{
    WINSCP_PUTTY_SECTION_ENTER;
    if (!random_active)
    {
        WINSCP_PUTTY_SECTION_LEAVE;
        return;
    }

    prng_add_entropy(global_prng, source, make_ptrlen(noise, length));
    WINSCP_PUTTY_SECTION_LEAVE;
}

static void random_timer(void *ctx, unsigned long now)
{
    unreachable_internal(); // WINSCP
    WINSCP_PUTTY_SECTION_ENTER;
    if (random_active > 0 && now == next_noise_collection) {
        noise_regular();
        next_noise_collection =
            schedule_timer(NOISE_REGULAR_INTERVAL, random_timer,
                           &random_timer_ctx);
    }
    WINSCP_PUTTY_SECTION_LEAVE;
}

static void random_seed_callback(void *noise, int length)
{
    WINSCP_PUTTY_SECTION_ENTER;
    put_data(global_prng, noise, length);
    WINSCP_PUTTY_SECTION_LEAVE;
}

static void random_create(const ssh_hashalg *hashalg)
{
    assert(!global_prng);
    global_prng = prng_new(hashalg);

    prng_seed_begin(global_prng);
    noise_get_heavy(random_seed_callback);
    prng_seed_finish(global_prng);

    next_noise_collection =
        schedule_timer(NOISE_REGULAR_INTERVAL, random_timer,
                       &random_timer_ctx);

    /* noise_get_heavy probably read our random seed file.
     * Therefore (in fact, even if it didn't), we should write a
     * fresh one, in case another instance of ourself starts up
     * before we finish, and also in case an attacker gets hold of
     * the seed data we used. */
    random_save_seed();
}

void random_save_seed(void)
{
    int len;
    void *data;

    if (random_active) {
        random_get_savedata(&data, &len);
        write_random_seed(data, len);
        sfree(data);
    }
}

void random_ref(void)
{
    WINSCP_PUTTY_SECTION_ENTER;
    if (!random_active++) {
        enable_dit(); /* just in case main() forgot */
        random_create(&ssh_sha256);
    }
    WINSCP_PUTTY_SECTION_LEAVE;
}

void random_setup_custom(const ssh_hashalg *hash)
{
    unreachable_internal(); // used by PuTTYgen only
    WINSCP_PUTTY_SECTION_ENTER;
    random_active++;
    random_create(hash);
    WINSCP_PUTTY_SECTION_LEAVE;
}

void random_reseed(ptrlen seed)
{
    unreachable_internal(); // used by PuTTYgen only
    WINSCP_PUTTY_SECTION_ENTER;
    prng_seed_begin(global_prng);
    put_datapl(global_prng, seed);
    prng_seed_finish(global_prng);
    WINSCP_PUTTY_SECTION_LEAVE;
}

// Never called directly in WINSCP
void random_clear(void)
{
    if (global_prng) {
        #ifndef WINSCP
        // We control this on our own in PuttyFinalize()
        random_save_seed();
        #endif
        expire_timer_context(&random_timer_ctx);
        prng_free(global_prng);
        global_prng = NULL;
        random_active = 0;
    }
}

void random_unref(void)
{
    WINSCP_PUTTY_SECTION_ENTER;
    assert(random_active > 0);
    if (--random_active == 0)
        random_clear();
    WINSCP_PUTTY_SECTION_LEAVE;
}

void random_read(void *buf, size_t size)
{
    WINSCP_PUTTY_SECTION_ENTER;
    assert(random_active > 0);
    prng_read(global_prng, buf, size);
    WINSCP_PUTTY_SECTION_LEAVE;
}

void random_get_savedata(void **data, int *len)
{
    WINSCP_PUTTY_SECTION_ENTER; // though called from our finalizer, when the app is single threaded only
    void *buf = snewn(global_prng->savesize, char);
    random_read(buf, global_prng->savesize);
    *len = global_prng->savesize;
    *data = buf;
    WINSCP_PUTTY_SECTION_LEAVE;
}

size_t random_seed_bits(void)
{
    assert(random_active > 0);
    return prng_seed_bits(global_prng);
}

#endif /* FUZZING */