{"id":34072598,"url":"https://github.com/sumeshi/reg2es","last_synced_at":"2025-12-31T00:45:04.052Z","repository":{"id":57460877,"uuid":"393981174","full_name":"sumeshi/reg2es","owner":"sumeshi","description":"A library for fast parse \u0026 import of Windows NT Registry(REGF format) into Elasticsearch.","archived":false,"fork":false,"pushed_at":"2022-04-01T13:55:57.000Z","size":50,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-03T03:53:13.809Z","etag":null,"topics":["elasticsearch","json","parser","python","registry","windows"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sumeshi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-08T14:20:48.000Z","updated_at":"2023-10-19T22:57:27.000Z","dependencies_parsed_at":"2022-08-28T14:02:41.119Z","dependency_job_id":null,"html_url":"https://github.com/sumeshi/reg2es","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/sumeshi/reg2es","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Freg2es","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Freg2es/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Freg2es/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Freg2es/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sumeshi","download_url":"https://codeload.github.com/sumeshi/reg2es/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sumeshi%2Freg2es/sbom","scorecard":{"id":858240,"data":{"date":"2025-08-11","repo":{"name":"github.com/sumeshi/reg2es","commit":"1d6a475ae5dd3a626311485d28163be402f1bda0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/17 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating python:3.7-slim-buster to python:3.7-slim-buster@sha256:9bd2bfc822a533f99cbe6b1311d5bf0ff136f776ebac9b985407829f17278935","Warn: pipCommand not pinned by hash: Dockerfile:4","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"11 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-48 / GHSA-fj7x-q9j7-g6q6","Warn: Project is vulnerable to: PYSEC-2024-230 / GHSA-248v-346w-9cwc","Warn: Project is vulnerable to: PYSEC-2022-42986 / GHSA-43fp-rhv2-5gv8","Warn: Project is vulnerable to: PYSEC-2023-135 / GHSA-xqr8-7jwr-rhp7","Warn: Project is vulnerable to: PYSEC-2024-40 / GHSA-pwr2-4v36-6qpr","Warn: Project is vulnerable to: GHSA-g7vv-2v7x-gj9p","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: PYSEC-2023-212 / GHSA-g4mx-q9vg-27p4","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: PYSEC-2023-192 / GHSA-v845-jxx5-vc9f","Warn: Project is vulnerable to: GHSA-jfmj-5v4g-7637"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T00:29:41.419Z","repository_id":57460877,"created_at":"2025-08-24T00:29:41.419Z","updated_at":"2025-08-24T00:29:41.419Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27722664,"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","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["elasticsearch","json","parser","python","registry","windows"],"created_at":"2025-12-14T08:03:56.707Z","updated_at":"2025-12-14T08:03:57.852Z","avatar_url":"https://github.com/sumeshi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# reg2es\n\n[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)\n[![PyPI version](https://badge.fury.io/py/reg2es.svg)](https://badge.fury.io/py/reg2es)\n[![Python Versions](https://img.shields.io/pypi/pyversions/reg2es.svg)](https://pypi.org/project/reg2es/)\n\n![reg2es logo](https://gist.githubusercontent.com/sumeshi/c2f430d352ae763273faadf9616a29e5/raw/bd51b2539d8bb639d4f630ef13639706bed1f905/reg2es.svg)\n\nA library for fast import of Windows NT Registry(REGF) into Elasticsearch.  \nreg2es uses C library [libregf](https://github.com/libyal/libregf).\n\n\n## Usage\n\nWhen using from the commandline interface:\n\n```bash\n$ reg2es /path/to/your/file.DAT\n```\n\nWhen using from the python-script:\n\n```python\nfrom reg2es import reg2es\n\nif __name__ == '__main__':\n  filepath = '/path/to/your/file.DAT'\n  reg2es(filepath)\n```\n\n### Arguments\n\nreg2es supports importing from multiple files.\n\n```bash\n$ reg2es NTUSER.DAT SYSTEM SAM\n```\n\nAlso, possible to import recursively from a specific directory.\n\nNote: In this case, the filename will not be checked, please check for unnecessary files before execute.\n\n```bash\n$ tree .\nregfiles/\n  ├── NTUSER.DAT\n  ├── NTUSER.MAN\n  ├── SAM\n  └── subdirectory/\n    ├── SOFTWARE\n    └── subsubdirectory/\n      ├── SYSTEM\n      └── UsrClass.dat\n\n$ reg2es /regfiles/ # The Path is recursively expanded to file1~6.reg.\n```\n\n### Options\n\n```\n--version, -v\n\n--help, -h\n\n--quiet, -q\n  Flag to suppress standard output\n  (default: False)\n\n--host:\n  ElasticSearch host address\n  (default: localhost)\n\n--port:\n  ElasticSearch port number\n  (default: 9200)\n\n--index:\n  Index name of Import destination\n  (default: reg2es)\n\n--scheme:\n  Scheme to use (http, or https)\n  (default: http)\n\n--pipeline\n  Elasticsearch Ingest Pipeline to use\n  (default: )\n\n--login:\n  The login to use if Elastic Security is enable\n  (default: )\n\n--pwd:\n  The password linked to the login provided\n  (default: )\n\n--fields-limit\n  index.mapping.total_fields.limit settings\n  (default: 10000)\n```\n\n### Examples\n\nWhen using from the commandline interface:\n\n```\n$ reg2es /path/to/your/file.dat --host=localhost --port=9200 --index=foobar\n```\n\nWhen using from the python-script:\n\n```py\nif __name__ == '__main__':\n    reg2es('/path/to/your/file.dat', host=localhost, port=9200, index='foobar')\n```\n\nWith the Amazon Elasticsearch Serivce (ES):\n\n```\n$ reg2es /path/to/your/file.dat --host=example.us-east-1.es.amazonaws.com --port=443 --scheme=https --index=foobar\n```\n\nWith credentials for Elastic Security:\n\n```\n$ reg2es /path/to/your/file.dat --host=localhost --port=9200 --index=foobar --login=elastic --pwd=******\n```\n\nNote: The current version does not verify the certificate.\n\n\n## Appendix\n\n### Reg2json\n\nExtra feature. :sushi: :sushi: :sushi:\n\nConvert from Windows NT Registry(REGF) to json file.\n\n```bash\n$ reg2json /path/to/your/file.DAT /path/to/output/target.json\n```\n\nConvert from Windows NT Registry(REGF) to Python dict object.\n\n```python\nfrom reg2es import reg2json\n\nif __name__ == '__main__':\n  filepath = '/path/to/your/file.DAT'\n  result: dict = reg2json(filepath)\n```\n\n## Output Format\n\nThe structures is not well optimized for searchable with Elasticsearch. I'm waiting for your PR!!\n\n```json\n{\n  \"ROOT\": {\n    \"AppEvents\": {\n      \"meta\": {\n        \"last_written_time\": \"2015-10-30T07:24:57.814133\"\n      },\n      \"EventLabels\": {\n        \"meta\": {\n          \"last_written_time\": \"2015-10-30T07:25:51.735838\"\n        },\n        \"Default\": {\n          \"meta\": {\n            \"last_written_time\": \"2015-10-30T07:24:57.861009\"\n          },\n          \"_\": {\n            \"type\": 1,\n            \"identifier\": \"REG_SZ\",\n            \"size\": 26,\n            \"data\": \"Default Beep\"\n          },\n          \"DispFileName\": {\n            \"type\": 1,\n            \"identifier\": \"REG_SZ\",\n            \"size\": 34,\n            \"data\": \"@mmres.dll,-5824\"\n          }\n        },\n        \"ActivatingDocument\": {\n          \"meta\": {\n            \"last_written_time\": \"2015-10-30T07:24:57.861009\"\n          },\n          \"_\": {\n            \"type\": 1,\n            \"identifier\": \"REG_SZ\",\n            \"size\": 40,\n            \"data\": \"Complete Navigation\"\n          },\n          \"DispFileName\": {\n            \"type\": 1,\n            \"identifier\": \"REG_SZ\",\n            \"size\": 40,\n            \"data\": \"@ieframe.dll,-10321\"\n          }\n        }\n        ...\n      }\n    }\n  }\n}\n```\n\n## Installation\n\n### via PyPI\n```\n$ pip install reg2es\n```\n\n## Known Issues\n\n```\nelasticsearch.exceptions.RequestError: RequestError(400, 'illegal_argument_exception', 'Limit of total fields [1000] in index [reg2es] has been exceeded')\n```\n\nWindows NT Registry has a large number of elements per document and is caught in the initial value of the limit.\nTherefore, please use the --fields-limit(default: 10000) option to remove the limit.\n\n```\n$ reg2es --fields-limit 10000 NTUSER.DAT\n```\n\n## Contributing\n\n[CONTRIBUTING](https://github.com/sumeshi/reg2es/blob/master/CONTRIBUTING.md)\n\nThe source code for reg2es is hosted at GitHub, and you may download, fork, and review it from this repository(https://github.com/sumeshi/reg2es).\nPlease report issues and feature requests. :sushi: :sushi: :sushi:\n\n## License\n\nreg2es is released under the [LGPLv3+](https://github.com/sumeshi/reg2es/blob/master/LICENSE) License.\n\nPowered by [libregf](https://github.com/libyal/libregf).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsumeshi%2Freg2es","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsumeshi%2Freg2es","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsumeshi%2Freg2es/lists"}