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