1 /*
2 * Copyright 2002-2022 The OpenSSL Project Authors. All Rights Reserved.
3 *
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
8 */
9
10 #include <string.h>
11 #include <openssl/pem.h> /* PEM_def_callback() */
12 #include "internal/thread_once.h"
13 #include "ui_local.h"
14
15 #ifndef BUFSIZ
16 #define BUFSIZ 256
17 #endif
18
UI_UTIL_read_pw_string(char * buf,int length,const char * prompt,int verify)19 int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
20 int verify)
21 {
22 char buff[BUFSIZ];
23 int ret;
24
25 ret =
26 UI_UTIL_read_pw(buf, buff, (length > BUFSIZ) ? BUFSIZ : length,
27 prompt, verify);
28 OPENSSL_cleanse(buff, BUFSIZ);
29 return ret;
30 }
31
UI_UTIL_read_pw(char * buf,char * buff,int size,const char * prompt,int verify)32 int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
33 int verify)
34 {
35 int ok = 0;
36 UI *ui;
37
38 if (size < 1)
39 return -1;
40
41 ui = UI_new();
42 if (ui != NULL) {
43 ok = UI_add_input_string(ui, prompt, 0, buf, 0, size - 1);
44 if (ok >= 0 && verify)
45 ok = UI_add_verify_string(ui, prompt, 0, buff, 0, size - 1, buf);
46 if (ok >= 0)
47 ok = UI_process(ui);
48 UI_free(ui);
49 }
50 if (ok > 0)
51 ok = 0;
52 return ok;
53 }
54
55 /*
56 * Wrapper around pem_password_cb, a method to help older APIs use newer
57 * ones.
58 */
59 struct pem_password_cb_data {
60 pem_password_cb *cb;
61 int rwflag;
62 };
63
ui_new_method_data(void * parent,void * ptr,CRYPTO_EX_DATA * ad,int idx,long argl,void * argp)64 static void ui_new_method_data(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
65 int idx, long argl, void *argp)
66 {
67 /*
68 * Do nothing, the data is allocated externally and assigned later with
69 * CRYPTO_set_ex_data()
70 */
71 }
72
ui_dup_method_data(CRYPTO_EX_DATA * to,const CRYPTO_EX_DATA * from,void ** pptr,int idx,long argl,void * argp)73 static int ui_dup_method_data(CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
74 void **pptr, int idx, long argl, void *argp)
75 {
76 if (*pptr != NULL) {
77 *pptr = OPENSSL_memdup(*pptr, sizeof(struct pem_password_cb_data));
78 if (*pptr != NULL)
79 return 1;
80 }
81 return 0;
82 }
83
ui_free_method_data(void * parent,void * ptr,CRYPTO_EX_DATA * ad,int idx,long argl,void * argp)84 static void ui_free_method_data(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
85 int idx, long argl, void *argp)
86 {
87 OPENSSL_free(ptr);
88 }
89
90 static CRYPTO_ONCE get_index_once = CRYPTO_ONCE_STATIC_INIT;
91 static int ui_method_data_index = -1;
DEFINE_RUN_ONCE_STATIC(ui_method_data_index_init)92 DEFINE_RUN_ONCE_STATIC(ui_method_data_index_init)
93 {
94 ui_method_data_index = CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_UI_METHOD,
95 0, NULL, ui_new_method_data,
96 ui_dup_method_data,
97 ui_free_method_data);
98 return 1;
99 }
100
ui_open(UI * ui)101 static int ui_open(UI *ui)
102 {
103 return 1;
104 }
ui_read(UI * ui,UI_STRING * uis)105 static int ui_read(UI *ui, UI_STRING *uis)
106 {
107 switch (UI_get_string_type(uis)) {
108 case UIT_PROMPT:
109 {
110 char result[PEM_BUFSIZE + 1];
111 const struct pem_password_cb_data *data =
112 UI_method_get_ex_data(UI_get_method(ui), ui_method_data_index);
113 int maxsize = UI_get_result_maxsize(uis);
114 int len = data->cb(result,
115 maxsize > PEM_BUFSIZE ? PEM_BUFSIZE : maxsize,
116 data->rwflag, UI_get0_user_data(ui));
117
118 if (len >= 0)
119 result[len] = '\0';
120 if (len < 0)
121 return len;
122 if (UI_set_result_ex(ui, uis, result, len) >= 0)
123 return 1;
124 return 0;
125 }
126 case UIT_VERIFY:
127 case UIT_NONE:
128 case UIT_BOOLEAN:
129 case UIT_INFO:
130 case UIT_ERROR:
131 break;
132 }
133 return 1;
134 }
ui_write(UI * ui,UI_STRING * uis)135 static int ui_write(UI *ui, UI_STRING *uis)
136 {
137 return 1;
138 }
ui_close(UI * ui)139 static int ui_close(UI *ui)
140 {
141 return 1;
142 }
143
UI_UTIL_wrap_read_pem_callback(pem_password_cb * cb,int rwflag)144 UI_METHOD *UI_UTIL_wrap_read_pem_callback(pem_password_cb *cb, int rwflag)
145 {
146 struct pem_password_cb_data *data = NULL;
147 UI_METHOD *ui_method = NULL;
148
149 if ((data = OPENSSL_zalloc(sizeof(*data))) == NULL
150 || (ui_method = UI_create_method("PEM password callback wrapper")) == NULL
151 || UI_method_set_opener(ui_method, ui_open) < 0
152 || UI_method_set_reader(ui_method, ui_read) < 0
153 || UI_method_set_writer(ui_method, ui_write) < 0
154 || UI_method_set_closer(ui_method, ui_close) < 0
155 || !RUN_ONCE(&get_index_once, ui_method_data_index_init)
156 || !UI_method_set_ex_data(ui_method, ui_method_data_index, data)) {
157 UI_destroy_method(ui_method);
158 OPENSSL_free(data);
159 return NULL;
160 }
161 data->rwflag = rwflag;
162 data->cb = cb != NULL ? cb : PEM_def_callback;
163
164 return ui_method;
165 }
166
