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