{"id":24708366,"url":"https://github.com/surface-security/scanner-example","last_synced_at":"2026-04-29T15:03:11.873Z","repository":{"id":43829949,"uuid":"458164446","full_name":"surface-security/scanner-example","owner":"surface-security","description":"Template scanner to speed up creating new ones. But also built as scanner image so it can be used to test scanners framework or a new rootbox","archived":false,"fork":false,"pushed_at":"2023-02-15T18:51:48.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-12T07:47:50.320Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/surface-security.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-11T11:46:33.000Z","updated_at":"2023-04-02T23:21:12.000Z","dependencies_parsed_at":"2025-01-27T06:41:54.819Z","dependency_job_id":null,"html_url":"https://github.com/surface-security/scanner-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/surface-security/scanner-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surface-security%2Fscanner-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surface-security%2Fscanner-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surface-security%2Fscanner-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surface-security%2Fscanner-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/surface-security","download_url":"https://codeload.github.com/surface-security/scanner-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/surface-security%2Fscanner-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32430803,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T13:34:34.882Z","status":"ssl_error","status_checked_at":"2026-04-29T13:34:29.830Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2025-01-27T06:31:39.884Z","updated_at":"2026-04-29T15:03:11.846Z","avatar_url":"https://github.com/surface-security.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boilerplate\n\nTemplate scanner to speed up creating new ones\n\nThe only thing scanners need to follow is:\n* process a single input file that will be specified as first positional argument\n* produce as many output files as wanted in `/output` path (inside the container)\n\nInput file format will match whatever is chosen as `Input Generator` and the output produced should match whatever is expected by `Output Parser` \u003c-- settings defined in the scanner configuration in Surface)\n\n\nThis repository is actually built as a scanner (named `example`) that can be used to test scanners framework or a new rootbox.\n\n## NOTE\n\nThis is a dumb scanner as it only resolves A records and it shells out to `host` utility. This has a performance impact (spawning shells) over simply using a DNS lib/package but the purpose is to exemplify the common scenario of building entrypoints to *wrap* external/3rd-party scanners\n\n\nRest of README.md is also part of the example, feel free to re-use\n\n# Example Scanner in Docker\n\nThis scanner performs DNS resolution.\n\nInput expected: one hostname per line\nOutput provided: single file, with `hostname:IP`\n\n## Usage\n\n```\nMass DNS Resolver\n\npositional arguments:\n  inputfile             THE input file\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -o OUTPUT, --output OUTPUT\n                        output directory for results\n  -p PROCESSES, --processes PROCESSES\n                        number of processes\n  --echo                just echo input back instead of resolving DNS (passive\n                        testing)\n  --wait WAIT           sleep WAIT seconds after completion\n```\n\n`echo` will just echo back so it can be executed without hammering nameservers (if not required).\n\n`wait` will introduce sleep at the end which can be useful to easily simulate a long scan.\n\n## Run locally\n- Build: `./build.sh nopush`\n- Create `/tmp/input/input.txt` and `/tmp/output`.\n- Run: `docker run --rm -v /tmp/input:/input -v /tmp/output:/output ${PWD##*/}:latest`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurface-security%2Fscanner-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsurface-security%2Fscanner-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsurface-security%2Fscanner-example/lists"}