This site is the archived OWASP Foundation Wiki and is no longer accepting Account Requests.
To view the new OWASP Foundation website, please visit https://owasp.org
Difference between revisions of "OWASP Web Mapper Project"
From OWASP
(→OWASP Web Mapper Project) |
|||
(34 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
=Main= | =Main= | ||
− | |||
− | |||
− | |||
<!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE --> | <!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE --> | ||
<div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div> | <div style="width:100%;height:160px;border:0,margin:0;overflow: hidden;">[[File:OWASP_Project_Header.jpg|link=]]</div> | ||
Line 16: | Line 13: | ||
− | This project is designed | + | What if there are quite a few web applications under your organization, but nobody seems to know all of them (before the talk of application risk assessment)? Then this project may be a right fit for you. |
+ | |||
+ | This project is designed to perform the web application asset discovery and auto tracking with scale. | ||
==Description== | ==Description== | ||
− | A pure Ruby library for the web application asset discovery and tracking. The tool is useful when you're handling a larger size organization with multiple Internet | + | A pure Ruby library for the web application asset discovery and tracking. The tool is useful when you're handling a larger size organization with multiple Internet domains and networks registered under the name. Where both legacy and new web applications are omni-present but nobody seems to be able to provide a complete list of application URLs to you. Yes you can always do it the old way by using tool sets such as NMAP, OWASP Zap web crawler, along with others. But such tool sets could quickly become too much manual-driven and inaccurate, if not impossible. In the contrary, once setup, this project will help you quickly identify all the 'unknown' web application asset, and keep track of them automatically. If you are serious about your organization's Internet web application exposure, this might be the perfect all-in-one footprinting tool you're looking for. |
− | Built as an open source project, the source code is both free and | + | Built as an open source project, the source code is both free and scalable. You're welcome to keep building on top of the current code base, or include it as part of your larger project distribution. |
==Licensing== | ==Licensing== | ||
Line 39: | Line 38: | ||
Ideally we could document various reverse-engineering techniques using by this project and publish it through the OWASP Press. Of course, it will always remain freely available, and any money collected will go directly into the project and to the OWASP Foundation. | Ideally we could document various reverse-engineering techniques using by this project and publish it through the OWASP Press. Of course, it will always remain freely available, and any money collected will go directly into the project and to the OWASP Foundation. | ||
− | == | + | == Demo == |
+ | |||
+ | *[http://wmap.io/ Demo] A demo web app exploring WMAP library power. | ||
− | |||
− | == Project | + | == Project Code and Documents == |
+ | * [https://github.com/yangsec888/wmap Latest WMAP source tree.] | ||
+ | * [https://github.com/yangsec888/www_wmap WMAP web app demo built in Ruby on Rails 5+] | ||
− | + | <!-- DO NOT ALTER OR REMOVE THE TEXT ON NEXT LINE --> | |
+ | | valign="top" style="padding-left:25px;width:200px;" | | ||
== Related Projects == | == Related Projects == | ||
Line 53: | Line 56: | ||
* [[OWASP_Zed_Attack_Proxy_Project]] | * [[OWASP_Zed_Attack_Proxy_Project]] | ||
− | == | + | == News and Events == |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.--> | <!-- Instructions are in RED and should be removed from your document by deleting the text with the span tags.--> | ||
− | + | * [January 1 2018] OWASP Web Mapper demo web application released. | |
+ | * [August 1 2015] OWASP Web Mapper Project created. | ||
− | |||
− | |||
− | |||
− | |||
− | + | == Project Leader == | |
− | |||
− | == | ||
− | |||
− | |||
+ | * [https://www.owasp.org/index.php/User:Yang_Li Sam (Yang) Li] | ||
− | |||
== In Print == | == In Print == | ||
− | + | I'm working on project document. But it's far from become a book at this moment. Instead, please refer to the project hosting site for more project document. | |
− | I'm working on project document. But it's far from become a book at this moment. Instead, please refer to the project site for project document. | ||
==Classifications== | ==Classifications== | ||
Line 151: | Line 139: | ||
$ wmap <seed file | target host | target url | target IP or network cidr> | $ wmap <seed file | target host | target url | target IP or network cidr> | ||
− | The above | + | The above utility is intelligent enough to take argument as either a seed file, or a string such as a host, an IP, a network block, or a URL. The new discoveries will be automatically tracked in the data file 'lib/wmap/data/target_sites'. |
Note: seed file - mix of url, cidr and domain seed, one entry per line. | Note: seed file - mix of url, cidr and domain seed, one entry per line. | ||
url seed - known URL(s) for further discovery via the web crawler. | url seed - known URL(s) for further discovery via the web crawler. | ||
Line 161: | Line 149: | ||
$ wdump [output file name from you] | $ wdump [output file name from you] | ||
− | The above | + | The above utility will dump out the discovery database into a single file as program output. Currently, the supported file format is Comma-separated Value (.csv) and Extensible Markup Language (.xml) |
+ | |||
+ | == Other Build-in Utilities == | ||
+ | You may need to update your sset repository from time to time. For this purpose, ‘wmap’ provide three utilities ‘wcheck’, ‘wadd’ and ‘wdel’ to perform the tasks for you. For example, you can check out the status of a site, as shown below: | ||
+ | $ wcheck https://www.owasp.org/ | ||
+ | <nowiki>{"ip"=>"104.130.192.89", "port"=>443, "url"=>"https://www.owasp.org/", "code"=>301, "redirection"=>"https://www.owasp.org/index.php/Main_Page", "md5"=>"d41d8cd98f00b204e9800998ecf8427e", "server"=>"Apache", "timestamp"=>2015-09-02 13:32:31 -0400, "status"=>"ext_hosted"}</nowiki> | ||
+ | |||
+ | You may want to use 'wadd' utility to add it, as shown below: | ||
+ | $ wadd https://www.owasp.org/ | ||
− | == More Usage | + | You may want to use 'wdel' utility to delete it, as shown below: |
− | There are | + | $ wdel https://www.owasp.org/ |
+ | |||
+ | == More Usage Examples == | ||
+ | There are also some code examples under the 'demos' folder of this package. The examples show how to use the 'wmap' API to get your job done easily. Please check out the code - they should be easy and straightforward to be understood. | ||
== More document(s) == | == More document(s) == | ||
− | The software comes with the Ruby doc during your installation as shown above. For your convenience, the Ruby doc is also distributed with | + | The software comes with the Ruby doc during your installation as shown above. For your convenience, the Ruby doc is also distributed with the software. You can navigate to the 'doc' folder of your local installation, and click the 'index.html' to open the start page in your favorite browser. You can also download the wmap-x.x.x.rdoc.zip documentation package alone from the hosting site, unzip and open the doc/index.html in your browser. |
− | If you need additional documentation / information other than this README file and the Ruby document package, please be patient - as I'm still working on it | + | If you need additional documentation / information other than this README file and the Ruby document package, please be patient - as I'm still working on it. |
==How do I report the bugs, or maybe require some new features?== | ==How do I report the bugs, or maybe require some new features?== | ||
Line 201: | Line 200: | ||
= Getting Involved = | = Getting Involved = | ||
− | Involvement in the development and promotion of the OWASP Web Mapper Project is | + | Involvement in the development and promotion of the OWASP Web Mapper Project is encouraged! |
You do not have to be a developer in order to contribute. | You do not have to be a developer in order to contribute. | ||
− | Some of the ways you can | + | Some of the ways you can get involved and contribute: |
+ | * Join the project [https://lists.owasp.org/mailman/listinfo/owasp-web-mapper-project Mailing List]. | ||
* Help QA test the project. | * Help QA test the project. | ||
* Help build a user-friendly front-end. | * Help build a user-friendly front-end. | ||
Line 210: | Line 210: | ||
* Writing support for the book. | * Writing support for the book. | ||
− | + | If you can help, please sign up a [https://github.com/ GITHUB] account, then [mailto:yang.li@owasp.org notify me]. | |