ui.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  1. /* $OpenBSD: ui.h,v 1.18 2023/04/18 08:33:43 tb Exp $ */
  2. /* Written by Richard Levitte ([email protected]) for the OpenSSL
  3. * project 2001.
  4. */
  5. /* ====================================================================
  6. * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  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
  18. * distribution.
  19. *
  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/)"
  24. *
  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. * [email protected].
  29. *
  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.
  33. *
  34. * 6. Redistributions of any form whatsoever must retain the following
  35. * acknowledgment:
  36. * "This product includes software developed by the OpenSSL Project
  37. * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38. *
  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. * ====================================================================
  52. *
  53. * This product includes cryptographic software written by Eric Young
  54. * ([email protected]). This product includes software written by Tim
  55. * Hudson ([email protected]).
  56. *
  57. */
  58. #ifndef HEADER_UI_H
  59. #define HEADER_UI_H
  60. #include <openssl/opensslconf.h>
  61. #include <openssl/crypto.h>
  62. #include <openssl/safestack.h>
  63. #include <openssl/ossl_typ.h>
  64. #ifdef __cplusplus
  65. extern "C" {
  66. #endif
  67. /* Declared already in ossl_typ.h */
  68. /* typedef struct ui_st UI; */
  69. /* typedef struct ui_method_st UI_METHOD; */
  70. /*
  71. * All the following functions return -1 or NULL on error and in some cases
  72. * (UI_process()) -2 if interrupted or in some other way cancelled.
  73. * When everything is fine, they return 0, a positive value or a non-NULL
  74. * pointer, all depending on their purpose.
  75. */
  76. /* Creators and destructor. */
  77. UI *UI_new(void);
  78. UI *UI_new_method(const UI_METHOD *method);
  79. void UI_free(UI *ui);
  80. /*
  81. * The following functions are used to add strings to be printed and prompt
  82. * strings to prompt for data. The names are UI_{add,dup}_<function>_string
  83. * and UI_{add,dup}_input_boolean.
  84. *
  85. * UI_{add,dup}_<function>_string have the following meanings:
  86. * add add a text or prompt string. The pointers given to these
  87. * functions are used verbatim, no copying is done.
  88. * dup make a copy of the text or prompt string, then add the copy
  89. * to the collection of strings in the user interface.
  90. * <function>
  91. * The function is a name for the functionality that the given
  92. * string shall be used for. It can be one of:
  93. * input use the string as data prompt.
  94. * verify use the string as verification prompt. This
  95. * is used to verify a previous input.
  96. * info use the string for informational output.
  97. * error use the string for error output.
  98. * Honestly, there's currently no difference between info and error for the
  99. * moment.
  100. *
  101. * UI_{add,dup}_input_boolean have the same semantics for "add" and "dup",
  102. * and are typically used when one wants to prompt for a yes/no response.
  103. *
  104. * All of the functions in this group take a UI and a prompt string.
  105. * The string input and verify addition functions also take a flag argument,
  106. * a buffer for the result to end up in, a minimum input size and a maximum
  107. * input size (the result buffer MUST be large enough to be able to contain
  108. * the maximum number of characters). Additionally, the verify addition
  109. * functions takes another buffer to compare the result against.
  110. * The boolean input functions take an action description string (which should
  111. * be safe to ignore if the expected user action is obvious, for example with
  112. * a dialog box with an OK button and a Cancel button), a string of acceptable
  113. * characters to mean OK and to mean Cancel. The two last strings are checked
  114. * to make sure they don't have common characters. Additionally, the same
  115. * flag argument as for the string input is taken, as well as a result buffer.
  116. * The result buffer is required to be at least one byte long. Depending on
  117. * the answer, the first character from the OK or the Cancel character strings
  118. * will be stored in the first byte of the result buffer. No NUL will be
  119. * added, so the result is *not* a string.
  120. *
  121. * On success, the functions all return an index of the added information.
  122. * That index is useful when retrieving results with UI_get0_result().
  123. */
  124. int UI_add_input_string(UI *ui, const char *prompt, int flags,
  125. char *result_buf, int minsize, int maxsize);
  126. int UI_dup_input_string(UI *ui, const char *prompt, int flags,
  127. char *result_buf, int minsize, int maxsize);
  128. int UI_add_verify_string(UI *ui, const char *prompt, int flags,
  129. char *result_buf, int minsize, int maxsize, const char *test_buf);
  130. int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
  131. char *result_buf, int minsize, int maxsize, const char *test_buf);
  132. int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  133. const char *ok_chars, const char *cancel_chars,
  134. int flags, char *result_buf);
  135. int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  136. const char *ok_chars, const char *cancel_chars,
  137. int flags, char *result_buf);
  138. int UI_add_info_string(UI *ui, const char *text);
  139. int UI_dup_info_string(UI *ui, const char *text);
  140. int UI_add_error_string(UI *ui, const char *text);
  141. int UI_dup_error_string(UI *ui, const char *text);
  142. /* These are the possible flags. They can be or'ed together. */
  143. /* Use to have echoing of input */
  144. #define UI_INPUT_FLAG_ECHO 0x01
  145. /*
  146. * Use a default password. Where that password is found is completely
  147. * up to the application, it might for example be in the user data set
  148. * with UI_add_user_data(). It is not recommended to have more than
  149. * one input in each UI being marked with this flag, or the application
  150. * might get confused.
  151. */
  152. #define UI_INPUT_FLAG_DEFAULT_PWD 0x02
  153. /*
  154. * Users of these routines may want to define flags of their own. The core
  155. * UI won't look at those, but will pass them on to the method routines. They
  156. * must use higher bits so they don't get confused with the UI bits above.
  157. * UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use. A good
  158. * example of use is this:
  159. *
  160. * #define MY_UI_FLAG1 (0x01 << UI_INPUT_FLAG_USER_BASE)
  161. */
  162. #define UI_INPUT_FLAG_USER_BASE 16
  163. /*
  164. * The following function helps construct a prompt. object_desc is a
  165. * textual short description of the object, for example "pass phrase",
  166. * and object_name is the name of the object (might be a card name or
  167. * a file name.
  168. * The returned string shall always be allocated on the heap with
  169. * malloc(), and need to be free'd with free().
  170. *
  171. * If the ui_method doesn't contain a pointer to a user-defined prompt
  172. * constructor, a default string is built, looking like this:
  173. *
  174. * "Enter {object_desc} for {object_name}:"
  175. *
  176. * So, if object_desc has the value "pass phrase" and object_name has
  177. * the value "foo.key", the resulting string is:
  178. *
  179. * "Enter pass phrase for foo.key:"
  180. */
  181. char *UI_construct_prompt(UI *ui_method, const char *object_desc,
  182. const char *object_name);
  183. /*
  184. * The following function is used to store a pointer to user-specific data.
  185. * Any previous such pointer will be returned and replaced.
  186. *
  187. * For callback purposes, this function makes a lot more sense than using
  188. * ex_data, since the latter requires that different parts of OpenSSL or
  189. * applications share the same ex_data index.
  190. *
  191. * Note that the UI_OpenSSL() method completely ignores the user data.
  192. * Other methods may not, however.
  193. */
  194. void *UI_add_user_data(UI *ui, void *user_data);
  195. /* We need a user data retrieving function as well. */
  196. void *UI_get0_user_data(UI *ui);
  197. /* Return the result associated with a prompt given with the index i. */
  198. const char *UI_get0_result(UI *ui, int i);
  199. /* When all strings have been added, process the whole thing. */
  200. int UI_process(UI *ui);
  201. /*
  202. * Give a user interface parametrised control commands. This can be used to
  203. * send down an integer, a data pointer or a function pointer, as well as
  204. * be used to get information from a UI.
  205. */
  206. int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)(void));
  207. /* The commands */
  208. /*
  209. * Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the
  210. * OpenSSL error stack before printing any info or added error messages and
  211. * before any prompting.
  212. */
  213. #define UI_CTRL_PRINT_ERRORS 1
  214. /*
  215. * Check if a UI_process() is possible to do again with the same instance of
  216. * a user interface. This makes UI_ctrl() return 1 if it is redoable, and 0
  217. * if not.
  218. */
  219. #define UI_CTRL_IS_REDOABLE 2
  220. /* Some methods may use extra data */
  221. #define UI_set_app_data(s,arg) UI_set_ex_data(s,0,arg)
  222. #define UI_get_app_data(s) UI_get_ex_data(s,0)
  223. int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
  224. CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
  225. int UI_set_ex_data(UI *r, int idx, void *arg);
  226. void *UI_get_ex_data(UI *r, int idx);
  227. /* Use specific methods instead of the built-in one */
  228. void UI_set_default_method(const UI_METHOD *meth);
  229. const UI_METHOD *UI_get_default_method(void);
  230. const UI_METHOD *UI_get_method(UI *ui);
  231. const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
  232. /* The method with all the built-in thingies */
  233. UI_METHOD *UI_OpenSSL(void);
  234. const UI_METHOD *UI_null(void);
  235. /*
  236. * ---------- For method writers ----------
  237. * A method contains a number of functions that implement the low level
  238. * of the User Interface. The functions are:
  239. *
  240. * an opener This function starts a session, maybe by opening
  241. * a channel to a tty, or by opening a window.
  242. * a writer This function is called to write a given string,
  243. * maybe to the tty, maybe as a field label in a
  244. * window.
  245. * a flusher This function is called to flush everything that
  246. * has been output so far. It can be used to actually
  247. * display a dialog box after it has been built.
  248. * a reader This function is called to read a given prompt,
  249. * maybe from the tty, maybe from a field in a
  250. * window. Note that it's called with all string
  251. * structures, not only the prompt ones, so it must
  252. * check such things itself.
  253. * a closer This function closes the session, maybe by closing
  254. * the channel to the tty, or closing the window.
  255. *
  256. * All these functions are expected to return:
  257. *
  258. * 0 on error.
  259. * 1 on success.
  260. * -1 on out-of-band events, for example if some prompting has
  261. * been canceled (by pressing Ctrl-C, for example). This is
  262. * only checked when returned by the flusher or the reader.
  263. *
  264. * The way this is used, the opener is first called, then the writer for all
  265. * strings, then the flusher, then the reader for all strings and finally the
  266. * closer. Note that if you want to prompt from a terminal or other command
  267. * line interface, the best is to have the reader also write the prompts
  268. * instead of having the writer do it. If you want to prompt from a dialog
  269. * box, the writer can be used to build up the contents of the box, and the
  270. * flusher to actually display the box and run the event loop until all data
  271. * has been given, after which the reader only grabs the given data and puts
  272. * them back into the UI strings.
  273. *
  274. * All method functions take a UI as argument. Additionally, the writer and
  275. * the reader take a UI_STRING.
  276. */
  277. /*
  278. * The UI_STRING type is the data structure that contains all the needed info
  279. * about a string or a prompt, including test data for a verification prompt.
  280. */
  281. typedef struct ui_string_st UI_STRING;
  282. DECLARE_STACK_OF(UI_STRING)
  283. /*
  284. * The different types of strings that are currently supported.
  285. * This is only needed by method authors.
  286. */
  287. enum UI_string_types {
  288. UIT_NONE = 0,
  289. UIT_PROMPT, /* Prompt for a string */
  290. UIT_VERIFY, /* Prompt for a string and verify */
  291. UIT_BOOLEAN, /* Prompt for a yes/no response */
  292. UIT_INFO, /* Send info to the user */
  293. UIT_ERROR /* Send an error message to the user */
  294. };
  295. /* Create and manipulate methods */
  296. UI_METHOD *UI_create_method(const char *name);
  297. void UI_destroy_method(UI_METHOD *ui_method);
  298. int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui));
  299. int UI_method_set_writer(UI_METHOD *method,
  300. int (*writer)(UI *ui, UI_STRING *uis));
  301. int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui));
  302. int UI_method_set_reader(UI_METHOD *method,
  303. int (*reader)(UI *ui, UI_STRING *uis));
  304. int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui));
  305. int UI_method_set_prompt_constructor(UI_METHOD *method,
  306. char *(*prompt_constructor)(UI *ui, const char *object_desc,
  307. const char *object_name));
  308. int (*UI_method_get_opener(const UI_METHOD *method))(UI *);
  309. int (*UI_method_get_writer(const UI_METHOD *method))(UI *, UI_STRING *);
  310. int (*UI_method_get_flusher(const UI_METHOD *method))(UI *);
  311. int (*UI_method_get_reader(const UI_METHOD *method))(UI *, UI_STRING *);
  312. int (*UI_method_get_closer(const UI_METHOD *method))(UI *);
  313. char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))(UI *,
  314. const char *, const char *);
  315. /*
  316. * The following functions are helpers for method writers to access relevant
  317. * data from a UI_STRING.
  318. */
  319. /* Return type of the UI_STRING */
  320. enum UI_string_types UI_get_string_type(UI_STRING *uis);
  321. /* Return input flags of the UI_STRING */
  322. int UI_get_input_flags(UI_STRING *uis);
  323. /* Return the actual string to output (the prompt, info or error) */
  324. const char *UI_get0_output_string(UI_STRING *uis);
  325. /* Return the optional action string to output (boolean prompt instruction) */
  326. const char *UI_get0_action_string(UI_STRING *uis);
  327. /* Return the result of a prompt */
  328. const char *UI_get0_result_string(UI_STRING *uis);
  329. /* Return the string to test the result against. Only useful with verifies. */
  330. const char *UI_get0_test_string(UI_STRING *uis);
  331. /* Return the required minimum size of the result */
  332. int UI_get_result_minsize(UI_STRING *uis);
  333. /* Return the required maximum size of the result */
  334. int UI_get_result_maxsize(UI_STRING *uis);
  335. /* Set the result of a UI_STRING. */
  336. int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
  337. /* A couple of popular utility functions */
  338. int UI_UTIL_read_pw_string(char *buf, int length, const char *prompt,
  339. int verify);
  340. int UI_UTIL_read_pw(char *buf, char *buff, int size, const char *prompt,
  341. int verify);
  342. void ERR_load_UI_strings(void);
  343. /* Error codes for the UI functions. */
  344. /* Function codes. */
  345. #define UI_F_GENERAL_ALLOCATE_BOOLEAN 108
  346. #define UI_F_GENERAL_ALLOCATE_PROMPT 109
  347. #define UI_F_GENERAL_ALLOCATE_STRING 100
  348. #define UI_F_UI_CTRL 111
  349. #define UI_F_UI_DUP_ERROR_STRING 101
  350. #define UI_F_UI_DUP_INFO_STRING 102
  351. #define UI_F_UI_DUP_INPUT_BOOLEAN 110
  352. #define UI_F_UI_DUP_INPUT_STRING 103
  353. #define UI_F_UI_DUP_VERIFY_STRING 106
  354. #define UI_F_UI_GET0_RESULT 107
  355. #define UI_F_UI_NEW_METHOD 104
  356. #define UI_F_UI_SET_RESULT 105
  357. /* Reason codes. */
  358. #define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS 104
  359. #define UI_R_INDEX_TOO_LARGE 102
  360. #define UI_R_INDEX_TOO_SMALL 103
  361. #define UI_R_NO_RESULT_BUFFER 105
  362. #define UI_R_RESULT_TOO_LARGE 100
  363. #define UI_R_RESULT_TOO_SMALL 101
  364. #define UI_R_UNKNOWN_CONTROL_COMMAND 106
  365. #ifdef __cplusplus
  366. }
  367. #endif
  368. #endif