1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>nepi.resources.linux.udptunnel — NEPI 3.0 documentation</title>
11 <link rel="stylesheet" href="../../../../_static/sphinxdoc.css" type="text/css" />
12 <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: '../../../../',
18 COLLAPSE_INDEX: false,
23 <script type="text/javascript" src="../../../../_static/jquery.js"></script>
24 <script type="text/javascript" src="../../../../_static/underscore.js"></script>
25 <script type="text/javascript" src="../../../../_static/doctools.js"></script>
26 <link rel="top" title="NEPI 3.0 documentation" href="../../../../index.html" />
27 <link rel="up" title="Module code" href="../../../index.html" />
33 <li class="right" style="margin-right: 10px">
34 <a href="../../../../genindex.html" title="General Index"
35 accesskey="I">index</a></li>
37 <a href="../../../../py-modindex.html" title="Python Module Index"
39 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
40 <li><a href="../../../index.html" accesskey="U">Module code</a> »</li>
43 <div class="sphinxsidebar">
44 <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
47 <form class="search" action="../../../../search.html" method="get">
48 <input type="text" name="q" />
49 <input type="submit" value="Go" />
50 <input type="hidden" name="check_keywords" value="yes" />
51 <input type="hidden" name="area" value="default" />
53 <p class="searchtip" style="font-size: 90%">
54 Enter search terms or a module, class or function name.
57 <script type="text/javascript">$('#searchbox').show(0);</script>
61 <div class="document">
62 <div class="documentwrapper">
63 <div class="bodywrapper">
66 <h1>Source code for nepi.resources.linux.udptunnel</h1><div class="highlight"><pre>
67 <span class="c">#</span>
68 <span class="c"># NEPI, a framework to manage network experiments</span>
69 <span class="c"># Copyright (C) 2013 INRIA</span>
70 <span class="c">#</span>
71 <span class="c"># This program is free software: you can redistribute it and/or modify</span>
72 <span class="c"># it under the terms of the GNU General Public License version 2 as</span>
73 <span class="c"># published by the Free Software Foundation;</span>
74 <span class="c">#</span>
75 <span class="c"># This program is distributed in the hope that it will be useful,</span>
76 <span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
77 <span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
78 <span class="c"># GNU General Public License for more details.</span>
79 <span class="c">#</span>
80 <span class="c"># You should have received a copy of the GNU General Public License</span>
81 <span class="c"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac <alina.quereilhac@inria.fr></span>
85 <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>
86 <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>
87 <span class="kn">from</span> <span class="nn">nepi.resources.linux.tunnel</span> <span class="kn">import</span> <span class="n">LinuxTunnel</span>
88 <span class="kn">from</span> <span class="nn">nepi.util.sshfuncs</span> <span class="kn">import</span> <span class="n">ProcStatus</span>
89 <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>
91 <span class="kn">import</span> <span class="nn">os</span>
92 <span class="kn">import</span> <span class="nn">socket</span>
93 <span class="kn">import</span> <span class="nn">time</span>
95 <span class="nd">@clsinit_copy</span>
96 <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>
97 <span class="n">_rtype</span> <span class="o">=</span> <span class="s">"linux::UdpTunnel"</span>
98 <span class="n">_help</span> <span class="o">=</span> <span class="s">"Constructs a tunnel between two Linux endpoints using a UDP connection "</span>
99 <span class="n">_platform</span> <span class="o">=</span> <span class="s">"linux"</span>
101 <span class="nd">@classmethod</span>
102 <span class="k">def</span> <span class="nf">_register_attributes</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
103 <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>
104 <span class="s">"Cipher to encript communication. "</span>
105 <span class="s">"One of PLAIN, AES, Blowfish, DES, DES3. "</span><span class="p">,</span>
106 <span class="n">default</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
107 <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>
108 <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>
109 <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>
111 <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>
112 <span class="s">"Specify a symmetric encryption key with which to protect "</span>
113 <span class="s">"packets across the tunnel. python-crypto must be installed "</span>
114 <span class="s">"on the system."</span> <span class="p">,</span>
115 <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>
117 <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>
118 <span class="s">"Specifies the interface's transmission queue length. "</span>
119 <span class="s">"Defaults to 1000. "</span><span class="p">,</span>
120 <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>
121 <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>
123 <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>
124 <span class="s">"Specifies the interface's emulated bandwidth in bytes "</span>
125 <span class="s">"per second."</span><span class="p">,</span>
126 <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>
127 <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>
129 <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>
130 <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>
131 <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>
132 <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>
134 <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>
135 <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>
136 <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>
137 <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>
139 <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>
140 <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>
141 <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>
142 <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>
143 <span class="n">msg</span><span class="p">)</span>
145 <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>
146 <span class="sd">""" Returns the list of RM that are endpoints to the tunnel </span>
147 <span class="sd"> """</span>
148 <span class="n">connected</span> <span class="o">=</span> <span class="p">[]</span>
149 <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>
150 <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>
151 <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>
152 <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>
153 <span class="k">return</span> <span class="n">connected</span>
155 <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>
156 <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>
157 <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>
158 <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>
159 <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>
160 <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>
161 <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>
163 <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>
164 <span class="n">remote_endpoint</span><span class="p">,</span>
165 <span class="n">connection_app_home</span><span class="p">,</span>
166 <span class="n">connection_run_home</span><span class="p">,</span>
167 <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>
169 <span class="k">return</span> <span class="n">port</span>
171 <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>
172 <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>
173 <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>
175 <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>
176 <span class="n">connection_app_home</span><span class="p">,</span>
177 <span class="n">connection_run_home</span><span class="p">,</span>
178 <span class="n">port</span><span class="p">)</span>
180 <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>
181 <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>
182 <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>
184 <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>
185 <span class="n">connection_app_home</span><span class="p">,</span>
186 <span class="n">connection_run_home</span><span class="p">)</span>
188 <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>
189 <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>
190 <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>
192 <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>
193 <span class="n">connection_app_home</span><span class="p">,</span>
194 <span class="n">connection_run_home</span><span class="p">)</span>
196 <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>
197 <span class="c"># Make sure the process is still running in background</span>
198 <span class="c"># No execution errors occurred. Make sure the background</span>
199 <span class="c"># process with the recorded pid is still running.</span>
201 <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>
202 <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>
204 <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> \
205 <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>
207 <span class="c"># check if execution errors occurred</span>
208 <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>
209 <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>
211 <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>
212 <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>
214 <span class="k">if</span> <span class="n">err1</span> <span class="ow">or</span> <span class="n">err2</span><span class="p">:</span>
215 <span class="n">msg</span> <span class="o">=</span> <span class="s">"Error occurred in tunnel"</span>
216 <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>
217 <span class="bp">self</span><span class="o">.</span><span class="n">fail</span><span class="p">()</span>
218 <span class="k">else</span><span class="p">:</span>
219 <span class="bp">self</span><span class="o">.</span><span class="n">set_stopped</span><span class="p">()</span>
220 </pre></div></div></div>
225 <div class="clearer"></div>
227 <div class="related">
230 <li class="right" style="margin-right: 10px">
231 <a href="../../../../genindex.html" title="General Index"
234 <a href="../../../../py-modindex.html" title="Python Module Index"
236 <li><a href="../../../../index.html">NEPI 3.0 documentation</a> »</li>
237 <li><a href="../../../index.html" >Module code</a> »</li>
241 © Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
242 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.