From: John Wolfe Date: Tue, 6 Oct 2020 21:30:54 +0000 (-0700) Subject: Adding the vgauthImport utility to open-vm-tools. X-Git-Tag: stable-11.3.0~306 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=66eb1b16e7cea8399c67d71eee45acd015e12a49;p=thirdparty%2Fopen-vm-tools.git Adding the vgauthImport utility to open-vm-tools. The vmware-alias-import utility is not currently packaged with the open-vm-tools bundle; this change adds the utility. It is built only if vgauth is enabled. --- diff --git a/open-vm-tools/Makefile.am b/open-vm-tools/Makefile.am index 3c72c39ac..a58c65db9 100644 --- a/open-vm-tools/Makefile.am +++ b/open-vm-tools/Makefile.am @@ -32,6 +32,7 @@ if BUILD_HGFSMOUNTER endif if ENABLE_VGAUTH SUBDIRS += vgauth + SUBDIRS += vgauthImport endif SUBDIRS += checkvm SUBDIRS += libguestlib diff --git a/open-vm-tools/configure.ac b/open-vm-tools/configure.ac index fe8f53747..192dc3676 100644 --- a/open-vm-tools/configure.ac +++ b/open-vm-tools/configure.ac @@ -1647,6 +1647,7 @@ AC_CONFIG_FILES([ \ rpctool/Makefile \ vgauth/Makefile \ vgauth/lib/Makefile \ + vgauthImport/Makefile \ namespacetool/Makefile \ vgauth/cli/Makefile \ vgauth/test/Makefile \ diff --git a/open-vm-tools/vgauthImport/COPYING b/open-vm-tools/vgauthImport/COPYING new file mode 100644 index 000000000..09f465ab7 --- /dev/null +++ b/open-vm-tools/vgauthImport/COPYING @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/open-vm-tools/vgauthImport/Makefile.am b/open-vm-tools/vgauthImport/Makefile.am new file mode 100644 index 000000000..5363327c3 --- /dev/null +++ b/open-vm-tools/vgauthImport/Makefile.am @@ -0,0 +1,48 @@ +################################################################################ +### Copyright (C) 2020 VMware, Inc. All rights reserved. +### +### This program is free software; you can redistribute it and/or modify +### it under the terms of version 2 of the GNU General Public License as +### published by the Free Software Foundation. +### +### 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, write to the Free Software +### Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +################################################################################ +bin_PROGRAMS = vmware-alias-import + +vmware_alias_import_LDADD = +vmware_alias_import_LDADD += @GLIB2_LIBS@ +vmware_alias_import_LDADD += ../lib/rpcOut/libRpcOut.la +vmware_alias_import_LDADD += ../lib/message/libMessage.la +vmware_alias_import_LDADD += ../lib/backdoor/libBackdoor.la +vmware_alias_import_LDADD += ../lib/dataMap/libDataMap.la +vmware_alias_import_LDADD += ../lib/hashMap/libHashMap.la +vmware_alias_import_LDADD += ../lib/err/libErr.la +vmware_alias_import_LDADD += ../lib/string/libString.la +vmware_alias_import_LDADD += ../lib/vmCheck/libVmCheck.la +vmware_alias_import_LDADD += ../lib/vmSignal/libVmSignal.la +vmware_alias_import_LDADD += ../lib/misc/libMisc.la +vmware_alias_import_LDADD += ../vgauth/lib/libvgauth.la +vmware_alias_import_LDADD += ../lib/stubs/libStubs.la + +vmware_alias_import_CPPFLAGS = +vmware_alias_import_CPPFLAGS += @GLIB2_CPPFLAGS@ +vmware_alias_import_CPPFLAGS += -DUSE_RPCI_ONLY +vmware_alias_import_CPPFLAGS += -I$(top_srcdir)/vgauth/public + +vmware_alias_import_rpcchandir = $(top_srcdir)/lib/rpcChannel + +vmware_alias_import_SOURCES = +vmware_alias_import_SOURCES += vgauthImport.c +vmware_alias_import_SOURCES += $(vmware_alias_import_rpcchandir)/bdoorChannel.c +vmware_alias_import_SOURCES += $(vmware_alias_import_rpcchandir)/rpcChannel.c +if HAVE_VSOCK +vmware_alias_import_SOURCES += $(vmware_alias_import_rpcchandir)/vsockChannel.c +vmware_alias_import_SOURCES += $(vmware_alias_import_rpcchandir)/simpleSocket.c +endif diff --git a/open-vm-tools/vgauthImport/vgauthImport.c b/open-vm-tools/vgauthImport/vgauthImport.c new file mode 100644 index 000000000..8f1c3e4ab --- /dev/null +++ b/open-vm-tools/vgauthImport/vgauthImport.c @@ -0,0 +1,568 @@ +/********************************************************* + * Copyright (C) 2012,2018-2020 VMware, Inc. All rights reserved. + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published + * by the Free Software Foundation version 2.1 and no 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 Lesser GNU General Public + * License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + *********************************************************/ + +/* + * vgauthImport.c -- + * + * Command line tool to import vgauth config data from the + * namespace DB and apply it to the running vgauth service. + */ + +#include +#include +#include + +#include "vmware.h" +#include "vmcheck.h" +#include "util.h" +#include "dynbuf.h" + +#include "VGAuthCommon.h" +#include "VGAuthError.h" +#include "VGAuthAuthentication.h" +#include "VGAuthAlias.h" +#include "vmware/tools/guestrpc.h" +#ifdef _WIN32 +#include "vmware/tools/win32util.h" +#endif + +#define VGAUTHIMPORT_APP_NAME "vgauthImport" + +#define NOT_VMWARE_ERROR "Failed sending message to VMware.\n" + +static Bool ProcessNamespace(char *namespace); + +#define NSDB_PRIV_GET_VALUES_CMD "namespace-priv-get-values" +#define NSDB_PRIV_SET_KEYS_CMD "namespace-priv-set-keys" + +/* + * The namspaceDB key names used. + */ + +/* + * These 5 are set by the solution on the vSphere side. + */ +#define KEY_NAME_CERT "certificate" +#define KEY_NAME_SUBJECT "subject" +#define KEY_NAME_COMMENT "comment" +#define KEY_NAME_USER "guestUsername" +#define KEY_NAME_ADDMAPPED "addMapped" + +/* + * This is set by this tool to allow the solution to know when + * the data was imported. + */ +#define KEY_NAME_IMPORTED "imported" + + +/* + * The underlying APIs will return values in the order they're + * queried. This structure simplifies deserializing the answers. + */ +typedef struct { + const char *keyName; + char *val; +} KeyNameValue; + +static KeyNameValue nameVals[] = { + { KEY_NAME_CERT, NULL}, + { KEY_NAME_SUBJECT, NULL}, + { KEY_NAME_COMMENT, NULL}, + { KEY_NAME_USER, NULL}, + { KEY_NAME_ADDMAPPED, NULL}, +}; + + +static gboolean verboseLogFlag = FALSE; +static gchar *gAppName = NULL; + +static const gchar *usageMsg = "namespaceID"; +static const gchar *summaryMsg = ""; + +/* + ****************************************************************************** + * PrintUsage -- */ /** + * + * Prints the usage mesage. + * + ****************************************************************************** + */ + +static void +PrintUsage(GOptionContext *optCtx) +{ + gchar *usage; + + usage = g_option_context_get_help(optCtx, TRUE, NULL); + g_printerr("%s", usage); + g_free(usage); +} + + +/* + ****************************************************************************** + * vgauthLog -- */ /** + * + * VGAuth error log handler. Catches any noise generated by VGAuth + * lib or glib underneath it. + * + * @param[in] logDomain The source domain of the error message. + * @param[in] loglevl The priority level of the error. + * @param[in] msg The error message. + * @param[in] userData Any user-supplied data. + * + ****************************************************************************** + */ + +static void +vgauthLog(const char *logDomain, + int loglevel, + const char *msg, + void *userData) +{ + /* + * Ignore debug and message levels. + */ + if (loglevel & + (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_WARNING)) { + fprintf(stderr, "VGAuth error: [%s] %s\n", logDomain, msg); + } +} + + +/* + ****************************************************************************** + * ProcessQueryReply -- */ /** + * + * Processes the return data from the namespace-get call. + * + * Parses the data coming back from the namespace-get-values call, and + * updates the VGAuth alias store with the information. + * + * @param[in] result The raw data. UTF-8 bytestream with embedded NULs. + * @param[in] ersultLen The length of the data. + * + * @return TRUE if successful, FALSE otherwise. + * + ****************************************************************************** + */ + +static Bool +ProcessQueryReply(char *result, + size_t resultLen) +{ + char *p = result; + VGAuthAliasInfo ai; + char *pemCert = NULL; + char *userName = NULL; + Bool addMapped = FALSE; + Bool status = TRUE; + VGAuthError vgErr; + VGAuthContext *ctx = NULL; + int i; + int numMapped = 0; + VGAuthMappedAlias *maList = NULL; + Bool alreadyExists = FALSE; + + ASSERT(result); + ai.subject.type = VGAUTH_SUBJECT_NAMED; + ai.comment = ""; + ai.subject.val.name = NULL; + + /* + * Deserialize the results. + */ + for (i = 0; i < ARRAYSIZE(nameVals); i++) { + nameVals[i].val = Util_SafeStrdup(p); + p += strlen(p) + 1; + ASSERT(p <= (result + resultLen)); + } + + /* + * Rename them so the VGAuth APIs have sane variable names. + */ + pemCert = nameVals[0].val; + ai.subject.val.name = nameVals[1].val; + ai.comment = nameVals[2].val; + userName = nameVals[3].val; + addMapped = (*(nameVals[4].val) == 't' || *(nameVals[4].val) == 'T'); + + if (verboseLogFlag) { + printf("Certficate: \n%s\n", pemCert); + printf("Subject: %s\n", ai.subject.val.name); + printf("Comment: %s\n", ai.comment); + printf("GuestUsername: %s\n", userName); + printf("AddMapped: %d\n", addMapped); + } + + + /* + * Verify we got at least the args we require. + */ + if ((NULL == userName) || (NULL == pemCert) || + (NULL == ai.subject.val.name)) { + fprintf(stderr, "Missing required keys\n"); + status = FALSE; + goto done; + } + + /* + * Clear out extra whitespace. + * + * XXX VGAuth will clean up any whitespace in the cert, so this + * is needed to properly match. May have to go to the full cert clean + * that vgauth uses (base64 decode, base64 encode), or compare + * the base64 decoded data. + */ + g_strstrip(pemCert); + + /* + * Now tell VGAuth. + */ + VGAuth_SetLogHandler(vgauthLog, NULL, 0, NULL); + vgErr = VGAuth_Init(VGAUTHIMPORT_APP_NAME, 0, NULL, &ctx); + if (VGAUTH_FAILED(vgErr)) { + fprintf(stderr, "Failed to init VGAuth context\n"); + status = FALSE; + goto done; + } + + /* + * Make sure we don't already have the entry. + * + * We only care for the addMapped case, since a duplicate mapped + * entry is an error. In the non-mapped case, a dup is a no-op. + */ + if (addMapped) { + vgErr = VGAuth_QueryMappedAliases(ctx, 0, NULL, + &numMapped, &maList); + for (i = 0; i < numMapped; i++) { + if ((strcmp(pemCert, maList[i].pemCert) == 0) && + (strcmp(userName, maList[i].userName) == 0)) { + int j; + + for (j = 0; j < maList[i].numSubjects; j++) { + if (maList[i].subjects[j].type != VGAUTH_SUBJECT_NAMED) { + continue; + } + if (strcmp(ai.subject.val.name, + maList[i].subjects[j].val.name) == 0) { + fprintf(stderr, + "Entry already exists; just updating 'import' timestamp\n"); + alreadyExists = TRUE; + } + } + } + } + } + + /* + * XXX + * + * Support a 'clobber' cmdline arg, that does a remove/add? + * Should only be useful for a comment tweak. + */ + + if (!alreadyExists) { + vgErr = VGAuth_AddAlias(ctx, userName, addMapped, + pemCert, &ai, 0, NULL); + if (VGAUTH_FAILED(vgErr)) { + fprintf(stderr, "Failed to set VGAuth data\n"); + status = FALSE; + goto done; + } + } else { + /* + * XXX + * + * Lets return success, so the timestamp still gets updated. + * May want to tie this to a cmdline flag. + */ + status = TRUE; + } + +done: + if (NULL != ctx) { + VGAuth_Shutdown(ctx); + } + for (i = 0; i < ARRAYSIZE(nameVals); i++) { + free(nameVals[i].val); + } + VGAuth_FreeMappedAliasList(numMapped, maList); + + return status; +} + + +/* + ****************************************************************************** + * SetImportTime -- */ /** + * + * Updates the namespace 'import' value with the current time. + * + * @param[in] namespace The namespace to be updated. + * + * @return TRUE if successful, FALSE otherwise. + * + ****************************************************************************** + */ + +static Bool +SetImportTime(char *namespace) +{ + char *curTimeStr; + Bool status; + DynBuf buf; + char *result = NULL; + size_t resultLen; + GTimeVal now; + + /* + * Use ISO timestamp to be VIM friendly. + */ + g_get_current_time(&now); + curTimeStr = g_time_val_to_iso8601(&now); + + DynBuf_Init(&buf); + + /* + * Format is: + * + * namespace-set-keys \0\0\0\0\0 + * + * We have just a single op, and want to always set the value, clobbering + * anything already there. + */ + if (!DynBuf_Append(&buf, NSDB_PRIV_SET_KEYS_CMD, + strlen(NSDB_PRIV_SET_KEYS_CMD)) || + !DynBuf_Append(&buf, " ", 1) || + !DynBuf_AppendString(&buf, namespace) || + !DynBuf_AppendString(&buf, "1") || // numOps + !DynBuf_AppendString(&buf, "0") || // op 0 == setAlways + !DynBuf_AppendString(&buf, KEY_NAME_IMPORTED) || + !DynBuf_AppendString(&buf, curTimeStr) || + !DynBuf_Append(&buf, "", 1)) { // NULL for set always + fprintf(stderr, "Could not construct update request buffer\n"); + status = FALSE; + } else { + status = RpcChannel_SendOneRaw(DynBuf_Get(&buf), + DynBuf_GetSize(&buf), + &result, &resultLen); + if (!status) { + fprintf(stderr, "Failed to update %s field after processing namespace '%s\n", + KEY_NAME_IMPORTED, namespace); + } + free(result); + } + g_free(curTimeStr); + DynBuf_Destroy(&buf); + + return status; +} + + +/* + ****************************************************************************** + * QueryNamespace -- */ /** + * + * Queries the namespace DB for the keys we want. + * + * @param[in] namespace The namespace name. + * @param[out] resultData The result data. + * @param[out] resultDataLen The length of the result data. + * + * @return TRUE if successful, FALSE otherwise. + * + ****************************************************************************** + */ + +static Bool +QueryNamespace(char *namespace, + char **resultData, + size_t *resultDataLen) +{ + char *result = NULL; + size_t resultLen; + DynBuf buf; + int i; + Bool status = FALSE; + + ASSERT(namespace); + + *resultData = NULL; + *resultDataLen = 0; + + DynBuf_Init(&buf); + + /* + * Format is + * + * namespace-get-values \0\0... + * + */ + if (!DynBuf_Append(&buf, NSDB_PRIV_GET_VALUES_CMD, + strlen(NSDB_PRIV_GET_VALUES_CMD)) || + !DynBuf_Append(&buf, " ", 1) || + !DynBuf_AppendString(&buf, namespace)) { + fprintf(stderr, "Could not contruct request buffer\n"); + goto done; + } + for (i = 0; i < ARRAYSIZE(nameVals); i++) { + if (!DynBuf_AppendString(&buf, nameVals[i].keyName)) { + fprintf(stderr, "Could not contruct request buffer\n"); + goto done; + } + } + + status = RpcChannel_SendOneRaw(DynBuf_Get(&buf), DynBuf_GetSize(&buf), + &result, &resultLen); + +done: + *resultData = result; + *resultDataLen = resultLen; + DynBuf_Destroy(&buf); + return status; +} + + +/* + ****************************************************************************** + * ProcessNamespace -- */ /** + * + * Processes the data in 'namespace'. Queries the namespace DB for + * the keys we want, sends them to VGAuth, and updates the namespace + * with a timestamp noting when the data was processed. + * + * @param[in] namespace The namespace name. + * + * @return TRUE if successful, FALSE otherwise. + * + ****************************************************************************** + */ + +static Bool +ProcessNamespace(char *namespace) +{ + char *result = NULL; + size_t resultLen = 0; + Bool status = FALSE; + + ASSERT(namespace); + + status = QueryNamespace(namespace, &result, &resultLen); + + if (!status) { + /* + * Underlying error message works just fine so use it. + */ + fprintf(stderr, "Error: %s\n", result ? result : "NULL"); + fprintf(stderr, "Failed to read namespace '%s'\n", namespace); + } else { + if (resultLen == 0) { + fprintf(stderr, "Error: No keys found in namespace '%s'\n", namespace); + } else { + status = ProcessQueryReply(result, resultLen); + + if (status ) { + status = SetImportTime(namespace); + } else { + fprintf(stderr, + "Failed to import vgauth record from namespace '%s'\n", + namespace); + } + } + } + + free(result); + + return status; +} + + +/* + ****************************************************************************** + * main -- */ /** + * + * Main entry point. + * + * @param[in] argc Number of args. + * @param[in] argv The args. + * + ****************************************************************************** + */ + +int +main(int argc, char *argv[]) +{ + int argcCopy; + char **argvCopy; + GError *gErr = NULL; + int success = -1; + const GOptionEntry options[] = { + { "verbose", 'v', 0, G_OPTION_ARG_NONE, &verboseLogFlag, + "Verbose logging mode", NULL }, + { NULL }, + }; + GOptionContext *optCtx; +#ifdef _WIN32 + WinUtil_EnableSafePathSearching(TRUE); +#endif + + /* + * The options parser needs to modify these, and using the variables + * coming into main doesn't work. + */ + argcCopy = argc; + argvCopy = argv; + + gAppName = g_path_get_basename(argv[0]); + + g_set_prgname(gAppName); + optCtx = g_option_context_new(usageMsg); + g_option_context_set_summary(optCtx, summaryMsg); + g_option_context_add_main_entries(optCtx, options, NULL); + + /* + * Check if environment is VM + */ + if (!VmCheck_IsVirtualWorld()) { + g_printerr("Error: %s must be run inside a virtual machine" + " on a VMware hypervisor product.\n", gAppName); + goto out; + } + + if (!g_option_context_parse(optCtx, &argcCopy, &argvCopy, &gErr)) { + fprintf(stderr, "%s: %s\n", gAppName, gErr->message); + g_error_free(gErr); + goto out; + } + + if (argc < 2) { + PrintUsage(optCtx); + goto out; + } + + success = ProcessNamespace(argv[1]) ? 0 : 1; + +out: + g_option_context_free(optCtx); + g_free(gAppName); + + return success; +} +