commit c0616030c6a1806bd1f8229aa5f674ab6deac55f Author: ston1th Date: Thu Nov 12 02:09:20 2020 +0100 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ef8a42c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +data/ +vipman diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e9a5538 --- /dev/null +++ b/Makefile @@ -0,0 +1,55 @@ +CC=go +BUILD=build -v -trimpath +VERSION=$(shell cat VERSION) +GCFLAGS=-gcflags '-e' +LDFLAGS=-ldflags '-X main.version=$(VERSION) -s -w' +PROGRAM=vipman +CMD=-o vipman cmd/vipman/main.go +ENV=CGO_ENABLED=0 GO111MODULE=on + +all: $(PROGRAM) + +setup: + $(CC) get -u github.com/client9/misspell + +release: clean generate gofmt codeqa + $(ENV) $(CC) $(BUILD) $(GCFLAGS) $(LDFLAGS) $(CMD) + +release-vendor: clean generate gofmt codeqa + $(ENV) $(CC) $(BUILD) -mod=vendor $(GCFLAGS) $(LDFLAGS) $(CMD) + +vendor: clean generate gofmt + $(ENV) $(CC) $(BUILD) -mod=vendor $(GCFLAGS) $(LDFLAGS) $(CMD) + +$(PROGRAM): clean generate gofmt + $(ENV) $(CC) $(BUILD) $(GCFLAGS) $(LDFLAGS) $(CMD) + +clean: + $(CC) clean -x + +codeqa: misspell golint test + +generate: + $(CC) generate + +gofmt: + gofmt -w pkg/ cmd/ + +golint: + $(GOPATH)/bin/golint . + +misspell: + $(GOPATH)/bin/misspell pkg/* cmd/* Makefile README.md + +test: +ifeq ($(shell go env GOARCH), $(shell go env GOHOSTARCH)) +ifeq ($(shell go env GOOS), $(shell go env GOHOSTOS)) + $(CC) test ./... +else + $(info skipping tests of other platforms) +endif +else + $(info skipping tests of other platforms) +endif + +.PHONY: setup release release-vendor vendor build clean codeqa generate gofmt golint misspell test diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..cebb419 --- /dev/null +++ b/go.mod @@ -0,0 +1,11 @@ +module git.giftfish.de/ston1th/vipman + +go 1.15 + +require ( + github.com/go-logr/logr v0.3.0 + github.com/hashicorp/raft v1.2.0 + github.com/hashicorp/raft-boltdb v0.0.0-20191021154308-4207f1bf0617 + gopkg.in/yaml.v2 v2.3.0 + k8s.io/klog v1.0.0 +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..7234155 --- /dev/null +++ b/go.sum @@ -0,0 +1,52 @@ +github.com/DataDog/datadog-go v2.2.0+incompatible/go.mod h1:LButxg5PwREeZtORoXG3tL4fMGNddJ+vMq1mwgfaqoQ= +github.com/armon/go-metrics v0.0.0-20190430140413-ec5e00d3c878 h1:EFSB7Zo9Eg91v7MJPVsifUysc/wPdN+NOnVe6bWbdBM= +github.com/armon/go-metrics v0.0.0-20190430140413-ec5e00d3c878/go.mod h1:3AMJUQhVx52RsWOnlkpikZr01T/yAVN2gn0861vByNg= +github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= +github.com/boltdb/bolt v1.3.1 h1:JQmyP4ZBrce+ZQu0dY660FMfatumYDLun9hBCUVIkF4= +github.com/boltdb/bolt v1.3.1/go.mod h1:clJnj/oiGkjum5o1McbSZDSLxVThjynRyGBgiAx27Ps= +github.com/circonus-labs/circonus-gometrics v2.3.1+incompatible/go.mod h1:nmEj6Dob7S7YxXgwXpfOuvO54S+tGdZdw9fuRZt25Ag= +github.com/circonus-labs/circonusllhist v0.1.3/go.mod h1:kMXHVDlOchFAehlya5ePtbp5jckzBHf4XRpQvBOLI+I= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-logr/logr v0.1.0/go.mod h1:ixOQHD9gLJUVQQ2ZOR7zLEifBX6tGkNJF4QyIY7sIas= +github.com/go-logr/logr v0.3.0 h1:q4c+kbcR0d5rSurhBR8dIgieOaYpXtsdTYfx22Cu6rs= +github.com/go-logr/logr v0.3.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= +github.com/hashicorp/go-hclog v0.9.1 h1:9PZfAcVEvez4yhLH2TBU64/h/z4xlFI80cWXRrxuKuM= +github.com/hashicorp/go-hclog v0.9.1/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= +github.com/hashicorp/go-immutable-radix v1.0.0 h1:AKDB1HM5PWEA7i4nhcpwOrO2byshxBjXVn/J/3+z5/0= +github.com/hashicorp/go-immutable-radix v1.0.0/go.mod h1:0y9vanUI8NX6FsYoO3zeMjhV/C5i9g4Q3DwcSNZ4P60= +github.com/hashicorp/go-msgpack v0.5.5 h1:i9R9JSrqIz0QVLz3sz+i3YJdT7TTSLcfLLzJi9aZTuI= +github.com/hashicorp/go-msgpack v0.5.5/go.mod h1:ahLV/dePpqEmjfWmKiqvPkv/twdG7iPBM1vqhUKIvfM= +github.com/hashicorp/go-retryablehttp v0.5.3/go.mod h1:9B5zBasrRhHXnJnui7y6sL7es7NDiJgTc6Er0maI1Xs= +github.com/hashicorp/go-uuid v1.0.0/go.mod h1:6SBZvOh/SIDV7/2o3Jml5SYk/TvGqwFJ/bN7x4byOro= +github.com/hashicorp/golang-lru v0.5.0 h1:CL2msUPvZTLb5O648aiLNJw3hnBxN2+1Jq8rCOH9wdo= +github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8= +github.com/hashicorp/raft v1.1.0/go.mod h1:4Ak7FSPnuvmb0GV6vgIAJ4vYT4bek9bb6Q+7HVbyzqM= +github.com/hashicorp/raft v1.2.0 h1:mHzHIrF0S91d3A7RPBvuqkgB4d/7oFJZyvf1Q4m7GA0= +github.com/hashicorp/raft v1.2.0/go.mod h1:vPAJM8Asw6u8LxC3eJCUZmRP/E4QmUGE1R7g7k8sG/8= +github.com/hashicorp/raft-boltdb v0.0.0-20171010151810-6e5ba93211ea/go.mod h1:pNv7Wc3ycL6F5oOWn+tPGo2gWD4a5X+yp/ntwdKLjRk= +github.com/hashicorp/raft-boltdb v0.0.0-20191021154308-4207f1bf0617 h1:CJDRE/2tBNFOrcoexD2nvTRbQEox3FDxl4NxIezp1b8= +github.com/hashicorp/raft-boltdb v0.0.0-20191021154308-4207f1bf0617/go.mod h1:aUF6HQr8+t3FC/ZHAC+pZreUBhTaxumuu3L+d37uRxk= +github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/pascaldekloe/goe v0.1.0/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/client_golang v0.9.2/go.mod h1:OsXs2jCmiKlQ1lTBmv21f2mNfw4xf/QclQDMrYNZzcM= +github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/common v0.0.0-20181126121408-4724e9255275/go.mod h1:daVV7qP5qjZbuso7PdcryaAu0sAZbrN9i7WWcTMWvro= +github.com/prometheus/procfs v0.0.0-20181204211112-1dc9a6cbc91a/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/tv42/httpunix v0.0.0-20150427012821-b75d8614f926/go.mod h1:9ESjWnEqriFuLhtthL60Sar/7RFoluCcXsuvEwTV5KM= +golang.org/x/net v0.0.0-20181201002055-351d144fa1fc/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190523142557-0e01d883c5c5/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190602015325-4c4f7f33c9ed/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU= +gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +k8s.io/klog v1.0.0 h1:Pt+yjF5aB1xDSVbau4VsWe+dQNzA0qv1LlXdC2dF6Q8= +k8s.io/klog v1.0.0/go.mod h1:4Bi6QPql/J/LkTDqv7R/cd3hPo4k2DG6Ptcz060Ez5I= diff --git a/pkg/cluster/cluster.go b/pkg/cluster/cluster.go new file mode 100644 index 0000000..637e2b6 --- /dev/null +++ b/pkg/cluster/cluster.go @@ -0,0 +1,45 @@ +package cluster + +import ( + "context" + "errors" +) + +// Cluster - The Cluster object manages the state of the cluster for a particular node +type Cluster struct { + stateMachine FSM + stop chan struct{} + done chan struct{} + Callbacks LeaderCallbacks +} + +type LeaderCallbacks struct { + // OnStartedLeading is called when a LeaderElector client starts leading + OnStartedLeading func(context.Context) + // OnStoppedLeading is called when a LeaderElector client stops leading + OnStoppedLeading func() + // OnNewLeader is called when the client observes a leader that is + // not the previously observed leader. This includes the first observed + // leader when the client starts. + OnNewLeader func(string) +} + +// InitCluster - Will attempt to initialise all of the required settings for the cluster +func InitCluster(callbacks LeaderCallbacks) (*Cluster, error) { + if callbacks.OnStartedLeading == nil { + return nil, errors.New("OnStartedLeading is nil") + } + if callbacks.OnStoppedLeading == nil { + return nil, errors.New("OnStoppedLeading is nil") + } + if callbacks.OnNewLeader == nil { + return nil, errors.New("OnNewLeader is nil") + } + c := &Cluster{ + stop: make(chan struct{}, 1), + done: make(chan struct{}, 1), + Callbacks: callbacks, + } + + return c, nil +} diff --git a/pkg/cluster/raft.go b/pkg/cluster/raft.go new file mode 100644 index 0000000..a805512 --- /dev/null +++ b/pkg/cluster/raft.go @@ -0,0 +1,200 @@ +package cluster + +import ( + "context" + "fmt" + "io/ioutil" + "net" + "net/http" + "os" + "runtime" + "time" + + "git.giftfish.de/ston1th/vipman/pkg/config" + "github.com/go-logr/logr" + "github.com/hashicorp/raft" + raftboltdb "github.com/hashicorp/raft-boltdb" + "k8s.io/klog" +) + +type raftLog string + +func (r *raftLog) Write(p []byte) (n int, err error) { + return os.Stdout.Write(append([]byte(*r), p...)) +} + +var _ = ioutil.Discard + +// StartRaftCluster - Begins a running instance of the Raft cluster +func (c *Cluster) StartRaftCluster(log logr.Logger, cfg *config.Config) error { + + // Create local configuration address + localAddress := fmt.Sprintf("%s:%d", cfg.LocalPeer.Address, cfg.LocalPeer.Port) + + // Begin the Raft configuration + rc := raft.DefaultConfig() + rc.LocalID = raft.ServerID(cfg.LocalPeer.ID) + rl := raftLog(cfg.LocalPeer.ID + " ") + rc.LogOutput = &rl + //rc.LogOutput = ioutil.Discard + + // Initialize communication + address, err := net.ResolveTCPAddr("tcp", localAddress) + if err != nil { + return err + } + + // Create transport + transport, err := raft.NewTCPTransport(localAddress, address, 3, 10*time.Second, os.Stdout) + if err != nil { + return err + } + + // Create Raft structures + snapshots := raft.NewInmemSnapshotStore() + //logStore := raft.NewInmemStore() + bootstrap := true + if _, err := os.Stat(cfg.DBFile); err == nil { + bootstrap = false + } + stableStore, err := raftboltdb.NewBoltStore(cfg.DBFile) + if err != nil { + return err + } + logStore, err := raftboltdb.NewBoltStore(cfg.DBFile + ".log") + if err != nil { + return err + } + + // Cluster configuration + configuration := raft.Configuration{} + + // Add Local Peer + configuration.Servers = append(configuration.Servers, raft.Server{ + ID: raft.ServerID(cfg.LocalPeer.ID), + Address: raft.ServerAddress(localAddress), + }) + + // If we want to start a node as leader then we will not add any remote peers, this will leave this as a cluster of one + // The remotePeers will add themselves to the cluster as they're added + if !cfg.Leader { + for _, p := range cfg.RemotePeers { + peerAddress := fmt.Sprintf("%s:%d", p.Address, p.Port) + if localAddress != peerAddress { + configuration.Servers = append(configuration.Servers, raft.Server{ + ID: raft.ServerID(p.ID), + Address: raft.ServerAddress(peerAddress)}) + } + } + log.Info("This node will attempt to start as Follower") + } else { + log.Info("This node will attempt to start as Leader") + } + + if bootstrap { + if err := raft.BootstrapCluster(rc, logStore, stableStore, snapshots, transport, configuration); err != nil { + return err + } + } + //else { + // if err := raft.RecoverCluster(rc, c.stateMachine, logStore, stableStore, snapshots, transport, configuration); err != nil { + // return err + // } + //} + + // Create RAFT instance + raftServer, err := raft.NewRaft(rc, c.stateMachine, logStore, stableStore, snapshots, transport) + if err != nil { + return err + } + + ticker := time.NewTicker(time.Second) + time.Sleep(time.Second * 5) + + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + lead := raftServer.Leader() + leading := false + for { + l := raftServer.Leader() + if lead != l && string(l) != "" { + go c.Callbacks.OnNewLeader(string(l)) + lead = l + } + if !leading && localAddress == string(raftServer.Leader()) { + leading = true + go c.Run(ctx) + } + + select { + case leader := <-raftServer.LeaderCh(): + if leader { + if !leading { + leading = true + go c.Run(ctx) + } + } else { + if leading { + cancel() + leading = false + ctx, cancel = context.WithCancel(context.Background()) + } + } + case <-ticker.C: + case <-c.stop: + if leading { + cancel() + raftServer.LeadershipTransfer() + } + close(c.done) + return nil + } + } + return nil +} + +func (c *Cluster) Run(ctx context.Context) { + defer func() { + handleCrash() + c.Callbacks.OnStoppedLeading() + }() + c.Callbacks.OnStartedLeading(ctx) +} + +var reallyCrash = false + +func handleCrash() { + if r := recover(); r != nil { + logPanic(r) + if reallyCrash { + panic(r) + } + } +} + +// logPanic logs the caller tree when a panic occurs (except in the special case of http.ErrAbortHandler). +func logPanic(r interface{}) { + if r == http.ErrAbortHandler { + // honor the http.ErrAbortHandler sentinel panic value: + // ErrAbortHandler is a sentinel panic value to abort a handler. + // While any panic from ServeHTTP aborts the response to the client, + // panicking with ErrAbortHandler also suppresses logging of a stack trace to the server's error log. + return + } + + // Same as stdlib http server code. Manually allocate stack trace buffer size + // to prevent excessively large logs + const size = 64 << 10 + stacktrace := make([]byte, size) + stacktrace = stacktrace[:runtime.Stack(stacktrace, false)] + if _, ok := r.(string); ok { + klog.Errorf("Observed a panic: %s\n%s", r, stacktrace) + } else { + klog.Errorf("Observed a panic: %#v (%v)\n%s", r, r, stacktrace) + } +} + +func (c *Cluster) Stop() { + close(c.stop) + <-c.done +} diff --git a/pkg/cluster/state.go b/pkg/cluster/state.go new file mode 100644 index 0000000..02f12f6 --- /dev/null +++ b/pkg/cluster/state.go @@ -0,0 +1,32 @@ +package cluster + +import ( + "io" + + "github.com/hashicorp/raft" +) + +type FSM struct { +} + +func (fsm FSM) Apply(log *raft.Log) interface{} { + return nil +} + +func (fsm FSM) Restore(snap io.ReadCloser) error { + return nil +} + +func (fsm FSM) Snapshot() (raft.FSMSnapshot, error) { + return Snapshot{}, nil +} + +type Snapshot struct { +} + +func (snapshot Snapshot) Persist(sink raft.SnapshotSink) error { + return nil +} + +func (snapshot Snapshot) Release() { +} diff --git a/pkg/config/config.go b/pkg/config/config.go new file mode 100644 index 0000000..15e497f --- /dev/null +++ b/pkg/config/config.go @@ -0,0 +1,48 @@ +package config + +import ( + "errors" + "gopkg.in/yaml.v2" + "os" +) + +func ParseFile(file string) (cfg *Config, err error) { + if file == "" { + return nil, errors.New("missing config file") + } + f, err := os.Open(file) + if err != nil { + return + } + cfg = new(Config) + err = yaml.NewDecoder(f).Decode(cfg) + return +} + +type Config struct { + DBFile string `yaml:"dbFile"` + + Leader bool `yaml:"leader"` + + AddressRange []string `yaml:"addressRange"` + + // LocalPeer is the configuration of this host + LocalPeer RaftPeer `yaml:"localPeer"` + + // Peers are all of the peers within the RAFT cluster + RemotePeers []RaftPeer `yaml:"remotePeers"` + + // Interface is the network interface to bind to (default: First Adapter) + Interface string `yaml:"interface,omitempty"` +} + +// RaftPeer details the configuration of all cluster peers +type RaftPeer struct { + ID string `yaml:"id"` + + // IP Address of a peer instance + Address string `yaml:"address"` + + // Listening port of this peer instance + Port int `yaml:"port"` +} diff --git a/pkg/vip/arp.go b/pkg/vip/arp.go new file mode 100644 index 0000000..5d73258 --- /dev/null +++ b/pkg/vip/arp.go @@ -0,0 +1,10 @@ +// +build !linux + +package vip + +import "fmt" + +// ARPSendGratuitous is only supported on Linux, so return an error +func ARPSendGratuitous(address, ifaceName string) error { + return fmt.Errorf("Unsupported on this OS") +} diff --git a/pkg/vip/arp_linux.go b/pkg/vip/arp_linux.go new file mode 100644 index 0000000..a8b1642 --- /dev/null +++ b/pkg/vip/arp_linux.go @@ -0,0 +1,176 @@ +// +build linux + +// These syscalls are only supported on Linux, so this uses a build directive during compilation. Other OS's will use the arp_unsupported.go and recieve an error + +package vip + +import ( + "bytes" + "encoding/binary" + "fmt" + "net" + "syscall" + "unsafe" + + log "github.com/sirupsen/logrus" +) + +const ( + opARPRequest = 1 + opARPReply = 2 + hwLen = 6 +) + +var ( + ethernetBroadcast = net.HardwareAddr{0xff, 0xff, 0xff, 0xff, 0xff, 0xff} + // arpRequest is used to flip between garp request or garp reply + arpRequest = true +) + +func htons(p uint16) uint16 { + var b [2]byte + binary.BigEndian.PutUint16(b[:], p) + return *(*uint16)(unsafe.Pointer(&b)) +} + +// arpHeader specifies the header for an ARP message. +type arpHeader struct { + hardwareType uint16 + protocolType uint16 + hardwareAddressLength uint8 + protocolAddressLength uint8 + opcode uint16 +} + +// arpMessage represents an ARP message. +type arpMessage struct { + arpHeader + senderHardwareAddress []byte + senderProtocolAddress []byte + targetHardwareAddress []byte + targetProtocolAddress []byte +} + +// bytes returns the wire representation of the ARP message. +func (m *arpMessage) bytes() ([]byte, error) { + buf := new(bytes.Buffer) + + if err := binary.Write(buf, binary.BigEndian, m.arpHeader); err != nil { + return nil, fmt.Errorf("binary write failed: %v", err) + } + buf.Write(m.senderHardwareAddress) + buf.Write(m.senderProtocolAddress) + buf.Write(m.targetHardwareAddress) + buf.Write(m.targetProtocolAddress) + + return buf.Bytes(), nil +} + +// gratuitousARP return a gARP request or gARP reply alternatively +// because different devices may support either one of them +func gratuitousARP(ip net.IP, mac net.HardwareAddr) (*arpMessage, error) { + if ip.To4() == nil { + return nil, fmt.Errorf("%q is not an IPv4 address", ip) + } + if len(mac) != hwLen { + return nil, fmt.Errorf("%q is not an Ethernet MAC address", mac) + } + + m := &arpMessage{ + arpHeader: arpHeader{ + 1, // Ethernet + 0x0800, // IPv4 + hwLen, // 48-bit MAC Address + net.IPv4len, // 32-bit IPv4 Address + opARPReply, // ARP Reply + }, + } + + // https://tools.ietf.org/html/rfc5944#section-4.6 + // In either case, the ARP Sender Hardware Address is + // set to the link-layer address to which this cache entry should be + // updated. + m.senderHardwareAddress = mac + + // When using an ARP Reply packet, the Target Hardware + // Address is also set to the link-layer address to which this cache + // entry should be updated (this field is not used in an ARP Request + // packet). + m.targetHardwareAddress = mac + + // In either case, the ARP Sender Protocol Address and + // ARP Target Protocol Address are both set to the IP address of the + // cache entry to be updated, + m.senderProtocolAddress = ip.To4() + m.targetProtocolAddress = ip.To4() + + // send arpRequest and arpReply alternatively + arpRequest = !arpRequest + if arpRequest { + m.arpHeader.opcode = opARPRequest + + // this field is not used in an ARP Request packet + m.targetHardwareAddress = ethernetBroadcast + } + + return m, nil +} + +// sendARP sends the given ARP message via the specified interface. +func sendARP(iface *net.Interface, m *arpMessage) error { + fd, err := syscall.Socket(syscall.AF_PACKET, syscall.SOCK_DGRAM, int(htons(syscall.ETH_P_ARP))) + if err != nil { + return fmt.Errorf("failed to get raw socket: %v", err) + } + defer syscall.Close(fd) + + if err := syscall.BindToDevice(fd, iface.Name); err != nil { + return fmt.Errorf("failed to bind to device: %v", err) + } + + ll := syscall.SockaddrLinklayer{ + Protocol: htons(syscall.ETH_P_ARP), + Ifindex: iface.Index, + Pkttype: 0, // syscall.PACKET_HOST + Hatype: m.hardwareType, + Halen: m.hardwareAddressLength, + } + target := ethernetBroadcast + for i := 0; i < len(target); i++ { + ll.Addr[i] = target[i] + } + + b, err := m.bytes() + if err != nil { + return fmt.Errorf("failed to convert ARP message: %v", err) + } + + if err := syscall.Bind(fd, &ll); err != nil { + return fmt.Errorf("failed to bind: %v", err) + } + if err := syscall.Sendto(fd, b, 0, &ll); err != nil { + return fmt.Errorf("failed to send: %v", err) + } + + return nil +} + +// ARPSendGratuitous sends a gratuitous ARP message via the specified interface. +func ARPSendGratuitous(address, ifaceName string) error { + iface, err := net.InterfaceByName(ifaceName) + if err != nil { + return fmt.Errorf("failed to get interface %q: %v", ifaceName, err) + } + + ip := net.ParseIP(address) + if ip == nil { + return fmt.Errorf("failed to parse address %s", ip) + } + + log.Infof("Broadcasting ARP update for %s (%s) via %s", address, iface.HardwareAddr, iface.Name) + m, err := gratuitousARP(ip, iface.HardwareAddr) + if err != nil { + return err + } + return sendARP(iface, m) +} diff --git a/pkg/vip/vip.go b/pkg/vip/vip.go new file mode 100644 index 0000000..f4a716e --- /dev/null +++ b/pkg/vip/vip.go @@ -0,0 +1,142 @@ +package vip + +import ( + "sync" + + "github.com/pkg/errors" + "github.com/vishvananda/netlink" +) + +const ( + defaultValidLft = 60 +) + +// Network is an interface that enable managing operations for a given IP +type Network interface { + AddIP() error + DeleteIP() error + IsSet() (bool, error) + IP() string + SetIP(ip string) error + Interface() string +} + +// network - This allows network configuration +type network struct { + mu sync.Mutex + + address *netlink.Addr + link netlink.Link + isDNS bool +} + +// NewConfig will attempt to provide an interface to the kernel network configuration +func NewConfig(address string, iface string) (Network, error) { + result := &network{} + + link, err := netlink.LinkByName(iface) + if err != nil { + return result, errors.Wrapf(err, "could not get link for interface '%s'", iface) + } + result.link = link + + if IsIP(address) { + result.address, err = netlink.ParseAddr(address + "/32") + if err != nil { + return result, errors.Wrapf(err, "could not parse address '%s'", address) + } + return result, nil + } + + // try to resolve the address + ip, err := lookupHost(address) + result.isDNS = err == nil + if err != nil { + return nil, err + } + + // we're able to resolve store this as the initial IP + if result.address, err = netlink.ParseAddr(ip + "/32"); err != nil { + return result, err + } + // set ValidLft so that the VIP expires if the DNS entry is updated, otherwise it'll be refreshed by the DNS prober + result.address.ValidLft = defaultValidLft + + return result, err +} + +//AddIP - Add an IP address to the interface +func (configurator *network) AddIP() error { + if err := netlink.AddrReplace(configurator.link, configurator.address); err != nil { + return errors.Wrap(err, "could not add ip") + } + return nil +} + +//DeleteIP - Remove an IP address from the interface +func (configurator *network) DeleteIP() error { + result, err := configurator.IsSet() + if err != nil { + return errors.Wrap(err, "ip check in DeleteIP failed") + } + + // Nothing to delete + if !result { + return nil + } + + if err = netlink.AddrDel(configurator.link, configurator.address); err != nil { + return errors.Wrap(err, "could not delete ip") + } + + return nil +} + +// IsSet - Check to see if VIP is set +func (configurator *network) IsSet() (result bool, err error) { + var addresses []netlink.Addr + + addresses, err = netlink.AddrList(configurator.link, 0) + if err != nil { + err = errors.Wrap(err, "could not list addresses") + + return + } + + for _, address := range addresses { + if address.Equal(*configurator.address) { + return true, nil + } + } + + return false, nil +} + +// SetIP updates the IP that is used +func (configurator *network) SetIP(ip string) error { + configurator.mu.Lock() + defer configurator.mu.Unlock() + + addr, err := netlink.ParseAddr(ip + "/32") + if err != nil { + return err + } + if configurator.address != nil && configurator.isDNS { + addr.ValidLft = defaultValidLft + } + configurator.address = addr + return nil +} + +// IP - return the IP Address +func (configurator *network) IP() string { + configurator.mu.Lock() + defer configurator.mu.Unlock() + + return configurator.address.IP.String() +} + +// Interface - return the Interface name +func (configurator *network) Interface() string { + return configurator.link.Attrs().Name +} diff --git a/run.sh b/run.sh new file mode 100755 index 0000000..aa352d6 --- /dev/null +++ b/run.sh @@ -0,0 +1,7 @@ +#!/bin/sh + +cd data +#rm -f node* +../vipman -config config1.yaml & +../vipman -config config2.yaml & +../vipman -config config3.yaml diff --git a/vipman.yaml b/vipman.yaml new file mode 100644 index 0000000..9de2435 --- /dev/null +++ b/vipman.yaml @@ -0,0 +1,14 @@ +dbFile: "" +addressRange: +- "" +localPeer: + id: "" + address: "" + port: 0 +remotePeers: +- id: "" + address: "" + port: 0 +- id: "" + address: "" + port: 0