Blame crypto/ui/ui_lib.c

Packit c4476c
/*
Packit c4476c
 * Copyright 2001-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
#include <string.h>
Packit c4476c
#include "internal/cryptlib.h"
Packit c4476c
#include <openssl/e_os2.h>
Packit c4476c
#include <openssl/buffer.h>
Packit c4476c
#include <openssl/ui.h>
Packit c4476c
#include <openssl/err.h>
Packit c4476c
#include "ui_local.h"
Packit c4476c
Packit c4476c
UI *UI_new(void)
Packit c4476c
{
Packit c4476c
    return UI_new_method(NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
UI *UI_new_method(const UI_METHOD *method)
Packit c4476c
{
Packit c4476c
    UI *ret = OPENSSL_zalloc(sizeof(*ret));
Packit c4476c
Packit c4476c
    if (ret == NULL) {
Packit c4476c
        UIerr(UI_F_UI_NEW_METHOD, ERR_R_MALLOC_FAILURE);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    ret->lock = CRYPTO_THREAD_lock_new();
Packit c4476c
    if (ret->lock == NULL) {
Packit c4476c
        UIerr(UI_F_UI_NEW_METHOD, ERR_R_MALLOC_FAILURE);
Packit c4476c
        OPENSSL_free(ret);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (method == NULL)
Packit c4476c
        method = UI_get_default_method();
Packit c4476c
    if (method == NULL)
Packit c4476c
        method = UI_null();
Packit c4476c
    ret->meth = method;
Packit c4476c
Packit c4476c
    if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI, ret, &ret->ex_data)) {
Packit c4476c
        OPENSSL_free(ret);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static void free_string(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    if (uis->flags & OUT_STRING_FREEABLE) {
Packit c4476c
        OPENSSL_free((char *)uis->out_string);
Packit c4476c
        switch (uis->type) {
Packit c4476c
        case UIT_BOOLEAN:
Packit c4476c
            OPENSSL_free((char *)uis->_.boolean_data.action_desc);
Packit c4476c
            OPENSSL_free((char *)uis->_.boolean_data.ok_chars);
Packit c4476c
            OPENSSL_free((char *)uis->_.boolean_data.cancel_chars);
Packit c4476c
            break;
Packit c4476c
        case UIT_NONE:
Packit c4476c
        case UIT_PROMPT:
Packit c4476c
        case UIT_VERIFY:
Packit c4476c
        case UIT_ERROR:
Packit c4476c
        case UIT_INFO:
Packit c4476c
            break;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    OPENSSL_free(uis);
Packit c4476c
}
Packit c4476c
Packit c4476c
void UI_free(UI *ui)
Packit c4476c
{
Packit c4476c
    if (ui == NULL)
Packit c4476c
        return;
Packit c4476c
    if ((ui->flags & UI_FLAG_DUPL_DATA) != 0) {
Packit c4476c
        ui->meth->ui_destroy_data(ui, ui->user_data);
Packit c4476c
    }
Packit c4476c
    sk_UI_STRING_pop_free(ui->strings, free_string);
Packit c4476c
    CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI, ui, &ui->ex_data);
Packit c4476c
    CRYPTO_THREAD_lock_free(ui->lock);
Packit c4476c
    OPENSSL_free(ui);
Packit c4476c
}
Packit c4476c
Packit c4476c
static int allocate_string_stack(UI *ui)
Packit c4476c
{
Packit c4476c
    if (ui->strings == NULL) {
Packit c4476c
        ui->strings = sk_UI_STRING_new_null();
Packit c4476c
        if (ui->strings == NULL) {
Packit c4476c
            return -1;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
static UI_STRING *general_allocate_prompt(UI *ui, const char *prompt,
Packit c4476c
                                          int prompt_freeable,
Packit c4476c
                                          enum UI_string_types type,
Packit c4476c
                                          int input_flags, char *result_buf)
Packit c4476c
{
Packit c4476c
    UI_STRING *ret = NULL;
Packit c4476c
Packit c4476c
    if (prompt == NULL) {
Packit c4476c
        UIerr(UI_F_GENERAL_ALLOCATE_PROMPT, ERR_R_PASSED_NULL_PARAMETER);
Packit c4476c
    } else if ((type == UIT_PROMPT || type == UIT_VERIFY
Packit c4476c
                || type == UIT_BOOLEAN) && result_buf == NULL) {
Packit c4476c
        UIerr(UI_F_GENERAL_ALLOCATE_PROMPT, UI_R_NO_RESULT_BUFFER);
Packit c4476c
    } else if ((ret = OPENSSL_malloc(sizeof(*ret))) != NULL) {
Packit c4476c
        ret->out_string = prompt;
Packit c4476c
        ret->flags = prompt_freeable ? OUT_STRING_FREEABLE : 0;
Packit c4476c
        ret->input_flags = input_flags;
Packit c4476c
        ret->type = type;
Packit c4476c
        ret->result_buf = result_buf;
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int general_allocate_string(UI *ui, const char *prompt,
Packit c4476c
                                   int prompt_freeable,
Packit c4476c
                                   enum UI_string_types type, int input_flags,
Packit c4476c
                                   char *result_buf, int minsize, int maxsize,
Packit c4476c
                                   const char *test_buf)
Packit c4476c
{
Packit c4476c
    int ret = -1;
Packit c4476c
    UI_STRING *s = general_allocate_prompt(ui, prompt, prompt_freeable,
Packit c4476c
                                           type, input_flags, result_buf);
Packit c4476c
Packit c4476c
    if (s != NULL) {
Packit c4476c
        if (allocate_string_stack(ui) >= 0) {
Packit c4476c
            s->_.string_data.result_minsize = minsize;
Packit c4476c
            s->_.string_data.result_maxsize = maxsize;
Packit c4476c
            s->_.string_data.test_buf = test_buf;
Packit c4476c
            ret = sk_UI_STRING_push(ui->strings, s);
Packit c4476c
            /* sk_push() returns 0 on error.  Let's adapt that */
