1 /* crypto/ui/ui_lib.c -*- mode:C; c-file-style: "eay" -*- */
2 /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * openssl-core@openssl.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
60 #include <openssl/e_os2.h>
61 #include <openssl/buffer.h>
62 #include <openssl/ui.h>
63 #include <openssl/err.h>
66 IMPLEMENT_STACK_OF(UI_STRING_ST)
68 static const UI_METHOD *default_UI_meth=NULL;
72 return(UI_new_method(NULL));
75 UI *UI_new_method(const UI_METHOD *method)
79 ret=(UI *)OPENSSL_malloc(sizeof(UI));
82 UIerr(UI_F_UI_NEW_METHOD,ERR_R_MALLOC_FAILURE);
86 ret->meth=UI_get_default_method();
92 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI, ret, &ret->ex_data);
96 static void free_string(UI_STRING *uis)
98 if (uis->flags & OUT_STRING_FREEABLE)
100 OPENSSL_free((char *)uis->out_string);
104 OPENSSL_free((char *)uis->_.boolean_data.action_desc);
105 OPENSSL_free((char *)uis->_.boolean_data.ok_chars);
106 OPENSSL_free((char *)uis->_.boolean_data.cancel_chars);
119 sk_UI_STRING_pop_free(ui->strings,free_string);
120 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI, ui, &ui->ex_data);
124 static int allocate_string_stack(UI *ui)
126 if (ui->strings == NULL)
128 ui->strings=sk_UI_STRING_new_null();
129 if (ui->strings == NULL)
137 static UI_STRING *general_allocate_prompt(UI *ui, const char *prompt,
138 int prompt_freeable, enum UI_string_types type, int input_flags,
141 UI_STRING *ret = NULL;
145 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT,ERR_R_PASSED_NULL_PARAMETER);
147 else if (result_buf == NULL)
149 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT,UI_R_NO_RESULT_BUFFER);
151 else if ((ret = (UI_STRING *)OPENSSL_malloc(sizeof(UI_STRING))))
153 ret->out_string=prompt;
154 ret->flags=prompt_freeable ? OUT_STRING_FREEABLE : 0;
155 ret->input_flags=input_flags;
157 ret->result_buf=result_buf;
162 static int general_allocate_string(UI *ui, const char *prompt,
163 int prompt_freeable, enum UI_string_types type, int input_flags,
164 char *result_buf, int minsize, int maxsize, const char *test_buf)
167 UI_STRING *s = general_allocate_prompt(ui, prompt, prompt_freeable,
168 type, input_flags, result_buf);
172 if (allocate_string_stack(ui) >= 0)
174 s->_.string_data.result_minsize=minsize;
175 s->_.string_data.result_maxsize=maxsize;
176 s->_.string_data.test_buf=test_buf;
177 ret=sk_UI_STRING_push(ui->strings, s);
178 /* sk_push() returns 0 on error. Let's addapt that */
187 static int general_allocate_boolean(UI *ui,
188 const char *prompt, const char *action_desc,
189 const char *ok_chars, const char *cancel_chars,
190 int prompt_freeable, enum UI_string_types type, int input_flags,
197 if (ok_chars == NULL)
199 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,ERR_R_PASSED_NULL_PARAMETER);
201 else if (cancel_chars == NULL)
203 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,ERR_R_PASSED_NULL_PARAMETER);
207 for(p = ok_chars; *p; p++)
209 if (strchr(cancel_chars, *p))
211 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,
212 UI_R_COMMON_OK_AND_CANCEL_CHARACTERS);
216 s = general_allocate_prompt(ui, prompt, prompt_freeable,
217 type, input_flags, result_buf);
221 if (allocate_string_stack(ui) >= 0)
223 s->_.boolean_data.action_desc = action_desc;
224 s->_.boolean_data.ok_chars = ok_chars;
225 s->_.boolean_data.cancel_chars = cancel_chars;
226 ret=sk_UI_STRING_push(ui->strings, s);
227 /* sk_push() returns 0 on error.
238 /* Returns the index to the place in the stack or 0 for error. Uses a
239 direct reference to the prompt. */
240 int UI_add_input_string(UI *ui, const char *prompt, int flags,
241 char *result_buf, int minsize, int maxsize)
243 return general_allocate_string(ui, prompt, 0,
244 UIT_PROMPT, flags, result_buf, minsize, maxsize, NULL);
247 /* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
248 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
249 char *result_buf, int minsize, int maxsize)
251 char *prompt_copy=NULL;
255 prompt_copy=BUF_strdup(prompt);
256 if (prompt_copy == NULL)
258 UIerr(UI_F_UI_DUP_INPUT_STRING,ERR_R_MALLOC_FAILURE);
263 return general_allocate_string(ui, prompt_copy, 1,
264 UIT_PROMPT, flags, result_buf, minsize, maxsize, NULL);
267 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
268 char *result_buf, int minsize, int maxsize, const char *test_buf)
270 return general_allocate_string(ui, prompt, 0,
271 UIT_VERIFY, flags, result_buf, minsize, maxsize, test_buf);
274 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
275 char *result_buf, int minsize, int maxsize, const char *test_buf)
277 char *prompt_copy=NULL;
281 prompt_copy=BUF_strdup(prompt);
282 if (prompt_copy == NULL)
284 UIerr(UI_F_UI_DUP_VERIFY_STRING,ERR_R_MALLOC_FAILURE);
289 return general_allocate_string(ui, prompt_copy, 1,
290 UIT_VERIFY, flags, result_buf, minsize, maxsize, test_buf);
293 int UI_add_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 return general_allocate_boolean(ui, prompt, action_desc,
298 ok_chars, cancel_chars, 0, UIT_BOOLEAN, flags, result_buf);
301 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
302 const char *ok_chars, const char *cancel_chars,
303 int flags, char *result_buf)
305 char *prompt_copy = NULL;
306 char *action_desc_copy = NULL;
307 char *ok_chars_copy = NULL;
308 char *cancel_chars_copy = NULL;
312 prompt_copy=BUF_strdup(prompt);
313 if (prompt_copy == NULL)
315 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
322 action_desc_copy=BUF_strdup(action_desc);
323 if (action_desc_copy == NULL)
325 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
332 ok_chars_copy=BUF_strdup(ok_chars);
333 if (ok_chars_copy == NULL)
335 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
342 cancel_chars_copy=BUF_strdup(cancel_chars);
343 if (cancel_chars_copy == NULL)
345 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
350 return general_allocate_boolean(ui, prompt_copy, action_desc_copy,
351 ok_chars_copy, cancel_chars_copy, 1, UIT_BOOLEAN, flags,
354 if (prompt_copy) OPENSSL_free(prompt_copy);
355 if (action_desc_copy) OPENSSL_free(action_desc_copy);
356 if (ok_chars_copy) OPENSSL_free(ok_chars_copy);
357 if (cancel_chars_copy) OPENSSL_free(cancel_chars_copy);
361 int UI_add_info_string(UI *ui, const char *text)
363 return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
367 int UI_dup_info_string(UI *ui, const char *text)
369 char *text_copy=NULL;
373 text_copy=BUF_strdup(text);
374 if (text_copy == NULL)
376 UIerr(UI_F_UI_DUP_INFO_STRING,ERR_R_MALLOC_FAILURE);
381 return general_allocate_string(ui, text_copy, 1, UIT_INFO, 0, NULL,
385 int UI_add_error_string(UI *ui, const char *text)
387 return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
391 int UI_dup_error_string(UI *ui, const char *text)
393 char *text_copy=NULL;
397 text_copy=BUF_strdup(text);
398 if (text_copy == NULL)
400 UIerr(UI_F_UI_DUP_ERROR_STRING,ERR_R_MALLOC_FAILURE);
404 return general_allocate_string(ui, text_copy, 1, UIT_ERROR, 0, NULL,
408 char *UI_construct_prompt(UI *ui, const char *object_desc,
409 const char *object_name)
413 if (ui->meth->ui_construct_prompt)
414 prompt = ui->meth->ui_construct_prompt(ui,
415 object_desc, object_name);
418 char prompt1[] = "Enter ";
419 char prompt2[] = " for ";
420 char prompt3[] = ":";
423 if (object_desc == NULL)
425 len = sizeof(prompt1) - 1 + strlen(object_desc);
427 len += sizeof(prompt2) - 1 + strlen(object_name);
428 len += sizeof(prompt3) - 1;
430 prompt = (char *)OPENSSL_malloc(len + 1);
431 strcpy(prompt, prompt1);
432 strcat(prompt, object_desc);
435 strcat(prompt, prompt2);
436 strcat(prompt, object_name);
438 strcat(prompt, prompt3);
443 void *UI_add_user_data(UI *ui, void *user_data)
445 void *old_data = ui->user_data;
446 ui->user_data = user_data;
450 void *UI_get0_user_data(UI *ui)
452 return ui->user_data;
455 const char *UI_get0_result(UI *ui, int i)
459 UIerr(UI_F_UI_GET0_RESULT,UI_R_INDEX_TOO_SMALL);
462 if (i >= sk_UI_STRING_num(ui->strings))
464 UIerr(UI_F_UI_GET0_RESULT,UI_R_INDEX_TOO_LARGE);
467 return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
470 static int print_error(const char *str, size_t len, UI *ui)
474 memset(&uis, 0, sizeof(uis));
475 uis.type = UIT_ERROR;
476 uis.out_string = str;
478 if (ui->meth->ui_write_string
479 && !ui->meth->ui_write_string(ui, &uis))
484 int UI_process(UI *ui)
488 if (ui->meth->ui_open_session && !ui->meth->ui_open_session(ui))
491 if (ui->flags & UI_FLAG_PRINT_ERRORS)
493 (int (*)(const char *, size_t, void *))print_error,
496 for(i=0; i<sk_UI_STRING_num(ui->strings); i++)
498 if (ui->meth->ui_write_string
499 && !ui->meth->ui_write_string(ui,
500 sk_UI_STRING_value(ui->strings, i)))
507 if (ui->meth->ui_flush)
508 switch(ui->meth->ui_flush(ui))
510 case -1: /* Interrupt/Cancel/something... */
516 default: /* Success */
521 for(i=0; i<sk_UI_STRING_num(ui->strings); i++)
523 if (ui->meth->ui_read_string)
525 switch(ui->meth->ui_read_string(ui,
526 sk_UI_STRING_value(ui->strings, i)))
528 case -1: /* Interrupt/Cancel/something... */
534 default: /* Success */
541 if (ui->meth->ui_close_session && !ui->meth->ui_close_session(ui))
546 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)())
550 UIerr(UI_F_UI_CTRL,ERR_R_PASSED_NULL_PARAMETER);
555 case UI_CTRL_PRINT_ERRORS:
557 int save_flag = !!(ui->flags & UI_FLAG_PRINT_ERRORS);
559 ui->flags |= UI_FLAG_PRINT_ERRORS;
561 ui->flags &= ~UI_FLAG_PRINT_ERRORS;
564 case UI_CTRL_IS_REDOABLE:
565 return !!(ui->flags & UI_FLAG_REDOABLE);
569 UIerr(UI_F_UI_CTRL,UI_R_UNKNOWN_CONTROL_COMMAND);
573 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
574 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
576 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI, argl, argp,
577 new_func, dup_func, free_func);
580 int UI_set_ex_data(UI *r, int idx, void *arg)
582 return(CRYPTO_set_ex_data(&r->ex_data,idx,arg));
585 void *UI_get_ex_data(UI *r, int idx)
587 return(CRYPTO_get_ex_data(&r->ex_data,idx));
590 void UI_set_default_method(const UI_METHOD *meth)
592 default_UI_meth=meth;
595 const UI_METHOD *UI_get_default_method(void)
597 if (default_UI_meth == NULL)
599 default_UI_meth=UI_OpenSSL();
601 return default_UI_meth;
604 const UI_METHOD *UI_get_method(UI *ui)
609 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
616 UI_METHOD *UI_create_method(char *name)
618 UI_METHOD *ui_method = (UI_METHOD *)OPENSSL_malloc(sizeof(UI_METHOD));
621 memset(ui_method, 0, sizeof(*ui_method));
622 ui_method->name = BUF_strdup(name);
626 /* BIG FSCKING WARNING!!!! If you use this on a statically allocated method
627 (that is, it hasn't been allocated using UI_create_method(), you deserve
628 anything Murphy can throw at you and more! You have been warned. */
629 void UI_destroy_method(UI_METHOD *ui_method)
631 OPENSSL_free(ui_method->name);
632 ui_method->name = NULL;
633 OPENSSL_free(ui_method);
636 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui))
640 method->ui_open_session = opener;
647 int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis))
651 method->ui_write_string = writer;
658 int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui))
662 method->ui_flush = flusher;
669 int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis))
673 method->ui_read_string = reader;
680 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui))
684 method->ui_close_session = closer;
691 int (*UI_method_get_opener(UI_METHOD *method))(UI*)
694 return method->ui_open_session;
699 int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*)
702 return method->ui_write_string;
707 int (*UI_method_get_flusher(UI_METHOD *method))(UI*)
710 return method->ui_flush;
715 int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*)
718 return method->ui_read_string;
723 int (*UI_method_get_closer(UI_METHOD *method))(UI*)
726 return method->ui_close_session;
731 enum UI_string_types UI_get_string_type(UI_STRING *uis)
738 int UI_get_input_flags(UI_STRING *uis)
742 return uis->input_flags;
745 const char *UI_get0_output_string(UI_STRING *uis)
749 return uis->out_string;
752 const char *UI_get0_action_string(UI_STRING *uis)
760 return uis->_.boolean_data.action_desc;
766 const char *UI_get0_result_string(UI_STRING *uis)
774 return uis->result_buf;
780 const char *UI_get0_test_string(UI_STRING *uis)
787 return uis->_.string_data.test_buf;
793 int UI_get_result_minsize(UI_STRING *uis)
801 return uis->_.string_data.result_minsize;
807 int UI_get_result_maxsize(UI_STRING *uis)
815 return uis->_.string_data.result_maxsize;
821 int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
823 int l = strlen(result);
825 ui->flags &= ~UI_FLAG_REDOABLE;
837 BIO_snprintf(number1, sizeof(number1), "%d",
838 uis->_.string_data.result_minsize);
839 BIO_snprintf(number2, sizeof(number2), "%d",
840 uis->_.string_data.result_maxsize);
842 if (l < uis->_.string_data.result_minsize)
844 ui->flags |= UI_FLAG_REDOABLE;
845 UIerr(UI_F_UI_SET_RESULT,UI_R_RESULT_TOO_SMALL);
846 ERR_add_error_data(5,"You must type in ",
847 number1," to ",number2," characters");
850 if (l > uis->_.string_data.result_maxsize)
852 ui->flags |= UI_FLAG_REDOABLE;
853 UIerr(UI_F_UI_SET_RESULT,UI_R_RESULT_TOO_LARGE);
854 ERR_add_error_data(5,"You must type in ",
855 number1," to ",number2," characters");
860 if (!uis->result_buf)
862 UIerr(UI_F_UI_SET_RESULT,UI_R_NO_RESULT_BUFFER);
866 strcpy(uis->result_buf, result);
872 if (!uis->result_buf)
874 UIerr(UI_F_UI_SET_RESULT,UI_R_NO_RESULT_BUFFER);
878 uis->result_buf[0] = '\0';
879 for(p = result; *p; p++)
881 if (strchr(uis->_.boolean_data.ok_chars, *p))
884 uis->_.boolean_data.ok_chars[0];
887 if (strchr(uis->_.boolean_data.cancel_chars, *p))
890 uis->_.boolean_data.cancel_chars[0];