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