summaryrefslogtreecommitdiff
path: root/hiredis_ssl.h
diff options
context:
space:
mode:
authorAnna (navi) Figueiredo Gomes <navi@vlhl.dev>2024-03-22 20:06:01 +0100
committerAnna (navi) Figueiredo Gomes <navi@vlhl.dev>2024-03-22 21:08:51 +0100
commit31d934d19bf82efdfc320fa7008008242a65332a (patch)
tree8e89bcc49941adcbe0314f1a6a8117c7f11a6c0f /hiredis_ssl.h
parent107f1c4cee2ac6534c536efc3affae5e417e01fe (diff)
all: rename output files
Signed-off-by: Anna (navi) Figueiredo Gomes <navi@vlhl.dev>
Diffstat (limited to 'hiredis_ssl.h')
-rw-r--r--hiredis_ssl.h143
1 files changed, 0 insertions, 143 deletions
diff --git a/hiredis_ssl.h b/hiredis_ssl.h
deleted file mode 100644
index 43f072a..0000000
--- a/hiredis_ssl.h
+++ /dev/null
@@ -1,143 +0,0 @@
-/*
- * Copyright (c) 2019, Redis Labs
- *
- * SPDX-FileCopyrightText: 2024 Hiredict Contributors
- * SPDX-FileCopyrightText: 2024 Redis Labs
- *
- * SPDX-License-Identifier: BSD-3-Clause
- * SPDX-License-Identifier: LGPL-3.0-or-later
- *
- */
-
-#ifndef __HIREDIS_SSL_H
-#define __HIREDIS_SSL_H
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* This is the underlying struct for SSL in ssl.h, which is not included to
- * keep build dependencies short here.
- */
-struct ssl_st;
-
-/* A wrapper around OpenSSL SSL_CTX to allow easy SSL use without directly
- * calling OpenSSL.
- */
-typedef struct redisSSLContext redisSSLContext;
-
-/**
- * Initialization errors that redisCreateSSLContext() may return.
- */
-
-typedef enum {
- REDIS_SSL_CTX_NONE = 0, /* No Error */
- REDIS_SSL_CTX_CREATE_FAILED, /* Failed to create OpenSSL SSL_CTX */
- REDIS_SSL_CTX_CERT_KEY_REQUIRED, /* Client cert and key must both be specified or skipped */
- REDIS_SSL_CTX_CA_CERT_LOAD_FAILED, /* Failed to load CA Certificate or CA Path */
- REDIS_SSL_CTX_CLIENT_CERT_LOAD_FAILED, /* Failed to load client certificate */
- REDIS_SSL_CTX_CLIENT_DEFAULT_CERT_FAILED, /* Failed to set client default certificate directory */
- REDIS_SSL_CTX_PRIVATE_KEY_LOAD_FAILED, /* Failed to load private key */
- REDIS_SSL_CTX_OS_CERTSTORE_OPEN_FAILED, /* Failed to open system certificate store */
- REDIS_SSL_CTX_OS_CERT_ADD_FAILED /* Failed to add CA certificates obtained from system to the SSL context */
-} redisSSLContextError;
-
-/* Constants that mirror OpenSSL's verify modes. By default,
- * REDIS_SSL_VERIFY_PEER is used with redisCreateSSLContext().
- * Some Redis clients disable peer verification if there are no
- * certificates specified.
- */
-#define REDIS_SSL_VERIFY_NONE 0x00
-#define REDIS_SSL_VERIFY_PEER 0x01
-#define REDIS_SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
-#define REDIS_SSL_VERIFY_CLIENT_ONCE 0x04
-#define REDIS_SSL_VERIFY_POST_HANDSHAKE 0x08
-
-/* Options to create an OpenSSL context. */
-typedef struct {
- const char *cacert_filename;
- const char *capath;
- const char *cert_filename;
- const char *private_key_filename;
- const char *server_name;
- int verify_mode;
-} redisSSLOptions;
-
-/**
- * Return the error message corresponding with the specified error code.
- */
-
-const char *redisSSLContextGetError(redisSSLContextError error);
-
-/**
- * Helper function to initialize the OpenSSL library.
- *
- * OpenSSL requires one-time initialization before it can be used. Callers should
- * call this function only once, and only if OpenSSL is not directly initialized
- * elsewhere.
- */
-int redisInitOpenSSL(void);
-
-/**
- * Helper function to initialize an OpenSSL context that can be used
- * to initiate SSL connections.
- *
- * cacert_filename is an optional name of a CA certificate/bundle file to load
- * and use for validation.
- *
- * capath is an optional directory path where trusted CA certificate files are
- * stored in an OpenSSL-compatible structure.
- *
- * cert_filename and private_key_filename are optional names of a client side
- * certificate and private key files to use for authentication. They need to
- * be both specified or omitted.
- *
- * server_name is an optional and will be used as a server name indication
- * (SNI) TLS extension.
- *
- * If error is non-null, it will be populated in case the context creation fails
- * (returning a NULL).
- */
-
-redisSSLContext *redisCreateSSLContext(const char *cacert_filename, const char *capath,
- const char *cert_filename, const char *private_key_filename,
- const char *server_name, redisSSLContextError *error);
-
-/**
- * Helper function to initialize an OpenSSL context that can be used
- * to initiate SSL connections. This is a more extensible version of redisCreateSSLContext().
- *
- * options contains a structure of SSL options to use.
- *
- * If error is non-null, it will be populated in case the context creation fails
- * (returning a NULL).
-*/
-redisSSLContext *redisCreateSSLContextWithOptions(redisSSLOptions *options,
- redisSSLContextError *error);
-
-/**
- * Free a previously created OpenSSL context.
- */
-void redisFreeSSLContext(redisSSLContext *redis_ssl_ctx);
-
-/**
- * Initiate SSL on an existing redisContext.
- *
- * This is similar to redisInitiateSSL() but does not require the caller
- * to directly interact with OpenSSL, and instead uses a redisSSLContext
- * previously created using redisCreateSSLContext().
- */
-
-int redisInitiateSSLWithContext(redisContext *c, redisSSLContext *redis_ssl_ctx);
-
-/**
- * Initiate SSL/TLS negotiation on a provided OpenSSL SSL object.
- */
-
-int redisInitiateSSL(redisContext *c, struct ssl_st *ssl);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* __HIREDIS_SSL_H */