openkts

Name	openkts JSON
Version	1.1.4 JSON
	download
home_page
Summary	Open Keyshare Threshold Scheme
upload_time	2024-02-12 12:10:09
maintainer
docs_url	None
author	Anthony Kruger
requires_python
license	MIT
keywords	keyshare
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            ## OPENKTS
An m of n key sharing solution.

### Features:
* Customizable split/join functionality
* Password protection on individual shares (uses Fernet)

### Usage:
*Depending on your dependencies/setup you might have to change <ins>__python__</ins> to <ins>__python3__</ins> below.*<br/>
<br/>Install Cryptography on the active environment</b>
<br/><code>python -m pip install cryptography</code>
<br/><br/>Install openkts to a targeted location</b>
<br/><code>pip install openkts --target="C:\tmp\openkts"</code>
<br/><br/>Go to the targeted directory before running openkts</b>
<br/><code>cd "C:\tmp\openkts"</code>
<br/><br/>Confirm that openkts is found</b>
<br/><code>python openkts -h</code>

<br/><ins><b>Split :</b></ins>&nbsp;&nbsp;<code>python openkts split -f "file_path" -m 3 -n 5 -e</code>

Property | Type | Description |
:---:|:---:|:---|
**-f** | <span style="color:#69cdff">STRING</span> | Filepath to file to be split into shares. |
**-m** | <span style="color:#69cdff">INT</span> | Minimum number of shares needed to reconstruct the file. |
**-n** | <span style="color:#69cdff">INT</span> | Total number of shares to split the file into. |
**-e** | NONE | <span style="color:#f57e42">[OPTIONAL]</span> Password encrypt shares when provided. |

<br/><ins><b>Join :</b></ins> &nbsp; &nbsp;<code>python openkts join -s "share_1" -s "share_2" -s "share_3" -o "out_file" -d</code>

Property | Type | Description |
:---:|:---:|:---|
**-s** | <span style="color:#69cdff">STRING</span> | <span style="color:#59db39">[REPEATABLE]</span> Filepath to one of the shares. |
**-o** | <span style="color:#69cdff">INT</span> | <span style="color:#f57e42">[OPTIONAL]</span> Output file path. |
**-d** | <span style="color:#69cdff">INT</span> | <span style="color:#f57e42">[OPTIONAL]</span> Password decrypt shares when provided. |

<br/>

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "openkts",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "keyshare",
    "author": "Anthony Kruger",
    "author_email": "devadmin@impression.cloud",
    "download_url": "https://files.pythonhosted.org/packages/19/a9/b3ddfdbcf6440356f4a4454f7cbe1a5e6845a6a42e0e93165fbc3647549b/openkts-1.1.4.tar.gz",
    "platform": null,
    "description": "## OPENKTS\r\nAn m of n key sharing solution.\r\n\r\n### Features:\r\n* Customizable split/join functionality\r\n* Password protection on individual shares (uses Fernet)\r\n\r\n### Usage:\r\n*Depending on your dependencies/setup you might have to change <ins>__python__</ins> to <ins>__python3__</ins> below.*<br/>\r\n<br/>Install Cryptography on the active environment</b>\r\n<br/><code>python -m pip install cryptography</code>\r\n<br/><br/>Install openkts to a targeted location</b>\r\n<br/><code>pip install openkts --target=\"C:\\tmp\\openkts\"</code>\r\n<br/><br/>Go to the targeted directory before running openkts</b>\r\n<br/><code>cd \"C:\\tmp\\openkts\"</code>\r\n<br/><br/>Confirm that openkts is found</b>\r\n<br/><code>python openkts -h</code>\r\n\r\n<br/><ins><b>Split :</b></ins>&nbsp;&nbsp;<code>python openkts split -f \"file_path\" -m 3 -n 5 -e</code>\r\n\r\nProperty | Type | Description |\r\n:---:|:---:|:---|\r\n**-f** | <span style=\"color:#69cdff\">STRING</span> | Filepath to file to be split into shares. |\r\n**-m** | <span style=\"color:#69cdff\">INT</span> | Minimum number of shares needed to reconstruct the file. |\r\n**-n** | <span style=\"color:#69cdff\">INT</span> | Total number of shares to split the file into. |\r\n**-e** | NONE | <span style=\"color:#f57e42\">[OPTIONAL]</span> Password encrypt shares when provided. |\r\n\r\n<br/><ins><b>Join :</b></ins> &nbsp; &nbsp;<code>python openkts join -s \"share_1\" -s \"share_2\" -s \"share_3\" -o \"out_file\" -d</code>\r\n\r\nProperty | Type | Description |\r\n:---:|:---:|:---|\r\n**-s** | <span style=\"color:#69cdff\">STRING</span> | <span style=\"color:#59db39\">[REPEATABLE]</span> Filepath to one of the shares. |\r\n**-o** | <span style=\"color:#69cdff\">INT</span> | <span style=\"color:#f57e42\">[OPTIONAL]</span> Output file path. |\r\n**-d** | <span style=\"color:#69cdff\">INT</span> | <span style=\"color:#f57e42\">[OPTIONAL]</span> Password decrypt shares when provided. |\r\n\r\n<br/>\r\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Open Keyshare Threshold Scheme",
    "version": "1.1.4",
    "project_urls": null,
    "split_keywords": [
        "keyshare"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "19a9b3ddfdbcf6440356f4a4454f7cbe1a5e6845a6a42e0e93165fbc3647549b",
                "md5": "09f145253e812ee3f5750b87c600a5df",
                "sha256": "84de0329c51b02ae0b31ec113542a7d5530372436fc978aa981c28890aae54f1"
            },
            "downloads": -1,
            "filename": "openkts-1.1.4.tar.gz",
            "has_sig": false,
            "md5_digest": "09f145253e812ee3f5750b87c600a5df",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8152,
            "upload_time": "2024-02-12T12:10:09",
            "upload_time_iso_8601": "2024-02-12T12:10:09.153613Z",
            "url": "https://files.pythonhosted.org/packages/19/a9/b3ddfdbcf6440356f4a4454f7cbe1a5e6845a6a42e0e93165fbc3647549b/openkts-1.1.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-12 12:10:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "openkts"
}