Console tools for working with Privateness service node.
Currently node and files services are supported.
Node service is for working with remote node.
Files service is for encrypted files storage.
All registration are done by Emercoin blockchain NVS.
All comunication between service node and client is encrypted and signed with ed25519 keypairs.
- Required Python 3.10 +
git clone https://github.com/NESS-Network/PrivatenessTools
pip install humanize requests pynacl pycryptodome prettytable validators lxml libxml2 libxslt
- Generate user (keygen.py)
- Register user in blockchain (
key.py nvsandkey.py worm) - Initialise local keys (key.py init)
- Update nodes list (nodes-update.py)
- Register in your node (python node.py set )
- Any command can be runned
python command.pyor./command
On service node all user files are stored in user's directory. There are no directories on service node, all user owned directories and real file names are stored on client. Here are the listin of files stored on service node:
user@robocop:~/Code/PrivatenessTools$ ./ls raw
*** list ***
+----------+------------------------------------------+---------+
| Filename | ID | Size |
+----------+------------------------------------------+---------+
| cgcu.94 | 84ac22776d99df2de55c4440609a7f9f9b73058c | 1244312 |
| dmsu.79 | 8c0f29eb08f96177188761490db9419c2b969d47 | 4690311 |
| gpte.61 | 782e579e92f85c2ed5526c1e418e5894dad4e2af | 4690023 |
| hnno.39 | b7e2187901e2257c3649b809c104186b66dc919a | 98531 |
| lgku.30 | 5672f1ec20b028f97903e5f2cb12a08b275e2230 | 1254024 |
| lpto.87 | 58cb5769261ac6f396e2c953b7c2298b010a9b1e | 4690023 |
| nlca.29 | 65bcf3ed2a7e241c4fce12012bc1cbc7b6882bae | 1244312 |
| swti.86 | f74010963816e7c4017f3a888e3b02849f3a4b47 | 6986349 |
| w.jpg | 3f272cb9774bb9ad22b27ffa8acce114ad6f1c46 | 1244296 |
| yyze.67 | 69f5855cb9f21f1144f0ec01142a6f80b5e235f3 | 3322 |
+----------+------------------------------------------+---------+
cgcu.94 is shadowname, this is a filename on service node, and a file is encrypted on client, each file is encrypted with it's own key. w.jpg is unencrypted file with custom shadowname=filename, this is a publicly shared file. Here is more informative file listing:
user@robocop:~/Code/PrivatenessTools$ ./ls
*** Contents of 4: /555/qwerty
+------------+----------+--------+---------+---------+-------------------------+
| Shadowname | Filename | Size | Cipher | Status | Filepath |
+------------+----------+--------+---------+---------+-------------------------+
| 5 | [..] | | | | |
| 6 | [pub] | | | | |
| cgcu.94 | w.jpg | 1.2 MB | salsa20 | On Node | /home/user/Videos/w.jpg |
+------------+----------+--------+---------+---------+-------------------------+
user@robocop:~/Code/PrivatenessTools$ ./cd 6
user@robocop:~/Code/PrivatenessTools$ ./ls
*** Contents of 6: /555/qwerty/pub
+------------+----------+--------+--------+---------+-------------------------+
| Shadowname | Filename | Size | Cipher | Status | Filepath |
+------------+----------+--------+--------+---------+-------------------------+
| 4 | [..] | | | | |
| w.jpg | w.jpg | 1.2 MB | | On Node | /home/user/Videos/w.jpg |
+------------+----------+--------+--------+---------+-------------------------+
4 5 and 6 are directory ID's linked to directory names all stored on client. cgcu.94 is encrypted file with original file name w.jpg and encrypted with salsa20 and uploaded from /home/user/Videos/w.jpg.
Here is fileinfo for both files:
user@robocop:~/Code/PrivatenessTools$ ./fileinfo cgcu.94
*** fileinfo ***
+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Param | value |
+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| File ID | 84ac22776d99df2de55c4440609a7f9f9b73058c |
| Filename | w.jpg |
| Shadowname | cgcu.94 |
| Status | On Node |
| Filesize (local) | 1.2 MB |
| Filesize (remote) | 1.2 MB |
| Filepath (local) | /home/user/Videos/w.jpg |
| Cipher | salsa20 |
| Encryption key | Dvw]>?gsf}gKa%Ivc1.Tv[K6k8SEVVv9 |
| Public link | http://node-xxx.net/files/pub/84ac22776d99df2de55c4440609a7f9f9b73058c-a48d3a94dd9981fa1a091acf96833abc-I7FZSCFN7WNGQEBGRHX6YBRQT2DGGKI3I7PY2IHOF6AWA2WI6TV5VMS5FKKKTZTSFWFDB3OK6E3G5DLV7MPNBRUYCFJA3QKURHVIAAA= |
+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
user@robocop:~/Code/PrivatenessTools$ ./fileinfo w.jpg
*** fileinfo ***
+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Param | value |
+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| File ID | 3f272cb9774bb9ad22b27ffa8acce114ad6f1c46 |
| Filename | w.jpg |
| Shadowname | w.jpg |
| Status | On Node |
| Filesize (local) | 1.2 MB |
| Filesize (remote) | 1.2 MB |
| Filepath (local) | /home/user/Videos/w.jpg |
| Cipher | |
| Encryption key | |
| Public link | http://node-xxx.net/files/pub/3f272cb9774bb9ad22b27ffa8acce114ad6f1c46-a48d3a94dd9981fa1a091acf96833abc-I7FZSCFN7WNGQEBGRHX6YBRQT2DGGKI3I7PY2IHOF6AWA2WI6TV5VMS5FKKKTZTSFWFDB3OK6E3G5DLV7MPNBRUYCFJA3QKURHVIAAA= |
+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
On client all keys are stored in ~/privateness-keys/*.json directory, directories are stored in directories.json and files are stored in files.json.
*** PrivateNess KEY GENERATOR
### DESCRIPTION:
Generates ciphers for NESS service nodes and NESS service node clients
Works on ed25519 for keypairs
Adjustable entropy when generating private keys
### USAGE:
#### Generate user
user <username> <Keypair count> "coma,separated,tags" <Entropy level>
Example: $ python keygen.py user user1 10 "Hello,World" 5
#### Generate node
node <Node URL> <Tariff> master-user-name "coma,separated,tags" <Entropy level>
Example: $ python keygen.py node http://my-node.net 111 master "Hello,World" 5
#### Change user's keypair
change <User Key File> <new keypair index>
Example: $ python keygen.py change user.key.json 2
#### Generate seed
seed <length> <Entropy level>
Example: $ python keygen.py seed 32 5
#### Show version
$ python codegen.py version
$ python codegen.py -v
#### Show this manual
$ python codegen.py help
$ python codegen.py -h
*** PrivateNess KEY UTILITY
### DESCRIPTION:
Privateness keys infrastructure management
### USAGE:
### List Keys
#### Show all contents of keyfile
list {dirpath]
### Show Key
#### Show all contents of keyfile
show <keyfile>
#### show nvs name (for blockchain)
nvs <keyfile>
#### Show <worm> for blockchain (if there are any)
worm <keyfile>
### Initialize local user keyfile (~/.privateness-keys/localuser.key.json) from main user keyfile
init <username.key.json>
### Initialize local node keyfile (node.json) from main node file
node <node-name.key.json>
#### Show all encrypted keys (if there are any)
list <keyfile>
### Pack keyfiles into encrypted keyfile
pack <keyfile1,keyfile2, ...> <encrypted keyfile>
### Unpack keyfiles from encrypted keyfile
unpack <encrypted keyfile>
### Save local keyfiles into encrypted keyfile
save <encrypted keyfile>
### Restore local keyfiles from encrypted keyfile
restore <encrypted keyfile>
### Eraise keyfile or all local keyfiles (fill with 0)
eraise [encrypted keyfile]
*** Remote nodes update UTILITY
### DESCRIPTION:
Service node list update from blockchain or remote node
### USAGE:
#### Update from blockchain (if RPC connection settings olready exist)
python nodes-update.py blockchain
python nodes-update.py blk
#### Update from blockchain (connect to Emercoin RPC and save connection settings)
python nodes-update.py blk rpc-host rpc-port rpc-user rpc-password
#### Update from remote node
python nodes-update.py node <remote-node-url>
#### Update from remote node (random node fron existing nodes list)
python nodes-update.py node
#### Auto update (try to update from random node, on error try to update from blockchain
python nodes-update.py
*** Node manipulation
### USAGE:
#### List all nodes (previously fetched from blockchain or remote node):
python node.py list
#### Set current node (you will be registered in that node):
python node.py set <node-name>
*** User manipulation
### USAGE:
#### Show information about current user (userinfo, balance, etc):
python user.py
#### Funds withdraw
TODO ...
*** User file usage quota
python quota.py
*** File upload
### USAGE:
#### Upload file on service node
python upload.py <path to your file to upload>
#### Upload and encrypt file on service node
python upload.py enc <path to your file to upload>
python upload.py encrypt <path to your file to upload>
#### Upload file on service node with filename=shadowname
python upload.py pub <path to your file to upload>
python upload.py public <path to your file to upload>
*** File download
### USAGE:
#### Download file from service node
python download.py <file_shadowname> [path]
*** File info
### USAGE:
python fileinfo.py <file_shadowname>
*** Move to other directory
### USAGE:
python move.py <File shadowname or Directory ID> <Directory ID>
TODO ...
*** Current directory listing
### USAGE:
#### List files (current directory)
python ls.py
#### RAW list files (as they are stored on service node)
python ls.py raw
*** File info
### USAGE:
python cd.py <Directory ID>
*** Create directory
### USAGE:
python mkdir.py <parent directory ID> <directory name>
*** Move to other directory
### USAGE:
python move.py <File shadowname or Directory ID> <Directory ID>
*** Directory tree
### USAGE:
#### List directories only
python tree.py
#### List directories with files
python tree.py files
TODO ...