--- /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.util.sshfuncs — 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.util.sshfuncs</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="c"># Claudio Freire <claudio-daniel.freire@inria.fr></span>
+
+<span class="c">## TODO: This code needs reviewing !!!</span>
+
+<span class="kn">import</span> <span class="nn">base64</span>
+<span class="kn">import</span> <span class="nn">errno</span>
+<span class="kn">import</span> <span class="nn">hashlib</span>
+<span class="kn">import</span> <span class="nn">logging</span>
+<span class="kn">import</span> <span class="nn">os</span>
+<span class="kn">import</span> <span class="nn">os.path</span>
+<span class="kn">import</span> <span class="nn">re</span>
+<span class="kn">import</span> <span class="nn">select</span>
+<span class="kn">import</span> <span class="nn">signal</span>
+<span class="kn">import</span> <span class="nn">socket</span>
+<span class="kn">import</span> <span class="nn">subprocess</span>
+<span class="kn">import</span> <span class="nn">threading</span>
+<span class="kn">import</span> <span class="nn">time</span>
+<span class="kn">import</span> <span class="nn">tempfile</span>
+
+<span class="n">_re_inet</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"\d+:\s+(?P<name>[a-z0-9_-]+)\s+inet6?\s+(?P<inet>[a-f0-9.:/]+)\s+(brd\s+[0-9.]+)?.*scope\s+global.*"</span><span class="p">)</span>
+
+<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">"sshfuncs"</span><span class="p">)</span>
+
+<div class="viewcode-block" id="log"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.log">[docs]</a><span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="n">out</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="bp">None</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s">" - OUT: </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="n">out</span>
+
+ <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">+=</span> <span class="s">" - ERROR: </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="n">err</span>
+
+ <span class="n">logger</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">level</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
+</div>
+<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">os</span><span class="p">,</span> <span class="s">"devnull"</span><span class="p">):</span>
+ <span class="n">DEV_NULL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">devnull</span>
+<span class="k">else</span><span class="p">:</span>
+ <span class="n">DEV_NULL</span> <span class="o">=</span> <span class="s">"/dev/null"</span>
+
+<span class="n">SHELL_SAFE</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">'^[-a-zA-Z0-9_=+:.,/]*$'</span><span class="p">)</span>
+
+<div class="viewcode-block" id="STDOUT"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.STDOUT">[docs]</a><span class="k">class</span> <span class="nc">STDOUT</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Special value that when given to rspawn in stderr causes stderr to </span>
+<span class="sd"> redirect to whatever stdout was redirected to.</span>
+<span class="sd"> """</span>
+</div>
+<div class="viewcode-block" id="ProcStatus"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.ProcStatus">[docs]</a><span class="k">class</span> <span class="nc">ProcStatus</span><span class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Codes for status of remote spawned process</span>
+<span class="sd"> """</span>
+ <span class="c"># Process is still running</span>
+ <span class="n">RUNNING</span> <span class="o">=</span> <span class="mi">1</span>
+
+ <span class="c"># Process is finished</span>
+ <span class="n">FINISHED</span> <span class="o">=</span> <span class="mi">2</span>
+
+ <span class="c"># Process hasn't started running yet (this should be very rare)</span>
+ <span class="n">NOT_STARTED</span> <span class="o">=</span> <span class="mi">3</span>
+</div>
+<span class="n">hostbyname_cache</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
+<span class="n">hostbyname_cache_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
+
+<div class="viewcode-block" id="resolve_hostname"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.resolve_hostname">[docs]</a><span class="k">def</span> <span class="nf">resolve_hostname</span><span class="p">(</span><span class="n">host</span><span class="p">):</span>
+ <span class="n">ip</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="k">if</span> <span class="n">host</span> <span class="ow">in</span> <span class="p">[</span><span class="s">"localhost"</span><span class="p">,</span> <span class="s">"127.0.0.1"</span><span class="p">,</span> <span class="s">"::1"</span><span class="p">]:</span>
+ <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="s">"ip -o addr list"</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="bp">True</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> <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>
+ <span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="n">m</span> <span class="o">=</span> <span class="n">_re_inet</span><span class="o">.</span><span class="n">findall</span><span class="p">(</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="n">ip</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"/"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">ip</span> <span class="o">=</span> <span class="n">socket</span><span class="o">.</span><span class="n">gethostbyname</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">ip</span>
+</div>
+<div class="viewcode-block" id="gethostbyname"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.gethostbyname">[docs]</a><span class="k">def</span> <span class="nf">gethostbyname</span><span class="p">(</span><span class="n">host</span><span class="p">):</span>
+ <span class="k">global</span> <span class="n">hostbyname_cache</span>
+ <span class="k">global</span> <span class="n">hostbyname_cache_lock</span>
+
+ <span class="n">hostbyname</span> <span class="o">=</span> <span class="n">hostbyname_cache</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">hostbyname</span><span class="p">:</span>
+ <span class="k">with</span> <span class="n">hostbyname_cache_lock</span><span class="p">:</span>
+ <span class="n">hostbyname</span> <span class="o">=</span> <span class="n">resolve_hostname</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
+ <span class="n">hostbyname_cache</span><span class="p">[</span><span class="n">host</span><span class="p">]</span> <span class="o">=</span> <span class="n">hostbyname</span>
+
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">" Added hostbyname </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="n">host</span><span class="p">,</span> <span class="n">hostbyname</span><span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
+
+ <span class="k">return</span> <span class="n">hostbyname</span>
+</div>
+<span class="n">OPENSSH_HAS_PERSIST</span> <span class="o">=</span> <span class="bp">None</span>
+
+<div class="viewcode-block" id="openssh_has_persist"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.openssh_has_persist">[docs]</a><span class="k">def</span> <span class="nf">openssh_has_persist</span><span class="p">():</span>
+ <span class="sd">""" The ssh_config options ControlMaster and ControlPersist allow to</span>
+<span class="sd"> reuse a same network connection for multiple ssh sessions. In this </span>
+<span class="sd"> way limitations on number of open ssh connections can be bypassed.</span>
+<span class="sd"> However, older versions of openSSH do not support this feature.</span>
+<span class="sd"> This function is used to determine if ssh connection persist features</span>
+<span class="sd"> can be used.</span>
+<span class="sd"> """</span>
+ <span class="k">global</span> <span class="n">OPENSSH_HAS_PERSIST</span>
+ <span class="k">if</span> <span class="n">OPENSSH_HAS_PERSIST</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
+ <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="s">"ssh"</span><span class="p">,</span><span class="s">"-v"</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>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">,</span>
+ <span class="n">stdin</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">"/dev/null"</span><span class="p">,</span><span class="s">"r"</span><span class="p">)</span> <span class="p">)</span>
+ <span class="n">out</span><span class="p">,</span><span class="n">err</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
+
+ <span class="n">vre</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r'OpenSSH_(?:[6-9]|5[.][8-9]|5[.][1-9][0-9]|[1-9][0-9]).*'</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
+ <span class="n">OPENSSH_HAS_PERSIST</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">vre</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">out</span><span class="p">))</span>
+ <span class="k">return</span> <span class="n">OPENSSH_HAS_PERSIST</span>
+</div>
+<div class="viewcode-block" id="make_server_key_args"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.make_server_key_args">[docs]</a><span class="k">def</span> <span class="nf">make_server_key_args</span><span class="p">(</span><span class="n">server_key</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
+ <span class="sd">""" Returns a reference to a temporary known_hosts file, to which </span>
+<span class="sd"> the server key has been added. </span>
+<span class="sd"> </span>
+<span class="sd"> Make sure to hold onto the temp file reference until the process is </span>
+<span class="sd"> done with it</span>
+
+<span class="sd"> :param server_key: the server public key</span>
+<span class="sd"> :type server_key: str</span>
+
+<span class="sd"> :param host: the hostname</span>
+<span class="sd"> :type host: str</span>
+
+<span class="sd"> :param port: the ssh port</span>
+<span class="sd"> :type port: str</span>
+
+<span class="sd"> """</span>
+ <span class="k">if</span> <span class="n">port</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">host</span> <span class="o">=</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="n">host</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">port</span><span class="p">))</span>
+
+ <span class="c"># Create a temporary server key file</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">()</span>
+
+ <span class="n">hostbyname</span> <span class="o">=</span> <span class="n">gethostbyname</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
+
+ <span class="c"># Add the intended host key</span>
+ <span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">write</span><span class="p">(</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="si">%s</span><span class="se">\n</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">hostbyname</span><span class="p">,</span> <span class="n">server_key</span><span class="p">))</span>
+
+ <span class="c"># If we're not in strict mode, add user-configured keys</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'NEPI_STRICT_AUTH_MODE'</span><span class="p">,</span><span class="s">""</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'1'</span><span class="p">,</span><span class="s">'true'</span><span class="p">,</span><span class="s">'on'</span><span class="p">):</span>
+ <span class="n">user_hosts_path</span> <span class="o">=</span> <span class="s">'</span><span class="si">%s</span><span class="s">/.ssh/known_hosts'</span> <span class="o">%</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'HOME'</span><span class="p">,</span><span class="s">""</span><span class="p">),)</span>
+ <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">access</span><span class="p">(</span><span class="n">user_hosts_path</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">R_OK</span><span class="p">):</span>
+ <span class="n">f</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">user_hosts_path</span><span class="p">,</span> <span class="s">"r"</span><span class="p">)</span>
+ <span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">())</span>
+ <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="n">tmp_known_hosts</span>
+</div>
+<div class="viewcode-block" id="make_control_path"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.make_control_path">[docs]</a><span class="k">def</span> <span class="nf">make_control_path</span><span class="p">(</span><span class="n">agent</span><span class="p">,</span> <span class="n">forward_x11</span><span class="p">):</span>
+ <span class="n">ctrl_path</span> <span class="o">=</span> <span class="s">"/tmp/nepi_ssh"</span>
+
+ <span class="k">if</span> <span class="n">agent</span><span class="p">:</span>
+ <span class="n">ctrl_path</span> <span class="o">+=</span><span class="s">"_a"</span>
+
+ <span class="k">if</span> <span class="n">forward_x11</span><span class="p">:</span>
+ <span class="n">ctrl_path</span> <span class="o">+=</span><span class="s">"_x"</span>
+
+ <span class="n">ctrl_path</span> <span class="o">+=</span> <span class="s">"-</span><span class="si">%r</span><span class="s">@%h:%p"</span>
+
+ <span class="k">return</span> <span class="n">ctrl_path</span>
+</div>
+<div class="viewcode-block" id="shell_escape"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.shell_escape">[docs]</a><span class="k">def</span> <span class="nf">shell_escape</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
+ <span class="sd">""" Escapes strings so that they are safe to use as command-line </span>
+<span class="sd"> arguments """</span>
+ <span class="k">if</span> <span class="n">SHELL_SAFE</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
+ <span class="c"># safe string - no escaping needed</span>
+ <span class="k">return</span> <span class="n">s</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="c"># unsafe string - escape</span>
+ <span class="k">def</span> <span class="nf">escp</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
+ <span class="k">if</span> <span class="p">(</span><span class="mi">32</span> <span class="o"><=</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o"><</span> <span class="mi">127</span> <span class="ow">or</span> <span class="n">c</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'</span><span class="se">\r</span><span class="s">'</span><span class="p">,</span><span class="s">'</span><span class="se">\n</span><span class="s">'</span><span class="p">,</span><span class="s">'</span><span class="se">\t</span><span class="s">'</span><span class="p">))</span> <span class="ow">and</span> <span class="n">c</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"'"</span><span class="p">,</span><span class="s">'"'</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">c</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="s">"'$'</span><span class="se">\\</span><span class="s">x</span><span class="si">%02x</span><span class="s">''"</span> <span class="o">%</span> <span class="p">(</span><span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">),)</span>
+ <span class="n">s</span> <span class="o">=</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="n">escp</span><span class="p">,</span><span class="n">s</span><span class="p">))</span>
+ <span class="k">return</span> <span class="s">"'</span><span class="si">%s</span><span class="s">'"</span> <span class="o">%</span> <span class="p">(</span><span class="n">s</span><span class="p">,)</span>
+</div>
+<div class="viewcode-block" id="eintr_retry"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.eintr_retry">[docs]</a><span class="k">def</span> <span class="nf">eintr_retry</span><span class="p">(</span><span class="n">func</span><span class="p">):</span>
+ <span class="sd">"""Retries a function invocation when a EINTR occurs"""</span>
+ <span class="kn">import</span> <span class="nn">functools</span>
+ <span class="nd">@functools.wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
+ <span class="k">def</span> <span class="nf">rv</span><span class="p">(</span><span class="o">*</span><span class="n">p</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
+ <span class="n">retry</span> <span class="o">=</span> <span class="n">kw</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s">"_retry"</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
+ <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="mi">0</span> <span class="k">if</span> <span class="n">retry</span> <span class="k">else</span> <span class="mi">4</span><span class="p">):</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">p</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
+ <span class="k">except</span> <span class="p">(</span><span class="n">select</span><span class="o">.</span><span class="n">error</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">error</span><span class="p">),</span> <span class="n">args</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span>
+ <span class="k">except</span> <span class="ne">OSError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
+ <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">errno</span><span class="o">.</span><span class="n">EINTR</span><span class="p">:</span>
+ <span class="k">continue</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">p</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
+ <span class="k">return</span> <span class="n">rv</span>
+</div>
+<div class="viewcode-block" id="rexec"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.rexec">[docs]</a><span class="k">def</span> <span class="nf">rexec</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
+ <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">tty</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">connect_timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">,</span>
+ <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="n">persistent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
+ <span class="n">forward_x11</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Executes a remote command, returns ((stdout,stderr),process)</span>
+<span class="sd"> """</span>
+
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="bp">None</span>
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">gw</span><span class="p">:</span>
+ <span class="n">hostip</span> <span class="o">=</span> <span class="n">gethostbyname</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span> <span class="n">hostip</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s">'ssh'</span><span class="p">,</span> <span class="s">'-C'</span><span class="p">,</span>
+ <span class="c"># Don't bother with localhost. Makes test easier</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'NoHostAuthenticationForLocalhost=yes'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ConnectTimeout=</span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">connect_timeout</span><span class="p">),),</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ConnectionAttempts=3'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ServerAliveInterval=30'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'TCPKeepAlive=yes'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'Batchmode=yes'</span><span class="p">,</span>
+ <span class="s">'-l'</span><span class="p">,</span> <span class="n">user</span><span class="p">,</span> <span class="n">hostip</span> <span class="ow">or</span> <span class="n">host</span><span class="p">]</span>
+
+ <span class="k">if</span> <span class="n">persistent</span> <span class="ow">and</span> <span class="n">openssh_has_persist</span><span class="p">():</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ControlMaster=auto'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ControlPath=</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">make_control_path</span><span class="p">(</span><span class="n">agent</span><span class="p">,</span> <span class="n">forward_x11</span><span class="p">),),</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ControlPersist=60'</span> <span class="p">])</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">strict_host_checking</span><span class="p">:</span>
+ <span class="c"># Do not check for Host key. Unsafe.</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">'-o'</span><span class="p">,</span> <span class="s">'StrictHostKeyChecking=no'</span><span class="p">])</span>
+
+ <span class="k">if</span> <span class="n">gw</span><span class="p">:</span>
+ <span class="n">proxycommand</span> <span class="o">=</span> <span class="n">_proxy_command</span><span class="p">(</span><span class="n">gw</span><span class="p">,</span> <span class="n">gwuser</span><span class="p">,</span> <span class="n">identity</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">'-o'</span><span class="p">,</span> <span class="n">proxycommand</span><span class="p">])</span>
+
+ <span class="k">if</span> <span class="n">agent</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-A'</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">port</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-p</span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="n">port</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">identity</span><span class="p">:</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="n">identity</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">((</span><span class="s">'-i'</span><span class="p">,</span> <span class="n">identity</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">tty</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-t'</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-t'</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">forward_x11</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-X'</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">server_key</span><span class="p">:</span>
+ <span class="c"># Create a temporary server key file</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">make_server_key_args</span><span class="p">(</span><span class="n">server_key</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">'-o'</span><span class="p">,</span> <span class="s">'UserKnownHostsFile=</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">name</span><span class="p">,)])</span>
+
+ <span class="k">if</span> <span class="n">sudo</span><span class="p">:</span>
+ <span class="n">command</span> <span class="o">=</span> <span class="s">"sudo "</span> <span class="o">+</span> <span class="n">command</span>
+
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">command</span><span class="p">)</span>
+
+ <span class="n">log_msg</span> <span class="o">=</span> <span class="s">" rexec - host </span><span class="si">%s</span><span class="s"> - command </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">host</span><span class="p">),</span> <span class="s">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">)))</span>
+
+ <span class="n">stdout</span> <span class="o">=</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">stdin</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span>
+ <span class="k">if</span> <span class="n">forward_x11</span><span class="p">:</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="n">stderr</span> <span class="o">=</span> <span class="n">stdin</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="k">return</span> <span class="n">_retry_rexec</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">log_msg</span><span class="p">,</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">,</span>
+ <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span><span class="p">,</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span><span class="p">,</span>
+ <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
+ <span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span><span class="p">,</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">tmp_known_hosts</span><span class="p">,</span>
+ <span class="n">blocking</span> <span class="o">=</span> <span class="n">blocking</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="rcopy"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.rcopy">[docs]</a><span class="k">def</span> <span class="nf">rcopy</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">dest</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">recursive</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Copies from/to remote sites.</span>
+<span class="sd"> </span>
+<span class="sd"> Source and destination should have the user and host encoded</span>
+<span class="sd"> as per scp specs.</span>
+<span class="sd"> </span>
+<span class="sd"> Source can be a list of files to copy to a single destination, </span>
+<span class="sd"> (in which case it is advised that the destination be a folder),</span>
+<span class="sd"> or a single file in a string.</span>
+<span class="sd"> """</span>
+
+ <span class="c"># Parse destination as <user>@<server>:<path></span>
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dest</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="s">':'</span> <span class="ow">in</span> <span class="n">dest</span><span class="p">:</span>
+ <span class="n">remspec</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">dest</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
+ <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="s">':'</span> <span class="ow">in</span> <span class="n">source</span><span class="p">:</span>
+ <span class="n">remspec</span><span class="p">,</span> <span class="n">path</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">"Both endpoints cannot be local"</span>
+ <span class="n">user</span><span class="p">,</span><span class="n">host</span> <span class="o">=</span> <span class="n">remspec</span><span class="o">.</span><span class="n">rsplit</span><span class="p">(</span><span class="s">'@'</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
+
+ <span class="c"># plain scp</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="bp">None</span>
+
+ <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s">'scp'</span><span class="p">,</span> <span class="s">'-q'</span><span class="p">,</span> <span class="s">'-p'</span><span class="p">,</span> <span class="s">'-C'</span><span class="p">,</span>
+ <span class="c"># Speed up transfer using blowfish cypher specification which is </span>
+ <span class="c"># faster than the default one (3des)</span>
+ <span class="s">'-c'</span><span class="p">,</span> <span class="s">'blowfish'</span><span class="p">,</span>
+ <span class="c"># Don't bother with localhost. Makes test easier</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'NoHostAuthenticationForLocalhost=yes'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ConnectTimeout=60'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ConnectionAttempts=3'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ServerAliveInterval=30'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'TCPKeepAlive=yes'</span> <span class="p">]</span>
+
+ <span class="k">if</span> <span class="n">port</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-P</span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="n">port</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">gw</span><span class="p">:</span>
+ <span class="n">proxycommand</span> <span class="o">=</span> <span class="n">_proxy_command</span><span class="p">(</span><span class="n">gw</span><span class="p">,</span> <span class="n">gwuser</span><span class="p">,</span> <span class="n">identity</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">'-o'</span><span class="p">,</span> <span class="n">proxycommand</span><span class="p">])</span>
+
+ <span class="k">if</span> <span class="n">recursive</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'-r'</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">identity</span><span class="p">:</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="n">identity</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">((</span><span class="s">'-i'</span><span class="p">,</span> <span class="n">identity</span><span class="p">))</span>
+
+ <span class="k">if</span> <span class="n">server_key</span><span class="p">:</span>
+ <span class="c"># Create a temporary server key file</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">make_server_key_args</span><span class="p">(</span><span class="n">server_key</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">)</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">'-o'</span><span class="p">,</span> <span class="s">'UserKnownHostsFile=</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">name</span><span class="p">,)])</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">strict_host_checking</span><span class="p">:</span>
+ <span class="c"># Do not check for Host key. Unsafe.</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">'-o'</span><span class="p">,</span> <span class="s">'StrictHostKeyChecking=no'</span><span class="p">])</span>
+
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">openssh_has_persist</span><span class="p">():</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ControlMaster=auto'</span><span class="p">,</span>
+ <span class="s">'-o'</span><span class="p">,</span> <span class="s">'ControlPath=</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">make_control_path</span><span class="p">(</span><span class="bp">False</span><span class="p">,</span> <span class="bp">False</span><span class="p">),)</span>
+ <span class="p">])</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">source</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dest</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">dest</span><span class="p">)</span>
+
+ <span class="n">log_msg</span> <span class="o">=</span> <span class="s">" rcopy - host </span><span class="si">%s</span><span class="s"> - command </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">host</span><span class="p">),</span> <span class="s">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="p">)))</span>
+
+ <span class="k">return</span> <span class="n">_retry_rexec</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">log_msg</span><span class="p">,</span> <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span><span class="p">,</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">tmp_known_hosts</span><span class="p">,</span>
+ <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
+</div>
+<div class="viewcode-block" id="rspawn"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.rspawn">[docs]</a><span class="k">def</span> <span class="nf">rspawn</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">pidfile</span><span class="p">,</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="s">'/dev/null'</span><span class="p">,</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="n">STDOUT</span><span class="p">,</span>
+ <span class="n">stdin</span> <span class="o">=</span> <span class="s">'/dev/null'</span><span class="p">,</span>
+ <span class="n">home</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">create_home</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">tty</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Spawn a remote command such that it will continue working asynchronously in </span>
+<span class="sd"> background. </span>
+
+<span class="sd"> :param command: The command to run, it should be a single line.</span>
+<span class="sd"> :type command: str</span>
+
+<span class="sd"> :param pidfile: Path to a file where to store the pid and ppid of the </span>
+<span class="sd"> spawned process</span>
+<span class="sd"> :type pidfile: str</span>
+
+<span class="sd"> :param stdout: Path to file to redirect standard output. </span>
+<span class="sd"> The default value is /dev/null</span>
+<span class="sd"> :type stdout: str</span>
+
+<span class="sd"> :param stderr: Path to file to redirect standard error.</span>
+<span class="sd"> If the special STDOUT value is used, stderr will </span>
+<span class="sd"> be redirected to the same file as stdout</span>
+<span class="sd"> :type stderr: str</span>
+
+<span class="sd"> :param stdin: Path to a file with input to be piped into the command's standard input</span>
+<span class="sd"> :type stdin: str</span>
+
+<span class="sd"> :param home: Path to working directory folder. </span>
+<span class="sd"> It is assumed to exist unless the create_home flag is set.</span>
+<span class="sd"> :type home: str</span>
+
+<span class="sd"> :param create_home: Flag to force creation of the home folder before </span>
+<span class="sd"> running the command</span>
+<span class="sd"> :type create_home: bool</span>
+<span class="sd"> </span>
+<span class="sd"> :param sudo: Flag forcing execution with sudo user</span>
+<span class="sd"> :type sudo: bool</span>
+<span class="sd"> </span>
+<span class="sd"> :rtype: tuple</span>
+
+<span class="sd"> (stdout, stderr), process</span>
+<span class="sd"> </span>
+<span class="sd"> Of the spawning process, which only captures errors at spawning time.</span>
+<span class="sd"> Usually only useful for diagnostics.</span>
+<span class="sd"> """</span>
+ <span class="c"># Start process in a "daemonized" way, using nohup and heavy</span>
+ <span class="c"># stdin/out redirection to avoid connection issues</span>
+ <span class="k">if</span> <span class="n">stderr</span> <span class="ow">is</span> <span class="n">STDOUT</span><span class="p">:</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="s">'&1'</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="s">' '</span> <span class="o">+</span> <span class="n">stderr</span>
+
+ <span class="n">daemon_command</span> <span class="o">=</span> <span class="s">'{ { </span><span class="si">%(command)s</span><span class="s"> > </span><span class="si">%(stdout)s</span><span class="s"> 2></span><span class="si">%(stderr)s</span><span class="s"> < </span><span class="si">%(stdin)s</span><span class="s"> & } ; echo $! 1 > </span><span class="si">%(pidfile)s</span><span class="s"> ; }'</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">'command'</span> <span class="p">:</span> <span class="n">command</span><span class="p">,</span>
+ <span class="s">'pidfile'</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">pidfile</span><span class="p">),</span>
+ <span class="s">'stdout'</span> <span class="p">:</span> <span class="n">stdout</span><span class="p">,</span>
+ <span class="s">'stderr'</span> <span class="p">:</span> <span class="n">stderr</span><span class="p">,</span>
+ <span class="s">'stdin'</span> <span class="p">:</span> <span class="n">stdin</span><span class="p">,</span>
+ <span class="p">}</span>
+
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">"</span><span class="si">%(create)s%(gohome)s</span><span class="s"> rm -f </span><span class="si">%(pidfile)s</span><span class="s"> ; </span><span class="si">%(sudo)s</span><span class="s"> nohup bash -c </span><span class="si">%(command)s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">'command'</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">daemon_command</span><span class="p">),</span>
+ <span class="s">'sudo'</span> <span class="p">:</span> <span class="s">'sudo -S'</span> <span class="k">if</span> <span class="n">sudo</span> <span class="k">else</span> <span class="s">''</span><span class="p">,</span>
+ <span class="s">'pidfile'</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">pidfile</span><span class="p">),</span>
+ <span class="s">'gohome'</span> <span class="p">:</span> <span class="s">'cd </span><span class="si">%s</span><span class="s"> ; '</span> <span class="o">%</span> <span class="p">(</span><span class="n">shell_escape</span><span class="p">(</span><span class="n">home</span><span class="p">),)</span> <span class="k">if</span> <span class="n">home</span> <span class="k">else</span> <span class="s">''</span><span class="p">,</span>
+ <span class="s">'create'</span> <span class="p">:</span> <span class="s">'mkdir -p </span><span class="si">%s</span><span class="s"> ; '</span> <span class="o">%</span> <span class="p">(</span><span class="n">shell_escape</span><span class="p">(</span><span class="n">home</span><span class="p">),)</span> <span class="k">if</span> <span class="n">create_home</span> <span class="ow">and</span> <span class="n">home</span> <span class="k">else</span> <span class="s">''</span><span class="p">,</span>
+ <span class="p">}</span>
+
+ <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span><span class="n">proc</span> <span class="o">=</span> <span class="n">rexec</span><span class="p">(</span>
+ <span class="n">cmd</span><span class="p">,</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
+ <span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span> <span class="p">,</span>
+ <span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">"Failed to set up application on host </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="n">host</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">,)</span>
+
+ <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
+</div>
+<span class="nd">@eintr_retry</span>
+<div class="viewcode-block" id="rgetpid"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.rgetpid">[docs]</a><span class="k">def</span> <span class="nf">rgetpid</span><span class="p">(</span><span class="n">pidfile</span><span class="p">,</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Returns the pid and ppid of a process from a remote file where the </span>
+<span class="sd"> information was stored.</span>
+
+<span class="sd"> :param home: Path to directory where the pidfile is located</span>
+<span class="sd"> :type home: str</span>
+
+<span class="sd"> :param pidfile: Name of file containing the pid information</span>
+<span class="sd"> :type pidfile: str</span>
+<span class="sd"> </span>
+<span class="sd"> :rtype: int</span>
+<span class="sd"> </span>
+<span class="sd"> A (pid, ppid) tuple useful for calling rstatus and rkill,</span>
+<span class="sd"> or None if the pidfile isn't valid yet (can happen when process is staring up)</span>
+
+<span class="sd"> """</span>
+ <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span><span class="n">proc</span> <span class="o">=</span> <span class="n">rexec</span><span class="p">(</span>
+ <span class="s">"cat </span><span class="si">%(pidfile)s</span><span class="s">"</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">'pidfile'</span> <span class="p">:</span> <span class="n">pidfile</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
+ <span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
+ <span class="k">return</span> <span class="bp">None</span>
+
+ <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="nb">map</span><span class="p">(</span><span class="nb">int</span><span class="p">,</span><span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">' '</span><span class="p">,</span><span class="mi">1</span><span class="p">))</span>
+ <span class="k">except</span><span class="p">:</span>
+ <span class="c"># Ignore, many ways to fail that don't matter that much</span>
+ <span class="k">return</span> <span class="bp">None</span>
+</div>
+<span class="nd">@eintr_retry</span>
+<div class="viewcode-block" id="rstatus"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.rstatus">[docs]</a><span class="k">def</span> <span class="nf">rstatus</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Returns a code representing the the status of a remote process</span>
+
+<span class="sd"> :param pid: Process id of the process</span>
+<span class="sd"> :type pid: int</span>
+
+<span class="sd"> :param ppid: Parent process id of process</span>
+<span class="sd"> :type ppid: int</span>
+<span class="sd"> </span>
+<span class="sd"> :rtype: int (One of NOT_STARTED, RUNNING, FINISHED)</span>
+<span class="sd"> </span>
+<span class="sd"> """</span>
+ <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span><span class="n">proc</span> <span class="o">=</span> <span class="n">rexec</span><span class="p">(</span>
+ <span class="c"># Check only by pid. pid+ppid does not always work (especially with sudo) </span>
+ <span class="s">" (( ps --pid </span><span class="si">%(pid)d</span><span class="s"> -o pid | grep -c </span><span class="si">%(pid)d</span><span class="s"> && echo 'wait') || echo 'done' ) | tail -n 1"</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">'ppid'</span> <span class="p">:</span> <span class="n">ppid</span><span class="p">,</span>
+ <span class="s">'pid'</span> <span class="p">:</span> <span class="n">pid</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
+ <span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
+ <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">NOT_STARTED</span>
+
+ <span class="n">status</span> <span class="o">=</span> <span class="bp">False</span>
+ <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s">"Error, do this: mount -t proc none /proc"</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">elif</span> <span class="n">out</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span class="p">(</span><span class="n">out</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s">'wait'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">NOT_STARTED</span>
+ <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">RUNNING</span> <span class="k">if</span> <span class="n">status</span> <span class="k">else</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">FINISHED</span>
+</div>
+<span class="nd">@eintr_retry</span>
+<div class="viewcode-block" id="rkill"><a class="viewcode-back" href="../../../_layout/nepi.util.html#nepi.util.sshfuncs.rkill">[docs]</a><span class="k">def</span> <span class="nf">rkill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">nowait</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Sends a kill signal to a remote process.</span>
+
+<span class="sd"> First tries a SIGTERM, and if the process does not end in 10 seconds,</span>
+<span class="sd"> it sends a SIGKILL.</span>
+<span class="sd"> </span>
+<span class="sd"> :param pid: Process id of process to be killed</span>
+<span class="sd"> :type pid: int</span>
+
+<span class="sd"> :param ppid: Parent process id of process to be killed</span>
+<span class="sd"> :type ppid: int</span>
+
+<span class="sd"> :param sudo: Flag indicating if sudo should be used to kill the process</span>
+<span class="sd"> :type sudo: bool</span>
+<span class="sd"> </span>
+<span class="sd"> """</span>
+ <span class="n">subkill</span> <span class="o">=</span> <span class="s">"$(ps --ppid </span><span class="si">%(pid)d</span><span class="s"> -o pid h)"</span> <span class="o">%</span> <span class="p">{</span> <span class="s">'pid'</span> <span class="p">:</span> <span class="n">pid</span> <span class="p">}</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">"""</span>
+<span class="s">SUBKILL="</span><span class="si">%(subkill)s</span><span class="s">" ;</span>
+<span class="si">%(sudo)s</span><span class="s"> kill -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
+<span class="si">%(sudo)s</span><span class="s"> kill </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
+<span class="s">for x in 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 ; do </span>
+<span class="s"> sleep 0.2 </span>
+<span class="s"> if [ `ps --pid </span><span class="si">%(pid)d</span><span class="s"> -o pid | grep -c </span><span class="si">%(pid)d</span><span class="s">` == '0' ]; then</span>
+<span class="s"> break</span>
+<span class="s"> else</span>
+<span class="s"> </span><span class="si">%(sudo)s</span><span class="s"> kill -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
+<span class="s"> </span><span class="si">%(sudo)s</span><span class="s"> kill </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
+<span class="s"> fi</span>
+<span class="s"> sleep 1.8</span>
+<span class="s">done</span>
+<span class="s">if [ `ps --pid </span><span class="si">%(pid)d</span><span class="s"> -o pid | grep -c </span><span class="si">%(pid)d</span><span class="s">` != '0' ]; then</span>
+<span class="s"> </span><span class="si">%(sudo)s</span><span class="s"> kill -9 -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
+<span class="s"> </span><span class="si">%(sudo)s</span><span class="s"> kill -9 </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
+<span class="s">fi</span>
+<span class="s">"""</span>
+ <span class="k">if</span> <span class="n">nowait</span><span class="p">:</span>
+ <span class="n">cmd</span> <span class="o">=</span> <span class="s">"( </span><span class="si">%s</span><span class="s"> ) >/dev/null 2>/dev/null </dev/null &"</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">,)</span>
+
+ <span class="p">(</span><span class="n">out</span><span class="p">,</span><span class="n">err</span><span class="p">),</span><span class="n">proc</span> <span class="o">=</span> <span class="n">rexec</span><span class="p">(</span>
+ <span class="n">cmd</span> <span class="o">%</span> <span class="p">{</span>
+ <span class="s">'ppid'</span> <span class="p">:</span> <span class="n">ppid</span><span class="p">,</span>
+ <span class="s">'pid'</span> <span class="p">:</span> <span class="n">pid</span><span class="p">,</span>
+ <span class="s">'sudo'</span> <span class="p">:</span> <span class="s">'sudo -S'</span> <span class="k">if</span> <span class="n">sudo</span> <span class="k">else</span> <span class="s">''</span><span class="p">,</span>
+ <span class="s">'subkill'</span> <span class="p">:</span> <span class="n">subkill</span><span class="p">,</span>
+ <span class="p">},</span>
+ <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
+ <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
+ <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
+ <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
+ <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
+ <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
+ <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
+ <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
+ <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
+ <span class="p">)</span>
+
+ <span class="c"># wait, don't leave zombies around</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
+
+ <span class="k">return</span> <span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span>
+</div>
+<span class="k">def</span> <span class="nf">_retry_rexec</span><span class="p">(</span><span class="n">args</span><span class="p">,</span>
+ <span class="n">log_msg</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>
+ <span class="n">stdin</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</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>
+ <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
+ <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
+ <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
+
+ <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="nb">xrange</span><span class="p">(</span><span class="n">retry</span><span class="p">):</span>
+ <span class="c"># connects to the remote host and starts a remote connection</span>
+ <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">args</span><span class="p">,</span>
+ <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span><span class="p">,</span>
+ <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span><span class="p">,</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">)</span>
+
+ <span class="c"># attach tempfile object to the process, to make sure the file stays</span>
+ <span class="c"># alive until the process is finished with it</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">_known_hosts</span> <span class="o">=</span> <span class="n">tmp_known_hosts</span>
+
+ <span class="c"># The argument block == False forces to rexec to return immediately, </span>
+ <span class="c"># without blocking </span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">err</span> <span class="o">=</span> <span class="n">out</span> <span class="o">=</span> <span class="s">" "</span>
+ <span class="k">if</span> <span class="n">blocking</span><span class="p">:</span>
+ <span class="c">#(out, err) = proc.communicate()</span>
+ <span class="c"># The method communicate was re implemented for performance issues</span>
+ <span class="c"># when using python subprocess communicate method the ssh commands </span>
+ <span class="c"># last one minute each</span>
+ <span class="n">out</span><span class="p">,</span> <span class="n">err</span> <span class="o">=</span> <span class="n">_communicate</span><span class="p">(</span><span class="n">proc</span><span class="p">,</span> <span class="nb">input</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
+
+ <span class="k">elif</span> <span class="n">stdout</span><span class="p">:</span>
+ <span class="n">out</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span> <span class="ow">and</span> <span class="n">stderr</span><span class="p">:</span>
+ <span class="n">err</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
+
+ <span class="n">log</span><span class="p">(</span><span class="n">log_msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
+ <span class="n">skip</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="k">if</span> <span class="n">err</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'ssh: '</span><span class="p">)</span> <span class="ow">or</span> <span class="n">err</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'mux_client_hello_exchange: '</span><span class="p">):</span>
+ <span class="c"># SSH error, can safely retry</span>
+ <span class="n">skip</span> <span class="o">=</span> <span class="bp">True</span>
+ <span class="k">elif</span> <span class="n">retry</span><span class="p">:</span>
+ <span class="c"># Probably timed out or plain failed but can retry</span>
+ <span class="n">skip</span> <span class="o">=</span> <span class="bp">True</span>
+
+ <span class="k">if</span> <span class="n">skip</span><span class="p">:</span>
+ <span class="n">t</span> <span class="o">=</span> <span class="n">x</span><span class="o">*</span><span class="mi">2</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">"SLEEPING </span><span class="si">%d</span><span class="s"> ... ATEMPT </span><span class="si">%d</span><span class="s"> - command </span><span class="si">%s</span><span class="s"> "</span> <span class="o">%</span> <span class="p">(</span>
+ <span class="n">t</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="s">" "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
+ <span class="n">log</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
+
+ <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
+ <span class="k">continue</span>
+ <span class="k">break</span>
+ <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">msg</span> <span class="o">=</span> <span class="s">" rexec EXCEPTION - TIMEOUT -> </span><span class="si">%s</span><span class="s"> </span><span class="se">\n</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">,</span> <span class="n">log_msg</span> <span class="p">)</span>
+ <span class="n">log</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">retry</span> <span class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span>
+ <span class="n">retry</span> <span class="o">-=</span> <span class="mi">1</span>
+
+ <span class="k">return</span> <span class="p">((</span><span class="n">out</span><span class="p">,</span> <span class="n">err</span><span class="p">),</span> <span class="n">proc</span><span class="p">)</span>
+
+<span class="c"># POSIX</span>
+<span class="c"># Don't remove. The method communicate was re implemented for performance issues</span>
+<span class="k">def</span> <span class="nf">_communicate</span><span class="p">(</span><span class="n">proc</span><span class="p">,</span> <span class="nb">input</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">err_on_timeout</span><span class="o">=</span><span class="bp">True</span><span class="p">):</span>
+ <span class="n">read_set</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">write_set</span> <span class="o">=</span> <span class="p">[]</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># Return</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># Return</span>
+
+ <span class="n">killed</span> <span class="o">=</span> <span class="bp">False</span>
+
+ <span class="k">if</span> <span class="n">timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">timelimit</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">+</span> <span class="n">timeout</span>
+ <span class="n">killtime</span> <span class="o">=</span> <span class="n">timelimit</span> <span class="o">+</span> <span class="mi">4</span>
+ <span class="n">bailtime</span> <span class="o">=</span> <span class="n">timelimit</span> <span class="o">+</span> <span class="mi">4</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="p">:</span>
+ <span class="c"># Flush stdio buffer. This might block, if the user has</span>
+ <span class="c"># been writing to .stdin in an uncontrolled fashion.</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
+ <span class="k">if</span> <span class="nb">input</span><span class="p">:</span>
+ <span class="n">write_set</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="p">:</span>
+ <span class="n">read_set</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="p">:</span>
+ <span class="n">read_set</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="p">[]</span>
+
+ <span class="n">input_offset</span> <span class="o">=</span> <span class="mi">0</span>
+ <span class="k">while</span> <span class="n">read_set</span> <span class="ow">or</span> <span class="n">write_set</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">timeout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">curtime</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+ <span class="k">if</span> <span class="n">timeout</span> <span class="ow">is</span> <span class="bp">None</span> <span class="ow">or</span> <span class="n">curtime</span> <span class="o">></span> <span class="n">timelimit</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">curtime</span> <span class="o">></span> <span class="n">bailtime</span><span class="p">:</span>
+ <span class="k">break</span>
+ <span class="k">elif</span> <span class="n">curtime</span> <span class="o">></span> <span class="n">killtime</span><span class="p">:</span>
+ <span class="n">signum</span> <span class="o">=</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGKILL</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">signum</span> <span class="o">=</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span>
+ <span class="c"># Lets kill it</span>
+ <span class="n">os</span><span class="o">.</span><span class="n">kill</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">pid</span><span class="p">,</span> <span class="n">signum</span><span class="p">)</span>
+ <span class="n">select_timeout</span> <span class="o">=</span> <span class="mf">0.5</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">select_timeout</span> <span class="o">=</span> <span class="n">timelimit</span> <span class="o">-</span> <span class="n">curtime</span> <span class="o">+</span> <span class="mf">0.1</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">select_timeout</span> <span class="o">=</span> <span class="mf">1.0</span>
+
+ <span class="k">if</span> <span class="n">select_timeout</span> <span class="o">></span> <span class="mf">1.0</span><span class="p">:</span>
+ <span class="n">select_timeout</span> <span class="o">=</span> <span class="mf">1.0</span>
+
+ <span class="k">try</span><span class="p">:</span>
+ <span class="n">rlist</span><span class="p">,</span> <span class="n">wlist</span><span class="p">,</span> <span class="n">xlist</span> <span class="o">=</span> <span class="n">select</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">read_set</span><span class="p">,</span> <span class="n">write_set</span><span class="p">,</span> <span class="p">[],</span> <span class="n">select_timeout</span><span class="p">)</span>
+ <span class="k">except</span> <span class="n">select</span><span class="o">.</span><span class="n">error</span><span class="p">,</span><span class="n">e</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">e</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">4</span><span class="p">:</span>
+ <span class="k">raise</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">continue</span>
+
+ <span class="k">if</span> <span class="ow">not</span> <span class="n">rlist</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">wlist</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">xlist</span> <span class="ow">and</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="c"># timeout and process exited, say bye</span>
+ <span class="k">break</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdin</span> <span class="ow">in</span> <span class="n">wlist</span><span class="p">:</span>
+ <span class="c"># When select has indicated that the file is writable,</span>
+ <span class="c"># we can write up to PIPE_BUF bytes without risk</span>
+ <span class="c"># blocking. POSIX defines PIPE_BUF >= 512</span>
+ <span class="n">bytes_written</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">fileno</span><span class="p">(),</span>
+ <span class="nb">buffer</span><span class="p">(</span><span class="nb">input</span><span class="p">,</span> <span class="n">input_offset</span><span class="p">,</span> <span class="mi">512</span><span class="p">))</span>
+ <span class="n">input_offset</span> <span class="o">+=</span> <span class="n">bytes_written</span>
+
+ <span class="k">if</span> <span class="n">input_offset</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">input</span><span class="p">):</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">write_set</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdout</span> <span class="ow">in</span> <span class="n">rlist</span><span class="p">:</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">fileno</span><span class="p">(),</span> <span class="mi">1024</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="s">""</span><span class="p">:</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">read_set</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="n">stdout</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stderr</span> <span class="ow">in</span> <span class="n">rlist</span><span class="p">:</span>
+ <span class="n">data</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">fileno</span><span class="p">(),</span> <span class="mi">1024</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="s">""</span><span class="p">:</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
+ <span class="n">read_set</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span>
+ <span class="n">stderr</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
+
+ <span class="c"># All data exchanged. Translate lists into strings.</span>
+ <span class="k">if</span> <span class="n">stdout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">stderr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">stderr</span><span class="p">)</span>
+
+ <span class="c"># Translate newlines, if requested. We cannot let the file</span>
+ <span class="c"># object do the translation: It is based on stdio, which is</span>
+ <span class="c"># impossible to combine with select (unless forcing no</span>
+ <span class="c"># buffering).</span>
+ <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">universal_newlines</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="nb">file</span><span class="p">,</span> <span class="s">'newlines'</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">stdout</span><span class="p">:</span>
+ <span class="n">stdout</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">_translate_newlines</span><span class="p">(</span><span class="n">stdout</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">stderr</span><span class="p">:</span>
+ <span class="n">stderr</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">_translate_newlines</span><span class="p">(</span><span class="n">stderr</span><span class="p">)</span>
+
+ <span class="k">if</span> <span class="n">killed</span> <span class="ow">and</span> <span class="n">err_on_timeout</span><span class="p">:</span>
+ <span class="n">errcode</span> <span class="o">=</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span>
+ <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="p">(</span><span class="s">"Operation timed out"</span><span class="p">,</span> <span class="n">errcode</span><span class="p">,</span> <span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">if</span> <span class="n">killed</span><span class="p">:</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
+ <span class="k">return</span> <span class="p">(</span><span class="n">stdout</span><span class="p">,</span> <span class="n">stderr</span><span class="p">)</span>
+
+<span class="k">def</span> <span class="nf">_proxy_command</span><span class="p">(</span><span class="n">gw</span><span class="p">,</span> <span class="n">gwuser</span><span class="p">,</span> <span class="n">gwidentity</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Constructs the SSH ProxyCommand option to add to the SSH command to connect</span>
+<span class="sd"> via a proxy</span>
+<span class="sd"> :param gw: SSH proxy hostname</span>
+<span class="sd"> :type gw: str </span>
+<span class="sd"> </span>
+<span class="sd"> :param gwuser: SSH proxy username</span>
+<span class="sd"> :type gwuser: str</span>
+
+<span class="sd"> :param gwidentity: SSH proxy identity file </span>
+<span class="sd"> :type gwidentity: str</span>
+
+<span class="sd"> </span>
+<span class="sd"> :rtype: str </span>
+<span class="sd"> </span>
+<span class="sd"> returns the SSH ProxyCommand option.</span>
+<span class="sd"> """</span>
+
+ <span class="n">proxycommand</span> <span class="o">=</span> <span class="s">'ProxyCommand=ssh -q '</span>
+ <span class="k">if</span> <span class="n">gwidentity</span><span class="p">:</span>
+ <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">'-i </span><span class="si">%s</span><span class="s"> '</span> <span class="o">%</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span><span class="n">gwidentity</span><span class="p">)</span>
+ <span class="k">if</span> <span class="n">gwuser</span><span class="p">:</span>
+ <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">'</span><span class="si">%s</span><span class="s">'</span> <span class="o">%</span> <span class="n">gwuser</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">'</span><span class="si">%r</span><span class="s">'</span>
+ <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">'@</span><span class="si">%s</span><span class="s"> -W </span><span class="si">%%</span><span class="s">h:</span><span class="si">%%</span><span class="s">p'</span> <span class="o">%</span> <span class="n">gw</span>
+
+ <span class="k">return</span> <span class="n">proxycommand</span>
+</pre></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
git://git.onelab.eu / nepi.git / blobdiff