nuclei-templates Documentation

Community curated list of templates for the nuclei engine to find security vulnerabilities.

RAW Doc

1. Project Overview & Quickstart (projectdiscovery/nuclei-templates)

File: README.md

Nuclei Templates

Community curated list of templates for the nuclei engine to find security vulnerabilities in applications.


Templates are the core of the nuclei scanner which powers the actual scanning engine.
This repository stores and houses various templates for the scanner provided by our team, as well as contributed by the community.
We hope that you also contribute by sending templates via pull requests or Github issues to grow the list.

Nuclei Templates overview

An overview of the nuclei template project, including statistics on unique tags, author, directory, severity, and type of templates. The table below contains the top ten statistics for each matrix; an expanded version of this is available here, and also available in JSON format for integration.

| ### ๐Ÿšจ Known Exploited Vulnerabilities (KEV) Coverage

Nuclei templates provide coverage for vulnerabilities actively exploited in the wild:

KEV Source Templates Description


๐Ÿ”ด CISA KEV 454 CISA Known Exploited Vulnerabilities Catalog
๐ŸŸ  VulnCheck KEV 1449 VulnCheck KEV - Enhanced vulnerability intelligence
๐ŸŸข Both Sources 407 Templates covering vulnerabilities in both catalogs

๐Ÿ’ก Total unique KEV templates: 1496 - Use nuclei -tags kev,vkev to scan for actively exploited vulnerabilities


Nuclei Templates Top 10 statistics

text
TAG      COUNT      AUTHOR       COUNT   DIRECTORY    COUNT   SEVERITY   COUNT   TYPE   COUNT

vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436
cve 3587 daffainfo 905 cloud 659 high 2552 dns 26
discovery 3265 princechaddha 854 file 436 medium 2457
vkev 1394 dwisiswant0 805 network 259 critical 1555
panel 1365 ritikchaddha 678 code 251 low 330
xss 1269 pussycat0x 675 dast 240 unknown 54
wordpress 1261 pikpikcu 353 workflows 205
exposure 1141 pdteam 314 javascript 92
wp-plugin 1103 pdresearch 275 ssl 38
osint 848 iamnoooob 263 dns 23

873 directories, 11997 files.

๐Ÿ“– Documentation

Please navigate to https://nuclei.projectdiscovery.io for detailed documentation to build new or your own custom templates.
We have also added a set of templates to help you understand how things work.

๐Ÿ’ช Contributions

Nuclei-templates is powered by major contributions from the community.
Template contributions , Feature Requests and Bug Reports are more than welcome.

๐Ÿ’ฌ Discussion

Have questions / doubts / ideas to discuss?
Feel free to open a discussion on Github discussions board.

๐Ÿ‘จโ€๐Ÿ’ป Community

You are welcome to join the active Discord Community to discuss directly with project maintainers and share things with others around security and automation.
Additionally, you may follow us on Twitter to be updated on all the things about Nuclei.

Thanks again for your contribution and keeping this community vibrant. :heart:


File: http/token-spray/README.md

About

This directory holds templates that have static API URL endpoints. Use these to test an API token against many API service endpoints. By providing token input using flag, Nuclei will test the token against all known API endpoints within the API templates, and return any successful results. By incorporating API checks as Nuclei Templates, users can test API keys that have no context (i.e., API keys that do not indicate for which API endpoint they are meant).

Usage

token-spray are self-contained template and does not requires URLs as input as the API endpoints have static URLs predefined in the template. Each template in the token-spray directory assumes the input API token/s will be provided using CLI var flag.

console
# Running token-spray templates against a single token to test
nuclei -t token-spray/ -var token=random-token-to-test -esc

# Running token-spray templates against a file containing multiple new line delimited tokens
nuclei -t token-spray/ -var token=file_with_tokens.txt -esc

Credits

These API testing templates were inspired by the streaak/keyhacks repository. The Bishop Fox Continuous Attack Surface Testing (CAST) team created additional API templates for testing API keys uncovered during investigations. You are welcome to add new templates based on the existing format to cover more APIs.


File: http/osint/phishing/README.md

Description

This directory contains a collection of templates designed for the identification and analysis of phishing sites. These templates are specifically created to help OSINT analysts, threat researchers, and security professionals in discovering and studying phishing campaigns.

Usage

The phishing templates are designed for targeted use and are not included in Nuclei's default scans. To incorporate these templates into your scan, you can specify them using the -itags flags as follows:

console
nuclei -u <host> -tags phishing -itags phishing

For users interested in comprehensive Open Source Intelligence (OSINT) gathering, these phishing templates have been integrated into the OSINT scan profile. This enables a more detailed and focused analysis as part of broader security research efforts or investigative journalism.
To execute the OSINT scan configuration profile, which includes phishing checks among other templates, use the following command:

console
# Execute the OSINT scan configuration profile
nuclei -u <host> -config ~/nuclei-templates/config/osint.yml

The integration of phishing templates into the OSINT scan profile allows for a more nuanced and in-depth approach to security research, aiding in the detection of emerging threats and the analysis of ongoing phishing campaigns.


File: http/osint/user-enumeration/README.md

Description

OSINT templates are available for conducting user enumeration across many websites. By utilizing the flag to input a user, Nuclei can verify the user's existence across all websites listed in the templates and report any instances of success.

Usage

The templates within the u directory are self-contained and do NOT require URLs as input because the OSINT templates have pre-defined static URLs. Each template in this directory expects the user(name), email, or phone number or list of it to be supplied as input using the V/var flag through the Nuclei engine.

