2 * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
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
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>
20 return UI_new_method(NULL);
23 UI *UI_new_method(const UI_METHOD *method)
25 UI *ret = OPENSSL_zalloc(sizeof(*ret));
28 UIerr(UI_F_UI_NEW_METHOD, ERR_R_MALLOC_FAILURE);
32 ret->lock = CRYPTO_THREAD_lock_new();
33 if (ret->lock == NULL) {
34 UIerr(UI_F_UI_NEW_METHOD, ERR_R_MALLOC_FAILURE);
40 method = UI_get_default_method();
45 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI, ret, &ret->ex_data)) {
52 static void free_string(UI_STRING *uis)
54 if (uis->flags & OUT_STRING_FREEABLE) {
55 OPENSSL_free((char *)uis->out_string);
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);
77 if ((ui->flags & UI_FLAG_DUPL_DATA) != 0) {
78 ui->meth->ui_destroy_data(ui, ui->user_data);
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);
86 static int allocate_string_stack(UI *ui)
88 if (ui->strings == NULL) {
89 ui->strings = sk_UI_STRING_new_null();
90 if (ui->strings == NULL) {
97 static UI_STRING *general_allocate_prompt(UI *ui, const char *prompt,
99 enum UI_string_types type,
100 int input_flags, char *result_buf)
102 UI_STRING *ret = NULL;
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;
114 ret->result_buf = result_buf;
119 static int general_allocate_string(UI *ui, const char *prompt,
121 enum UI_string_types type, int input_flags,
122 char *result_buf, int minsize, int maxsize,
123 const char *test_buf)
126 UI_STRING *s = general_allocate_prompt(ui, prompt, prompt_freeable,
127 type, input_flags, result_buf);
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 */
146 static int general_allocate_boolean(UI *ui,
148 const char *action_desc,
149 const char *ok_chars,
150 const char *cancel_chars,
152 enum UI_string_types type,
153 int input_flags, char *result_buf)
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);
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);
171 s = general_allocate_prompt(ui, prompt, prompt_freeable,
172 type, input_flags, result_buf);
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);
181 * sk_push() returns 0 on error. Let's adapt that
195 * Returns the index to the place in the stack or -1 for error. Uses a
196 * direct reference to the prompt.
198 int UI_add_input_string(UI *ui, const char *prompt, int flags,
199 char *result_buf, int minsize, int maxsize)
201 return general_allocate_string(ui, prompt, 0,
202 UIT_PROMPT, flags, result_buf, minsize,
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)
210 char *prompt_copy = NULL;
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);
220 return general_allocate_string(ui, prompt_copy, 1,
221 UIT_PROMPT, flags, result_buf, minsize,
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)
229 return general_allocate_string(ui, prompt, 0,
230 UIT_VERIFY, flags, result_buf, minsize,
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)
238 char *prompt_copy = NULL;
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);
248 return general_allocate_string(ui, prompt_copy, 1,
249 UIT_VERIFY, flags, result_buf, minsize,
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)
257 return general_allocate_boolean(ui, prompt, action_desc,
258 ok_chars, cancel_chars, 0, UIT_BOOLEAN,
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)
266 char *prompt_copy = NULL;
267 char *action_desc_copy = NULL;
268 char *ok_chars_copy = NULL;
269 char *cancel_chars_copy = NULL;
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);
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);
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);
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);
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);
307 OPENSSL_free(prompt_copy);
308 OPENSSL_free(action_desc_copy);
309 OPENSSL_free(ok_chars_copy);
310 OPENSSL_free(cancel_chars_copy);
314 int UI_add_info_string(UI *ui, const char *text)
316 return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
320 int UI_dup_info_string(UI *ui, const char *text)
322 char *text_copy = NULL;
325 text_copy = OPENSSL_strdup(text);
326 if (text_copy == NULL) {
327 UIerr(UI_F_UI_DUP_INFO_STRING, ERR_R_MALLOC_FAILURE);
332 return general_allocate_string(ui, text_copy, 1, UIT_INFO, 0, NULL,
336 int UI_add_error_string(UI *ui, const char *text)
338 return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
342 int UI_dup_error_string(UI *ui, const char *text)
344 char *text_copy = NULL;
347 text_copy = OPENSSL_strdup(text);
348 if (text_copy == NULL) {
349 UIerr(UI_F_UI_DUP_ERROR_STRING, ERR_R_MALLOC_FAILURE);
353 return general_allocate_string(ui, text_copy, 1, UIT_ERROR, 0, NULL,
357 char *UI_construct_prompt(UI *ui, const char *object_desc,
358 const char *object_name)
362 if (ui->meth->ui_construct_prompt != NULL)
363 prompt = ui->meth->ui_construct_prompt(ui, object_desc, object_name);
365 char prompt1[] = "Enter ";
366 char prompt2[] = " for ";
367 char prompt3[] = ":";
370 if (object_desc == 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;
377 if ((prompt = OPENSSL_malloc(len + 1)) == NULL) {
378 UIerr(UI_F_UI_CONSTRUCT_PROMPT, ERR_R_MALLOC_FAILURE);
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);
387 OPENSSL_strlcat(prompt, prompt3, len + 1);
392 void *UI_add_user_data(UI *ui, void *user_data)
394 void *old_data = ui->user_data;
396 if ((ui->flags & UI_FLAG_DUPL_DATA) != 0) {
397 ui->meth->ui_destroy_data(ui, old_data);
400 ui->user_data = user_data;
401 ui->flags &= ~UI_FLAG_DUPL_DATA;
405 int UI_dup_user_data(UI *ui, void *user_data)
407 void *duplicate = NULL;
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);
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);
421 (void)UI_add_user_data(ui, duplicate);
422 ui->flags |= UI_FLAG_DUPL_DATA;
427 void *UI_get0_user_data(UI *ui)
429 return ui->user_data;
432 const char *UI_get0_result(UI *ui, int i)
435 UIerr(UI_F_UI_GET0_RESULT, UI_R_INDEX_TOO_SMALL);
438 if (i >= sk_UI_STRING_num(ui->strings)) {
439 UIerr(UI_F_UI_GET0_RESULT, UI_R_INDEX_TOO_LARGE);
442 return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
445 int UI_get_result_length(UI *ui, int i)
448 UIerr(UI_F_UI_GET_RESULT_LENGTH, UI_R_INDEX_TOO_SMALL);
451 if (i >= sk_UI_STRING_num(ui->strings)) {
452 UIerr(UI_F_UI_GET_RESULT_LENGTH, UI_R_INDEX_TOO_LARGE);
455 return UI_get_result_string_length(sk_UI_STRING_value(ui->strings, i));
458 static int print_error(const char *str, size_t len, UI *ui)
462 memset(&uis, 0, sizeof(uis));
463 uis.type = UIT_ERROR;
464 uis.out_string = str;
466 if (ui->meth->ui_write_string != NULL
467 && ui->meth->ui_write_string(ui, &uis) <= 0)
472 int UI_process(UI *ui)
475 const char *state = "processing";
477 if (ui->meth->ui_open_session != NULL
478 && ui->meth->ui_open_session(ui) <= 0) {
479 state = "opening session";
484 if (ui->flags & UI_FLAG_PRINT_ERRORS)
485 ERR_print_errors_cb((int (*)(const char *, size_t, void *))
486 print_error, (void *)ui);
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))
494 state = "writing strings";
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;
510 default: /* Success */
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,
520 case -1: /* Interrupt/Cancel/something... */
521 ui->flags &= ~UI_FLAG_REDOABLE;
525 state = "reading strings";
528 default: /* Success */
537 if (ui->meth->ui_close_session != NULL
538 && ui->meth->ui_close_session(ui) <= 0) {
540 state = "closing session";
545 UIerr(UI_F_UI_PROCESS, UI_R_PROCESSING_ERROR);
546 ERR_add_error_data(2, "while ", state);
551 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void))
554 UIerr(UI_F_UI_CTRL, ERR_R_PASSED_NULL_PARAMETER);
558 case UI_CTRL_PRINT_ERRORS:
560 int save_flag = ! !(ui->flags & UI_FLAG_PRINT_ERRORS);
562 ui->flags |= UI_FLAG_PRINT_ERRORS;
564 ui->flags &= ~UI_FLAG_PRINT_ERRORS;
567 case UI_CTRL_IS_REDOABLE:
568 return ! !(ui->flags & UI_FLAG_REDOABLE);
572 UIerr(UI_F_UI_CTRL, UI_R_UNKNOWN_CONTROL_COMMAND);
576 int UI_set_ex_data(UI *r, int idx, void *arg)
578 return CRYPTO_set_ex_data(&r->ex_data, idx, arg);
581 void *UI_get_ex_data(const UI *r, int idx)
583 return CRYPTO_get_ex_data(&r->ex_data, idx);
586 const UI_METHOD *UI_get_method(UI *ui)
591 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
597 UI_METHOD *UI_create_method(const char *name)
599 UI_METHOD *ui_method = NULL;
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)) {
606 OPENSSL_free(ui_method->name);
607 OPENSSL_free(ui_method);
608 UIerr(UI_F_UI_CREATE_METHOD, ERR_R_MALLOC_FAILURE);
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.
619 void UI_destroy_method(UI_METHOD *ui_method)
621 if (ui_method == NULL)
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);
630 int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui))
632 if (method != NULL) {
633 method->ui_open_session = opener;
639 int UI_method_set_writer(UI_METHOD *method,
640 int (*writer) (UI *ui, UI_STRING *uis))
642 if (method != NULL) {
643 method->ui_write_string = writer;
649 int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui))
651 if (method != NULL) {
652 method->ui_flush = flusher;
658 int UI_method_set_reader(UI_METHOD *method,
659 int (*reader) (UI *ui, UI_STRING *uis))
661 if (method != NULL) {
662 method->ui_read_string = reader;
668 int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui))
670 if (method != NULL) {
671 method->ui_close_session = closer;
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))
681 if (method != NULL) {
682 method->ui_duplicate_data = duplicator;
683 method->ui_destroy_data = destructor;
689 int UI_method_set_prompt_constructor(UI_METHOD *method,
690 char *(*prompt_constructor) (UI *ui,
696 if (method != NULL) {
697 method->ui_construct_prompt = prompt_constructor;
703 int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data)
705 return CRYPTO_set_ex_data(&method->ex_data, idx, data);
708 int (*UI_method_get_opener(const UI_METHOD *method)) (UI *)
711 return method->ui_open_session;
715 int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *)
718 return method->ui_write_string;
722 int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *)
725 return method->ui_flush;
729 int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *)
732 return method->ui_read_string;
736 int (*UI_method_get_closer(const UI_METHOD *method)) (UI *)
739 return method->ui_close_session;
743 char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
744 (UI *, const char *, const char *)
747 return method->ui_construct_prompt;
751 void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *)
754 return method->ui_duplicate_data;
758 void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *)
761 return method->ui_destroy_data;
765 const void *UI_method_get_ex_data(const UI_METHOD *method, int idx)
767 return CRYPTO_get_ex_data(&method->ex_data, idx);
770 enum UI_string_types UI_get_string_type(UI_STRING *uis)
775 int UI_get_input_flags(UI_STRING *uis)
777 return uis->input_flags;
780 const char *UI_get0_output_string(UI_STRING *uis)
782 return uis->out_string;
785 const char *UI_get0_action_string(UI_STRING *uis)
789 return uis->_.boolean_data.action_desc;
800 const char *UI_get0_result_string(UI_STRING *uis)
805 return uis->result_buf;
815 int UI_get_result_string_length(UI_STRING *uis)
820 return uis->result_len;
830 const char *UI_get0_test_string(UI_STRING *uis)
834 return uis->_.string_data.test_buf;
845 int UI_get_result_minsize(UI_STRING *uis)
850 return uis->_.string_data.result_minsize;
860 int UI_get_result_maxsize(UI_STRING *uis)
865 return uis->_.string_data.result_maxsize;
875 int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
877 return UI_set_result_ex(ui, uis, result, strlen(result));
880 int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len)
882 ui->flags &= ~UI_FLAG_REDOABLE;
888 char number1[DECIMAL_SIZE(uis->_.string_data.result_minsize) + 1];
889 char number2[DECIMAL_SIZE(uis->_.string_data.result_maxsize) + 1];
891 BIO_snprintf(number1, sizeof(number1), "%d",
892 uis->_.string_data.result_minsize);
893 BIO_snprintf(number2, sizeof(number2), "%d",
894 uis->_.string_data.result_maxsize);
896 if (len < uis->_.string_data.result_minsize) {
897 ui->flags |= UI_FLAG_REDOABLE;
898 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_RESULT_TOO_SMALL);
899 ERR_add_error_data(5, "You must type in ",
900 number1, " to ", number2, " characters");
903 if (len > uis->_.string_data.result_maxsize) {
904 ui->flags |= UI_FLAG_REDOABLE;
905 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_RESULT_TOO_LARGE);
906 ERR_add_error_data(5, "You must type in ",
907 number1, " to ", number2, " characters");
912 if (uis->result_buf == NULL) {
913 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_NO_RESULT_BUFFER);
917 memcpy(uis->result_buf, result, len);
918 if (len <= uis->_.string_data.result_maxsize)
919 uis->result_buf[len] = '\0';
920 uis->result_len = len;
926 if (uis->result_buf == NULL) {
927 UIerr(UI_F_UI_SET_RESULT_EX, UI_R_NO_RESULT_BUFFER);
931 uis->result_buf[0] = '\0';
932 for (p = result; *p; p++) {
933 if (strchr(uis->_.boolean_data.ok_chars, *p)) {
934 uis->result_buf[0] = uis->_.boolean_data.ok_chars[0];
937 if (strchr(uis->_.boolean_data.cancel_chars, *p)) {
938 uis->result_buf[0] = uis->_.boolean_data.cancel_chars[0];