Sign Up
Log In
Log In
or
Sign Up
Places
All Projects
Status Monitor
Collapse sidebar
openSUSE:Factory:Rebuild
libmicrodns
libmicrodns-0.2.0+6.obscpio
Overview
Repositories
Revisions
Requests
Users
Attributes
Meta
File libmicrodns-0.2.0+6.obscpio of Package libmicrodns
07070100000000000041ED0000000000000000000000036291210E00000000000000000000000000000000000000000000001C00000000libmicrodns-0.2.0+6/.github07070100000001000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000002600000000libmicrodns-0.2.0+6/.github/workflows07070100000002000081A40000000000000000000000016291210E000002FA000000000000000000000000000000000000003000000000libmicrodns-0.2.0+6/.github/workflows/build.ymlname: build on: push: branches: - master pull_request: branches: - master jobs: build: strategy: fail-fast: false matrix: include: - os: ubuntu-latest cc: clang - os: ubuntu-latest cc: gcc runs-on: ${{ matrix.os }} steps: - uses: actions/checkout@v2 - name: Install Linux dependencies if: runner.os == 'Linux' run: | sudo add-apt-repository -y "deb http://archive.ubuntu.com/ubuntu `lsb_release -sc` main universe" sudo apt-get update -y -qq sudo apt-get install meson ninja-build - name: Execute build env: CC: ${{ matrix.cc }} run: | meson setup build cd build && ninja 07070100000003000081A40000000000000000000000016291210E0000024B000000000000000000000000000000000000001F00000000libmicrodns-0.2.0+6/.gitignore# Object files *.o *.lo *.ko *.obj *.elf # Libraries *.lib *.a *.la # Shared objects (inc. Windows DLLs) *.dll *.so *.so.* *.dylib # Executables *.exe *.out *.app *.i*86 *.x86_64 *.hex # Build System .deps .dirstamp .libs /Makefile /Makefile.in /aclocal.m4 /autom4te.cache /compile /config /config.* /config.guess /config.h /config.h.in /config.log /config.status /config.sub /configure /depcomp /install-sh /libtool /ltmain.sh /missing /stamp-h1 m4/libtool.m4 m4/ltoptions.m4 m4/ltsugar.m4 m4/ltversion.m4 m4/lt~obsolete.m4 build* # Generated files src/version.h src/microdns.pc 07070100000004000081A40000000000000000000000016291210E00000230000000000000000000000000000000000000001C00000000libmicrodns-0.2.0+6/AUTHORSThis library was developed under the direction of Videolabs SAS Jonathan Calmels <jbjcalmels@gmail.com> Steve Lhomme <robux4@videolabs.io> Jean-Baptiste Kempf <jb@videolan.org> Diego Elio Pettenò <flameeyes@flameeyes.eu> Joseph Calderon <calderon.joe@gmail.com> Hugo Beauzée-Luyssen <hugo@beauzee.fr> Thomas Guillem <thomas@gllm.fr> Steve Lhomme <robUx4@gmail.com> Roland Bewick <roland.bewick@gmail.com> Martin Storsjö <martin@martin.st> Mathieu Duponchelle <mathieu@centricular.com> Victorien Le Couviour--Tuffet <victorien.lecouviour.tuffet@gmail.com> 07070100000005000081A40000000000000000000000016291210E000067E6000000000000000000000000000000000000001C00000000libmicrodns-0.2.0+6/COPYINGLicensed under the LGPL 2.1 and priorietary licenses via Videolabs GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 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. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, 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 and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, 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 library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete 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 distribute a copy of this License along with the Library. 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 Library or any portion of it, thus forming a work based on the Library, 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) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, 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 Library, 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 Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you 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. If distribution of 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 satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be 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. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library 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. 9. 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 Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library 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 with this License. 11. 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 Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library 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 Library. 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. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library 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. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser 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 Library 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 Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, 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 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "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 LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. 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 LIBRARY 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 LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), 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 Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the library's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library 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 Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; 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. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. <signature of Ty Coon>, 1 April 1990 Ty Coon, President of Vice That's all there is to it! 07070100000006000081A40000000000000000000000016291210E000007FB000000000000000000000000000000000000001900000000libmicrodns-0.2.0+6/NEWS----------------- libmicrodns 0.2.0 ----------------- * Fix IPv6 support * Add support for dual IP stack * Fix invalid 0-length packet payload ----------------- libmicrodns 0.1.2 ----------------- * Fixes to the new meson buildsystem ----------------- libmicrodns 0.1.1 ----------------- * Move the buildsystem to meson * Fix many security issues * Fix memory leaks ----------------- libmicrodns 0.1.0 ----------------- * Fix incorrect IPv6 interface index on Windows * Pass IPv4/IPv6 addresses to announce callbacks * Improve examples * Fix warnings and potential crashes * Port to WinRT/UWP ----------------- libmicrodns 0.0.10 ----------------- * Fix another crash with interfaces without an IP address ----------------- libmicrodns 0.0.9 ----------------- * Fix a crash with interfaces without an IP address * Fixes for building with llvm-mingw ----------------- libmicrodns 0.0.8 ----------------- * Fix stack overflow on network errors * Fix leak on errors * Avoid infinite loops on network errors ----------------- libmicrodns 0.0.7 ----------------- * Various error handling fixes ----------------- libmicrodns 0.0.6 ----------------- * Fix an interface selection issue on windows * Fix invalid calls to free() * Fix invalid allocation on windows * Fix multi-interfaces fallback * Fix MSVC build ----------------- libmicrodns 0.0.5 ----------------- * Fix UWP build * Fix invalid error message formating ----------------- libmicrodns 0.0.4 ----------------- * Fix heap buffer overflow * Add support for multiple interfaces * Fix various memory leaks * Fix various potential crashes * Fix build for MSVC * Fix incorrect wide strings handling ----------------- libmicrodns 0.0.3 ----------------- * Fix build on Windows Vista+ ----------------- libmicrodns 0.0.2 ----------------- * Fix leaks and possible crashes in init libmicrodns 0.0.1 ----------------- First release! * Basic listening for mDNS services * Basic announce of mDNS services * Works on Windows (XP to 10), GNU/Linux 07070100000007000081A40000000000000000000000016291210E0000035C000000000000000000000000000000000000001E00000000libmicrodns-0.2.0+6/README.mdmicrodns ======== microdns is an **mDNS** library, focused on being **simple** and **cross-platform**. Minimal mDNS resolver (and announcer) library --------------------------------------------- This library **microdns** is still in development, and therefore can still have bugs. The goal is to have a simple library to listen and create mDNS announces, without the complexity of larger libraries like *avahi*. This means that the API is quite *low-level* and that the code is in C. Bindings to other languages are welcome. License ------- microdns is available under the LGPL license. People who want *(or need)* a commercial license can acquire one. CoC --- The [VideoLAN Code of Conduct](https://wiki.videolan.org/CoC) applies to this project. Installation ------------ meson builddir && ninja -C builddir # ninja -C builddir install 07070100000008000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000001B00000000libmicrodns-0.2.0+6/compat07070100000009000081A40000000000000000000000016291210E0000157F000000000000000000000000000000000000002400000000libmicrodns-0.2.0+6/compat/compat.c/** * Copyright © 2014-2015 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include <assert.h> #include <errno.h> #include <string.h> #include "compat.h" #include "utils.h" #if defined (__unix__) || defined (__APPLE__) struct timeval os_deadline = { .tv_sec = 0, .tv_usec = 100000, }; #endif // __unix__ || (__APPLE__) #if defined (_WIN32) uint32_t os_deadline = 1000; #include <winapifamily.h> #endif // _WIN32 int os_strerror(int errnum, char *buf, size_t buflen) { int r = 0; if (buflen == 0) return -1; buf[0] = '\0'; switch (errnum) { #if defined (_WIN32) case MDNS_NETERR: errno = WSAGetLastError(); // fallthrough case MDNS_STDERR: { wchar_t* wbuff = malloc(sizeof(*wbuff) * buflen); if (wbuff == NULL) return (-1); DWORD nbChar = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM, NULL, errno, 0, wbuff, buflen, NULL); if (!nbChar) { snprintf(buf, buflen, "Error %d\n", errno); r = -1; } else nbChar = WideCharToMultiByte(CP_UTF8, 0, wbuff, nbChar, buf, buflen, NULL, NULL); free(wbuff); break; } #if WINAPI_FAMILY_PARTITION (WINAPI_PARTITION_DESKTOP) || _WIN32_WINNT >= 0x0A00 case MDNS_LKPERR: { // Win32 gai_strerror returns a static buffer, but as a non-const char* WCHAR *s = gai_strerror(errno); if (!WideCharToMultiByte(CP_UTF8, 0, s, -1, buf, buflen, NULL, NULL)) return (-1); break; } #endif #else case MDNS_STDERR: case MDNS_NETERR: if (strerror_r(errno, buf, buflen) != 0) return (-1); break; case MDNS_LKPERR: { const char *s; s = gai_strerror(errno); if ( s == NULL ) return (-1); strncpy(buf, s, buflen); buf[buflen - 1] = '\0'; break; } #endif default: r = -1; } return (r); } int os_mcast_join(sock_t s, const struct sockaddr_storage *ss, uint32_t intf_idx, const struct sockaddr_storage* intf_addr) { #ifdef MCAST_JOIN_GROUP (void)intf_addr; struct group_req mgroup; memset(&mgroup, 0, sizeof(mgroup)); mgroup.gr_interface = intf_idx; memcpy(&mgroup.gr_group, ss, ss_len(ss)); if (setsockopt(s, ss_level(ss), MCAST_JOIN_GROUP, (const void *) &mgroup, sizeof(mgroup)) < 0) return (-1); #else union { struct sockaddr_storage ss; struct sockaddr_in sin; struct sockaddr_in6 sin6; } u; memcpy(&u, ss, sizeof(*ss)); switch (ss_family(ss)) { case AF_INET: { struct ip_mreq mreq; const struct sockaddr_in* sin = (const struct sockaddr_in*)intf_addr; memcpy(&mreq.imr_multiaddr.s_addr, &u.sin.sin_addr, sizeof(struct in_addr)); memcpy(&mreq.imr_interface, &sin->sin_addr, sizeof(sin->sin_addr)); if (setsockopt(s, ss_level(ss), IP_ADD_MEMBERSHIP, (const void *) &mreq, sizeof(mreq)) < 0) return (-1); break; } case AF_INET6: { struct ipv6_mreq mreq6; memcpy(&mreq6.ipv6mr_multiaddr, &u.sin6.sin6_addr, sizeof(struct in6_addr)); memcpy(&mreq6.ipv6mr_interface, &intf_idx, sizeof(intf_idx)); if (setsockopt(s, ss_level(ss), IPV6_JOIN_GROUP, (const void *) &mreq6, sizeof(mreq6)) < 0) return (-1); break; } default: assert(1); } #endif return (0); } 0707010000000A000081A40000000000000000000000016291210E00000EA2000000000000000000000000000000000000002400000000libmicrodns-0.2.0+6/compat/compat.h/** * Copyright © 2014-2015 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef MICRODNS_COMPAT_H #define MICRODNS_COMPAT_H #ifdef HAVE_CONFIG_H # include "config.h" #endif enum { MDNS_STDERR = -1, // standard error MDNS_NETERR = -2, // network error MDNS_LKPERR = -3, // lookup error MDNS_ERROR = -4, // any runtime error that's not originating from the standard library }; /* * POSIX systems */ #if defined (__unix__) || defined (__APPLE__) # include <unistd.h> # include <sys/socket.h> # include <arpa/inet.h> # include <netdb.h> # include <sys/types.h> # include <errno.h> # include <net/if.h> # include <poll.h> extern struct timeval os_deadline; typedef int sock_t; # define INVALID_SOCKET -1 static inline int os_init(const char *version) { (void)version; return (0);} static inline int os_cleanup(void) {return (0);} static inline int os_close(sock_t s) {return (close(s));} static inline int os_wouldblock(void) {return (errno == EWOULDBLOCK);} #endif // __unix__ || (__APPLE__) /* * Windows glue */ #if defined (_WIN32) # include <stdint.h> # include <winsock2.h> # include <windows.h> # include <ws2tcpip.h> # include <iphlpapi.h> /* MinGW lacks AI_NUMERICSERV */ # ifndef AI_NUMERICSERV # define AI_NUMERICSERV 0x00000008 # endif // !AI_NUMERICSERV extern uint32_t os_deadline; typedef SOCKET sock_t; typedef int socklen_t; static inline int os_init(const char *version) { WSADATA data; uint16_t low, high; low = version[0] - '0'; high = version[2] - '0'; return (WSAStartup(MAKEWORD(low, high), &data)); } static inline int os_cleanup(void) {return (WSACleanup());} static inline int os_close(sock_t s) {return (closesocket(s));} static inline int os_wouldblock(void) {return (WSAGetLastError() == WSAEWOULDBLOCK);} # define strerror_r(x, y, z) strerror_s(y, z, x) #ifndef HAVE_INET_NTOP extern const char *inet_ntop(int af, const void *src, char *dst, socklen_t size); extern int inet_pton(int af, const char *src, void *dst); # endif // !inet_ntop #else # if HAVE_IFADDRS_H #include <ifaddrs.h> # endif #endif // _WIN32 #if !defined(HAVE_STRUCT_POLLFD) && !defined(_SYS_POLL_H) enum { POLLERR=0x1, POLLHUP=0x2, POLLNVAL=0x4, POLLWRNORM=0x10, POLLWRBAND=0x20, POLLRDNORM=0x100, POLLRDBAND=0x200, POLLPRI=0x400, }; #define POLLIN (POLLRDNORM|POLLRDBAND) struct pollfd { int fd; unsigned events; unsigned revents; }; #endif #if !defined(HAVE_POLL) && !defined(_SYS_POLL_H) int poll(struct pollfd *fds, unsigned nfds, int timeout); #endif #if defined(_MSC_VER) #include <io.h> #include <basetsd.h> typedef SSIZE_T ssize_t; #define alloca(s) _alloca(s) #define write(f,b,c) _write(f,b,c) #endif extern int os_strerror(int, char *, size_t); extern int os_mcast_join(sock_t, const struct sockaddr_storage *, uint32_t intf_idx, const struct sockaddr_storage* intf_addr); #endif /* MICRODNS_COMPAT_H */ 0707010000000B000081A40000000000000000000000016291210E000008AD000000000000000000000000000000000000002200000000libmicrodns-0.2.0+6/compat/inet.c/** * Copyright © 2014-2015 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include <assert.h> #include <errno.h> #include <string.h> #include "compat.h" #include "utils.h" #if defined (_WIN32) && !defined(HAVE_INET_NTOP) const char * inet_ntop(int af, const void *src, char *dst, socklen_t size) { union { struct sockaddr_storage ss; struct sockaddr_in sin; struct sockaddr_in6 sin6; } u; memset(&u, 0, sizeof(u)); switch (af) { case AF_INET: u.sin.sin_family = af; memcpy(&u.sin.sin_addr, src, sizeof(struct in_addr)); break; case AF_INET6: u.sin6.sin6_family = af; memcpy(&u.sin6.sin6_addr, src, sizeof(struct in6_addr)); break; } if (getnameinfo((const struct sockaddr *) &u.ss, ss_len(&u.ss), dst, size, NULL, 0, NI_NUMERICHOST) != 0) return (NULL); return (dst); } int inet_pton (int af, const char *src, void *dst) { unsigned char *b = dst; switch (af) { case AF_INET: return sscanf (src, "%hhu.%hhu.%hhu.%hhu", b + 0, b + 1, b + 2, b + 3) == 4; } errno = EAFNOSUPPORT; return -1; } #endif // _WIN32 && !inet_ntop 0707010000000C000081A40000000000000000000000016291210E000000E7000000000000000000000000000000000000002700000000libmicrodns-0.2.0+6/compat/meson.buildlibcompat_sources = [ 'compat.c', 'inet.c', 'poll.c', ] libcompat = static_library('compat', libcompat_sources, include_directories: incdirs, dependencies: deps, c_args: c_args, link_args: link_flags ) 0707010000000D000081A40000000000000000000000016291210E000014B8000000000000000000000000000000000000002200000000libmicrodns-0.2.0+6/compat/poll.c/** * Copyright © 2007-2012 Rémi Denis-Courmont * Copyright © 2014-2015 VideoLabs SAS * * Author: Rémi Denis-Courmont * Jonathan Calmels <jbjcalmels@gmail.com> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include <assert.h> #include <errno.h> #include <string.h> #include "compat.h" #include "utils.h" #ifndef HAVE_POLL int poll(struct pollfd *fds, unsigned nfds, int timeout) { DWORD to = (timeout >= 0) ? (DWORD)timeout : INFINITE; if (nfds == 0) { /* WSAWaitForMultipleEvents() does not allow zero events */ if (SleepEx(to, TRUE)) { errno = EINTR; return -1; } return 0; } WSAEVENT *evts = malloc(nfds * sizeof (WSAEVENT)); if (evts == NULL) return -1; /* ENOMEM */ DWORD ret = WSA_WAIT_FAILED; for (unsigned i = 0; i < nfds; i++) { SOCKET fd = fds[i].fd; long mask = FD_CLOSE; fd_set rdset, wrset, exset; FD_ZERO(&rdset); FD_ZERO(&wrset); FD_ZERO(&exset); FD_SET(fd, &exset); if (fds[i].events & POLLRDNORM) { mask |= FD_READ | FD_ACCEPT; FD_SET(fd, &rdset); } if (fds[i].events & POLLWRNORM) { mask |= FD_WRITE | FD_CONNECT; FD_SET(fd, &wrset); } if (fds[i].events & POLLPRI) mask |= FD_OOB; fds[i].revents = 0; evts[i] = WSACreateEvent(); if (evts[i] == WSA_INVALID_EVENT) { while (i > 0) WSACloseEvent(evts[--i]); free(evts); errno = ENOMEM; return -1; } if (WSAEventSelect(fds[i].fd, evts[i], mask) && WSAGetLastError() == WSAENOTSOCK) fds[i].revents |= POLLNVAL; struct timeval tv = { 0, 0 }; /* By its horrible design, WSAEnumNetworkEvents() only enumerates * events that were not already signaled (i.e. it is edge-triggered). * WSAPoll() would be better in this respect, but worse in others. * So use WSAEnumNetworkEvents() after manually checking for pending * events. */ if (select(0, &rdset, &wrset, &exset, &tv) > 0) { if (FD_ISSET(fd, &rdset)) fds[i].revents |= fds[i].events & POLLRDNORM; if (FD_ISSET(fd, &wrset)) fds[i].revents |= fds[i].events & POLLWRNORM; if (FD_ISSET(fd, &exset)) /* To add pain to injury, POLLERR and POLLPRI cannot be * distinguished here. */ fds[i].revents |= POLLERR | (fds[i].events & POLLPRI); } if (fds[i].revents != 0 && ret == WSA_WAIT_FAILED) ret = WSA_WAIT_EVENT_0 + i; } if (ret == WSA_WAIT_FAILED) ret = WSAWaitForMultipleEvents(nfds, evts, FALSE, to, TRUE); unsigned count = 0; for (unsigned i = 0; i < nfds; i++) { WSANETWORKEVENTS ne; if (WSAEnumNetworkEvents(fds[i].fd, evts[i], &ne)) memset(&ne, 0, sizeof (ne)); WSAEventSelect(fds[i].fd, evts[i], 0); WSACloseEvent(evts[i]); if (ne.lNetworkEvents & FD_CONNECT) { fds[i].revents |= POLLWRNORM; if (ne.iErrorCode[FD_CONNECT_BIT] != 0) fds[i].revents |= POLLERR; } if (ne.lNetworkEvents & FD_CLOSE) { fds[i].revents |= (fds[i].events & POLLRDNORM) | POLLHUP; if (ne.iErrorCode[FD_CLOSE_BIT] != 0) fds[i].revents |= POLLERR; } if (ne.lNetworkEvents & FD_ACCEPT) { fds[i].revents |= POLLRDNORM; if (ne.iErrorCode[FD_ACCEPT_BIT] != 0) fds[i].revents |= POLLERR; } if (ne.lNetworkEvents & FD_OOB) { fds[i].revents |= POLLPRI; if (ne.iErrorCode[FD_OOB_BIT] != 0) fds[i].revents |= POLLERR; } if (ne.lNetworkEvents & FD_READ) { fds[i].revents |= POLLRDNORM; if (ne.iErrorCode[FD_READ_BIT] != 0) fds[i].revents |= POLLERR; } if (ne.lNetworkEvents & FD_WRITE) { fds[i].revents |= POLLWRNORM; if (ne.iErrorCode[FD_WRITE_BIT] != 0) fds[i].revents |= POLLERR; } count += fds[i].revents != 0; } free(evts); if (count == 0 && ret == WSA_WAIT_IO_COMPLETION) { errno = EINTR; return -1; } return count; } #endif 0707010000000E000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000001800000000libmicrodns-0.2.0+6/doc0707010000000F000081A40000000000000000000000016291210E000187DD000000000000000000000000000000000000002400000000libmicrodns-0.2.0+6/doc/Doxyfile.in# Doxyfile 1.8.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single 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. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = @PACKAGE_NAME@ # 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 = @VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "Minimalist mDNS client library" # With the PROJECT_LOGO tag one can specify an logo or icon that is included in # the documentation. The maximum height of the logo should not exceed 55 pixels # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. 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 = doc # 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 causes # performance problems for the file system. # The default value is: NO. 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. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES 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. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES 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. # The default value is: YES. 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 and 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. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # 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. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES 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 # The default value is: YES. FULL_PATH_NAMES = YES # 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. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. 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 list of 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. # The default value is: NO. 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-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. 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 Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. 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 behavior. 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 behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. 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. # The default value is: NO. 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. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 2 # This tag can be used to specify a number of aliases that act 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 = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # 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. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. 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. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C # (default is Fortran), use: inc=Fortran f=C. # # Note For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by by putting a % sign in front of the word # or globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # 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); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) 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. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_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. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES 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. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag 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. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # 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 respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file will be # included in the documentation. # The default value is: NO. 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. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = NO # 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 only methods in the interface are # included. # The default value is: NO. 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. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO 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. # The default value is: NO. HIDE_UNDOC_MEMBERS = YES # 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 these classes will be included in the various overviews. This option has # no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO these declarations will be # included in the documentation. # The default value is: NO. 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 these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. 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 then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. 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. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES 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. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = 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 group names will # appear in their defined order. # The default value is: NO. 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 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. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = 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. # The default value is: YES. 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. # The default value is: YES. 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. # The default value is: YES. 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. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if <section_label> ... \endif and \cond <section_label> # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have 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 value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. 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. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # 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 command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. Do not use file names with spaces, bibtex cannot handle them. See # also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag 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. # The default value is: YES. WARN_IF_UNDOCUMENTED = NO # If the WARN_IF_DOC_ERROR tag 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. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO doxygen will only warn about wrong or incomplete parameter # documentation, but not about the absence of documentation. # The default value is: NO. 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) # The default value is: $file:$line: $text. 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 standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is 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. # Note: If this tag is empty the current directory is searched. INPUT = @abs_top_srcdir@/src 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. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (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, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, # *.qsf, *.as and *.js. FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should be # 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. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. 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 # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */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. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be 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: # # <filter> <input-file> # # where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. 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 information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER ) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # 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 that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES 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 documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = 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. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES 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. # See also: Section \class. # The default value is: YES. 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. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 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 a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES doxygen will generate HTML output # The default value is: YES. 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. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. 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 left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- # defined cascading style sheet that is included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefor more robust against future updates. # Doxygen will copy the style sheet file to the output directory. For an example # see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the stylesheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to NO can help when comparing the output of multiple runs. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # 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. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # 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 (see: http://developer.apple.com/tools/xcode/), 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. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset 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. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # 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. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # 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. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # 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. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # 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). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # 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. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value 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 # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # 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. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using prerendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use <access key> + S # (what the <access key> is depends on the OS and browser, but it is typically # <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down # key> to jump into the search results window, the results can be navigated # using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel # the search. The filter options can be selected when the cursor is inside the # search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> # to select a filter and <Enter> or <escape> to activate or cancel the filter # option. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There # are two flavours of web server based searching depending on the # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for # searching and an index file used by the script. When EXTERNAL_SEARCH is # enabled the indexing and searching needs to be provided by external tools. See # the section "External Indexing and Searching" for details. # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. SERVER_BASED_SEARCH = NO # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file # which needs to be processed by an external indexer. Doxygen will invoke an # external search engine pointed to by the SEARCHENGINE_URL option to obtain the # search results. # # Doxygen ships with an example indexer ( doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library # Xapian (see: http://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. EXTERNAL_SEARCH = NO # The SEARCHENGINE_URL should point to a search engine hosted by a web server # which will return the search results when EXTERNAL_SEARCH is enabled. # # Doxygen ships with an example indexer ( doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library # Xapian (see: http://xapian.org/). See the section "External Indexing and # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHENGINE_URL = # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # search data is written to a file for indexing by an external tool. With the # SEARCHDATA_FILE tag the name of this file can be specified. # The default file is: searchdata.xml. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHDATA_FILE = searchdata.xml # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the # EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is # useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple # projects and redirect the results back to the right project. # This tag requires that the tag SEARCHENGINE is set to YES. EXTERNAL_SEARCH_ID = # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen # projects other than the one defined by this configuration file, but that are # all added to the same external search index. Each project needs to have a # unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of # to a relative location where the documentation can be found. The format is: # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... # This tag requires that the tag SEARCHENGINE is set to YES. EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. # The default value is: YES. 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. # The default directory is: latex. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. # # Note that when enabling USE_PDFLATEX this option is only used for generating # bitmaps for formulas in the HTML output, but not in the Makefile that is # written to the output directory. # The default file is: latex. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate # index for LaTeX. # The default file is: makeindex. # This tag requires that the tag GENERATE_LATEX is set to YES. 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. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. 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 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x # 14 inches) and executive (7.25 x 10.5 inches). # The default value is: a4. # This tag requires that the tag GENERATE_LATEX is set to YES. PAPER_TYPE = a4 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names # that should be included in the LaTeX output. To get the times font for # instance you can specify # EXTRA_PACKAGES=times # If left blank no extra packages will be included. # This tag requires that the tag GENERATE_LATEX is set to YES. 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. See # section "Doxygen usage" for information on how to let doxygen write the # default header to a separate file. # # Note: Only use a user-defined header if you know what you are doing! The # following commands have a special meaning inside the header: $title, # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will # replace them by respectively the title of the page, the current date and time, # only the current date, the version number of doxygen, the project name (see # PROJECT_NAME), or the project number (see PROJECT_NUMBER). # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the # generated LaTeX document. The footer should contain everything after the last # chapter. If it is left blank doxygen will generate a standard footer. # # Note: Only use a user-defined footer if you know what you are doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output # directory. Note that the files will be copied as-is; there are no commands or # markers available. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_EXTRA_FILES = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is # prepared for conversion to PDF (using ps2pdf or pdflatex). 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. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. PDF_HYPERLINKS = YES # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate # the PDF file directly from the LaTeX files. Set this option to YES to get a # higher quality PDF documentation. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. 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. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BATCHMODE = NO # If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the # index chapters (such as File Index, Compound Index, etc.) in the output. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HIDE_INDICES = NO # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source # code with syntax highlighting in the LaTeX output. # # Note that which sources are shown also depends on other settings such as # SOURCE_BROWSER. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # http://en.wikipedia.org/wiki/BibTeX and \cite for more info. # The default value is: plain. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain #--------------------------------------------------------------------------- # 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 too pretty with other RTF # readers/editors. # The default value is: NO. 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. # The default directory is: rtf. # This tag requires that the tag GENERATE_RTF is set to YES. 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. # The default value is: NO. # This tag requires that the tag GENERATE_RTF is set to YES. 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 some other Word compatible readers that support those # fields. # # Note: WordPad (write) and others do not support links. # The default value is: NO. # This tag requires that the tag GENERATE_RTF is set to YES. 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. # # See also section "Doxygen usage" for information on how to generate the # default style sheet that doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is # similar to doxygen's config file. A template extensions file can be generated # using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES doxygen will generate man pages for # classes and files. # The default value is: NO. 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. A directory man3 will be created inside the directory specified by # MAN_OUTPUT. # The default directory is: man. # This tag requires that the tag GENERATE_MAN is set to YES. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to the generated # man pages. In case the manual section does not start with a number, the number # 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is # optional. # The default value is: .3. # This tag requires that the tag GENERATE_MAN is set to YES. 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 value is: NO. # This tag requires that the tag GENERATE_MAN is set to YES. 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. # The default value is: NO. 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. # The default directory is: xml. # This tag requires that the tag GENERATE_XML is set to YES. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a # validating XML parser to check the syntax of the XML files. # This tag requires that the tag GENERATE_XML is set to YES. XML_SCHEMA = # The XML_DTD tag can be used to specify a XML DTD, which can be used by a # validating XML parser to check the syntax of the XML files. # This tag requires that the tag GENERATE_XML is set to YES. 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. # The default value is: YES. # This tag requires that the tag GENERATE_XML is set to YES. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- # If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. GENERATE_DOCBOOK = NO # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in # front of it. # The default directory is: docbook. # This tag requires that the tag GENERATE_DOCBOOK is set to YES. DOCBOOK_OUTPUT = docbook #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen # Definitions (see http://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. # The default value is: NO. 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. # The default value is: NO. 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. # The default value is: NO. # This tag requires that the tag GENERATE_PERLMOD is set to YES. 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. # The default value is: YES. # This tag requires that the tag GENERATE_PERLMOD is set to YES. 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. # This tag requires that the tag GENERATE_PERLMOD is set to YES. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. 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 only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. MACRO_EXPANSION = YES # 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. # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES the includes files in the # INCLUDE_PATH will be searched if a #include is found. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 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. # This tag requires that the tag SEARCH_INCLUDES is set to YES. 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. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 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 e.g. # 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. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. PREDEFINED = __attribute__(x)= # 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 that overrules the # definition found in the source code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # remove all refrences to 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. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration options related to external references #--------------------------------------------------------------------------- # The TAGFILES tag can be used to specify one or more tag files. For each tag # file the location of the external documentation should be added. 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. See the # section "Linking to external documentation" for more information about the use # of tag files. # Note: Each tag file must have an 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. See section "Linking to # external documentation" for more information about the usage of tag files. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external class will be listed in the # class index. If set to NO only the inherited external classes will be listed. # The default value is: NO. 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. # The default value is: YES. EXTERNAL_GROUPS = YES # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. EXTERNAL_PAGES = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of 'which perl'). # The default file (with absolute path) is: /usr/bin/perl. PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to # NO turns the diagrams off. Note that this option also works with HAVE_DOT # disabled, but it is recommended to install and use dot, since it yields more # powerful graphs. # The default value is: YES. 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 = # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. # If left empty dia is assumed to be found in the default search path. DIA_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. # The default value is: YES. 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 (see: # http://www.graphviz.org/), 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 value is: NO. HAVE_DOT = NO # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed # to run in parallel. When set to 0 doxygen will base this on the number of # processors available in the system. You can set it explicitly to a value # larger than 0 to get control over the balance between CPU load and processing # speed. # Minimum value: 0, maximum value: 32, default value: 0. # This tag requires that the tag HAVE_DOT is set to YES. DOT_NUM_THREADS = 0 # When you want a differently looking font n the dot files that doxygen # generates you can specify the font name using DOT_FONTNAME. You need to make # sure dot is able to find the font, which can be done by putting it in a # standard location or by setting the DOTFONTPATH environment variable or by # setting DOT_FONTPATH to the directory containing the font. # The default value is: Helvetica. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTNAME = Helvetica # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of # dot graphs. # Minimum value: 4, maximum value: 24, default value: 10. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the default font as specified with # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set # the path where dot can find it using this tag. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = # If the CLASS_GRAPH tag is 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 CLASS_DIAGRAMS tag to NO. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH tag is 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. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for # groups, showing the direct groups dependencies. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. 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. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. UML_LOOK = NO # If the UML_LOOK tag is enabled, the fields and methods are shown inside the # class node. If there are many fields or methods and many nodes the graph may # become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the # number of items for each type to make the size more manageable. Set this to 0 # for no limit. Note that the threshold may be exceeded by 50% before the limit # is enforced. So when you set the threshold to 10, up to 15 fields may appear, # but if the number exceeds 15, the total amount of fields shown is limited to # 10. # Minimum value: 0, maximum value: 100, default value: 10. # This tag requires that the tag HAVE_DOT is set to YES. UML_LIMIT_NUM_FIELDS = 10 # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. TEMPLATE_RELATIONS = NO # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDE_GRAPH = YES # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES 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. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH tag is 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. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. CALL_GRAPH = NO # If the CALLER_GRAPH tag is 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. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical # hierarchy of all classes instead of a textual one. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH tag is 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. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). # Possible values are: png, jpg, gif and svg. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. DOT_IMAGE_FORMAT = png # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. # # Note that this requires a modern browser other than Internet Explorer. Tested # and working are Firefox, Chrome, Safari, and Opera. # Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make # the SVG files visible. Older versions of IE do not have SVG support. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. INTERACTIVE_SVG = NO # The DOT_PATH tag 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. # This tag requires that the tag HAVE_DOT is set to YES. 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). # This tag requires that the tag HAVE_DOT is set to YES. DOTFILE_DIRS = # The MSCFILE_DIRS tag can be used to specify one or more directories that # contain msc files that are included in the documentation (see the \mscfile # command). MSCFILE_DIRS = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile # command). DIAFILE_DIRS = # The 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. # Minimum value: 0, maximum value: 10000, default value: 50. # This tag requires that the tag HAVE_DOT is set to YES. 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. # Minimum value: 0, maximum value: 1000, default value: 0. # This tag requires that the tag HAVE_DOT is set to YES. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not seem # to support this out of the box. # # 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). # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. DOT_TRANSPARENT = NO # 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. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. DOT_MULTI_TARGETS = NO # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot # files that are used to generate the various graphs. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES 07070100000010000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000001D00000000libmicrodns-0.2.0+6/examples07070100000011000081A40000000000000000000000016291210E000011D2000000000000000000000000000000000000002800000000libmicrodns-0.2.0+6/examples/announce.c/* * Copyright © 2014-2015 VideoLabs SAS * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include <stdio.h> #include <signal.h> #include <string.h> #include <microdns/microdns.h> #include "compat.h" #ifdef HAVE_UNISTD_H #include <unistd.h> #endif volatile sig_atomic_t sigflag = 0; static void sighandler(int signum) { char s[] = "SIGINT received, exiting ...\n"; ssize_t result = write(fileno(stdout), s, sizeof(s)); (void)result; sigflag = 1; } static bool stop(void *cbarg) { return (sigflag ? true : false); } static void callback(void *cbarg, const struct sockaddr *mdns_ip, const char* service, enum mdns_announce_type type) { if ( service != NULL && strcmp( service, "_googlecast._tcp.local" ) ) return; struct mdns_ctx *ctx = (struct mdns_ctx *) cbarg; struct mdns_hdr hdr = {0}; struct rr_entry answers[4] = {{0}}; // A/AAAA, SRV, TXT, PTR hdr.flags |= FLAG_QR; hdr.flags |= FLAG_AA; hdr.num_ans_rr = sizeof(answers) / sizeof(answers[0]); for (int i = 0; i < hdr.num_ans_rr; i++) { answers[i].rr_class = RR_IN; answers[i].ttl = type == MDNS_ANNOUNCE_GOODBYE ? 0 : 120; answers[i].msbit = 1; if (i + 1 < hdr.num_ans_rr) answers[i].next = &answers[i + 1]; } char domain_name[] = "mdnshost.local"; char service_type[] = "_googlecast._tcp.local"; // link service type (_googlecast._tcp) to our domain (mdnshost.local) char service_type_link[] = "mdnshost mDNShost._googlecast._tcp.local"; // RR_PTR: point service type (_vlc._tcp._local) to local domain answers[0].type = RR_PTR; answers[0].name = service_type; answers[0].data.PTR.domain = service_type_link; // RR_TXT: provide additional information (HTTP server root directory etc.) answers[1].type = RR_TXT; answers[1].name = service_type_link; // RR_SRV: provide info about the service we're announcing (port no, etc.) answers[2].type = RR_SRV; answers[2].name = service_type_link; answers[2].data.SRV.port = 9001; answers[2].data.SRV.priority = 0; answers[2].data.SRV.weight = 0; answers[2].data.SRV.target = domain_name; // RR_A/AAAA: link .local domain to IP address answers[3].name = domain_name; if (mdns_ip->sa_family == AF_INET) { answers[3].type = RR_A; memcpy(&answers[3].data.A.addr, &((struct sockaddr_in*)mdns_ip)->sin_addr, sizeof(answers[3].data.A.addr)); } else { answers[3].type = RR_AAAA; memcpy(&answers[3].data.AAAA.addr, &((struct sockaddr_in6*)mdns_ip)->sin6_addr, sizeof(answers[3].data.AAAA.addr)); } mdns_entries_send(ctx, &hdr, answers); } int main(int argc, char *argv[]) { int r = 0; char err[128]; struct mdns_ctx *ctx; signal(SIGINT, sighandler); signal(SIGTERM, sighandler); if ((r = mdns_init(&ctx, NULL, MDNS_PORT)) < 0) goto err; // test with `ping mdnshost.local` after discovery (run ./test first) // NB: a zeroconf service (eg Avahi) must be running for ping to work mdns_announce(ctx, RR_PTR, callback, ctx); if ((r = mdns_serve(ctx, stop, NULL)) < 0) goto err; err: if (r < 0) { mdns_strerror(r, err, sizeof(err)); fprintf(stderr, "fatal: %s\n", err); } mdns_destroy(ctx); return (0); } 07070100000012000081A40000000000000000000000016291210E00000A1D000000000000000000000000000000000000002400000000libmicrodns-0.2.0+6/examples/main.c/* * Copyright © 2014-2015 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include <compat.h> #include <stdio.h> #include <signal.h> #include <microdns/microdns.h> #include "compat.h" #ifdef HAVE_UNISTD_H #include <unistd.h> #endif volatile sig_atomic_t sigflag = 0; static void sighandler(int signum) { char s[] = "SIGINT received, exiting ...\n"; ssize_t result = write(fileno(stdout), s, sizeof(s)); (void)result; sigflag = 1; } static bool stop(void *p_cookie) { return (sigflag ? true : false); } static void callback(void *p_cookie, int status, const struct rr_entry *entries) { char err[128]; if (status < 0) { mdns_strerror(status, err, sizeof(err)); fprintf(stderr, "error: %s\n", err); return; } mdns_entries_print(entries); } int main(int i_argc, char *ppsz_argv[]) { int r = 0; char err[128]; struct mdns_ctx *ctx; const char **ppsz_names; int i_nb_names; static const char *psz_default_name = "_googlecast._tcp.local"; if (i_argc > 1) { ppsz_names = (const char **) &ppsz_argv[1]; i_nb_names = i_argc - 1; } else { ppsz_names = &psz_default_name; i_nb_names = 1; } signal(SIGINT, &sighandler); if ((r = mdns_init(&ctx, NULL, MDNS_PORT)) < 0) goto err; if ((r = mdns_listen(ctx, ppsz_names, i_nb_names, RR_PTR, 10, stop, callback, NULL)) < 0) goto err; err: if (r < 0) { mdns_strerror(r, err, sizeof(err)); fprintf(stderr, "fatal: %s\n", err); } mdns_destroy(ctx); return (0); } 07070100000013000081A40000000000000000000000016291210E00000141000000000000000000000000000000000000002900000000libmicrodns-0.2.0+6/examples/meson.buildif get_option('examples').disabled() subdir_done() endif examples_kwargs = { 'include_directories': incdirs, 'link_with': libmicrodns, 'c_args': c_args, 'link_args': link_flags, } executable('listen', 'main.c', kwargs: examples_kwargs) executable('announce', 'announce.c', kwargs: examples_kwargs) 07070100000014000041ED0000000000000000000000036291210E00000000000000000000000000000000000000000000001C00000000libmicrodns-0.2.0+6/include07070100000015000081A40000000000000000000000016291210E0000067F000000000000000000000000000000000000002300000000libmicrodns-0.2.0+6/include/mdns.h/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2020 VideoLabs SAS * * Author: Hugo Beauzée-Luyssen <hugo@beauzee.fr> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifndef MDNS_H #define MDNS_H #include "microdns/microdns.h" int mdns_parse(struct mdns_hdr *hdr, struct rr_entry **entries, const uint8_t *buf, size_t length); int mdns_write(const struct mdns_hdr *hdr, const struct rr_entry *entries, uint8_t *buf, size_t bufSize, size_t* length); void mdns_free(struct rr_entry *entries); #endif // MDNS_H 07070100000016000081A40000000000000000000000016291210E00000084000000000000000000000000000000000000002800000000libmicrodns-0.2.0+6/include/meson.buildlibmicrodns_headers = [ 'microdns/microdns.h', 'microdns/rr.h', ] install_headers(libmicrodns_headers, subdir: 'microdns') 07070100000017000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000002500000000libmicrodns-0.2.0+6/include/microdns07070100000018000081A40000000000000000000000016291210E00001EA2000000000000000000000000000000000000003000000000libmicrodns-0.2.0+6/include/microdns/microdns.h/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2014-2016 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifndef MICRODNS_MDNS_H #define MICRODNS_MDNS_H /** * @file microdns.h * @brief main functions to listen and announce services */ #include <stdbool.h> #include "rr.h" # ifdef __cplusplus extern "C" { # endif #if defined(_MSC_VER) #define MDNS_EXPORT __declspec(dllexport) extern #else #define MDNS_EXPORT extern #endif struct mdns_ctx; #define MDNS_PORT 5353 #define MDNS_ADDR_IPV4 "224.0.0.251" #define MDNS_ADDR_IPV6 "FF02::FB" #define GET_RCODE(x) (x&0x000f) #define SET_RCODE(x,c) (x|(c&0x000f)) #define GET_OPCODE(x) (x&0x7800) #define SET_OPCODE(x,c) (x|(c&0x7800)) enum mdns_hdr_flag { FLAG_QR = 1 << 15, // Question/Response FLAG_AA = 1 << 10, // Authoritative Answer FLAG_TC = 1 << 9, // Truncated Response FLAG_RD = 1 << 8, // Recursion Desired FLAG_RA = 1 << 7, // Recursion Available FLAG_Z = 1 << 6, // Reserved FLAG_AD = 1 << 5, // Authentic Data FLAG_CD = 1 << 4, // Checking Disabled }; struct mdns_hdr { uint16_t id; uint16_t flags; uint16_t num_qn; uint16_t num_ans_rr; uint16_t num_auth_rr; uint16_t num_add_rr; }; enum mdns_announce_type { MDNS_ANNOUNCE_INITIAL, // An initial announce needs to be sent MDNS_ANNOUNCE_RESPONSE, // The application needs to respond to an MDNS question MDNS_ANNOUNCE_GOODBYE, // A goodbye packet needs to be sent }; typedef void (*mdns_listen_callback)(void*, int, const struct rr_entry *); /** * @brief mdns_announce_callback Will be invoked for each received question * * @param cookie The pointer provided as last parameter to mdns_serve * @param addr The address for which a probe was received * @param service The service being probed or NULL when an initial discovery is requested * @param type The type of announce that's expected from the application * * It is the application responsibility to filter which service it should respond * to. * This callback will be invoked with a NULL service upon startup so that the * application can send a unsolicited announce. If there are more than a single * network interface, this callback might be invoked multiple times for the same * service, so that the application can announce itself as it sees fit (for * instance it can announce both an A and AAAA records) * This callback will also be invoked with a non-NULL service and * MDNS_ANNOUNCE_INITIAL if the requests it through mdns_request_initial_announce * In this case the application is responsible for knowing which service needs * to be announced and announce it accordingly. */ typedef void (*mdns_announce_callback)(void* cookie, const struct sockaddr *addr, const char* service, enum mdns_announce_type type ); /** * \return true if the listener should be stopped */ typedef bool (*mdns_stop_func)(void*); /** * @brief Allocates and initialize a new mdns context * * @param ctx Returns the allocated context for the library [OUT] * @param addr Protocol specific address to listen to, or NULL to use both IPv4 and IPv6 * @param port Port to listen on * * @see use mdns_destroy() to clean * * @return 0 if success, negative in other cases */ MDNS_EXPORT int mdns_init(struct mdns_ctx **ctx, const char *addr, unsigned short port); /** * @brief Destroy an mdns context * * @param ctx The context created by mdns_init() * * @return 0 if success, negative in other cases */ MDNS_EXPORT int mdns_destroy(struct mdns_ctx *ctx); /** * @brief Send the entries on the network * * @param ctx A mdns context created by mdns_init() * @param hdr A mdns_hdr header * @param entries The entries to send * * @return 0 if successful, negative in other cases */ MDNS_EXPORT int mdns_entries_send(const struct mdns_ctx *ctx, const struct mdns_hdr *hdr, const struct rr_entry *entries); /** * @brief Print in human form an entry to debug * * @param entry The entry one wants to debug */ MDNS_EXPORT void mdns_entries_print(const struct rr_entry *); /** * @brief Wrapper around strerror to get strings from errors * * @param error The error number * @param buf The buffer where the string can be written * @param n The maximum of characters that can be written inside buf * * @return 0 if success, negative in other cases */ MDNS_EXPORT int mdns_strerror(int error, char *buf, size_t n); /** * @brief The main listening function for mDNS * * @param ctx A mdns context created by mdns_init() * @param names The list of names of the services you are looking for * @param nb_names The number of names in names list * @param type The type of Record you want \see rr_type * @param interval The refreshing interval to send a probe request (in seconds) * @param stop The stop function to stop the discovery * @param callback The callback function to receive the entries * @param p_cookie user data for the callback * * @return 0 if success, negative in other cases */ MDNS_EXPORT int mdns_listen(const struct mdns_ctx *ctx, const char *const names[], unsigned int nb_names, enum rr_type type, unsigned int interval, mdns_stop_func stop, mdns_listen_callback callback, void *p_cookie); /** * @brief Announce a new name to serve * * @param ctx A mdns context created by mdns_init() * @param type The type of Record you want \see rr_type * @param callback The callback function to send the entries * @param p_cookie user data for the callback * * @return 0 if success, negative in other cases */ MDNS_EXPORT int mdns_announce(struct mdns_ctx *ctx, enum rr_type type, mdns_announce_callback callback, void *p_cookie); /** * @brief The main serving function for mDNS * mdns_announce() must be called before for each service you want to announce. * * @param ctx A mdns context created by mdns_init() * @param stop The stop function to stop the discovery * @param p_cookie user data for the callback * * @return 0 if success, negative in other cases */ MDNS_EXPORT int mdns_serve(struct mdns_ctx *ctx, mdns_stop_func stop, void *p_cookie); /** * @brief mdns_request_initial_announce Request an initial announce for the provided service * @param ctx A mdns context created by mdns_init() * @param service */ MDNS_EXPORT void mdns_request_initial_announce(struct mdns_ctx *ctx, const char* service); # ifdef __cplusplus } # endif #endif /* MICRODNS_MDNS_H */ 07070100000019000081A40000000000000000000000016291210E00000AC0000000000000000000000000000000000000002A00000000libmicrodns-0.2.0+6/include/microdns/rr.h/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2014-2016 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifndef MICRODNS_RR_H #define MICRODNS_RR_H #include <stdint.h> #if defined (__unix__) || defined (__APPLE__) # include <arpa/inet.h> # include <netinet/in.h> #elif defined(_WIN32) # include <ws2tcpip.h> #endif # ifdef __cplusplus extern "C" { # endif enum rr_type { RR_A = 0x01, RR_PTR = 0x0C, RR_TXT = 0x10, RR_AAAA = 0x1C, RR_SRV = 0x21, }; enum rr_class { RR_IN = 0x01, }; struct rr_data_srv { uint16_t priority; uint16_t weight; uint16_t port; char *target; }; struct rr_data_txt { char txt[256]; // RFC 6762 struct rr_data_txt *next; }; struct rr_data_ptr { char *domain; }; struct rr_data_a { char addr_str[INET_ADDRSTRLEN]; struct in_addr addr; }; struct rr_data_aaaa { char addr_str[INET6_ADDRSTRLEN]; struct in6_addr addr; }; union rr_data { struct rr_data_srv SRV; struct rr_data_txt *TXT; struct rr_data_ptr PTR; struct rr_data_a A; struct rr_data_aaaa AAAA; }; struct rr_entry { char *name; uint16_t type; uint16_t rr_class : 15; uint16_t msbit : 1; // unicast query | cache flush (RFC 6762) /* Answers only */ uint32_t ttl; uint16_t data_len; union rr_data data; struct rr_entry *next; }; # ifdef __cplusplus } # endif #endif /* MICRODNS_RR_H */ 0707010000001A000081A40000000000000000000000016291210E00000DBC000000000000000000000000000000000000002400000000libmicrodns-0.2.0+6/include/utils.h/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2014-2015 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifndef MICRODNS_UTILS_H #define MICRODNS_UTILS_H #include <inttypes.h> #include <stdio.h> #include <stdint.h> #if defined (__unix__) || defined (__APPLE__) # include <netinet/in.h> #endif #include "compat.h" #define MDNS_DN_MAXSZ 256 // domain name maximum size static inline int ss_family(const struct sockaddr_storage *ss) { return (((const struct sockaddr *) ss)->sa_family); } static inline int ss_level(const struct sockaddr_storage *ss) { return (ss_family(ss) == AF_INET ? IPPROTO_IP : IPPROTO_IPV6); } static inline socklen_t ss_len(const struct sockaddr_storage *ss) { return (ss_family(ss) == AF_INET ? sizeof(struct sockaddr_in) : sizeof(struct sockaddr_in6)); } static inline socklen_t sa_len(const struct sockaddr* sa) { return sa->sa_family == AF_INET ? sizeof(struct sockaddr_in) : sizeof(struct sockaddr_in6); } static inline uint8_t *write_u16(uint8_t *p, size_t *s, const uint16_t v) { *p++ = (v >> 8) & 0xFF; *p++ = (v >> 0) & 0xFF; if (s != NULL) *s -= 2; return (p); } static inline uint8_t *write_u32(uint8_t *p, size_t *s, const uint32_t v) { *p++ = (v >> 24) & 0xFF; *p++ = (v >> 16) & 0xFF; *p++ = (v >> 8) & 0xFF; *p++ = (v >> 0) & 0xFF; if (s != NULL) *s -= 4; return (p); } static inline uint8_t *write_raw(uint8_t *p, size_t* s, const uint8_t *v) { size_t len; len = strlen((const char *) v) + 1; if (*s < len) return (NULL); memcpy(p, v, len); p += len; *s -= len; return (p); } static inline const uint8_t *read_u16(const uint8_t *p, size_t *s, uint16_t *v) { *v = 0; *v |= (uint16_t)*p++ << 8; *v |= (uint16_t)*p++ << 0; *s -= 2; return (p); } static inline const uint8_t *read_u32(const uint8_t *p, size_t *s, uint32_t *v) { *v = 0; *v |= (uint32_t)*p++ << 24; *v |= (uint32_t)*p++ << 16; *v |= (uint32_t)*p++ << 8; *v |= (uint32_t)*p++ << 0; *s -= 4; return (p); } #endif /* MICRODNS_UTILS_H */ 0707010000001B000081A40000000000000000000000016291210E0000145D000000000000000000000000000000000000002000000000libmicrodns-0.2.0+6/meson.build# This file is part of libmicrodns. # # Copyright © 2019 VideoLabs SAS # # Author: Mathieu Duponchelle <mathieu@centricular.com> # ######################################################################### # libmicrodns is released under LGPLv2.1 (or later) and is also available # under a commercial license. ######################################################################### # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. # # You should have received a copy of the GNU Lesser 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. project('microdns', ['c'], version : '0.2.0', meson_version : '>= 0.50.0', default_options : ['warning_level=2', 'buildtype=release', 'b_ndebug=if-release']) mdns_version = meson.project_version() mdns_soname_version = '1.0.0' ver_arr = mdns_soname_version.split('.') mdns_major_version = ver_arr[0] mdns_minor_version = ver_arr[1] mdns_micro_version = ver_arr[2] cc = meson.get_compiler('c') warning_flags = [] warning_flags += [ '-Wsign-compare', '-Wstrict-aliasing', '-Wstrict-overflow', '-Wformat=2', '-Wno-unused-parameter', '-Wcast-align', '-Wpointer-arith', '-Wmissing-prototypes', '-Wwrite-strings', '-Wlogical-op', ] add_project_arguments(cc.get_supported_arguments(warning_flags), language: 'c') cdata = configuration_data() deps = [] cc_args = [] host_system = host_machine.system() if host_system == 'windows' deps += [cc.find_library('ws2_32')] deps += [cc.find_library('iphlpapi')] building_for_vista = cc.compiles('''#include <windows.h> #ifndef WINVER #error "unknown minimum supported OS version" #endif #if (WINVER < _WIN32_WINNT_VISTA) #error "Windows Vista API is not guaranteed" #endif ''', name: 'building for Windows Vista') if not building_for_vista cc_args = [ '-D_WIN32_WINNT=_WIN32_WINNT_VISTA', '-DWINVER=_WIN32_WINNT_VISTA', ] add_project_arguments(cc_args, language: 'c') endif endif inet_ntop_src = ''' #ifdef _WIN32 #include <ws2tcpip.h> #include <windows.h> #else #include <sys/socket.h> #include <arpa/inet.h> #endif int main() { inet_ntop(AF_INET, NULL, NULL, 0); } ''' if cc.links(inet_ntop_src, dependencies: deps, args: cc_args) cdata.set('HAVE_INET_NTOP', 1) endif poll_src = ''' #include <stddef.h> #ifdef _WIN32 #include <winsock2.h> #include <windows.h> # if defined(_MSC_VER) # error # endif #else #include <poll.h> #endif int main() { poll(NULL, 0, 0); } ''' if cc.links(poll_src, dependencies: deps, args: cc_args) cdata.set('HAVE_POLL', 1) endif pollfd_check_prefix = '#include <sys/types.h>\n' if cdata.get('HAVE_POLL', 0) == 1 pollfd_check_prefix += '#include <poll.h>\n' elif host_system == 'windows' pollfd_check_prefix += '#include <winsock2.h>' endif if cc.has_type('struct pollfd', prefix: pollfd_check_prefix, args: cc_args) cdata.set('HAVE_STRUCT_POLLFD', 1) endif if cc.has_function('getifaddrs') cdata.set('HAVE_GETIFADDRS', 1) endif if cc.has_header('ifaddrs.h') cdata.set('HAVE_IFADDRS_H', 1) endif if cc.has_header('unistd.h') cdata.set('HAVE_UNISTD_H', 1) endif configure_file(output : 'config.h', configuration : cdata) c_args = ['-DHAVE_CONFIG_H'] if host_system == 'windows' c_args += [ '-D_UNICODE=1', '-DUNICODE=1', '-D_POSIX_C_SOURCE=200809L', '-D_BSD_SOURCE=1' ] endif if cc.get_id() == 'msvc' c_args += [ '-D_CRT_NONSTDC_NO_DEPRECATE', '-D_CRT_SECURE_NO_WARNINGS', '-D_CRT_SECURE_NO_DEPRECATE', ] endif link_flags=[] if get_option('fuzzing') if cc.has_argument('-fsanitize=fuzzer') fuzz_flags = ['-fsanitize=fuzzer-no-link,address,undefined'] c_args += fuzz_flags c_args += ['-fprofile-instr-generate', '-fcoverage-mapping'] link_flags += fuzz_flags link_flags += ['-fprofile-instr-generate', '-fcoverage-mapping'] else error('Unsupported required option: -fsanitize=fuzzer') endif endif incdirs = include_directories('.', 'include', 'compat') subdir('compat') subdir('include') subdir('src') mdns_dep = declare_dependency(link_with : libmicrodns, include_directories : incdirs, dependencies: deps, ) doc_cdata = configuration_data() doc_cdata.set('PACKAGE_NAME', meson.project_name()) doc_cdata.set('VERSION', mdns_version) doc_cdata.set('abs_top_srcdir', meson.current_source_dir()) configure_file( input: 'doc/Doxyfile.in', output: 'Doxyfile', configuration: doc_cdata ) subdir('examples') subdir('tests') 0707010000001C000081A40000000000000000000000016291210E00000095000000000000000000000000000000000000002600000000libmicrodns-0.2.0+6/meson_options.txtoption('fuzzing', type: 'boolean', value: false) option('tests', type: 'feature', value: 'auto') option('examples', type: 'feature', value: 'auto') 0707010000001D000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000001800000000libmicrodns-0.2.0+6/src0707010000001E000081A40000000000000000000000016291210E00007FE1000000000000000000000000000000000000001F00000000libmicrodns-0.2.0+6/src/mdns.c/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2014-2016 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include <stdlib.h> #include <string.h> #include <errno.h> #include <time.h> #include <stdint.h> #include "compat.h" #include "utils.h" #include "microdns/microdns.h" #include "mdns.h" #define MDNS_PKT_MAXSZ 4096 // read/write buffer size struct mdns_svc { enum rr_type type; union { mdns_announce_callback announce_callback; //mdns_listen_callback listen_callback; // currently unused }; void *p_cookie; struct mdns_svc *next; }; struct mdns_conn { sock_t sock; uint32_t intf_idx; struct sockaddr_storage intf_addr; // IP address and family of the interface struct sockaddr_storage mcast_addr; // The multicast address targeted by this connection }; struct mdns_ctx { struct mdns_conn *conns; size_t nb_conns; struct mdns_svc *services; }; static int mdns_resolve(struct mdns_ctx *ctx, const char *addr, unsigned short port); static size_t mdns_write_hdr(uint8_t *, size_t *s, const struct mdns_hdr *); static int strrcmp(const char *, const char *); extern const uint8_t *rr_read(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *, int8_t ans); extern ssize_t rr_write(uint8_t *, size_t *, const struct rr_entry *, int8_t ans); extern void rr_print(const struct rr_entry *); extern void rr_free(struct rr_entry *); #ifndef _WIN32 #if HAVE_GETIFADDRS static bool mdns_is_interface_valuable(const struct ifaddrs* ifa, int family) { struct sockaddr_in6 saddr; if (ifa->ifa_addr == NULL) return false; memcpy(&saddr, ifa->ifa_addr, sizeof(saddr)); return ifa->ifa_addr->sa_family == family && (ifa->ifa_flags & IFF_LOOPBACK) == 0 && (ifa->ifa_flags & IFF_UP) != 0 && (ifa->ifa_flags & IFF_RUNNING) != 0 && /* We only want a link local address, especially since we then * can get the associated interface index */ ((family == AF_INET6 && saddr.sin6_scope_id != 0) || ifa->ifa_addr->sa_family == AF_INET); } static size_t count_interfaces(const struct ifaddrs *ifs, const struct addrinfo* addrs) { size_t nb_if = 0; for ( const struct addrinfo* addr = addrs; addr != NULL; addr = addr->ai_next ) { for (const struct ifaddrs *c = ifs; c != NULL; c = c->ifa_next) { if (!mdns_is_interface_valuable(c, addr->ai_family)) { continue; } nb_if++; } } return nb_if; } static int mdns_list_interfaces(uint32_t** pp_intfs, struct sockaddr_storage **pp_mdns_ips, size_t* p_nb_intf, struct sockaddr_storage **pp_mcast_addrs, const struct addrinfo* addrs) { struct ifaddrs *ifs; struct sockaddr_storage *mdns_ips; struct ifaddrs *c; struct sockaddr_storage *mcast_addrs; size_t nb_if; uint32_t* intfs; *p_nb_intf = 0; if (getifaddrs(&ifs) || ifs == NULL) return (MDNS_NETERR); nb_if = count_interfaces(ifs, addrs); if (nb_if == 0) { freeifaddrs(ifs); return (MDNS_ERROR); } *pp_intfs = intfs = malloc(sizeof(*intfs) * nb_if); if (intfs == NULL) { freeifaddrs(ifs); return (MDNS_ERROR); } *pp_mdns_ips = mdns_ips = malloc(sizeof(*mdns_ips) * nb_if); if (mdns_ips == NULL) { free(intfs); *pp_intfs = NULL; freeifaddrs(ifs); return (MDNS_ERROR); } *pp_mcast_addrs = mcast_addrs = malloc(sizeof(*mcast_addrs) * nb_if); if (mcast_addrs == NULL) { free(mdns_ips); free(intfs); *pp_intfs = NULL; *pp_mdns_ips = NULL; freeifaddrs(ifs); return (MDNS_ERROR); } for ( const struct addrinfo* addr = addrs; addr != NULL; addr = addr->ai_next ) { for (c = ifs; c != NULL; c = c->ifa_next) { if (!mdns_is_interface_valuable(c, addr->ai_family)) continue; if (c->ifa_addr->sa_family == AF_INET) { *intfs = if_nametoindex(c->ifa_name); } else { memcpy(intfs, &((struct sockaddr_in6*)c->ifa_addr)->sin6_scope_id, sizeof(*intfs)); } memcpy(mdns_ips, c->ifa_addr, sa_len(c->ifa_addr)); memcpy(mcast_addrs, addr->ai_addr, sa_len(addr->ai_addr)); mdns_ips++; intfs++; mcast_addrs++; } } freeifaddrs(ifs); *p_nb_intf = nb_if; return (0); } #else static size_t mdns_list_interfaces(uint32_t** pp_intfs, struct sockaddr_storage **pp_mdns_ips, size_t* p_nb_intf, struct sockaddr_storage **pp_mcast_addrs, const struct addrinfo* addrs) { struct sockaddr_storage *mdns_ips; uint32_t *intfs; size_t nb_intfs = 0; for( const struct addrinfo* addr = addrs; addr != NULL; addr = addr->ai_next ) { if( addr->ai_family == AF_INET || addr->ai_family == AF_INET6 ) ++nb_intfs; } *pp_intfs = intfs = malloc( nb_intfs * sizeof(*intfs) ); if (intfs == NULL) return (MDNS_ERROR); *pp_mdns_ips = mdns_ips = malloc( nb_intfs * sizeof(*mdns_ips) ); if (mdns_ips == NULL) { free(intfs); *pp_intfs = NULL; return (MDNS_ERROR); } struct sockaddr_storage* mcast_addrs; mcast_addrs = *pp_mcast_addrs = malloc( nb_intfs * sizeof( *mcast_addrs ) ); if( mcast_addrs == NULL ) { free(mdns_ips); free(intfs); *pp_intfs = NULL; *pp_mdns_ips = NULL; return (MDNS_ERROR); } for( const struct addrinfo* addr = addrs; addr != NULL; addr = addr->ai_next ) { if( addr->ai_family == AF_INET || addr->ai_family == AF_INET6 ) { *intfs = 0; /* Take a shortcut assuming when we are in this case, we * can use MCAST_JOIN_GROUP. Otherwise, we need the * adapter IP address, which without getifaddrs is a pain * in the lower back to fetch */ #ifndef MCAST_JOIN_GROUP # error We need the adapter address #endif mdns_ips->ss_family = addr->ai_family; memcpy(mcast_addrs, addr->ai_addr, sa_len(addr->ai_addr)); intfs++; mdns_ips++; mcast_addrs++; } } *p_nb_intf = nb_intfs; return (0); } #endif // HAVE_GETIFADDRS #else // _WIN32 static bool mdns_is_interface_valuable(IP_ADAPTER_ADDRESSES *intf, int family) { return (intf->IfType == IF_TYPE_IEEE80211 || intf->IfType == IF_TYPE_ETHERNET_CSMACD) && intf->OperStatus == IfOperStatusUp && ((family == AF_INET && intf->Ipv4Enabled) || (family == AF_INET6 && intf->Ipv6Enabled)); } static size_t mdns_list_interfaces(uint32_t** pp_intfs, struct sockaddr_storage **pp_mdns_ips, size_t* p_nb_intf, struct sockaddr_storage **pp_mcast_addrs, const struct addrinfo* addrs) { uint32_t* intfs; struct sockaddr_storage *mdns_ips; struct sockaddr_storage *mcast_addrs; IP_ADAPTER_ADDRESSES *res = NULL, *current; ULONG size; HRESULT hr; size_t nb_intf = 0; *p_nb_intf = 0; /** * https://msdn.microsoft.com/en-us/library/aa365915.aspx * * The recommended method of calling the GetAdaptersAddresses function is to pre-allocate a * 15KB working buffer pointed to by the AdapterAddresses parameter. On typical computers, * this dramatically reduces the chances that the GetAdaptersAddresses function returns * ERROR_BUFFER_OVERFLOW, which would require calling GetAdaptersAddresses function multiple * times. The example code illustrates this method of use. */ size = 15 * 1024; do { free(res); res = malloc( size ); if (res == NULL) return (MDNS_ERROR); hr = GetAdaptersAddresses(AF_UNSPEC, GAA_FLAG_SKIP_ANYCAST | GAA_FLAG_SKIP_DNS_SERVER, NULL, res, &size); } while (hr == ERROR_BUFFER_OVERFLOW); if (hr != NO_ERROR) { free(res); return (MDNS_NETERR); } for ( const struct addrinfo* addr = addrs; addr != NULL; addr = addr->ai_next ) { for (current = res; current != NULL; current = current->Next) { if (!mdns_is_interface_valuable(current, addr->ai_family)) continue; ++nb_intf; } } if (nb_intf == 0) { // Fallback to the default interface *pp_intfs = malloc(sizeof(*intfs)); if (*pp_intfs == NULL) { free(res); return (MDNS_ERROR); } **pp_intfs = 0; *pp_mdns_ips = mdns_ips = malloc(sizeof(*mdns_ips)); if (*pp_mdns_ips == NULL) { free(*pp_intfs); free(res); return (MDNS_ERROR); } memset(mdns_ips, 0, sizeof(*mdns_ips)); *pp_mcast_addrs = mcast_addrs = malloc(sizeof(*mcast_addrs)); if (mcast_addrs == NULL) { free(mdns_ips); free(*pp_intfs); free(res); return (MDNS_ERROR); } memcpy(mcast_addrs, addrs->ai_addr, sa_len(addrs->ai_addr)); *p_nb_intf = 1; return (0); } *pp_intfs = intfs = malloc(nb_intf * sizeof(*intfs)); if (intfs == NULL) { free(res); return (MDNS_ERROR); } *pp_mdns_ips = mdns_ips = malloc(sizeof(*mdns_ips) * nb_intf); if (mdns_ips == NULL) { free(intfs); free(res); return (MDNS_ERROR); } *pp_mcast_addrs = mcast_addrs = malloc(sizeof(*mcast_addrs) * nb_intf); if (mcast_addrs == NULL) { free(mdns_ips); free(intfs); free(res); return (MDNS_ERROR); } for ( const struct addrinfo* addr = addrs; addr != NULL; addr = addr->ai_next ) { for (current = res; current != NULL; current = current->Next) { if (!mdns_is_interface_valuable(current, addr->ai_family)) continue; if (addr->ai_family == AF_INET6) { *intfs = current->Ipv6IfIndex; } else { *intfs = current->IfIndex; } memcpy(mcast_addrs, addr->ai_addr, sa_len(addr->ai_addr)); PIP_ADAPTER_UNICAST_ADDRESS p_unicast = current->FirstUnicastAddress; if (p_unicast == NULL) { free(mdns_ips); free(intfs); free(res); return (MDNS_ERROR); } // Take the first unicast address (highest priority) for (; p_unicast != NULL; p_unicast = p_unicast->Next) { if (p_unicast->Address.lpSockaddr->sa_family != addr->ai_family) { continue; } if (addr->ai_family == AF_INET) { memcpy(mdns_ips, p_unicast->Address.lpSockaddr, sizeof(struct sockaddr_in)); } else { memcpy(mdns_ips, p_unicast->Address.lpSockaddr, sizeof(struct sockaddr_in6)); } } ++mdns_ips; ++intfs; ++mcast_addrs; } } *p_nb_intf = nb_intf; free(res); return (0); } #endif static int mdns_resolve(struct mdns_ctx *ctx, const char *addr, unsigned short port) { char buf[6]; struct addrinfo hints, *res = NULL; uint32_t* ifaddrs = NULL; struct sockaddr_storage *mdns_ips = NULL; struct sockaddr_storage *mcast_addrs = NULL; size_t i; int status; sprintf(buf, "%hu", port); memset(&hints, 0, sizeof(hints)); hints.ai_socktype = SOCK_DGRAM; hints.ai_flags = AI_NUMERICHOST | AI_NUMERICSERV; if (addr == NULL) { hints.ai_family = AF_INET; /* First, get the ipv4 multicast address info */ errno = getaddrinfo(MDNS_ADDR_IPV4, buf, &hints, &res); if (errno != 0) return (MDNS_LKPERR); /* Now get the ipv6 informations and link them with the ipv4 ones */ struct addrinfo *ipv6_res = NULL; hints.ai_family = AF_INET6; errno = getaddrinfo(MDNS_ADDR_IPV6, buf, &hints, &ipv6_res); if (errno != 0) { freeaddrinfo(res); return (MDNS_LKPERR); } struct addrinfo* ipv4 = res; for (; ipv4->ai_next != NULL; ipv4 = ipv4->ai_next) ; ipv4->ai_next = ipv6_res; } else { int family; if (!strcmp(addr, MDNS_ADDR_IPV4)) family = AF_INET; else if (!strcmp(addr, MDNS_ADDR_IPV6)) family = AF_INET6; else return (MDNS_LKPERR); hints.ai_family = family; errno = getaddrinfo(addr, buf, &hints, &res); if (errno != 0) return (MDNS_LKPERR); } status = mdns_list_interfaces(&ifaddrs, &mdns_ips, &ctx->nb_conns, &mcast_addrs, res); if ( status < 0) { freeaddrinfo(res); return (status); } if (ctx->nb_conns == 0) { freeaddrinfo(res); return (MDNS_NETERR); } ctx->conns = malloc(ctx->nb_conns * sizeof(*ctx->conns)); if (ctx->conns == NULL) { free(ifaddrs); free(mdns_ips); freeaddrinfo(res); free(mcast_addrs); return (MDNS_ERROR); } for (i = 0; i < ctx->nb_conns; ++i ) { ctx->conns[i].sock = INVALID_SOCKET; ctx->conns[i].intf_idx = ifaddrs[i]; ctx->conns[i].intf_addr = mdns_ips[i]; ctx->conns[i].mcast_addr = mcast_addrs[i]; } free(mcast_addrs); free(ifaddrs); free(mdns_ips); freeaddrinfo(res); return (0); } int mdns_init(struct mdns_ctx **p_ctx, const char *addr, unsigned short port) { const uint32_t on_off = 1; const uint32_t ttl = 255; const uint32_t loop = 1; int res; union { struct sockaddr_storage ss; struct sockaddr_in sin; struct sockaddr_in6 sin6; } dumb; struct mdns_ctx *ctx; if (p_ctx == NULL) return (MDNS_ERROR); *p_ctx = NULL; ctx = malloc(sizeof(struct mdns_ctx)); if (ctx == NULL) return (MDNS_ERROR); ctx->services = NULL; ctx->conns = NULL; ctx->nb_conns = 0; errno = os_init("2.2"); if (errno != 0) return mdns_destroy(ctx), (MDNS_NETERR); res = mdns_resolve(ctx, addr, port); if (res < 0) return mdns_destroy(ctx), (res); for (size_t i = 0; i < ctx->nb_conns; ++i ) { struct sockaddr_storage* ss_addr = (struct sockaddr_storage*)&ctx->conns[i].mcast_addr; if ((ctx->conns[i].sock = socket(ctx->conns[i].intf_addr.ss_family, SOCK_DGRAM, IPPROTO_UDP)) == INVALID_SOCKET) return mdns_destroy(ctx), (MDNS_NETERR); if (setsockopt(ctx->conns[i].sock, SOL_SOCKET, SO_REUSEADDR, (const void *) &on_off, sizeof(on_off)) < 0) return mdns_destroy(ctx), (MDNS_NETERR); /* bind the receiver on any local address */ memset(&dumb, 0, sizeof(dumb)); dumb.ss.ss_family = ss_family(&ctx->conns[i].intf_addr); if (dumb.ss.ss_family == AF_INET) { dumb.sin.sin_port = htons(port); dumb.sin.sin_addr.s_addr = INADDR_ANY; } else { dumb.sin6.sin6_port = htons(port); dumb.sin6.sin6_addr = in6addr_any; } if (bind(ctx->conns[i].sock, (const struct sockaddr *) &dumb, ss_len(&dumb.ss)) < 0) return mdns_destroy(ctx), (MDNS_NETERR); if (os_mcast_join(ctx->conns[i].sock, ss_addr, ctx->conns[i].intf_idx, &ctx->conns[i].intf_addr) < 0) return mdns_destroy(ctx), (MDNS_NETERR); if (setsockopt(ctx->conns[i].sock, ss_level(&ctx->conns[i].intf_addr), ctx->conns[i].intf_addr.ss_family == AF_INET ? IP_MULTICAST_TTL : IPV6_MULTICAST_HOPS, (const void *) &ttl, sizeof(ttl)) < 0) { return mdns_destroy(ctx), (MDNS_NETERR); } if (setsockopt(ctx->conns[i].sock, ss_level(&ctx->conns[i].intf_addr), ctx->conns[i].intf_addr.ss_family == AF_INET ? IP_MULTICAST_LOOP : IPV6_MULTICAST_LOOP, (const void *) &loop, sizeof(loop)) < 0) { return mdns_destroy(ctx), (MDNS_NETERR); } } *p_ctx = ctx; return (0); } int mdns_destroy(struct mdns_ctx *ctx) { if (ctx != NULL) { for (size_t i = 0; i < ctx->nb_conns; ++i) { struct mdns_conn *conn = &ctx->conns[i]; if (conn->sock != INVALID_SOCKET) { os_close(conn->sock); conn->sock = INVALID_SOCKET; } } free(ctx->conns); if (ctx->services) { struct mdns_svc *svc; while ((svc = ctx->services)) { ctx->services = ctx->services->next; free(svc); } } free(ctx); } if (os_cleanup() < 0) return (MDNS_NETERR); return (0); } static size_t mdns_write_hdr(uint8_t *ptr, size_t* s, const struct mdns_hdr *hdr) { uint8_t *p = ptr; if (*s < 12) return (-1); p = write_u16(p, s, hdr->id); p = write_u16(p, s, hdr->flags); p = write_u16(p, s, hdr->num_qn); p = write_u16(p, s, hdr->num_ans_rr); p = write_u16(p, s, hdr->num_auth_rr); p = write_u16(p, s, hdr->num_add_rr); return (p - ptr); } int mdns_write(const struct mdns_hdr *hdr, const struct rr_entry *entries, uint8_t *buf, size_t bufSize, size_t* length) { *length = 0; if (!entries) return (MDNS_ERROR); const struct rr_entry *entry = entries; ssize_t l; l = mdns_write_hdr(buf, &bufSize, hdr); if (l < 0) return (MDNS_ERROR); *length += l; for (entry = entries; entry; entry = entry->next) { l = rr_write(buf + *length, &bufSize, entry, (hdr->flags & FLAG_QR) > 0); if (l < 0) { return (MDNS_STDERR); } *length += l; } return (0); } int mdns_entries_send(const struct mdns_ctx *ctx, const struct mdns_hdr *hdr, const struct rr_entry *entries) { uint8_t buf[MDNS_PKT_MAXSZ] = {0}; size_t l; if (mdns_write(hdr, entries, buf, sizeof(buf), &l) < 0) return (MDNS_ERROR); for (size_t i = 0; i < ctx->nb_conns; ++i) { ssize_t r = sendto(ctx->conns[i].sock, (const char *) buf, l, 0, (const struct sockaddr *) &ctx->conns[i].mcast_addr, ss_len((struct sockaddr_storage*)&ctx->conns[i].mcast_addr)); if (r < 0) return (MDNS_NETERR); } return (0); } void mdns_free(struct rr_entry *entries) { struct rr_entry *entry; while ((entry = entries)) { entries = entries->next; rr_free(entry); free(entry); } } static const uint8_t * mdns_read_header(const uint8_t *ptr, size_t *n, struct mdns_hdr *hdr) { if (*n <= sizeof(struct mdns_hdr)) { errno = ENOSPC; return NULL; } ptr = read_u16(ptr, n, &hdr->id); ptr = read_u16(ptr, n, &hdr->flags); ptr = read_u16(ptr, n, &hdr->num_qn); ptr = read_u16(ptr, n, &hdr->num_ans_rr); ptr = read_u16(ptr, n, &hdr->num_auth_rr); ptr = read_u16(ptr, n, &hdr->num_add_rr); return ptr; } int mdns_parse(struct mdns_hdr *hdr, struct rr_entry **entries, const uint8_t *buf, size_t length) { size_t num_entry; struct rr_entry *entry; *entries = NULL; const uint8_t *ptr = mdns_read_header(buf, &length, hdr); if (ptr == NULL) return (MDNS_ERROR); num_entry = hdr->num_qn + hdr->num_ans_rr + hdr->num_add_rr; for (size_t i = 0; i < num_entry; ++i) { entry = calloc(1, sizeof(struct rr_entry)); if (!entry) goto err; ptr = rr_read(ptr, &length, buf, entry, i >= hdr->num_qn); if (!ptr) { mdns_free(entry); errno = ENOSPC; goto err; } entry->next = *entries; *entries = entry; } if (*entries == NULL) { return (MDNS_ERROR); } return (0); err: mdns_free(*entries); *entries = NULL; return (MDNS_ERROR); } static int mdns_recv(const struct mdns_conn* conn, struct mdns_hdr *hdr, struct rr_entry **entries) { uint8_t buf[MDNS_PKT_MAXSZ]; ssize_t length; *entries = NULL; if ((length = recv(conn->sock, (char *) buf, sizeof(buf), 0)) < 0) return (MDNS_NETERR); return mdns_parse(hdr, entries, buf, (size_t)length); } void mdns_entries_print(const struct rr_entry *entry) { printf("["); while (entry) { rr_print(entry); if (entry->next) printf(","); entry = entry->next; } printf("]\n"); } int mdns_strerror(int r, char *buf, size_t n) { return os_strerror(r, buf, n); } /* Test if string s ends in string sub * return 0 if match */ static int strrcmp(const char *s, const char *sub) { size_t m, n; if (!s || !sub) return (1); m = strlen(s); n = strlen(sub); if (n > m) return (1); return (strncmp(s + m - n, sub, n)); } static int mdns_listen_probe_network(const struct mdns_ctx *ctx, const char *const names[], unsigned int nb_names, mdns_listen_callback callback, void *p_cookie) { struct mdns_hdr ahdr = {0}; struct rr_entry *entries; struct pollfd *pfd = alloca( sizeof(*pfd) * ctx->nb_conns ); int r; for (size_t i = 0; i < ctx->nb_conns; ++i) { pfd[i].fd = ctx->conns[i].sock; pfd[i].events = POLLIN; } r = poll(pfd, ctx->nb_conns, 1000); if (r <= 0) { return r; } for (size_t i = 0; i < ctx->nb_conns; ++i) { if ((pfd[i].revents & POLLIN) == 0) continue; r = mdns_recv(&ctx->conns[i], &ahdr, &entries); if (r == MDNS_NETERR && os_wouldblock()) { mdns_free(entries); continue; } if (ahdr.num_ans_rr + ahdr.num_add_rr == 0) { mdns_free(entries); continue; } for (struct rr_entry *entry = entries; entry; entry = entry->next) { for (unsigned int i = 0; i < nb_names; ++i) { if (!strrcmp(entry->name, names[i])) { callback(p_cookie, r, entries); break; } } } mdns_free(entries); } return 0; } int mdns_listen(const struct mdns_ctx *ctx, const char *const names[], unsigned int nb_names, enum rr_type type, unsigned int interval, mdns_stop_func stop, mdns_listen_callback callback, void *p_cookie) { if (ctx->nb_conns == 0) return (MDNS_ERROR); int r; time_t t1, t2; struct mdns_hdr hdr = {0}; struct rr_entry *qns = malloc(nb_names * sizeof(struct rr_entry)); if (qns == NULL) return (MDNS_ERROR); memset(qns, 0, nb_names * sizeof(struct rr_entry)); hdr.num_qn = nb_names; for (unsigned int i = 0; i < nb_names; ++i) { qns[i].name = (char *)names[i]; qns[i].type = type; qns[i].rr_class = RR_IN; if (i + 1 < nb_names) qns[i].next = &qns[i+1]; } for (size_t i = 0; i < ctx->nb_conns; ++i) { if (setsockopt(ctx->conns[i].sock, SOL_SOCKET, SO_SNDTIMEO, (const void *) &os_deadline, sizeof(os_deadline)) < 0) { free(qns); return (MDNS_NETERR); } } if ((r = mdns_entries_send(ctx, &hdr, qns)) < 0) // send a first probe request callback(p_cookie, r, NULL); for (t1 = t2 = time(NULL); stop(p_cookie) == false; t2 = time(NULL)) { if (difftime(t2, t1) >= (double) interval) { if ((r = mdns_entries_send(ctx, &hdr, qns)) < 0) { callback(p_cookie, r, NULL); } t1 = t2; } mdns_listen_probe_network(ctx, names, nb_names, callback, p_cookie); } free(qns); return (0); } int mdns_announce(struct mdns_ctx *ctx, enum rr_type type, mdns_announce_callback callback, void *p_cookie) { if (!callback) return (MDNS_ERROR); struct mdns_svc *svc = (struct mdns_svc *) calloc(1, sizeof(struct mdns_svc)); if (!svc) return (MDNS_ERROR); svc->type = type; svc->announce_callback = callback; svc->p_cookie = p_cookie; svc->next = ctx->services; ctx->services = svc; return (0); } void mdns_request_initial_announce(struct mdns_ctx *ctx, const char* service) { /* Send the initial announce (RFC 6762 §8.3) */ for (struct mdns_svc* svc = ctx->services; svc; svc = svc->next) { for ( size_t i = 0; i < ctx->nb_conns; ++i ) { svc->announce_callback(svc->p_cookie, (struct sockaddr*)&ctx->conns[i].intf_addr, service, MDNS_ANNOUNCE_INITIAL); } } } int mdns_serve(struct mdns_ctx *ctx, mdns_stop_func stop, void *p_cookie) { int r; struct mdns_svc *svc; struct mdns_hdr qhdr = {0}; struct rr_entry *question = NULL; for (size_t i = 0; i < ctx->nb_conns; ++i) { if (setsockopt(ctx->conns[i].sock, SOL_SOCKET, SO_SNDTIMEO, (const void *) &os_deadline, sizeof(os_deadline)) < 0) return (MDNS_NETERR); } /* Send the initial announce (RFC 6762 §8.3) */ for (svc = ctx->services; svc; svc = svc->next) { for ( size_t i = 0; i < ctx->nb_conns; ++i ) { svc->announce_callback(svc->p_cookie, (struct sockaddr*)&ctx->conns[i].intf_addr, NULL, MDNS_ANNOUNCE_INITIAL); } } for (; stop(p_cookie) == false;) { struct pollfd *pfd = alloca( sizeof(*pfd) * ctx->nb_conns ); for (size_t i = 0; i < ctx->nb_conns; ++i) { pfd[i].fd = ctx->conns[i].sock; pfd[i].events = POLLIN; } if (poll(pfd, ctx->nb_conns, 1000) <= 0) { continue; } for (size_t i = 0; i < ctx->nb_conns; ++i) { if ((pfd[i].revents & POLLIN) == 0) continue; r = mdns_recv(&ctx->conns[i], &qhdr, &question); if (r < 0) continue; if (qhdr.num_qn == 0) goto again; for (svc = ctx->services; svc; svc = svc->next) { if (question->type == svc->type) { svc->announce_callback(svc->p_cookie, (struct sockaddr*)&ctx->conns[i].intf_addr, question->name, MDNS_ANNOUNCE_RESPONSE); goto again; } } mdns_free(question); question = NULL; } again: mdns_free(question); question = NULL; } /* Send the goodbye packets (RFC 6762 §10.1) */ for (svc = ctx->services; svc; svc = svc->next) { for ( size_t i = 0; i < ctx->nb_conns; ++i ) { svc->announce_callback(svc->p_cookie, (struct sockaddr*)&ctx->conns[i].intf_addr, NULL, MDNS_ANNOUNCE_GOODBYE); } } return (0); } 0707010000001F000081A40000000000000000000000016291210E0000027B000000000000000000000000000000000000002400000000libmicrodns-0.2.0+6/src/meson.buildlibmicrodns_sources = [ 'mdns.c', 'rr.c' ] if host_machine.system() == 'windows' mdns_soversion = '' else mdns_soversion = mdns_major_version endif libmicrodns = library('microdns', libmicrodns_sources, include_directories: incdirs, link_with: libcompat, link_args: link_flags, dependencies: deps, c_args: c_args, install: true, soversion: mdns_soversion, version: mdns_soname_version, ) pkgconf = import('pkgconfig') pkgconf.generate(libmicrodns, name: 'microDNS', description: 'mDNS simple implementation', filebase: 'microdns', ) 07070100000020000081A40000000000000000000000016291210E00004697000000000000000000000000000000000000001D00000000libmicrodns-0.2.0+6/src/rr.c/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2014-2016 VideoLabs SAS * * Author: Jonathan Calmels <jbjcalmels@gmail.com> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include <string.h> #include <stdlib.h> #include <stdint.h> #include "utils.h" #include "microdns/microdns.h" #include "microdns/rr.h" typedef const uint8_t *(*rr_reader)(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *); typedef ssize_t (*rr_writer)(uint8_t *, size_t *, const struct rr_entry *); typedef void (*rr_printer)(const union rr_data *); static const uint8_t *rr_decode(const uint8_t *ptr, size_t *n, const uint8_t *root, char **ss, uint8_t nb_rec); static uint8_t *rr_encode(const char *s); const uint8_t * rr_read(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry, int8_t ans); static const uint8_t *rr_read_SRV(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *); static const uint8_t *rr_read_PTR(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *); static const uint8_t *rr_read_TXT(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *); static const uint8_t *rr_read_AAAA(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *); static const uint8_t *rr_read_A(const uint8_t *, size_t *, const uint8_t *, struct rr_entry *); ssize_t rr_write(uint8_t *ptr, size_t *s, const struct rr_entry *entry, int8_t ans); static ssize_t rr_write_SRV(uint8_t *, size_t *, const struct rr_entry *); static ssize_t rr_write_PTR(uint8_t *, size_t *, const struct rr_entry *); static ssize_t rr_write_TXT(uint8_t *, size_t *, const struct rr_entry *); static ssize_t rr_write_AAAA(uint8_t *, size_t *, const struct rr_entry *); static ssize_t rr_write_A(uint8_t *, size_t *, const struct rr_entry *); void rr_print(const struct rr_entry *entry); static void rr_print_SRV(const union rr_data *); static void rr_print_PTR(const union rr_data *); static void rr_print_TXT(const union rr_data *); static void rr_print_AAAA(const union rr_data *); static void rr_print_A(const union rr_data *); void rr_free(struct rr_entry *entry); static const char *rr_type_str(enum rr_type); static const char *rr_class_str(enum rr_class); static const struct { enum rr_type type; const char *name; rr_reader read; rr_writer write; rr_printer print; } rrs[] = { {RR_SRV, "SRV", &rr_read_SRV, &rr_write_SRV, &rr_print_SRV}, {RR_PTR, "PTR", &rr_read_PTR, &rr_write_PTR, &rr_print_PTR}, {RR_TXT, "TXT", &rr_read_TXT, &rr_write_TXT, &rr_print_TXT}, {RR_AAAA, "AAAA", &rr_read_AAAA, &rr_write_AAAA, &rr_print_AAAA}, {RR_A, "A", &rr_read_A, &rr_write_A, &rr_print_A}, }; static const size_t rr_num = sizeof(rrs) / sizeof(*rrs); #define advance(x) ptr += x; *n -= x static const uint8_t * rr_read_SRV(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry) { union rr_data *data = &entry->data; if (*n <= sizeof(uint16_t) * 3) return (NULL); ptr = read_u16(ptr, n, &data->SRV.priority); ptr = read_u16(ptr, n, &data->SRV.weight); ptr = read_u16(ptr, n, &data->SRV.port); if ((ptr = rr_decode(ptr, n, root, &data->SRV.target, 0)) == NULL) return (NULL); return (ptr); } static ssize_t rr_write_SRV(uint8_t *ptr, size_t *s, const struct rr_entry *entry) { uint8_t *target, *p = ptr; if ((target = rr_encode(entry->data.SRV.target)) == NULL) return (-1); if (*s < 6) { free(target); return -1; } p = write_u16(p, s, entry->data.SRV.priority); p = write_u16(p, s, entry->data.SRV.weight); p = write_u16(p, s, entry->data.SRV.port); p = write_raw(p, s, target); free(target); if (p == NULL) return (-1); return (p - ptr); } static void rr_print_SRV(const union rr_data *data) { printf("{" "\"target\":\"%s\"," "\"port\":%" PRIu16 "," "\"priority\":%" PRIu16 "," "\"weight\":%" PRIu16 "}", data->SRV.target, data->SRV.port, data->SRV.priority, data->SRV.weight); } static const uint8_t * rr_read_PTR(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry) { union rr_data *data = &entry->data; if (*n == 0) return (NULL); if ((ptr = rr_decode(ptr, n, root, &data->PTR.domain, 0)) == NULL) return (NULL); return (ptr); } static ssize_t rr_write_PTR(uint8_t *ptr, size_t *s, const struct rr_entry *entry) { uint8_t *domain, *p = ptr; if ((domain = rr_encode(entry->data.PTR.domain)) == NULL) return (0); p = write_raw(p, s, domain); free(domain); if (p == NULL) return -1; return (p - ptr); } static void rr_print_PTR(const union rr_data *data) { printf("{\"domain\":\"%s\"}", data->PTR.domain); } static const uint8_t * rr_read_TXT(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry) { union rr_data *data = &entry->data; uint16_t len = entry->data_len; uint8_t l; if (*n == 0 || *n < len) return (NULL); for (; len > 0 && *n > 0; len -= l + 1) { struct rr_data_txt *text; memcpy(&l, ptr, sizeof(l)); advance(1); if (*n < l) return (NULL); text = malloc(sizeof(struct rr_data_txt)); if (!text) return (NULL); text->next = data->TXT; data->TXT = text; if (l > 0) memcpy(text->txt, ptr, l); text->txt[l] = '\0'; advance(l); } return (ptr); } static ssize_t rr_write_TXT(uint8_t *ptr, size_t *s, const struct rr_entry *entry) { uint8_t *p = ptr; size_t l; struct rr_data_txt *text = entry->data.TXT; while (text) { l = strlen(text->txt); if (*s < l + 1) return (-1); memcpy(p, &l, 1); memcpy(p+1, text->txt, l); p += l + 1; *s -= l + 1; text = text->next; } return (p - ptr); } static void rr_print_TXT(const union rr_data *data) { struct rr_data_txt *text = data->TXT; printf("{\"text\":["); while (text) { printf("\"%s\"%s", text->txt, text->next ? "," : ""); text = text->next; } printf("]}"); } static const uint8_t * rr_read_AAAA(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry) { union rr_data *data = &entry->data; const size_t len = sizeof(struct in6_addr); if (*n < len || entry->data_len < len) return (NULL); memcpy(&data->AAAA.addr, ptr, len); advance(len); if (!inet_ntop(AF_INET6, &data->AAAA.addr, data->AAAA.addr_str, INET6_ADDRSTRLEN)) return (NULL); return (ptr); } static ssize_t rr_write_AAAA(uint8_t *ptr, size_t *s, const struct rr_entry *entry) { size_t len = sizeof(entry->data.AAAA.addr); if (*s < len) return (-1); memcpy(ptr, &entry->data.AAAA.addr, len); *s -= len; return len; } static void rr_print_AAAA(const union rr_data *data) { printf("{\"address\":\"%s\"}", data->AAAA.addr_str); } static const uint8_t * rr_read_A(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry) { union rr_data *data = &entry->data; const size_t len = sizeof(struct in_addr); if (*n < len) return (NULL); memcpy(&data->A.addr, ptr, len); advance(len); if (!inet_ntop(AF_INET, &data->A.addr, data->A.addr_str, INET_ADDRSTRLEN)) return (NULL); return (ptr); } static ssize_t rr_write_A(uint8_t *ptr, size_t *s, const struct rr_entry *entry) { size_t len = sizeof(entry->data.A.addr); if (*s < len) return -1; memcpy(ptr, &entry->data.A.addr, sizeof(entry->data.A.addr)); *s -= len; return len; } static void rr_print_A(const union rr_data *data) { printf("{\"address\":\"%s\"}", data->A.addr_str); } /* * Decodes a DN compressed format (RFC 1035) * e.g "\x03foo\x03bar\x00" gives "foo.bar" */ static const uint8_t * rr_decode(const uint8_t *ptr, size_t *n, const uint8_t *root, char **ss, uint8_t nb_rec) { char *s; const uint8_t *orig_ptr = ptr; /* * 16 is arbitrary here, but it should be high enough for most cases * Ideally, we should store previously analyzed domains with their * associated offset, in order to avoid re-parsing them for each later * records */ if (nb_rec > 16) return (NULL); if (*n == 0) return (NULL); s = *ss = malloc(MDNS_DN_MAXSZ); if (!s) return (NULL); if (*ptr == 0) { *s = '\0'; advance(1); return (ptr); } while (*ptr) { size_t free_space; uint16_t len; free_space = *ss + MDNS_DN_MAXSZ - s; len = *ptr; advance(1); /* resolve the offset of the pointer (RFC 1035-4.1.4) */ if ((len & 0xC0) == 0xC0) { const uint8_t *p; char *buf; size_t m; uint16_t offset; /* * We only check if we have enough bytes left to read the * offset for now, and will check the offset validity * just after */ if (*n == 0) goto err; offset = ~0xC0 & len; offset = (uint16_t)(offset << 8u) | *ptr; advance(1); p = root + offset; /* * The resulting pointer can only point to a prior record * We substract 2 here since we already read the 2 offset * bytes */ if (p > (ptr - 2)) goto err; m = ptr - p + *n; /* Avoid recursing on the same element */ if (p == orig_ptr) goto err; if (rr_decode(p, &m, root, &buf, nb_rec + 1) == NULL) goto err; if (free_space <= strlen(buf)) { free(buf); goto err; } (void) strcpy(s, buf); free(buf); return (ptr); } if (*n <= len || free_space <= len) goto err; strncpy(s, (const char *) ptr, len); advance(len); s += len; *s++ = (*ptr) ? '.' : '\0'; } advance(1); return (ptr); err: free(*ss); *ss = NULL; return (NULL); } /* * Encode a DN into its compressed format (RFC 1035) * e.g "foo.bar" gives "\x03foo\x03bar\x00" */ static uint8_t * rr_encode(const char *s) { if (!s) return (NULL); uint8_t *buf, *b, l = 0; const char *p = s; buf = malloc(strlen(s) + 2); if (!buf) return (NULL); for (b = buf, l = strcspn(p, "."); l > 0; l = *p ? strcspn(++p, ".") : 0) { *b = l; memcpy(b + 1, p, l); b += l + 1; p += l; } *b = 0; return (buf); } static const uint8_t * rr_read_RR(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry, int8_t ans) { uint16_t tmp; ptr = rr_decode(ptr, n, root, &entry->name, 0); if (!ptr || *n < 4) return (NULL); ptr = read_u16(ptr, n, &entry->type); ptr = read_u16(ptr, n, &tmp); entry->rr_class = (tmp & ~0x8000); entry->msbit = ((tmp & 0x8000) == 0x8000); if (ans) { if (*n < 6) return (NULL); ptr = read_u32(ptr, n, &entry->ttl); ptr = read_u16(ptr, n, &entry->data_len); } return ptr; } static ssize_t rr_write_RR(uint8_t *ptr, size_t *s, const struct rr_entry *entry, int8_t ans) { uint8_t *name, *p = ptr; if ((name = rr_encode(entry->name)) == NULL) return (-1); p = write_raw(p, s, name); free(name); if (p == NULL) return (-1); if (*s < 4) return (-1); p = write_u16(p, s, entry->type); p = write_u16(p, s, (entry->rr_class & ~0x8000) | (entry->msbit << 15)); if (ans) { if (*s < 6) return (-1); p = write_u32(p, s, entry->ttl); p = write_u16(p, s, entry->data_len); } return (p - ptr); } const uint8_t * rr_read(const uint8_t *ptr, size_t *n, const uint8_t *root, struct rr_entry *entry, int8_t ans) { size_t skip; const uint8_t *p; p = ptr = rr_read_RR(ptr, n, root, entry, ans); if (ans == 0) return ptr; if (ptr == NULL) return (NULL); for (size_t i = 0; i < rr_num; ++i) { if (rrs[i].type == entry->type) { ptr = (*rrs[i].read)(ptr, n, root, entry); if (!ptr) return (NULL); break; } } // XXX skip unknown records skip = entry->data_len - (ptr - p); if (*n < skip) return (NULL); advance(skip); return (ptr); } ssize_t rr_write(uint8_t *ptr, size_t *s, const struct rr_entry *entry, int8_t ans) { uint8_t *p = ptr; ssize_t n = 0; ssize_t l = 0; n = rr_write_RR(p, s, entry, ans); if (n < 0) return (-1); if (ans == 0) return n; for (size_t i = 0; i < rr_num; ++i) { if (rrs[i].type == entry->type) { l = (*rrs[i].write)(p + n, s, entry); if (l < 0) return (-1); // fill in data length after its computed write_u16(p + n - 2, NULL, l); n += l; } } return n; } static const char * rr_type_str(enum rr_type type) { for (size_t i = 0; i < rr_num; ++i) { if (rrs[i].type == type) return (rrs[i].name); } return ("UNKNOWN"); } static const char * rr_class_str(enum rr_class rr_class) { if (rr_class == RR_IN) return ("IN"); return ("UNKNOWN"); } void rr_print(const struct rr_entry *entry) { size_t i; printf("{" "\"name\":\"%s\"," "\"type\":\"%s\"," "\"class\":\"%s\"," "\"data\":", entry->name, rr_type_str(entry->type), rr_class_str(entry->rr_class)); for (i = 0; i < rr_num; ++i) { if (rrs[i].type == entry->type) { (*rrs[i].print)(&entry->data); break; } } if (i == rr_num) printf("null"); printf("}"); } void rr_free(struct rr_entry *entry) { if (!entry) return; switch (entry->type) { case RR_SRV: if (entry->data.SRV.target) free(entry->data.SRV.target); break; case RR_PTR: if (entry->data.PTR.domain) free(entry->data.PTR.domain); break; case RR_TXT: { struct rr_data_txt *text, *TXT; TXT = entry->data.TXT; while ((text = TXT)) { TXT = TXT->next; if (text) free(text); } }} if (entry->name) free(entry->name); } 07070100000021000041ED0000000000000000000000026291210E00000000000000000000000000000000000000000000001A00000000libmicrodns-0.2.0+6/tests07070100000022000081A40000000000000000000000016291210E000006EE000000000000000000000000000000000000002100000000libmicrodns-0.2.0+6/tests/fuzz.c/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2020 VideoLabs SAS * * Author: Hugo Beauzée-Luyssen <hugo@beauzee.fr> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include "mdns.h" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size); int LLVMFuzzerTestOneInput(const uint8_t *buff, size_t size) { struct mdns_hdr hdr; struct rr_entry *entries; mdns_parse(&hdr, &entries, buff, size); // Same size as MDNS_PKT_MAXSZ in mdns.c uint8_t buf[4096] = {0}; size_t len; mdns_write(&hdr, entries, buf, sizeof(buf), &len); mdns_free(entries); return 0; } 07070100000023000081A40000000000000000000000016291210E0000027A000000000000000000000000000000000000002600000000libmicrodns-0.2.0+6/tests/meson.buildif get_option('tests').disabled() subdir_done() endif mdns_objs = libmicrodns.extract_all_objects(recursive: true) unittest_e = executable('unittest', 'unittests.c', include_directories: incdirs, objects: mdns_objs, link_with: libcompat, c_args: c_args, link_args: link_flags ) test('unittest', unittest_e) if get_option('fuzzing') executable('mdnsfuzz', 'fuzz.c', include_directories: incdirs, link_with: libmicrodns, link_args: ['-fsanitize=fuzzer,address,undefined', '-lasan', '-lubsan', '-fprofile-instr-generate', '-fcoverage-mapping'], c_args: c_args, ) endif 07070100000024000081A40000000000000000000000016291210E00000A02000000000000000000000000000000000000002600000000libmicrodns-0.2.0+6/tests/unittests.c/***************************************************************************** * This file is part of libmicrodns. * * Copyright © 2020 VideoLabs SAS * * Author: Hugo Beauzée-Luyssen <hugo@beauzee.fr> * ***************************************************************************** * libmicrodns is released under LGPLv2.1 (or later) and is also available * under a commercial license. ***************************************************************************** * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser 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. *****************************************************************************/ #ifdef HAVE_CONFIG_H # include "config.h" #endif #include "mdns.h" #include <string.h> #undef NDEBUG #include <assert.h> static void simple_answer_test() { uint8_t buff[] = { 0x00, 0x00, 0x84, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x0a, 0x5f, 0x6e, 0x6f, 0x6d, 0x61, 0x63, 0x68, 0x69, 0x6e, 0x65, 0x04, 0x5f, 0x74, 0x63, 0x70, 0x05, 0x6c, 0x6f, 0x63, 0x61, 0x6c, 0x00, 0x00, 0x0c, 0x00, 0x01, 0x00, 0x00, 0x00, 0x78, 0x00, 0x0b, 0x08, 0x6d, 0x69, 0x6e, 0x69, 0x32, 0x30, 0x31, 0x38, 0xc0, 0x0c, }; size_t len = sizeof(buff) / sizeof(buff[0]); struct mdns_hdr hdr = {0}; struct rr_entry *entries = NULL; int res = mdns_parse(&hdr, &entries, buff, len); assert(res == 0); assert(hdr.num_qn == 0); assert(hdr.num_ans_rr == 1); assert(hdr.num_auth_rr == 0); assert(hdr.num_add_rr == 0); assert(hdr.flags == (FLAG_QR | FLAG_AA)); assert(entries != NULL); assert(entries->next == NULL); assert(entries->type == RR_PTR); assert(strcmp("_nomachine._tcp.local", entries->name) == 0); assert(strcmp("mini2018._nomachine._tcp.local", entries->data.PTR.domain) == 0); mdns_free(entries); } int main() { simple_answer_test(); return 0; } 07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!468 blocks
Locations
Projects
Search
Status Monitor
Help
OpenBuildService.org
Documentation
API Documentation
Code of Conduct
Contact
Support
@OBShq
Terms
openSUSE Build Service is sponsored by
The Open Build Service is an
openSUSE project
.
Sign Up
Log In
Places
Places
All Projects
Status Monitor