Coverage Report

Created: 2025-06-13 06:58

/src/openssl30/crypto/ui/ui_lib.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2001-2023 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 <string.h>
11
#include "internal/cryptlib.h"
12
#include <openssl/e_os2.h>
13
#include <openssl/buffer.h>
14
#include <openssl/ui.h>
15
#include <openssl/err.h>
16
#include "ui_local.h"
17
18
UI *UI_new(void)
19
0
{
20
0
    return UI_new_method(NULL);
21
0
}
22
23
UI *UI_new_method(const UI_METHOD *method)
24
0
{
25
0
    UI *ret = OPENSSL_zalloc(sizeof(*ret));
26
27
0
    if (ret == NULL) {
28
0
        ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
29
0
        return NULL;
30
0
    }
31
32
0
    ret->lock = CRYPTO_THREAD_lock_new();
33
0
    if (ret->lock == NULL) {
34
0
        ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
35
0
        OPENSSL_free(ret);
36
0
        return NULL;
37
0
    }
38
39
0
    if (method == NULL)
40
0
        method = UI_get_default_method();
41
0
    if (method == NULL)
42
0
        method = UI_null();
43
0
    ret->meth = method;
44
45
0
    if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI, ret, &ret->ex_data)) {
46
0
        UI_free(ret);
47
0
        return NULL;
48
0
    }
49
0
    return ret;
50
0
}
51
52
static void free_string(UI_STRING *uis)
53
0
{
54
0
    if (uis->flags & OUT_STRING_FREEABLE) {
55
0
        OPENSSL_free((char *)uis->out_string);
56
0
        switch (uis->type) {
57
0
        case UIT_BOOLEAN:
58
0
            OPENSSL_free((char *)uis->_.boolean_data.action_desc);
59
0
            OPENSSL_free((char *)uis->_.boolean_data.ok_chars);
60
0
            OPENSSL_free((char *)uis->_.boolean_data.cancel_chars);
61
0
            break;
62
0
        case UIT_NONE:
63
0
        case UIT_PROMPT:
64
0
        case UIT_VERIFY:
65
0
        case UIT_ERROR:
66
0
        case UIT_INFO:
67
0
            break;
68
0
        }
69
0
    }
70
0
    OPENSSL_free(uis);
71
0
}
72
73
void UI_free(UI *ui)
74
0
{
75
0
    if (ui == NULL)
76
0
        return;
77
0
    if ((ui->flags & UI_FLAG_DUPL_DATA) != 0) {
78
0
        ui->meth->ui_destroy_data(ui, ui->user_data);
79
0
    }
80
0
    sk_UI_STRING_pop_free(ui->strings, free_string);
81
0
    CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI, ui, &ui->ex_data);
82
0
    CRYPTO_THREAD_lock_free(ui->lock);
83
0
    OPENSSL_free(ui);
84
0
}
85
86
static int allocate_string_stack(UI *ui)
87
0
{
88
0
    if (ui->strings == NULL) {
89
0
        ui->strings = sk_UI_STRING_new_null();
90
0
        if (ui->strings == NULL) {
91
0
            return -1;
92
0
        }
93
0
    }
94
0
    return 0;
95
0
}
96
97
static UI_STRING *general_allocate_prompt(UI *ui, const char *prompt,
98
                                          int prompt_freeable,
99
                                          enum UI_string_types type,
100
                                          int input_flags, char *result_buf)
101
0
{
102
0
    UI_STRING *ret = NULL;
103
104
0
    if (prompt == NULL) {
105
0
        ERR_raise(ERR_LIB_UI, ERR_R_PASSED_NULL_PARAMETER);
106
0
    } else if ((type == UIT_PROMPT || type == UIT_VERIFY
107
0
                || type == UIT_BOOLEAN) && result_buf == NULL) {
108
0
        ERR_raise(ERR_LIB_UI, UI_R_NO_RESULT_BUFFER);
109
0
    } else if ((ret = OPENSSL_zalloc(sizeof(*ret))) != NULL) {
110
0
        ret->out_string = prompt;
111
0
        ret->flags = prompt_freeable ? OUT_STRING_FREEABLE : 0;
112
0
        ret->input_flags = input_flags;
113
0
        ret->type = type;
114
0
        ret->result_buf = result_buf;
115
0
    }
116
0
    return ret;
117
0
}
118
119
static int general_allocate_string(UI *ui, const char *prompt,
120
                                   int prompt_freeable,
121
                                   enum UI_string_types type, int input_flags,
122
                                   char *result_buf, int minsize, int maxsize,
123
                                   const char *test_buf)
