xref: /freebsd/crypto/openssl/apps/lib/app_params.c (revision b077aed3)
1*b077aed3SPierre Pronchery /*
2*b077aed3SPierre Pronchery  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
3*b077aed3SPierre Pronchery  *
4*b077aed3SPierre Pronchery  * Licensed under the Apache License 2.0 (the "License").  You may not use
5*b077aed3SPierre Pronchery  * this file except in compliance with the License.  You can obtain a copy
6*b077aed3SPierre Pronchery  * in the file LICENSE in the source distribution or at
7*b077aed3SPierre Pronchery  * https://www.openssl.org/source/license.html
8*b077aed3SPierre Pronchery  */
9*b077aed3SPierre Pronchery 
10*b077aed3SPierre Pronchery #include "apps.h"
11*b077aed3SPierre Pronchery #include "app_params.h"
12*b077aed3SPierre Pronchery 
describe_param_type(char * buf,size_t bufsz,const OSSL_PARAM * param)13*b077aed3SPierre Pronchery static int describe_param_type(char *buf, size_t bufsz, const OSSL_PARAM *param)
14*b077aed3SPierre Pronchery {
15*b077aed3SPierre Pronchery     const char *type_mod = "";
16*b077aed3SPierre Pronchery     const char *type = NULL;
17*b077aed3SPierre Pronchery     int show_type_number = 0;
18*b077aed3SPierre Pronchery     int printed_len;
19*b077aed3SPierre Pronchery 
20*b077aed3SPierre Pronchery     switch (param->data_type) {
21*b077aed3SPierre Pronchery     case OSSL_PARAM_UNSIGNED_INTEGER:
22*b077aed3SPierre Pronchery         type_mod = "unsigned ";
23*b077aed3SPierre Pronchery         /* FALLTHRU */
24*b077aed3SPierre Pronchery     case OSSL_PARAM_INTEGER:
25*b077aed3SPierre Pronchery         type = "integer";
26*b077aed3SPierre Pronchery         break;
27*b077aed3SPierre Pronchery     case OSSL_PARAM_UTF8_PTR:
28*b077aed3SPierre Pronchery         type_mod = "pointer to a ";
29*b077aed3SPierre Pronchery         /* FALLTHRU */
30*b077aed3SPierre Pronchery     case OSSL_PARAM_UTF8_STRING:
31*b077aed3SPierre Pronchery         type = "UTF8 encoded string";
32*b077aed3SPierre Pronchery         break;
33*b077aed3SPierre Pronchery     case OSSL_PARAM_OCTET_PTR:
34*b077aed3SPierre Pronchery         type_mod = "pointer to an ";
35*b077aed3SPierre Pronchery         /* FALLTHRU */
36*b077aed3SPierre Pronchery     case OSSL_PARAM_OCTET_STRING:
37*b077aed3SPierre Pronchery         type = "octet string";
38*b077aed3SPierre Pronchery         break;
39*b077aed3SPierre Pronchery     default:
40*b077aed3SPierre Pronchery         type = "unknown type";
41*b077aed3SPierre Pronchery         show_type_number = 1;
42*b077aed3SPierre Pronchery         break;
43*b077aed3SPierre Pronchery     }
44*b077aed3SPierre Pronchery 
45*b077aed3SPierre Pronchery     printed_len = BIO_snprintf(buf, bufsz, "%s: ", param->key);
46*b077aed3SPierre Pronchery     if (printed_len > 0) {
47*b077aed3SPierre Pronchery         buf += printed_len;
48*b077aed3SPierre Pronchery         bufsz -= printed_len;
49*b077aed3SPierre Pronchery     }
50*b077aed3SPierre Pronchery     printed_len = BIO_snprintf(buf, bufsz, "%s%s", type_mod, type);
51*b077aed3SPierre Pronchery     if (printed_len > 0) {
52*b077aed3SPierre Pronchery         buf += printed_len;
53*b077aed3SPierre Pronchery         bufsz -= printed_len;
54*b077aed3SPierre Pronchery     }
55*b077aed3SPierre Pronchery     if (show_type_number) {
56*b077aed3SPierre Pronchery         printed_len = BIO_snprintf(buf, bufsz, " [%d]", param->data_type);
57*b077aed3SPierre Pronchery         if (printed_len > 0) {
58*b077aed3SPierre Pronchery             buf += printed_len;
59*b077aed3SPierre Pronchery             bufsz -= printed_len;
60*b077aed3SPierre Pronchery         }
61*b077aed3SPierre Pronchery     }
62*b077aed3SPierre Pronchery     if (param->data_size == 0)
63*b077aed3SPierre Pronchery         printed_len = BIO_snprintf(buf, bufsz, " (arbitrary size)");
64*b077aed3SPierre Pronchery     else
65*b077aed3SPierre Pronchery         printed_len = BIO_snprintf(buf, bufsz, " (max %zu bytes large)",
66*b077aed3SPierre Pronchery                                    param->data_size);
67*b077aed3SPierre Pronchery     if (printed_len > 0) {
68*b077aed3SPierre Pronchery         buf += printed_len;
69*b077aed3SPierre Pronchery         bufsz -= printed_len;
70*b077aed3SPierre Pronchery     }
71*b077aed3SPierre Pronchery     *buf = '\0';
72*b077aed3SPierre Pronchery     return 1;
73*b077aed3SPierre Pronchery }
74*b077aed3SPierre Pronchery 
print_param_types(const char * thing,const OSSL_PARAM * pdefs,int indent)75*b077aed3SPierre Pronchery int print_param_types(const char *thing, const OSSL_PARAM *pdefs, int indent)
76*b077aed3SPierre Pronchery {
77*b077aed3SPierre Pronchery     if (pdefs == NULL) {
78*b077aed3SPierre Pronchery         return 1;
79*b077aed3SPierre Pronchery     } else if (pdefs->key == NULL) {
80*b077aed3SPierre Pronchery         /*
81*b077aed3SPierre Pronchery          * An empty list?  This shouldn't happen, but let's just make sure to
82*b077aed3SPierre Pronchery          * say something if there's a badly written provider...
83*b077aed3SPierre Pronchery          */
84*b077aed3SPierre Pronchery         BIO_printf(bio_out, "%*sEmpty list of %s (!!!)\n", indent, "", thing);
85*b077aed3SPierre Pronchery     } else {
86*b077aed3SPierre Pronchery         BIO_printf(bio_out, "%*s%s:\n", indent, "", thing);
87*b077aed3SPierre Pronchery         for (; pdefs->key != NULL; pdefs++) {
88*b077aed3SPierre Pronchery             char buf[200];       /* This should be ample space */
89*b077aed3SPierre Pronchery 
90*b077aed3SPierre Pronchery             describe_param_type(buf, sizeof(buf), pdefs);
91*b077aed3SPierre Pronchery             BIO_printf(bio_out, "%*s  %s\n", indent, "", buf);
92*b077aed3SPierre Pronchery         }
93*b077aed3SPierre Pronchery     }
94*b077aed3SPierre Pronchery     return 1;
95*b077aed3SPierre Pronchery }
96*b077aed3SPierre Pronchery 
print_param_value(const OSSL_PARAM * p,int indent)97*b077aed3SPierre Pronchery void print_param_value(const OSSL_PARAM *p, int indent)
98*b077aed3SPierre Pronchery {
99*b077aed3SPierre Pronchery     int64_t i;
100*b077aed3SPierre Pronchery     uint64_t u;
101*b077aed3SPierre Pronchery 
102*b077aed3SPierre Pronchery     printf("%*s%s: ", indent, "", p->key);
103*b077aed3SPierre Pronchery     switch (p->data_type) {
104*b077aed3SPierre Pronchery     case OSSL_PARAM_UNSIGNED_INTEGER:
105*b077aed3SPierre Pronchery         if (OSSL_PARAM_get_uint64(p, &u))
106*b077aed3SPierre Pronchery             BIO_printf(bio_out, "%llu\n", (unsigned long long int)u);
107*b077aed3SPierre Pronchery         else
108*b077aed3SPierre Pronchery             BIO_printf(bio_out, "error getting value\n");
109*b077aed3SPierre Pronchery         break;
110*b077aed3SPierre Pronchery     case OSSL_PARAM_INTEGER:
111*b077aed3SPierre Pronchery         if (OSSL_PARAM_get_int64(p, &i))
112*b077aed3SPierre Pronchery             BIO_printf(bio_out, "%lld\n", (long long int)i);
113*b077aed3SPierre Pronchery         else
114*b077aed3SPierre Pronchery             BIO_printf(bio_out, "error getting value\n");
115*b077aed3SPierre Pronchery         break;
116*b077aed3SPierre Pronchery     case OSSL_PARAM_UTF8_PTR:
117*b077aed3SPierre Pronchery         BIO_printf(bio_out, "'%s'\n", *(char **)(p->data));
118*b077aed3SPierre Pronchery         break;
119*b077aed3SPierre Pronchery     case OSSL_PARAM_UTF8_STRING:
120*b077aed3SPierre Pronchery         BIO_printf(bio_out, "'%s'\n", (char *)p->data);
121*b077aed3SPierre Pronchery         break;
122*b077aed3SPierre Pronchery     case OSSL_PARAM_OCTET_PTR:
123*b077aed3SPierre Pronchery     case OSSL_PARAM_OCTET_STRING:
124*b077aed3SPierre Pronchery         BIO_printf(bio_out, "<%zu bytes>\n", p->data_size);
125*b077aed3SPierre Pronchery         break;
126*b077aed3SPierre Pronchery     default:
127*b077aed3SPierre Pronchery         BIO_printf(bio_out, "unknown type (%u) of %zu bytes\n",
128*b077aed3SPierre Pronchery                    p->data_type, p->data_size);
129*b077aed3SPierre Pronchery         break;
130*b077aed3SPierre Pronchery     }
131*b077aed3SPierre Pronchery }
132*b077aed3SPierre Pronchery 
133