Merge branch rexy

This commit is contained in:
rexy712 2021-09-05 14:27:27 -07:00
commit 3694b6e6d0
11 changed files with 167 additions and 26 deletions

1
.gitignore vendored
View File

@ -5,4 +5,5 @@ cmake-build-release
CMakeCache\.txt CMakeCache\.txt
pc/frnetlib.pc pc/frnetlib.pc
include/frnetlib/version.h include/frnetlib/version.h
*.swp
build build

View File

@ -14,7 +14,7 @@ Frnetlib is tested on both Linux and Windows and currently supports:
# Connecting to a Socket: # Connecting to a Socket:
```c++ ```c++
#include <TcpSocket.h> #include <frnetlib/TcpSocket.h>
fr::TcpSocket socket; fr::TcpSocket socket;
if(socket.connect("127.0.0.1", "8081", std::chrono::seconds(10)) != fr::Socket::Status::Success) if(socket.connect("127.0.0.1", "8081", std::chrono::seconds(10)) != fr::Socket::Status::Success)
@ -27,8 +27,8 @@ Here, we create a new fr::TcpSocket and connect it to an address. Simple. fr::Tc
# Listening and accepting connections: # Listening and accepting connections:
```c++ ```c++
#include <TcpSocket.h> #include <frnetlib/TcpSocket.h>
#include <TcpListener.h> #include <frnetlib/TcpListener.h>
fr::TcpListener listener; fr::TcpListener listener;
@ -51,14 +51,14 @@ Here we create a new fr::TcpListener, which is used to listen for incoming conne
# Using SSL # Using SSL
```c++ ```c++
#include <SSLSocket.h> #include <frnetlib/SSLSocket.h>
#include <SSLContext.h> #include <frnetlib/SSLContext.h>
#include <SSLListener.h> #include <frnetlib/SSLListener.h>
std::shared_ptr<fr::SSLContext> ssl_context(new fr::SSLContext("certs.crt")); //Creates a new 'SSL' context. This stores certificates and is shared between SSL enabled objects. std::shared_ptr<fr::SSLContext> ssl_context(new fr::SSLContext()); //Creates a new 'SSL' context. This stores certificates and is shared between SSL enabled objects.
ssl_conext->load_ca_certs_from_file(filepath); //This, or 'load_ca_certs_from_memory' should be called on the context, to load your SSL certificates. ssl_conext->load_ca_certs_from_file(filepath); //This, or 'load_ca_certs_from_memory' should be called on the context, to load your SSL certificates.
fr::SSLListener listener(ssl_context, "crt_path", "pem_path", "private_key_path"); //This is the SSL equivilent to fr::TcpListener fr::SSLListener listener(ssl_context, "pem_path", "private_key_path"); //This is the SSL equivilent to fr::TcpListener
fr::SSLSocket socket(ssl_context); //This is the SSL equivilent to fr::TcpSocket fr::SSLSocket socket(ssl_context); //This is the SSL equivilent to fr::TcpSocket
@ -71,7 +71,7 @@ SSLListener accepts a lot more arguments than its unencrypted counterpart, TcpLi
# Sending packets: # Sending packets:
```c++ ```c++
#include <Packet.h> #include <frnetlib/Packet.h>
fr::Packet packet; fr::Packet packet;
packet << "Hello there, I am" << (float)1.2 << "years old"; packet << "Hello there, I am" << (float)1.2 << "years old";
@ -101,8 +101,8 @@ Effectively the reverse of sending packets. We call fr::TcpSocket::receive, pass
# A simple HTTP server: # A simple HTTP server:
```c++ ```c++
#include <HttpRequest.h> #include <frnetlib/HttpRequest.h>
#include <HttpResponse.h> #include <frnetlib/HttpResponse.h>
fr::TcpSocket client; //fr::TcpSocket for HTTP. fr::SSLSocket for HTTPS. fr::TcpSocket client; //fr::TcpSocket for HTTP. fr::SSLSocket for HTTPS.
fr::TcpListener listener; //Use an fr::SSLListener if HTTPS. fr::TcpListener listener; //Use an fr::SSLListener if HTTPS.
@ -149,8 +149,8 @@ fr::HttpRequest objects are used for dealing with data being sent *to* the serve
# A simple HTTP client: # A simple HTTP client:
```c++ ```c++
#include <HttpRequest.h> #include <frnetlib/HttpRequest.h>
#include <HttpResponse.h> #include <frnetlib/HttpResponse.h>
//Connect to the website example.com on port 80, with a 10 second connection timeout //Connect to the website example.com on port 80, with a 10 second connection timeout
fr::TcpSocket socket; fr::TcpSocket socket;