124
0
{
125
0
    int ret = -1;
126
0
    UI_STRING *s = general_allocate_prompt(ui, prompt, prompt_freeable,
127
0
                                           type, input_flags, result_buf);
128
129
0
    if (s != NULL) {
130
0
        if (allocate_string_stack(ui) >= 0) {
131
0
            s->_.string_data.result_minsize = minsize;
132
0
            s->_.string_data.result_maxsize = maxsize;
133
0
            s->_.string_data.test_buf = test_buf;
134
0
            ret = sk_UI_STRING_push(ui->strings, s);
135
            /* sk_push() returns 0 on error.  Let's adapt that */
136
0
            if (ret <= 0) {
137
0
                ret--;
138
0
                free_string(s);
139
0
            }
140
0
        } else
141
0
            free_string(s);
142
0
    }
143
0
    return ret;
144
0
}
145
146
static int general_allocate_boolean(UI *ui,
147
                                    const char *prompt,
148
                                    const char *action_desc,
149
                                    const char *ok_chars,
150
                                    const char *cancel_chars,
151
                                    int prompt_freeable,
152
                                    enum UI_string_types type,
153
                                    int input_flags, char *result_buf)
154
0
{
155
0
    int ret = -1;
156
0
    UI_STRING *s;
157
0
    const char *p;
158
159
0
    if (ok_chars == NULL) {
160
0
        ERR_raise(ERR_LIB_UI, ERR_R_PASSED_NULL_PARAMETER);
161
0
    } else if (cancel_chars == NULL) {
162
0
        ERR_raise(ERR_LIB_UI, ERR_R_PASSED_NULL_PARAMETER);
163
0
    } else {
164
0
        for (p = ok_chars; *p != '\0'; p++) {
165
0
            if (strchr(cancel_chars, *p) != NULL) {
166
0
                ERR_raise(ERR_LIB_UI, UI_R_COMMON_OK_AND_CANCEL_CHARACTERS);
167
0
            }
168
0
        }
169
170
0
        s = general_allocate_prompt(ui, prompt, prompt_freeable,
171
0
                                    type, input_flags, result_buf);
172
173
0
        if (s != NULL) {
174
0
            if (allocate_string_stack(ui) >= 0) {
175
0
                s->_.boolean_data.action_desc = action_desc;
176
0
                s->_.boolean_data.ok_chars = ok_chars;
177
0
                s->_.boolean_data.cancel_chars = cancel_chars;
178
0
                ret = sk_UI_STRING_push(ui->strings, s);
179
                /*
180
                 * sk_push() returns 0 on error. Let's adapt that
181
                 */
182
0
                if (ret <= 0) {
183
0
                    ret--;
184
0
                    free_string(s);
185
0
                }
186
0
            } else
187
0
                free_string(s);
188
0
        }
189
0
    }
190
0
    return ret;
191
0
}
192
193
/*
194
 * Returns the index to the place in the stack or -1 for error.  Uses a
195
 * direct reference to the prompt.
196
 */
197
int UI_add_input_string(UI *ui, const char *prompt, int flags,
198
                        char *result_buf, int minsize, int maxsize)
