]>
git.ipfire.org Git - thirdparty/openssl.git/blob - crypto/ui/ui_locl.h
1 /* crypto/ui/ui.h -*- mode:C; c-file-style: "eay" -*- */
3 * Written by Richard Levitte (richard@levitte.org) for the OpenSSL project
6 /* ====================================================================
7 * Copyright (c) 2001 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
60 #ifndef HEADER_UI_LOCL_H
61 # define HEADER_UI_LOCL_H
63 # include <openssl/ui.h>
64 # include <openssl/crypto.h>
73 * All the functions return 1 or non-NULL for success and 0 or NULL for
77 * Open whatever channel for this, be it the console, an X window or
78 * whatever. This function should use the ex_data structure to save
81 int (*ui_open_session
) (UI
*ui
);
82 int (*ui_write_string
) (UI
*ui
, UI_STRING
*uis
);
84 * Flush the output. If a GUI dialog box is used, this function can be
85 * used to actually display it.
87 int (*ui_flush
) (UI
*ui
);
88 int (*ui_read_string
) (UI
*ui
, UI_STRING
*uis
);
89 int (*ui_close_session
) (UI
*ui
);
91 * Construct a prompt in a user-defined manner. object_desc is a textual
92 * short description of the object, for example "pass phrase", and
93 * object_name is the name of the object (might be a card name or a file
94 * name. The returned string shall always be allocated on the heap with
95 * OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
97 char *(*ui_construct_prompt
) (UI
*ui
, const char *object_desc
,
98 const char *object_name
);
101 struct ui_string_st
{
102 enum UI_string_types type
; /* Input */
103 const char *out_string
; /* Input */
104 int input_flags
; /* Flags from the user */
106 * The following parameters are completely irrelevant for UIT_INFO, and
107 * can therefore be set to 0 or NULL
109 char *result_buf
; /* Input and Output: If not NULL,
110 * user-defined with size in result_maxsize.
111 * Otherwise, it may be allocated by the UI
112 * routine, meaning result_minsize is going
113 * to be overwritten. */
116 int result_minsize
; /* Input: minimum required size of the
118 int result_maxsize
; /* Input: maximum permitted size of the
120 const char *test_buf
; /* Input: test string to verify against */
123 const char *action_desc
; /* Input */
124 const char *ok_chars
; /* Input */
125 const char *cancel_chars
; /* Input */
129 # define OUT_STRING_FREEABLE 0x01
130 int flags
; /* flags for internal use */
134 const UI_METHOD
*meth
;
135 STACK_OF(UI_STRING
) *strings
; /* We might want to prompt for more than
136 * one thing at a time, and with different
139 CRYPTO_EX_DATA ex_data
;
140 # define UI_FLAG_REDOABLE 0x0001
141 # define UI_FLAG_PRINT_ERRORS 0x0100