{"id":21447855,"url":"https://github.com/hsbc/encryption-helper-python","last_synced_at":"2025-07-14T20:30:53.014Z","repository":{"id":250342541,"uuid":"834118493","full_name":"hsbc/encryption-helper-python","owner":"hsbc","description":"A Python CLI application for generating RSA public and private key pairs.","archived":false,"fork":false,"pushed_at":"2024-11-11T21:22:19.000Z","size":730,"stargazers_count":1,"open_issues_count":3,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-11-11T22:26:20.065Z","etag":null,"topics":["automation","cryptography","data-protection","devops-tools","encryption","hsbc","key-generation","key-management","open-source","poetry-python","public-key","python","python-rsa","python-rsa-key-pairs-public-key-private-key","rsa","security"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hsbc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-26T13:06:58.000Z","updated_at":"2024-11-08T01:21:29.000Z","dependencies_parsed_at":"2024-07-29T20:20:07.162Z","dependency_job_id":"23d6a4e5-0eee-4646-b82e-98e9fd08b3a7","html_url":"https://github.com/hsbc/encryption-helper-python","commit_stats":null,"previous_names":["hsbc/encryption-helper-python"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsbc%2Fencryption-helper-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsbc%2Fencryption-helper-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsbc%2Fencryption-helper-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hsbc%2Fencryption-helper-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hsbc","download_url":"https://codeload.github.com/hsbc/encryption-helper-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225994783,"owners_count":17556830,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","cryptography","data-protection","devops-tools","encryption","hsbc","key-generation","key-management","open-source","poetry-python","public-key","python","python-rsa","python-rsa-key-pairs-public-key-private-key","rsa","security"],"created_at":"2024-11-23T03:12:23.879Z","updated_at":"2024-11-23T03:12:24.603Z","avatar_url":"https://github.com/hsbc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable MD033 MD041 --\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://www.hsbc.com/-/files/hsbc/header/hsbc-logo-200x25.svg\" alt=\"HSBC Logo\" width=\"200\" title=\"HSBC Logo\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eEncryption Helper Python\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/banner.jpg\" alt=\"Encryption Helper Banner\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eA Python CLI application for generating RSA public and private key pairs using the cryptography library\u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e •\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e •\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e •\n  \u003ca href=\"#configuration\"\u003eConfiguration\u003c/a\u003e •\n  \u003ca href=\"#development\"\u003eDevelopment\u003c/a\u003e •\n  \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\u003c!-- markdownlint-enable MD033 MD041 --\u003e\n\n## Features\n\nEncryption Helper is a robust Python package designed to simplify the process of creating RSA key pairs. It leverages the [cryptography][0] library to offer:\n\n- Generation of 2048-bit RSA key pairs\n- Automatic saving of keys in PEM format\n- Logging of key generation for debugging purposes\n- Simple CLI interface for ease of use\n\n## Installation\n\nThis package requires Python 3.8 or later and uses cryptography for cryptographic operations.\n\n### Using Poetry (recommended)\n\nEnsure you have Poetry installed, then follow these steps:\n\n```bash\n# Clone the repository\ngit clone https://github.com/hsbc/encryption-helper-python.git\ncd encryption-helper-python\n\n# Install dependencies (including cryptography)\npoetry install\n```\n\n### Using pip\n\nIf you prefer to use pip:\n\n```bash\n# Clone the repository\ngit clone https://github.com/hsbc/encryption-helper-python.git\ncd encryption-helper-python\n\n# Create a virtual environment (optional but recommended)\npython -m venv venv\nsource venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n\n# Install the package and its dependencies (including cryptography)\npip install .\n```\n\n## Usage\n\n### With Poetry\n\nTo generate an RSA key pair using Poetry:\n\n```bash\npoetry run encryption-helper\n```\n\n### With standard Python\n\nIf you installed the package using pip:\n\n```bash\n# If you're using a virtual environment, make sure it's activated\nencryption-helper\n```\n\nOr run the module directly:\n\n```bash\npython -m encryption_helper\n```\n\nThese commands will:\n\n- Use cryptography to generate a 2048-bit RSA key pair\n- Save the private key to `keys/pem/private-key.pem`\n- Save the public key to `keys/pem/public-key.pem`\n- Display both keys in the console\n- Log the key generation process\n\n## Configuration\n\nThe key generation process uses cryptography with the following specifications:\n\n- Standard: PKCS#1\n- Type: RSA\n- Size: 2048 bits\n\nTo modify these settings, you'll need to edit the `generate_rsa_key()` function in `encryption_helper/main.py`. Refer to the cryptography documentation for more advanced configurations.\n\n## Development\n\n### With Poetry\n\nTo set up the development environment using Poetry:\n\n```bash\n# Create a virtual environment and install dependencies\npoetry install\n\n# Activate the virtual environment\npoetry shell\n\n# Run tests\npytest tests/\n\n# Generate documentation\npydoc -w encryption_helper\n```\n\n### With standard Python\n\nIf you're not using Poetry:\n\n```bash\n# Create a virtual environment\npython -m venv venv\nsource venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n\n# Install development dependencies\npip install .[dev]\n\n# Run tests\npytest tests/\n\n# Generate documentation\npydoc -w encryption_helper\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n\n[0]: https://github.com/pyca/cryptography","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhsbc%2Fencryption-helper-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhsbc%2Fencryption-helper-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhsbc%2Fencryption-helper-python/lists"}