diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..cad3f82 --- /dev/null +++ b/.gitignore @@ -0,0 +1,24 @@ +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go releaser +dist/ + +/unifi-notifications + +*.xml + +.vscode/ \ No newline at end of file diff --git a/.goreleaser.yml b/.goreleaser.yml new file mode 100644 index 0000000..048abfc --- /dev/null +++ b/.goreleaser.yml @@ -0,0 +1,12 @@ +builds: +- env: + - CGO_ENABLED=0 +archives: +- replacements: + darwin: Darwin + linux: Linux + windows: Windows + 386: i386 + amd64: x86_64 +checksum: + name_template: 'checksums.txt' diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..5156c68 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,20 @@ +# ---- Build container +FROM golang:alpine AS builder +WORKDIR /unifi-notifications +COPY . . +RUN apk add --no-cache git +RUN go build -v ./... + +# ---- App container +FROM alpine:latest as unifi-notifications +ENV NOTIFCATION_SERVICES=slack +ENV UNIFI_URL= +ENV UNIFI_SITES= +ENV UNIFI_USERNAME= +ENV UNIFI_PASSWORD= +ENV SLACK_ALARMS_WEBHOOK= +ENV SLACK_EVENTS_WEBHOOK= +RUN apk --no-cache add ca-certificates +COPY --from=builder unifi-notifications/unifi-notifications / +ENTRYPOINT ./unifi-notifications +LABEL Name=unifi-notifications Version=0.0.1 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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/README.md b/README.md new file mode 100644 index 0000000..cfa2be8 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# unifi-notifications +Send events and alerts from Unify to a notification service diff --git a/domain/model/config.go b/domain/model/config.go new file mode 100644 index 0000000..b933886 --- /dev/null +++ b/domain/model/config.go @@ -0,0 +1,61 @@ +package model + +import ( + "errors" + "strings" + + "github.com/caarlos0/env" +) + +type AppConfig struct { + CheckInterval int `env:"CHECK_INTERVAL" envDefault:"1"` + NotificationServices []string `env:"NOTIFCATION_SERVICES,required" envSeparator:","` +} + +type LoggerConfig struct { + Level string `env:"LOG_LEVEL" envDefault:"info"` +} + +type UnifiConfig struct { + URL string `env:"UNIFI_URL,required"` + Sites []string `env:"UNIFI_SITES,required" envSeparator:","` + Username string `env:"UNIFI_USERNAME,required"` + Password string `env:"UNIFI_PASSWORD,required"` +} + +type SlackConfig struct { + AlarmsWebhook string `env:"SLACK_ALARMS_WEBHOOK,required"` + EventsWebhook string `env:"SLACK_EVENTS_WEBHOOK,required"` +} + +func NewConfig() (AppConfig, LoggerConfig, UnifiConfig, SlackConfig, error) { + appConfig := AppConfig{} + loggerConfig := LoggerConfig{} + unifiConfig := UnifiConfig{} + slackConfig := SlackConfig{} + var errs []string + for _, e := range []error{ + env.Parse(&appConfig), + env.Parse(&loggerConfig), + env.Parse(&unifiConfig), + } { + if e != nil { + errs = append(errs, e.Error()) + } + } + + for _, notificationService := range appConfig.NotificationServices { + if notificationService == "slack" { + err := env.Parse(&slackConfig) + if err != nil { + errs = append(errs, err.Error()) + } + } + } + + var err error + if len(errs) > 0 { + err = errors.New(strings.Join(errs, ", ")) + } + return appConfig, loggerConfig, unifiConfig, slackConfig, err +} diff --git a/domain/model/unifi.go b/domain/model/unifi.go new file mode 100644 index 0000000..7560100 --- /dev/null +++ b/domain/model/unifi.go @@ -0,0 +1,184 @@ +package model + +import ( + "time" +) + +type UnifiLogin struct { + Username string `json:"username"` + Password string `json:"password"` +} + +type UnifiSession struct { + Key string + Expiration time.Time +} + +type UnifiPagination struct { + Limit int `json:"_limit"` + Start int `json:"_start"` +} + +type UnifiSiteAlarms map[string]UnifiAlarms + +type UnifiSiteEvents map[string]UnifiEvents + +type Meta struct { + RC string `json:"rc"` + Count int64 `json:"count"` + Msg string `json:"msg"` +} + +type UnifiAlarms struct { + Meta Meta `json:"meta"` + Alarms []UnifiAlarm `json:"data"` +} + +type UnifiAlarm struct { + ID string `json:"_id"` + Archived bool `json:"archived"` + Timestamp int64 `json:"timestamp"` + FlowID int64 `json:"flow_id"` + InIface string `json:"in_iface"` + EventType string `json:"event_type"` + SrcIP string `json:"src_ip"` + SrcMAC string `json:"src_mac"` + SrcPort int64 `json:"src_port"` + DestIP string `json:"dest_ip"` + DstMAC string `json:"dst_mac"` + DestPort int64 `json:"dest_port"` + Proto string `json:"proto"` + TxID int64 `json:"tx_id"` + AppProto string `json:"app_proto"` + Host string `json:"host"` + Usgip string `json:"usgip"` + UniqueAlertid string `json:"unique_alertid"` + UsgipCountry string `json:"usgipCountry"` + SrcipASN string `json:"srcipASN"` + DstipASN string `json:"dstipASN"` + UsgipASN string `json:"usgipASN"` + Catname string `json:"catname"` + InnerAlertAction string `json:"inner_alert_action"` + InnerAlertGid int64 `json:"inner_alert_gid"` + InnerAlertSignatureID int64 `json:"inner_alert_signature_id"` + InnerAlertRev int64 `json:"inner_alert_rev"` + InnerAlertSignature string `json:"inner_alert_signature"` + InnerAlertCategory string `json:"inner_alert_category"` + InnerAlertSeverity int64 `json:"inner_alert_severity"` + Key string `json:"key"` + Subsystem string `json:"subsystem"` + SiteID string `json:"site_id"` + Time int64 `json:"time"` + Datetime time.Time `json:"datetime"` + Msg string `json:"msg"` + Ap string `json:"ap"` + ApName string `json:"ap_name"` + HandledAdminID string `json:"handled_admin_id"` + HandledTime string `json:"handled_time"` + Gw string `json:"gw"` + GwName string `json:"gw_name"` + VLAN int64 `json:"vlan"` + ICMPType int64 `json:"icmp_type"` + ICMPCode int64 `json:"icmp_code"` +} + +type UnifiEvents struct { + Meta Meta `json:"meta"` + Events []UnifiEvent `json:"data"` +} + +type UnifiEvent struct { + ID string `json:"_id"` + IP string `json:"ip"` + Admin string `json:"admin"` + SiteID string `json:"site_id"` + IsAdmin bool `json:"is_admin"` + Key string `json:"key"` + Subsystem string `json:"subsystem"` + Time int64 `json:"time"` + Datetime time.Time `json:"datetime"` + Msg string `json:"msg"` + User string `json:"user"` + Network string `json:"network"` + Duration int64 `json:"duration"` + Bytes int64 `json:"bytes"` + SSID string `json:"ssid"` + Ap string `json:"ap"` + Radio string `json:"radio"` + Channel string `json:"channel"` + Hostname string `json:"hostname"` + RadioFrom string `json:"radio_from"` + RadioTo string `json:"radio_to"` + Gw string `json:"gw"` + GwName string `json:"gw_name"` + ApName string `json:"ap_name"` + Timestamp int64 `json:"timestamp"` + FlowID int64 `json:"flow_id"` + InIface string `json:"in_iface"` + EventType string `json:"event_type"` + SrcIP string `json:"src_ip"` + SrcMAC string `json:"src_mac"` + SrcPort int64 `json:"src_port"` + DestIP string `json:"dest_ip"` + DstMAC string `json:"dst_mac"` + DestPort int64 `json:"dest_port"` + Proto string `json:"proto"` + TxID int64 `json:"tx_id"` + AppProto string `json:"app_proto"` + Host string `json:"host"` + Usgip string `json:"usgip"` + UniqueAlertid string `json:"unique_alertid"` + UsgipCountry string `json:"usgipCountry"` + SrcipASN string `json:"srcipASN"` + DstipASN string `json:"dstipASN"` + UsgipASN string `json:"usgipASN"` + Catname string `json:"catname"` + InnerAlertAction string `json:"inner_alert_action"` + InnerAlertGid int64 `json:"inner_alert_gid"` + InnerAlertSignatureID int64 `json:"inner_alert_signature_id"` + InnerAlertRev int64 `json:"inner_alert_rev"` + InnerAlertSignature string `json:"inner_alert_signature"` + InnerAlertCategory string `json:"inner_alert_category"` + InnerAlertSeverity int64 `json:"inner_alert_severity"` + NumSta int64 `json:"num_sta"` + ApFrom string `json:"ap_from"` + ApTo string `json:"ap_to"` + Name string `json:"name"` +} + +type UnifiSiteUsers map[string]UnifiUsers + +type UnifiUsers struct { + Meta Meta `json:"meta"` + Users []UnifiUser `json:"data"` +} + +type UnifiUser struct { + ID string `json:"_id"` + Mac string `json:"mac"` + SiteID string `json:"site_id"` + Oui string `json:"oui"` + IsGuest bool `json:"is_guest"` + FirstSeen int64 `json:"first_seen"` + LastSeen int64 `json:"last_seen"` + IsWired bool `json:"is_wired"` + Hostname string `json:"hostname"` +} + +type UnifiSiteDevices map[string]UnifiDevices + +type UnifiDevices struct { + Meta Meta `json:"meta"` + Devices []UnifiDevice `json:"data"` +} + +type UnifiDevice struct { + ID string `json:"_id"` + Mac string `json:"mac"` + State int64 `json:"state"` + Adopted bool `json:"adopted"` + Disabled bool `json:"disabled"` + Type string `json:"type"` + Model string `json:"model"` + Name string `json:"name"` +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..9ac178f --- /dev/null +++ b/go.mod @@ -0,0 +1,15 @@ +module github.com/ryancurrah/unifi-notifications + +go 1.12 + +require ( + github.com/caarlos0/env v3.5.0+incompatible + github.com/gorilla/websocket v1.4.0 // indirect + github.com/lusis/go-slackbot v0.0.0-20180109053408-401027ccfef5 // indirect + github.com/lusis/slack-test v0.0.0-20190426140909-c40012f20018 // indirect + github.com/nlopes/slack v0.5.0 + github.com/pkg/errors v0.8.1 // indirect + github.com/prometheus/common v0.9.1 + github.com/sirupsen/logrus v1.4.2 + golang.org/x/sys v0.0.0-20190520201301-c432e742b0af // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..780c210 --- /dev/null +++ b/go.sum @@ -0,0 +1,81 @@ +github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751 h1:JYp7IbQjafoB+tBA3gMyHYHrpOtNuDiK/uB5uXxq5wM= +github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= +github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4 h1:Hs82Z41s6SdL1CELW+XaDYmOH4hkBN4/N9og/AsOv7E= +github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= +github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q= +github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8= +github.com/caarlos0/env v3.5.0+incompatible h1:Yy0UN8o9Wtr/jGHZDpCBLpNrzcFLLM2yixi/rBrKyJs= +github.com/caarlos0/env v3.5.0+incompatible/go.mod h1:tdCsowwCzMLdkqRYDlHpZCp2UooDD3MspDBjZ2AD02Y= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-kit/kit v0.9.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as= +github.com/go-logfmt/logfmt v0.3.0/go.mod h1:Qt1PoO58o5twSAckw1HlFXLmHsOX5/0LbT9GBnD5lWE= +github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V4qmtdjCk= +github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ= +github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= +github.com/gorilla/websocket v1.4.0 h1:WDFjx/TMzVgy9VdMMQi2K2Emtwi2QcUQsztZ/zLaH/Q= +github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ= +github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU= +github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w= +github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk= +github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= +github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc= +github.com/lusis/go-slackbot v0.0.0-20180109053408-401027ccfef5 h1:AsEBgzv3DhuYHI/GiQh2HxvTP71HCCE9E/tzGUzGdtU= +github.com/lusis/go-slackbot v0.0.0-20180109053408-401027ccfef5/go.mod h1:c2mYKRyMb1BPkO5St0c/ps62L4S0W2NAkaTXj9qEI+0= +github.com/lusis/slack-test v0.0.0-20190426140909-c40012f20018 h1:MNApn+Z+fIT4NPZopPfCc1obT6aY3SVM6DOctz1A9ZU= +github.com/lusis/slack-test v0.0.0-20190426140909-c40012f20018/go.mod h1:sFlOUpQL1YcjhFVXhg1CG8ZASEs/Mf1oVb6H75JL/zg= +github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0= +github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U= +github.com/nlopes/slack v0.5.0 h1:NbIae8Kd0NpqaEI3iUrsuS0KbcEDhzhc939jLW5fNm0= +github.com/nlopes/slack v0.5.0/go.mod h1:jVI4BBK3lSktibKahxBF74txcK2vyvkza1z/+rRnVAM= +github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= +github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/prometheus/client_golang v0.9.1/go.mod h1:7SWBe2y4D6OKWSNQJUaRYU/AaXPKyh/dDVn+NZz0KFw= +github.com/prometheus/client_golang v1.0.0/go.mod h1:db9x61etRT2tGnBNRi70OPL5FsnadC4Ky3P0J6CfImo= +github.com/prometheus/client_model v0.0.0-20180712105110-5c3871d89910/go.mod h1:MbSGuTsp3dbXC40dX6PRTWyKYBIrTGTE9sqQNg2J8bo= +github.com/prometheus/client_model v0.0.0-20190129233127-fd36f4220a90/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/client_model v0.2.0/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA= +github.com/prometheus/common v0.4.1/go.mod h1:TNfzLD0ON7rHzMJeJkieUDPYmFC7Snx/y86RQel1bk4= +github.com/prometheus/common v0.9.1 h1:KOMtN28tlbam3/7ZKEYKHhKoJZYYj3gMH4uc62x7X7U= +github.com/prometheus/common v0.9.1/go.mod h1:yhUN8i9wzaXS3w1O07YhxHEBxD+W35wd8bs7vj7HSQ4= +github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk= +github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA= +github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo= +github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4= +github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= +github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= +golang.org/x/net v0.0.0-20190613194153-d28f0bde5980/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20181221193216-37e7f081c4d4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc= +golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20190520201301-c432e742b0af h1:NXfmMfXz6JqGfG3ikSxcz2N93j6DgScr19Oo2uwFu88= +golang.org/x/sys v0.0.0-20190520201301-c432e742b0af/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +gopkg.in/alecthomas/kingpin.v2 v2.2.6 h1:jMFz6MfLP0/4fUyZle81rXUoxOBFi19VUFKVDOQfozc= +gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/infrastructure/logrus.go b/infrastructure/logrus.go new file mode 100644 index 0000000..4aa1795 --- /dev/null +++ b/infrastructure/logrus.go @@ -0,0 +1,20 @@ +package infrastructure + +import ( + "os" + + "github.com/ryancurrah/unifi-notifications/domain/model" + "github.com/sirupsen/logrus" +) + +func NewLogHandler(config model.LoggerConfig) (*logrus.Logger, error) { + var log = logrus.New() + log.SetFormatter(&logrus.JSONFormatter{}) + log.SetOutput(os.Stdout) + level, err := logrus.ParseLevel(config.Level) + if err != nil { + return &logrus.Logger{}, err + } + log.SetLevel(level) + return log, nil +} diff --git a/infrastructure/slack.go b/infrastructure/slack.go new file mode 100644 index 0000000..d6a3295 --- /dev/null +++ b/infrastructure/slack.go @@ -0,0 +1,94 @@ +package infrastructure + +import ( + "encoding/json" + "fmt" + "strconv" + + "github.com/sirupsen/logrus" + + "github.com/ryancurrah/unifi-notifications/domain/model" + + "github.com/nlopes/slack" +) + +const attachmentLimit = 20 + +type SlackHandler struct { + Config model.SlackConfig + Logger *logrus.Logger +} + +func NewSlackHandler(config model.SlackConfig, logger *logrus.Logger) SlackHandler { + return SlackHandler{Config: config, Logger: logger} +} + +func (h *SlackHandler) NotifyAlarms(unifiSiteAlarms model.UnifiSiteAlarms) error { + h.Logger.Infof("number of alarm sites %d", len(unifiSiteAlarms)) + messages := []slack.WebhookMessage{} + for site, unifiAlarms := range unifiSiteAlarms { + attachments := []slack.Attachment{} + h.Logger.WithField("site", site).Infof("number of alarms %d", len(unifiAlarms.Alarms)) + for _, unifiAlarm := range unifiAlarms.Alarms { + attachments = append(attachments, slack.Attachment{ + Color: "danger", + Text: fmt.Sprintf(" %s", unifiAlarm.Msg), + Ts: json.Number(strconv.FormatInt(unifiAlarm.Datetime.Unix(), 10)), + Fields: []slack.AttachmentField{{Title: "Site", Value: site, Short: true}}, + }) + + if len(attachments) >= attachmentLimit { + messages = append(messages, slack.WebhookMessage{Attachments: attachments}) + attachments = []slack.Attachment{} + } + } + if len(attachments) > 0 { + messages = append(messages, slack.WebhookMessage{Attachments: attachments}) + } + } + + h.Logger.Infof("number of alarm messages %d", len(messages)) + + for _, message := range messages { + err := slack.PostWebhook(h.Config.AlarmsWebhook, &message) + if err != nil { + return err + } + } + return nil +} + +func (h *SlackHandler) NotifyEvents(unifiSiteEvents model.UnifiSiteEvents) error { + h.Logger.Infof("number of event sites %d", len(unifiSiteEvents)) + messages := []slack.WebhookMessage{} + for site, unifiEvents := range unifiSiteEvents { + attachments := []slack.Attachment{} + h.Logger.WithField("site", site).Infof("number of events %d", len(unifiEvents.Events)) + for _, unifiEvent := range unifiEvents.Events { + attachments = append(attachments, slack.Attachment{ + Color: "danger", + Text: fmt.Sprintf(" %s %s", unifiEvent.Host, unifiEvent.Msg), + Ts: json.Number(strconv.FormatInt(unifiEvent.Datetime.Unix(), 10)), + Fields: []slack.AttachmentField{{Title: "Site", Value: site, Short: true}}, + }) + + if len(attachments) >= attachmentLimit { + messages = append(messages, slack.WebhookMessage{Attachments: attachments}) + attachments = []slack.Attachment{} + } + } + if len(attachments) > 0 { + messages = append(messages, slack.WebhookMessage{Attachments: attachments}) + } + } + + h.Logger.Infof("number of event messages %d", len(messages)) + + for _, message := range messages { + err := slack.PostWebhook(h.Config.EventsWebhook, &message) + if err != nil { + return err + } + } + return nil +} diff --git a/infrastructure/unifi.go b/infrastructure/unifi.go new file mode 100644 index 0000000..487a73e --- /dev/null +++ b/infrastructure/unifi.go @@ -0,0 +1,267 @@ +package infrastructure + +import ( + "bytes" + "encoding/json" + "fmt" + "io/ioutil" + "net/http" + "net/url" + "strings" + "time" + + "github.com/sirupsen/logrus" + + "github.com/ryancurrah/unifi-notifications/domain/model" +) + +const ( + LoginURI = "api/login" + StatAlarmURI = "api/s/%s/stat/alarm" + StatEventURI = "api/s/%s/stat/event" + StatDeviceBasicURI = "api/s/%s/stat/device-basic" + ListUserURI = "api/s/%s/list/user" + ContentType = "application/json;charset=UTF-8" + AuthCookieName = "unifises" + AuthCookieDuration = time.Minute * 19 + PaginateBy = 20 +) + +var session model.UnifiSession + +type UnifiHandler struct { + Config model.UnifiConfig + HTTPClient http.Client + Logger *logrus.Logger +} + +func NewUnifiHandler(config model.UnifiConfig, httpClient http.Client, logger *logrus.Logger) UnifiHandler { + return UnifiHandler{Config: config, HTTPClient: httpClient, Logger: logger} +} + +func (h *UnifiHandler) GetAlarms(since time.Time) (model.UnifiSiteAlarms, error) { + unifiSiteAlarms := make(model.UnifiSiteAlarms) + for _, site := range h.Config.Sites { + pagination := model.UnifiPagination{Limit: 0, Start: 0} + newUnifiAlarms := model.UnifiAlarms{} + + for { + pagination.Start = pagination.Start + pagination.Limit + pagination.Limit = pagination.Limit + PaginateBy + + body, _, err := h.getURI(fmt.Sprintf(StatAlarmURI, site), pagination) + if err != nil { + return model.UnifiSiteAlarms{}, err + } + + unifiAlarms := model.UnifiAlarms{} + err = json.Unmarshal(body, &unifiAlarms) + if err != nil { + return model.UnifiSiteAlarms{}, err + } + + var done bool + for _, unifiAlarm := range unifiAlarms.Alarms { + if unifiAlarm.Datetime.After(since) { + newUnifiAlarms.Alarms = append(newUnifiAlarms.Alarms, unifiAlarm) + } else { + done = true + break + } + } + + if done { + break + } + } + + unifiSiteAlarms[site] = newUnifiAlarms + } + return unifiSiteAlarms, nil +} + +func (h *UnifiHandler) GetEvents(since time.Time) (model.UnifiSiteEvents, error) { + unifiSiteDevices, err := h.getDevices() + if err != nil { + return model.UnifiSiteEvents{}, err + } + + unifiSiteUsers, err := h.getUsers() + if err != nil { + return model.UnifiSiteEvents{}, err + } + + unifiSiteEvents := make(model.UnifiSiteEvents) + for _, site := range h.Config.Sites { + pagination := model.UnifiPagination{Limit: 0, Start: 0} + newUnifiEvents := model.UnifiEvents{} + + for { + pagination.Start = pagination.Start + pagination.Limit + pagination.Limit = pagination.Limit + PaginateBy + + body, _, err := h.getURI(fmt.Sprintf(StatEventURI, site), pagination) + if err != nil { + return model.UnifiSiteEvents{}, err + } + + unifiEvents := model.UnifiEvents{} + err = json.Unmarshal(body, &unifiEvents) + if err != nil { + return model.UnifiSiteEvents{}, err + } + + var done bool + for _, unifiEvent := range unifiEvents.Events { + if unifiEvent.Datetime.After(since) { + unifiEvent.Msg = replaceDeviceAndUserMac(unifiSiteDevices[site], unifiSiteUsers[site], unifiEvent.Msg) + newUnifiEvents.Events = append(newUnifiEvents.Events, unifiEvent) + } else { + done = true + break + } + } + + if done { + break + } + } + + unifiSiteEvents[site] = newUnifiEvents + } + return unifiSiteEvents, nil +} + +func (h *UnifiHandler) setAuthCookie(url *url.URL) error { + if session == (model.UnifiSession{}) || session.Expiration.After(time.Now()) { + err := h.login() + if err != nil { + return err + } + } + cookie := http.Cookie{Name: AuthCookieName, Value: session.Key} + h.HTTPClient.Jar.SetCookies(url, []*http.Cookie{&cookie}) + return nil +} + +func (h *UnifiHandler) login() error { + creds := model.UnifiLogin{Username: h.Config.Username, Password: h.Config.Password} + credBytes, err := json.Marshal(creds) + if err != nil { + return err + } + u, err := url.Parse(fmt.Sprintf("%s/%s", h.Config.URL, LoginURI)) + if err != nil { + return err + } + h.Logger.Debugf("logging into unifi controller at url %s", u) + resp, err := h.HTTPClient.Post(u.String(), ContentType, bytes.NewBuffer(credBytes)) + if err != nil { + return err + } + defer resp.Body.Close() + bodyBytes, err := ioutil.ReadAll(resp.Body) + if err != nil { + return err + } + body := string(bodyBytes) + for _, cookie := range resp.Cookies() { + if cookie.Name == AuthCookieName && cookie.Value != "" { + session = model.UnifiSession{ + Key: cookie.Value, + Expiration: time.Now().Add(AuthCookieDuration), + } + return nil + } + } + return fmt.Errorf("could not login unfi controller, status=%s body=%s", resp.Status, body) +} + +func (h *UnifiHandler) getURI(uri string, pagination model.UnifiPagination) ([]byte, *http.Response, error) { + paginationBytes, err := json.Marshal(pagination) + if err != nil { + return []byte{}, nil, err + } + u, err := url.Parse(fmt.Sprintf("%s/%s", h.Config.URL, uri)) + if err != nil { + return []byte{}, nil, err + } + h.Logger.Debugf("getting unifi url %s", u) + err = h.setAuthCookie(u) + if err != nil { + return []byte{}, nil, err + } + resp, err := h.HTTPClient.Post(u.String(), ContentType, bytes.NewBuffer(paginationBytes)) + if err != nil { + return []byte{}, resp, err + } + defer resp.Body.Close() + body, err := ioutil.ReadAll(resp.Body) + return body, resp, err +} + +func (h *UnifiHandler) getDevices() (model.UnifiSiteDevices, error) { + unifiSiteDevices := make(model.UnifiSiteDevices) + for _, site := range h.Config.Sites { + pagination := model.UnifiPagination{Limit: 0, Start: 0} + newUnifiDevices := model.UnifiDevices{} + + body, _, err := h.getURI(fmt.Sprintf(StatDeviceBasicURI, site), pagination) + if err != nil { + return model.UnifiSiteDevices{}, err + } + + unifiDevices := model.UnifiDevices{} + err = json.Unmarshal(body, &unifiDevices) + if err != nil { + return model.UnifiSiteDevices{}, err + } + + for _, unifiDevice := range unifiDevices.Devices { + newUnifiDevices.Devices = append(newUnifiDevices.Devices, unifiDevice) + } + + unifiSiteDevices[site] = newUnifiDevices + } + return unifiSiteDevices, nil +} + +func (h *UnifiHandler) getUsers() (model.UnifiSiteUsers, error) { + unifiSiteUsers := make(model.UnifiSiteUsers) + for _, site := range h.Config.Sites { + pagination := model.UnifiPagination{Limit: 0, Start: 0} + newUnifiUsers := model.UnifiUsers{} + + body, _, err := h.getURI(fmt.Sprintf(ListUserURI, site), pagination) + if err != nil { + return model.UnifiSiteUsers{}, err + } + + unifiUsers := model.UnifiUsers{} + err = json.Unmarshal(body, &unifiUsers) + if err != nil { + return model.UnifiSiteUsers{}, err + } + + for _, unifiUser := range unifiUsers.Users { + newUnifiUsers.Users = append(newUnifiUsers.Users, unifiUser) + } + + unifiSiteUsers[site] = newUnifiUsers + } + return unifiSiteUsers, nil +} + +func replaceDeviceAndUserMac(unifiDevices model.UnifiDevices, unifiUsers model.UnifiUsers, msg string) string { + for _, unifiDevice := range unifiDevices.Devices { + if unifiDevice.Mac != "" && unifiDevice.Name != "" { + msg = strings.ReplaceAll(msg, unifiDevice.Mac, unifiDevice.Name) + } + } + for _, unifiUser := range unifiUsers.Users { + if unifiUser.Mac != "" && unifiUser.Hostname != "" { + msg = strings.ReplaceAll(msg, unifiUser.Mac, unifiUser.Hostname) + } + } + return msg +} diff --git a/main.go b/main.go new file mode 100644 index 0000000..3b665da --- /dev/null +++ b/main.go @@ -0,0 +1,159 @@ +package main + +import ( + tls "crypto/tls" + "fmt" + "math/rand" + "net/http" + "net/http/cookiejar" + "os" + "os/signal" + "strings" + "sync" + "syscall" + "time" + + "github.com/ryancurrah/unifi-notifications/infrastructure" + "github.com/sirupsen/logrus" + + "github.com/ryancurrah/unifi-notifications/domain/model" +) + +var ( + alarmsLastChecked = time.Now() + eventsLastChecked = time.Now() + alarmsQuitSignal chan bool + eventsQuitSignal chan bool + mainQuitSignal chan os.Signal + wg sync.WaitGroup +) + +func main() { + defer wg.Wait() + alarmsQuitSignal = make(chan bool) + eventsQuitSignal = make(chan bool) + mainQuitSignal = make(chan os.Signal, 1) + signal.Notify(mainQuitSignal, syscall.SIGINT, syscall.SIGTERM) + + appConfig, loggerConfig, unifiConfig, slackConfig, err := model.NewConfig() + if err != nil { + fmt.Println(err) + os.Exit(1) + } + + logger, err := infrastructure.NewLogHandler(loggerConfig) + if err != nil { + logger.Fatalf("logger handler setup failed, error=%s", err) + } + + tr := &http.Transport{ + TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, + } + + jar, err := cookiejar.New(nil) + if err != nil { + logger.Fatalf("cookie jar setup failed, error=%s", err) + } + httpClient := http.Client{Jar: jar, Transport: tr} + + unifiHandler := infrastructure.NewUnifiHandler(unifiConfig, httpClient, logger) + + slackHandler := infrastructure.NewSlackHandler(slackConfig, logger) + + go checkAlarms(appConfig.CheckInterval, logger, unifiHandler, slackHandler) + go checkEvents(appConfig.CheckInterval, logger, unifiHandler, slackHandler, unifiConfig.Username) + + logger.Info("started successfully") + for { + select { + case <-mainQuitSignal: + logger.Warn("received quit signal") + go func() { + alarmsQuitSignal <- true + logger.Info("alarms checker quit succesfully") + }() + + go func() { + eventsQuitSignal <- true + logger.Info("events checker quit succesfully") + }() + return + } + } +} + +func checkAlarms(checkInterval int, logger *logrus.Logger, unifiHandler infrastructure.UnifiHandler, slackHandler infrastructure.SlackHandler) { + wg.Add(1) + defer wg.Done() + for { + select { + case <-time.After(time.Duration(checkInterval)*time.Minute + time.Duration(rand.Intn(30-1)+1)*time.Second): + logger.Infof("checking for new alarms since %s", alarmsLastChecked.String()) + siteAlarms, err := unifiHandler.GetAlarms(alarmsLastChecked) + if err != nil { + logger.Error(err) + } + + for _, unifiAlarms := range siteAlarms { + for _, unifiAlarm := range unifiAlarms.Alarms { + logger.WithField("type", "alarm").Infof("%s %s", unifiAlarm.Msg, unifiAlarm.Datetime.String()) + } + } + + err = slackHandler.NotifyAlarms(siteAlarms) + if err != nil { + logger.Error(err) + } + + alarmsLastChecked = time.Now() + case <-alarmsQuitSignal: + return + } + } +} + +func checkEvents(checkInterval int, logger *logrus.Logger, unifiHandler infrastructure.UnifiHandler, slackHandler infrastructure.SlackHandler, username string) { + wg.Add(1) + defer wg.Done() + for { + select { + case <-time.After(time.Duration(checkInterval)*time.Minute + time.Duration(rand.Intn(30-1)+1)*time.Second): + logger.Infof("checking for new events since %s", eventsLastChecked.String()) + siteEvents, err := unifiHandler.GetEvents(eventsLastChecked) + if err != nil { + logger.Error(err) + } + + siteEvents = filterAdminLoginEvents(username, siteEvents) + + for _, unifiEvents := range siteEvents { + for _, unifiEvent := range unifiEvents.Events { + logger.WithField("type", "event").Infof("%s %s", unifiEvent.Msg, unifiEvent.Datetime.String()) + } + } + + err = slackHandler.NotifyEvents(siteEvents) + if err != nil { + logger.Error(err) + } + + eventsLastChecked = time.Now() + case <-eventsQuitSignal: + return + } + } +} + +func filterAdminLoginEvents(adminName string, unifiSiteEvents model.UnifiSiteEvents) model.UnifiSiteEvents { + filteredUnifiSiteEvents := model.UnifiSiteEvents{} + for site, unifiEvents := range unifiSiteEvents { + filteredUnifiEvents := model.UnifiEvents{} + for _, unifiEvent := range unifiEvents.Events { + if !strings.HasPrefix(unifiEvent.Msg, fmt.Sprintf("Admin[%s] log in from", adminName)) { + filteredUnifiEvents.Events = append(filteredUnifiEvents.Events, unifiEvent) + } + } + filteredUnifiSiteEvents[site] = filteredUnifiEvents + } + return filteredUnifiSiteEvents +}