{"action":"closed","number":6708,"pull_request":{"url":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/6708","id":64114791,"html_url":"https://github.com/rapid7/metasploit-framework/pull/6708","diff_url":"https://github.com/rapid7/metasploit-framework/pull/6708.diff","patch_url":"https://github.com/rapid7/metasploit-framework/pull/6708.patch","issue_url":"https://api.github.com/repos/rapid7/metasploit-framework/issues/6708","number":6708,"state":"closed","locked":false,"title":"Add module documentation feature in Framework","user":{"login":"wchen-r7","id":1170914,"avatar_url":"https://avatars.githubusercontent.com/u/1170914?v=3","gravatar_id":"","url":"https://api.github.com/users/wchen-r7","html_url":"https://github.com/wchen-r7","followers_url":"https://api.github.com/users/wchen-r7/followers","following_url":"https://api.github.com/users/wchen-r7/following{/other_user}","gists_url":"https://api.github.com/users/wchen-r7/gists{/gist_id}","starred_url":"https://api.github.com/users/wchen-r7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wchen-r7/subscriptions","organizations_url":"https://api.github.com/users/wchen-r7/orgs","repos_url":"https://api.github.com/users/wchen-r7/repos","events_url":"https://api.github.com/users/wchen-r7/events{/privacy}","received_events_url":"https://api.github.com/users/wchen-r7/received_events","type":"User","site_admin":false},"body":"## What This PR Does\r\n\r\nThis pull request adds new features that allow the user to have access to:\r\n\r\n**The Overview section** Allows the user to learn about the module, such as description, basic and advanced usage. Also pull requests associated with the module if a GITHUB_OAUTH_TOKEN environment variable is specified. The overview section is automatically generated content, so every module has it.\r\n\r\n**Knowledge base** The module writer can also provide a manually written markdown doc about the module. For example, how to set up the vulnerable box, explaining about module-specific datastore options, how to use the module in different penetration testing scenarios, etc. In this PR, there are 10 knowledge base docs:\r\n\r\n* tomcat_mgr_login.md\r\n* smb_login.md\r\n* browser_autopwn2.md\r\n* web_delivery.md\r\n* ms08_067_netapi.md\r\n* psexec.md\r\n* windows/meterpreter/reverse_tcp.md\r\n* android/meterpreter/reverse_tcp.md\r\n* local_exploit_suggester.md\r\n* hashdump.md\r\n\r\n**Module documentation over RPC** You can also request the module doc (as HTML) via RPC.\r\n\r\nTo learn more, you can also read the wiki here:\r\nhttps://github.com/rapid7/metasploit-framework/wiki/Generating-Module-Documentation\r\n\r\n## Verification\r\n\r\n**Without the GITHUB_OAUTH_TOKEN environment variable**\r\n\r\n- [x] Make sure you don't have a GITHUB_OAUTH_TOKEN environment variable\r\n- [x] Start msfconsole\r\n- [x] Do: ```use exploit/windows/smb/ms08_067_netapi```\r\n- [x] Do: ```info -d```\r\n- [x] msfconsole should say \"Please wait, generating documentation for ms08_067_netapi\"\r\n- [x] Pretty much immediately, your browser should pop up with the documentation about MS08-067\r\n- [x] At the top of the MS08-067 doc, there should be a Knowledge Base button you can click on, and there should be more content (such as options, scenarios, etc)\r\n\r\n---\r\n\r\n**With the GITHUB_OAUTH_TOKEN environment variable**\r\n\r\n- [x] Obtain a Github access token: https://help.github.com/articles/creating-an-access-token-for-command-line-use/\r\n- [x] Save the access token as a GITHUB_OAUTH_TOKEN environment. For example: if you're on Ubuntu or OS X, then you can add ```export GITHUB_OAUTH_TOKEN=\"[your token]\"``` to file ~/.bash_profile\r\n- [x] Start msfconsole\r\n- [x] Do: ```use exploit/windows/smb/ms08_067_netapi```\r\n- [x] Do: ```info -d```\r\n- [x] msfconsole should say \"Please wait, generating documentation for ms08_067_netapi\". You will wait a little while (depending on your network speed at the time)\r\n- [x] Your browser should pop up with the documentation about MS08-067\r\n- [x] Under Overview, you should see all the pull requests associated with ms08_067_netapi\r\n\r\n---\r\n\r\n**Requesting module documentation via RPC**\r\n\r\n- [x] In the Metasploit directory, start the RPC server by doing: ```ruby msfrpcd -f -U test -P test```\r\n- [x] In a new terminal (still in the Metasploit directory), start the RPC client: ```ruby msfrpc -U test -P test -a 127.0.0.1```\r\n- [x] At the prompt, type: ```rpc.call('module.info_html', 'exploit', 'windows/smb/ms08_067_netapi')```\r\n- [x] It should return the MS08-067 module documentation in HTML form.","created_at":"2016-03-24T23:40:55Z","updated_at":"2016-03-29T18:31:47Z","closed_at":"2016-03-29T18:31:47Z","merged_at":"2016-03-29T18:31:47Z","merge_commit_sha":"c4735bd72a391d8b7be7b1b99d335a00cf9530c0","assignee":{"login":"tdoan-r7","id":1195616,"avatar_url":"https://avatars.githubusercontent.com/u/1195616?v=3","gravatar_id":"","url":"https://api.github.com/users/tdoan-r7","html_url":"https://github.com/tdoan-r7","followers_url":"https://api.github.com/users/tdoan-r7/followers","following_url":"https://api.github.com/users/tdoan-r7/following{/other_user}","gists_url":"https://api.github.com/users/tdoan-r7/gists{/gist_id}","starred_url":"https://api.github.com/users/tdoan-r7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tdoan-r7/subscriptions","organizations_url":"https://api.github.com/users/tdoan-r7/orgs","repos_url":"https://api.github.com/users/tdoan-r7/repos","events_url":"https://api.github.com/users/tdoan-r7/events{/privacy}","received_events_url":"https://api.github.com/users/tdoan-r7/received_events","type":"User","site_admin":false},"milestone":null,"commits_url":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/6708/commits","review_comments_url":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/6708/comments","review_comment_url":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/comments{/number}","comments_url":"https://api.github.com/repos/rapid7/metasploit-framework/issues/6708/comments","statuses_url":"https://api.github.com/repos/rapid7/metasploit-framework/statuses/c4735bd72a391d8b7be7b1b99d335a00cf9530c0","head":{"label":"wchen-r7:mod_doc_cmd","ref":"mod_doc_cmd","sha":"c4735bd72a391d8b7be7b1b99d335a00cf9530c0","user":{"login":"wchen-r7","id":1170914,"avatar_url":"https://avatars.githubusercontent.com/u/1170914?v=3","gravatar_id":"","url":"https://api.github.com/users/wchen-r7","html_url":"https://github.com/wchen-r7","followers_url":"https://api.github.com/users/wchen-r7/followers","following_url":"https://api.github.com/users/wchen-r7/following{/other_user}","gists_url":"https://api.github.com/users/wchen-r7/gists{/gist_id}","starred_url":"https://api.github.com/users/wchen-r7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wchen-r7/subscriptions","organizations_url":"https://api.github.com/users/wchen-r7/orgs","repos_url":"https://api.github.com/users/wchen-r7/repos","events_url":"https://api.github.com/users/wchen-r7/events{/privacy}","received_events_url":"https://api.github.com/users/wchen-r7/received_events","type":"User","site_admin":false},"repo":{"id":3789747,"name":"metasploit-framework","full_name":"wchen-r7/metasploit-framework","owner":{"login":"wchen-r7","id":1170914,"avatar_url":"https://avatars.githubusercontent.com/u/1170914?v=3","gravatar_id":"","url":"https://api.github.com/users/wchen-r7","html_url":"https://github.com/wchen-r7","followers_url":"https://api.github.com/users/wchen-r7/followers","following_url":"https://api.github.com/users/wchen-r7/following{/other_user}","gists_url":"https://api.github.com/users/wchen-r7/gists{/gist_id}","starred_url":"https://api.github.com/users/wchen-r7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wchen-r7/subscriptions","organizations_url":"https://api.github.com/users/wchen-r7/orgs","repos_url":"https://api.github.com/users/wchen-r7/repos","events_url":"https://api.github.com/users/wchen-r7/events{/privacy}","received_events_url":"https://api.github.com/users/wchen-r7/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/wchen-r7/metasploit-framework","description":"Metasploit Framework","fork":true,"url":"https://api.github.com/repos/wchen-r7/metasploit-framework","forks_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/forks","keys_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/keys{/key_id}","collaborators_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/teams","hooks_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/hooks","issue_events_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/issues/events{/number}","events_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/events","assignees_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/assignees{/user}","branches_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/branches{/branch}","tags_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/tags","blobs_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/git/refs{/sha}","trees_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/git/trees{/sha}","statuses_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/statuses/{sha}","languages_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/languages","stargazers_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/stargazers","contributors_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/contributors","subscribers_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/subscribers","subscription_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/subscription","commits_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/commits{/sha}","git_commits_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/git/commits{/sha}","comments_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/comments{/number}","issue_comment_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/issues/comments{/number}","contents_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/contents/{+path}","compare_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/compare/{base}...{head}","merges_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/merges","archive_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/downloads","issues_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/issues{/number}","pulls_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/pulls{/number}","milestones_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/milestones{/number}","notifications_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/labels{/name}","releases_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/releases{/id}","deployments_url":"https://api.github.com/repos/wchen-r7/metasploit-framework/deployments","created_at":"2012-03-21T18:19:05Z","updated_at":"2016-01-22T22:14:42Z","pushed_at":"2016-03-25T01:57:03Z","git_url":"git://github.com/wchen-r7/metasploit-framework.git","ssh_url":"git@github.com:wchen-r7/metasploit-framework.git","clone_url":"https://github.com/wchen-r7/metasploit-framework.git","svn_url":"https://github.com/wchen-r7/metasploit-framework","homepage":"http://www.metasploit.com/","size":300532,"stargazers_count":8,"watchers_count":8,"language":"Ruby","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":3,"mirror_url":null,"open_issues_count":1,"forks":3,"open_issues":1,"watchers":8,"default_branch":"master"}},"base":{"label":"rapid7:master","ref":"master","sha":"18604c3d4437179405e61fe230f194804e7895d4","user":{"login":"rapid7","id":1013671,"avatar_url":"https://avatars.githubusercontent.com/u/1013671?v=3","gravatar_id":"","url":"https://api.github.com/users/rapid7","html_url":"https://github.com/rapid7","followers_url":"https://api.github.com/users/rapid7/followers","following_url":"https://api.github.com/users/rapid7/following{/other_user}","gists_url":"https://api.github.com/users/rapid7/gists{/gist_id}","starred_url":"https://api.github.com/users/rapid7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rapid7/subscriptions","organizations_url":"https://api.github.com/users/rapid7/orgs","repos_url":"https://api.github.com/users/rapid7/repos","events_url":"https://api.github.com/users/rapid7/events{/privacy}","received_events_url":"https://api.github.com/users/rapid7/received_events","type":"Organization","site_admin":false},"repo":{"id":2293158,"name":"metasploit-framework","full_name":"rapid7/metasploit-framework","owner":{"login":"rapid7","id":1013671,"avatar_url":"https://avatars.githubusercontent.com/u/1013671?v=3","gravatar_id":"","url":"https://api.github.com/users/rapid7","html_url":"https://github.com/rapid7","followers_url":"https://api.github.com/users/rapid7/followers","following_url":"https://api.github.com/users/rapid7/following{/other_user}","gists_url":"https://api.github.com/users/rapid7/gists{/gist_id}","starred_url":"https://api.github.com/users/rapid7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rapid7/subscriptions","organizations_url":"https://api.github.com/users/rapid7/orgs","repos_url":"https://api.github.com/users/rapid7/repos","events_url":"https://api.github.com/users/rapid7/events{/privacy}","received_events_url":"https://api.github.com/users/rapid7/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/rapid7/metasploit-framework","description":"Metasploit Framework","fork":false,"url":"https://api.github.com/repos/rapid7/metasploit-framework","forks_url":"https://api.github.com/repos/rapid7/metasploit-framework/forks","keys_url":"https://api.github.com/repos/rapid7/metasploit-framework/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rapid7/metasploit-framework/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rapid7/metasploit-framework/teams","hooks_url":"https://api.github.com/repos/rapid7/metasploit-framework/hooks","issue_events_url":"https://api.github.com/repos/rapid7/metasploit-framework/issues/events{/number}","events_url":"https://api.github.com/repos/rapid7/metasploit-framework/events","assignees_url":"https://api.github.com/repos/rapid7/metasploit-framework/assignees{/user}","branches_url":"https://api.github.com/repos/rapid7/metasploit-framework/branches{/branch}","tags_url":"https://api.github.com/repos/rapid7/metasploit-framework/tags","blobs_url":"https://api.github.com/repos/rapid7/metasploit-framework/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rapid7/metasploit-framework/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rapid7/metasploit-framework/git/refs{/sha}","trees_url":"https://api.github.com/repos/rapid7/metasploit-framework/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rapid7/metasploit-framework/statuses/{sha}","languages_url":"https://api.github.com/repos/rapid7/metasploit-framework/languages","stargazers_url":"https://api.github.com/repos/rapid7/metasploit-framework/stargazers","contributors_url":"https://api.github.com/repos/rapid7/metasploit-framework/contributors","subscribers_url":"https://api.github.com/repos/rapid7/metasploit-framework/subscribers","subscription_url":"https://api.github.com/repos/rapid7/metasploit-framework/subscription","commits_url":"https://api.github.com/repos/rapid7/metasploit-framework/commits{/sha}","git_commits_url":"https://api.github.com/repos/rapid7/metasploit-framework/git/commits{/sha}","comments_url":"https://api.github.com/repos/rapid7/metasploit-framework/comments{/number}","issue_comment_url":"https://api.github.com/repos/rapid7/metasploit-framework/issues/comments{/number}","contents_url":"https://api.github.com/repos/rapid7/metasploit-framework/contents/{+path}","compare_url":"https://api.github.com/repos/rapid7/metasploit-framework/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rapid7/metasploit-framework/merges","archive_url":"https://api.github.com/repos/rapid7/metasploit-framework/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rapid7/metasploit-framework/downloads","issues_url":"https://api.github.com/repos/rapid7/metasploit-framework/issues{/number}","pulls_url":"https://api.github.com/repos/rapid7/metasploit-framework/pulls{/number}","milestones_url":"https://api.github.com/repos/rapid7/metasploit-framework/milestones{/number}","notifications_url":"https://api.github.com/repos/rapid7/metasploit-framework/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rapid7/metasploit-framework/labels{/name}","releases_url":"https://api.github.com/repos/rapid7/metasploit-framework/releases{/id}","deployments_url":"https://api.github.com/repos/rapid7/metasploit-framework/deployments","created_at":"2011-08-30T06:13:20Z","updated_at":"2016-03-29T08:46:34Z","pushed_at":"2016-03-29T18:31:38Z","git_url":"git://github.com/rapid7/metasploit-framework.git","ssh_url":"git@github.com:rapid7/metasploit-framework.git","clone_url":"https://github.com/rapid7/metasploit-framework.git","svn_url":"https://github.com/rapid7/metasploit-framework","homepage":"http://www.metasploit.com/","size":472544,"stargazers_count":5455,"watchers_count":5455,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":3845,"mirror_url":null,"open_issues_count":292,"forks":3845,"open_issues":292,"watchers":5455,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/6708"},"html":{"href":"https://github.com/rapid7/metasploit-framework/pull/6708"},"issue":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/issues/6708"},"comments":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/issues/6708/comments"},"review_comments":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/6708/comments"},"review_comment":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/pulls/6708/commits"},"statuses":{"href":"https://api.github.com/repos/rapid7/metasploit-framework/statuses/c4735bd72a391d8b7be7b1b99d335a00cf9530c0"}},"merged":true,"mergeable":null,"mergeable_state":"unknown","merged_by":{"login":"tdoan-r7","id":1195616,"avatar_url":"https://avatars.githubusercontent.com/u/1195616?v=3","gravatar_id":"","url":"https://api.github.com/users/tdoan-r7","html_url":"https://github.com/tdoan-r7","followers_url":"https://api.github.com/users/tdoan-r7/followers","following_url":"https://api.github.com/users/tdoan-r7/following{/other_user}","gists_url":"https://api.github.com/users/tdoan-r7/gists{/gist_id}","starred_url":"https://api.github.com/users/tdoan-r7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tdoan-r7/subscriptions","organizations_url":"https://api.github.com/users/tdoan-r7/orgs","repos_url":"https://api.github.com/users/tdoan-r7/repos","events_url":"https://api.github.com/users/tdoan-r7/events{/privacy}","received_events_url":"https://api.github.com/users/tdoan-r7/received_events","type":"User","site_admin":false},"comments":2,"review_comments":0,"commits":82,"additions":3463,"deletions":12,"changed_files":34}}