RSA, DSA, DH: Allow some given input to be NULL on already initialised keys
[openssl.git] / crypto / ui / ui_locl.h
1 /*
2  * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
3  * 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  *    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 # include <openssl/crypto.h>
64
65 # ifdef _
66 #  undef _
67 # endif
68
69 struct ui_method_st {
70     char *name;
71     /*
72      * All the functions return 1 or non-NULL for success and 0 or NULL for
73      * failure
74      */
75     /*
76      * Open whatever channel for this, be it the console, an X window or
77      * whatever. This function should use the ex_data structure to save
78      * intermediate data.
79      */
80     int (*ui_open_session) (UI *ui);
81     int (*ui_write_string) (UI *ui, UI_STRING *uis);
82     /*
83      * Flush the output.  If a GUI dialog box is used, this function can be
84      * used to actually display it.
85      */
86     int (*ui_flush) (UI *ui);
87     int (*ui_read_string) (UI *ui, UI_STRING *uis);
88     int (*ui_close_session) (UI *ui);
89     /*
90      * Construct a prompt in a user-defined manner.  object_desc is a textual
91      * short description of the object, for example "pass phrase", and
92      * object_name is the name of the object (might be a card name or a file
93      * name. The returned string shall always be allocated on the heap with
94      * OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
95      */
96     char *(*ui_construct_prompt) (UI *ui, const char *object_desc,
97                                   const char *object_name);
98 };
99
100 struct ui_string_st {
101     enum UI_string_types type;  /* Input */
102     const char *out_string;     /* Input */
103     int input_flags;            /* Flags from the user */
104     /*
105      * The following parameters are completely irrelevant for UIT_INFO, and
106      * can therefore be set to 0 or NULL
107      */
108     char *result_buf;           /* Input and Output: If not NULL,
109                                  * user-defined with size in result_maxsize.
110                                  * Otherwise, it may be allocated by the UI
111                                  * routine, meaning result_minsize is going
112                                  * to be overwritten. */
113     union {
114         struct {
115             int result_minsize; /* Input: minimum required size of the
116                                  * result. */
117             int result_maxsize; /* Input: maximum permitted size of the
118                                  * result */
119             const char *test_buf; /* Input: test string to verify against */
120         } string_data;
121         struct {
122             const char *action_desc; /* Input */
123             const char *ok_chars; /* Input */
124             const char *cancel_chars; /* Input */
125         } boolean_data;
126     } _;
127
128 # define OUT_STRING_FREEABLE 0x01
129     int flags;                  /* flags for internal use */
130 };
131
132 struct ui_st {
133     const UI_METHOD *meth;
134     STACK_OF(UI_STRING) *strings; /* We might want to prompt for more than
135                                    * one thing at a time, and with different
136                                    * echoing status.  */
137     void *user_data;
138     CRYPTO_EX_DATA ex_data;
139 # define UI_FLAG_REDOABLE        0x0001
140 # define UI_FLAG_PRINT_ERRORS    0x0100
141     int flags;
142
143     CRYPTO_RWLOCK *lock;
144 };
145
146 #endif