bash
# Running OSINT templates against a single user to test
nuclei -tags osint -var user=elon

OSINT templates can be also ran against list of usernames as well.

console
$ cat user_names.txt

user_1
user_2
user_3
user_4
user_5
bash
# Running OSINT templates against a list of users to test
nuclei -tags osint -var user=user_names.txt

Categories

The OSINT templates are classified into categories such as archived, art, blog, business, coding, dating, finance, gaming, health, hobby, images, misc, music, news, political, search, shopping, social, tech, video, porn.

To execute OSINT templates within a particular category, you can apply a filter using the tags flag and set the prefix value to osint-.

bash
# Running OSINT templates against the social category
nuclei -t osint/ -tags osint-social -var user=some-user

# Running OSINT templates against the multiple categories
nuclei -t osint/ -tags osint-social,osint-finance -var user=some-user

Acknowledgment

These OSINT templates were inspired by the WebBreacher/WhatsMyName repository.


File: http/osint/README.md

Description

Nuclei-templates provide a comprehensive suite of security checks, including OSINT templates in this directory for user-enumeration and phishing templates for the identification and analysis of phishing sites.

The User Enumeration templates are tailored for user enumeration across various websites, allowing Nuclei to verify user existence. They expect input such as username, email, or phone number through the V/var flag.

The Phishing templates are crafted for detecting and analyzing phishing sites. These templates are essential for OSINT analysts, threat researchers, and security professionals to uncover and study phishing campaigns.

Usage

These templates are specifically added to help OSINT analysts, threat researchers therefore, we have added them to the OSINT scan profile here.
Users can execute the OSINT scan configuration profile with the following command:

console
nuclei -u <host> -config ~/nuclei-templates/config/osint.yml

File: http/credential-stuffing/README.md

Credential Stuffing Templates

This directory contains a collection of credential stuffing templates for both cloud and self-hosted services. These templates help automate the detection and prevention of credential stuffing attempts on your organization's websites and applications using the Nuclei vulnerability scanner.

Types of Templates

  • Cloud Services: Templates for credential stuffing testing on cloud service providers.
  • Self-Hosted Services: Templates for credential stuffing testing on self-hosted software instances that often have custom hosting environments.

Usage

Cloud Services Template

An example of using a cloud service credential stuffing template can be seen with the Datadog Login Check template:

bash
nuclei -var [email protected] -var password=test123 -id datadog-login-check

Here, the -var option supplies the necessary inputs (username/email and password) to the template.

Self-Hosted Services Template

An example of using a self-hosted service credential stuffing template can be seen with the Jira Login Check template:

bash
nuclei -u https://jira.projectdiscovery.io/ -id jira-login-check -var [email protected] -var password=test123

In this case, you also need to provide the hostname/IP of the deployed instance using the -u or --url option along with the necessary credentials using the -var option.

Attack Types

By default, Nuclei uses Pitchfork mode in which it takes the first line from email.txt as the username input and the first line from pass.txt as the password parameter input. Ensure that both email.txt and pass.txt have an equal number of entries, with email/password combinations aligned on the same line in both files.

Starting with Nuclei 2.8, you can override the default behavior using the -at or -attack-type CLI option. Specifying the attack-type option as clusterbomb enables convenient verification of weak credentials for a list of given email addresses across various services.

For example, assuming email.txt contains:

And pass.txt contains:

text
password1
password2
password3

The command below will check credential validity by sequentially testing each email from email.txt with all entries in pass.txt across different hosts stored in jira.txt:

bash
cat jira.txt | nuclei -var username=email.txt -var password=pass.txt -id jira-login-check -attack-type clusterbomb

Developing custom target-specific templates for internal/custom portals can yield even more comprehensive results.

Contributing and Updating Templates

Help us improve the credential stuffing templates by contributing new templates, reporting bugs, or requesting new features. Contributions are most welcome!

Fix issues, add new templates, and update existing ones by submitting a pull request. Always adhere to the best practices for YAML syntax and ensure that your template is tested before submitting.

Please refer to the template documentation to learn more about writing and submitting new templates to this repository: https://docs.projectdiscovery.io/templates/introduction


File: profiles/README.md

About

This directory hosts Nuclei configuration profiles specifically designed for various use cases, including Bug Bounty, OSINT, and Compliance. The centerpiece of these configurations is the recommended.yml file, which offers a handpicked selection of templates that are both efficient and relevant for the majority of scanning scenarios. This curated approach is intended to provide a more focused scanning experience, reducing the occurrence of irrelevant results that often accompany broader scans.

Usage

The Nuclei configuration profiles are straightforward to integrate into your existing scanning workflows. Below are guidelines on how to utilize the recommended.yml configuration for a streamlined scanning process, as well as instructions for customizing your scans to fit specific needs.

To execute a scan with the recommended.yml configuration, which has been optimized for general use to yield efficient and relevant results, use the following command:

text
nuclei -config ~/nuclei-templates/profiles/recommended.yml

Customizing Your Scanning Configuration

If you have specific requirements or wish to modify the focus of your scans, you can create a custom configuration file based on the structure of recommended.yml. Adjust the template selections to fit your targeted scanning objectives. Once your configuration is set, run Nuclei using your custom file with the command:

text
nuclei -config your-custom-config.yml

Examples

Here are examples of how to run scans for specific scenarios:

Running Local Privilege Escalation Checks

For targeting local privilege escalation vulnerabilities, utilize the dedicated config as follows:

text
nuclei -config ~/nuclei-templates/profiles/privilege-escalation.yml

Config Focusing on OSINT

