aboutsummaryrefslogtreecommitdiff
path: root/lib/crypto/qolmsession.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/crypto/qolmsession.h')
-rw-r--r--lib/crypto/qolmsession.h92
1 files changed, 60 insertions, 32 deletions
diff --git a/lib/crypto/qolmsession.h b/lib/crypto/qolmsession.h
index 3be3c7fc..6e13801e 100644
--- a/lib/crypto/qolmsession.h
+++ b/lib/crypto/qolmsession.h
@@ -1,49 +1,77 @@
-// SPDX-FileCopyrightText: 2021 Carl Schwan <carlschwan@kde.org>
+// SPDX-FileCopyrightText: 2021 Alexey Andreyev <aa13q@ya.ru>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#pragma once
-#include <variant>
-#include <olm/olm.h>
+#ifdef Quotient_E2EE_ENABLED
+
+#include <QDebug>
+#include <olm/olm.h> // FIXME: OlmSession
#include "crypto/e2ee.h"
-#include "crypto/errors.h"
+#include "crypto/qolmmessage.h"
+#include "crypto/qolmerrors.h"
+#include "crypto/qolmaccount.h"
namespace Quotient {
-//! An encrypted Olm message.
-struct Message {
- QByteArray message;
-};
+class QOlmAccount;
+class QOlmSession;
-//! A encrypted Olm pre-key message.
-//!
-//! This message, unlike a normal Message, can be used to create new Olm sessions.
-struct PreKeyMessage
-{
- QByteArray message;
-};
-enum OlmMessageType
+//! Either an outbound or inbound session for secure communication.
+class QOlmSession
{
- PreKeyType,
- MessageType,
-};
+public:
+ ~QOlmSession();
+ //! Creates an inbound session for sending/receiving messages from a received 'prekey' message.
+ static std::variant<std::unique_ptr<QOlmSession>, QOlmError> createInboundSession(QOlmAccount *account, const QOlmMessage &preKeyMessage);
+ static std::variant<std::unique_ptr<QOlmSession>, QOlmError> createInboundSessionFrom(QOlmAccount *account, const QString &theirIdentityKey, const QOlmMessage &preKeyMessage);
+ static std::variant<std::unique_ptr<QOlmSession>, QOlmError> createOutboundSession(QOlmAccount *account, const QString &theirIdentityKey, const QString &theirOneTimeKey);
+ //! Serialises an `QOlmSession` to encrypted Base64.
+ std::variant<QByteArray, QOlmError> pickle(const PicklingMode &mode);
+ //! Deserialises from encrypted Base64 that was previously obtained by pickling a `QOlmSession`.
+ static std::variant<std::unique_ptr<QOlmSession>, QOlmError> unpickle(const QByteArray &pickled, const PicklingMode &mode);
+ //! Encrypts a plaintext message using the session.
+ QOlmMessage encrypt(const QString &plaintext);
-using OlmMessage = std::variant<Message, PreKeyMessage>;
+ //! Decrypts a message using this session. Decoding is lossy, meaing if
+ //! the decrypted plaintext contains invalid UTF-8 symbols, they will
+ //! be returned as `U+FFFD` (�).
+ std::variant<QString, QOlmError> decrypt(const QOlmMessage &message) const;
-std::optional<OlmMessage> fromTypeAndCipthertext(size_t messageType, const QByteArray &ciphertext);
+ //! Get a base64-encoded identifier for this session.
+ QByteArray sessionId() const;
-std::pair<OlmMessageType, QByteArray> toPair(const OlmMessage &message);
+ //! The type of the next message that will be returned from encryption.
+ QOlmMessage::Type encryptMessageType();
-//class QOlmSession
-//{
-// /// Creates an inbound session for sending/receiving messages from a received 'prekey' message.
-// static std::variant<std::unique_ptr<QOlmSession>, OlmError> createInboundSession(const QOlmAccount &account,
-// PreKeyMessage &message);
-//
-////private:
-// //static std::variant<std::unique_ptr<QOlmSession>, OlmError> createSessionWith(std::function<std::variant<size_t(OlmSession *)>> func);
-//}
+ //! Checker for any received messages for this session.
+ bool hasReceivedMessage() const;
+
+ //! Checks if the 'prekey' message is for this in-bound session.
+ std::variant<bool, QOlmError> matchesInboundSession(QOlmMessage &preKeyMessage);
+
+ friend bool operator<(const QOlmSession& lhs, const QOlmSession& rhs)
+ {
+ return lhs.sessionId() < rhs.sessionId();
+ }
+
+ friend bool operator<(const std::unique_ptr<QOlmSession> &lhs, const std::unique_ptr<QOlmSession> &rhs) {
+ return *lhs < *rhs;
+ }
+
+ QOlmSession(OlmSession* session);
+private:
+ //! Helper function for creating new sessions and handling errors.
+ static OlmSession* create();
+ static std::variant<std::unique_ptr<QOlmSession>, QOlmError> createInbound(QOlmAccount *account, const QOlmMessage& preKeyMessage, bool from = false, const QString& theirIdentityKey = "");
+ OlmSession* m_session;
+};
+
+
+//using QOlmSessionPtr = std::unique_ptr<QOlmSession>;
+
+} //namespace Quotient
-}
+#endif // Quotient_E2EE_ENABLED