add sphinx documentation
[nepi.git] / doc / sphinx / _build / html / _modules / nepi / util / environ.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>nepi.util.environ &mdash; NEPI 3.0 documentation</title>
10     
11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    '../../../',
17         VERSION:     '3.0',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
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" /> 
28   </head>
29   <body>
30     <div class="related">
31       <h3>Navigation</h3>
32       <ul>
33         <li class="right" style="margin-right: 10px">
34           <a href="../../../genindex.html" title="General Index"
35              accesskey="I">index</a></li>
36         <li class="right" >
37           <a href="../../../py-modindex.html" title="Python Module Index"
38              >modules</a> |</li>
39         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
41       </ul>
42     </div>
43       <div class="sphinxsidebar">
44         <div class="sphinxsidebarwrapper">
45 <div id="searchbox" style="display: none">
46   <h3>Quick search</h3>
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" />
52     </form>
53     <p class="searchtip" style="font-size: 90%">
54     Enter search terms or a module, class or function name.
55     </p>
56 </div>
57 <script type="text/javascript">$('#searchbox').show(0);</script>
58         </div>
59       </div>
60
61     <div class="document">
62       <div class="documentwrapper">
63         <div class="bodywrapper">
64           <div class="body">
65             
66   <h1>Source code for nepi.util.environ</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 &lt;http://www.gnu.org/licenses/&gt;.</span>
82 <span class="c">#</span>
83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
84 <span class="c">#         Martin Ferrari &lt;martin.ferrari@inria.fr&gt;</span>
85
86
87
88 <span class="kn">import</span> <span class="nn">ctypes</span>
89 <span class="kn">import</span> <span class="nn">imp</span>
90 <span class="kn">import</span> <span class="nn">sys</span>
91
92 <span class="kn">import</span> <span class="nn">os</span><span class="o">,</span> <span class="nn">os.path</span><span class="o">,</span> <span class="nn">re</span><span class="o">,</span> <span class="nn">signal</span><span class="o">,</span> <span class="nn">shutil</span><span class="o">,</span> <span class="nn">socket</span><span class="o">,</span> <span class="nn">subprocess</span><span class="o">,</span> <span class="nn">tempfile</span>
93
94 <span class="n">__all__</span> <span class="o">=</span>  <span class="p">[</span><span class="s">&quot;python&quot;</span><span class="p">,</span> <span class="s">&quot;ssh_path&quot;</span><span class="p">]</span>
95 <span class="n">__all__</span> <span class="o">+=</span> <span class="p">[</span><span class="s">&quot;rsh&quot;</span><span class="p">,</span> <span class="s">&quot;tcpdump_path&quot;</span><span class="p">,</span> <span class="s">&quot;sshd_path&quot;</span><span class="p">]</span>
96 <span class="n">__all__</span> <span class="o">+=</span> <span class="p">[</span><span class="s">&quot;execute&quot;</span><span class="p">,</span> <span class="s">&quot;backticks&quot;</span><span class="p">]</span>
97
98
99 <span class="c"># Unittest from Python 2.6 doesn&#39;t have these decorators</span>
100 <span class="k">def</span> <span class="nf">_bannerwrap</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
101     <span class="n">name</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">__name__</span>
102     <span class="k">def</span> <span class="nf">banner</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
103         <span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;*** WARNING: Skipping test </span><span class="si">%s</span><span class="s">: `</span><span class="si">%s</span><span class="s">&#39;</span><span class="se">\n</span><span class="s">&quot;</span> <span class="o">%</span>
104                 <span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">text</span><span class="p">))</span>
105         <span class="k">return</span> <span class="bp">None</span>
106     <span class="k">return</span> <span class="n">banner</span>
107
108 <span class="k">def</span> <span class="nf">skip</span><span class="p">(</span><span class="n">text</span><span class="p">):</span>
109     <span class="k">return</span> <span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">_bannerwrap</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
110
111 <span class="k">def</span> <span class="nf">skipUnless</span><span class="p">(</span><span class="n">cond</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
112     <span class="k">return</span> <span class="p">(</span><span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">_bannerwrap</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">text</span><span class="p">))</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">cond</span> <span class="k">else</span> <span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span>
113
114 <span class="k">def</span> <span class="nf">skipIf</span><span class="p">(</span><span class="n">cond</span><span class="p">,</span> <span class="n">text</span><span class="p">):</span>
115     <span class="k">return</span> <span class="p">(</span><span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">_bannerwrap</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">text</span><span class="p">))</span> <span class="k">if</span> <span class="n">cond</span> <span class="k">else</span> <span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span>
116
117 <span class="k">def</span> <span class="nf">find_bin</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">extra_path</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
118     <span class="n">search</span> <span class="o">=</span> <span class="p">[]</span>
119     <span class="k">if</span> <span class="s">&quot;PATH&quot;</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
120         <span class="n">search</span> <span class="o">+=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">&quot;PATH&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;:&quot;</span><span class="p">)</span>
121     <span class="k">for</span> <span class="n">pref</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&quot;/&quot;</span><span class="p">,</span> <span class="s">&quot;/usr/&quot;</span><span class="p">,</span> <span class="s">&quot;/usr/local/&quot;</span><span class="p">):</span>
122         <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&quot;bin&quot;</span><span class="p">,</span> <span class="s">&quot;sbin&quot;</span><span class="p">):</span>
123             <span class="n">search</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pref</span> <span class="o">+</span> <span class="n">d</span><span class="p">)</span>
124     <span class="k">if</span> <span class="n">extra_path</span><span class="p">:</span>
125         <span class="n">search</span> <span class="o">+=</span> <span class="n">extra_path</span>
126
127     <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">search</span><span class="p">:</span>
128             <span class="k">try</span><span class="p">:</span>
129                 <span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">d</span> <span class="o">+</span> <span class="s">&quot;/&quot;</span> <span class="o">+</span> <span class="n">name</span><span class="p">)</span>
130                 <span class="k">return</span> <span class="n">d</span> <span class="o">+</span> <span class="s">&quot;/&quot;</span> <span class="o">+</span> <span class="n">name</span>
131             <span class="k">except</span> <span class="ne">OSError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
132                 <span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">os</span><span class="o">.</span><span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">:</span>
133                     <span class="k">raise</span>
134     <span class="k">return</span> <span class="bp">None</span>
135
136 <span class="k">def</span> <span class="nf">find_bin_or_die</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">extra_path</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
137     <span class="n">r</span> <span class="o">=</span> <span class="n">find_bin</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
138     <span class="k">if</span> <span class="ow">not</span> <span class="n">r</span><span class="p">:</span>
139         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">((</span><span class="s">&quot;Cannot find `</span><span class="si">%s</span><span class="s">&#39; command, impossible to &quot;</span> <span class="o">+</span>
140                 <span class="s">&quot;continue.&quot;</span><span class="p">)</span> <span class="o">%</span> <span class="n">name</span><span class="p">)</span>
141     <span class="k">return</span> <span class="n">r</span>
142
143 <span class="k">def</span> <span class="nf">find_bin</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">extra_path</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
144     <span class="n">search</span> <span class="o">=</span> <span class="p">[]</span>
145     <span class="k">if</span> <span class="s">&quot;PATH&quot;</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">:</span>
146         <span class="n">search</span> <span class="o">+=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s">&quot;PATH&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;:&quot;</span><span class="p">)</span>
147     <span class="k">for</span> <span class="n">pref</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&quot;/&quot;</span><span class="p">,</span> <span class="s">&quot;/usr/&quot;</span><span class="p">,</span> <span class="s">&quot;/usr/local/&quot;</span><span class="p">):</span>
148         <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="p">(</span><span class="s">&quot;bin&quot;</span><span class="p">,</span> <span class="s">&quot;sbin&quot;</span><span class="p">):</span>
149             <span class="n">search</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">pref</span> <span class="o">+</span> <span class="n">d</span><span class="p">)</span>
150     <span class="k">if</span> <span class="n">extra_path</span><span class="p">:</span>
151         <span class="n">search</span> <span class="o">+=</span> <span class="n">extra_path</span>
152
153     <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">search</span><span class="p">:</span>
154             <span class="k">try</span><span class="p">:</span>
155                 <span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">d</span> <span class="o">+</span> <span class="s">&quot;/&quot;</span> <span class="o">+</span> <span class="n">name</span><span class="p">)</span>
156                 <span class="k">return</span> <span class="n">d</span> <span class="o">+</span> <span class="s">&quot;/&quot;</span> <span class="o">+</span> <span class="n">name</span>
157             <span class="k">except</span> <span class="ne">OSError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
158                 <span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">os</span><span class="o">.</span><span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">:</span>
159                     <span class="k">raise</span>
160     <span class="k">return</span> <span class="bp">None</span>
161
162 <span class="n">ssh_path</span> <span class="o">=</span> <span class="n">find_bin_or_die</span><span class="p">(</span><span class="s">&quot;ssh&quot;</span><span class="p">)</span>
163 <span class="n">python_path</span> <span class="o">=</span> <span class="n">find_bin_or_die</span><span class="p">(</span><span class="s">&quot;python&quot;</span><span class="p">)</span>
164
165 <span class="c"># Optional tools</span>
166 <span class="n">rsh_path</span> <span class="o">=</span> <span class="n">find_bin</span><span class="p">(</span><span class="s">&quot;rsh&quot;</span><span class="p">)</span>
167 <span class="n">tcpdump_path</span> <span class="o">=</span> <span class="n">find_bin</span><span class="p">(</span><span class="s">&quot;tcpdump&quot;</span><span class="p">)</span>
168 <span class="n">sshd_path</span> <span class="o">=</span> <span class="n">find_bin</span><span class="p">(</span><span class="s">&quot;sshd&quot;</span><span class="p">)</span>
169
170 <div class="viewcode-block" id="execute"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.environ.execute">[docs]</a><span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
171     <span class="c"># FIXME: create a global debug variable</span>
172     <span class="c">#print &quot;[pid %d]&quot; % os.getpid(), &quot; &quot;.join(cmd)</span>
173     <span class="n">null</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&quot;/dev/null&quot;</span><span class="p">,</span> <span class="s">&quot;r+&quot;</span><span class="p">)</span>
174     <span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">stdout</span> <span class="o">=</span> <span class="n">null</span><span class="p">,</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
175     <span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
176     <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
177         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Error executing `</span><span class="si">%s</span><span class="s">&#39;: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cmd</span><span class="p">),</span> <span class="n">err</span><span class="p">))</span>
178 </div>
179 <div class="viewcode-block" id="backticks"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.environ.backticks">[docs]</a><span class="k">def</span> <span class="nf">backticks</span><span class="p">(</span><span class="n">cmd</span><span class="p">):</span>
180     <span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">cmd</span><span class="p">,</span> <span class="n">stdout</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
181             <span class="n">stderr</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
182     <span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
183     <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
184         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="s">&quot;Error executing `</span><span class="si">%s</span><span class="s">&#39;: </span><span class="si">%s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cmd</span><span class="p">),</span> <span class="n">err</span><span class="p">))</span>
185     <span class="k">return</span> <span class="n">out</span>
186
187
188 <span class="c"># SSH stuff</span>
189 </div>
190 <span class="k">def</span> <span class="nf">gen_ssh_keypair</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
191     <span class="n">ssh_keygen</span> <span class="o">=</span> <span class="n">nepi</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">find_bin_or_die</span><span class="p">(</span><span class="s">&quot;ssh-keygen&quot;</span><span class="p">)</span>
192     <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="n">ssh_keygen</span><span class="p">,</span> <span class="s">&#39;-q&#39;</span><span class="p">,</span> <span class="s">&#39;-N&#39;</span><span class="p">,</span> <span class="s">&#39;&#39;</span><span class="p">,</span> <span class="s">&#39;-f&#39;</span><span class="p">,</span> <span class="n">filename</span><span class="p">]</span>
193     <span class="k">assert</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">args</span><span class="p">)</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span>
194     <span class="k">return</span> <span class="n">filename</span><span class="p">,</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s">.pub&quot;</span> <span class="o">%</span> <span class="n">filename</span>
195
196 <span class="k">def</span> <span class="nf">add_key_to_agent</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
197     <span class="n">ssh_add</span> <span class="o">=</span> <span class="n">nepi</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">find_bin_or_die</span><span class="p">(</span><span class="s">&quot;ssh-add&quot;</span><span class="p">)</span>
198     <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="n">ssh_add</span><span class="p">,</span> <span class="n">filename</span><span class="p">]</span>
199     <span class="n">null</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="s">&quot;/dev/null&quot;</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
200     <span class="k">assert</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">null</span><span class="p">)</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span>
201     <span class="n">null</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
202
203 <span class="k">def</span> <span class="nf">get_free_port</span><span class="p">():</span>
204     <span class="n">s</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">socket</span><span class="p">()</span>
205     <span class="n">s</span><span class="o">.</span><span class="n">bind</span><span class="p">((</span><span class="s">&quot;127.0.0.1&quot;</span><span class="p">,</span> <span class="mi">0</span><span class="p">))</span>
206     <span class="n">port</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">getsockname</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span>
207     <span class="k">return</span> <span class="n">port</span>
208
209 <span class="n">_SSH_CONF</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;ListenAddress 127.0.0.1:</span><span class="si">%d</span><span class="s"></span>
210 <span class="s">Protocol 2</span>
211 <span class="s">HostKey </span><span class="si">%s</span><span class="s"></span>
212 <span class="s">UsePrivilegeSeparation no</span>
213 <span class="s">PubkeyAuthentication yes</span>
214 <span class="s">PasswordAuthentication no</span>
215 <span class="s">AuthorizedKeysFile </span><span class="si">%s</span><span class="s"></span>
216 <span class="s">UsePAM no</span>
217 <span class="s">AllowAgentForwarding yes</span>
218 <span class="s">PermitRootLogin yes</span>
219 <span class="s">StrictModes no</span>
220 <span class="s">PermitUserEnvironment yes</span>
221 <span class="s">&quot;&quot;&quot;</span>
222
223 <span class="k">def</span> <span class="nf">gen_sshd_config</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">server_key</span><span class="p">,</span> <span class="n">auth_keys</span><span class="p">):</span>
224     <span class="n">conf</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
225     <span class="n">text</span> <span class="o">=</span> <span class="n">_SSH_CONF</span> <span class="o">%</span> <span class="p">(</span><span class="n">port</span><span class="p">,</span> <span class="n">server_key</span><span class="p">,</span> <span class="n">auth_keys</span><span class="p">)</span>
226     <span class="n">conf</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
227     <span class="n">conf</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
228     <span class="k">return</span> <span class="n">filename</span>
229
230 <span class="k">def</span> <span class="nf">gen_auth_keys</span><span class="p">(</span><span class="n">pubkey</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">environ</span><span class="p">):</span>
231     <span class="c">#opts = [&#39;from=&quot;127.0.0.1/32&quot;&#39;] # fails in stupid yans setup</span>
232     <span class="n">opts</span> <span class="o">=</span> <span class="p">[]</span>
233     <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">environ</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
234         <span class="n">opts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;environment=&quot;</span><span class="si">%s</span><span class="s">=</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">))</span>
235
236     <span class="n">lines</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="n">pubkey</span><span class="p">)</span><span class="o">.</span><span class="n">readlines</span><span class="p">()</span>
237     <span class="n">pubkey</span> <span class="o">=</span> <span class="n">lines</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span>
238     <span class="n">out</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="n">output</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
239     <span class="n">out</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&quot;</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="se">\n</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="s">&quot;,&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">opts</span><span class="p">),</span> <span class="n">pubkey</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">pubkey</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span>
240     <span class="n">out</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
241     <span class="k">return</span> <span class="n">output</span>
242
243 <span class="k">def</span> <span class="nf">start_ssh_agent</span><span class="p">():</span>
244     <span class="n">ssh_agent</span> <span class="o">=</span> <span class="n">nepi</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">find_bin_or_die</span><span class="p">(</span><span class="s">&quot;ssh-agent&quot;</span><span class="p">)</span>
245     <span class="n">proc</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="n">ssh_agent</span><span class="p">],</span> <span class="n">stdout</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">)</span>
246     <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">foo</span><span class="p">)</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
247     <span class="k">assert</span> <span class="n">proc</span><span class="o">.</span><span class="n">returncode</span> <span class="o">==</span> <span class="mi">0</span>
248     <span class="n">d</span> <span class="o">=</span> <span class="p">{}</span>
249     <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">out</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">&quot;</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">):</span>
250         <span class="n">match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">&quot;^(\w+)=([^ ;]+);.*&quot;</span><span class="p">,</span> <span class="n">l</span><span class="p">)</span>
251         <span class="k">if</span> <span class="ow">not</span> <span class="n">match</span><span class="p">:</span>
252             <span class="k">continue</span>
253         <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
254         <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
255         <span class="n">d</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">=</span> <span class="n">v</span>
256     <span class="k">return</span> <span class="n">d</span>
257
258 <span class="k">def</span> <span class="nf">stop_ssh_agent</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
259     <span class="c"># No need to gather the pid, ssh-agent knows how to kill itself; after we</span>
260     <span class="c"># had set up the environment</span>
261     <span class="n">ssh_agent</span> <span class="o">=</span> <span class="n">nepi</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">find_bin_or_die</span><span class="p">(</span><span class="s">&quot;ssh-agent&quot;</span><span class="p">)</span>
262     <span class="n">null</span> <span class="o">=</span> <span class="nb">file</span><span class="p">(</span><span class="s">&quot;/dev/null&quot;</span><span class="p">,</span> <span class="s">&quot;w&quot;</span><span class="p">)</span>
263     <span class="n">proc</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="n">ssh_agent</span><span class="p">,</span> <span class="s">&quot;-k&quot;</span><span class="p">],</span> <span class="n">stdout</span> <span class="o">=</span> <span class="n">null</span><span class="p">)</span>
264     <span class="n">null</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
265     <span class="k">assert</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span> <span class="o">==</span> <span class="mi">0</span>
266     <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">data</span><span class="p">:</span>
267         <span class="k">del</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
268 </pre></div>
269
270           </div>
271         </div>
272       </div>
273       <div class="clearer"></div>
274     </div>
275     <div class="related">
276       <h3>Navigation</h3>
277       <ul>
278         <li class="right" style="margin-right: 10px">
279           <a href="../../../genindex.html" title="General Index"
280              >index</a></li>
281         <li class="right" >
282           <a href="../../../py-modindex.html" title="Python Module Index"
283              >modules</a> |</li>
284         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
285           <li><a href="../../index.html" >Module code</a> &raquo;</li> 
286       </ul>
287     </div>
288     <div class="footer">
289         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
290       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
291     </div>
292   </body>
293 </html>