crypto/ui/ui_locl.h

   1 /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */
   2 /* Written by Richard Levitte (levitte@stacken.kth.se) for the OpenSSL
   3  * project 2000.
   4  */
   5 /* ====================================================================
   6  * Copyright (c) 1998-2000 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  *    openssl-core@openssl.org.
  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  * (eay@cryptsoft.com).  This product includes software written by Tim
  55  * Hudson (tjh@cryptsoft.com).
  56  *
  57  */
  58
  59 #ifndef HEADER_UI_LOCL_H
  60 #define HEADER_UI_LOCL_H
  61
  62 #include <openssl/ui.h>
  63
  64 struct ui_method_st
  65         {
  66         const char *name;
  67
  68         /* All the functions return 1 for success and 0 for failure */
  69         int (*ui_open_session)(UI *ui); /* Open whatever channel for this,
  70                                            be it the console, an X window
  71                                            or whatever.
  72                                            This function should use the
  73                                            ex_data structure to save
  74                                            intermediate data. */
  75         int (*ui_read_string)(UI *ui, UI_STRING *uis);
  76         int (*ui_write_string)(UI *ui, UI_STRING *uis);
  77         int (*ui_close_session)(UI *ui);
  78         };
  79
  80 struct ui_string_st
  81         {
  82         const char *out_string; /* Input */
  83         enum UI_string_types type; /* Input */
  84
  85         /* The following parameters are completely irrelevant for UI_INFO,
  86            and can therefore be set to 0 ro NULL */
  87         char *result_buf;       /* Input and Output: If not NULL, user-defined
  88                                    with size in result_maxsize.  Otherwise, it
  89                                    may be allocated by the UI routine, meaning
  90                                    result_minsize is going to be overwritten.*/
  91         int result_minsize;     /* Input: minimum required size of the result*/
  92         int result_maxsize;     /* Input: maximum permitted size of the
  93                                    result */
  94
  95         const char *test_buf;   /* Input: test string to verify against */
  96
  97 #define OUT_STRING_FREEABLE 0x01
  98         int flags;
  99         };
 100
 101 struct ui_st
 102         {
 103         const UI_METHOD *meth;
 104         STACK_OF(UI_STRING) *strings; /* We might want to prompt for more
 105                                          than one thing at a time, and
 106                                          with different echoing status.  */
 107         void *user_data;
 108         CRYPTO_EX_DATA ex_data;
 109         };
 110
 111 #endif