{"id":13843774,"url":"https://github.com/nccgroup/nlist","last_synced_at":"2025-09-12T21:13:31.873Z","repository":{"id":147079554,"uuid":"349008540","full_name":"nccgroup/nlist","owner":"nccgroup","description":"An nmap script to produce target lists for use with various tools.","archived":false,"fork":false,"pushed_at":"2021-05-13T14:00:16.000Z","size":28,"stargazers_count":33,"open_issues_count":0,"forks_count":8,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-26T04:44:31.103Z","etag":null,"topics":["lua","nmap","nmap-scripts","nse","nsescript","pentesting"],"latest_commit_sha":null,"homepage":"","language":"Lua","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/nccgroup.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-03-18T09:13:15.000Z","updated_at":"2024-03-19T03:56:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"ff15c54f-a446-4d3e-b8be-0c7133059566","html_url":"https://github.com/nccgroup/nlist","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nccgroup/nlist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nccgroup%2Fnlist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nccgroup%2Fnlist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nccgroup%2Fnlist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nccgroup%2Fnlist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nccgroup","download_url":"https://codeload.github.com/nccgroup/nlist/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nccgroup%2Fnlist/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274879249,"owners_count":25367094,"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-09-12T02:00:09.324Z","response_time":60,"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":["lua","nmap","nmap-scripts","nse","nsescript","pentesting"],"created_at":"2024-08-04T17:02:26.734Z","updated_at":"2025-09-12T21:13:31.837Z","avatar_url":"https://github.com/nccgroup.png","language":"Lua","readme":"# nList\nAn Nmap script to produce target lists for use with various tools.\n\n## Installation\nFor the script to be run by default as part of all script scans (`-sC`), it will need to be saved in the `scripts` subdirectory of the Nmap data directory along with an `nlist.conf` file.\n\nA `.nlist` file placed in the user's home directory will be used instead of the default `nlist.conf` file if another configuration file is not specified using the `nlist.config` argument. \n\n## Usage\nWorks best when run as part of a version scan (`-sV`).\n\u003cpre\u003e\nnmap [-sV] --script nlist [--script-args nlist.config=\u0026lt;config_file\u0026gt;,nlist.ignorehome,nlist.outdir=\u0026lt;output_directory\u0026gt;,nlist.overwrite] [-p-] \u0026lt;target\u0026gt;\n\n-- nlist.config=\u0026lt;config_file\u0026gt;: \t\tnList configuration file\n-- nlist.ignorehome: \t\t\t\tIf specified, the '.nlist' configuration file in the user's home directory is ignored\n-- nlist.outdir=\u0026lt;output_directory\u0026gt;: Output directory to write list files to ('./target_lists' by default)\n-- nlist.overwrite: \t\t\t\tIf specified, existing output files are overwritten\n\u003c/pre\u003e\nAll arguments override settings specified in config files!\n\n## Configuration\nConfiguration files must follow the same structure as the `nlist.conf` file provided in this repository. It is advised that you familiarise yourself with this file before attempting to write your own configuration files.\n\nConfiguration files can contain the following options:\n\n- `overwrite`: A Boolean value that specifies whether to overwrite existing output files (`true`) or append to them (`false`)\n- `output_directory`: A string containing the directory in which to save any output files (will be created if it does not already exist)\n- `use_default_rules`: A Boolean value that specifies whether to use the default rules defined in the `nlist.conf` file as well as the rules defined in this configuration file (`true`) or not (`false`)\n- `use_home_rules`: A Boolean value that specifies whether to use the rules defined in the `.nlist` file in the user's home directory as well as the rules defined in this configuration file (`true`) or not (`false`)\n- `output_files`: An array of specifications for each output file the script should generate (see subsection below for details)\n\n### `output_files` Specifications\nEach `output_files` specification is made up of the following options:\n\n- `name`: A string containing the path to the output file\n- `rules`: An array of rules that should be used to determine the contents of the file (see subsection below for details)\n- `output_format`: An array specifying the format each line in the file should take (see subsection below for details)\n\n#### `rules` Rules\nOnly one of the rules specified for an output file needs to be met for a port to be included in the output file (subsequent rules for the output file will be skipped for that port)!\n\nRules can be made up of a combination of the following criteria:\n\n- `port_protocol`: An array containing acceptable port protocols (`tcp` and/or `udp`)\n- `port_number`: An array containing acceptable port numbers\n- `service`: An array containing acceptable services (not case sensitive)\n- `service_type`: An array containing acceptable service types (currently only `http` and `ssl/tls` are valid values)\n\n#### `output_format` Format\nThe first string in this array should be a format string containing `%s` where subsequent values should appear (these will appear in the order they are specified in). The following strings can be any combination of the following values:\n\n- `ip`: The IP address of the host\n- `port_number`: The port number\n- `port_protocol`: The port protocol (`tcp` or `udp`)\n- `service`: The service running on the port\n\nYou must specify the same number of values as there are occurrences of `%s` in your format string!\n\nLiteral `%` characters will need to be backslash escaped (`\\%`)! \n","funding_links":[],"categories":["Lua"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnccgroup%2Fnlist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnccgroup%2Fnlist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnccgroup%2Fnlist/lists"}