199
0
{
200
0
    return general_allocate_string(ui, prompt, 0,
201
0
                                   UIT_PROMPT, flags, result_buf, minsize,
202
0
                                   maxsize, NULL);
203
0
}
204
205
/* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
206
int UI_dup_input_string(UI *ui, const char *prompt, int flags,
207
                        char *result_buf, int minsize, int maxsize)
208
0
{
209
0
    char *prompt_copy = NULL;
210
0
    int ret;
211
212
0
    if (prompt != NULL) {
213
0
        prompt_copy = OPENSSL_strdup(prompt);
214
0
        if (prompt_copy == NULL) {
215
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
216
0
            return 0;
217
0
        }
218
0
    }
219
220
0
    ret = general_allocate_string(ui, prompt_copy, 1,
221
0
                                  UIT_PROMPT, flags, result_buf, minsize,
222
0
                                  maxsize, NULL);
223
0
    if (ret <= 0)
224
0
        OPENSSL_free(prompt_copy);
225
226
0
    return ret;
227
0
}
228
229
int UI_add_verify_string(UI *ui, const char *prompt, int flags,
230
                         char *result_buf, int minsize, int maxsize,
231
                         const char *test_buf)
232
0
{
233
0
    return general_allocate_string(ui, prompt, 0,
234
0
                                   UIT_VERIFY, flags, result_buf, minsize,
235
0
                                   maxsize, test_buf);
236
0
}
237
238
int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
239
                         char *result_buf, int minsize, int maxsize,
240
                         const char *test_buf)
241
0
{
242
0
    char *prompt_copy = NULL;
243
0
    int ret;
244
245
0
    if (prompt != NULL) {
246
0
        prompt_copy = OPENSSL_strdup(prompt);
247
0
        if (prompt_copy == NULL) {
248
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
249
0
            return -1;
250
0
        }
251
0
    }
252
253
0
    ret = general_allocate_string(ui, prompt_copy, 1,
254
0
                                  UIT_VERIFY, flags, result_buf, minsize,
255
0
                                  maxsize, test_buf);
256
0
    if (ret <= 0)
257
0
        OPENSSL_free(prompt_copy);
258
0
    return ret;
259
0
}
260
261
int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
262
                         const char *ok_chars, const char *cancel_chars,
263
                         int flags, char *result_buf)
264
0
{
265
0
    return general_allocate_boolean(ui, prompt, action_desc,
266
0
                                    ok_chars, cancel_chars, 0, UIT_BOOLEAN,
267
0
                                    flags, result_buf);
268
0
}
269
270
int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
271
                         const char *ok_chars, const char *cancel_chars,
272
                         int flags, char *result_buf)
273
0
{
274
0
    char *prompt_copy = NULL;
275
0
    char *action_desc_copy = NULL;
276
0
    char *ok_chars_copy = NULL;
277
0
    char *cancel_chars_copy = NULL;
278
0
    int ret;
279
280
0
    if (prompt != NULL) {
281
0
        prompt_copy = OPENSSL_strdup(prompt);
282
0
        if (prompt_copy == NULL) {
283
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
284
0
            goto err;
285
0
        }
286
0
    }
287
288
0
    if (action_desc != NULL) {
289
0
        action_desc_copy = OPENSSL_strdup(action_desc);
290
0
        if (action_desc_copy == NULL) {
291
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
292
0
            goto err;
293
0
        }
294
0
    }
295
296
0
    if (ok_chars != NULL) {
297
0
        ok_chars_copy = OPENSSL_strdup(ok_chars);
298
0
        if (ok_chars_copy == NULL) {
299
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
300
0
            goto err;
301
0
        }
302
0
    }
303
304
0
    if (cancel_chars != NULL) {
305
0
        cancel_chars_copy = OPENSSL_strdup(cancel_chars);
306
0
        if (cancel_chars_copy == NULL) {
307
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
308
0
            goto err;
309
0
        }
310
0
    }
311
312
0
    ret = general_allocate_boolean(ui, prompt_copy, action_desc_copy,
313
0
                                   ok_chars_copy, cancel_chars_copy, 1,
314
0
                                   UIT_BOOLEAN, flags, result_buf);
315
0
    if (ret <= 0)
316
0
        goto err;
317
318
0
    return ret;
319
320
0
 err:
321
0
    OPENSSL_free(prompt_copy);
322
0
    OPENSSL_free(action_desc_copy);
323
0
    OPENSSL_free(ok_chars_copy);
324
0
    OPENSSL_free(cancel_chars_copy);
325
0
    return -1;
326
0
}
327
328
int UI_add_info_string(UI *ui, const char *text)
329
0
{
330
0
    return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
331
0
                                   NULL);
332
0
}
333
334
int UI_dup_info_string(UI *ui, const char *text)
335
0
{
336
0
    char *text_copy = NULL;
337
0
    int ret;
338
339
0
    if (text != NULL) {
340
0
        text_copy = OPENSSL_strdup(text);
341
0
        if (text_copy == NULL) {
342
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
343
0
            return -1;
344
0
        }
345
0
    }
346
347
0
    ret = general_allocate_string(ui, text_copy, 1, UIT_INFO, 0, NULL,
348
0
                                  0, 0, NULL);
349
0
    if (ret <= 0)
350
0
        OPENSSL_free(text_copy);
351
0
    return ret;
352
0
}
353
354
int UI_add_error_string(UI *ui, const char *text)
355
0
{
356
0
    return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
357
0
                                   NULL);
358
0
}
359
360
int UI_dup_error_string(UI *ui, const char *text)
361
0
{
362
0
    char *text_copy = NULL;
363
0
    int ret;
364
365
0
    if (text != NULL) {
366
0
        text_copy = OPENSSL_strdup(text);
367
0
        if (text_copy == NULL) {
368
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
369
0
            return -1;
370
0
        }
371
0
    }
372
373
0
    ret = general_allocate_string(ui, text_copy, 1, UIT_ERROR, 0, NULL,
374
0
                                  0, 0, NULL);
375
0
    if (ret <= 0)
376
0
        OPENSSL_free(text_copy);
377
0
    return ret;
378
0
}
379
380
char *UI_construct_prompt(UI *ui, const char *phrase_desc,
381
                          const char *object_name)
382
0
{
383
0
    char *prompt = NULL;
384
385
0
    if (ui != NULL && ui->meth != NULL && ui->meth->ui_construct_prompt != NULL)
386
0
        prompt = ui->meth->ui_construct_prompt(ui, phrase_desc, object_name);
387
0
    else {
388
0
        char prompt1[] = "Enter ";
389
0
        char prompt2[] = " for ";
390
0
        char prompt3[] = ":";
391
0
        int len = 0;
392
393
0
        if (phrase_desc == NULL)
394
0
            return NULL;
395
0
        len = sizeof(prompt1) - 1 + strlen(phrase_desc);
396
0
        if (object_name != NULL)
397
0
            len += sizeof(prompt2) - 1 + strlen(object_name);
398
0
        len += sizeof(prompt3) - 1;
399
400
0
        if ((prompt = OPENSSL_malloc(len + 1)) == NULL) {
401
0
            ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
402
0
            return NULL;
403
0
        }
404
0
        OPENSSL_strlcpy(prompt, prompt1, len + 1);
405
0
        OPENSSL_strlcat(prompt, phrase_desc, len + 1);
406
0
        if (object_name != NULL) {
407
0
            OPENSSL_strlcat(prompt, prompt2, len + 1);
408
0
            OPENSSL_strlcat(prompt, object_name, len + 1);
409
0
        }
410
0
        OPENSSL_strlcat(prompt, prompt3, len + 1);
411
0
    }
412
0
    return prompt;
413
0
}
414
415
void *UI_add_user_data(UI *ui, void *user_data)
416
0
{
417
0
    void *old_data = ui->user_data;
418
419
0
    if ((ui->flags & UI_FLAG_DUPL_DATA) != 0) {
420
0
        ui->meth->ui_destroy_data(ui, old_data);
421
0
        old_data = NULL;
422
0
    }
423
0
    ui->user_data = user_data;
424
0
    ui->flags &= ~UI_FLAG_DUPL_DATA;
425
0
    return old_data;
426
0
}
427
428
int UI_dup_user_data(UI *ui, void *user_data)
429
0
{
430
0
    void *duplicate = NULL;
431
432
0
    if (ui->meth->ui_duplicate_data == NULL
433
0
        || ui->meth->ui_destroy_data == NULL) {
434
0
        ERR_raise(ERR_LIB_UI, UI_R_USER_DATA_DUPLICATION_UNSUPPORTED);
435
0
        return -1;
436
0
    }
437
438
0
    duplicate = ui->meth->ui_duplicate_data(ui, user_data);
439
0
    if (duplicate == NULL) {
440
0
        ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
441
0
        return -1;
442
0
    }
443
444
0
    (void)UI_add_user_data(ui, duplicate);
445
0
    ui->flags |= UI_FLAG_DUPL_DATA;
446
447
0
    return 0;
448
0
}
449
450
void *UI_get0_user_data(UI *ui)
451
0
{
452
0
    return ui->user_data;
453
0
}
454
455
const char *UI_get0_result(UI *ui, int i)
456
0
{
457
0
    if (i < 0) {
458
0
        ERR_raise(ERR_LIB_UI, UI_R_INDEX_TOO_SMALL);
459
0
        return NULL;
460
0
    }
461
0
    if (i >= sk_UI_STRING_num(ui->strings)) {
462
0
        ERR_raise(ERR_LIB_UI, UI_R_INDEX_TOO_LARGE);
463
0
        return NULL;
464
0
    }
465
0
    return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
466
0
}
467
468
int UI_get_result_length(UI *ui, int i)
469
0
{
470
0
    if (i < 0) {
471
0
        ERR_raise(ERR_LIB_UI, UI_R_INDEX_TOO_SMALL);
472
0
        return -1;
473
0
    }
474
0
    if (i >= sk_UI_STRING_num(ui->strings)) {
475
0
        ERR_raise(ERR_LIB_UI, UI_R_INDEX_TOO_LARGE);
476
0
        return -1;
477
0
    }
478
0
    return UI_get_result_string_length(sk_UI_STRING_value(ui->strings, i));
479
0
}
480
481
static int print_error(const char *str, size_t len, UI *ui)
482
0
{
483
0
    UI_STRING uis;
484
485
0
    memset(&uis, 0, sizeof(uis));
486
0
    uis.type = UIT_ERROR;
487
0
    uis.out_string = str;
488
489
0
    if (ui->meth->ui_write_string != NULL
490
0
        && ui->meth->ui_write_string(ui, &uis) <= 0)
491
0
        return -1;
492
0
    return 0;
493
0
}
494
495
int UI_process(UI *ui)
496
0
{
497
0
    int i, ok = 0;
498
0
    const char *state = "processing";
499
500
0
    if (ui->meth->ui_open_session != NULL
501
0
        && ui->meth->ui_open_session(ui) <= 0) {
502
0
        state = "opening session";
503
0
        ok = -1;
504
0
        goto err;
505
0
    }
506
507
0
    if (ui->flags & UI_FLAG_PRINT_ERRORS)
508
0
        ERR_print_errors_cb((int (*)(const char *, size_t, void *))
509
0
                            print_error, (void *)ui);
510
511
0
    for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
512
0
        if (ui->meth->ui_write_string != NULL
513
0
            && (ui->meth->ui_write_string(ui,
514
0
                                          sk_UI_STRING_value(ui->strings, i))
515
0
                <= 0))
516
0
        {
517
0
            state = "writing strings";
518
0
            ok = -1;
519
0
            goto err;
520
0
        }
521
0
    }
522
523
0
    if (ui->meth->ui_flush != NULL)
524
0
        switch (ui->meth->ui_flush(ui)) {
525
0
        case -1:               /* Interrupt/Cancel/something... */
