[certi-cvs] certi doc/certi_install.cnf.in doc/certi_instal...

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    certi
Changes by:     Petr Gotthard <gotthardp>       08/10/26 16:20:15

Modified files:
        doc            : certi_install.cnf.in certi_install_doc.tree 
                         execute.dox 
        libCERTI       : SocketHTTPProxy.cc 
Added files:
        doc/images     : putty-portforwarding.png 

Log message:
        Bug #24536: Described HTTP tunneling.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.cnf.in?cvsroot=certi&r1=3.4&r2=3.5
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install_doc.tree?cvsroot=certi&r1=3.4&r2=3.5
http://cvs.savannah.gnu.org/viewcvs/certi/doc/execute.dox?cvsroot=certi&r1=3.1&r2=3.2
http://cvs.savannah.gnu.org/viewcvs/certi/doc/images/putty-portforwarding.png?cvsroot=certi&rev=1.1
http://cvs.savannah.gnu.org/viewcvs/certi/libCERTI/SocketHTTPProxy.cc?cvsroot=certi&r1=3.1&r2=3.2

Patches:
Index: doc/certi_install.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.cnf.in,v
retrieving revision 3.4
retrieving revision 3.5
diff -u -b -r3.4 -r3.5
--- doc/certi_install.cnf.in    19 Oct 2008 21:44:24 -0000      3.4
+++ doc/certi_install.cnf.in    26 Oct 2008 16:20:12 -0000      3.5
@@ -440,7 +440,8 @@
                          "${CMAKE_SOURCE_DIR}/doc/install.dox" \
                          "${CMAKE_SOURCE_DIR}/doc/execute.dox" \
                          "${CMAKE_SOURCE_DIR}/RTIG/main.cc" \
-                         "${CMAKE_SOURCE_DIR}/RTIA/main.cc"
+                         "${CMAKE_SOURCE_DIR}/RTIA/main.cc" \
+                         "${CMAKE_SOURCE_DIR}/libCERTI/SocketHTTPProxy.cc"
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

Index: doc/certi_install_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_install_doc.tree,v
retrieving revision 3.4
retrieving revision 3.5
diff -u -b -r3.4 -r3.5
--- doc/certi_install_doc.tree  19 Oct 2008 21:44:24 -0000      3.4
+++ doc/certi_install_doc.tree  26 Oct 2008 16:20:13 -0000      3.5
@@ -34,13 +34,12 @@
  *
  * This documentation is divided into several parts:
  *
- * <ul>
- *  <li>\ref intro</li>
- *  <li>\ref build</li>
- *  <li>\ref install</li>
- *  <li>\ref execute</li>
- * </ul> 
+ * - \ref intro
+ * - \ref build
+ * - \ref install
+ * - \ref execute
+ *   - \ref certi_HTTP_proxy
  *
  */
 
-// $Id: certi_install_doc.tree,v 3.4 2008/10/19 21:44:24 gotthardp Exp $
+// $Id: certi_install_doc.tree,v 3.5 2008/10/26 16:20:13 gotthardp Exp $

Index: doc/execute.dox
===================================================================
RCS file: /sources/certi/certi/doc/execute.dox,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- doc/execute.dox     19 Oct 2008 21:44:24 -0000      3.1
+++ doc/execute.dox     26 Oct 2008 16:20:13 -0000      3.2
@@ -46,7 +46,9 @@
  * <tr>
  * <td>CERTI_UDP_PORT</td> <td>RTIG, RTIA</td> <td>UDP port used for RTIA/RTIG 
communications</td>
  * </tr>
- * <tr> <td>CERTI_HTTP_PROXY</td> <td>RTIA</td> <td>HTTP proxy address in the 
format http://host:port</td>
+ * <tr> <td>CERTI_HTTP_PROXY</td> <td>RTIA</td>
+ * <td>HTTP proxy address in the format http://host:port.
+ * See \ref certi_HTTP_proxy "HTTP tunneling".</td>
  * </tr>
  * <tr> <td>CERTI_NO_STATISTICS</td> <td>RTIA</td> <td>if set, do not display 
service calls statistics</td>
  * </tr>
@@ -73,4 +75,4 @@
  * \image html "billiard.png"
  */
 
-// $Id: execute.dox,v 3.1 2008/10/19 21:44:24 gotthardp Exp $
+// $Id: execute.dox,v 3.2 2008/10/26 16:20:13 gotthardp Exp $

