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