haraldwolff
/
aasdk
mirror of https://github.com/opencardev/aasdk
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Manual merge of commits from OpenCarDev aasdk 

* Swap getSize() to getFrameSize() and add totalSize() for completeness.
* Add SSL Error Logging
* Switch decrypt() to read the number of bytes from the frame size.
* Support FrameType descriptor
* Rework Message Handling
opencardev_merge
Matt Hilton 2022-02-14 23:45:13 +00:00
parent 1bc0fe69d5
commit f2388e8267
12 changed files with 148 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/aasdk/Messenger/Cryptor.hpp
View File

@ -37,7 +37,7 @@ public:
void deinit() override;
bool doHandshake() override;
size_t encrypt(common::Data& output, const common::DataConstBuffer& buffer) override;
size_t decrypt(common::Data& output, const common::DataConstBuffer& buffer) override;
size_t decrypt(common::Data& output, const common::DataConstBuffer& buffer, int length) override;
common::Data readHandshakeBuffer() override;
void writeHandshakeBuffer(const common::DataConstBuffer& buffer) override;

3
include/aasdk/Messenger/FrameSize.hpp
View File

@ -35,7 +35,8 @@ public:
FrameSize(const common::DataConstBuffer& buffer);
common::Data getData() const;
size_t getSize() const;
size_t getFrameSize() const;
size_t getTotalSize() const;
static size_t getSizeOf(FrameSizeType type);

3
include/aasdk/Messenger/FrameType.hpp
View File

@ -19,6 +19,7 @@
#pragma once
#include <stdint.h>
#include <string>
namespace aasdk
@ -34,5 +35,7 @@ enum class FrameType
BULK = FIRST | LAST
};
std::string frameTypeToString(FrameType frameType);
}
}

2
include/aasdk/Messenger/ICryptor.hpp
View File

@ -39,7 +39,7 @@ public:
virtual void deinit() = 0;
virtual bool doHandshake() = 0;
virtual size_t encrypt(common::Data& output, const common::DataConstBuffer& buffer) = 0;
virtual size_t decrypt(common::Data& output, const common::DataConstBuffer& buffer) = 0;
virtual size_t decrypt(common::Data& output, const common::DataConstBuffer& buffer, int length) = 0;
virtual common::Data readHandshakeBuffer() = 0;
virtual void writeHandshakeBuffer(const common::DataConstBuffer& buffer) = 0;
virtual bool isActive() const = 0;

8
include/aasdk/Messenger/MessageInStream.hpp
View File

@ -49,10 +49,16 @@ private:
boost::asio::io_service::strand strand_;
transport::ITransport::Pointer transport_;
ICryptor::Pointer cryptor_;
FrameType recentFrameType_;
FrameType thisFrameType_;
ReceivePromise::Pointer promise_;
ReceivePromise::Pointer interleavedPromise_;
Message::Pointer message_;
std::map<messenger::ChannelId, Message::Pointer> messageBuffer_;
int frameSize_;
bool isValidFrame_;
};
}

1
include/aasdk/Messenger/Messenger.hpp
View File

@ -57,6 +57,7 @@ private:
ChannelReceivePromiseQueue channelReceivePromiseQueue_;
ChannelReceiveMessageQueue channelReceiveMessageQueue_;
ChannelSendQueue channelSendPromiseQueue_;
};
}

20
src/Messenger/Cryptor.cpp
View File

