--- /dev/null
+*****************************************************************************
+The text that follows is the GNU General Public License, Version 2 (GPL V2)
+and governs your use, modification and/or distribution of SNORT.
+
+Section 9 of the GPL V2 acknowledges that the Free Software Foundation may
+publish revised and/or new versions of the GPL V2 from time to time. Section 9
+further states that a licensee of a program subject to the GPL V2 could be
+free to use any such revised and/or new versions under two different scenarios:
+
+1. "Failure to Specify." Section 9 of the GPL V2 allows a licensee of a
+program governed by an unspecified version of the General Public License to
+choose any version of the General Public License ever published by the Free
+Software Foundation to govern his or her use of such program.
+
+This provision is not applicable to your use of SNORT because we have
+expressly stated in a number of instances that any third party's use,
+modification or distribution of SNORT is governed by GPL V2.
+
+2. "Any Later Version." At the end of the terms and condition of the GPL V2 is
+a section called "How to Apply these Terms to Your New Program," which
+provides guidance to a developer on how to apply the GPL V2 to a third party's
+use, modification and/or distribution of his/her program. Among other things,
+this guidance suggests that the developer attach certain notices to the
+program. Of particular importance is the following notice:
+
+"This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version."
+
+Thus if a developer follows strictly the guidance provided by the Free
+Software Foundation, Section 9 of the GPL V2 provides the licensee the option
+to either use, modify or distribute the program under GPL V2 or under any
+later version published by the Free Software Foundation.
+
+SNORT is an open source project that is governed exclusively by the GPL V2
+and any third party desiring to use, modify or distribute SNORT must do so by
+strictly following the terms and conditions of GPL V2. Anyone using, modifying
+or distributing SNORT does not have the option to chose to use, modify or
+distribute SNORT under any revised or new version of the GPL, including
+without limitation, the GNU General Public License Version 3.
+
+For ease of reference, the comparable notice that is used with SNORT
+(contained in the 'README' file) is as follows:
+
+"This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License Version 2 as published by the Free
+Software Foundation. You may not use, modify or distribute this program under
+any other version of the GNU General Public License."
+
+If you have any questions about this statement, please feel free to email
+snort-info@snort.org.
+*****************************************************************************
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+\f
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 19yy <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19yy name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
AM_CXXFLAGS = @AM_CXXFLAGS@
EXTRA_DIST = \
-snort.pc.in
+snort.pc.in \
+README \
+COPYING \
+LICENSE
DISTCLEANFILES = \
stamp-h.in \
--- /dev/null
+Snort++
+
+The Snort++ project has been hard at work for a while now and we are finally ready to release the first alpha of the next generation Snort IPS (Intrusion Prevention System). This post will show you what Snort++ has to offer and guide you through the steps from download to demo. If you are unfamiliar with Snort you should take a look at the Snort documentation first. We will cover the following topics:
+
+* Overview
+* Dependencies
+* Download
+* Build Snort
+* Run Snort
+* Documentation
+* Squeal
+
+OVERVIEW
+
+This first alpha release is based on Snort 2.9.6-9 and excludes all but one of Snort's dynamic preprocessors (ftp_telnet). Work is underway to port that functionality and sync with 2.9.7; those updates will be rolled out as they become available.
+
+ Project = Snort++
+ Binary = snort
+ Version = 3.0.0-a1
+
+Here are some key features in this alpha release:
+
+* Support multiple packet processing threads
+* Use a shared configuration and attribute table
+* Use a simple, scriptable configuration
+* Make key components pluggable
+* Autodetect services for portless configuration
+* Support sticky buffers in rules
+* Autogenerate reference documentation
+* Provide better cross platform support
+
+Additional features on the roadmap include:
+
+* Use a shared network map
+* Support pipelining of packet processing
+* Support hardware offload and data plane integration
+* Rewrite critical modules like TCP reassembly and HTTP inspection
+* Support proxy mode
+* Facilitate component testing
+* Simplify memory management
+* Provide all of Snort's functionality
+
+DEPENDENCIES
+
+If you already build Snort, you may have everything you need. If not, grab the latest:
+
+* autotools or cmake to build from source
+* g++ >= 4.8 or other C++11 compiler
+* daq from http://www.snort.org for packet IO
+* dnet from http://code.google.com/p/libdnet/ for network utility functions
+* LuaJIT from http://luajit.org for configuration and scripting
+* pcap from http://www.tcpdump.org for tcpdump style logging
+* pcre from http://www.pcre.org for regular expression pattern matching
+* zlib from http://www.zlib.net for decompression
+* pkgconfig from http://www.freedesktop.org to build the example plugins
+
+DOWNLOAD
+
+There are two sets of source tarballs, once for autotools and one for cmake. snort-3 contains the base program and snort_extra has example plugins.
+
+ snort-3.0.0-a1-129-auto.tar.gz
+ snort-3.0.0-a1-129-cmake.tar.gz
+
+BUILD SNORT
+
+First do these setup steps:
+
+ export my_path=/path/to/snorty
+ tar zxf snort-tarball
+ cd snort-3.0.0*
+
+Then do one of the following:
+
+To build with autotools, simply do the usual from the top level directory:
+
+ ./configure --prefix=$my_path
+ make -j 8 install
+
+To build with cmake and make, run configure_cmake.sh. It will automatically create and populate a new subdirectory named 'build'.
+
+ ./configure_cmake.sh --prefix=$my_path
+ cd build
+ make -j 8 install
+
+Note:
+
+* If you can do src/snort -V you built successfully.
+* If you are familiar with cmake, you can run cmake/ccmake instead of configure_cmake.sh.
+* cmake --help will list any available generators, such as Xcode. Feel free to use one, however help with those will be provided in a later post.
+
+RUN SNORT
+
+First set up the environment:
+
+ export LUA_PATH=$my_path/include/snort/lua/\?.lua\;\;
+ export SNORT_LUA_PATH=$my_path/etc/snort
+
+Then give it a go:
+
+Snort++ provides lots of help from the command line. Here are some examples:
+
+ $my_path/bin/snort --help
+ $my_path/bin/snort --help-module suppress
+ $my_path/bin/snort --help-config | grep thread
+
+Examine and dump a pcap:
+
+ $my_path/bin/snort -r pcap
+ $my_path/bin/snort -K text -d -e -q -r pcap
+
+Verify a config, with or w/o rules:
+
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -R $my_path/etc/snort/sample.rules
+
+
+Run IDS mode. In the following, replace a.pcap with your favorite. pcaps/ is a directory with one or more *.pcap files:
+
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -R $my_path/etc/snort/sample.rules \
+ -r a.pcap -A alert_test -n 100000
+
+Let's suppress 1:2123. We could edit the conf or just do this:
+
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -R $my_path/etc/snort/sample.rules \
+ -r a.pcap -A alert_test -n 100000 --lua "suppress = { { gid = 1, sid = 2123 } }"
+
+Go whole hog on a directory with multiple packet threads:
+
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -R $my_path/etc/snort/sample.rules \
+ --pcap-filter \*.pcap --pcap-dir pcaps/ -A alert_fast --max-packet-threads 8
+
+DOCUMENTATION
+
+Take a look at the manual, parts of which are generated by the code so it stays up to date:
+
+ $my_path/share/doc/snort/snort_manual.pdf
+ $my_path/share/doc/snort/snort_manual.html
+ $my_path/share/doc/snort/snort_manual/index.html
+
+It does not yet have much on the how and why, but it does have all the currently available configuration, etc. Some key changes to rules:
+
+* you must use comma separated content sub options like this: content:"foo", nocase;
+* buffer selectors must appear before the content and remain in effect until changed
+* pcre buffer selectors were deleted
+* check the manual for more on Snort++ vs Snort
+* check the manual reference section to understand how parameters are defined, etc.
+
+It also covers new features not demonstrated here:
+
+* snort2lua, a tool to convert Snort 2.X conf and rules to the new form
+* a new HTTP inspector, new_http_inspect - incomplete but off to a good start
+* a binder, for mapping configuration to traffic
+* a wizard for port-independent configuration
+* improved rule parsing - arbitrary whitespace, C style comments, #begin/#end comments
+* local and remote command line shell
+
+SQUEAL o")~
+
+We hope you are as excited about Snort++ as we are. Although a lot of work remains, we wanted to give you a chance to try it out and let us know what you think on the snort-users list. In the meantime, we'll keep our snout to the grindstone.
+
set (CPACK_PACKAGE_VERSION_PATCH "${SNORT_VERSION_BUILD}")
set (CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/doc/images/snort.png")
set (CPACK_PACKAGE_INSTALL_DIRECTORY "snort")
-set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/COPYING")
-set (CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/doc/start.txt")
+set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
+set (CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README")
set (CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}")
set (CPACK_SOURCE_IGNORE_FILES "tools/snort2lua/tests/;\\\\.git/;\\\\.gitignore;extra/;${AUTOTOOL_FILES}")
set (CPACK_SOURCE_GENERATOR TGZ)
find_package(LuaJIT REQUIRED)
- # add Snort++ properties to the current build
- string (REPLACE "-DHAVE_CONFIG_H" " " tmp_cmp_flags "${SNORT_INTERFACE_COMPILE_OPTIONS}")
- string (STRIP "${CMAKE_CXX_FLAGS} ${tmp_cmp_flags}" tmp_cmp_flags)
- set (CMAKE_CXX_FLAGS "${tmp_cmp_flags}" CACHE STRING
- "Flags used by the compiler during all build types." FORCE)
- include_directories(${SNORT_INTERFACE_INCLUDE_DIRECTORIES})
- string (STRIP "${CMAKE_EXE_LINKER_FLAGS} ${SNORT_INTERFACE_LINK_FLAGS}" tmp_link_flags)
- set (CMAKE_EXE_LINKER_FLAGS "${tmp_link_flags}" CACHE STRING
- "Flags used by the linker. " FORCE)
+ if ((NOT SNORT_FOUND) AND (NOT SNORT_PKG_MODULE_FOUND))
+ find_package(SNORT REQUIRED) # to print the helpful Snort message
+ message(FATAL_ERROR "Unable to find Snort includes!!")
+ endif()
+
+ string (REPLACE ";" " " CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
+ string (REPLACE "-DHAVE_CONFIG_H" " " CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
+ message(STATUS "${CMAKE_CXX_FLAGS}")
include(CheckCXXCompilerFlag)
endif ()
unset(CMAKE_REQUIRED_FLAGS)
-
add_subdirectory(src)
+
# adding make unisntall
configure_file(
"${CMAKE_CURRENT_SOURCE_DIR}/cmake_uninstall.cmake.in"
# SNORT_EXECUTABLE - The Snort++ executable
# SNORT_INCLUDE_DIR - Snort include directory
#
-#
-# SNORT_INTERFACE_COMPILE_OPTIONS - Snort++'s compile options. If snort.cmake found,
-# use those compile flags. Else, use
-# `pkg-config snort` compile flags
-# SNORT_INTERFACE_INCLUDE_DIRECTORIES - The directories that Snort++ includes
-# when building. retrieved from snort.cmake
-# SNORT_INTERFACE_LINK_FLAGS - Snort++ link flags. retrived from `pkg-config`
-#
set(ERROR_MESSAGE
"
- Unable to find Snort!!! Either
+ Unable to find Snort. Either
1) Using ccmake, manually set the cmake variables
SNORT_INCLUDE_DIR and SNORT_EXECUTABLE.
set(SNORT_EXECUTABLE "${tmp_exe}" CACHE FILEPATH "Snort executable" FORCE)
endif()
- get_target_property(tmp_cflags snort INTERFACE_COMPILE_OPTIONS)
- set (SNORT_INTERFACE_COMPILE_OPTIONS "${tmp_cflags}" CACHE STRING
- "The compile options with which Snort was linked" FORCE)
-
- get_target_property(tmp_int_dir snort INTERFACE_INCLUDE_DIRECTORIES)
- set(SNORT_INTERFACE_INCLUDE_DIRECTORIES "${tmp_int_dir}" CACHE FILEPATH
- "The directories that Snort include's when building" FORCE)
-
-
+ if (NOT SNORT_INCLUDE_DIR)
+ get_target_property(tmp_exe snort INTERFACE_INCLUDE_DIRECTORIES)
+ set(SNORT_INCLUDE_DIR "${tmp_exe}" CACHE FILEPATH "Snort executable" FORCE)
+ endif()
endif(SNORT_IMPORT_FILE)
if (SNORT_PKG_FOUND)
- # CMake file takes precedence over pkg-config file
- if (NOT SNORT_INTERFACE_COMPILE_OPTIONS)
- string(REPLACE ";" " " tmp_cflags "${SNORT_PKG_CFLAGS}")
- set (SNORT_INTERFACE_COMPILE_OPTIONS "${tmp_cflags}" CACHE STRING
- "The compile options with which Snort was linked" FORCE)
- endif()
-
+ # add Snort link flags
+ string(REPLACE ";" " " tmp_cflags "${SNORT_PKG_CFLAGS}")
+ set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${tmp_cflags}" CACHE STRING
+ "Flags used by the compiler during all build types." FORCE)
# add Snort link flags
string(REPLACE ";" " " tmp_lflags "${SNORT_PKG_LDFLAGS}")
- set (SNORT_INTERFACE_LINK_FLAGS "${tmp_lflags}"
- CACHE STRING "The link flags with which the Snort++ binary was linked" FORCE)
-
+ set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${tmp_lflags}"
+ CACHE STRING "Flags used by the linker." FORCE)
if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
set (CMAKE_INSTALL_PREFIX "${SNORT_PKG_PREFIX}" CACHE PATH
"Install path prefix, prepended onto install directories." FORCE)
endif (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+
endif (SNORT_PKG_FOUND)
endif (PKG_CONFIG_FOUND)
find_path (SNORT_INCLUDE_DIR
NAMES main/snort_types.h
- HINTS ${SNORT_INTERFACE_INCLUDE_DIRECTORIES} ENV SNORT_DIR
+ HINTS ${SNORT_PKG_INCLUDE_DIRS} ENV SNORT_DIR
PATH_SUFFIXES snort include/snort
)
)
+
include(FindPackageHandleStandardArgs)
-find_package_handle_standard_args( Snort
+find_package_handle_standard_args(SNORT
REQUIRED_VARS SNORT_INCLUDE_DIR SNORT_EXECUTABLE
FAIL_MESSAGE "${ERROR_MESSAGE}"
)
SNORT_INCLUDE_DIR
SNORT_EXECUTABLE
SNORT_IMPORT_FILE
- SNORT_INTERFACE_COMPILE_OPTIONS
- SNORT_INTERFACE_INCLUDE_DIRECTORIES
- SNORT_INTERFACE_LINK_FLAGS
)
--- /dev/null
+*****************************************************************************
+The text that follows is the GNU General Public License, Version 2 (GPL V2)
+and governs your use, modification and/or distribution of SNORT.
+
+Section 9 of the GPL V2 acknowledges that the Free Software Foundation may
+publish revised and/or new versions of the GPL V2 from time to time. Section 9
+further states that a licensee of a program subject to the GPL V2 could be
+free to use any such revised and/or new versions under two different scenarios:
+
+1. "Failure to Specify." Section 9 of the GPL V2 allows a licensee of a
+program governed by an unspecified version of the General Public License to
+choose any version of the General Public License ever published by the Free
+Software Foundation to govern his or her use of such program.
+
+This provision is not applicable to your use of SNORT because we have
+expressly stated in a number of instances that any third party's use,
+modification or distribution of SNORT is governed by GPL V2.
+
+2. "Any Later Version." At the end of the terms and condition of the GPL V2 is
+a section called "How to Apply these Terms to Your New Program," which
+provides guidance to a developer on how to apply the GPL V2 to a third party's
+use, modification and/or distribution of his/her program. Among other things,
+this guidance suggests that the developer attach certain notices to the
+program. Of particular importance is the following notice:
+
+"This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version."
+
+Thus if a developer follows strictly the guidance provided by the Free
+Software Foundation, Section 9 of the GPL V2 provides the licensee the option
+to either use, modify or distribute the program under GPL V2 or under any
+later version published by the Free Software Foundation.
+
+SNORT is an open source project that is governed exclusively by the GPL V2
+and any third party desiring to use, modify or distribute SNORT must do so by
+strictly following the terms and conditions of GPL V2. Anyone using, modifying
+or distributing SNORT does not have the option to chose to use, modify or
+distribute SNORT under any revised or new version of the GPL, including
+without limitation, the GNU General Public License Version 3.
+
+For ease of reference, the comparable notice that is used with SNORT
+(contained in the 'README' file) is as follows:
+
+"This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License Version 2 as published by the Free
+Software Foundation. You may not use, modify or distribute this program under
+any other version of the GNU General Public License."
+
+If you have any questions about this statement, please feel free to email
+snort-info@snort.org.
+*****************************************************************************
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+\f
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+\f
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+\f
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+\f
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+\f
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 19yy <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
+ USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19yy name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
AUTOMAKE_OPTIONS=foreign no-dependencies
EXTRA_DIST = \
-README
+README \
+COPYING \
+LICENSE
SUBDIRS = \
src
-0. Given this variable:
+Snort++ Extras
-install_dir=/home/snorty/install
+Snort++ is all about plugins. It has over 140 by default and makes it easy to add more in C++ or LuaJIT. This post will walk you through building and running a set of extra example plugins. If you haven't installed and verified Snort++, you will need to do that first. We will cover the following topics:
-1. Build and install the Snort package first:
+* Overview
+* Download
+* Build Extras
+* Run Extras
+* Next Steps
-./configure --prefix=$install_dir ...
+OVERVIEW
-2. Make sure that pkg-config is installed. Then
+The following things are pluggable in Snort++:
-export PKG_CONFIG_PATH=$install_dir/lib/pkgconfig
+* codec - decode and encode support for a given protocol
+* data - additional configuration for inspectors
+* inspector - replaces Snort preprocessors
+* ips_option - IPS rule option like content and byte_test
+* ips_action - IPS rule action like alert and block
+* search_engine - fast pattern matcher
+* logger - event handers
+* SO rules - dynamic rules
-3. Build and install the example plugins:
+DOWNLOAD
-./configure --prefix=$install_dir --with-snort-includes=$install_dir/include/snort
-make
-make install
+There are two extra tarballs, once for autotools and one for cmake:
-4. Run Snort with the example plugins:
+ snort_extra-1.0.0-a1-129-auto.tar.gz
+ snort_extra-1.0.0-a1-129-cmake.tar.gz
-snort --plugin-path $install_dir/lib/snort_examples ...
+BUILD EXTRAS
-5. Now build your own plugins following the examples.
- For inspiration, also look at:
+To build the example plugins, first do these setup steps:
-src/service_handlers/
-src/network_handlers/
-src/event_handlers/
-src/detection_plugins/ips_*
+ tar zxf extra-tarball
+ cd snort_extra-1.0.0*
+ export PKG_CONFIG_PATH=$my_path/lib/pkgconfig
+
+Then do one of the following:
+
+To build with autotools, simply do the usual from the top level directory:
+
+ ./configure --prefix=$my_path --with-snort-includes=$my_path/include/snort
+ make -j 8 install
+
+To build with cmake, do the following:
+
+ mkdir build && cd build
+ cmake ..
+ make -j 8 install
+
+RUN EXTRAS
+
+The following demonstrates a C++ logger and a LuaJIT logger:
+
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -R $my_path/etc/snort/sample.rules \
+ -r pcap --plugin-path $my_path/lib/snort_extra -A alert_ex
+
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -R $my_path/etc/snort/sample.rules \
+ -r pcap --script-path $my_path/lib/snort_extra -A lualert
+
+You can edit $my_path/lib/snort_extra/loggers/alert.lua to tweak the output format and rerun the above command to try it out.
+
+The last example demonstrates a LuaJIT rule option called find. The rule, supplied on stdin, uses the Lua [[ multiline string ]] delimiters to avoid shell escape issues:
+
+ echo 'alert tcp any any -> any 80 ( sid:1; msg:"test"; http_method; find:"pat = [[GET]]"; )' | \
+ $my_path/bin/snort -c $my_path/etc/snort/snort.lua -r pcap \
+ -A cmg --script-path $my_path/lib/snort_extra --stdin-rules
+
+NEXT STEPS o")~
+
+There is no design guide yet but you can develop your own plugins in C++ by using the examples as a starting point. In addition, IPS options and loggers can also be written in LuaJIT. The API may change going forward, but you are encouraged to roll your own now and let us know how it goes so we can incorporate any suggestions in the final design.
set (CPACK_PACKAGE_VERSION_PATCH "${EXTRA_VERSION_BUILD}")
set (CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/doc/images/snort.png")
set (CPACK_PACKAGE_INSTALL_DIRECTORY "snort")
-set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/COPYING")
+set (CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
set (CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README")
set (CPACK_SOURCE_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}")
set (CPACK_SOURCE_IGNORE_FILES "${AUTOTOOL_FILES}")
projects / thirdparty / snort3.git / commitdiff
