JingleS5BTransportManager.java

  1. /**
  2.  *
  3.  * Copyright 2017 Paul Schaub
  4.  *
  5.  * Licensed under the Apache License, Version 2.0 (the "License");
  6.  * you may not use this file except in compliance with the License.
  7.  * You may obtain a copy of the License at
  8.  *
  9.  *     http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.jivesoftware.smackx.jingle.transports.jingle_s5b;

  19. import java.util.ArrayList;
  20. import java.util.Iterator;
  21. import java.util.List;
  22. import java.util.WeakHashMap;
  23. import java.util.logging.Level;
  24. import java.util.logging.Logger;

  26. import org.jivesoftware.smack.SmackException;
  27. import org.jivesoftware.smack.XMPPConnection;
  28. import org.jivesoftware.smack.XMPPException;
  29. import org.jivesoftware.smack.packet.IQ;

  31. import org.jivesoftware.smackx.bytestreams.socks5.Socks5BytestreamManager;
  32. import org.jivesoftware.smackx.bytestreams.socks5.Socks5Proxy;
  33. import org.jivesoftware.smackx.bytestreams.socks5.packet.Bytestream;
  34. import org.jivesoftware.smackx.jingle.JingleSession;
  35. import org.jivesoftware.smackx.jingle.element.Jingle;
  36. import org.jivesoftware.smackx.jingle.element.JingleAction;
  37. import org.jivesoftware.smackx.jingle.element.JingleContent;
  38. import org.jivesoftware.smackx.jingle.provider.JingleContentProviderManager;
  39. import org.jivesoftware.smackx.jingle.transports.JingleTransportManager;
  40. import org.jivesoftware.smackx.jingle.transports.JingleTransportSession;
  41. import org.jivesoftware.smackx.jingle.transports.jingle_s5b.elements.JingleS5BTransport;
  42. import org.jivesoftware.smackx.jingle.transports.jingle_s5b.provider.JingleS5BTransportProvider;

  44. import org.jxmpp.jid.FullJid;
  45. import org.jxmpp.jid.Jid;

  47. /**
  48.  * Manager for Jingle SOCKS5 Bytestream transports (XEP-0261).
  49.  */
  50. public final class JingleS5BTransportManager extends JingleTransportManager<JingleS5BTransport> {

  52.     private static final Logger LOGGER = Logger.getLogger(JingleS5BTransportManager.class.getName());

  54.     private static final WeakHashMap<XMPPConnection, JingleS5BTransportManager> INSTANCES = new WeakHashMap<>();

  56.     private List<Bytestream.StreamHost> localStreamHosts = null;
  57.     private List<Bytestream.StreamHost> availableStreamHosts = null;

  59.     private static boolean useLocalCandidates = true;
  60.     private static boolean useExternalCandidates = true;

  62.     private JingleS5BTransportManager(XMPPConnection connection) {
  63.         super(connection);
  64.         JingleContentProviderManager.addJingleContentTransportProvider(getNamespace(), new JingleS5BTransportProvider());
  65.     }

  67.     public static synchronized JingleS5BTransportManager getInstanceFor(XMPPConnection connection) {
  68.         JingleS5BTransportManager manager = INSTANCES.get(connection);
  69.         if (manager == null) {
  70.             manager = new JingleS5BTransportManager(connection);
  71.             INSTANCES.put(connection, manager);
  72.         }
  73.         return manager;
  74.     }

  76.     @Override
  77.     public String getNamespace() {
  78.         return JingleS5BTransport.NAMESPACE_V1;
  79.     }

  81.     @Override
  82.     public JingleTransportSession<JingleS5BTransport> transportSession(JingleSession jingleSession) {
  83.         return new JingleS5BTransportSession(jingleSession);
  84.     }

  86.     private List<Bytestream.StreamHost> queryAvailableStreamHosts() throws XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException, SmackException.NoResponseException {
  87.         Socks5BytestreamManager s5m = Socks5BytestreamManager.getBytestreamManager(getConnection());
  88.         List<Jid> proxies = s5m.determineProxies();
  89.         return determineStreamHostInfo(proxies);
  90.     }

  92.     private List<Bytestream.StreamHost> queryLocalStreamHosts() {
  93.         return Socks5BytestreamManager.getBytestreamManager(getConnection())
  94.                 .getLocalStreamHost();
  95.     }

  97.     public List<Bytestream.StreamHost> getAvailableStreamHosts() throws XMPPException.XMPPErrorException, SmackException.NotConnectedException, InterruptedException, SmackException.NoResponseException {
  98.         if (availableStreamHosts == null) {
  99.             availableStreamHosts = queryAvailableStreamHosts();
  100.         }
  101.         return availableStreamHosts;
  102.     }

  104.     public List<Bytestream.StreamHost> getLocalStreamHosts() {
  105.         if (localStreamHosts == null) {
  106.             localStreamHosts = queryLocalStreamHosts();
  107.         }
  108.         return localStreamHosts;
  109.     }

  111.     public List<Bytestream.StreamHost> determineStreamHostInfo(List<Jid> proxies) {
  112.         XMPPConnection connection = getConnection();
  113.         List<Bytestream.StreamHost> streamHosts = new ArrayList<>();

  115.         Iterator<Jid> iterator = proxies.iterator();
  116.         while (iterator.hasNext()) {
  117.             Jid proxy = iterator.next();
  118.             Bytestream request = new Bytestream();
  119.             request.setType(IQ.Type.get);
  120.             request.setTo(proxy);
  121.             try {
  122.                 Bytestream response = connection.sendIqRequestAndWaitForResponse(request);
  123.                 streamHosts.addAll(response.getStreamHosts());
  124.             }
  125.             catch (Exception e) {
  126.                 iterator.remove();
  127.             }
  128.         }

  130.         return streamHosts;
  131.     }


  134.     @Override
  135.     public void authenticated(XMPPConnection connection, boolean resumed) {
  136.         if (!resumed) try {
  137.             Socks5Proxy socks5Proxy = Socks5Proxy.getSocks5Proxy();
  138.             if (!socks5Proxy.isRunning()) {
  139.                 socks5Proxy.start();
  140.             }
  141.             localStreamHosts = queryLocalStreamHosts();
  142.             availableStreamHosts = queryAvailableStreamHosts();
  143.         } catch (InterruptedException | SmackException.NoResponseException | SmackException.NotConnectedException | XMPPException.XMPPErrorException e) {
  144.             LOGGER.log(Level.WARNING, "Could not query available StreamHosts: " + e, e);
  145.         }
  146.     }

  148.     public Jingle createCandidateUsed(FullJid recipient, FullJid initiator, String sessionId, JingleContent.Senders contentSenders,
  149.                                       JingleContent.Creator contentCreator, String contentName, String streamId,
  150.                                       String candidateId) {
  151.         Jingle.Builder jb = Jingle.builder(connection());
  152.         jb.setSessionId(sessionId).setInitiator(initiator).setAction(JingleAction.transport_info);

  154.         JingleContent.Builder cb = JingleContent.getBuilder();
  155.         cb.setName(contentName).setCreator(contentCreator).setSenders(contentSenders);

  157.         JingleS5BTransport.Builder tb = JingleS5BTransport.getBuilder();
  158.         tb.setCandidateUsed(candidateId).setStreamId(streamId);

  160.         Jingle jingle = jb.addJingleContent(cb.setTransport(tb.build()).build()).build();
  161.         jingle.setFrom(getConnection().getUser().asFullJidOrThrow());
  162.         jingle.setTo(recipient);

  164.         return jingle;
  165.     }

  167.     public Jingle createCandidateError(FullJid remote, FullJid initiator, String sessionId, JingleContent.Senders senders, JingleContent.Creator creator, String name, String streamId) {
  168.         Jingle.Builder jb = Jingle.builder(connection());
  169.         jb.setSessionId(sessionId).setInitiator(initiator).setAction(JingleAction.transport_info);

  171.         JingleContent.Builder cb = JingleContent.getBuilder();
  172.         cb.setName(name).setCreator(creator).setSenders(senders);

  174.         JingleS5BTransport.Builder tb = JingleS5BTransport.getBuilder();
  175.         tb.setCandidateError().setStreamId(streamId);

  177.         Jingle jingle = jb.addJingleContent(cb.setTransport(tb.build()).build()).build();
  178.         jingle.setFrom(getConnection().getUser().asFullJidOrThrow());
  179.         jingle.setTo(remote);

  181.         return jingle;
  182.     }

  184.     public Jingle createProxyError(FullJid remote, FullJid initiator, String sessionId,
  185.                                    JingleContent.Senders senders, JingleContent.Creator creator,
  186.                                    String name, String streamId) {
  187.         Jingle.Builder jb = Jingle.builder(connection());
  188.         jb.setSessionId(sessionId).setAction(JingleAction.transport_info).setInitiator(initiator);

  190.         JingleContent.Builder cb = JingleContent.getBuilder();
  191.         cb.setSenders(senders).setCreator(creator).setName(name);

  193.         JingleS5BTransport.Builder tb = JingleS5BTransport.getBuilder();
  194.         tb.setStreamId(sessionId).setProxyError().setStreamId(streamId);

  196.         Jingle jingle = jb.addJingleContent(cb.setTransport(tb.build()).build()).build();
  197.         jingle.setTo(remote);
  198.         jingle.setFrom(getConnection().getUser().asFullJidOrThrow());
  199.         return jingle;
  200.     }

  202.     public Jingle createCandidateActivated(FullJid remote, FullJid initiator, String sessionId,
  203.                                            JingleContent.Senders senders, JingleContent.Creator creator,
  204.                                            String name, String streamId, String candidateId) {
  205.         Jingle.Builder jb = Jingle.builder(connection());
  206.         jb.setInitiator(initiator).setSessionId(sessionId).setAction(JingleAction.transport_info);

  208.         JingleContent.Builder cb = JingleContent.getBuilder();
  209.         cb.setName(name).setCreator(creator).setSenders(senders);

  211.         JingleS5BTransport.Builder tb = JingleS5BTransport.getBuilder();
  212.         tb.setStreamId(streamId).setCandidateActivated(candidateId);

  214.         Jingle jingle = jb.addJingleContent(cb.setTransport(tb.build()).build()).build();
  215.         jingle.setFrom(getConnection().getUser().asFullJidOrThrow());
  216.         jingle.setTo(remote);
  217.         return jingle;
  218.     }

  220.     public static void setUseLocalCandidates(boolean localCandidates) {
  221.         JingleS5BTransportManager.useLocalCandidates = localCandidates;
  222.     }

  224.     public static void setUseExternalCandidates(boolean externalCandidates) {
  225.         JingleS5BTransportManager.useExternalCandidates = externalCandidates;
  226.     }

  228.     public static boolean isUseLocalCandidates() {
  229.         return useLocalCandidates;
  230.     }

  232.     public static boolean isUseExternalCandidates() {
  233.         return useExternalCandidates;
  234.     }
  235. }
Created with JaCoCo 0.8.6.202009150832