From 5cac23de1963880d8fb3aed4be47ec2894cf520c Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Fri, 25 Apr 2014 14:09:02 +0100 Subject: [PATCH] Add miniexpect library. --- .gitignore | 32 ++++ COPYING.LIB | 502 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile.am | 50 ++++++ README | 27 +++ configure.ac | 52 ++++++ example-sshpass.c | 211 +++++++++++++++++++++++ miniexpect.c | 346 +++++++++++++++++++++++++++++++++++++ miniexpect.h | 151 ++++++++++++++++ test-spawn.c | 46 +++++ tests.h | 42 +++++ 10 files changed, 1459 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING.LIB create mode 100644 Makefile.am create mode 100644 README create mode 100644 configure.ac create mode 100644 example-sshpass.c create mode 100644 miniexpect.c create mode 100644 miniexpect.h create mode 100644 test-spawn.c create mode 100644 tests.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..60d02d0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +*~ +*.la +*.lo +*.log +*.o +*.trs + +/.deps/ +/.gdb_history +/.libs/ +/Makefile +/Makefile.in +/aclocal.m4 +/autom4te.cache/ +/compile +/config.guess +/config.h +/config.h.in +/config.log +/config.status +/config.sub +/configure +/depcomp +/example-sshpass +/install-sh +/libtool +/ltmain.sh +/m4/ +/missing +/stamp-h1 +/test-driver +/test-spawn diff --git a/COPYING.LIB b/COPYING.LIB new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/COPYING.LIB @@ -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/Makefile.am b/Makefile.am new file mode 100644 index 0000000..80e4053 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,50 @@ +# miniexpect +# Copyright (C) 2014 Red Hat Inc. +# +# 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 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 + +ACLOCAL_AMFLAGS = -I m4 + +EXTRA_DIST = + +# The library. + +lib_LTLIBRARIES = libminiexpect.la + +libminiexpect_la_SOURCES = miniexpect.c miniexpect.h +libminiexpect_la_CFLAGS = $(PCRE_CFLAGS) -Wall +libminiexpect_la_LIBADD = $(PCRE_LIBS) +libminiexpect_la_LDFLAGS = -version-info 0:0:0 + +# Examples. + +noinst_PROGRAMS = example-sshpass + +example_sshpass_SOURCES = example-sshpass.c +example_sshpass_CFLAGS = $(PCRE_CFLAGS) -Wall +example_sshpass_LDADD = libminiexpect.la + +# Tests. + +TESTS = $(check_PROGRAMS) +check_PROGRAMS = test-spawn + +test_spawn_SOURCES = test-spawn.c +test_spawn_CFLAGS = $(PCRE_CFLAGS) -Wall +test_spawn_LDADD = libminiexpect.la + +# Clean. + +CLEANFILES = *~ diff --git a/README b/README new file mode 100644 index 0000000..f739940 --- /dev/null +++ b/README @@ -0,0 +1,27 @@ +miniexpect is a very simple expect-like library for C. + +It has a saner interface than libexpect, and doesn't depend on Tcl. +It is also thread safe, const-correct and uses modern C standards. + +It is standalone, except that it requires the PCRE (Perl Compatible +Regular Expressions) library from http://www.pcre.org/. The PCRE +dependency is fundamental because we want to offer the most powerful +regular expression syntax to match on, but more importantly because +PCRE has a convenient way to detect partial matches which made this +library very simple to implement. + +License +------- + +The library was written by Richard W.M. Jones +and is licensed under the Library GPL (LGPL) version 2 or above. + +Source is available from: http://git.annexia.org/?p=miniexpect.git;a=summary + +Using the library +----------------- + +The API is described in miniexpect.h. + +To understand how to use the API, take a look at the examples and +tests in the source directory. diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..4edc425 --- /dev/null +++ b/configure.ac @@ -0,0 +1,52 @@ +# miniexpect +# Copyright (C) 2014 Red Hat Inc. +# +# 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 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 + +AC_INIT([miniexpect],[1.0]) + +AM_INIT_AUTOMAKE(foreign) dnl NB: Do not [quote] this parameter. + +m4_ifndef([AM_SILENT_RULES], [m4_define([AM_SILENT_RULES],[])]) +AM_SILENT_RULES([yes]) # make --enable-silent-rules the default. + +AC_CONFIG_MACRO_DIR([m4]) + +AM_PROG_LIBTOOL + +dnl Check for basic C environment. +AC_PROG_CC_STDC +AC_PROG_INSTALL +AC_PROG_CPP + +AC_C_PROTOTYPES +test "x$U" != "x" && AC_MSG_ERROR([Compiler not ANSI compliant]) + +AM_PROG_CC_C_O + +dnl Enable system extensions (_GNU_SOURCE etc). +AC_USE_SYSTEM_EXTENSIONS + +dnl Check support for 64 bit file offsets. +AC_SYS_LARGEFILE + +dnl The only dependency is libpcre (Perl Compatible Regular Expressions). +PKG_CHECK_MODULES([PCRE], [libpcre]) + +dnl Produce output files. +AC_CONFIG_HEADERS([config.h]) + +AC_CONFIG_FILES([Makefile]) +AC_OUTPUT diff --git a/example-sshpass.c b/example-sshpass.c new file mode 100644 index 0000000..a35c1d4 --- /dev/null +++ b/example-sshpass.c @@ -0,0 +1,211 @@ +/* miniexpect example. + * Copyright (C) 2014 Red Hat Inc. + * + * 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 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 + */ + +/* There is a program called 'sshpass' which does roughly the same + * as this simplified example. We run ssh as a subprocess, and log + * in using the given password from the command line. + * + * The first argument is the password to send at the password prompt. + * The remaining arguments are passed to the ssh subprocess. + * + * For example: + * sshpass 123456 ssh remote.example.com + * sshpass 123456 ssh -l root remote.example.com + */ + +#include + +#include +#include +#include +#include +#include + +#include + +#include "miniexpect.h" + +static pcre * +compile_re (const char *rex) +{ + const char *errptr; + int erroffset; + pcre *ret; + + ret = pcre_compile (rex, 0, &errptr, &erroffset, NULL); + if (ret == NULL) { + fprintf (stderr, "error: failed to compile regular expression '%s': %s at offset %d\n", + rex, errptr, erroffset); + exit (EXIT_FAILURE); + } + return ret; +} + +int +main (int argc, char *argv[]) +{ + mexp_h *h; + const char *password; + int status; + pcre *password_re, *prompt_re, *hello_re; + const int ovecsize = 12; + int ovector[ovecsize]; + int pcre_err; + + if (argc <= 3) { + fprintf (stderr, "usage: sshpass PASSWORD ssh [SSH-ARGS...] HOST\n"); + exit (EXIT_FAILURE); + } + + password = argv[1]; + + printf ("starting ssh command ...\n"); + + h = mexp_spawnv ("ssh", &argv[2]); + if (h == NULL) { + perror ("mexp_spawnv: ssh"); + exit (EXIT_FAILURE); + } + + /* Wait for the password prompt. */ + password_re = compile_re ("assword"); + switch (mexp_expect (h, password_re, NULL, 0, ovector, ovecsize, &pcre_err)) { + case MEXP_EOF: + fprintf (stderr, "error: ssh closed the connection unexpectedly\n"); + goto error; + case MEXP_ERROR: + perror ("mexp_expect"); + goto error; + case MEXP_TIMEOUT: + fprintf (stderr, "error: timeout before reaching the password prompt\n"); + goto error; + case MEXP_PCRE_ERROR: + fprintf (stderr, "error: PCRE error: %d\n", pcre_err); + goto error; + case MEXP_MATCHED: + break; + } + + /* Got the password prompt, so send a password. */ + printf ("sending the password ...\n"); + + if (mexp_printf (h, "%s\n", password) == -1) { + perror ("mexp_printf"); + goto error; + } + + /* We have to wait for the prompt before we can send commands + * (because the ssh connection may not be fully established). If we + * get "password" again, then probably the password was wrong. This + * expect checks all these possibilities. Unfortunately since all + * prompts are a little bit different, we have to guess here. + */ + prompt_re = compile_re ("(assword)|([#$])"); + switch (mexp_expect (h, prompt_re, NULL, 0, ovector, ovecsize, &pcre_err)) { + case MEXP_EOF: + fprintf (stderr, "error: ssh closed the connection unexpectedly\n"); + goto error; + case MEXP_ERROR: + perror ("mexp_expect"); + goto error; + case MEXP_TIMEOUT: + fprintf (stderr, "error: timeout before reaching the prompt\n"); + goto error; + case MEXP_PCRE_ERROR: + fprintf (stderr, "error: PCRE error: %d\n", pcre_err); + goto error; + case MEXP_MATCHED: + /* Which part of the regexp matched? */ + if (ovector[2] >= 0) { /* password */ + fprintf (stderr, "error: ssh asked for password again, probably the password supplied is wrong\n"); + goto error; + } + else if (ovector[4] >= 0) { /* prompt */ + break; + } + else + abort (); /* shouldn't happen */ + } + + /* Send a command which will have expected output. */ + printf ("sending a test command ...\n"); + + if (mexp_printf (h, "echo h''ello\n") == -1) { + perror ("mexp_printf"); + goto error; + } + + /* Wait for expected output from echo hello command. */ + hello_re = compile_re ("hello"); + switch (mexp_expect (h, hello_re, NULL, 0, ovector, ovecsize, &pcre_err)) { + case MEXP_EOF: + fprintf (stderr, "error: ssh closed the connection unexpectedly\n"); + goto error; + case MEXP_ERROR: + perror ("mexp_expect"); + goto error; + case MEXP_TIMEOUT: + fprintf (stderr, "error: timeout before reading command output\n"); + goto error; + case MEXP_PCRE_ERROR: + fprintf (stderr, "error: PCRE error: %d\n", pcre_err); + goto error; + case MEXP_MATCHED: + break; + } + + /* Send exit command and wait for ssh to exit. */ + printf ("sending the exit command ...\n"); + + if (mexp_printf (h, "exit\n") == -1) { + perror ("mexp_printf"); + goto error; + } + + switch (mexp_expect (h, NULL, NULL, 0, NULL, 0, NULL)) { + case MEXP_EOF: + /* This is what we're expecting: ssh will close the connection. */ + break; + case MEXP_ERROR: + perror ("mexp_expect"); + goto error; + case MEXP_TIMEOUT: + fprintf (stderr, "error: timeout before ssh closed the connection\n"); + goto error; + case MEXP_PCRE_ERROR: + case MEXP_MATCHED: + fprintf (stderr, "error: unexpected return value from mexp_expect\n"); + goto error; + } + + /* Close the ssh connection. */ + status = mexp_close (h); + if (status != 0) { + fprintf (stderr, "error: bad exit status from ssh subprocess (status=%d)\n", + status); + exit (EXIT_FAILURE); + } + + printf ("test was successful\n"); + + exit (EXIT_SUCCESS); + + error: + mexp_close (h); + exit (EXIT_FAILURE); +} diff --git a/miniexpect.c b/miniexpect.c new file mode 100644 index 0000000..f525b68 --- /dev/null +++ b/miniexpect.c @@ -0,0 +1,346 @@ +/* miniexpect + * Copyright (C) 2014 Red Hat Inc. + * + * 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 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 + */ + +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "miniexpect.h" + +#define DEBUG 0 + +static mexp_h * +create_handle (void) +{ + mexp_h *h = malloc (sizeof *h); + if (h == NULL) + return NULL; + + /* Initialize the fields to default values. */ + h->fd = -1; + h->pid = 0; + h->timeout = 60000; + h->read_size = 1024; + h->buffer = NULL; + h->len = h->alloc = 0; + h->user1 = h->user2 = h->user3 = NULL; + + return h; +} + +static void +clear_buffer (mexp_h *h) +{ + free (h->buffer); + h->buffer = NULL; + h->alloc = h->len = 0; +} + +int +mexp_close (mexp_h *h) +{ + int status = 0; + + free (h->buffer); + + if (h->fd >= 0) + close (h->fd); + if (h->pid > 0) { + if (waitpid (h->pid, &status, 0) == -1) + return -1; + } + + return status; +} + +mexp_h * +mexp_spawnl (const char *file, const char *arg, ...) +{ + char **argv, **new_argv; + size_t i; + va_list args; + mexp_h *h; + + argv = malloc (sizeof (char *)); + if (argv == NULL) + return NULL; + argv[0] = (char *) arg; + + va_start (args, arg); + for (i = 1; arg != NULL; ++i) { + arg = va_arg (args, const char *); + new_argv = realloc (argv, sizeof (char *) * (i+1)); + if (new_argv == NULL) { + free (argv); + return NULL; + } + argv = new_argv; + argv[i] = (char *) arg; + } + + h = mexp_spawnv (file, argv); + free (argv); + return h; +} + +mexp_h * +mexp_spawnv (const char *file, char **argv) +{ + mexp_h *h; + int fd = -1; + int err; + char slave[1024]; + pid_t pid = 0; + + fd = posix_openpt (O_RDWR|O_NOCTTY); + if (fd == -1) + goto error; + + if (grantpt (fd) == -1) + goto error; + + if (unlockpt (fd) == -1) + goto error; + + /* Get the slave pty name now, but don't open it in the parent. */ + if (ptsname_r (fd, slave, sizeof slave) != 0) + goto error; + + /* Create the handle last before we fork. */ + h = create_handle (); + if (h == NULL) + goto error; + + pid = fork (); + if (pid == -1) + goto error; + + if (pid == 0) { /* Child. */ + struct termios terminal_settings; + int slave_fd; + + setsid (); + + /* Open the slave side of the pty. We must do this in the child + * after setsid so it becomes our controlling tty. + */ + slave_fd = open (slave, O_RDWR); + if (slave_fd == -1) + goto error; + + /* Set raw mode. */ + tcgetattr (slave_fd, &terminal_settings); + cfmakeraw (&terminal_settings); + tcsetattr (slave_fd, TCSANOW, &terminal_settings); + + /* Set up stdin, stdout, stderr to point to the pty. */ + dup2 (slave_fd, 0); + dup2 (slave_fd, 1); + dup2 (slave_fd, 2); + close (slave_fd); + + /* Close the master side of the pty - do this late to avoid a + * kernel bug, see sshpass source code. + */ + close (fd); + + /* Run the subprocess. */ + execvp (file, argv); + perror (file); + _exit (EXIT_FAILURE); + } + + /* Parent. */ + + h->fd = fd; + h->pid = pid; + return h; + + error: + err = errno; + if (fd >= 0) + close (fd); + if (pid > 0) + waitpid (pid, NULL, 0); + errno = err; + return NULL; +} + +enum mexp_status +mexp_expect (mexp_h *h, const pcre *code, + const pcre_extra *extra, + int options, int *ovector, int ovecsize, + int *pcre_ret) +{ + time_t start_t, now_t; + int timeout; + struct pollfd pfds[1]; + int r; + ssize_t rs; + + time (&start_t); + + options |= PCRE_PARTIAL_SOFT; + + /* Clear the read buffer. */ + clear_buffer (h); + + for (;;) { + /* If we've got a timeout then work out how many seconds are left. + * Timeout == 0 is not particularly well-defined, but it probably + * means "return immediately if there's no data to be read". + */ + if (h->timeout >= 0) { + time (&now_t); + timeout = h->timeout - ((now_t - start_t) * 1000); + if (timeout < 0) + timeout = 0; + } + else + timeout = 0; + + pfds[0].fd = h->fd; + pfds[0].events = POLLIN; + pfds[0].revents = 0; + r = poll (pfds, 1, timeout); +#if DEBUG + fprintf (stderr, "DEBUG: poll returned %d\n", r); +#endif + if (r == -1) + return MEXP_ERROR; + + if (r == 0) + return MEXP_TIMEOUT; + + /* Otherwise we expect there is something to read from the file + * descriptor. + */ + if (h->alloc - h->len <= h->read_size) { + char *new_buffer; + /* +1 here allows us to store \0 after the data read */ + new_buffer = realloc (h->buffer, h->alloc + h->read_size + 1); + if (new_buffer == NULL) + return MEXP_ERROR; + h->buffer = new_buffer; + h->alloc += h->read_size; + } + rs = read (h->fd, h->buffer + h->len, h->read_size); +#if DEBUG + fprintf (stderr, "DEBUG: read returned %zd\n", rs); +#endif + if (rs == -1) { + /* Annoyingly on Linux (I'm fairly sure this is a bug) if the + * writer closes the connection, the entire pty is destroyed, + * and read returns -1 / EIO. Handle that special case here. + */ + if (errno == EIO) + return MEXP_EOF; + return MEXP_ERROR; + } + if (rs == 0) + return MEXP_EOF; + + /* We read something. */ + h->len += rs; + h->buffer[h->len] = '\0'; +#if DEBUG + fprintf (stderr, "DEBUG: read %zd bytes from pty\n", rs); + fprintf (stderr, "DEBUG: buffer content: %s\n", h->buffer); +#endif + + /* See if there is a full or partial match against the regular expression. */ + if (code) { + assert (h->buffer != NULL); + r = pcre_exec (code, extra, h->buffer, (int)h->len, 0, + options, ovector, ovecsize); + if (pcre_ret) + *pcre_ret = r; + + if (r >= 0) { + /* A full match. */ + return MEXP_MATCHED; + } + + else if (r == PCRE_ERROR_NOMATCH) { + /* No match at all, so we can dump the input buffer. */ + clear_buffer (h); + } + + else if (r == PCRE_ERROR_PARTIAL) { + /* Partial match. Keep the buffer and keep reading. */ + /* (nothing here) */ + } + + else { + /* An actual PCRE error. */ + return MEXP_PCRE_ERROR; + } + } /* if (code) */ + } +} + +int +mexp_printf (mexp_h *h, const char *fs, ...) +{ + va_list args; + char *msg; + int len; + size_t n; + ssize_t r; + char *p; + + va_start (args, fs); + len = vasprintf (&msg, fs, args); + va_end (args); + + if (len < 0) + return -1; + +#if DEBUG + fprintf (stderr, "DEBUG: writing: %s\n", msg); +#endif + + n = len; + p = msg; + while (n > 0) { + r = write (h->fd, p, n); + if (r == -1) { + free (msg); + return -1; + } + n -= r; + p += r; + } + + free (msg); + return len; +} diff --git a/miniexpect.h b/miniexpect.h new file mode 100644 index 0000000..8392ca5 --- /dev/null +++ b/miniexpect.h @@ -0,0 +1,151 @@ +/* miniexpect + * Copyright (C) 2014 Red Hat Inc. + * + * 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 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 + */ + +#ifndef MINIEXPECT_H_ +#define MINIEXPECT_H_ + +#include + +#include + +/* This handle is created per subprocess that is spawned. */ +struct mexp_h { + int fd; /* File descriptor pointing to pty. */ + pid_t pid; /* Subprocess PID. */ + + /* Timeout (milliseconds, 1/1000th seconds). The caller may set + * this before calling mexp_expect. Set it to -1 to mean no + * timeout. The default is 60000 (= 60 seconds). + */ + int timeout; + + /* The read buffer is allocated by the library when mexp_expect is + * called. It is available so you can examine the buffer to see + * what part of the regexp matched. Note this buffer does not + * contain the full input from the process, but it will contain at + * least the part matched by the regular expression (and maybe some + * more). + */ + char *buffer; /* Read buffer. */ + size_t len; /* Length of data in the buffer. */ + size_t alloc; /* Allocated size of the buffer. */ + + /* The caller may set this to set the size (in bytes) for reads from + * the subprocess. The default is 1024. + */ + size_t read_size; + + /* Opaque pointers for use of the caller. The library will not + * touch these. + */ + void *user1; + void *user2; + void *user3; +}; +typedef struct mexp_h mexp_h; + +/* Spawn a subprocess. + * + * If successful it returns a handle. If it fails, it returns NULL + * and sets errno. + */ +extern mexp_h *mexp_spawnv (const char *file, char **argv); + +/* Same as mexp_spawnv, but it uses a NULL-terminated variable length + * list of arguments. + */ +extern mexp_h *mexp_spawnl (const char *file, const char *arg, ...); + +/* Close the handle and clean up the subprocess. + * + * This returns: + * 0: successful close, subprocess exited cleanly. + * -1: error in system call, see errno. + * > 0: exit status of subprocess if it didn't exit cleanly. Use + * WIFEXITED, WEXITSTATUS, WIFSIGNALED, WTERMSIG etc macros to + * examine this. + * + * Notes: + * + * - Even in the error cases, the handle is always closed and + * freed by this call. + * + * - It is normal for the kernel to send SIGHUP to the subprocess. + * If the subprocess doesn't catch the SIGHUP, then it will die + * (WIFSIGNALED (status) && WTERMSIG (status) == SIGHUP). This + * case should not necessarily be considered an error. + */ +extern int mexp_close (mexp_h *h); + +enum mexp_status { + MEXP_EOF = 0, + MEXP_ERROR = 1, + MEXP_TIMEOUT = 2, + MEXP_MATCHED = 3, + MEXP_PCRE_ERROR = 4, +}; + +/* Expect some output from the subprocess. Match the output against + * the PCRE regular expression. + * + * 'code', 'extra', 'options', 'ovector' and 'ovecsize' are passed + * through to the pcre_exec function. See pcreapi(3). + * + * If you want to match multiple strings, you have to combine them + * into a single regexp, eg. "([Pp]assword)|([Ll]ogin)|([Ff]ailed)". + * Then examine ovector[2], ovector[4], ovector[6] to see if they + * contain '>= 0' or '-1'. See the pcreapi(3) man page for further + * information. + * + * 'code' may be NULL, which means we don't match against a regular + * expression. This is useful if you just want to wait for EOF or + * timeout. + * + * This can return: + * + * MEXP_MATCHED: + * The input matched the regular expression. Use ovector + * to find out what matched in the buffer (mexp_h->buffer). + * MEXP_TIMEOUT: + * No input matched before the timeout (mexp_h->timeout) was reached. + * MEXP_EOF: + * The subprocess closed the connection. + * MEXP_ERROR: + * There was a system call error (eg. from the read call). See errno. + * MEXP_PCRE_ERROR + * There was a pcre_exec error. *pcre_ret is set to the error code + * (see pcreapi(3) for a list of PCRE_* error codes and what they mean). + */ +extern enum mexp_status mexp_expect (mexp_h *h, const pcre *code, + const pcre_extra *extra, + int options, int *ovector, int ovecsize, + int *pcre_ret); + +/* This is a convenience function for writing something (eg. a + * password or command) to the subprocess. You could do this by + * writing directly to 'h->fd', but this function does all the error + * checking for you. + * + * Returns the number of bytes if the whole message was written OK + * (partial writes are not possible with this function), or -1 if + * there was an error (check errno). + */ +extern int mexp_printf (mexp_h *h, const char *fs, ...) + __attribute__((format(printf,2,3))); + +#endif /* MINIEXPECT_H_ */ diff --git a/test-spawn.c b/test-spawn.c new file mode 100644 index 0000000..d4d44c7 --- /dev/null +++ b/test-spawn.c @@ -0,0 +1,46 @@ +/* miniexpect test suite + * Copyright (C) 2014 Red Hat Inc. + * + * 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 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 + */ + +#include + +#include +#include +#include +#include + +#include "miniexpect.h" +#include "tests.h" + +int +main (int argc, char *argv[]) +{ + mexp_h *h; + int status; + + h = mexp_spawnl ("cat", "cat", NULL); + assert (h != NULL); + status = mexp_close (h); + if (status != 0 && !test_is_sighup (status)) { + fprintf (stderr, "%s: non-zero exit status from subcommand: ", argv[0]); + test_diagnose (status); + fprintf (stderr, "\n"); + exit (EXIT_FAILURE); + } + + exit (EXIT_SUCCESS); +} diff --git a/tests.h b/tests.h new file mode 100644 index 0000000..e258782 --- /dev/null +++ b/tests.h @@ -0,0 +1,42 @@ +/* miniexpect test suite + * Copyright (C) 2014 Red Hat Inc. + * + * 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 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 + */ + +#ifndef TESTS_H_ +#define TESTS_H_ + +#include +#include + +static inline int +test_is_sighup (int status) +{ + return WIFSIGNALED (status) && WTERMSIG (status) == SIGHUP; +} + +static inline void +test_diagnose (int status) +{ + if (WIFEXITED (status)) + fprintf (stderr, "exited with code %d", WEXITSTATUS (status)); + else if (WIFSIGNALED (status)) + fprintf (stderr, "terminated by signal %d", WTERMSIG (status)); + else if (WIFSTOPPED (status)) + fprintf (stderr, "stopped by signal %d", WSTOPSIG (status)); +} + +#endif /* TESTS_H_ */ -- 1.8.3.1