home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / nmap254b.zip / HACKING < prev    next >
Text File  |  2000-10-15  |  5KB  |  120 lines
  1. Nmap HACKING
  2. ------------
  3.  
  4. Information for potential Nmap hackers!
  5.  
  6. Source is provided to Nmap because we believe users have a
  7. right to know exactly what a program is going to do before they run
  8. it.  This also allows you to audit the software for security holes
  9. (none have been found so far).
  10.  
  11. Source code also allows you to port Nmap to new platforms, fix bugs,
  12. and add new features.  You are highly encouraged to send your changes
  13. to fyodor@insecure.org or nmap-dev@insecure.org for possible
  14. incorporation into the main distribution.  By sending these changes to
  15. Fyodor or one the insecure.org development mailing lists, it is
  16. assumed that you are offering Fyodor the unlimited, non-exclusive
  17. right to reuse, modify, and relicense the code.  This is important
  18. because the inability to relicense code has caused devastating
  19. problems for other Free Software projects (such as KDE and NASM).
  20. Nmap will always be available Open Source.  If you wish to specify
  21. special license conditions of your contributions, just say so when you
  22. send them.
  23.  
  24. Nmap is a community project and has already benefitted greatly from
  25. outside contributors ( for examples, see the CHANGELOG or
  26. http://www.insecure.org/nmap/#thanks ).  Bugfixes, and portability
  27. changes will almost always be accepted.  Even if you do not have time
  28. to track down and patch a problem, bug reports are always welcome.
  29.  
  30. Hackers interested in something more major, such as a new feature, are
  31. encouraged to send a mail describing their plans to
  32. nmap-dev@insecure.org .  This is a good way to solicit feedback on
  33. your proposals.  List members or often very willing to help.  You
  34. might want to subscribe to that mailing list as well -- send a blank
  35. email to nmap-dev-subscribe@insecure.org .  While you are at it, you
  36. might also want to subscribe to nmap-hackers via the same mechanism.
  37. Web archives of those lists are at http://lists.insecure.org .
  38.  
  39. If you are not ready to send details of your feature to the whole
  40. list, you can always start by mailing fyodor@insecure.org .
  41.  
  42. Some ideas of useful contributions/projects
  43. -------------------------------------------
  44.  
  45. Of course, you are welcome to work on whatever suits your fancy.  But
  46. here are some ideas of contributions that might be particularly
  47. useful:
  48.  
  49. Table Rendering Code -- The system nmap uses for outputing the port
  50. status table is not very extensible.  For example, witness the chaos
  51. in Nmap.c required to support adding an Ident column to the table when
  52. -I is specified.  A simple table rendering library would be userul.
  53. Presumably it would take some sort of specification giving the number
  54. of columns & justification and an array of rows.  Then it would decide
  55. the appropriate column widths and print out the nicely formatted table.
  56.  
  57. NmapFE improvements -- I am currently maintaining NmapFE (also known
  58. as xnmap) -- the GTK GUI front end to Nmap.  I am very open to changes
  59. and improvements in that program.  If you have enhancement ideas, give
  60. it a shot!
  61.  
  62. Debian/SPARC binaries -- I would like to offer Debian and SPARC native
  63. binary packages via the web site.  Right now the nmap 'distro' rule
  64. creates the .tgz and *.rpm versions.  If anyone wants to enhance that
  65. to spit out debian packages as well, that would be great!  A
  66. 'sunpackage' rule that I could run on a sparc would also be useful.
  67. Debian & Solaris packages are already available at debian.org and
  68. sunfreeware.com, but they are not always up-to-date.
  69.  
  70. XML Output -- We have pretty much decided on a format ( see
  71. http://lists.insecure.org/nmap-dev/2000/Jul-Sep/0038.html ) , but the
  72. code hasn't been written yet.  An XSchema or DTD for the format would
  73. also be useful.
  74.  
  75.  
  76. How to make code contributions
  77. ------------------------------
  78.  
  79. The preferred mechanism for submitted changes is unified diffs against
  80. the latest development release version of Nmap.  Please send them to
  81. fyodor@insecure.org or nmap-dev@insecure.org .  
  82.  
  83. To make a unified diff, please follow these instructions:
  84.  
  85. 1. Remove temporary files:
  86.     make clean
  87.  
  88. 2. Rename your source tree:
  89.     cd ..
  90.     mv nmap-2.54BETA4 nmap-2.54BETA4-snazzy-feature
  91.  
  92. 3. Unpack the original Nmap source alongside it:
  93.     tar xzf /tmp/nmap-2.54BETA4.tgz
  94.  
  95. 4. Generate the diffs:
  96.    diff -urNb nmap-2.54BETA4 nmap-2.54BETA4-snazzy-feature > /tmp/nmap.patch
  97.  
  98. 5. Check the patch and remove any unnecessary patches from the file.
  99.  
  100. 6. If you've added several features, it's best to send them as
  101.    several independent patches if you can.
  102.  
  103. If you have just patched one or two files, then making patches is even
  104. easier. For each file, just do:
  105.  
  106.   cp file.c file.c.orig
  107.   [Make changes to file.c ...]
  108.   diff -u file.c.orig file.c > /tmp/file.c.patch
  109.  
  110. and just send us the patch: /tmp/file.c.patch.
  111.  
  112.  
  113. Credits
  114. -------
  115.  
  116. I got the idea for this HACKING file from GNet (
  117. http://www.eecs.umich.edu/~dhelder/misc/gnet/ ) and followed the
  118. general structure of their HACKING file.
  119.  
  120.