411 lines
20 KiB
HTML
411 lines
20 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
|
|
<meta name="generator" content="pdoc 0.7.4" />
|
|
<title>src.apiservers.private API documentation</title>
|
|
<meta name="description" content="Onionr - Private P2P Communication …" />
|
|
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
|
|
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
|
|
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
|
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<article id="content">
|
|
<header>
|
|
<h1 class="title">Module <code>src.apiservers.private</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<p>Onionr - Private P2P Communication.</p>
|
|
<p>This file handles all incoming http requests to the client, using Flask</p>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">"""Onionr - Private P2P Communication.
|
|
|
|
This file handles all incoming http requests to the client, using Flask
|
|
"""
|
|
from typing import Dict
|
|
import hmac
|
|
|
|
import flask
|
|
from gevent.pywsgi import WSGIServer
|
|
|
|
from onionrutils import epoch
|
|
import httpapi
|
|
from filepaths import private_API_host_file
|
|
import logger
|
|
|
|
from etc import waitforsetvar
|
|
from . import register_private_blueprints
|
|
import config
|
|
from .. import public
|
|
"""
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
"""
|
|
|
|
|
|
class PrivateAPI:
|
|
"""Client HTTP api for controlling onionr and using UI."""
|
|
|
|
callbacks: Dict[str, Dict] = {'public': {}, 'private': {}}
|
|
|
|
def __init__(self):
|
|
"""Initialize the api server, preping variables for later use.
|
|
|
|
This initialization defines all of the API entry points
|
|
and handlers for the endpoints and errors
|
|
This also saves the used host (random localhost IP address)
|
|
to the data folder in host.txt
|
|
"""
|
|
self.config = config
|
|
|
|
self.startTime = epoch.get_epoch()
|
|
app = flask.Flask(__name__)
|
|
bind_port = int(config.get('client.client.port', 59496))
|
|
self.bindPort = bind_port
|
|
|
|
self.clientToken = config.get('client.webpassword')
|
|
|
|
self.host = httpapi.apiutils.setbindip.set_bind_IP(
|
|
private_API_host_file)
|
|
logger.info('Running api on %s:%s' % (self.host, self.bindPort))
|
|
self.httpServer = ''
|
|
|
|
self.queueResponse = {}
|
|
self.get_block_data = httpapi.apiutils.GetBlockData(self)
|
|
register_private_blueprints.register_private_blueprints(self, app)
|
|
httpapi.load_plugin_blueprints(app)
|
|
self.app = app
|
|
|
|
def start(self):
|
|
"""Start client gevent API web server with flask client app."""
|
|
waitforsetvar.wait_for_set_var(self, "_too_many")
|
|
fd_handler = httpapi.fdsafehandler.FDSafeHandler
|
|
self.publicAPI = self._too_many.get( # pylint: disable=E1101
|
|
public.PublicAPI)
|
|
self.httpServer = WSGIServer((self.host, self.bindPort),
|
|
self.app, log=None,
|
|
handler_class=fd_handler)
|
|
self.httpServer.serve_forever()
|
|
|
|
def setPublicAPIInstance(self, inst):
|
|
"""Dynamically set public API instance."""
|
|
self.publicAPI = inst
|
|
|
|
def validateToken(self, token):
|
|
"""Validate that the client token matches the given token.
|
|
|
|
Used to prevent CSRF and other attacks.
|
|
"""
|
|
if not self.clientToken:
|
|
logger.error("client password needs to be set")
|
|
return False
|
|
try:
|
|
return hmac.compare_digest(self.clientToken, token)
|
|
except TypeError:
|
|
return False
|
|
|
|
def getUptime(self) -> int:
|
|
"""Safely wait for uptime to be set and return it."""
|
|
while True:
|
|
try:
|
|
return epoch.get_epoch() - self.startTime
|
|
except (AttributeError, NameError):
|
|
# Don't error on race condition with startup
|
|
pass
|
|
|
|
def getBlockData(self, bHash, decrypt=False, raw=False,
|
|
headerOnly=False) -> bytes:
|
|
"""Returns block data bytes."""
|
|
return self.get_block_data.get_block_data(bHash,
|
|
decrypt=decrypt,
|
|
raw=raw,
|
|
headerOnly=headerOnly)</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
|
|
<dl>
|
|
<dt><code class="name"><a title="src.apiservers.private.register_private_blueprints" href="register_private_blueprints.html">src.apiservers.private.register_private_blueprints</a></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Onionr - Private P2P Communication …</p></section>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
<dt id="src.apiservers.private.PrivateAPI"><code class="flex name class">
|
|
<span>class <span class="ident">PrivateAPI</span></span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Client HTTP api for controlling onionr and using UI.</p>
|
|
<p>Initialize the api server, preping variables for later use.</p>
|
|
<p>This initialization defines all of the API entry points
|
|
and handlers for the endpoints and errors
|
|
This also saves the used host (random localhost IP address)
|
|
to the data folder in host.txt</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">class PrivateAPI:
|
|
"""Client HTTP api for controlling onionr and using UI."""
|
|
|
|
callbacks: Dict[str, Dict] = {'public': {}, 'private': {}}
|
|
|
|
def __init__(self):
|
|
"""Initialize the api server, preping variables for later use.
|
|
|
|
This initialization defines all of the API entry points
|
|
and handlers for the endpoints and errors
|
|
This also saves the used host (random localhost IP address)
|
|
to the data folder in host.txt
|
|
"""
|
|
self.config = config
|
|
|
|
self.startTime = epoch.get_epoch()
|
|
app = flask.Flask(__name__)
|
|
bind_port = int(config.get('client.client.port', 59496))
|
|
self.bindPort = bind_port
|
|
|
|
self.clientToken = config.get('client.webpassword')
|
|
|
|
self.host = httpapi.apiutils.setbindip.set_bind_IP(
|
|
private_API_host_file)
|
|
logger.info('Running api on %s:%s' % (self.host, self.bindPort))
|
|
self.httpServer = ''
|
|
|
|
self.queueResponse = {}
|
|
self.get_block_data = httpapi.apiutils.GetBlockData(self)
|
|
register_private_blueprints.register_private_blueprints(self, app)
|
|
httpapi.load_plugin_blueprints(app)
|
|
self.app = app
|
|
|
|
def start(self):
|
|
"""Start client gevent API web server with flask client app."""
|
|
waitforsetvar.wait_for_set_var(self, "_too_many")
|
|
fd_handler = httpapi.fdsafehandler.FDSafeHandler
|
|
self.publicAPI = self._too_many.get( # pylint: disable=E1101
|
|
public.PublicAPI)
|
|
self.httpServer = WSGIServer((self.host, self.bindPort),
|
|
self.app, log=None,
|
|
handler_class=fd_handler)
|
|
self.httpServer.serve_forever()
|
|
|
|
def setPublicAPIInstance(self, inst):
|
|
"""Dynamically set public API instance."""
|
|
self.publicAPI = inst
|
|
|
|
def validateToken(self, token):
|
|
"""Validate that the client token matches the given token.
|
|
|
|
Used to prevent CSRF and other attacks.
|
|
"""
|
|
if not self.clientToken:
|
|
logger.error("client password needs to be set")
|
|
return False
|
|
try:
|
|
return hmac.compare_digest(self.clientToken, token)
|
|
except TypeError:
|
|
return False
|
|
|
|
def getUptime(self) -> int:
|
|
"""Safely wait for uptime to be set and return it."""
|
|
while True:
|
|
try:
|
|
return epoch.get_epoch() - self.startTime
|
|
except (AttributeError, NameError):
|
|
# Don't error on race condition with startup
|
|
pass
|
|
|
|
def getBlockData(self, bHash, decrypt=False, raw=False,
|
|
headerOnly=False) -> bytes:
|
|
"""Returns block data bytes."""
|
|
return self.get_block_data.get_block_data(bHash,
|
|
decrypt=decrypt,
|
|
raw=raw,
|
|
headerOnly=headerOnly)</code></pre>
|
|
</details>
|
|
<h3>Class variables</h3>
|
|
<dl>
|
|
<dt id="src.apiservers.private.PrivateAPI.callbacks"><code class="name">var <span class="ident">callbacks</span></code></dt>
|
|
<dd>
|
|
<section class="desc"><p>dict() -> new empty dictionary
|
|
dict(mapping) -> new dictionary initialized from a mapping object's
|
|
(key, value) pairs
|
|
dict(iterable) -> new dictionary initialized as if via:
|
|
d = {}
|
|
for k, v in iterable:
|
|
d[k] = v
|
|
dict(**kwargs) -> new dictionary initialized with the name=value pairs
|
|
in the keyword argument list.
|
|
For example:
|
|
dict(one=1, two=2)</p></section>
|
|
</dd>
|
|
</dl>
|
|
<h3>Methods</h3>
|
|
<dl>
|
|
<dt id="src.apiservers.private.PrivateAPI.getBlockData"><code class="name flex">
|
|
<span>def <span class="ident">getBlockData</span></span>(<span>self, bHash, decrypt=False, raw=False, headerOnly=False)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Returns block data bytes.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def getBlockData(self, bHash, decrypt=False, raw=False,
|
|
headerOnly=False) -> bytes:
|
|
"""Returns block data bytes."""
|
|
return self.get_block_data.get_block_data(bHash,
|
|
decrypt=decrypt,
|
|
raw=raw,
|
|
headerOnly=headerOnly)</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="src.apiservers.private.PrivateAPI.getUptime"><code class="name flex">
|
|
<span>def <span class="ident">getUptime</span></span>(<span>self)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Safely wait for uptime to be set and return it.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def getUptime(self) -> int:
|
|
"""Safely wait for uptime to be set and return it."""
|
|
while True:
|
|
try:
|
|
return epoch.get_epoch() - self.startTime
|
|
except (AttributeError, NameError):
|
|
# Don't error on race condition with startup
|
|
pass</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="src.apiservers.private.PrivateAPI.setPublicAPIInstance"><code class="name flex">
|
|
<span>def <span class="ident">setPublicAPIInstance</span></span>(<span>self, inst)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Dynamically set public API instance.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def setPublicAPIInstance(self, inst):
|
|
"""Dynamically set public API instance."""
|
|
self.publicAPI = inst</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="src.apiservers.private.PrivateAPI.start"><code class="name flex">
|
|
<span>def <span class="ident">start</span></span>(<span>self)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Start client gevent API web server with flask client app.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def start(self):
|
|
"""Start client gevent API web server with flask client app."""
|
|
waitforsetvar.wait_for_set_var(self, "_too_many")
|
|
fd_handler = httpapi.fdsafehandler.FDSafeHandler
|
|
self.publicAPI = self._too_many.get( # pylint: disable=E1101
|
|
public.PublicAPI)
|
|
self.httpServer = WSGIServer((self.host, self.bindPort),
|
|
self.app, log=None,
|
|
handler_class=fd_handler)
|
|
self.httpServer.serve_forever()</code></pre>
|
|
</details>
|
|
</dd>
|
|
<dt id="src.apiservers.private.PrivateAPI.validateToken"><code class="name flex">
|
|
<span>def <span class="ident">validateToken</span></span>(<span>self, token)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Validate that the client token matches the given token.</p>
|
|
<p>Used to prevent CSRF and other attacks.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def validateToken(self, token):
|
|
"""Validate that the client token matches the given token.
|
|
|
|
Used to prevent CSRF and other attacks.
|
|
"""
|
|
if not self.clientToken:
|
|
logger.error("client password needs to be set")
|
|
return False
|
|
try:
|
|
return hmac.compare_digest(self.clientToken, token)
|
|
except TypeError:
|
|
return False</code></pre>
|
|
</details>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</article>
|
|
<nav id="sidebar">
|
|
<h1>Index</h1>
|
|
<div class="toc">
|
|
<ul></ul>
|
|
</div>
|
|
<ul id="index">
|
|
<li><h3>Super-module</h3>
|
|
<ul>
|
|
<li><code><a title="src.apiservers" href="../index.html">src.apiservers</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
|
|
<ul>
|
|
<li><code><a title="src.apiservers.private.register_private_blueprints" href="register_private_blueprints.html">src.apiservers.private.register_private_blueprints</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-classes">Classes</a></h3>
|
|
<ul>
|
|
<li>
|
|
<h4><code><a title="src.apiservers.private.PrivateAPI" href="#src.apiservers.private.PrivateAPI">PrivateAPI</a></code></h4>
|
|
<ul class="">
|
|
<li><code><a title="src.apiservers.private.PrivateAPI.callbacks" href="#src.apiservers.private.PrivateAPI.callbacks">callbacks</a></code></li>
|
|
<li><code><a title="src.apiservers.private.PrivateAPI.getBlockData" href="#src.apiservers.private.PrivateAPI.getBlockData">getBlockData</a></code></li>
|
|
<li><code><a title="src.apiservers.private.PrivateAPI.getUptime" href="#src.apiservers.private.PrivateAPI.getUptime">getUptime</a></code></li>
|
|
<li><code><a title="src.apiservers.private.PrivateAPI.setPublicAPIInstance" href="#src.apiservers.private.PrivateAPI.setPublicAPIInstance">setPublicAPIInstance</a></code></li>
|
|
<li><code><a title="src.apiservers.private.PrivateAPI.start" href="#src.apiservers.private.PrivateAPI.start">start</a></code></li>
|
|
<li><code><a title="src.apiservers.private.PrivateAPI.validateToken" href="#src.apiservers.private.PrivateAPI.validateToken">validateToken</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.4</a>.</p>
|
|
</footer>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad()</script>
|
|
</body>
|
|
</html> |