526
0
            ui->flags &= ~UI_FLAG_REDOABLE;
527
0
            ok = -2;
528
0
            goto err;
529
0
        case 0:                /* Errors */
530
0
            state = "flushing";
531
0
            ok = -1;
532
0
            goto err;
533
0
        default:               /* Success */
534
0
            ok = 0;
535
0
            break;
536
0
        }
537
538
0
    for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
539
0
        if (ui->meth->ui_read_string != NULL) {
540
0
            switch (ui->meth->ui_read_string(ui,
541
0
                                             sk_UI_STRING_value(ui->strings,
542
0
                                                                i))) {
543
0
            case -1:           /* Interrupt/Cancel/something... */
544
0
                ui->flags &= ~UI_FLAG_REDOABLE;
545
0
                ok = -2;
546
0
                goto err;
547
0
            case 0:            /* Errors */
548
0
                state = "reading strings";
549
0
                ok = -1;
550
0
                goto err;
551
0
            default:           /* Success */
552
0
                ok = 0;
553
0
                break;
554
0
            }
555
0
        } else {
556
0
            ui->flags &= ~UI_FLAG_REDOABLE;
557
0
            ok = -2;
558
0
            goto err;
559
0
        }
560
0
    }
561
562
0
    state = NULL;
563
0
 err:
