metasploit-framework/.github/ISSUE_TEMPLATE/bug_report.md

---
name: Bug Report 🐞
about: Something isn't working as expected? Here is the right place to report.
labels: "bug"
---

<!--
  Please fill out each section below, otherwise, your issue will be closed. This info allows Metasploit maintainers to diagnose (and fix!) your issue as quickly as possible.

  Useful Links:
  - Wiki: https://docs.metasploit.com/
  - Reporting a Bug: https://docs.metasploit.com/docs/using-metasploit/getting-started/reporting-a-bug.html

  Before opening a new issue, please search existing issues: https://github.com/rapid7/metasploit-framework/issues
-->

## Steps to reproduce

How'd you do it?

1. ...
2. ...

This section should also tell us any relevant information about the
environment; for example, if an exploit that used to work is failing,
tell us the victim operating system and service versions.

## Were you following a specific guide/tutorial or reading documentation?

If yes link the guide/tutorial or documentation you were following here, otherwise you may omit this section.

## Expected behavior

What should happen?

## Current behavior

What happens instead?

### Metasploit version

Get this with the `version` command in msfconsole (or `git log -1 --pretty=oneline` for a source install).

## Additional Information
If your version is less than `5.0.96`, please update to the latest version and ensure your issue is still present.

If the issue is encountered within `msfconsole`, please run the `debug` command using the instructions below. If the issue is encountered outisde `msfconsole`, or the issue causes `msfconsole` to crash on startup, please delete this section.

1. Start `msfconsole`
2. Run the command `set loglevel 3`
3. Take the steps necessary recreate your issue
4. Run the `debug` command
5. Copy all the output below the `===8<=== CUT AND PASTE EVERYTHING BELOW THIS LINE ===8<===` line and make sure to **REMOVE ANY SENSITIVE INFORMATION.**
6. Replace these instructions and the paragraph above with the output from step 5.
Use new issue templates 2020-06-15 18:06:27 +08:00			`---`
			`name: Bug Report 🐞`
			`about: Something isn't working as expected? Here is the right place to report.`
Address pr comments, add termux issue 2020-06-17 22:39:54 +08:00			`labels: "bug"`
Use new issue templates 2020-06-15 18:06:27 +08:00			`---`

			`<!--`
Remove gatsby references 2020-06-15 18:10:23 +08:00			`Please fill out each section below, otherwise, your issue will be closed. This info allows Metasploit maintainers to diagnose (and fix!) your issue as quickly as possible.`
Use new issue templates 2020-06-15 18:06:27 +08:00
			`Useful Links:`
issue template: update doc links 2022-06-19 07:35:29 +08:00			`- Wiki: https://docs.metasploit.com/`
			`- Reporting a Bug: https://docs.metasploit.com/docs/using-metasploit/getting-started/reporting-a-bug.html`
Use new issue templates 2020-06-15 18:06:27 +08:00
			`Before opening a new issue, please search existing issues: https://github.com/rapid7/metasploit-framework/issues`
			`-->`

Add issue template 2016-02-23 01:46:21 +08:00			`## Steps to reproduce`

			`How'd you do it?`

			`1. ...`
			`2. ...`

			`This section should also tell us any relevant information about the`
			`environment; for example, if an exploit that used to work is failing,`
			`tell us the victim operating system and service versions.`

Address pr comments, add termux issue 2020-06-17 22:39:54 +08:00			`## Were you following a specific guide/tutorial or reading documentation?`

			`If yes link the guide/tutorial or documentation you were following here, otherwise you may omit this section.`

Add issue template 2016-02-23 01:46:21 +08:00			`## Expected behavior`

			`What should happen?`

			`## Current behavior`

			`What happens instead?`

			`### Metasploit version`

			Get this with the `version` command in msfconsole (or `git log -1 --pretty=oneline` for a source install).

Updates bug report to include debug instructions 2020-09-04 21:01:29 +08:00			`## Additional Information`
			If your version is less than `5.0.96`, please update to the latest version and ensure your issue is still present.
Add issue template 2016-02-23 01:46:21 +08:00
Updates bug report to include debug instructions 2020-09-04 21:01:29 +08:00			If the issue is encountered within `msfconsole`, please run the `debug` command using the instructions below. If the issue is encountered outisde `msfconsole`, or the issue causes `msfconsole` to crash on startup, please delete this section.
Add issue template 2016-02-23 01:46:21 +08:00
Updates bug report to include debug instructions 2020-09-04 21:01:29 +08:00			1. Start `msfconsole`
			2. Run the command `set loglevel 3`
			`3. Take the steps necessary recreate your issue`
			4. Run the `debug` command
			5. Copy all the output below the `===8<=== CUT AND PASTE EVERYTHING BELOW THIS LINE ===8<===` line and make sure to REMOVE ANY SENSITIVE INFORMATION.
			`6. Replace these instructions and the paragraph above with the output from step 5.`