You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

110 lines
3.8 KiB

* Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
* Licensed under the Apache License 2.0 (the "License"). You may not use
* this file except in compliance with the License. You can obtain a copy
* in the file LICENSE in the source distribution or at
# include <openssl/ui.h>
# include <openssl/crypto.h>
# ifdef _
# undef _
# endif
struct ui_method_st {
char *name;
* All the functions return 1 or non-NULL for success and 0 or NULL for
* failure
* Open whatever channel for this, be it the console, an X window or
* whatever. This function should use the ex_data structure to save
* intermediate data.
int (*ui_open_session) (UI *ui);
int (*ui_write_string) (UI *ui, UI_STRING *uis);
* Flush the output. If a GUI dialog box is used, this function can be
* used to actually display it.
int (*ui_flush) (UI *ui);
int (*ui_read_string) (UI *ui, UI_STRING *uis);
int (*ui_close_session) (UI *ui);
* Duplicate the ui_data that often comes alongside a ui_method. This
* allows some backends to save away UI information for later use.
void *(*ui_duplicate_data) (UI *ui, void *ui_data);
void (*ui_destroy_data) (UI *ui, void *ui_data);
* Construct a prompt in a user-defined manner. object_desc is a textual
* short description of the object, for example "pass phrase", and
* object_name is the name of the object (might be a card name or a file
* name. The returned string shall always be allocated on the heap with
* OPENSSL_malloc(), and need to be free'd with OPENSSL_free().
char *(*ui_construct_prompt) (UI *ui, const char *object_desc,
const char *object_name);
* UI_METHOD specific application data.
struct ui_string_st {
enum UI_string_types type; /* Input */
const char *out_string; /* Input */
int input_flags; /* Flags from the user */
* The following parameters are completely irrelevant for UIT_INFO, and
* can therefore be set to 0 or NULL
char *result_buf; /* Input and Output: If not NULL,
* user-defined with size in result_maxsize.
* Otherwise, it may be allocated by the UI
* routine, meaning result_minsize is going
* to be overwritten. */
size_t result_len;
union {
struct {
int result_minsize; /* Input: minimum required size of the
* result. */
int result_maxsize; /* Input: maximum permitted size of the
* result */
const char *test_buf; /* Input: test string to verify against */
} string_data;
struct {
const char *action_desc; /* Input */
const char *ok_chars; /* Input */
const char *cancel_chars; /* Input */
} boolean_data;
} _;
int flags; /* flags for internal use */
struct ui_st {
const UI_METHOD *meth;
STACK_OF(UI_STRING) *strings; /* We might want to prompt for more than
* one thing at a time, and with different
* echoing status. */
void *user_data;
# define UI_FLAG_REDOABLE 0x0001
# define UI_FLAG_DUPL_DATA 0x0002 /* user_data was duplicated */
# define UI_FLAG_PRINT_ERRORS 0x0100
int flags;