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.Conversation;
  9import eu.siacs.conversations.services.MessageArchiveService;
 10import eu.siacs.conversations.services.XmppConnectionService;
 11import eu.siacs.conversations.xml.Element;
 12import eu.siacs.conversations.xml.Namespace;
 13import eu.siacs.conversations.xmpp.Jid;
 14import eu.siacs.conversations.xmpp.forms.Data;
 15import im.conversations.android.xmpp.model.stanza.Iq;
 16import java.security.cert.CertificateEncodingException;
 17import java.security.cert.X509Certificate;
 18import java.util.ArrayList;
 19import java.util.List;
 20import java.util.Set;
 21import org.whispersystems.libsignal.IdentityKey;
 22import org.whispersystems.libsignal.ecc.ECPublicKey;
 23import org.whispersystems.libsignal.state.PreKeyRecord;
 24import org.whispersystems.libsignal.state.SignedPreKeyRecord;
 25
 26public class IqGenerator extends AbstractGenerator {
 27
 28    public IqGenerator(final XmppConnectionService service) {
 29        super(service);
 30    }
 31
 32    protected Iq publish(final String node, final Element item, final Bundle options) {
 33        final var packet = new Iq(Iq.Type.SET);
 34        final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB);
 35        final Element publish = pubsub.addChild("publish");
 36        publish.setAttribute("node", node);
 37        publish.addChild(item);
 38        if (options != null) {
 39            final Element publishOptions = pubsub.addChild("publish-options");
 40            publishOptions.addChild(Data.create(Namespace.PUBSUB_PUBLISH_OPTIONS, options));
 41        }
 42        return packet;
 43    }
 44
 45    protected Iq publish(final String node, final Element item) {
 46        return publish(node, item, null);
 47    }
 48
 49    private Iq retrieve(String node, Element item) {
 50        final var packet = new Iq(Iq.Type.GET);
 51        final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB);
 52        final Element items = pubsub.addChild("items");
 53        items.setAttribute("node", node);
 54        if (item != null) {
 55            items.addChild(item);
 56        }
 57        return packet;
 58    }
 59
 60    public Iq deleteNode(final String node) {
 61        final var packet = new Iq(Iq.Type.SET);
 62        final Element pubsub = packet.addChild("pubsub", Namespace.PUBSUB_OWNER);
 63        pubsub.addChild("delete").setAttribute("node", node);
 64        return packet;
 65    }
 66
 67    public Iq retrieveDeviceIds(final Jid to) {
 68        final var packet = retrieve(AxolotlService.PEP_DEVICE_LIST, null);
 69        if (to != null) {
 70            packet.setTo(to);
 71        }
 72        return packet;
 73    }
 74
 75    public Iq retrieveBundlesForDevice(final Jid to, final int deviceid) {
 76        final var packet = retrieve(AxolotlService.PEP_BUNDLES + ":" + deviceid, null);
 77        packet.setTo(to);
 78        return packet;
 79    }
 80
 81    public Iq retrieveVerificationForDevice(final Jid to, final int deviceid) {
 82        final var packet = retrieve(AxolotlService.PEP_VERIFICATION + ":" + deviceid, null);
 83        packet.setTo(to);
 84        return packet;
 85    }
 86
 87    public Iq publishDeviceIds(final Set<Integer> ids, final Bundle publishOptions) {
 88        final Element item = new Element("item");
 89        item.setAttribute("id", "current");
 90        final Element list = item.addChild("list", AxolotlService.PEP_PREFIX);
 91        for (Integer id : ids) {
 92            final Element device = new Element("device");
 93            device.setAttribute("id", id);
 94            list.addChild(device);
 95        }
 96        return publish(AxolotlService.PEP_DEVICE_LIST, item, publishOptions);
 97    }
 98
 99    public Iq publishBundles(
100            final SignedPreKeyRecord signedPreKeyRecord,
101            final IdentityKey identityKey,
102            final Set<PreKeyRecord> preKeyRecords,
103            final int deviceId,
104            Bundle publishOptions) {
105        final Element item = new Element("item");
106        item.setAttribute("id", "current");
107        final Element bundle = item.addChild("bundle", AxolotlService.PEP_PREFIX);
108        final Element signedPreKeyPublic = bundle.addChild("signedPreKeyPublic");
109        signedPreKeyPublic.setAttribute("signedPreKeyId", signedPreKeyRecord.getId());
110        ECPublicKey publicKey = signedPreKeyRecord.getKeyPair().getPublicKey();
111        signedPreKeyPublic.setContent(Base64.encodeToString(publicKey.serialize(), Base64.NO_WRAP));
112        final Element signedPreKeySignature = bundle.addChild("signedPreKeySignature");
113        signedPreKeySignature.setContent(
114                Base64.encodeToString(signedPreKeyRecord.getSignature(), Base64.NO_WRAP));
115        final Element identityKeyElement = bundle.addChild("identityKey");
116        identityKeyElement.setContent(
117                Base64.encodeToString(identityKey.serialize(), Base64.NO_WRAP));
118
119        final Element prekeys = bundle.addChild("prekeys", AxolotlService.PEP_PREFIX);
120        for (PreKeyRecord preKeyRecord : preKeyRecords) {
121            final Element prekey = prekeys.addChild("preKeyPublic");
122            prekey.setAttribute("preKeyId", preKeyRecord.getId());
123            prekey.setContent(
124                    Base64.encodeToString(
125                            preKeyRecord.getKeyPair().getPublicKey().serialize(), Base64.NO_WRAP));
126        }
127
128        return publish(AxolotlService.PEP_BUNDLES + ":" + deviceId, item, publishOptions);
129    }
130
131    public Iq publishVerification(
132            byte[] signature, X509Certificate[] certificates, final int deviceId) {
133        final Element item = new Element("item");
134        item.setAttribute("id", "current");
135        final Element verification = item.addChild("verification", AxolotlService.PEP_PREFIX);
136        final Element chain = verification.addChild("chain");
137        for (int i = 0; i < certificates.length; ++i) {
138            try {
139                Element certificate = chain.addChild("certificate");
140                certificate.setContent(
141                        Base64.encodeToString(certificates[i].getEncoded(), Base64.NO_WRAP));
142                certificate.setAttribute("index", i);
143            } catch (CertificateEncodingException e) {
144                Log.d(Config.LOGTAG, "could not encode certificate");
145            }
146        }
147        verification
148                .addChild("signature")
149                .setContent(Base64.encodeToString(signature, Base64.NO_WRAP));
150        return publish(AxolotlService.PEP_VERIFICATION + ":" + deviceId, item);
151    }
152
153    public Iq queryMessageArchiveManagement(final MessageArchiveService.Query mam) {
154        final Iq packet = new Iq(Iq.Type.SET);
155        final Element query = packet.query(mam.version.namespace);
156        query.setAttribute("queryid", mam.getQueryId());
157        final Data data = new Data();
158        data.setFormType(mam.version.namespace);
159        if (mam.muc()) {
160            packet.setTo(mam.getWith());
161        } else if (mam.getWith() != null) {
162            data.put("with", mam.getWith().toString());
163        }
164        final long start = mam.getStart();
165        final long end = mam.getEnd();
166        if (start != 0) {
167            data.put("start", getTimestamp(start));
168        }
169        if (end != 0) {
170            data.put("end", getTimestamp(end));
171        }
172        data.submit();
173        query.addChild(data);
174        Element set = query.addChild("set", "http://jabber.org/protocol/rsm");
175        if (mam.getPagingOrder() == MessageArchiveService.PagingOrder.REVERSE) {
176            set.addChild("before").setContent(mam.getReference());
177        } else if (mam.getReference() != null) {
178            set.addChild("after").setContent(mam.getReference());
179        }
180        set.addChild("max").setContent(String.valueOf(Config.PAGE_SIZE));
181        return packet;
182    }
183
184    public Iq changeAffiliation(Conversation conference, Jid jid, String affiliation) {
185        List<Jid> jids = new ArrayList<>();
186        jids.add(jid);
187        return changeAffiliation(conference, jids, affiliation);
188    }
189
190    public Iq changeAffiliation(Conversation conference, List<Jid> jids, String affiliation) {
191        final Iq packet = new Iq(Iq.Type.SET);
192        packet.setTo(conference.getJid().asBareJid());
193        packet.setFrom(conference.getAccount().getJid());
194        Element query = packet.query("http://jabber.org/protocol/muc#admin");
195        for (Jid jid : jids) {
196            Element item = query.addChild("item");
197            item.setAttribute("jid", jid);
198            item.setAttribute("affiliation", affiliation);
199        }
200        return packet;
201    }
202
203    public Iq changeRole(Conversation conference, String nick, String role) {
204        final Iq packet = new Iq(Iq.Type.SET);
205        packet.setTo(conference.getJid().asBareJid());
206        packet.setFrom(conference.getAccount().getJid());
207        Element item = packet.query("http://jabber.org/protocol/muc#admin").addChild("item");
208        item.setAttribute("nick", nick);
209        item.setAttribute("role", role);
210        return packet;
211    }
212
213    public Iq pushTokenToAppServer(Jid appServer, String token, String deviceId) {
214        return pushTokenToAppServer(appServer, token, deviceId, null);
215    }
216
217    public Iq pushTokenToAppServer(Jid appServer, String token, String deviceId, Jid muc) {
218        final Iq packet = new Iq(Iq.Type.SET);
219        packet.setTo(appServer);
220        final Element command = packet.addChild("command", Namespace.COMMANDS);
221        command.setAttribute("node", "register-push-fcm");
222        command.setAttribute("action", "execute");
223        final Data data = new Data();
224        data.put("token", token);
225        data.put("android-id", deviceId);
226        if (muc != null) {
227            data.put("muc", muc.toString());
228        }
229        data.submit();
230        command.addChild(data);
231        return packet;
232    }
233
234    public Iq unregisterChannelOnAppServer(Jid appServer, String deviceId, String channel) {
235        final Iq packet = new Iq(Iq.Type.SET);
236        packet.setTo(appServer);
237        final Element command = packet.addChild("command", Namespace.COMMANDS);
238        command.setAttribute("node", "unregister-push-fcm");
239        command.setAttribute("action", "execute");
240        final Data data = new Data();
241        data.put("channel", channel);
242        data.put("android-id", deviceId);
243        data.submit();
244        command.addChild(data);
245        return packet;
246    }
247
248    public Iq enablePush(final Jid jid, final String node, final String secret) {
249        final Iq packet = new Iq(Iq.Type.SET);
250        Element enable = packet.addChild("enable", Namespace.PUSH);
251        enable.setAttribute("jid", jid);
252        enable.setAttribute("node", node);
253        if (secret != null) {
254            Data data = new Data();
255            data.setFormType(Namespace.PUBSUB_PUBLISH_OPTIONS);
256            data.put("secret", secret);
257            data.submit();
258            enable.addChild(data);
259        }
260        return packet;
261    }
262
263    public Iq disablePush(final Jid jid, final String node) {
264        Iq packet = new Iq(Iq.Type.SET);
265        Element disable = packet.addChild("disable", Namespace.PUSH);
266        disable.setAttribute("jid", jid);
267        disable.setAttribute("node", node);
268        return packet;
269    }
270
271    public Iq queryAffiliation(Conversation conversation, String affiliation) {
272        final Iq packet = new Iq(Iq.Type.GET);
273        packet.setTo(conversation.getJid().asBareJid());
274        packet.query("http://jabber.org/protocol/muc#admin")
275                .addChild("item")
276                .setAttribute("affiliation", affiliation);
277        return packet;
278    }
279
280    public static Bundle defaultGroupChatConfiguration() {
281        Bundle options = new Bundle();
282        options.putString("muc#roomconfig_persistentroom", "1");
283        options.putString("muc#roomconfig_membersonly", "1");
284        options.putString("muc#roomconfig_publicroom", "0");
285        options.putString("muc#roomconfig_whois", "anyone");
286        options.putString("muc#roomconfig_changesubject", "0");
287        options.putString("muc#roomconfig_allowinvites", "0");
288        options.putString("muc#roomconfig_enablearchiving", "1"); // prosody
289        options.putString("mam", "1"); // ejabberd community
290        options.putString("muc#roomconfig_mam", "1"); // ejabberd saas
291        return options;
292    }
293
294    public static Bundle defaultChannelConfiguration() {
295        Bundle options = new Bundle();
296        options.putString("muc#roomconfig_persistentroom", "1");
297        options.putString("muc#roomconfig_membersonly", "0");
298        options.putString("muc#roomconfig_publicroom", "1");
299        options.putString("muc#roomconfig_whois", "moderators");
300        options.putString("muc#roomconfig_changesubject", "0");
301        options.putString("muc#roomconfig_enablearchiving", "1"); // prosody
302        options.putString("mam", "1"); // ejabberd community
303        options.putString("muc#roomconfig_mam", "1"); // ejabberd saas
304        return options;
305    }
306
307    public Iq requestPubsubConfiguration(Jid jid, String node) {
308        return pubsubConfiguration(jid, node, null);
309    }
310
311    public Iq publishPubsubConfiguration(Jid jid, String node, Data data) {
312        return pubsubConfiguration(jid, node, data);
313    }
314
315    private Iq pubsubConfiguration(Jid jid, String node, Data data) {
316        final Iq packet = new Iq(data == null ? Iq.Type.GET : Iq.Type.SET);
317        packet.setTo(jid);
318        Element pubsub = packet.addChild("pubsub", "http://jabber.org/protocol/pubsub#owner");
319        Element configure = pubsub.addChild("configure").setAttribute("node", node);
320        if (data != null) {
321            configure.addChild(data);
322        }
323        return packet;
324    }
325}