Eneboo - Documentación para desarrolladores
src/libdigidoc/openssl/crypto/ui/ui.h
Ir a la documentación de este archivo.
00001 /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */
00002 /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
00003  * project 2001.
00004  */
00005 /* ====================================================================
00006  * Copyright (c) 2001 The OpenSSL Project.  All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. All advertising materials mentioning features or use of this
00021  *    software must display the following acknowledgment:
00022  *    "This product includes software developed by the OpenSSL Project
00023  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
00024  *
00025  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
00026  *    endorse or promote products derived from this software without
00027  *    prior written permission. For written permission, please contact
00028  *    openssl-core@openssl.org.
00029  *
00030  * 5. Products derived from this software may not be called "OpenSSL"
00031  *    nor may "OpenSSL" appear in their names without prior written
00032  *    permission of the OpenSSL Project.
00033  *
00034  * 6. Redistributions of any form whatsoever must retain the following
00035  *    acknowledgment:
00036  *    "This product includes software developed by the OpenSSL Project
00037  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
00038  *
00039  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
00040  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00041  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00042  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
00043  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00044  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00045  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00046  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00047  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
00048  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00049  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
00050  * OF THE POSSIBILITY OF SUCH DAMAGE.
00051  * ====================================================================
00052  *
00053  * This product includes cryptographic software written by Eric Young
00054  * (eay@cryptsoft.com).  This product includes software written by Tim
00055  * Hudson (tjh@cryptsoft.com).
00056  *
00057  */
00058 
00059 #ifndef HEADER_UI_H
00060 #define HEADER_UI_H
00061 
00062 #ifndef OPENSSL_NO_DEPRECATED
00063 #include <openssl/crypto.h>
00064 #endif
00065 #include <openssl/safestack.h>
00066 #include <openssl/ossl_typ.h>
00067 
00068 #ifdef  __cplusplus
00069 extern "C" {
00070 #endif
00071 
00072 /* Declared already in ossl_typ.h */
00073 /* typedef struct ui_st UI; */
00074 /* typedef struct ui_method_st UI_METHOD; */
00075 
00076 
00077 /* All the following functions return -1 or NULL on error and in some cases
00078    (UI_process()) -2 if interrupted or in some other way cancelled.
00079    When everything is fine, they return 0, a positive value or a non-NULL
00080    pointer, all depending on their purpose. */
00081 
00082 /* Creators and destructor.   */
00083 UI *UI_new(void);
00084 UI *UI_new_method(const UI_METHOD *method);
00085 void UI_free(UI *ui);
00086 
00087 /* The following functions are used to add strings to be printed and prompt
00088    strings to prompt for data.  The names are UI_{add,dup}_<function>_string
00089    and UI_{add,dup}_input_boolean.
00090 
00091    UI_{add,dup}_<function>_string have the following meanings:
00092         add     add a text or prompt string.  The pointers given to these
00093                 functions are used verbatim, no copying is done.
00094         dup     make a copy of the text or prompt string, then add the copy
00095                 to the collection of strings in the user interface.
00096         <function>
00097                 The function is a name for the functionality that the given
00098                 string shall be used for.  It can be one of:
00099                         input   use the string as data prompt.
00100                         verify  use the string as verification prompt.  This
00101                                 is used to verify a previous input.
00102                         info    use the string for informational output.
00103                         error   use the string for error output.
00104    Honestly, there's currently no difference between info and error for the
00105    moment.
00106 
00107    UI_{add,dup}_input_boolean have the same semantics for "add" and "dup",
00108    and are typically used when one wants to prompt for a yes/no response.
00109 
00110 
00111    All of the functions in this group take a UI and a prompt string.
00112    The string input and verify addition functions also take a flag argument,
00113    a buffer for the result to end up with, a minimum input size and a maximum
00114    input size (the result buffer MUST be large enough to be able to contain
00115    the maximum number of characters).  Additionally, the verify addition
00116    functions takes another buffer to compare the result against.
00117    The boolean input functions take an action description string (which should
00118    be safe to ignore if the expected user action is obvious, for example with
00119    a dialog box with an OK button and a Cancel button), a string of acceptable
00120    characters to mean OK and to mean Cancel.  The two last strings are checked
00121    to make sure they don't have common characters.  Additionally, the same
00122    flag argument as for the string input is taken, as well as a result buffer.
00123    The result buffer is required to be at least one byte long.  Depending on
00124    the answer, the first character from the OK or the Cancel character strings
00125    will be stored in the first byte of the result buffer.  No NUL will be
00126    added, so the result is *not* a string.
00127 
00128    On success, the all return an index of the added information.  That index
00129    is usefull when retrieving results with UI_get0_result(). */
00130 int UI_add_input_string(UI *ui, const char *prompt, int flags,
00131         char *result_buf, int minsize, int maxsize);
00132 int UI_dup_input_string(UI *ui, const char *prompt, int flags,
00133         char *result_buf, int minsize, int maxsize);
00134 int UI_add_verify_string(UI *ui, const char *prompt, int flags,
00135         char *result_buf, int minsize, int maxsize, const char *test_buf);
00136 int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
00137         char *result_buf, int minsize, int maxsize, const char *test_buf);
00138 int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
00139         const char *ok_chars, const char *cancel_chars,
00140         int flags, char *result_buf);
00141 int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
00142         const char *ok_chars, const char *cancel_chars,
00143         int flags, char *result_buf);
00144 int UI_add_info_string(UI *ui, const char *text);
00145 int UI_dup_info_string(UI *ui, const char *text);
00146 int UI_add_error_string(UI *ui, const char *text);
00147 int UI_dup_error_string(UI *ui, const char *text);
00148 
00149 /* These are the possible flags.  They can be or'ed together. */
00150 /* Use to have echoing of input */
00151 #define UI_INPUT_FLAG_ECHO              0x01
00152 /* Use a default password.  Where that password is found is completely
00153    up to the application, it might for example be in the user data set
00154    with UI_add_user_data().  It is not recommended to have more than
00155    one input in each UI being marked with this flag, or the application
00156    might get confused. */
00157 #define UI_INPUT_FLAG_DEFAULT_PWD       0x02
00158 
00159 /* The user of these routines may want to define flags of their own.  The core
00160    UI won't look at those, but will pass them on to the method routines.  They
00161    must use higher bits so they don't get confused with the UI bits above.
00162    UI_INPUT_FLAG_USER_BASE tells which is the lowest bit to use.  A good
00163    example of use is this:
00164 
00165         #define MY_UI_FLAG1     (0x01 << UI_INPUT_FLAG_USER_BASE)
00166 
00167 */
00168 #define UI_INPUT_FLAG_USER_BASE 16
00169 
00170 
00171 /* The following function helps construct a prompt.  object_desc is a
00172    textual short description of the object, for example "pass phrase",
00173    and object_name is the name of the object (might be a card name or
00174    a file name.
00175    The returned string shall always be allocated on the heap with
00176    OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
00177 
00178    If the ui_method doesn't contain a pointer to a user-defined prompt
00179    constructor, a default string is built, looking like this:
00180 
00181         "Enter {object_desc} for {object_name}:"
00182 
00183    So, if object_desc has the value "pass phrase" and object_name has
00184    the value "foo.key", the resulting string is:
00185 
00186         "Enter pass phrase for foo.key:"
00187 */
00188 char *UI_construct_prompt(UI *ui_method,
00189         const char *object_desc, const char *object_name);
00190 
00191 
00192 /* The following function is used to store a pointer to user-specific data.
00193    Any previous such pointer will be returned and replaced.
00194 
00195    For callback purposes, this function makes a lot more sense than using
00196    ex_data, since the latter requires that different parts of OpenSSL or
00197    applications share the same ex_data index.
00198 
00199    Note that the UI_OpenSSL() method completely ignores the user data.
00200    Other methods may not, however.  */
00201 void *UI_add_user_data(UI *ui, void *user_data);
00202 /* We need a user data retrieving function as well.  */
00203 void *UI_get0_user_data(UI *ui);
00204 
00205 /* Return the result associated with a prompt given with the index i. */
00206 const char *UI_get0_result(UI *ui, int i);
00207 
00208 /* When all strings have been added, process the whole thing. */
00209 int UI_process(UI *ui);
00210 
00211 /* Give a user interface parametrised control commands.  This can be used to
00212    send down an integer, a data pointer or a function pointer, as well as
00213    be used to get information from a UI. */
00214 int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f)(void));
00215 
00216 /* The commands */
00217 /* Use UI_CONTROL_PRINT_ERRORS with the value 1 to have UI_process print the
00218    OpenSSL error stack before printing any info or added error messages and
00219    before any prompting. */
00220 #define UI_CTRL_PRINT_ERRORS            1
00221 /* Check if a UI_process() is possible to do again with the same instance of
00222    a user interface.  This makes UI_ctrl() return 1 if it is redoable, and 0
00223    if not. */
00224 #define UI_CTRL_IS_REDOABLE             2
00225 
00226 
00227 /* Some methods may use extra data */
00228 #define UI_set_app_data(s,arg)         UI_set_ex_data(s,0,arg)
00229 #define UI_get_app_data(s)             UI_get_ex_data(s,0)
00230 int UI_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
00231         CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
00232 int UI_set_ex_data(UI *r,int idx,void *arg);
00233 void *UI_get_ex_data(UI *r, int idx);
00234 
00235 /* Use specific methods instead of the built-in one */
00236 void UI_set_default_method(const UI_METHOD *meth);
00237 const UI_METHOD *UI_get_default_method(void);
00238 const UI_METHOD *UI_get_method(UI *ui);
00239 const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth);
00240 
00241 /* The method with all the built-in thingies */
00242 UI_METHOD *UI_OpenSSL(void);
00243 
00244 
00245 /* ---------- For method writers ---------- */
00246 /* A method contains a number of functions that implement the low level
00247    of the User Interface.  The functions are:
00248 
00249         an opener       This function starts a session, maybe by opening
00250                         a channel to a tty, or by opening a window.
00251         a writer        This function is called to write a given string,
00252                         maybe to the tty, maybe as a field label in a
00253                         window.
00254         a flusher       This function is called to flush everything that
00255                         has been output so far.  It can be used to actually
00256                         display a dialog box after it has been built.
00257         a reader        This function is called to read a given prompt,
00258                         maybe from the tty, maybe from a field in a
00259                         window.  Note that it's called wth all string
00260                         structures, not only the prompt ones, so it must
00261                         check such things itself.
00262         a closer        This function closes the session, maybe by closing
00263                         the channel to the tty, or closing the window.
00264 
00265    All these functions are expected to return:
00266 
00267         0       on error.
00268         1       on success.
00269         -1      on out-of-band events, for example if some prompting has
00270                 been canceled (by pressing Ctrl-C, for example).  This is
00271                 only checked when returned by the flusher or the reader.
00272 
00273    The way this is used, the opener is first called, then the writer for all
00274    strings, then the flusher, then the reader for all strings and finally the
00275    closer.  Note that if you want to prompt from a terminal or other command
00276    line interface, the best is to have the reader also write the prompts
00277    instead of having the writer do it.  If you want to prompt from a dialog
00278    box, the writer can be used to build up the contents of the box, and the
00279    flusher to actually display the box and run the event loop until all data
00280    has been given, after which the reader only grabs the given data and puts
00281    them back into the UI strings.
00282 
00283    All method functions take a UI as argument.  Additionally, the writer and
00284    the reader take a UI_STRING.
00285 */
00286 
00287 /* The UI_STRING type is the data structure that contains all the needed info
00288    about a string or a prompt, including test data for a verification prompt.
00289 */
00290 DECLARE_STACK_OF(UI_STRING)
00291 typedef struct ui_string_st UI_STRING;
00292 
00293 /* The different types of strings that are currently supported.
00294    This is only needed by method authors. */
00295 enum UI_string_types
00296         {
00297         UIT_NONE=0,
00298         UIT_PROMPT,             /* Prompt for a string */
00299         UIT_VERIFY,             /* Prompt for a string and verify */
00300         UIT_BOOLEAN,            /* Prompt for a yes/no response */
00301         UIT_INFO,               /* Send info to the user */
00302         UIT_ERROR               /* Send an error message to the user */
00303         };
00304 
00305 /* Create and manipulate methods */
00306 UI_METHOD *UI_create_method(char *name);
00307 void UI_destroy_method(UI_METHOD *ui_method);
00308 int UI_method_set_opener(UI_METHOD *method, int (*opener)(UI *ui));
00309 int UI_method_set_writer(UI_METHOD *method, int (*writer)(UI *ui, UI_STRING *uis));
00310 int UI_method_set_flusher(UI_METHOD *method, int (*flusher)(UI *ui));
00311 int UI_method_set_reader(UI_METHOD *method, int (*reader)(UI *ui, UI_STRING *uis));
00312 int UI_method_set_closer(UI_METHOD *method, int (*closer)(UI *ui));
00313 int (*UI_method_get_opener(UI_METHOD *method))(UI*);
00314 int (*UI_method_get_writer(UI_METHOD *method))(UI*,UI_STRING*);
00315 int (*UI_method_get_flusher(UI_METHOD *method))(UI*);
00316 int (*UI_method_get_reader(UI_METHOD *method))(UI*,UI_STRING*);
00317 int (*UI_method_get_closer(UI_METHOD *method))(UI*);
00318 
00319 /* The following functions are helpers for method writers to access relevant
00320    data from a UI_STRING. */
00321 
00322 /* Return type of the UI_STRING */
00323 enum UI_string_types UI_get_string_type(UI_STRING *uis);
00324 /* Return input flags of the UI_STRING */
00325 int UI_get_input_flags(UI_STRING *uis);
00326 /* Return the actual string to output (the prompt, info or error) */
00327 const char *UI_get0_output_string(UI_STRING *uis);
00328 /* Return the optional action string to output (the boolean promtp instruction) */
00329 const char *UI_get0_action_string(UI_STRING *uis);
00330 /* Return the result of a prompt */
00331 const char *UI_get0_result_string(UI_STRING *uis);
00332 /* Return the string to test the result against.  Only useful with verifies. */
00333 const char *UI_get0_test_string(UI_STRING *uis);
00334 /* Return the required minimum size of the result */
00335 int UI_get_result_minsize(UI_STRING *uis);
00336 /* Return the required maximum size of the result */
00337 int UI_get_result_maxsize(UI_STRING *uis);
00338 /* Set the result of a UI_STRING. */
00339 int UI_set_result(UI *ui, UI_STRING *uis, const char *result);
00340 
00341 
00342 /* A couple of popular utility functions */
00343 int UI_UTIL_read_pw_string(char *buf,int length,const char *prompt,int verify);
00344 int UI_UTIL_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
00345 
00346 
00347 /* BEGIN ERROR CODES */
00348 /* The following lines are auto generated by the script mkerr.pl. Any changes
00349  * made after this point may be overwritten when the script is next run.
00350  */
00351 void ERR_load_UI_strings(void);
00352 
00353 /* Error codes for the UI functions. */
00354 
00355 /* Function codes. */
00356 #define UI_F_GENERAL_ALLOCATE_BOOLEAN                    108
00357 #define UI_F_GENERAL_ALLOCATE_PROMPT                     109
00358 #define UI_F_GENERAL_ALLOCATE_STRING                     100
00359 #define UI_F_UI_CTRL                                     111
00360 #define UI_F_UI_DUP_ERROR_STRING                         101
00361 #define UI_F_UI_DUP_INFO_STRING                          102
00362 #define UI_F_UI_DUP_INPUT_BOOLEAN                        110
00363 #define UI_F_UI_DUP_INPUT_STRING                         103
00364 #define UI_F_UI_DUP_VERIFY_STRING                        106
00365 #define UI_F_UI_GET0_RESULT                              107
00366 #define UI_F_UI_NEW_METHOD                               104
00367 #define UI_F_UI_SET_RESULT                               105
00368 
00369 /* Reason codes. */
00370 #define UI_R_COMMON_OK_AND_CANCEL_CHARACTERS             104
00371 #define UI_R_INDEX_TOO_LARGE                             102
00372 #define UI_R_INDEX_TOO_SMALL                             103
00373 #define UI_R_NO_RESULT_BUFFER                            105
00374 #define UI_R_RESULT_TOO_LARGE                            100
00375 #define UI_R_RESULT_TOO_SMALL                            101
00376 #define UI_R_UNKNOWN_CONTROL_COMMAND                     106
00377 
00378 #ifdef  __cplusplus
00379 }
00380 #endif
00381 #endif
 Todo Clases Namespaces Archivos Funciones Variables 'typedefs' Enumeraciones Valores de enumeraciones Propiedades Amigas 'defines'