Skip to content

Commit b3d4812

Browse files
committed
Update docs to use links for github handles
1 parent eb12cfe commit b3d4812

10 files changed

+13
-83
lines changed

docs/build.rb

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ def rerender(markdown)
181181
new_markdown.gsub!(link[:full_match], link[:replacement])
182182
end
183183

184-
fix_github_username_links(new_markdown)
184+
new_markdown
185185
end
186186

187187
attr_reader :links
@@ -300,76 +300,6 @@ def new_path_for(old_path, old_path_anchor)
300300

301301
matched_pages.first.fetch(:new_path)
302302
end
303-
304-
def fix_github_username_links(content)
305-
known_github_names = [
306-
'@0a2940',
307-
'@ChrisTuncer',
308-
'@TomSellers',
309-
'@asoto-r7',
310-
'@busterb',
311-
'@bwatters-r7',
312-
'@jbarnett-r7',
313-
'@jlee-r7',
314-
'@jmartin-r7',
315-
'@mcfakepants',
316-
'@Op3n4M3',
317-
'@gwillcox-r7',
318-
'@red0xff',
319-
'@mkienow-r7',
320-
'@pbarry-r7',
321-
'@schierlm',
322-
'@timwr',
323-
'@zerosteiner',
324-
'@zeroSteiner',
325-
'@harmj0y',
326-
]
327-
# These tags look like Github/Twitter handles, but are actually ruby/java code snippets
328-
ignored_tags = [
329-
'@spid',
330-
'@adf3',
331-
'@LDAP-DC3',
332-
'@harmj0yDescription',
333-
'@phpsessid',
334-
'@http_client',
335-
'@abstract',
336-
'@accepts_all_logins',
337-
'@addresses',
338-
'@aliases',
339-
'@channel',
340-
'@client',
341-
'@dep',
342-
'@handle',
343-
'@instance',
344-
'@param',
345-
'@pid',
346-
'@process',
347-
'@return',
348-
'@scanner',
349-
'@yieldparam',
350-
'@yieldreturn',
351-
'@compressed',
352-
'@content',
353-
'@path',
354-
'@sha1',
355-
'@type',
356-
'@git_repo_uri',
357-
'@git_addr',
358-
'@git_objs',
359-
'@refs',
360-
]
361-
362-
# Replace any dangling github usernames, i.e. `@foo` - but not `[@foo](http://...)` or `[email protected]`
363-
content.gsub(/(?<![\[|\w])@[\w-]+/) do |username|
364-
if known_github_names.include? username
365-
"[#{username}](https://www.github.com/#{username.gsub('@', '')})"
366-
elsif ignored_tags.include? username
367-
username
368-
else
369-
raise "Unexpected username: '#{username}'"
370-
end
371-
end
372-
end
373303
end
374304

375305
# Verifies that markdown links are not relative. Instead the Github wiki flavored syntax should be used.

docs/metasploit-framework.wiki/GSoC-2018-Project-Ideas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GSoC Project Ideas in no particular order.
22

3-
Mentors: @busterb, @zerosteiner, @timwr, @asoto-r7, @jmartin-r7, @pbarry-r7, @mkienow-r7, @jbarnett-r7
3+
Mentors: [@busterb](https://github.com/busterb), [@zerosteiner](https://github.com/zerosteiner), [@timwr](https://github.com/timwr), [@asoto-r7](https://github.com/asoto-r7), [@jmartin-r7](https://github.com/jmartin-r7), [@pbarry-r7](https://github.com/pbarry-r7), [@mkienow-r7](https://github.com/mkienow-r7), [@jbarnett-r7](https://github.com/jbarnett-r7)
44

55
## Enhance Metasploit Framework
66

docs/metasploit-framework.wiki/GSoC-2020-Project-Ideas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GSoC Project Ideas in no particular order. When you've picked one, take a look at [[How-to-Apply-to-GSoC]] for how to make a proposal.
22

3-
Mentors: @zerosteiner, @jmartin-r7
3+
Mentors: [@zerosteiner](https://github.com/zerosteiner), [@jmartin-r7](https://github.com/jmartin-r7)
44

55
## Enhance Metasploit Framework
66

docs/metasploit-framework.wiki/GSoC-2021-Project-Ideas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GSoC Project Ideas in no particular order. When you've picked one, take a look at [[How-to-Apply-to-GSoC]] for how to make a proposal.
22

3-
Mentors: @zerosteiner, @jmartin-r7
3+
Mentors: [@zerosteiner](https://github.com/zerosteiner), [@jmartin-r7](https://github.com/jmartin-r7)
44

55
## Enhance Metasploit Framework
66

docs/metasploit-framework.wiki/GSoC-2022-Project-Ideas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GSoC Project Ideas in no particular order. When you've picked one, take a look at [[How-to-Apply-to-GSoC]] for how to make a proposal.
22

3-
Mentors: @zerosteiner, @jmartin-r7, @gwillcox-r7
3+
Mentors: [@zerosteiner](https://github.com/zerosteiner), [@jmartin-r7](https://github.com/jmartin-r7), [@gwillcox-r7](https://github.com/gwillcox-r7)
44

55
Slack Contacts: @zeroSteiner, @Op3n4M3, @gwillcox-r7 on [Metasploit Slack](https://metasploit.slack.com/)
66

docs/metasploit-framework.wiki/GSoC-2023-Project-Ideas.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
GSoC Project Ideas in no particular order. When you've picked one, take a look at [[How-to-Apply-to-GSoC]] for how to make a proposal.
22

3-
Mentors: @jmartin-r7
3+
Mentors: [@jmartin-r7](https://github.com/jmartin-r7)
44

55
Slack Contacts: @Op3n4M3 on [Metasploit Slack](https://metasploit.slack.com/)
66

docs/metasploit-framework.wiki/Landing-Pull-Requests.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,15 +198,15 @@ Filling in the blanks (provided by the original PR's information from GitHub) ge
198198
https://github.com/todb-r7/metasploit-framework/pull/new/schierlm:javapayload-maven...pr1217-fix-gitignore-conflict
199199
````
200200
201-
I opened that in a browser, and ended up with https://github.com/schierlm/metasploit-framework/pull/1 . Once @schierlm landed it on his branch (again, using `git merge --no-ff` and a short, informational merge commit message), all I (or anyone) had to do was `git fetch` to get the change reflected in upstream/pr/1217, and then the integration of the PR could continue.
201+
I opened that in a browser, and ended up with https://github.com/schierlm/metasploit-framework/pull/1 . Once [@schierlm](https://github.com/schierlm) landed it on his branch (again, using `git merge --no-ff` and a short, informational merge commit message), all I (or anyone) had to do was `git fetch` to get the change reflected in upstream/pr/1217, and then the integration of the PR could continue.
202202
203203
# Collaboration between contributors
204204
205205
Note the important bit here: **you do not need commit rights to Rapid7 to branch pull requests**. If Alice knows a solution to Bob's pull request that Juan pointed out, it is **easy** for Alice to provide that solution by following the procedure above. `git blame` will still work correctly, commit histories will all be accurate, everyone on the pull request will be notified of Alice's changes, and Juan doesn't have to wait around for Bob to figure out how to use `send_request_cgi()` or whatever the problem was. The hardest part is remembering how to construct the pull request to Bob -- lucky for you, [this .git/config alias](https://gist.github.com/todb-r7/5438391) makes that part pretty push-button.
206206
207207
# Landing to upstream
208208
209-
Back to PR #1217. Turns out, my change was enough to land the original chunk of work. So, someone else (@jlee-r7) was able to to do something like this:
209+
Back to PR #1217. Turns out, my change was enough to land the original chunk of work. So, someone else ([@jlee-r7](https://github.com/jlee-r7)) was able to to do something like this:
210210
211211
````
212212
$ git fetch upstream
@@ -291,4 +291,4 @@ If that works, great, you know you don't have any merge conflicts right now.
291291
292292
# Questions and Corrections
293293
294-
Reach out in #contributors on [Metasploit Slack](https://metasploit.com/slack), or by e-mailing msfdev at metasploit dot com.
294+
Reach out in #contributors on [Metasploit Slack](https://metasploit.com/slack), or by e-mailing msfdev at metasploit dot com.

docs/metasploit-framework.wiki/MSF6-Feature-Proposals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Tools like Veil, pwnlib, etc. have for a long time used native compilers and too
2020

2121
### Native first-class UUID-aware, async stager payload
2222

23-
Make a new async payload type (based on pingback payload work) making secure comms, endpoint verification, and async communication first-class citizens, and on by default. These session types would support a much more limited set of actions than Meterpreter, only supporting sleep/upload/download/stage, but would be upgraded to Meterpreter directly as-needed (maybe even transparently). Network protocols can be much more exotic for this, and the listener/payload should be usable externally from Metasploit as well. Todo: pull in async payload proposal notes from @bwatters-r7.
23+
Make a new async payload type (based on pingback payload work) making secure comms, endpoint verification, and async communication first-class citizens, and on by default. These session types would support a much more limited set of actions than Meterpreter, only supporting sleep/upload/download/stage, but would be upgraded to Meterpreter directly as-needed (maybe even transparently). Network protocols can be much more exotic for this, and the listener/payload should be usable externally from Metasploit as well. Todo: pull in async payload proposal notes from [@bwatters-r7](https://github.com/bwatters-r7).
2424

2525
## Module Interface
2626

docs/metasploit-framework.wiki/Metasploit-Loginpalooza.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The Loginpalooza contest is over! Congrats and thanks to @TomSellers, @ChrisTuncer, and @0a2940!
1+
The Loginpalooza contest is over! Congrats and thanks to [@TomSellers](https://github.com/TomSellers), [@ChrisTruncer](https://github.com/ChrisTruncer), and [@0a2940](https://github.com/0a2940)!
22

33
The list of [modules to refactor](#modules-to-refactor) is still here. Modules that get refactored should be removed from the list entirely.
44

@@ -115,4 +115,4 @@ If you'd like to learn how to convert your favorite existing module, or write a
115115
- [ ]
116116
[post/windows/gather/enum_domains.rb](https://github.com/rapid7/metasploit-framework/tree/master/modules/post/windows/gather/enum_domains.rb) - Creates realms
117117
- [ ]
118-
[post/windows/gather/enum_logged_on_users.rb](https://github.com/rapid7/metasploit-framework/tree/master/modules/post/windows/gather/enum_logged_on_users.rb) - Creates publics but not privates
118+
[post/windows/gather/enum_logged_on_users.rb](https://github.com/rapid7/metasploit-framework/tree/master/modules/post/windows/gather/enum_logged_on_users.rb) - Creates publics but not privates

docs/metasploit-framework.wiki/SQL-Injection-Libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
SQL Injection library support was added in 2020 by @red0xff during the Google Summer of Code.
1+
SQL Injection library support was added in 2020 by [@red0xff](https://github.com/red0xff) during the Google Summer of Code.
22

33
## Supported Databases
44

0 commit comments

Comments
 (0)