doc/sphinx/_build/html/_modules/nepi/util/sshfuncs.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>nepi.util.sshfuncs &mdash; NEPI 3.0 documentation</title>
  10
  11     <link rel="stylesheet" href="../../../_static/sphinxdoc.css" type="text/css" />
  12     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  13
  14     <script type="text/javascript">
  15       var DOCUMENTATION_OPTIONS = {
  16         URL_ROOT:    '../../../',
  17         VERSION:     '3.0',
  18         COLLAPSE_INDEX: false,
  19         FILE_SUFFIX: '.html',
  20         HAS_SOURCE:  true
  21       };
  22     </script>
  23     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  24     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  25     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  26     <link rel="top" title="NEPI 3.0 documentation" href="../../../index.html" />
  27     <link rel="up" title="Module code" href="../../index.html" />
  28   </head>
  29   <body>
  30     <div class="related">
  31       <h3>Navigation</h3>
  32       <ul>
  33         <li class="right" style="margin-right: 10px">
  34           <a href="../../../genindex.html" title="General Index"
  35              accesskey="I">index</a></li>
  36         <li class="right" >
  37           <a href="../../../py-modindex.html" title="Python Module Index"
  38              >modules</a> |</li>
  39         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
  40           <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li>
  41       </ul>
  42     </div>
  43       <div class="sphinxsidebar">
  44         <div class="sphinxsidebarwrapper">
  45 <div id="searchbox" style="display: none">
  46   <h3>Quick search</h3>
  47     <form class="search" action="../../../search.html" method="get">
  48       <input type="text" name="q" />
  49       <input type="submit" value="Go" />
  50       <input type="hidden" name="check_keywords" value="yes" />
  51       <input type="hidden" name="area" value="default" />
  52     </form>
  53     <p class="searchtip" style="font-size: 90%">
  54     Enter search terms or a module, class or function name.
  55     </p>
  56 </div>
  57 <script type="text/javascript">$('#searchbox').show(0);</script>
  58         </div>
  59       </div>
  60
  61     <div class="document">
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <h1>Source code for nepi.util.sshfuncs</h1><div class="highlight"><pre>
  67 <span class="c">#</span>
  68 <span class="c">#    NEPI, a framework to manage network experiments</span>
  69 <span class="c">#    Copyright (C) 2013 INRIA</span>
  70 <span class="c">#</span>
  71 <span class="c">#    This program is free software: you can redistribute it and/or modify</span>
  72 <span class="c">#    it under the terms of the GNU General Public License version 2 as</span>
  73 <span class="c">#    published by the Free Software Foundation;</span>
  74 <span class="c">#</span>
  75 <span class="c">#    This program is distributed in the hope that it will be useful,</span>
  76 <span class="c">#    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  77 <span class="c">#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
  78 <span class="c">#    GNU General Public License for more details.</span>
  79 <span class="c">#</span>
  80 <span class="c">#    You should have received a copy of the GNU General Public License</span>
  81 <span class="c">#    along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
  82 <span class="c">#</span>
  83 <span class="c"># Author: Alina Quereilhac &lt;alina.quereilhac@inria.fr&gt;</span>
  84 <span class="c">#         Claudio Freire &lt;claudio-daniel.freire@inria.fr&gt;</span>
  85
  86 <span class="c">## TODO: This code needs reviewing !!!</span>
  87
  88 <span class="kn">import</span> <span class="nn">base64</span>
  89 <span class="kn">import</span> <span class="nn">errno</span>
  90 <span class="kn">import</span> <span class="nn">hashlib</span>
  91 <span class="kn">import</span> <span class="nn">logging</span>
  92 <span class="kn">import</span> <span class="nn">os</span>
  93 <span class="kn">import</span> <span class="nn">os.path</span>
  94 <span class="kn">import</span> <span class="nn">re</span>
  95 <span class="kn">import</span> <span class="nn">select</span>
  96 <span class="kn">import</span> <span class="nn">signal</span>
  97 <span class="kn">import</span> <span class="nn">socket</span>
  98 <span class="kn">import</span> <span class="nn">subprocess</span>
  99 <span class="kn">import</span> <span class="nn">threading</span>
 100 <span class="kn">import</span> <span class="nn">time</span>
 101 <span class="kn">import</span> <span class="nn">tempfile</span>
 102
 103 <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">&quot;\d+:\s+(?P&lt;name&gt;[a-z0-9_-]+)\s+inet6?\s+(?P&lt;inet&gt;[a-f0-9.:/]+)\s+(brd\s+[0-9.]+)?.*scope\s+global.*&quot;</span><span class="p">)</span>
 104
 105 <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">&quot;sshfuncs&quot;</span><span class="p">)</span>
 106
 107 <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>
 108     <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
 109         <span class="n">msg</span> <span class="o">+=</span> <span class="s">&quot; - OUT: </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">out</span>
 110
 111     <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
 112         <span class="n">msg</span> <span class="o">+=</span> <span class="s">&quot; - ERROR: </span><span class="si">%s</span><span class="s"> &quot;</span> <span class="o">%</span> <span class="n">err</span>
 113
 114     <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>
 115 </div>
 116 <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">&quot;devnull&quot;</span><span class="p">):</span>
 117     <span class="n">DEV_NULL</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">devnull</span>
 118 <span class="k">else</span><span class="p">:</span>
 119     <span class="n">DEV_NULL</span> <span class="o">=</span> <span class="s">&quot;/dev/null&quot;</span>
 120
 121 <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">&#39;^[-a-zA-Z0-9_=+:.,/]*$&#39;</span><span class="p">)</span>
 122
 123 <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>
 124     <span class="sd">&quot;&quot;&quot;</span>
 125 <span class="sd">    Special value that when given to rspawn in stderr causes stderr to </span>
 126 <span class="sd">    redirect to whatever stdout was redirected to.</span>
 127 <span class="sd">    &quot;&quot;&quot;</span>
 128 </div>
 129 <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>
 130     <span class="sd">&quot;&quot;&quot;</span>
 131 <span class="sd">    Codes for status of remote spawned process</span>
 132 <span class="sd">    &quot;&quot;&quot;</span>
 133     <span class="c"># Process is still running</span>
 134     <span class="n">RUNNING</span> <span class="o">=</span> <span class="mi">1</span>
 135
 136     <span class="c"># Process is finished</span>
 137     <span class="n">FINISHED</span> <span class="o">=</span> <span class="mi">2</span>
 138
 139     <span class="c"># Process hasn&#39;t started running yet (this should be very rare)</span>
 140     <span class="n">NOT_STARTED</span> <span class="o">=</span> <span class="mi">3</span>
 141 </div>
 142 <span class="n">hostbyname_cache</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
 143 <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>
 144
 145 <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>
 146     <span class="n">ip</span> <span class="o">=</span> <span class="bp">None</span>
 147
 148     <span class="k">if</span> <span class="n">host</span> <span class="ow">in</span> <span class="p">[</span><span class="s">&quot;localhost&quot;</span><span class="p">,</span> <span class="s">&quot;127.0.0.1&quot;</span><span class="p">,</span> <span class="s">&quot;::1&quot;</span><span class="p">]:</span>
 149         <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">&quot;ip -o addr list&quot;</span><span class="p">,</span> <span class="n">shell</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
 150                 <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>
 151         <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>
 152         <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>
 153         <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">&quot;/&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
 154     <span class="k">else</span><span class="p">:</span>
 155         <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>
 156
 157     <span class="k">return</span> <span class="n">ip</span>
 158 </div>
 159 <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>
 160     <span class="k">global</span> <span class="n">hostbyname_cache</span>
 161     <span class="k">global</span> <span class="n">hostbyname_cache_lock</span>
 162
 163     <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>
 164     <span class="k">if</span> <span class="ow">not</span> <span class="n">hostbyname</span><span class="p">:</span>
 165         <span class="k">with</span> <span class="n">hostbyname_cache_lock</span><span class="p">:</span>
 166             <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>
 167             <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>
 168
 169             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; Added hostbyname </span><span class="si">%s</span><span class="s"> - </span><span class="si">%s</span><span class="s"> &quot;</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>
 170             <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>
 171
 172     <span class="k">return</span> <span class="n">hostbyname</span>
 173 </div>
 174 <span class="n">OPENSSH_HAS_PERSIST</span> <span class="o">=</span> <span class="bp">None</span>
 175
 176 <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>
 177     <span class="sd">&quot;&quot;&quot; The ssh_config options ControlMaster and ControlPersist allow to</span>
 178 <span class="sd">    reuse a same network connection for multiple ssh sessions. In this </span>
 179 <span class="sd">    way limitations on number of open ssh connections can be bypassed.</span>
 180 <span class="sd">    However, older versions of openSSH do not support this feature.</span>
 181 <span class="sd">    This function is used to determine if ssh connection persist features</span>
 182 <span class="sd">    can be used.</span>
 183 <span class="sd">    &quot;&quot;&quot;</span>
 184     <span class="k">global</span> <span class="n">OPENSSH_HAS_PERSIST</span>
 185     <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>
 186         <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">&quot;ssh&quot;</span><span class="p">,</span><span class="s">&quot;-v&quot;</span><span class="p">],</span>
 187             <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>
 188             <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>
 189             <span class="n">stdin</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="s">&quot;/dev/null&quot;</span><span class="p">,</span><span class="s">&quot;r&quot;</span><span class="p">)</span> <span class="p">)</span>
 190         <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>
 191         <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
 192
 193         <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&#39;OpenSSH_(?:[6-9]|5[.][8-9]|5[.][1-9][0-9]|[1-9][0-9]).*&#39;</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
 194         <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>
 195     <span class="k">return</span> <span class="n">OPENSSH_HAS_PERSIST</span>
 196 </div>
 197 <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>
 198     <span class="sd">&quot;&quot;&quot; Returns a reference to a temporary known_hosts file, to which </span>
 199 <span class="sd">    the server key has been added. </span>
 200 <span class="sd">    </span>
 201 <span class="sd">    Make sure to hold onto the temp file reference until the process is </span>
 202 <span class="sd">    done with it</span>
 203
 204 <span class="sd">    :param server_key: the server public key</span>
 205 <span class="sd">    :type server_key: str</span>
 206
 207 <span class="sd">    :param host: the hostname</span>
 208 <span class="sd">    :type host: str</span>
 209
 210 <span class="sd">    :param port: the ssh port</span>
 211 <span class="sd">    :type port: str</span>
 212
 213 <span class="sd">    &quot;&quot;&quot;</span>
 214     <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>
 215         <span class="n">host</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">:</span><span class="si">%s</span><span class="s">&#39;</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>
 216
 217     <span class="c"># Create a temporary server key file</span>
 218     <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>
 219
 220     <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>
 221
 222     <span class="c"># Add the intended host key</span>
 223     <span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s">&#39;</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">&#39;</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>
 224
 225     <span class="c"># If we&#39;re not in strict mode, add user-configured keys</span>
 226     <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">&#39;NEPI_STRICT_AUTH_MODE&#39;</span><span class="p">,</span><span class="s">&quot;&quot;</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">&#39;1&#39;</span><span class="p">,</span><span class="s">&#39;true&#39;</span><span class="p">,</span><span class="s">&#39;on&#39;</span><span class="p">):</span>
 227         <span class="n">user_hosts_path</span> <span class="o">=</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">/.ssh/known_hosts&#39;</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">&#39;HOME&#39;</span><span class="p">,</span><span class="s">&quot;&quot;</span><span class="p">),)</span>
 228         <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>
 229             <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">&quot;r&quot;</span><span class="p">)</span>
 230             <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>
 231             <span class="n">f</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
 232
 233     <span class="n">tmp_known_hosts</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
 234
 235     <span class="k">return</span> <span class="n">tmp_known_hosts</span>
 236 </div>
 237 <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>
 238     <span class="n">ctrl_path</span> <span class="o">=</span> <span class="s">&quot;/tmp/nepi_ssh&quot;</span>
 239
 240     <span class="k">if</span> <span class="n">agent</span><span class="p">:</span>
 241         <span class="n">ctrl_path</span> <span class="o">+=</span><span class="s">&quot;_a&quot;</span>
 242
 243     <span class="k">if</span> <span class="n">forward_x11</span><span class="p">:</span>
 244         <span class="n">ctrl_path</span> <span class="o">+=</span><span class="s">&quot;_x&quot;</span>
 245
 246     <span class="n">ctrl_path</span> <span class="o">+=</span> <span class="s">&quot;-</span><span class="si">%r</span><span class="s">@%h:%p&quot;</span>
 247
 248     <span class="k">return</span> <span class="n">ctrl_path</span>
 249 </div>
 250 <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>
 251     <span class="sd">&quot;&quot;&quot; Escapes strings so that they are safe to use as command-line </span>
 252 <span class="sd">    arguments &quot;&quot;&quot;</span>
 253     <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>
 254         <span class="c"># safe string - no escaping needed</span>
 255         <span class="k">return</span> <span class="n">s</span>
 256     <span class="k">else</span><span class="p">:</span>
 257         <span class="c"># unsafe string - escape</span>
 258         <span class="k">def</span> <span class="nf">escp</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
 259             <span class="k">if</span> <span class="p">(</span><span class="mi">32</span> <span class="o">&lt;=</span> <span class="nb">ord</span><span class="p">(</span><span class="n">c</span><span class="p">)</span> <span class="o">&lt;</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">&#39;</span><span class="se">\r</span><span class="s">&#39;</span><span class="p">,</span><span class="s">&#39;</span><span class="se">\n</span><span class="s">&#39;</span><span class="p">,</span><span class="s">&#39;</span><span class="se">\t</span><span class="s">&#39;</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">&quot;&#39;&quot;</span><span class="p">,</span><span class="s">&#39;&quot;&#39;</span><span class="p">):</span>
 260                 <span class="k">return</span> <span class="n">c</span>
 261             <span class="k">else</span><span class="p">:</span>
 262                 <span class="k">return</span> <span class="s">&quot;&#39;$&#39;</span><span class="se">\\</span><span class="s">x</span><span class="si">%02x</span><span class="s">&#39;&#39;&quot;</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>
 263         <span class="n">s</span> <span class="o">=</span> <span class="s">&#39;&#39;</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>
 264         <span class="k">return</span> <span class="s">&quot;&#39;</span><span class="si">%s</span><span class="s">&#39;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">s</span><span class="p">,)</span>
 265 </div>
 266 <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>
 267     <span class="sd">&quot;&quot;&quot;Retries a function invocation when a EINTR occurs&quot;&quot;&quot;</span>
 268     <span class="kn">import</span> <span class="nn">functools</span>
 269     <span class="nd">@functools.wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
 270     <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>
 271         <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">&quot;_retry&quot;</span><span class="p">,</span> <span class="bp">False</span><span class="p">)</span>
 272         <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>
 273             <span class="k">try</span><span class="p">:</span>
 274                 <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>
 275             <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>
 276                 <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>
 277                     <span class="k">continue</span>
 278                 <span class="k">else</span><span class="p">:</span>
 279                     <span class="k">raise</span>
 280             <span class="k">except</span> <span class="ne">OSError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
 281                 <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>
 282                     <span class="k">continue</span>
 283                 <span class="k">else</span><span class="p">:</span>
 284                     <span class="k">raise</span>
 285         <span class="k">else</span><span class="p">:</span>
 286             <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>
 287     <span class="k">return</span> <span class="n">rv</span>
 288 </div>
 289 <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>
 290         <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 291         <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 292         <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 293         <span class="n">agent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 294         <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 295         <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 296         <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 297         <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 298         <span class="n">tty</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 299         <span class="n">connect_timeout</span> <span class="o">=</span> <span class="mi">30</span><span class="p">,</span>
 300         <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
 301         <span class="n">persistent</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 302         <span class="n">forward_x11</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 303         <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span>
 304         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 305     <span class="sd">&quot;&quot;&quot;</span>
 306 <span class="sd">    Executes a remote command, returns ((stdout,stderr),process)</span>
 307 <span class="sd">    &quot;&quot;&quot;</span>
 308
 309     <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="bp">None</span>
 310     <span class="k">if</span> <span class="ow">not</span> <span class="n">gw</span><span class="p">:</span>
 311         <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>
 312     <span class="k">else</span><span class="p">:</span> <span class="n">hostip</span> <span class="o">=</span> <span class="bp">None</span>
 313
 314     <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;ssh&#39;</span><span class="p">,</span> <span class="s">&#39;-C&#39;</span><span class="p">,</span>
 315             <span class="c"># Don&#39;t bother with localhost. Makes test easier</span>
 316             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;NoHostAuthenticationForLocalhost=yes&#39;</span><span class="p">,</span>
 317             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ConnectTimeout=</span><span class="si">%d</span><span class="s">&#39;</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>
 318             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ConnectionAttempts=3&#39;</span><span class="p">,</span>
 319             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ServerAliveInterval=30&#39;</span><span class="p">,</span>
 320             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;TCPKeepAlive=yes&#39;</span><span class="p">,</span>
 321             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;Batchmode=yes&#39;</span><span class="p">,</span>
 322             <span class="s">&#39;-l&#39;</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>
 323
 324     <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>
 325         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>
 326             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ControlMaster=auto&#39;</span><span class="p">,</span>
 327             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ControlPath=</span><span class="si">%s</span><span class="s">&#39;</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>
 328             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ControlPersist=60&#39;</span> <span class="p">])</span>
 329
 330     <span class="k">if</span> <span class="ow">not</span> <span class="n">strict_host_checking</span><span class="p">:</span>
 331         <span class="c"># Do not check for Host key. Unsafe.</span>
 332         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;StrictHostKeyChecking=no&#39;</span><span class="p">])</span>
 333
 334     <span class="k">if</span> <span class="n">gw</span><span class="p">:</span>
 335         <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>
 336         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="n">proxycommand</span><span class="p">])</span>
 337
 338     <span class="k">if</span> <span class="n">agent</span><span class="p">:</span>
 339         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-A&#39;</span><span class="p">)</span>
 340
 341     <span class="k">if</span> <span class="n">port</span><span class="p">:</span>
 342         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-p</span><span class="si">%d</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">port</span><span class="p">)</span>
 343
 344     <span class="k">if</span> <span class="n">identity</span><span class="p">:</span>
 345         <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>
 346         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">((</span><span class="s">&#39;-i&#39;</span><span class="p">,</span> <span class="n">identity</span><span class="p">))</span>
 347
 348     <span class="k">if</span> <span class="n">tty</span><span class="p">:</span>
 349         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-t&#39;</span><span class="p">)</span>
 350         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-t&#39;</span><span class="p">)</span>
 351
 352     <span class="k">if</span> <span class="n">forward_x11</span><span class="p">:</span>
 353         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-X&#39;</span><span class="p">)</span>
 354
 355     <span class="k">if</span> <span class="n">server_key</span><span class="p">:</span>
 356         <span class="c"># Create a temporary server key file</span>
 357         <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>
 358         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;UserKnownHostsFile=</span><span class="si">%s</span><span class="s">&#39;</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>
 359
 360     <span class="k">if</span> <span class="n">sudo</span><span class="p">:</span>
 361         <span class="n">command</span> <span class="o">=</span> <span class="s">&quot;sudo &quot;</span> <span class="o">+</span> <span class="n">command</span>
 362
 363     <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>
 364
 365     <span class="n">log_msg</span> <span class="o">=</span> <span class="s">&quot; rexec - host </span><span class="si">%s</span><span class="s"> - command </span><span class="si">%s</span><span class="s"> &quot;</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">&quot; &quot;</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>
 366
 367     <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>
 368     <span class="k">if</span> <span class="n">forward_x11</span><span class="p">:</span>
 369         <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>
 370
 371     <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>
 372             <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">,</span>
 373             <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span><span class="p">,</span>
 374             <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span><span class="p">,</span>
 375             <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
 376             <span class="n">retry</span> <span class="o">=</span> <span class="n">retry</span><span class="p">,</span>
 377             <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">tmp_known_hosts</span><span class="p">,</span>
 378             <span class="n">blocking</span> <span class="o">=</span> <span class="n">blocking</span><span class="p">)</span>
 379 </div>
 380 <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>
 381         <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 382         <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 383         <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 384         <span class="n">recursive</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 385         <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 386         <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 387         <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
 388         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 389     <span class="sd">&quot;&quot;&quot;</span>
 390 <span class="sd">    Copies from/to remote sites.</span>
 391 <span class="sd">    </span>
 392 <span class="sd">    Source and destination should have the user and host encoded</span>
 393 <span class="sd">    as per scp specs.</span>
 394 <span class="sd">    </span>
 395 <span class="sd">    Source can be a list of files to copy to a single destination, </span>
 396 <span class="sd">    (in which case it is advised that the destination be a folder),</span>
 397 <span class="sd">    or a single file in a string.</span>
 398 <span class="sd">    &quot;&quot;&quot;</span>
 399
 400     <span class="c"># Parse destination as &lt;user&gt;@&lt;server&gt;:&lt;path&gt;</span>
 401     <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">&#39;:&#39;</span> <span class="ow">in</span> <span class="n">dest</span><span class="p">:</span>
 402         <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">&#39;:&#39;</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
 403     <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">&#39;:&#39;</span> <span class="ow">in</span> <span class="n">source</span><span class="p">:</span>
 404         <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">&#39;:&#39;</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
 405     <span class="k">else</span><span class="p">:</span>
 406         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">,</span> <span class="s">&quot;Both endpoints cannot be local&quot;</span>
 407     <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">&#39;@&#39;</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span>
 408
 409     <span class="c"># plain scp</span>
 410     <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="bp">None</span>
 411
 412     <span class="n">args</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;scp&#39;</span><span class="p">,</span> <span class="s">&#39;-q&#39;</span><span class="p">,</span> <span class="s">&#39;-p&#39;</span><span class="p">,</span> <span class="s">&#39;-C&#39;</span><span class="p">,</span>
 413             <span class="c"># Speed up transfer using blowfish cypher specification which is </span>
 414             <span class="c"># faster than the default one (3des)</span>
 415             <span class="s">&#39;-c&#39;</span><span class="p">,</span> <span class="s">&#39;blowfish&#39;</span><span class="p">,</span>
 416             <span class="c"># Don&#39;t bother with localhost. Makes test easier</span>
 417             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;NoHostAuthenticationForLocalhost=yes&#39;</span><span class="p">,</span>
 418             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ConnectTimeout=60&#39;</span><span class="p">,</span>
 419             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ConnectionAttempts=3&#39;</span><span class="p">,</span>
 420             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ServerAliveInterval=30&#39;</span><span class="p">,</span>
 421             <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;TCPKeepAlive=yes&#39;</span> <span class="p">]</span>
 422
 423     <span class="k">if</span> <span class="n">port</span><span class="p">:</span>
 424         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-P</span><span class="si">%d</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">port</span><span class="p">)</span>
 425
 426     <span class="k">if</span> <span class="n">gw</span><span class="p">:</span>
 427         <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>
 428         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="n">proxycommand</span><span class="p">])</span>
 429
 430     <span class="k">if</span> <span class="n">recursive</span><span class="p">:</span>
 431         <span class="n">args</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">&#39;-r&#39;</span><span class="p">)</span>
 432
 433     <span class="k">if</span> <span class="n">identity</span><span class="p">:</span>
 434         <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>
 435         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">((</span><span class="s">&#39;-i&#39;</span><span class="p">,</span> <span class="n">identity</span><span class="p">))</span>
 436
 437     <span class="k">if</span> <span class="n">server_key</span><span class="p">:</span>
 438         <span class="c"># Create a temporary server key file</span>
 439         <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>
 440         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;UserKnownHostsFile=</span><span class="si">%s</span><span class="s">&#39;</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>
 441
 442     <span class="k">if</span> <span class="ow">not</span> <span class="n">strict_host_checking</span><span class="p">:</span>
 443         <span class="c"># Do not check for Host key. Unsafe.</span>
 444         <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;StrictHostKeyChecking=no&#39;</span><span class="p">])</span>
 445
 446     <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>
 447         <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>
 448     <span class="k">else</span><span class="p">:</span>
 449         <span class="k">if</span> <span class="n">openssh_has_persist</span><span class="p">():</span>
 450             <span class="n">args</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span>
 451                 <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ControlMaster=auto&#39;</span><span class="p">,</span>
 452                 <span class="s">&#39;-o&#39;</span><span class="p">,</span> <span class="s">&#39;ControlPath=</span><span class="si">%s</span><span class="s">&#39;</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>
 453                 <span class="p">])</span>
 454         <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>
 455
 456     <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>
 457         <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>
 458     <span class="k">else</span><span class="p">:</span>
 459         <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>
 460
 461     <span class="n">log_msg</span> <span class="o">=</span> <span class="s">&quot; rcopy - host </span><span class="si">%s</span><span class="s"> - command </span><span class="si">%s</span><span class="s"> &quot;</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">&quot; &quot;</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>
 462
 463     <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>
 464             <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="n">tmp_known_hosts</span><span class="p">,</span>
 465             <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">)</span>
 466 </div>
 467 <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>
 468         <span class="n">stdout</span> <span class="o">=</span> <span class="s">&#39;/dev/null&#39;</span><span class="p">,</span>
 469         <span class="n">stderr</span> <span class="o">=</span> <span class="n">STDOUT</span><span class="p">,</span>
 470         <span class="n">stdin</span> <span class="o">=</span> <span class="s">&#39;/dev/null&#39;</span><span class="p">,</span>
 471         <span class="n">home</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 472         <span class="n">create_home</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 473         <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 474         <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 475         <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 476         <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 477         <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 478         <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 479         <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 480         <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 481         <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 482         <span class="n">tty</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 483         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 484     <span class="sd">&quot;&quot;&quot;</span>
 485 <span class="sd">    Spawn a remote command such that it will continue working asynchronously in </span>
 486 <span class="sd">    background. </span>
 487
 488 <span class="sd">        :param command: The command to run, it should be a single line.</span>
 489 <span class="sd">        :type command: str</span>
 490
 491 <span class="sd">        :param pidfile: Path to a file where to store the pid and ppid of the </span>
 492 <span class="sd">                        spawned process</span>
 493 <span class="sd">        :type pidfile: str</span>
 494
 495 <span class="sd">        :param stdout: Path to file to redirect standard output. </span>
 496 <span class="sd">                       The default value is /dev/null</span>
 497 <span class="sd">        :type stdout: str</span>
 498
 499 <span class="sd">        :param stderr: Path to file to redirect standard error.</span>
 500 <span class="sd">                       If the special STDOUT value is used, stderr will </span>
 501 <span class="sd">                       be redirected to the same file as stdout</span>
 502 <span class="sd">        :type stderr: str</span>
 503
 504 <span class="sd">        :param stdin: Path to a file with input to be piped into the command&#39;s standard input</span>
 505 <span class="sd">        :type stdin: str</span>
 506
 507 <span class="sd">        :param home: Path to working directory folder. </span>
 508 <span class="sd">                    It is assumed to exist unless the create_home flag is set.</span>
 509 <span class="sd">        :type home: str</span>
 510
 511 <span class="sd">        :param create_home: Flag to force creation of the home folder before </span>
 512 <span class="sd">                            running the command</span>
 513 <span class="sd">        :type create_home: bool</span>
 514 <span class="sd"> </span>
 515 <span class="sd">        :param sudo: Flag forcing execution with sudo user</span>
 516 <span class="sd">        :type sudo: bool</span>
 517 <span class="sd">        </span>
 518 <span class="sd">        :rtype: tuple</span>
 519
 520 <span class="sd">        (stdout, stderr), process</span>
 521 <span class="sd">        </span>
 522 <span class="sd">        Of the spawning process, which only captures errors at spawning time.</span>
 523 <span class="sd">        Usually only useful for diagnostics.</span>
 524 <span class="sd">    &quot;&quot;&quot;</span>
 525     <span class="c"># Start process in a &quot;daemonized&quot; way, using nohup and heavy</span>
 526     <span class="c"># stdin/out redirection to avoid connection issues</span>
 527     <span class="k">if</span> <span class="n">stderr</span> <span class="ow">is</span> <span class="n">STDOUT</span><span class="p">:</span>
 528         <span class="n">stderr</span> <span class="o">=</span> <span class="s">&#39;&amp;1&#39;</span>
 529     <span class="k">else</span><span class="p">:</span>
 530         <span class="n">stderr</span> <span class="o">=</span> <span class="s">&#39; &#39;</span> <span class="o">+</span> <span class="n">stderr</span>
 531
 532     <span class="n">daemon_command</span> <span class="o">=</span> <span class="s">&#39;{ { </span><span class="si">%(command)s</span><span class="s"> &gt; </span><span class="si">%(stdout)s</span><span class="s"> 2&gt;</span><span class="si">%(stderr)s</span><span class="s"> &lt; </span><span class="si">%(stdin)s</span><span class="s"> &amp; } ; echo $! 1 &gt; </span><span class="si">%(pidfile)s</span><span class="s"> ; }&#39;</span> <span class="o">%</span> <span class="p">{</span>
 533         <span class="s">&#39;command&#39;</span> <span class="p">:</span> <span class="n">command</span><span class="p">,</span>
 534         <span class="s">&#39;pidfile&#39;</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">pidfile</span><span class="p">),</span>
 535         <span class="s">&#39;stdout&#39;</span> <span class="p">:</span> <span class="n">stdout</span><span class="p">,</span>
 536         <span class="s">&#39;stderr&#39;</span> <span class="p">:</span> <span class="n">stderr</span><span class="p">,</span>
 537         <span class="s">&#39;stdin&#39;</span> <span class="p">:</span> <span class="n">stdin</span><span class="p">,</span>
 538     <span class="p">}</span>
 539
 540     <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;</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"> &quot;</span> <span class="o">%</span> <span class="p">{</span>
 541             <span class="s">&#39;command&#39;</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>
 542             <span class="s">&#39;sudo&#39;</span> <span class="p">:</span> <span class="s">&#39;sudo -S&#39;</span> <span class="k">if</span> <span class="n">sudo</span> <span class="k">else</span> <span class="s">&#39;&#39;</span><span class="p">,</span>
 543             <span class="s">&#39;pidfile&#39;</span> <span class="p">:</span> <span class="n">shell_escape</span><span class="p">(</span><span class="n">pidfile</span><span class="p">),</span>
 544             <span class="s">&#39;gohome&#39;</span> <span class="p">:</span> <span class="s">&#39;cd </span><span class="si">%s</span><span class="s"> ; &#39;</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">&#39;&#39;</span><span class="p">,</span>
 545             <span class="s">&#39;create&#39;</span> <span class="p">:</span> <span class="s">&#39;mkdir -p </span><span class="si">%s</span><span class="s"> ; &#39;</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">&#39;&#39;</span><span class="p">,</span>
 546         <span class="p">}</span>
 547
 548     <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>
 549         <span class="n">cmd</span><span class="p">,</span>
 550         <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
 551         <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
 552         <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
 553         <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
 554         <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
 555         <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
 556         <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
 557         <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
 558         <span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span><span class="p">,</span>
 559         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span> <span class="p">,</span>
 560         <span class="p">)</span>
 561
 562     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
 563         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="s">&quot;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">&quot;</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>
 564
 565     <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>
 566 </div>
 567 <span class="nd">@eintr_retry</span>
 568 <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>
 569         <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 570         <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 571         <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 572         <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 573         <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 574         <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 575         <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 576         <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 577         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 578     <span class="sd">&quot;&quot;&quot;</span>
 579 <span class="sd">    Returns the pid and ppid of a process from a remote file where the </span>
 580 <span class="sd">    information was stored.</span>
 581
 582 <span class="sd">        :param home: Path to directory where the pidfile is located</span>
 583 <span class="sd">        :type home: str</span>
 584
 585 <span class="sd">        :param pidfile: Name of file containing the pid information</span>
 586 <span class="sd">        :type pidfile: str</span>
 587 <span class="sd">        </span>
 588 <span class="sd">        :rtype: int</span>
 589 <span class="sd">        </span>
 590 <span class="sd">        A (pid, ppid) tuple useful for calling rstatus and rkill,</span>
 591 <span class="sd">        or None if the pidfile isn&#39;t valid yet (can happen when process is staring up)</span>
 592
 593 <span class="sd">    &quot;&quot;&quot;</span>
 594     <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>
 595         <span class="s">&quot;cat </span><span class="si">%(pidfile)s</span><span class="s">&quot;</span> <span class="o">%</span> <span class="p">{</span>
 596             <span class="s">&#39;pidfile&#39;</span> <span class="p">:</span> <span class="n">pidfile</span><span class="p">,</span>
 597         <span class="p">},</span>
 598         <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
 599         <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
 600         <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
 601         <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
 602         <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
 603         <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
 604         <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
 605         <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
 606         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
 607         <span class="p">)</span>
 608
 609     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
 610         <span class="k">return</span> <span class="bp">None</span>
 611
 612     <span class="k">if</span> <span class="n">out</span><span class="p">:</span>
 613         <span class="k">try</span><span class="p">:</span>
 614             <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">&#39; &#39;</span><span class="p">,</span><span class="mi">1</span><span class="p">))</span>
 615         <span class="k">except</span><span class="p">:</span>
 616             <span class="c"># Ignore, many ways to fail that don&#39;t matter that much</span>
 617             <span class="k">return</span> <span class="bp">None</span>
 618 </div>
 619 <span class="nd">@eintr_retry</span>
 620 <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>
 621         <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 622         <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 623         <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 624         <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 625         <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 626         <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 627         <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 628         <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 629         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 630     <span class="sd">&quot;&quot;&quot;</span>
 631 <span class="sd">    Returns a code representing the the status of a remote process</span>
 632
 633 <span class="sd">        :param pid: Process id of the process</span>
 634 <span class="sd">        :type pid: int</span>
 635
 636 <span class="sd">        :param ppid: Parent process id of process</span>
 637 <span class="sd">        :type ppid: int</span>
 638 <span class="sd">    </span>
 639 <span class="sd">        :rtype: int (One of NOT_STARTED, RUNNING, FINISHED)</span>
 640 <span class="sd">    </span>
 641 <span class="sd">    &quot;&quot;&quot;</span>
 642     <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>
 643         <span class="c"># Check only by pid. pid+ppid does not always work (especially with sudo) </span>
 644         <span class="s">&quot; (( 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"> &amp;&amp; echo &#39;wait&#39;)  || echo &#39;done&#39; ) | tail -n 1&quot;</span> <span class="o">%</span> <span class="p">{</span>
 645             <span class="s">&#39;ppid&#39;</span> <span class="p">:</span> <span class="n">ppid</span><span class="p">,</span>
 646             <span class="s">&#39;pid&#39;</span> <span class="p">:</span> <span class="n">pid</span><span class="p">,</span>
 647         <span class="p">},</span>
 648         <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
 649         <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
 650         <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
 651         <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
 652         <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
 653         <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
 654         <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
 655         <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
 656         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
 657         <span class="p">)</span>
 658
 659     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">():</span>
 660         <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">NOT_STARTED</span>
 661
 662     <span class="n">status</span> <span class="o">=</span> <span class="bp">False</span>
 663     <span class="k">if</span> <span class="n">err</span><span class="p">:</span>
 664         <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">&quot;Error, do this: mount -t proc none /proc&quot;</span><span class="p">)</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">:</span>
 665             <span class="n">status</span> <span class="o">=</span> <span class="bp">True</span>
 666     <span class="k">elif</span> <span class="n">out</span><span class="p">:</span>
 667         <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">&#39;wait&#39;</span><span class="p">)</span>
 668     <span class="k">else</span><span class="p">:</span>
 669         <span class="k">return</span> <span class="n">ProcStatus</span><span class="o">.</span><span class="n">NOT_STARTED</span>
 670     <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>
 671 </div>
 672 <span class="nd">@eintr_retry</span>
 673 <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>
 674         <span class="n">host</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 675         <span class="n">port</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 676         <span class="n">user</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 677         <span class="n">gwuser</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 678         <span class="n">gw</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 679         <span class="n">agent</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 680         <span class="n">sudo</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 681         <span class="n">identity</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 682         <span class="n">server_key</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 683         <span class="n">nowait</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span>
 684         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 685     <span class="sd">&quot;&quot;&quot;</span>
 686 <span class="sd">    Sends a kill signal to a remote process.</span>
 687
 688 <span class="sd">    First tries a SIGTERM, and if the process does not end in 10 seconds,</span>
 689 <span class="sd">    it sends a SIGKILL.</span>
 690 <span class="sd"> </span>
 691 <span class="sd">        :param pid: Process id of process to be killed</span>
 692 <span class="sd">        :type pid: int</span>
 693
 694 <span class="sd">        :param ppid: Parent process id of process to be killed</span>
 695 <span class="sd">        :type ppid: int</span>
 696
 697 <span class="sd">        :param sudo: Flag indicating if sudo should be used to kill the process</span>
 698 <span class="sd">        :type sudo: bool</span>
 699 <span class="sd">        </span>
 700 <span class="sd">    &quot;&quot;&quot;</span>
 701     <span class="n">subkill</span> <span class="o">=</span> <span class="s">&quot;$(ps --ppid </span><span class="si">%(pid)d</span><span class="s"> -o pid h)&quot;</span> <span class="o">%</span> <span class="p">{</span> <span class="s">&#39;pid&#39;</span> <span class="p">:</span> <span class="n">pid</span> <span class="p">}</span>
 702     <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;</span>
 703 <span class="s">SUBKILL=&quot;</span><span class="si">%(subkill)s</span><span class="s">&quot; ;</span>
 704 <span class="si">%(sudo)s</span><span class="s"> kill -- -</span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 705 <span class="si">%(sudo)s</span><span class="s"> kill </span><span class="si">%(pid)d</span><span class="s"> $SUBKILL || /bin/true</span>
 706 <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>
 707 <span class="s">    sleep 0.2 </span>
 708 <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">` == &#39;0&#39; ]; then</span>
 709 <span class="s">        break</span>
 710 <span class="s">    else</span>
 711 <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>
 712 <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>
 713 <span class="s">    fi</span>
 714 <span class="s">    sleep 1.8</span>
 715 <span class="s">done</span>
 716 <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">` != &#39;0&#39; ]; then</span>
 717 <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>
 718 <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>
 719 <span class="s">fi</span>
 720 <span class="s">&quot;&quot;&quot;</span>
 721     <span class="k">if</span> <span class="n">nowait</span><span class="p">:</span>
 722         <span class="n">cmd</span> <span class="o">=</span> <span class="s">&quot;( </span><span class="si">%s</span><span class="s"> ) &gt;/dev/null 2&gt;/dev/null &lt;/dev/null &amp;&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">cmd</span><span class="p">,)</span>
 723
 724     <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>
 725         <span class="n">cmd</span> <span class="o">%</span> <span class="p">{</span>
 726             <span class="s">&#39;ppid&#39;</span> <span class="p">:</span> <span class="n">ppid</span><span class="p">,</span>
 727             <span class="s">&#39;pid&#39;</span> <span class="p">:</span> <span class="n">pid</span><span class="p">,</span>
 728             <span class="s">&#39;sudo&#39;</span> <span class="p">:</span> <span class="s">&#39;sudo -S&#39;</span> <span class="k">if</span> <span class="n">sudo</span> <span class="k">else</span> <span class="s">&#39;&#39;</span><span class="p">,</span>
 729             <span class="s">&#39;subkill&#39;</span> <span class="p">:</span> <span class="n">subkill</span><span class="p">,</span>
 730         <span class="p">},</span>
 731         <span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span>
 732         <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
 733         <span class="n">user</span> <span class="o">=</span> <span class="n">user</span><span class="p">,</span>
 734         <span class="n">gwuser</span> <span class="o">=</span> <span class="n">gwuser</span><span class="p">,</span>
 735         <span class="n">gw</span> <span class="o">=</span> <span class="n">gw</span><span class="p">,</span>
 736         <span class="n">agent</span> <span class="o">=</span> <span class="n">agent</span><span class="p">,</span>
 737         <span class="n">identity</span> <span class="o">=</span> <span class="n">identity</span><span class="p">,</span>
 738         <span class="n">server_key</span> <span class="o">=</span> <span class="n">server_key</span><span class="p">,</span>
 739         <span class="n">strict_host_checking</span> <span class="o">=</span> <span class="n">strict_host_checking</span>
 740         <span class="p">)</span>
 741
 742     <span class="c"># wait, don&#39;t leave zombies around</span>
 743     <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
 744
 745     <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>
 746 </div>
 747 <span class="k">def</span> <span class="nf">_retry_rexec</span><span class="p">(</span><span class="n">args</span><span class="p">,</span>
 748         <span class="n">log_msg</span><span class="p">,</span>
 749         <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>
 750         <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>
 751         <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>
 752         <span class="n">env</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 753         <span class="n">retry</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
 754         <span class="n">tmp_known_hosts</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
 755         <span class="n">blocking</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
 756
 757     <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>
 758         <span class="c"># connects to the remote host and starts a remote connection</span>
 759         <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>
 760                 <span class="n">env</span> <span class="o">=</span> <span class="n">env</span><span class="p">,</span>
 761                 <span class="n">stdout</span> <span class="o">=</span> <span class="n">stdout</span><span class="p">,</span>
 762                 <span class="n">stdin</span> <span class="o">=</span> <span class="n">stdin</span><span class="p">,</span>
 763                 <span class="n">stderr</span> <span class="o">=</span> <span class="n">stderr</span><span class="p">)</span>
 764
 765         <span class="c"># attach tempfile object to the process, to make sure the file stays</span>
 766         <span class="c"># alive until the process is finished with it</span>
 767         <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>
 768
 769         <span class="c"># The argument block == False forces to rexec to return immediately, </span>
 770         <span class="c"># without blocking </span>
 771         <span class="k">try</span><span class="p">:</span>
 772             <span class="n">err</span> <span class="o">=</span> <span class="n">out</span> <span class="o">=</span> <span class="s">&quot; &quot;</span>
 773             <span class="k">if</span> <span class="n">blocking</span><span class="p">:</span>
 774                 <span class="c">#(out, err) = proc.communicate()</span>
 775                 <span class="c"># The method communicate was re implemented for performance issues</span>
 776                 <span class="c"># when using python subprocess communicate method the ssh commands </span>
 777                 <span class="c"># last one minute each</span>
 778                 <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>
 779
 780             <span class="k">elif</span> <span class="n">stdout</span><span class="p">:</span>
 781                 <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>
 782                 <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>
 783                     <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>
 784
 785             <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>
 786
 787             <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">():</span>
 788                 <span class="n">skip</span> <span class="o">=</span> <span class="bp">False</span>
 789
 790                 <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">&#39;ssh: &#39;</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">&#39;mux_client_hello_exchange: &#39;</span><span class="p">):</span>
 791                     <span class="c"># SSH error, can safely retry</span>
 792                     <span class="n">skip</span> <span class="o">=</span> <span class="bp">True</span>
 793                 <span class="k">elif</span> <span class="n">retry</span><span class="p">:</span>
 794                     <span class="c"># Probably timed out or plain failed but can retry</span>
 795                     <span class="n">skip</span> <span class="o">=</span> <span class="bp">True</span>
 796
 797                 <span class="k">if</span> <span class="n">skip</span><span class="p">:</span>
 798                     <span class="n">t</span> <span class="o">=</span> <span class="n">x</span><span class="o">*</span><span class="mi">2</span>
 799                     <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot;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"> &quot;</span> <span class="o">%</span> <span class="p">(</span>
 800                             <span class="n">t</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="s">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">args</span><span class="p">))</span>
 801                     <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>
 802
 803                     <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>
 804                     <span class="k">continue</span>
 805             <span class="k">break</span>
 806         <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
 807             <span class="n">msg</span> <span class="o">=</span> <span class="s">&quot; rexec EXCEPTION - TIMEOUT -&gt; </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">&quot;</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>
 808             <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>
 809
 810             <span class="k">if</span> <span class="n">retry</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
 811                 <span class="k">raise</span>
 812             <span class="n">retry</span> <span class="o">-=</span> <span class="mi">1</span>
 813
 814     <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>
 815
 816 <span class="c"># POSIX</span>
 817 <span class="c"># Don&#39;t remove. The method communicate was re implemented for performance issues</span>
 818 <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>
 819     <span class="n">read_set</span> <span class="o">=</span> <span class="p">[]</span>
 820     <span class="n">write_set</span> <span class="o">=</span> <span class="p">[]</span>
 821     <span class="n">stdout</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># Return</span>
 822     <span class="n">stderr</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># Return</span>
 823
 824     <span class="n">killed</span> <span class="o">=</span> <span class="bp">False</span>
 825
 826     <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>
 827         <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>
 828         <span class="n">killtime</span> <span class="o">=</span> <span class="n">timelimit</span> <span class="o">+</span> <span class="mi">4</span>
 829         <span class="n">bailtime</span> <span class="o">=</span> <span class="n">timelimit</span> <span class="o">+</span> <span class="mi">4</span>
 830
 831     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdin</span><span class="p">:</span>
 832         <span class="c"># Flush stdio buffer.  This might block, if the user has</span>
 833         <span class="c"># been writing to .stdin in an uncontrolled fashion.</span>
 834         <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>
 835         <span class="k">if</span> <span class="nb">input</span><span class="p">:</span>
 836             <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>
 837         <span class="k">else</span><span class="p">:</span>
 838             <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>
 839
 840     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stdout</span><span class="p">:</span>
 841         <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>
 842         <span class="n">stdout</span> <span class="o">=</span> <span class="p">[]</span>
 843
 844     <span class="k">if</span> <span class="n">proc</span><span class="o">.</span><span class="n">stderr</span><span class="p">:</span>
 845         <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>
 846         <span class="n">stderr</span> <span class="o">=</span> <span class="p">[]</span>
 847
 848     <span class="n">input_offset</span> <span class="o">=</span> <span class="mi">0</span>
 849     <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>
 850         <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>
 851             <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>
 852             <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">&gt;</span> <span class="n">timelimit</span><span class="p">:</span>
 853                 <span class="k">if</span> <span class="n">curtime</span> <span class="o">&gt;</span> <span class="n">bailtime</span><span class="p">:</span>
 854                     <span class="k">break</span>
 855                 <span class="k">elif</span> <span class="n">curtime</span> <span class="o">&gt;</span> <span class="n">killtime</span><span class="p">:</span>
 856                     <span class="n">signum</span> <span class="o">=</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGKILL</span>
 857                 <span class="k">else</span><span class="p">:</span>
 858                     <span class="n">signum</span> <span class="o">=</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span>
 859                 <span class="c"># Lets kill it</span>
 860                 <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>
 861                 <span class="n">select_timeout</span> <span class="o">=</span> <span class="mf">0.5</span>
 862             <span class="k">else</span><span class="p">:</span>
 863                 <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>
 864         <span class="k">else</span><span class="p">:</span>
 865             <span class="n">select_timeout</span> <span class="o">=</span> <span class="mf">1.0</span>
 866
 867         <span class="k">if</span> <span class="n">select_timeout</span> <span class="o">&gt;</span> <span class="mf">1.0</span><span class="p">:</span>
 868             <span class="n">select_timeout</span> <span class="o">=</span> <span class="mf">1.0</span>
 869
 870         <span class="k">try</span><span class="p">:</span>
 871             <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>
 872         <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>
 873             <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>
 874                 <span class="k">raise</span>
 875             <span class="k">else</span><span class="p">:</span>
 876                 <span class="k">continue</span>
 877
 878         <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>
 879             <span class="c"># timeout and process exited, say bye</span>
 880             <span class="k">break</span>
 881
 882         <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>
 883             <span class="c"># When select has indicated that the file is writable,</span>
 884             <span class="c"># we can write up to PIPE_BUF bytes without risk</span>
 885             <span class="c"># blocking.  POSIX defines PIPE_BUF &gt;= 512</span>
 886             <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>
 887                     <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>
 888             <span class="n">input_offset</span> <span class="o">+=</span> <span class="n">bytes_written</span>
 889
 890             <span class="k">if</span> <span class="n">input_offset</span> <span class="o">&gt;=</span> <span class="nb">len</span><span class="p">(</span><span class="nb">input</span><span class="p">):</span>
 891                 <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>
 892                 <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>
 893
 894         <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>
 895             <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>
 896             <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="s">&quot;&quot;</span><span class="p">:</span>
 897                 <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>
 898                 <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>
 899             <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>
 900
 901         <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>
 902             <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>
 903             <span class="k">if</span> <span class="n">data</span> <span class="o">==</span> <span class="s">&quot;&quot;</span><span class="p">:</span>
 904                 <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>
 905                 <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>
 906             <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>
 907
 908     <span class="c"># All data exchanged.  Translate lists into strings.</span>
 909     <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>
 910         <span class="n">stdout</span> <span class="o">=</span> <span class="s">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">stdout</span><span class="p">)</span>
 911     <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>
 912         <span class="n">stderr</span> <span class="o">=</span> <span class="s">&#39;&#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">stderr</span><span class="p">)</span>
 913
 914     <span class="c"># Translate newlines, if requested.  We cannot let the file</span>
 915     <span class="c"># object do the translation: It is based on stdio, which is</span>
 916     <span class="c"># impossible to combine with select (unless forcing no</span>
 917     <span class="c"># buffering).</span>
 918     <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">&#39;newlines&#39;</span><span class="p">):</span>
 919         <span class="k">if</span> <span class="n">stdout</span><span class="p">:</span>
 920             <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>
 921         <span class="k">if</span> <span class="n">stderr</span><span class="p">:</span>
 922             <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>
 923
 924     <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>
 925         <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>
 926         <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="p">(</span><span class="s">&quot;Operation timed out&quot;</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>
 927     <span class="k">else</span><span class="p">:</span>
 928         <span class="k">if</span> <span class="n">killed</span><span class="p">:</span>
 929             <span class="n">proc</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span>
 930         <span class="k">else</span><span class="p">:</span>
 931             <span class="n">proc</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
 932         <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>
 933
 934 <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>
 935     <span class="sd">&quot;&quot;&quot;</span>
 936 <span class="sd">    Constructs the SSH ProxyCommand option to add to the SSH command to connect</span>
 937 <span class="sd">    via a proxy</span>
 938 <span class="sd">        :param gw: SSH proxy hostname</span>
 939 <span class="sd">        :type gw:  str </span>
 940 <span class="sd">       </span>
 941 <span class="sd">        :param gwuser: SSH proxy username</span>
 942 <span class="sd">        :type gwuser:  str</span>
 943
 944 <span class="sd">        :param gwidentity: SSH proxy identity file </span>
 945 <span class="sd">        :type gwidentity:  str</span>
 946
 947 <span class="sd">  </span>
 948 <span class="sd">        :rtype: str </span>
 949 <span class="sd">        </span>
 950 <span class="sd">        returns the SSH ProxyCommand option.</span>
 951 <span class="sd">    &quot;&quot;&quot;</span>
 952
 953     <span class="n">proxycommand</span> <span class="o">=</span> <span class="s">&#39;ProxyCommand=ssh -q &#39;</span>
 954     <span class="k">if</span> <span class="n">gwidentity</span><span class="p">:</span>
 955         <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">&#39;-i </span><span class="si">%s</span><span class="s"> &#39;</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>
 956     <span class="k">if</span> <span class="n">gwuser</span><span class="p">:</span>
 957         <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">&#39;</span><span class="si">%s</span><span class="s">&#39;</span> <span class="o">%</span> <span class="n">gwuser</span>
 958     <span class="k">else</span><span class="p">:</span>
 959         <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">&#39;</span><span class="si">%r</span><span class="s">&#39;</span>
 960     <span class="n">proxycommand</span> <span class="o">+=</span> <span class="s">&#39;@</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&#39;</span> <span class="o">%</span> <span class="n">gw</span>
 961
 962     <span class="k">return</span> <span class="n">proxycommand</span>
 963 </pre></div>
 964
 965           </div>
 966         </div>
 967       </div>
 968       <div class="clearer"></div>
 969     </div>
 970     <div class="related">
 971       <h3>Navigation</h3>
 972       <ul>
 973         <li class="right" style="margin-right: 10px">
 974           <a href="../../../genindex.html" title="General Index"
 975              >index</a></li>
 976         <li class="right" >
 977           <a href="../../../py-modindex.html" title="Python Module Index"
 978              >modules</a> |</li>
 979         <li><a href="../../../index.html">NEPI 3.0 documentation</a> &raquo;</li>
 980           <li><a href="../../index.html" >Module code</a> &raquo;</li>
 981       </ul>
 982     </div>
 983     <div class="footer">
 984         &copy; Copyright 2014, Alina Quereilhac, Lucia Guevgeozian Odizzio, Julien Tribino.
 985       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
 986     </div>
 987   </body>
 988 </html>