1 /* crypto/ui/ui_lib.c -*- mode:C; c-file-style: "eay" -*- */
3 * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * openssl-core@openssl.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/e_os2.h>
63 #include <openssl/buffer.h>
64 #include <openssl/ui.h>
65 #include <openssl/err.h>
68 static const UI_METHOD
*default_UI_meth
= NULL
;
72 return (UI_new_method(NULL
));
75 UI
*UI_new_method(const UI_METHOD
*method
)
77 UI
*ret
= OPENSSL_malloc(sizeof(UI
));
80 UIerr(UI_F_UI_NEW_METHOD
, ERR_R_MALLOC_FAILURE
);
84 ret
->meth
= UI_get_default_method();
89 ret
->user_data
= NULL
;
91 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI
, ret
, &ret
->ex_data
);
95 static void free_string(UI_STRING
*uis
)
97 if (uis
->flags
& OUT_STRING_FREEABLE
) {
98 OPENSSL_free((char *)uis
->out_string
);
101 OPENSSL_free((char *)uis
->_
.boolean_data
.action_desc
);
102 OPENSSL_free((char *)uis
->_
.boolean_data
.ok_chars
);
103 OPENSSL_free((char *)uis
->_
.boolean_data
.cancel_chars
);
116 sk_UI_STRING_pop_free(ui
->strings
, free_string
);
117 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI
, ui
, &ui
->ex_data
);
121 static int allocate_string_stack(UI
*ui
)
123 if (ui
->strings
== NULL
) {
124 ui
->strings
= sk_UI_STRING_new_null();
125 if (ui
->strings
== NULL
) {
132 static UI_STRING
*general_allocate_prompt(UI
*ui
, const char *prompt
,
134 enum UI_string_types type
,
135 int input_flags
, char *result_buf
)
137 UI_STRING
*ret
= NULL
;
139 if (prompt
== NULL
) {
140 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT
, ERR_R_PASSED_NULL_PARAMETER
);
141 } else if ((type
== UIT_PROMPT
|| type
== UIT_VERIFY
142 || type
== UIT_BOOLEAN
) && result_buf
== NULL
) {
143 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT
, UI_R_NO_RESULT_BUFFER
);
144 } else if ((ret
= OPENSSL_malloc(sizeof(UI_STRING
)))) {
145 ret
->out_string
= prompt
;
146 ret
->flags
= prompt_freeable
? OUT_STRING_FREEABLE
: 0;
147 ret
->input_flags
= input_flags
;
149 ret
->result_buf
= result_buf
;
154 static int general_allocate_string(UI
*ui
, const char *prompt
,
156 enum UI_string_types type
, int input_flags
,
157 char *result_buf
, int minsize
, int maxsize
,
158 const char *test_buf
)
161 UI_STRING
*s
= general_allocate_prompt(ui
, prompt
, prompt_freeable
,
162 type
, input_flags
, result_buf
);
165 if (allocate_string_stack(ui
) >= 0) {
166 s
->_
.string_data
.result_minsize
= minsize
;
167 s
->_
.string_data
.result_maxsize
= maxsize
;
168 s
->_
.string_data
.test_buf
= test_buf
;
169 ret
= sk_UI_STRING_push(ui
->strings
, s
);
170 /* sk_push() returns 0 on error. Let's addapt that */
179 static int general_allocate_boolean(UI
*ui
,
181 const char *action_desc
,
182 const char *ok_chars
,
183 const char *cancel_chars
,
185 enum UI_string_types type
,
186 int input_flags
, char *result_buf
)
192 if (ok_chars
== NULL
) {
193 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN
, ERR_R_PASSED_NULL_PARAMETER
);
194 } else if (cancel_chars
== NULL
) {
195 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN
, ERR_R_PASSED_NULL_PARAMETER
);
197 for (p
= ok_chars
; *p
; p
++) {
198 if (strchr(cancel_chars
, *p
)) {
199 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN
,
200 UI_R_COMMON_OK_AND_CANCEL_CHARACTERS
);
204 s
= general_allocate_prompt(ui
, prompt
, prompt_freeable
,
205 type
, input_flags
, result_buf
);
208 if (allocate_string_stack(ui
) >= 0) {
209 s
->_
.boolean_data
.action_desc
= action_desc
;
210 s
->_
.boolean_data
.ok_chars
= ok_chars
;
211 s
->_
.boolean_data
.cancel_chars
= cancel_chars
;
212 ret
= sk_UI_STRING_push(ui
->strings
, s
);
214 * sk_push() returns 0 on error. Let's addapt that
226 * Returns the index to the place in the stack or -1 for error. Uses a
227 * direct reference to the prompt.
229 int UI_add_input_string(UI
*ui
, const char *prompt
, int flags
,
230 char *result_buf
, int minsize
, int maxsize
)
232 return general_allocate_string(ui
, prompt
, 0,
233 UIT_PROMPT
, flags
, result_buf
, minsize
,
237 /* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
238 int UI_dup_input_string(UI
*ui
, const char *prompt
, int flags
,
239 char *result_buf
, int minsize
, int maxsize
)
241 char *prompt_copy
= NULL
;
244 prompt_copy
= BUF_strdup(prompt
);
245 if (prompt_copy
== NULL
) {
246 UIerr(UI_F_UI_DUP_INPUT_STRING
, ERR_R_MALLOC_FAILURE
);
251 return general_allocate_string(ui
, prompt_copy
, 1,
252 UIT_PROMPT
, flags
, result_buf
, minsize
,
256 int UI_add_verify_string(UI
*ui
, const char *prompt
, int flags
,
257 char *result_buf
, int minsize
, int maxsize
,
258 const char *test_buf
)
260 return general_allocate_string(ui
, prompt
, 0,
261 UIT_VERIFY
, flags
, result_buf
, minsize
,
265 int UI_dup_verify_string(UI
*ui
, const char *prompt
, int flags
,
266 char *result_buf
, int minsize
, int maxsize
,
267 const char *test_buf
)
269 char *prompt_copy
= NULL
;
272 prompt_copy
= BUF_strdup(prompt
);
273 if (prompt_copy
== NULL
) {
274 UIerr(UI_F_UI_DUP_VERIFY_STRING
, ERR_R_MALLOC_FAILURE
);
279 return general_allocate_string(ui
, prompt_copy
, 1,
280 UIT_VERIFY
, flags
, result_buf
, minsize
,
284 int UI_add_input_boolean(UI
*ui
, const char *prompt
, const char *action_desc
,
285 const char *ok_chars
, const char *cancel_chars
,
286 int flags
, char *result_buf
)
288 return general_allocate_boolean(ui
, prompt
, action_desc
,
289 ok_chars
, cancel_chars
, 0, UIT_BOOLEAN
,
293 int UI_dup_input_boolean(UI
*ui
, const char *prompt
, const char *action_desc
,
294 const char *ok_chars
, const char *cancel_chars
,
295 int flags
, char *result_buf
)
297 char *prompt_copy
= NULL
;
298 char *action_desc_copy
= NULL
;
299 char *ok_chars_copy
= NULL
;
300 char *cancel_chars_copy
= NULL
;
303 prompt_copy
= BUF_strdup(prompt
);
304 if (prompt_copy
== NULL
) {
305 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
, ERR_R_MALLOC_FAILURE
);
311 action_desc_copy
= BUF_strdup(action_desc
);
312 if (action_desc_copy
== NULL
) {
313 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
, ERR_R_MALLOC_FAILURE
);
319 ok_chars_copy
= BUF_strdup(ok_chars
);
320 if (ok_chars_copy
== NULL
) {
321 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
, ERR_R_MALLOC_FAILURE
);
327 cancel_chars_copy
= BUF_strdup(cancel_chars
);
328 if (cancel_chars_copy
== NULL
) {
329 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
, ERR_R_MALLOC_FAILURE
);
334 return general_allocate_boolean(ui
, prompt_copy
, action_desc_copy
,
335 ok_chars_copy
, cancel_chars_copy
, 1,
336 UIT_BOOLEAN
, flags
, result_buf
);
339 OPENSSL_free(prompt_copy
);
340 if (action_desc_copy
)
341 OPENSSL_free(action_desc_copy
);
343 OPENSSL_free(ok_chars_copy
);
344 if (cancel_chars_copy
)
345 OPENSSL_free(cancel_chars_copy
);
349 int UI_add_info_string(UI
*ui
, const char *text
)
351 return general_allocate_string(ui
, text
, 0, UIT_INFO
, 0, NULL
, 0, 0,
355 int UI_dup_info_string(UI
*ui
, const char *text
)
357 char *text_copy
= NULL
;
360 text_copy
= BUF_strdup(text
);
361 if (text_copy
== NULL
) {
362 UIerr(UI_F_UI_DUP_INFO_STRING
, ERR_R_MALLOC_FAILURE
);
367 return general_allocate_string(ui
, text_copy
, 1, UIT_INFO
, 0, NULL
,
371 int UI_add_error_string(UI
*ui
, const char *text
)
373 return general_allocate_string(ui
, text
, 0, UIT_ERROR
, 0, NULL
, 0, 0,
377 int UI_dup_error_string(UI
*ui
, const char *text
)
379 char *text_copy
= NULL
;
382 text_copy
= BUF_strdup(text
);
383 if (text_copy
== NULL
) {
384 UIerr(UI_F_UI_DUP_ERROR_STRING
, ERR_R_MALLOC_FAILURE
);
388 return general_allocate_string(ui
, text_copy
, 1, UIT_ERROR
, 0, NULL
,
392 char *UI_construct_prompt(UI
*ui
, const char *object_desc
,
393 const char *object_name
)
397 if (ui
->meth
->ui_construct_prompt
)
398 prompt
= ui
->meth
->ui_construct_prompt(ui
, object_desc
, object_name
);
400 char prompt1
[] = "Enter ";
401 char prompt2
[] = " for ";
402 char prompt3
[] = ":";
405 if (object_desc
== NULL
)
407 len
= sizeof(prompt1
) - 1 + strlen(object_desc
);
409 len
+= sizeof(prompt2
) - 1 + strlen(object_name
);
410 len
+= sizeof(prompt3
) - 1;
412 prompt
= OPENSSL_malloc(len
+ 1);
415 BUF_strlcpy(prompt
, prompt1
, len
+ 1);
416 BUF_strlcat(prompt
, object_desc
, len
+ 1);
418 BUF_strlcat(prompt
, prompt2
, len
+ 1);
419 BUF_strlcat(prompt
, object_name
, len
+ 1);
421 BUF_strlcat(prompt
, prompt3
, len
+ 1);
426 void *UI_add_user_data(UI
*ui
, void *user_data
)
428 void *old_data
= ui
->user_data
;
429 ui
->user_data
= user_data
;
433 void *UI_get0_user_data(UI
*ui
)
435 return ui
->user_data
;
438 const char *UI_get0_result(UI
*ui
, int i
)
441 UIerr(UI_F_UI_GET0_RESULT
, UI_R_INDEX_TOO_SMALL
);
444 if (i
>= sk_UI_STRING_num(ui
->strings
)) {
445 UIerr(UI_F_UI_GET0_RESULT
, UI_R_INDEX_TOO_LARGE
);
448 return UI_get0_result_string(sk_UI_STRING_value(ui
->strings
, i
));
451 static int print_error(const char *str
, size_t len
, UI
*ui
)
455 memset(&uis
, 0, sizeof(uis
));
456 uis
.type
= UIT_ERROR
;
457 uis
.out_string
= str
;
459 if (ui
->meth
->ui_write_string
&& !ui
->meth
->ui_write_string(ui
, &uis
))
464 int UI_process(UI
*ui
)
468 if (ui
->meth
->ui_open_session
&& !ui
->meth
->ui_open_session(ui
))
471 if (ui
->flags
& UI_FLAG_PRINT_ERRORS
)
472 ERR_print_errors_cb((int (*)(const char *, size_t, void *))
473 print_error
, (void *)ui
);
475 for (i
= 0; i
< sk_UI_STRING_num(ui
->strings
); i
++) {
476 if (ui
->meth
->ui_write_string
477 && !ui
->meth
->ui_write_string(ui
,
478 sk_UI_STRING_value(ui
->strings
, i
)))
485 if (ui
->meth
->ui_flush
)
486 switch (ui
->meth
->ui_flush(ui
)) {
487 case -1: /* Interrupt/Cancel/something... */
493 default: /* Success */
498 for (i
= 0; i
< sk_UI_STRING_num(ui
->strings
); i
++) {
499 if (ui
->meth
->ui_read_string
) {
500 switch (ui
->meth
->ui_read_string(ui
,
501 sk_UI_STRING_value(ui
->strings
,
503 case -1: /* Interrupt/Cancel/something... */
509 default: /* Success */
516 if (ui
->meth
->ui_close_session
&& !ui
->meth
->ui_close_session(ui
))
521 int UI_ctrl(UI
*ui
, int cmd
, long i
, void *p
, void (*f
) (void))
524 UIerr(UI_F_UI_CTRL
, ERR_R_PASSED_NULL_PARAMETER
);
528 case UI_CTRL_PRINT_ERRORS
:
530 int save_flag
= ! !(ui
->flags
& UI_FLAG_PRINT_ERRORS
);
532 ui
->flags
|= UI_FLAG_PRINT_ERRORS
;
534 ui
->flags
&= ~UI_FLAG_PRINT_ERRORS
;
537 case UI_CTRL_IS_REDOABLE
:
538 return ! !(ui
->flags
& UI_FLAG_REDOABLE
);
542 UIerr(UI_F_UI_CTRL
, UI_R_UNKNOWN_CONTROL_COMMAND
);
546 int UI_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
547 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
)
549 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI
, argl
, argp
,
550 new_func
, dup_func
, free_func
);
553 int UI_set_ex_data(UI
*r
, int idx
, void *arg
)
555 return (CRYPTO_set_ex_data(&r
->ex_data
, idx
, arg
));
558 void *UI_get_ex_data(UI
*r
, int idx
)
560 return (CRYPTO_get_ex_data(&r
->ex_data
, idx
));
563 void UI_set_default_method(const UI_METHOD
*meth
)
565 default_UI_meth
= meth
;
568 const UI_METHOD
*UI_get_default_method(void)
570 if (default_UI_meth
== NULL
) {
571 default_UI_meth
= UI_OpenSSL();
573 return default_UI_meth
;
576 const UI_METHOD
*UI_get_method(UI
*ui
)
581 const UI_METHOD
*UI_set_method(UI
*ui
, const UI_METHOD
*meth
)
587 UI_METHOD
*UI_create_method(char *name
)
589 UI_METHOD
*ui_method
= OPENSSL_malloc(sizeof(UI_METHOD
));
592 memset(ui_method
, 0, sizeof(*ui_method
));
593 ui_method
->name
= BUF_strdup(name
);
599 * BIG FSCKING WARNING!!!! If you use this on a statically allocated method
600 * (that is, it hasn't been allocated using UI_create_method(), you deserve
601 * anything Murphy can throw at you and more! You have been warned.
603 void UI_destroy_method(UI_METHOD
*ui_method
)
605 OPENSSL_free(ui_method
->name
);
606 ui_method
->name
= NULL
;
607 OPENSSL_free(ui_method
);
610 int UI_method_set_opener(UI_METHOD
*method
, int (*opener
) (UI
*ui
))
613 method
->ui_open_session
= opener
;
619 int UI_method_set_writer(UI_METHOD
*method
,
620 int (*writer
) (UI
*ui
, UI_STRING
*uis
))
623 method
->ui_write_string
= writer
;
629 int UI_method_set_flusher(UI_METHOD
*method
, int (*flusher
) (UI
*ui
))
632 method
->ui_flush
= flusher
;
638 int UI_method_set_reader(UI_METHOD
*method
,
639 int (*reader
) (UI
*ui
, UI_STRING
*uis
))
642 method
->ui_read_string
= reader
;
648 int UI_method_set_closer(UI_METHOD
*method
, int (*closer
) (UI
*ui
))
651 method
->ui_close_session
= closer
;
657 int UI_method_set_prompt_constructor(UI_METHOD
*method
,
658 char *(*prompt_constructor
) (UI
*ui
,
665 method
->ui_construct_prompt
= prompt_constructor
;
671 int (*UI_method_get_opener(UI_METHOD
*method
)) (UI
*) {
673 return method
->ui_open_session
;
678 int (*UI_method_get_writer(UI_METHOD
*method
)) (UI
*, UI_STRING
*) {
680 return method
->ui_write_string
;
685 int (*UI_method_get_flusher(UI_METHOD
*method
)) (UI
*) {
687 return method
->ui_flush
;
692 int (*UI_method_get_reader(UI_METHOD
*method
)) (UI
*, UI_STRING
*) {
694 return method
->ui_read_string
;
699 int (*UI_method_get_closer(UI_METHOD
*method
)) (UI
*) {
701 return method
->ui_close_session
;
706 char *(*UI_method_get_prompt_constructor(UI_METHOD
*method
)) (UI
*,
710 return method
->ui_construct_prompt
;
715 enum UI_string_types
UI_get_string_type(UI_STRING
*uis
)
722 int UI_get_input_flags(UI_STRING
*uis
)
726 return uis
->input_flags
;
729 const char *UI_get0_output_string(UI_STRING
*uis
)
733 return uis
->out_string
;
736 const char *UI_get0_action_string(UI_STRING
*uis
)
743 return uis
->_
.boolean_data
.action_desc
;
749 const char *UI_get0_result_string(UI_STRING
*uis
)
756 return uis
->result_buf
;
762 const char *UI_get0_test_string(UI_STRING
*uis
)
768 return uis
->_
.string_data
.test_buf
;
774 int UI_get_result_minsize(UI_STRING
*uis
)
781 return uis
->_
.string_data
.result_minsize
;
787 int UI_get_result_maxsize(UI_STRING
*uis
)
794 return uis
->_
.string_data
.result_maxsize
;
800 int UI_set_result(UI
*ui
, UI_STRING
*uis
, const char *result
)
802 int l
= strlen(result
);
804 ui
->flags
&= ~UI_FLAG_REDOABLE
;
812 char number1
[DECIMAL_SIZE(uis
->_
.string_data
.result_minsize
) + 1];
813 char number2
[DECIMAL_SIZE(uis
->_
.string_data
.result_maxsize
) + 1];
815 BIO_snprintf(number1
, sizeof(number1
), "%d",
816 uis
->_
.string_data
.result_minsize
);
817 BIO_snprintf(number2
, sizeof(number2
), "%d",
818 uis
->_
.string_data
.result_maxsize
);
820 if (l
< uis
->_
.string_data
.result_minsize
) {
821 ui
->flags
|= UI_FLAG_REDOABLE
;
822 UIerr(UI_F_UI_SET_RESULT
, UI_R_RESULT_TOO_SMALL
);
823 ERR_add_error_data(5, "You must type in ",
824 number1
, " to ", number2
, " characters");
827 if (l
> uis
->_
.string_data
.result_maxsize
) {
828 ui
->flags
|= UI_FLAG_REDOABLE
;
829 UIerr(UI_F_UI_SET_RESULT
, UI_R_RESULT_TOO_LARGE
);
830 ERR_add_error_data(5, "You must type in ",
831 number1
, " to ", number2
, " characters");
836 if (!uis
->result_buf
) {
837 UIerr(UI_F_UI_SET_RESULT
, UI_R_NO_RESULT_BUFFER
);
841 BUF_strlcpy(uis
->result_buf
, result
,
842 uis
->_
.string_data
.result_maxsize
+ 1);
848 if (!uis
->result_buf
) {
849 UIerr(UI_F_UI_SET_RESULT
, UI_R_NO_RESULT_BUFFER
);
853 uis
->result_buf
[0] = '\0';
854 for (p
= result
; *p
; p
++) {
855 if (strchr(uis
->_
.boolean_data
.ok_chars
, *p
)) {
856 uis
->result_buf
[0] = uis
->_
.boolean_data
.ok_chars
[0];
859 if (strchr(uis
->_
.boolean_data
.cancel_chars
, *p
)) {
860 uis
->result_buf
[0] = uis
->_
.boolean_data
.cancel_chars
[0];