# API Key Locator (APIKL) #
## What is this? ##
This module allows you to find API keys and passwords in your project. \
In short, it uses regular expressions to find suspicious strings and Shannon’s entropy prove that they are API keys.\
This module successfully finds not only API keys but also passwords.\
It doesn't use any web services so your API keys are in safe, you may check all the code in my GitHub.
## Quick Guide ##
The module is based on the following structure:
files = ['...']
probability = 6
locator = APIKL(files, probability)
locator.find_keys()
***files*** is for files you want to check *(blank to check the current folder)*\
***probability*** defines level of keys to show *(from 1 to 10, 5 is default)*
----------
### Using ###
Using the library is as simple and convenient as possible:
First, import everything from the library (use the `from `...` import *` construct).
Examples of all operations:
Finding keys in *files_to_check* `find_keys(files_to_check: list)` \
If *files_to_check* is blank, it will check for keys in _locator.files_to_check_ which is defined in constructor
files = ['path/to/file1', 'path/to/file2']
locator.find_keys(files)
----------
## Troubleshooting ##
This module doesn't pose much of a problem since it's quite simple. But there's one issue that cannot be fixed.
APIKL(['C:\Users\User\Desktop\database.xml'], 6).find_keys()
You may get `SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 2-3:
truncated \UXXXXXXXX escape`. In this case just place "r" before your path to replace it with raw string.
Example:
APIKL([r'C:\Users\User\Desktop\database.xml'], 6).find_keys()
## Developer ##
My site: https://github.com/VitalyKalinsky
Raw data
{
"_id": null,
"home_page": "https://github.com/VitalyKalinsky/APIKL",
"name": "APIKL",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12.2",
"maintainer_email": null,
"keywords": "API keys APIkeys locate detect passwords",
"author": "Vitaly_Kalinsky",
"author_email": "kalinskyvii@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2e/40/cff8df614e6bec5384bb62fc1e95dd249db819c900b0138d3198e8f7b82d/apikl-1.2.tar.gz",
"platform": null,
"description": "# API Key Locator (APIKL) #\r\n\r\n## What is this? ##\r\nThis module allows you to find API keys and passwords in your project. \\\r\nIn short, it uses regular expressions to find suspicious strings and Shannon\u0432\u0402\u2122s entropy prove that they are API keys.\\\r\nThis module successfully finds not only API keys but also passwords.\\\r\nIt doesn't use any web services so your API keys are in safe, you may check all the code in my GitHub. \r\n\r\n## Quick Guide ##\r\nThe module is based on the following structure:\r\n\r\n files = ['...']\r\n probability = 6\r\n locator = APIKL(files, probability)\r\n locator.find_keys()\r\n\r\n***files*** is for files you want to check *(blank to check the current folder)*\\\r\n***probability*** defines level of keys to show *(from 1 to 10, 5 is default)*\r\n\r\n----------\r\n\r\n\r\n### Using ###\r\n\r\nUsing the library is as simple and convenient as possible:\r\n\r\nFirst, import everything from the library (use the `from `...` import *` construct).\r\n\r\nExamples of all operations:\r\n\r\nFinding keys in *files_to_check* `find_keys(files_to_check: list)` \\\r\nIf *files_to_check* is blank, it will check for keys in _locator.files_to_check_ which is defined in constructor\r\n\r\n files = ['path/to/file1', 'path/to/file2']\r\n locator.find_keys(files)\r\n\r\n\r\n\r\n----------\r\n## Troubleshooting ##\r\nThis module doesn't pose much of a problem since it's quite simple. But there's one issue that cannot be fixed.\r\n\r\n APIKL(['C:\\Users\\User\\Desktop\\database.xml'], 6).find_keys()\r\n\r\nYou may get `SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 2-3: \r\ntruncated \\UXXXXXXXX escape`. In this case just place \"r\" before your path to replace it with raw string.\r\nExample: \r\n\r\n APIKL([r'C:\\Users\\User\\Desktop\\database.xml'], 6).find_keys()\r\n\r\n\r\n\r\n\r\n\r\n## Developer ##\r\nMy site: https://github.com/VitalyKalinsky\r\n",
"bugtrack_url": null,
"license": null,
"summary": "This module allows you to find API keys and passwords in your project.",
"version": "1.2",
"project_urls": {
"GitHub": "https://github.com/VitalyKalinsky",
"Homepage": "https://github.com/VitalyKalinsky/APIKL"
},
"split_keywords": [
"api",
"keys",
"apikeys",
"locate",
"detect",
"passwords"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea8819332b0df6d2e18dedfa0131ba1d6f82146485f219bf96962b0f1ad2c186",
"md5": "e2bcf061d7a2866b41ebb6fb699b213e",
"sha256": "5f3e847635ee39409767537ca59b48820ed0b6a2d029bad5d9234637e41fccb4"
},
"downloads": -1,
"filename": "APIKL-1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e2bcf061d7a2866b41ebb6fb699b213e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12.2",
"size": 5519,
"upload_time": "2025-01-12T10:49:32",
"upload_time_iso_8601": "2025-01-12T10:49:32.128048Z",
"url": "https://files.pythonhosted.org/packages/ea/88/19332b0df6d2e18dedfa0131ba1d6f82146485f219bf96962b0f1ad2c186/APIKL-1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2e40cff8df614e6bec5384bb62fc1e95dd249db819c900b0138d3198e8f7b82d",
"md5": "e6ea1bb75acac0b4ad5f4f12313b7b64",
"sha256": "6a4290118357e247e3b7a2cfb3cd17e0588d08f0cf68cec625859d9f19e8359f"
},
"downloads": -1,
"filename": "apikl-1.2.tar.gz",
"has_sig": false,
"md5_digest": "e6ea1bb75acac0b4ad5f4f12313b7b64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12.2",
"size": 5284,
"upload_time": "2025-01-12T10:49:34",
"upload_time_iso_8601": "2025-01-12T10:49:34.789451Z",
"url": "https://files.pythonhosted.org/packages/2e/40/cff8df614e6bec5384bb62fc1e95dd249db819c900b0138d3198e8f7b82d/apikl-1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-12 10:49:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VitalyKalinsky",
"github_project": "APIKL",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apikl"
}
JSON
