summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/ui/ui_local.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/ui/ui_local.h')
-rw-r--r--src/lib/libcrypto/ui/ui_local.h152
1 files changed, 152 insertions, 0 deletions
diff --git a/src/lib/libcrypto/ui/ui_local.h b/src/lib/libcrypto/ui/ui_local.h
new file mode 100644
index 0000000000..d62c628f8c
--- /dev/null
+++ b/src/lib/libcrypto/ui/ui_local.h
@@ -0,0 +1,152 @@
1/* $OpenBSD: ui_local.h,v 1.1 2022/11/26 16:08:54 tb Exp $ */
2
3/* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
4 * project 2001.
5 */
6/* ====================================================================
7 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25 *
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * openssl-core@openssl.org.
30 *
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
34 *
35 * 6. Redistributions of any form whatsoever must retain the following
36 * acknowledgment:
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
53 *
54 * This product includes cryptographic software written by Eric Young
55 * (eay@cryptsoft.com). This product includes software written by Tim
56 * Hudson (tjh@cryptsoft.com).
57 *
58 */
59
60#ifndef HEADER_UI_LOCL_H
61#define HEADER_UI_LOCL_H
62
63#include <openssl/ui.h>
64#include <openssl/crypto.h>
65
66__BEGIN_HIDDEN_DECLS
67
68#ifdef _
69#undef _
70#endif
71
72struct ui_method_st {
73 char *name;
74
75 /* All the functions return 1 or non-NULL for success and 0 or NULL
76 for failure */
77
78 /* Open whatever channel for this, be it the console, an X window
79 or whatever.
80 This function should use the ex_data structure to save
81 intermediate data. */
82 int (*ui_open_session)(UI *ui);
83
84 int (*ui_write_string)(UI *ui, UI_STRING *uis);
85
86 /* Flush the output. If a GUI dialog box is used, this function can
87 be used to actually display it. */
88 int (*ui_flush)(UI *ui);
89
90 int (*ui_read_string)(UI *ui, UI_STRING *uis);
91
92 int (*ui_close_session)(UI *ui);
93
94 /* Construct a prompt in a user-defined manner. object_desc is a
95 textual short description of the object, for example "pass phrase",
96 and object_name is the name of the object (might be a card name or
97 a file name.
98 The returned string shall always be allocated on the heap with
99 malloc(), and need to be free'd with free(). */
100 char *(*ui_construct_prompt)(UI *ui, const char *object_desc,
101 const char *object_name);
102};
103
104struct ui_string_st {
105 enum UI_string_types type; /* Input */
106 const char *out_string; /* Input */
107 int input_flags; /* Flags from the user */
108
109 /* The following parameters are completely irrelevant for UIT_INFO,
110 and can therefore be set to 0 or NULL */
111 char *result_buf; /* Input and Output: If not NULL, user-defined
112 with size in result_maxsize. Otherwise, it
113 may be allocated by the UI routine, meaning
114 result_minsize is going to be overwritten.*/
115 union {
116 struct {
117 int result_minsize; /* Input: minimum required
118 size of the result.
119 */
120 int result_maxsize; /* Input: maximum permitted
121 size of the result */
122
123 const char *test_buf; /* Input: test string to verify
124 against */
125 } string_data;
126 struct {
127 const char *action_desc; /* Input */
128 const char *ok_chars; /* Input */
129 const char *cancel_chars; /* Input */
130 } boolean_data;
131 } _;
132
133#define OUT_STRING_FREEABLE 0x01
134 int flags; /* flags for internal use */
135};
136
137struct ui_st {
138 const UI_METHOD *meth;
139 STACK_OF(UI_STRING) *strings; /* We might want to prompt for more
140 than one thing at a time, and
141 with different echoing status. */
142 void *user_data;
143 CRYPTO_EX_DATA ex_data;
144
145#define UI_FLAG_REDOABLE 0x0001
146#define UI_FLAG_PRINT_ERRORS 0x0100
147 int flags;
148};
149
150__END_HIDDEN_DECLS
151
152#endif