blob: e8da63552665234ce15bb673834e56346d58caae (
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
|
// SPDX-FileCopyrightText: 2021 Carl Schwan <carlschwan@kde.org>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#pragma once
#include "e2ee/e2ee.h"
struct OlmInboundGroupSession;
namespace Quotient {
//! An in-bound group session is responsible for decrypting incoming
//! communication in a Megolm session.
class QUOTIENT_API QOlmInboundGroupSession
{
public:
~QOlmInboundGroupSession();
//! Creates a new instance of `OlmInboundGroupSession`.
static std::unique_ptr<QOlmInboundGroupSession> create(const QByteArray& key);
//! Import an inbound group session, from a previous export.
static std::unique_ptr<QOlmInboundGroupSession> import(const QByteArray& key);
//! Serialises an `OlmInboundGroupSession` to encrypted Base64.
QByteArray pickle(const PicklingMode &mode) const;
//! Deserialises from encrypted Base64 that was previously obtained by pickling
//! an `OlmInboundGroupSession`.
static QOlmExpected<QOlmInboundGroupSessionPtr> unpickle(
const QByteArray& pickled, const PicklingMode& mode);
//! Decrypts ciphertext received for this group session.
QOlmExpected<std::pair<QByteArray, uint32_t> > decrypt(const QByteArray& message);
//! Export the base64-encoded ratchet key for this session, at the given index,
//! in a format which can be used by import.
QOlmExpected<QByteArray> exportSession(uint32_t messageIndex);
//! Get the first message index we know how to decrypt.
uint32_t firstKnownIndex() const;
//! Get a base64-encoded identifier for this session.
QByteArray sessionId() const;
bool isVerified() const;
//! The olm session that this session was received from.
//! Required to get the device this session is from.
QString olmSessionId() const;
void setOlmSessionId(const QString& newOlmSessionId);
//! The sender of this session.
QString senderId() const;
void setSenderId(const QString& senderId);
OlmErrorCode lastErrorCode() const;
const char* lastError() const;
QOlmInboundGroupSession(OlmInboundGroupSession* session);
private:
OlmInboundGroupSession* m_groupSession;
QString m_olmSessionId;
QString m_senderId;
};
using QOlmInboundGroupSessionPtr = std::unique_ptr<QOlmInboundGroupSession>;
} // namespace Quotient
|