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;
69 static int ui_meth_num=0;
70 static STACK_OF(CRYPTO_EX_DATA_FUNCS) *ui_meth=NULL;
74 return(UI_new_method(NULL));
77 UI *UI_new_method(const UI_METHOD *method)
81 ret=(UI *)OPENSSL_malloc(sizeof(UI));
84 UIerr(UI_F_UI_NEW_METHOD,ERR_R_MALLOC_FAILURE);
88 ret->meth=UI_get_default_method();
94 CRYPTO_new_ex_data(ui_meth,ret,&ret->ex_data);
98 static void free_string(UI_STRING *uis)
100 if (uis->flags & OUT_STRING_FREEABLE)
102 OPENSSL_free((char *)uis->out_string);
106 OPENSSL_free((char *)uis->_.boolean_data.action_desc);
107 OPENSSL_free((char *)uis->_.boolean_data.ok_chars);
108 OPENSSL_free((char *)uis->_.boolean_data.cancel_chars);
121 sk_UI_STRING_pop_free(ui->strings,free_string);
125 static int allocate_string_stack(UI *ui)
127 if (ui->strings == NULL)
129 ui->strings=sk_UI_STRING_new_null();
130 if (ui->strings == NULL)
138 static UI_STRING *general_allocate_prompt(UI *ui, const char *prompt,
139 int prompt_freeable, enum UI_string_types type, int input_flags,
142 UI_STRING *ret = NULL;
146 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT,ERR_R_PASSED_NULL_PARAMETER);
148 else if (result_buf == NULL)
150 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT,UI_R_NO_RESULT_BUFFER);
152 else if ((ret = (UI_STRING *)OPENSSL_malloc(sizeof(UI_STRING))))
154 ret->out_string=prompt;
155 ret->flags=prompt_freeable ? OUT_STRING_FREEABLE : 0;
156 ret->input_flags=input_flags;
158 ret->result_buf=result_buf;
163 static int general_allocate_string(UI *ui, const char *prompt,
164 int prompt_freeable, enum UI_string_types type, int input_flags,
165 char *result_buf, int minsize, int maxsize, const char *test_buf)
168 UI_STRING *s = general_allocate_prompt(ui, prompt, prompt_freeable,
169 type, input_flags, result_buf);
173 if (allocate_string_stack(ui) >= 0)
175 s->_.string_data.result_minsize=minsize;
176 s->_.string_data.result_maxsize=maxsize;
177 s->_.string_data.test_buf=test_buf;
178 ret=sk_UI_STRING_push(ui->strings, s);
179 /* sk_push() returns 0 on error. Let's addapt that */
188 static int general_allocate_boolean(UI *ui,
189 const char *prompt, const char *action_desc,
190 const char *ok_chars, const char *cancel_chars,
191 int prompt_freeable, enum UI_string_types type, int input_flags,
198 if (ok_chars == NULL)
200 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,ERR_R_PASSED_NULL_PARAMETER);
202 else if (cancel_chars == NULL)
204 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,ERR_R_PASSED_NULL_PARAMETER);
208 for(p = ok_chars; *p; p++)
210 if (strchr(cancel_chars, *p))
212 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,
213 UI_R_COMMON_OK_AND_CANCEL_CHARACTERS);
217 s = general_allocate_prompt(ui, prompt, prompt_freeable,
218 type, input_flags, result_buf);
222 if (allocate_string_stack(ui) >= 0)
224 s->_.boolean_data.action_desc = action_desc;
225 s->_.boolean_data.ok_chars = ok_chars;
226 s->_.boolean_data.cancel_chars = cancel_chars;
227 ret=sk_UI_STRING_push(ui->strings, s);
228 /* sk_push() returns 0 on error.
239 /* Returns the index to the place in the stack or 0 for error. Uses a
240 direct reference to the prompt. */
241 int UI_add_input_string(UI *ui, const char *prompt, int flags,
242 char *result_buf, int minsize, int maxsize)
244 return general_allocate_string(ui, prompt, 0,
245 UIT_PROMPT, flags, result_buf, minsize, maxsize, NULL);
248 /* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
249 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
250 char *result_buf, int minsize, int maxsize)
252 char *prompt_copy=NULL;
256 prompt_copy=BUF_strdup(prompt);
257 if (prompt_copy == NULL)
259 UIerr(UI_F_UI_DUP_INPUT_STRING,ERR_R_MALLOC_FAILURE);
264 return general_allocate_string(ui, prompt_copy, 1,
265 UIT_PROMPT, flags, result_buf, minsize, maxsize, NULL);
268 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
269 char *result_buf, int minsize, int maxsize, const char *test_buf)
271 return general_allocate_string(ui, prompt, 0,
272 UIT_VERIFY, flags, result_buf, minsize, maxsize, test_buf);
275 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
276 char *result_buf, int minsize, int maxsize, const char *test_buf)
278 char *prompt_copy=NULL;
282 prompt_copy=BUF_strdup(prompt);
283 if (prompt_copy == NULL)
285 UIerr(UI_F_UI_DUP_VERIFY_STRING,ERR_R_MALLOC_FAILURE);
290 return general_allocate_string(ui, prompt_copy, 1,
291 UIT_VERIFY, flags, result_buf, minsize, maxsize, test_buf);
294 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
295 const char *ok_chars, const char *cancel_chars,
296 int flags, char *result_buf)
298 return general_allocate_boolean(ui, prompt, action_desc,
299 ok_chars, cancel_chars, 0, UIT_BOOLEAN, flags, result_buf);
302 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
303 const char *ok_chars, const char *cancel_chars,
304 int flags, char *result_buf)
306 char *prompt_copy = NULL;
307 char *action_desc_copy = NULL;
308 char *ok_chars_copy = NULL;
309 char *cancel_chars_copy = NULL;
313 prompt_copy=BUF_strdup(prompt);
314 if (prompt_copy == NULL)
316 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
323 action_desc_copy=BUF_strdup(action_desc);
324 if (action_desc_copy == NULL)
326 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
333 ok_chars_copy=BUF_strdup(ok_chars);
334 if (ok_chars_copy == NULL)
336 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
343 cancel_chars_copy=BUF_strdup(cancel_chars);
344 if (cancel_chars_copy == NULL)
346 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN,ERR_R_MALLOC_FAILURE);
351 return general_allocate_boolean(ui, prompt_copy, action_desc_copy,
352 ok_chars_copy, cancel_chars_copy, 1, UIT_BOOLEAN, flags,
355 if (prompt_copy) OPENSSL_free(prompt_copy);
356 if (action_desc_copy) OPENSSL_free(action_desc_copy);
357 if (ok_chars_copy) OPENSSL_free(ok_chars_copy);
358 if (cancel_chars_copy) OPENSSL_free(cancel_chars_copy);
362 int UI_add_info_string(UI *ui, const char *text)
364 return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
368 int UI_dup_info_string(UI *ui, const char *text)
370 char *text_copy=NULL;
374 text_copy=BUF_strdup(text);
375 if (text_copy == NULL)
377 UIerr(UI_F_UI_DUP_INFO_STRING,ERR_R_MALLOC_FAILURE);
382 return general_allocate_string(ui, text_copy, 1, UIT_INFO, 0, NULL,
386 int UI_add_error_string(UI *ui, const char *text)
388 return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
392 int UI_dup_error_string(UI *ui, const char *text)
394 char *text_copy=NULL;
398 text_copy=BUF_strdup(text);
399 if (text_copy == NULL)
401 UIerr(UI_F_UI_DUP_ERROR_STRING,ERR_R_MALLOC_FAILURE);
405 return general_allocate_string(ui, text_copy, 1, UIT_ERROR, 0, NULL,
409 char *UI_construct_prompt(UI *ui, const char *object_desc,
410 const char *object_name)
414 if (ui->meth->ui_construct_prompt)
415 prompt = ui->meth->ui_construct_prompt(ui,
416 object_desc, object_name);
419 char prompt1[] = "Enter ";
420 char prompt2[] = " for ";
421 char prompt3[] = ":";
424 if (object_desc == NULL)
426 len = sizeof(prompt1) - 1 + strlen(object_desc);
428 len += sizeof(prompt2) - 1 + strlen(object_name);
429 len += sizeof(prompt3) - 1;
431 prompt = (char *)OPENSSL_malloc(len + 1);
432 strcpy(prompt, prompt1);
433 strcat(prompt, object_desc);
436 strcat(prompt, prompt2);
437 strcat(prompt, object_name);
439 strcat(prompt, prompt3);
444 void *UI_add_user_data(UI *ui, void *user_data)
446 void *old_data = ui->user_data;
447 ui->user_data = user_data;
451 void *UI_get0_user_data(UI *ui)
453 return ui->user_data;
456 const char *UI_get0_result(UI *ui, int i)
460 UIerr(UI_F_UI_GET0_RESULT,UI_R_INDEX_TOO_SMALL);
463 if (i >= sk_UI_STRING_num(ui->strings))
465 UIerr(UI_F_UI_GET0_RESULT,UI_R_INDEX_TOO_LARGE);
468 return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
471 static int print_error(const char *str, size_t len, UI *ui)
475 memset(&uis, 0, sizeof(uis));
476 uis.type = UIT_ERROR;
477 uis.out_string = str;
479 if (ui->meth->ui_write_string
480 && !ui->meth->ui_write_string(ui, &uis))
485 int UI_process(UI *ui)
489 if (ui->meth->ui_open_session && !ui->meth->ui_open_session(ui))
492 if (ui->flags & UI_FLAG_PRINT_ERRORS)
494 (int (*)(const char *, size_t, void *))print_error,
497 for(i=0; i<sk_UI_STRING_num(ui->strings); i++)
499 if (ui->meth->ui_write_string
500 && !ui->meth->ui_write_string(ui,
501 sk_UI_STRING_value(ui->strings, i)))
508 if (ui->meth->ui_flush)
509 switch(ui->meth->ui_flush(ui))
511 case -1: /* Interrupt/Cancel/something... */
517 default: /* Success */
522 for(i=0; i<sk_UI_STRING_num(ui->strings); i++)
524 if (ui->meth->ui_read_string)
526 switch(ui->meth->ui_read_string(ui,
527 sk_UI_STRING_value(ui->strings, i)))
529 case -1: /* Interrupt/Cancel/something... */
535 default: /* Success */
542 if (ui->meth->ui_close_session && !ui->meth->ui_close_session(ui))
547 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)())
551 UIerr(UI_F_UI_CTRL,ERR_R_PASSED_NULL_PARAMETER);
556 case UI_CTRL_PRINT_ERRORS:
558 int save_flag = !!(ui->flags & UI_FLAG_PRINT_ERRORS);
560 ui->flags |= UI_FLAG_PRINT_ERRORS;
562 ui->flags &= ~UI_FLAG_PRINT_ERRORS;
565 case UI_CTRL_IS_REDOABLE:
566 return !!(ui->flags & UI_FLAG_REDOABLE);
570 UIerr(UI_F_UI_CTRL,UI_R_UNKNOWN_CONTROL_COMMAND);
574 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
575 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
578 return(CRYPTO_get_ex_new_index(ui_meth_num-1,
579 &ui_meth,argl,argp,new_func,dup_func,free_func));
582 int UI_set_ex_data(UI *r, int idx, void *arg)
584 return(CRYPTO_set_ex_data(&r->ex_data,idx,arg));
587 void *UI_get_ex_data(UI *r, int idx)
589 return(CRYPTO_get_ex_data(&r->ex_data,idx));
592 void UI_set_default_method(const UI_METHOD *meth)
594 default_UI_meth=meth;
597 const UI_METHOD *UI_get_default_method(void)
599 if (default_UI_meth == NULL)
601 default_UI_meth=UI_OpenSSL();
603 return default_UI_meth;
606 const UI_METHOD *UI_get_method(UI *ui)
611 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
618 UI_METHOD *UI_create_method(char *name)
620 UI_METHOD *ui_method = (UI_METHOD *)OPENSSL_malloc(sizeof(UI_METHOD));
623 memset(ui_method, 0, sizeof(*ui_method));
624 ui_method->name = BUF_strdup(name);
628 /* BIG FSCKING WARNING!!!! If you use this on a statically allocated method
629 (that is, it hasn't been allocated using UI_create_method(), you deserve
630 anything Murphy can throw at you and more! You have been warned. */
631 void UI_destroy_method(UI_METHOD *ui_method)
633 OPENSSL_free(ui_method->name);
634 ui_method->name = NULL;
635 OPENSSL_free(ui_method);
638 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui))
642 method->ui_open_session = opener;
649 int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis))
653 method->ui_write_string = writer;
660 int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui))
664 method->ui_flush = flusher;
671 int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis))
675 method->ui_read_string = reader;
682 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui))
686 method->ui_close_session = closer;
693 int (*UI_method_get_opener(UI_METHOD *method))(UI*)
696 return method->ui_open_session;
701 int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*)
704 return method->ui_write_string;
709 int (*UI_method_get_flusher(UI_METHOD *method))(UI*)
712 return method->ui_flush;
717 int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*)
720 return method->ui_read_string;
725 int (*UI_method_get_closer(UI_METHOD *method))(UI*)
728 return method->ui_close_session;
733 enum UI_string_types UI_get_string_type(UI_STRING *uis)
740 int UI_get_input_flags(UI_STRING *uis)
744 return uis->input_flags;
747 const char *UI_get0_output_string(UI_STRING *uis)
751 return uis->out_string;
754 const char *UI_get0_action_string(UI_STRING *uis)
762 return uis->_.boolean_data.action_desc;
768 const char *UI_get0_result_string(UI_STRING *uis)
776 return uis->result_buf;
782 const char *UI_get0_test_string(UI_STRING *uis)
789 return uis->_.string_data.test_buf;
795 int UI_get_result_minsize(UI_STRING *uis)
803 return uis->_.string_data.result_minsize;
809 int UI_get_result_maxsize(UI_STRING *uis)
817 return uis->_.string_data.result_maxsize;
823 int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
825 int l = strlen(result);
827 ui->flags &= ~UI_FLAG_REDOABLE;
839 BIO_snprintf(number1, sizeof(number1), "%d",
840 uis->_.string_data.result_minsize);
841 BIO_snprintf(number2, sizeof(number2), "%d",
842 uis->_.string_data.result_maxsize);
844 if (l < uis->_.string_data.result_minsize)
846 ui->flags |= UI_FLAG_REDOABLE;
847 UIerr(UI_F_UI_SET_RESULT,UI_R_RESULT_TOO_SMALL);
848 ERR_add_error_data(5,"You must type in ",
849 number1," to ",number2," characters");
852 if (l > uis->_.string_data.result_maxsize)
854 ui->flags |= UI_FLAG_REDOABLE;
855 UIerr(UI_F_UI_SET_RESULT,UI_R_RESULT_TOO_LARGE);
856 ERR_add_error_data(5,"You must type in ",
857 number1," to ",number2," characters");
862 if (!uis->result_buf)
864 UIerr(UI_F_UI_SET_RESULT,UI_R_NO_RESULT_BUFFER);
868 strcpy(uis->result_buf, result);
874 if (!uis->result_buf)
876 UIerr(UI_F_UI_SET_RESULT,UI_R_NO_RESULT_BUFFER);
880 uis->result_buf[0] = '\0';
881 for(p = result; *p; p++)
883 if (strchr(uis->_.boolean_data.ok_chars, *p))
886 uis->_.boolean_data.ok_chars[0];
889 if (strchr(uis->_.boolean_data.cancel_chars, *p))
892 uis->_.boolean_data.cancel_chars[0];