]>
Commit | Line | Data |
---|---|---|
a63d5eaa | 1 | /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */ |
219a3580 RL |
2 | /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL |
3 | * project 2001. | |
a63d5eaa RL |
4 | */ |
5 | /* ==================================================================== | |
219a3580 | 6 | * Copyright (c) 2001 The OpenSSL Project. All rights reserved. |
a63d5eaa RL |
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> | |
678c1e02 | 63 | #include <openssl/crypto.h> |
a63d5eaa | 64 | |
0491e058 AP |
65 | #ifdef _ |
66 | #undef _ | |
67 | #endif | |
68 | ||
a63d5eaa RL |
69 | struct ui_method_st |
70 | { | |
eb929eef | 71 | char *name; |
a63d5eaa | 72 | |
9ad0f681 RL |
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 | ||
a63d5eaa | 82 | int (*ui_write_string)(UI *ui, UI_STRING *uis); |
9ad0f681 RL |
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 | ||
a63d5eaa | 90 | int (*ui_close_session)(UI *ui); |
9ad0f681 RL |
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); | |
a63d5eaa RL |
100 | }; |
101 | ||
102 | struct ui_string_st | |
103 | { | |
a63d5eaa | 104 | enum UI_string_types type; /* Input */ |
2d2ed9df | 105 | const char *out_string; /* Input */ |
9ad0f681 | 106 | int input_flags; /* Flags from the user */ |
a63d5eaa | 107 | |
2d2ed9df RL |
108 | /* The following parameters are completely irrelevant for UIT_INFO, |
109 | and can therefore be set to 0 or NULL */ | |
a63d5eaa RL |
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.*/ | |
2d2ed9df RL |
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 | } _; | |
a63d5eaa RL |
134 | |
135 | #define OUT_STRING_FREEABLE 0x01 | |
9ad0f681 | 136 | int flags; /* flags for internal use */ |
a63d5eaa RL |
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. */ | |
1e7e62f8 | 145 | void *user_data; |
a63d5eaa | 146 | CRYPTO_EX_DATA ex_data; |
2d2ed9df RL |
147 | |
148 | #define UI_FLAG_REDOABLE 0x0001 | |
149 | #define UI_FLAG_PRINT_ERRORS 0x0100 | |
150 | int flags; | |
a63d5eaa RL |
151 | }; |
152 | ||
153 | #endif |