diff --git a/releases/1.1/INSTALL b/releases/1.1/INSTALL new file mode 100644 index 0000000..0c9579f --- /dev/null +++ b/releases/1.1/INSTALL @@ -0,0 +1,66 @@ +IPwatchD requirements +--------------------- + +IPwatchD can be built as a pure daemon (useful for servers without +X Window System) or with desktop notification support. + +To build IPwatchD from source code you will need gcc, libpcap +and libnet1 installed in your system. For desktop notification +support you will also need libnotify. + +On Ubuntu 8.04 it should be sufficient to install following packages: + + - build-essential - C compiler and other development tools + - libpcap-dev - Network packet capture library + - libnet1-dev - Network packet construction library + - libnotify-dev - Desktop notification library + + +Building IPwatchD as a pure daemon +---------------------------------- + +Download IPwatchD source from sourceforge project page. + +Extract code and build it: +$ bunzip2 ipwatchd-x.x.tar.bz2 +$ tar -xf ipwatchd-x.x.tar +$ cd ipwatchd-x.x/src +$ make daemon + + +Building IPwatchD with desktop notification support +--------------------------------------------------- + +Download IPwatchD source from sourceforge project page. + +Extract code and build it: +$ bunzip2 ipwatchd-x.x.tar.bz2 +$ tar -xf ipwatchd-x.x.tar +$ cd ipwatchd-x.x/src +$ make + + +IPwatchD installation and uninstallation +---------------------------------------- + +You can install IPwatchD as root with command: +# make install + +You can uninstall IPwatchD as root with command: +# make uninstall + + +IPwatchD configuration +---------------------- + +IPwatchD executable is copied into /usr/local/sbin +and the configuration file is copied into /usr/local/etc. + +Edit configuration file /usr/local/etc/ipwatchd.conf with +your favourite editor to suite your needs. + +Run IPwatchD as root with command: +# /usr/local/sbin/ipwatchd -c /usr/local/etc/ipwatchd.conf + +For more information please read "ipwatchd" manual page. + diff --git a/releases/1.1/LICENCE b/releases/1.1/LICENCE new file mode 100644 index 0000000..d511905 --- /dev/null +++ b/releases/1.1/LICENCE @@ -0,0 +1,339 @@ + 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 Lesser 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. + + 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.) + +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. + + 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. + + 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 + + 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. + + + Copyright (C) + + 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) year 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. + + , 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 Lesser General +Public License instead of this License. diff --git a/releases/1.1/doc/doxygen.conf b/releases/1.1/doc/doxygen.conf new file mode 100644 index 0000000..9dca3bb --- /dev/null +++ b/releases/1.1/doc/doxygen.conf @@ -0,0 +1,1356 @@ +# Doxyfile 1.5.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = IPwatchD + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 1.0.1 + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./ + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = ../src/ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify o:ne or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.c *.h + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = doxygen + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/releases/1.1/doc/doxygen/analyse_8c.html b/releases/1.1/doc/doxygen/analyse_8c.html new file mode 100644 index 0000000..c2079ad --- /dev/null +++ b/releases/1.1/doc/doxygen/analyse_8c.html @@ -0,0 +1,123 @@ + + +IPwatchD: analyse.c File Reference + + + + + +
+

analyse.c File Reference

Contains logic used for analysing of captured ARP packets. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + + + + +

Functions

void ipwd_analyse (u_char *args, const struct pcap_pkthdr *header, const u_char *packet)
 Callback for "pcap_loop" with standard parameters. Called when ARP packet is received (detection of conflict is done here).

Variables

IPWD_S_DEVS devices
 Structure that holds information about network interfaces.
char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
+

Detailed Description

+Contains logic used for analysing of captured ARP packets. +

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void ipwd_analyse (u_char *  args,
const struct pcap_pkthdr *  header,
const u_char *  packet 
)
+
+
+ +

+Callback for "pcap_loop" with standard parameters. Called when ARP packet is received (detection of conflict is done here). +

+

Parameters:
+ + + + +
args Last parameter of pcap_loop
header Packet header
packet Packet data
+
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
IPWD_S_DEVS devices
+
+
+ +

+Structure that holds information about network interfaces. +

+ +

+

+ +

+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/annotated.html b/releases/1.1/doc/doxygen/annotated.html new file mode 100644 index 0000000..fd8a40c --- /dev/null +++ b/releases/1.1/doc/doxygen/annotated.html @@ -0,0 +1,34 @@ + + +IPwatchD: Data Structures + + + + + +
+

Data Structures

Here are the data structures with brief descriptions: + + + +
IPWD_S_ARP_HEADERStructure useful for parsing of individual addresses from packet
IPWD_S_DEVStructure that holds information about ONE network interface
IPWD_S_DEVSStructure that holds information about ALL network interfaces
+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/config_8c.html b/releases/1.1/doc/doxygen/config_8c.html new file mode 100644 index 0000000..76c85d6 --- /dev/null +++ b/releases/1.1/doc/doxygen/config_8c.html @@ -0,0 +1,158 @@ + + +IPwatchD: config.c File Reference + + + + + +
+

config.c File Reference

Contains logic used for parsing of configuration. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + + + + + + + + + + +

Functions

int ipwd_file_exists (char *filename)
 Checks existence of the file.
int ipwd_read_config (char *filename)
 Reads configuration file and stores names of interfaces into the "devices" structure.

Variables

int debug_flag
 Flag indicating debug mode.
IPWD_S_DEVS devices
 Structure that holds information about network interfaces.
char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
+

Detailed Description

+Contains logic used for parsing of configuration. +

+

Function Documentation

+ +
+
+ + + + + + + + + +
int ipwd_file_exists (char *  filename  ) 
+
+
+ +

+Checks existence of the file. +

+

Parameters:
+ + +
filename Path to the file
+
+
Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+ +

+
+ + + + + + + + + +
int ipwd_read_config (char *  filename  ) 
+
+
+ +

+Reads configuration file and stores names of interfaces into the "devices" structure. +

+

Parameters:
+ + +
filename Path to the configurationfile
+
+
Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
int debug_flag
+
+
+ +

+Flag indicating debug mode. +

+ +

+

+ +

+
+ + + + +
IPWD_S_DEVS devices
+
+
+ +

+Structure that holds information about network interfaces. +

+ +

+

+ +

+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/daemonize_8c.html b/releases/1.1/doc/doxygen/daemonize_8c.html new file mode 100644 index 0000000..67f5b16 --- /dev/null +++ b/releases/1.1/doc/doxygen/daemonize_8c.html @@ -0,0 +1,82 @@ + + +IPwatchD: daemonize.c File Reference + + + + + +
+

daemonize.c File Reference

Contains logic used for daemonization of the proccess. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + +

Functions

int ipwd_daemonize (void)
 Daemonizes the proccess.

Variables

char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
+

Detailed Description

+Contains logic used for daemonization of the proccess. +

+

Function Documentation

+ +
+
+ + + + + + + + + +
int ipwd_daemonize (void   ) 
+
+
+ +

+Daemonizes the proccess. +

+

Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/desktop_8c.html b/releases/1.1/doc/doxygen/desktop_8c.html new file mode 100644 index 0000000..ccf07d4 --- /dev/null +++ b/releases/1.1/doc/doxygen/desktop_8c.html @@ -0,0 +1,65 @@ + + +IPwatchD: desktop.c File Reference + + + + + +
+

desktop.c File Reference

Contains logic used for showing notification pop-ups on desktop. More... +

+#include <libnotify/notify.h>
+#include "ipwatchd.h"
+ + + + + + +

Functions

void ipwd_desktop_notification (char *message)
 Shows desktop pop-up notification with libnotify.
+

Detailed Description

+Contains logic used for showing notification pop-ups on desktop. +

+

Function Documentation

+ +
+
+ + + + + + + + + +
void ipwd_desktop_notification (char *  message  ) 
+
+
+ +

+Shows desktop pop-up notification with libnotify. +

+

Parameters:
+ + +
message Message to be shown
+
+ +
+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/devinfo_8c.html b/releases/1.1/doc/doxygen/devinfo_8c.html new file mode 100644 index 0000000..e5c1199 --- /dev/null +++ b/releases/1.1/doc/doxygen/devinfo_8c.html @@ -0,0 +1,104 @@ + + +IPwatchD: devinfo.c File Reference + + + + + +
+

