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