aboutsummaryrefslogtreecommitdiff
path: root/lib/olm/qolmoutboundsession.h
blob: a642f5819965cabfc76d82b3f6202ebf1081f043 (plain)
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
// SPDX-FileCopyrightText: 2021 Carl Schwan <carlschwan@kde.org>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#pragma once
#ifdef Quotient_E2EE_ENABLED

#include "olm/olm.h" // from Olm
#include "olm/errors.h"
#include "olm/e2ee.h"
#include <memory>

namespace Quotient {


//! An out-bound group session is responsible for encrypting outgoing
//! communication in a Megolm session.
class QOlmOutboundGroupSession
{
public:
    ~QOlmOutboundGroupSession();
    //! Creates a new instance of `QOlmOutboundGroupSession`.
    //! Throw OlmError on errors
    static std::unique_ptr<QOlmOutboundGroupSession> create();
    //! Serialises an `QOlmOutboundGroupSession` to encrypted Base64.
    std::variant<QByteArray, OlmError> pickle(const PicklingMode &mode);
    //! Deserialises from encrypted Base64 that was previously obtained by
    //! pickling a `QOlmOutboundGroupSession`.
    static std::variant<std::unique_ptr<QOlmOutboundGroupSession>, OlmError> unpickle(QByteArray &pickled, const PicklingMode &mode);
    //! Encrypts a plaintext message using the session.
    std::variant<QByteArray, OlmError> encrypt(const QString &plaintext);

    //! Get the current message index for this session.
    //!
    //! Each message is sent with an increasing index; this returns the
    //! index for the next message.
    uint32_t sessionMessageIndex() const;

    //! Get a base64-encoded identifier for this session.
    QByteArray sessionId() const;

    //! Get the base64-encoded current ratchet key for this session.
    //!
    //! Each message is sent with a different ratchet key. This function returns the
    //! ratchet key that will be used for the next message.
    std::variant<QByteArray, OlmError> sessionKey() const;
    QOlmOutboundGroupSession(OlmOutboundGroupSession *groupSession);
private:
    OlmOutboundGroupSession *m_groupSession;
};

using QOlmOutboundGroupSessionPtr = std::unique_ptr<QOlmOutboundGroupSession>;
}
#endif