@ -20,7 +20,7 @@
#include <functional>
#include <aasdk/Messenger/Cryptor.hpp>
#include <aasdk/Error/Error.hpp>
#include <aasdk/Common/Log.hpp>
namespace aasdk
{
@ -178,18 +178,23 @@ size_t Cryptor::encrypt(common::Data& output, const common::DataConstBuffer& buf
return this->read(output);
}
size_t Cryptor::decrypt(common::Data& output, const common::DataConstBuffer& buffer)
size_t Cryptor::decrypt(common::Data& output, const common::DataConstBuffer& buffer, int frameLength)
{
int overhead = 29;
int length = frameLength - overhead;
std::lock_guard<decltype(mutex_)> lock(mutex_);
this->write(buffer);
const size_t beginOffset = output.size();
output.resize(beginOffset + 1);
size_t availableBytes = 1;
size_t totalReadSize = 0;
size_t totalReadSize = 0; // Initialise
size_t availableBytes = length;
size_t readBytes = (length - totalReadSize) > 2048 ? 2048 : length - totalReadSize; // Calculate How many Bytes to Read
output.resize(output.size() + readBytes); // Resize Output to match the bytes we want to read
while(availableBytes > 0)
// We try to be a bit more explicit here, using the frame length from the frame itself rather than just blindly reading from the SSL buffer.
while(readBytes > 0)
{
const auto& currentBuffer = common::DataBuffer(output, totalReadSize + beginOffset);
auto readSize = sslWrapper_->sslRead(ssl_, currentBuffer.data, currentBuffer.size);
@ -201,7 +206,8 @@ size_t Cryptor::decrypt(common::Data& output, const common::DataConstBuffer& buf
totalReadSize += readSize;
availableBytes = sslWrapper_->getAvailableBytes(ssl_);
output.resize(output.size() + availableBytes);
readBytes = (length - totalReadSize) > 2048 ? 2048 : length - totalReadSize;
output.resize(output.size() + readBytes);
}
return totalReadSize;

9
src/Messenger/FrameSize.cpp
View File

@ -47,6 +47,7 @@ FrameSize::FrameSize(const common::DataConstBuffer& buffer)
{
frameSizeType_ = FrameSizeType::SHORT;
frameSize_ = boost::endian::big_to_native(reinterpret_cast<const uint16_t&>(buffer.cdata[0]));
totalSize_ = frameSize_;
}
if(buffer.size >= 6)
@ -74,11 +75,17 @@ common::Data FrameSize::getData() const
return data;
}
size_t FrameSize::getSize() const
size_t FrameSize::getFrameSize() const
{
return frameSize_;
}
size_t FrameSize::getTotalSize() const
{
return totalSize_;
}
size_t FrameSize::getSizeOf(FrameSizeType type)
{
return type == FrameSizeType::EXTENDED ? 6 : 2;

44
src/Messenger/FrameType.cpp 100644
View File

@ -0,0 +1,44 @@
/*
* This file is part of aasdk library project.
* Copyright (C) 2018 f1x.studio (Michal Szwaj)
*
* aasdk is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
* aasdk is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with aasdk. If not, see <http://www.gnu.org/licenses/>.
*/
#include <aasdk/Messenger/FrameType.hpp>
namespace aasdk
{
namespace messenger
{
std::string frameTypeToString(FrameType frameType)
{
switch(frameType)
{
case FrameType::MIDDLE:
return "MIDDLE";
case FrameType::FIRST:
return "FIRST";
case FrameType::LAST:
return "LAST";
case FrameType::BULK:
return "BULK";
default:
return "(null)";
}
}
}
}

102
src/Messenger/MessageInStream.cpp
View File

@ -18,7 +18,8 @@
#include <aasdk/Messenger/MessageInStream.hpp>
#include <aasdk/Error/Error.hpp>
#include <aasdk/Common/Log.hpp>
#include <iostream>
namespace aasdk
{
@ -36,24 +37,20 @@ MessageInStream::MessageInStream(boost::asio::io_service& ioService, transport::
void MessageInStream::startReceive(ReceivePromise::Pointer promise)
{
strand_.dispatch([this, self = this->shared_from_this(), promise = std::move(promise)]() mutable {
if(promise_ == nullptr)
{
if (promise_ == nullptr) {
promise_ = std::move(promise);
auto transportPromise = transport::ITransport::ReceivePromise::defer(strand_);
transportPromise->then(
[this, self = this->shared_from_this()](common::Data data) mutable {
this->receiveFrameHeaderHandler(common::DataConstBuffer(data));
},
[this, self = this->shared_from_this()](const error::Error& e) mutable {
promise_->reject(e);
promise_.reset();
});
[this, self = this->shared_from_this()](common::Data data) mutable {
this->receiveFrameHeaderHandler(common::DataConstBuffer(data));
},
[this, self = this->shared_from_this()](const error::Error &e) mutable {
promise_->reject(e);
promise_.reset();
});
transport_->receive(FrameHeader::getSizeOf(), std::move(transportPromise));
}
else
{
} else {
promise->reject(error::Error(error::ErrorCode::OPERATION_IN_PROGRESS));
}
});
@ -63,32 +60,35 @@ void MessageInStream::receiveFrameHeaderHandler(const common::DataConstBuffer& b
{
FrameHeader frameHeader(buffer);
if(message_ != nullptr && message_->getChannelId() != frameHeader.getChannelId())
{
messageBuffer_[message_->getChannelId()] = message_;
message_ = nullptr;
}
AASDK_LOG(debug) << "[MessageInStream] Processing Frame Header: Ch " << channelIdToString(frameHeader.getChannelId()) << " Fr " << frameTypeToString(frameHeader.getType());
isValidFrame_ = true;
auto bufferedMessage = messageBuffer_.find(frameHeader.getChannelId());
if (bufferedMessage != messageBuffer_.end()) {
// We have found a message...
message_ = std::move(bufferedMessage->second);
messageBuffer_.erase(bufferedMessage);
if(bufferedMessage != messageBuffer_.end())
{
if(frameHeader.getType() != FrameType::FIRST)
{
message_ = bufferedMessage->second;
}
else
{
AASDK_LOG(debug) << "[MessageInStream] Found existing message.";
if (frameHeader.getType() == FrameType::FIRST || frameHeader.getType() == FrameType::BULK) {
// If it's first or bulk, we need to override the message anyhow, so we will start again.
// Need to start a new message anyhow
message_ = std::make_shared<Message>(frameHeader.getChannelId(), frameHeader.getEncryptionType(), frameHeader.getMessageType());
}
messageBuffer_.erase(bufferedMessage);
}
else if(message_ == nullptr)
{
} else {
AASDK_LOG(debug) << "[MessageInStream] Could not find existing message.";
// No Message Found in Buffers and this is a middle or last frame, this an error.
// Still need to process the frame, but we will not resolve at the end.
message_ = std::make_shared<Message>(frameHeader.getChannelId(), frameHeader.getEncryptionType(), frameHeader.getMessageType());
if (frameHeader.getType() == FrameType::MIDDLE || frameHeader.getType() == FrameType::LAST) {
// This is an error
isValidFrame_ = false;
}
}
recentFrameType_ = frameHeader.getType();
thisFrameType_ = frameHeader.getType();
const size_t frameSize = FrameSize::getSizeOf(frameHeader.getType() == FrameType::FIRST ? FrameSizeType::EXTENDED : FrameSizeType::SHORT);
auto transportPromise = transport::ITransport::ReceivePromise::defer(strand_);
@ -119,7 +119,8 @@ void MessageInStream::receiveFrameSizeHandler(const common::DataConstBuffer& buf
});
FrameSize frameSize(buffer);
transport_->receive(frameSize.getSize(), std::move(transportPromise));
frameSize_ = (int) frameSize.getFrameSize();
transport_->receive(frameSize.getFrameSize(), std::move(transportPromise));
}
void MessageInStream::receiveFramePayloadHandler(const common::DataConstBuffer& buffer)
@ -128,7 +129,7 @@ void MessageInStream::receiveFramePayloadHandler(const common::DataConstBuffer&
{
try
{
cryptor_->decrypt(message_->getPayload(), buffer);
cryptor_->decrypt(message_->getPayload(), buffer, frameSize_);
}
catch(const error::Error& e)
{
@ -143,23 +144,34 @@ void MessageInStream::receiveFramePayloadHandler(const common::DataConstBuffer&
message_->insertPayload(buffer);
}
if(recentFrameType_ == FrameType::BULK || recentFrameType_ == FrameType::LAST)
bool isResolved = false;
// If this is the LAST frame or a BULK frame...
if((thisFrameType_ == FrameType::BULK || thisFrameType_ == FrameType::LAST) && isValidFrame_)
{
AASDK_LOG(debug) << "[MessageInStream] Resolving message.";
promise_->resolve(std::move(message_));
promise_.reset();
isResolved = true;
currentMessageIndex_--;
} else {
// First or Middle message, we'll store in our buffer...
messageBuffer_[message_->getChannelId()] = std::move(message_);
}
else
{
// If the main promise isn't resolved, then carry on retrieving frame headers.
if (!isResolved) {
auto transportPromise = transport::ITransport::ReceivePromise::defer(strand_);
transportPromise->then(
[this, self = this->shared_from_this()](common::Data data) mutable {
this->receiveFrameHeaderHandler(common::DataConstBuffer(data));
},
[this, self = this->shared_from_this()](const error::Error& e) mutable {
message_.reset();
promise_->reject(e);
promise_.reset();
});
[this, self = this->shared_from_this()](common::Data data) mutable {
this->receiveFrameHeaderHandler(common::DataConstBuffer(data));
},
[this, self = this->shared_from_this()](const error::Error& e) mutable {
message_.reset();
promise_->reject(e);
promise_.reset();
});
transport_->receive(FrameHeader::getSizeOf(), std::move(transportPromise));
}

6
src/Messenger/Messenger.cpp
View File

@ -19,7 +19,7 @@
#include <boost/endian/conversion.hpp>
#include <aasdk/Error/Error.hpp>
#include <aasdk/Messenger/Messenger.hpp>
#include <aasdk/Common/Log.hpp>
namespace aasdk
{
@ -37,7 +37,9 @@ Messenger::Messenger(boost::asio::io_service& ioService, IMessageInStream::Point
void Messenger::enqueueReceive(ChannelId channelId, ReceivePromise::Pointer promise)
{
// enqueueReceive is called from the service channel.
receiveStrand_.dispatch([this, self = this->shared_from_this(), channelId, promise = std::move(promise)]() mutable {
//If there's any messages on the channel, resolve. The channel will call enqueueReceive again.
if(!channelReceiveMessageQueue_.empty(channelId))
{
promise->resolve(std::move(channelReceiveMessageQueue_.pop(channelId)));
@ -73,12 +75,14 @@ void Messenger::inStreamMessageHandler(Message::Pointer message)
{
auto channelId = message->getChannelId();
// If there's a promise on the queue, we resolve the promise with this message....
if(channelReceivePromiseQueue_.isPending(channelId))
{
channelReceivePromiseQueue_.pop(channelId)->resolve(std::move(message));
}
else
{
// Or we push the message to the Message Queue for when we do get a promise
channelReceiveMessageQueue_.push(std::move(message));
}

7
src/Transport/SSLWrapper.cpp
View File

@ -22,7 +22,7 @@
#include <openssl/ssl.h>
#include <openssl/conf.h>
#include <aasdk/Transport/SSLWrapper.hpp>
#include <aasdk/Common/Log.hpp>
namespace aasdk
{
@ -48,6 +48,8 @@ SSLWrapper::~SSLWrapper()
ERR_remove_state(0);
#endif
ERR_free_strings();
ERR_load_crypto_strings();
ERR_load_ERR_strings();
}
X509* SSLWrapper::readCertificate(const std::string& certificate)
@ -187,6 +189,9 @@ int SSLWrapper::sslWrite(SSL *ssl, const void *buf, int num)
int SSLWrapper::getError(SSL* ssl, int returnCode)
{
while (auto err = ERR_get_error()) {
AASDK_LOG(error) << "[SSLWrapper] SSL Error " << ERR_error_string(err, NULL);
}
return SSL_get_error(ssl, returnCode);
}