--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ <title>nepi.resources.linux.udptunnel — NEPI 3.0 documentation</title>
+
+ <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
+ <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: '../../../../',
+ VERSION: '3.0',
+ COLLAPSE_INDEX: false,
+ FILE_SUFFIX: '.html',
+ HAS_SOURCE: true
+ };
+ </script>
+ <script type="text/javascript" src="../../../../_static/jquery.js"></script>
+ <script type="text/javascript" src="../../../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../../../_static/doctools.js"></script>
+ <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
+ <link rel="up" title="Module code" href="../../../index.html" />
+ </head>
+ <body>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ accesskey="I">index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="sphinxsidebar">
+ <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none">
+ <h3>Quick search</h3>
+ <form class="search" action="../../../../search.html" method="get">
+ <input type="text" name="q" />
+ <input type="submit" value="Go" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+ <p class="searchtip" style="font-size: 90%">
+ Enter search terms or a module, class or function name.
+ </p>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+ </div>
+ </div>
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+ <div class="body">
+
+ <h1>Source code for nepi.resources.linux.udptunnel</h1><div class="highlight"><pre>
+<span class="c">#</span>
+<span class="c"># NEPI, a framework to manage network experiments</span>
+<span class="c"># Copyright (C) 2013 INRIA</span>
+<span class="c">#</span>
+<span class="c"># This program is free software: you can redistribute it and/or modify</span>
+<span class="c"># it under the terms of the GNU General Public License version 2 as</span>
+<span class="c"># published by the Free Software Foundation;</span>
+<span class="c">#</span>
+<span class="c"># This program is distributed in the hope that it will be useful,</span>
+<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
+<span class="c"># GNU General Public License for more details.</span>
+<span class="c">#</span>
+<span class="c"># You should have received a copy of the GNU General Public License</span>
+<span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
+<span class="c">#</span>
+<span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
+
+<span class="kn">from</span> <span class="nn">nepi.execution.attribute</span> <span class="kn">import</span> <span class="n">Attribute</span><span class="p">,</span> <span class="n">Flags</span><span class="p">,</span> <span class="n">Types</span>
+<span class="kn">from</span> <span class="nn">nepi.execution.resource</span> <span class="kn">import</span> <span class="n">clsinit_copy</span><span class="p">,</span> <span class="n">ResourceState</span>
+<span class="kn">from</span> <span class="nn">nepi.resources.linux.tunnel</span> <span class="kn">import</span> <span class="n">LinuxTunnel</span>
+<span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span>
+<span class="kn">from</span> <span class="nn">nepi.util.timefuncs</span> <span class="kn">import</span> <span class="n">tnow</span><span class="p">,</span> <span class="n">tdiffsec</span>
+
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">socket</span>
+<span class="kn">import</span> <span class="nn">time</span>
+
+<span class="nd">@clsinit_copy</span>
+<div class="viewcode-block" id="LinuxUdpTunnel"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel">[docs]</a><span class="k">class</span> <span class="nc">LinuxUdpTunnel</span><span class="p">(</span><span class="n">LinuxTunnel</span><span class="p">):</span>
+ <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"linux::UdpTunnel"</span>
+ <span class="n">_help</span> <span class="o">=</span> <span class="s">"Constructs a tunnel between two Linux endpoints using a UDP connection "</span>
+ <span class="n">_platform</span> <span class="o">=</span> <span class="s">"linux"</span>
+
+ <span class="nd">@classmethod</span>
+ <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+ <span class="n">cipher</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"cipher"</span><span class="p">,</span>
+ <span class="s">"Cipher to encript communication. "</span>
+ <span class="s">"One of PLAIN, AES, Blowfish, DES, DES3. "</span><span class="p">,</span>
+ <span class="n">default</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">allowed</span> <span class="o">=</span> <span class="p">[</span><span class="s">"PLAIN"</span><span class="p">,</span> <span class="s">"AES"</span><span class="p">,</span> <span class="s">"Blowfish"</span><span class="p">,</span> <span class="s">"DES"</span><span class="p">,</span> <span class="s">"DES3"</span><span class="p">],</span>
+ <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Enumerate</span><span class="p">,</span>
+ <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
+
+ <span class="n">cipher_key</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"cipherKey"</span><span class="p">,</span>
+ <span class="s">"Specify a symmetric encryption key with which to protect "</span>
+ <span class="s">"packets across the tunnel. python-crypto must be installed "</span>
+ <span class="s">"on the system."</span> <span class="p">,</span>
+ <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
+
+ <span class="n">txqueuelen</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"txQueueLen"</span><span class="p">,</span>
+ <span class="s">"Specifies the interface's transmission queue length. "</span>
+ <span class="s">"Defaults to 1000. "</span><span class="p">,</span>
+ <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
+ <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
+
+ <span class="n">bwlimit</span> <span class="o">=</span> <span class="n">Attribute</span><span class="p">(</span><span class="s">"bwLimit"</span><span class="p">,</span>
+ <span class="s">"Specifies the interface's emulated bandwidth in bytes "</span>
+ <span class="s">"per second."</span><span class="p">,</span>
+ <span class="nb">type</span> <span class="o">=</span> <span class="n">Types</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span>
+ <span class="n">flags</span> <span class="o">=</span> <span class="n">Flags</span><span class="o">.</span><span class="n">Design</span><span class="p">)</span>
+
+ <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">cipher</span><span class="p">)</span>
+ <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">cipher_key</span><span class="p">)</span>
+ <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">txqueuelen</span><span class="p">)</span>
+ <span class="n">cls</span><span class="o">.</span><span class="n">_register_attribute</span><span class="p">(</span><span class="n">bwlimit</span><span class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">):</span>
+ <span class="nb">super</span><span class="p">(</span><span class="n">LinuxUdpTunnel</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">ec</span><span class="p">,</span> <span class="n">guid</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_home</span> <span class="o">=</span> <span class="s">"udp-tunnel-</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">guid</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">_pids</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+
+<div class="viewcode-block" id="LinuxUdpTunnel.log_message"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.log_message">[docs]</a> <span class="k">def</span> <span class="nf">log_message</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg</span><span class="p">):</span>
+ <span class="k">return</span> <span class="s">" guid </span><span class="si">%d</span><span class="s"> - udptunnel </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">guid</span><span class="p">,</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">endpoint1</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"hostname"</span><span class="p">),</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">endpoint2</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"hostname"</span><span class="p">),</span>
+ <span class="n">msg</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LinuxUdpTunnel.get_endpoints"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.get_endpoints">[docs]</a> <span class="k">def</span> <span class="nf">get_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="sd">""" Returns the list of RM that are endpoints to the tunnel </span>
+<span class="sd"> """</span>
+ <span class="n">connected</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="k">for</span> <span class="n">guid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">connections</span><span class="p">:</span>
+ <span class="n">rm</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ec</span><span class="o">.</span><span class="n">get_resource</span><span class="p">(</span><span class="n">guid</span><span class="p">)</span>
+ <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">rm</span><span class="p">,</span> <span class="s">"initiate_udp_connection"</span><span class="p">):</span>
+ <span class="n">connected</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">rm</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">connected</span>
+</div>
+<div class="viewcode-block" id="LinuxUdpTunnel.initiate_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.initiate_connection">[docs]</a> <span class="k">def</span> <span class="nf">initiate_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">):</span>
+ <span class="n">cipher</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"cipher"</span><span class="p">)</span>
+ <span class="n">cipher_key</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"cipherKey"</span><span class="p">)</span>
+ <span class="n">bwlimit</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"bwLimit"</span><span class="p">)</span>
+ <span class="n">txqueuelen</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">"txQueueLen"</span><span class="p">)</span>
+ <span class="n">connection_app_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+ <span class="n">connection_run_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+
+ <span class="n">port</span> <span class="o">=</span> <span class="n">endpoint</span><span class="o">.</span><span class="n">initiate_udp_connection</span><span class="p">(</span>
+ <span class="n">remote_endpoint</span><span class="p">,</span>
+ <span class="n">connection_app_home</span><span class="p">,</span>
+ <span class="n">connection_run_home</span><span class="p">,</span>
+ <span class="n">cipher</span><span class="p">,</span> <span class="n">cipher_key</span><span class="p">,</span> <span class="n">bwlimit</span><span class="p">,</span> <span class="n">txqueuelen</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">port</span>
+</div>
+<div class="viewcode-block" id="LinuxUdpTunnel.establish_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.establish_connection">[docs]</a> <span class="k">def</span> <span class="nf">establish_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
+ <span class="n">connection_app_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+ <span class="n">connection_run_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+
+ <span class="n">endpoint</span><span class="o">.</span><span class="n">establish_udp_connection</span><span class="p">(</span><span class="n">remote_endpoint</span><span class="p">,</span>
+ <span class="n">connection_app_home</span><span class="p">,</span>
+ <span class="n">connection_run_home</span><span class="p">,</span>
+ <span class="n">port</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LinuxUdpTunnel.verify_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.verify_connection">[docs]</a> <span class="k">def</span> <span class="nf">verify_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">):</span>
+ <span class="n">connection_app_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+ <span class="n">connection_run_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+
+ <span class="n">endpoint</span><span class="o">.</span><span class="n">verify_connection</span><span class="p">(</span><span class="n">remote_endpoint</span><span class="p">,</span>
+ <span class="n">connection_app_home</span><span class="p">,</span>
+ <span class="n">connection_run_home</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LinuxUdpTunnel.terminate_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.terminate_connection">[docs]</a> <span class="k">def</span> <span class="nf">terminate_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">remote_endpoint</span><span class="p">):</span>
+ <span class="n">connection_app_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">app_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+ <span class="n">connection_run_home</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="n">endpoint</span><span class="p">)</span>
+
+ <span class="n">endpoint</span><span class="o">.</span><span class="n">terminate_connection</span><span class="p">(</span><span class="n">remote_endpoint</span><span class="p">,</span>
+ <span class="n">connection_app_home</span><span class="p">,</span>
+ <span class="n">connection_run_home</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="LinuxUdpTunnel.check_state_connection"><a class="viewcode-back" href="../../../../_layout/nepi.resources.linux.html#nepi.resources.linux.udptunnel.LinuxUdpTunnel.check_state_connection">[docs]</a> <span class="k">def</span> <span class="nf">check_state_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="c"># Make sure the process is still running in background</span>
+ <span class="c"># No execution errors occurred. Make sure the background</span>
+ <span class="c"># process with the recorded pid is still running.</span>
+
+ <span class="n">status1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint1</span><span class="o">.</span><span class="n">check_status</span><span class="p">()</span>
+ <span class="n">status2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint2</span><span class="o">.</span><span class="n">check_status</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="n">status1</span> <span class="o">==</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">FINISHED</span> <span class="ow">and</span> \
+ <span class="n">status2</span> <span class="o">==</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">FINISHED</span><span class="p">:</span>
+
+ <span class="c"># check if execution errors occurred</span>
+ <span class="p">(</span><span class="n">out1</span><span class="p">,</span> <span class="n">err1</span><span class="p">),</span> <span class="n">proc1</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint1</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">check_errors</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">endpoint1</span><span class="p">))</span>
+
+ <span class="p">(</span><span class="n">out2</span><span class="p">,</span> <span class="n">err2</span><span class="p">),</span> <span class="n">proc2</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">endpoint2</span><span class="o">.</span><span class="n">node</span><span class="o">.</span><span class="n">check_errors</span><span class="p">(</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">run_home</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">endpoint2</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">err1</span> <span class="ow">or</span> <span class="n">err2</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error occurred in tunnel"</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">err1</span><span class="p">,</span> <span class="n">err2</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">fail</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
+</pre></div></div></div>
+
+ </div>
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="related">
+ <h3>Navigation</h3>
+ <ul>
+ <li class="right" style="margin-right: 10px">
+ <a href="../../../../genindex.html" title="General Index"
+ >index</a></li>
+ <li class="right" >
+ <a href="../../../../py-modindex.html" title="Python Module Index"
+ >modules</a> |</li>
+ <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
+ <li><a href="../../../index.html" >Module code</a> »</li>
+ </ul>
+ </div>
+ <div class="footer">
+ © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
+ Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
+ </div>
+ </body>
+</html>
\ No newline at end of file