devinfo.c File Reference

Contains logic used for acquiring information about network devices. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + +

Functions

int ipwd_devinfo (char *p_dev, char *p_ip, char *p_mac)
 Gets the IP and MAC addresses of specified device in human readable form.

Variables

char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
+

Detailed Description

+Contains logic used for acquiring information about network devices. +

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int ipwd_devinfo (char *  p_dev,
char *  p_ip,
char *  p_mac 
)
+
+
+ +

+Gets the IP and MAC addresses of specified device in human readable form. +

+Based on examples from: http://english.geekpage.jp/programming/linux-network/

Parameters:
+ + + + +
p_dev Name of the device (i.e. eth0)
p_ip Pointer to string where the IP address should be stored
p_mac Pointer to string where the MAC address should be stored
+
+
Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/doxygen.css b/releases/1.1/doc/doxygen/doxygen.css new file mode 100644 index 0000000..74c22a2 --- /dev/null +++ b/releases/1.1/doc/doxygen/doxygen.css @@ -0,0 +1,433 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { + font-weight: bold +} +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navpath { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { + text-decoration: none; + background-color: #6666cc; + color: #ffffff +} +A.el { + text-decoration: none; + font-weight: bold +} +A.elRef { + font-weight: bold +} +A.code:link { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.code:visited { + text-decoration: none; + font-weight: normal; + color: #0000FF +} +A.codeRef:link { + font-weight: normal; + color: #0000FF +} +A.codeRef:visited { + font-weight: normal; + color: #0000FF +} +A:hover { + text-decoration: none; + background-color: #f2f2ff +} +DL.el { + margin-left: -1cm +} +.fragment { + font-family: monospace, fixed; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px +} + +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { + margin-left: 16px; + font-style: italic; + font-size: 90% +} +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { + text-align: center; +} +IMG.formulaDsp { +} +IMG.formulaInl { + vertical-align: middle; +} +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +SPAN.vhdldigit { color: #ff00ff } +SPAN.vhdlchar { color: #000000 } +SPAN.vhdlkeyword { color: #700070 } +SPAN.vhdllogic { color: #ff0000 } + +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { + color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { + font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { + background: #e8eef2; + font-weight: bold; +} +HR { + height: 1px; + border: none; + border-top: 1px solid black; +} + +/* Style for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; + margin-left: 3px; +} +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; +} +.memname { + white-space: nowrap; + font-weight: bold; +} +.memdoc{ + padding-left: 10px; +} +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; +} +.paramkey { + text-align: right; +} +.paramtype { + white-space: nowrap; +} +.paramname { + color: #602020; + font-style: italic; + white-space: nowrap; +} +/* End Styling for detailed member documentation */ + +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin:0.5em; +} +.directory { + font-size: 9pt; + font-weight: bold; +} +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} +.directory > h3 { + margin-top: 0; +} +.directory p { + margin: 0px; + white-space: nowrap; +} +.directory div { + display: none; + margin: 0px; +} +.directory img { + vertical-align: -30%; +} + diff --git a/releases/1.1/doc/doxygen/doxygen.png b/releases/1.1/doc/doxygen/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/releases/1.1/doc/doxygen/doxygen.png differ diff --git a/releases/1.1/doc/doxygen/files.html b/releases/1.1/doc/doxygen/files.html new file mode 100644 index 0000000..ff4086d --- /dev/null +++ b/releases/1.1/doc/doxygen/files.html @@ -0,0 +1,41 @@ + + +IPwatchD: File Index + + + + + +
+

File List

Here is a list of all documented files with brief descriptions: + + + + + + + + + + +
analyse.cContains logic used for analysing of captured ARP packets
config.cContains logic used for parsing of configuration
daemonize.cContains logic used for daemonization of the proccess
desktop.cContains logic used for showing notification pop-ups on desktop
devinfo.cContains logic used for acquiring information about network devices
genarp.cContains logic used for generation of ARP packets
ipwatchd.cMain source file of the project
ipwatchd.hMain header file of the project
message.cContains logic used for manipulating program messages
signal.cContains logic used for signal handling
+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/functions.html b/releases/1.1/doc/doxygen/functions.html new file mode 100644 index 0000000..38b9c58 --- /dev/null +++ b/releases/1.1/doc/doxygen/functions.html @@ -0,0 +1,59 @@ + + +IPwatchD: Data Fields + + + + + +
+Here is a list of all documented struct and union fields with links to the struct/union documentation for each field: +

+

+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/functions_vars.html b/releases/1.1/doc/doxygen/functions_vars.html new file mode 100644 index 0000000..ef9bf0c --- /dev/null +++ b/releases/1.1/doc/doxygen/functions_vars.html @@ -0,0 +1,59 @@ + + +IPwatchD: Data Fields - Variables + + + + + +
+  +

+

+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/genarp_8c.html b/releases/1.1/doc/doxygen/genarp_8c.html new file mode 100644 index 0000000..556f136 --- /dev/null +++ b/releases/1.1/doc/doxygen/genarp_8c.html @@ -0,0 +1,125 @@ + + +IPwatchD: genarp.c File Reference + + + + + +
+

genarp.c File Reference

Contains logic used for generation of ARP packets. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + +

Functions

int ipwd_genarp (char *dev, char *p_sip, char *p_smac, char *p_dip, char *p_dmac, int opcode)
 Generates ARP packet with libnet1.

Variables

char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
+

Detailed Description

+Contains logic used for generation of ARP packets. +

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int ipwd_genarp (char *  dev,
char *  p_sip,
char *  p_smac,
char *  p_dip,
char *  p_dmac,
int  opcode 
)
+
+
+ +

+Generates ARP packet with libnet1. +

+

Parameters:
+ + + + + + + +
dev Name of the device
p_sip Source IP address
p_smac Source MAC address
p_dip Destination IP address
p_dmac Destination MAC address
opcode ARPOP_REQUEST or ARPOP_REPLY
+
+
Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/globals.html b/releases/1.1/doc/doxygen/globals.html new file mode 100644 index 0000000..736e091 --- /dev/null +++ b/releases/1.1/doc/doxygen/globals.html @@ -0,0 +1,128 @@ + + +IPwatchD: Data Fields + + + + + +
+Here is a list of all documented functions, variables, defines, enums, and typedefs with links to the documentation: +

+

- d -

+

- h -

+

- i -

+

- m -

+

- s -

+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/globals_defs.html b/releases/1.1/doc/doxygen/globals_defs.html new file mode 100644 index 0000000..f219ceb --- /dev/null +++ b/releases/1.1/doc/doxygen/globals_defs.html @@ -0,0 +1,63 @@ + + +IPwatchD: Data Fields + + + + + +
+  +

+

+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/globals_func.html b/releases/1.1/doc/doxygen/globals_func.html new file mode 100644 index 0000000..c499abb --- /dev/null +++ b/releases/1.1/doc/doxygen/globals_func.html @@ -0,0 +1,65 @@ + + +IPwatchD: Data Fields + + + + + +
+  +

+

+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/globals_vars.html b/releases/1.1/doc/doxygen/globals_vars.html new file mode 100644 index 0000000..6cae3f6 --- /dev/null +++ b/releases/1.1/doc/doxygen/globals_vars.html @@ -0,0 +1,63 @@ + + +IPwatchD: Data Fields + + + + + +
+  +

+

+
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/index.html b/releases/1.1/doc/doxygen/index.html new file mode 100644 index 0000000..0e110ad --- /dev/null +++ b/releases/1.1/doc/doxygen/index.html @@ -0,0 +1,25 @@ + + +IPwatchD: Main Page + + + + + +
+

IPwatchD Documentation

+

+

1.0.1

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/ipwatchd_8c.html b/releases/1.1/doc/doxygen/ipwatchd_8c.html new file mode 100644 index 0000000..b25db63 --- /dev/null +++ b/releases/1.1/doc/doxygen/ipwatchd_8c.html @@ -0,0 +1,202 @@ + + +IPwatchD: ipwatchd.c File Reference + + + + + +
+

ipwatchd.c File Reference

Main source file of the project. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

int main (int argc, char *argv[])
 Main function of the program.
void ipwd_print_help (void)
 Prints help to the stdout.

Variables

int debug_flag = 0
 Flag indicating debug mode.
int syslog_flag = 0
 Flag indicating that output of program must be recorded by syslog.
IPWD_S_DEVS devices
 Structure that holds information about network interfaces.
char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
pcap_t * h_pcap = NULL
 Handle for libpcap.
+

Detailed Description

+Main source file of the project. +

+

Function Documentation

+ +
+
+ + + + + + + + + +
void ipwd_print_help (void   ) 
+
+
+ +

+Prints help to the stdout. +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int main (int  argc,
char *  argv[] 
)
+
+
+ +

+Main function of the program. +

+

Parameters:
+ + + +
argc Number of received command line arguments
argv Argument values
+
+
Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
int debug_flag = 0
+
+
+ +

+Flag indicating debug mode. +

+ +

+

+ +

+
+ + + + +
IPWD_S_DEVS devices
+
+
+ +

+Structure that holds information about network interfaces. +

+ +

+

+ +

+
+ + + + +
pcap_t* h_pcap = NULL
+
+
+ +

+Handle for libpcap. +

+ +

+

+ +

+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+ +

+
+ + + + +
int syslog_flag = 0
+
+
+ +

+Flag indicating that output of program must be recorded by syslog. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/ipwatchd_8h.html b/releases/1.1/doc/doxygen/ipwatchd_8h.html new file mode 100644 index 0000000..0e68e95 --- /dev/null +++ b/releases/1.1/doc/doxygen/ipwatchd_8h.html @@ -0,0 +1,276 @@ + + +IPwatchD: ipwatchd.h File Reference + + + + + +
+

ipwatchd.h File Reference

Main header file of the project. More... +

+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <signal.h>
+#include <syslog.h>
+#include <net/if.h>
+#include <netinet/ether.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <sys/ioctl.h>
+#include <libnet.h>
+#include <pcap.h>
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Data Structures

struct  IPWD_S_DEV
 Structure that holds information about ONE network interface. More...
struct  IPWD_S_DEVS
 Structure that holds information about ALL network interfaces. More...
struct  IPWD_S_ARP_HEADER
 Structure useful for parsing of individual addresses from packet. More...

Defines

#define IPWATCHD_VERSION   "IPwatchD 1.0.1"
 String with IPwatchD version information.
#define IPWD_RV_SUCCESS   0
 "Success" return value of IPwatchD internal functions
#define IPWD_RV_ERROR   2
 "Error" return value of IPwatchD internal functions
#define IPWD_MSG_BUFSIZ   1000
 Size of buffer for output messages.
#define IPWD_MSG_INFO   1
 Message type: information.
#define IPWD_MSG_ERROR   2
 Message type: error.
#define IPWD_MSG_ALERT   3
 Message type: alert.
#define IPWD_MSG_DEBUG   4
 Message type: debug.
#define IPWD_MODE_ACTIVE   1
 Indicates that IPwatchD should operate in active mode on selected device.
#define IPWD_MODE_PASSIVE   2
 Indicates that IPwatchD should operate in passive mode on selected device.
#define IPWD_ARP_HEADER_SIZE   24
 Number of useless bytes in ARP packet.
+

Detailed Description

+Main header file of the project. +

+

Define Documentation

+ +
+
+ + + + +
#define IPWATCHD_VERSION   "IPwatchD 1.0.1"
+
+
+ +

+String with IPwatchD version information. +

+ +

+

+ +

+
+ + + + +
#define IPWD_ARP_HEADER_SIZE   24
+
+
+ +

+Number of useless bytes in ARP packet. +

+Parsing of packets captured by libpcap on pseudo device "any" seems to be slightly different than parsing of packets captured on one particular interface. Instead of usual 14th byte addresses begin on 24th byte of ARP header. +

+

+ +

+
+ + + + +
#define IPWD_MODE_ACTIVE   1
+
+
+ +

+Indicates that IPwatchD should operate in active mode on selected device. +

+ +

+

+ +

+
+ + + + +
#define IPWD_MODE_PASSIVE   2
+
+
+ +

+Indicates that IPwatchD should operate in passive mode on selected device. +

+ +

+

+ +

+
+ + + + +
#define IPWD_MSG_ALERT   3
+
+
+ +

+Message type: alert. +

+ +

+

+ +

+
+ + + + +
#define IPWD_MSG_BUFSIZ   1000
+
+
+ +

+Size of buffer for output messages. +

+ +

+

+ +

+
+ + + + +
#define IPWD_MSG_DEBUG   4
+
+
+ +

+Message type: debug. +

+ +

+

+ +

+
+ + + + +
#define IPWD_MSG_ERROR   2
+
+
+ +

+Message type: error. +

+ +

+

+ +

+
+ + + + +
#define IPWD_MSG_INFO   1
+
+
+ +

+Message type: information. +

+ +

+

+ +

+
+ + + + +
#define IPWD_RV_ERROR   2
+
+
+ +

+"Error" return value of IPwatchD internal functions +

+ +

+

+ +

+
+ + + + +
#define IPWD_RV_SUCCESS   0
+
+
+ +

+"Success" return value of IPwatchD internal functions +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/message_8c.html b/releases/1.1/doc/doxygen/message_8c.html new file mode 100644 index 0000000..b70a5c1 --- /dev/null +++ b/releases/1.1/doc/doxygen/message_8c.html @@ -0,0 +1,116 @@ + + +IPwatchD: message.c File Reference + + + + + +
+

message.c File Reference

Contains logic used for manipulating program messages. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + + + + +

Functions

void ipwd_message (char *msg, int type)
 Handles output of messages generated by IPwatchD.

Variables

int debug_flag
 Flag indicating debug mode.
int syslog_flag
 Flag indicating that output of program must be recorded by syslog.
+

Detailed Description

+Contains logic used for manipulating program messages. +

+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void ipwd_message (char *  msg,
int  type 
)
+
+
+ +

+Handles output of messages generated by IPwatchD. +

+

Parameters:
+ + + +
msg Message to output
type Type of message. Possible values are IPWD_MSG_INFO, IPWD_MSG_ERROR and IPWD_MSG_ALERT.
+
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
int debug_flag
+
+
+ +

+Flag indicating debug mode. +

+ +

+

+ +

+
+ + + + +
int syslog_flag
+
+
+ +

+Flag indicating that output of program must be recorded by syslog. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/signal_8c.html b/releases/1.1/doc/doxygen/signal_8c.html new file mode 100644 index 0000000..6bae220 --- /dev/null +++ b/releases/1.1/doc/doxygen/signal_8c.html @@ -0,0 +1,132 @@ + + +IPwatchD: signal.c File Reference + + + + + +
+

signal.c File Reference

Contains logic used for signal handling. More... +

+#include "ipwatchd.h"
+ + + + + + + + + + + + + + + + +

Functions

int ipwd_set_signal_handler (void)
 Sets signal handler for SIGTERM.
void ipwd_signal_handler (int signal)
 Signal handler that is called when signal received.

Variables

char msgbuf [IPWD_MSG_BUFSIZ]
 Buffer for output messages.
pcap_t * h_pcap
 Handle for libpcap.
+

Detailed Description

+Contains logic used for signal handling. +

+

Function Documentation

+ +
+
+ + + + + + + + + +
int ipwd_set_signal_handler (void   ) 
+
+
+ +

+Sets signal handler for SIGTERM. +

+

Returns:
IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise
+ +
+

+ +

+
+ + + + + + + + + +
void ipwd_signal_handler (int  signal  ) 
+
+
+ +

+Signal handler that is called when signal received. +

+

Parameters:
+ + +
signal Signal identifier
+
+ +
+

+

Variable Documentation

+ +
+
+ + + + +
pcap_t* h_pcap
+
+
+ +

+Handle for libpcap. +

+ +

+

+ +

+
+ + + + +
char msgbuf[IPWD_MSG_BUFSIZ]
+
+
+ +

+Buffer for output messages. +

+ +

+

+

+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/structIPWD__S__ARP__HEADER.html b/releases/1.1/doc/doxygen/structIPWD__S__ARP__HEADER.html new file mode 100644 index 0000000..ed66ff9 --- /dev/null +++ b/releases/1.1/doc/doxygen/structIPWD__S__ARP__HEADER.html @@ -0,0 +1,110 @@ + + +IPwatchD: IPWD_S_ARP_HEADER Struct Reference + + + + + +
+

IPWD_S_ARP_HEADER Struct Reference

Structure useful for parsing of individual addresses from packet. +More... +

+#include <ipwatchd.h> +

+ + + + + + + + + + + +

Data Fields

u_int8_t arp_sha [ETH_ALEN]
u_int8_t arp_spa [4]
u_int8_t arp_tha [ETH_ALEN]
u_int8_t arp_tpa [4]
+

Detailed Description

+Structure useful for parsing of individual addresses from packet.

Field Documentation

+ +
+
+ + + + +
u_int8_t IPWD_S_ARP_HEADER::arp_sha[ETH_ALEN]
+
+
+ +

+Source MAC address +

+

+ +

+
+ + + + +
u_int8_t IPWD_S_ARP_HEADER::arp_spa[4]
+
+
+ +

+Source IP address +

+

+ +

+
+ + + + +
u_int8_t IPWD_S_ARP_HEADER::arp_tha[ETH_ALEN]
+
+
+ +

+Destination MAC address +

+

+ +

+
+ + + + +
u_int8_t IPWD_S_ARP_HEADER::arp_tpa[4]
+
+
+ +

+Destination IP address +

+

+

The documentation for this struct was generated from the following file: +
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/structIPWD__S__DEV.html b/releases/1.1/doc/doxygen/structIPWD__S__DEV.html new file mode 100644 index 0000000..10d7898 --- /dev/null +++ b/releases/1.1/doc/doxygen/structIPWD__S__DEV.html @@ -0,0 +1,110 @@ + + +IPwatchD: IPWD_S_DEV Struct Reference + + + + + +
+

IPWD_S_DEV Struct Reference

Structure that holds information about ONE network interface. +More... +

+#include <ipwatchd.h> +

+ + + + + + + + + + + +

Data Fields

char device [10]
char ip [20]
char mac [20]
int mode
+

Detailed Description

+Structure that holds information about ONE network interface.

Field Documentation

+ +
+
+ + + + +
char IPWD_S_DEV::device[10]
+
+
+ +

+Device name +

+

+ +

+
+ + + + +
char IPWD_S_DEV::ip[20]
+
+
+ +

+IP address of device +

+

+ +

+
+ + + + +
char IPWD_S_DEV::mac[20]
+
+
+ +

+MAC address of device +

+

+ +

+
+ + + + +
int IPWD_S_DEV::mode
+
+
+ +

+IPwatch mode on interface: IPWATCHD_DEVICE_MODE_ACTIVE or IPWATCHD_DEVICE_MODE_PASSIVE +

+

+

The documentation for this struct was generated from the following file: +
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/structIPWD__S__DEVS.html b/releases/1.1/doc/doxygen/structIPWD__S__DEVS.html new file mode 100644 index 0000000..b23a361 --- /dev/null +++ b/releases/1.1/doc/doxygen/structIPWD__S__DEVS.html @@ -0,0 +1,76 @@ + + +IPwatchD: IPWD_S_DEVS Struct Reference + + + + + +
+

IPWD_S_DEVS Struct Reference

Structure that holds information about ALL network interfaces. +More... +

+#include <ipwatchd.h> +

+ + + + + + + +

Data Fields

IPWD_S_DEV * dev
int devnum
+

Detailed Description

+Structure that holds information about ALL network interfaces.

Field Documentation

+ +
+
+ + + + +
IPWD_S_DEV* IPWD_S_DEVS::dev
+
+
+ +

+Dynamicaly allocated array of IPWD_S_DEV structures +

+

+ +

+
+ + + + +
int IPWD_S_DEVS::devnum
+
+
+ +

+Number of watched interfaces +

+

+

The documentation for this struct was generated from the following file: +
+
Generated on Tue Aug 12 16:23:50 2008 for IPwatchD by  + +doxygen 1.5.5
+ + diff --git a/releases/1.1/doc/doxygen/tab_b.gif b/releases/1.1/doc/doxygen/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/releases/1.1/doc/doxygen/tab_b.gif differ diff --git a/releases/1.1/doc/doxygen/tab_l.gif b/releases/1.1/doc/doxygen/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/releases/1.1/doc/doxygen/tab_l.gif differ diff --git a/releases/1.1/doc/doxygen/tab_r.gif b/releases/1.1/doc/doxygen/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/releases/1.1/doc/doxygen/tab_r.gif differ diff --git a/releases/1.1/doc/doxygen/tabs.css b/releases/1.1/doc/doxygen/tabs.css new file mode 100644 index 0000000..95f00a9 --- /dev/null +++ b/releases/1.1/doc/doxygen/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/releases/1.1/doc/ipwatchd.8 b/releases/1.1/doc/ipwatchd.8 new file mode 100644 index 0000000..24e7005 --- /dev/null +++ b/releases/1.1/doc/ipwatchd.8 @@ -0,0 +1,48 @@ +.TH IPWATCHD 8 +.SH NAME +IPwatchD \- IP conflict detection tool for Linux +.SH SYNOPSIS +.B ipwatchd --config +.I config_file +.B [\-\-debug] +.br +.B ipwatchd \-\-version +.br +.B ipwatchd \-\-help +.SH DESCRIPTION +IPwatchD is simple daemon that uses libpcap to detect IP conflict on Linux. It can be configured to listen on one or more interfaces (alias interfaces are also supported) in active or passive mode. In active mode IPwatchD protects your host before IP takeover by answering Gratuitous ARP requests received from conflicting system. In passive mode it just records information about conflict through standard syslog interface. +.SH OPTIONS +The following options are supported: +.TP +.B "\-c \-\-config" +Specifies path to configuration file. +.TP +.B "\-d \-\-debug" +Enables debug mode. Debug information are recorded through syslog with facility set to "daemon" and priority set to "debug". +.TP +.B "\-v \-\-version" +Prints program version to standard output. +.TP +.B "\-h \-\-help" +Prints short help information to standard output. +.SH EXAMPLE +Every line starting with a hash mark ('#') in IPwatchD configuration file is considered to be a comment. Every uncommented line must start with a name of the network interface followed by at least one space or tab and requested mode for interface. +.PP +IPwatchD can operate on each network interface in one of two modes. In +.B passive +mode it just generates syslog events. In +.B active +mode it also answers Gratuitous ARP request and sends following Gratuitous ARP requests to update ARP cache of neighboring hosts with correct data. + +# Example configuration file +.br +eth0 active +.br +eth0:0 passive +.SH AUTHOR +This manual page was written by Jaroslav Imrich +.SH SEE ALSO +More information about IP conflict detection can be found on +.UR http://ipwatchd.sf.net +http://ipwatchd.sf.net +.UE diff --git a/releases/1.1/doc/ipwatchd.8.gz b/releases/1.1/doc/ipwatchd.8.gz new file mode 100644 index 0000000..69b38d0 Binary files /dev/null and b/releases/1.1/doc/ipwatchd.8.gz differ diff --git a/releases/1.1/src/Makefile b/releases/1.1/src/Makefile new file mode 100644 index 0000000..1c1100d --- /dev/null +++ b/releases/1.1/src/Makefile @@ -0,0 +1,68 @@ +# IPwatchD - IP conflict detection tool for Linux +# Copyright (C) 2007-2008 Jaroslav Imrich + +CC= gcc +CFLAGS= -Wall -O2 +LIBS= -lpcap -lnet +LIBNOTIFY_CFLAGS=`pkg-config --cflags libnotify` +LIBNOTIFY_LIBS=`pkg-config --libs libnotify` + + +all: analyse-wdn.o config.o daemonize.o desktop.o devinfo.o genarp.o ipwatchd.o message.o signal.o + $(CC) $(CFLAGS) analyse-wdn.o config.o daemonize.o desktop.o devinfo.o genarp.o \ + ipwatchd.o message.o signal.o -o ipwatchd $(LIBS) $(LIBNOTIFY_LIBS) + +daemon: analyse.o config.o daemonize.o devinfo.o genarp.o ipwatchd.o message.o signal.o + $(CC) $(CFLAGS) analyse.o config.o daemonize.o devinfo.o genarp.o \ + ipwatchd.o message.o signal.o -o ipwatchd $(LIBS) + + +analyse.o: analyse.c ipwatchd.h + $(CC) $(CFLAGS) -c analyse.c -o analyse.o + +analyse-wdn.o: analyse.c ipwatchd.h + $(CC) $(CFLAGS) -DWITH_DESKTOP_NOTIFICATION -c analyse.c -o analyse-wdn.o + +config.o: config.c ipwatchd.h + $(CC) $(CFLAGS) -c config.c -o config.o + +daemonize.o: daemonize.c ipwatchd.h + $(CC) $(CFLAGS) -c daemonize.c -o daemonize.o + +desktop.o: desktop.c ipwatchd.h + $(CC) $(CFLAGS) $(LIBNOTIFY_CFLAGS) -c desktop.c -o desktop.o + +devinfo.o: devinfo.c ipwatchd.h + $(CC) $(CFLAGS) -c devinfo.c -o devinfo.o + +genarp.o: genarp.c ipwatchd.h + $(CC) $(CFLAGS) -c genarp.c -o genarp.o + +ipwatchd.o: ipwatchd.c ipwatchd.h + $(CC) $(CFLAGS) -c ipwatchd.c -o ipwatchd.o + +message.o: message.c ipwatchd.h + $(CC) $(CFLAGS) -c message.c -o message.o + +signal.o: signal.c ipwatchd.h + $(CC) $(CFLAGS) -c signal.c -o signal.o + + +clean: + -rm -f *.o + +distclean: + -rm -f *.o ipwatchd + + +install: + cp ipwatchd /usr/local/sbin + cp ipwatchd.conf /usr/local/etc + mkdir -p /usr/local/share/man/man8 + cp ../doc/ipwatchd.8.gz /usr/local/share/man/man8 + +uninstall: + rm -f /usr/local/sbin/ipwatchd + rm -f /usr/local/etc/ipwatchd.conf + rm -f /usr/local/share/man/man8/ipwatchd.8.gz + diff --git a/releases/1.1/src/analyse.c b/releases/1.1/src/analyse.c new file mode 100644 index 0000000..d545d20 --- /dev/null +++ b/releases/1.1/src/analyse.c @@ -0,0 +1,149 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file analyse.c + * \brief Contains logic used for analysing of captured ARP packets + */ + + +#include "ipwatchd.h" + + +extern IPWD_S_DEVS devices; +extern char msgbuf[IPWD_MSG_BUFSIZ]; + + +//! Callback for "pcap_loop" with standard parameters. Called when ARP packet is received (detection of conflict is done here). +/*! + * \param args Last parameter of pcap_loop + * \param header Packet header + * \param packet Packet data + */ +void ipwd_analyse (u_char * args, const struct pcap_pkthdr *header, const u_char * packet) +{ + + /* Get addresses from packet */ + IPWD_S_ARP_HEADER *arpaddr; + arpaddr = (IPWD_S_ARP_HEADER *) (packet + IPWD_ARP_HEADER_SIZE); + + /* Source IP address */ + char rcv_sip[16]; + char *p_rcv_sip = NULL; + + if ((p_rcv_sip = inet_ntoa (*((struct in_addr *) &arpaddr->arp_spa))) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not get source IP address from packet"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return; + } + + strcpy (rcv_sip, p_rcv_sip); + + /* Source MAC address */ + char rcv_smac[18]; + char *p_rcv_smac = NULL; + + if ((p_rcv_smac = ether_ntoa ((const struct ether_addr *) &arpaddr->arp_sha)) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not get source MAC address from packet"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return; + } + + strcpy (rcv_smac, p_rcv_smac); + + /* Destination IP address */ + char rcv_dip[16]; + char *p_rcv_dip = NULL; + + if ((p_rcv_dip = inet_ntoa (*((struct in_addr *) &arpaddr->arp_tpa))) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not get destination IP address from packet"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return; + } + + strcpy (rcv_dip, p_rcv_dip); + + /* Destination MAC address */ + char rcv_dmac[18]; + char *p_rcv_dmac = NULL; + + if ((p_rcv_dmac = ether_ntoa ((const struct ether_addr *) &arpaddr->arp_tha)) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not get destination MAC address from packet"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return; + } + + strcpy (rcv_dmac, p_rcv_dmac); + + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Received ARP packet: S:%s-%s D:%s-%s", rcv_sip, rcv_smac, rcv_dip, rcv_dmac); + ipwd_message (msgbuf, IPWD_MSG_DEBUG); + + /* Search through devices structure */ + int i = 0; + + for (i = 0; i < devices.devnum; i++) + { + + /* Get actual IP and MAC address of interface */ + if (ipwd_devinfo (devices.dev[i].device, devices.dev[i].ip, devices.dev[i].mac) == IPWD_RV_ERROR) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to get IP and MAC address of %s", devices.dev[i].device); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return; + } + + /* Check if received packet causes conflict with IP address of this interface */ + if ((strcmp (rcv_sip, devices.dev[i].ip) == 0) && (strcmp (rcv_smac, devices.dev[i].mac) != 0)) + { + if (devices.dev[i].mode == IPWD_MODE_ACTIVE) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "MAC address %s causes IP conflict with address %s set on interface %s - active mode - reply sent", rcv_smac, devices.dev[i].ip, devices.dev[i].device); + ipwd_message (msgbuf, IPWD_MSG_ALERT); + + /* Send reply to conflicting system */ + ipwd_genarp (devices.dev[i].device, devices.dev[i].ip, devices.dev[i].mac, rcv_sip, rcv_smac, ARPOP_REPLY); + + /* Send GARP request to update cache of our neighbours */ + ipwd_genarp (devices.dev[i].device, devices.dev[i].ip, devices.dev[i].mac, devices.dev[i].ip, "ff:ff:ff:ff:ff:ff", ARPOP_REQUEST); + } + else + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "MAC address %s causes IP conflict with address %s set on interface %s - passive mode - reply not sent", rcv_smac, devices.dev[i].ip, devices.dev[i].device); + ipwd_message (msgbuf, IPWD_MSG_ALERT); + } + +#ifdef WITH_DESKTOP_NOTIFICATION + /* Show desktop pop-up notification with libnotify */ + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "MAC address %s causes IP conflict with address %s set on interface %s", rcv_smac, devices.dev[i].ip, devices.dev[i].device); + ipwd_desktop_notification (msgbuf); +#endif + + } + else + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Packet does not conflict with: %s %s-%s", devices.dev[i].device, devices.dev[i].ip, devices.dev[i].mac); + ipwd_message (msgbuf, IPWD_MSG_DEBUG); + } + + } + +} + diff --git a/releases/1.1/src/config.c b/releases/1.1/src/config.c new file mode 100644 index 0000000..4412516 --- /dev/null +++ b/releases/1.1/src/config.c @@ -0,0 +1,169 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file config.c + * \brief Contains logic used for parsing of configuration + */ + + +#include "ipwatchd.h" + + +extern int debug_flag; +extern IPWD_S_DEVS devices; +extern char msgbuf[IPWD_MSG_BUFSIZ]; + + +//! Checks existence of the file +/*! + * \param filename Path to the file + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int ipwd_file_exists (char *filename) +{ + + FILE *fr = NULL; + + if ((fr = fopen (filename, "r")) == NULL) + { + return (IPWD_RV_ERROR); + } + + if (fclose (fr) == EOF) + { + return (IPWD_RV_ERROR); + } + + return (IPWD_RV_SUCCESS); + +} + + +//! Reads configuration file and stores names of interfaces into the "devices" structure +/*! + * \param filename Path to the configurationfile + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int ipwd_read_config (char *filename) +{ + + FILE *fr = NULL; + + char line[255]; + int linenum = 0; + + char device[10]; + char mode[10]; + + pcap_t *h_pcap = NULL; + char errbuf[PCAP_ERRBUF_SIZE]; + + /* Starting with empty devices structure */ + devices.dev = NULL; + devices.devnum = 0; + + if ((fr = fopen (filename, "r")) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to open configuration file %s", filename); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Parse config file */ + while (fgets (line, 254, fr) != NULL) + { + + linenum = linenum + 1; + + device[0] = '\0'; + mode[0] = '\0'; + + if ((line[0] == '#') || (line[0] == '\n')) + { + continue; + } + + if (sscanf (line, "%9s %9s", device, mode) != 2) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Not enough parameters in configuration file on line %d", linenum); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Check if device is valid ethernet device */ + h_pcap = pcap_open_live (device, BUFSIZ, 0, 0, errbuf); + if (h_pcap == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "IPwatchD is unable to work with device \"%s\"", device); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + if (pcap_datalink (h_pcap) != DLT_EN10MB) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Device \"%s\" is not valid ethernet device", device); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + pcap_close (h_pcap); + + /* Check mode value */ + if ((strcmp (mode, "active") != 0) && (strcmp (mode, "passive") != 0)) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Mode \"%s\" on line %d in configuration file not supported", mode, linenum); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Put read values into devices structure */ + if ((devices.dev = (IPWD_S_DEV *) realloc (devices.dev, (devices.devnum + 1) * sizeof (IPWD_S_DEV))) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to initialize devices structure"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + strcpy (devices.dev[devices.devnum].device, device); + + if (strcmp (mode, "active") == 0) + { + devices.dev[devices.devnum].mode = IPWD_MODE_ACTIVE; + } + else + { + devices.dev[devices.devnum].mode = IPWD_MODE_PASSIVE; + } + + devices.devnum = devices.devnum + 1; + + line[0] = '\0'; + + } + + if (fclose (fr) == EOF) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to close configuration file %s", filename); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + return (IPWD_RV_SUCCESS); + +} + diff --git a/releases/1.1/src/daemonize.c b/releases/1.1/src/daemonize.c new file mode 100644 index 0000000..38da1c7 --- /dev/null +++ b/releases/1.1/src/daemonize.c @@ -0,0 +1,107 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file daemonize.c + * \brief Contains logic used for daemonization of the proccess + */ + + +#include "ipwatchd.h" + + +extern char msgbuf[IPWD_MSG_BUFSIZ]; + + +//! Daemonizes the proccess +/*! + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int ipwd_daemonize (void) +{ + + /* If parent of this process is init we are already in daemon mode */ + if (getppid () == 1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Already running as daemon"); + ipwd_message (msgbuf, IPWD_MSG_INFO); + return (IPWD_RV_SUCCESS); + } + + /* Fork child process */ + pid_t pid = fork (); + if (pid < 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to fork a child process"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Fork was successful we can exit parent */ + if (pid > 0) + { + exit (IPWD_RV_SUCCESS); + } + + /* Set default umask */ + umask (0); + + /* Create new session */ + pid_t sid = setsid (); + if (sid < 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to create a new session"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Change current directory to root */ + if ((chdir ("/")) == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to change current directory to /"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Redirect standard input */ + if ((freopen ("/dev/null", "r", stdin)) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to redirect STDIN"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Redirect standard output */ + if ((freopen ("/dev/null", "w", stdout)) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to redirect STDOUT"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Redirect standard error output */ + if ((freopen ("/dev/null", "w", stderr)) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to redirect STDERR"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + return (IPWD_RV_SUCCESS); + +} + diff --git a/releases/1.1/src/desktop.c b/releases/1.1/src/desktop.c new file mode 100644 index 0000000..316fb22 --- /dev/null +++ b/releases/1.1/src/desktop.c @@ -0,0 +1,49 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file desktop.c + * \brief Contains logic used for showing notification pop-ups on desktop + */ + + +#include +#include "ipwatchd.h" + + +//! Shows desktop pop-up notification with libnotify +/*! + * \param message Message to be shown + */ +void ipwd_desktop_notification(char *message) +{ + NotifyNotification *notify = NULL; + + if (!notify_init("IPwatchD")) + { + ipwd_message ("Unable to connect to notification daemon", IPWD_MSG_ERROR); + return; + } + + notify = notify_notification_new("IP Conflict occured", message, GTK_STOCK_DIALOG_WARNING, NULL); + notify_notification_set_urgency(notify, NOTIFY_URGENCY_CRITICAL); + notify_notification_set_timeout(notify, NOTIFY_EXPIRES_DEFAULT); + notify_notification_show(notify, NULL); + g_object_unref(G_OBJECT(notify)); + notify_uninit(); +} + diff --git a/releases/1.1/src/devinfo.c b/releases/1.1/src/devinfo.c new file mode 100644 index 0000000..97e4e7d --- /dev/null +++ b/releases/1.1/src/devinfo.c @@ -0,0 +1,102 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file devinfo.c + * \brief Contains logic used for acquiring information about network devices + */ + + +#include "ipwatchd.h" + + +extern char msgbuf[IPWD_MSG_BUFSIZ]; + + +//! Gets the IP and MAC addresses of specified device in human readable form +/*! + * Based on examples from: http://english.geekpage.jp/programming/linux-network/ + * \param p_dev Name of the device (i.e. eth0) + * \param p_ip Pointer to string where the IP address should be stored + * \param p_mac Pointer to string where the MAC address should be stored + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int ipwd_devinfo (char *p_dev, char *p_ip, char *p_mac) +{ + + /* Create UDP socket */ + int sock = -1; + sock = socket (AF_INET, SOCK_DGRAM, 0); + if (sock < 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not open socket"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + struct ifreq ifr; + ifr.ifr_addr.sa_family = AF_INET; + strcpy (ifr.ifr_name, p_dev); + + /* Get IP address of interface */ + if (ioctl (sock, SIOCGIFADDR, &ifr) < 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not retrieve IP address of the device \"%s\"", p_dev); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + char *p_dev_ip = NULL; + + if ((p_dev_ip = inet_ntoa (((struct sockaddr_in *) &ifr.ifr_addr)->sin_addr)) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not convert IP address of the device \"%s\"", p_dev); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + strcpy (p_ip, p_dev_ip); + + /* Get MAC address of interface */ + if (ioctl (sock, SIOCGIFHWADDR, &ifr) < 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not retrieve IP address of the device \"%s\"", p_dev); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + char *p_dev_mac = NULL; + + if ((p_dev_mac = ether_ntoa ((const struct ether_addr *) &ifr.ifr_hwaddr.sa_data[0])) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Could not convert IP address of the device \"%s\"", p_dev); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + strcpy (p_mac, p_dev_mac); + + /* Close socket */ + close (sock); + + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Device info: %s %s-%s", p_dev, p_ip, p_mac); + ipwd_message (msgbuf, IPWD_MSG_DEBUG); + + return (IPWD_RV_SUCCESS); + +} + diff --git a/releases/1.1/src/genarp.c b/releases/1.1/src/genarp.c new file mode 100644 index 0000000..124e6fe --- /dev/null +++ b/releases/1.1/src/genarp.c @@ -0,0 +1,197 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file genarp.c + * \brief Contains logic used for generation of ARP packets + */ + + +#include "ipwatchd.h" + + +extern char msgbuf[IPWD_MSG_BUFSIZ]; + + +//! Generates ARP packet with libnet1 +/*! + * \param dev Name of the device + * \param p_sip Source IP address + * \param p_smac Source MAC address + * \param p_dip Destination IP address + * \param p_dmac Destination MAC address + * \param opcode ARPOP_REQUEST or ARPOP_REPLY + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int ipwd_genarp (char *dev, char *p_sip, char *p_smac, char *p_dip, char *p_dmac, int opcode) +{ + + struct in_addr sip, dip; + struct ether_addr smac, dmac; + + /* Convert source IP address */ + if (inet_aton (p_sip, &sip) == 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to convert source IP address %s", p_sip); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Convert destination IP address */ + if (inet_aton (p_dip, &dip) == 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to convert destination IP address %s", p_dip); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Convert source MAC address */ + if (ether_aton_r (p_smac, &smac) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to convert source MAC address %s", p_smac); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Convert destination MAC address */ + if (ether_aton_r (p_dmac, &dmac) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to convert destination MAC address %s", p_dmac); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Set opcode once again. Just in case.. */ + if (opcode != ARPOP_REQUEST) + { + opcode = ARPOP_REPLY; + } + + libnet_t *h_net = NULL; + char errbuf[LIBNET_ERRBUF_SIZE]; + + /* Initialize libnet */ + h_net = libnet_init (LIBNET_LINK_ADV, dev, errbuf); + if (h_net == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to initialize libnet1 - %s", errbuf); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Gratuitous ARP request will be created if destination MAC address is broadcast. + * GARP requests from Windows and OpenBSD have destination MAC in ARP header + * always set to 00:00:00:00:00:00 so we will do the same thing */ + if ((strcmp (p_dmac, "ff:ff:ff:ff:ff:ff") == 0) && (opcode == ARPOP_REQUEST)) + { + struct ether_addr nullmac; + char *null_mac = "00:00:00:00:00:00"; + + /* Convert null MAC address */ + if (ether_aton_r (null_mac, &nullmac) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to convert destination MAC address for gratuitous ARP request"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + libnet_destroy (h_net); + return (IPWD_RV_ERROR); + } + + /* Build ARP header for gratuitous ARP packet */ + libnet_ptag_t arp = 0; + arp = libnet_build_arp ( ARPHRD_ETHER, + ETHERTYPE_IP, + 6, + 4, + opcode, + (u_int8_t *) & smac, + (u_int8_t *) & sip, + (u_int8_t *) & nullmac, + (u_int8_t *) & dip, + NULL, + 0, + h_net, + arp ); + if (arp == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to build ARP header: %s", libnet_geterror (h_net)); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + libnet_destroy (h_net); + return (IPWD_RV_ERROR); + } + + } + else + { + + /* Build ARP header for normal ARP packet */ + libnet_ptag_t arp = 0; + arp = libnet_build_arp ( ARPHRD_ETHER, + ETHERTYPE_IP, + 6, + 4, + opcode, + (u_int8_t *) & smac, + (u_int8_t *) & sip, + (u_int8_t *) & dmac, + (u_int8_t *) & dip, + NULL, + 0, + h_net, + arp); + if (arp == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to build ARP header: %s", libnet_geterror (h_net)); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + libnet_destroy (h_net); + return (IPWD_RV_ERROR); + } + + } + + /* Build ethernet header */ + libnet_ptag_t ether = 0; + ether = libnet_build_ethernet ((u_int8_t *) & dmac, (u_int8_t *) & smac, ETHERTYPE_ARP, NULL, 0, h_net, ether); + if (ether == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to build ethernet header: %s", libnet_geterror (h_net)); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + libnet_destroy (h_net); + return (IPWD_RV_ERROR); + } + + /* Send packet */ + int c = libnet_write (h_net); + if (c == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to send packet: %s", + libnet_geterror (h_net)); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + libnet_destroy (h_net); + return (IPWD_RV_ERROR); + } + else + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Packet with size of %d bytes sent", c); + ipwd_message (msgbuf, IPWD_MSG_DEBUG); + } + + libnet_destroy (h_net); + + return (IPWD_RV_SUCCESS); + +} + diff --git a/releases/1.1/src/ipwatchd.c b/releases/1.1/src/ipwatchd.c new file mode 100644 index 0000000..39bc49e --- /dev/null +++ b/releases/1.1/src/ipwatchd.c @@ -0,0 +1,264 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file ipwatchd.c + * \brief Main source file of the project + */ + +#include "ipwatchd.h" + + +//! Flag indicating debug mode +int debug_flag = 0; + +//! Flag indicating that output of program must be recorded by syslog +int syslog_flag = 0; + +//! Structure that holds information about network interfaces +IPWD_S_DEVS devices; + +//! Buffer for output messages +char msgbuf[IPWD_MSG_BUFSIZ]; + +//! Handle for libpcap +pcap_t *h_pcap = NULL; + + +//! Main function of the program +/*! + * \param argc Number of received command line arguments + * \param argv Argument values + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int main (int argc, char *argv[]) +{ + + /* Name of configuration file */ + char *config_file = NULL; + + int c; + int option_index = 0; + + /* Parse command line arguments */ + while (1) + { + + static struct option long_options[] = { + { "config", required_argument, 0, 'c' }, + { "debug", no_argument, &debug_flag, 1 }, + { "help", no_argument, 0, 'h' }, + { "version", no_argument, 0, 'v' }, + { 0, 0, 0, 0 } + }; + + c = getopt_long (argc, argv, "c:dhv", long_options, &option_index); + + if (c == -1) + { + break; + } + + switch (c) + { + + case 0: + /* If debug_flag is set do nothing */ + if (long_options[option_index].flag != 0) + { + break; + } + + case 'c': + if (ipwd_file_exists (optarg) == IPWD_RV_ERROR) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to open configuration file %s", optarg); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + if ((config_file = (char *) malloc ((strlen (optarg) + 1) * sizeof (char))) == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to open configuration file %s", optarg); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + strcpy (config_file, optarg); + break; + + case 'd': + debug_flag = 1; + break; + + case 'h': + ipwd_print_help (); + return (IPWD_RV_SUCCESS); + + case 'v': + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "%s", IPWATCHD_VERSION); + ipwd_message (msgbuf, IPWD_MSG_INFO); + return (IPWD_RV_SUCCESS); + + case '?': + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Try %s --help", argv[0]); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + + default: + ipwd_print_help (); + return (IPWD_RV_ERROR); + } + + } + + /* Print help if there is any unknown argument */ + if (optind < argc) + { + ipwd_print_help (); + return (IPWD_RV_ERROR); + } + + /* Path to configuration file must be specified */ + if (config_file == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "You must specify path to configuration file."); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Try %s --help", argv[0]); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Only root can run IPwatchD */ + if (getuid () != 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "You must be root to run IPwatchD"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Read config file */ + if (ipwd_read_config (config_file) == IPWD_RV_ERROR) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to read configuration file"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + free (config_file); + config_file = NULL; + + /* Daemonize */ + if (ipwd_daemonize () != IPWD_RV_SUCCESS) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to daemonize"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* All messages must be sysloged since now */ + openlog ("IPwatchD", LOG_PID, LOG_DAEMON); + syslog_flag = 1; + + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "IPwatchD started"); + ipwd_message (msgbuf, IPWD_MSG_INFO); + + char errbuf[PCAP_ERRBUF_SIZE]; + struct bpf_program fp; + + /* Initialize libpcap and listen on all interfaces */ + h_pcap = pcap_open_live (NULL, BUFSIZ, 0, 0, errbuf); + if (h_pcap == NULL) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to create packet capture object - %s", errbuf); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Set SIGTERM handler */ + if (ipwd_set_signal_handler () != IPWD_RV_SUCCESS) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to set signal handlers"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Compile packet capture filter - only ARP packets will be captured */ + if (pcap_compile (h_pcap, &fp, "arp", 0, 0) == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to compile packet capture filter - %s", pcap_geterr (h_pcap)); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + /* Set packet capture filter */ + if (pcap_setfilter (h_pcap, &fp) == -1) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to set packet capture filter - %s", pcap_geterr (h_pcap)); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + pcap_freecode (&fp); + + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Entering pcap loop"); + ipwd_message (msgbuf, IPWD_MSG_DEBUG); + + /* Loop until SIGTERM or any error destroys pcap object */ + pcap_loop (h_pcap, -1, ipwd_analyse, NULL); + + /* Stop IPwatchD */ + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "IPwatchD stopped"); + ipwd_message (msgbuf, IPWD_MSG_INFO); + + closelog (); + + free (devices.dev); + + return (IPWD_RV_SUCCESS); + +} + + +//! Prints help to the stdout +void ipwd_print_help (void) +{ + fprintf (stdout, "IPwatchD - IP conflict detection tool for Linux\n"); + fprintf (stdout, "\n"); + fprintf (stdout, "Usage: ipwatchd --config config_file [--debug]\n"); + fprintf (stdout, "\n"); + fprintf (stdout, " --config config_file - Path to configuration file\n"); + fprintf (stdout, " --debug - Run in debug mode\n"); + fprintf (stdout, "\n"); + fprintf (stdout, "or ipwatchd --version|--help\n"); + fprintf (stdout, "\n"); + fprintf (stdout, " --version - Prints program version\n"); + fprintf (stdout, " --help - Displays this help message\n"); + fprintf (stdout, "\n"); + fprintf (stdout, "IPwatchD is simple daemon that uses pcap library to capture\n"); + fprintf (stdout, "all incoming ARP packets. It then compares IP and MAC\n"); + fprintf (stdout, "addresses from packets with addresses of local interfaces\n"); + fprintf (stdout, "trying to detect IP conflict. IPwatchD can operate on each\n"); + fprintf (stdout, "network interface in two modes – passive and active.\n"); + fprintf (stdout, "In passive mode it just generates syslog events. In active\n"); + fprintf (stdout, "mode it also answers Gratuitous ARP request and sends\n"); + fprintf (stdout, "following Gratuitous ARP requests to update ARP cache of\n"); + fprintf (stdout, "neighboring hosts with correct data.\n"); + fprintf (stdout, "\n"); + fprintf (stdout, "Please send any bug reports to jariq@jariq.sk\n"); +} + diff --git a/releases/1.1/src/ipwatchd.conf b/releases/1.1/src/ipwatchd.conf new file mode 100644 index 0000000..062ca3f --- /dev/null +++ b/releases/1.1/src/ipwatchd.conf @@ -0,0 +1,16 @@ +################################################################ +# +# IPwatchD configuration file +# +# Every uncommented line must contain name of network interface +# followed by the requested mode for interface. +# +# IPwatchD can operate on network interface in two modes: +# passive - IPwatchD just generates syslog events +# active - IPwatchD also answers Gratuitous ARP requests +# +# For more information please visit project website: +# http: //ipwatchd.sourceforge.net + +eth0 active +#eth0:0 passive diff --git a/releases/1.1/src/ipwatchd.h b/releases/1.1/src/ipwatchd.h new file mode 100644 index 0000000..df4ef7c --- /dev/null +++ b/releases/1.1/src/ipwatchd.h @@ -0,0 +1,153 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file ipwatchd.h + * \brief Main header file of the project + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + + +//! String with IPwatchD version information +#define IPWATCHD_VERSION "IPwatchD 1.1" + + +/* Return values */ + +//! "Success" return value of IPwatchD internal functions +#define IPWD_RV_SUCCESS 0 + +//! "Error" return value of IPwatchD internal functions +#define IPWD_RV_ERROR 2 + + +/* Message options */ + +//! Size of buffer for output messages +#define IPWD_MSG_BUFSIZ 1000 + +//! Message type: information +#define IPWD_MSG_INFO 1 + +//! Message type: error +#define IPWD_MSG_ERROR 2 + +//! Message type: alert +#define IPWD_MSG_ALERT 3 + +//! Message type: debug +#define IPWD_MSG_DEBUG 4 + + +/* Operation modes */ + +//! Indicates that IPwatchD should operate in active mode on selected device +#define IPWD_MODE_ACTIVE 1 + +//! Indicates that IPwatchD should operate in passive mode on selected device +#define IPWD_MODE_PASSIVE 2 + + +/* Structures for network device information */ + +//! Structure that holds information about ONE network interface +typedef struct +{ + char device[10]; /**< Device name */ + char ip[20]; /**< IP address of device */ + char mac[20]; /**< MAC address of device */ + int mode; /**< IPwatch mode on interface: IPWATCHD_DEVICE_MODE_ACTIVE or IPWATCHD_DEVICE_MODE_PASSIVE */ +} +IPWD_S_DEV; + +//! Structure that holds information about ALL network interfaces +typedef struct +{ + IPWD_S_DEV *dev; /**< Dynamicaly allocated array of IPWD_S_DEV structures */ + int devnum; /**< Number of watched interfaces */ +} +IPWD_S_DEVS; + + +/* ARP packet information */ + +//! Number of useless bytes in ARP packet +/*! Parsing of packets captured by libpcap on pseudo device "any" seems to be + * slightly different than parsing of packets captured on one particular interface. + * Instead of usual 14th byte addresses begin on 24th byte of ARP header. + */ +#define IPWD_ARP_HEADER_SIZE 24 + +//! Structure useful for parsing of individual addresses from packet +typedef struct +{ + u_int8_t arp_sha[ETH_ALEN]; /**< Source MAC address */ + u_int8_t arp_spa[4]; /**< Source IP address */ + u_int8_t arp_tha[ETH_ALEN]; /**< Destination MAC address */ + u_int8_t arp_tpa[4]; /**< Destination IP address */ +} +IPWD_S_ARP_HEADER; + + +/* IPwatchD internal functions - described in corresponding source files */ + +// \cond - Doxygen ignore block start + +/* analyse.c */ +void ipwd_analyse (u_char * args, const struct pcap_pkthdr *header, const u_char * packet); + +/* config.c */ +int ipwd_file_exists (char *filename); +int ipwd_read_config (char *filename); + +/* daemonize.c */ +int ipwd_daemonize (void); + +/* desktop.c */ +void ipwd_desktop_notification (char *message); + +/* devinfo.c */ +int ipwd_devinfo (char *p_dev, char *p_ip, char *p_mac); + +/* genarp.c */ +int ipwd_genarp (char *dev, char *p_sip, char *p_smac, char *p_dip, char *p_dmac, int opcode); + +/* ipwatchd.c */ +void ipwd_print_help (void); + +/* message.c */ +void ipwd_message (char *msg, int type); + +/* signal.c */ +int ipwd_set_signal_handler (void); +void ipwd_signal_handler (int signal); + +// \endcond - Doxygen ignore block end + diff --git a/releases/1.1/src/message.c b/releases/1.1/src/message.c new file mode 100644 index 0000000..ba02086 --- /dev/null +++ b/releases/1.1/src/message.c @@ -0,0 +1,107 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file message.c + * \brief Contains logic used for manipulating program messages + */ + + +#include "ipwatchd.h" + + +extern int debug_flag; +extern int syslog_flag; + + +//! Handles output of messages generated by IPwatchD +/*! + * \param msg Message to output + * \param type Type of message. Possible values are IPWD_MSG_INFO, IPWD_MSG_ERROR and IPWD_MSG_ALERT. + */ +void ipwd_message (char *msg, int type) +{ + + /* In daemon mode - must record messages by syslog */ + if (syslog_flag) + { + + switch (type) + { + + case IPWD_MSG_INFO: + syslog (LOG_INFO, msg); + break; + + case IPWD_MSG_ERROR: + syslog (LOG_ERR, msg); + break; + + case IPWD_MSG_ALERT: + syslog (LOG_ALERT, msg); + break; + + case IPWD_MSG_DEBUG: + if (debug_flag) + { + syslog (LOG_DEBUG, msg); + } + break; + + default: + syslog (LOG_ERR, msg); + break; + + } + + } + else + /* Not daemon yet - messages can be printed to terminal */ + { + + switch (type) + { + + case IPWD_MSG_INFO: + fprintf (stdout, "%s\n", msg); + break; + + case IPWD_MSG_ERROR: + fprintf (stderr, "%s\n", msg); + break; + + case IPWD_MSG_ALERT: + fprintf (stderr, "%s\n", msg); + break; + + case IPWD_MSG_DEBUG: + if (debug_flag) + { + fprintf (stdout, "%s\n", msg); + } + break; + + default: + fprintf (stderr, "%s\n", msg); + break; + + } + + } + +} + diff --git a/releases/1.1/src/signal.c b/releases/1.1/src/signal.c new file mode 100644 index 0000000..8e999e4 --- /dev/null +++ b/releases/1.1/src/signal.c @@ -0,0 +1,72 @@ +/* IPwatchD - IP conflict detection tool for Linux + * Copyright (C) 2007-2008 Jaroslav Imrich + * + * 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. + * + * 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. + */ + +/** \file signal.c + * \brief Contains logic used for signal handling + */ + + +#include "ipwatchd.h" + + +extern char msgbuf[IPWD_MSG_BUFSIZ]; +extern pcap_t *h_pcap; + + +//! Sets signal handler for SIGTERM +/*! + * \return IPWD_RV_SUCCESS if successful IPWD_RV_ERROR otherwise + */ +int ipwd_set_signal_handler (void) +{ + + struct sigaction sigact; + + sigemptyset (&sigact.sa_mask); + sigact.sa_flags = 0; + sigact.sa_handler = ipwd_signal_handler; + + if (sigaction (SIGTERM, &sigact, 0) != 0) + { + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Unable to set SIGTERM handler"); + ipwd_message (msgbuf, IPWD_MSG_ERROR); + return (IPWD_RV_ERROR); + } + + return (IPWD_RV_SUCCESS); + +} + + +//! Signal handler that is called when signal received +/*! + * \param signal Signal identifier + */ +void ipwd_signal_handler (int signal) +{ + + snprintf (msgbuf, IPWD_MSG_BUFSIZ, "Received signal %d", signal); + ipwd_message (msgbuf, IPWD_MSG_DEBUG); + + if (signal == SIGTERM) + { + pcap_close (h_pcap); + } + +} +