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>
67 IMPLEMENT_STACK_OF(UI_STRING_ST
)
69 static const UI_METHOD
*default_UI_meth
=NULL
;
73 return(UI_new_method(NULL
));
76 UI
*UI_new_method(const UI_METHOD
*method
)
80 ret
=(UI
*)OPENSSL_malloc(sizeof(UI
));
83 UIerr(UI_F_UI_NEW_METHOD
,ERR_R_MALLOC_FAILURE
);
87 ret
->meth
=UI_get_default_method();
93 CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI
, ret
, &ret
->ex_data
);
97 static void free_string(UI_STRING
*uis
)
99 if (uis
->flags
& OUT_STRING_FREEABLE
)
101 OPENSSL_free((char *)uis
->out_string
);
105 OPENSSL_free((char *)uis
->_
.boolean_data
.action_desc
);
106 OPENSSL_free((char *)uis
->_
.boolean_data
.ok_chars
);
107 OPENSSL_free((char *)uis
->_
.boolean_data
.cancel_chars
);
120 sk_UI_STRING_pop_free(ui
->strings
,free_string
);
121 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI
, ui
, &ui
->ex_data
);
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 ((type
== UIT_PROMPT
|| type
== UIT_VERIFY
149 || type
== UIT_BOOLEAN
) && result_buf
== NULL
)
151 UIerr(UI_F_GENERAL_ALLOCATE_PROMPT
,UI_R_NO_RESULT_BUFFER
);
153 else if ((ret
= (UI_STRING
*)OPENSSL_malloc(sizeof(UI_STRING
))))
155 ret
->out_string
=prompt
;
156 ret
->flags
=prompt_freeable
? OUT_STRING_FREEABLE
: 0;
157 ret
->input_flags
=input_flags
;
159 ret
->result_buf
=result_buf
;
164 static int general_allocate_string(UI
*ui
, const char *prompt
,
165 int prompt_freeable
, enum UI_string_types type
, int input_flags
,
166 char *result_buf
, int minsize
, int maxsize
, const char *test_buf
)
169 UI_STRING
*s
= general_allocate_prompt(ui
, prompt
, prompt_freeable
,
170 type
, input_flags
, result_buf
);
174 if (allocate_string_stack(ui
) >= 0)
176 s
->_
.string_data
.result_minsize
=minsize
;
177 s
->_
.string_data
.result_maxsize
=maxsize
;
178 s
->_
.string_data
.test_buf
=test_buf
;
179 ret
=sk_UI_STRING_push(ui
->strings
, s
);
180 /* sk_push() returns 0 on error. Let's addapt that */
189 static int general_allocate_boolean(UI
*ui
,
190 const char *prompt
, const char *action_desc
,
191 const char *ok_chars
, const char *cancel_chars
,
192 int prompt_freeable
, enum UI_string_types type
, int input_flags
,
199 if (ok_chars
== NULL
)
201 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN
,ERR_R_PASSED_NULL_PARAMETER
);
203 else if (cancel_chars
== NULL
)
205 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN
,ERR_R_PASSED_NULL_PARAMETER
);
209 for(p
= ok_chars
; *p
; p
++)
211 if (strchr(cancel_chars
, *p
))
213 UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN
,
214 UI_R_COMMON_OK_AND_CANCEL_CHARACTERS
);
218 s
= general_allocate_prompt(ui
, prompt
, prompt_freeable
,
219 type
, input_flags
, result_buf
);
223 if (allocate_string_stack(ui
) >= 0)
225 s
->_
.boolean_data
.action_desc
= action_desc
;
226 s
->_
.boolean_data
.ok_chars
= ok_chars
;
227 s
->_
.boolean_data
.cancel_chars
= cancel_chars
;
228 ret
=sk_UI_STRING_push(ui
->strings
, s
);
229 /* sk_push() returns 0 on error.
240 /* Returns the index to the place in the stack or -1 for error. Uses a
241 direct reference to the prompt. */
242 int UI_add_input_string(UI
*ui
, const char *prompt
, int flags
,
243 char *result_buf
, int minsize
, int maxsize
)
245 return general_allocate_string(ui
, prompt
, 0,
246 UIT_PROMPT
, flags
, result_buf
, minsize
, maxsize
, NULL
);
249 /* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
250 int UI_dup_input_string(UI
*ui
, const char *prompt
, int flags
,
251 char *result_buf
, int minsize
, int maxsize
)
253 char *prompt_copy
=NULL
;
257 prompt_copy
=BUF_strdup(prompt
);
258 if (prompt_copy
== NULL
)
260 UIerr(UI_F_UI_DUP_INPUT_STRING
,ERR_R_MALLOC_FAILURE
);
265 return general_allocate_string(ui
, prompt_copy
, 1,
266 UIT_PROMPT
, flags
, result_buf
, minsize
, maxsize
, NULL
);
269 int UI_add_verify_string(UI
*ui
, const char *prompt
, int flags
,
270 char *result_buf
, int minsize
, int maxsize
, const char *test_buf
)
272 return general_allocate_string(ui
, prompt
, 0,
273 UIT_VERIFY
, flags
, result_buf
, minsize
, maxsize
, test_buf
);
276 int UI_dup_verify_string(UI
*ui
, const char *prompt
, int flags
,
277 char *result_buf
, int minsize
, int maxsize
, const char *test_buf
)
279 char *prompt_copy
=NULL
;
283 prompt_copy
=BUF_strdup(prompt
);
284 if (prompt_copy
== NULL
)
286 UIerr(UI_F_UI_DUP_VERIFY_STRING
,ERR_R_MALLOC_FAILURE
);
291 return general_allocate_string(ui
, prompt_copy
, 1,
292 UIT_VERIFY
, flags
, result_buf
, minsize
, maxsize
, test_buf
);
295 int UI_add_input_boolean(UI
*ui
, const char *prompt
, const char *action_desc
,
296 const char *ok_chars
, const char *cancel_chars
,
297 int flags
, char *result_buf
)
299 return general_allocate_boolean(ui
, prompt
, action_desc
,
300 ok_chars
, cancel_chars
, 0, UIT_BOOLEAN
, flags
, result_buf
);
303 int UI_dup_input_boolean(UI
*ui
, const char *prompt
, const char *action_desc
,
304 const char *ok_chars
, const char *cancel_chars
,
305 int flags
, char *result_buf
)
307 char *prompt_copy
= NULL
;
308 char *action_desc_copy
= NULL
;
309 char *ok_chars_copy
= NULL
;
310 char *cancel_chars_copy
= NULL
;
314 prompt_copy
=BUF_strdup(prompt
);
315 if (prompt_copy
== NULL
)
317 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
,ERR_R_MALLOC_FAILURE
);
324 action_desc_copy
=BUF_strdup(action_desc
);
325 if (action_desc_copy
== NULL
)
327 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
,ERR_R_MALLOC_FAILURE
);
334 ok_chars_copy
=BUF_strdup(ok_chars
);
335 if (ok_chars_copy
== NULL
)
337 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
,ERR_R_MALLOC_FAILURE
);
344 cancel_chars_copy
=BUF_strdup(cancel_chars
);
345 if (cancel_chars_copy
== NULL
)
347 UIerr(UI_F_UI_DUP_INPUT_BOOLEAN
,ERR_R_MALLOC_FAILURE
);
352 return general_allocate_boolean(ui
, prompt_copy
, action_desc_copy
,
353 ok_chars_copy
, cancel_chars_copy
, 1, UIT_BOOLEAN
, flags
,
356 if (prompt_copy
) OPENSSL_free(prompt_copy
);
357 if (action_desc_copy
) OPENSSL_free(action_desc_copy
);
358 if (ok_chars_copy
) OPENSSL_free(ok_chars_copy
);
359 if (cancel_chars_copy
) OPENSSL_free(cancel_chars_copy
);
363 int UI_add_info_string(UI
*ui
, const char *text
)
365 return general_allocate_string(ui
, text
, 0, UIT_INFO
, 0, NULL
, 0, 0,
369 int UI_dup_info_string(UI
*ui
, const char *text
)
371 char *text_copy
=NULL
;
375 text_copy
=BUF_strdup(text
);
376 if (text_copy
== NULL
)
378 UIerr(UI_F_UI_DUP_INFO_STRING
,ERR_R_MALLOC_FAILURE
);
383 return general_allocate_string(ui
, text_copy
, 1, UIT_INFO
, 0, NULL
,
387 int UI_add_error_string(UI
*ui
, const char *text
)
389 return general_allocate_string(ui
, text
, 0, UIT_ERROR
, 0, NULL
, 0, 0,
393 int UI_dup_error_string(UI
*ui
, const char *text
)
395 char *text_copy
=NULL
;
399 text_copy
=BUF_strdup(text
);
400 if (text_copy
== NULL
)
402 UIerr(UI_F_UI_DUP_ERROR_STRING
,ERR_R_MALLOC_FAILURE
);
406 return general_allocate_string(ui
, text_copy
, 1, UIT_ERROR
, 0, NULL
,
410 char *UI_construct_prompt(UI
*ui
, const char *object_desc
,
411 const char *object_name
)
415 if (ui
->meth
->ui_construct_prompt
)
416 prompt
= ui
->meth
->ui_construct_prompt(ui
,
417 object_desc
, object_name
);
420 char prompt1
[] = "Enter ";
421 char prompt2
[] = " for ";
422 char prompt3
[] = ":";
425 if (object_desc
== NULL
)
427 len
= sizeof(prompt1
) - 1 + strlen(object_desc
);
429 len
+= sizeof(prompt2
) - 1 + strlen(object_name
);
430 len
+= sizeof(prompt3
) - 1;
432 prompt
= (char *)OPENSSL_malloc(len
+ 1);
433 BUF_strlcpy(prompt
, prompt1
, len
+ 1);
434 BUF_strlcat(prompt
, object_desc
, len
+ 1);
437 BUF_strlcat(prompt
, prompt2
, len
+ 1);
438 BUF_strlcat(prompt
, object_name
, len
+ 1);
440 BUF_strlcat(prompt
, prompt3
, len
+ 1);
445 void *UI_add_user_data(UI
*ui
, void *user_data
)
447 void *old_data
= ui
->user_data
;
448 ui
->user_data
= user_data
;
452 void *UI_get0_user_data(UI
*ui
)
454 return ui
->user_data
;
457 const char *UI_get0_result(UI
*ui
, int i
)
461 UIerr(UI_F_UI_GET0_RESULT
,UI_R_INDEX_TOO_SMALL
);
464 if (i
>= sk_UI_STRING_num(ui
->strings
))
466 UIerr(UI_F_UI_GET0_RESULT
,UI_R_INDEX_TOO_LARGE
);
469 return UI_get0_result_string(sk_UI_STRING_value(ui
->strings
, i
));
472 static int print_error(const char *str
, size_t len
, UI
*ui
)
476 memset(&uis
, 0, sizeof(uis
));
477 uis
.type
= UIT_ERROR
;
478 uis
.out_string
= str
;
480 if (ui
->meth
->ui_write_string
481 && !ui
->meth
->ui_write_string(ui
, &uis
))
486 int UI_process(UI
*ui
)
490 if (ui
->meth
->ui_open_session
&& !ui
->meth
->ui_open_session(ui
))
493 if (ui
->flags
& UI_FLAG_PRINT_ERRORS
)
495 (int (*)(const char *, size_t, void *))print_error
,
498 for(i
=0; i
<sk_UI_STRING_num(ui
->strings
); i
++)
500 if (ui
->meth
->ui_write_string
501 && !ui
->meth
->ui_write_string(ui
,
502 sk_UI_STRING_value(ui
->strings
, i
)))
509 if (ui
->meth
->ui_flush
)
510 switch(ui
->meth
->ui_flush(ui
))
512 case -1: /* Interrupt/Cancel/something... */
518 default: /* Success */
523 for(i
=0; i
<sk_UI_STRING_num(ui
->strings
); i
++)
525 if (ui
->meth
->ui_read_string
)
527 switch(ui
->meth
->ui_read_string(ui
,
528 sk_UI_STRING_value(ui
->strings
, i
)))
530 case -1: /* Interrupt/Cancel/something... */
536 default: /* Success */
543 if (ui
->meth
->ui_close_session
&& !ui
->meth
->ui_close_session(ui
))
548 int UI_ctrl(UI
*ui
, int cmd
, long i
, void *p
, void (*f
)(void))
552 UIerr(UI_F_UI_CTRL
,ERR_R_PASSED_NULL_PARAMETER
);
557 case UI_CTRL_PRINT_ERRORS
:
559 int save_flag
= !!(ui
->flags
& UI_FLAG_PRINT_ERRORS
);
561 ui
->flags
|= UI_FLAG_PRINT_ERRORS
;
563 ui
->flags
&= ~UI_FLAG_PRINT_ERRORS
;
566 case UI_CTRL_IS_REDOABLE
:
567 return !!(ui
->flags
& UI_FLAG_REDOABLE
);
571 UIerr(UI_F_UI_CTRL
,UI_R_UNKNOWN_CONTROL_COMMAND
);
575 int UI_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
576 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
)
578 return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI
, argl
, argp
,
579 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
;
836 char number1
[DECIMAL_SIZE(uis
->_
.string_data
.result_minsize
)+1];
837 char number2
[DECIMAL_SIZE(uis
->_
.string_data
.result_maxsize
)+1];
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 BUF_strlcpy(uis
->result_buf
, result
,
869 uis
->_
.string_data
.result_maxsize
+ 1);
875 if (!uis
->result_buf
)
877 UIerr(UI_F_UI_SET_RESULT
,UI_R_NO_RESULT_BUFFER
);
881 uis
->result_buf
[0] = '\0';
882 for(p
= result
; *p
; p
++)
884 if (strchr(uis
->_
.boolean_data
.ok_chars
, *p
))
887 uis
->_
.boolean_data
.ok_chars
[0];
890 if (strchr(uis
->_
.boolean_data
.cancel_chars
, *p
))
893 uis
->_
.boolean_data
.cancel_chars
[0];