mirror of
https://github.com/evennia/evennia.git
synced 2026-04-02 14:07:16 +02:00
269 lines
No EOL
22 KiB
HTML
269 lines
No EOL
22 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.cred.portal — 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.cred.portal</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.cred.portal</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1"># -*- test-case-name: twisted.cred.test.test_cred -*-</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">The point of integration of application and authentication.</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">Callable</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">,</span> <span class="n">Type</span><span class="p">,</span> <span class="n">Union</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">Interface</span><span class="p">,</span> <span class="n">providedBy</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.cred</span><span class="w"> </span><span class="kn">import</span> <span class="n">error</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.cred.checkers</span><span class="w"> </span><span class="kn">import</span> <span class="n">ICredentialsChecker</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.cred.credentials</span><span class="w"> </span><span class="kn">import</span> <span class="n">ICredentials</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.internet</span><span class="w"> </span><span class="kn">import</span> <span class="n">defer</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">twisted.internet.defer</span><span class="w"> </span><span class="kn">import</span> <span class="n">Deferred</span><span class="p">,</span> <span class="n">maybeDeferred</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">failure</span><span class="p">,</span> <span class="n">reflect</span>
|
|
|
|
<span class="c1"># To say 'we need an Interface object', we have to say Type[Interface];</span>
|
|
<span class="c1"># although zope.interface has no type/instance distinctions within the</span>
|
|
<span class="c1"># implementation of Interface itself (subclassing it actually instantiates it),</span>
|
|
<span class="c1"># since mypy-zope treats Interface objects *as* types, this is how you have to</span>
|
|
<span class="c1"># treat it.</span>
|
|
<span class="n">_InterfaceItself</span> <span class="o">=</span> <span class="n">Type</span><span class="p">[</span><span class="n">Interface</span><span class="p">]</span>
|
|
|
|
<span class="c1"># This is the result shape for both IRealm.requestAvatar and Portal.login,</span>
|
|
<span class="c1"># although the former is optionally allowed to return synchronously and the</span>
|
|
<span class="c1"># latter must be Deferred.</span>
|
|
<span class="n">_requestResult</span> <span class="o">=</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">_InterfaceItself</span><span class="p">,</span> <span class="nb">object</span><span class="p">,</span> <span class="n">Callable</span><span class="p">[[],</span> <span class="kc">None</span><span class="p">]]</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">IRealm</span><span class="p">(</span><span class="n">Interface</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> The realm connects application-specific objects to the</span>
|
|
<span class="sd"> authentication system.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">requestAvatar</span><span class="p">(</span>
|
|
<span class="n">avatarId</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">[()]],</span> <span class="n">mind</span><span class="p">:</span> <span class="nb">object</span><span class="p">,</span> <span class="o">*</span><span class="n">interfaces</span><span class="p">:</span> <span class="n">_InterfaceItself</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">Deferred</span><span class="p">[</span><span class="n">_requestResult</span><span class="p">],</span> <span class="n">_requestResult</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return avatar which provides one of the given interfaces.</span>
|
|
|
|
<span class="sd"> @param avatarId: a string that identifies an avatar, as returned by</span>
|
|
<span class="sd"> L{ICredentialsChecker.requestAvatarId<twisted.cred.checkers.ICredentialsChecker.requestAvatarId>}</span>
|
|
<span class="sd"> (via a Deferred). Alternatively, it may be</span>
|
|
<span class="sd"> C{twisted.cred.checkers.ANONYMOUS}.</span>
|
|
<span class="sd"> @param mind: usually None. See the description of mind in</span>
|
|
<span class="sd"> L{Portal.login}.</span>
|
|
<span class="sd"> @param interfaces: the interface(s) the returned avatar should</span>
|
|
<span class="sd"> implement, e.g. C{IMailAccount}. See the description of</span>
|
|
<span class="sd"> L{Portal.login}.</span>
|
|
|
|
<span class="sd"> @returns: a deferred which will fire a tuple of (interface,</span>
|
|
<span class="sd"> avatarAspect, logout), or the tuple itself. The interface will be</span>
|
|
<span class="sd"> one of the interfaces passed in the 'interfaces' argument. The</span>
|
|
<span class="sd"> 'avatarAspect' will implement that interface. The 'logout' object</span>
|
|
<span class="sd"> is a callable which will detach the mind from the avatar.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
|
|
<div class="viewcode-block" id="Portal">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.Portal">[docs]</a>
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">Portal</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> A mediator between clients and a realm.</span>
|
|
|
|
<span class="sd"> A portal is associated with one Realm and zero or more credentials checkers.</span>
|
|
<span class="sd"> When a login is attempted, the portal finds the appropriate credentials</span>
|
|
<span class="sd"> checker for the credentials given, invokes it, and if the credentials are</span>
|
|
<span class="sd"> valid, retrieves the appropriate avatar from the Realm.</span>
|
|
|
|
<span class="sd"> This class is not intended to be subclassed. Customization should be done</span>
|
|
<span class="sd"> in the realm object and in the credentials checker objects.</span>
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="n">checkers</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">Interface</span><span class="p">],</span> <span class="n">ICredentialsChecker</span><span class="p">]</span>
|
|
|
|
<div class="viewcode-block" id="Portal.__init__">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.Portal.__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">realm</span><span class="p">:</span> <span class="n">IRealm</span><span class="p">,</span> <span class="n">checkers</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">ICredentialsChecker</span><span class="p">]</span> <span class="o">=</span> <span class="p">()</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Create a Portal to a L{IRealm}.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">realm</span> <span class="o">=</span> <span class="n">realm</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checkers</span> <span class="o">=</span> <span class="p">{}</span>
|
|
<span class="k">for</span> <span class="n">checker</span> <span class="ow">in</span> <span class="n">checkers</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">registerChecker</span><span class="p">(</span><span class="n">checker</span><span class="p">)</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="Portal.listCredentialsInterfaces">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.Portal.listCredentialsInterfaces">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">listCredentialsInterfaces</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">Interface</span><span class="p">]]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return list of credentials interfaces that can be used to login.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="Portal.registerChecker">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.Portal.registerChecker">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">registerChecker</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">checker</span><span class="p">:</span> <span class="n">ICredentialsChecker</span><span class="p">,</span> <span class="o">*</span><span class="n">credentialInterfaces</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">Interface</span><span class="p">]</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">credentialInterfaces</span><span class="p">:</span>
|
|
<span class="n">credentialInterfaces</span> <span class="o">=</span> <span class="n">checker</span><span class="o">.</span><span class="n">credentialInterfaces</span>
|
|
<span class="k">for</span> <span class="n">credentialInterface</span> <span class="ow">in</span> <span class="n">credentialInterfaces</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">[</span><span class="n">credentialInterface</span><span class="p">]</span> <span class="o">=</span> <span class="n">checker</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="Portal.login">
|
|
<a class="viewcode-back" href="../../../api/evennia.server.portal.ssh.html#evennia.server.portal.ssh.Portal.login">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">login</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="p">,</span> <span class="n">credentials</span><span class="p">:</span> <span class="n">ICredentials</span><span class="p">,</span> <span class="n">mind</span><span class="p">:</span> <span class="nb">object</span><span class="p">,</span> <span class="o">*</span><span class="n">interfaces</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">Interface</span><span class="p">]</span>
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">Deferred</span><span class="p">[</span><span class="n">_requestResult</span><span class="p">]:</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> @param credentials: an implementor of</span>
|
|
<span class="sd"> L{twisted.cred.credentials.ICredentials}</span>
|
|
|
|
<span class="sd"> @param mind: an object which implements a client-side interface for</span>
|
|
<span class="sd"> your particular realm. In many cases, this may be None, so if the</span>
|
|
<span class="sd"> word 'mind' confuses you, just ignore it.</span>
|
|
|
|
<span class="sd"> @param interfaces: list of interfaces for the perspective that the mind</span>
|
|
<span class="sd"> wishes to attach to. Usually, this will be only one interface, for</span>
|
|
<span class="sd"> example IMailAccount. For highly dynamic protocols, however, this</span>
|
|
<span class="sd"> may be a list like (IMailAccount, IUserChooser, IServiceInfo). To</span>
|
|
<span class="sd"> expand: if we are speaking to the system over IMAP, any information</span>
|
|
<span class="sd"> that will be relayed to the user MUST be returned as an</span>
|
|
<span class="sd"> IMailAccount implementor; IMAP clients would not be able to</span>
|
|
<span class="sd"> understand anything else. Any information about unusual status</span>
|
|
<span class="sd"> would have to be relayed as a single mail message in an</span>
|
|
<span class="sd"> otherwise-empty mailbox. However, in a web-based mail system, or a</span>
|
|
<span class="sd"> PB-based client, the ``mind'' object inside the web server</span>
|
|
<span class="sd"> (implemented with a dynamic page-viewing mechanism such as a</span>
|
|
<span class="sd"> Twisted Web Resource) or on the user's client program may be</span>
|
|
<span class="sd"> intelligent enough to respond to several ``server''-side</span>
|
|
<span class="sd"> interfaces.</span>
|
|
|
|
<span class="sd"> @return: A deferred which will fire a tuple of (interface,</span>
|
|
<span class="sd"> avatarAspect, logout). The interface will be one of the interfaces</span>
|
|
<span class="sd"> passed in the 'interfaces' argument. The 'avatarAspect' will</span>
|
|
<span class="sd"> implement that interface. The 'logout' object is a callable which</span>
|
|
<span class="sd"> will detach the mind from the avatar. It must be called when the</span>
|
|
<span class="sd"> user has conceptually disconnected from the service. Although in</span>
|
|
<span class="sd"> some cases this will not be in connectionLost (such as in a</span>
|
|
<span class="sd"> web-based session), it will always be at the end of a user's</span>
|
|
<span class="sd"> interactive session.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">i</span><span class="o">.</span><span class="n">providedBy</span><span class="p">(</span><span class="n">credentials</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">maybeDeferred</span><span class="p">(</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">checkers</span><span class="p">[</span><span class="n">i</span><span class="p">]</span><span class="o">.</span><span class="n">requestAvatarId</span><span class="p">,</span> <span class="n">credentials</span>
|
|
<span class="p">)</span><span class="o">.</span><span class="n">addCallback</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">realm</span><span class="o">.</span><span class="n">requestAvatar</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="n">ifac</span> <span class="o">=</span> <span class="n">providedBy</span><span class="p">(</span><span class="n">credentials</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">defer</span><span class="o">.</span><span class="n">fail</span><span class="p">(</span>
|
|
<span class="n">failure</span><span class="o">.</span><span class="n">Failure</span><span class="p">(</span>
|
|
<span class="n">error</span><span class="o">.</span><span class="n">UnhandledCredentials</span><span class="p">(</span>
|
|
<span class="s2">"No checker for </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="s2">", "</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">reflect</span><span class="o">.</span><span class="n">qual</span><span class="p">,</span> <span class="n">ifac</span><span class="p">))</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="p">)</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.cred.portal</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> |