1 /* crypto/ui/ui_lib.c -*- mode:C; c-file-style: "eay" -*- */
2 /* Written by Richard Levitte (levitte@stacken.kth.se) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1998-2000 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).
59 #include <openssl/e_os2.h>
60 /* The following defines enable the declaration of strdup(), which is an
61 extended function according to X/Open. */
62 #ifdef OPENSSL_SYS_VMS_DECC
63 # define _XOPEN_SOURCE_EXTENDED
65 #ifdef OPENSSL_SYS_UNIX
66 # define __USE_XOPEN_EXTENDED /* For Linux and probably anything GNU */
70 #include <openssl/ui.h>
71 #include <openssl/err.h>
74 IMPLEMENT_STACK_OF(UI_STRING_ST)
76 static const UI_METHOD *default_UI_meth=NULL;
77 static int ui_meth_num=0;
78 static STACK_OF(CRYPTO_EX_DATA_FUNCS) *ui_meth=NULL;
82 return(UI_new_method(NULL));
85 UI *UI_new_method(const UI_METHOD *method)
89 ret=(UI *)OPENSSL_malloc(sizeof(UI));
92 UIerr(UI_F_UI_NEW_METHOD,ERR_R_MALLOC_FAILURE);
96 ret->meth=UI_get_default_method();
104 static void free_string(UI_STRING *uis)
106 if (uis->flags & OUT_STRING_FREEABLE)
107 OPENSSL_free((char *)uis->out_string);
113 sk_UI_STRING_pop_free(ui->strings,free_string);
117 static int allocate_string_stack(UI *ui)
119 if (ui->strings == NULL)
121 ui->strings=sk_UI_STRING_new_null();
122 if (ui->strings == NULL)
130 static int general_allocate_string(UI *ui, const char *prompt,
131 int prompt_freeable, enum UI_string_types type,
132 char *result_buf, int minsize, int maxsize, const char *test_buf)
138 UIerr(UI_F_GENERAL_ALLOCATE_STRING,ERR_R_PASSED_NULL_PARAMETER);
140 else if (allocate_string_stack(ui) >= 0)
142 UI_STRING *s=(UI_STRING *)OPENSSL_malloc(sizeof(UI_STRING));
143 s->out_string=prompt;
144 s->flags=prompt_freeable ? OUT_STRING_FREEABLE : 0;
146 s->result_buf=result_buf;
147 s->result_minsize=minsize;
148 s->result_maxsize=maxsize;
149 s->test_buf=test_buf;
150 ret=sk_UI_STRING_push(ui->strings, s);
155 /* Returns the index to the place in the stack or 0 for error. Uses a
156 direct reference to the prompt. */
157 int UI_add_input_string(UI *ui, const char *prompt, int echo_p,
158 char *result_buf, int minsize, int maxsize)
160 return general_allocate_string(ui, prompt, 0,
161 echo_p?UI_STRING_ECHO:UI_STRING_NOECHO,
162 result_buf, minsize, maxsize, NULL);
165 /* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
166 int UI_dup_input_string(UI *ui, const char *prompt, int echo_p,
167 char *result_buf, int minsize, int maxsize)
169 char *prompt_copy=NULL;
173 prompt_copy=strdup(prompt);
174 if (prompt_copy == NULL)
176 UIerr(UI_F_UI_DUP_INPUT_STRING,ERR_R_MALLOC_FAILURE);
181 return general_allocate_string(ui, prompt, 1,
182 echo_p?UI_STRING_ECHO:UI_STRING_NOECHO,
183 result_buf, minsize, maxsize, NULL);
186 int UI_add_verify_string(UI *ui, const char *prompt, int echo_p,
187 char *result_buf, int minsize, int maxsize, const char *test_buf)
189 return general_allocate_string(ui, prompt, 0,
190 echo_p?UI_VERIFY_ECHO:UI_VERIFY_NOECHO,
191 result_buf, minsize, maxsize, test_buf);
194 int UI_dup_verify_string(UI *ui, const char *prompt, int echo_p,
195 char *result_buf, int minsize, int maxsize, const char *test_buf)
197 char *prompt_copy=NULL;
201 prompt_copy=strdup(prompt);
202 if (prompt_copy == NULL)
204 UIerr(UI_F_UI_DUP_VERIFY_STRING,ERR_R_MALLOC_FAILURE);
209 return general_allocate_string(ui, prompt, 1,
210 echo_p?UI_VERIFY_ECHO:UI_VERIFY_NOECHO,
211 result_buf, minsize, maxsize, test_buf);
214 int UI_add_info_string(UI *ui, const char *text)
216 return general_allocate_string(ui, text, 0, UI_INFO, NULL, 0, 0, NULL);
219 int UI_dup_info_string(UI *ui, const char *text)
221 char *text_copy=NULL;
225 text_copy=strdup(text);
226 if (text_copy == NULL)
228 UIerr(UI_F_UI_DUP_INFO_STRING,ERR_R_MALLOC_FAILURE);
233 return general_allocate_string(ui, text, 1, UI_INFO, NULL, 0, 0, NULL);
236 int UI_add_error_string(UI *ui, const char *text)
238 return general_allocate_string(ui, text, 0, UI_ERROR, NULL, 0, 0,
242 int UI_dup_error_string(UI *ui, const char *text)
244 char *text_copy=NULL;
248 text_copy=strdup(text);
249 if (text_copy == NULL)
251 UIerr(UI_F_UI_DUP_ERROR_STRING,ERR_R_MALLOC_FAILURE);
255 return general_allocate_string(ui, text_copy, 1, UI_ERROR, NULL, 0, 0,
259 void *UI_add_user_data(UI *ui, void *user_data)
261 void *old_data = ui->user_data;
262 ui->user_data = user_data;
266 void *UI_get0_user_data(UI *ui)
268 return ui->user_data;
271 const char *UI_get0_result(UI *ui, int i)
275 UIerr(UI_F_UI_GET0_RESULT,UI_R_INDEX_TOO_SMALL);
278 if (i >= sk_UI_STRING_num(ui->strings))
280 UIerr(UI_F_UI_GET0_RESULT,UI_R_INDEX_TOO_LARGE);
283 return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
286 int UI_process(UI *ui)
290 if (ui->meth->ui_open_session && !ui->meth->ui_open_session(ui))
293 for(i=0; i<sk_UI_STRING_num(ui->strings); i++)
295 if (ui->meth->ui_write_string
296 && !ui->meth->ui_write_string(ui,
297 sk_UI_STRING_value(ui->strings, i)))
304 for(i=0; i<sk_UI_STRING_num(ui->strings); i++)
306 if (ui->meth->ui_read_string
307 && !ui->meth->ui_read_string(ui,
308 sk_UI_STRING_value(ui->strings, i)))
315 if (ui->meth->ui_close_session && !ui->meth->ui_close_session(ui))
320 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
321 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
324 return(CRYPTO_get_ex_new_index(ui_meth_num-1,
325 &ui_meth,argl,argp,new_func,dup_func,free_func));
328 int UI_set_ex_data(UI *r, int idx, void *arg)
330 return(CRYPTO_set_ex_data(&r->ex_data,idx,arg));
333 void *UI_get_ex_data(UI *r, int idx)
335 return(CRYPTO_get_ex_data(&r->ex_data,idx));
338 void UI_set_default_method(const UI_METHOD *meth)
340 default_UI_meth=meth;
343 const UI_METHOD *UI_get_default_method(void)
345 if (default_UI_meth == NULL)
347 default_UI_meth=UI_OpenSSL();
349 return default_UI_meth;
352 const UI_METHOD *UI_get_method(UI *ui)
357 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
364 UI_METHOD *UI_create_method(void)
366 return (UI_METHOD *)OPENSSL_malloc(sizeof(UI_METHOD));
369 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui))
373 method->ui_open_session = opener;
380 int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis))
384 method->ui_write_string = writer;
391 int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis))
395 method->ui_read_string = reader;
402 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui))
406 method->ui_close_session = closer;
413 int (*UI_method_get_opener(UI_METHOD *method))(UI*)
416 return method->ui_open_session;
421 int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*)
424 return method->ui_write_string;
429 int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*)
432 return method->ui_read_string;
437 int (*UI_method_get_closer(UI_METHOD *method))(UI*)
440 return method->ui_close_session;
445 enum UI_string_types UI_get_string_type(UI_STRING *uis)
452 const char *UI_get0_output_string(UI_STRING *uis)
456 return uis->out_string;
459 const char *UI_get0_result_string(UI_STRING *uis)
466 case UI_STRING_NOECHO:
468 case UI_VERIFY_NOECHO:
469 return uis->result_buf;
475 const char *UI_get0_test_string(UI_STRING *uis)
479 return uis->test_buf;
482 int UI_get_result_minsize(UI_STRING *uis)
486 return uis->result_minsize;
489 int UI_get_result_maxsize(UI_STRING *uis)
493 return uis->result_maxsize;
496 int UI_set_result(UI_STRING *uis, char *result)
498 int l = strlen(result);
502 if (l < uis->result_minsize)
504 UIerr(UI_F_UI_SET_RESULT,UI_R_RESULT_TOO_SMALL);
507 if (l > uis->result_maxsize)
509 UIerr(UI_F_UI_SET_RESULT,UI_R_RESULT_TOO_LARGE);
513 if (!uis->result_buf)
515 uis->result_buf = OPENSSL_malloc(uis->result_maxsize+1);
518 if (!uis->result_buf)
520 UIerr(UI_F_UI_NEW_METHOD,ERR_R_MALLOC_FAILURE);
524 strcpy(uis->result_buf, result);