{"id":18374709,"url":"https://github.com/jupiterone/graph-nmap","last_synced_at":"2025-04-06T20:30:41.710Z","repository":{"id":41977677,"uuid":"253291517","full_name":"JupiterOne/graph-nmap","owner":"JupiterOne","description":"Ingest hosts discovered from Nmap scans to JupiterOne graph","archived":false,"fork":false,"pushed_at":"2024-01-02T19:12:24.000Z","size":646,"stargazers_count":2,"open_issues_count":7,"forks_count":3,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-22T06:24:42.245Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JupiterOne.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-04-05T17:24:52.000Z","updated_at":"2025-02-11T06:50:00.000Z","dependencies_parsed_at":"2023-12-05T18:46:31.515Z","dependency_job_id":"50ab89d5-a092-4ca5-b1c5-54ad26fcb4db","html_url":"https://github.com/JupiterOne/graph-nmap","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-nmap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-nmap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-nmap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JupiterOne%2Fgraph-nmap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JupiterOne","download_url":"https://codeload.github.com/JupiterOne/graph-nmap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247547020,"owners_count":20956471,"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":[],"created_at":"2024-11-06T00:15:44.723Z","updated_at":"2025-04-06T20:30:41.325Z","avatar_url":"https://github.com/JupiterOne.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# graph-nmap\n\nThis is a local/unmanaged integration that processes discovered hosts from\n[Nmap](https://nmap.org/) scans and ingests the findings into JupiterOne (J1).\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your\nlocal machine for development and testing purposes.\n\n### Prerequisites\n\n* Node.js\n* J1 Account\n* J1 API Key\n* Nmap installed locally\n\n### Usage\n\nExport the following environment variables (or store locally in a `.env` file):\n\n```bash\nexport J1_ACCESS_TOKEN=\u003capi_key\u003e\nexport J1_ACCOUNT=\u003caccount_id\u003e\n```\n\n`J1_ACCOUNT` should be your JupiterOne `accountId`, which can be found by\nrunning the query `Find Account as a return a.accountId` in the JupiterOne web\nconsole.\n\n`J1_ACCESS_TOKEN` is a JupiterOne API key, which can be created in the\nJupiterOne console by going to the gear icon in the top-right, then clicking\n`Users \u0026 Access`, then click the key icon and create an API key.\n\nThen run:\n\n1. `yarn install`\n\n1. `nmap` scan and output to an XML file. For example:\n\n   ```bash\n   nmap -v -sn 192.168.1.0/24 -oX local/nmap-out.xml\n   ```\n\n1. `cat local/{filename}.xml | yarn ts-node ./src/index.ts`\n\n1. The newly created entities are of class `Host` and can be found through the\n   J1QL query `Find nmap_discovered_host`.\n\n   Here are two example output screenshots from JupiterOne:\n\n   ![example1.png](images/example1.png)\n\n   ![example2.png](images/example2.png)\n\n### Examples\n\nAn example Nmap output file is included in `test/nmap-out.xml`. The converted\n`test/nmap-out.json` file is for reference purpose only.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupiterone%2Fgraph-nmap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjupiterone%2Fgraph-nmap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupiterone%2Fgraph-nmap/lists"}