564
0
    if (ui->meth->ui_close_session != NULL
565
0
        && ui->meth->ui_close_session(ui) <= 0) {
566
0
        if (state == NULL)
567
0
            state = "closing session";
568
0
        ok = -1;
569
0
    }
570
571
0
    if (ok == -1)
572
0
        ERR_raise_data(ERR_LIB_UI, UI_R_PROCESSING_ERROR, "while %s", state);
573
0
    return ok;
574
0
}
575
576
int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void))
577
0
{
578
0
    if (ui == NULL) {
579
0
        ERR_raise(ERR_LIB_UI, ERR_R_PASSED_NULL_PARAMETER);
580
0
        return -1;
581
0
    }
582
0
    switch (cmd) {
583
0
    case UI_CTRL_PRINT_ERRORS:
584
0
        {
585
0
            int save_flag = ! !(ui->flags & UI_FLAG_PRINT_ERRORS);
586
0
            if (i)
587
0
                ui->flags |= UI_FLAG_PRINT_ERRORS;
588
0
            else
589
0
                ui->flags &= ~UI_FLAG_PRINT_ERRORS;
590
0
            return save_flag;
591
0
        }
592
0
    case UI_CTRL_IS_REDOABLE:
593
0
        return ! !(ui->flags & UI_FLAG_REDOABLE);
594
0
    default:
595
0
        break;
596
0
    }
597
0
    ERR_raise(ERR_LIB_UI, UI_R_UNKNOWN_CONTROL_COMMAND);
598
0
    return -1;
599
0
}
600
601
int UI_set_ex_data(UI *r, int idx, void *arg)
602
0
{
603
0
    return CRYPTO_set_ex_data(&r->ex_data, idx, arg);
604
0
}
605
606
void *UI_get_ex_data(const UI *r, int idx)
607
0
{
608
0
    return CRYPTO_get_ex_data(&r->ex_data, idx);
609
0
}
610
611
const UI_METHOD *UI_get_method(UI *ui)
612
0
{
613
0
    return ui->meth;
614
0
}
615
616
const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
617
0
{
618
0
    ui->meth = meth;
619
0
    return ui->meth;
620
0
}
621
622
UI_METHOD *UI_create_method(const char *name)
623
0
{
624
0
    UI_METHOD *ui_method = NULL;
625
626
0
    if ((ui_method = OPENSSL_zalloc(sizeof(*ui_method))) == NULL
627
0
        || (ui_method->name = OPENSSL_strdup(name)) == NULL
628
0
        || !CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI_METHOD, ui_method,
629
0
                               &ui_method->ex_data)) {
630
0
        if (ui_method)
631
0
            OPENSSL_free(ui_method->name);
632
0
        OPENSSL_free(ui_method);
633
0
        ERR_raise(ERR_LIB_UI, ERR_R_MALLOC_FAILURE);
634
0
        return NULL;
635
0
    }