text
nuclei -config ~/nuclei-templates/profiles/osint.yml

File: README_CN.md

Nuclei ๆจกๆฟ

่ฟ™ไธชไป“ๅบ“็”จไบŽๅญ˜ๆ”พ็”ฑ็คพๅŒบ็ฒพๅฟƒๆŒ‘้€‰็š„ๆจกๆฟ,ๅฏไปฅไฝฟ็”จnucleiๅผ•ๆ“Ž็ป“ๅˆๆจกๆฟๅ‘็Žฐๅบ”็”จไธญ็š„ๆผๆดžใ€‚


ๆจกๆฟๆ˜ฏ nuclei ๆ‰ซๆๅ™จ ็š„ๆ ธๅฟƒ.
่ฟ™ไธชgitไป“ๅบ“ๅ‚จๅญ˜ไบ†็”ฑPDๅ›ข้˜ŸไปฅๅŠ็คพๅŒบ่ดก็Œฎ็š„ๅ„็งๆ‰ซๆๆจกๆฟ.
ๆˆ‘ไปฌๅธŒๆœ›ๆ‚จไนŸ่ƒฝๆ”ป้€š่ฟ‡ pull requests ๆˆ–่€…Github issuesๆฅๆไบคๆจกๆฟไปฅๆ‰ฉๅคงๆˆ‘ไปฌ็š„ไป“ๅบ“ๅˆ—่กจ.

Nucleiๆจกๆฟ้กน็›ฎๆƒ…ๅ†ตๆฆ‚่ฟฐ

ไปฅไธ‹ๆ˜ฏnucleiๆจกๆฟ้กน็›ฎ็š„ๆƒ…ๅ†ตๆฆ‚่งˆ,ๅŒ…ๆ‹ฌๅ”ฏไธ€ๆ ‡็ญพ,ไฝœ่€…,็›ฎๅฝ•,ไธฅ้‡ๆ€ง,ๆจกๆฟ็ฑปๅž‹็š„็›ธๅ…ณ็ปŸ่ฎกๆƒ…ๅ†ต.ไปฅไธ‹่กจๆ ผๅˆ—ๅ‡บไบ†ๅ‰้ขๆๅˆฐ็š„ๆฏ้กนๆƒ…ๅ†ต็š„TOP10ไฟกๆฏ;ไฝ ไนŸๅฏไปฅ็‚นๅ‡ป่ฟ™้‡ŒๆŸฅ็œ‹่ฏฆ็ป†ไฟกๆฏ.ๅฝ“็„ถไฝ ไนŸๅฏไปฅ็‚นๅ‡ป่ฟ™้‡Œ่Žทๅ–JSONๆ ผๅผ็š„่ฏฆ็ป†ๆƒ…ๅ†ต็ปŸ่ฎก

| ### ๐Ÿšจ ๅทฒ็Ÿฅ่ขซๅˆฉ็”จๆผๆดž (KEV) ่ฆ†็›–่Œƒๅ›ด

Nuclei ๆจกๆฟไธบ้‡Žๅค–่ขซ็งฏๆžๅˆฉ็”จ็š„ๆผๆดžๆไพ›่ฆ†็›–:

KEV ๆฅๆบ ๆจกๆฟๆ•ฐ้‡ ๆ่ฟฐ


๐Ÿ”ด CISA KEV 454 CISA ๅทฒ็Ÿฅ่ขซๅˆฉ็”จๆผๆดž็›ฎๅฝ•
๐ŸŸ  VulnCheck KEV 1449 VulnCheck KEV - ๅขžๅผบ็š„ๆผๆดžๆƒ…ๆŠฅ
๐ŸŸข ไธคไธชๆฅๆบ 407 ่ฆ†็›–ไธคไธช็›ฎๅฝ•ไธญๆผๆดž็š„ๆจกๆฟ

๐Ÿ’ก ๅ”ฏไธ€ KEV ๆจกๆฟๆ€ปๆ•ฐ: 1496 - ไฝฟ็”จ nuclei -tags kev,vkev ๆ‰ซๆ่ขซ็งฏๆžๅˆฉ็”จ็š„ๆผๆดž


Nuclei Templates Top 10 statistics

text
TAG      COUNT      AUTHOR       COUNT   DIRECTORY    COUNT   SEVERITY   COUNT   TYPE   COUNT

vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436
cve 3587 daffainfo 905 cloud 659 high 2552 dns 26
discovery 3265 princechaddha 854 file 436 medium 2457
vkev 1394 dwisiswant0 805 network 259 critical 1555
panel 1365 ritikchaddha 678 code 251 low 330
xss 1269 pussycat0x 675 dast 240 unknown 54
wordpress 1261 pikpikcu 353 workflows 205
exposure 1141 pdteam 314 javascript 92
wp-plugin 1103 pdresearch 275 ssl 38
osint 848 iamnoooob 263 dns 23

873 directories, 11997 files.

๐Ÿ“– ๆ–‡ๆกฃ

่ฏฆ็ป†็š„ๆ–‡ๆกฃ่ฏท่ฎฟ้—ฎๆˆ‘ไปฌ็š„็ฝ‘็ซ™https://nuclei.projectdiscovery.io,ๅœจๆˆ‘ไปฌ็ฝ‘็ซ™็š„่ฏฆ็ป†ๆ–‡ๆกฃไธญ,ๆˆ‘ไปฌๆไพ›ไบ†ๅฆ‚ไฝ•ๅˆ›ๅปบๆจกๆฟ็š„ๅ…ทไฝ“ๆ–นๆณ•,ๅนถไธ”ไนŸๆไพ›ไบ†็›ธๅบ”็š„็คบไพ‹ๆจกๆฟๆฅๅธฎๅŠฉๆ‚จๆ›ดๅฅฝๅœฐ็†่งฃๆจกๆฟ็š„ๅผ€ๅ‘ไปฅๅŠ่ฟ่กŒๅŽŸ็†.

