1*cedac418Stb /* $OpenBSD: ui_lib.c,v 1.51 2023/02/16 08:38:17 tb Exp $ */
2da347917Sbeck /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
3da347917Sbeck * project 2001.
4da347917Sbeck */
5da347917Sbeck /* ====================================================================
6da347917Sbeck * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
7da347917Sbeck *
8da347917Sbeck * Redistribution and use in source and binary forms, with or without
9da347917Sbeck * modification, are permitted provided that the following conditions
10da347917Sbeck * are met:
11da347917Sbeck *
12da347917Sbeck * 1. Redistributions of source code must retain the above copyright
13da347917Sbeck * notice, this list of conditions and the following disclaimer.
14da347917Sbeck *
15da347917Sbeck * 2. Redistributions in binary form must reproduce the above copyright
16da347917Sbeck * notice, this list of conditions and the following disclaimer in
17da347917Sbeck * the documentation and/or other materials provided with the
18da347917Sbeck * distribution.
19da347917Sbeck *
20da347917Sbeck * 3. All advertising materials mentioning features or use of this
21da347917Sbeck * software must display the following acknowledgment:
22da347917Sbeck * "This product includes software developed by the OpenSSL Project
23da347917Sbeck * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24da347917Sbeck *
25da347917Sbeck * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26da347917Sbeck * endorse or promote products derived from this software without
27da347917Sbeck * prior written permission. For written permission, please contact
28da347917Sbeck * openssl-core@openssl.org.
29da347917Sbeck *
30da347917Sbeck * 5. Products derived from this software may not be called "OpenSSL"
31da347917Sbeck * nor may "OpenSSL" appear in their names without prior written
32da347917Sbeck * permission of the OpenSSL Project.
33da347917Sbeck *
34da347917Sbeck * 6. Redistributions of any form whatsoever must retain the following
35da347917Sbeck * acknowledgment:
36da347917Sbeck * "This product includes software developed by the OpenSSL Project
37da347917Sbeck * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38da347917Sbeck *
39da347917Sbeck * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40da347917Sbeck * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41da347917Sbeck * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42da347917Sbeck * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43da347917Sbeck * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44da347917Sbeck * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45da347917Sbeck * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46da347917Sbeck * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47da347917Sbeck * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48da347917Sbeck * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49da347917Sbeck * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50da347917Sbeck * OF THE POSSIBILITY OF SUCH DAMAGE.
51da347917Sbeck * ====================================================================
52da347917Sbeck *
53da347917Sbeck * This product includes cryptographic software written by Eric Young
54da347917Sbeck * (eay@cryptsoft.com). This product includes software written by Tim
55da347917Sbeck * Hudson (tjh@cryptsoft.com).
56da347917Sbeck *
57da347917Sbeck */
58da347917Sbeck
59da347917Sbeck #include <string.h>
6020175b85Sjsing
6120175b85Sjsing #include <openssl/opensslconf.h>
6220175b85Sjsing
63da347917Sbeck #include <openssl/buffer.h>
64da347917Sbeck #include <openssl/err.h>
65b6ab114eSjsing #include <openssl/ui.h>
66b6ab114eSjsing
67c9675a23Stb #include "ui_local.h"
68da347917Sbeck
69569a82d4Sjsing static const UI_METHOD *default_UI_meth = NULL;
70da347917Sbeck
71c3bf3550Sjsing UI *
UI_new(void)72c3bf3550Sjsing UI_new(void)
73da347917Sbeck {
74da347917Sbeck return (UI_new_method(NULL));
75da347917Sbeck }
76*cedac418Stb LCRYPTO_ALIAS(UI_new);
77da347917Sbeck
78764af611Stedu UI *
UI_new_method(const UI_METHOD * method)79764af611Stedu UI_new_method(const UI_METHOD *method)
80da347917Sbeck {
81da347917Sbeck UI *ret;
82da347917Sbeck
83c4393b6dStb if ((ret = calloc(1, sizeof(UI))) == NULL) {
845067ae9fSbeck UIerror(ERR_R_MALLOC_FAILURE);
85da347917Sbeck return NULL;
86da347917Sbeck }
87c4393b6dStb if ((ret->meth = method) == NULL)
88da347917Sbeck ret->meth = UI_get_default_method();
89da347917Sbeck CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI, ret, &ret->ex_data);
90c4393b6dStb
91da347917Sbeck return ret;
92da347917Sbeck }
93*cedac418Stb LCRYPTO_ALIAS(UI_new_method);
94da347917Sbeck
95764af611Stedu static void
free_string(UI_STRING * uis)96764af611Stedu free_string(UI_STRING *uis)
97da347917Sbeck {
988804eef0Stb if (uis == NULL)
998804eef0Stb return;
100764af611Stedu if (uis->flags & OUT_STRING_FREEABLE) {
1016f3a6cb1Sbeck free((char *) uis->out_string);
102764af611Stedu switch (uis->type) {
103da347917Sbeck case UIT_BOOLEAN:
1046f3a6cb1Sbeck free((char *)uis->_.boolean_data.action_desc);
1056f3a6cb1Sbeck free((char *)uis->_.boolean_data.ok_chars);
1066f3a6cb1Sbeck free((char *)uis->_.boolean_data.cancel_chars);
107da347917Sbeck break;
108da347917Sbeck default:
109da347917Sbeck break;
110da347917Sbeck }
111da347917Sbeck }
1126f3a6cb1Sbeck free(uis);
113da347917Sbeck }
114da347917Sbeck
115764af611Stedu void
UI_free(UI * ui)116764af611Stedu UI_free(UI *ui)
117da347917Sbeck {
118da347917Sbeck if (ui == NULL)
119da347917Sbeck return;
120bcc93ea7Sjsing
121da347917Sbeck sk_UI_STRING_pop_free(ui->strings, free_string);
122da347917Sbeck CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI, ui, &ui->ex_data);
1236f3a6cb1Sbeck free(ui);
124da347917Sbeck }
125*cedac418Stb LCRYPTO_ALIAS(UI_free);
126da347917Sbeck
127764af611Stedu static int
allocate_string_stack(UI * ui)128764af611Stedu allocate_string_stack(UI *ui)
129da347917Sbeck {
130764af611Stedu if (ui->strings == NULL) {
131c95ba6a2Stb if ((ui->strings = sk_UI_STRING_new_null()) == NULL) {
132c95ba6a2Stb UIerror(ERR_R_MALLOC_FAILURE);
133da347917Sbeck return -1;
134da347917Sbeck }
135da347917Sbeck }
136da347917Sbeck return 0;
137da347917Sbeck }
138da347917Sbeck
139764af611Stedu static UI_STRING *
general_allocate_prompt(const char * prompt,int dup_prompt,enum UI_string_types type,int input_flags,char * result_buf)140cc93904dStb general_allocate_prompt(const char *prompt, int dup_prompt,
141ba586daeSjsing enum UI_string_types type, int input_flags, char *result_buf)
142da347917Sbeck {
143cc93904dStb UI_STRING *uis = NULL;
144da347917Sbeck
145764af611Stedu if (prompt == NULL) {
1465067ae9fSbeck UIerror(ERR_R_PASSED_NULL_PARAMETER);
147cc93904dStb goto err;
148da347917Sbeck }
149cc93904dStb if ((type == UIT_PROMPT || type == UIT_VERIFY || type == UIT_BOOLEAN) &&
150cc93904dStb result_buf == NULL) {
151cc93904dStb UIerror(UI_R_NO_RESULT_BUFFER);
152cc93904dStb goto err;
153cc93904dStb }
154cc93904dStb
155cc93904dStb if ((uis = calloc(1, sizeof(UI_STRING))) == NULL) {
156cc93904dStb UIerror(ERR_R_MALLOC_FAILURE);
157cc93904dStb goto err;
158cc93904dStb }
159cc93904dStb uis->out_string = prompt;
160cc93904dStb if (dup_prompt) {
161cc93904dStb if ((uis->out_string = strdup(prompt)) == NULL) {
162cc93904dStb UIerror(ERR_R_MALLOC_FAILURE);
163cc93904dStb goto err;
164cc93904dStb }
165cc93904dStb uis->flags = OUT_STRING_FREEABLE;
166cc93904dStb }
167cc93904dStb uis->input_flags = input_flags;
168cc93904dStb uis->type = type;
169cc93904dStb uis->result_buf = result_buf;
170cc93904dStb
171cc93904dStb return uis;
172cc93904dStb
173cc93904dStb err:
174cc93904dStb free_string(uis);
175cc93904dStb return NULL;
176da347917Sbeck }
177da347917Sbeck
178764af611Stedu static int
general_allocate_string(UI * ui,const char * prompt,int dup_prompt,enum UI_string_types type,int input_flags,char * result_buf,int minsize,int maxsize,const char * test_buf)179cc93904dStb general_allocate_string(UI *ui, const char *prompt, int dup_prompt,
180ba586daeSjsing enum UI_string_types type, int input_flags, char *result_buf, int minsize,
181ba586daeSjsing int maxsize, const char *test_buf)
182da347917Sbeck {
183cc93904dStb UI_STRING *s;
184cc93904dStb int ret;
185da347917Sbeck
186cc93904dStb if ((s = general_allocate_prompt(prompt, dup_prompt, type, input_flags,
187cc93904dStb result_buf)) == NULL)
188cc93904dStb goto err;
189da347917Sbeck s->_.string_data.result_minsize = minsize;
190da347917Sbeck s->_.string_data.result_maxsize = maxsize;
191da347917Sbeck s->_.string_data.test_buf = test_buf;
192cc93904dStb
193cc93904dStb if (allocate_string_stack(ui) < 0)
194cc93904dStb goto err;
195cc93904dStb if ((ret = sk_UI_STRING_push(ui->strings, s)) <= 0)
196cc93904dStb goto err;
197cc93904dStb
198da347917Sbeck return ret;
199cc93904dStb
200cc93904dStb err:
201cc93904dStb free_string(s);
202cc93904dStb return -1;
203da347917Sbeck }
204da347917Sbeck
205764af611Stedu static int
general_allocate_boolean(UI * ui,const char * prompt,const char * action_desc,const char * ok_chars,const char * cancel_chars,int dup_strings,enum UI_string_types type,int input_flags,char * result_buf)206ba586daeSjsing general_allocate_boolean(UI *ui, const char *prompt, const char *action_desc,
207cc93904dStb const char *ok_chars, const char *cancel_chars, int dup_strings,
208ba586daeSjsing enum UI_string_types type, int input_flags, char *result_buf)
209da347917Sbeck {
210cc93904dStb UI_STRING *s = NULL;
211cc93904dStb int ret;
212da347917Sbeck
213cc93904dStb if (ok_chars == NULL || cancel_chars == NULL) {
2145067ae9fSbeck UIerror(ERR_R_PASSED_NULL_PARAMETER);
215cc93904dStb goto err;
216cc93904dStb }
21756735cd3Stb if (ok_chars[strcspn(ok_chars, cancel_chars)] != '\0') {
2185067ae9fSbeck UIerror(UI_R_COMMON_OK_AND_CANCEL_CHARACTERS);
21956735cd3Stb goto err;
22056735cd3Stb }
221cc93904dStb
222cc93904dStb if ((s = general_allocate_prompt(prompt, dup_strings, type, input_flags,
223cc93904dStb result_buf)) == NULL)
224cc93904dStb goto err;
225cc93904dStb
226cc93904dStb if (dup_strings) {
227cc93904dStb if (action_desc != NULL) {
228cc93904dStb if ((s->_.boolean_data.action_desc =
229cc93904dStb strdup(action_desc)) == NULL) {
230cc93904dStb UIerror(ERR_R_MALLOC_FAILURE);
231cc93904dStb goto err;
232da347917Sbeck }
233da347917Sbeck }
234cc93904dStb if ((s->_.boolean_data.ok_chars = strdup(ok_chars)) == NULL) {
235cc93904dStb UIerror(ERR_R_MALLOC_FAILURE);
236cc93904dStb goto err;
237cc93904dStb }
238cc93904dStb if ((s->_.boolean_data.cancel_chars = strdup(cancel_chars)) ==
239cc93904dStb NULL) {
240cc93904dStb UIerror(ERR_R_MALLOC_FAILURE);
241cc93904dStb goto err;
242cc93904dStb }
243cc93904dStb } else {
244da347917Sbeck s->_.boolean_data.action_desc = action_desc;
245da347917Sbeck s->_.boolean_data.ok_chars = ok_chars;
246da347917Sbeck s->_.boolean_data.cancel_chars = cancel_chars;
247da347917Sbeck }
248cc93904dStb
249cc93904dStb if (allocate_string_stack(ui) < 0)
250cc93904dStb goto err;
251cc93904dStb if ((ret = sk_UI_STRING_push(ui->strings, s)) <= 0)
252cc93904dStb goto err;
253cc93904dStb
254da347917Sbeck return ret;
255cc93904dStb
256cc93904dStb err:
257cc93904dStb free_string(s);
258cc93904dStb return -1;
259da347917Sbeck }
260da347917Sbeck
261a0462387Stb /*
262a0462387Stb * Returns the index to the place in the stack or -1 for error. Uses a
263a0462387Stb * direct reference to the prompt.
264a0462387Stb */
265764af611Stedu int
UI_add_input_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize)266ba586daeSjsing UI_add_input_string(UI *ui, const char *prompt, int flags, char *result_buf,
267ba586daeSjsing int minsize, int maxsize)
268da347917Sbeck {
269ba586daeSjsing return general_allocate_string(ui, prompt, 0, UIT_PROMPT, flags,
270ba586daeSjsing result_buf, minsize, maxsize, NULL);
271da347917Sbeck }
272*cedac418Stb LCRYPTO_ALIAS(UI_add_input_string);
273da347917Sbeck
274a0462387Stb /* Same as UI_add_input_string(), excepts it takes a copy of the prompt. */
275764af611Stedu int
UI_dup_input_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize)276ba586daeSjsing UI_dup_input_string(UI *ui, const char *prompt, int flags, char *result_buf,
277ba586daeSjsing int minsize, int maxsize)
278da347917Sbeck {
279cc93904dStb return general_allocate_string(ui, prompt, 1, UIT_PROMPT, flags,
280ba586daeSjsing result_buf, minsize, maxsize, NULL);
281da347917Sbeck }
282*cedac418Stb LCRYPTO_ALIAS(UI_dup_input_string);
283da347917Sbeck
284764af611Stedu int
UI_add_verify_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize,const char * test_buf)285ba586daeSjsing UI_add_verify_string(UI *ui, const char *prompt, int flags, char *result_buf,
286ba586daeSjsing int minsize, int maxsize, const char *test_buf)
287da347917Sbeck {
288ba586daeSjsing return general_allocate_string(ui, prompt, 0, UIT_VERIFY, flags,
289ba586daeSjsing result_buf, minsize, maxsize, test_buf);
290da347917Sbeck }
291*cedac418Stb LCRYPTO_ALIAS(UI_add_verify_string);
292da347917Sbeck
293764af611Stedu int
UI_dup_verify_string(UI * ui,const char * prompt,int flags,char * result_buf,int minsize,int maxsize,const char * test_buf)294764af611Stedu UI_dup_verify_string(UI *ui, const char *prompt, int flags,
295da347917Sbeck char *result_buf, int minsize, int maxsize, const char *test_buf)
296da347917Sbeck {
297cc93904dStb return general_allocate_string(ui, prompt, 1, UIT_VERIFY, flags,
298ba586daeSjsing result_buf, minsize, maxsize, test_buf);
299da347917Sbeck }
300*cedac418Stb LCRYPTO_ALIAS(UI_dup_verify_string);
301da347917Sbeck
302764af611Stedu int
UI_add_input_boolean(UI * ui,const char * prompt,const char * action_desc,const char * ok_chars,const char * cancel_chars,int flags,char * result_buf)303764af611Stedu UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
304ba586daeSjsing const char *ok_chars, const char *cancel_chars, int flags, char *result_buf)
305da347917Sbeck {
306ba586daeSjsing return general_allocate_boolean(ui, prompt, action_desc, ok_chars,
307ba586daeSjsing cancel_chars, 0, UIT_BOOLEAN, flags, result_buf);
308da347917Sbeck }
309*cedac418Stb LCRYPTO_ALIAS(UI_add_input_boolean);
310da347917Sbeck
311764af611Stedu int
UI_dup_input_boolean(UI * ui,const char * prompt,const char * action_desc,const char * ok_chars,const char * cancel_chars,int flags,char * result_buf)312764af611Stedu UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
313ba586daeSjsing const char *ok_chars, const char *cancel_chars, int flags, char *result_buf)
314da347917Sbeck {
315cc93904dStb return general_allocate_boolean(ui, prompt, action_desc, ok_chars,
316cc93904dStb cancel_chars, 1, UIT_BOOLEAN, flags, result_buf);
317da347917Sbeck }
318*cedac418Stb LCRYPTO_ALIAS(UI_dup_input_boolean);
319da347917Sbeck
320764af611Stedu int
UI_add_info_string(UI * ui,const char * text)321764af611Stedu UI_add_info_string(UI *ui, const char *text)
322da347917Sbeck {
323da347917Sbeck return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
324da347917Sbeck NULL);
325da347917Sbeck }
326*cedac418Stb LCRYPTO_ALIAS(UI_add_info_string);
327da347917Sbeck
328764af611Stedu int
UI_dup_info_string(UI * ui,const char * text)329764af611Stedu UI_dup_info_string(UI *ui, const char *text)
330da347917Sbeck {
331cc93904dStb return general_allocate_string(ui, text, 1, UIT_INFO, 0, NULL, 0, 0,
332cc93904dStb NULL);
333da347917Sbeck }
334*cedac418Stb LCRYPTO_ALIAS(UI_dup_info_string);
335da347917Sbeck
336764af611Stedu int
UI_add_error_string(UI * ui,const char * text)337764af611Stedu UI_add_error_string(UI *ui, const char *text)
338da347917Sbeck {
339da347917Sbeck return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
340da347917Sbeck NULL);
341da347917Sbeck }
342*cedac418Stb LCRYPTO_ALIAS(UI_add_error_string);
343da347917Sbeck
344764af611Stedu int
UI_dup_error_string(UI * ui,const char * text)345764af611Stedu UI_dup_error_string(UI *ui, const char *text)
346da347917Sbeck {
347cc93904dStb return general_allocate_string(ui, text, 1, UIT_ERROR, 0, NULL, 0, 0,
348cc93904dStb NULL);
349da347917Sbeck }
350*cedac418Stb LCRYPTO_ALIAS(UI_dup_error_string);
351da347917Sbeck
352764af611Stedu char *
UI_construct_prompt(UI * ui,const char * object_desc,const char * object_name)353c3bf3550Sjsing UI_construct_prompt(UI *ui, const char *object_desc, const char *object_name)
354da347917Sbeck {
35564a2fea0Sjsing char *prompt;
356da347917Sbeck
357da347917Sbeck if (ui->meth->ui_construct_prompt)
35864a2fea0Sjsing return ui->meth->ui_construct_prompt(ui, object_desc,
35964a2fea0Sjsing object_name);
360da347917Sbeck
361da347917Sbeck if (object_desc == NULL)
362da347917Sbeck return NULL;
363dda2f39bSdoug
364dda2f39bSdoug if (object_name == NULL) {
365dda2f39bSdoug if (asprintf(&prompt, "Enter %s:", object_desc) == -1)
366dda2f39bSdoug return (NULL);
367dda2f39bSdoug } else {
368dda2f39bSdoug if (asprintf(&prompt, "Enter %s for %s:", object_desc,
369dda2f39bSdoug object_name) == -1)
370dda2f39bSdoug return (NULL);
371dda2f39bSdoug }
372da347917Sbeck
373da347917Sbeck return prompt;
374da347917Sbeck }
375*cedac418Stb LCRYPTO_ALIAS(UI_construct_prompt);
376da347917Sbeck
377764af611Stedu void *
UI_add_user_data(UI * ui,void * user_data)378764af611Stedu UI_add_user_data(UI *ui, void *user_data)
379da347917Sbeck {
380da347917Sbeck void *old_data = ui->user_data;
381ba586daeSjsing
382da347917Sbeck ui->user_data = user_data;
383bcc93ea7Sjsing
384da347917Sbeck return old_data;
385da347917Sbeck }
386*cedac418Stb LCRYPTO_ALIAS(UI_add_user_data);
387da347917Sbeck
388764af611Stedu void *
UI_get0_user_data(UI * ui)389764af611Stedu UI_get0_user_data(UI *ui)
390da347917Sbeck {
391da347917Sbeck return ui->user_data;
392da347917Sbeck }
393*cedac418Stb LCRYPTO_ALIAS(UI_get0_user_data);
394da347917Sbeck
395764af611Stedu const char *
UI_get0_result(UI * ui,int i)396764af611Stedu UI_get0_result(UI *ui, int i)
397da347917Sbeck {
398764af611Stedu if (i < 0) {
3995067ae9fSbeck UIerror(UI_R_INDEX_TOO_SMALL);
400da347917Sbeck return NULL;
401da347917Sbeck }
402764af611Stedu if (i >= sk_UI_STRING_num(ui->strings)) {
4035067ae9fSbeck UIerror(UI_R_INDEX_TOO_LARGE);
404da347917Sbeck return NULL;
405da347917Sbeck }
406da347917Sbeck return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
407da347917Sbeck }
408*cedac418Stb LCRYPTO_ALIAS(UI_get0_result);
409da347917Sbeck
410764af611Stedu static int
print_error(const char * str,size_t len,void * arg)411a37673fdStb print_error(const char *str, size_t len, void *arg)
412da347917Sbeck {
413a37673fdStb UI *ui = arg;
414da347917Sbeck UI_STRING uis;
415da347917Sbeck
416da347917Sbeck memset(&uis, 0, sizeof(uis));
417da347917Sbeck uis.type = UIT_ERROR;
418da347917Sbeck uis.out_string = str;
419da347917Sbeck
420c3bf3550Sjsing if (ui->meth->ui_write_string &&
421c3bf3550Sjsing !ui->meth->ui_write_string(ui, &uis))
422da347917Sbeck return -1;
423da347917Sbeck return 0;
424da347917Sbeck }
425da347917Sbeck
426764af611Stedu int
UI_process(UI * ui)427764af611Stedu UI_process(UI *ui)
428da347917Sbeck {
429da347917Sbeck int i, ok = 0;
430da347917Sbeck
431da347917Sbeck if (ui->meth->ui_open_session && !ui->meth->ui_open_session(ui))
432da347917Sbeck return -1;
433da347917Sbeck
434da347917Sbeck if (ui->flags & UI_FLAG_PRINT_ERRORS)
435a37673fdStb ERR_print_errors_cb(print_error, ui);
436da347917Sbeck
437764af611Stedu for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
438c3bf3550Sjsing if (ui->meth->ui_write_string &&
439c3bf3550Sjsing !ui->meth->ui_write_string(ui,
440764af611Stedu sk_UI_STRING_value(ui->strings, i))) {
441da347917Sbeck ok = -1;
442da347917Sbeck goto err;
443da347917Sbeck }
444da347917Sbeck }
445da347917Sbeck
446da347917Sbeck if (ui->meth->ui_flush)
447764af611Stedu switch (ui->meth->ui_flush(ui)) {
448da347917Sbeck case -1: /* Interrupt/Cancel/something... */
449da347917Sbeck ok = -2;
450da347917Sbeck goto err;
451da347917Sbeck case 0: /* Errors */
452da347917Sbeck ok = -1;
453da347917Sbeck goto err;
454da347917Sbeck default: /* Success */
455da347917Sbeck ok = 0;
456da347917Sbeck break;
457da347917Sbeck }
458da347917Sbeck
459764af611Stedu for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
460764af611Stedu if (ui->meth->ui_read_string) {
461da347917Sbeck switch (ui->meth->ui_read_string(ui,
462764af611Stedu sk_UI_STRING_value(ui->strings, i))) {
463da347917Sbeck case -1: /* Interrupt/Cancel/something... */
464b549695bStedu ui->flags &= ~UI_FLAG_REDOABLE;
465da347917Sbeck ok = -2;
466da347917Sbeck goto err;
467da347917Sbeck case 0: /* Errors */
468da347917Sbeck ok = -1;
469da347917Sbeck goto err;
470da347917Sbeck default: /* Success */
471da347917Sbeck ok = 0;
472da347917Sbeck break;
473da347917Sbeck }
474da347917Sbeck }
475da347917Sbeck }
476ba586daeSjsing
477da347917Sbeck err:
478da347917Sbeck if (ui->meth->ui_close_session && !ui->meth->ui_close_session(ui))
479da347917Sbeck return -1;
480da347917Sbeck return ok;
481da347917Sbeck }
482*cedac418Stb LCRYPTO_ALIAS(UI_process);
483da347917Sbeck
484764af611Stedu int
UI_ctrl(UI * ui,int cmd,long i,void * p,void (* f)(void))485764af611Stedu UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void))
486da347917Sbeck {
487764af611Stedu if (ui == NULL) {
4885067ae9fSbeck UIerror(ERR_R_PASSED_NULL_PARAMETER);
489da347917Sbeck return -1;
490da347917Sbeck }
491bcc93ea7Sjsing
492764af611Stedu switch (cmd) {
493da347917Sbeck case UI_CTRL_PRINT_ERRORS:
494da347917Sbeck {
495da347917Sbeck int save_flag = !!(ui->flags & UI_FLAG_PRINT_ERRORS);
496da347917Sbeck if (i)
497da347917Sbeck ui->flags |= UI_FLAG_PRINT_ERRORS;
498da347917Sbeck else
499da347917Sbeck ui->flags &= ~UI_FLAG_PRINT_ERRORS;
500da347917Sbeck return save_flag;
501da347917Sbeck }
502da347917Sbeck case UI_CTRL_IS_REDOABLE:
503da347917Sbeck return !!(ui->flags & UI_FLAG_REDOABLE);
504da347917Sbeck default:
505da347917Sbeck break;
506da347917Sbeck }
5075067ae9fSbeck UIerror(UI_R_UNKNOWN_CONTROL_COMMAND);
508da347917Sbeck return -1;
509da347917Sbeck }
510*cedac418Stb LCRYPTO_ALIAS(UI_ctrl);
511da347917Sbeck
512764af611Stedu int
UI_get_ex_new_index(long argl,void * argp,CRYPTO_EX_new * new_func,CRYPTO_EX_dup * dup_func,CRYPTO_EX_free * free_func)513764af611Stedu UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
514da347917Sbeck CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func)
515da347917Sbeck {
516da347917Sbeck return CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI, argl, argp,
517da347917Sbeck new_func, dup_func, free_func);
518da347917Sbeck }
519*cedac418Stb LCRYPTO_ALIAS(UI_get_ex_new_index);
520da347917Sbeck
521764af611Stedu int
UI_set_ex_data(UI * r,int idx,void * arg)522764af611Stedu UI_set_ex_data(UI *r, int idx, void *arg)
523da347917Sbeck {
524da347917Sbeck return (CRYPTO_set_ex_data(&r->ex_data, idx, arg));
525da347917Sbeck }
526*cedac418Stb LCRYPTO_ALIAS(UI_set_ex_data);
527da347917Sbeck
528764af611Stedu void *
UI_get_ex_data(UI * r,int idx)529764af611Stedu UI_get_ex_data(UI *r, int idx)
530da347917Sbeck {
531da347917Sbeck return (CRYPTO_get_ex_data(&r->ex_data, idx));
532da347917Sbeck }
533*cedac418Stb LCRYPTO_ALIAS(UI_get_ex_data);
534da347917Sbeck
535764af611Stedu void
UI_set_default_method(const UI_METHOD * method)536bcc93ea7Sjsing UI_set_default_method(const UI_METHOD *method)
537da347917Sbeck {
538bcc93ea7Sjsing default_UI_meth = method;
539da347917Sbeck }
540*cedac418Stb LCRYPTO_ALIAS(UI_set_default_method);
541da347917Sbeck
542764af611Stedu const UI_METHOD *
UI_get_default_method(void)543764af611Stedu UI_get_default_method(void)
544da347917Sbeck {
545bcc93ea7Sjsing if (default_UI_meth == NULL)
546da347917Sbeck default_UI_meth = UI_OpenSSL();
547bcc93ea7Sjsing
548da347917Sbeck return default_UI_meth;
549da347917Sbeck }
550*cedac418Stb LCRYPTO_ALIAS(UI_get_default_method);
551da347917Sbeck
552764af611Stedu const UI_METHOD *
UI_get_method(UI * ui)553764af611Stedu UI_get_method(UI *ui)
554da347917Sbeck {
555da347917Sbeck return ui->meth;
556da347917Sbeck }
557*cedac418Stb LCRYPTO_ALIAS(UI_get_method);
558da347917Sbeck
559764af611Stedu const UI_METHOD *
UI_set_method(UI * ui,const UI_METHOD * method)560bcc93ea7Sjsing UI_set_method(UI *ui, const UI_METHOD *method)
561da347917Sbeck {
562bcc93ea7Sjsing ui->meth = method;
563bcc93ea7Sjsing
564da347917Sbeck return ui->meth;
565da347917Sbeck }
566*cedac418Stb LCRYPTO_ALIAS(UI_set_method);
567da347917Sbeck
568764af611Stedu UI_METHOD *
UI_create_method(const char * name)569b6108fceStb UI_create_method(const char *name)
570da347917Sbeck {
5717218a23dSjsing UI_METHOD *method = NULL;
572da347917Sbeck
5737218a23dSjsing if ((method = calloc(1, sizeof(UI_METHOD))) == NULL)
5747218a23dSjsing goto err;
57566415b63Stedu
5767218a23dSjsing if (name != NULL) {
5777218a23dSjsing if ((method->name = strdup(name)) == NULL)
5787218a23dSjsing goto err;
5797218a23dSjsing }
5807218a23dSjsing
5817218a23dSjsing return method;
5827218a23dSjsing
5837218a23dSjsing err:
5847218a23dSjsing UI_destroy_method(method);
5857218a23dSjsing
5867218a23dSjsing return NULL;
587da347917Sbeck }
588*cedac418Stb LCRYPTO_ALIAS(UI_create_method);
589da347917Sbeck
590764af611Stedu void
UI_destroy_method(UI_METHOD * method)591d533e99eSjsing UI_destroy_method(UI_METHOD *method)
592da347917Sbeck {
593d533e99eSjsing if (method == NULL)
594d533e99eSjsing return;
595d533e99eSjsing
596d533e99eSjsing free(method->name);
597d533e99eSjsing free(method);
598da347917Sbeck }
599*cedac418Stb LCRYPTO_ALIAS(UI_destroy_method);
600da347917Sbeck
601764af611Stedu int
UI_method_set_opener(UI_METHOD * method,int (* opener)(UI * ui))602764af611Stedu UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui))
603da347917Sbeck {
604bcc93ea7Sjsing if (method == NULL)
605da347917Sbeck return -1;
606bcc93ea7Sjsing
607bcc93ea7Sjsing method->ui_open_session = opener;
608bcc93ea7Sjsing
609bcc93ea7Sjsing return 0;
610da347917Sbeck }
611*cedac418Stb LCRYPTO_ALIAS(UI_method_set_opener);
612da347917Sbeck
613764af611Stedu int
UI_method_set_writer(UI_METHOD * method,int (* writer)(UI * ui,UI_STRING * uis))614764af611Stedu UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis))
615da347917Sbeck {
616bcc93ea7Sjsing if (method == NULL)
617da347917Sbeck return -1;
618bcc93ea7Sjsing
619bcc93ea7Sjsing method->ui_write_string = writer;
620bcc93ea7Sjsing
621bcc93ea7Sjsing return 0;
622da347917Sbeck }
623*cedac418Stb LCRYPTO_ALIAS(UI_method_set_writer);
624da347917Sbeck
625764af611Stedu int
UI_method_set_flusher(UI_METHOD * method,int (* flusher)(UI * ui))626764af611Stedu UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui))
627da347917Sbeck {
628bcc93ea7Sjsing if (method == NULL)
629da347917Sbeck return -1;
630bcc93ea7Sjsing
631bcc93ea7Sjsing method->ui_flush = flusher;
632bcc93ea7Sjsing
633bcc93ea7Sjsing return 0;
634da347917Sbeck }
635*cedac418Stb LCRYPTO_ALIAS(UI_method_set_flusher);
636da347917Sbeck
637764af611Stedu int
UI_method_set_reader(UI_METHOD * method,int (* reader)(UI * ui,UI_STRING * uis))638764af611Stedu UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis))
639da347917Sbeck {
640bcc93ea7Sjsing if (method == NULL)
641da347917Sbeck return -1;
642bcc93ea7Sjsing
643bcc93ea7Sjsing method->ui_read_string = reader;
644bcc93ea7Sjsing
645bcc93ea7Sjsing return 0;
646da347917Sbeck }
647*cedac418Stb LCRYPTO_ALIAS(UI_method_set_reader);
648da347917Sbeck
649764af611Stedu int
UI_method_set_closer(UI_METHOD * method,int (* closer)(UI * ui))650764af611Stedu UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui))
651da347917Sbeck {
652bcc93ea7Sjsing if (method == NULL)
653da347917Sbeck return -1;
654bcc93ea7Sjsing
655bcc93ea7Sjsing method->ui_close_session = closer;
656bcc93ea7Sjsing
657bcc93ea7Sjsing return 0;
658da347917Sbeck }
659*cedac418Stb LCRYPTO_ALIAS(UI_method_set_closer);
660da347917Sbeck
661764af611Stedu int
UI_method_set_prompt_constructor(UI_METHOD * method,char * (* prompt_constructor)(UI * ui,const char * object_desc,const char * object_name))662c3bf3550Sjsing UI_method_set_prompt_constructor(UI_METHOD *method,
663c3bf3550Sjsing char *(*prompt_constructor)(UI *ui, const char *object_desc,
664c3bf3550Sjsing const char *object_name))
6650a5d6edeSdjm {
666bcc93ea7Sjsing if (method == NULL)
6670a5d6edeSdjm return -1;
668bcc93ea7Sjsing
669bcc93ea7Sjsing method->ui_construct_prompt = prompt_constructor;
670bcc93ea7Sjsing
671bcc93ea7Sjsing return 0;
6720a5d6edeSdjm }
673*cedac418Stb LCRYPTO_ALIAS(UI_method_set_prompt_constructor);
6740a5d6edeSdjm
675c3bf3550Sjsing int
UI_method_get_opener(const UI_METHOD * method)676a3cf9474Stb (*UI_method_get_opener(const UI_METHOD * method))(UI *)
677da347917Sbeck {
678bcc93ea7Sjsing if (method == NULL)
679da347917Sbeck return NULL;
680bcc93ea7Sjsing
681bcc93ea7Sjsing return method->ui_open_session;
682da347917Sbeck }
683*cedac418Stb LCRYPTO_ALIAS(UI_method_get_opener);
684da347917Sbeck
685c3bf3550Sjsing int
UI_method_get_writer(const UI_METHOD * method)686a3cf9474Stb (*UI_method_get_writer(const UI_METHOD *method))(UI *, UI_STRING *)
687da347917Sbeck {
688bcc93ea7Sjsing if (method == NULL)
689da347917Sbeck return NULL;
690bcc93ea7Sjsing
691bcc93ea7Sjsing return method->ui_write_string;
692da347917Sbeck }
693*cedac418Stb LCRYPTO_ALIAS(UI_method_get_writer);
694da347917Sbeck
695c3bf3550Sjsing int
UI_method_get_flusher(const UI_METHOD * method)696a3cf9474Stb (*UI_method_get_flusher(const UI_METHOD *method)) (UI *)
697da347917Sbeck {
698bcc93ea7Sjsing if (method == NULL)
699da347917Sbeck return NULL;
700bcc93ea7Sjsing
701bcc93ea7Sjsing return method->ui_flush;
702da347917Sbeck }
703*cedac418Stb LCRYPTO_ALIAS(UI_method_get_flusher);
704da347917Sbeck
705c3bf3550Sjsing int
UI_method_get_reader(const UI_METHOD * method)706a3cf9474Stb (*UI_method_get_reader(const UI_METHOD *method))(UI *, UI_STRING *)
707da347917Sbeck {
708bcc93ea7Sjsing if (method == NULL)
709da347917Sbeck return NULL;
710bcc93ea7Sjsing
711bcc93ea7Sjsing return method->ui_read_string;
712da347917Sbeck }
713*cedac418Stb LCRYPTO_ALIAS(UI_method_get_reader);
714da347917Sbeck
715c3bf3550Sjsing int
UI_method_get_closer(const UI_METHOD * method)716a3cf9474Stb (*UI_method_get_closer(const UI_METHOD *method))(UI *)
717da347917Sbeck {
718bcc93ea7Sjsing if (method == NULL)
719da347917Sbeck return NULL;
720bcc93ea7Sjsing
721bcc93ea7Sjsing return method->ui_close_session;
722da347917Sbeck }
723*cedac418Stb LCRYPTO_ALIAS(UI_method_get_closer);
724da347917Sbeck
725c3bf3550Sjsing char *
UI_method_get_prompt_constructor(const UI_METHOD * method)726a3cf9474Stb (*UI_method_get_prompt_constructor(const UI_METHOD *method))(UI *, const char *,
727c3bf3550Sjsing const char *)
7280a5d6edeSdjm {
729bcc93ea7Sjsing if (method == NULL)
7300a5d6edeSdjm return NULL;
731bcc93ea7Sjsing
732bcc93ea7Sjsing return method->ui_construct_prompt;
7330a5d6edeSdjm }
734*cedac418Stb LCRYPTO_ALIAS(UI_method_get_prompt_constructor);
7350a5d6edeSdjm
736764af611Stedu enum UI_string_types
UI_get_string_type(UI_STRING * uis)737764af611Stedu UI_get_string_type(UI_STRING *uis)
738da347917Sbeck {
739bcc93ea7Sjsing if (uis == NULL)
740da347917Sbeck return UIT_NONE;
741bcc93ea7Sjsing
742da347917Sbeck return uis->type;
743da347917Sbeck }
744*cedac418Stb LCRYPTO_ALIAS(UI_get_string_type);
745da347917Sbeck
746764af611Stedu int
UI_get_input_flags(UI_STRING * uis)747764af611Stedu UI_get_input_flags(UI_STRING *uis)
748da347917Sbeck {
749bcc93ea7Sjsing if (uis == NULL)
750da347917Sbeck return 0;
751bcc93ea7Sjsing
752da347917Sbeck return uis->input_flags;
753da347917Sbeck }
754*cedac418Stb LCRYPTO_ALIAS(UI_get_input_flags);
755da347917Sbeck
756764af611Stedu const char *
UI_get0_output_string(UI_STRING * uis)757764af611Stedu UI_get0_output_string(UI_STRING *uis)
758da347917Sbeck {
759bcc93ea7Sjsing if (uis == NULL)
760da347917Sbeck return NULL;
761bcc93ea7Sjsing
762da347917Sbeck return uis->out_string;
763da347917Sbeck }
764*cedac418Stb LCRYPTO_ALIAS(UI_get0_output_string);
765da347917Sbeck
766764af611Stedu const char *
UI_get0_action_string(UI_STRING * uis)767764af611Stedu UI_get0_action_string(UI_STRING *uis)
768da347917Sbeck {
769bcc93ea7Sjsing if (uis == NULL)
770da347917Sbeck return NULL;
771bcc93ea7Sjsing
772764af611Stedu switch (uis->type) {
773da347917Sbeck case UIT_PROMPT:
774da347917Sbeck case UIT_BOOLEAN:
775da347917Sbeck return uis->_.boolean_data.action_desc;
776da347917Sbeck default:
777da347917Sbeck return NULL;
778da347917Sbeck }
779da347917Sbeck }
780*cedac418Stb LCRYPTO_ALIAS(UI_get0_action_string);
781da347917Sbeck
782764af611Stedu const char *
UI_get0_result_string(UI_STRING * uis)783764af611Stedu UI_get0_result_string(UI_STRING *uis)
784da347917Sbeck {
785bcc93ea7Sjsing if (uis == NULL)
786da347917Sbeck return NULL;
787bcc93ea7Sjsing
788764af611Stedu switch (uis->type) {
789da347917Sbeck case UIT_PROMPT:
790da347917Sbeck case UIT_VERIFY:
791da347917Sbeck return uis->result_buf;
792da347917Sbeck default:
793da347917Sbeck return NULL;
794da347917Sbeck }
795da347917Sbeck }
796*cedac418Stb LCRYPTO_ALIAS(UI_get0_result_string);
797da347917Sbeck
798764af611Stedu const char *
UI_get0_test_string(UI_STRING * uis)799764af611Stedu UI_get0_test_string(UI_STRING *uis)
800da347917Sbeck {
801bcc93ea7Sjsing if (uis == NULL)
802da347917Sbeck return NULL;
803bcc93ea7Sjsing
804764af611Stedu switch (uis->type) {
805da347917Sbeck case UIT_VERIFY:
806da347917Sbeck return uis->_.string_data.test_buf;
807da347917Sbeck default:
808da347917Sbeck return NULL;
809da347917Sbeck }
810da347917Sbeck }
811*cedac418Stb LCRYPTO_ALIAS(UI_get0_test_string);
812da347917Sbeck
813764af611Stedu int
UI_get_result_minsize(UI_STRING * uis)814764af611Stedu UI_get_result_minsize(UI_STRING *uis)
815da347917Sbeck {
816bcc93ea7Sjsing if (uis == NULL)
817da347917Sbeck return -1;
818bcc93ea7Sjsing
819764af611Stedu switch (uis->type) {
820da347917Sbeck case UIT_PROMPT:
821da347917Sbeck case UIT_VERIFY:
822da347917Sbeck return uis->_.string_data.result_minsize;
823da347917Sbeck default:
824da347917Sbeck return -1;
825da347917Sbeck }
826da347917Sbeck }
827*cedac418Stb LCRYPTO_ALIAS(UI_get_result_minsize);
828da347917Sbeck
829764af611Stedu int
UI_get_result_maxsize(UI_STRING * uis)830764af611Stedu UI_get_result_maxsize(UI_STRING *uis)
831da347917Sbeck {
832bcc93ea7Sjsing if (uis == NULL)
833da347917Sbeck return -1;
834bcc93ea7Sjsing
835764af611Stedu switch (uis->type) {
836da347917Sbeck case UIT_PROMPT:
837da347917Sbeck case UIT_VERIFY:
838da347917Sbeck return uis->_.string_data.result_maxsize;
839da347917Sbeck default:
840da347917Sbeck return -1;
841da347917Sbeck }
842da347917Sbeck }
843*cedac418Stb LCRYPTO_ALIAS(UI_get_result_maxsize);
844da347917Sbeck
845764af611Stedu int
UI_set_result(UI * ui,UI_STRING * uis,const char * result)846764af611Stedu UI_set_result(UI *ui, UI_STRING *uis, const char *result)
847da347917Sbeck {
8487f00cb0dStb const char *p;
849da347917Sbeck int l = strlen(result);
850da347917Sbeck
851da347917Sbeck ui->flags &= ~UI_FLAG_REDOABLE;
852da347917Sbeck
853bcc93ea7Sjsing if (uis == NULL)
854da347917Sbeck return -1;
855bcc93ea7Sjsing
856764af611Stedu switch (uis->type) {
857da347917Sbeck case UIT_PROMPT:
858da347917Sbeck case UIT_VERIFY:
859764af611Stedu if (l < uis->_.string_data.result_minsize) {
860da347917Sbeck ui->flags |= UI_FLAG_REDOABLE;
8615067ae9fSbeck UIerror(UI_R_RESULT_TOO_SMALL);
8620f637b92Sbeck ERR_asprintf_error_data
8630f637b92Sbeck ("You must type in %d to %d characters",
8640f637b92Sbeck uis->_.string_data.result_minsize,
8650f637b92Sbeck uis->_.string_data.result_maxsize);
866da347917Sbeck return -1;
867da347917Sbeck }
868764af611Stedu if (l > uis->_.string_data.result_maxsize) {
869da347917Sbeck ui->flags |= UI_FLAG_REDOABLE;
8705067ae9fSbeck UIerror(UI_R_RESULT_TOO_LARGE);
8710f637b92Sbeck ERR_asprintf_error_data
8720f637b92Sbeck ("You must type in %d to %d characters",
8730f637b92Sbeck uis->_.string_data.result_minsize,
8740f637b92Sbeck uis->_.string_data.result_maxsize);
875da347917Sbeck return -1;
876da347917Sbeck }
877764af611Stedu if (!uis->result_buf) {
8785067ae9fSbeck UIerror(UI_R_NO_RESULT_BUFFER);
879da347917Sbeck return -1;
880da347917Sbeck }
881143cedbbSbeck strlcpy(uis->result_buf, result,
882c52d3e9eSho uis->_.string_data.result_maxsize + 1);
883da347917Sbeck break;
884da347917Sbeck case UIT_BOOLEAN:
885764af611Stedu if (!uis->result_buf) {
8865067ae9fSbeck UIerror(UI_R_NO_RESULT_BUFFER);
887da347917Sbeck return -1;
888da347917Sbeck }
889da347917Sbeck uis->result_buf[0] = '\0';
890764af611Stedu for (p = result; *p; p++) {
891764af611Stedu if (strchr(uis->_.boolean_data.ok_chars, *p)) {
892da347917Sbeck uis->result_buf[0] =
893da347917Sbeck uis->_.boolean_data.ok_chars[0];
894da347917Sbeck break;
895da347917Sbeck }
896764af611Stedu if (strchr(uis->_.boolean_data.cancel_chars, *p)) {
897da347917Sbeck uis->result_buf[0] =
898da347917Sbeck uis->_.boolean_data.cancel_chars[0];
899da347917Sbeck break;
900da347917Sbeck }
901da347917Sbeck }
902da347917Sbeck default:
903da347917Sbeck break;
904da347917Sbeck }
905da347917Sbeck return 0;
906da347917Sbeck }
907*cedac418Stb LCRYPTO_ALIAS(UI_set_result);
908