Welcome to rVRRPd’s documentation!¶
rVRRPd is a fast, secure and standard compliant implementation of the high-availability VRRP protocol. It is very scalable, and can run on multiple platforms and operating systems.
As its name implies, rVRRPd can run as a Unix daemon or as a standalone program. It can also exposes a RESTful API for monitoring and configuration purposes, enabling Software Defined Networking (SDN) applications.
Features¶
- rVRRPd supports a number of innovative features:
- Secure software architecture leveraging the Rust programming language
- Highly scalable; up to several hundreds of concurrent VRRP groups
- Supports standard RFC3768 and RFC2338,
Simple Password
authentication - Supports additional proprietary authentication methods
- Supports multiple operating systems and processors architectures
- Provides a RESTful Client Application Programming Interface (API)
- Provides a plain-text HTTP or SSL/TLS HTTPS interface to the Client API
- Leverages additional features such as
macvlan
andLinux Socket Filters
Features Support Matrix¶
Supported Features | Linux | FreeBSD |
---|---|---|
Multiple Listeners Threads | Yes | Yes |
RESTful Client API | Yes | Yes |
Socket Filters (eBPF) | Yes | No |
MAC-Based Virtual LAN Interface (macvlan ) |
Yes | No |
Static Routing | Yes | No |
Configuration Guide¶
This part of the documentation focuses on the step-by-step installation instructions of the daemon and on how to configure the latter for various network and high-availability scenarios.
Introduction¶
By default, rVRRPd reads the /etc/rvrrpd.conf
configuration file.
This file holds all the configuration elements needed for the proper operation
of the daemon, the virtual routers, and their related functions.
At this time of writing, both TOML (default) and the JSON formats are supported for the main configuration file. The former is usually simpler to understand and to write, greatly reducing human errors. JSON based configurations however, are harder to write and to parse for some people, but may be more practical when used with automation tools or with an HTTP based Application Programming Interface (API).
If you don’t know which configuration file format to use, we recommend to stick with TOML, unless you want to use the Client API extensively.
The rVRRPd daemon runs one virtual-router
per interface, group
pair, which means you can configure the same VRRP groups id or
virtual-router
id across several physical interfaces. The daemon can
scale to hundreds if not thousands of active virtual-routers if the CPU
and memory resources permit.
The initial developer of rVRRPd has chosen to build the daemon entirely using the Rust programming language. Rust is a language, aimed primarily at security and speed. You get all the benefits of a modern object-oriented programming language such as Java or C++, without their respective performance penalty and inherent security risks.
We tried to keep unsafe
blocks as small as possible in order to provides
a clean interface to unsafe functions. However, we cannot removes all of them
as they are necessary to implement functions calls to the standard C library,
and to the various interfaces (such as IOCTLs) to the operating system kernel.
We hope that you will enjoy running rVRRPd and you would be able to solve your current network and high-availability challenges in less time and thus without the hassles commonly found in commercial solutions.
This project wouldn’t be live without the dedication of its developers, and the open source community. Any contributions are greatly welcome, and will help us developing new features and a more stable and secure implementation.
Developpers¶
- Nicolas Chabbey
- Keybase: @e3prom
- PGP Public Key Fingerprint:
DBD4 3BD8 81F3 C3E2 37E1 9E54 D7FF 004E 2E22 CF1C
Sponsorship¶
You can help us directly by donating to the project.
Every single penny will cover the development cost of rVRRPd, which is comprised of a lot of coffee, and the power bill of the bare-metal servers running the interoperability and testing labs.
You can donate by Paypal, or by using a crypto-currency listed below:
Crypto Currency | Wallet Address |
---|---|
Bitcoin (BTC) | 3Pz7PQk5crAABg2MsR6PVfUxGzq2MmPd2i |
Etherum (ETH) | 0x0686Dd4474dAA1181Fc3391035d22C8e0D2dA058 |
Software License¶
GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If 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 convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
Install rVRRPd¶
rVRRPd can be installed from source or by using pre-compiled binaries packages. The latter is recommended for production uses, as the executables have been previously tested for stability.
Software Requirements¶
- The Linux or FreeBSD operating system (64 bits)
- The OpenSSL library
- The Netlink Protocol Library Suite library (Linux)
Hardware Requirements¶
- An Intel IA-64 (x86_64) or ARMv8 (aarch64) processor
- At least one Ethernet interface
Source Installation¶
Getting Started¶
To install rVRRPd from source, first of all, make sure you have all the required build dependencies (see Building Dependencies section below).
Then download the source tarball files (tar.gz) from our release page or use git to clone the source repository.
Below we will describe the step-by-step instructions on how to install a stable release of the daemon and its utilities:
Building Dependencies¶
- To build rVRRPd from source you must have several programs and libraries installed on your system (preferably system-wide):
- Rust Cargo (v1.33.0 or later), to build the project and its related dependencies (crates).
- The OpenSSL development headers
- The Netlink Protocol Library Suite development headers (Linux)
On Debian and derivatives, all three libraries’ headers files can be installed with the below command:
$ sudo apt-get install libnl-3-dev libnl-route-3-dev libssl-dev
Cloning Source Repository¶
We will now clone the source from our official github repository:
$ git clone https://github.com/e3prom/rvrrpd
Cloning into 'rvrrpd'...
remote: Enumerating objects: 16, done.
remote: Counting objects: 100% (16/16), done.
remote: Compressing objects: 100% (12/12), done.
remote: Total 1301 (delta 4), reused 12 (delta 4), pack-reused 1285
Receiving objects: 100% (1301/1301), 347.88 KiB | 0 bytes/s, done.
Resolving deltas: 100% (831/831), done.
Switching to Stable Release¶
We move to the rvrrpd
directory just created by git and we will
switch to the latest stable release (here version 0.1.3
):
$ cd rvrrpd
$ git checkout tags/0.1.3
[...]
Invoking the Build Process¶
Enter the make
command to start the build process.
Rust Cargo will automatically fetch and build all the required dependencies and
will start the build process of the rVRRPd daemon and related utilities
such as rvrrpd-pw
:
$ make
Updating crates.io index
[...]
Compiling rVRRPd v0.1.3 (/var/tmp/rvrrpd)
Finished release [optimized] target(s) in 2m 40s
Once the build process is completed, you can find the daemon executable
in target/release/main
. The latter can be executed as-is or can be
installed system-wide (recommended).
Installing System-wide¶
We will now install rvrrpd
, its accompanying configuration file
/etc/rvrrpd.conf
, and the rvrrpd-pw
utility in our system
paths by using the make install
command (requires root privileges):
$ sudo make install
cp target/release/main /usr/bin/rvrrpd
chmod 755 /usr/bin/rvrrpd
if [ ! -d "/etc/rvrrpd" ]; then \
mkdir /etc/rvrrpd; \
fi
Configuring¶
Prior to running the daemon, you must edit the main configuration file according to your network or high-availability environment. See Configure below for a basic sample configuration example.
Running¶
rVRRPd supports multiple operating modes: it can run in foreground
mode from a terminal or in background
mode as a standard Unix daemon,
using the -m1
and -m2
switches, respectively.
Warning
The daemon requires root privileges to run successfully. The daemon must have access to raw sockets, and to privileged kernel functions to create virtual interfaces, IP addresses and routes.
In the below example, we are running the daemon in foreground
mode
using the -m1
switch:
$ sudo rvrrpd -m1
Binary Package Installation¶
rVRRPd could also be installed directly from binaries packages. This is the recommended way of installing the VRRP daemon for production uses as we are testing every executable for stability prior to shipping the releases to the public.
Getting Binary Archives¶
Visit the official release page on github and download
the latest package in tar.xz
format.
You can download directly from the command-line using the wget
utility:
$ wget "https://github.com/e3prom/rVRRPd/releases/download/0.1.3/rvrrpd-0.1.3-linux-amd64.tar.xz"
Verifying the Archives Integrity¶
Prior to unpacking the archive, we strongly suggest to verify the file checksum to ensure it has not be tempered by a third party.
$ wget "https://github.com/e3prom/rVRRPd/releases/download/0.1.3/SHA256SUMS"
$ sha256sum --check SHA256SUMS
rvrrpd-0.1.3-linux-amd64.tar.xz: OK
Unpacking Archives¶
Untar the downloaded archive using tar
:
$ tar -xvf rvrrpd-0.1.3-linux-amd64.tar.xz
rvrrpd-0.1.3-linux-amd64/
rvrrpd-0.1.3-linux-amd64/README.md
rvrrpd-0.1.3-linux-amd64/conf/
rvrrpd-0.1.3-linux-amd64/conf/rvrrpd.conf
rvrrpd-0.1.3-linux-amd64/conf/rvrrpd.json.conf
rvrrpd-0.1.3-linux-amd64/rvrrpd
rvrrpd-0.1.3-linux-amd64/LICENSE
Configuring¶
Move into the release rvrrpd-<version>-<os>-<arch>/
directory just
created above:
$ cd rvrrpd-0.1.3-linux-amd64/
Edit the sample configuration file in
etc/rvrrpd.conf
and run the daemon from the current directory:
Running¶
Warning
The daemon requires root privileges to run successfully. The daemon must have access to raw sockets, and to privileged kernel functions to create virtual interfaces, IP addresses and routes.
$ sudo ./rvrrpd -m1 -c conf/rvrrpd.conf
See our configuration reference for more information about the available configuration options.
Basic Configuration Example¶
rVRRPd read its configuration file from the default /etc/rvrrpd.conf
.
The later, must be configured to match your current network and
high-availability configuration. You can also overwrite the config
file path using the -c
or --conf
command-line switches.
Below a sample TOML configuration file of a basic VRRP first-hop router:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | debug = 5
pid = "/var/tmp/rvrrpd.pid"
working_dir = "/var/tmp"
main_log = "/var/tmp/rvrrpd.log"
error_log = "/var/tmp/rvrrpd-error.log"
client_api = "http"
[[vrouter]]
group = 1
interface = "ens192.900"
vip = "10.100.100.1"
priority = 254
preemption = true
rfc3768 = true
netdrv = "libnl"
iftype = "macvlan"
vifname = "vrrp0"
auth_type = "rfc2338-simple"
auth_secret = "thissecretnolongeris"
[protocols]
[[protocols.static]]
route = "0.0.0.0"
mask = "0.0.0.0"
nh = "10.240.0.254"
[api]
tls = false
host = "0.0.0.0:7080"
users = [ "{{SHA256}}admin:0:1eb7ac761a1201f9:095820af..." ]
|
- The above configuration do the following:
- Starts the daemon in foreground mode with a debug level of
5
(extensive). - Enable the Client API with the
http
listener (listen by default ontcp/7080
). - Runs one virtual-router with group id
1
on interfaceens192.900
, with the below parameters:- Uses the virtual IP address
10.100.100.1
. - Is configured with the highest priority of
254
. - Has preemption enabled.
- Has compatibility with RFC3768 turned on (may be required to fully interoperate with some equipment vendors).
- Uses the network driver
libnl
which leverage the netlink protocol. Alternatively, you can use theioctl
driver, which is simpler but will removes the interface’s IP addresse(s) for the VIP when in Master state. - Is configured for a
macvlan
type interface, a MAC-based virtual interface. - Name the child virtual interface
vrrp0
, the latter will be used to hold the virtual router IP address. - Set authentication to the RFC2338 ,
Simple Password
authentication method. - Set the secret key (or password) to be shared between the virtual routers.
- Uses the virtual IP address
- When Master, install a static default route with a next-hop of
10.240.0.254
. - The Client API only authorizes queries from the users listed in the
users
list under the[api]
section. The users must authenticate prior to accessing the virtual router’s information.- You can generate users passwords hashes using the rvrrpd-pw utility.
- Starts the daemon in foreground mode with a debug level of
You can consult our configuration guide to have more details and explanation about all the available configuration options.
Configuration Reference¶
General Directives¶
debug¶
Description: The verbose or debugging level. Value type: Decimal Default: 0 The
debug
directive sets the debugging (or verbosity) level of the daemon.
- Possible values are:
0
Information1
Low2
Medium3
High5
Extensive
time_zone¶
Description: The timestamps reference time zone Value type: String Default: local The
time_zone
directive sets the reference time zone for the various daemon timestamps.
- Possible values are:
local
for Local Time (LT)- This setting uses the locally configured time zone of the operating system.
utc
for Coordinated Universal Time (UTC)- Timestamps will be given in UTC or Zulu time.
time_format¶
Description: The timestamps time format Value type: String Default: disabled The
time_format
directive sets the reference time format for the various daemon timestamps.
- Possible values are:
disabled
for no particular time format (use the default time format)short
for a shortened, more concise time formatrfc2822
for the standard RFC2822, Internet Time Format
pid¶
Description: The daemon’s PID file path Value type: String Default: /var/run/rvrrpd.pid The
pid
directive sets the full or relative path to the daemon’s PID file.
working_dir¶
Description: The daemon’s working directory Value type: String Default: /tmp The
working_dir
directive sets the daemon’s working directory. The daemon’s user must have read access to this directory.
main_log¶
Description: Path to the daemon’s main log file Value type: String Default: /var/log/rvrrpd.log The
main_log
directive sets the path to the daemon’s main log file.
error_log¶
Description: Path to the daemon’s error log file Value type: String Default: disabled The
error_log
directive sets the path to the daemon’s error log file. Any errors occuring during the runtime are written to this log file.
client_api¶
Description: Client API interface type Value type: String Default: http The
client_api
directive sets the Client API interface type.
- Possible values are:
http
for the RESTful HTTP interface- This value enable a plain-text HTTP or HTTPS (SSL/TLS) interface to the client API. It does include user authentication and a secure communication channel when SSL/TLS is enabled.
New in version 0.1.3: Directive added with Client API Support
Virtual Routers Directives¶
group¶
Description: Virtual Router Group ID (VRID) Value type: Integer Default: none The
group
directive sets the VRRP group id or virtual-router id (VRID).
- Valid values are:
0-255
The VRRP group id or virtual-router id. Usually matches the sub-interface unit number or interface’s vlan id.
interface¶
Description: Interface to run VRRP on Value type: String Default: none The
interface
directive sets the VRRP virtual-router’s interface. Only Ethernet interfaces are supported.
iftype¶
Description: Interface type Value type: String Default: none The
iftype
directive sets the VRRP virtual-router’s interface type. By default, the daemon will directly work with the configured running interface, and therefore may change its IP and/or MAC address(es).
- Valid values are:
macvlan
Use a MAC-Based Virtual LAN interface.
New in version 0.1.1: Directive added with MAC-Based Virtual LAN Interface Support
vip¶
Description: Virtual IP Address Value type: String Default: none The
vip
directive sets the VRRP standby address or virtual-router address. Only IPv4 addresses are currently supported at this time.
priority¶
Description: Virtual Router Priority Value type: Integer Default: 100 The
priority
directive sets the virtual-router VRRP priority.
- Valid values are:
1-254
The VRRP virtual router priority. Values 0 and 255 are reserved as per RFC3768 and cannot be configured manually.
preemption¶
Description: Preemption Support Value type: Boolean Default: false The
preemption
directive sets if preemption is enabled. By default, preemption is turned off; a higher-priority virtual router cannot preempt an active Master.
- Valid values are:
true
Preemption is turned on, a higher-priority Standby virtual router can preempt the current Master virtual router.false
Preemption is turned off.
auth_type¶
Description: Authentication Type Value type: String Default: none The
auth_type
directive sets the VRRP group’s authentication type. Authentication allow to authenticate VRRP messages and with some types allow to verify their integrity. Authentication can prevent a misconfigured VRRP virtual router to take over the Master, resulting in the blackhole or interception of the user network traffic.
- Valid values are:
rfc2338-simple
for RFC2338 Simple Password Authentication.p0-t8-sha256
for proprietary P0 Authentication. Uses a SHA256 HMAC of the VRRP messages. This type provides both messages authentication and integrity.p1-t8-shake256
for proprietary P1 Authentication. Uses the SHAKE256 Extendable-Output Function (XOF). This type provides both messages authentication and integrity.
auth_secret¶
Description: Authentication Secret Value type: String Default: none The
auth_secret
directive sets the VRRP group’s authentication secret or password. Ensure all virtual routers among the configured group share the same secret and that the latter has been transmitted securely.Warning
Keep in mind that the configuration file holds the secret, therefore only authorized users should be able to read it.
rfc3768¶
Description: RFC3768 Compatibility Warning Flag Value type: Boolean Default: true The
rfc3768
directive allow you to force the compatibility flag. The meaning of this flag may be confusing, and can be safely ignored most of the time. When this flag is set totrue
, it indicates the virtual router may NOT operates entirely according to the applicable VRRP RFCs. In particular regarding to the authentication and to the length of some VRRP PDUs header fields. When this flag istrue
, the virtual router may not be interoperable with third-party, standard-compliant devices or softwares.Note
Enabling proprietary features such as the proprietary authentication types, will automatically turn this flag on.
- Valid values are:
true
to forcibly enable non-standard operations.false
to forcibly disable non-standard operations whenever possible.
netdrv¶
Description: Network Driver Value type: String Default: ioctl The
netdrv
directive specify which network driver to uses for the virtual-router. The available drivers depend on the operating system and slight differences do exists between them. The driver is used partially or entirely to; add the virtual IP addresses, create the virtual interface, change the interface’s MAC address, or to update the kernel routes.
- Valid values are:
ioctl
for using IOCTLs. This option should be supported in all Linux based operating systems, even with the presence of an old kernel.
libnl
for using the Netlink Protocol Library which is an intermediate API to communicate with the Linux Netlink protocol. The latter is a modern and robust way of configuring and interrogating the kernel.Note
We strongly suggest to keep using this driver whenever possible. When using
macvlan
interfaces, this driver is automatically enabled.
vifname¶
Description: Virtual Interface Name Value type: String Default: standby<group-id> The
vifname
directive sets the virtual-router’s virtual interface name. By default, the virtual interface is named using thestandby<group-id>
format, wheregroup-id
correspond to the virtual-router’s VRRP group id or VRID.Note
This directive is only used when virtual interface support is activated. (e,g. by having the iftype directive set to
macvlan
).
New in version 0.1.1: Directive added with MAC-Based Virtual LAN Interface Support
socket_filter¶
Description: Socket Filter Support Value type: String Default: true The
socket_filter
directive allow you to enable or disable the use of Socket Filters. On Linux, eBPF based Socket Filters allow every virtual-router raw sockets to only receives VRRP traffic matching their interface and VRRP group, thus greatly improving performance.
- Valid values are:
true
for enabling support for socket filters. Drastically improves the listener threads performance by allowing the kernel to filter out unwanted traffic not to be processed by the listening thread.false
for disabling support for socket filters.
New in version 0.1.2: Directive added with Linux Socket Filters Support
API Directives¶
users¶
Description: API Users Value type: List of Strings Default: none The
users
directive lists the user accounts authorized for the Client API. Every string in the list must adhere to strict formatting rules and can be easily generated using thervrrpd-pw
utility.
secret¶
Description: API Secret Value type: String Default: 128-bits random number The
secret
directive sets the API secret. This secret is used for a number of cryptogrphic functions and must be kept secret.By default, at every start of the daemon, a random 128 bits unsigned integer is generated from a secure PRNG. This number is large enough and SHOULD have sufficient entropy to provides good security.
You can overwrite this secret by specifiy your own. The secret will be maintained across restart of the rVRRPd daemon.
Warning
Improper setting of the secret string can open up vulnerabilities or security holes, such as authentication bypass.
Note
If setting the secret manually, please ensure your string is long and random enough to provides sufficient security. We strongly recommend to use a random number generator to generate it.
host¶
Description: Listening Host Value type: String Default: 0.0.0.0:7080 The
host
directive sets the IP address(es) and port for the API interface to listen on. By default it listens on all interfaces on port7080
.When setting the Client API Interface to
http
this directive will specify which interfaces and port the HTTP or HTTPS service will listen on.
tls¶
Description: Transport Layer Security (TLS) Support Value type: Boolean Default: false The
tls
directive allow you to enable or disable support for SSL/TLS. When using thehttp
Client API Interface, it will allow you to enable secure HTTPS communication with the API clients.
- Valid values are:
true
for activating Transport Layer Security (TLS) on the API interface.false
for disabling the TLS support.
tls_key¶
Description: SSL/TLS Key File Value type: String Default: /etc/rvrrpd/ssl/key.pem The
tls_key
directive allow you to set the full or relative path to the TLS key file.
tls_cert¶
Description: SSL/TLS Certificate File Value type: String Default: /etc/rvrrpd/ssl/cert.pem The
tls_key
directive allow you to set the full or relative path to the certificate chain file. At this time of writting, only a valid X.509 server’s certificate is necessary.
Client API Guide¶
This guide covers the Client Application Programming Interface (API), how to configure it, how to make requests and interprets their various responses.
Introduction to the API¶
rVRRPd provides an Application Programming Interface (API) that allow remote tasks to be performed on the daemon and on the running virtual routers.
The Client API can be accessed by various means, but at this time of writing, only supports the Hypertext Transfer Protocol (HTTP), in plain-text or securely by using a SSL/TLS channel. The use of the latter is highly recommended for integrity and confidentiality purposes.
RESTful HTTP Interface¶
The Client API can be accessed over HTTP using the Representational State Transfer or REST model, which provides a simple and uniform access model to the various data coming from the daemon instance, the VRRP virtual routers, and from the operating system such as interfaces information and kernel routes.
The API not only allow to read data and to parse it efficiently, but also to make modification to the running instance of rVRRPd, such as adding a new virtual router, or changing its priority so it can take over a Master router.
Note
As of version 0.1.3, the Client API is only providing read-only access. Modifications are not yet supported but will be introduced in a later release.
To query rVRRPd for information, such as the current role of a running VRRP virtual router, a simple HTTP GET request can be made to a specific resource path. If the query can be honored, the API will return a JSON formatted body response with all the attributes and values corresponding to your query.
The responses can be easily and efficiently parsed by both a human and a machine, thus providing a uniform and standardize interface that can be used as a console, as an automation interface for SDN applications and much more.
API Reference¶
Todo
The API is still under active development. The reference documentation will be available when the API will be stable and ready for production use.
Client API Queries Examples¶
Getting Virtual Router States¶
Getting Started¶
You can get running information directly from an instance of rVRRPd using
the HTTP Client API, but first you must authenticate using an HTTP POST
request to the auth/
path.
Authenticating¶
The below example shows how to authenticate to the daemon running on
10.0.0.1
, using the curl
utility:
$ curl -k -c /tmp/rvrrpd-api-cookie -d "user=admin passwd=banana" -X POST https://10.0.0.1:7080/auth
The above command will send an HTTP POST
request to the API, and if
successful will store the resulting session cookie to
/tmp/rvrrpd-api-cookie
.
Requesting VRRP Information¶
Once authenticated, you can query the router for the current VRRP running
information by sending an HTTP GET
request to the run/vrrp
resource
path:
$ curl -k -s -b /tmp/rvrrpd-api-cookie -X GET https://10.0.0.1:7080/run/vrrp | jq
You should get a JSON formatted response like below:
[
{
"virtual_ip": "10.100.100.1",
"group": 1,
"interface": "standby1",
"priority": 254,
"preempt": true,
"state": "Master"
},
{
"virtual_ip": "10.100.101.1",
"group": 2,
"interface": "standby2",
"priority": 254,
"preempt": true,
"state": "Master"
}
]
\ Sort by:\ best rated\ newest\ oldest\
\\
Add a comment\ (markup):
\``code``
, \ code blocks:::
and an indented block after blank line