๐Ÿ’ช ่ดก็Œฎ

็คพๅŒบๆ˜ฏNucleiๆจกๆฟ้กน็›ฎ็š„ไธป่ฆ่ดก็ŒฎไธปๅŠ›,ๆˆ‘ไปฌ้žๅธธๆฌข่ฟŽๅผ€ๅ‘่€…ไปฌๆฅ่ดก็Œฎๆจกๆฟ,ๆๅ‡บ้œ€ๆฑ‚ๅ’ŒๆŠฅๅ‘ŠBug.

๐Ÿ’ฌ ไบคๆต

ๅฆ‚ๆžœๆ‚จๆœ‰ไปปไฝ•ๅ…ณไบŽ่ฏฅ้กน็›ฎ็š„็–‘้—ฎๆˆ–ๆ˜ฏๆ–ฐๅฅ‡็š„็‚นๅญ,ๆฌข่ฟŽๅœจGithub discussionsๅˆ›ๅปบๆ–ฐ็š„ๆฟๅ—ๆฅ่ฟ›่กŒ่ฎจ่ฎบ.

๐Ÿ‘จโ€๐Ÿ’ป ็คพๅŒบ

ๆฌข่ฟŽๆ‚จๅŠ ๅ…ฅๆˆ‘ไปฌ็š„Discord ็คพๅŒบ๏ผŒไธŽ้กน็›ฎ็ปดๆŠคไบบๅ‘˜็›ดๆŽฅ่ฎจ่ฎบ๏ผŒๆˆ–ไธŽๅ…ถไป–ไบบๅˆ†ไบซๆœ‰ๅ…ณๅฎ‰ๅ…จๅ’Œ่‡ชๅŠจๅŒ–็š„ๆƒณๆณ•ใ€‚
ๆญคๅค–๏ผŒๆ‚จ่ฟ˜ๅฏไปฅๅœจ Twitter ไธŠๅ…ณๆณจๆˆ‘ไปฌ๏ผŒไบ†่งฃ Nuclei ็š„ๆœ€ๆ–ฐๅŠจๆ€ใ€‚

ๆœ€ๅŽ,ๆ„Ÿ่ฐขๆ‚จๅฏน่ฟ™ไธช้กน็›ฎ็š„่ดก็Œฎ,่ฟ™ๅฐ†่ฎฉๆˆ‘ไปฌ็š„็คพๅŒบๆ›ดๅŠ ๅ……ๆปกๆดปๅŠ›.


File: README_JA.md

Nuclei ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆ

ใ‚ขใƒ—ใƒชใ‚ฑใƒผใ‚ทใƒงใƒณใฎใ‚ปใ‚ญใƒฅใƒชใƒ†ใ‚ฃ่„†ๅผฑๆ€งใ‚’็™บ่ฆ‹ใ™ใ‚‹ใŸใ‚ใฎNucleiใ‚จใƒณใ‚ธใƒณ็”จใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฎใ‚ณใƒŸใƒฅใƒ‹ใƒ†ใ‚ฃใ‚ญใƒฅใƒฌใƒผใ‚ทใƒงใƒณใƒชใ‚นใƒˆ


ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฏใ€ๅฎŸ้š›ใฎใ‚นใ‚ญใƒฃใƒณใ‚จใƒณใ‚ธใƒณใ‚’ๅ‹•ไฝœใ•ใ›ใ‚‹nucleiใ‚นใ‚ญใƒฃใƒŠใƒผใฎใ‚ณใ‚ขใงใ™ใ€‚
ใ“ใฎใƒชใƒใ‚ธใƒˆใƒชใฏใ€็งใŸใกใฎใƒใƒผใƒ ใŒๆไพ›ใ™ใ‚‹ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใ‚„ใ€ใ‚ณใƒŸใƒฅใƒ‹ใƒ†ใ‚ฃใ‹ใ‚‰ใฎ่ฒข็Œฎใซใ‚ˆใ‚‹ใ•ใพใ–ใพใชใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใ‚’ไฟๅญ˜ใƒป็ฎก็†ใ—ใพใ™ใ€‚
ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฎใƒชใ‚นใƒˆใ‚’ๅข—ใ‚„ใ™ใŸใ‚ใซใ€ใƒ—ใƒซใƒชใ‚ฏใ‚จใ‚นใƒˆใ‚„Github issuesใ‚’้€šใ˜ใฆ่ฒข็Œฎใ—ใฆใ„ใŸใ ใ‘ใ‚‹ใจๅนธใ„ใงใ™ใ€‚

Nuclei ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฎๆฆ‚่ฆ

Nucleiใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใฎๆฆ‚่ฆใงใ‚ใ‚Šใ€ใƒฆใƒ‹ใƒผใ‚ฏใชใ‚ฟใ‚ฐใ€่‘—่€…ใ€ใƒ‡ใ‚ฃใƒฌใ‚ฏใƒˆใƒชใ€้‡ๅคงๅบฆใ€ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฎ็จฎ้กžใซ้–ขใ™ใ‚‹็ตฑ่จˆใ‚’ๅซใฟใพใ™ใ€‚ไปฅไธ‹ใฎ่กจใฏใ€ๅ„ใƒžใƒˆใƒชใƒƒใ‚ฏใ‚นใฎใƒˆใƒƒใƒ—10ใฎ็ตฑ่จˆใ‚’็คบใ—ใฆใ„ใพใ™ใ€‚ๆ‹กๅผตใƒใƒผใ‚ธใƒงใƒณใฏใ“ใกใ‚‰ใง็ขบ่ชใงใใ€JSONๅฝขๅผใงใ‚‚ๅˆฉ็”จๅฏ่ƒฝใงใ™ใ€‚

