ui.pod 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. =pod
  2. =head1 NAME
  3. UI_new, UI_new_method, UI_free, UI_add_input_string, UI_dup_input_string,
  4. UI_add_verify_string, UI_dup_verify_string, UI_add_input_boolean,
  5. UI_dup_input_boolean, UI_add_info_string, UI_dup_info_string,
  6. UI_add_error_string, UI_dup_error_string, UI_construct_prompt,
  7. UI_add_user_data, UI_get0_user_data, UI_get0_result, UI_process,
  8. UI_ctrl, UI_set_default_method, UI_get_default_method, UI_get_method,
  9. UI_set_method, UI_OpenSSL, ERR_load_UI_strings - New User Interface
  10. =head1 SYNOPSIS
  11. #include <openssl/ui.h>
  12. typedef struct ui_st UI;
  13. typedef struct ui_method_st UI_METHOD;
  14. UI *UI_new(void);
  15. UI *UI_new_method(const UI_METHOD *method);
  16. void UI_free(UI *ui);
  17. int UI_add_input_string(UI *ui, const char *prompt, int flags,
  18. char *result_buf, int minsize, int maxsize);
  19. int UI_dup_input_string(UI *ui, const char *prompt, int flags,
  20. char *result_buf, int minsize, int maxsize);
  21. int UI_add_verify_string(UI *ui, const char *prompt, int flags,
  22. char *result_buf, int minsize, int maxsize, const char *test_buf);
  23. int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
  24. char *result_buf, int minsize, int maxsize, const char *test_buf);
  25. int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  26. const char *ok_chars, const char *cancel_chars,
  27. int flags, char *result_buf);
  28. int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
  29. const char *ok_chars, const char *cancel_chars,
  30. int flags, char *result_buf);
  31. int UI_add_info_string(UI *ui, const char *text);
  32. int UI_dup_info_string(UI *ui, const char *text);
  33. int UI_add_error_string(UI *ui, const char *text);
  34. int UI_dup_error_string(UI *ui, const char *text);
  35. /* These are the possible flags. They can be or'ed together. */
  36. #define UI_INPUT_FLAG_ECHO 0x01
  37. #define UI_INPUT_FLAG_DEFAULT_PWD 0x02
  38. char *UI_construct_prompt(UI *ui_method,
  39. const char *object_desc, const char *object_name);
  40. void *UI_add_user_data(UI *ui, void *user_data);
  41. void *UI_get0_user_data(UI *ui);
  42. const char *UI_get0_result(UI *ui, int i);
  43. int UI_process(UI *ui);
  44. int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)());
  45. #define UI_CTRL_PRINT_ERRORS 1
  46. #define UI_CTRL_IS_REDOABLE 2
  47. void UI_set_default_method(const UI_METHOD *meth);
  48. const UI_METHOD *UI_get_default_method(void);
  49. const UI_METHOD *UI_get_method(UI *ui);
  50. const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
  51. UI_METHOD *UI_OpenSSL(void);
  52. =head1 DESCRIPTION
  53. UI stands for User Interface, and is general purpose set of routines to
  54. prompt the user for text-based information. Through user-written methods
  55. (see L<ui_create(3)|ui_create(3)>), prompting can be done in any way
  56. imaginable, be it plain text prompting, through dialog boxes or from a
  57. cell phone.
  58. All the functions work through a context of the type UI. This context
  59. contains all the information needed to prompt correctly as well as a
  60. reference to a UI_METHOD, which is an ordered vector of functions that
  61. carry out the actual prompting.
  62. The first thing to do is to create a UI with UI_new() or UI_new_method(),
  63. then add information to it with the UI_add or UI_dup functions. Also,
  64. user-defined random data can be passed down to the underlying method
  65. through calls to UI_add_user_data. The default UI method doesn't care
  66. about these data, but other methods might. Finally, use UI_process()
  67. to actually perform the prompting and UI_get0_result() to find the result
  68. to the prompt.
  69. A UI can contain more than one prompt, which are performed in the given
  70. sequence. Each prompt gets an index number which is returned by the
  71. UI_add and UI_dup functions, and has to be used to get the corresponding
  72. result with UI_get0_result().
  73. The functions are as follows:
  74. UI_new() creates a new UI using the default UI method. When done with
  75. this UI, it should be freed using UI_free().
  76. UI_new_method() creates a new UI using the given UI method. When done with
  77. this UI, it should be freed using UI_free().
  78. UI_OpenSSL() returns the built-in UI method (note: not the default one,
  79. since the default can be changed. See further on). This method is the
  80. most machine/OS dependent part of OpenSSL and normally generates the
  81. most problems when porting.
  82. UI_free() removes a UI from memory, along with all other pieces of memory
  83. that's connected to it, like duplicated input strings, results and others.
  84. UI_add_input_string() and UI_add_verify_string() add a prompt to the UI,
  85. as well as flags and a result buffer and the desired minimum and maximum
  86. sizes of the result, not counting the final NUL character. The given
  87. information is used to prompt for information, for example a password,
  88. and to verify a password (i.e. having the user enter it twice and check
  89. that the same string was entered twice). UI_add_verify_string() takes
  90. and extra argument that should be a pointer to the result buffer of the
  91. input string that it's supposed to verify, or verification will fail.
  92. UI_add_input_boolean() adds a prompt to the UI that's supposed to be answered
  93. in a boolean way, with a single character for yes and a different character
  94. for no. A set of characters that can be used to cancel the prompt is given
  95. as well. The prompt itself is divided in two, one part being the
  96. descriptive text (given through the I<prompt> argument) and one describing
  97. the possible answers (given through the I<action_desc> argument).
  98. UI_add_info_string() and UI_add_error_string() add strings that are shown at
  99. the same time as the prompt for extra information or to show an error string.
  100. The difference between the two is only conceptual. With the builtin method,
  101. there's no technical difference between them. Other methods may make a
  102. difference between them, however.
  103. The flags currently supported are UI_INPUT_FLAG_ECHO, which is relevant for
  104. UI_add_input_string() and will have the users response be echoed (when
  105. prompting for a password, this flag should obviously not be used, and
  106. UI_INPUT_FLAG_DEFAULT_PWD, which means that a default password of some
  107. sort will be used (completely depending on the application and the UI
  108. method).
  109. UI_dup_input_string(), UI_dup_verify_string(), UI_dup_input_boolean(),
  110. UI_dup_info_string() and UI_dup_error_string() are basically the same
  111. as their UI_add counterparts, except that they make their own copies
  112. of all strings.
  113. UI_construct_prompt() is a helper function that can be used to create
  114. a prompt from two pieces of information: an description and a name.
  115. The default constructor (if there is none provided by the method used)
  116. creates a string "Enter I<description> for I<name>:". With the
  117. description "pass phrase" and the file name "foo.key", that becomes
  118. "Enter pass phrase for foo.key:". Other methods may create whatever
  119. string and may include encodings that will be processed by the other
  120. method functions.
  121. UI_add_user_data() adds a piece of memory for the method to use at any
  122. time. The builtin UI method doesn't care about this info. Note that several
  123. calls to this function doesn't add data, it replaces the previous blob
  124. with the one given as argument.
  125. UI_get0_user_data() retrieves the data that has last been given to the
  126. UI with UI_add_user_data().
  127. UI_get0_result() returns a pointer to the result buffer associated with
  128. the information indexed by I<i>.
  129. UI_process() goes through the information given so far, does all the printing
  130. and prompting and returns.
  131. UI_ctrl() adds extra control for the application author. For now, it
  132. understands two commands: UI_CTRL_PRINT_ERRORS, which makes UI_process()
  133. print the OpenSSL error stack as part of processing the UI, and
  134. UI_CTRL_IS_REDOABLE, which returns a flag saying if the used UI can
  135. be used again or not.
  136. UI_set_default_method() changes the default UI method to the one given.
  137. UI_get_default_method() returns a pointer to the current default UI method.
  138. UI_get_method() returns the UI method associated with a given UI.
  139. UI_set_method() changes the UI method associated with a given UI.
  140. =head1 SEE ALSO
  141. L<ui_create(3)|ui_create(3)>, L<ui_compat(3)|ui_compat(3)>
  142. =head1 HISTORY
  143. The UI section was first introduced in OpenSSL 0.9.7.
  144. =head1 AUTHOR
  145. Richard Levitte (richard@levitte.org) for the OpenSSL project
  146. (http://www.openssl.org).
  147. =cut