636
0
    return ui_method;
637
0
}
638
639
/*
640
 * BIG FSCKING WARNING!!!! If you use this on a statically allocated method
641
 * (that is, it hasn't been allocated using UI_create_method(), you deserve
642
 * anything Murphy can throw at you and more! You have been warned.
643
 */
644
void UI_destroy_method(UI_METHOD *ui_method)
645
0
{
646
0
    if (ui_method == NULL)
647
0
        return;
648
0
    CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI_METHOD, ui_method,
649
0
                        &ui_method->ex_data);
650
0
    OPENSSL_free(ui_method->name);
651
0
    ui_method->name = NULL;
652
0
    OPENSSL_free(ui_method);
653
0
}
654
655
int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui))
656
0
{
657
0
    if (method != NULL) {
658
0
        method->ui_open_session = opener;
659
0
        return 0;
660
0
    }
661
0
    return -1;
662
0
}
663
664
int UI_method_set_writer(UI_METHOD *method,
665
                         int (*writer) (UI *ui, UI_STRING *uis))
666
0
{
667
0
    if (method != NULL) {
668
0
        method->ui_write_string = writer;
669
0
        return 0;
670
0
    }
671
0
    return -1;
672
0
}
673
674
int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui))
675
0
{
676
0
    if (method != NULL) {
677
0
        method->ui_flush = flusher;
678
0
        return 0;
679
0
    }
680
0
    return -1;
681
0
}
682
683
int UI_method_set_reader(UI_METHOD *method,
684
                         int (*reader) (UI *ui, UI_STRING *uis))
685
0
{
686
0
    if (method != NULL) {
687
0
        method->ui_read_string = reader;
688
0
        return 0;
689
0
    }
690
0
    return -1;
691
0
}
692
693
int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui))
694
0
{
695
0
    if (method != NULL) {
696
0
        method->ui_close_session = closer;
697
0
        return 0;
698
0
    }
699
0
    return -1;
700
0
}
701
702
int UI_method_set_data_duplicator(UI_METHOD *method,
703
                                  void *(*duplicator) (UI *ui, void *ui_data),
704
                                  void (*destructor)(UI *ui, void *ui_data))
