xref: /freebsd-13-stable/crypto/openssl/crypto/ui/ui_lib.c (revision cb56391c165ebdc10a80545f025a2d8f09106ed5)
1 /*
2  * Copyright 2001-2023 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (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 
UI_new(void)18 UI *UI_new(void)
19 {
20     return UI_new_method(NULL);
21 }
22 
UI_new_method(const UI_METHOD * method)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 
free_string(UI_STRING * uis)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 
UI_free(UI * ui)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 
allocate_string_stack(UI * ui)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 
general_allocate_prompt(UI * ui,const char * prompt,int prompt_freeable,enum UI_string_types type,int input_flags,char * result_buf)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 
general_allocate_string(UI * ui,const char * prompt,int prompt_freeable,enum UI_string_types type,int input_flags,char * result_buf,int minsize,int maxsize,const char * test_buf)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 
general_allocate_boolean(UI * ui,const char * prompt,const char * action_desc,const char * ok_chars,const char * cancel_chars,int prompt_freeable,enum UI_string_types type,int input_flags,char * result_buf)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  */
UI_add_input_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize)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 */
UI_dup_input_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize)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 
UI_add_verify_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize,const char * test_buf)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 
UI_dup_verify_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize,const char * test_buf)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 
UI_add_input_boolean(UI * ui,const char * prompt,const char * action_desc,const char * ok_chars,const char * cancel_chars,int flags,char * result_buf)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 
UI_dup_input_boolean(UI * ui,const char * prompt,const char * action_desc,const char * ok_chars,const char * cancel_chars,int flags,char * result_buf)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 
UI_add_info_string(UI * ui,const char * text)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 
UI_dup_info_string(UI * ui,const char * text)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 
UI_add_error_string(UI * ui,const char * text)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 
UI_dup_error_string(UI * ui,const char * text)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 
UI_construct_prompt(UI * ui,const char * object_desc,const char * object_name)357 char *UI_construct_prompt(UI *ui, const char *object_desc,
358                           const char *object_name)
359 {
360     char *prompt = NULL;
361 
362     if (ui->meth->ui_construct_prompt != NULL)
363         prompt = ui->meth->ui_construct_prompt(ui, object_desc, object_name);
364     else {
365         char prompt1[] = "Enter ";
366         char prompt2[] = " for ";
367         char prompt3[] = ":";
368         int len = 0;
369 
370         if (object_desc == NULL)
371             return NULL;
372         len = sizeof(prompt1) - 1 + strlen(object_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, object_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 
UI_add_user_data(UI * ui,void * user_data)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 
UI_dup_user_data(UI * ui,void * user_data)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 
UI_get0_user_data(UI * ui)427 void *UI_get0_user_data(UI *ui)
428 {
429     return ui->user_data;
430 }
431 
UI_get0_result(UI * ui,int i)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 
UI_get_result_length(UI * ui,int i)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 
print_error(const char * str,size_t len,UI * ui)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 
UI_process(UI * ui)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         } else {
533             ui->flags &= ~UI_FLAG_REDOABLE;
534             ok = -2;
535             goto err;
536         }
537     }
538 
539     state = NULL;
540  err:
541     if (ui->meth->ui_close_session != NULL
542         && ui->meth->ui_close_session(ui) <= 0) {
543         if (state == NULL)
544             state = "closing session";
545         ok = -1;
546     }
547 
548     if (ok == -1) {
549         UIerr(UI_F_UI_PROCESS, UI_R_PROCESSING_ERROR);
550         ERR_add_error_data(2, "while ", state);
551     }
552     return ok;
553 }
554 
UI_ctrl(UI * ui,int cmd,long i,void * p,void (* f)(void))555 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void))
556 {
557     if (ui == NULL) {
558         UIerr(UI_F_UI_CTRL, ERR_R_PASSED_NULL_PARAMETER);
559         return -1;
560     }
561     switch (cmd) {
562     case UI_CTRL_PRINT_ERRORS:
563         {
564             int save_flag = ! !(ui->flags & UI_FLAG_PRINT_ERRORS);
565             if (i)
566                 ui->flags |= UI_FLAG_PRINT_ERRORS;
567             else
568                 ui->flags &= ~UI_FLAG_PRINT_ERRORS;
569             return save_flag;
570         }
571     case UI_CTRL_IS_REDOABLE:
572         return ! !(ui->flags & UI_FLAG_REDOABLE);
573     default:
574         break;
575     }
576     UIerr(UI_F_UI_CTRL, UI_R_UNKNOWN_CONTROL_COMMAND);
577     return -1;
578 }
579 
UI_set_ex_data(UI * r,int idx,void * arg)580 int UI_set_ex_data(UI *r, int idx, void *arg)
581 {
582     return CRYPTO_set_ex_data(&r->ex_data, idx, arg);
583 }
584 
UI_get_ex_data(UI * r,int idx)585 void *UI_get_ex_data(UI *r, int idx)
586 {
587     return CRYPTO_get_ex_data(&r->ex_data, idx);
588 }
589 
UI_get_method(UI * ui)590 const UI_METHOD *UI_get_method(UI *ui)
591 {
592     return ui->meth;
593 }
594 
UI_set_method(UI * ui,const UI_METHOD * meth)595 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
596 {
597     ui->meth = meth;
598     return ui->meth;
599 }
600 
UI_create_method(const char * name)601 UI_METHOD *UI_create_method(const char *name)
602 {
603     UI_METHOD *ui_method = NULL;
604 
605     if ((ui_method = OPENSSL_zalloc(sizeof(*ui_method))) == NULL
606         || (ui_method->name = OPENSSL_strdup(name)) == NULL
607         || !CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI_METHOD, ui_method,
608                                &ui_method->ex_data)) {
609         if (ui_method)
610             OPENSSL_free(ui_method->name);
611         OPENSSL_free(ui_method);
612         UIerr(UI_F_UI_CREATE_METHOD, ERR_R_MALLOC_FAILURE);
613         return NULL;
614     }
615     return ui_method;
616 }
617 
618 /*
619  * BIG FSCKING WARNING!!!! If you use this on a statically allocated method
620  * (that is, it hasn't been allocated using UI_create_method(), you deserve
621  * anything Murphy can throw at you and more! You have been warned.
622  */
UI_destroy_method(UI_METHOD * ui_method)623 void UI_destroy_method(UI_METHOD *ui_method)
624 {
625     if (ui_method == NULL)
626         return;
627     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI_METHOD, ui_method,
628                         &ui_method->ex_data);
629     OPENSSL_free(ui_method->name);
630     ui_method->name = NULL;
631     OPENSSL_free(ui_method);
632 }
633 
UI_method_set_opener(UI_METHOD * method,int (* opener)(UI * ui))634 int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui))
635 {
636     if (method != NULL) {
637         method->ui_open_session = opener;
638         return 0;
639     }
640     return -1;
641 }
642 
UI_method_set_writer(UI_METHOD * method,int (* writer)(UI * ui,UI_STRING * uis))643 int UI_method_set_writer(UI_METHOD *method,
644                          int (*writer) (UI *ui, UI_STRING *uis))
645 {
646     if (method != NULL) {
647         method->ui_write_string = writer;
648         return 0;
649     }
650     return -1;
651 }
652 
UI_method_set_flusher(UI_METHOD * method,int (* flusher)(UI * ui))653 int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui))
654 {
655     if (method != NULL) {
656         method->ui_flush = flusher;
657         return 0;
658     }
659     return -1;
660 }
661 
UI_method_set_reader(UI_METHOD * method,int (* reader)(UI * ui,UI_STRING * uis))662 int UI_method_set_reader(UI_METHOD *method,
663                          int (*reader) (UI *ui, UI_STRING *uis))
664 {
665     if (method != NULL) {
666         method->ui_read_string = reader;
667         return 0;
668     }
669     return -1;
670 }
671 
UI_method_set_closer(UI_METHOD * method,int (* closer)(UI * ui))672 int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui))
673 {
674     if (method != NULL) {
675         method->ui_close_session = closer;
676         return 0;
677     }
678     return -1;
679 }
680 
UI_method_set_data_duplicator(UI_METHOD * method,void * (* duplicator)(UI * ui,void * ui_data),void (* destructor)(UI * ui,void * ui_data))681 int UI_method_set_data_duplicator(UI_METHOD *method,
682                                   void *(*duplicator) (UI *ui, void *ui_data),
683                                   void (*destructor)(UI *ui, void *ui_data))
684 {
685     if (method != NULL) {
686         method->ui_duplicate_data = duplicator;
687         method->ui_destroy_data = destructor;
688         return 0;
689     }
690     return -1;
691 }
692 
UI_method_set_prompt_constructor(UI_METHOD * method,char * (* prompt_constructor)(UI * ui,const char * object_desc,const char * object_name))693 int UI_method_set_prompt_constructor(UI_METHOD *method,
694                                      char *(*prompt_constructor) (UI *ui,
695                                                                   const char
696                                                                   *object_desc,
697                                                                   const char
698                                                                   *object_name))
699 {
700     if (method != NULL) {
701         method->ui_construct_prompt = prompt_constructor;
702         return 0;
703     }
704     return -1;
705 }
706 
UI_method_set_ex_data(UI_METHOD * method,int idx,void * data)707 int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data)
708 {
709     return CRYPTO_set_ex_data(&method->ex_data, idx, data);
710 }
711 
UI_method_get_opener(const UI_METHOD * method)712 int (*UI_method_get_opener(const UI_METHOD *method)) (UI *)
713 {
714     if (method != NULL)
715         return method->ui_open_session;
716     return NULL;
717 }
718 
UI_method_get_writer(const UI_METHOD * method)719 int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *)
720 {
721     if (method != NULL)
722         return method->ui_write_string;
723     return NULL;
724 }
725 
UI_method_get_flusher(const UI_METHOD * method)726 int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *)
727 {
728     if (method != NULL)
729         return method->ui_flush;
730     return NULL;
731 }
732 
UI_method_get_reader(const UI_METHOD * method)733 int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *)
734 {
735     if (method != NULL)
736         return method->ui_read_string;
737     return NULL;
738 }
739 
UI_method_get_closer(const UI_METHOD * method)740 int (*UI_method_get_closer(const UI_METHOD *method)) (UI *)
741 {
742     if (method != NULL)
743         return method->ui_close_session;
744     return NULL;
745 }
746 
UI_method_get_prompt_constructor(const UI_METHOD * method)747 char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
748     (UI *, const char *, const char *)
749 {
750     if (method != NULL)
751         return method->ui_construct_prompt;
752     return NULL;
753 }
754 
UI_method_get_data_duplicator(const UI_METHOD * method)755 void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *)
756 {
757     if (method != NULL)
758         return method->ui_duplicate_data;
759     return NULL;
760 }
761 
UI_method_get_data_destructor(const UI_METHOD * method)762 void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *)
763 {
764     if (method != NULL)
765         return method->ui_destroy_data;
766     return NULL;
767 }
768 
UI_method_get_ex_data(const UI_METHOD * method,int idx)769 const void *UI_method_get_ex_data(const UI_METHOD *method, int idx)
770 {
771     return CRYPTO_get_ex_data(&method->ex_data, idx);
772 }
773 
UI_get_string_type(UI_STRING * uis)774 enum UI_string_types UI_get_string_type(UI_STRING *uis)
775 {
776     return uis->type;
777 }
778 
UI_get_input_flags(UI_STRING * uis)779 int UI_get_input_flags(UI_STRING *uis)
780 {
781     return uis->input_flags;
782 }
783 
UI_get0_output_string(UI_STRING * uis)784 const char *UI_get0_output_string(UI_STRING *uis)
785 {
786     return uis->out_string;
787 }
788 
UI_get0_action_string(UI_STRING * uis)789 const char *UI_get0_action_string(UI_STRING *uis)
790 {
791     switch (uis->type) {
792     case UIT_BOOLEAN:
793         return uis->_.boolean_data.action_desc;
794     case UIT_PROMPT:
795     case UIT_NONE:
796     case UIT_VERIFY:
797     case UIT_INFO:
798     case UIT_ERROR:
799         break;
800     }
801     return NULL;
802 }
803 
UI_get0_result_string(UI_STRING * uis)804 const char *UI_get0_result_string(UI_STRING *uis)
805 {
806     switch (uis->type) {
807     case UIT_PROMPT:
808     case UIT_VERIFY:
809         return uis->result_buf;
810     case UIT_NONE:
811     case UIT_BOOLEAN:
812     case UIT_INFO:
813     case UIT_ERROR:
814         break;
815     }
816     return NULL;
817 }
818 
UI_get_result_string_length(UI_STRING * uis)819 int UI_get_result_string_length(UI_STRING *uis)
820 {
821     switch (uis->type) {
822     case UIT_PROMPT:
823     case UIT_VERIFY:
824         return uis->result_len;
825     case UIT_NONE:
826     case UIT_BOOLEAN:
827     case UIT_INFO:
828     case UIT_ERROR:
829         break;
830     }
831     return -1;
832 }
833 
UI_get0_test_string(UI_STRING * uis)834 const char *UI_get0_test_string(UI_STRING *uis)
835 {
836     switch (uis->type) {
837     case UIT_VERIFY:
838         return uis->_.string_data.test_buf;
839     case UIT_NONE:
840     case UIT_BOOLEAN:
841     case UIT_INFO:
842     case UIT_ERROR:
843     case UIT_PROMPT:
844         break;
845     }
846     return NULL;
847 }
848 
UI_get_result_minsize(UI_STRING * uis)849 int UI_get_result_minsize(UI_STRING *uis)
850 {
851     switch (uis->type) {
852     case UIT_PROMPT:
853     case UIT_VERIFY:
854         return uis->_.string_data.result_minsize;
855     case UIT_NONE:
856     case UIT_INFO:
857     case UIT_ERROR:
858     case UIT_BOOLEAN:
859         break;
860     }
861     return -1;
862 }
863 
UI_get_result_maxsize(UI_STRING * uis)864 int UI_get_result_maxsize(UI_STRING *uis)
865 {
866     switch (uis->type) {
867     case UIT_PROMPT:
868     case UIT_VERIFY:
869         return uis->_.string_data.result_maxsize;
870     case UIT_NONE:
871     case UIT_INFO:
872     case UIT_ERROR:
873     case UIT_BOOLEAN:
874         break;
875     }
876     return -1;
877 }
878 
UI_set_result(UI * ui,UI_STRING * uis,const char * result)879 int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
880 {
881 #if 0
882     /*
883      * This is placed here solely to preserve UI_F_UI_SET_RESULT
884      * To be removed for OpenSSL 1.2.0
885      */
886     UIerr(UI_F_UI_SET_RESULT, ERR_R_DISABLED);
887 #endif
888     return UI_set_result_ex(ui, uis, result, strlen(result));
889 }
890 
UI_set_result_ex(UI * ui,UI_STRING * uis,const char * result,int len)891 int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len)
892 {
893     ui->flags &= ~UI_FLAG_REDOABLE;
894 
895     switch (uis->type) {
896     case UIT_PROMPT:
897     case UIT_VERIFY:
898         {
899             char number1[DECIMAL_SIZE(uis->_.string_data.result_minsize) + 1];
900             char number2[DECIMAL_SIZE(uis->_.string_data.result_maxsize) + 1];
901 
902             BIO_snprintf(number1, sizeof(number1), "%d",
903                          uis->_.string_data.result_minsize);
904             BIO_snprintf(number2, sizeof(number2), "%d",
905                          uis->_.string_data.result_maxsize);
906 
907             if (len < uis->_.string_data.result_minsize) {
908                 ui->flags |= UI_FLAG_REDOABLE;
909                 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_RESULT_TOO_SMALL);
910                 ERR_add_error_data(5, "You must type in ",
911                                    number1, " to ", number2, " characters");
912                 return -1;
913             }
914             if (len > uis->_.string_data.result_maxsize) {
915                 ui->flags |= UI_FLAG_REDOABLE;
916                 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_RESULT_TOO_LARGE);
917                 ERR_add_error_data(5, "You must type in ",
918                                    number1, " to ", number2, " characters");
919                 return -1;
920             }
921         }
922 
923         if (uis->result_buf == NULL) {
924             UIerr(UI_F_UI_SET_RESULT_EX, UI_R_NO_RESULT_BUFFER);
925             return -1;
926         }
927 
928         memcpy(uis->result_buf, result, len);
929         if (len <= uis->_.string_data.result_maxsize)
930             uis->result_buf[len] = '\0';
931         uis->result_len = len;
932         break;
933     case UIT_BOOLEAN:
934         {
935             const char *p;
936 
937             if (uis->result_buf == NULL) {
938                 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_NO_RESULT_BUFFER);
939                 return -1;
940             }
941 
942             uis->result_buf[0] = '\0';
943             for (p = result; *p; p++) {
944                 if (strchr(uis->_.boolean_data.ok_chars, *p)) {
945                     uis->result_buf[0] = uis->_.boolean_data.ok_chars[0];
946                     break;
947                 }
948                 if (strchr(uis->_.boolean_data.cancel_chars, *p)) {
949                     uis->result_buf[0] = uis->_.boolean_data.cancel_chars[0];
950                     break;
951                 }
952             }
953         }
954     case UIT_NONE:
955     case UIT_INFO:
956     case UIT_ERROR:
957         break;
958     }
959     return 0;
960 }
961