| Name | eatshell JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | Automate the process of extracting, loading and assembling shellcode. |
| upload_time | 2024-11-07 16:51:55 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Shruti Priya 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 |
python
shellcode-extractor
shellcode-loader
shellcode-assembler
shellcode
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center">eatshell</h1>
<p align="center">
<a href="#summary">Summary</a> •
<a href="#requirements">Requirements</a> •
<a href="#installation">Installation</a> •
<a href="#usage">Usage</a> •
<a href="#license">License</a>
</p>
## Summary
eatshell is a simple command line tool to automate the process of shellcode extraction, loading and assembling. eatshell contains three commands `extract`, `load`, and `assemble`.
>[!NOTE]
**Note: eatshell is meant for small-scale application and primarily created for personal use only.**
## Requirements
- Python 3.xx
## Installation
There are two ways to install `eatshell`:
Install the tool directly with `pip`
```bash
pip install eatshell
```
Or, you can build from source. Download the latest [release](https://github.com/sapphicart/eatshell/releases).
## Usage
Use the `--help` switch to read the `COMMANDS` and `OPTIONS` available.
```bash
$ eatshell --help
Usage: eatshell.py [OPTIONS] COMMAND [ARGS]...
Options:
--hush Suppress Usage and Warning info.
--help Show this message and exit.
Commands:
assemble
extract
load
```
There are three commands available for `eatshell`:
- assemble
- extract
- load
```
$ eatshell assemble --shellcode <hex string> --file <filename>
Use this command to assemble given shellcode
into an ELF file with +rwx permissions for
the owner.
```
```
$ eatshell extract --file <filename> --hex <boolean>
Use this command to extract shellcode
from an existing ELF file.
Turn --hex on for hex encoding.
```
```
$ eatshell load --shellcode <hex string>
Use this command to run the provided
shellcode interactively.
Use with caution, might not work everytime.
```
>[!WARNING]
Create an `.env` file with the following variables. Otherwise, the program might not work.
`.env` file structure example:
```
OS=linux
ARCH=amd64
LOG_LEVEL=error
```
## License
Distributed under [MIT](LICENSE) License.
Raw data
{
"_id": null,
"home_page": null,
"name": "eatshell",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "python, shellcode-extractor, shellcode-loader, shellcode-assembler, shellcode",
"author": null,
"author_email": "sapphicart <shrutipriya44@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/68/6e/0a097acbd7700fa37f15d1439120e0ab5762d00da1f78dc1ac90d47a3d9e/eatshell-1.0.2.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">eatshell</h1>\n\n<p align=\"center\">\n <a href=\"#summary\">Summary</a> \u2022\n <a href=\"#requirements\">Requirements</a> \u2022\n <a href=\"#installation\">Installation</a> \u2022\n <a href=\"#usage\">Usage</a> \u2022\n <a href=\"#license\">License</a>\n</p>\n\n## Summary\n\neatshell is a simple command line tool to automate the process of shellcode extraction, loading and assembling. eatshell contains three commands `extract`, `load`, and `assemble`.\n\n>[!NOTE]\n**Note: eatshell is meant for small-scale application and primarily created for personal use only.**\n\n## Requirements\n\n- Python 3.xx\n\n## Installation\n\nThere are two ways to install `eatshell`:\n\nInstall the tool directly with `pip`\n```bash\npip install eatshell\n```\n\nOr, you can build from source. Download the latest [release](https://github.com/sapphicart/eatshell/releases).\n\n## Usage\n\nUse the `--help` switch to read the `COMMANDS` and `OPTIONS` available.\n```bash\n$ eatshell --help\nUsage: eatshell.py [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --hush Suppress Usage and Warning info.\n --help Show this message and exit.\n\nCommands:\n assemble\n extract\n load\n```\nThere are three commands available for `eatshell`:\n- assemble\n- extract\n- load\n\n```\n$ eatshell assemble --shellcode <hex string> --file <filename>\n \n Use this command to assemble given shellcode\n into an ELF file with +rwx permissions for\n the owner.\n```\n\n```\n$ eatshell extract --file <filename> --hex <boolean>\n \n Use this command to extract shellcode\n from an existing ELF file.\n Turn --hex on for hex encoding.\n```\n\n```\n$ eatshell load --shellcode <hex string>\n\n Use this command to run the provided\n shellcode interactively.\n Use with caution, might not work everytime.\n```\n\n>[!WARNING]\nCreate an `.env` file with the following variables. Otherwise, the program might not work.\n\n`.env` file structure example:\n```\nOS=linux\nARCH=amd64\nLOG_LEVEL=error\n```\n\n## License\nDistributed under [MIT](LICENSE) License.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Shruti Priya 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": "Automate the process of extracting, loading and assembling shellcode.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/sapphicart/eatshell",
"Issues": "https://github.com/sapphicart/eatshell/issues"
},
"split_keywords": [
"python",
" shellcode-extractor",
" shellcode-loader",
" shellcode-assembler",
" shellcode"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "498221197c819974e876a501e2f13f94fddc74218c3fa319a68b15f5e184d240",
"md5": "81ec4eca2b580ae21c07c4c1c222f858",
"sha256": "42ca14967c603c51625867a0dbc6d0380202113bd2bdd97a9b55e82ca870674a"
},
"downloads": -1,
"filename": "eatshell-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "81ec4eca2b580ae21c07c4c1c222f858",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5984,
"upload_time": "2024-11-07T16:51:53",
"upload_time_iso_8601": "2024-11-07T16:51:53.647596Z",
"url": "https://files.pythonhosted.org/packages/49/82/21197c819974e876a501e2f13f94fddc74218c3fa319a68b15f5e184d240/eatshell-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "686e0a097acbd7700fa37f15d1439120e0ab5762d00da1f78dc1ac90d47a3d9e",
"md5": "46249cd610bc2d509ba112f856c6f161",
"sha256": "56ea13806d9b076b4bcdf5a2ebdbcc758664e37f4ccac05e32bc01cdf376c686"
},
"downloads": -1,
"filename": "eatshell-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "46249cd610bc2d509ba112f856c6f161",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4839,
"upload_time": "2024-11-07T16:51:55",
"upload_time_iso_8601": "2024-11-07T16:51:55.376191Z",
"url": "https://files.pythonhosted.org/packages/68/6e/0a097acbd7700fa37f15d1439120e0ab5762d00da1f78dc1ac90d47a3d9e/eatshell-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 16:51:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sapphicart",
"github_project": "eatshell",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "eatshell"
}
