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