1package eu.siacs.conversations.generator;
2
3import android.os.Bundle;
4import android.util.Base64;
5import android.util.Log;
6import eu.siacs.conversations.Config;
7import eu.siacs.conversations.crypto.axolotl.AxolotlService;
8import eu.siacs.conversations.entities.Account;
9import eu.siacs.conversations.entities.Conversation;
10import eu.siacs.conversations.entities.DownloadableFile;
11import eu.siacs.conversations.services.MessageArchiveService;
12import eu.siacs.conversations.services.XmppConnectionService;
13import eu.siacs.conversations.xml.Element;
14import eu.siacs.conversations.xml.Namespace;
15import eu.siacs.conversations.xmpp.Jid;
16import eu.siacs.conversations.xmpp.forms.Data;
17import eu.siacs.conversations.xmpp.pep.Avatar;
18import im.conversations.android.xmpp.model.stanza.Iq;
19import im.conversations.android.xmpp.model.upload.Request;
20import java.nio.ByteBuffer;
21import java.security.cert.CertificateEncodingException;
22import java.security.cert.X509Certificate;
23import java.util.ArrayList;
24import java.util.List;
25import java.util.Set;
26import java.util.UUID;
27import org.whispersystems.libsignal.IdentityKey;
28import org.whispersystems.libsignal.ecc.ECPublicKey;
29import org.whispersystems.libsignal.state.PreKeyRecord;
30import org.whispersystems.libsignal.state.SignedPreKeyRecord;
31
32public class IqGenerator extends AbstractGenerator {
33
34 public IqGenerator(final XmppConnectionService service) {
35 super(service);
36 }
37
38 public static Iq purgeOfflineMessages() {
39 final Iq packet = new Iq(Iq.Type.SET);
40 packet.addChild("offline", Namespace.FLEXIBLE_OFFLINE_MESSAGE_RETRIEVAL).addChild("purge");
41 return packet;
42 }
43
44 protected Iq publish(final String node, final Element item, final Bundle options) {
45 final var packet = new Iq(Iq.Type.SET);
46 final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB);
47 final Element publish = pubsub.addChild("publish");
48 publish.setAttribute("node", node);
49 publish.addChild(item);
50 if (options != null) {
51 final Element publishOptions = pubsub.addChild("publish-options");
52 publishOptions.addChild(Data.create(Namespace.PUBSUB_PUBLISH_OPTIONS, options));
53 }
54 return packet;
55 }
56
57 protected Iq publish(final String node, final Element item) {
58 return publish(node, item, null);
59 }
60
61 private Iq retrieve(String node, Element item) {
62 final var packet = new Iq(Iq.Type.GET);
63 final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB);
64 final Element items = pubsub.addChild("items");
65 items.setAttribute("node", node);
66 if (item != null) {
67 items.addChild(item);
68 }
69 return packet;
70 }
71
72 public Iq retrieveBookmarks() {
73 return retrieve(Namespace.BOOKMARKS2, null);
74 }
75
76 public Iq retrieveMds() {
77 return retrieve(Namespace.MDS_DISPLAYED, null);
78 }
79
80 public Iq publishNick(String nick) {
81 final Element item = new Element("item");
82 item.setAttribute("id", "current");
83 item.addChild("nick", Namespace.NICK).setContent(nick);
84 return publish(Namespace.NICK, item);
85 }
86
87 public Iq deleteNode(final String node) {
88 final var packet = new Iq(Iq.Type.SET);
89 final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB_OWNER);
90 pubsub.addChild("delete").setAttribute("node", node);
91 return packet;
92 }
93
94 public Iq deleteItem(final String node, final String id) {
95 final var packet = new Iq(Iq.Type.SET);
96 final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB);
97 final Element retract = pubsub.addChild("retract");
98 retract.setAttribute("node", node);
99 retract.setAttribute("notify", "true");
100 retract.addChild("item").setAttribute("id", id);
101 return packet;
102 }
103
104 public Iq publishAvatar(Avatar avatar, Bundle options) {
105 final Element item = new Element("item");
106 item.setAttribute("id", avatar.sha1sum);
107 final Element data = item.addChild("data", Namespace.AVATAR_DATA);
108 data.setContent(avatar.image);
109 return publish(Namespace.AVATAR_DATA, item, options);
110 }
111
112 public Iq publishElement(
113 final String namespace, final Element element, String id, final Bundle options) {
114 final Element item = new Element("item");
115 item.setAttribute("id", id);
116 item.addChild(element);
117 return publish(namespace, item, options);
118 }
119
120 public Iq publishAvatarMetadata(final Avatar avatar, final Bundle options) {
121 final Element item = new Element("item");
122 item.setAttribute("id", avatar.sha1sum);
123 final Element metadata = item.addChild("metadata", Namespace.AVATAR_METADATA);
124 final Element info = metadata.addChild("info");
125 info.setAttribute("bytes", avatar.size);
126 info.setAttribute("id", avatar.sha1sum);
127 info.setAttribute("height", avatar.height);
128 info.setAttribute("width", avatar.height);
129 info.setAttribute("type", avatar.type);
130 return publish(Namespace.AVATAR_METADATA, item, options);
131 }
132
133 public Iq retrievePepAvatar(final Avatar avatar) {
134 final Element item = new Element("item");
135 item.setAttribute("id", avatar.sha1sum);
136 final var packet = retrieve(Namespace.AVATAR_DATA, item);
137 packet.setTo(avatar.owner);
138 return packet;
139 }
140
141 public Iq retrieveVcardAvatar(final Avatar avatar) {
142 final Iq packet = new Iq(Iq.Type.GET);
143 packet.setTo(avatar.owner);
144 packet.addChild("vCard", "vcard-temp");
145 return packet;
146 }
147
148 public Iq retrieveVcardAvatar(final Jid to) {
149 final Iq packet = new Iq(Iq.Type.GET);
150 packet.setTo(to);
151 packet.addChild("vCard", "vcard-temp");
152 return packet;
153 }
154
155 public Iq retrieveAvatarMetaData(final Jid to) {
156 final Iq packet = retrieve("urn:xmpp:avatar:metadata", null);
157 if (to != null) {
158 packet.setTo(to);
159 }
160 return packet;
161 }
162
163 public Iq retrieveDeviceIds(final Jid to) {
164 final var packet = retrieve(AxolotlService.PEP_DEVICE_LIST, null);
165 if (to != null) {
166 packet.setTo(to);
167 }
168 return packet;
169 }
170
171 public Iq retrieveBundlesForDevice(final Jid to, final int deviceid) {
172 final var packet = retrieve(AxolotlService.PEP_BUNDLES + ":" + deviceid, null);
173 packet.setTo(to);
174 return packet;
175 }
176
177 public Iq retrieveVerificationForDevice(final Jid to, final int deviceid) {
178 final var packet = retrieve(AxolotlService.PEP_VERIFICATION + ":" + deviceid, null);
179 packet.setTo(to);
180 return packet;
181 }
182
183 public Iq publishDeviceIds(final Set<Integer> ids, final Bundle publishOptions) {
184 final Element item = new Element("item");
185 item.setAttribute("id", "current");
186 final Element list = item.addChild("list", AxolotlService.PEP_PREFIX);
187 for (Integer id : ids) {
188 final Element device = new Element("device");
189 device.setAttribute("id", id);
190 list.addChild(device);
191 }
192 return publish(AxolotlService.PEP_DEVICE_LIST, item, publishOptions);
193 }
194
195 public Element mdsDisplayed(final String stanzaId, final Conversation conversation) {
196 final Jid by;
197 if (conversation.getMode() == Conversation.MODE_MULTI) {
198 by = conversation.getJid().asBareJid();
199 } else {
200 by = conversation.getAccount().getJid().asBareJid();
201 }
202 return mdsDisplayed(stanzaId, by);
203 }
204
205 private Element mdsDisplayed(final String stanzaId, final Jid by) {
206 final Element displayed = new Element("displayed", Namespace.MDS_DISPLAYED);
207 final Element stanzaIdElement = displayed.addChild("stanza-id", Namespace.STANZA_IDS);
208 stanzaIdElement.setAttribute("id", stanzaId);
209 stanzaIdElement.setAttribute("by", by);
210 return displayed;
211 }
212
213 public Iq publishBundles(
214 final SignedPreKeyRecord signedPreKeyRecord,
215 final IdentityKey identityKey,
216 final Set<PreKeyRecord> preKeyRecords,
217 final int deviceId,
218 Bundle publishOptions) {
219 final Element item = new Element("item");
220 item.setAttribute("id", "current");
221 final Element bundle = item.addChild("bundle", AxolotlService.PEP_PREFIX);
222 final Element signedPreKeyPublic = bundle.addChild("signedPreKeyPublic");
223 signedPreKeyPublic.setAttribute("signedPreKeyId", signedPreKeyRecord.getId());
224 ECPublicKey publicKey = signedPreKeyRecord.getKeyPair().getPublicKey();
225 signedPreKeyPublic.setContent(Base64.encodeToString(publicKey.serialize(), Base64.NO_WRAP));
226 final Element signedPreKeySignature = bundle.addChild("signedPreKeySignature");
227 signedPreKeySignature.setContent(
228 Base64.encodeToString(signedPreKeyRecord.getSignature(), Base64.NO_WRAP));
229 final Element identityKeyElement = bundle.addChild("identityKey");
230 identityKeyElement.setContent(
231 Base64.encodeToString(identityKey.serialize(), Base64.NO_WRAP));
232
233 final Element prekeys = bundle.addChild("prekeys", AxolotlService.PEP_PREFIX);
234 for (PreKeyRecord preKeyRecord : preKeyRecords) {
235 final Element prekey = prekeys.addChild("preKeyPublic");
236 prekey.setAttribute("preKeyId", preKeyRecord.getId());
237 prekey.setContent(
238 Base64.encodeToString(
239 preKeyRecord.getKeyPair().getPublicKey().serialize(), Base64.NO_WRAP));
240 }
241
242 return publish(AxolotlService.PEP_BUNDLES + ":" + deviceId, item, publishOptions);
243 }
244
245 public Iq publishVerification(
246 byte[] signature, X509Certificate[] certificates, final int deviceId) {
247 final Element item = new Element("item");
248 item.setAttribute("id", "current");
249 final Element verification = item.addChild("verification", AxolotlService.PEP_PREFIX);
250 final Element chain = verification.addChild("chain");
251 for (int i = 0; i < certificates.length; ++i) {
252 try {
253 Element certificate = chain.addChild("certificate");
254 certificate.setContent(
255 Base64.encodeToString(certificates[i].getEncoded(), Base64.NO_WRAP));
256 certificate.setAttribute("index", i);
257 } catch (CertificateEncodingException e) {
258 Log.d(Config.LOGTAG, "could not encode certificate");
259 }
260 }
261 verification
262 .addChild("signature")
263 .setContent(Base64.encodeToString(signature, Base64.NO_WRAP));
264 return publish(AxolotlService.PEP_VERIFICATION + ":" + deviceId, item);
265 }
266
267 public Iq queryMessageArchiveManagement(final MessageArchiveService.Query mam) {
268 final Iq packet = new Iq(Iq.Type.SET);
269 final Element query = packet.query(mam.version.namespace);
270 query.setAttribute("queryid", mam.getQueryId());
271 final Data data = new Data();
272 data.setFormType(mam.version.namespace);
273 if (mam.muc()) {
274 packet.setTo(mam.getWith());
275 } else if (mam.getWith() != null) {
276 data.put("with", mam.getWith().toString());
277 }
278 final long start = mam.getStart();
279 final long end = mam.getEnd();
280 if (start != 0) {
281 data.put("start", getTimestamp(start));
282 }
283 if (end != 0) {
284 data.put("end", getTimestamp(end));
285 }
286 data.submit();
287 query.addChild(data);
288 Element set = query.addChild("set", "http://jabber.org/protocol/rsm");
289 if (mam.getPagingOrder() == MessageArchiveService.PagingOrder.REVERSE) {
290 set.addChild("before").setContent(mam.getReference());
291 } else if (mam.getReference() != null) {
292 set.addChild("after").setContent(mam.getReference());
293 }
294 set.addChild("max").setContent(String.valueOf(Config.PAGE_SIZE));
295 return packet;
296 }
297
298 public Iq generateSetPassword(final Account account, final String newPassword) {
299 final Iq packet = new Iq(Iq.Type.SET);
300 packet.setTo(account.getDomain());
301 final Element query = packet.addChild("query", Namespace.REGISTER);
302 final Jid jid = account.getJid();
303 query.addChild("username").setContent(jid.getLocal());
304 query.addChild("password").setContent(newPassword);
305 return packet;
306 }
307
308 public Iq changeAffiliation(Conversation conference, Jid jid, String affiliation) {
309 List<Jid> jids = new ArrayList<>();
310 jids.add(jid);
311 return changeAffiliation(conference, jids, affiliation);
312 }
313
314 public Iq changeAffiliation(Conversation conference, List<Jid> jids, String affiliation) {
315 final Iq packet = new Iq(Iq.Type.SET);
316 packet.setTo(conference.getJid().asBareJid());
317 packet.setFrom(conference.getAccount().getJid());
318 Element query = packet.query("http://jabber.org/protocol/muc#admin");
319 for (Jid jid : jids) {
320 Element item = query.addChild("item");
321 item.setAttribute("jid", jid);
322 item.setAttribute("affiliation", affiliation);
323 }
324 return packet;
325 }
326
327 public Iq changeRole(Conversation conference, String nick, String role) {
328 final Iq packet = new Iq(Iq.Type.SET);
329 packet.setTo(conference.getJid().asBareJid());
330 packet.setFrom(conference.getAccount().getJid());
331 Element item = packet.query("http://jabber.org/protocol/muc#admin").addChild("item");
332 item.setAttribute("nick", nick);
333 item.setAttribute("role", role);
334 return packet;
335 }
336
337 public Iq requestHttpUploadSlot(
338 final Jid host, final DownloadableFile file, final String mime) {
339 final Iq packet = new Iq(Iq.Type.GET);
340 packet.setTo(host);
341 final var request = packet.addExtension(new Request());
342 request.setFilename(convertFilename(file.getName()));
343 request.setSize(file.getExpectedSize());
344 return packet;
345 }
346
347 private static String convertFilename(String name) {
348 int pos = name.indexOf('.');
349 if (pos != -1) {
350 try {
351 UUID uuid = UUID.fromString(name.substring(0, pos));
352 ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
353 bb.putLong(uuid.getMostSignificantBits());
354 bb.putLong(uuid.getLeastSignificantBits());
355 return Base64.encodeToString(
356 bb.array(), Base64.URL_SAFE | Base64.NO_PADDING | Base64.NO_WRAP)
357 + name.substring(pos);
358 } catch (Exception e) {
359 return name;
360 }
361 } else {
362 return name;
363 }
364 }
365
366 public static Iq generateCreateAccountWithCaptcha(
367 final Account account, final String id, final Data data) {
368 final Iq register = new Iq(Iq.Type.SET);
369 register.setFrom(account.getJid().asBareJid());
370 register.setTo(account.getDomain());
371 register.setId(id);
372 Element query = register.query(Namespace.REGISTER);
373 if (data != null) {
374 query.addChild(data);
375 }
376 return register;
377 }
378
379 public Iq pushTokenToAppServer(Jid appServer, String token, String deviceId) {
380 return pushTokenToAppServer(appServer, token, deviceId, null);
381 }
382
383 public Iq pushTokenToAppServer(Jid appServer, String token, String deviceId, Jid muc) {
384 final Iq packet = new Iq(Iq.Type.SET);
385 packet.setTo(appServer);
386 final Element command = packet.addChild("command", Namespace.COMMANDS);
387 command.setAttribute("node", "register-push-fcm");
388 command.setAttribute("action", "execute");
389 final Data data = new Data();
390 data.put("token", token);
391 data.put("android-id", deviceId);
392 if (muc != null) {
393 data.put("muc", muc.toString());
394 }
395 data.submit();
396 command.addChild(data);
397 return packet;
398 }
399
400 public Iq unregisterChannelOnAppServer(Jid appServer, String deviceId, String channel) {
401 final Iq packet = new Iq(Iq.Type.SET);
402 packet.setTo(appServer);
403 final Element command = packet.addChild("command", Namespace.COMMANDS);
404 command.setAttribute("node", "unregister-push-fcm");
405 command.setAttribute("action", "execute");
406 final Data data = new Data();
407 data.put("channel", channel);
408 data.put("android-id", deviceId);
409 data.submit();
410 command.addChild(data);
411 return packet;
412 }
413
414 public Iq enablePush(final Jid jid, final String node, final String secret) {
415 final Iq packet = new Iq(Iq.Type.SET);
416 Element enable = packet.addChild("enable", Namespace.PUSH);
417 enable.setAttribute("jid", jid);
418 enable.setAttribute("node", node);
419 if (secret != null) {
420 Data data = new Data();
421 data.setFormType(Namespace.PUBSUB_PUBLISH_OPTIONS);
422 data.put("secret", secret);
423 data.submit();
424 enable.addChild(data);
425 }
426 return packet;
427 }
428
429 public Iq disablePush(final Jid jid, final String node) {
430 Iq packet = new Iq(Iq.Type.SET);
431 Element disable = packet.addChild("disable", Namespace.PUSH);
432 disable.setAttribute("jid", jid);
433 disable.setAttribute("node", node);
434 return packet;
435 }
436
437 public Iq queryAffiliation(Conversation conversation, String affiliation) {
438 final Iq packet = new Iq(Iq.Type.GET);
439 packet.setTo(conversation.getJid().asBareJid());
440 packet.query("http://jabber.org/protocol/muc#admin")
441 .addChild("item")
442 .setAttribute("affiliation", affiliation);
443 return packet;
444 }
445
446 public static Bundle defaultGroupChatConfiguration() {
447 Bundle options = new Bundle();
448 options.putString("muc#roomconfig_persistentroom", "1");
449 options.putString("muc#roomconfig_membersonly", "1");
450 options.putString("muc#roomconfig_publicroom", "0");
451 options.putString("muc#roomconfig_whois", "anyone");
452 options.putString("muc#roomconfig_changesubject", "0");
453 options.putString("muc#roomconfig_allowinvites", "0");
454 options.putString("muc#roomconfig_enablearchiving", "1"); // prosody
455 options.putString("mam", "1"); // ejabberd community
456 options.putString("muc#roomconfig_mam", "1"); // ejabberd saas
457 return options;
458 }
459
460 public static Bundle defaultChannelConfiguration() {
461 Bundle options = new Bundle();
462 options.putString("muc#roomconfig_persistentroom", "1");
463 options.putString("muc#roomconfig_membersonly", "0");
464 options.putString("muc#roomconfig_publicroom", "1");
465 options.putString("muc#roomconfig_whois", "moderators");
466 options.putString("muc#roomconfig_changesubject", "0");
467 options.putString("muc#roomconfig_enablearchiving", "1"); // prosody
468 options.putString("mam", "1"); // ejabberd community
469 options.putString("muc#roomconfig_mam", "1"); // ejabberd saas
470 return options;
471 }
472
473 public Iq requestPubsubConfiguration(Jid jid, String node) {
474 return pubsubConfiguration(jid, node, null);
475 }
476
477 public Iq publishPubsubConfiguration(Jid jid, String node, Data data) {
478 return pubsubConfiguration(jid, node, data);
479 }
480
481 private Iq pubsubConfiguration(Jid jid, String node, Data data) {
482 final Iq packet = new Iq(data == null ? Iq.Type.GET : Iq.Type.SET);
483 packet.setTo(jid);
484 Element pubsub = packet.addChild("pubsub", "http://jabber.org/protocol/pubsub#owner");
485 Element configure = pubsub.addChild("configure").setAttribute("node", node);
486 if (data != null) {
487 configure.addChild(data);
488 }
489 return packet;
490 }
491}