mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 22:06:30 +01:00
194 lines
No EOL
10 KiB
HTML
194 lines
No EOL
10 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
||
<title>evennia.server.portal.ssl — Evennia 2.x documentation</title>
|
||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/language_data.js"></script>
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="evennia.server.portal.suppress_ga" href="evennia.server.portal.suppress_ga.html" />
|
||
<link rel="prev" title="evennia.server.portal.ssh" href="evennia.server.portal.ssh.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="right" >
|
||
<a href="evennia.server.portal.suppress_ga.html" title="evennia.server.portal.suppress_ga"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.server.portal.ssh.html" title="evennia.server.portal.ssh"
|
||
accesskey="P">previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.server.html" >evennia.server</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.server.portal.html" accesskey="U">evennia.server.portal</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.server.portal.ssl</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
|
||
<div class="documentwrapper">
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
|
||
</a></p>
|
||
<div 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" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="evennia.server.portal.ssh.html"
|
||
title="previous chapter">evennia.server.portal.ssh</a></p>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="evennia.server.portal.suppress_ga.html"
|
||
title="next chapter">evennia.server.portal.suppress_ga</a></p>
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.server.portal.ssl.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div><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>
|
||
<h3>Doc Versions</h3>
|
||
<ul>
|
||
|
||
<li><a href="evennia.server.portal.ssl.html">2.x (main branch)</a></li>
|
||
<ul>
|
||
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
|
||
|
||
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<section id="module-evennia.server.portal.ssl">
|
||
<span id="evennia-server-portal-ssl"></span><h1>evennia.server.portal.ssl<a class="headerlink" href="#module-evennia.server.portal.ssl" title="Permalink to this headline">¶</a></h1>
|
||
<p>This is a simple context factory for auto-creating
|
||
SSL keys and certificates.</p>
|
||
<dl class="py class">
|
||
<dt id="evennia.server.portal.ssl.SSLProtocol">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.portal.ssl.</code><code class="sig-name descname">SSLProtocol</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/ssl.html#SSLProtocol"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.ssl.SSLProtocol" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.server.portal.telnet.html#evennia.server.portal.telnet.TelnetProtocol" title="evennia.server.portal.telnet.TelnetProtocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.server.portal.telnet.TelnetProtocol</span></code></a></p>
|
||
<p>Communication is the same as telnet, except data transfer
|
||
is done with encryption.</p>
|
||
<dl class="py method">
|
||
<dt id="evennia.server.portal.ssl.SSLProtocol.__init__">
|
||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/ssl.html#SSLProtocol.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.ssl.SSLProtocol.__init__" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.server.portal.ssl.verify_SSL_key_and_cert">
|
||
<code class="sig-prename descclassname">evennia.server.portal.ssl.</code><code class="sig-name descname">verify_SSL_key_and_cert</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">keyfile</span></em>, <em class="sig-param"><span class="n">certfile</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/ssl.html#verify_SSL_key_and_cert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.ssl.verify_SSL_key_and_cert" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This function looks for RSA key and certificate in the current
|
||
directory. If files ssl.key and ssl.cert does not exist, they
|
||
are created.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt id="evennia.server.portal.ssl.getSSLContext">
|
||
<code class="sig-prename descclassname">evennia.server.portal.ssl.</code><code class="sig-name descname">getSSLContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/portal/ssl.html#getSSLContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.portal.ssl.getSSLContext" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This is called by the portal when creating the SSL context
|
||
server-side.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p><p><em>ssl_context (tuple)</em> –</p>
|
||
<dl class="simple">
|
||
<dt>A key and certificate that is either</dt><dd><p>existing previously or or created on the fly.</p>
|
||
</dd>
|
||
</dl>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</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="right" >
|
||
<a href="evennia.server.portal.suppress_ga.html" title="evennia.server.portal.suppress_ga"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<a href="evennia.server.portal.ssh.html" title="evennia.server.portal.ssh"
|
||
>previous</a> |</li>
|
||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> »</li>
|
||
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> »</li>
|
||
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> »</li>
|
||
<li class="nav-item nav-item-4"><a href="evennia.server.html" >evennia.server</a> »</li>
|
||
<li class="nav-item nav-item-5"><a href="evennia.server.portal.html" >evennia.server.portal</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">evennia.server.portal.ssl</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2023, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |