Skip to content

Commit f61a321

Browse files
authored
Merge pull request #20591 from survivant/feature/fix-typos-hacktoberfest
Fix typos in documentation / hacktoberfest
2 parents e1bcc0a + 77f760c commit f61a321

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Before we get into the details of contributing code, you should know there are m
1111
- [Help fellow users with open issues]. This can require technical knowledge, but you can also get involved in conversations about bug reports and feature requests. This is a great way to get involved without getting too overwhelmed!
1212
- [Help fellow committers test recently submitted pull requests](https://github.com/rapid7/metasploit-framework/pulls). Again this can require some technical skill, but by pulling down a pull request and testing it, you can help ensure our new code contributions for stability and quality.
1313
- [Report a security vulnerability in Metasploit itself] to Rapid7. If you see something you think makes Metasploit vulnerable to an attack, let us know!
14-
- Add [module documentation]. New documentation is always needed and cleaning up existing documents is just as important! If you're a non-native english speaker, you can help by replacing any ambiguous idioms, metaphors, or unclear language that might make our documentation hard to understand.
14+
- Add [module documentation]. New documentation is always needed and cleaning up existing documents is just as important! If you're a non-native English speaker, you can help by replacing any ambiguous idioms, metaphors, or unclear language that might make our documentation hard to understand.
1515

1616

1717
## Code Contributions
@@ -26,7 +26,7 @@ will be closed. We need to ensure the code we're adding to master is written to
2626
We strive to respect the community that has given us so much, so in the odd situation where we get multiple submissions for the same vulnerability, generally we will work with the first person who assigns themselves to the issue or the first person that submits a good-faith PR. A good-faith PR might not even work, but it will show that the author is working their way toward a solution. Despite this general rule, there are rare circumstances where we may ask a contributor to step aside or allow a committer to take the lead on the creation of a new module if a complete and working module with documents has not already been submitted. This kind of expedited module creation process comes up infrequently, and usually it involves high-profile or high priority modules that we have marked internally as time-critical: think KEV list, active exploitation campaigns, CISA announcements, etc. In those cases, we may ask a contributor that is assigned to the issue or who has submitted an incomplete module to allow a committer to take over an issue or a module PR in the interest of getting a module out quickly. If a contributor has submitted an incomplete module, they will remain as a co-author of the module and we may build directly onto the PR they submitted, leaving the original commits in the tree. We sincerely hope that the original author will remain involved in this expedited module creation process. We would appreciate testing, critiquing, and any assistance that can be offered. If the module is complete but requires minor changes, we may ask the contributor to allow us to take over testing/verification and make these minor changes without asking so we can land the module as quickly as possible. In these cases of minor code changes, the authorship of the module will remain unchanged. We hope everyone involved in this expedited module creation process continues to feel valued and appreciated.
2727

2828
## Vibecoding, AI, and LLM
29-
My first job had a token ring LAN and I still own a Win98SE CD, so I'm not entirely sure what _vibecoding_ is, but we're cool with any coding technique you use to create a PR as long as it is tested, documented, and does what it says it does. Untested code is incomplete code, and incomplete code should be marked as a draft PR or WIP (Work in Progress) until it is complete, tested, and ready for a committer to review. We have had several sumbissions clearly from AI that were well-formatted, looked really neat, and did nothing it said it did. While we have no problem with AI-assisted coding, please do not assume that the code generated by an AI or LLM is logically or even syntactically correct.
29+
My first job had a token ring LAN and I still own a Win98SE CD, so I'm not entirely sure what _vibecoding_ is, but we're cool with any coding technique you use to create a PR as long as it is tested, documented, and does what it says it does. Untested code is incomplete code, and incomplete code should be marked as a draft PR or WIP (Work in Progress) until it is complete, tested, and ready for a committer to review. We have had several submissions clearly from AI that were well-formatted, looked really neat, and did nothing it said it did. While we have no problem with AI-assisted coding, please do not assume that the code generated by an AI or LLM is logically or even syntactically correct.
3030

3131
### Code Contribution Do's & Don'ts:
3232
Keeping the following in mind gives your contribution the best chance of landing!

docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ override.
5757
```bash
5858
echo "COMPOSE_FILE=./docker-compose.yml:./docker-compose.override.yml:./docker-compose.local.override.yml" >> .env
5959
```
60-
Now you should be able get reverse shells working
60+
Now you should be able to get reverse shells working

docs/metasploit-framework.wiki/Evading-Anti-Virus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
* [Facts and myths about antivirus evasion with Metasploit](http://schierlm.users.sourceforge.net/avevasion.html)
77
* [Using metasm to avoid antivirus detection ghost writing asm](https://web.archive.org/web/20200330111926/https://www.pentestgeek.com/penetration-testing/using-metasm-to-avoid-antivirus-detection-ghost-writing-asm)
88

9-
There are approximately 14 million other resources out there on the why's and wherefores of evading antivirus, but the about articles should get you started.
9+
There are approximately 14 million other resources out there on the why's and wherefores of evading antivirus, but the above articles should get you started.

docs/metasploit-framework.wiki/Get-Started-Writing-an-Exploit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ end
110110

111111
* **Stability** - The Stability field describes how the exploit affects the system it's being run on, ex: `CRASH_SAFE`, `CRASH_OS_DOWN`
112112
* **Reliability** - The Reliability field describes how reliable the session is that gets returned by the exploit, ex: `REPEATABLE_SESSION`, `UNRELIABLE_SESSION`
113-
* **SideEffects** - The SideEffects field describes the side effects cause by the exploit that the user should be aware of, ex: `ARTIFACTS_ON_DISK`, `IOC_IN_LOGS`, `ACCOUNT_LOCKOUTS`.
113+
* **SideEffects** - The SideEffects field describes the side effects caused by the exploit that the user should be aware of, ex: `ARTIFACTS_ON_DISK`, `IOC_IN_LOGS`, `ACCOUNT_LOCKOUTS`.
114114

115115
### Non-required fields
116116

docs/metasploit-framework.wiki/How-to-get-started-with-writing-an-auxiliary-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ include Msf::Auxiliary::Scanner
4141

4242
A couple of new things will be added to your module when you include this mixin. You will have a new datastore option named "RHOSTS", which allows the user to specify multiple hosts. There's a new "THREADS" option, which allows the number of threads to run during execution. There's also "ShowProgress" and "ShowProgressPercent" for tracking scan progress.
4343

44-
Typically, the main method for an auxiliary module is "def run". But when you use the ```Msf::Auxiliary::Scanenr``` mixin, you need to be using ```def run_host(ip)```. The IP parameter is the target machine.
44+
Typically, the main method for an auxiliary module is "def run". But when you use the ```Msf::Auxiliary::Scanner``` mixin, you need to be using ```def run_host(ip)```. The IP parameter is the target machine.
4545

4646
## Templates
4747

documentation/modules/auxiliary/admin/aws/aws_launch_instances.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ retrieve deployment packages from S3.
5454
The VPC or Virtual Private Cloud, an isolated local area network. Network access
5555
can be made available by assigning an Internet routable IP address to a host or
5656
routing traffic to it through an ELB (Elastic Load Balancer). In either case
57-
security-groups are used to open access to network ranges and specific TPC/UDP
57+
security-groups are used to open access to network ranges and specific TCP/UDP
5858
ports. Security-groups provide much of the functionality of traditional firewalls
59-
and can be configured by specifying a protocol, a CIDR and a port.
59+
and can be configured by specifying a protocol, a CIDR and a port.
6060

6161
## How it Works
6262

@@ -65,7 +65,7 @@ Web console or the CLI, launching a host in the Cloud requires a fair
6565
amount of configuration; this module does its best to abstract configuration
6666
requirements away from the user by auto detecting the VPC, subnets, creating
6767
security groups, etc. It performs several tasks to launch a host with
68-
a public IP address, these are as follow: 1) select a VPC, 2) select a subnet, 3)
68+
a public IP address, these are as follows: 1) select a VPC, 2) select a subnet, 3)
6969
create/select a security group, 4) create/select a key-pair, and 5) launch
7070
a host.
7171

