aboutsummaryrefslogtreecommitdiff
path: root/sw/trng_extractor.c
blob: e25ebf04fb943c483379999e8fed79bdd1ebef22 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*
 * trng_extractor.c
 * ----------------
 * This program extracts raw data from the avalanche_entropy, rosc_entropy,
 * and csprng cores.
 *
 * Author: Paul Selkirk
 * Copyright (c) 2015, NORDUnet A/S All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the NORDUnet nor the names of its contributors may
 *   be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <stdint.h>
#include <ctype.h>

#include "cryptech.h"

char *usage =
"%s [-a|r|c] [-n #] [-o file]\n\
\n\
-a      avalanche entropy\n\
-r      rosc entropy\n\
-c      csprng (default data source)\n\
-n      number of 4-byte samples (scale with K, M, or G suffix)\n\
-o      output file (defaults to stdout)\n\
-v      verbose operation\n\
";

/* check availability of avalanche entropy core by reading core name and version */
static int avalanche_check(void)
{
    return
        tc_expected(ENTROPY1_ADDR_NAME0, (const uint8_t *)AVALANCHE_ENTROPY_NAME0, 4) ||
        tc_expected(ENTROPY1_ADDR_NAME1, (const uint8_t *)AVALANCHE_ENTROPY_NAME1, 4);
}

/* check availability of rosc core by reading the core name and version */
static int rosc_check(void)
{
    return
        tc_expected(ENTROPY2_ADDR_NAME0, (const uint8_t *)ROSC_ENTROPY_NAME0, 4) ||
        tc_expected(ENTROPY2_ADDR_NAME1, (const uint8_t *)ROSC_ENTROPY_NAME1, 4);
}

/* check availability of csprng core by reading the core name and version */
static int csprng_check(void)
{
    return
        tc_expected(CSPRNG_ADDR_NAME0, (const uint8_t *)CSPRNG_NAME0, 4) ||
        tc_expected(CSPRNG_ADDR_NAME1, (const uint8_t *)CSPRNG_NAME1, 4);
}

/* extract one data sample */
static int extract(off_t status_addr, off_t data_addr, uint32_t *data)
{
    if (tc_wait(status_addr, ENTROPY1_STATUS_VALID, NULL) != 0) {
        fprintf(stderr, "tc_wait failed\n");
        return 1;
    }

    if (tc_read(data_addr, (uint8_t *)data, 4) != 0) {
        fprintf(stderr, "tc_read failed\n");
        return 1;
    }

    return 0;
}

/* main */
int main(int argc, char *argv[])
{
    int opt;
    unsigned long num_words = 1, i;
    char *endptr;
    off_t status_addr = CSPRNG_ADDR_STATUS;
    off_t data_addr = CSPRNG_ADDR_RANDOM;
    FILE *output = stdout;
    uint32_t data;
    int verbose = 0;

    /* parse command line */
    while ((opt = getopt(argc, argv, "h?varcn:o:")) != -1) {
        switch (opt) {
        case 'h':
        case '?':
            printf(usage, argv[0]);
            return EXIT_SUCCESS;
        case 'a':
            status_addr = ENTROPY1_ADDR_STATUS;
            data_addr = ENTROPY1_ADDR_ENTROPY;
            break;
        case 'r':
            status_addr = ENTROPY2_ADDR_STATUS;
            data_addr = ENTROPY2_ADDR_ENTROPY;
            break;
        case 'c':
            status_addr = CSPRNG_ADDR_STATUS;
            data_addr = CSPRNG_ADDR_RANDOM;
            break;
        case 'v':
            verbose = 1;
            break;
        case 'n':
            num_words = strtoul(optarg, &endptr, 10);
            switch (toupper(*endptr)) {
            case '\0':
                break;
            case 'K':
                num_words *= 1000;
                break;
            case 'M':
                num_words *= 1000000;
                break;
            case 'G':
                num_words *= 1000000000;
                break;
            default:
                fprintf(stderr, "unsupported -n suffix %s\n", endptr);
                return EXIT_FAILURE;
            }
            break;
        case 'o':
            output = fopen(optarg, "wb+");
            if (output == NULL) {
                fprintf(stderr, "error opening output file %s: ", optarg);
                perror("");
                return EXIT_FAILURE;
            }
            break;
        default:
        errout:
            fprintf(stderr, usage, argv[0]);
            return EXIT_FAILURE;
        }
    }
    if (optind < argc) {
        fprintf(stderr, "%s: invalid argument%s --",
                argv[0], argc - optind > 1 ? "s" : "");
        do {
            fprintf(stderr, " %s", argv[optind]);
            ++optind;
        } while (optind < argc);
        fprintf(stderr, "\n");
        goto errout;
    }

    // Check that we can talk to the trng.
    if (verbose)
        printf("Checking that we can access the TRNG...\n");
    if (avalanche_check() || rosc_check() || csprng_check()) {
        fprintf(stderr, "Can't properly access the trng.\n");
        return EXIT_FAILURE;
    }
    if (verbose)
        printf("TRNG access ok..\n");

    /* get the data */
    for (i = 0; i < num_words; ++i) {
        if (extract(status_addr, data_addr, &data) != 0)
            return EXIT_FAILURE;
        if (fwrite(&data, sizeof(data), 1, output) != 1) {
            perror("fwrite");
            fclose(output);
            return EXIT_FAILURE;
        }
        if (verbose && ((i & 0xffff) == 0)) {
	    fprintf(stderr, ".");
	    fflush(stderr);
	}
    }

    fclose(output);
    return EXIT_SUCCESS;
}