diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4840669..98d25e0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -82,3 +82,12 @@ jobs: DVLS_APP_SECRET: ${{ secrets.DVLS_APP_SECRET }} DVLS_SERVER_BASE_URL: ${{ secrets.DVLS_SERVER_BASE_URL }} DVLS_VAULT_ID: ${{ secrets.DVLS_VAULT_ID }} + + - name: Run lookup_plugins + run: ansible-playbook test_lookup_plugins.yml + working-directory: ansible/ansible_collections/devolutions/dvls/tests/integration + env: + DVLS_APP_KEY: ${{ secrets.DVLS_APP_KEY }} + DVLS_APP_SECRET: ${{ secrets.DVLS_APP_SECRET }} + DVLS_SERVER_BASE_URL: ${{ secrets.DVLS_SERVER_BASE_URL }} + DVLS_VAULT_ID: ${{ secrets.DVLS_VAULT_ID }} diff --git a/LICENSE-GPL-3.0 b/LICENSE-GPL-3.0 new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE-GPL-3.0 @@ -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 index cff9b92..9ee3e39 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ This Ansible module allows you to authenticate with DVLS and fetch server inform - Authenticate with DVLS using application identities. - Fetch server information, vault lists, or specific secrets. - Flexible support for static secrets or fetching all secrets in a vault. +- Lookup plugins for idiomatic inline credential retrieval in playbooks and templates. ## Requirements - Ansible 2.18 @@ -126,6 +127,91 @@ Example response } ``` +## Using Lookup Plugins + +The collection provides two lookup plugins for retrieving credentials directly in playbooks, templates, and variable assignments: + +### 1. `devolutions.dvls.secret` - Field-Specific Lookup + +Retrieve a single field from a credential: + +```yaml +- name: Simple password lookup (default field) + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'prod-database') }}" + +- name: Get username field + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'prod-database', field='username') }}" + +- name: Set variables from credentials + set_fact: + db_user: "{{ lookup('devolutions.dvls.secret', 'prod-db', field='username') }}" + db_pass: "{{ lookup('devolutions.dvls.secret', 'prod-db', field='password') }}" +``` + +### 2. `devolutions.dvls.secret_full` - Full Object Lookup + +Retrieve the complete credential object: + +```yaml +- name: Get full credential + set_fact: + db_cred: "{{ lookup('devolutions.dvls.secret_full', 'prod-database') }}" + +- name: Use multiple fields from credential + postgresql_db: + name: mydb + login_host: "{{ db_cred.domain }}" + login_user: "{{ db_cred.username }}" + login_password: "{{ db_cred.password }}" +``` + +### Configuration + +Lookup plugins use the same environment variables as the modules: + +```sh +export DVLS_SERVER_BASE_URL="https://example.yourcompany.com" +export DVLS_APP_KEY="your_app_key_here" +export DVLS_APP_SECRET="your_app_secret_here" +export DVLS_VAULT_ID="00000000-0000-0000-0000-000000000000" +``` + +You can also override these per-lookup: + +```yaml +- name: Get credential from specific server + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'my-cred', + server_base_url='https://dvls.example.com', + app_key='my-key', + app_secret='my-secret', + vault_id='vault-uuid', + field='password') }}" +``` + +### Supported Fields + +The `field` parameter in `devolutions.dvls.secret` supports: +- `username`, `password`, `domain` (Username/Password credentials) +- `connectionString` (Connection String) +- `apiId`, `apiKey` (API Key) +- `tenantId`, `clientId`, `clientSecret` (Azure Service Principal) +- `privateKeyData`, `publicKeyData`, `privateKeyPassPhrase` (SSH Key) + +### Lookup by Name or UUID + +Both plugins support lookup by credential name or UUID: + +```yaml +# By name +lookup('devolutions.dvls.secret', 'prod-database') + +# By UUID +lookup('devolutions.dvls.secret', '12345678-1234-1234-1234-123456789012') +``` + ## Secrets definition To access a particular field within a secret, you can use the format ```{{ secrets['name-or-id'].value }}```. Here's a breakdown of the available categories and their fields: diff --git a/galaxy.yml b/galaxy.yml index f1182ff..b745500 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,15 +1,17 @@ namespace: devolutions name: dvls -version: 1.2.4 +version: 1.3.0 readme: README.md authors: - Danny Bédard + - Dion Gionet Mallet description: > Ansible collection for interacting with Devolutions Server (DVLS). It provides modules for authentication, retrieving server information and vaults, and performing create, read and update operations on secrets. - Enables automation of common Devolutions Password Server tasks within Ansible workflows. + It includes lookup plugins for idiomatic inline credential retrieval in playbooks and templates. + It enables automation of common Devolutions Password Server tasks within Ansible workflows. license: - - MIT + - GPL-3.0-or-later tags: [dvls, secrets, devolutions, password] dependencies: {} repository: https://github.com/Devolutions/ansible-dvls diff --git a/plugins/lookup/secret.py b/plugins/lookup/secret.py new file mode 100644 index 0000000..c03ed8c --- /dev/null +++ b/plugins/lookup/secret.py @@ -0,0 +1,207 @@ +# GNU General Public License v3.0+ (see LICENSE-GPL-3.0 or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +DOCUMENTATION = r""" +--- +name: secret +author: Dion Gionet Mallet (@dion-gionet) +version_added: "1.3.0" +short_description: Retrieve a specific field from a DVLS credential +description: + - Fetches a single field value from a Devolutions Server (DVLS) credential entry. + - Supports lookup by credential name, path, or UUID. + - Credentials retrieved from specified vault using application authentication. +options: + _terms: + description: + - Credential identifier (name, path, or UUID) to retrieve. + - "Path format: 'folder\\\\subfolder\\\\credential-name'" + required: true + type: str + field: + description: + - Field name to extract from credential. + - Supported fields depend on credential type. + - "Common fields include: username, password, domain, connectionString," + - "apiId, apiKey, tenantId, clientId, clientSecret, privateKeyData," + - "publicKeyData, privateKeyPassPhrase." + type: str + default: password + server_base_url: + description: + - DVLS server base URL. + - Falls back to DVLS_SERVER_BASE_URL environment variable if not provided. + type: str + required: false + app_key: + description: + - Application key for authentication. + - Falls back to DVLS_APP_KEY environment variable if not provided. + type: str + required: false + app_secret: + description: + - Application secret for authentication. + - Falls back to DVLS_APP_SECRET environment variable if not provided. + type: str + required: false + vault_id: + description: + - Vault UUID containing the credential. + - Falls back to DVLS_VAULT_ID environment variable if not provided. + type: str + required: false +notes: + - Requires network access to DVLS server. + - Authentication token is cached for the duration of the playbook run. +""" + +EXAMPLES = r""" +# Retrieve password field (default) +- name: Get database password + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'prod-database') }}" + +# Retrieve specific field +- name: Get database username + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'prod-database', field='username') }}" + +# Lookup by path +- name: Get credential by full path + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'Production\\\\Database\\\\prod-db') }}" + +# Lookup by path with specific field +- name: Get username from path-specified credential + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'Production\\\\Database\\\\prod-db', field='username') }}" + +# Lookup by UUID +- name: Get API key by ID + debug: + msg: "{{ lookup('devolutions.dvls.secret', '12345678-1234-1234-1234-123456789012', field='apiKey') }}" + +# Use in variable assignment +- name: Set database credentials + set_fact: + db_user: "{{ lookup('devolutions.dvls.secret', 'prod-db', field='username') }}" + db_pass: "{{ lookup('devolutions.dvls.secret', 'prod-db', field='password') }}" + +# Use path to avoid name conflicts +- name: Get specific credential when multiple have same name + set_fact: + staging_pass: "{{ lookup('devolutions.dvls.secret', 'Staging\\\\Database\\\\api-db', field='password') }}" + prod_pass: "{{ lookup('devolutions.dvls.secret', 'Production\\\\Database\\\\api-db', field='password') }}" + +# Override server configuration +- name: Get credential from specific server + debug: + msg: "{{ lookup('devolutions.dvls.secret', 'my-cred', + server_base_url='https://dvls.example.com', + app_key='my-key', + app_secret='my-secret', + vault_id='vault-uuid', + field='password') }}" + +# Use in template +- name: Configure database connection + template: + src: database.conf.j2 + dest: /etc/database.conf + vars: + db_password: "{{ lookup('devolutions.dvls.secret', 'prod-db') }}" +""" + +RETURN = r""" +_raw: + description: The requested field value from the credential. + type: list + elements: str +""" + +from ansible.errors import AnsibleError +from ansible.plugins.lookup import LookupBase +from ansible.utils.display import Display + +try: + from ansible_collections.devolutions.dvls.plugins.module_utils.lookup_base import ( + DVLSLookupHelper, + SUPPORTED_CREDENTIAL_FIELDS, + ) +except ImportError as e: + raise AnsibleError(f"Failed to import DVLS module_utils: {e}") + +display = Display() + + +class LookupModule(LookupBase): + """Lookup plugin to retrieve a specific field from a DVLS credential.""" + + def __init__(self, *args, **kwargs): + super(LookupModule, self).__init__(*args, **kwargs) + self._helper = DVLSLookupHelper(display, AnsibleError) + + def run(self, terms, variables=None, **kwargs): + """ + Main lookup execution method. + + Handles authentication, credential retrieval, and result transformation. + """ + self.set_options(var_options=variables, direct=kwargs) + + config = self._helper.get_config(self.get_option, variables) + self._helper.authenticate( + config["server_base_url"], config["app_key"], config["app_secret"] + ) + + results = [] + for term in terms: + try: + credential = self._helper.get_credential( + config["server_base_url"], config["vault_id"], term + ) + result = self._transform_result(credential, term) + results.append(result) + + except AnsibleError: + raise + except Exception as e: + raise AnsibleError( + f"Failed to retrieve credential '{term}': {e}" + ) from e + + return results + + def _transform_result(self, credential, term): + """ + Extract a specific field from the credential. + + Args: + credential: Complete credential object from DVLS + term: Original lookup term + + Returns: + str: The requested field value + """ + field = self.get_option("field") or "password" + + if field not in SUPPORTED_CREDENTIAL_FIELDS: + raise AnsibleError( + f"Invalid field '{field}'. " + f"Supported fields: {', '.join(sorted(SUPPORTED_CREDENTIAL_FIELDS))}" + ) + + field_value = credential.get(field) + if field_value is None: + raise AnsibleError( + f"Field '{field}' not found in credential '{term}'. " + f"Available fields: {', '.join(credential.keys())}" + ) + + display.vvv(f"Successfully retrieved field '{field}' from '{term}'") + return field_value diff --git a/plugins/lookup/secret_full.py b/plugins/lookup/secret_full.py new file mode 100644 index 0000000..b3e4500 --- /dev/null +++ b/plugins/lookup/secret_full.py @@ -0,0 +1,177 @@ +# GNU General Public License v3.0+ (see LICENSE-GPL-3.0 or https://www.gnu.org/licenses/gpl-3.0.txt) +# SPDX-License-Identifier: GPL-3.0-or-later + +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +DOCUMENTATION = r""" +--- +name: secret_full +author: Dion Gionet Mallet (@dion-gionet) +version_added: "1.3.0" +short_description: Retrieve complete DVLS credential object +description: + - Fetches entire credential object from Devolutions Server (DVLS). + - Returns same structure as fetch_secrets module. + - Supports lookup by credential name, path, or UUID. + - Useful when multiple fields from the same credential are needed. +options: + _terms: + description: + - Credential identifier (name, path, or UUID) to retrieve. + - "Path format: 'folder\\\\subfolder\\\\credential-name'" + required: true + type: str + server_base_url: + description: + - DVLS server base URL. + - Falls back to DVLS_SERVER_BASE_URL environment variable if not provided. + type: str + required: false + app_key: + description: + - Application key for authentication. + - Falls back to DVLS_APP_KEY environment variable if not provided. + type: str + required: false + app_secret: + description: + - Application secret for authentication. + - Falls back to DVLS_APP_SECRET environment variable if not provided. + type: str + required: false + vault_id: + description: + - Vault UUID containing the credential. + - Falls back to DVLS_VAULT_ID environment variable if not provided. + type: str + required: false +notes: + - Requires network access to DVLS server. + - Authentication token is cached for the duration of the playbook run. + - Returns the complete credential object with all available fields. +""" + +EXAMPLES = r""" +# Retrieve full credential object by name +- name: Get complete database credential + debug: + msg: "{{ lookup('devolutions.dvls.secret_full', 'prod-database') }}" + +# Retrieve full credential object by path +- name: Get credential by full path + debug: + msg: "{{ lookup('devolutions.dvls.secret_full', 'Production\\\\Database\\\\prod-db') }}" + +# Use multiple fields from credential +- name: Configure database connection + set_fact: + db_cred: "{{ lookup('devolutions.dvls.secret_full', 'prod-db') }}" + +- name: Connect to database + postgresql_db: + name: mydb + login_host: "{{ db_cred.domain }}" + login_user: "{{ db_cred.username }}" + login_password: "{{ db_cred.password }}" + +# Azure Service Principal example with path +- name: Get Azure credentials from specific environment + set_fact: + azure_sp: "{{ lookup('devolutions.dvls.secret_full', 'Production\\\\Azure\\\\service-principal') }}" + +- name: Use Azure credentials + debug: + msg: "Tenant: {{ azure_sp.tenantId }}, Client: {{ azure_sp.clientId }}" + +# SSH Key example +- name: Get SSH credentials + set_fact: + ssh_cred: "{{ lookup('devolutions.dvls.secret_full', 'server-ssh-key') }}" + +- name: Use SSH key + ansible.builtin.copy: + content: "{{ ssh_cred.privateKeyData }}" + dest: ~/.ssh/id_rsa + mode: '0600' + +# API Key example with path to avoid name conflicts +- name: Get specific API credentials + set_fact: + staging_api: "{{ lookup('devolutions.dvls.secret_full', 'Staging\\\\APIs\\\\external-api') }}" + prod_api: "{{ lookup('devolutions.dvls.secret_full', 'Production\\\\APIs\\\\external-api') }}" + +- name: Call staging API + uri: + url: "https://staging-api.example.com/endpoint" + headers: + X-API-ID: "{{ staging_api.apiId }}" + X-API-KEY: "{{ staging_api.apiKey }}" + +- name: Call production API + uri: + url: "https://api.example.com/endpoint" + headers: + X-API-ID: "{{ prod_api.apiId }}" + X-API-KEY: "{{ prod_api.apiKey }}" +""" + +RETURN = r""" +_raw: + description: Complete credential object with all fields. + type: list + elements: dict +""" + +from ansible.errors import AnsibleError +from ansible.plugins.lookup import LookupBase +from ansible.utils.display import Display + +try: + from ansible_collections.devolutions.dvls.plugins.module_utils.lookup_base import ( + DVLSLookupHelper, + ) +except ImportError as e: + raise AnsibleError(f"Failed to import DVLS module_utils: {e}") + +display = Display() + + +class LookupModule(LookupBase): + """Lookup plugin to retrieve complete DVLS credential objects.""" + + def __init__(self, *args, **kwargs): + super(LookupModule, self).__init__(*args, **kwargs) + self._helper = DVLSLookupHelper(display, AnsibleError) + + def run(self, terms, variables=None, **kwargs): + """ + Main lookup execution method. + + Handles authentication, credential retrieval, and result transformation. + """ + self.set_options(var_options=variables, direct=kwargs) + + config = self._helper.get_config(self.get_option, variables) + self._helper.authenticate( + config["server_base_url"], config["app_key"], config["app_secret"] + ) + + results = [] + for term in terms: + try: + credential = self._helper.get_credential( + config["server_base_url"], config["vault_id"], term + ) + display.vvv(f"Successfully retrieved credential '{term}'") + results.append(credential) + + except AnsibleError: + raise + except Exception as e: + raise AnsibleError( + f"Failed to retrieve credential '{term}': {e}" + ) from e + + return results diff --git a/plugins/module_utils/lookup_base.py b/plugins/module_utils/lookup_base.py new file mode 100644 index 0000000..5dab86d --- /dev/null +++ b/plugins/module_utils/lookup_base.py @@ -0,0 +1,191 @@ +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + +import atexit +import os +import re + +try: + from ansible_collections.devolutions.dvls.plugins.module_utils.auth import ( + login, + logout, + ) + from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import ( + get_vault_entry, + get_vault_entry_from_name, + get_vault_entry_from_path, + validate_unique_entry, + ) +except ImportError: + # Will be caught by lookup plugins + pass + +UUID_PATTERN = re.compile( + r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + re.IGNORECASE, +) + +SUPPORTED_CREDENTIAL_FIELDS = { + "username", + "password", + "domain", + "connectionString", + "apiId", + "apiKey", + "tenantId", + "clientId", + "clientSecret", + "privateKeyData", + "publicKeyData", + "privateKeyPassPhrase", +} + +_token_cache = {} +_cleanup_registered = False +_display = None + + +class DVLSLookupHelper: + """Helper class for DVLS lookup plugins with shared authentication and retrieval logic.""" + + def __init__(self, display_instance, ansible_error_class): + """ + Initialize the helper. + + Args: + display_instance: Display instance for logging + ansible_error_class: AnsibleError class for raising exceptions + """ + global _display + self._display = display_instance + self._ansible_error = ansible_error_class + _display = display_instance + + @staticmethod + def _cleanup_tokens(): + """Cleanup method called at interpreter exit to logout all cached tokens""" + for server_url, token in _token_cache.items(): + try: + logout(server_url, token) + except (ConnectionError, TimeoutError, OSError): + pass + except Exception as e: + _display.warning(f"Failed to logout from {server_url}: {e}") + _token_cache.clear() + + def _is_uuid(self, value): + """Check if a string matches UUID format""" + return UUID_PATTERN.match(value) is not None + + def get_config(self, get_option, variables): + """Extract configuration from options and environment variables""" + server_base_url = get_option("server_base_url") or os.environ.get( + "DVLS_SERVER_BASE_URL" + ) + app_key = get_option("app_key") or os.environ.get("DVLS_APP_KEY") + app_secret = get_option("app_secret") or os.environ.get("DVLS_APP_SECRET") + vault_id = get_option("vault_id") or os.environ.get("DVLS_VAULT_ID") + + if not all([server_base_url, app_key, app_secret, vault_id]): + raise self._ansible_error( + "Missing required configuration. Set DVLS_SERVER_BASE_URL, DVLS_APP_KEY, " + "DVLS_APP_SECRET, and DVLS_VAULT_ID environment variables or pass as parameters." + ) + + return { + "server_base_url": server_base_url, + "app_key": app_key, + "app_secret": app_secret, + "vault_id": vault_id, + } + + def authenticate(self, server_base_url, app_key, app_secret): + """Authenticate to DVLS and cache the token at module level""" + global _cleanup_registered + + if server_base_url not in _token_cache: + try: + self._display.vvv(f"Authenticating to DVLS at {server_base_url}") + token = login(server_base_url, app_key, app_secret) + _token_cache[server_base_url] = token + + if not _cleanup_registered: + atexit.register(DVLSLookupHelper._cleanup_tokens) + _cleanup_registered = True + except Exception as e: + raise self._ansible_error(f"DVLS authentication failed: {e}") from e + else: + self._display.vvv(f"Using cached token for {server_base_url}") + + def get_credential(self, server_base_url, vault_id, term): + """ + Retrieve a credential from DVLS by name, path, or UUID. + + Args: + server_base_url: DVLS server base URL + vault_id: Vault UUID + term: Credential identifier (name, path, or UUID) + + Returns: + dict: Complete credential object + """ + self._display.vvv(f"Looking up credential: {term}") + token = _token_cache.get(server_base_url) + if not token: + raise self._ansible_error( + f"Authentication token not found for server '{server_base_url}'. " + "Ensure authenticate() was called first." + ) + + if self._is_uuid(term): + self._display.vvv(f"Using ID lookup for {term}") + response = get_vault_entry(server_base_url, token, vault_id, term) + credential = response.get("data", {}) + elif "\\" in term: + self._display.vvv(f"Using path lookup for {term}") + response = get_vault_entry_from_path( + server_base_url, token, vault_id, term + ) + entries = response.get("data", []) + if not entries: + raise self._ansible_error( + f"Credential at path '{term}' not found in vault {vault_id}" + ) + validate_unique_entry(entries, f"path '{term}'") + entry_id = entries[0].get("id") + if not entry_id: + raise self._ansible_error( + f"Entry at path '{term}' is missing required 'id' field" + ) + full_response = get_vault_entry( + server_base_url, token, vault_id, entry_id + ) + credential = full_response.get("data", {}) + else: + self._display.vvv(f"Using name lookup for {term}") + response = get_vault_entry_from_name( + server_base_url, token, vault_id, term + ) + entries = response.get("data", []) + if not entries: + raise self._ansible_error( + f"Credential '{term}' not found in vault {vault_id}" + ) + validate_unique_entry(entries, f"name '{term}'") + entry_id = entries[0].get("id") + if not entry_id: + raise self._ansible_error( + f"Entry for '{term}' is missing required 'id' field" + ) + full_response = get_vault_entry( + server_base_url, token, vault_id, entry_id + ) + credential = full_response.get("data", {}) + + if not credential: + raise self._ansible_error( + f"Credential '{term}' returned empty data from vault {vault_id}" + ) + + return credential diff --git a/plugins/module_utils/vaults.py b/plugins/module_utils/vaults.py index 779deca..0ed84a6 100644 --- a/plugins/module_utils/vaults.py +++ b/plugins/module_utils/vaults.py @@ -10,6 +10,58 @@ REQUESTS_LIBRARY_IMPORT_ERROR = None +def filter_folders(data, exact_match_field=None, exact_match_value=None): + """Filter out folder entries from vault data and optionally filter for exact matches. + + Args: + data: Either a list of entries or a dict with a 'data' key containing entries + exact_match_field: Optional field name to match exactly (case insensitive) + exact_match_value: Optional value to match exactly (case insensitive) + + Returns: + Filtered data in the same format as input (list or dict) + """ + + def should_include(entry): + if entry.get("subType") == "Folder": + return False + + if exact_match_field is not None and exact_match_value is not None: + entry_value = entry.get(exact_match_field, "") + if isinstance(entry_value, str) and isinstance(exact_match_value, str): + return entry_value.lower() == exact_match_value.lower() + else: + return entry_value == exact_match_value + + return True + + if isinstance(data, dict) and "data" in data: + entries = data.get("data", []) + data["data"] = [entry for entry in entries if should_include(entry)] + return data + elif isinstance(data, list): + return [entry for entry in data if should_include(entry)] + return data + + +def validate_unique_entry(entries, filter_description): + """Validate that only one entry exists in the list. + + Args: + entries: List of entries to validate + filter_description: Description of the filter used (e.g., "name 'my-secret'") + + Raises: + ValueError: If multiple entries are found + """ + if len(entries) > 1: + raise ValueError( + f"Multiple entries found with {filter_description}. " + f"Found {len(entries)} entries. Please use a more specific filter " + f"or specify the entry by ID instead." + ) + + def get_vaults(server_base_url, token): vaults_url = f"{server_base_url}/api/v1/vault" vaults_headers = {"Content-Type": "application/json", "tokenId": token} @@ -50,7 +102,16 @@ def get_vault_entry_from_name(server_base_url, token, vault_id, entry_name): ) response.raise_for_status() - return response.json() + result = response.json() + + result = filter_folders( + result, exact_match_field="name", exact_match_value=entry_name + ) + + if isinstance(result, dict) and "data" in result: + validate_unique_entry(result.get("data", []), f"name '{entry_name}'") + + return result except Exception as e: raise Exception(f"An error occurred while getting a vault entry: {e}") @@ -65,7 +126,8 @@ def get_vault_entry_from_tag(server_base_url, token, vault_id, entry_tag): ) response.raise_for_status() - return response.json() + result = response.json() + return filter_folders(result) except Exception as e: raise Exception(f"An error occurred while getting a vault entry: {e}") @@ -80,7 +142,11 @@ def get_vault_entry_from_path(server_base_url, token, vault_id, entry_path): ) response.raise_for_status() - return response.json() + result = response.json() + return filter_folders( + result, exact_match_field="path", exact_match_value=entry_path + ) + except Exception as e: raise Exception(f"An error occurred while getting a vault entry: {e}") @@ -95,7 +161,11 @@ def get_vault_entry_from_type(server_base_url, token, vault_id, entry_type): ) response.raise_for_status() - return response.json() + result = response.json() + return filter_folders( + result, exact_match_field="type", exact_match_value=entry_type + ) + except Exception as e: raise Exception(f"An error occurred while getting a vault entry: {e}") @@ -106,8 +176,6 @@ def get_vault_entries(server_base_url, token, vault_id): all_entries = [] page = 1 - response = requests - try: while True: response = requests.get( @@ -123,7 +191,7 @@ def get_vault_entries(server_base_url, token, vault_id): if not entries: break - all_entries.extend(entries) + all_entries.extend(filter_folders(entries)) if page >= json_data.get("totalPage", 0): break @@ -136,7 +204,14 @@ def get_vault_entries(server_base_url, token, vault_id): def find_entry_by_name(entries, name, path=""): - for entry in entries: - if entry.get("name") == name and entry.get("path") == path: - return entry - return None + non_folder_entries = filter_folders(entries) + + matching_entries = [ + entry + for entry in non_folder_entries + if entry.get("name") == name and entry.get("path") == path + ] + + validate_unique_entry(matching_entries, f"name '{name}' and path '{path}'") + + return matching_entries[0] if matching_entries else None diff --git a/plugins/modules/create_secret.py b/plugins/modules/create_secret.py index 67f7f6e..bad9806 100644 --- a/plugins/modules/create_secret.py +++ b/plugins/modules/create_secret.py @@ -1,5 +1,9 @@ #!/usr/bin/python +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + DOCUMENTATION = r""" --- module: create_secret diff --git a/plugins/modules/fetch_secrets.py b/plugins/modules/fetch_secrets.py index 0f1ee33..a90ed6a 100644 --- a/plugins/modules/fetch_secrets.py +++ b/plugins/modules/fetch_secrets.py @@ -1,5 +1,9 @@ #!/usr/bin/python +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + DOCUMENTATION = r""" --- module: fetch_secrets diff --git a/plugins/modules/fetch_server.py b/plugins/modules/fetch_server.py index 6c64995..4444ed0 100644 --- a/plugins/modules/fetch_server.py +++ b/plugins/modules/fetch_server.py @@ -1,5 +1,9 @@ #!/usr/bin/python +from __future__ import absolute_import, division, print_function + +__metaclass__ = type + DOCUMENTATION = r""" --- module: fetch_server diff --git a/tests/debug/vscode/debug_create_secrets.py b/tests/debug/vscode/debug_create_secrets.py index 38d7e47..66f495f 100644 --- a/tests/debug/vscode/debug_create_secrets.py +++ b/tests/debug/vscode/debug_create_secrets.py @@ -12,10 +12,7 @@ "app_key": os.getenv("DVLS_APP_KEY"), "app_secret": os.getenv("DVLS_APP_SECRET"), "vault_id": os.getenv("DVLS_VAULT_ID"), - "secret": { - "secret_name": "test", - "value": "test" - } + "secret": {"secret_name": "test", "value": "test"}, } } @@ -25,4 +22,5 @@ # Import and run your module from ansible_collections.devolutions.dvls.plugins.modules import create_secret + create_secret.main() diff --git a/tests/debug/vscode/debug_fetch_secrets.py b/tests/debug/vscode/debug_fetch_secrets.py index ea0eac7..1edf429 100644 --- a/tests/debug/vscode/debug_fetch_secrets.py +++ b/tests/debug/vscode/debug_fetch_secrets.py @@ -21,4 +21,5 @@ # Import and run your module from ansible_collections.devolutions.dvls.plugins.modules import fetch_secrets + fetch_secrets.main() diff --git a/tests/debug/vscode/debug_fetch_server.py b/tests/debug/vscode/debug_fetch_server.py index cd2843c..5d05a85 100644 --- a/tests/debug/vscode/debug_fetch_server.py +++ b/tests/debug/vscode/debug_fetch_server.py @@ -10,7 +10,7 @@ "ANSIBLE_MODULE_ARGS": { "server_base_url": os.getenv("DVLS_SERVER_BASE_URL"), "app_key": os.getenv("DVLS_APP_KEY"), - "app_secret": os.getenv("DVLS_APP_SECRET") + "app_secret": os.getenv("DVLS_APP_SECRET"), } } @@ -20,4 +20,5 @@ # Import and run your module from ansible_collections.devolutions.dvls.plugins.modules import fetch_server + fetch_server.main() diff --git a/tests/integration/test_lookup_plugins.yml b/tests/integration/test_lookup_plugins.yml new file mode 100644 index 0000000..46c72e4 --- /dev/null +++ b/tests/integration/test_lookup_plugins.yml @@ -0,0 +1,319 @@ +--- +- name: Test DVLS Lookup Plugins + hosts: localhost + vars: + # Test credential that should exist in the DVLS test instance + test_credential_name: "lookup-plugin" + test_credential_id: "8f586548-7688-4981-8d56-09509ab68101" + test_credential_path: "tests\\lookup-plugin" + tasks: + # ======================================== + # Tests for devolutions.dvls.secret plugin + # ======================================== + + - name: Test secret lookup - password field (default) + block: + - name: Lookup password field by name + set_fact: + password_value: "{{ lookup('devolutions.dvls.secret', test_credential_name) }}" + + - name: Print full credential object for inspection + ansible.builtin.debug: + var: lookup('devolutions.dvls.secret_full', test_credential_name) + + - name: Verify password was retrieved + ansible.builtin.assert: + that: + - password_value is defined + - password_value | length > 0 + fail_msg: "Failed to retrieve password field" + success_msg: "Successfully retrieved password field" + + - name: Test secret lookup - username field + block: + - name: Lookup username field by name + set_fact: + username_value: "{{ lookup('devolutions.dvls.secret', test_credential_name, field='username') }}" + + - name: Verify username was retrieved + ansible.builtin.assert: + that: + - username_value is defined + - username_value | length > 0 + fail_msg: "Failed to retrieve username field" + success_msg: "Successfully retrieved username field" + + - name: Test secret lookup - by UUID + block: + - name: Lookup password by UUID + set_fact: + password_by_id: "{{ lookup('devolutions.dvls.secret', test_credential_id) }}" + + - name: Verify password was retrieved by UUID + ansible.builtin.assert: + that: + - password_by_id is defined + - password_by_id | length > 0 + fail_msg: "Failed to retrieve password by UUID" + success_msg: "Successfully retrieved password by UUID" + + - name: Verify UUID and name lookups return the same password + ansible.builtin.assert: + that: + - password_value == password_by_id + fail_msg: "Password retrieved by UUID doesn't match password retrieved by name" + success_msg: "UUID and name lookups return identical passwords" + + - name: Test secret lookup - by path + block: + - name: Lookup password by path + set_fact: + password_by_path: "{{ lookup('devolutions.dvls.secret', test_credential_path) }}" + + - name: Verify password was retrieved by path + ansible.builtin.assert: + that: + - password_by_path is defined + - password_by_path | length > 0 + fail_msg: "Failed to retrieve password by path" + success_msg: "Successfully retrieved password by path" + + - name: Verify path and name lookups return the same password + ansible.builtin.assert: + that: + - password_value == password_by_path + fail_msg: "Password retrieved by path doesn't match password retrieved by name" + success_msg: "Path and name lookups return identical passwords" + + - name: Test secret lookup - by path with specific field + block: + - name: Lookup username by path + set_fact: + username_by_path: "{{ lookup('devolutions.dvls.secret', test_credential_path, field='username') }}" + + - name: Verify username was retrieved by path + ansible.builtin.assert: + that: + - username_by_path is defined + - username_by_path | length > 0 + fail_msg: "Failed to retrieve username by path" + success_msg: "Successfully retrieved username by path" + + - name: Verify path and name lookups return the same username + ansible.builtin.assert: + that: + - username_value == username_by_path + fail_msg: "Username retrieved by path doesn't match username retrieved by name" + success_msg: "Path and name lookups return identical usernames for specific field" + + - name: Test secret lookup - domain field + block: + - name: Lookup domain field + set_fact: + domain_value: "{{ lookup('devolutions.dvls.secret', test_credential_name, field='domain') }}" + ignore_errors: true + register: domain_result + + - name: Show domain value (may be empty) + ansible.builtin.debug: + msg: "Domain: {{ domain_value | default('not set') }}" + + - name: Verify domain field behavior + ansible.builtin.assert: + that: + - (domain_result is succeeded and domain_value is defined) or domain_result is failed + fail_msg: "Domain field lookup produced unexpected result" + success_msg: "Domain field lookup behaved as expected (field may or may not exist on credential)" + + - name: Test secret lookup - multiple credentials at once + block: + - name: Fetch username and password in one task + set_fact: + db_username: "{{ lookup('devolutions.dvls.secret', test_credential_name, field='username') }}" + db_password: "{{ lookup('devolutions.dvls.secret', test_credential_name, field='password') }}" + + - name: Verify both values retrieved + ansible.builtin.assert: + that: + - db_username is defined + - db_password is defined + fail_msg: "Failed to retrieve multiple fields" + success_msg: "Successfully retrieved multiple fields" + + - name: Test secret lookup - error handling (invalid field) + block: + - name: Try to lookup invalid field + set_fact: + invalid_field: "{{ lookup('devolutions.dvls.secret', test_credential_name, field='nonexistent_field') }}" + ignore_errors: true + register: invalid_field_result + + - name: Verify error was raised + ansible.builtin.assert: + that: + - invalid_field_result is failed + fail_msg: "Should have failed with invalid field" + success_msg: "Correctly failed with invalid field" + + # ======================================== + # Tests for devolutions.dvls.secret_full plugin + # ======================================== + + - name: Test secret_full lookup - by name + block: + - name: Lookup full credential object by name + set_fact: + full_cred: "{{ lookup('devolutions.dvls.secret_full', test_credential_name) }}" + + - name: Verify full credential object was retrieved + ansible.builtin.assert: + that: + - full_cred is defined + - full_cred is mapping + - full_cred.username is defined or full_cred.password is defined + fail_msg: "Failed to retrieve full credential object" + success_msg: "Successfully retrieved full credential object" + + - name: Display full credential (masked) + ansible.builtin.debug: + msg: + - "Username: {{ full_cred.username | default('N/A') }}" + - "Domain: {{ full_cred.domain | default('N/A') }}" + - "Password: ***MASKED***" + + - name: Test secret_full lookup - by UUID + block: + - name: Lookup full credential object by UUID + set_fact: + full_cred_by_id: "{{ lookup('devolutions.dvls.secret_full', test_credential_id) }}" + + - name: Verify full credential object was retrieved by UUID + ansible.builtin.assert: + that: + - full_cred_by_id is defined + - full_cred_by_id is mapping + fail_msg: "Failed to retrieve full credential by UUID" + success_msg: "Successfully retrieved full credential by UUID" + + - name: Test secret_full lookup - by path + block: + - name: Lookup full credential object by path + set_fact: + full_cred_by_path: "{{ lookup('devolutions.dvls.secret_full', test_credential_path) }}" + + - name: Verify full credential object was retrieved by path + ansible.builtin.assert: + that: + - full_cred_by_path is defined + - full_cred_by_path is mapping + - full_cred_by_path.username is defined or full_cred_by_path.password is defined + fail_msg: "Failed to retrieve full credential by path" + success_msg: "Successfully retrieved full credential by path" + + - name: Verify path and name lookups return the same credential + ansible.builtin.assert: + that: + - full_cred.username == full_cred_by_path.username + - full_cred.password == full_cred_by_path.password + fail_msg: "Credential retrieved by path doesn't match credential retrieved by name" + success_msg: "Path and name lookups return identical credentials" + + - name: Test secret_full lookup - accessing multiple fields + block: + - name: Get credential and use multiple fields + set_fact: + cred: "{{ lookup('devolutions.dvls.secret_full', test_credential_name) }}" + + - name: Use fields from credential + ansible.builtin.debug: + msg: + - "Configuring connection with:" + - " Username: {{ cred.username | default('N/A') }}" + - " Domain: {{ cred.domain | default('N/A') }}" + + - name: Verify we can access multiple fields + ansible.builtin.assert: + that: + - cred.username is defined or cred.password is defined + fail_msg: "Could not access credential fields" + success_msg: "Successfully accessed multiple fields" + + - name: Test secret_full lookup - error handling (invalid credential) + block: + - name: Try to lookup non-existent credential + set_fact: + nonexistent: "{{ lookup('devolutions.dvls.secret_full', 'this-credential-does-not-exist-12345') }}" + ignore_errors: true + register: nonexistent_result + + - name: Verify error was raised + ansible.builtin.assert: + that: + - nonexistent_result is failed + fail_msg: "Should have failed with non-existent credential" + success_msg: "Correctly failed with non-existent credential" + + # ======================================== + # Comparison tests + # ======================================== + + - name: Compare secret vs secret_full + block: + - name: Get password using secret plugin + set_fact: + password_field: "{{ lookup('devolutions.dvls.secret', test_credential_name, field='password') }}" + + - name: Get full object using secret_full plugin + set_fact: + full_object: "{{ lookup('devolutions.dvls.secret_full', test_credential_name) }}" + + - name: Verify both return the same password + ansible.builtin.assert: + that: + - password_field == full_object.password + fail_msg: "Password from secret and secret_full don't match" + success_msg: "Password values match between plugins" + + - name: Compare name vs UUID vs path lookups + block: + - name: Fetch password using all three methods + set_fact: + pwd_by_name: "{{ lookup('devolutions.dvls.secret', test_credential_name) }}" + pwd_by_uuid: "{{ lookup('devolutions.dvls.secret', test_credential_id) }}" + pwd_by_path: "{{ lookup('devolutions.dvls.secret', test_credential_path) }}" + + - name: Verify all three methods return the same password + ansible.builtin.assert: + that: + - pwd_by_name == pwd_by_uuid + - pwd_by_name == pwd_by_path + - pwd_by_uuid == pwd_by_path + fail_msg: "Passwords from different lookup methods don't match" + success_msg: "All three lookup methods (name, UUID, path) return identical results" + + - name: Fetch full objects using all three methods + set_fact: + obj_by_name: "{{ lookup('devolutions.dvls.secret_full', test_credential_name) }}" + obj_by_uuid: "{{ lookup('devolutions.dvls.secret_full', test_credential_id) }}" + obj_by_path: "{{ lookup('devolutions.dvls.secret_full', test_credential_path) }}" + + - name: Verify all three methods return the same credential object + ansible.builtin.assert: + that: + - obj_by_name.username == obj_by_uuid.username + - obj_by_name.username == obj_by_path.username + - obj_by_name.password == obj_by_uuid.password + - obj_by_name.password == obj_by_path.password + fail_msg: "Credential objects from different lookup methods don't match" + success_msg: "All three lookup methods return identical credential objects" + + - name: Summary + ansible.builtin.debug: + msg: + - "==========================================" + - "All lookup plugin tests completed!" + - "==========================================" + - "secret plugin: Retrieves specific fields" + - "secret_full plugin: Retrieves complete objects" + - "Lookup methods tested: name, UUID, and path" + - "All plugins and lookup methods tested successfully!"