@@ -80,15 +80,15 @@ an Internet routable IP address. The module dynamically finds which subnet to
8080
launch the host in. It will use the first subnet it finds having the
8181
`Auto-assign Public IP` option set, if no such subnet exists, then it will
8282
select the first subnet having an Internet gateway. To circumvent this process,
83-
the `SUBNET_ID` advanced option can be set.
83+
the `SUBNET_ID` advanced option can be set.
8484

8585
When launching a Cloud host at least one security group is required. There are
8686
several advanced options for creating/selecting a security group. The
8787
`SEC_GROUP_ID` option works much in the same way the `VPC_ID` option does.
8888
That is, the module will create a security group unless the `SEC_GROUP_ID`
8989
options is set. If the `SEC_GROUP_ID` option is not set, the module will attempt
9090
to create a security group using the values specified in the `SEC_GROUP_CIDR`,
91-
`SEC_GROUP_NAME`, and `SEC_GROUP_PORT` options as configuration.
91+
`SEC_GROUP_NAME`, and `SEC_GROUP_PORT` options as configuration.
9292

9393
The `KEY_NAME` and `SSH_PUB_KEY` options are used in conjunction to select or
9494
create a key-pair (a named SSH public key). Key-pairs are used to authenticate
@@ -113,7 +113,7 @@ use command. To run the module, only the `AccessKeyId`, `SecretAccessKey`, and
113113
Basic Options:
114114

