aboutsummaryrefslogtreecommitdiff
path: root/lib/e2ee/qolmoutboundsession.h
blob: e5e73ddffb1163aec09e5b6c243d29c7f2c6c406 (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
54
55
56
57
58
59
60
61
62
63
// SPDX-FileCopyrightText: 2021 Carl Schwan <carlschwan@kde.org>
//
// SPDX-License-Identifier: LGPL-2.1-or-later

#pragma once

#include "e2ee/e2ee.h"

struct OlmOutboundGroupSession;

namespace Quotient {

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

    //! Encrypts a plaintext message using the session.
    QOlmExpected<QByteArray> encrypt(const QByteArray& plaintext) const;

    //! 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.
    QOlmExpected<QByteArray> sessionKey() const;
    QOlmOutboundGroupSession(OlmOutboundGroupSession *groupSession);

    int messageCount() const;
    void setMessageCount(int messageCount);

    QDateTime creationTime() const;
    void setCreationTime(const QDateTime& creationTime);

    OlmErrorCode lastErrorCode() const;
    const char* lastError() const;

private:
    OlmOutboundGroupSession *m_groupSession;
    int m_messageCount = 0;
    QDateTime m_creationTime = QDateTime::currentDateTime();
};

} // namespace Quotient