| ### ๐Ÿšจ ๆ—ข็Ÿฅใฎๆ‚ช็”จใ•ใ‚Œใ‚‹่„†ๅผฑๆ€ง (KEV) ใ‚ซใƒใƒฌใƒƒใ‚ธ

Nucleiใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฏใ€้‡Ž็”Ÿใง็ฉๆฅต็š„ใซๆ‚ช็”จใ•ใ‚Œใฆใ„ใ‚‹่„†ๅผฑๆ€งใฎใ‚ซใƒใƒฌใƒƒใ‚ธใ‚’ๆไพ›ใ—ใพใ™:

KEV ใ‚ฝใƒผใ‚น ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆๆ•ฐ ่ชฌๆ˜Ž


๐Ÿ”ด CISA KEV 454 CISA ๆ—ข็Ÿฅใฎๆ‚ช็”จใ•ใ‚Œใ‚‹่„†ๅผฑๆ€งใ‚ซใ‚ฟใƒญใ‚ฐ
๐ŸŸ  VulnCheck KEV 1449 VulnCheck KEV - ๅผทๅŒ–ใ•ใ‚ŒใŸ่„†ๅผฑๆ€งใ‚คใƒณใƒ†ใƒชใ‚ธใ‚งใƒณใ‚น
๐ŸŸข ไธกๆ–นใฎใ‚ฝใƒผใ‚น 407 ไธกๆ–นใฎใ‚ซใ‚ฟใƒญใ‚ฐใฎ่„†ๅผฑๆ€งใ‚’ใ‚ซใƒใƒผใ™ใ‚‹ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆ

๐Ÿ’ก ใƒฆใƒ‹ใƒผใ‚ฏKEVใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆ็ทๆ•ฐ: 1496 - nuclei -tags kev,vkev ใ‚’ไฝฟ็”จใ—ใฆ็ฉๆฅต็š„ใซๆ‚ช็”จใ•ใ‚Œใฆใ„ใ‚‹่„†ๅผฑๆ€งใ‚’ใ‚นใ‚ญใƒฃใƒณ


Nuclei Templates Top 10 statistics

text
TAG      COUNT      AUTHOR       COUNT   DIRECTORY    COUNT   SEVERITY   COUNT   TYPE   COUNT

vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436
cve 3587 daffainfo 905 cloud 659 high 2552 dns 26
discovery 3265 princechaddha 854 file 436 medium 2457
vkev 1394 dwisiswant0 805 network 259 critical 1555
panel 1365 ritikchaddha 678 code 251 low 330
xss 1269 pussycat0x 675 dast 240 unknown 54
wordpress 1261 pikpikcu 353 workflows 205
exposure 1141 pdteam 314 javascript 92
wp-plugin 1103 pdresearch 275 ssl 38
osint 848 iamnoooob 263 dns 23

873 directories, 11997 files.

๐Ÿ“– ใƒ‰ใ‚ญใƒฅใƒกใƒณใƒˆ

ๆ–ฐใ—ใ„ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใ‚„ใ‚ซใ‚นใ‚ฟใƒ ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใ‚’ไฝœๆˆใ™ใ‚‹ใŸใ‚ใฎ่ฉณ็ดฐใชใƒ‰ใ‚ญใƒฅใƒกใƒณใƒˆใฏใ€https://nuclei.projectdiscovery.io ใง็ขบ่ชใงใใพใ™ใ€‚ไฝœๆฅญๆ–นๆณ•ใ‚’็†่งฃใ™ใ‚‹ใŸใ‚ใฎใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใ‚‚็”จๆ„ใ—ใฆใ„ใพใ™ใ€‚

๐Ÿ’ช ่ฒข็Œฎ

Nucleiใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฏใ‚ณใƒŸใƒฅใƒ‹ใƒ†ใ‚ฃใฎ่ฒข็Œฎใซใ‚ˆใฃใฆๅ‹•ไฝœใ—ใพใ™ใ€‚
ใƒ†ใƒณใƒ—ใƒฌใƒผใƒˆใฎ่ฒข็Œฎใ€ๆฉŸ่ƒฝใƒชใ‚ฏใ‚จใ‚นใƒˆใ€ใƒใ‚ฐๅ ฑๅ‘Šใฏใ„ใคใงใ‚‚ๆญ“่ฟŽใ—ใพใ™ใ€‚

๐Ÿ’ฌ ใƒ‡ใ‚ฃใ‚นใ‚ซใƒƒใ‚ทใƒงใƒณ

่ณชๅ•ใ€็–‘ๅ•ใ€ใ‚ขใ‚คใƒ‡ใ‚ขใ‚’่ฉฑใ—ๅˆใ„ใŸใ„ใงใ™ใ‹๏ผŸ
Github discussionsใง่‡ช็”ฑใซๅง‹ใ‚ใ‚‹ใ“ใจใŒใงใใพใ™ใ€‚

๐Ÿ‘จโ€๐Ÿ’ป ใ‚ณใƒŸใƒฅใƒ‹ใƒ†ใ‚ฃ

