Home page logo
/
Intro Reference Guide Book Install Guide
Download Changelog Zenmap GUI Docs
Bug Reports OS Detection Propaganda Related Projects
In the Movies In the News

Nmap Summer of Code Introduction

The Nmap Security Scanner Project has participated in all nine previous Google Summers of Code and we're really excited for a spectacular 10th SoC in 2014! They have been a tremendous success for us and the 62 student participants we've mentored! Google even featured our success stories and lessons learned in their Open Source Program blog. This innovative and extraordinarily generous program provides $5,500 stipends to 1,000+ college and graduate students each year to create and enhance open source software during their summer break. Students gain valuable experience, get paid, strengthen their résumé, and write code which will be distributed freely and used by millions of people! Last year was a huge success, and we're excited to participate again in 2014.

Nmap is a free tool for network exploration or security auditing. Several project ideas are suggested below, or you can come up with your own clever project. Maybe there is a feature that you have wanted for years, but nobody has yet stepped up to the plate to implement it.

Almost all college and graduate students are eligible, but you need to hurry because student applications are only accepted until Friday, March 21, 19:00 UTC (complete timeline). Applications can be submitted using the orange “Log in” button (under “Students” not “Mentors and Administrators”) on the Google SoC 2014 Homepage. We have written some tips for preparing a great application. If you apply (or plan to), please join the temporary Nmap SoC mailing list to receive announcements. If you have any questions about your ideas, the best place to post them is the Nmap Dev mailing list (you can join here or read the archives online). Questions specific to the Nmap SoC program may be sent to Nmap Dev or SoC lists, but we recommend Nmap Dev if the post is technical in nature.

Note that there are some basic requirements which apply to all sponsored projects.

While we hope you apply for Nmap, you are allowed to apply to multiple organizations. Doing so increases your odds of acceptance as long as you put sufficient time into each app. Many great security-related projects are taking part in SoC this year, including The Tor Project, Netfilter, OpenBSD, Nmap Security Scanner, Privly, Crypto Stick, Freenet, LEAP Encryption Access Project, Tox, OpenKeychain, OWASP, and Syslog-NG.

Project Ideas

While you may submit a proposal for any cool idea your heart desires, here are some suggestions that we consider extremely desirable for the Nmap project and its users:

Index


Performance/Optimization Specialist

Key requirements: Strong C++, algorithm, data structure, benchmarking, and code analysis skills.

We at the Nmap project pride ourselves at writing fast, efficient code, but there is always room for improvement. We're looking for someone who can do a deep dive into Nmap and find ways to improve the user experience by increasing speed and reducing resource (memory, CPU, network) usage. But we don't want to dramatically increase code complexity or cause other major maintenance headaches either.

For this role, deciding what to do will probably involve as much or more work than actually doing that. It will take careful analysis to determine what changes are likely to provide the most postive effect for users for a given amount of work.

The person in this role may also help with our large-scale scanning research to collect empirical data for improving performance, and/or analyze existing large data sets such as the Carna botnet. You will also want to take a close look at "competitor" scanning tools which focus on performance, such as Masscan and Zmap.

Here are some example tasks:

  • Parallelize Nmap's forward DNS (target lookup) system so it doesn't have to handle them one-by-one using the gethostbyname family of system calls.
  • Consider using a binary decision diagram for --exclude list to make it more efficient for large exclude lists. See http://seclists.org/nmap-dev/2012/q4/420.
  • Improve our "top port list" (finding the best ports to scan by default) by using empirical data from the Carna botnet (details) or maybe by conducting large scale Internet scanning research.
  • Benchmark Nmap's fixed rate scanning capability to ensure we can keep up with smaller tools like Masscan and Zmap.
  • Optimize Zenmap to work with large-scale scans without running out of memory or otherwise bogging down.

Applications for this position should focus on your relevant optimization skills and experience as well as any ideas you have for improving Nmap performance.

Nmap Scripting Engine—Script Developers (3 Positions)

Key requirements: Know or quickly learn the (simple) Lua scripting language. Have significant network security and/or network administration skills. Experience with the C and C++ languages is a plus.

In 2006, Diman Todorov worked as a GSoC student with Nmap author Fyodor to create the Nmap Scripting Engine (NSE). It has become one of Nmap's most popular and powerful features, allowing users to write (and share) simple scripts to automate a wide variety of networking tasks. We now have more than 430 scripts, all documented at the NSEDoc Reference Portal. They run the gamut from simple discovery tasks like whois lookups, retrieving web site titles, and banner grabbing, to complex functions like spidering a web server to find SQL injection vulnerabilities and brute force authentication cracking of MSRPC (SMB) servers. For a fun 38-minute introduction to NSE, see Fyodor and David Fifield's 2010 Defcon presentation video.

It is time we make the most of this fast and powerful scripting system! We need talented, creative developers to identify useful scripts (through research and community input) and then implementing them. We already have many candidate script ideas on our wiki.