Index: libCERTI/SocketHTTPProxy.cc
===================================================================
RCS file: /sources/certi/certi/libCERTI/SocketHTTPProxy.cc,v
retrieving revision 3.1
retrieving revision 3.2
diff -u -b -r3.1 -r3.2
--- libCERTI/SocketHTTPProxy.cc 12 Oct 2008 11:46:40 -0000      3.1
+++ libCERTI/SocketHTTPProxy.cc 26 Oct 2008 16:20:15 -0000      3.2
@@ -17,7 +17,7 @@
 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 // USA
 //
-// $Id: SocketHTTPProxy.cc,v 3.1 2008/10/12 11:46:40 gotthardp Exp $
+// $Id: SocketHTTPProxy.cc,v 3.2 2008/10/26 16:20:15 gotthardp Exp $
 // ----------------------------------------------------------------------------
 
 #include "SocketHTTPProxy.hh"
@@ -32,6 +32,64 @@
 static PrettyDebug D("SOCKHTTP", "(SocketHTTPProxy) - ");
 static PrettyDebug G("GENDOC",__FILE__);
 
+/**
+ * @page certi_HTTP_proxy Connecting to RTIG via a HTTP tunnel
+ *
+ * To pass the RTIA--RTIG connection through firewalls, you may use
+ * the HTTP tunnel.
+ *
+ * Federates behind a firewall may be unnable to connect to the RTIG.
+ * To connect via a HTTP tunnel
+ * -# Set the \p CERTI_HOST and \p CERTI_TCP_PORT environment variables
+ *    to RTIG address and port.
+ * -# Set the \p CERTI_HTTP_PROXY environment variable to HTTP proxy address
+ *    in the form http://host:port.
+ * -# Run the federate.
+ *
+ * Note: In the HTTP proxy configuration you may need to enable the HTTP 
CONNECT
+ * method for the port number defined in \p CERTI_TCP_PORT. For example, in
+ * the /etc/squid/squid.conf you may need to configure
+\verbatim
+ acl CERTI_ports port 60400   # the value of CERTI_TCP_PORT
+ acl CONNECT method CONNECT
+ http_access allow CONNECT CERTI_ports
+\endverbatim
+ *
+ * If \p CERTI_HTTP_PROXY is not defined, the system-wide \p http_proxy is 
used.
+ * To disable HTTP tunneling, you must unset both environment variables, or set
+ * \p CERTI_HTTP_PROXY to an empty string.
+ *
+ * If the HTTP proxy is directly accessible for the federate (RTIA), you can 
set
+ * the \p CERTI_HTTP_PROXY environment variable to address of the HTTP proxy,
+ * e.g. http://proxy.example.com. The default port is 3128.
+ *
+ * If you cannot access the HTTP proxy directly, you may use SSH port 
forwarding.
+ * The SSH client will listen to a local port and will ask the remote SSH 
server
+ * to open an outgoing connection to the HTTP proxy. It will then forward all
+ * traffic between the local port and the HTTP proxy inside the SSH connection.
+ *
+ * To use SSH port forwarding
+ * -# Set the \p CERTI_HTTP_PROXY environment variable to an arbitrary local 
port
+ * number, e.g. http://localhost:8808.
+ * -# Establish an SSH connection as follows.
+ *
+ * On Windows you may use the PuTTY client
+ * http://www.chiark.greenend.org.uk/~sgtatham/putty
+ *
+ * Create a SSH session and select the SSH protocol.
+ * Open the Connection -- SSH -- Tunnels configuration. Select "Local", enter
+ * chosen arbitrary "Source port" number (e.g. 8808) and the HTTP proxy
+ * address as "Destination". Make sure you then click "Add".
+ *
+ * \image html "putty-portforwarding.png"
+ *
+ * Most Linux systems have a SSH client installed. Use the \p ssh command.
+\verbatim
+ ssh -L8808:proxy.example.com:3128 address@hidden
+\endverbatim
+ *
+ */
+
 // ----------------------------------------------------------------------------
 SocketHTTPProxy::SocketHTTPProxy() : SocketTCP()
 {
@@ -183,4 +241,4 @@
 
 } // namespace
 
-// $Id: SocketHTTPProxy.cc,v 3.1 2008/10/12 11:46:40 gotthardp Exp $
+// $Id: SocketHTTPProxy.cc,v 3.2 2008/10/26 16:20:15 gotthardp Exp $

Index: doc/images/putty-portforwarding.png
===================================================================
RCS file: doc/images/putty-portforwarding.png
diff -N doc/images/putty-portforwarding.png
Binary files /dev/null and /tmp/cvs6czLz5 differ