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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/*
* Copyright (C) 2008-2021 The QXmpp developers
*
* Author:
* Melvin Keskin <melvo@olomono.de>
*
* Source:
* https://github.com/qxmpp-project/qxmpp
*
* This file is a part of QXmpp library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
*/
///
/// \class QXmppTrustStorage
///
/// \brief The QXmppTrustStorage class stores trust data for end-to-end
/// encryption.
///
/// \warning THIS API IS NOT FINALIZED YET!
///
/// \since QXmpp 1.5
///
///
/// \fn QXmppTrustStorage::addOwnKey(const QString &encryption, const QString &keyId)
///
/// Adds an own key (i.e., the key used by this client instance).
///
/// \param encryption encryption protocol namespace
/// \param keyId ID of the key
///
///
/// \fn QXmppTrustStorage::removeOwnKey(const QString &encryption)
///
/// Removes an own key (i.e., the key used by this client instance).
///
/// \param encryption encryption protocol namespace
///
///
/// \fn QXmppTrustStorage::ownKey(const QString &encryption) const
///
/// Returns an own key (i.e., the key used by this client instance).
///
/// \param encryption encryption protocol namespace
///
/// \return the ID of the own key
///
///
/// \fn QXmppTrustStorage::addKeys(const QString &encryption, const QString &keyOwnerJid, const QList<QString> &keyIds, const QXmppTrustStorage::TrustLevel trustLevel)
///
/// Adds keys.
///
/// \param encryption encryption protocol namespace
/// \param keyOwnerJid key owner's bare JID
/// \param keyIds IDs of the keys
/// \param trustLevel trust level of the keys
///
///
/// \fn QXmppTrustStorage::removeKeys(const QString &encryption, const QList<QString> &keyIds)
///
/// Removes keys.
///
/// If keyIds is not passed, all keys for encryption are removed.
/// If encryption is also not passed, all keys are removed.
///
/// \param encryption encryption protocol namespace
/// \param keyIds IDs of the keys
///
///
/// \fn QXmppTrustStorage::keys(const QString &encryption, TrustLevels trustLevels = {}) const
///
/// Returns the JIDs of the key owners mapped to the IDs of their keys with a
/// specific trust level.
///
/// If no trust levels are passed, all keys are returned.
///
/// \param encryption encryption protocol namespace
/// \param trustLevels trust levels of the keys
///
/// \return the key owner JIDs mapped to their keys with a specific trust level
///
///
/// \fn QXmppTrustStorage::setTrustLevel(const QString &encryption, const QMultiHash<QString, QString> &keyIds, TrustLevel trustLevel)
///
/// Sets the trust level of keys.
///
/// If a key is not stored, it is added to the storage.
///
/// \param encryption encryption protocol namespace
/// \param keyIds key owners' bare JIDs mapped to the IDs of their keys
/// \param trustLevel trust level being set
///
///
/// \fn QXmppTrustStorage::setTrustLevel(const QString &encryption, const QList<QString> &keyOwnerJids, TrustLevel oldTrustLevel, TrustLevel newTrustLevel)
///
/// Sets the trust level of keys specified by their key owner and trust level.
///
/// \param encryption encryption protocol namespace
/// \param keyOwnerJids key owners' bare JIDs
/// \param oldTrustLevel trust level being changed
/// \param newTrustLevel trust level being set
///
///
/// \fn QXmppTrustStorage::trustLevel(const QString &encryption, const QString &keyId) const
///
/// Returns the trust level of a key.
///
/// If the key is not stored, it is seen as automatically distrusted.
///
/// \param encryption encryption protocol namespace
/// \param keyId ID of the key
///
/// \return the key's trust level
///
///
/// \fn QXmppTrustStorage::addKeysForPostponedTrustDecisions(const QString &encryption, const QString &senderKeyId, const QList<QXmppTrustMessageKeyOwner> &keyOwners)
///
/// Adds keys that cannot be authenticated or distrusted directly because the
/// key of the trust message's sender is not yet authenticated.
///
/// Those keys are being authenticated or distrusted once the sender's key is
/// authenticated.
/// Each element of keyOwners (i.e., keyOwner) can contain keys for postponed
/// authentication as trustedKeys or for postponed distrusting as
/// distrustedKeys.
///
/// If keys of keyOwner.trustedKeys() are already stored for postponed
/// distrusting, they are changed to be used for postponed authentication.
/// If keys of keyOwner.distrustedKeys() are already stored for postponed
/// authentication, they are changed to be used for postponed distrusting.
/// If the same keys are in keyOwner.trustedKeys() and
/// keyOwner.distrustedKeys(), they are used for postponed distrusting.
///
/// \param encryption encryption protocol namespace
/// \param senderKeyId key ID of the trust message's sender
/// \param keyOwners key owners containing key IDs for postponed trust decisions
///
///
/// \fn QXmppTrustStorage::removeKeysForPostponedTrustDecisions(const QString &encryption, const QList<QString> &keyIdsForAuthentication, const QList<QString> &keyIdsForDistrusting)
///
/// Removes keys for postponed authentication or distrusting.
///
/// \param encryption encryption protocol namespace
/// \param keyIdsForAuthentication IDs of the keys for postponed authentication
/// \param keyIdsForDistrusting IDs of the keys for postponed distrusting
///
///
/// \fn QXmppTrustStorage::removeKeysForPostponedTrustDecisions(const QString &encryption = {}, const QList<QString> &senderKeyIds = {})
///
/// Removes keys for postponed authentication or distrusting by the trust
/// message's sender's key ID.
///
/// If senderKeyIds is empty, all keys for encryption are removed.
/// If encryption is empty too, all keys are removed.
///
/// \param encryption encryption protocol namespace
/// \param senderKeyIds key IDs of the trust messages' senders
///
///
/// \fn QXmppTrustStorage::keysForPostponedTrustDecisions(const QString &encryption, const QList<QString> &senderKeyIds = {})
///
/// Returns the JIDs of key owners mapped to the IDs of their keys stored for
/// postponed authentication (true) or postponed distrusting (false).
///
/// If senderKeyIds is empty, all keys for encryption are returned.
///
/// \param encryption encryption protocol namespace
/// \param senderKeyIds key IDs of the trust messages' senders
///
/// \return the key owner JIDs mapped to their keys
///
|
