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