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

293 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.onionrcommands.pubkeymanager 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.onionrcommands.pubkeymanager</code></h1>
</header>
<section id="section-intro">
<p>Onionr - Private P2P Communication</p>
<p>This module defines user ID-related CLI commands</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
Onionr - Private P2P Communication
This module defines user ID-related CLI commands
&#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;
import sys, getpass
import unpaddedbase32
import vanityonionr
import mnemonic
import logger, onionrexceptions
from onionrutils import stringvalidators, bytesconverter
from onionrusers import onionrusers, contactmanager
import config
from coredb import keydb
import keymanager, onionrcrypto
from etc import onionrvalues
DETERMINISTIC_REQUIREMENT = onionrvalues.PASSWORD_LENGTH
def add_ID():
key_manager = keymanager.KeyManager()
try:
sys.argv[2]
if not sys.argv[2].lower() == &#39;true&#39;: raise ValueError
except (IndexError, ValueError) as e:
newID = key_manager.addKey()[0]
else:
logger.warn(&#39;Deterministic keys require random and long passphrases.&#39;, terminal=True)
logger.warn(&#39;If a good passphrase is not used, your key can be easily stolen.&#39;, terminal=True)
logger.warn(&#39;You should use a series of hard to guess words, see this for reference: https://www.xkcd.com/936/&#39;, terminal=True)
try:
pass1 = getpass.getpass(prompt=&#39;Enter at least %s characters: &#39; % (DETERMINISTIC_REQUIREMENT,))
pass2 = getpass.getpass(prompt=&#39;Confirm entry: &#39;)
except KeyboardInterrupt:
sys.exit(42)
if onionrcrypto.cryptoutils.safe_compare(pass1, pass2):
try:
logger.info(&#39;Generating deterministic key. This can take a while.&#39;, terminal=True)
newID, privKey = onionrcrypto.generate_deterministic(pass1)
except onionrexceptions.PasswordStrengthError:
logger.error(&#39;Passphrase must use at least %s characters.&#39; % (DETERMINISTIC_REQUIREMENT,), terminal=True)
sys.exit(1)
else:
logger.error(&#39;Passwords do not match.&#39;, terminal=True)
sys.exit(1)
try:
key_manager.addKey(pubKey=newID,
privKey=privKey)
except ValueError:
logger.error(&#39;That ID is already available, you can change to it with the change-id command.&#39;, terminal=True)
return
logger.info(&#39;Added ID: %s&#39; % (bytesconverter.bytes_to_str(newID),), terminal=True)
add_ID.onionr_help = &#34;If the first argument is true, Onionr will show a deterministic generation prompt. Otherwise it will generate &amp; save a new random key pair.&#34;
def change_ID():
key_manager = keymanager.KeyManager()
try:
key = sys.argv[2]
key = unpaddedbase32.repad(key.encode()).decode()
except IndexError:
logger.warn(&#39;Specify pubkey to use&#39;, terminal=True)
else:
if stringvalidators.validate_pub_key(key):
key_list = key_manager.getPubkeyList()
if key in key_list or key.replace(&#39;=&#39;, &#39;&#39;) in key_list:
config.set(&#39;general.public_key&#39;, key)
config.save()
logger.info(&#39;Set active key to: %s&#39; % (key,), terminal=True)
logger.info(&#39;Restart Onionr if it is running.&#39;, terminal=True)
else:
logger.warn(&#39;That key does not exist&#39;, terminal=True)
else:
logger.warn(&#39;Invalid key %s&#39; % (key,), terminal=True)
change_ID.onionr_help = &#34;&lt;pubkey&gt;: Switches Onionr to use a different user ID key. You should immediately restart Onionr if it is running.&#34;
def add_vanity():
key_manager = keymanager.KeyManager()
tell = lambda tell: logger.info(tell, terminal=True)
words = &#39;&#39;
m = mnemonic.Mnemonic(&#39;english&#39;)
length = len(sys.argv) - 2
if length == 0: return
for i in range(2, len(sys.argv)):
words += &#39; &#39;
words += sys.argv[i]
try:
if length == 1:
tell(&#39;Finding vanity, this should only take a few moments.&#39;)
else:
tell(&#39;Finding vanity, this will probably take a really long time.&#39;)
try:
vanity = vanityonionr.find_multiprocess(words)
except ValueError:
logger.warn(&#39;Vanity words must be valid english bip39&#39;, terminal=True)
else:
b32_pub = unpaddedbase32.b32encode(vanity[0])
tell(&#39;Found vanity address:\n&#39; + m.to_mnemonic(vanity[0]))
tell(&#39;Base32 Public key: %s&#39; % (b32_pub.decode(),))
key_manager.addKey(b32_pub, unpaddedbase32.b32encode(vanity[1]))
except KeyboardInterrupt:
pass
add_vanity.onionr_help = &#34;&lt;space separated bip32 words&gt; - Generates and stores an Onionr vanity address (see https://github.com/trezor/python-mnemonic/blob/master/mnemonic/wordlist/english.txt)&#34;</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="onionr.onionrcommands.pubkeymanager.add_ID"><code class="name flex">
<span>def <span class="ident">add_ID</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def add_ID():
key_manager = keymanager.KeyManager()
try:
sys.argv[2]
if not sys.argv[2].lower() == &#39;true&#39;: raise ValueError
except (IndexError, ValueError) as e:
newID = key_manager.addKey()[0]
else:
logger.warn(&#39;Deterministic keys require random and long passphrases.&#39;, terminal=True)
logger.warn(&#39;If a good passphrase is not used, your key can be easily stolen.&#39;, terminal=True)
logger.warn(&#39;You should use a series of hard to guess words, see this for reference: https://www.xkcd.com/936/&#39;, terminal=True)
try:
pass1 = getpass.getpass(prompt=&#39;Enter at least %s characters: &#39; % (DETERMINISTIC_REQUIREMENT,))
pass2 = getpass.getpass(prompt=&#39;Confirm entry: &#39;)
except KeyboardInterrupt:
sys.exit(42)
if onionrcrypto.cryptoutils.safe_compare(pass1, pass2):
try:
logger.info(&#39;Generating deterministic key. This can take a while.&#39;, terminal=True)
newID, privKey = onionrcrypto.generate_deterministic(pass1)
except onionrexceptions.PasswordStrengthError:
logger.error(&#39;Passphrase must use at least %s characters.&#39; % (DETERMINISTIC_REQUIREMENT,), terminal=True)
sys.exit(1)
else:
logger.error(&#39;Passwords do not match.&#39;, terminal=True)
sys.exit(1)
try:
key_manager.addKey(pubKey=newID,
privKey=privKey)
except ValueError:
logger.error(&#39;That ID is already available, you can change to it with the change-id command.&#39;, terminal=True)
return
logger.info(&#39;Added ID: %s&#39; % (bytesconverter.bytes_to_str(newID),), terminal=True)</code></pre>
</details>
</dd>
<dt id="onionr.onionrcommands.pubkeymanager.add_vanity"><code class="name flex">
<span>def <span class="ident">add_vanity</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def add_vanity():
key_manager = keymanager.KeyManager()
tell = lambda tell: logger.info(tell, terminal=True)
words = &#39;&#39;
m = mnemonic.Mnemonic(&#39;english&#39;)
length = len(sys.argv) - 2
if length == 0: return
for i in range(2, len(sys.argv)):
words += &#39; &#39;
words += sys.argv[i]
try:
if length == 1:
tell(&#39;Finding vanity, this should only take a few moments.&#39;)
else:
tell(&#39;Finding vanity, this will probably take a really long time.&#39;)
try:
vanity = vanityonionr.find_multiprocess(words)
except ValueError:
logger.warn(&#39;Vanity words must be valid english bip39&#39;, terminal=True)
else:
b32_pub = unpaddedbase32.b32encode(vanity[0])
tell(&#39;Found vanity address:\n&#39; + m.to_mnemonic(vanity[0]))
tell(&#39;Base32 Public key: %s&#39; % (b32_pub.decode(),))
key_manager.addKey(b32_pub, unpaddedbase32.b32encode(vanity[1]))
except KeyboardInterrupt:
pass</code></pre>
</details>
</dd>
<dt id="onionr.onionrcommands.pubkeymanager.change_ID"><code class="name flex">
<span>def <span class="ident">change_ID</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def change_ID():
key_manager = keymanager.KeyManager()
try:
key = sys.argv[2]
key = unpaddedbase32.repad(key.encode()).decode()
except IndexError:
logger.warn(&#39;Specify pubkey to use&#39;, terminal=True)
else:
if stringvalidators.validate_pub_key(key):
key_list = key_manager.getPubkeyList()
if key in key_list or key.replace(&#39;=&#39;, &#39;&#39;) in key_list:
config.set(&#39;general.public_key&#39;, key)
config.save()
logger.info(&#39;Set active key to: %s&#39; % (key,), terminal=True)
logger.info(&#39;Restart Onionr if it is running.&#39;, terminal=True)
else:
logger.warn(&#39;That key does not exist&#39;, terminal=True)
else:
logger.warn(&#39;Invalid key %s&#39; % (key,), terminal=True)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
</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.onionrcommands" href="index.html">onionr.onionrcommands</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="onionr.onionrcommands.pubkeymanager.add_ID" href="#onionr.onionrcommands.pubkeymanager.add_ID">add_ID</a></code></li>
<li><code><a title="onionr.onionrcommands.pubkeymanager.add_vanity" href="#onionr.onionrcommands.pubkeymanager.add_vanity">add_vanity</a></code></li>
<li><code><a title="onionr.onionrcommands.pubkeymanager.change_ID" href="#onionr.onionrcommands.pubkeymanager.change_ID">change_ID</a></code></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>