xref: /openssl/apps/rand.c (revision fecb3aae)
1 /*
2  * Copyright 1998-2022 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9 
10 #include "apps.h"
11 #include "progs.h"
12 
13 #include <ctype.h>
14 #include <stdio.h>
15 #include <string.h>
16 
17 #include <openssl/bio.h>
18 #include <openssl/err.h>
19 #include <openssl/rand.h>
20 
21 typedef enum OPTION_choice {
22     OPT_COMMON,
23     OPT_OUT, OPT_ENGINE, OPT_BASE64, OPT_HEX,
24     OPT_R_ENUM, OPT_PROV_ENUM
25 } OPTION_CHOICE;
26 
27 const OPTIONS rand_options[] = {
28     {OPT_HELP_STR, 1, '-', "Usage: %s [options] num\n"},
29 
30     OPT_SECTION("General"),
31     {"help", OPT_HELP, '-', "Display this summary"},
32 #ifndef OPENSSL_NO_ENGINE
33     {"engine", OPT_ENGINE, 's', "Use engine, possibly a hardware device"},
34 #endif
35 
36     OPT_SECTION("Output"),
37     {"out", OPT_OUT, '>', "Output file"},
38     {"base64", OPT_BASE64, '-', "Base64 encode output"},
39     {"hex", OPT_HEX, '-', "Hex encode output"},
40 
41     OPT_R_OPTIONS,
42     OPT_PROV_OPTIONS,
43 
44     OPT_PARAMETERS(),
45     {"num", 0, 0, "Number of bytes to generate"},
46     {NULL}
47 };
48 
rand_main(int argc,char ** argv)49 int rand_main(int argc, char **argv)
50 {
51     ENGINE *e = NULL;
52     BIO *out = NULL;
53     char *outfile = NULL, *prog;
54     OPTION_CHOICE o;
55     int format = FORMAT_BINARY, r, i, ret = 1, buflen = 131072;
56     long num = -1;
57     uint8_t *buf = NULL;
58 
59     prog = opt_init(argc, argv, rand_options);
60     while ((o = opt_next()) != OPT_EOF) {
61         switch (o) {
62         case OPT_EOF:
63         case OPT_ERR:
64  opthelp:
65             BIO_printf(bio_err, "%s: Use -help for summary.\n", prog);
66             goto end;
67         case OPT_HELP:
68             opt_help(rand_options);
69             ret = 0;
70             goto end;
71         case OPT_OUT:
72             outfile = opt_arg();
73             break;
74         case OPT_ENGINE:
75             e = setup_engine(opt_arg(), 0);
76             break;
77         case OPT_R_CASES:
78             if (!opt_rand(o))
79                 goto end;
80             break;
81         case OPT_BASE64:
82             format = FORMAT_BASE64;
83             break;
84         case OPT_HEX:
85             format = FORMAT_TEXT;
86             break;
87         case OPT_PROV_CASES:
88             if (!opt_provider(o))
89                 goto end;
90             break;
91         }
92     }
93 
94     /* Optional argument is number of bytes to generate. */
95     argc = opt_num_rest();
96     argv = opt_rest();
97     if (argc == 1) {
98         if (!opt_long(argv[0], &num) || num <= 0)
99             goto opthelp;
100     } else if (!opt_check_rest_arg(NULL)) {
101         goto opthelp;
102     }
103 
104     if (!app_RAND_load())
105         goto end;
106 
107     out = bio_open_default(outfile, 'w', format);
108     if (out == NULL)
109         goto end;
110 
111     if (format == FORMAT_BASE64) {
112         BIO *b64 = BIO_new(BIO_f_base64());
113         if (b64 == NULL)
114             goto end;
115         out = BIO_push(b64, out);
116     }
117 
118     buf = app_malloc(buflen, "buffer for output file");
119     while (num > 0) {
120         long chunk;
121 
122         chunk = (num > buflen) ? buflen : num;
123         r = RAND_bytes(buf, chunk);
124         if (r <= 0)
125             goto end;
126         if (format != FORMAT_TEXT) {
127             if (BIO_write(out, buf, chunk) != chunk)
128                 goto end;
129         } else {
130             for (i = 0; i < chunk; i++)
131                 if (BIO_printf(out, "%02x", buf[i]) != 2)
132                     goto end;
133         }
134         num -= chunk;
135     }
136     if (format == FORMAT_TEXT)
137         BIO_puts(out, "\n");
138     if (BIO_flush(out) <= 0)
139         goto end;
140 
141     ret = 0;
142 
143  end:
144     if (ret != 0)
145         ERR_print_errors(bio_err);
146     OPENSSL_free(buf);
147     release_engine(e);
148     BIO_free_all(out);
149     return ret;
150 }
151