Metadata-Version: 2.1
Name: pyvserv
Version: 1.0.1
Summary: High power secure server with blockchain backend.
Home-page: https://github.com/pglen/pyvserv
Author: Peter Glen
Author-email: peterglen99@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyvpacker
Requires-Dist: pydbase
Requires-Dist: pycryptodome
Requires-Dist: pyvecc

#  PyvServer
## 	Python fully encrypted TCP/IP server

 &nbsp; &nbsp; PyvServ is an encrypting TCP/IP server written in Python. The
encryption algorithm is AES. (Advanced Encryption Standard) The server can be
fully administered from the protocol side. The key exchange uses ECC. (Elliptic curve)

## How to use, what it is for:

    Public Voting System Blockchain server.
    Charity administration, trust maintenance. (Zakat)
    Internal currency / resource maintenance.

#### Public Voting System Blockchain server.

  The system maintains an encrypted chain of vote events. Every entry has
the Voter ID, an Electronic ID, and the vote action (register / cast /
un-cast / withdraw)

  The voter ID is a number allocated by authorities, the Electronic ID is a
number allocated on initial login / registration by the system.
The Voter Block Chain and Electronic ID and vote is visible by the public,
so every voter can verify his / her participation. The voter ID
is visible by the electorate only.

  The blockchain may be replicated to independent hosts, so falsifying it
would require breaching multiple services.

 The blockchain visibility allows that every voter can verify their participation.
This also allows all parties to verify the chain, and create independent counts.

 The chain can  be verified for legitimate and singular registration. This system
crates accountability from both the voter sides and the electorate (authority's) side.

#### Charity administration, trust maintenance. (Zakat)

 The blockchain will allow the donation's public visibility and usage.

#### Internal resource / currency maintenance

 The blockchain will allow monitoring internal resource allocation / usage.

 &nbsp; &nbsp; PyvServ contains protocol level encryption, which can be switched on by
instructing the server to use an encryption (session) key.

 &nbsp; &nbsp; PyvServ contains a key exchange protocol, so the new session keys
can be transmitted securely. The key exchange is based on ECC.

 PyvServ has utilities to generate encryption keys. At least one
key needs to be generated before use. (now automatic) The server picks from
a pool of keys, so communication data is always distinctive. Make sure you
generate them with the 'pyvgenkeys' utility.

 PyvServ has blockchain empowered back end. The new data is linked to the
previous record. Utilities to verify the data are also provided.
(dbaseadm and chainadm)

 PyvServ has file upload / download capabilities with encrypted transport.

 PyvServ has replication facilities via a client based 'I have You have'
 mechanism featuring encrypted transport. It is also capable of replication
 on a 'replicate when received' mechanism. The replicated records are marked
 with a replication count, so replication does not enter looping. By default,
 the replicated records are not replicated any further, assuming a flat
 structure of replication.

 Project is still in motion, but a lot of it is usable.

#### Installation:

    pip install pyvserv

 Dependencies:

 Most linux systems already have all the dependencies by default. Some dependencies
 are added automatically on installation.

     pydbase, pyvpacker, pyvecc, pyvguicom

 The firewall needs to be opened for incoming connections on port xxxx

For example (assuming port 6666):

    sudo iptables -A INPUT -p tcp --dport 6666
    sudo iptables -A INPUT -p tcp --sport 6666

 Please note that this is not a recommendation, it is a port we used during development.

#### Platform:

    This project was developed on Ubuntu 22.x. Most linux distributions should work.

#### Working parts:

    Server.     subdir: pyvserver       -- Server has most of the commands done
    Client.     subdir: pyvclient       -- Exercise server commands / demo code
    Tool Suite. subdir: pyvtools        -- Key generation etc ...
    Test Suite. subdir: pyvclient/tests -- official pytest tests
    GUI base    subdir: pyvgui          -- Monitoring / administering the server
    Studies.    subdir: study           -- testing/learning subsystems (ignore it)

#### Quick start:

 One can mimic global connectivity on a single machine. This would allow the study
of the client / server interaction before live deployment. This chapter assumes
installation from github, replicating directory structure on the local drive.

    open terminal window
    navigate to the server's pyvserver subdir
    type ./pyvserv.py  -D

    The -D option stands for development mode. The server will not ask for
    2FA authentication.

    open another terminal window
    navigate to the pyvclient subdir
    type ./pyvcli_hello.py

The following (and more) should be printed on the command line:

    ./pyvcli_hello.py
    Server initial: ['OK', 'pyvserv 1.0 ready']
    resp ['OK', 'Hello', '6ccdaaf1-a22d-4140-9608-8fb93a8845af', '11812']
    Server quit response: ['OK', 'Bye', '11812']

Quick rundown of the above test:

1.) Server responds to connection
2.) Delivers OK status, hello message, server serial number, and a unique id
3.) Server signs off. This interaction is typical of all the commands.

 The unique ID the thread ID and it is not cryptographically secure;

 The best way to learn about the operation of the server is to look at the
sample client examples in the client source tree. (Files named pyvcli_*)

## Testing:

 All pytest cases pass. Note that the for the pytest client tests one needs to
 start the 'pyvserv.py' server.
 The server --port and --dataroot option can ba used to start the server in an alternate
 universe.  Please make sure it does not interfere with production.

   More test coming soon ....

    ============================= test session starts ==============================
    platform linux -- Python 3.10.12, pytest-7.4.3, pluggy-1.0.0
    rootdir: /home/peterglen/pgpygtk/pyvserv
    collected 9 items

    test_afirst.py .                                                         [ 11%]
    test_file.py .                                                           [ 22%]
    test_help.py .                                                           [ 33%]
    test_id.py .                                                             [ 44%]
    test_key.py .                                                            [ 55%]
    test_login.py .                                                          [ 66%]
    test_sess.py ..                                                          [ 88%]
    test_ver.py .                                                            [100%]

    ============================== 9 passed in 1.35s ===============================

Additional tests can be found in the test directory.

## Screen shots:

Screen shot of the Monitoring tool:

![Screen Shot](montool.png)

 This screen shot depicts the monitoring (control panel) application 'pyvcpanel'.
The top left area contains a live view of the pyvserver syslog. The top right
contains a live view of the replicator log.

 The bottom area of the window contains a live view of the incoming data, as it is
originally formatted, without the blockchain and hash details.

  All views monitor the live files, without interfering with any of the operations.

## History:

 Recent history kept, for the full list of changes consult the github site.

    1.0.0   Sun 03.Mar.2024    Beta ready
    1.0.0   Mon 11.Mar.2024    PIP installation with utils
    1.0.0   Wed 13.Mar.2024    rget rput and family (rget=BC record get)
    1.0.0   Thu 14.Mar.2024    Started GUI tools

Written by Peter Glen, 2022, 2023

// EOF