ใƒ—ใƒญใ‚ธใ‚งใ‚ฏใƒˆใฎ็ฎก็†่€…ใจ็›ดๆŽฅ่ฉฑใ—ๅˆใ„ใ€ใ‚ปใ‚ญใƒฅใƒชใƒ†ใ‚ฃใ‚„่‡ชๅ‹•ๅŒ–ใซ้–ขใ™ใ‚‹ใ“ใจใ‚’ไป–ใฎไบบใจๅ…ฑๆœ‰ใ™ใ‚‹ใŸใ‚ใซใ€Discord Communityใซๅ‚ๅŠ ใ™ใ‚‹ใ“ใจใ‚’ๆญ“่ฟŽใ—ใพใ™ใ€‚ใ•ใ‚‰ใซใ€Nucleiใซ้–ขใ™ใ‚‹ใ™ในใฆใฎๆƒ…ๅ ฑใ‚’ๆ›ดๆ–ฐใ™ใ‚‹ใŸใ‚ใซใ€Twitterใ‚’ใƒ•ใ‚ฉใƒญใƒผใ™ใ‚‹ใ“ใจใ‚‚ใงใใพใ™ใ€‚

็š†ใ•ใ‚“ใฎ่ฒข็Œฎใจใ‚ณใƒŸใƒฅใƒ‹ใƒ†ใ‚ฃใฎๆดปๆ€งๅŒ–ใธใฎๅŠชๅŠ›ใซๆ„Ÿ่ฌใ—ใพใ™ใ€‚
:heart:


File: README_KR.md

Nuclei ํ…œํ”Œ๋ฆฟ

์ปค๋ฎค๋‹ˆํ‹ฐ์—์„œ ์—„์„ ํ•œ, ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ๋ณด์•ˆ ์ทจ์•ฝ์ ์„ ์ฐพ๊ธฐ ์œ„ํ•œ Nuclei ์—”์ง„์šฉ ํ…œํ”Œ๋ฆฟ ๋ชฉ๋ก


ํ…œํ”Œ๋ฆฟ์€ ์‹ค์ œ ์Šค์บ๋‹ ์—”์ง„์„ ๋™์ž‘ํ•˜๊ฒŒ ํ•˜๋Š” nuclei scanner์˜ ํ•ต์‹ฌ์ž…๋‹ˆ๋‹ค.
์ด ์ €์žฅ์†Œ๋Š” ์šฐ๋ฆฌ ํŒ€์—์„œ ์ œ๊ณตํ•˜๊ฑฐ๋‚˜, ์ปค๋ฎค๋‹ˆํ‹ฐ์—์„œ ๊ธฐ์—ฌํ•œ ๋‹ค์–‘ํ•œ ํ…œํ”Œ๋ฆฟ๋“ค์„ ์ €์žฅํ•˜๊ณ  ๋ณด๊ด€ํ•ฉ๋‹ˆ๋‹ค.
ํ…œํ”Œ๋ฆฟ ๋ชฉ๋ก์„ ์ฆ๊ฐ€์‹œํ‚ค๊ธฐ ์œ„ํ•ด์„œ pull requests ๋‚˜ Github issues ๋ฅผ ํ†ตํ•ด ๊ธฐ์—ฌํ•ด์ฃผ์‹œ๊ธฐ๋ฅผ ๋ถ€ํƒ๋“œ๋ฆฝ๋‹ˆ๋‹ค.

Nuclei ํ…œํ”Œ๋ฆฟ ๊ฐœ์š”

๊ณ ์œ  ํƒœ๊ทธ, ์ž‘์„ฑ์ž, ๋””๋ ‰ํ† ๋ฆฌ, ์‹ฌ๊ฐ๋„, ํ…œํ”Œ๋ฆฟ ์ข…๋ฅ˜์— ๋Œ€ํ•œ ํ†ต๊ณ„๋ฅผ ํฌํ•จํ•˜๊ณ  ์žˆ๋Š” nuclei ํ…œํ”Œ๋ฆฟ์˜ ๊ฐœ์š”์ž…๋‹ˆ๋‹ค. ์•„๋ž˜ ํ‘œ๋Š” ๊ฐ ์ง€ํ‘œ์˜ ์ƒ์œ„ 10๊ฐœ ํ•ญ๋ชฉ์„ ๋‚˜ํƒ€๋‚ด๊ณ  ์žˆ์Šต๋‹ˆ๋‹ค. ๋” ์ž์„ธํ•œ ์ •๋ณด๋Š” ์ด๊ณณ์—์„œ ํ™•์ธ ๊ฐ€๋Šฅํ•˜๊ณ , JSON ํ˜•์‹์œผ๋กœ๋„ ํ™•์ธ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.

| ### ๐Ÿšจ ์•Œ๋ ค์ง„ ์•…์šฉ๋˜๋Š” ์ทจ์•ฝ์  (KEV) ์ ์šฉ ๋ฒ”์œ„

Nuclei ํ…œํ”Œ๋ฆฟ์€ ์‹ค์ œ๋กœ ์•…์šฉ๋˜๊ณ  ์žˆ๋Š” ์ทจ์•ฝ์ ์— ๋Œ€ํ•œ ์ ์šฉ ๋ฒ”์œ„๋ฅผ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค:

KEV ์†Œ์Šค ํ…œํ”Œ๋ฆฟ ์ˆ˜ ์„ค๋ช…