705
0
{
706
0
    if (method != NULL) {
707
0
        method->ui_duplicate_data = duplicator;
708
0
        method->ui_destroy_data = destructor;
709
0
        return 0;
710
0
    }
711
0
    return -1;
712
0
}
713
714
int UI_method_set_prompt_constructor(UI_METHOD *method,
715
                                     char *(*prompt_constructor) (UI *ui,
716
                                                                  const char *,
717
                                                                  const char *))
718
0
{
719
0
    if (method != NULL) {
720
0
        method->ui_construct_prompt = prompt_constructor;
721
0
        return 0;
722
0
    }
723
0
    return -1;
724
0
}
725
726
int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data)
727
0
{
728
0
    return CRYPTO_set_ex_data(&method->ex_data, idx, data);
729
0
}
730
731
int (*UI_method_get_opener(const UI_METHOD *method)) (UI *)
732
0
{
733
0
    if (method != NULL)
734
0
        return method->ui_open_session;
735
0
    return NULL;
736
0
}
737
738
int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *)
739
0
{
740
0
    if (method != NULL)
741
0
        return method->ui_write_string;
742
0
    return NULL;
743
0
}
744
745
int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *)
746
0
{
747
0
    if (method != NULL)
748
0
        return method->ui_flush;
749
0
    return NULL;
750
0
}
751
752
int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *)
753
0
{
754
0
    if (method != NULL)
755
0
        return method->ui_read_string;
756
0
    return NULL;
757
0
}
758
759
int (*UI_method_get_closer(const UI_METHOD *method)) (UI *)
760
0
{
761
0
    if (method != NULL)
762
0
        return method->ui_close_session;
763
0
    return NULL;
764
0
}
765
766
char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
767
    (UI *, const char *, const char *)
