<!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.onionrsetup.dbcreator 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.onionrsetup.dbcreator</code></h1>
</header>
<section id="section-intro">
<p>Onionr - Private P2P Communication</p>
<p>DBCreator, creates sqlite3 databases used by Onionr</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
    Onionr - Private P2P Communication

    DBCreator, creates sqlite3 databases used by Onionr
&#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 sqlite3, os
from coredb import dbfiles
import filepaths

def createAddressDB():
    &#39;&#39;&#39;
        Generate the address database

        types:
            1: I2P b32 address
            2: Tor v2 (like facebookcorewwwi.onion)
            3: Tor v3
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.address_info_db):
        raise FileExistsError(&#34;Address database already exists&#34;)
    conn = sqlite3.connect(dbfiles.address_info_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE adders(
        address text,
        type int,
        knownPeer text,
        speed int,
        success int,
        powValue text,
        failure int,
        lastConnect int,
        lastConnectAttempt int,
        trust int,
        introduced int
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()

def createPeerDB():
    &#39;&#39;&#39;
        Generate the peer sqlite3 database and populate it with the peers table.
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.user_id_info_db):
        raise FileExistsError(&#34;User database already exists&#34;)
    # generate the peer database
    conn = sqlite3.connect(dbfiles.user_id_info_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE peers(
        ID text not null,
        name text,
        adders text,
        dateSeen not null,
        trust int,
        hashID text);
    &#39;&#39;&#39;)
    c.execute(&#39;&#39;&#39;CREATE TABLE forwardKeys(
    peerKey text not null,
    forwardKey text not null,
    date int not null,
    expire int not null
    );&#39;&#39;&#39;)
    conn.commit()
    conn.close()
    return

def createBlockDB():
    &#39;&#39;&#39;
        Create a database for blocks

        hash         - the hash of a block
        dateReceived - the date the block was recieved, not necessarily when it was created
        decrypted    - if we can successfully decrypt the block (does not describe its current state)
        dataType     - data type of the block
        dataFound    - if the data has been found for the block
        dataSaved    - if the data has been saved for the block
        sig    - optional signature by the author (not optional if author is specified)
        author       - multi-round partial sha3-256 hash of authors public key
        dateClaimed  - timestamp claimed inside the block, only as trustworthy as the block author is
        expire int   - block expire date in epoch
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.block_meta_db):
        raise FileExistsError(&#34;Block database already exists&#34;)
    conn = sqlite3.connect(dbfiles.block_meta_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE hashes(
        hash text not null,
        dateReceived int,
        decrypted int,
        dataType text,
        dataFound int,
        dataSaved int,
        sig text,
        author text,
        dateClaimed int,
        expire int
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()
    return

def createBlockDataDB():
    if os.path.exists(dbfiles.block_data_db):
        raise FileExistsError(&#34;Block data database already exists&#34;)
    else:
        if not os.path.exists(filepaths.block_data_location):
            os.mkdir(filepaths.block_data_location)
    conn = sqlite3.connect(dbfiles.block_data_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE blockData(
        hash text not null,
        data blob not null
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()

def createForwardKeyDB():
    &#39;&#39;&#39;
        Create the forward secrecy key db (*for *OUR* keys*)
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.forward_keys_db):
        raise FileExistsError(&#34;Block database already exists&#34;)
    conn = sqlite3.connect(dbfiles.forward_keys_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE myForwardKeys(
        peer text not null,
        publickey text not null,
        privatekey text not null,
        date int not null,
        expire int not null
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()
    return

def createDaemonDB():
    &#39;&#39;&#39;
        Create the daemon queue database
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.daemon_queue_db):
        raise FileExistsError(&#34;Daemon queue db already exists&#34;)
    conn = sqlite3.connect(dbfiles.daemon_queue_db, timeout=10)
    c = conn.cursor()
    # Create table
    c.execute(&#39;&#39;&#39;CREATE TABLE commands (id integer primary key autoincrement, command text, data text, date text, responseID text)&#39;&#39;&#39;)
    conn.commit()
    conn.close()

def create_blacklist_db():
    if os.path.exists(dbfiles.blacklist_db):
        raise FileExistsError(&#34;Blacklist db already exists&#34;)
    conn = sqlite3.connect(dbfiles.blacklist_db, timeout=10)
    c = conn.cursor()
    # Create table
    c.execute(&#39;&#39;&#39;CREATE TABLE blacklist(
            hash text primary key not null,
            dataType int,
            blacklistDate int,
            expire int
            );
        &#39;&#39;&#39;)
    conn.commit()
    conn.close()


create_funcs = [createAddressDB, createPeerDB, createBlockDB, createBlockDataDB, createForwardKeyDB, createDaemonDB, create_blacklist_db]</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="onionr.onionrsetup.dbcreator.createAddressDB"><code class="name flex">
<span>def <span class="ident">createAddressDB</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Generate the address database</p>
<p>types:
1: I2P b32 address
2: Tor v2 (like facebookcorewwwi.onion)
3: Tor v3</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def createAddressDB():
    &#39;&#39;&#39;
        Generate the address database

        types:
            1: I2P b32 address
            2: Tor v2 (like facebookcorewwwi.onion)
            3: Tor v3
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.address_info_db):
        raise FileExistsError(&#34;Address database already exists&#34;)
    conn = sqlite3.connect(dbfiles.address_info_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE adders(
        address text,
        type int,
        knownPeer text,
        speed int,
        success int,
        powValue text,
        failure int,
        lastConnect int,
        lastConnectAttempt int,
        trust int,
        introduced int
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()</code></pre>
</details>
</dd>
<dt id="onionr.onionrsetup.dbcreator.createBlockDB"><code class="name flex">
<span>def <span class="ident">createBlockDB</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Create a database for blocks</p>
<p>hash
- the hash of a block
dateReceived - the date the block was recieved, not necessarily when it was created
decrypted
- if we can successfully decrypt the block (does not describe its current state)
dataType
- data type of the block
dataFound
- if the data has been found for the block
dataSaved
- if the data has been saved for the block
sig
- optional signature by the author (not optional if author is specified)
author
- multi-round partial sha3-256 hash of authors public key
dateClaimed
- timestamp claimed inside the block, only as trustworthy as the block author is
expire int
- block expire date in epoch</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def createBlockDB():
    &#39;&#39;&#39;
        Create a database for blocks

        hash         - the hash of a block
        dateReceived - the date the block was recieved, not necessarily when it was created
        decrypted    - if we can successfully decrypt the block (does not describe its current state)
        dataType     - data type of the block
        dataFound    - if the data has been found for the block
        dataSaved    - if the data has been saved for the block
        sig    - optional signature by the author (not optional if author is specified)
        author       - multi-round partial sha3-256 hash of authors public key
        dateClaimed  - timestamp claimed inside the block, only as trustworthy as the block author is
        expire int   - block expire date in epoch
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.block_meta_db):
        raise FileExistsError(&#34;Block database already exists&#34;)
    conn = sqlite3.connect(dbfiles.block_meta_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE hashes(
        hash text not null,
        dateReceived int,
        decrypted int,
        dataType text,
        dataFound int,
        dataSaved int,
        sig text,
        author text,
        dateClaimed int,
        expire int
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()
    return</code></pre>
</details>
</dd>
<dt id="onionr.onionrsetup.dbcreator.createBlockDataDB"><code class="name flex">
<span>def <span class="ident">createBlockDataDB</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def createBlockDataDB():
    if os.path.exists(dbfiles.block_data_db):
        raise FileExistsError(&#34;Block data database already exists&#34;)
    else:
        if not os.path.exists(filepaths.block_data_location):
            os.mkdir(filepaths.block_data_location)
    conn = sqlite3.connect(dbfiles.block_data_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE blockData(
        hash text not null,
        data blob not null
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()</code></pre>
</details>
</dd>
<dt id="onionr.onionrsetup.dbcreator.createDaemonDB"><code class="name flex">
<span>def <span class="ident">createDaemonDB</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Create the daemon queue database</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def createDaemonDB():
    &#39;&#39;&#39;
        Create the daemon queue database
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.daemon_queue_db):
        raise FileExistsError(&#34;Daemon queue db already exists&#34;)
    conn = sqlite3.connect(dbfiles.daemon_queue_db, timeout=10)
    c = conn.cursor()
    # Create table
    c.execute(&#39;&#39;&#39;CREATE TABLE commands (id integer primary key autoincrement, command text, data text, date text, responseID text)&#39;&#39;&#39;)
    conn.commit()
    conn.close()</code></pre>
</details>
</dd>
<dt id="onionr.onionrsetup.dbcreator.createForwardKeyDB"><code class="name flex">
<span>def <span class="ident">createForwardKeyDB</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Create the forward secrecy key db (<em>for </em>OUR<em> keys</em>)</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def createForwardKeyDB():
    &#39;&#39;&#39;
        Create the forward secrecy key db (*for *OUR* keys*)
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.forward_keys_db):
        raise FileExistsError(&#34;Block database already exists&#34;)
    conn = sqlite3.connect(dbfiles.forward_keys_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE myForwardKeys(
        peer text not null,
        publickey text not null,
        privatekey text not null,
        date int not null,
        expire int not null
        );
    &#39;&#39;&#39;)
    conn.commit()
    conn.close()
    return</code></pre>
</details>
</dd>
<dt id="onionr.onionrsetup.dbcreator.createPeerDB"><code class="name flex">
<span>def <span class="ident">createPeerDB</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"><p>Generate the peer sqlite3 database and populate it with the peers table.</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def createPeerDB():
    &#39;&#39;&#39;
        Generate the peer sqlite3 database and populate it with the peers table.
    &#39;&#39;&#39;
    if os.path.exists(dbfiles.user_id_info_db):
        raise FileExistsError(&#34;User database already exists&#34;)
    # generate the peer database
    conn = sqlite3.connect(dbfiles.user_id_info_db)
    c = conn.cursor()
    c.execute(&#39;&#39;&#39;CREATE TABLE peers(
        ID text not null,
        name text,
        adders text,
        dateSeen not null,
        trust int,
        hashID text);
    &#39;&#39;&#39;)
    c.execute(&#39;&#39;&#39;CREATE TABLE forwardKeys(
    peerKey text not null,
    forwardKey text not null,
    date int not null,
    expire int not null
    );&#39;&#39;&#39;)
    conn.commit()
    conn.close()
    return</code></pre>
</details>
</dd>
<dt id="onionr.onionrsetup.dbcreator.create_blacklist_db"><code class="name flex">
<span>def <span class="ident">create_blacklist_db</span></span>(<span>)</span>
</code></dt>
<dd>
<section class="desc"></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def create_blacklist_db():
    if os.path.exists(dbfiles.blacklist_db):
        raise FileExistsError(&#34;Blacklist db already exists&#34;)
    conn = sqlite3.connect(dbfiles.blacklist_db, timeout=10)
    c = conn.cursor()
    # Create table
    c.execute(&#39;&#39;&#39;CREATE TABLE blacklist(
            hash text primary key not null,
            dataType int,
            blacklistDate int,
            expire int
            );
        &#39;&#39;&#39;)
    conn.commit()
    conn.close()</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.onionrsetup" href="index.html">onionr.onionrsetup</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="two-column">
<li><code><a title="onionr.onionrsetup.dbcreator.createAddressDB" href="#onionr.onionrsetup.dbcreator.createAddressDB">createAddressDB</a></code></li>
<li><code><a title="onionr.onionrsetup.dbcreator.createBlockDB" href="#onionr.onionrsetup.dbcreator.createBlockDB">createBlockDB</a></code></li>
<li><code><a title="onionr.onionrsetup.dbcreator.createBlockDataDB" href="#onionr.onionrsetup.dbcreator.createBlockDataDB">createBlockDataDB</a></code></li>
<li><code><a title="onionr.onionrsetup.dbcreator.createDaemonDB" href="#onionr.onionrsetup.dbcreator.createDaemonDB">createDaemonDB</a></code></li>
<li><code><a title="onionr.onionrsetup.dbcreator.createForwardKeyDB" href="#onionr.onionrsetup.dbcreator.createForwardKeyDB">createForwardKeyDB</a></code></li>
<li><code><a title="onionr.onionrsetup.dbcreator.createPeerDB" href="#onionr.onionrsetup.dbcreator.createPeerDB">createPeerDB</a></code></li>
<li><code><a title="onionr.onionrsetup.dbcreator.create_blacklist_db" href="#onionr.onionrsetup.dbcreator.create_blacklist_db">create_blacklist_db</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>