๐Ÿ”ด CISA KEV 454 CISA ์•Œ๋ ค์ง„ ์•…์šฉ๋˜๋Š” ์ทจ์•ฝ์  ์นดํƒˆ๋กœ๊ทธ
๐ŸŸ  VulnCheck KEV 1449 VulnCheck KEV - ๊ฐ•ํ™”๋œ ์ทจ์•ฝ์  ์ธํ…”๋ฆฌ์ „์Šค
๐ŸŸข ๋‘ ์†Œ์Šค ๋ชจ๋‘ 407 ๋‘ ์นดํƒˆ๋กœ๊ทธ์˜ ์ทจ์•ฝ์ ์„ ํฌํ•จํ•˜๋Š” ํ…œํ”Œ๋ฆฟ

๐Ÿ’ก ์ด ๊ณ ์œ  KEV ํ…œํ”Œ๋ฆฟ: 1496 - nuclei -tags kev,vkev๋ฅผ ์‚ฌ์šฉํ•˜์—ฌ ์ ๊ทน์ ์œผ๋กœ ์•…์šฉ๋˜๋Š” ์ทจ์•ฝ์  ์Šค์บ”


Nuclei Templates Top 10 statistics

text
TAG      COUNT      AUTHOR       COUNT   DIRECTORY    COUNT   SEVERITY   COUNT   TYPE   COUNT

vuln 6468 dhiyaneshdk 1894 http 9281 info 4353 file 436
cve 3587 daffainfo 905 cloud 659 high 2552 dns 26
discovery 3265 princechaddha 854 file 436 medium 2457
vkev 1394 dwisiswant0 805 network 259 critical 1555
panel 1365 ritikchaddha 678 code 251 low 330
xss 1269 pussycat0x 675 dast 240 unknown 54
wordpress 1261 pikpikcu 353 workflows 205
exposure 1141 pdteam 314 javascript 92
wp-plugin 1103 pdresearch 275 ssl 38
osint 848 iamnoooob 263 dns 23

873 directories, 11997 files.

๐Ÿ“– ๋ฌธ์„œ

์ƒˆ ํ…œํ”Œ๋ฆฟ์ด๋‚˜ ์‚ฌ์šฉ์ž ์ •์˜ ํ…œํ”Œ๋ฆฟ์„ ๋นŒ๋“œํ•˜๊ธฐ ์œ„ํ•œ ์ž์„ธํ•œ ๋ฌธ์„œ๋Š” https://nuclei.projectdiscovery.io ์—์„œ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์ž‘์—… ๋ฐฉ์‹์˜ ์ดํ•ด๋ฅผ ๋•๊ธฐ ์œ„ํ•œ ํ…œํ”Œ๋ฆฟ๋“ค๋„ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ’ช ๊ธฐ์—ฌ

Nuclei ํ…œํ”Œ๋ฆฟ์€ ์ปค๋ฎค๋‹ˆํ‹ฐ์˜ ๊ธฐ์—ฌ๋กœ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค.
ํ…œํ”Œ๋ฆฟ ๊ธฐ์—ฌ, ๊ธฐ๋Šฅ ์š”์ฒญ, ๋ฒ„๊ทธ ์ œ๋ณด๋Š” ์–ธ์ œ๋“ ์ง€ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ’ฌ ๋…ผ์˜

๊ฐ™์ด ์ด์•ผ๊ธฐํ•˜๊ณ  ์‹ถ์€ ์งˆ๋ฌธ, ์˜๋ฌธ ํ˜น์€ ์•„์ด๋””์–ด๊ฐ€ ์žˆ์œผ์‹ ๊ฐ€์š”?
Github discussions ์—์„œ ์ž์œ ๋กญ๊ฒŒ ์‹œ์ž‘ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

๐Ÿ‘จโ€๐Ÿ’ป ์ปค๋ฎค๋‹ˆํ‹ฐ

ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ์ž์™€ ์ง์ ‘ ๋…ผ์˜ํ•˜๊ณ  ๋ณด์•ˆ๊ณผ ์ž๋™ํ™” ๊ด€๋ จ ์‚ฌํ•ญ์„ ๋‹ค๋ฅธ ์‚ฌ๋žŒ๊ณผ ๊ณต์œ ํ•˜๊ธฐ ์œ„ํ•ด Discord Community ์— ์ฐธ์—ฌํ•˜๋Š” ๊ฒƒ์„ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค. ์ถ”๊ฐ€๋กœ Nuclei ์— ๋Œ€ํ•œ ๋ชจ๋“  ์ •๋ณด๋ฅผ ์—…๋ฐ์ดํŠธ ํ•˜๊ธฐ ์œ„ํ•ด ํŠธ์œ„ํ„ฐ ํŒ”๋กœ์šฐ๋ฅผ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์—ฌ๋Ÿฌ๋ถ„์˜ ๊ธฐ์—ฌ์™€ ์ปค๋ฎค๋‹ˆํ‹ฐ์˜ ํ™œ์„ฑํ™”๋ฅผ ์œ„ํ•œ ๋…ธ๋ ฅ์— ๋‹ค์‹œํ•œ๋ฒˆ ๊ฐ์‚ฌ๋“œ๋ฆฝ๋‹ˆ๋‹ค.
:heart:

2. Official Technical Reference & Guides (projectdiscovery/docs)

File: README.md

ProjectDiscovery Documentation

This is the source code for the ProjectDiscovery documentation located at https://docs.projectdiscovery.io


Development

  1. Checkout this repository
  2. Install mintlify with npm i mintlify@latest
  3. Run mintlify dev

Deploying

