kev
/
Onionr
1
0
Fork 0
Code Issues 24 Pull Requests Projects Releases 2 Wiki Activity
Onionr/docs/html/onionr/httpapi/miscclientapi/endpoints.html

309 lines
16 KiB
HTML
Raw Normal View History

added auto generated api documentation
2019-09-23 23:20:14 +00:00
<!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.6.3" />
<title>onionr.httpapi.miscclientapi.endpoints 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{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.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>onionr.httpapi.miscclientapi.endpoints</code></h1>
</header>
<section id="section-intro">
<p>Onionr - Private P2P Communication</p>
<p>Misc client API endpoints too small to need their own file and that need access to the client api inst</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
Onionr - Private P2P Communication
Misc client API endpoints too small to need their own file and that need access to the client api inst
&#39;&#39;&#39;
&#39;&#39;&#39;
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 &lt;https://www.gnu.org/licenses/&gt;.
&#39;&#39;&#39;
from flask import Response, Blueprint, request, send_from_directory, abort
import unpaddedbase32
from httpapi import apiutils
import onionrcrypto, config
from netcontroller import NetController
from serializeddata import SerializedData
from onionrutils import mnemonickeys
from onionrutils import bytesconverter
from utils import reconstructhash
from onionrcommands import restartonionr
pub_key = onionrcrypto.pub_key.replace(&#39;=&#39;, &#39;&#39;)
class PrivateEndpoints:
def __init__(self, client_api):
private_endpoints_bp = Blueprint(&#39;privateendpoints&#39;, __name__)
self.private_endpoints_bp = private_endpoints_bp
@private_endpoints_bp.route(&#39;/www/&lt;path:path&gt;&#39;, endpoint=&#39;www&#39;)
def wwwPublic(path):
if not config.get(&#34;www.private.run&#34;, True):
abort(403)
return send_from_directory(config.get(&#39;www.private.path&#39;, &#39;static-data/www/private/&#39;), path)
@private_endpoints_bp.route(&#39;/hitcount&#39;)
def get_hit_count():
return Response(str(client_api.publicAPI.hitCount))
@private_endpoints_bp.route(&#39;/queueResponseAdd/&lt;name&gt;&#39;, methods=[&#39;post&#39;])
def queueResponseAdd(name):
# Responses from the daemon. TODO: change to direct var access instead of http endpoint
client_api.queueResponse[name] = request.form[&#39;data&#39;]
return Response(&#39;success&#39;)
@private_endpoints_bp.route(&#39;/queueResponse/&lt;name&gt;&#39;)
def queueResponse(name):
# Fetch a daemon queue response
resp = &#39;failure&#39;
try:
resp = client_api.queueResponse[name]
except KeyError:
pass
else:
del client_api.queueResponse[name]
if resp == &#39;failure&#39;:
return resp, 404
else:
return resp
@private_endpoints_bp.route(&#39;/ping&#39;)
def ping():
# Used to check if client api is working
return Response(&#34;pong!&#34;)
@private_endpoints_bp.route(&#39;/lastconnect&#39;)
def lastConnect():
return Response(str(client_api.publicAPI.lastRequest))
@private_endpoints_bp.route(&#39;/waitforshare/&lt;name&gt;&#39;, methods=[&#39;post&#39;])
def waitforshare(name):
&#39;&#39;&#39;Used to prevent the **public** api from sharing blocks we just created&#39;&#39;&#39;
if not name.isalnum(): raise ValueError(&#39;block hash needs to be alpha numeric&#39;)
name = reconstructhash.reconstruct_hash(name)
if name in client_api.publicAPI.hideBlocks:
client_api.publicAPI.hideBlocks.remove(name)
return Response(&#34;removed&#34;)
else:
client_api.publicAPI.hideBlocks.append(name)
return Response(&#34;added&#34;)
@private_endpoints_bp.route(&#39;/shutdown&#39;)
def shutdown():
return apiutils.shutdown.shutdown(client_api)
@private_endpoints_bp.route(&#39;/restartclean&#39;)
def restart_clean():
restartonionr.restart()
return Response(&#34;bye&#34;)
@private_endpoints_bp.route(&#39;/getstats&#39;)
def getStats():
# returns node stats
while True:
try:
return Response(client_api._too_many.get(SerializedData).get_stats())
except AttributeError as e:
pass
@private_endpoints_bp.route(&#39;/getuptime&#39;)
def showUptime():
return Response(str(client_api.getUptime()))
@private_endpoints_bp.route(&#39;/getActivePubkey&#39;)
def getActivePubkey():
return Response(pub_key)
@private_endpoints_bp.route(&#39;/getHumanReadable&#39;)
def getHumanReadableDefault():
return Response(mnemonickeys.get_human_readable_ID())
@private_endpoints_bp.route(&#39;/getHumanReadable/&lt;name&gt;&#39;)
def getHumanReadable(name):
name = unpaddedbase32.repad(bytesconverter.str_to_bytes(name))
return Response(mnemonickeys.get_human_readable_ID(name))
@private_endpoints_bp.route(&#39;/getBase32FromHumanReadable/&lt;words&gt;&#39;)
def get_base32_from_human_readable(words):
return Response(bytesconverter.bytes_to_str(mnemonickeys.get_base32(words)))
@private_endpoints_bp.route(&#39;/gettorsocks&#39;)
def get_tor_socks():
return Response(str(client_api._too_many.get(NetController).socksPort))</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="onionr.httpapi.miscclientapi.endpoints.PrivateEndpoints"><code class="flex name class">
<span>class <span class="ident">PrivateEndpoints</span></span>
<span>(</span><span>client_api)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">class PrivateEndpoints:
def __init__(self, client_api):
private_endpoints_bp = Blueprint(&#39;privateendpoints&#39;, __name__)
self.private_endpoints_bp = private_endpoints_bp
@private_endpoints_bp.route(&#39;/www/&lt;path:path&gt;&#39;, endpoint=&#39;www&#39;)
def wwwPublic(path):
if not config.get(&#34;www.private.run&#34;, True):
abort(403)
return send_from_directory(config.get(&#39;www.private.path&#39;, &#39;static-data/www/private/&#39;), path)
@private_endpoints_bp.route(&#39;/hitcount&#39;)
def get_hit_count():
return Response(str(client_api.publicAPI.hitCount))
@private_endpoints_bp.route(&#39;/queueResponseAdd/&lt;name&gt;&#39;, methods=[&#39;post&#39;])
def queueResponseAdd(name):
# Responses from the daemon. TODO: change to direct var access instead of http endpoint
client_api.queueResponse[name] = request.form[&#39;data&#39;]
return Response(&#39;success&#39;)
@private_endpoints_bp.route(&#39;/queueResponse/&lt;name&gt;&#39;)
def queueResponse(name):
# Fetch a daemon queue response
resp = &#39;failure&#39;
try:
resp = client_api.queueResponse[name]
except KeyError:
pass
else:
del client_api.queueResponse[name]
if resp == &#39;failure&#39;:
return resp, 404
else:
return resp
@private_endpoints_bp.route(&#39;/ping&#39;)
def ping():
# Used to check if client api is working
return Response(&#34;pong!&#34;)
@private_endpoints_bp.route(&#39;/lastconnect&#39;)
def lastConnect():
return Response(str(client_api.publicAPI.lastRequest))
@private_endpoints_bp.route(&#39;/waitforshare/&lt;name&gt;&#39;, methods=[&#39;post&#39;])
def waitforshare(name):
&#39;&#39;&#39;Used to prevent the **public** api from sharing blocks we just created&#39;&#39;&#39;
if not name.isalnum(): raise ValueError(&#39;block hash needs to be alpha numeric&#39;)
name = reconstructhash.reconstruct_hash(name)
if name in client_api.publicAPI.hideBlocks:
client_api.publicAPI.hideBlocks.remove(name)
return Response(&#34;removed&#34;)
else:
client_api.publicAPI.hideBlocks.append(name)
return Response(&#34;added&#34;)
@private_endpoints_bp.route(&#39;/shutdown&#39;)
def shutdown():
return apiutils.shutdown.shutdown(client_api)
@private_endpoints_bp.route(&#39;/restartclean&#39;)
def restart_clean():
restartonionr.restart()
return Response(&#34;bye&#34;)
@private_endpoints_bp.route(&#39;/getstats&#39;)
def getStats():
# returns node stats
while True:
try:
return Response(client_api._too_many.get(SerializedData).get_stats())
except AttributeError as e:
pass
@private_endpoints_bp.route(&#39;/getuptime&#39;)
def showUptime():
return Response(str(client_api.getUptime()))
@private_endpoints_bp.route(&#39;/getActivePubkey&#39;)
def getActivePubkey():
return Response(pub_key)
@private_endpoints_bp.route(&#39;/getHumanReadable&#39;)
def getHumanReadableDefault():
return Response(mnemonickeys.get_human_readable_ID())
@private_endpoints_bp.route(&#39;/getHumanReadable/&lt;name&gt;&#39;)
def getHumanReadable(name):
name = unpaddedbase32.repad(bytesconverter.str_to_bytes(name))
return Response(mnemonickeys.get_human_readable_ID(name))
@private_endpoints_bp.route(&#39;/getBase32FromHumanReadable/&lt;words&gt;&#39;)
def get_base32_from_human_readable(words):
return Response(bytesconverter.bytes_to_str(mnemonickeys.get_base32(words)))
@private_endpoints_bp.route(&#39;/gettorsocks&#39;)
def get_tor_socks():
return Response(str(client_api._too_many.get(NetController).socksPort))</code></pre>
</details>
</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="onionr.httpapi.miscclientapi" href="index.html">onionr.httpapi.miscclientapi</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="onionr.httpapi.miscclientapi.endpoints.PrivateEndpoints" href="#onionr.httpapi.miscclientapi.endpoints.PrivateEndpoints">PrivateEndpoints</a></code></h4>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</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>