| Name | ssh-keygen JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | None |
| Summary | ssh-keygen in pure python with seeded key generation support |
| upload_time | 2024-07-14 08:43:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.0 |
| license | Copyright (c) 2024 John Ao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
feed
reader
tutorial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# ssh-keygen
This is a pure python implementation of `ed25519` key generation, with the support for seeded key generation so that you can create a pair of ssh keys from any string you like.
## Security & Disclaimer
The author of this project is **NOT** a cryptography expert and provide **ZERO** guarantee on the security of this tool.
**USE IT AT YOUR OWN RISK.**
To the best of the author's knowledge, this tool has the following characteristics:
* It may suffer from timing attacks, so the key generation process must not be timed by a potential attacker.
* After generation, the key pair is cryptographically safe to use:
* The private key cannot be recovered from the public key.
* The seed cannot be recovered from the public key or private key or both.
## Install
```bash
pip install ssh-keygen
```
## Usage
Generate a private/public key pair:
```bash
# Interactive mode (launch a key generation wizard)
python -m ssh_keygen
# Command line mode
# -s <seed_string> Option 1: use seed string
# -f <file> Option 2: use seed file
# --random Option 3: use random 256-bit string
# -o <path> Path to save the private key file
# -n <N=1024> The number of hash iterations for seed string
# Larger N is safer but takes more time.
# -C <comment> Comment for the generate key
python -m ssh_keygen -s "this is a seed string" -o "/path/to/save/private_key"
python -m ssh_keygen -f "/path/to/seed_file" -o "/path/to/save/private_key"
```
## Acknowledgements
This project refers to the following sources:
* `ed25519` python implementation: https://github.com/pyca/ed25519/blob/main/ed25519.py
* OpenSSH private key format: https://coolaj86.com/articles/the-openssh-private-key-format/
* `balloon` password hashing: https://github.com/nachonavarro/balloon-hashing/blob/master/balloon.py
Raw data
{
"_id": null,
"home_page": null,
"name": "ssh-keygen",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": null,
"keywords": "feed, reader, tutorial",
"author": null,
"author_email": "John Ao <johnao73thu@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/72/05aa088183d3bab59a5e07ab02215aa049876e09cf1b64e0e8c5d6daa92e/ssh_keygen-1.0.3.tar.gz",
"platform": null,
"description": "# ssh-keygen\r\nThis is a pure python implementation of `ed25519` key generation, with the support for seeded key generation so that you can create a pair of ssh keys from any string you like.\r\n\r\n## Security & Disclaimer\r\nThe author of this project is **NOT** a cryptography expert and provide **ZERO** guarantee on the security of this tool.\r\n\r\n**USE IT AT YOUR OWN RISK.**\r\n\r\nTo the best of the author's knowledge, this tool has the following characteristics:\r\n* It may suffer from timing attacks, so the key generation process must not be timed by a potential attacker.\r\n* After generation, the key pair is cryptographically safe to use:\r\n * The private key cannot be recovered from the public key.\r\n * The seed cannot be recovered from the public key or private key or both.\r\n\r\n## Install\r\n```bash\r\npip install ssh-keygen\r\n```\r\n\r\n## Usage\r\nGenerate a private/public key pair:\r\n\r\n```bash\r\n# Interactive mode (launch a key generation wizard)\r\npython -m ssh_keygen\r\n\r\n# Command line mode\r\n# -s <seed_string> Option 1: use seed string\r\n# -f <file> Option 2: use seed file\r\n# --random Option 3: use random 256-bit string\r\n# -o <path> Path to save the private key file\r\n# -n <N=1024> The number of hash iterations for seed string\r\n# Larger N is safer but takes more time.\r\n# -C <comment> Comment for the generate key\r\npython -m ssh_keygen -s \"this is a seed string\" -o \"/path/to/save/private_key\"\r\npython -m ssh_keygen -f \"/path/to/seed_file\" -o \"/path/to/save/private_key\"\r\n```\r\n\r\n## Acknowledgements\r\nThis project refers to the following sources:\r\n* `ed25519` python implementation: https://github.com/pyca/ed25519/blob/main/ed25519.py\r\n* OpenSSH private key format: https://coolaj86.com/articles/the-openssh-private-key-format/\r\n* `balloon` password hashing: https://github.com/nachonavarro/balloon-hashing/blob/master/balloon.py\r\n",
"bugtrack_url": null,
"license": "Copyright (c) 2024 John Ao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "ssh-keygen in pure python with seeded key generation support",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/John-Ao/python-ssh-keygen"
},
"split_keywords": [
"feed",
" reader",
" tutorial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a643276b6ab670917f76718e41728f61e457369eade602346fbda98ef16755a4",
"md5": "158008d7fb4cec5ff1c0adbdbda1caf8",
"sha256": "a1621b55422b9be80c5f1224e7a8332d07019886bea181bea5a812132282526c"
},
"downloads": -1,
"filename": "ssh_keygen-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "158008d7fb4cec5ff1c0adbdbda1caf8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 14537,
"upload_time": "2024-07-14T08:43:10",
"upload_time_iso_8601": "2024-07-14T08:43:10.449898Z",
"url": "https://files.pythonhosted.org/packages/a6/43/276b6ab670917f76718e41728f61e457369eade602346fbda98ef16755a4/ssh_keygen-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "857205aa088183d3bab59a5e07ab02215aa049876e09cf1b64e0e8c5d6daa92e",
"md5": "16ff3d9f92abc943eb3ffdfe2b6b5345",
"sha256": "aa72f49f1a0d1b9b2faed04877ac930920d7159d5861cd270236fac939bf01fb"
},
"downloads": -1,
"filename": "ssh_keygen-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "16ff3d9f92abc943eb3ffdfe2b6b5345",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 13471,
"upload_time": "2024-07-14T08:43:12",
"upload_time_iso_8601": "2024-07-14T08:43:12.176624Z",
"url": "https://files.pythonhosted.org/packages/85/72/05aa088183d3bab59a5e07ab02215aa049876e09cf1b64e0e8c5d6daa92e/ssh_keygen-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-14 08:43:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "John-Ao",
"github_project": "python-ssh-keygen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ssh-keygen"
}
