1package eu.siacs.conversations.xmpp.jingle.stanzas;
2
3import android.util.Log;
4
5import androidx.annotation.NonNull;
6
7import com.google.common.base.Joiner;
8import com.google.common.base.MoreObjects;
9import com.google.common.base.Objects;
10import com.google.common.base.Preconditions;
11import com.google.common.base.Splitter;
12import com.google.common.base.Strings;
13import com.google.common.collect.ArrayListMultimap;
14import com.google.common.collect.Collections2;
15import com.google.common.collect.ImmutableList;
16import com.google.common.collect.Iterables;
17
18import eu.siacs.conversations.Config;
19import eu.siacs.conversations.xml.Element;
20import eu.siacs.conversations.xml.Namespace;
21import eu.siacs.conversations.xmpp.jingle.SessionDescription;
22
23import java.util.Arrays;
24import java.util.Collection;
25import java.util.Collections;
26import java.util.HashMap;
27import java.util.Hashtable;
28import java.util.LinkedHashMap;
29import java.util.List;
30import java.util.Locale;
31import java.util.Map;
32import java.util.UUID;
33
34public class IceUdpTransportInfo extends GenericTransportInfo {
35
36 public static final IceUdpTransportInfo STUB = new IceUdpTransportInfo();
37
38 public IceUdpTransportInfo() {
39 super("transport", Namespace.JINGLE_TRANSPORT_ICE_UDP);
40 }
41
42 public static IceUdpTransportInfo upgrade(final Element element) {
43 Preconditions.checkArgument(
44 "transport".equals(element.getName()), "Name of provided element is not transport");
45 Preconditions.checkArgument(
46 Namespace.JINGLE_TRANSPORT_ICE_UDP.equals(element.getNamespace()),
47 "Element does not match ice-udp transport namespace");
48 final IceUdpTransportInfo transportInfo = new IceUdpTransportInfo();
49 transportInfo.setAttributes(element.getAttributes());
50 transportInfo.setChildren(element.getChildren());
51 return transportInfo;
52 }
53
54 public static IceUdpTransportInfo of(
55 SessionDescription sessionDescription, SessionDescription.Media media) {
56 final String ufrag = Iterables.getFirst(media.attributes.get("ice-ufrag"), null);
57 final String pwd = Iterables.getFirst(media.attributes.get("ice-pwd"), null);
58 final IceUdpTransportInfo iceUdpTransportInfo = new IceUdpTransportInfo();
59 if (ufrag != null) {
60 iceUdpTransportInfo.setAttribute("ufrag", ufrag);
61 }
62 if (pwd != null) {
63 iceUdpTransportInfo.setAttribute("pwd", pwd);
64 }
65 final Fingerprint fingerprint = Fingerprint.of(sessionDescription, media);
66 if (fingerprint != null) {
67 iceUdpTransportInfo.addChild(fingerprint);
68 }
69 for (final String iceOption : IceOption.of(media)) {
70 iceUdpTransportInfo.addChild(new IceOption(iceOption));
71 }
72 return iceUdpTransportInfo;
73 }
74
75 public static IceUdpTransportInfo of(
76 final Credentials credentials,
77 final Collection<String> iceOptions,
78 final Setup setup,
79 final String hash,
80 final String fingerprint) {
81 final IceUdpTransportInfo iceUdpTransportInfo = new IceUdpTransportInfo();
82 iceUdpTransportInfo.addChild(Fingerprint.of(setup, hash, fingerprint));
83 iceUdpTransportInfo.setAttribute("ufrag", credentials.ufrag);
84 iceUdpTransportInfo.setAttribute("pwd", credentials.password);
85 for (final String iceOption : iceOptions) {
86 iceUdpTransportInfo.addChild(new IceOption(iceOption));
87 }
88 return iceUdpTransportInfo;
89 }
90
91 public Fingerprint getFingerprint() {
92 final Element fingerprint = this.findChild("fingerprint", Namespace.JINGLE_APPS_DTLS);
93 return fingerprint == null ? null : Fingerprint.upgrade(fingerprint);
94 }
95
96 public List<String> getIceOptions() {
97 final ImmutableList.Builder<String> optionBuilder = new ImmutableList.Builder<>();
98 for (final Element child : this.children) {
99 if (Namespace.JINGLE_TRANSPORT_ICE_OPTION.equals(child.getNamespace())
100 && IceOption.WELL_KNOWN.contains(child.getName())) {
101 optionBuilder.add(child.getName());
102 }
103 }
104 return optionBuilder.build();
105 }
106
107 public Credentials getCredentials() {
108 final String ufrag = this.getAttribute("ufrag");
109 final String password = this.getAttribute("pwd");
110 return new Credentials(ufrag, password);
111 }
112
113 public boolean isStub() {
114 return Strings.isNullOrEmpty(this.getAttribute("ufrag"))
115 && Strings.isNullOrEmpty(this.getAttribute("pwd"))
116 && this.children.isEmpty();
117 }
118
119 public List<Candidate> getCandidates() {
120 final ImmutableList.Builder<Candidate> builder = new ImmutableList.Builder<>();
121 for (final Element child : getChildren()) {
122 if ("candidate".equals(child.getName())) {
123 builder.add(Candidate.upgrade(child));
124 }
125 }
126 return builder.build();
127 }
128
129 public IceUdpTransportInfo cloneWrapper() {
130 final IceUdpTransportInfo transportInfo = new IceUdpTransportInfo();
131 transportInfo.setAttributes(new Hashtable<>(getAttributes()));
132 return transportInfo;
133 }
134
135 public IceUdpTransportInfo modifyCredentials(final Credentials credentials, final Setup setup) {
136 final IceUdpTransportInfo transportInfo = new IceUdpTransportInfo();
137 transportInfo.setAttribute("ufrag", credentials.ufrag);
138 transportInfo.setAttribute("pwd", credentials.password);
139 for (final Element child : getChildren()) {
140 if (child.getName().equals("fingerprint")
141 && Namespace.JINGLE_APPS_DTLS.equals(child.getNamespace())) {
142 final Fingerprint fingerprint = new Fingerprint();
143 fingerprint.setAttributes(new Hashtable<>(child.getAttributes()));
144 fingerprint.setContent(child.getContent());
145 fingerprint.setAttribute("setup", setup.toString().toLowerCase(Locale.ROOT));
146 transportInfo.addChild(fingerprint);
147 }
148 }
149 for (final String iceOption : this.getIceOptions()) {
150 transportInfo.addChild(new IceOption(iceOption));
151 }
152 return transportInfo;
153 }
154
155 public static class Credentials {
156 public final String ufrag;
157 public final String password;
158
159 public Credentials(String ufrag, String password) {
160 this.ufrag = ufrag;
161 this.password = password;
162 }
163
164 @Override
165 public boolean equals(Object o) {
166 if (this == o) return true;
167 if (o == null || getClass() != o.getClass()) return false;
168 Credentials that = (Credentials) o;
169 return Objects.equal(ufrag, that.ufrag) && Objects.equal(password, that.password);
170 }
171
172 @Override
173 public int hashCode() {
174 return Objects.hashCode(ufrag, password);
175 }
176
177 @Override
178 @NonNull
179 public String toString() {
180 return MoreObjects.toStringHelper(this)
181 .add("ufrag", ufrag)
182 .add("password", password)
183 .toString();
184 }
185 }
186
187 public static class Candidate extends Element {
188
189 private Candidate() {
190 super("candidate");
191 }
192
193 public static Candidate upgrade(final Element element) {
194 Preconditions.checkArgument("candidate".equals(element.getName()));
195 final Candidate candidate = new Candidate();
196 candidate.setAttributes(element.getAttributes());
197 candidate.setChildren(element.getChildren());
198 return candidate;
199 }
200
201 // https://tools.ietf.org/html/draft-ietf-mmusic-ice-sip-sdp-39#section-5.1
202 public static Candidate fromSdpAttribute(final String attribute, String currentUfrag) {
203 final String[] pair = attribute.split(":", 2);
204 if (pair.length == 2 && "candidate".equals(pair[0])) {
205 final String[] segments = pair[1].split(" ");
206 if (segments.length >= 6) {
207 final String id = UUID.randomUUID().toString();
208 final String foundation = segments[0];
209 final String component = segments[1];
210 final String transport = segments[2].toLowerCase(Locale.ROOT);
211 final String priority = segments[3];
212 final String connectionAddress = segments[4];
213 final String port = segments[5];
214 final HashMap<String, String> additional = new HashMap<>();
215 for (int i = 6; i < segments.length - 1; i = i + 2) {
216 additional.put(segments[i], segments[i + 1]);
217 }
218 final String ufrag = additional.get("ufrag");
219 if (ufrag != null && !ufrag.equals(currentUfrag)) {
220 return null;
221 }
222 final Candidate candidate = new Candidate();
223 candidate.setAttribute("component", component);
224 candidate.setAttribute("foundation", foundation);
225 candidate.setAttribute("generation", additional.get("generation"));
226 candidate.setAttribute("rel-addr", additional.get("raddr"));
227 candidate.setAttribute("rel-port", additional.get("rport"));
228 candidate.setAttribute("id", id);
229 candidate.setAttribute("ip", connectionAddress);
230 candidate.setAttribute("port", port);
231 candidate.setAttribute("priority", priority);
232 candidate.setAttribute("protocol", transport);
233 candidate.setAttribute("type", additional.get("typ"));
234 return candidate;
235 }
236 }
237 return null;
238 }
239
240 public int getComponent() {
241 return getAttributeAsInt("component");
242 }
243
244 public int getFoundation() {
245 return getAttributeAsInt("foundation");
246 }
247
248 public int getGeneration() {
249 return getAttributeAsInt("generation");
250 }
251
252 public String getId() {
253 return getAttribute("id");
254 }
255
256 public String getIp() {
257 return getAttribute("ip");
258 }
259
260 public int getNetwork() {
261 return getAttributeAsInt("network");
262 }
263
264 public int getPort() {
265 return getAttributeAsInt("port");
266 }
267
268 public int getPriority() {
269 return getAttributeAsInt("priority");
270 }
271
272 public String getProtocol() {
273 return getAttribute("protocol");
274 }
275
276 public String getRelAddr() {
277 return getAttribute("rel-addr");
278 }
279
280 public int getRelPort() {
281 return getAttributeAsInt("rel-port");
282 }
283
284 public String getType() { // TODO might be converted to enum
285 return getAttribute("type");
286 }
287
288 private int getAttributeAsInt(final String name) {
289 final String value = this.getAttribute(name);
290 if (value == null) {
291 return 0;
292 }
293 try {
294 return Integer.parseInt(value);
295 } catch (NumberFormatException e) {
296 return 0;
297 }
298 }
299
300 public String toSdpAttribute(final String ufrag) {
301 final String foundation = this.getAttribute("foundation");
302 checkNotNullNoWhitespace(foundation, "foundation");
303 final String component = this.getAttribute("component");
304 checkNotNullNoWhitespace(component, "component");
305 final String protocol = this.getAttribute("protocol");
306 checkNotNullNoWhitespace(protocol, "protocol");
307 final String transport = protocol.toLowerCase(Locale.ROOT);
308 if (!"udp".equals(transport)) {
309 throw new IllegalArgumentException(
310 String.format("'%s' is not a supported protocol", transport));
311 }
312 final String priority = this.getAttribute("priority");
313 checkNotNullNoWhitespace(priority, "priority");
314 final String connectionAddress = this.getAttribute("ip");
315 checkNotNullNoWhitespace(connectionAddress, "ip");
316 final String port = this.getAttribute("port");
317 checkNotNullNoWhitespace(port, "port");
318 final Map<String, String> additionalParameter = new LinkedHashMap<>();
319 final String relAddr = this.getAttribute("rel-addr");
320 final String type = this.getAttribute("type");
321 if (type != null) {
322 additionalParameter.put("typ", type);
323 }
324 if (relAddr != null) {
325 additionalParameter.put("raddr", relAddr);
326 }
327 final String relPort = this.getAttribute("rel-port");
328 if (relPort != null) {
329 additionalParameter.put("rport", relPort);
330 }
331 final String generation = this.getAttribute("generation");
332 if (generation != null) {
333 additionalParameter.put("generation", generation);
334 }
335 if (ufrag != null) {
336 additionalParameter.put("ufrag", ufrag);
337 }
338 final String parametersString =
339 Joiner.on(' ')
340 .join(
341 Collections2.transform(
342 additionalParameter.entrySet(),
343 input ->
344 String.format(
345 "%s %s",
346 input.getKey(), input.getValue())));
347 return String.format(
348 "candidate:%s %s %s %s %s %s %s",
349 foundation,
350 component,
351 transport,
352 priority,
353 connectionAddress,
354 port,
355 parametersString);
356 }
357 }
358
359 private static void checkNotNullNoWhitespace(final String value, final String name) {
360 if (Strings.isNullOrEmpty(value)) {
361 throw new IllegalArgumentException(
362 String.format("Parameter %s is missing or empty", name));
363 }
364 SessionDescription.checkNoWhitespace(
365 value, String.format("Parameter %s contains white spaces", name));
366 }
367
368 public static class Fingerprint extends Element {
369
370 private Fingerprint() {
371 super("fingerprint", Namespace.JINGLE_APPS_DTLS);
372 }
373
374 public static Fingerprint upgrade(final Element element) {
375 Preconditions.checkArgument("fingerprint".equals(element.getName()));
376 Preconditions.checkArgument(Namespace.JINGLE_APPS_DTLS.equals(element.getNamespace()));
377 final Fingerprint fingerprint = new Fingerprint();
378 fingerprint.setAttributes(element.getAttributes());
379 fingerprint.setContent(element.getContent());
380 return fingerprint;
381 }
382
383 private static Fingerprint of(ArrayListMultimap<String, String> attributes) {
384 final String fingerprint = Iterables.getFirst(attributes.get("fingerprint"), null);
385 final String setup = Iterables.getFirst(attributes.get("setup"), null);
386 if (setup != null && fingerprint != null) {
387 final String[] fingerprintParts = fingerprint.split(" ", 2);
388 if (fingerprintParts.length == 2) {
389 final String hash = fingerprintParts[0];
390 final String actualFingerprint = fingerprintParts[1];
391 final Fingerprint element = new Fingerprint();
392 element.setAttribute("hash", hash);
393 element.setAttribute("setup", setup);
394 element.setContent(actualFingerprint);
395 return element;
396 }
397 }
398 return null;
399 }
400
401 public static Fingerprint of(
402 final SessionDescription sessionDescription, final SessionDescription.Media media) {
403 final Fingerprint fingerprint = of(media.attributes);
404 return fingerprint == null ? of(sessionDescription.attributes) : fingerprint;
405 }
406
407 private static Fingerprint of(final Setup setup, final String hash, final String content) {
408 final Fingerprint fingerprint = new Fingerprint();
409 fingerprint.setContent(content);
410 fingerprint.setAttribute("hash", hash);
411 fingerprint.setAttribute("setup", setup.toString().toLowerCase(Locale.ROOT));
412 return fingerprint;
413 }
414
415 public String getHash() {
416 return this.getAttribute("hash");
417 }
418
419 public Setup getSetup() {
420 final String setup = this.getAttribute("setup");
421 return setup == null ? null : Setup.of(setup);
422 }
423 }
424
425 public enum Setup {
426 ACTPASS,
427 PASSIVE,
428 ACTIVE;
429
430 public static Setup of(String setup) {
431 try {
432 return valueOf(setup.toUpperCase(Locale.ROOT));
433 } catch (IllegalArgumentException e) {
434 return null;
435 }
436 }
437
438 public Setup flip() {
439 if (this == PASSIVE) {
440 return ACTIVE;
441 }
442 if (this == ACTIVE) {
443 return PASSIVE;
444 }
445 throw new IllegalStateException(this.name() + " can not be flipped");
446 }
447 }
448
449 public static class IceOption extends Element {
450
451 public static final List<String> WELL_KNOWN = Arrays.asList("trickle", "renomination");
452
453 public IceOption(final String name) {
454 super(name, Namespace.JINGLE_TRANSPORT_ICE_OPTION);
455 }
456
457 public static Collection<String> of(SessionDescription.Media media) {
458 final String iceOptions = Iterables.getFirst(media.attributes.get("ice-options"), null);
459 if (Strings.isNullOrEmpty(iceOptions)) {
460 return Collections.emptyList();
461 }
462 final ImmutableList.Builder<String> optionBuilder = new ImmutableList.Builder<>();
463 for (final String iceOption : Splitter.on(' ').split(iceOptions)) {
464 if (WELL_KNOWN.contains(iceOption)) {
465 optionBuilder.add(iceOption);
466 } else {
467 Log.w(Config.LOGTAG, "unrecognized ice option: " + iceOption);
468 }
469 }
470 return optionBuilder.build();
471 }
472 }
473}