Packit c4476c
            if (ret <= 0) {
Packit c4476c
                ret--;
Packit c4476c
                free_string(s);
Packit c4476c
            }
Packit c4476c
        } else
Packit c4476c
            free_string(s);
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int general_allocate_boolean(UI *ui,
Packit c4476c
                                    const char *prompt,
Packit c4476c
                                    const char *action_desc,
Packit c4476c
                                    const char *ok_chars,
Packit c4476c
                                    const char *cancel_chars,
Packit c4476c
                                    int prompt_freeable,
Packit c4476c
                                    enum UI_string_types type,
Packit c4476c
                                    int input_flags, char *result_buf)
Packit c4476c
{
Packit c4476c
    int ret = -1;
Packit c4476c
    UI_STRING *s;
Packit c4476c
    const char *p;
Packit c4476c
Packit c4476c
    if (ok_chars == NULL) {
Packit c4476c
        UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN, ERR_R_PASSED_NULL_PARAMETER);
Packit c4476c
    } else if (cancel_chars == NULL) {
Packit c4476c
        UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN, ERR_R_PASSED_NULL_PARAMETER);
Packit c4476c
    } else {
Packit c4476c
        for (p = ok_chars; *p != '\0'; p++) {
Packit c4476c
            if (strchr(cancel_chars, *p) != NULL) {
Packit c4476c
                UIerr(UI_F_GENERAL_ALLOCATE_BOOLEAN,
Packit c4476c
                      UI_R_COMMON_OK_AND_CANCEL_CHARACTERS);
Packit c4476c
            }
Packit c4476c
        }
Packit c4476c
Packit c4476c
        s = general_allocate_prompt(ui, prompt, prompt_freeable,
Packit c4476c
                                    type, input_flags, result_buf);
Packit c4476c
Packit c4476c
        if (s != NULL) {
Packit c4476c
            if (allocate_string_stack(ui) >= 0) {
Packit c4476c
                s->_.boolean_data.action_desc = action_desc;
Packit c4476c
                s->_.boolean_data.ok_chars = ok_chars;
Packit c4476c
                s->_.boolean_data.cancel_chars = cancel_chars;
Packit c4476c
                ret = sk_UI_STRING_push(ui->strings, s);
Packit c4476c
                /*
Packit c4476c
                 * sk_push() returns 0 on error. Let's adapt that
Packit c4476c
                 */
Packit c4476c
                if (ret <= 0) {
Packit c4476c
                    ret--;
Packit c4476c
                    free_string(s);
Packit c4476c
                }
Packit c4476c
            } else
Packit c4476c
                free_string(s);
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * Returns the index to the place in the stack or -1 for error.  Uses a
Packit c4476c
 * direct reference to the prompt.
Packit c4476c
 */
Packit c4476c
int UI_add_input_string(UI *ui, const char *prompt, int flags,
Packit c4476c
                        char *result_buf, int minsize, int maxsize)
Packit c4476c
{
Packit c4476c
    return general_allocate_string(ui, prompt, 0,
Packit c4476c
                                   UIT_PROMPT, flags, result_buf, minsize,
Packit c4476c
                                   maxsize, NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
/* Same as UI_add_input_string(), excepts it takes a copy of the prompt */
Packit c4476c
int UI_dup_input_string(UI *ui, const char *prompt, int flags,
Packit c4476c
                        char *result_buf, int minsize, int maxsize)
Packit c4476c
{
Packit c4476c
    char *prompt_copy = NULL;
Packit c4476c
Packit c4476c
    if (prompt != NULL) {
Packit c4476c
        prompt_copy = OPENSSL_strdup(prompt);
Packit c4476c
        if (prompt_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_INPUT_STRING, ERR_R_MALLOC_FAILURE);
Packit c4476c
            return 0;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    return general_allocate_string(ui, prompt_copy, 1,
Packit c4476c
                                   UIT_PROMPT, flags, result_buf, minsize,
Packit c4476c
                                   maxsize, NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_add_verify_string(UI *ui, const char *prompt, int flags,
Packit c4476c
                         char *result_buf, int minsize, int maxsize,
Packit c4476c
                         const char *test_buf)
Packit c4476c
{
Packit c4476c
    return general_allocate_string(ui, prompt, 0,
Packit c4476c
                                   UIT_VERIFY, flags, result_buf, minsize,
Packit c4476c
                                   maxsize, test_buf);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_dup_verify_string(UI *ui, const char *prompt, int flags,
Packit c4476c
                         char *result_buf, int minsize, int maxsize,
Packit c4476c
                         const char *test_buf)
Packit c4476c
{
Packit c4476c
    char *prompt_copy = NULL;
Packit c4476c
Packit c4476c
    if (prompt != NULL) {
Packit c4476c
        prompt_copy = OPENSSL_strdup(prompt);
Packit c4476c
        if (prompt_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_VERIFY_STRING, ERR_R_MALLOC_FAILURE);
Packit c4476c
            return -1;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    return general_allocate_string(ui, prompt_copy, 1,
Packit c4476c
                                   UIT_VERIFY, flags, result_buf, minsize,
Packit c4476c
                                   maxsize, test_buf);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_add_input_boolean(UI *ui, const char *prompt, const char *action_desc,
Packit c4476c
                         const char *ok_chars, const char *cancel_chars,
Packit c4476c
                         int flags, char *result_buf)
Packit c4476c
{
Packit c4476c
    return general_allocate_boolean(ui, prompt, action_desc,
Packit c4476c
                                    ok_chars, cancel_chars, 0, UIT_BOOLEAN,
Packit c4476c
                                    flags, result_buf);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_dup_input_boolean(UI *ui, const char *prompt, const char *action_desc,
Packit c4476c
                         const char *ok_chars, const char *cancel_chars,
Packit c4476c
                         int flags, char *result_buf)
Packit c4476c
{
Packit c4476c
    char *prompt_copy = NULL;
Packit c4476c
    char *action_desc_copy = NULL;
Packit c4476c
    char *ok_chars_copy = NULL;
Packit c4476c
    char *cancel_chars_copy = NULL;
Packit c4476c
Packit c4476c
    if (prompt != NULL) {
Packit c4476c
        prompt_copy = OPENSSL_strdup(prompt);
Packit c4476c
        if (prompt_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
Packit c4476c
            goto err;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (action_desc != NULL) {
Packit c4476c
        action_desc_copy = OPENSSL_strdup(action_desc);
Packit c4476c
        if (action_desc_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
Packit c4476c
            goto err;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (ok_chars != NULL) {
Packit c4476c
        ok_chars_copy = OPENSSL_strdup(ok_chars);
Packit c4476c
        if (ok_chars_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
Packit c4476c
            goto err;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (cancel_chars != NULL) {
Packit c4476c
        cancel_chars_copy = OPENSSL_strdup(cancel_chars);
Packit c4476c
        if (cancel_chars_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_INPUT_BOOLEAN, ERR_R_MALLOC_FAILURE);
Packit c4476c
            goto err;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    return general_allocate_boolean(ui, prompt_copy, action_desc_copy,
Packit c4476c
                                    ok_chars_copy, cancel_chars_copy, 1,
Packit c4476c
                                    UIT_BOOLEAN, flags, result_buf);
Packit c4476c
 err:
Packit c4476c
    OPENSSL_free(prompt_copy);
Packit c4476c
    OPENSSL_free(action_desc_copy);
Packit c4476c
    OPENSSL_free(ok_chars_copy);
Packit c4476c
    OPENSSL_free(cancel_chars_copy);
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_add_info_string(UI *ui, const char *text)
Packit c4476c
{
Packit c4476c
    return general_allocate_string(ui, text, 0, UIT_INFO, 0, NULL, 0, 0,
Packit c4476c
                                   NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_dup_info_string(UI *ui, const char *text)
Packit c4476c
{
Packit c4476c
    char *text_copy = NULL;
Packit c4476c
Packit c4476c
    if (text != NULL) {
Packit c4476c
        text_copy = OPENSSL_strdup(text);
Packit c4476c
        if (text_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_INFO_STRING, ERR_R_MALLOC_FAILURE);
Packit c4476c
            return -1;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    return general_allocate_string(ui, text_copy, 1, UIT_INFO, 0, NULL,
Packit c4476c
                                   0, 0, NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_add_error_string(UI *ui, const char *text)
Packit c4476c
{
Packit c4476c
    return general_allocate_string(ui, text, 0, UIT_ERROR, 0, NULL, 0, 0,
Packit c4476c
                                   NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_dup_error_string(UI *ui, const char *text)
Packit c4476c
{
Packit c4476c
    char *text_copy = NULL;
Packit c4476c
Packit c4476c
    if (text != NULL) {
Packit c4476c
        text_copy = OPENSSL_strdup(text);
Packit c4476c
        if (text_copy == NULL) {
Packit c4476c
            UIerr(UI_F_UI_DUP_ERROR_STRING, ERR_R_MALLOC_FAILURE);
Packit c4476c
            return -1;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    return general_allocate_string(ui, text_copy, 1, UIT_ERROR, 0, NULL,
Packit c4476c
                                   0, 0, NULL);
Packit c4476c
}
Packit c4476c
Packit c4476c
char *UI_construct_prompt(UI *ui, const char *object_desc,
Packit c4476c
                          const char *object_name)
Packit c4476c
{
Packit c4476c
    char *prompt = NULL;
Packit c4476c
Packit c4476c
    if (ui->meth->ui_construct_prompt != NULL)
Packit c4476c
        prompt = ui->meth->ui_construct_prompt(ui, object_desc, object_name);
Packit c4476c
    else {
Packit c4476c
        char prompt1[] = "Enter ";
Packit c4476c
        char prompt2[] = " for ";
Packit c4476c
        char prompt3[] = ":";
Packit c4476c
        int len = 0;
Packit c4476c
Packit c4476c
        if (object_desc == NULL)
Packit c4476c
            return NULL;
Packit c4476c
        len = sizeof(prompt1) - 1 + strlen(object_desc);
Packit c4476c
        if (object_name != NULL)
Packit c4476c
            len += sizeof(prompt2) - 1 + strlen(object_name);
Packit c4476c
        len += sizeof(prompt3) - 1;
Packit c4476c
Packit c4476c
        if ((prompt = OPENSSL_malloc(len + 1)) == NULL) {
Packit c4476c
            UIerr(UI_F_UI_CONSTRUCT_PROMPT, ERR_R_MALLOC_FAILURE);
Packit c4476c
            return NULL;
Packit c4476c
        }
Packit c4476c
        OPENSSL_strlcpy(prompt, prompt1, len + 1);
Packit c4476c
        OPENSSL_strlcat(prompt, object_desc, len + 1);
Packit c4476c
        if (object_name != NULL) {
Packit c4476c
            OPENSSL_strlcat(prompt, prompt2, len + 1);
Packit c4476c
            OPENSSL_strlcat(prompt, object_name, len + 1);
Packit c4476c
        }
Packit c4476c
        OPENSSL_strlcat(prompt, prompt3, len + 1);
Packit c4476c
    }
Packit c4476c
    return prompt;
Packit c4476c
}
Packit c4476c
Packit c4476c
void *UI_add_user_data(UI *ui, void *user_data)
Packit c4476c
{
Packit c4476c
    void *old_data = ui->user_data;
Packit c4476c
Packit c4476c
    if ((ui->flags & UI_FLAG_DUPL_DATA) != 0) {
Packit c4476c
        ui->meth->ui_destroy_data(ui, old_data);
Packit c4476c
        old_data = NULL;
Packit c4476c
    }
Packit c4476c
    ui->user_data = user_data;
Packit c4476c
    ui->flags &= ~UI_FLAG_DUPL_DATA;
Packit c4476c
    return old_data;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_dup_user_data(UI *ui, void *user_data)
Packit c4476c
{
Packit c4476c
    void *duplicate = NULL;
Packit c4476c
Packit c4476c
    if (ui->meth->ui_duplicate_data == NULL
Packit c4476c
        || ui->meth->ui_destroy_data == NULL) {
Packit c4476c
        UIerr(UI_F_UI_DUP_USER_DATA, UI_R_USER_DATA_DUPLICATION_UNSUPPORTED);
Packit c4476c
        return -1;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    duplicate = ui->meth->ui_duplicate_data(ui, user_data);
Packit c4476c
    if (duplicate == NULL) {
Packit c4476c
        UIerr(UI_F_UI_DUP_USER_DATA, ERR_R_MALLOC_FAILURE);
Packit c4476c
        return -1;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    (void)UI_add_user_data(ui, duplicate);
Packit c4476c
    ui->flags |= UI_FLAG_DUPL_DATA;
Packit c4476c
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
void *UI_get0_user_data(UI *ui)
Packit c4476c
{
Packit c4476c
    return ui->user_data;
Packit c4476c
}
Packit c4476c
Packit c4476c
const char *UI_get0_result(UI *ui, int i)
Packit c4476c
{
Packit c4476c
    if (i < 0) {
Packit c4476c
        UIerr(UI_F_UI_GET0_RESULT, UI_R_INDEX_TOO_SMALL);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
    if (i >= sk_UI_STRING_num(ui->strings)) {
Packit c4476c
        UIerr(UI_F_UI_GET0_RESULT, UI_R_INDEX_TOO_LARGE);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
    return UI_get0_result_string(sk_UI_STRING_value(ui->strings, i));
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_get_result_length(UI *ui, int i)
Packit c4476c
{
Packit c4476c
    if (i < 0) {
Packit c4476c
        UIerr(UI_F_UI_GET_RESULT_LENGTH, UI_R_INDEX_TOO_SMALL);
Packit c4476c
        return -1;
Packit c4476c
    }
Packit c4476c
    if (i >= sk_UI_STRING_num(ui->strings)) {
Packit c4476c
        UIerr(UI_F_UI_GET_RESULT_LENGTH, UI_R_INDEX_TOO_LARGE);
Packit c4476c
        return -1;
Packit c4476c
    }
Packit c4476c
    return UI_get_result_string_length(sk_UI_STRING_value(ui->strings, i));
Packit c4476c
}
Packit c4476c
Packit c4476c
static int print_error(const char *str, size_t len, UI *ui)
Packit c4476c
{
Packit c4476c
    UI_STRING uis;
Packit c4476c
Packit c4476c
    memset(&uis, 0, sizeof(uis));
Packit c4476c
    uis.type = UIT_ERROR;
Packit c4476c
    uis.out_string = str;
Packit c4476c
Packit c4476c
    if (ui->meth->ui_write_string != NULL
Packit c4476c
        && ui->meth->ui_write_string(ui, &uis) <= 0)
Packit c4476c
        return -1;
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_process(UI *ui)
Packit c4476c
{
Packit c4476c
    int i, ok = 0;
Packit c4476c
    const char *state = "processing";
Packit c4476c
Packit c4476c
    if (ui->meth->ui_open_session != NULL
Packit c4476c
        && ui->meth->ui_open_session(ui) <= 0) {
Packit c4476c
        state = "opening session";
Packit c4476c
        ok = -1;
Packit c4476c
        goto err;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (ui->flags & UI_FLAG_PRINT_ERRORS)
Packit c4476c
        ERR_print_errors_cb((int (*)(const char *, size_t, void *))
Packit c4476c
                            print_error, (void *)ui);
Packit c4476c
Packit c4476c
    for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
Packit c4476c
        if (ui->meth->ui_write_string != NULL
Packit c4476c
            && (ui->meth->ui_write_string(ui,
Packit c4476c
                                          sk_UI_STRING_value(ui->strings, i))
Packit c4476c
                <= 0))
Packit c4476c
        {
Packit c4476c
            state = "writing strings";
Packit c4476c
            ok = -1;
Packit c4476c
            goto err;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (ui->meth->ui_flush != NULL)
Packit c4476c
        switch (ui->meth->ui_flush(ui)) {
Packit c4476c
        case -1:               /* Interrupt/Cancel/something... */
Packit c4476c
            ui->flags &= ~UI_FLAG_REDOABLE;
Packit c4476c
            ok = -2;
Packit c4476c
            goto err;
Packit c4476c
        case 0:                /* Errors */
Packit c4476c
            state = "flushing";
Packit c4476c
            ok = -1;
Packit c4476c
            goto err;
Packit c4476c
        default:               /* Success */
Packit c4476c
            ok = 0;
Packit c4476c
            break;
Packit c4476c
        }
Packit c4476c
Packit c4476c
    for (i = 0; i < sk_UI_STRING_num(ui->strings); i++) {
Packit c4476c
        if (ui->meth->ui_read_string != NULL) {
Packit c4476c
            switch (ui->meth->ui_read_string(ui,
Packit c4476c
                                             sk_UI_STRING_value(ui->strings,
Packit c4476c
                                                                i))) {
Packit c4476c
            case -1:           /* Interrupt/Cancel/something... */
Packit c4476c
                ui->flags &= ~UI_FLAG_REDOABLE;
Packit c4476c
                ok = -2;
Packit c4476c
                goto err;
Packit c4476c
            case 0:            /* Errors */
Packit c4476c
                state = "reading strings";
Packit c4476c
                ok = -1;
Packit c4476c
                goto err;
Packit c4476c
            default:           /* Success */
Packit c4476c
                ok = 0;
Packit c4476c
                break;
Packit c4476c
            }
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    state = NULL;
Packit c4476c
 err:
Packit c4476c
    if (ui->meth->ui_close_session != NULL
Packit c4476c
        && ui->meth->ui_close_session(ui) <= 0) {
Packit c4476c
        if (state == NULL)
Packit c4476c
            state = "closing session";
Packit c4476c
        ok = -1;
Packit c4476c
    }
Packit c4476c
Packit c4476c
    if (ok == -1) {
Packit c4476c
        UIerr(UI_F_UI_PROCESS, UI_R_PROCESSING_ERROR);
Packit c4476c
        ERR_add_error_data(2, "while ", state);
Packit c4476c
    }
Packit c4476c
    return ok;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_ctrl(UI *ui, int cmd, long i, void *p, void (*f) (void))
Packit c4476c
{
Packit c4476c
    if (ui == NULL) {
Packit c4476c
        UIerr(UI_F_UI_CTRL, ERR_R_PASSED_NULL_PARAMETER);
Packit c4476c
        return -1;
Packit c4476c
    }
Packit c4476c
    switch (cmd) {
Packit c4476c
    case UI_CTRL_PRINT_ERRORS:
Packit c4476c
        {
Packit c4476c
            int save_flag = ! !(ui->flags & UI_FLAG_PRINT_ERRORS);
Packit c4476c
            if (i)
Packit c4476c
                ui->flags |= UI_FLAG_PRINT_ERRORS;
Packit c4476c
            else
Packit c4476c
                ui->flags &= ~UI_FLAG_PRINT_ERRORS;
Packit c4476c
            return save_flag;
Packit c4476c
        }
Packit c4476c
    case UI_CTRL_IS_REDOABLE:
Packit c4476c
        return ! !(ui->flags & UI_FLAG_REDOABLE);
Packit c4476c
    default:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    UIerr(UI_F_UI_CTRL, UI_R_UNKNOWN_CONTROL_COMMAND);
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_set_ex_data(UI *r, int idx, void *arg)
Packit c4476c
{
Packit c4476c
    return CRYPTO_set_ex_data(&r->ex_data, idx, arg);
Packit c4476c
}
Packit c4476c
Packit c4476c
void *UI_get_ex_data(UI *r, int idx)
Packit c4476c
{
Packit c4476c
    return CRYPTO_get_ex_data(&r->ex_data, idx);
Packit c4476c
}
Packit c4476c
Packit c4476c
const UI_METHOD *UI_get_method(UI *ui)
Packit c4476c
{
Packit c4476c
    return ui->meth;
Packit c4476c
}
Packit c4476c
Packit c4476c
const UI_METHOD *UI_set_method(UI *ui, const UI_METHOD *meth)
Packit c4476c
{
Packit c4476c
    ui->meth = meth;
Packit c4476c
    return ui->meth;
Packit c4476c
}
Packit c4476c
Packit c4476c
UI_METHOD *UI_create_method(const char *name)
Packit c4476c
{
Packit c4476c
    UI_METHOD *ui_method = NULL;
Packit c4476c
Packit c4476c
    if ((ui_method = OPENSSL_zalloc(sizeof(*ui_method))) == NULL
Packit c4476c
        || (ui_method->name = OPENSSL_strdup(name)) == NULL
Packit c4476c
        || !CRYPTO_new_ex_data(CRYPTO_EX_INDEX_UI_METHOD, ui_method,
Packit c4476c
                               &ui_method->ex_data)) {
Packit c4476c
        if (ui_method)
Packit c4476c
            OPENSSL_free(ui_method->name);
Packit c4476c
        OPENSSL_free(ui_method);
Packit c4476c
        UIerr(UI_F_UI_CREATE_METHOD, ERR_R_MALLOC_FAILURE);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
    return ui_method;
Packit c4476c
}
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * BIG FSCKING WARNING!!!! If you use this on a statically allocated method
Packit c4476c
 * (that is, it hasn't been allocated using UI_create_method(), you deserve
Packit c4476c
 * anything Murphy can throw at you and more! You have been warned.
Packit c4476c
 */
Packit c4476c
void UI_destroy_method(UI_METHOD *ui_method)
Packit c4476c
{
Packit c4476c
    if (ui_method == NULL)
Packit c4476c
        return;
Packit c4476c
    CRYPTO_free_ex_data(CRYPTO_EX_INDEX_UI_METHOD, ui_method,
Packit c4476c
                        &ui_method->ex_data);
Packit c4476c
    OPENSSL_free(ui_method->name);
Packit c4476c
    ui_method->name = NULL;
Packit c4476c
    OPENSSL_free(ui_method);
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_opener(UI_METHOD *method, int (*opener) (UI *ui))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_open_session = opener;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_writer(UI_METHOD *method,
Packit c4476c
                         int (*writer) (UI *ui, UI_STRING *uis))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_write_string = writer;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_flusher(UI_METHOD *method, int (*flusher) (UI *ui))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_flush = flusher;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_reader(UI_METHOD *method,
Packit c4476c
                         int (*reader) (UI *ui, UI_STRING *uis))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_read_string = reader;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_closer(UI_METHOD *method, int (*closer) (UI *ui))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_close_session = closer;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_data_duplicator(UI_METHOD *method,
Packit c4476c
                                  void *(*duplicator) (UI *ui, void *ui_data),
Packit c4476c
                                  void (*destructor)(UI *ui, void *ui_data))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_duplicate_data = duplicator;
Packit c4476c
        method->ui_destroy_data = destructor;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_prompt_constructor(UI_METHOD *method,
Packit c4476c
                                     char *(*prompt_constructor) (UI *ui,
Packit c4476c
                                                                  const char
Packit c4476c
                                                                  *object_desc,
Packit c4476c
                                                                  const char
Packit c4476c
                                                                  *object_name))
Packit c4476c
{
Packit c4476c
    if (method != NULL) {
Packit c4476c
        method->ui_construct_prompt = prompt_constructor;
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_method_set_ex_data(UI_METHOD *method, int idx, void *data)
Packit c4476c
{
Packit c4476c
    return CRYPTO_set_ex_data(&method->ex_data, idx, data);
Packit c4476c
}
Packit c4476c
Packit c4476c
int (*UI_method_get_opener(const UI_METHOD *method)) (UI *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_open_session;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int (*UI_method_get_writer(const UI_METHOD *method)) (UI *, UI_STRING *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_write_string;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int (*UI_method_get_flusher(const UI_METHOD *method)) (UI *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_flush;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int (*UI_method_get_reader(const UI_METHOD *method)) (UI *, UI_STRING *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_read_string;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int (*UI_method_get_closer(const UI_METHOD *method)) (UI *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_close_session;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
char *(*UI_method_get_prompt_constructor(const UI_METHOD *method))
Packit c4476c
    (UI *, const char *, const char *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_construct_prompt;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
void *(*UI_method_get_data_duplicator(const UI_METHOD *method)) (UI *, void *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_duplicate_data;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
void (*UI_method_get_data_destructor(const UI_METHOD *method)) (UI *, void *)
Packit c4476c
{
Packit c4476c
    if (method != NULL)
Packit c4476c
        return method->ui_destroy_data;
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
const void *UI_method_get_ex_data(const UI_METHOD *method, int idx)
Packit c4476c
{
Packit c4476c
    return CRYPTO_get_ex_data(&method->ex_data, idx);
Packit c4476c
}
Packit c4476c
Packit c4476c
enum UI_string_types UI_get_string_type(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    return uis->type;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_get_input_flags(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    return uis->input_flags;
Packit c4476c
}
Packit c4476c
Packit c4476c
const char *UI_get0_output_string(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    return uis->out_string;
Packit c4476c
}
Packit c4476c
Packit c4476c
const char *UI_get0_action_string(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
        return uis->_.boolean_data.action_desc;
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
const char *UI_get0_result_string(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
        return uis->result_buf;
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_get_result_string_length(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
        return uis->result_len;
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
const char *UI_get0_test_string(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
        return uis->_.string_data.test_buf;
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return NULL;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_get_result_minsize(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
        return uis->_.string_data.result_minsize;
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_get_result_maxsize(UI_STRING *uis)
Packit c4476c
{
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
        return uis->_.string_data.result_maxsize;
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return -1;
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_set_result(UI *ui, UI_STRING *uis, const char *result)
Packit c4476c
{
Packit c4476c
#if 0
Packit c4476c
    /*
Packit c4476c
     * This is placed here solely to preserve UI_F_UI_SET_RESULT
Packit c4476c
     * To be removed for OpenSSL 1.2.0
Packit c4476c
     */
Packit c4476c
    UIerr(UI_F_UI_SET_RESULT, ERR_R_DISABLED);
Packit c4476c
#endif
Packit c4476c
    return UI_set_result_ex(ui, uis, result, strlen(result));
Packit c4476c
}
Packit c4476c
Packit c4476c
int UI_set_result_ex(UI *ui, UI_STRING *uis, const char *result, int len)
Packit c4476c
{
Packit c4476c
    ui->flags &= ~UI_FLAG_REDOABLE;
Packit c4476c
Packit c4476c
    switch (uis->type) {
Packit c4476c
    case UIT_PROMPT:
Packit c4476c
    case UIT_VERIFY:
Packit c4476c
        {
Packit c4476c
            char number1[DECIMAL_SIZE(uis->_.string_data.result_minsize) + 1];
Packit c4476c
            char number2[DECIMAL_SIZE(uis->_.string_data.result_maxsize) + 1];
Packit c4476c
Packit c4476c
            BIO_snprintf(number1, sizeof(number1), "%d",
Packit c4476c
                         uis->_.string_data.result_minsize);
Packit c4476c
            BIO_snprintf(number2, sizeof(number2), "%d",
Packit c4476c
                         uis->_.string_data.result_maxsize);
Packit c4476c
Packit c4476c
            if (len < uis->_.string_data.result_minsize) {
Packit c4476c
                ui->flags |= UI_FLAG_REDOABLE;
Packit c4476c
                UIerr(UI_F_UI_SET_RESULT_EX, UI_R_RESULT_TOO_SMALL);
Packit c4476c
                ERR_add_error_data(5, "You must type in ",
Packit c4476c
                                   number1, " to ", number2, " characters");
Packit c4476c
                return -1;
Packit c4476c
            }
Packit c4476c
            if (len > uis->_.string_data.result_maxsize) {
Packit c4476c
                ui->flags |= UI_FLAG_REDOABLE;
Packit c4476c
                UIerr(UI_F_UI_SET_RESULT_EX, UI_R_RESULT_TOO_LARGE);
Packit c4476c
                ERR_add_error_data(5, "You must type in ",
Packit c4476c
                                   number1, " to ", number2, " characters");
Packit c4476c
                return -1;
Packit c4476c
            }
Packit c4476c
        }
Packit c4476c
Packit c4476c
        if (uis->result_buf == NULL) {
Packit c4476c
            UIerr(UI_F_UI_SET_RESULT_EX, UI_R_NO_RESULT_BUFFER);
Packit c4476c
            return -1;
Packit c4476c
        }
Packit c4476c
Packit c4476c
        memcpy(uis->result_buf, result, len);
Packit c4476c
        if (len <= uis->_.string_data.result_maxsize)
Packit c4476c
            uis->result_buf[len] = '\0';
Packit c4476c
        uis->result_len = len;
Packit c4476c
        break;
Packit c4476c
    case UIT_BOOLEAN:
Packit c4476c
        {
Packit c4476c
            const char *p;
Packit c4476c
Packit c4476c
            if (uis->result_buf == NULL) {
Packit c4476c
                UIerr(UI_F_UI_SET_RESULT_EX, UI_R_NO_RESULT_BUFFER);
Packit c4476c
                return -1;
Packit c4476c
            }
Packit c4476c
Packit c4476c
            uis->result_buf[0] = '\0';
Packit c4476c
            for (p = result; *p; p++) {
Packit c4476c
                if (strchr(uis->_.boolean_data.ok_chars, *p)) {
Packit c4476c
                    uis->result_buf[0] = uis->_.boolean_data.ok_chars[0];
Packit c4476c
                    break;
Packit c4476c
                }
Packit c4476c
                if (strchr(uis->_.boolean_data.cancel_chars, *p)) {
Packit c4476c
                    uis->result_buf[0] = uis->_.boolean_data.cancel_chars[0];
Packit c4476c
                    break;
Packit c4476c
                }
Packit c4476c
            }
Packit c4476c
        }
Packit c4476c
    case UIT_NONE:
Packit c4476c
    case UIT_INFO:
Packit c4476c
    case UIT_ERROR:
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return 0;
Packit c4476c
}