IqGenerator.java

  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 Iq publishBundles(
196            final SignedPreKeyRecord signedPreKeyRecord,
197            final IdentityKey identityKey,
198            final Set<PreKeyRecord> preKeyRecords,
199            final int deviceId,
200            Bundle publishOptions) {
201        final Element item = new Element("item");
202        item.setAttribute("id", "current");
203        final Element bundle = item.addChild("bundle", AxolotlService.PEP_PREFIX);
204        final Element signedPreKeyPublic = bundle.addChild("signedPreKeyPublic");
205        signedPreKeyPublic.setAttribute("signedPreKeyId", signedPreKeyRecord.getId());
206        ECPublicKey publicKey = signedPreKeyRecord.getKeyPair().getPublicKey();
207        signedPreKeyPublic.setContent(Base64.encodeToString(publicKey.serialize(), Base64.NO_WRAP));
208        final Element signedPreKeySignature = bundle.addChild("signedPreKeySignature");
209        signedPreKeySignature.setContent(
210                Base64.encodeToString(signedPreKeyRecord.getSignature(), Base64.NO_WRAP));
211        final Element identityKeyElement = bundle.addChild("identityKey");
212        identityKeyElement.setContent(
213                Base64.encodeToString(identityKey.serialize(), Base64.NO_WRAP));
214
215        final Element prekeys = bundle.addChild("prekeys", AxolotlService.PEP_PREFIX);
216        for (PreKeyRecord preKeyRecord : preKeyRecords) {
217            final Element prekey = prekeys.addChild("preKeyPublic");
218            prekey.setAttribute("preKeyId", preKeyRecord.getId());
219            prekey.setContent(
220                    Base64.encodeToString(
221                            preKeyRecord.getKeyPair().getPublicKey().serialize(), Base64.NO_WRAP));
222        }
223
224        return publish(AxolotlService.PEP_BUNDLES + ":" + deviceId, item, publishOptions);
225    }
226
227    public Iq publishVerification(
228            byte[] signature, X509Certificate[] certificates, final int deviceId) {
229        final Element item = new Element("item");
230        item.setAttribute("id", "current");
231        final Element verification = item.addChild("verification", AxolotlService.PEP_PREFIX);
232        final Element chain = verification.addChild("chain");
233        for (int i = 0; i < certificates.length; ++i) {
234            try {
235                Element certificate = chain.addChild("certificate");
236                certificate.setContent(
237                        Base64.encodeToString(certificates[i].getEncoded(), Base64.NO_WRAP));
238                certificate.setAttribute("index", i);
239            } catch (CertificateEncodingException e) {
240                Log.d(Config.LOGTAG, "could not encode certificate");
241            }
242        }
243        verification
244                .addChild("signature")
245                .setContent(Base64.encodeToString(signature, Base64.NO_WRAP));
246        return publish(AxolotlService.PEP_VERIFICATION + ":" + deviceId, item);
247    }
248
249    public Iq queryMessageArchiveManagement(final MessageArchiveService.Query mam) {
250        final Iq packet = new Iq(Iq.Type.SET);
251        final Element query = packet.query(mam.version.namespace);
252        query.setAttribute("queryid", mam.getQueryId());
253        final Data data = new Data();
254        data.setFormType(mam.version.namespace);
255        if (mam.muc()) {
256            packet.setTo(mam.getWith());
257        } else if (mam.getWith() != null) {
258            data.put("with", mam.getWith().toString());
259        }
260        final long start = mam.getStart();
261        final long end = mam.getEnd();
262        if (start != 0) {
263            data.put("start", getTimestamp(start));
264        }
265        if (end != 0) {
266            data.put("end", getTimestamp(end));
267        }
268        data.submit();
269        query.addChild(data);
270        Element set = query.addChild("set", "http://jabber.org/protocol/rsm");
271        if (mam.getPagingOrder() == MessageArchiveService.PagingOrder.REVERSE) {
272            set.addChild("before").setContent(mam.getReference());
273        } else if (mam.getReference() != null) {
274            set.addChild("after").setContent(mam.getReference());
275        }
276        set.addChild("max").setContent(String.valueOf(Config.PAGE_SIZE));
277        return packet;
278    }
279
280    public Iq generateSetPassword(final Account account, final String newPassword) {
281        final Iq packet = new Iq(Iq.Type.SET);
282        packet.setTo(account.getDomain());
283        final Element query = packet.addChild("query", Namespace.REGISTER);
284        final Jid jid = account.getJid();
285        query.addChild("username").setContent(jid.getLocal());
286        query.addChild("password").setContent(newPassword);
287        return packet;
288    }
289
290    public Iq changeAffiliation(Conversation conference, Jid jid, String affiliation) {
291        List<Jid> jids = new ArrayList<>();
292        jids.add(jid);
293        return changeAffiliation(conference, jids, affiliation);
294    }
295
296    public Iq changeAffiliation(Conversation conference, List<Jid> jids, String affiliation) {
297        final Iq packet = new Iq(Iq.Type.SET);
298        packet.setTo(conference.getJid().asBareJid());
299        packet.setFrom(conference.getAccount().getJid());
300        Element query = packet.query("http://jabber.org/protocol/muc#admin");
301        for (Jid jid : jids) {
302            Element item = query.addChild("item");
303            item.setAttribute("jid", jid);
304            item.setAttribute("affiliation", affiliation);
305        }
306        return packet;
307    }
308
309    public Iq changeRole(Conversation conference, String nick, String role) {
310        final Iq packet = new Iq(Iq.Type.SET);
311        packet.setTo(conference.getJid().asBareJid());
312        packet.setFrom(conference.getAccount().getJid());
313        Element item = packet.query("http://jabber.org/protocol/muc#admin").addChild("item");
314        item.setAttribute("nick", nick);
315        item.setAttribute("role", role);
316        return packet;
317    }
318
319    public Iq requestHttpUploadSlot(
320            final Jid host, final DownloadableFile file, final String mime) {
321        final Iq packet = new Iq(Iq.Type.GET);
322        packet.setTo(host);
323        final var request = packet.addExtension(new Request());
324        request.setFilename(convertFilename(file.getName()));
325        request.setSize(file.getExpectedSize());
326        return packet;
327    }
328
329    private static String convertFilename(String name) {
330        int pos = name.indexOf('.');
331        if (pos != -1) {
332            try {
333                UUID uuid = UUID.fromString(name.substring(0, pos));
334                ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
335                bb.putLong(uuid.getMostSignificantBits());
336                bb.putLong(uuid.getLeastSignificantBits());
337                return Base64.encodeToString(
338                                bb.array(), Base64.URL_SAFE | Base64.NO_PADDING | Base64.NO_WRAP)
339                        + name.substring(pos);
340            } catch (Exception e) {
341                return name;
342            }
343        } else {
344            return name;
345        }
346    }
347
348    public static Iq generateCreateAccountWithCaptcha(
349            final Account account, final String id, final Data data) {
350        final Iq register = new Iq(Iq.Type.SET);
351        register.setFrom(account.getJid().asBareJid());
352        register.setTo(account.getDomain());
353        register.setId(id);
354        Element query = register.query(Namespace.REGISTER);
355        if (data != null) {
356            query.addChild(data);
357        }
358        return register;
359    }
360
361    public Iq pushTokenToAppServer(Jid appServer, String token, String deviceId) {
362        return pushTokenToAppServer(appServer, token, deviceId, null);
363    }
364
365    public Iq pushTokenToAppServer(Jid appServer, String token, String deviceId, Jid muc) {
366        final Iq packet = new Iq(Iq.Type.SET);
367        packet.setTo(appServer);
368        final Element command = packet.addChild("command", Namespace.COMMANDS);
369        command.setAttribute("node", "register-push-fcm");
370        command.setAttribute("action", "execute");
371        final Data data = new Data();
372        data.put("token", token);
373        data.put("android-id", deviceId);
374        if (muc != null) {
375            data.put("muc", muc.toString());
376        }
377        data.submit();
378        command.addChild(data);
379        return packet;
380    }
381
382    public Iq unregisterChannelOnAppServer(Jid appServer, String deviceId, String channel) {
383        final Iq packet = new Iq(Iq.Type.SET);
384        packet.setTo(appServer);
385        final Element command = packet.addChild("command", Namespace.COMMANDS);
386        command.setAttribute("node", "unregister-push-fcm");
387        command.setAttribute("action", "execute");
388        final Data data = new Data();
389        data.put("channel", channel);
390        data.put("android-id", deviceId);
391        data.submit();
392        command.addChild(data);
393        return packet;
394    }
395
396    public Iq enablePush(final Jid jid, final String node, final String secret) {
397        final Iq packet = new Iq(Iq.Type.SET);
398        Element enable = packet.addChild("enable", Namespace.PUSH);
399        enable.setAttribute("jid", jid);
400        enable.setAttribute("node", node);
401        if (secret != null) {
402            Data data = new Data();
403            data.setFormType(Namespace.PUBSUB_PUBLISH_OPTIONS);
404            data.put("secret", secret);
405            data.submit();
406            enable.addChild(data);
407        }
408        return packet;
409    }
410
411    public Iq disablePush(final Jid jid, final String node) {
412        Iq packet = new Iq(Iq.Type.SET);
413        Element disable = packet.addChild("disable", Namespace.PUSH);
414        disable.setAttribute("jid", jid);
415        disable.setAttribute("node", node);
416        return packet;
417    }
418
419    public Iq queryAffiliation(Conversation conversation, String affiliation) {
420        final Iq packet = new Iq(Iq.Type.GET);
421        packet.setTo(conversation.getJid().asBareJid());
422        packet.query("http://jabber.org/protocol/muc#admin")
423                .addChild("item")
424                .setAttribute("affiliation", affiliation);
425        return packet;
426    }
427
428    public static Bundle defaultGroupChatConfiguration() {
429        Bundle options = new Bundle();
430        options.putString("muc#roomconfig_persistentroom", "1");
431        options.putString("muc#roomconfig_membersonly", "1");
432        options.putString("muc#roomconfig_publicroom", "0");
433        options.putString("muc#roomconfig_whois", "anyone");
434        options.putString("muc#roomconfig_changesubject", "0");
435        options.putString("muc#roomconfig_allowinvites", "0");
436        options.putString("muc#roomconfig_enablearchiving", "1"); // prosody
437        options.putString("mam", "1"); // ejabberd community
438        options.putString("muc#roomconfig_mam", "1"); // ejabberd saas
439        return options;
440    }
441
442    public static Bundle defaultChannelConfiguration() {
443        Bundle options = new Bundle();
444        options.putString("muc#roomconfig_persistentroom", "1");
445        options.putString("muc#roomconfig_membersonly", "0");
446        options.putString("muc#roomconfig_publicroom", "1");
447        options.putString("muc#roomconfig_whois", "moderators");
448        options.putString("muc#roomconfig_changesubject", "0");
449        options.putString("muc#roomconfig_enablearchiving", "1"); // prosody
450        options.putString("mam", "1"); // ejabberd community
451        options.putString("muc#roomconfig_mam", "1"); // ejabberd saas
452        return options;
453    }
454
455    public Iq requestPubsubConfiguration(Jid jid, String node) {
456        return pubsubConfiguration(jid, node, null);
457    }
458
459    public Iq publishPubsubConfiguration(Jid jid, String node, Data data) {
460        return pubsubConfiguration(jid, node, data);
461    }
462
463    private Iq pubsubConfiguration(Jid jid, String node, Data data) {
464        final Iq packet = new Iq(data == null ? Iq.Type.GET : Iq.Type.SET);
465        packet.setTo(jid);
466        Element pubsub = packet.addChild("pubsub", "http://jabber.org/protocol/pubsub#owner");
467        Element configure = pubsub.addChild("configure").setAttribute("node", node);
468        if (data != null) {
469            configure.addChild(data);
470        }
471        return packet;
472    }
473}