mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 00:06:30 +01:00
263 lines
No EOL
23 KiB
HTML
263 lines
No EOL
23 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>twisted.conch.manhole_ssh — Evennia latest documentation</title>
|
|
<link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/nature.css?v=245aff17" />
|
|
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
|
<script src="../../../_static/documentation_options.js?v=c6e86fd7"></script>
|
|
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
</head><body>
|
|
|
|
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia latest</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">twisted.conch.manhole_ssh</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<search id="searchbox" style="display: none" role="search">
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
<div class="searchformwrapper">
|
|
<form class="search" action="../../../search.html" method="get">
|
|
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Links</h3>
|
|
<ul>
|
|
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
|
|
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
|
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
|
|
<li><a href="http://games.evennia.com">Game Index</a> </li>
|
|
<li>
|
|
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
|
|
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
|
|
<a href="https://evennia.blogspot.com/">Blog</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for twisted.conch.manhole_ssh</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># -*- test-case-name: twisted.conch.test.test_manhole -*-</span>
|
|
<span class="c1"># Copyright (c) Twisted Matrix Laboratories.</span>
|
|
<span class="c1"># See LICENSE for details.</span>
|
|
|
|
<span class="sd">"""</span>
|
|
<span class="sd">insults/SSH integration support.</span>
|
|
|
|
<span class="sd">@author: Jp Calderone</span>
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Dict</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">zope.interface</span><span class="w"> </span><span class="kn">import</span> <span class="n">implementer</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.conch</span><span class="w"> </span><span class="kn">import</span> <span class="n">avatar</span><span class="p">,</span> <span class="n">error</span> <span class="k">as</span> <span class="n">econch</span><span class="p">,</span> <span class="n">interfaces</span> <span class="k">as</span> <span class="n">iconch</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.conch.insults</span><span class="w"> </span><span class="kn">import</span> <span class="n">insults</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.conch.ssh</span><span class="w"> </span><span class="kn">import</span> <span class="n">factory</span><span class="p">,</span> <span class="n">session</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.python</span><span class="w"> </span><span class="kn">import</span> <span class="n">components</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">_Glue</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> A feeble class for making one attribute look like another.</span>
|
|
|
|
<span class="sd"> This should be replaced with a real class at some point, probably.</span>
|
|
<span class="sd"> Try not to write new code that uses it.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="vm">__dict__</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kw</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s2">"has no attribute"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">TerminalSessionTransport</span><span class="p">:</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">,</span> <span class="n">chainedProtocol</span><span class="p">,</span> <span class="n">avatar</span><span class="p">,</span> <span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">proto</span> <span class="o">=</span> <span class="n">proto</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">avatar</span> <span class="o">=</span> <span class="n">avatar</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">chainedProtocol</span> <span class="o">=</span> <span class="n">chainedProtocol</span>
|
|
|
|
<span class="n">protoSession</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">proto</span><span class="o">.</span><span class="n">session</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">proto</span><span class="o">.</span><span class="n">makeConnection</span><span class="p">(</span>
|
|
<span class="n">_Glue</span><span class="p">(</span>
|
|
<span class="n">write</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">chainedProtocol</span><span class="o">.</span><span class="n">dataReceived</span><span class="p">,</span>
|
|
<span class="n">loseConnection</span><span class="o">=</span><span class="k">lambda</span><span class="p">:</span> <span class="n">avatar</span><span class="o">.</span><span class="n">conn</span><span class="o">.</span><span class="n">sendClose</span><span class="p">(</span><span class="n">protoSession</span><span class="p">),</span>
|
|
<span class="n">name</span><span class="o">=</span><span class="s2">"SSH Proto Transport"</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">loseConnection</span><span class="p">():</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">proto</span><span class="o">.</span><span class="n">loseConnection</span><span class="p">()</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">chainedProtocol</span><span class="o">.</span><span class="n">makeConnection</span><span class="p">(</span>
|
|
<span class="n">_Glue</span><span class="p">(</span>
|
|
<span class="n">write</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">proto</span><span class="o">.</span><span class="n">write</span><span class="p">,</span>
|
|
<span class="n">loseConnection</span><span class="o">=</span><span class="n">loseConnection</span><span class="p">,</span>
|
|
<span class="n">name</span><span class="o">=</span><span class="s2">"Chained Proto Transport"</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="c1"># XXX TODO</span>
|
|
<span class="c1"># chainedProtocol is supposed to be an ITerminalTransport,</span>
|
|
<span class="c1"># maybe. That means perhaps its terminalProtocol attribute is</span>
|
|
<span class="c1"># an ITerminalProtocol, it could be. So calling terminalSize</span>
|
|
<span class="c1"># on that should do the right thing But it'd be nice to clean</span>
|
|
<span class="c1"># this bit up.</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">chainedProtocol</span><span class="o">.</span><span class="n">terminalProtocol</span><span class="o">.</span><span class="n">terminalSize</span><span class="p">(</span><span class="n">width</span><span class="p">,</span> <span class="n">height</span><span class="p">)</span>
|
|
|
|
|
|
<span class="nd">@implementer</span><span class="p">(</span><span class="n">iconch</span><span class="o">.</span><span class="n">ISession</span><span class="p">)</span>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">TerminalSession</span><span class="p">(</span><span class="n">components</span><span class="o">.</span><span class="n">Adapter</span><span class="p">):</span>
|
|
<span class="n">transportFactory</span> <span class="o">=</span> <span class="n">TerminalSessionTransport</span>
|
|
<span class="n">chainedProtocolFactory</span> <span class="o">=</span> <span class="n">insults</span><span class="o">.</span><span class="n">ServerProtocol</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">getPty</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">term</span><span class="p">,</span> <span class="n">windowSize</span><span class="p">,</span> <span class="n">attrs</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">height</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">width</span> <span class="o">=</span> <span class="n">windowSize</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">openShell</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">transportFactory</span><span class="p">(</span>
|
|
<span class="n">proto</span><span class="p">,</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">chainedProtocolFactory</span><span class="p">(),</span>
|
|
<span class="n">iconch</span><span class="o">.</span><span class="n">IConchUser</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">original</span><span class="p">),</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">width</span><span class="p">,</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">height</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">execCommand</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">,</span> <span class="n">cmd</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="n">econch</span><span class="o">.</span><span class="n">ConchError</span><span class="p">(</span><span class="s2">"Cannot execute commands"</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">windowChanged</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">newWindowSize</span><span class="p">):</span>
|
|
<span class="c1"># ISession.windowChanged</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"Unimplemented: TerminalSession.windowChanged"</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">eofReceived</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="c1"># ISession.eofReceived</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">"Unimplemented: TerminalSession.eofReceived"</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">closed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="c1"># ISession.closed</span>
|
|
<span class="k">pass</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">TerminalUser</span><span class="p">(</span><span class="n">avatar</span><span class="o">.</span><span class="n">ConchUser</span><span class="p">,</span> <span class="n">components</span><span class="o">.</span><span class="n">Adapter</span><span class="p">):</span>
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">original</span><span class="p">,</span> <span class="n">avatarId</span><span class="p">):</span>
|
|
<span class="n">components</span><span class="o">.</span><span class="n">Adapter</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">original</span><span class="p">)</span>
|
|
<span class="n">avatar</span><span class="o">.</span><span class="n">ConchUser</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">channelLookup</span><span class="p">[</span><span class="sa">b</span><span class="s2">"session"</span><span class="p">]</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">SSHSession</span>
|
|
|
|
|
|
<div class="viewcode-block" id="TerminalRealm">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.TerminalRealm">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">TerminalRealm</span><span class="p">:</span>
|
|
<span class="n">userFactory</span> <span class="o">=</span> <span class="n">TerminalUser</span>
|
|
<span class="n">sessionFactory</span> <span class="o">=</span> <span class="n">TerminalSession</span>
|
|
|
|
<span class="n">transportFactory</span> <span class="o">=</span> <span class="n">TerminalSessionTransport</span>
|
|
<span class="n">chainedProtocolFactory</span> <span class="o">=</span> <span class="n">insults</span><span class="o">.</span><span class="n">ServerProtocol</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_getAvatar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">avatarId</span><span class="p">):</span>
|
|
<span class="n">comp</span> <span class="o">=</span> <span class="n">components</span><span class="o">.</span><span class="n">Componentized</span><span class="p">()</span>
|
|
<span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">userFactory</span><span class="p">(</span><span class="n">comp</span><span class="p">,</span> <span class="n">avatarId</span><span class="p">)</span>
|
|
<span class="n">sess</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">sessionFactory</span><span class="p">(</span><span class="n">comp</span><span class="p">)</span>
|
|
|
|
<span class="n">sess</span><span class="o">.</span><span class="n">transportFactory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transportFactory</span>
|
|
<span class="n">sess</span><span class="o">.</span><span class="n">chainedProtocolFactory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">chainedProtocolFactory</span>
|
|
|
|
<span class="n">comp</span><span class="o">.</span><span class="n">setComponent</span><span class="p">(</span><span class="n">iconch</span><span class="o">.</span><span class="n">IConchUser</span><span class="p">,</span> <span class="n">user</span><span class="p">)</span>
|
|
<span class="n">comp</span><span class="o">.</span><span class="n">setComponent</span><span class="p">(</span><span class="n">iconch</span><span class="o">.</span><span class="n">ISession</span><span class="p">,</span> <span class="n">sess</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">user</span>
|
|
|
|
<div class="viewcode-block" id="TerminalRealm.__init__">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.TerminalRealm.__init__">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">transportFactory</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">transportFactory</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">transportFactory</span> <span class="o">=</span> <span class="n">transportFactory</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="TerminalRealm.requestAvatar">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.TerminalRealm.requestAvatar">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">requestAvatar</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">avatarId</span><span class="p">,</span> <span class="n">mind</span><span class="p">,</span> <span class="o">*</span><span class="n">interfaces</span><span class="p">):</span>
|
|
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">interfaces</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">i</span> <span class="ow">is</span> <span class="n">iconch</span><span class="o">.</span><span class="n">IConchUser</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">iconch</span><span class="o">.</span><span class="n">IConchUser</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_getAvatar</span><span class="p">(</span><span class="n">avatarId</span><span class="p">),</span> <span class="k">lambda</span><span class="p">:</span> <span class="kc">None</span><span class="p">)</span>
|
|
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="viewcode-block" id="ConchFactory">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.ConchFactory">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">ConchFactory</span><span class="p">(</span><span class="n">factory</span><span class="o">.</span><span class="n">SSHFactory</span><span class="p">):</span>
|
|
<span class="n">publicKeys</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
|
<span class="n">privateKeys</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">bytes</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
|
|
|
<div class="viewcode-block" id="ConchFactory.__init__">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.ConchFactory.__init__">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">portal</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">portal</span> <span class="o">=</span> <span class="n">portal</span></div>
|
|
</div>
|
|
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../../../index.html">Evennia latest</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">twisted.conch.manhole_ssh</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |