/*------------------------------------------------------------------------------
 *
 * Copyright (c) 2011-2025, EURid vzw. All rights reserved.
 * The YADIFA TM software product is provided under the BSD 3-clause license:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *        * Redistributions of source code must retain the above copyright
 *          notice, this list of conditions and the following disclaimer.
 *        * Redistributions in binary form must reproduce the above copyright
 *          notice, this list of conditions and the following disclaimer in the
 *          documentation and/or other materials provided with the distribution.
 *        * Neither the name of EURid nor the names of its contributors may be
 *          used to endorse or promote products derived from this software
 *          without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *----------------------------------------------------------------------------*/

/**-----------------------------------------------------------------------------
 * @defgroup crypto
 * @ingroup dnscore
 * @brief
 *
 * @{
 *----------------------------------------------------------------------------*/

#pragma once
#include <dnscore/sys_types.h>

// #if SSL
#define SSL_ERROR_BASE        0x800f0000
#define SSL_ERROR_CODE(code_) ((int32_t)(SSL_ERROR_BASE + (code_)))
#define SSL_ERROR_MAKE_FROM_CATEGORY_ONLY(code_) SSL_ERROR_CODE(0xfff0 + (code_))  // only report the general category of the error
#define SSL_ERROR_CATEGORY_MAX 15

ya_result   crypto_init();

void        crypto_finalise();

/**
 * Decodes an SSL error.
 *
 * Logs the error on the system logger if the feature isn't disabled,
 * else prints on stderr using osformatln.
 *
 * Returns a proper YADIFA error code.
 *
 * The error may be translated.
 * e.g.
 *    0 for EOF
 *    MAKE_ERRNO_ERROR(EAGAIN) for non-blocking calls (but not exclusively)
 *    INVALID_STATE
 *    SSL-specific error code (SSL_ERROR_BASE + something)
 *
 * @param ssl the ssl object
 * @param n the code returned by the SSL function ( <= 0)
 * @return an error code
 */

ya_result   crypto_ssl_error(void *ssl_, int n);

ya_result   crypto_openssl_error();

void        crypto_preferred_ciphers_set(const char *preferred_ciphers);

const char *crypto_preferred_ciphers();

/** @} */