The script developers will also likely write some new libraries since general code that many scripts are likely to use belongs in libraries rather than the scripts themselves. Developers will also help with testing and reviewing each other's scripts as well as those submitted by the Nmap community. They may also have opportunities to improve the NSE engine and infrastructure itself (this is where the C/C++ experience helps).

If we receive enough great applications and sufficient slots from Google, we would like to sponsor three script developers. Please specify your preferences among the following development roles:

  • Web scanning specialist

    This position is perfect for a budding web guru with intimate knowledge and interest in web-related standards and protocols, particularly HTTP and HTML. SSL, Javascript, CSS, and XML are important too. An understanding of common web vulnerabilities such as SQL injection and cross-site scripting (XSS) will also help. Tools to look at for inspiration include Burp Suite and w3af. Nmap already has quite a few HTTP scripts that you can find on the NSEDoc Portal, but many of them could use improvement and they only scratch the surface of possible scripts. The web has grown to dominate the Internet, so it is crucial that Nmap have solid web scanning capabilities.

  • Discovery scanning specialist

    Nmap is famous for network discovery and it already has 110 discovery scripts. That still isn't good enough for us. Applicants for this position must enjoy learning about and implementing a wide variety of protocols. They will also be the go-to guy (or gal) for any scripts which don't fit either of the positions above, even if they aren't exclusively related to discovery.

  • Vulnerability and exploitation specialist

    If you love researching vulnerabilities and devising (and implementing) scripts to detect and/or exploit them, this position is for you! This person will follow the vulnerability announcement forums and decide which ones merit detection and/or exploitation in Nmap. They will watch what competing vuln scanners and exploitation tools are implementing, but we also hope to beat many of those tools to the punch. Malware detection scripts fit in this role too. You can see our current scripts in this genre by reviewing our vuln, exploit, auth, and malware categories.

While script developers may have specialties, they won't focus exclusively on that single niche. Sometimes priorities or workload balancing will dictate that they work on scripts or libraries which don't precisely match their NSE specialty.


Feature Creepers and Bug Wranglers

Key requirements: Strong C/C++ skills. Python and
Lua skills are valuable as well.

There are many Nmap bugs and desired features which are quite important but take much less than a whole summer to implement. Some may only take hours, while others could take weeks or even a month. The feature creeper and bug wranglers handle many such tasks during the summer. This lets them explore and contribute to a wide variety of the Nmap code base rather than spending the whole summer working on just one subsystem. The exact tasks won't all be itemized in advance, but you can look at the Nmap TODO list for the current list of pending tasks. Also see the community ideas page. If you apply for this task, you might mention several of the TODO items which you would be interested in and qualified for. Here are some more ideas:

  • Implement port scanning from within the Nmap Scripting Engine (see here and here.
  • When high-priority bugs are discovered, you get on the case and solve them.

Rather than take a specific role (bug wrangler or feature creeper), the individual(s) sponsored for this position will do some of each. If you have ideas for small feature-creeping/bug-wrangling tasks, we'd love to hear about them in your application.


Slacker

Nmap developers are known as some of the most productive in the open source world. In order to crank out more code, many eschew luxuries like classes, social lives, sex, and sleep. To counterbalance all of this planned productivity, we may need some experienced slackers to spend the summer playing Call of Duty (or NetHack), surfing Reddit, taking elaborate vacations, and dating. You will report these activities in a weekly status report so the rest of us can live our lives vicariously through yours.

Since laziness is a virtue for this position, our normal application form is not required. Just tell us your best time-wasting story or any other relevant credentials for this critical role.


Your Own Creative Idea!

Key requirements: Creativity

Don't feel constrained to the ideas we have suggested here. If you are very familiar with Nmap and have your own great idea for improvement, propose it! There will be dozens of applicants for each position listed on this page, but your suggestions have less competition. Before writing a whole proposal, we recommend that you send a paragraph or two describing your idea to the nmap-dev list for feedback. Note that even if we don't accept your project idea (maybe the timing is not right or it doesn't quite fit into the Nmap roadmap), we will consider you for other Nmap projects if possible. We pay close attention to the credentials of every applicant and are happy to work with anyone with exceptional talent to find a project which is highly desirable to them and to the Nmap project. So even submitting your own "long shot" idea is often more successful than cut and pasting one of the canned ideas on this page.


Community-contributed Ideas

Key requirements: Varies

If nothing yet has tickled your fancy and you don't want to propose your own idea from scratch, consider some of the commnity-contributed ideas on our wiki. Or feel free to add your own ideas there, even if you don't plan to apply for Nmap SoC.

In addition, we have many candidate ideas in the Nmap TODO list.


Ready to apply? Great! Please visit our SoC Application Notes page for instructions.

Nmap Site Navigation

Intro Reference Guide Book Install Guide
Download Changelog Zenmap GUI Docs
Bug Reports OS Detection Propaganda Related Projects
In the Movies In the News
[ Nmap | Sec Tools | Mailing Lists | Site News | About/Contact | Advertising | Privacy ]