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