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 final String[] segments = pair[1].split(" ");
204 if (segments.length >= 6) {
205 final String id = UUID.randomUUID().toString();
206 final String foundation = segments[0];
207 final String component = segments[1];
208 final String transport = segments[2].toLowerCase(Locale.ROOT);
209 final String priority = segments[3];
210 final String connectionAddress = segments[4];
211 final String port = segments[5];
212 final HashMap<String, String> additional = new HashMap<>();
213 for (int i = 6; i < segments.length - 1; i = i + 2) {
214 additional.put(segments[i], segments[i + 1]);
215 }
216 final String ufrag = additional.get("ufrag");
217 if (ufrag != null && !ufrag.equals(currentUfrag)) {
218 return null;
219 }
220 final Candidate candidate = new Candidate();
221 candidate.setAttribute("component", component);
222 candidate.setAttribute("foundation", foundation);
223 candidate.setAttribute("generation", additional.get("generation"));
224 candidate.setAttribute("rel-addr", additional.get("raddr"));
225 candidate.setAttribute("rel-port", additional.get("rport"));
226 candidate.setAttribute("id", id);
227 candidate.setAttribute("ip", connectionAddress);
228 candidate.setAttribute("port", port);
229 candidate.setAttribute("priority", priority);
230 candidate.setAttribute("protocol", transport);
231 candidate.setAttribute("type", additional.get("typ"));
232 return candidate;
233 }
234 }
235 return null;
236 }
237
238 public int getComponent() {
239 return getAttributeAsInt("component");
240 }
241
242 public int getFoundation() {
243 return getAttributeAsInt("foundation");
244 }
245
246 public int getGeneration() {
247 return getAttributeAsInt("generation");
248 }
249
250 public String getId() {
251 return getAttribute("id");
252 }
253
254 public String getIp() {
255 return getAttribute("ip");
256 }
257
258 public int getNetwork() {
259 return getAttributeAsInt("network");
260 }
261
262 public int getPort() {
263 return getAttributeAsInt("port");
264 }
265
266 public int getPriority() {
267 return getAttributeAsInt("priority");
268 }
269
270 public String getProtocol() {
271 return getAttribute("protocol");
272 }
273
274 public String getRelAddr() {
275 return getAttribute("rel-addr");
276 }
277
278 public int getRelPort() {
279 return getAttributeAsInt("rel-port");
280 }
281
282 public String getType() { // TODO might be converted to enum
283 return getAttribute("type");
284 }
285
286 private int getAttributeAsInt(final String name) {
287 final String value = this.getAttribute(name);
288 if (value == null) {
289 return 0;
290 }
291 try {
292 return Integer.parseInt(value);
293 } catch (NumberFormatException e) {
294 return 0;
295 }
296 }
297
298 public String toSdpAttribute(final String ufrag) {
299 final String foundation = this.getAttribute("foundation");
300 checkNotNullNoWhitespace(foundation, "foundation");
301 final String component = this.getAttribute("component");
302 checkNotNullNoWhitespace(component, "component");
303 final String protocol = this.getAttribute("protocol");
304 checkNotNullNoWhitespace(protocol, "protocol");
305 final String transport = protocol.toLowerCase(Locale.ROOT);
306 if (!"udp".equals(transport)) {
307 throw new IllegalArgumentException(
308 String.format("'%s' is not a supported protocol", transport));
309 }
310 final String priority = this.getAttribute("priority");
311 checkNotNullNoWhitespace(priority, "priority");
312 final String connectionAddress = this.getAttribute("ip");
313 checkNotNullNoWhitespace(connectionAddress, "ip");
314 final String port = this.getAttribute("port");
315 checkNotNullNoWhitespace(port, "port");
316 final Map<String, String> additionalParameter = new LinkedHashMap<>();
317 final String relAddr = this.getAttribute("rel-addr");
318 final String type = this.getAttribute("type");
319 if (type != null) {
320 additionalParameter.put("typ", type);
321 }
322 if (relAddr != null) {
323 additionalParameter.put("raddr", relAddr);
324 }
325 final String relPort = this.getAttribute("rel-port");
326 if (relPort != null) {
327 additionalParameter.put("rport", relPort);
328 }
329 final String generation = this.getAttribute("generation");
330 if (generation != null) {
331 additionalParameter.put("generation", generation);
332 }
333 if (ufrag != null) {
334 additionalParameter.put("ufrag", ufrag);
335 }
336 final String parametersString =
337 Joiner.on(' ')
338 .join(
339 Collections2.transform(
340 additionalParameter.entrySet(),
341 input ->
342 String.format(
343 "%s %s",
344 input.getKey(), input.getValue())));
345 return String.format(
346 "candidate:%s %s %s %s %s %s %s",
347 foundation,
348 component,
349 transport,
350 priority,
351 connectionAddress,
352 port,
353 parametersString);
354 }
355 }
356
357 private static void checkNotNullNoWhitespace(final String value, final String name) {
358 if (Strings.isNullOrEmpty(value)) {
359 throw new IllegalArgumentException(
360 String.format("Parameter %s is missing or empty", name));
361 }
362 SessionDescription.checkNoWhitespace(
363 value, String.format("Parameter %s contains white spaces", name));
364 }
365
366 public static class Fingerprint extends Element {
367
368 private Fingerprint() {
369 super("fingerprint", Namespace.JINGLE_APPS_DTLS);
370 }
371
372 public static Fingerprint upgrade(final Element element) {
373 Preconditions.checkArgument("fingerprint".equals(element.getName()));
374 Preconditions.checkArgument(Namespace.JINGLE_APPS_DTLS.equals(element.getNamespace()));
375 final Fingerprint fingerprint = new Fingerprint();
376 fingerprint.setAttributes(element.getAttributes());
377 fingerprint.setContent(element.getContent());
378 return fingerprint;
379 }
380
381 private static Fingerprint of(ArrayListMultimap<String, String> attributes) {
382 final String fingerprint = Iterables.getFirst(attributes.get("fingerprint"), null);
383 final String setup = Iterables.getFirst(attributes.get("setup"), null);
384 if (setup != null && fingerprint != null) {
385 final String[] fingerprintParts = fingerprint.split(" ", 2);
386 if (fingerprintParts.length == 2) {
387 final String hash = fingerprintParts[0];
388 final String actualFingerprint = fingerprintParts[1];
389 final Fingerprint element = new Fingerprint();
390 element.setAttribute("hash", hash);
391 element.setAttribute("setup", setup);
392 element.setContent(actualFingerprint);
393 return element;
394 }
395 }
396 return null;
397 }
398
399 public static Fingerprint of(
400 final SessionDescription sessionDescription, final SessionDescription.Media media) {
401 final Fingerprint fingerprint = of(media.attributes);
402 return fingerprint == null ? of(sessionDescription.attributes) : fingerprint;
403 }
404
405 private static Fingerprint of(final Setup setup, final String hash, final String content) {
406 final Fingerprint fingerprint = new Fingerprint();
407 fingerprint.setContent(content);
408 fingerprint.setAttribute("hash", hash);
409 fingerprint.setAttribute("setup", setup.toString().toLowerCase(Locale.ROOT));
410 return fingerprint;
411 }
412
413 public String getHash() {
414 return this.getAttribute("hash");
415 }
416
417 public Setup getSetup() {
418 final String setup = this.getAttribute("setup");
419 return setup == null ? null : Setup.of(setup);
420 }
421 }
422
423 public enum Setup {
424 ACTPASS,
425 PASSIVE,
426 ACTIVE;
427
428 public static Setup of(String setup) {
429 try {
430 return valueOf(setup.toUpperCase(Locale.ROOT));
431 } catch (IllegalArgumentException e) {
432 return null;
433 }
434 }
435
436 public Setup flip() {
437 if (this == PASSIVE) {
438 return ACTIVE;
439 }
440 if (this == ACTIVE) {
441 return PASSIVE;
442 }
443 throw new IllegalStateException(this.name() + " can not be flipped");
444 }
445 }
446
447 public static class IceOption extends Element {
448
449 public static final List<String> WELL_KNOWN = Arrays.asList("trickle", "renomination");
450
451 public IceOption(final String name) {
452 super(name, Namespace.JINGLE_TRANSPORT_ICE_OPTION);
453 }
454
455 public static Collection<String> of(SessionDescription.Media media) {
456 final String iceOptions = Iterables.getFirst(media.attributes.get("ice-options"), null);
457 if (Strings.isNullOrEmpty(iceOptions)) {
458 return Collections.emptyList();
459 }
460 final ImmutableList.Builder<String> optionBuilder = new ImmutableList.Builder<>();
461 for (final String iceOption : Splitter.on(' ').split(iceOptions)) {
462 if (WELL_KNOWN.contains(iceOption)) {
463 optionBuilder.add(iceOption);
464 } else {
465 Log.w(Config.LOGTAG, "unrecognized ice option: " + iceOption);
466 }
467 }
468 return optionBuilder.build();
469 }
470 }
471}