1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
|
// OpenVPN -- An application to securely tunnel IP networks
// over a single port, with support for SSL/TLS-based
// session authentication and key exchange,
// packet encryption, packet authentication, and
// packet compression.
//
// Copyright (C) 2012- OpenVPN Inc.
//
// SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
// This code implements an OpenSSL BIO object for streams based on the
// MemQ buffer queue object.
#pragma once
#include <cstring> // for std::strlen and others
#include <openssl/err.h>
#include <openssl/bio.h>
#include <openvpn/common/size.hpp>
#include <openvpn/common/numeric_util.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/frame/frame.hpp>
#include <openvpn/frame/memq_stream.hpp>
#include <openvpn/openssl/compat.hpp>
namespace openvpn::bmq_stream {
class MemQ : public MemQStream
{
public:
MemQ()
{
}
long ctrl(BIO *b, int cmd, long num, void *ptr)
{
long ret = 1;
switch (cmd)
{
case BIO_CTRL_RESET:
clear();
break;
case BIO_CTRL_EOF:
ret = (long)empty();
break;
case BIO_C_SET_BUF_MEM_EOF_RETURN:
return_eof_on_empty = (num == 0);
break;
case BIO_CTRL_GET_CLOSE:
ret = BIO_get_shutdown(b);
break;
case BIO_CTRL_SET_CLOSE:
BIO_set_shutdown(b, (int)num);
break;
case BIO_CTRL_WPENDING:
ret = 0L;
break;
case BIO_CTRL_PENDING:
ret = (long)pending();
break;
case BIO_CTRL_DUP:
case BIO_CTRL_FLUSH:
ret = 1;
break;
default:
// OPENVPN_LOG("*** MemQ-stream unimplemented ctrl method=" << cmd);
ret = 0;
break;
}
return (ret);
}
bool return_eof_on_empty = false;
};
class bio_memq_internal
{
public:
inline static int memq_method_type = -1;
inline static BIO_METHOD *memq_method = nullptr;
static inline int memq_new(BIO *b)
{
MemQ *bmq = new (std::nothrow) MemQ();
if (!bmq)
return 0;
BIO_set_shutdown(b, 1);
BIO_set_init(b, 1);
BIO_set_data(b, (void *)bmq);
return 1;
}
static inline int memq_free(BIO *b)
{
if (b == nullptr)
return (0);
if (BIO_get_shutdown(b))
{
MemQ *bmq = (MemQ *)(BIO_get_data(b));
if (BIO_get_init(b) && (bmq != nullptr))
{
delete bmq;
BIO_set_data(b, nullptr);
}
}
return 1;
}
static inline int memq_write(BIO *b, const char *in, int len)
{
MemQ *bmq = (MemQ *)(BIO_get_data(b));
if (in)
{
BIO_clear_retry_flags(b);
try
{
if (len)
bmq->write((const unsigned char *)in, (size_t)len);
return len;
}
catch (...)
{
BIOerr(BIO_F_MEM_WRITE, BIO_R_INVALID_ARGUMENT);
return -1;
}
}
else
{
BIOerr(BIO_F_MEM_WRITE, BIO_R_NULL_PARAMETER);
return -1;
}
}
static inline int memq_read(BIO *b, char *out, int size)
{
MemQ *bmq = (MemQ *)(BIO_get_data(b));
int ret = -1;
BIO_clear_retry_flags(b);
if (!bmq->empty())
{
try
{
ret = (int)bmq->read((unsigned char *)out, (size_t)size);
}
catch (...)
{
BIOerr(memq_method_type, BIO_R_INVALID_ARGUMENT);
return -1;
}
}
else
{
if (!bmq->return_eof_on_empty)
BIO_set_retry_read(b);
}
return ret;
}
static inline long memq_ctrl(BIO *b, int cmd, long arg1, void *arg2)
{
MemQ *bmq = (MemQ *)(BIO_get_data(b));
return bmq->ctrl(b, cmd, arg1, arg2);
}
static inline int memq_puts(BIO *b, const char *str)
{
int ret = -1;
auto len = std::strlen(str);
if (is_safe_conversion<int>(len))
{
ret = memq_write(b, str, static_cast<int>(len));
}
return ret;
}
static inline void init_static()
{
memq_method_type = BIO_get_new_index();
memq_method = BIO_meth_new(memq_method_type, "stream memory queue");
BIO_meth_set_write(memq_method, memq_write);
BIO_meth_set_read(memq_method, memq_read);
BIO_meth_set_puts(memq_method, memq_puts);
BIO_meth_set_create(memq_method, memq_new);
BIO_meth_set_destroy(memq_method, memq_free);
BIO_meth_set_gets(memq_method, nullptr);
BIO_meth_set_ctrl(memq_method, memq_ctrl);
}
static inline void free_bio_method()
{
BIO_meth_free(memq_method);
memq_method = nullptr;
}
}; // class bio_memq_internal
inline void init_static()
{
bio_memq_internal::init_static();
}
inline BIO_METHOD *BIO_s_memq(void)
{
return (bio_memq_internal::memq_method);
}
inline MemQ *memq_from_bio(BIO *b)
{
if (BIO_method_type(b) == bio_memq_internal::memq_method_type)
return (MemQ *)(BIO_get_data(b));
else
return nullptr;
}
inline const MemQ *const_memq_from_bio(const BIO *b)
{
if (BIO_method_type(b) == bio_memq_internal::memq_method_type)
return (const MemQ *)(BIO_get_data(const_cast<BIO *>(b)));
else
return nullptr;
}
} // namespace openvpn::bmq_stream
|