To build the final product, we have a couple of additional steps:

  1. Build the JS Protocol Docs
  • npm install jsdoc-to-markdown
  • ./bin/jsdocs.sh
  1. Build the PDCP API reference documentation
  • Either download the latest openapi.yaml manually or run ./bin/download-api.sh
  • Run ./bin/generate-api.sh to generate any new API files
  • OR run ./bin/generate-filtered-api.sh to generate API docs without internal/admin endpoints
  1. Deployment

After those, Mintlify handles the deployment automatically.


File: bin/README-auto-grouped-api.md

Auto-Grouped API Documentation Generator

This script automatically generates and maintains API documentation with logical grouping based on OpenAPI tags. It combines the best of both worlds: auto-generation (no missing endpoints) and logical organization.

Usage

bash
# Use default source file (Downloads directory)
./bin/generate-auto-grouped-api.sh

# Use custom source file  
./bin/generate-auto-grouped-api.sh /path/to/your/openapi.yaml

What it does

๐Ÿค– **Auto-Generation**

  • Reads OpenAPI specification
  • Filters out admin and internal APIs
  • Generates MDX files for all public endpoints
  • Never misses endpoints - everything is included automatically

๐Ÿ“ **Logical Grouping**

The script organizes endpoints into logical groups based on OpenAPI tags:

  • Assets โ†’ assets + enumerations tags
  • Templates โ†’ templates + template/v2 tags
  • Scans โ†’ scans tag
  • Results โ†’ results + retests tags
  • Configurations โ†’ configurations tag
  • Users โ†’ users + user tags
  • Logs โ†’ elog + scan_log tags
  • Export โ†’ export tag
  • Automations โ†’ automations tag
  • Integration โ†’ oauth tag
  • Utilities โ†’ chaos, vulns, leaks, billing, usage tags

๐Ÿ”„ **Auto-Updates Navigation**

  • Automatically updates mint.json with new structure
  • Maintains logical grouping
  • Sorts endpoints alphabetically within groups
  • Handles new endpoints automatically

Benefits

โœ… No Manual Maintenance - Add new endpoints to OpenAPI spec and they appear automatically
โœ… Never Miss Endpoints - All public endpoints are included
โœ… Logical Organization - Grouped by functionality, not alphabetically
โœ… Consistent Naming - Uses OpenAPI summaries and operation IDs
โœ… Future-Proof - Works with any OpenAPI specification changes

Output Structure

After running, your mint.json will have clean navigation like:

json
{
  "group": "API Reference",
  "pages": [
    "api-reference/introduction",
    {
      "group": "Assets", 
      "pages": [
        "api-reference/assets/get-asset-list",
        "api-reference/assets/upload-asset",
        "api-reference/enumerations/create-enumeration",
        "..."
      ]
    },
    {
      "group": "Templates",
      "pages": [
        "api-reference/templates/create-template",
        "api-reference/templates/get-template-list",
        "..."
      ]
    }
  ]
}

Comparison with Manual Approach

Feature Manual (generate-filtered-api.sh) Auto-Grouped (generate-auto-grouped-api.sh)
Missing Endpoints โŒ Requires manual addition to mint.json โœ… Never - all endpoints auto-included
Logical Grouping โœ… Full manual control โœ… Smart tag-based grouping
Maintenance โŒ High - update mint.json for new endpoints โœ… Zero - fully automated
Consistency โŒ Depends on manual updates โœ… Always consistent
New API Versions โŒ Manual review and updates needed โœ… Automatically handles changes

When to Use

Use Auto-Grouped when:

  • You want zero maintenance overhead
  • You frequently add/remove API endpoints
  • You have a team that might forget to update navigation
  • You want consistent organization based on API design

Use Manual when:

  • You need very specific custom grouping that doesn't match tags
  • You want to exclude certain public endpoints from docs
  • You have complex navigation requirements

Next Steps

After running this script:

  1. Preview: mintlify dev
  2. Deploy: Your CI/CD can run this script automatically when OpenAPI changes
  3. Customize: Modify the logicalGroups mapping in the script if needed

File: bin/README-filtered-api.md

Filtered API Documentation Generator

This script generates API documentation from an OpenAPI specification while excluding internal and admin endpoints.

Usage

bash
# Use default source file (Downloads directory)
./bin/generate-filtered-api.sh

# Use custom source file
./bin/generate-filtered-api.sh /path/to/your/openapi.yaml

Note: The script will create a filtered openapi.yaml file in the current directory for Mintlify to use.

What gets filtered out

The script automatically excludes:

  1. Admin APIs: All paths starting with /v1/admin/

    • Examples: /v1/admin/user/search, /v1/admin/team/change_owner
  2. Internal APIs: Endpoints tagged with internal

    • Any endpoint with "internal" in its tags array

Output

  • Creates filtered API documentation in the api-reference/ directory
  • Removes existing internal/ and admin/ folders before regenerating
  • Uses Mintlify scraping to generate MDX files for each endpoint
  • Provides detailed console output showing what was filtered

Requirements

  • Node.js and npm/npx
  • Internet connection (to download @mintlify/scraping package)
  • Valid OpenAPI 3.x specification file

Integration with existing workflow

You can replace the existing ./bin/generate-api.sh call in your build process with:

bash
# Old way (includes internal/admin APIs)
./bin/generate-api.sh

# New way (excludes internal/admin APIs)  
./bin/generate-filtered-api.sh

Troubleshooting

If you encounter errors:

  1. "OpenAPI source file not found": Ensure the file path is correct
  2. "Node.js is required": Install Node.js from https://nodejs.org
  3. Network errors: Check internet connection for npm package downloads
  4. Permission errors: Ensure the script is executable (chmod +x bin/generate-filtered-api.sh)