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