115115
* `AMI_ID`: The Amazon Machine Image (AMI) ID (region dependent)
116-
* `RHOST`: the AWS EC2 Endpoint (ec2.us-west-2.amazonaws.com), may change this to something closer to you
116+
* `RHOST`: The AWS EC2 Endpoint (ec2.us-west-2.amazonaws.com), may change this to something closer to you
117117
* `Region`: The default region (us-west-2), must match endpoint
118118
* `AccessKeyId`: AWS API access key
119119
* `SecretAccessKey`: AWS API secret access key
@@ -129,10 +129,10 @@ Advanced Options:
129129
* `MinCount`: Minimum number of instances to launch
130130
* `ROLE_NAME`: The instance profile/role name
131131
* `RPORT:` AWS EC2 Endpoint TCP Port
132-
* `SEC_GROUP_ID`: the EC2 security group to use
133-
* `SEC_GROUP_CIDR`: the EC2 security group network access CIDR, defaults to 0.0.0.0/0
134-
* `SEC_GROUP_NAME`: the EC2 security group name
135-
* `SEC_GROUP_PORT`: the EC2 security group network access port, defaults to tcp:22
132+
* `SEC_GROUP_ID`: The EC2 security group to use
133+
* `SEC_GROUP_CIDR`: The EC2 security group network access CIDR, defaults to 0.0.0.0/0
134+
* `SEC_GROUP_NAME`: The EC2 security group name
135+
* `SEC_GROUP_PORT`: The EC2 security group network access port, defaults to tcp:22
136136
* `SUBNET_ID`: The public subnet to use
137137
* `UserAgent`: The User-Agent header to use for all requests
138138
* `VPC_ID`: The EC2 VPC ID
@@ -181,7 +181,7 @@ msf auxiliary(aws_launch_instances) > run
181181
...
182182
[*] instance i-12345678 status: ok
183183
[*] Instance i-12345678 has IP address 54.186.158.6
184-
[*] Auxiliary module execution completed
184+
[*] Auxiliary module execution completed
185185
```
186186

187187
When the host has passed its primary system checks, the IP address will be

documentation/modules/auxiliary/admin/smb/ms17_010_command.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This can be either the plain text version or the Windows hash.
6565

6666
**Automatic Target**
6767

68-
There are multiple targets available for exploit/windows/smb/psexec. The Automatic target is the default target. If the Automatic target detects Powershell on the remote machine, it will try Powershell, otherwise it uses the natvie upload. Each target is explained below.
68+
There are multiple targets available for exploit/windows/smb/psexec. The Automatic target is the default target. If the Automatic target detects Powershell on the remote machine, it will try Powershell, otherwise it uses the native upload. Each target is explained below.
6969

7070
**Powershell Target**
7171

0 commit comments

Comments
 (0)