commit 0d0ddec026070c01a07e330e019d64d8edaa9e26 Author: Maksym Sadovnychyy Date: Mon Nov 24 18:14:51 2025 +0100 (feature): init diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..830dd2c --- /dev/null +++ b/.gitignore @@ -0,0 +1,265 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# DNX +project.lock.json +project.fragment.lock.json +artifacts/ + +*_i.c +*_p.c +*_i.h +*.ilk +*.meta +*.obj +*.pch +*.pdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# TODO: Comment the next line if you want to checkin your web deploy settings +# but database connection strings (with potential passwords) will be unencrypted +#*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/packages/* +# except build/, which is used as an MSBuild target. +!**/packages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/packages/repositories.config +# NuGet v3's project.json files produces more ignoreable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +node_modules/ +dist/ +orleans.codegen.cs +.directory + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm + +# SQL Server files +*.mdf +*.ldf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush +.cr/ + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + + diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +### 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..582fe63 --- /dev/null +++ b/README.md @@ -0,0 +1,281 @@ +# MaksIT.CertsUI – HAProxy and Agent Configuration + +This guide explains how to configure HAProxy, Nginx, and install the MaksIT.CertsUI Agent for automated, secure certificate management. + +--- + + +If you find this project useful, please consider supporting its development: + +[Buy Me A Coffee](https://www.buymeacoffee.com/maksitcom) + + +--- + +## Overview + +The **MaksIT.CertsUI Agent** is a lightweight, cross-platform service designed to: +- **Receive cached certificates** from the MaksIT.CertsUI server via secure HTTP APIs. +- **Deploy certificates** to your reverse proxy’s local file system (e.g., HAProxy, Nginx). +- **Reload or restart** the proxy service to activate new certificates automatically. + +### Key Features +- **Language Agnostic:** + The agent communicates using standard HTTP APIs. While a C# WebAPI implementation is provided, you can build your own agent in any language or framework (C#, Go, Python, Rust, Node.js, etc.) as long as it can: + - Receive certificate files via HTTP + - Write files to the proxy’s certificate directory + - Reload or restart the proxy process + +- **Security:** + All communication between the agent and the MaksIT.CertsUI server is protected by a shared API key. Only authorized agents can deploy certificates and trigger proxy reloads, safeguarding your infrastructure. + + > **Warning:** Never commit secrets or API keys to version control. Always use strong, unique secrets and passwords. + +- **Flexible Integration:** + The agent is fully independent from the MaksIT.CertsUI server, allowing you to integrate it into any environment or technology stack that supports HTTP endpoints. + +--- + +## Table of Contents +- [HAProxy configuration](#haproxy-configuration) + - [Explanation](#explanation) +- [Nginx configuration](#nginx-configuration) + - [Nginx Explanation](#nginx-explanation) +- [MaksIT.CertsUI Agent installation](#maksitcertsui-agent-installation) +- [Contact](#contact) + +--- + +## HAProxy configuration + +Create the certificates directory: + +```bash +sudo mkdir /etc/haproxy/certs +``` + +Edit your HAProxy configuration: + +```bash +sudo nano /etc/haproxy/haproxy.cfg +``` + +Example configuration: + +```cfg +# Global settings +#--------------------------------------------------------------------- +global + log 127.0.0.1 local2 + chroot /var/lib/haproxy + pidfile /var/run/haproxy.pid + maxconn 4000 + user haproxy + group haproxy + daemon + stats socket /var/lib/haproxy/stats + ssl-default-bind-ciphers PROFILE=SYSTEM + ssl-default-server-ciphers PROFILE=SYSTEM + +#--------------------------------------------------------------------- +# common defaults that all the 'listen' and 'backend' sections will +# use if not designated in their block +#--------------------------------------------------------------------- +defaults + mode http + log global + option httplog + option dontlognull + option http-server-close + option forwardfor except 127.0.0.0/8 + option redispatch + retries 3 + timeout http-request 10s + timeout queue 1m + timeout connect 10s + timeout client 1m + timeout server 1m + timeout http-keep-alive 10s + timeout check 10s + maxconn 3000 + +#--------------------------------------------------------------------- +# Frontend for HTTP traffic on port 80 +#--------------------------------------------------------------------- +frontend http_frontend + bind *:80 + acl acme_path path_beg /.well-known/acme-challenge/ + + # Redirect all HTTP traffic to HTTPS except ACME challenge requests + redirect scheme https if !acme_path + + # Use the appropriate backend based on hostname if it's an ACME challenge request + use_backend acme_backend if acme_path + +#--------------------------------------------------------------------- +# Backend to handle ACME challenge requests +#--------------------------------------------------------------------- +backend acme_backend + #server local_acme 172.16.0.5:8080 + +#--------------------------------------------------------------------- +# Frontend for HTTPS traffic (port 443) with SNI and strict-sni +#--------------------------------------------------------------------- +frontend https_frontend + bind *:443 ssl crt /etc/haproxy/certs strict-sni + + http-request capture req.hdr(host) len 64 + + # Define ACLs for routing based on hostname + acl host_homepage hdr(host) -i maks-it.com + + # Use appropriate backend based on SNI hostname + use_backend homepage_backend if host_homepage + + default_backend homepage_backend + +#--------------------------------------------------------------------- +# Backend for maks-it.com +#--------------------------------------------------------------------- +backend homepage_backend + http-request set-header X-Forwarded-Proto https + http-request set-header X-Forwarded-Host %[hdr(host)] + server homepage_server 172.16.0.10:8080 +``` + +### Explanation +- **ACME Challenge Handling:** + - The `http_frontend` listens on port80 and checks if the request path starts with `/.well-known/acme-challenge/`. These requests are required by Let's Encrypt for domain validation and are forwarded to the `acme_backend`. All other HTTP requests are redirected to HTTPS. +- **HTTPS Frontend:** + - The `https_frontend` listens on port443, uses SNI (Server Name Indication) to serve the correct certificate, and routes requests to the appropriate backend based on the hostname. +- **Backends:** + - `acme_backend` should point to your ACME challenge responder (such as your LetsEncrypt client). + - `homepage_backend` is an example backend for your main site, forwarding requests to your application server. +- **Certificate Storage:** + - SSL certificates will be placed by agent in `/etc/haproxy/certs`. Each certificate file will contain the full certificate chain and private key. + +--- + +## Nginx configuration + +Create the certificates directory: + +```bash +sudo mkdir -p /etc/nginx/certs +``` + +Edit your Nginx configuration: + +```bash +sudo nano /etc/nginx/nginx.conf +``` + +Example configuration: + +```nginx +server { + listen 80; + server_name maks-it.com; + + location /.well-known/acme-challenge/ { + proxy_pass http://127.0.0.1:5000; # Point to your ACME challenge responder (agent) + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + } + + location / { + return 301 https://$host$request_uri; + } +} + +server { + listen 443 ssl; + server_name maks-it.com; + + ssl_certificate /etc/nginx/certs/maks-it.com; + ssl_protocols TLSv1.2 TLSv1.3; + ssl_ciphers HIGH:!aNULL:!MD5; + + location / { + proxy_pass http://127.0.0.1:8080; # Your backend application + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-Proto $scheme; + } +} +``` + +### Nginx Explanation +- **ACME Challenge Handling:** + - The first server block listens on port80 and forwards requests to `/.well-known/acme-challenge/` to the agent (or ACME challenge responder). All other HTTP requests are redirected to HTTPS. +- **HTTPS Frontend:** + - The second server block listens on port443, uses the certificate and key files placed by the agent in `/etc/nginx/certs`, and proxies requests to your backend application. +- **Certificate Storage:** + - SSL certificates and keys should be placed by the agent in `/etc/nginx/certs`. Each domain should have its own `.crt` and `.key` files. + +--- + +## MaksIT.CertsUI Agent installation + +The Agent should be installed on the same machine as your reverse proxy. + +Clone the repository in your home dir and navigate to the Agent directory (git should be installed): + +```bash +cd ~ + +git clone https://github.com/MAKS-IT-COM/maksit-certs-ui-agent.git +cd maksit-certs-ui-agent/src/MaksIT.CertsUI.Agent +``` + +Edit `appsettings.json` configuration: + +```json +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + + "Configuration": { + "ApiKey": "", + "CertsPath": "" + } +} +``` + +**Note:** +- Replace `` with your shared API key. +- Replace `` with the path to your certificates directory (e.g., `/etc/haproxy/certs` or `/etc/nginx/certs`). + +```bash +cd ../Installers +``` + +To deploy the agent via script: + +```bash +sudo sh ./install.sh +``` + +This script will create the `maksit-certs-ui-agent` service and open port `5000` for communication. + +## MaksIT.CertsUI Agent uninstallation + +To uninstall the agent, run the following command: + +```bash +sudo sh ./uninstall.sh +``` + +--- + +## Contact + +For any inquiries or contributions, feel free to reach out: + +- **Email**: maksym.sadovnychyy@gmail.com +- **Author**: Maksym Sadovnychyy (MAKS-IT) diff --git a/src/Installers/install.sh b/src/Installers/install.sh new file mode 100644 index 0000000..076545d --- /dev/null +++ b/src/Installers/install.sh @@ -0,0 +1,196 @@ +#!/bin/bash + +# Variables +REQUIRED_DOTNET_SDK="10.0" + +SERVICE_NAME="maksit-certs-ui-agent" +SERVICE_PORT="5000" +SERVICE_FILE="/etc/systemd/system/$SERVICE_NAME.service" +INSTALL_DIR="/opt/$SERVICE_NAME" +DOTNET_EXEC="/usr/bin/dotnet" +EXEC_CMD="$DOTNET_EXEC $INSTALL_DIR/MaksIT.CertsUI.Agent.dll --urls \"http://*:$SERVICE_PORT\"" +APPSETTINGS_FILE="appsettings.json" +NO_NEW_KEY_FLAG="--no-new-key" +TMP_JSON_FILE="/tmp/tmp.$$.json" + +# Detect distro and version +if [ -f /etc/os-release ]; then + . /etc/os-release + DISTRO=$ID + VERSION_ID=$VERSION_ID +else + echo "Cannot detect Linux distribution." + exit 1 +fi + +# Helper: Check available SDKs and install +check_and_install_dotnet_sdk() { + local sdk_pkg + + case "$DISTRO" in + ubuntu|debian) + if ! dpkg -l | grep -q packages-microsoft-prod; then + wget -q https://packages.microsoft.com/config/$DISTRO/$VERSION_ID/packages-microsoft-prod.deb -O packages-microsoft-prod.deb + sudo dpkg -i packages-microsoft-prod.deb + sudo apt-get update + fi + + sdk_pkg="dotnet-sdk-$REQUIRED_DOTNET_SDK" + + if ! dpkg -l | grep -q "$sdk_pkg"; then + if ! apt-cache show "$sdk_pkg" > /dev/null 2>&1; then + echo "Required .NET SDK not available." + exit 1 + fi + sudo apt-get install -y "$sdk_pkg" + fi + ;; + + centos|rhel|fedora|almalinux|alma|rocky) + if [[ "$DISTRO" == "almalinux" ]]; then + MS_DISTRO="alma" + elif [[ "$DISTRO" == "rocky" ]]; then + MS_DISTRO="rocky" + else + MS_DISTRO="$DISTRO" + fi + + LOCAL_MAJOR="${VERSION_ID%%.*}" + REPO_INDEX_URL="https://packages.microsoft.com/config/$MS_DISTRO/" + + AVAILABLE_VERSIONS=$(curl -s "$REPO_INDEX_URL" | grep -oP '(?<=href=")[0-9][^/]*(?=/")' | sort -V) + if [ -z "$AVAILABLE_VERSIONS" ]; then + echo "ERROR: Cannot fetch repo index." + exit 1 + fi + + SELECTED_VERSION="" + for v in $AVAILABLE_VERSIONS; do + if [[ "$v" == "$LOCAL_MAJOR" ]]; then + SELECTED_VERSION="$v" + break + fi + if [[ "$v" -lt "$LOCAL_MAJOR" ]]; then + SELECTED_VERSION="$v" + fi + done + + if [ -z "$SELECTED_VERSION" ]; then + echo "No matching repo version found" + exit 1 + fi + + REPO_RPM_URL="$REPO_INDEX_URL$SELECTED_VERSION/packages-microsoft-prod.rpm" + + # Idempotent repo install + if ! rpm -q packages-microsoft-prod > /dev/null 2>&1; then + sudo rpm -Uvh --quiet "$REPO_RPM_URL" || { + echo "ERROR: Failed installing Microsoft repo" + exit 1 + } + else + echo "Microsoft repo already installed, skipping" + fi + + sudo dnf makecache + + sdk_pkg="dotnet-sdk-$REQUIRED_DOTNET_SDK" + + # Idempotent SDK install + if ! rpm -q "$sdk_pkg" > /dev/null 2>&1; then + if dnf list available "$sdk_pkg" > /dev/null 2>&1; then + sudo dnf install -y "$sdk_pkg" + else + echo "ERROR: .NET SDK $sdk_pkg not found and not installed" + exit 1 + fi + else + echo ".NET SDK already installed." + fi + ;; + + *) + echo "Unsupported distro: $DISTRO" + exit 1 + ;; + esac +} + +check_and_install_dotnet_sdk + +# Stop service if exists (idempotent) +if systemctl list-unit-files | grep -q "$SERVICE_NAME.service"; then + sudo systemctl stop "$SERVICE_NAME.service" || true + sudo systemctl disable "$SERVICE_NAME.service" || true +fi + +# Remove old systemd file (idempotent) +sudo rm -f "$SERVICE_FILE" + +# Recreate install dir +sudo rm -rf "$INSTALL_DIR" +sudo mkdir -p "$INSTALL_DIR" + +# Update API key +if [[ "$1" != "$NO_NEW_KEY_FLAG" ]]; then + if [ -f "$APPSETTINGS_FILE" ]; then + NEW_API_KEY=$(openssl rand -base64 32) + jq --arg newApiKey "$NEW_API_KEY" '.Configuration.ApiKey = $newApiKey' "$APPSETTINGS_FILE" > "$TMP_JSON_FILE" && mv "$TMP_JSON_FILE" "$APPSETTINGS_FILE" + fi +fi + +SCRIPT_DIR=$(dirname "$(realpath "$0")") +cd "$SCRIPT_DIR/.." || exit 1 + +if [ ! -f "MaksIT.CertsUI.Agent/MaksIT.CertsUI.Agent.csproj" ]; then + echo "Project missing" + exit 1 +fi + +sudo dotnet build MaksIT.CertsUI.Agent/MaksIT.CertsUI.Agent.csproj --configuration Release +sudo dotnet publish MaksIT.CertsUI.Agent/MaksIT.CertsUI.Agent.csproj -c Release -o "$INSTALL_DIR" + +# Systemd unit (idempotent) +sudo bash -c "cat > $SERVICE_FILE < /dev/null 2>&1; then + FIREWALL_SERVICE_XML="/etc/firewalld/services/$SERVICE_NAME.xml" + + if [ ! -f "$FIREWALL_SERVICE_XML" ]; then + echo ' + + MaksIT.CertsUI Agent + +' | sudo tee "$FIREWALL_SERVICE_XML" + fi + + sleep 10 + + sudo firewall-cmd --permanent --add-service=$SERVICE_NAME || true + sudo firewall-cmd --reload + +elif command -v ufw > /dev/null 2>&1; then + sudo ufw allow "$SERVICE_PORT"/tcp || true +fi diff --git a/src/Installers/uninstall.sh b/src/Installers/uninstall.sh new file mode 100644 index 0000000..57d5c16 --- /dev/null +++ b/src/Installers/uninstall.sh @@ -0,0 +1,54 @@ +#!/bin/bash + +# Variables +SERVICE_NAME="maksit-certs-ui-agent" +SERVICE_FILE="/etc/systemd/system/$SERVICE_NAME.service" +INSTALL_DIR="/opt/$SERVICE_NAME" +SERVICE_PORT="5000" +FIREWALL_XML="/etc/firewalld/services/maks-it-agent.xml" + +echo "Uninstalling $SERVICE_NAME ..." + +# Stop and disable the service if it exists +if systemctl list-unit-files | grep -q "$SERVICE_NAME.service"; then + echo "Stopping service..." + sudo systemctl stop "$SERVICE_NAME.service" || true + sudo systemctl disable "$SERVICE_NAME.service" || true +fi + +# Remove the systemd service file +if [ -f "$SERVICE_FILE" ]; then + echo "Removing systemd service file..." + sudo rm -f "$SERVICE_FILE" +fi + +# Reload systemd +echo "Reloading systemd..." +sudo systemctl daemon-reload + +# Remove installation directory +if [ -d "$INSTALL_DIR" ]; then + echo "Removing installation directory $INSTALL_DIR ..." + sudo rm -rf "$INSTALL_DIR" +fi + +# Remove firewalld rule and XML +if command -v firewall-cmd > /dev/null 2>&1; then + echo "Removing firewalld service rule..." + sudo firewall-cmd --permanent --remove-service=$SERVICE_NAME || true + + if [ -f "$FIREWALL_XML" ]; then + echo "Removing firewalld XML file..." + sudo rm -f "$FIREWALL_XML" + fi + + sudo firewall-cmd --reload || true +fi + +# Remove UFW rule if available +if command -v ufw > /dev/null 2>&1; then + echo "Removing UFW rule..." + sudo ufw delete allow "$SERVICE_PORT"/tcp || true +fi + +echo "Uninstall complete." diff --git a/src/MaksIT.CertsUI.Agent.sln b/src/MaksIT.CertsUI.Agent.sln new file mode 100644 index 0000000..5464f90 --- /dev/null +++ b/src/MaksIT.CertsUI.Agent.sln @@ -0,0 +1,43 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.31903.59 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MaksIT.CertsUI.Agent", "MaksIT.CertsUI.Agent\MaksIT.CertsUI.Agent.csproj", "{F7D5BDB4-25C7-688F-79F6-226D35BD9546}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Installers", "Installers", "{8EC462FD-D22E-90A8-E5CE-7E832BA40C5D}" + ProjectSection(SolutionItems) = preProject + Installers\install.sh = Installers\install.sh + Installers\uninstall.sh = Installers\uninstall.sh + EndProjectSection +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MaksIT.CertsUI.Models", "MaksIT.Models\MaksIT.CertsUI.Models.csproj", "{693902E3-A782-4842-A0A6-B451964DC7E3}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Documentation", "Documentation", "{02EA681E-C7D8-13C7-8484-4AC65E1B71E8}" + ProjectSection(SolutionItems) = preProject + ..\LICENSE.md = ..\LICENSE.md + ..\README.md = ..\README.md + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {F7D5BDB4-25C7-688F-79F6-226D35BD9546}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {F7D5BDB4-25C7-688F-79F6-226D35BD9546}.Debug|Any CPU.Build.0 = Debug|Any CPU + {F7D5BDB4-25C7-688F-79F6-226D35BD9546}.Release|Any CPU.ActiveCfg = Release|Any CPU + {F7D5BDB4-25C7-688F-79F6-226D35BD9546}.Release|Any CPU.Build.0 = Release|Any CPU + {693902E3-A782-4842-A0A6-B451964DC7E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {693902E3-A782-4842-A0A6-B451964DC7E3}.Debug|Any CPU.Build.0 = Debug|Any CPU + {693902E3-A782-4842-A0A6-B451964DC7E3}.Release|Any CPU.ActiveCfg = Release|Any CPU + {693902E3-A782-4842-A0A6-B451964DC7E3}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {B55147D5-7865-42A3-8979-3423AD562252} + EndGlobalSection +EndGlobal diff --git a/src/MaksIT.CertsUI.Agent/Agent.generated.sln b/src/MaksIT.CertsUI.Agent/Agent.generated.sln new file mode 100644 index 0000000..bc97ffd --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Agent.generated.sln @@ -0,0 +1,37 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.5.002.0 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Agent - Backup (1)", "Agent - Backup (1).csproj", "{392E9E34-E17C-4118-9C83-52AF52A56E54}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Agent - Backup", "Agent - Backup.csproj", "{18049E33-180E-41F1-8343-5BCD4755B2A8}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Agent", "Agent.csproj", "{2C1A9C83-0B26-450C-A874-0B8DBD251B0F}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {392E9E34-E17C-4118-9C83-52AF52A56E54}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {392E9E34-E17C-4118-9C83-52AF52A56E54}.Debug|Any CPU.Build.0 = Debug|Any CPU + {392E9E34-E17C-4118-9C83-52AF52A56E54}.Release|Any CPU.ActiveCfg = Release|Any CPU + {392E9E34-E17C-4118-9C83-52AF52A56E54}.Release|Any CPU.Build.0 = Release|Any CPU + {18049E33-180E-41F1-8343-5BCD4755B2A8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {18049E33-180E-41F1-8343-5BCD4755B2A8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {18049E33-180E-41F1-8343-5BCD4755B2A8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {18049E33-180E-41F1-8343-5BCD4755B2A8}.Release|Any CPU.Build.0 = Release|Any CPU + {2C1A9C83-0B26-450C-A874-0B8DBD251B0F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2C1A9C83-0B26-450C-A874-0B8DBD251B0F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2C1A9C83-0B26-450C-A874-0B8DBD251B0F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2C1A9C83-0B26-450C-A874-0B8DBD251B0F}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {281E7450-1EDC-4E77-B04F-C14F65273D90} + EndGlobalSection +EndGlobal diff --git a/src/MaksIT.CertsUI.Agent/AuthorizationFilters/ApiKeyAuthorizationFilter.cs b/src/MaksIT.CertsUI.Agent/AuthorizationFilters/ApiKeyAuthorizationFilter.cs new file mode 100644 index 0000000..c93c06b --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/AuthorizationFilters/ApiKeyAuthorizationFilter.cs @@ -0,0 +1,29 @@ +using Microsoft.AspNetCore.Mvc.Filters; +using Microsoft.AspNetCore.Mvc; +using Microsoft.Extensions.Options; + + +namespace MaksIT.CertsUI.Agent.AuthorizationFilters; + +public class ApiKeyAuthorizationFilter : IAuthorizationFilter { + + private readonly Configuration _appSettings; + + public ApiKeyAuthorizationFilter( + IOptions appSettings + ) { + _appSettings = appSettings.Value; + } + + public void OnAuthorization(AuthorizationFilterContext context) { + if (!context.HttpContext.Request.Headers.TryGetValue("X-API-KEY", out var extractedApiKey)) { + context.Result = new UnauthorizedResult(); + return; + } + + if (!_appSettings.ApiKey.Equals(extractedApiKey)) { + context.Result = new UnauthorizedResult(); + return; + } + } +} \ No newline at end of file diff --git a/src/MaksIT.CertsUI.Agent/Configuration.cs b/src/MaksIT.CertsUI.Agent/Configuration.cs new file mode 100644 index 0000000..416c0ee --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Configuration.cs @@ -0,0 +1,29 @@ +namespace MaksIT.CertsUI.Agent; + +public class Configuration { + + private string? _apiKey; + public string ApiKey { + get { + var env = Environment.GetEnvironmentVariable("MAKS-IT_AGENT_API_KEY"); + return env ?? _apiKey ?? string.Empty; + } + + set { + _apiKey = value; + } + + } + + private string? _certsPath; + public string CertsPath { + get { + var env = Environment.GetEnvironmentVariable("MAKS-IT_AGENT_CERTS_PATH"); + return env ?? _certsPath ?? string.Empty; + } + + set { + _certsPath = value; + } + } +} diff --git a/src/MaksIT.CertsUI.Agent/Controllers/CertsController.cs b/src/MaksIT.CertsUI.Agent/Controllers/CertsController.cs new file mode 100644 index 0000000..8d520ef --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Controllers/CertsController.cs @@ -0,0 +1,35 @@ +using Microsoft.AspNetCore.Mvc; +using Microsoft.Extensions.Options; +using MaksIT.CertsUI.Models.Requests; +using MaksIT.CertsUI.Agent.AuthorizationFilters; + + +namespace MaksIT.CertsUI.Agent.Controllers; + +[ApiController] +[Route("[controller]")] +[ServiceFilter(typeof(ApiKeyAuthorizationFilter))] +public class CertsController : ControllerBase { + + private readonly Configuration _appSettings; + private readonly ILogger _logger; + + public CertsController( + IOptions appSettings, + ILogger logger + ) { + _logger = logger; + _appSettings = appSettings.Value; + } + + [HttpPost("[action]")] + public IActionResult Upload([FromBody] CertsUploadRequest requestData) { + _logger.LogInformation("Uploading certificates"); + + foreach (var (fileName, fileContent) in requestData.Certs) { + System.IO.File.WriteAllText(Path.Combine(_appSettings.CertsPath, fileName), fileContent); + } + + return Ok("Certificates uploaded successfully"); + } +} diff --git a/src/MaksIT.CertsUI.Agent/Controllers/HelloWorldController.cs b/src/MaksIT.CertsUI.Agent/Controllers/HelloWorldController.cs new file mode 100644 index 0000000..f9bdcc1 --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Controllers/HelloWorldController.cs @@ -0,0 +1,16 @@ +using Microsoft.AspNetCore.Mvc; +using MaksIT.CertsUI.Agent.AuthorizationFilters; + + +namespace MaksIT.CertsUI.Agent.Controllers; + +[ApiController] +[Route("[controller]")] +[ServiceFilter(typeof(ApiKeyAuthorizationFilter))] +public class HelloWorldController : ControllerBase { + + [HttpGet] + public IActionResult Get() { + return Ok("Hello, World!"); + } +} diff --git a/src/MaksIT.CertsUI.Agent/Controllers/ServiceController.cs b/src/MaksIT.CertsUI.Agent/Controllers/ServiceController.cs new file mode 100644 index 0000000..ca3d0c3 --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Controllers/ServiceController.cs @@ -0,0 +1,56 @@ +using System.Diagnostics; +using Microsoft.AspNetCore.Mvc; +using Microsoft.Extensions.Options; +using MaksIT.CertsUI.Agent.AuthorizationFilters; +using MaksIT.CertsUI.Models.Requests; + + +namespace MaksIT.CertsUI.Agent.Controllers; + +[ApiController] +[Route("[controller]")] +[ServiceFilter(typeof(ApiKeyAuthorizationFilter))] +public class ServiceController : ControllerBase { + + private readonly Configuration _appSettings; + + public ServiceController( + IOptions appSettings + ) { + _appSettings = appSettings.Value; + } + + [HttpPost("[action]")] + public IActionResult Reload([FromBody] ServiceReloadRequest requestData) { + var serviceName = requestData.ServiceName; + + try { + var processStartInfo = new ProcessStartInfo { + FileName = "/bin/systemctl", + Arguments = $"reload {serviceName}", + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false, + CreateNoWindow = true + }; + + using (var process = new Process { StartInfo = processStartInfo }) { + process.Start(); + process.WaitForExit(); + + var output = process.StandardOutput.ReadToEnd(); + var error = process.StandardError.ReadToEnd(); + + if (process.ExitCode != 0) { + return StatusCode(500, $"Error reloading service: {error}"); + } + + return Ok($"Service {serviceName} reloaded successfully: {output}"); + } + } + catch (Exception ex) { + return StatusCode(500, $"Exception: {ex.Message}"); + } + } +} + diff --git a/src/MaksIT.CertsUI.Agent/MaksIT.CertsUI.Agent.csproj b/src/MaksIT.CertsUI.Agent/MaksIT.CertsUI.Agent.csproj new file mode 100644 index 0000000..e4668d8 --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/MaksIT.CertsUI.Agent.csproj @@ -0,0 +1,27 @@ + + + + net10.0 + enable + enable + $(MSBuildProjectName.Replace(" ", "_")) + Linux + README.md + LICENSE.md + + + + + + + + + + + + + + Never + + + diff --git a/src/MaksIT.CertsUI.Agent/Program.cs b/src/MaksIT.CertsUI.Agent/Program.cs new file mode 100644 index 0000000..930c306 --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Program.cs @@ -0,0 +1,37 @@ +using MaksIT.CertsUI.Agent; +using MaksIT.CertsUI.Agent.AuthorizationFilters; + +var builder = WebApplication.CreateBuilder(args); + +// Extract configuration +var configuration = builder.Configuration; + +// Configure strongly typed settings objects +var configurationSection = configuration.GetSection("Configuration"); +var appSettings = configurationSection.Get() ?? throw new ArgumentNullException(); + +// Allow configurations to be available through IOptions +builder.Services.Configure(configurationSection); + +// Add services to the container. + +builder.Services.AddControllers(); +// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle +builder.Services.AddEndpointsApiExplorer(); +builder.Services.AddSwaggerGen(); + +builder.Services.AddScoped(); + +var app = builder.Build(); + +// Configure the HTTP request pipeline. +if (app.Environment.IsDevelopment()) { + app.UseSwagger(); + app.UseSwaggerUI(); +} + +app.UseAuthorization(); + +app.MapControllers(); + +app.Run(); diff --git a/src/MaksIT.CertsUI.Agent/Properties/launchSettings.json b/src/MaksIT.CertsUI.Agent/Properties/launchSettings.json new file mode 100644 index 0000000..a6d5872 --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/Properties/launchSettings.json @@ -0,0 +1,40 @@ +{ + "profiles": { + "http": { + "commandName": "Project", + "launchBrowser": true, + "launchUrl": "swagger", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + }, + "dotnetRunMessages": true, + "applicationUrl": "http://localhost:5000" + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "launchUrl": "swagger", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "Container (Dockerfile)": { + "commandName": "Docker", + "launchBrowser": true, + "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}/swagger", + "environmentVariables": { + "ASPNETCORE_HTTP_PORTS": "5000" + }, + "publishAllPorts": true + } + }, + "$schema": "http://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:7748", + "sslPort": 0 + } + } +} \ No newline at end of file diff --git a/src/MaksIT.CertsUI.Agent/appsettings.Development.json b/src/MaksIT.CertsUI.Agent/appsettings.Development.json new file mode 100644 index 0000000..0c208ae --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/src/MaksIT.CertsUI.Agent/appsettings.json b/src/MaksIT.CertsUI.Agent/appsettings.json new file mode 100644 index 0000000..c2941ed --- /dev/null +++ b/src/MaksIT.CertsUI.Agent/appsettings.json @@ -0,0 +1,14 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + + "Configuration": { + "ApiKey": "UGnCaElLLJClHgUeet/yr7vNvPf13b1WkDJQMfsiP6I=", + "CertsPath": "/etc/haproxy/certs" + } +} \ No newline at end of file diff --git a/src/MaksIT.Models/MaksIT.CertsUI.Models.csproj b/src/MaksIT.Models/MaksIT.CertsUI.Models.csproj new file mode 100644 index 0000000..1103579 --- /dev/null +++ b/src/MaksIT.Models/MaksIT.CertsUI.Models.csproj @@ -0,0 +1,13 @@ + + + + net10.0 + enable + enable + + + + + + + diff --git a/src/MaksIT.Models/Requests/CertsUploadRequest.cs b/src/MaksIT.Models/Requests/CertsUploadRequest.cs new file mode 100644 index 0000000..01e2c07 --- /dev/null +++ b/src/MaksIT.Models/Requests/CertsUploadRequest.cs @@ -0,0 +1,8 @@ +using MaksIT.Core.Abstractions.Webapi; + + +namespace MaksIT.CertsUI.Models.Requests; + +public class CertsUploadRequest : RequestModelBase { + public Dictionary Certs { get; set; } +} diff --git a/src/MaksIT.Models/Requests/ServiceReloadRequest.cs b/src/MaksIT.Models/Requests/ServiceReloadRequest.cs new file mode 100644 index 0000000..e497b5b --- /dev/null +++ b/src/MaksIT.Models/Requests/ServiceReloadRequest.cs @@ -0,0 +1,9 @@ +using MaksIT.Core.Abstractions.Webapi; + + +namespace MaksIT.CertsUI.Models.Requests; + +public class ServiceReloadRequest : RequestModelBase { + public string ServiceName { get; set; } +} + diff --git a/src/MaksIT.Models/Responses/HelloWorldResponse.cs b/src/MaksIT.Models/Responses/HelloWorldResponse.cs new file mode 100644 index 0000000..5be5046 --- /dev/null +++ b/src/MaksIT.Models/Responses/HelloWorldResponse.cs @@ -0,0 +1,8 @@ +using MaksIT.Core.Abstractions.Webapi; + + +namespace MaksIT.CertsUI.Models.Responses; + +public class HelloWorldResponse : ResponseModelBase { + public string Message { get; set; } +} \ No newline at end of file