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).
61 #include "internal/cryptlib.h"
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_zalloc(sizeof(*ret));
80 UIerr(UI_F_UI_NEW_METHOD, ERR_R_MALLOC_FAILURE);
84 ret->meth = UI_get_default_method();
88 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI, ret, &ret->ex_data);
92 static void free_string(UI_STRING *uis)
94 if (uis->flags & OUT_STRING_FREEABLE) {
95 OPENSSL_free((char *)uis->out_string);
98 OPENSSL_free((char *)uis->_.boolean_data.action_desc);
99 OPENSSL_free((char *)uis->_.boolean_data.ok_chars);
100 OPENSSL_free((char *)uis->_.boolean_data.cancel_chars);
113 sk_UI_STRING_pop_free(ui->strings, free_string);
114 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI, ui, &ui->ex_data);
118 static int allocate_string_stack(UI *ui)
120 if (ui->strings == NULL) {
121 ui->strings = sk_UI_STRING_new_null();
122 if (ui->strings == NULL) {
129 static UI_STRING *general_allocate_prompt(UI *ui, const char *prompt,
131 enum UI_string_types type,
132 int input_flags, char *result_buf)
134 UI_STRING *ret = NULL;
136 if (prompt == NULL) {
137 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT, ERR_R_PASSED_NULL_PARAMETER);
138 } else if ((type == UIT_PROMPT || type == UIT_VERIFY
139 || type == UIT_BOOLEAN) && result_buf == NULL) {
140 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT, UI_R_NO_RESULT_BUFFER);
141 } else if ((ret = OPENSSL_malloc(sizeof(*ret))) != NULL) {
142 ret->out_string = prompt;
143 ret->flags = prompt_freeable ? OUT_STRING_FREEABLE : 0;
144 ret->input_flags = input_flags;
146 ret->result_buf = result_buf;
151 static int general_allocate_string(UI *ui, const char *prompt,
153 enum UI_string_types type, int input_flags,
154 char *result_buf, int minsize, int maxsize,
155 const char *test_buf)
158 UI_STRING *s = general_allocate_prompt(ui, prompt, prompt_freeable,
159 type, input_flags, result_buf);
162 if (allocate_string_stack(ui) >= 0) {
163 s->_.string_data.result_minsize = minsize;
164 s->_.string_data.result_maxsize = maxsize;
165 s->_.string_data.test_buf = test_buf;
166 ret = sk_UI_STRING_push(ui->strings, s);
167 /* sk_push() returns 0 on error. Let's addapt that */
176 static int general_allocate_boolean(UI *ui,
178 const char *action_desc,
179 const char *ok_chars,
180 const char *cancel_chars,
182 enum UI_string_types type,
183 int input_flags, char *result_buf)
189 if (ok_chars == NULL) {
190 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN, ERR_R_PASSED_NULL_PARAMETER);
191 } else if (cancel_chars == NULL) {
192 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN, ERR_R_PASSED_NULL_PARAMETER);
194 for (p = ok_chars; *p; p++) {
195 if (strchr(cancel_chars, *p)) {
196 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,
197 UI_R_COMMON_OK_AND_CANCEL_CHARACTERS);
201 s = general_allocate_prompt(ui, prompt, prompt_freeable,
202 type, input_flags, result_buf);
205 if (allocate_string_stack(ui) >= 0) {
206 s->_.boolean_data.action_desc = action_desc;
207 s->_.boolean_data.ok_chars = ok_chars;
208 s->_.boolean_data.cancel_chars = cancel_chars;
209 ret = sk_UI_STRING_push(ui->strings, s);
211 * sk_push() returns 0 on error. Let's addapt that
223 * Returns the index to the place in the stack or -1 for error. Uses a
224 * direct reference to the prompt.
226 int UI_add_input_string(UI *ui, const char *prompt, int flags,
227 char *result_buf, int minsize, int maxsize)
229 return general_allocate_string(ui, prompt, 0,
230 UIT_PROMPT, flags, result_buf, minsize,
234 /* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
235 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
236 char *result_buf, int minsize, int maxsize)
238 char *prompt_copy = NULL;
241 prompt_copy = OPENSSL_strdup(prompt);
242 if (prompt_copy == NULL) {
243 UIerr(UI_F_UI_DUP_INPUT_STRING, ERR_R_MALLOC_FAILURE);
248 return general_allocate_string(ui, prompt_copy, 1,
249 UIT_PROMPT, flags, result_buf, minsize,
253 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
254 char *result_buf, int minsize, int maxsize,
255 const char *test_buf)
257 return general_allocate_string(ui, prompt, 0,
258 UIT_VERIFY, flags, result_buf, minsize,
262 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
263 char *result_buf, int minsize, int maxsize,
264 const char *test_buf)
266 char *prompt_copy = NULL;
269 prompt_copy = OPENSSL_strdup(prompt);
270 if (prompt_copy == NULL) {
271 UIerr(UI_F_UI_DUP_VERIFY_STRING, ERR_R_MALLOC_FAILURE);
276 return general_allocate_string(ui, prompt_copy, 1,
277 UIT_VERIFY, flags, result_buf, minsize,
281 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
282 const char *ok_chars, const char *cancel_chars,
283 int flags, char *result_buf)
285 return general_allocate_boolean(ui, prompt, action_desc,
286 ok_chars, cancel_chars, 0, UIT_BOOLEAN,
290 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
291 const char *ok_chars, const char *cancel_chars,
292 int flags, char *result_buf)
294 char *prompt_copy = NULL;
295 char *action_desc_copy = NULL;
296 char *ok_chars_copy = NULL;
297 char *cancel_chars_copy = NULL;
300 prompt_copy = OPENSSL_strdup(prompt);
301 if (prompt_copy == NULL) {
302 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
308 action_desc_copy = OPENSSL_strdup(action_desc);
309 if (action_desc_copy == NULL) {
310 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
316 ok_chars_copy = OPENSSL_strdup(ok_chars);
317 if (ok_chars_copy == NULL) {
318 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
324 cancel_chars_copy = OPENSSL_strdup(cancel_chars);
325 if (cancel_chars_copy == NULL) {
326 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
331 return general_allocate_boolean(ui, prompt_copy, action_desc_copy,
332 ok_chars_copy, cancel_chars_copy, 1,
333 UIT_BOOLEAN, flags, result_buf);
335 OPENSSL_free(prompt_copy);
336 OPENSSL_free(action_desc_copy);
337 OPENSSL_free(ok_chars_copy);
338 OPENSSL_free(cancel_chars_copy);
342 int UI_add_info_string(UI *ui, const char *text)
344 return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
348 int UI_dup_info_string(UI *ui, const char *text)
350 char *text_copy = NULL;
353 text_copy = OPENSSL_strdup(text);
354 if (text_copy == NULL) {
355 UIerr(UI_F_UI_DUP_INFO_STRING, ERR_R_MALLOC_FAILURE);
360 return general_allocate_string(ui, text_copy, 1, UIT_INFO, 0, NULL,
364 int UI_add_error_string(UI *ui, const char *text)
366 return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
370 int UI_dup_error_string(UI *ui, const char *text)
372 char *text_copy = NULL;
375 text_copy = OPENSSL_strdup(text);
376 if (text_copy == NULL) {
377 UIerr(UI_F_UI_DUP_ERROR_STRING, ERR_R_MALLOC_FAILURE);
381 return general_allocate_string(ui, text_copy, 1, UIT_ERROR, 0, NULL,
385 char *UI_construct_prompt(UI *ui, const char *object_desc,
386 const char *object_name)
390 if (ui->meth->ui_construct_prompt)
391 prompt = ui->meth->ui_construct_prompt(ui, object_desc, object_name);
393 char prompt1[] = "Enter ";
394 char prompt2[] = " for ";
395 char prompt3[] = ":";
398 if (object_desc == NULL)
400 len = sizeof(prompt1) - 1 + strlen(object_desc);
402 len += sizeof(prompt2) - 1 + strlen(object_name);
403 len += sizeof(prompt3) - 1;
405 prompt = OPENSSL_malloc(len + 1);
408 OPENSSL_strlcpy(prompt, prompt1, len + 1);
409 OPENSSL_strlcat(prompt, object_desc, len + 1);
411 OPENSSL_strlcat(prompt, prompt2, len + 1);
412 OPENSSL_strlcat(prompt, object_name, len + 1);
414 OPENSSL_strlcat(prompt, prompt3, len + 1);
419 void *UI_add_user_data(UI *ui, void *user_data)
421 void *old_data = ui->user_data;
422 ui->user_data = user_data;
426 void *UI_get0_user_data(UI *ui)
428 return ui->user_data;
431 const char *UI_get0_result(UI *ui, int i)
434 UIerr(UI_F_UI_GET0_RESULT, UI_R_INDEX_TOO_SMALL);
437 if (i >= sk_UI_STRING_num(ui->strings)) {
438 UIerr(UI_F_UI_GET0_RESULT, UI_R_INDEX_TOO_LARGE);
441 return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
444 static int print_error(const char *str, size_t len, UI *ui)
448 memset(&uis, 0, sizeof(uis));
449 uis.type = UIT_ERROR;
450 uis.out_string = str;
452 if (ui->meth->ui_write_string && !ui->meth->ui_write_string(ui, &uis))
457 int UI_process(UI *ui)
461 if (ui->meth->ui_open_session && !ui->meth->ui_open_session(ui))
464 if (ui->flags & UI_FLAG_PRINT_ERRORS)
465 ERR_print_errors_cb((int (*)(const char *, size_t, void *))
466 print_error, (void *)ui);
468 for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
469 if (ui->meth->ui_write_string
470 && !ui->meth->ui_write_string(ui,
471 sk_UI_STRING_value(ui->strings, i)))
478 if (ui->meth->ui_flush)
479 switch (ui->meth->ui_flush(ui)) {
480 case -1: /* Interrupt/Cancel/something... */
486 default: /* Success */
491 for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
492 if (ui->meth->ui_read_string) {
493 switch (ui->meth->ui_read_string(ui,
494 sk_UI_STRING_value(ui->strings,
496 case -1: /* Interrupt/Cancel/something... */
502 default: /* Success */
509 if (ui->meth->ui_close_session && !ui->meth->ui_close_session(ui))
514 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void))
517 UIerr(UI_F_UI_CTRL, ERR_R_PASSED_NULL_PARAMETER);
521 case UI_CTRL_PRINT_ERRORS:
523 int save_flag = ! !(ui->flags & UI_FLAG_PRINT_ERRORS);
525 ui->flags |= UI_FLAG_PRINT_ERRORS;
527 ui->flags &= ~UI_FLAG_PRINT_ERRORS;
530 case UI_CTRL_IS_REDOABLE:
531 return ! !(ui->flags & UI_FLAG_REDOABLE);
535 UIerr(UI_F_UI_CTRL, UI_R_UNKNOWN_CONTROL_COMMAND);
539 int UI_set_ex_data(UI *r, int idx, void *arg)
541 return (CRYPTO_set_ex_data(&r->ex_data, idx, arg));
544 void *UI_get_ex_data(UI *r, int idx)
546 return (CRYPTO_get_ex_data(&r->ex_data, idx));
549 void UI_set_default_method(const UI_METHOD *meth)
551 default_UI_meth = meth;
554 const UI_METHOD *UI_get_default_method(void)
556 if (default_UI_meth == NULL) {
557 default_UI_meth = UI_OpenSSL();
559 return default_UI_meth;
562 const UI_METHOD *UI_get_method(UI *ui)
567 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
573 UI_METHOD *UI_create_method(char *name)
575 UI_METHOD *ui_method = OPENSSL_zalloc(sizeof(*ui_method));
577 if (ui_method != NULL)
578 ui_method->name = OPENSSL_strdup(name);
583 * BIG FSCKING WARNING!!!! If you use this on a statically allocated method
584 * (that is, it hasn't been allocated using UI_create_method(), you deserve
585 * anything Murphy can throw at you and more! You have been warned.
587 void UI_destroy_method(UI_METHOD *ui_method)
589 OPENSSL_free(ui_method->name);
590 ui_method->name = NULL;
591 OPENSSL_free(ui_method);
594 int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui))
597 method->ui_open_session = opener;
603 int UI_method_set_writer(UI_METHOD *method,
604 int (*writer) (UI *ui, UI_STRING *uis))
607 method->ui_write_string = writer;
613 int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui))
616 method->ui_flush = flusher;
622 int UI_method_set_reader(UI_METHOD *method,
623 int (*reader) (UI *ui, UI_STRING *uis))
626 method->ui_read_string = reader;
632 int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui))
635 method->ui_close_session = closer;
641 int UI_method_set_prompt_constructor(UI_METHOD *method,
642 char *(*prompt_constructor) (UI *ui,
649 method->ui_construct_prompt = prompt_constructor;
655 int (*UI_method_get_opener(UI_METHOD *method)) (UI *) {
657 return method->ui_open_session;
662 int (*UI_method_get_writer(UI_METHOD *method)) (UI *, UI_STRING *) {
664 return method->ui_write_string;
669 int (*UI_method_get_flusher(UI_METHOD *method)) (UI *) {
671 return method->ui_flush;
676 int (*UI_method_get_reader(UI_METHOD *method)) (UI *, UI_STRING *) {
678 return method->ui_read_string;
683 int (*UI_method_get_closer(UI_METHOD *method)) (UI *) {
685 return method->ui_close_session;
690 char *(*UI_method_get_prompt_constructor(UI_METHOD *method)) (UI *,
694 return method->ui_construct_prompt;
699 enum UI_string_types UI_get_string_type(UI_STRING *uis)
706 int UI_get_input_flags(UI_STRING *uis)
710 return uis->input_flags;
713 const char *UI_get0_output_string(UI_STRING *uis)
717 return uis->out_string;
720 const char *UI_get0_action_string(UI_STRING *uis)
727 return uis->_.boolean_data.action_desc;
733 const char *UI_get0_result_string(UI_STRING *uis)
740 return uis->result_buf;
746 const char *UI_get0_test_string(UI_STRING *uis)
752 return uis->_.string_data.test_buf;
758 int UI_get_result_minsize(UI_STRING *uis)
765 return uis->_.string_data.result_minsize;
771 int UI_get_result_maxsize(UI_STRING *uis)
778 return uis->_.string_data.result_maxsize;
784 int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
786 int l = strlen(result);
788 ui->flags &= ~UI_FLAG_REDOABLE;
796 char number1[DECIMAL_SIZE(uis->_.string_data.result_minsize) + 1];
797 char number2[DECIMAL_SIZE(uis->_.string_data.result_maxsize) + 1];
799 BIO_snprintf(number1, sizeof(number1), "%d",
800 uis->_.string_data.result_minsize);
801 BIO_snprintf(number2, sizeof(number2), "%d",
802 uis->_.string_data.result_maxsize);
804 if (l < uis->_.string_data.result_minsize) {
805 ui->flags |= UI_FLAG_REDOABLE;
806 UIerr(UI_F_UI_SET_RESULT, UI_R_RESULT_TOO_SMALL);
807 ERR_add_error_data(5, "You must type in ",
808 number1, " to ", number2, " characters");
811 if (l > uis->_.string_data.result_maxsize) {
812 ui->flags |= UI_FLAG_REDOABLE;
813 UIerr(UI_F_UI_SET_RESULT, UI_R_RESULT_TOO_LARGE);
814 ERR_add_error_data(5, "You must type in ",
815 number1, " to ", number2, " characters");
820 if (!uis->result_buf) {
821 UIerr(UI_F_UI_SET_RESULT, UI_R_NO_RESULT_BUFFER);
825 OPENSSL_strlcpy(uis->result_buf, result,
826 uis->_.string_data.result_maxsize + 1);
832 if (!uis->result_buf) {
833 UIerr(UI_F_UI_SET_RESULT, UI_R_NO_RESULT_BUFFER);
837 uis->result_buf[0] = '\0';
838 for (p = result; *p; p++) {
839 if (strchr(uis->_.boolean_data.ok_chars, *p)) {
840 uis->result_buf[0] = uis->_.boolean_data.ok_chars[0];
843 if (strchr(uis->_.boolean_data.cancel_chars, *p)) {
844 uis->result_buf[0] = uis->_.boolean_data.cancel_chars[0];