View File

@ -81,6 +81,20 @@ namespace fr
*/ */
int32_t get_socket_descriptor() const override; int32_t get_socket_descriptor() const override;
/*!
* Gets the ssl context
*
* @return The SSLContext
*/
const std::shared_ptr<SSLContext> &get_ssl_context()const;
/*!
* Gets the ssl context
*
* @return The SSLContext
*/
std::shared_ptr<SSLContext> &get_ssl_context();
private: private:
mbedtls_net_context listen_fd; mbedtls_net_context listen_fd;
mbedtls_ssl_config conf; mbedtls_ssl_config conf;

View File

@ -21,9 +21,9 @@ namespace fr
public: public:
explicit SSLSocket(std::shared_ptr<SSLContext> ssl_context) noexcept; explicit SSLSocket(std::shared_ptr<SSLContext> ssl_context) noexcept;
~SSLSocket() override; ~SSLSocket() override;
SSLSocket(SSLSocket &&) = delete; SSLSocket(SSLSocket &&);
SSLSocket(const SSLSocket &) = delete; SSLSocket(const SSLSocket &) = delete;
void operator=(SSLSocket &&)=delete; SSLSocket &operator=(SSLSocket &&);
void operator=(const SSLSocket &)=delete; void operator=(const SSLSocket &)=delete;
/*! /*!
@ -126,6 +126,20 @@ namespace fr
return is_blocking; return is_blocking;
} }
/*!
* Gets the ssl context
*
* @return The SSLContext
*/
const std::shared_ptr<SSLContext> &get_ssl_context()const;
/*!
* Gets the ssl context
*
* @return The SSLContext
*/
std::shared_ptr<SSLContext> &get_ssl_context();
/*! /*!
* Checks to see if we're connected to a socket or not * Checks to see if we're connected to a socket or not
* *

View File

@ -52,10 +52,10 @@ namespace fr
}; };
Socket(); Socket();
Socket(Socket &&) =delete; Socket(Socket &&);
Socket(const Socket &) =delete; Socket(const Socket &) =delete;
void operator=(const Socket &) =delete; void operator=(const Socket &) =delete;
void operator=(Socket &&) =delete; Socket &operator=(Socket &&);
/*! /*!
* Converts an fr::Socket::Status value to a printable string * Converts an fr::Socket::Status value to a printable string

View File

@ -16,9 +16,9 @@ namespace fr
public: public:
TcpSocket() noexcept; TcpSocket() noexcept;
~TcpSocket() override; ~TcpSocket() override;
TcpSocket(TcpSocket &&) = delete; TcpSocket(TcpSocket &&);
TcpSocket(const TcpSocket &) = delete; TcpSocket(const TcpSocket &) = delete;
void operator=(TcpSocket &&)=delete; TcpSocket &operator=(TcpSocket &&);
void operator=(const TcpSocket &)=delete; void operator=(const TcpSocket &)=delete;
/*! /*!

40
include/frnetlib/Util.h Normal file
View File

@ -0,0 +1,40 @@
//
// Created by rexy712 on 06/25/2021.
//
#ifndef FRNETLIB_UTIL_H
#define FRNETLIB_UTIL_H
#include <mbedtls/ssl.h>
#include <cstdlib> //size_t
#include <cstring> //memcpy, memset
namespace fr
{
template<class T>
constexpr void swap(T& a, T& b)
{
T tmp = std::move(a);
a = std::move(b);
b = std::move(tmp);
}
template<class T, size_t N>
constexpr void swap(T (&a)[N], T (&b)[N])
{
for(size_t i = 0;i < N;++i)
{
swap(a[i], b[i]);
}
}
static inline mbedtls_ssl_config move_mbedtls_ssl_config(mbedtls_ssl_config &&src)
{
mbedtls_ssl_config retval = {};
memcpy(&retval, &src, sizeof(src));
memset(&src, 0, sizeof(src));
return retval;
}
}
#endif

View File

@ -171,6 +171,16 @@ namespace fr
} }
} }
const std::shared_ptr<SSLContext> &SSLListener::get_ssl_context()const
{
return ssl_context;
}
std::shared_ptr<SSLContext> &SSLListener::get_ssl_context()
{
return ssl_context;
}
bool SSLListener::connected() const bool SSLListener::connected() const
{ {
return listen_fd.fd > -1; return listen_fd.fd > -1;

View File

@ -3,6 +3,7 @@
// //
#include "frnetlib/SSLSocket.h" #include "frnetlib/SSLSocket.h"
#include "frnetlib/Util.h"
#include <memory> #include <memory>
#include <utility> #include <utility>
@ -58,6 +59,29 @@ namespace fr
mbedtls_ssl_config_free(&conf); mbedtls_ssl_config_free(&conf);
} }
SSLSocket::SSLSocket(SSLSocket &&s)
: Socket(std::move(s)),
ssl_context(std::move(s.ssl_context)),
ssl_socket_descriptor(std::move(s.ssl_socket_descriptor)),
ssl(std::move(s.ssl)),
conf(move_mbedtls_ssl_config(std::move(s.conf))),
should_verify(s.should_verify),
receive_timeout(s.receive_timeout),
is_blocking(s.is_blocking){}
SSLSocket &SSLSocket::operator=(SSLSocket &&s)
{
Socket::operator=(std::move(s));
ssl_context = std::move(s.ssl_context);
ssl_socket_descriptor = std::move(s.ssl_socket_descriptor);
ssl = std::move(s.ssl);
conf = move_mbedtls_ssl_config(std::move(s.conf));
should_verify = s.should_verify;
receive_timeout = s.receive_timeout;
is_blocking = s.is_blocking;
return *this;
}
void SSLSocket::close_socket() void SSLSocket::close_socket()
{ {
ssl = nullptr; ssl = nullptr;
@ -284,6 +308,14 @@ namespace fr
return -1; return -1;
return ssl_socket_descriptor->fd; return ssl_socket_descriptor->fd;
} }
const std::shared_ptr<SSLContext> &SSLSocket::get_ssl_context()const
{
return ssl_context;
}
std::shared_ptr<SSLContext> &SSLSocket::get_ssl_context()
{
return ssl_context;
}
bool SSLSocket::connected() const bool SSLSocket::connected() const
{ {

View File

@ -24,6 +24,23 @@ namespace fr
init_wsa(); init_wsa();
} }
Socket::Socket(Socket &&s)
: fr_socket_remote_address(std::move(s.fr_socket_remote_address)),
ai_family(s.ai_family),
max_receive_size(s.max_receive_size),
socket_read_timeout(s.socket_read_timeout),
socket_write_timeout(s.socket_write_timeout){}
Socket &Socket::operator=(Socket &&s)
{
fr_socket_remote_address = std::move(s.fr_socket_remote_address);
ai_family = s.ai_family;
max_receive_size = s.max_receive_size;
socket_read_timeout = s.socket_read_timeout;
socket_write_timeout = s.socket_write_timeout;
return *this;
}
Socket::Status Socket::send(const Sendable &obj) Socket::Status Socket::send(const Sendable &obj)
{ {
if(!connected()) if(!connected())

View File

@ -17,11 +17,24 @@ namespace fr
} }
TcpSocket::TcpSocket(TcpSocket &&t)
: Socket(std::move(t)),
socket_descriptor(std::exchange(t.socket_descriptor, -1)),
is_blocking(t.is_blocking){}
TcpSocket::~TcpSocket() TcpSocket::~TcpSocket()
{ {
TcpSocket::close_socket(); TcpSocket::close_socket();
} }
TcpSocket &TcpSocket::operator=(TcpSocket &&t)
{
Socket::operator=(std::move(t));
std::swap(socket_descriptor, t.socket_descriptor);
is_blocking = t.is_blocking;
return *this;
}
Socket::Status TcpSocket::send_raw(const char *data, size_t size, size_t &sent) Socket::Status TcpSocket::send_raw(const char *data, size_t size, size_t &sent)
{ {
while(sent < size) while(sent < size)