768
0
{
769
0
    if (method != NULL)
770
0
        return method->ui_construct_prompt;
771
0
    return NULL;
772
0
}
773
774
void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *)
775
0
{
776
0
    if (method != NULL)
777
0
        return method->ui_duplicate_data;
778
0
    return NULL;
779
0
}
780
781
void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *)
782
0
{
783
0
    if (method != NULL)
784
0
        return method->ui_destroy_data;
785
0
    return NULL;
786
0
}
787
788
const void *UI_method_get_ex_data(const UI_METHOD *method, int idx)
789
0
{
790
0
    return CRYPTO_get_ex_data(&method->ex_data, idx);
791
0
}
792
793
enum UI_string_types UI_get_string_type(UI_STRING *uis)
794
0
{
795
0
    return uis->type;
796
0
}
797
798
int UI_get_input_flags(UI_STRING *uis)
799
0
{
800
0
    return uis->input_flags;
801
0
}
802
803
const char *UI_get0_output_string(UI_STRING *uis)
804
0
{
805
0
    return uis->out_string;
806
0
}
807
808
const char *UI_get0_action_string(UI_STRING *uis)
809
0
{
810
0
    switch (uis->type) {
811
0
    case UIT_BOOLEAN:
812
0
        return uis->_.boolean_data.action_desc;
813
0
    case UIT_PROMPT:
814
0
    case UIT_NONE:
815
0
    case UIT_VERIFY:
816
0
    case UIT_INFO:
817
0
    case UIT_ERROR:
818
0
        break;
819
0
    }
820
0
    return NULL;
821
0
}
822
823
const char *UI_get0_result_string(UI_STRING *uis)
824
0
{
825
0
    switch (uis->type) {
826
0
    case UIT_PROMPT:
827
0
    case UIT_VERIFY:
828
0
        return uis->result_buf;
829
0
    case UIT_NONE:
830
0
    case UIT_BOOLEAN:
831
0
    case UIT_INFO:
832
0
    case UIT_ERROR:
833
0
        break;
834
0
    }
835
0
    return NULL;
836
0
}
837
838
int UI_get_result_string_length(UI_STRING *uis)
839
0
{
840
0
    switch (uis->type) {
841
0
    case UIT_PROMPT:
842
0
    case UIT_VERIFY:
843
0
        return uis->result_len;
844
0
    case UIT_NONE:
845
0
    case UIT_BOOLEAN:
846
0
    case UIT_INFO:
847
0
    case UIT_ERROR:
848
0
        break;
849
0
    }
850
0
    return -1;
851
0
}
852
853
const char *UI_get0_test_string(UI_STRING *uis)
854
0
{
855
0
    switch (uis->type) {
856
0
    case UIT_VERIFY:
857
0
        return uis->_.string_data.test_buf;
858
0
    case UIT_NONE:
859
0
    case UIT_BOOLEAN:
860
0
    case UIT_INFO:
861
0
    case UIT_ERROR:
862
0
    case UIT_PROMPT:
863
0
        break;
864
0
    }
865
0
    return NULL;
866
0
}
867
868
int UI_get_result_minsize(UI_STRING *uis)
869
0
{
870
0
    switch (uis->type) {
871
0
    case UIT_PROMPT:
872
0
    case UIT_VERIFY:
873
0
        return uis->_.string_data.result_minsize;
874
0
    case UIT_NONE:
875
0
    case UIT_INFO:
876
0
    case UIT_ERROR:
877
0
    case UIT_BOOLEAN:
878
0
        break;
879
0
    }
880
0
    return -1;
881
0
}
882
883
int UI_get_result_maxsize(UI_STRING *uis)
884
0
{
885
0
    switch (uis->type) {
886
0
    case UIT_PROMPT:
887
0
    case UIT_VERIFY:
888
0
        return uis->_.string_data.result_maxsize;
889
0
    case UIT_NONE:
890
0
    case UIT_INFO:
891
0
    case UIT_ERROR:
892
0
    case UIT_BOOLEAN:
893
0
        break;
894
0
    }
895
0
    return -1;
896
0
}
897
898
int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
899
0
{
900
0
    return UI_set_result_ex(ui, uis, result, strlen(result));
901
0
}
902
903
int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len)
904
0
{
905
0
    ui->flags &= ~UI_FLAG_REDOABLE;
906
907
0
    switch (uis->type) {
908
0
    case UIT_PROMPT:
909
0
    case UIT_VERIFY:
910
0
        if (len < uis->_.string_data.result_minsize) {
911
0
            ui->flags |= UI_FLAG_REDOABLE;
912
0
            ERR_raise_data(ERR_LIB_UI, UI_R_RESULT_TOO_SMALL,
913
0
                           "You must type in %d to %d characters",
914
0
                           uis->_.string_data.result_minsize,
915
0
                           uis->_.string_data.result_maxsize);
916
0
            return -1;
917
0
        }
918
0
        if (len > uis->_.string_data.result_maxsize) {
919
0
            ui->flags |= UI_FLAG_REDOABLE;
920
0
            ERR_raise_data(ERR_LIB_UI, UI_R_RESULT_TOO_LARGE,
921
0
                           "You must type in %d to %d characters",
922
0
                           uis->_.string_data.result_minsize,
923
0
                           uis->_.string_data.result_maxsize);
924
0
            return -1;
925
0
        }
926
927
0
        if (uis->result_buf == NULL) {
928
0
            ERR_raise(ERR_LIB_UI, UI_R_NO_RESULT_BUFFER);
929
0
            return -1;
930
0
        }
931
932
0
        memcpy(uis->result_buf, result, len);
933
0
        if (len <= uis->_.string_data.result_maxsize)
934
0
            uis->result_buf[len] = '\0';
935
0
        uis->result_len = len;
936
0
        break;
937
0
    case UIT_BOOLEAN:
938
0
        {
939
0
            const char *p;
940
941
0
            if (uis->result_buf == NULL) {
942
0
                ERR_raise(ERR_LIB_UI, UI_R_NO_RESULT_BUFFER);
943
0
                return -1;
944
0
            }
945
946
0
            uis->result_buf[0] = '\0';
947
0
            for (p = result; *p; p++) {
948
0
                if (strchr(uis->_.boolean_data.ok_chars, *p)) {
949
0
                    uis->result_buf[0] = uis->_.boolean_data.ok_chars[0];
950
0
                    break;
951
0
                }
952
0
                if (strchr(uis->_.boolean_data.cancel_chars, *p)) {
953
0
                    uis->result_buf[0] = uis->_.boolean_data.cancel_chars[0];
954
0
                    break;
955
0
                }
956
0
            }
957
0
        }
958
0
    case UIT_NONE:
959
0
    case UIT_INFO:
960
0
    case UIT_ERROR:
961
0
        break;
962
0
    }
963
0
    return 0;
964
0
}