diff options
| author | james <james@e7ae566f-a301-0410-adde-c780ea21d3b5> | 2005-09-26 05:28:27 +0000 |
|---|---|---|
| committer | james <james@e7ae566f-a301-0410-adde-c780ea21d3b5> | 2005-09-26 05:28:27 +0000 |
| commit | 6fbf66fad3367b24fd6743bcd50254902fd9c8d5 (patch) | |
| tree | 9802876e3771744eead18917bb47ff6e90ac39f5 | |
| download | openvpn-6fbf66fad3367b24fd6743bcd50254902fd9c8d5.tar.xz | |
This is the start of the BETA21 branch.
It includes the --topology feature, and
TAP-Win32 driver changes to allow
non-admin access.
git-svn-id: http://svn.openvpn.net/projects/openvpn/branches/BETA21/openvpn@580 e7ae566f-a301-0410-adde-c780ea21d3b5
Diffstat (limited to '')
255 files changed, 77931 insertions, 0 deletions
@@ -0,0 +1 @@ +James Yonan <jim@yonan.net> @@ -0,0 +1,215 @@ +OpenVPN (TM) -- An Open Source VPN daemon + +Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + +This distribution contains multiple components, some +of which fall under different licenses. By using OpenVPN +or any of the bundled components enumerated below, you +agree to be bound by the conditions of the license for +each respective component. + +OpenVPN trademark +----------------- + + "OpenVPN" is a trademark of OpenVPN Solutions LLC. + + +OpenVPN license: +---------------- + + OpenVPN is distributed under the GPL license version 2 (see Below). + + Special exception for linking OpenVPN with OpenSSL: + + In addition, as a special exception, OpenVPN Solutions LLC gives + permission to link the code of this program with the OpenSSL + library (or with modified versions of OpenSSL that use the same + license as OpenSSL), and distribute linked combinations including + the two. You must obey the GNU General Public License in all + respects for all of the code used other than OpenSSL. If you modify + this file, you may extend this exception to your version of the + file, but you are not obligated to do so. If you do not wish to + do so, delete this exception statement from your version. + +LZO license: +------------ + + LZO is Copyright (C) Markus F.X.J. Oberhumer, + and is licensed under the GPL. + + Special exception for linking OpenVPN with both OpenSSL and LZO: + + Hereby I grant a special exception to the OpenVPN project + (http://openvpn.net/) to link the LZO library with + the OpenSSL library (http://www.openssl.org). + + Markus F.X.J. Oberhumer + +TAP-Win32 Driver license: +------------------------- + + The TAP-Win32 driver is derived from the CIPE-Win32 + kernel driver, Copyright (C) Damion K. Wilson, + and is licensed under the GPL. + +Windows DDK Samples: +-------------------- + + The Windows binary distribution includes devcon.exe, a + Microsoft DDK sample which is redistributed under the terms + of the DDK EULA. + +NSIS License: +------------- + + Copyright (C) 2002-2003 Joost Verburg + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. + + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute + it freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; + you must not claim that you wrote the original software. + If you use this software in a product, an acknowledgment in the + product documentation would be appreciated but is not required. + 2. Altered versions must be plainly marked as such, + and must not be misrepresented as being the original software. + 3. This notice may not be removed or altered from any distribution. + +OpenSSL License: +---------------- + + The OpenSSL toolkit stays under a dual license, i.e. both the conditions of + the OpenSSL License and the original SSLeay license apply to the toolkit. + See below for the actual license texts. Actually both licenses are BSD-style + Open Source licenses. In case of any license issues related to OpenSSL + please contact openssl-core@openssl.org. + +/* ==================================================================== + * Copyright (c) 1998-2003 The OpenSSL Project. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * + * 3. All advertising materials mentioning features or use of this + * software must display the following acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit. (http://www.openssl.org/)" + * + * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to + * endorse or promote products derived from this software without + * prior written permission. For written permission, please contact + * openssl-core@openssl.org. + * + * 5. Products derived from this software may not be called "OpenSSL" + * nor may "OpenSSL" appear in their names without prior written + * permission of the OpenSSL Project. + * + * 6. Redistributions of any form whatsoever must retain the following + * acknowledgment: + * "This product includes software developed by the OpenSSL Project + * for use in the OpenSSL Toolkit (http://www.openssl.org/)" + * + * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY + * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR + * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + * OF THE POSSIBILITY OF SUCH DAMAGE. + * ==================================================================== + * + * This product includes cryptographic software written by Eric Young + * (eay@cryptsoft.com). This product includes software written by Tim + * Hudson (tjh@cryptsoft.com). + * + */ + + Original SSLeay License + ----------------------- + +/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) + * All rights reserved. + * + * This package is an SSL implementation written + * by Eric Young (eay@cryptsoft.com). + * The implementation was written so as to conform with Netscapes SSL. + * + * This library is free for commercial and non-commercial use as long as + * the following conditions are aheared to. The following conditions + * apply to all code found in this distribution, be it the RC4, RSA, + * lhash, DES, etc., code; not just the SSL code. The SSL documentation + * included with this distribution is covered by the same copyright terms + * except that the holder is Tim Hudson (tjh@cryptsoft.com). + * + * Copyright remains Eric Young's, and as such any Copyright notices in + * the code are not to be removed. + * If this package is used in a product, Eric Young should be given attribution + * as the author of the parts of the library used. + * This can be in the form of a textual message at program startup or + * in documentation (online or textual) provided with the package. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * "This product includes cryptographic software written by + * Eric Young (eay@cryptsoft.com)" + * The word 'cryptographic' can be left out if the rouines from the library + * being used are not cryptographic related :-). + * 4. If you include any Windows specific code (or a derivative thereof) from + * the apps directory (application code) you must include an acknowledgement: + * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" + * + * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * The licence and distribution terms for any publically available version or + * derivative of this code cannot be changed. i.e. this code cannot simply be + * copied and put under another distribution licence + * [including the GNU Public Licence.] + */ + +GNU Public License (GPL) +------------------------ + + OpenVPN, LZO, and the TAP-Win32 distributions are + licensed under the GPL version 2 (see COPYRIGHT.GPL). + + In the Windows binary distribution of OpenVPN, the + GPL is reproduced below. + + diff --git a/COPYRIGHT.GPL b/COPYRIGHT.GPL new file mode 100644 index 0000000..ff8a7f0 --- /dev/null +++ b/COPYRIGHT.GPL @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +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 Program or any portion +of it, thus forming a work based on the Program, 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) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +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 Program, 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 Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) 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; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, 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 executable. However, as a +special exception, the source code 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. + +If distribution of executable or 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 counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program 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. + + 5. 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 Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program 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 to +this License. + + 7. 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 Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program 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 Program. + +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. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program 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. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies 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 Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, 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 + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License version 2 + 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..f70ed1d --- /dev/null +++ b/ChangeLog @@ -0,0 +1,2102 @@ +OpenVPN +Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + +$Id$ + +2005.09.25 -- Version 2.0.3-rc1 + +* openvpn_plugin_abort_v1 function wasn't being properly + registered on Windows. +* Fixed a bug where --mode server --proto tcp-server --cipher none + operation could cause tunnel packet truncation. + +2005.08.25 -- Version 2.0.2 + +* No change from 2.0.2-rc1. + +2005.08.24 -- Version 2.0.2-rc1 + +* Fixed regression bug in Win32 installer, introduced in 2.0.1, + which incorrectly set OpenVPN service to autostart. +* Don't package source code zip file in Windows installer + in order to reduce the size of the installer. The source + zip file can always be downloaded separately if needed. +* Fixed bug in route.c in FreeBSD, Darwin, OpenBSD and NetBSD + version of get_default_gateway. Allocated socket for route + manipulation is never freed so number of mbufs continuously + grow and exhaust system resources after a while (Jaroslav Klaus). +* Fixed bug where "--proto tcp-server --mode p2p --management + host port" would cause the management port to not respond until + the OpenVPN peer connects. +* Modified pkitool script to be /bin/sh compatible (Johnny Lam). + +2005.08.16 -- Version 2.0.1 + +* Security Fix -- DoS attack against server when run with "verb 0" and + without "tls-auth". If a client connection to the server fails + certificate verification, the OpenSSL error queue is not properly + flushed, which can result in another unrelated client instance on the + server seeing the error and responding to it, resulting in disconnection + of the unrelated client (CAN-2005-2531). +* Security Fix -- DoS attack against server by authenticated client. + This bug presents a potential DoS attack vector against the server + which can only be initiated by a connected and authenticated client. + If the client sends a packet which fails to decrypt on the server, + the OpenSSL error queue is not properly flushed, which can result in + another unrelated client instance on the server seeing the error and + responding to it, resulting in disconnection of the unrelated client + (CAN-2005-2532). +* Security Fix -- DoS attack against server by authenticated client. + A malicious client in "dev tap" ethernet bridging mode could + theoretically flood the server with packets appearing to come from + hundreds of thousands of different MAC addresses, causing the OpenVPN + process to deplete system virtual memory as it expands its internal + routing table. A --max-routes-per-client directive has been added + (default=256) to limit the maximum number of routes in OpenVPN's + internal routing table which can be associated with a given client + (CAN-2005-2533). +* Security Fix -- DoS attack against server by authenticated client. + If two or more client machines try to connect to the server at the + same time via TCP, using the same client certificate, and when + --duplicate-cn is not enabled on the server, a race condition can + crash the server with "Assertion failed at mtcp.c:411" + (CAN-2005-2534). +* Fixed server bug where under certain circumstances, the client instance + object deletion function would try to delete iroutes which had never been + added in the first place, triggering "Assertion failed at mroute.c:349". +* Added --auth-retry option to prevent auth errors from being fatal + on the client side, and to permit username/password requeries in case + of error. Also controllable via new "auth-retry" management interface + command. See man page for more info. +* Added easy-rsa 2.0 scripts to the tarball in easy-rsa/2.0 +* Fixed bug in openvpn.spec where rpmbuild --define 'without_pam 1' + would fail to build. +* Implement "make check" to perform loopback tests (Matthias Andree). + +2005.07.21 -- Version 2.0.1-rc7 + +* Support LZO 2.01 which renamed its library to lzo2 (Matthias Andree). +* Include linux/types.h before checking for linux/errqueue.h (Matthias + Andree). + +2005.07.15 -- Version 2.0.1-rc6 + +* Commented out "user nobody" and "group nobody" in sample + client/server config files. +* Allow '@' character to be used in --client-config-dir + file names. + +2005.07.04 -- Version 2.0.1-rc5 + +* Windows version will log a for-further-info URL when + initialization sequence is completed with errors. +* Added DLOPEN_PAM parameter to plugin/auth-pam/Makefile + to control whether auth-pam plugin links to PAM via + dlopen or -lpam. By default, DLOPEN_PAM=1 so pre-existing + behavior should be preserved. DLOPEN_PAM=0 is the preferred + setting to link via -lpam, but DLOPEN_PAM=1 works around + a bug in SuSE 9.1 (and possibly other distros as well) + where the PAM modules are not linked with -lpam. See + thread on openvpn-devel for more discussion about this + patch (Simon Perreault). + +2005.06.15 -- Version 2.0.1-rc4 + +* Support LZO 2.00, including changes to configure script to + autodetect LZO version. + +2005.06.12 -- Version 2.0.1-rc3 + +* Fixed a bug which caused standard file handles to not be closed + after daemonization when --plugin and --daemon are used together, + and if the plugin initialization function forks (as does auth-pam + and down-root) (Simon Perreault). +* Added client-side up/down scripts in contrib/pull-resolv-conf + for accepting server-pushed "dhcp-option DOMAIN" and "dhcp-option DNS" + on Linux/Unix systems (Jesse Adelman). +* Fixed bug where if client-connect scripts/plugins were cascaded, + and one (but not all) of them returned an error status, there might + be cases where for an individual script/plugin, client-connect was + called but not client-disconnect. The goal of this fix is to + ensure that if client-connect is called on a given client instance, + then client-disconnect will definitely be called. A potential + complication of this fix is that when client-connect functions are + cascaded, it's possible that the client-disconnect function would + be called in cases where the related client-connect function returned + an error status. This fix should not alter OpenVPN behavior when + scripts/plugins are not cascaded. +* Changed the hard-to-reproduce "Assertion failed at fragment.c:312" + fatal error to a warning: "FRAG: outgoing buffer is not empty". + Need more info on how to reproduce this one. +* When --duplicate-cn is used, the --ifconfig-pool allocation + algorithm will now allocate the first available IP address. +* When --daemon and --management-hold are used together, + OpenVPN will daemonize before it enters the management hold state. + +2005.05.16 -- Version 2.0.1-rc2 + +* Modified vendor test in openvpn.spec file to match against + "Mandrakesoft" in addition to "MandrakeSoft". +* Using --iroute in a --client-config-dir file while in --dev tap + mode is not currently supported and will produce a warning + message. Fixed bug where in certain cases, in addition to + generating a warning message, this combination of options + would also produce a fatal assertion in mroute.c. +* Pass --auth-user-pass username to server-side plugin without + performing any string remapping (plugins, unlike scripts, + don't get any security benefit from string remapping). + This is intended to fix an issue with openvpn-auth-pam/pam_winbind + where backslash characters in a username ('\') were being remapped + to underscore ('_'). +* Updated OpenSSL DLLs in Windows build to 0.9.7g. +* Documented --explicit-exit-notify in man page. +* --explicit-exit-notify seconds parameter defaults to 1 if + unspecified. + +2005.04.30 -- Version 2.0.1-rc1 + +* Fixed bug where certain kinds of fatal errors after + initialization (such as port in use) would leave plugin + processes (such as openvpn-auth-pam) still running. +* Added optional openvpn_plugin_abort_v1 plugin function for + closing initialized plugin objects in the event of a fatal + error by main OpenVPN process. +* When the --remote list is > 1, and --resolv-retry is not + specified (meaning that it defaults to "infinite"), apply the + infinite timeout to the --remote list as a whole, but try each + list item only once before moving on to the next item. +* Added new --syslog directive which redirects output + to syslog without requiring the use of the --daemon or --inetd + directives. +* Added openvpn.spec option to allow RPM to be built with support + for passwords read from a file: + rpmbuild -tb [openvpn.x.tar.gz] --define 'with_password_save 1' + +2005.04.17 -- Version 2.0 + +* Fixed minor options string typo in options.c. + +2005.04.10 -- Version 2.0-rc21 + +* Change license description from "GPL Version 2 or (at your + option) any later version" to just "GPL Version 2". + +2005.04.04 -- Version 2.0-rc20 + +* Dag Wieers has put together an OpenVPN/LZO binary RPM set with + excellent distro/version coverage for RH/EL/Fedora, though + using his own SPEC. I modified openvpn.spec to follow some of + the same conventions such as putting sample scripts and doc + files in %doc rather than /usr/share/openvpn. +* Minor change to init scripts to run the user-defined script + /etc/openvpn/openvpn-startup (if it exists) before any OpenVPN + configs are started, and to run /etc/openvpn/openvpn-shutdown + after all OpenVPN configs have been stopped. The + openvpn-startup script can be used for stuff like + insmod tun.o, setting up firewall rules, or starting + ethernet bridges. + +2005.03.29 -- Version 2.0-rc19 + +* Omit additions of routes where the network and + gateway are equal and the netmask is 255.255.255.255. + This can come up if you are using both + server/ifconfig-pool and client-config-dir with + ifconfig-push static addresses for some subset of clients + which directly reference the server IP address as the + remote endpoint. + +2005.03.28 -- Version 2.0-rc18 + +* Packaged Windows installer with OpenSSL 0.9.7f. +* Built Windows installer with NSIS 2.06. + +2005.03.12 -- Version 2.0-rc17 + +* "MANAGEMENT: CMD" log file output will now only occur + at --verb 7 or greater. +* Added an optional name/value configuration list to + the openvpn-auth-pam plugin module argument list. See + plugin/auth-pam/README for documentation. This is necessary + in order for openvpn-auth-pam to work with queries generated + by arbitrary PAM modules. +* In both auth-pam and down-root plugins, in the forked process, + a read error on the parent process socket is no longer fatal. +* MandrakeSoft liblzo1 RPM only Provides for a 'liblzo1'. + A conditional test of the vendor has been added to + Require the appropriately named 'lzo' (liblzo1 / lzo). + (Tom Walsh - http://openhardware.net) + + +2005.02.20 -- Version 2.0-rc16 + +* Fixed bug introduced in rc13 where Windows service wrapper + would be installed with a startup type of Automatic. + This fix restores the previous behavior of installing + with a startup type of Manual. + +2005.02.19 -- Version 2.0-rc15 + +* Added warning when --keepalive is not used in a server + configuration. +* Don't include OpenSSL md4.h file if we are not building + NTLM proxy support (Waldemar Brodkorb). +* Added easy-rsa/build-key-pkcs12 and + easy-rsa/Windows/build-key-pkcs12.bat scripts + (Mathias Sundman). + +2005.02.16 -- Version 2.0-rc14 + +* Fixed small memory leak that occurs when --crl-verify + is used. +* Upgraded Windows installer and .nsi script to NSIS 2.05 + (Mathias Sundman). +* Changed #include backslash usage in cryptoapi.c to use + forward slashes instead (Gisle Vanem). +* Created easy-rsa/revoke-full to handle revocations in + a single step: (a) revoke crt, (b) regenerate CRL, and + (c) verify that revocation succeeded. +* Renamed easy-rsa/Windows/revoke-key to revoke-full so + that both *nix and Windows scripts are equivalent. + +2005.02.11 -- Version 2.0-rc13 + +* Improve human-readability of local/remote options + diff, when inconsistencies are present. +* For Windows easy-rsa, distribute vars.bat.sample and + openssl.cnf.sample, then copy them to their normal + filenames (without the .sample) when init-config.bat + is run. This is to prevent OpenVPN upgrades from + wiping out vars.bat and openssl.cnf edits. +* Modified service wrapper (Windows) to use a + case-insensitive search when scanning for .ovpn files + in \Program Files\OpenVPN\config. Prior versions + required an all-lower-case .ovpn file extension. +* Miscellaneous service wrapper code cleanup. +* If --user/--group is used on Windows, treat it + as a no-op with a warning (this makes it easier to + distribute the same client config file to Windows + and *nix users). +* Warn if --ifconfig-pool-persist is used with + --duplicate-cn. + +2005.02.05 -- Version 2.0-rc12 + +* Removed some debugging code inadvertently included + in rc11 which would print the --auth-user-pass + username/password provided by clients in the server + logfile. +* Client code for cycling through --remote list will + retry the last address which successfully authenticated + before moving on through the list. +* Windows installer will now install sample configuration + files in \Program Files\OpenVPN\sample-configs as well + as generate a start menu shortcut to this directory. +* Minor type change in buffer.[ch] to work around char-type + ambiguity bug. Caused management interface lock-ups on + ARM when building with armv4b-hardhat-linux-gcc 2.95.3. + +2005.02.03 -- Version 2.0-rc11 + +* Windows installer will now install easy-rsa directory + in \Program Files\OpenVPN +* Allow syslog facility to be controlled at compile time, + e.g. -DLOG_OPENVPN=LOG_LOCAL6 (P Kern). +* Changed certain shell scripts in distribution to use + #!/bin/sh rather than #!/bin/bash for better portability. +* If --ifconfig-pool-persist seconds parameter is 0, treat + persist file as an allocation of fixed IP addresses + (previous versions took IP-to-common-name associations + from this list as hints, not mandatory static allocations). +* Fixed bug on *nix where if --auth-user-pass and --log + were used together, the username prompt would be sent to + the log file rather than /dev/tty. +* Spurious text in openvpn.8 detected by doclifter + (Eric S. Raymond). +* Call closelog later on daemon kill so that process + exit message is written to syslog. + +2005.01.27 -- Version 2.0-rc10 + +* When ./configure is run with plugins enabled (the default), + check whether or not dlopen exists in libc before testing + for libdl. This is to fix an issue on FreeBSD and possibly + other OSes which bundle libdl functions in libc. +* On Windows, filter initial WSAEINVAL warning which occurs + on the initial read attempt of an unbound socket. +* The easy-rsa scripts build-key, build-key-pass, and + build-key-server will now chmod the .key file + to 0600. This is in addition to the fact the generated + keys directory has always been similarly protected + (Pete Harlan). + +2005.01.23 -- Version 2.0-rc9 + +* Fixed error "ROUTE: route addition failed using + CreateIpForwardEntry ..." on Windows when --redirect-gateway + is used over a RRAS internet link. +* When using --route-method exe on Windows, include the + gateway parameter on route delete commands (Mathias Sundman). +* Try not to do a hard reset (i.e. SIGHUP) when two + SIGUSR1 signals are received in close succession. +* If the push list tries to grow beyond its buffer capacity, + the resulting error will be non-fatal. +* To increase the push list capacity (must be done on both + client and server), increase TLS_CHANNEL_BUF_SIZE in + common.h (default=1024). + +2005.01.15 -- Version 2.0-rc8 + +* Fixed bug introduced in rc7 where options error + "--auth-user-pass requires --pull" might occur even + if --pull was correctly specified. +* Changed management interface code to bind once + to TCP socket, rather than rebinding after every + client disconnect. +* Added "disable" directive for client-config-dir + files. +* Windows binary install is now distributed with + OpenSSL 0.9.7e. +* Query the management interface for --http-proxy + username/password if authfile is set to "stdin". +* Added current OpenVPN version number to "Unrecognized + option or missing parameter" error message. +* Added "-extensions server" to "openssl req" command + in easy-rsa/build-key-server (Nir Yeffet). + +2005.01.10 -- Version 2.0-rc7 + +* Fixed bug in management interface which could cause + 100% CPU utilization in --proto tcp-server mode + on all *nix OSes except for Linux 2.6. +* --ifconfig-push now accepts DNS names as well as + IP addresses. +* Added sanity check errors when --pull or + --auth-user-pass is used in an incorrect mode. +* Updated man page entries for --client-connect and + --ifconfig-push. +* Added "String Types and Remapping" section to man + page to consisely document the way which OpenVPN + may convert certain types of characters in strings + to ('_'). +* Modified bridging description in HOWTO to emphasize + the fact that bridging allows Windows file and print + sharing without a WINS server (Charles Duffy). + +2004.12.20 -- Version 2.0-rc6 + +* Improved checking for epoll support in ./configure + to fix false positive on RH9 (Jan Just Keijser). +* Made the "MULTI TCP: I/O wait required blocking in + multi_tcp_action, action=7" error nonfatal and replaced + with "MULTI: Outgoing TUN queue full, dropped packet". + So far the issue only seems to occur on Linux 2.2 + in --mode server --proto tcp mode. It occurs when + the TUN/TAP driver locks up and refuses to accept + new packet writes for a second or more. +* Fixed bug where if a --client-config-dir file tried + to include another file using "config", and if that + include failed, OpenVPN would abort with a fatal + error. Now such inclusion failures will be logged + but are no longer fatal. +* Global changes to the way that packet buffer alignment + is handled. Previously we didn't care about alignment + and took care, when handling 16 and 32 bit words + in buffers, to always use alignment-safe transfers. + This approach appears to be inadequate on some + architectures such as alpha. The new approach is + to initialize packet buffers in a way that anticipates + how component structures will be allocated within + them, to maintain correct alignment. +* Added --dhcp-option DISABLE-NBT to disable NetBIOS + over TCP (Jan Just Keijser). +* Added --http-proxy-option directive for controlling + miscellaneous HTTP proxy options. +* Management state will no longer transition to "WAIT" + during TLS renegotiations. + +2004.12.16 -- Version 2.0-rc5 + +* The --client-config-dir option will now try to open + a default file called "DEFAULT" if no file matching + the common name of the incoming client was found. +* The --client-connect script/plugin can now veto client + authentication by returning a failure code. +* The --learn-address script/plugin can now prevent a + client-instance/address association from being learned + by returning a failure code. +* Changed RPM group in .spec file to Applications/Internet. + +2004.12.14 -- Version 2.0-rc4 + +* SuSE only -- Fixed interaction between openvpn.spec and + suse/openvpn.init where the .spec file was writing the + OpenVPN binary to a different location than where the + .init script was referencing it (Stefan Engel). +* Solaris only -- Split Solaris ifconfig command into two + parts (Jan Just Keijser). +* Some cleanup in add_option(). +* Better error checking on input dotted quad IP addresses. +* Verify that --push argument is quoted, if there is + more than one. +* More miscellaneous option sanity checks. + +2004.12.13 -- Version 2.0-rc3 + +* On Windows, when --log or --log-append is used, + save the original stderr for username and password + prompts. +* Fixed a bug introduced in the late 2.0 betas where + if a "verb" parameter >= 16 was used, it would be + ignored and the actual verb level would remain at 1. +* Fixed a bug mostly seen on OS X where --management-hold + or --management-query-passwords would cause the management + interface to be unresponsive to incoming client connections. +* Trigger an options error if one of the management-modifying + options is used without "management" itself. + +2004.12.12 -- Version 2.0-rc2 + +* Amplified warnings in documentation about possible + man-in-the-middle attack when clients do not properly + verify server certificate. Changes to easy-rsa README, + FAQ, HOWTO, man page, and sample client config file. +* Added a warning message if --tls-client or --client + is used without also specifying one of either + --ns-cert-type, --tls-remote, or --tls-verify. +* status_open() fixes for MSVC builds (Blaine Fleming). +* Fix attempt of "ntlm.c:55: error: `des_cblock' undeclared" + compiler error which has been reported on some platforms. +* The openvpn.spec file for rpmbuild has several + new build-time options. See comments in the file. +* Plugins are now built and packaged in the RPM and + will be saved in /usr/share/openvpn/plugin/lib. +* Added --management-hold directive to start OpenVPN + in a hibernating state until released by the + management interface. Also added "hold" command + to the management interface. + +2004.12.07 -- Version 2.0-rc1 + +* openvpn.spec workaround for SuSE confusion regarding + /etc/init.d vs. /etc/rc.d/init.d (Stefan Engel). + +2004.12.05 -- Version 2.0-beta20 + +* The ability to read --askpass and --auth-user-pass + passwords from a file has been disabled by default. + To re-enable, use ./configure --enable-password-save. +* Added additional pre-connected states to management + interface. See management/management-notes.txt + for more info. +* State history is now recorded by the management + interface, and the "state" command now works like + the log or echo commands. +* State history and real-time state change notifications + are now prepended with an integer unix timestamp. +* Added --http-proxy-timeout option, previously + the timeout was hardcoded to 5 seconds. + +2004.12.02 -- Version 2.0-beta19 + +* Fixed bug in management interface line termination + where output lines incorrectly contained a \00 char + after the customary \0d \0a. +* Fixed bug introduced in beta18 where Windows version + would segfault on options errors. +* Fixed bug in management interface where an empty + quoted string ("") entered as a parameter would cause + a segfault. +* Fixed bug where --resolv-retry was not working + properly with multiple --remote hosts. +* Added additional ./configure options to reduce + executable size for embedded applications. + See ./configure --help. + +2004.11.28 -- Version 2.0-beta18 + +* Added management interface. See new --management-* + options or the full management interface documentation + in management/management-notes.txt in the tarball. + Management interface inclusion can be disabled by + ./configure --disable-management. +* Added two new plugin modules: auth-pam and down-root. + Auth-pam supports pam-based authentication using a + split privilege execution model, while down-root enables + a down script to be executed with root privileges, even + when --user/--group is used to drop root privileges. + See the plugin directory in the tarball for READMEs, + source code, and Makefiles. +* Plugin developers should note that some changes were + made to the plugin interface since beta17. See + openvpn-plugin.h for details. + Plugin interface inclusion can be disabled with + ./configure --disable-plugins +* Added easy-rsa/build-key-server script which will + build a certificate with with nsCertType=server. +* Added --ns-cert-type option for verification + of nsCertType field in peer certificate. +* If --fragment n is specified and --mssfix is specified + without a parameter, default --mssfix to n. This restores + the 1.6 behavior when using --mssfix without a parameter. +* Fixed SSL context initialization bug introduced in beta14 + where this error might occur on restarts: "Cannot load + certificate chain ... PEM_read_bio:no start line". + +2004.11.11 -- Version 2.0-beta17 + +* Changed default port number to 1194 per IANA official + port number assignment. +* Added --plugin directive which allows compiled + modules to intercept script callbacks. See + plugin folder in tarball for more info. +* Fixed bug introduced in beta12 where --key-method 1 + authentications which should have succeeded would fail. +* Ignore SIGUSR1 during DNS resolution. +* Added SuSE support to openvpn.spec (Umberto Nicoletti). +* Fixed --cryptoapicert SUBJ: parsing bug (Peter 'Luna' + Runestig). + +2004.11.07 -- Version 2.0-beta16 + +* Modified sample-scripts/auth-pam.pl to get username + and password from OpenVPN via a file rather than + via environmental variables. +* Added bytes_sent and bytes_received environmental + variables to be set prior to client-disconnect script. +* Changed client virtual IP derivation precedence: + (1) use --ifconfig-push directive from --client-connect + script, (2) use --ifconfig-push directive from + --client-config-dir, and (3) use --ifconfig-pool + address. +* If a --client-config-dir file specifies --ifconfig-push, + it will be visible to the --client-connect-script in + the ifconfig_pool_remote_ip environmental variable. +* For tun-style tunnels, the ifconfig_pool_local_ip + environmental variable will be set, while for + tap-style tunnels, the ifconfig_pool_netmask variable + will be set. +* Added intelligence to autoconf script to test + compiler for the accepted form of zero-length arrays. +* Fixed a bug introduced in beta12 where --ip-win32 + netsh would fail if --dev-node was not explicitly + specified. +* --ip-win32 netsh will now work on hidden adapters. +* Fix attempt of "Assertion failed at crypto.c:149". + This assertion has also been reported on 1.x with a + slightly different line number. The fix is twofold: + (1) In previous releases, --mtu-test may trigger this + assertion -- this bug has been fixed. (2) If something + else causes the assertion to be thrown, don't panic, + just output a nonfatal warning to the log and drop + the packet which generated the error. +* Support TAP interfaces on Mac OS X (Waldemar Brodkorb). +* Added --echo directive. +* Added --auth-nocache directive. + +2004.10.28 -- Version 2.0-beta15 + +* Changed environmental variable character classes + so that names must consist of alphanumeric or + underbar chars and values must consist of printable + characters. Illegal chars will be deleted. + Versions prior to 2.0-beta12 were more restrictive + and would map spaces to '.'. +* On Windows, when the TAP adapter fails to + initialize with the correct IP address, output + "Initialization Sequence Completed with Errors" + to the console or log file. +* Added a warning when user/group/chroot is used + without persist-tun and persist-key. +* Added cryptoapi.[ch] to tarball and source zip. +* --tls-remote option now works with common name + prefixes as well as with the full X509 subject + string. This is a useful alternative to using + a CRL on the client. +* common names associated with a static + --ifconfig-push setting will no longer leave + any state in the --ifconfig-pool-persist file. +* Hard TLS errors (TLS handshake failed) will now + trigger either a SIGUSR1 signal by default + or SIGTERM (if --tls-exit is specified). In TCP + mode, all TLS errors are considered to be hard. + In server mode, the signal will be local to the + client instance. +* Added method parameter to --auth-user-pass-verify + directive to select whether username/password + is passed to script via environment or a temporary + file. +* Added --status-version option to control format + of --status file. The --mode server + --status-version 2 format now includes a line + type token, the virtual IP address is shown + in the client list (even in --dev tap mode), + and the integer time_t value is shown anywhere + an ascii-formatted time/date is also shown. +* Added --remap-usr1 directive which can be used + to control whether internally or externally + generated SIGUSR1 signals are remapped to + SIGHUP (restart without persisting state) or + SIGTERM (exit). +* When running as a Windows service (using + --service option), check the exit event before + and after reading one line of input from + stdin, when reading username/password info. +* For developers: Extended the --gremlin function + to better stress-test the new 2.0 features, + added Valgrind support on Linux and Dmalloc + support on Windows. + +2004.10.19 -- Version 2.0-beta14 + +* Fixed a bug introduced in Beta12 that would occur + if you use a --client-connect script without also + defining --tmp-dir. +* Fixed a bug introduced in Beta12 where a learn-address + script might segfault on the delete method. +* Added Crypto API support in Windows version via + the --cryptoapicert option (Peter 'Luna' Runestig). + +2004.10.18 -- Version 2.0-beta13 + +* Fixed an issue introduced in Beta12 where the private + key password would not be prompted for unless --askpass + was explicitly specified in the config. + +2004.10.17 -- Version 2.0-beta12 + +* Added support for username/password-based authentication. + Clients can now authentication themselves with the server + using either a certificate, a username/password, or both. + New directives: --auth-user-pass, --auth-user-pass-verify, + --client-cert-not-required, and --username-as-common-name. +* Added NTLM proxy patch (William Preston). +* Added --ifconfig-pool-linear server flag to allocate + individual tun addresses for clients rather than /30 + subnets (won't work with Windows clients). +* Modified --http-proxy code to cache username/password + across restarts. +* Modified --http-proxy code to read username/password + from the console when the auth file is given as "stdin". +* Modified --askpass to take an optional filename argument. +* --persist-tun and --persist-key now work in client mode + and can be pushed to clients as well. +* Added --ifconfig-pool-persist directive, to maintain + ifconfig-pool info in a file which is persistent across + daemon instantiations. +* --user and --group privilege downgrades as well as + --chroot now also work in client mode (the + dowgrade/chroot will be delayed until the initialization + sequence is completed). +* Added --show-engines standalone directive to show + available OpenSSL crypto accelerator engine support. +* --engine directive now accepts an optional engine-ID + parameter to control which engine is used. +* "Connection reset, restarting" log message now shows + which client is being reset. +* Added --dhcp-pre-release directive in Windows version. +* Second parm to --ip-win32 can be "default", e.g. + --ip-win32 dynamic default 60. +* Fixed documentation bug regarding environmental + variable settings for --ifconfig-pool IP addresses. + The correct environmental variable names are: + ifconfig_pool_local_ip and ifconfig_pool_remote_ip. +* ifconfig_pool_local_ip and ifconfig_pool_remote_ip + environmental variables are now passed to the + client-disconnect script. +* In server mode, environmental variables are now scoped + according to the client they are associated with, + to solve the problem of "crosstalk" between different + client's environmental variable sets. +* Added --down-pre flag to cause --down script to be + called before TUN/TAP close (rather than after). +* Added --tls-exit flag which will cause OpenVPN + to exit on any TLS errors. +* Don't push a route to a client if it exactly + matches an iroute (this lets you push routes to + all clients, and OpenVPN will automatically remove + the route from the route push list only for that client + which the route actually belongs to). +* Made '--resolv-retry infinite' the default. + --resolv-retry can be disabled by using a parameter of 0. +* For clients which plan to pull config info from server, + set an initial default ping-restart of 60 seconds. +* Optimized mute code to lessen the load on the processor + when messages are being muted at a higher frequency. +* Made route log messages non-mutable. +* Silence the Linux "No buffer space available" message. +* Added miscellaneous additional option sanity checks. +* Added Windows version of easy-rsa scripts in + easy-rsa/Windows directory (Andrew J. Richardson). +* Added NetBSD route patch (Ed Ravin). +* Added OpenBSD patch for TAP + --redirect-gateway + (Waldemar Brodkorb). +* Directives which prompt for a username and/or password + will now work with --daemon (OpenVPN will prompt + before forking). +* Warn if CRL is from a different issuer than the + issuer of the peer certificate (Bernhard Weisshuhn). +* Changed init script chkconfig parameters to start + OpenVPN daemon(s) before NFS. +* Bug fix attempt of "too many I/O wait events" which occurs + on OSes which prefer select() over poll() such as Mac OS X. +* Added --ccd-exclusive flag. This flag will require, as a + condition of authentication, that a connecting client has + a --client-config-dir file. +* TAP-Win32 open code will attempt to open a free adapter + if --dev-node is not specified (Mathias Sundman). +* Resequenced --nice and --chroot ordering so that --nice + occurs first. +* Added --suppress-timestamps flag (Charles Duffy). +* Source code changes to allow compilation by MSVC + (Peter 'Luna' Runestig). +* Added experimental --fast-io flag which optimizes + TUN/TAP/UDP writes on non-Windows systems. + +2004.08.18 -- Version 2.0-beta11 + +* Added --server, --server-bridge, --client, and + --keepalive helper directives. See client.conf + and server.conf in sample-config-files for sample + configurations which use the new directives. +* On Windows, added --route-method to control + whether IP Helper API or route.exe is used + to add/delete routes. +* On Windows, added a second parameter to + --route-delay to control the maximum time period + to wait for the TAP-Win32 adapter to come up + before adding routes. +* Fixed bug in Windows version where configurations + which omit --ifconfig might fail to recognize when + the TAP adapter is up. +* Proxy connection failures will now retry according + to the --connect-retry parameter. +* Fixed --dev null handling on Windows so that TLS + loopback test described in INSTALL file works + correctly on Windows. +* Added "Initialization Sequence Completed" message + after all initialization steps have been completed + and the VPN can be considered "up". +* Better sanity-checking on --ifconfig-pool parameters. +* Added --tcp-queue-limit option to control + TUN/TAP -> TCP socket overflow. +* --ifconfig-nowarn flag will now silence general + warnings about possible --ifconfig address + conflicts, including the warning about --ifconfig + and --remote addresses being in same /24 subnet. +* Fixed case where server mode did not correctly + identify certain types of ethernet multicast packets + (Marcel de Kogel). +* Added --explicit-exit-notify option (experimental). + +2004.08.02 -- Version 2.0-beta10 + +* Fixed possible reference after free of option strings + after a restart, bug was introduced in beta8. +* Fixed segfault at route.c:919 in the beta9 + Windows version that was being caused by indirection + through a NULL pointer. +* Mistakenly built debug version of TAP-Win32 driver + for beta9. Beta10 has correct release build. + +2004.07.30 -- Version 2.0-beta9 + +* Fixed --route issue on Windows that was introduced with + the new beta8 route implementation based on the + IP Helper API. + +2004.07.27 -- Version 2.0-beta8 + +* Added TCP support in server mode. +* Added PKCS #12 support (Mathias Sundman). +* Added patch to make revoke-crt and make-crl work + seamlessly within the easy-rsa environment (Jan Kiszka). +* Modified --mode server ethernet bridge code to forward + special IEEE 802.1d MAC Groups, i.e. 01:80:C2:XX:XX:XX. +* Added --dhcp-renew and --dhcp-release flags to Windows + version. Normally DHCP renewal and release on the TAP + adapter occurs automatically under Windows, however + if you set the TAP-Win32 adapter Media Status property + to "Always Connected", you may need these flags. +* Added --show-net standalone flag to Windows version to + show OpenVPN's view of the system adapter and routing + tables. +* Added --show-net-up flag to Windows version to output + the system routing table and network adapter list to + the log file after the TAP-Win32 adapter has been brought + up and any routes have been added. +* Modified Windows version to add routes using the IP Helper + API rather than by calling route.exe. +* Fixed bug where --route-up script was not being called + if no --route options were specified. +* Added --mute-replay-warnings to suppress packet replay + warnings. This is a common false alarm on WiFi nets. +* Added "def1" flag to --redirect-gateway option to override + the default gateway by using 0.0.0.0/1 and 128.0.0.0/1 + rather than 0.0.0.0/0. This has the benefit of overriding + but not wiping out the original default gateway. + (Thanks to Jim Carter for pointing out this idea). +* You can now run OpenVPN with a single config file argument. + For example, you can now say "openvpn config.conf" + rather than "openvpn --config config.conf". +* On Windows, made --route and --route-delay more adaptive + with respect to waiting for interfaces referenced by the + route destination to come up. Routes added by --route + should now be added as soon as the interface comes up, + rather than after an obligatory 10 second delay. The + way this works internally is that --route-delay now + defaults to 0 on Windows. Previous versions would + wait for --route-delay seconds then add the routes. + This version will wait --route-delay seconds and then + test the routing table at one second intervals for the + next 30 seconds and will not add the routes until they + can be added without errors. +* On Windows, don't setsockopt SO_SNDBUF or SO_RCVBUF by + default on TCP/UDP socket in light of reports that this + action can have undesirable global side effects on the + MTU settings of other adapters. These parameters can + still be set, but you need to explicitly specify + --sndbuf and/or --rcvbuf. +* Added --max-clients option to limit the maximum number + of simultaneously connected clients in server mode. +* Added error message to illuminate shell escape gotcha when + single backslashes are used in Windows path names. +* Added optional netmask parm to --ifconfig-pool. +* Fixed bug where http-proxy connect retry attempts were + incorrectly going to the remote OpenVPN server, + not to the HTTP proxy server. + +2004.06.29 -- Version 2.0-beta7 + +* Fixed bug in link_socket_verify_incoming_addr() which + under certain circumstances could have caused --float + behavior even if --float was not specified. +* --tls-auth option now works with --mode server. + All clients and the server should use the same + --tls-auth key when operating in client/server mode. +* Added --engine option to make use of OpenSSL-supported + crypto acceleration hardware. +* Fixed some high verbosity print format size issues + in event.c for 64 bit platforms (Janne Johansson). +* Made failure to open --log or --log-append file + a non-fatal error. + +2004.06.23 -- Version 2.0-beta6 + +* Fixed Windows installer to intelligently put + up a reboot dialog only if tapinstall tells + us that it's really necessary. +* Fixed "Assertion failed at fragment.c:309" + bug when --mode server and --fragment are used + together. +* Ignore HUP, USR1, and USR2 signals during + initialization. Prior versions would abort. +* Fixed bug on OS X: "Assertion failed at event.c:406". +* Added --service option to Windows version, for use + when OpenVPN is being programmatically instantiated + by another process (see man page for info). +* --log and --log-append options now work on Windows. +* Update OpenBSD INSTALL notes (Janne Johansson). +* Enable multicast on tun interface when running on + OpenBSD (Pavlin Radoslavov). +* Fixed recent --test-crypto breakage, where options + such as --cipher were not being parsed correctly. +* Modified options compatibility string by removing + ifconfig substring if it is empty. Incremented + options compatibility string version number to 4. +* Fixed typo in --tls-timeout option parsing + (Mikael Lonnroth). + +2004.06.13 -- Version 2.0-beta5 + +* Fixed rare --mode server crash that could occur + if data was being routed to a client at + high bandwidth at the precise moment that the + client instance object on the server was being + deleted. +* Fixed issue on machines which have epoll.h and + the epoll_create glibc call defined, but which + don't actually implement epoll in the kernel. + OpenVPN will now gracefully fall back to the + poll API in this case. +* Fixed Windows bug which would cause the following + error in a --mode server --dev tap configuration: + "resource limit WSA_MAXIMUM_WAIT_EVENTS has been + exceeded". +* Added CRL (certificate revocation list) management + scripts to easy-rsa directory (Jon Bendtsen). +* Do a better job of getting the ifconfig component + of the options consistency check to work correctly + when --up-delay is used. +* De-inlined some functions which were too complex + to be inlined anyway with gcc. +* If a --dhcp-option option is pushed to a non-windows + client, the option will be saved in the client's + environment before the --up script is called, under + the name "foreign_option_{n}". +* Added --learn-address script (see man page) which + allows for firewall access through the VPN to be + controlled based on the client common name. +* In mode --server mode, when a client connects to + the server, the server will disconnect any + still-active clients which use the same common + name. Use --duplicate-cn flag to revert to + previous behavior of allowing multiple clients + to concurrently connect with the same common name. + +2004.06.08 -- Version 2.0-beta4 + +* Fixed issue with beta3 where Win32 service wrapper + was keying off of old TAP HWID as a dependency. To + ensure that the new service wrapper is correctly + installed, the Windows install script will uninstall + the old wrapper before installing the new one, + causing a reset of service properties. +* Fixed permissions issue on --status output file, + with default access permissions of owner read/write + only (default permissions can be changed of course with + chmod). + +2004.06.05 -- Version 2.0-beta3 + +* More changes to TAP-Win32 driver's INF file which + affects the placement of the driver in the Windows + device namespace. This is done to work around an + apparent bug in Windows when short HWIDs are used, + and will also ease the upgrade from 1.x to 2.0 by + reducing the chances that a reboot will be needed + on upgrade. Like beta2, this upgrade will + delete existing TAP-Win32 interfaces, and reinstall + a single new interface with default properties. +* Major rewrite of I/O event wait layer in the style + of libevent. This is a precursor to TCP support + in --mode server. +* New feature: --status. Outputs a SIGUSR2-like + status summary to a given file, updated once + per n seconds. The status file is comma delimited + for easy machine parsing. +* --ifconfig-pool now remembers common names and + will try to assign a consistent IP to a given + common name. Still to do: persist --ifconfig-pool + memory across restarts by saving state in file. +* Fixed bug in event timer queue which could cause + recurring timer events such as --ping to not + correctly schedule again after firing. This in + turn would cause spurrious ping restarts and possible + connection outages. Thanks to Denis Vlasenko for + tracking this down. +* Possible fix to reported bug where --daemon argument + was not printing to syslog correctly after restart. +* Fixed bug where pulling --route or --dhcp-option + directives from a server would problematically + interact with --persist-tun on the client. +* Updated contrib/multilevel-init.patch (Farkas Levente). +* Added RPM build option to .spec and .spec.in files + to optionally disable LZO inclusion (Ian Pilcher). +* The latest MingW runtime and headers define + 'ssize_t', so a patch is needed (Gisle Vanem). + +2004.05.14 -- Version 2.0-beta2 + +* Fixed signal handling bug in --mode server, where + SIGHUP and SIGUSR1 were treated as SIGTERM. +* Changed the TAP-Win32 HWID from "TAP" to "TAPDEV". + Apparently the larger string may work around + a problem where the TAP adapter is sometimes missing + from the network connections panel, especially under + XP SP2. Also note that installing this upgrade will + uninstall any pre-existing TAP-Win32 adapters, and then + install a single new adapter, meaning that old adapter + properties will be lost. Thanks to Md5Chap for solving + this one. +* For --mode server --dev tap, the options --ifconfig and + --ifconfig-pool are now optional. This allows address + assignment via DHCP or use of a TAP VPN without + IP support, as has always been possible with 1.x. +* Fixed bug where --ifconfig may not work correctly on + Linux 2.2. +* Added 'local' flag to --redirect-gateway for use on + networks where both OpenVPN daemons are connected + to a shared subnet, such as wireless. + +2004.05.09 -- Version 2.0-beta1 + +* Unchanged from test29 except for version number + upgrade. + +2004.05.08 -- Version 2.0-test29 + +* Modified --dev-node on Windows to accept a TAP-Win32 + GUID name. In addition, --show-adapters will now + display the high-level name and GUID of each adapter. + This is an attempt to work around an issue in Windows + where sometimes the TAP-Win32 adapter installs correctly + but has no icon in the network connections control + panel. In such cases, being able to specify + --dev-node {TAP-GUID} can work around the missing icon. + +2004.05.07 -- Version 2.0-test28 + +* Fixed bug which could cause segfault on program + shutdown if --route and --persist-tun are used + together. + +2004.05.06 -- Version 2.0-test27 + +* Fixed bug in close_instance() which might cause + memory to be accessed after it had already been freed. +* Fixed bug in verify_callback() that might have + caused uninitialized data to be referenced. +* --iroute now allows full CIDR subnet routing. +* In "--mode server --dev tun" usage, source addresses + on VPN packets coming from a particular client must + be associated with that client in the OpenVPN internal + routing table. + +2004.04.28 -- Version 2.0-test26 + +* Optimized broadcast path in multi-client mode. +* Added socket buffer size options --rcvbuf & --sndbuf. +* Configure Linux tun/tap driver to use a more sensible + txqueuelen default. Also allow explicit setting + via --txqueuelen option (Harald Roelle). +* The --remote option now allows the port number + to be specified as the second parameter. If + unspecified, the port number defaults to the + --rport value. +* Multiple --remote options on the client can now be + specified for load balancing and failover. The + --remote-random flag can be used to initially randomize + the --remote list for basic load balancing. +* If a remote DNS name resolves to multiple DNS addresses, + one will be chosen by random as a kind of basic + load-balancing feature if --remote-random is used. +* Added --connect-freq option to control maximum + new connection frequency in multi-client mode. +* In multi-client mode, all syslog messages associated + with a specific client now include a client-ID prefix. +* For Windows, use a gettimeofday() function based + on QueryPerformanceCounter (Derek Burdick). +* Fixed bug in interaction between --key-method 2 + and DES ciphers, where dynamic keys would be generated + with bad parity and then be rejected. + +2004.04.17 -- Version 2.0-test24 + +* Reworked multi-client broadcast handling. + +2004.04.13 -- Version 2.0-test23 + +* Fixed bug in --dev tun --client-to-client routing. +* Fixed a potential deadlock in --pull. +* Fixed a problem with select() usage which could + cause a repeating sequence of "select : Invalid + argument (code=22)" + +2004.04.11 -- Version 2.0-test22 + +* Fixed bug where --mode server + --daemon was + prematurely closing syslog connection. +* Added support for --redirect-gateway on Mac OS X + (Jeremy Apple). +* Minor changes to TAP-Win32 driver based on feedback + from the NDISTest tool. + +2004.04.11 -- Version 2.0-test21 + +* Optimizations in multi-client server event loop. + +2004.04.10 -- Version 2.0-test20 + +* --mode server capability now works with either tun + or tap interfaces. When used with tap interfaces, + OpenVPN will internally bridge all client tap + interfaces with the server tap interface. +* Connecting clients can now have a client-specific + configuration on the server, based on the client + common name embedded in the client certificate. + See --client-config-dir and --client-connect. + These options can be used to configure client-specific + routes. +* Added an option --client-to-client that enables + internal client-to-client routing or bridging. + Otherwise, clients will only "see" the server, + not other connected clients. +* Fixed bug in route scheduling which would have caused + --mode server to not work on Windows in test18 + and test19 with the sample config file. +* Man page is up to date with all new options. +* OpenVPN 2.0 release notes on web site updated + with tap-style tunnel examples. + +2004.04.02 -- Version 2.0-test19 + +* Fixed bug where routes pushed from server were + not working correctly on Windows clients. +* Added Mac OS X route patch (Jeremy Apple). + +2004.03.30 -- Version 2.0-test18 + +* Minor fixes + Windows self-install modified + to use OpenSSL 0.9.7d. + +2004.03.29 -- Version 2.0-test17 + +* Fixed some bugs related to instance timeout and deletion. +* Extended --push/--pull option to support additional + option classes. + +2004.03.28 -- Version 2.0-test16 + +* Successful test of --mode udp-server, --push, + --pull, and --ifconfig-pool with server on + Linux 2.4 and clients on Linux and Windows. + +2004.03.25 -- Version 2.0-test15 + +* Implemented hash-table lookup of client instances + based either on remote UDP address/port or remote + ifconfig endpoint. +* Implemented a randomized binary tree based + scheduler for scalably scheduling a large number + of client instance events. Uses the treap + data structure and node rotation algorithm + to keep the tree balanced. +* Initial implementation of ifconfig-pool. +* Made --key-method 2 the default. + +2004.03.20 -- Version 2.0-test14 + +* Implemented --push and --pull. + +2004.03.20 -- Version 2.0-test13 + +* Reduced struct tls_multi and --single-session + memory footprint. +* Modified --single-session flag to be used + in multi-client UDP server client instances. + +2004.03.19 -- Version 2.0-test12 + +* Added the key multi-client UDP server options, + --mode, --push, --pull, and --ifconfig-pool. +* Revamped GC (garbage collection) code to not rely + on any global data. +* Modifications to thread.[ch] to allow a more + flexible thread model. + +2004.03.16 -- Version 2.0-test11 + +* Moved all timer code to interval.h, added new file + interval.c. +* Fixed missing include. + +2004.03.16 -- Version 2.0-test10 + +* More TAP-Win32 fixes. +* Initial debugging and testing of multi.[ch]. + +2004.03.14 -- Version 2.0-test9 + +* Branch merge with 1.6-rc3 +* More point-to-multipoint work in multi.[ch]. +* Major TAP-Win32 driver restructuring to use + NdisMRegisterDevice instead of + IoCreateDevice/IoCreateSymbolicLink. +* Changed TAP-Win32 symbolic links to use \DosDevices\Global\ + pathname prefix. +* In the majority of cases, TAP-Win32 should now be + able to install and uninstall on Win2K without requiring + a reboot. +* TAP-Win32 MAC address can now be explicitly set in the + adapter advanced properties page. + +2004.03.04 -- Version 2.0-test8 + +* Branch merge with 1.6-rc2. + +2004.03.03 -- Version 2.0-test7 + +* Branch merge with 1.6-rc1.2. + +2004.03.02 -- Version 2.0-test6 + +* Branch merge with 1.6-rc1. + +2004.03.02 -- Version 2.0-test5 + +* Move Socks5 UDP header append/remove to socks.c, and is + called from forward.c. +* Moved verify statics from ssl.c into struct tls_session. +* Wrote multi.[ch] to handle top level of point-to-multipoint + mode. +* Wrote some code to allow a struct link_socket in a child context + to be slaved to the parent context. +* Broke up packet read and process functions in forward.c + (from socket or tuntap) into separate functions for read + and process, so that point-to-point and point-to-multipoint can + share the same code. +* Expand TLS control channel to allow the passing of configuration + commands. +* Wrote mroute.[ch] to handle internal packet routing for + point-to-multipoint mode. + +2004.02.22 -- Version 2.0-test3 + +* Initial work on UDP multi-client server. +* Branch merge of 1.6-beta7 + +2004.02.14 -- Version 2.0-test2 + +* Refactorization of openvpn.c into openvpn.[ch] + init.[ch] forward.[ch] forward-inline.h + occ.[ch] occ-inline.h ping.[ch] ping-inline.h + sig.[ch]. Created a master per-tunnel + struct context in openvpn.h. +* Branch merge of 1.6-beta6.2 + +2003.11.06 -- Version 2.0-test1 + +* Initial testbed for 2.0. + +2004.05.09 -- Version 1.6.0 + +* Unchanged from 1.6-rc4 except for version number + upgrade. + +2004.04.01 -- Version 1.6-rc4 + +* Made minor customizations to devcon and + renamed as tapinstall.exe for Windows version. +* Fixed "storage size of `iv' isn't known" build + problem on FreeBSD. +* OpenSSL 0.9.7d bundled with Windows self-install. + +2004.03.13 -- Version 1.6-rc3 + +* Minor Windows fixes for --ip-win32 dynamic, relating to + the way the TAP-Win32 driver responds to a DHCP request + from the Windows DHCP client. +* The net_gateway environmental variable wasn't being + set correctly for called scripts (Paul Zuber). +* Added code to determine the default gateway on FreeBSD, + allowing the --redirect-gateway option to work + (Juan Rodriguez Hervella). + +2004.03.04 -- Version 1.6-rc2 + +* Fixed bug in Windows version where the NetBIOS node-type + DHCP option might have been passed even if it was not + specified. +* Fixed bug in Windows version introduced in 1.6-rc1, where + DHCP timeout would be set to 0 seconds if --ifconfig option + was used and --ip-win32 option was not explicitly specified. +* Added some new --dhcp-option types for Windows version. + +2004.03.02 -- Version 1.6-rc1 + +* For Windows, make "--ip-win32 dynamic" the default. +* For Windows, make "--route-delay 10" the default + unless --ip-win32 dynamic is not used or --route-delay + is explicitly specified. +* L_TLS mutex could have been left in a locked state + for certain kinds of TLS errors. + +2004.02.22 -- Version 1.6-beta7 + +* Allow scheduling priority increase (--nice) together + with UID/GID downgrade (--user/--group). +* Code that causes SIGUSR1 restart on TLS errors in TCP + mode was not activated in pthread builds. +* Save the certificate serial number in an environmental + variable called tls_serial_{n} prior to calling the + --tls-verify script. n is the current cert chain level. +* Added NetBSD IPv6 tunnel capability (also requires + a kernel patch) (Horst Laschinsky). +* Fixed bug in checking the return value of the nice() + function (Ian Pilcher). +* Bug fix in new FreeBSD IPv6 over TUN code which was + originally added in 1.6-beta5 (Nathanael Rensen). +* More Socks5 fixes -- extended the struct frame + infrastructure to accomodate proxy-based encapsulation + overhead. +* Added --dhcp-option to Windows version for setting + adapter properties such as WINS & DNS servers. +* Use a default route-delay of 5 seconds when + --ip-win32 dynamic is specified (only applicable when + --route-delay is not explicitly specified). +* Added "log_append" registry variable to control + whether the OpenVPN service wrapper on Windows + opens log files in append (log_append="1") or + truncate (log_append="0") mode. The default + is truncate. + +2004.02.05 -- Version 1.6-beta6 + +* UDP over Socks5 fix to accomodate Socks5 encapsulation + overhead (Christof Meerwald). +* Minor --ip-win32 dynamic tweaks (use long lease time, + invalidate existing lease with DHCPNAK). + +2004.02.01 -- Version 1.6-beta5 + +* Added Socks5 proxy support (Christof Meerwald). +* IPv6 tun support for FreeBSD (Thomas Glanzmann). +* Special TAP-Win32 debug mode for Windows self-install that was + enabled in beta4 is now turned off. +* Added some new Solaris notes to INSTALL (Koen Maris). +* More work on --ip-win32 dynamic. + +2004.01.27 -- Version 1.6-beta4 + +* For this beta, the Windows self-install is a debug version + and will run slower -- use only for testing. +* Reverted the --ip-win32 default back to 'ipapi' + from 'dynamic'. +* Added the offset parameter to '--ip-win32 dynamic' which + can be used to control the address of the masqueraded + DHCP server which replies to Windows DHCP requests. +* Added a wait/nowait option to --inetd (nowait can only + be used with TCP sockets, TLS authentication, and over + a bridged configuration -- see FAQ for more info) + (Stefan `Sec` Zehl). +* Added a build-time capability where TAP-Win32 driver + debug messages can be output by OpenVPN at --verb 6 + or higher. + +2004.01.20 -- Version 1.6-beta2 + +* Added ./configure --enable-iproute2 flag which + uses iproute2 instead of route + ifconfig -- + this is necessary for the LEAF Linux distro + (Martin Hejl). +* Added renewal-time and rebind-time to set of + DHCP options returned by the TAP-Win32 driver when + "--ip-win32 dynamic" is used. + +2004.01.14 -- Version 1.6-beta1 + +* Fixed --proxy bug that sometimes caused plaintext + control info generated by the proxy prior to http + CONNECT method establishment to be incorrectly + parsed as OpenVPN data. +* For Windows version, implemented the + "--ip-win32 dynamic" method and made it the default. + This method sets the TAP-Win32 adapter IP address + and netmask by replying to the kernel's DHCP queries. + See the man page for more detailed info. +* Added --connect-retry parameter which controls + the time interval (in seconds) between connect() + retries when --proto tcp-client is used. Previously, + this value was hardcoded to 5 seconds, and still + defaults as such. +* --resolv-retry can now be used with a parameter + of "infinite" to retry indefinitely. +* Added SSL_CTX_use_certificate_chain_file() to ssl.c + for support of multi-level certificate chains + (Sten Kalenda). +* Fixed --tls-auth incompatibility with 1.4.x and earlier + versions of OpenVPN when the passphrase file is an + OpenVPN static key file (as generated by --genkey). +* Added shell-escape support in config files using + the backslash character ("\") so that (for example) + double quotes can be passed to the shell. +* Added "contrib" subdirectory on tarball, source zip, + and CVS containing user-submitted contributions. +* Added an optional patch to the Redhat init script to + allow the configuration file directory to be a + multi-level directory hierarchy (Farkas Levente). + See contrib/multilevel-init.patch +* Added some scripts and documentation on using + Linux "fwmark" iptables rules to enable + fine-grained routing control over the VPN + (Sean Reifschneider, <jafo@tummy.com>). + See contrib/openvpn-fwmarkroute-1.00 + +2003.11.20 -- Version 1.5.0 + +* Minor documentation changes. + +2003.11.04 -- Version 1.5-beta14 + +* Fixed build problem with ./configure --disable-ssl + that was reported on Debian woody. +* Fixed bug where --redirect-gateway could not be used + together with --resolv-retry. + +2003.11.03 -- Version 1.5-beta13 + +* Added CRL (certificate revocation list) capability using + --crl-verify option (Stefano Bracalenti). +* Added --replay-window option for variable replay-protection + window sizes. +* Fixed --fragment bug which might have caused certain large + packets to be sent unfragmented. +* Modified --secret and --tls-auth to permit different cipher and + HMAC keys to be used for each data flow direction. Also + increased static key file size generated by --genkey from + 1024 to 2048 bits, where 512 bits each are reserved for + send-HMAC, encrypt, receive-HMAC, and decrypt. Key file forward + and backward compatibility is maintained. See --secret option + documentation on the man page for more info. +* Added --tls-remote option (Teemu Kiviniemi). +* Fixed --tls-cipher documention regarding correct delimiter + usage (Teemu Kiviniemi). +* Added --key-method option for selecting alternative data + channel key negotiation methods. Method 1 is the default. + Method 2 has been added (see man page for more info). +* Added French translation of HOWTO to web site + (Guillaume Lehmann). +* Fixed problem caused by late resolver library load on + certain platforms when --resolv-retry and --chroot are + used together (Teemu Kiviniemi). +* In TCP mode, all decryption or TLS errors will abort the current + connection (this is not done in UDP mode because UDP is + "connectionless"). +* Fixed a TCP client reconnect bug that only occurs on the + BSDs, where connect() fails with an invalid argument. This + bug was partially (but not completely) fixed in beta7. +* Added "route_net_gateway" environmental variable which contains + the pre-existing default gateway address from the routing table + (there's no standard API for getting the default gateway, so + right now this feature only works on Windows or Linux). +* Renamed the "route_default_gateway" enviromental variable to + "route_vpn_gateway" -- this is the remote VPN endpoint. +* The special keywords vpn_gateway, net_gateway, and remote_host + can now be used for the network or gateway components of the + --route option. See the man page for more info. +* Added the --redirect-gateway option to configure the VPN + as the default gateway (implemented on Linux and Windows only). +* Added the --http-proxy option with basic authentication + support for use in TCP client mode. Successfully tested + using Squid as the HTTP proxy, with and without authentication. + +2003.10.12 -- Version 1.5-beta12 + +* Fixed Linux-only bug in --mktun and --rmtun which was + introduced around beta8 or so, which would cause + an error such as "I don't recognize device tun0 as a + tun or tap device1". +* Added --ifconfig-nowarn option to disable options + consistency warnings about --ifconfig parameters. +* Don't allow any kind of sequence number backtracking or + message reordering when in TCP mode. +* Changed beta naming convention to use '_' (underscore) + rather than '-' (dash) to pacify rpmbuild. + +2003.10.08 -- Version 1.5-beta11 + +* Modified code in the Windows version which sets the IP address + and netmask of the TAP-Win32 adapter using the IP Helper API. + Most of the changes involve better error recovery when + the IP Helper API returns an error status. See the + manual page entry on --ip-win32 for more info. + +2003.10.08 -- Version 1.5-beta10 + +* Added getpass() function for Windows version so that --askpass + option works correctly (Stefano Bracalenti). +* Added reboot advisory to end of Win32 install script. +* Changed crypto code to use pseudo-random IVs rather than + carrying forward the IV state from the previous packet. + This is in response to item 2 in the following document: + http://www.openssl.org/~bodo/tls-cbc.txt which points + out weaknesses in TLS's use of the same IV carryforward + approach. This change does not break protocol compatibility + with previous versions of OpenVPN. +* Made a change to the crypto replay protection code to also + protect against certain kinds of packet reordering attacks. + This change does not break protocol compatibility with + previous versions of OpenVPN. +* Added --ip-win32 option to provide several choices for + setting the IP address on the TAP-Win32 adapter. +* #ifdefed out non-CBC crypto modes by default. +* Added --up-delay option to delay TUN/TAP open and --up script + execution until after connection establishment. This option + replaces the earlier windows-only option --tap-delay. + +2003.10.01 -- Version 1.5-beta9 + +* Fixed --route-noexec bug where option was not parsed correctly. +* Complain if --dev tun is specified without --ifconfig on Windows. +* Fixed bug where TCP connections on windows would sometimes cause + an assertion failure. +* Added a new flag to TAP-Win32 advanced properties that allows one + to set the adapter to be always "connected" even when an OpenVPN + process doesn't have it open. The default behavior is to report + a media status of connected only when an OpenVPN process has the + adapter open. +* Rebuilt the Windows self-install distribution with OpenSSL 0.9.7c + DLLs in response to an OpenSSL security advisory. + +2003.09.30 -- Version 1.5-beta8 + +* Extended the --ifconfig option to work on tap devices as well + as tun devices. +* Implemented the --ifconfig option for Windows, by calling the + netsh tool. +* By default, do an "arp -d *" on Windows after TAP-Win32 open to + refresh the MAC cache. This behaviour can be disabled with + --no-arp-del. +* On Windows, allow the --dev-node parameter (which specifies + the name of the TAP-Win32 adapter) to be omitted in cases where + there is a single TAP-Win32 adapter on the system which can be + assumed to be the default. +* Modified the diagnostic --verb 5 debugging level to print 'R' + for TCP/UDP read, 'W' for TCP/UDP write, 'r' for TUN/TAP read, + and 'w' for TUN/TAP write. +* Conditionalize OpenBSD read_tun and write_tun based on tun or tap + mode. +* Added IPv6 tun support to OpenBSD (Thomas Glanzmann). +* Make the --enable-mtu-dynamic ./configure option enabled by + default. +* Deprecated the --mtu-dynamic run-time option, in favor of + --fragment. +* DNS names can now be used as --ifconfig parameters. +* Significant work on TAP-Win32 driver to bring up to SMP standards. +* On Windows, fixed dangling IRP problem if TAP-Win32 driver is + unloaded or disabled, while a user-space process has it open. +* On Windows, if --tun-mtu is not specified, it will be read from + the TAP-Win32 driver via ioctl. +* On Windows, added TAP-Win32 driver status info to "F2" keyboard + signal (only when run from a console window). +* Added --mssfix option to control TCP MSS size (YANO Hirokuni). +* Renamed --mtu-dynamic option to --fragment to more accurately + reflect its function. Fragment accepts a single parameter which + is the upper limit on acceptable UDP packet size. +* Changed default --tun-mtu-extra parameter to 32 from 64. +* Eliminated reference to malloc.o in configure.ac. +* Added tun device emulation to the TAP-Win32 driver. +* Added --route and related options. +* Added init script for SuSE Linux (Frank Plohmann). +* Extended option consistency check between peers to function + in all crypto modes, including static-key and cleartext modes. + Previously only TLS mode was supported. Disable with + --disable-occ. +* Overall, increased the amount of configuration option sanity + checking, especially of networking parameters. +* Added --mtu-test option for empirical MTU measurement. +* Added Windows-only option --tap-delay to not set the TAP-Win32 + adapter media state to 'connected' until TCP/UDP connection + establishment with peer. +* Slightly modified --route/--route-delay semantics so that when + --route is given without --route-delay, routes are added + immediately after tun/tap device open. When --route-delay is + specified, routes will be added n seconds after connection + initiation, where n is the --route-delay parameter (which + can be set to 0). +* Made TCP framing error into a non-fatal error that triggers a + connection reset. + +2003.08.28 -- Version 1.5-beta7 + +* Fixed bug that caused OpenVPN not to respond to exit/restart + signals when --resolv-retry is used and a local or remote DNS + name cannot be resolved. +* Exported a series of environmental variables with useful + info for scripts. See man page for more info. Based + on a suggestion by Anthony Ciaravalo. +* Moved TCP/UDP socket bind to a point in the initialization + before the --up script gets called. This is desirable + because (a) a socket bind failure will happen before + daemonization, allowing an error status code to be returned + to the shell and (b) the possibility is eliminated of a + socket bind failure causing the --up script to be run + but not the --down script. This change has a side effect + that --resolv-retry will no longer work with --local. +* Fixed bug where if an OpenVPN TCP server went down and back + up again, Solaris or FreeBSD clients would fail to reconnect + to it. +* Fixed bug that prevented OpenVPN from being run by + inetd/xinetd in TCP mode. +* Added --log and --log-append options for logging messages to + a file. +* On Windows, check that the current user is a member of the + Administrator group before attempting install or uninstall. + +2003.08.16 -- Version 1.5-beta6 + +* Fixed TAP-Win32 driver to properly increment the Rx/Tx count. + +2003.08.14 -- Version 1.5-beta5 + +* Added user-configurability of the TAP-Win32 adapter MTU + through the adapter advanced properties page. +* Added Windows Service support. +* On Windows, added file association and right-clickability + for .ovpn files (OpenVPN config files). + +2003.08.05 -- Version 1.5-beta4 + +* Extra refinements and error checking added to Windows + NSIS install script. + +2003.08.05 -- Version 1.5-beta3 + +* Added md5.h include to crypto.c to fix build problem on + OpenBSD. +* Created a Win32 installer using NSIS. +* Removed DelService command from TAP-Win32 INF file. It appears + to be not necessary and it interfered with the ability to + uninstall and reinstall the driver without needing to reboot. +* On Windows version, added "addtap" and "deltapall" batch + files to add and delete TAP-Win32 adapter instances. + +2003.07.31 -- Version 1.5-beta2 + +* Renamed INSTALL.w32 to INSTALL-win32.txt and reformatted + in Windows ASCII so it's easier to click and view. +* Added postscript and PDF versions of the HOWTO to the web + site (C R Zamana). +* Merged Michael Clarke's stability patch into TAP-Win32 + driver which appears to fix the suspend/resume driver bug + and significantly improve driver stability. +* Added Christof Meerwald's Media Status patch to the + TAP-Win32 driver which shows the TAP adapter to be + disconnected when OpenVPN is not running. +* Moved socket connect and TCP server listen code to a later + point in openvpn() function so that the TCP server listen + state is entered after daemonization. +* Added keyboard shortcuts to simulate signals in the Windows + version, see the window title bar for descriptions. + +2003.07.24 -- Version 1.5-beta1 + +* Added TCP support via the new --proto option. +* Renamed udp-centric options such as --udp-mtu to + --link-mtu (old option names preserved for compatibility). +* Ported to Windows 2000 + XP using mingw and a TAP driver + derived from the Cipe-Win32 project by Damion K. Wilson. +* Added --show-adapters flag for windows version. +* Reworked the SSL/TLS packet acknowledge code to better + handle certain corner cases. +* Turned off the default enabling of IP forwarding in the + sample-scripts/openvpn.init script for Redhat. + Forwarding can be enabled by users in their --up scripts + or firewall config. +* Added --up-restart option based on suggestion from Sean + Reifschneider. +* If --dev tap or --dev-type tap is specified, --tun-mtu + defaults to 1500 and --tun-mtu-extra defaults to 64. +* Enabled --verb 5 debugging mode that prints 'R' and 'W' + for each packet read or write on the TCP/UDP socket. + +2003.08.04 -- Version 1.4.3 + +* Added md5.h include to crypto.c + to fix build problem on OpenBSD. + +2003.07.15 -- Version 1.4.2 + +* Removed adaptive bandwidth from + --mtu-dynamic -- its absence appears + to work better than its existence (1.4.1.2). +* Minor changes to --shaper to fix long + retransmit timeouts at low bandwidth + (1.4.1.2). +* Added LOG_RW flag to openvpn.h for + debugging (1.4.1.2). +* Silenced spurious configure warnings (1.4.1.2). +* Backed out --dev-name patch, modified --dev + to offer equivalent functionality (1.4.1.4). +* Added an optional parameter to --daemon and + --inetd to support the passing of a custom + program name to the system logger (1.4.1.5). +* Add compiled-in options to the program title + (1.4.1.5). +* Coded the beginnings of a WIN32 port (1.4.1.5). +* Succeeded in porting to Win32 Mingw environment + and running loopback tests (1.4.1.6). Still + need a kernel driver for full Win32 + functionality. +* Fixed a bug in error.h where + HAVE_CPP_VARARG_MACRO_GCC was misspelled. + This would have caused a significant slowdown + of OpenVPN when built by compilers that + lack ISO C99 vararg macros (1.4.1.6). +* Created an init script for Gentoo Linux + in ./gentoo directory (1.4.1.6). + +2003.05.15 -- Version 1.4.1 + +* Modified the Linux 2.4 TUN/TAP open code to + fall back to the 2.2 TUN/TAP interface if the + open or ioctl fails. +* Fixed bug when --verb is set to 0 and non-fatal + socket errors occur, causing 100% CPU utilization. + Occurs on platorms where + EXTENDED_SOCKET_ERROR_CAPABILITY is defined, + such as Linux 2.4. +* Fixed typo in tun.c that was preventing + OpenBSD build. +* Added --enable-mtu-dynamic configure option + to enable --mtu-dynamic experimental option. + +2003.05.07 -- Version 1.4.0 + +* Added --replay-persist feature to allow replay + protection across sessions. +* Fixed bug where --ifconfig could not be used + with --tun-mtu. +* Added --tun-mtu-extra parameter to deal with + the situation where a read on a TUN/TAP device + returns more data than the device's MTU size. +* Fixed bug where some IPv6 support code for + Linux was not being properly ifdefed out for + Linux 2.2, causing compile errors. +* Added OPENVPN_EXIT_STATUS_x codes to + openvpn.h to control which status value + openvpn returns to its caller (such as + a shell or inetd/xinetd) for various conditions. +* Added OPENVPN_DEBUG_COMMAND_LINE flag to + openvpn.h to allow debugging in situations + where stdout, stderr, and syslog cannot be used + for message output, such as when OpenVPN is + instantiated by inetd/xinetd. +* Removed owner-execute permission from file + created by static key generator (Herbert Xu + and Alberto Gonzalez Iniesta). +* Added --passtos option to allow IPv4 TOS bits + to be passed from TUN/TAP input packets to + the outgoing UDP socket (Craig Knox). +* Added code to prevent open socket file descriptors + from being accessible to called scripts. +* Added --dev-name option (Christian Lademann). +* Added --mtu-disc option for manual control + over MTU options. +* Show OS MTU value on UDP socket write failures + (linux only). +* Numerous build system and portability + fixes (Matthias Andree). +* Added better sensing of compiler support for + variable argument macros, including (a) gcc + style, (b) ISO C 1999 style, and (c) no support. +* Removed generated files from CVS. Note INSTALL + file for new CVS build commands. +* Changed certain internal symbol names + for C standards compliance. +* Added TUN/TAP open code to cycle dynamically + through unit numbers until it finds a free + unit (based on code from Thomas Gielfeldt + and VTun). +* Added dynamic MTU and fragmenting infrastructure + (Experimental). Rebuild with FRAGMENT_ENABLE + defined to enable. +* Minor changes to SSL/TLS negotiation, use + exponential backoff on retransmits, and use + a smaller MTU size (note that no protocol + changes have been made which would break + compatibility with 1.3.x). +* Added --enable-strict-options flag + to ./configure. This option will cause + a more strict check for options compatibility + between peers when SSL/TLS negotiation is used, + but should only be used when both OpenVPN peers + are of the same version. +* Reorganization of debugging levels. +* Added a workaround in configure.ac for + default SSL header location on Linux + to fix RH9 build problem. +* Fixed potential deadlock when pthread support + is used on OSes that allocate a small socketpair() + message buffer. +* Fixed openvpn.init to be sh compliant + (Bishop Clark). +* Changed --daemon to wait until all + initialization is finished before becoming a + daemon, for the benefit of initialization + scripts that want a useful return status from + the openvpn command. +* Made openvpn.init script more robust, including + positive indication of initialization errors + in the openvpn daemon and better sanity checks. +* Changed --chroot to wait until initialization + is finished before calling chroot(), and allow + the use of --user and --group with --chroot. +* When syslog logging is enabled (--daemon or + --inetd), set stdin/stdout/stderr to point + to /dev/null. +* For inetd instantiations, dup socket descriptor + to a >2 value. +* Fixed bug in verify-cn script, where test would + incorrectly fail if CN=x was the last component + of the X509 composite string (Anonymous). +* Added Markus F.X.J. Oberhumer's special + license exception to COPYING. + +2002.10.23 -- Version 1.3.2 + +* Added SSL_CTX_set_client_CA_list call + to follow the canonical form for TLS initialization + recommended by the OpenSSL docs. This change allows + better support for intermediate CAs and has no impact + on security. +* Added build-inter script to easy-rsa package, to + facilitate the generation of intermediate CAs. +* Ported to NetBSD (Dimitri Goldin). +* Fixed minor bug in easy-rsa/sign-req. It refers to + openssl.cnf file, instead of $KEY_CONFIG, like all + other scripts (Ernesto Baschny). +* Added --days 3650 to the root CA generation command + in the HOWTO to override the woefully small 30 day + default (Dominik 'Aeneas' Schnitzer). +* Fixed bug where --ping-restart would sometimes + not re-resolve remote DNS hostname. +* Added --tun-ipv6 option and related infrastructure + support for IPv6 over tun. +* Added IPv6 over tun support for Linux (Aaron Sethman). +* Added FreeBSD 4.1.1+ TUN/TAP driver notes to + INSTALL (Matthias Andree). +* Added inetd/xinetd support (--inetd) including + documentation in the HOWTO. +* Added "Important Note on the use of commercial certificate + authorities (CAs) with OpenVPN" to HOWTO based on + issues raised on the openvpn-users list. + +2002.07.10 -- Version 1.3.1 + +* Fixed bug in openvpn.spec and openvpn.init + which caused RPM upgrade to fail. + +2002.07.10 -- Version 1.3.0 + +* Added --dev-node option to allow explicit selection of + tun/tap device node. +* Removed mlockall call from child thread, as it doesn't + appear to be necessary (child thread inherits mlockall + state from parent). +* Added --ping-timer-rem which causes timer for --ping-exit + and --ping-restart not to run unless we have a remote IP + address. +* Added condrestart to openvpn.init and openvpn.spec + (Bishop Clark). +* Added --ifconfig case for FreeBSD (Matthias Andree). +* Call openlog with facility=LOG_DAEMON (Matthias Andree). +* Changed LOG_INFO messages to LOG_NOTICE. +* Added warning when key files are group/others accessible. +* Added --single-session flag for TLS mode. +* Fixed bug where --writepid would segfault if used with + an invalid filename. +* Fixed bug where --ipchange status message was formatted + incorrectly. +* Print more concise error message when system() call + fails. +* Added --disable-occ option. +* Added --local, --remote, and --ifconfig options sanity + check. +* Changed default UDP MTU to 1300 and TUN/TAP MTU to + 1300. +* Successfully tested with OpenSSL 0.9.7 Beta 2. +* Broke out debug level definitions to errlevel.h +* Minor documentation and web site changes. +* All changes maintain protocol compatibility + with OpenVPN versions since 1.1.0, however default + MTU changes will require setting the MTU explicitly + by command line option, if you want 1.3.0 to + communicate with previous versions. + +2002.06.12 -- Version 1.2.1 + +* Added --ping-restart option to restart + connection on ping timeout using SIGUSR1 + logic (Matthias Andree). +* Added --persist-tun, --persist-key, + --persist-local-ip, and --persist-remote-ip + options for finer-grained control over SIGUSR1 + and --ping-restart restarts. To + replicate previous SIGUSR1 functionality, + use --persist-remote-ip. +* Changed residual IV fetching code to take + IV from tail of ciphertext. +* Added check to make sure that CFB or OFB + cipher modes are only used with SSL/TLS + authentication mode, and added a caveat + to INSTALL. +* Changed signal handling during initialization + (including re-initialization during restarts) + to exit on SIGTERM or SIGINT and ignore other + signals which would ordinarily be caught. +* Added --resolv-retry option to allow + retries on hostname resolution. +* Expanded the --float option to also + allow dynamic changes in source port number + on incoming datagrams. +* Added --mute option to limit repetitive + logging of similar message types. +* Added --group option to downgrade GID + after initialization. +* Try to set ifconfig path automatically + in configure. +* Added --ifconfig code for Mac OS X + (Christoph Pfisterer). +* Moved "Peer Connection Initiated" message + to --verb level 1. +* Successfully tested with + OpenSSL 0.9.7 Beta 1 and AES cipher. +* Added RPM notes to INSTALL. +* Added ACX_PTHREAD (from the autoconf + macro archive) to configure.ac + to figure out the right pthread + options for a given platform. +* Broke out macro definitions from + configure.ac to acinclude.m4. +* Minor changes to docs and HOWTO. +* All changes maintain protocol compatibility + with OpenVPN versions since 1.1.0. + +2002.05.22 -- Version 1.2.0 + +* Added configuration file support via + the --config option. +* Added pthread support to improve latency. + With pthread support, OpenVPN + will offload CPU-intensive tasks such as RSA + key number crunching to a background thread + to improve tunnel packet forwarding + latency. pthread support can be enabled + with the --enable-pthread configure option. + Pthread support is currently available + only for Linux and Solaris. +* Added --dev-type option so that tun/tap + device names don't need to begin with + "tun" or "tap". +* Added --writepid option to write main + process ID to a file. +* Numerous portability fixes to ease + porting to other OSes including changing + all network types to uint8_t and uint32_t, + and not assuming that time_t is 32 bits. +* Backported to OpenSSL 0.9.5. +* Ported to Solaris. +* Finished OpenBSD port except for + pthread support. +* Added initialization script: + sample-scripts/openvpn.init + (Douglas Keller) +* Ported to Mac OS X (Christoph Pfisterer). +* Improved resilience to DoS attacks when + TLS mode is used without --remote or + --tls-auth, or when --float is used + with --remote. Note however that the best + defense against DoS attacks in TLS mode + is to use --tls-auth. +* Eliminated automake/autoconf dependency + for non-developers. +* Ported configure.in to configure.ac + and autoconf 2.50+. +* SIGHUP signal now causes OpenVPN to restart + and re-read command line and or config file, + in conformance with canonical daemon behaviour. +* SIGUSR1 now does what SIGHUP did in + version 1.1.1 and earlier -- close and reopen + the UDP socket for use when DHCP changes + host's IP address and preserve most recently + authenticated peer address without rereading + config file. +* SIGUSR2 added -- outputs current statistics, + including compression statistics. +* All changes maintain protocol compatibility + with 1.1.1 and 1.1.0. + +2002.04.22 -- Version 1.1.1 + +* Added --ifconfig option to automatically configure + TUN device. +* Added inactivity disconnect (--inactive + and --ping-exit options). +* Added --ping option to keep stateful firewalls + from timing out. +* Added sanity check to command line parser to + err if any TLS options are used in non-TLS mode. +* Fixed build problem with compiler environments that + define printf as a macro. +* Fixed build problem on linux systems that have + an integrated TUN/TAP driver but lack the persistent + tunnel feature (TUNSETPERSIST). Some linux kernels + >= 2.4.0 and < 2.4.7 fall into this category. +* Changed all calls to EVP_CipherInit to use explicit + encrypt/decrypt mode in order to fix problem with + IDEA-CBC and AES-256-CBC ciphers. +* Minor changes to control channel transmit limiter + algorithm to fix problem where TLS control channel + might not renegotiate within the default 60 second window. +* Simplified man page examples by taking advantage + of the new --ifconfig option. +* Minor changes to configure.in to check more + rigourously for OpenSSL 0.9.6 or greater. +* Put back openvpn.spec, eliminated + openvpn.spec.in. +* Modified openvpn.spec to reflect new automake-based + build environment (Bishop Clark). +* Other documentation changes. +* Added --test-crypto option for debugging. +* Added "missing" and "mkinstalldirs" automake + support files. + + +2002.04.09 -- Version 1.1.0 + +* Strengthened replay protection and IV handling, + extending it fully to both static key and + TLS dynamic key exchange modes. +* Added --mlock option to disable paging and ensure that key + material and tunnel data is never paged to disk. +* Added optional traffic shaping feature to cap the maximum + data rate of the tunnel. +* Converted to automake (The Platypus Brothers 2002-04-01). +* Ported to OpenBSD by Janne Johansson. +* Added --tun-af-inet option to work around an incompatibility + between Linux and BSD tun drivers. +* Sequence number-based replay protection using the + IPSec sliding window model is now the default, + disable with --no-replay. +* Explicit IV is now the default, disable with --no-iv. +* Disabled all cipher modes except CBC, CFB, and OFB. +* In CBC mode, use explicit IV and carry forward residuals, + using IPSec model. +* In CFB/OFB mode, IV is timestamp, sequence number. +* Eliminated --packet-id, --timestamp, and max-delta parameter to + the --tls-auth option as they are now supplanted by improved + replay code which is enabled by default. +* Eliminated --rand-iv as it is now obsolete with improved + IV code. +* Eliminated --reneg-err option as it increases vulnerability + to DoS attacks. +* Added weak key check for DES ciphers. +* --tls-freq option is no longer specified on the command line, + instead it now inherits its parameter from the + --tls-timeout option. +* Fixed bug that would try to free memory on exit that was + never malloced if --comp-lzo was not specified. +* Errata fixed in the man page examples: "test-ca" should be + "tmp-ca". +* Updated manual page. +* Preliminary work in porting to OpenSSL 0.9.7. +* Changed license to allowing linking with OpenSSL. + +2002.03.29 -- Version 1.0.3 + +* Fixed a problem in configure with library ordering on the + command line. + +2002.03.28 -- Version 1.0.2 + +* Improved the efficiency of the inner event loop. +* Fixed a minor bug with timeout handling. +* Improved the build system to build on RH 6.2 through 7.2. +* Added an openvpn.spec file for RPM builders (Bishop Clark). + +2002.03.23 -- Version 1.0 + +* Added TLS-based authentication and key exchange. +* Added gremlin mode to stress test. +* Wrote man page. + +2001.12.26 -- Version 0.91 + +* Added any choice of cipher or HMAC digest. + +2001.5.13 -- Version 0.90 + +* Initial release. +* IP tunnel over UDP, with blowfish cipher and SHA1 HMAC signature. @@ -0,0 +1,284 @@ +Installation instructions for OpenVPN, a Secure Tunneling Daemon + +Copyright (C) 2002-2005 OpenVPN Solutions LLC. This program is free software; +you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 +as published by the Free Software Foundation. + +************************************************************************* + +To download OpenVPN, go to: + + http://openvpn.net/download.html + +For step-by-step installation instructions with real-world +examples see: + + http://openvpn.net/howto.html + +For examples see: + + http://openvpn.net/examples.html + +************************************************************************* + +SUPPORTED PLATFORMS: + (1) Linux 2.2+ + (2) Solaris + (3) OpenBSD 3.0+ (Comes with OpenSSL and TUN devices by default) + (4) Mac OS X Darwin + (5) FreeBSD + (6) NetBSD + (7) Windows (Win 2K and higher) + +SUPPORTED PROCESSOR ARCHITECTURES: + In general, OpenVPN is word size and endian independent, so + most processors should be supported. Architectures known to + work include Intel x86, Alpha, Sparc, Amd64, and ARM. + +REQUIRES: + (1) TUN and/or TAP driver to allow user-space programs to control + a virtual point-to-point IP or Ethernet device. See + TUN/TAP Driver Configuration section below for more info. + +OPTIONAL (but recommended): + (1) OpenSSL library, necessary for encryption, version 0.9.5 or higher + required, available from http://www.openssl.org/ + (2) LZO real-time compression library, required for link compression, + available from http://www.oberhumer.com/opensource/lzo/ + OpenBSD users can use ports or packages to install lzo, but remember + to add "--with-lzo-headers" and "--with-lzo-lib" directives to + "configure", pointing to /usr/local/include and /usr/local/lib + respectively since gcc will not find them otherwise. + (3) Pthread library. + +OPTIONAL (for developers only): + (1) Autoconf 2.50 or higher + Automake 1.5 or higher + -- available from http://www.gnu.org/software/software.html + (2) Dmalloc library + -- available from http://dmalloc.com/ + +************************************************************************* + +BUILD COMMANDS FROM TARBALL: + + ./configure + make + make install + +************************************************************************* + +BUILD COMMANDS FROM CVS: + + autoreconf -i -v + ./configure + make + make install + +************************************************************************* + +BUILD A TARBALL FROM CVS: + + autoreconf -i -v + ./configure + make dist + +************************************************************************* + +LOOPBACK TESTS (after BUILD): + +make check (Run all tests below) + +Test Crypto: + +./openvpn --genkey --secret key +./openvpn --test-crypto --secret key + +Test SSL/TLS negotiations (runs for 2 minutes): + +./openvpn --config sample-config-files/loopback-client (In one window) +./openvpn --config sample-config-files/loopback-server (Simultaneously in another window) + +************************************************************************* + +OPTIONS for ./configure: + + --enable-pthread Compile pthread support for + improved latency during SSL/TLS key + negotiations (Linux or Solaris only) + + --disable-lzo Do not compile LZO compression support + --disable-crypto Do not compile OpenSSL crypto support + --disable-ssl Do not compile OpenSSL SSL support for + TLS-based key exchange + + --with-ssl-headers=DIR Crypto/SSL Include files location + --with-ssl-lib=DIR Crypto/SSL Library location + --with-lzo-headers=DIR LZO Include files location + --with-lzo-lib=DIR LZO Library location + + --with-ifconfig-path=PATH Path to ifconfig tool (only need to + specify if in a non-standard location) + + --with-leak-check=TYPE Build with memory leak checking + TYPE = dmalloc or ssl + + --enable-strict Enable strict compiler warnings + + --enable-strict-options Enable strict options check between peers + +************************************************************************* + +BUILDING ON LINUX 2.4+ FROM RPM + +You can build a binary RPM directly from the OpenVPN tarball file: + + rpmbuild -tb [tarball] + +This command will build a binary RPM file and place it in the system +RPM directory. You can then install the RPM with the standard RPM +install command: + + rpm -ivh [binary-rpm] + +When you install the binary RPM, it will install +sample-scripts/openvpn.init, which can be used to +automatically start or stop one or more OpenVPN tunnels on system +startup or shutdown, based on OpenVPN .conf files in /etc/openvpn. +See the comments in openvpn.init for more information. + +Installing the RPM will also configure the TUN/TAP device node +for linux 2.4. + +Note that the current openvpn.spec file, which instructs the rpm tool +how to build a package, will build OpenVPN with all options enabled, +including OpenSSL, LZO, and pthread linkage. Therefore all of +these packages will need to be present prior to the RPM build, unless +you edit the openvpn.spec file. + +************************************************************************* + +TUN/TAP Driver Configuration: + +* Linux 2.4 or higher (with integrated TUN/TAP driver): + + (1) make device node: mknod /dev/net/tun c 10 200 + (2a) add to /etc/modules.conf: alias char-major-10-200 tun + (2b) load driver: modprobe tun + (3) enable routing: echo 1 > /proc/sys/net/ipv4/ip_forward + + Note that either of steps (2a) or (2b) is sufficient. While (2a) + only needs to be done once per install, (2b) needs to be done once + per reboot. If you install from RPM (see above) and use the + openvpn.init script, these steps are taken care of for you. + +* Linux 2.2 or Solaris: + + You should obtain + version 1.1 of the TUN/TAP driver from + http://vtun.sourceforge.net/tun/ + and follow the installation instructions. + +* Solaris + + For 64 bit, I used the tun-1.1.tar.gz source and compiled it. + + Of course there is a but :) + In the tun-1-1\solaris\Makefile I changed a line so it compiles with 64 bit + + CFLAGS = $(DEFS) -m64 -O2 -Wall -D_KERNEL -I. + + I just added -m64 and it worked. + + The tun driver works fine as said previously, however we noticed there is a + minor problem when creating multiple tunnels on Solaris. + Mr Tycho Fruru changed the code in tun.c file where he locked the tun device + number to -1. This way it is impossible to specify the name of the tun device + but it is still possible to have multiple devices. + The modification will increment automatically meaning starting from tun0 ---> + tunX I know you are not responsible for the tun coding but if you think the + modification can be useful for you feel free to use it. + + http://openvpn.net/solaris/tun.c + +* FreeBSD 4.1.1+: + + FreeBSD ships with the TUN/TAP driver, and the device nodes for tap0, + tap1, tap2, tap3, tun0, tun1, tun2 and tun3 are made by default. + However, only the TUN driver is linked into the GENERIC kernel. + + To load the TAP driver, enter: + + kldload if_tap + + See man rc(8) to find out how you can do this at boot time. + + The easiest way is to install OpenVPN from the FreeBSD ports system, + the port includes a sample script to automatically load the TAP driver + at boot-up time. + +* OpenBSD: + + OpenBSD ships with tun0 and tun1 installed by default on pre-3.5 systems, + while 3.5 and later have dynamically created tun* devices so you only need + to create an empty /etc/hostname.tun0 (tun1, tun2 and so on) for each tun + you plan to use to create the device(s) at boot. + +* Mac OS X: + + 2005.02.13: Angelo Laub has developed a GUI for OS X: + + http://rechenknecht.net/OpenVPN-GUI/ + + 2004.10.26: Mattias Nissler has developed a new TUN/TAP driver for + MAC OS X: + + http://www-user.rhrk.uni-kl.de/~nissler/tuntap/ + + Christoph Pfisterer's old TUN driver can be obtained at + http://chrisp.de/en/projects/tunnel.html -- note that it + is no longer being maintained. + +* Solaris9 Sparc/64 + + The kernel module for solaris + can be generated by adding the -m64 switch to a modern + gcc compiler (I'm using 3.2) The resulting kernel driver + needs to be manually copied to /kernel/drv/sparcv9/ and then a + reconfiguration reboot. (boot -r). + +* Windows 2000 and XP + + See INSTALL-win32.txt for more info + + See the man page for more information, usage examples, and + information on firewall configuration. + +************************************************************************* + +CAVEATS & BUGS: + +* I have noticed cases where TCP sessions tunneled over the Linux + TAP driver (kernel 2.4.21 and 2.4.22) stall when lower --mssfix + values are used. The TCP sessions appear to unstall and resume + normally when the remote VPN endpoint is pinged. + +* If run through a firewall using OpenBSDs packet filter PF and the + filter rules include a "scrub" directive, you may get problems talking + to Linux hosts over the tunnel, since the scrubbing will kill packets + sent from Linux hosts if they are fragmented. This is usually seen as + tunnels where small packets and pings get through but large packets + and "regular traffic" don't. To circumvent this, add "no-df" to + the scrub directive so that the packet filter will let fragments with + the "dont fragment"-flag set through anyway. + +* Mixing OFB or CFB cipher modes with static key mode is not recommended, + and is flagged as an error on OpenVPN versions 1.2.1 and greater. + If you use the --cipher option to explicitly select an OFB or CFB + cipher AND you are using static key mode, it is possible that there + could be an IV collision if the OpenVPN daemons on both sides + of the connection are started at exactly the same time, since + OpenVPN uses a timestamp combined with a sequence number as the cipher + IV for OFB and CFB modes. This is not an issue if you are + using CBC cipher mode (the default), or if you are using OFB or CFB + cipher mode with SSL/TLS authentication. diff --git a/INSTALL-win32.txt b/INSTALL-win32.txt new file mode 100644 index 0000000..001b1a6 --- /dev/null +++ b/INSTALL-win32.txt @@ -0,0 +1,3 @@ +OpenVPN on Windows Notes can be found here: + +http://openvpn.net/INSTALL-win32.html diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..590002e --- /dev/null +++ b/Makefile.am @@ -0,0 +1,128 @@ +# +# OpenVPN -- An application to securely tunnel IP networks +# over a single UDP port, with support for SSL/TLS-based +# session authentication and key exchange, +# packet encryption, packet authentication, and +# packet compression. +# +# Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 +# 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 (see the file COPYING included with this +# distribution); if not, write to the Free Software Foundation, Inc., +# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# + +# This option prevents autoreconf from overriding our COPYING and +# INSTALL targets: +AUTOMAKE_OPTIONS = foreign + +sbin_PROGRAMS = openvpn + +nodist_openvpn_SOURCES = config.h + +TESTS = t_lpback.sh t_cltsrv.sh +dist_noinst_SCRIPTS = $(TESTS) + +openvpn_SOURCES = \ + base64.c base64.h \ + basic.h \ + buffer.c buffer.h \ + circ_list.h \ + common.h \ + crypto.c crypto.h \ + errlevel.h \ + error.c error.h \ + event.c event.h \ + fdmisc.c fdmisc.h \ + forward.c forward.h forward-inline.h \ + fragment.c fragment.h \ + gremlin.c gremlin.h \ + helper.c helper.h \ + init.c init.h \ + integer.h \ + interval.c interval.h \ + list.c list.h \ + lzo.c lzo.h \ + manage.c manage.h \ + mbuf.c mbuf.h \ + memdbg.h \ + misc.c misc.h \ + mroute.c mroute.h \ + mss.c mss.h \ + mtcp.c mtcp.h \ + mtu.c mtu.h \ + mudp.c mudp.h \ + multi.c multi.h \ + ntlm.c ntlm.h \ + occ.c occ.h occ-inline.h \ + openvpn.c openvpn.h \ + openvpn-plugin.h \ + options.c options.h \ + otime.c otime.h \ + packet_id.c packet_id.h \ + perf.c perf.h \ + ping.c ping.h ping-inline.h \ + plugin.c plugin.h \ + pool.c pool.h \ + proto.c proto.h \ + proxy.c proxy.h \ + push.c push.h \ + reliable.c reliable.h \ + route.c route.h \ + schedule.c schedule.h \ + session_id.c session_id.h \ + shaper.c shaper.h \ + sig.c sig.h \ + socket.c socket.h \ + socks.c socks.h \ + ssl.c ssl.h \ + status.c status.h \ + syshead.h \ + thread.c thread.h \ + tun.c tun.h + +LDADD = @LIBOBJS@ + +man_MANS = openvpn.8 + +EXTRA_DIST = \ + doclean \ + $(man_MANS) \ + COPYRIGHT.GPL \ + PORTS \ + openvpn.spec \ + easy-rsa \ + sample-config-files \ + sample-keys \ + sample-scripts \ + gentoo \ + suse \ + openvpn.spec.in \ + config-win32.h \ + win32.h \ + win32.c \ + cryptoapi.h \ + cryptoapi.c \ + makefile.w32 \ + makefile.w32-vc \ + INSTALL-win32.txt \ + tap-win32 \ + install-win32 \ + service-win32 \ + contrib \ + debug \ + plugin \ + management + +dist-hook: + cd $(distdir) && for i in $(EXTRA_DIST) ; do find $$i -name CVS -type d -prune -exec rm -r '{}' ';' ; rm -f `find $$i -type f | grep -E '(^|\/)\.?\#|\~$$|\.s?o$$'` ; done @@ -0,0 +1,94 @@ +OpenVPN +Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + + OpenVPN has been written to try to avoid features + that are not standardized well across different + OSes, so porting OpenVPN itself will probably be + straightforward if a tun or tap driver already exists. + + Where special OS features are used, they are usually + bracketed with #ifdef HAVE_SOME_FUNCTION. + +PLATFORM STATUS: + + * Linux 2.2+ (supported) + * Solaris (supported) + * OpenBSD 3.0 (supported but pthreads are broken) + * Max OS X Darwin + * FreeBSD + * NetBSD + * Windows + * 64 bit platforms -- I have heard reports that + OpenVPN runs on Alpha Linux and FreeBSD. + * ARM -- I have heard of at least one case + where OpenVPN was successfully built and + run on the ARM architecture. + +PORTING NOTES: + + * Make sure that OpenSSL will build on your + platform. + * Make sure that a tun or tap virtual device + driver exists for your platform. See + http://vtun.sourceforge.net/tun/ for examples + of tun and tap drivers that have been written + for Linux, Solaris, and FreeBSD. + * Make sure you have autoconf 2.50+ and + automake 1.6+. + * Edit configure.ac, adding platform specific + config code, and a TARGET_YOUROS define. + * Add platform-specific includes to syshead.h. + * Add an #ifdef TARGET_YOUROS to the do_ifconfig() + function in tun.c to generate a correct "ifconfig" + command for your platform. Note that OpenVPN + determines the ifconfig path at ./configure time. + * Add an ifconfig_order() variant for your OS so + openvpn knows whether to call ifconfig before + or after tun/tap dev open. + * Add an #ifdef TARGET_YOUROS block in tun.c and define + the open_tun, close_tun, read_tun, and write_tun + functions. If your tun/tap virtual device is + sufficiently generic, you may be able to use the + default case. + * Add appropriate code to route.c to handle + the route command on your platform. This + is necessary for the --route option to + work correctly. + * After you successfully build OpenVPN, run + the loopback tests as described in INSTALL. + * For the next test, confirm that the UDP socket + functionality is working independently of the + tun device, by doing something like: + ./openvpn --remote localhost --verb 9 --ping 1 --dev null + * Now try with --remote [a real host] + * Now try with a real tun/tap device, you will + need to figure out the appropriate ifconfig + command to use once openvpn has opened the tun/tap + device. + * Once you have simple tests working on the tun device, + try more complex tests such as using TLS mode. + * Stress test the link by doing ping -f across it. + * Make sure that packet fragmenting is happening + correctly by doing a ping -s 2000 or higher. + * Ensure that OpenVPN on your platform will talk + to OpenVPN on other platforms such as Linux. + Some tun/tap driver implementations will prepend + unnecessary stuff onto the datagram that must be + disabled with an explicit ioctl call if cross-platform + compatibility is to be preserved. You can see some + examples of this in tun.c. + * If your system supports pthreads, try building + with ./configure --enable-pthread and do a stress + test in TLS mode. + * Try the ultimate stress test which is --gremlin + --reneg-sec 10 in TLS mode (preferably with pthreads + enabled), then do a flood ping across the tunnel + (ping -f remote-endpoint) in both directions and let + it run overnight. --gremlin will induce massive + corruption and packet loss, but you win if you + wake up the next morning and both peers are still + running and occasionally even succeeding in their + attempted once-per-10-seconds TLS handshake. + * When it's working, submit your patch to + <openvpn-devel@lists.sourceforge.net> + and rejoice :) @@ -0,0 +1,75 @@ +OpenVPN -- A Secure tunneling daemon + +Copyright (C) 2002-2005 OpenVPN Solutions LLC. This program is free software; +you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 +as published by the Free Software Foundation. + +************************************************************************* + +For the latest version of OpenVPN, go to: + + http://openvpn.net/ + +To Build and Install, + + ./configure + make + make install + +or see the file INSTALL for more info. + +************************************************************************* + +For detailed information on OpenVPN, including examples, see the man page + http://openvpn.net/man.html + +For a sample VPN configuration, see + http://openvpn.net/howto.html + +For a description of OpenVPN's underlying protocol, + see the file ssl.h included in the source distribution. + +************************************************************************* + +Other Files & Directories: + +* INSTALL-win32.txt -- installation instructions + for Windows + +* configure.ac -- script to rebuild our configure + script and makefile. + +* openvpn.spec -- RPM Spec file + To build an OpenVPN binary RPM, use the command: + + rpmbuild -tb [tarball] + + When you install the binary RPM, it will automatically + install sample-scripts/openvpn.init (see below) + +* sample-scripts/openvpn.init + + A sample init script for OpenVPN. See the file for + comments and additional information. + +* sample-scripts/verify-cn + + A sample perl script which can be used with OpenVPN's + --tls-verify option to provide a customized authentication + test on embedded X509 certificate fields. + +* sample-keys/ + + Sample RSA keys and certificates. DON'T USE THESE FILES + FOR ANYTHING OTHER THAN TESTING BECAUSE THEY ARE TOTALLY INSECURE. + +* sample-config-files/ + + A collection of OpenVPN config files and scripts from + the HOWTO at http://openvpn.net/howto.html + +* easy-rsa/ + + A simple guide to RSA key management, scripts included. + Also see http://openvpn.net/easyrsa.html diff --git a/acinclude.m4 b/acinclude.m4 new file mode 100644 index 0000000..8ff8dad --- /dev/null +++ b/acinclude.m4 @@ -0,0 +1,346 @@ +dnl Special Autoconf Macros for OpenVPN + +dnl OPENVPN_ADD_LIBS(LIB) +AC_DEFUN([OPENVPN_ADD_LIBS], [ + LIBS="$1 $LIBS" +]) + +dnl @synopsis AX_EMPTY_ARRAY +dnl +dnl Define EMPTY_ARRAY_SIZE to be either "0" +dnl or "" depending on which syntax the compiler +dnl prefers for empty arrays in structs. +dnl +dnl @version +dnl @author James Yonan <jim@yonan.net> + + +AC_DEFUN([AX_EMPTY_ARRAY], [ + AC_MSG_RESULT([checking for C compiler empty array support]) + AC_COMPILE_IFELSE( + [ + struct { int foo; int bar[0]; } mystruct; + ], [ + AC_DEFINE_UNQUOTED(EMPTY_ARRAY_SIZE, 0, [Dimension to use for empty array declaration]) + ], [ + AC_COMPILE_IFELSE( + [ + struct { int foo; int bar[]; } mystruct; + ], [ + AC_DEFINE_UNQUOTED(EMPTY_ARRAY_SIZE,, [Dimension to use for empty array declaration]) + ], [ + AC_MSG_ERROR([C compiler is unable to creaty empty arrays]) + ]) + ]) + ] +) + +dnl @synopsis AX_CPP_VARARG_MACRO_GCC +dnl +dnl Test if the preprocessor understands GNU GCC-style vararg macros. +dnl If it does, defines HAVE_CPP_VARARG_MACRO_GCC to 1. +dnl +dnl @version +dnl @author James Yonan <jim@yonan.net>, Matthias Andree <matthias.andree@web.de> +AC_DEFUN([AX_CPP_VARARG_MACRO_GCC], [dnl + AS_VAR_PUSHDEF([VAR],[ax_cv_cpp_vararg_macro_gcc])dnl + AC_CACHE_CHECK([for GNU GCC vararg macro support], VAR, [dnl + AC_COMPILE_IFELSE([ + #define macro(a, b...) func(a, b) + int func(int a, int b, int c); + int test() { return macro(1, 2, 3); } + ], [ VAR=yes ], [VAR=no])]) + if test $VAR = yes ; then + AC_DEFINE([HAVE_CPP_VARARG_MACRO_GCC], 1, + [Define to 1 if your compiler supports GNU GCC-style variadic macros]) + fi + AS_VAR_POPDEF([VAR])dnl +]) + +dnl @synopsis AX_CPP_VARARG_MACRO_ISO +dnl +dnl Test if the preprocessor understands ISO C 1999 vararg macros. +dnl If it does, defines HAVE_CPP_VARARG_MACRO_ISO to 1. +dnl +dnl @version +dnl @author James Yonan <jim@yonan.net>, Matthias Andree <matthias.andree@web.de> +AC_DEFUN([AX_CPP_VARARG_MACRO_ISO], [dnl + AS_VAR_PUSHDEF([VAR],[ax_cv_cpp_vararg_macro_iso])dnl + AC_CACHE_CHECK([for ISO C 1999 vararg macro support], VAR, [dnl + AC_COMPILE_IFELSE([ +#define macro(a, ...) func(a, __VA_ARGS__) + int func(int a, int b, int c); + int test() { return macro(1, 2, 3); } + ], [ VAR=yes ], [VAR=no])]) + if test $VAR = yes ; then + AC_DEFINE([HAVE_CPP_VARARG_MACRO_ISO], 1, + [Define to 1 if your compiler supports ISO C99 variadic macros]) + fi + AS_VAR_POPDEF([VAR])dnl +]) + +dnl -- The following is taken from curl's acinclude.m4 -- +dnl Check for socklen_t: historically on BSD it is an int, and in +dnl POSIX 1g it is a type of its own, but some platforms use different +dnl types for the argument to getsockopt, getpeername, etc. So we +dnl have to test to find something that will work. +AC_DEFUN([TYPE_SOCKLEN_T], +[ + AC_CHECK_TYPE([socklen_t], ,[ + AC_MSG_CHECKING([for socklen_t equivalent]) + AC_CACHE_VAL([curl_cv_socklen_t_equiv], + [ + # Systems have either "struct sockaddr *" or + # "void *" as the second argument to getpeername + curl_cv_socklen_t_equiv= + for arg2 in "struct sockaddr" void; do + for t in int size_t unsigned long "unsigned long"; do + AC_TRY_COMPILE([ + #include <sys/types.h> + #include <sys/socket.h> + + int getpeername (int, $arg2 *, $t *); + ],[ + $t len; + getpeername(0,0,&len); + ],[ + curl_cv_socklen_t_equiv="$t" + break + ]) + done + done + + if test "x$curl_cv_socklen_t_equiv" = x; then + AC_MSG_ERROR([Cannot find a type to use in place of socklen_t]) + fi + ]) + AC_MSG_RESULT($curl_cv_socklen_t_equiv) + AC_DEFINE_UNQUOTED(socklen_t, $curl_cv_socklen_t_equiv, + [type to use in place of socklen_t if not defined])], + [#include <sys/types.h> +#include <sys/socket.h>]) +]) + +dnl @synopsis ACX_PTHREAD([ACTION-IF-FOUND[, ACTION-IF-NOT-FOUND]]) +dnl +dnl This macro figures out how to build C programs using POSIX +dnl threads. It sets the PTHREAD_LIBS output variable to the threads +dnl library and linker flags, and the PTHREAD_CFLAGS output variable +dnl to any special C compiler flags that are needed. (The user can also +dnl force certain compiler flags/libs to be tested by setting these +dnl environment variables.) +dnl +dnl Also sets PTHREAD_CC to any special C compiler that is needed for +dnl multi-threaded programs (defaults to the value of CC otherwise). +dnl (This is necessary on AIX to use the special cc_r compiler alias.) +dnl +dnl If you are only building threads programs, you may wish to +dnl use these variables in your default LIBS, CFLAGS, and CC: +dnl +dnl LIBS="$PTHREAD_LIBS $LIBS" +dnl CFLAGS="$CFLAGS $PTHREAD_CFLAGS" +dnl CC="$PTHREAD_CC" +dnl +dnl In addition, if the PTHREAD_CREATE_JOINABLE thread-attribute +dnl constant has a nonstandard name, defines PTHREAD_CREATE_JOINABLE +dnl to that name (e.g. PTHREAD_CREATE_UNDETACHED on AIX). +dnl +dnl ACTION-IF-FOUND is a list of shell commands to run if a threads +dnl library is found, and ACTION-IF-NOT-FOUND is a list of commands +dnl to run it if it is not found. If ACTION-IF-FOUND is not specified, +dnl the default action will define HAVE_PTHREAD. +dnl +dnl Please let the authors know if this macro fails on any platform, +dnl or if you have any other suggestions or comments. This macro was +dnl based on work by SGJ on autoconf scripts for FFTW (www.fftw.org) +dnl (with help from M. Frigo), as well as ac_pthread and hb_pthread +dnl macros posted by AFC to the autoconf macro repository. We are also +dnl grateful for the helpful feedback of numerous users. +dnl +dnl @author Steven G. Johnson <stevenj@alum.mit.edu> and Alejandro Forero Cuervo <bachue@bachue.com> + +AC_DEFUN([ACX_PTHREAD], [ +AC_REQUIRE([AC_CANONICAL_HOST]) +acx_pthread_ok=no + +# We used to check for pthread.h first, but this fails if pthread.h +# requires special compiler flags (e.g. on True64 or Sequent). +# It gets checked for in the link test anyway. + +# First of all, check if the user has set any of the PTHREAD_LIBS, +# etcetera environment variables, and if threads linking works using +# them: +if test x"$PTHREAD_LIBS$PTHREAD_CFLAGS" != x; then + save_CFLAGS="$CFLAGS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + save_LIBS="$LIBS" + LIBS="$PTHREAD_LIBS $LIBS" + AC_MSG_CHECKING([for pthread_join in LIBS=$PTHREAD_LIBS with CFLAGS=$PTHREAD_CFLAGS]) + AC_TRY_LINK_FUNC(pthread_join, acx_pthread_ok=yes) + AC_MSG_RESULT($acx_pthread_ok) + if test x"$acx_pthread_ok" = xno; then + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" + fi + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" +fi + +# We must check for the threads library under a number of different +# names; the ordering is very important because some systems +# (e.g. DEC) have both -lpthread and -lpthreads, where one of the +# libraries is broken (non-POSIX). + +# Create a list of thread flags to try. Items starting with a "-" are +# C compiler flags, and other items are library names, except for "none" +# which indicates that we try without any flags at all. + +acx_pthread_flags="pthreads none -Kthread -kthread lthread -pthread -pthreads -mthreads pthread --thread-safe -mt" + +# The ordering *is* (sometimes) important. Some notes on the +# individual items follow: + +# pthreads: AIX (must check this before -lpthread) +# none: in case threads are in libc; should be tried before -Kthread and +# other compiler flags to prevent continual compiler warnings +# -Kthread: Sequent (threads in libc, but -Kthread needed for pthread.h) +# -kthread: FreeBSD kernel threads (preferred to -pthread since SMP-able) +# lthread: LinuxThreads port on FreeBSD (also preferred to -pthread) +# -pthread: Linux/gcc (kernel threads), BSD/gcc (userland threads) +# -pthreads: Solaris/gcc +# -mthreads: Mingw32/gcc, Lynx/gcc +# -mt: Sun Workshop C (may only link SunOS threads [-lthread], but it +# doesn't hurt to check since this sometimes defines pthreads too; +# also defines -D_REENTRANT) +# pthread: Linux, etcetera +# --thread-safe: KAI C++ + +case "$target" in + *solaris*) + + # On Solaris (at least, for some versions), libc contains stubbed + # (non-functional) versions of the pthreads routines, so link-based + # tests will erroneously succeed. (We need to link with -pthread or + # -lpthread.) (The stubs are missing pthread_cleanup_push, or rather + # a function called by this macro, so we could check for that, but + # who knows whether they'll stub that too in a future libc.) So, + # we'll just look for -pthreads and -lpthread first: + + acx_pthread_flags="-pthread -pthreads pthread -mt $acx_pthread_flags" + ;; +esac + +if test x"$acx_pthread_ok" = xno; then +for flag in $acx_pthread_flags; do + + case $flag in + none) + AC_MSG_CHECKING([whether pthreads work without any flags]) + ;; + + -*) + AC_MSG_CHECKING([whether pthreads work with $flag]) + PTHREAD_CFLAGS="$flag" + ;; + + *) + AC_MSG_CHECKING([for the pthreads library -l$flag]) + PTHREAD_LIBS="-l$flag" + ;; + esac + + save_LIBS="$LIBS" + save_CFLAGS="$CFLAGS" + LIBS="$PTHREAD_LIBS $LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + + # Check for various functions. We must include pthread.h, + # since some functions may be macros. (On the Sequent, we + # need a special flag -Kthread to make this header compile.) + # We check for pthread_join because it is in -lpthread on IRIX + # while pthread_create is in libc. We check for pthread_attr_init + # due to DEC craziness with -lpthreads. We check for + # pthread_cleanup_push because it is one of the few pthread + # functions on Solaris that doesn't have a non-functional libc stub. + # We try pthread_create on general principles. + AC_TRY_LINK([#include <pthread.h>], + [pthread_t th; pthread_join(th, 0); + pthread_attr_init(0); pthread_cleanup_push(0, 0); + pthread_create(0,0,0,0); pthread_cleanup_pop(0); ], + [acx_pthread_ok=yes]) + + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" + + AC_MSG_RESULT($acx_pthread_ok) + if test "x$acx_pthread_ok" = xyes; then + break; + fi + + PTHREAD_LIBS="" + PTHREAD_CFLAGS="" +done +fi + +# Various other checks: +if test "x$acx_pthread_ok" = xyes; then + save_LIBS="$LIBS" + LIBS="$PTHREAD_LIBS $LIBS" + save_CFLAGS="$CFLAGS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + + # Detect AIX lossage: threads are created detached by default + # and the JOINABLE attribute has a nonstandard name (UNDETACHED). + AC_MSG_CHECKING([for joinable pthread attribute]) + AC_TRY_LINK([#include <pthread.h>], + [int attr=PTHREAD_CREATE_JOINABLE;], + ok=PTHREAD_CREATE_JOINABLE, ok=unknown) + if test x"$ok" = xunknown; then + AC_TRY_LINK([#include <pthread.h>], + [int attr=PTHREAD_CREATE_UNDETACHED;], + ok=PTHREAD_CREATE_UNDETACHED, ok=unknown) + fi + if test x"$ok" != xPTHREAD_CREATE_JOINABLE; then + AC_DEFINE(PTHREAD_CREATE_JOINABLE, $ok, + [Define to the necessary symbol if this constant + uses a non-standard name on your system.]) + fi + AC_MSG_RESULT(${ok}) + if test x"$ok" = xunknown; then + AC_MSG_WARN([we do not know how to create joinable pthreads]) + fi + + AC_MSG_CHECKING([if more special flags are required for pthreads]) + flag=no + case "$target" in + *-aix* | *-freebsd*) flag="-D_THREAD_SAFE";; + *solaris* | alpha*-osf* | *linux*) flag="-D_REENTRANT";; + esac + AC_MSG_RESULT(${flag}) + if test "x$flag" != xno; then + PTHREAD_CFLAGS="$flag $PTHREAD_CFLAGS" + fi + + LIBS="$save_LIBS" + CFLAGS="$save_CFLAGS" + + # More AIX lossage: must compile with cc_r + AC_CHECK_PROG(PTHREAD_CC, cc_r, cc_r, ${CC}) +else + PTHREAD_CC="$CC" +fi + +AC_SUBST(PTHREAD_LIBS) +AC_SUBST(PTHREAD_CFLAGS) +AC_SUBST(PTHREAD_CC) + +# Finally, execute ACTION-IF-FOUND/ACTION-IF-NOT-FOUND: +if test x"$acx_pthread_ok" = xyes; then + ifelse([$1],,AC_DEFINE(HAVE_PTHREAD,1,[Define if you have POSIX threads libraries and header files.]),[$1]) + : +else + acx_pthread_ok=no + $2 +fi + +])dnl ACX_PTHREAD diff --git a/base64.c b/base64.c new file mode 100644 index 0000000..dcdb0ee --- /dev/null +++ b/base64.c @@ -0,0 +1,146 @@ +/* + * Copyright (c) 1995-2001 Kungliga Tekniska Högskolan + * (Royal Institute of Technology, Stockholm, Sweden). + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of the Institute nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if NTLM + +#include "base64.h" + +#include "memdbg.h" + +static char base64_chars[] = + "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; + +static int +pos(char c) +{ + char *p; + for (p = base64_chars; *p; p++) + if (*p == c) + return p - base64_chars; + return -1; +} + +int +base64_encode(const void *data, int size, char **str) +{ + char *s, *p; + int i; + int c; + const unsigned char *q; + + p = s = (char *) malloc(size * 4 / 3 + 4); + if (p == NULL) + return -1; + q = (const unsigned char *) data; + i = 0; + for (i = 0; i < size;) { + c = q[i++]; + c *= 256; + if (i < size) + c += q[i]; + i++; + c *= 256; + if (i < size) + c += q[i]; + i++; + p[0] = base64_chars[(c & 0x00fc0000) >> 18]; + p[1] = base64_chars[(c & 0x0003f000) >> 12]; + p[2] = base64_chars[(c & 0x00000fc0) >> 6]; + p[3] = base64_chars[(c & 0x0000003f) >> 0]; + if (i > size) + p[3] = '='; + if (i > size + 1) + p[2] = '='; + p += 4; + } + *p = 0; + *str = s; + return strlen(s); +} + +#define DECODE_ERROR 0xffffffff + +static unsigned int +token_decode(const char *token) +{ + int i; + unsigned int val = 0; + int marker = 0; + if (strlen(token) < 4) + return DECODE_ERROR; + for (i = 0; i < 4; i++) { + val *= 64; + if (token[i] == '=') + marker++; + else if (marker > 0) + return DECODE_ERROR; + else + val += pos(token[i]); + } + if (marker > 2) + return DECODE_ERROR; + return (marker << 24) | val; +} + +int +base64_decode(const char *str, void *data) +{ + const char *p; + unsigned char *q; + + q = data; + for (p = str; *p && (*p == '=' || strchr(base64_chars, *p)); p += 4) { + unsigned int val = token_decode(p); + unsigned int marker = (val >> 24) & 0xff; + if (val == DECODE_ERROR) + return -1; + *q++ = (val >> 16) & 0xff; + if (marker < 2) + *q++ = (val >> 8) & 0xff; + if (marker < 1) + *q++ = val & 0xff; + } + return q - (unsigned char *) data; +} + +#else +static void dummy(void) {} +#endif diff --git a/base64.h b/base64.h new file mode 100644 index 0000000..0cd43fa --- /dev/null +++ b/base64.h @@ -0,0 +1,46 @@ +/* + * Copyright (c) 1995, 1996, 1997 Kungliga Tekniska Högskolan + * (Royal Institute of Technology, Stockholm, Sweden). + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. Neither the name of the Institute nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +/* $KTH: base64.h,v 1.2 1999/12/02 16:58:45 joda Exp $ */ + +#ifndef _BASE64_H_ +#define _BASE64_H_ + +#if NTLM + +int base64_encode(const void *data, int size, char **str); +int base64_decode(const char *str, void *data); + +#endif + +#endif @@ -0,0 +1,41 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef BASIC_H +#define BASIC_H + +/* bool definitions */ +#define bool int +#define true 1 +#define false 0 + +#define BOOL_CAST(x) ((x) ? (true) : (false)) + +/* size of an array */ +#define SIZE(x) (sizeof(x)/sizeof(x[0])) + +/* clear an object */ +#define CLEAR(x) memset(&(x), 0, sizeof(x)) + +#endif diff --git a/buffer.c b/buffer.c new file mode 100644 index 0000000..cfff06e --- /dev/null +++ b/buffer.c @@ -0,0 +1,743 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "common.h" +#include "buffer.h" +#include "error.h" +#include "mtu.h" +#include "thread.h" + +#include "memdbg.h" + +struct buffer +#ifdef DMALLOC +alloc_buf_debug (size_t size, const char *file, int line) +#else +alloc_buf (size_t size) +#endif +{ +#ifdef DMALLOC + return alloc_buf_gc_debug (size, NULL, file, line); +#else + return alloc_buf_gc (size, NULL); +#endif +} + +struct buffer +#ifdef DMALLOC +alloc_buf_gc_debug (size_t size, struct gc_arena *gc, const char *file, int line) +#else +alloc_buf_gc (size_t size, struct gc_arena *gc) +#endif +{ + struct buffer buf; + buf.capacity = (int)size; + buf.offset = 0; + buf.len = 0; +#ifdef DMALLOC + buf.data = (uint8_t *) gc_malloc_debug (size, false, gc, file, line); +#else + buf.data = (uint8_t *) gc_malloc (size, false, gc); +#endif + if (size) + *buf.data = 0; + return buf; +} + +struct buffer +#ifdef DMALLOC +clone_buf_debug (const struct buffer* buf, const char *file, int line) +#else +clone_buf (const struct buffer* buf) +#endif +{ + struct buffer ret; + ret.capacity = buf->capacity; + ret.offset = buf->offset; + ret.len = buf->len; +#ifdef DMALLOC + ret.data = (uint8_t *) openvpn_dmalloc (file, line, buf->capacity); +#else + ret.data = (uint8_t *) malloc (buf->capacity); +#endif + check_malloc_return (ret.data); + memcpy (BPTR (&ret), BPTR (buf), BLEN (buf)); + return ret; +} + +#ifdef BUF_INIT_TRACKING + +bool +buf_init_debug (struct buffer *buf, int offset, const char *file, int line) +{ + buf->debug_file = file; + buf->debug_line = line; + return buf_init_dowork (buf, offset); +} + +static inline int +buf_debug_line (const struct buffer *buf) +{ + return buf->debug_line; +} + +static const char * +buf_debug_file (const struct buffer *buf) +{ + return buf->debug_file; +} + +#else + +#define buf_debug_line(buf) 0 +#define buf_debug_file(buf) "[UNDEF]" + +#endif + +void +buf_clear (struct buffer *buf) +{ + if (buf->capacity > 0) + memset (buf->data, 0, buf->capacity); + buf->len = 0; + buf->offset = 0; +} + +bool +buf_assign (struct buffer *dest, const struct buffer *src) +{ + if (!buf_init (dest, src->offset)) + return false; + return buf_write (dest, BPTR (src), BLEN (src)); +} + +struct buffer +clear_buf () +{ + struct buffer buf; + CLEAR (buf); + return buf; +} + +void +free_buf (struct buffer *buf) +{ + if (buf->data) + free (buf->data); + CLEAR (*buf); +} + +/* + * Return a buffer for write that is a subset of another buffer + */ +struct buffer +buf_sub (struct buffer *buf, int size, bool prepend) +{ + struct buffer ret; + uint8_t *data; + + CLEAR (ret); + data = prepend ? buf_prepend (buf, size) : buf_write_alloc (buf, size); + if (data) + { + ret.capacity = size; + ret.data = data; + } + return ret; +} + +/* + * printf append to a buffer with overflow check + */ +void +buf_printf (struct buffer *buf, const char *format, ...) +{ + if (buf_defined (buf)) + { + va_list arglist; + uint8_t *ptr = BEND (buf); + int cap = buf_forward_capacity (buf); + + if (cap > 0) + { + va_start (arglist, format); + vsnprintf ((char *)ptr, cap, format, arglist); + va_end (arglist); + *(buf->data + buf->capacity - 1) = 0; /* windows vsnprintf needs this */ + buf->len += (int) strlen ((char *)ptr); + } + } +} + +/* + * This is necessary due to certain buggy implementations of snprintf, + * that don't guarantee null termination for size > 0. + */ + +int openvpn_snprintf(char *str, size_t size, const char *format, ...) +{ + va_list arglist; + int ret = 0; + if (size > 0) + { + va_start (arglist, format); + ret = vsnprintf (str, size, format, arglist); + va_end (arglist); + str[size - 1] = 0; + } + return ret; +} + +/* + * write a string to the end of a buffer that was + * truncated by buf_printf + */ +void +buf_catrunc (struct buffer *buf, const char *str) +{ + if (buf_forward_capacity (buf) <= 1) + { + int len = (int) strlen (str) + 1; + if (len < buf_forward_capacity_total (buf)) + { + strncpynt ((char *)(buf->data + buf->capacity - len), str, len); + } + } +} + +/* + * convert a multi-line output to one line + */ +void +convert_to_one_line (struct buffer *buf) +{ + uint8_t *cp = BPTR(buf); + int len = BLEN(buf); + while (len--) + { + if (*cp == '\n') + *cp = '|'; + ++cp; + } +} + +/* NOTE: requires that string be null terminated */ +void +buf_write_string_file (const struct buffer *buf, const char *filename, int fd) +{ + const int len = strlen ((char *) BPTR (buf)); + const int size = write (fd, BPTR (buf), len); + if (size != len) + msg (M_ERR, "Write error on file '%s'", filename); +} + +/* + * Garbage collection + */ + +void * +#ifdef DMALLOC +gc_malloc_debug (size_t size, bool clear, struct gc_arena *a, const char *file, int line) +#else +gc_malloc (size_t size, bool clear, struct gc_arena *a) +#endif +{ + void *ret; + if (a) + { + struct gc_entry *e; +#ifdef DMALLOC + e = (struct gc_entry *) openvpn_dmalloc (file, line, size + sizeof (struct gc_entry)); +#else + e = (struct gc_entry *) malloc (size + sizeof (struct gc_entry)); +#endif + check_malloc_return (e); + ret = (char *) e + sizeof (struct gc_entry); + /*mutex_lock_static (L_GC_MALLOC);*/ + e->next = a->list; + a->list = e; + /*mutex_unlock_static (L_GC_MALLOC);*/ + } + else + { +#ifdef DMALLOC + ret = openvpn_dmalloc (file, line, size); +#else + ret = malloc (size); +#endif + check_malloc_return (ret); + } +#ifndef ZERO_BUFFER_ON_ALLOC + if (clear) +#endif + memset (ret, 0, size); + return ret; +} + +void +x_gc_free (struct gc_arena *a) +{ + struct gc_entry *e; + /*mutex_lock_static (L_GC_MALLOC);*/ + e = a->list; + a->list = NULL; + /*mutex_unlock_static (L_GC_MALLOC);*/ + + while (e != NULL) + { + struct gc_entry *next = e->next; + free (e); + e = next; + } +} + +/* + * Hex dump -- Output a binary buffer to a hex string and return it. + */ + +char * +format_hex_ex (const uint8_t *data, int size, int maxoutput, + int space_break, const char* separator, + struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (maxoutput ? maxoutput : + ((size * 2) + (size / space_break) * (int) strlen (separator) + 2), + gc); + int i; + for (i = 0; i < size; ++i) + { + if (separator && i && !(i % space_break)) + buf_printf (&out, "%s", separator); + buf_printf (&out, "%02x", data[i]); + } + buf_catrunc (&out, "[more...]"); + return (char *)out.data; +} + +/* + * remove specific trailing character + */ + +void +buf_rmtail (struct buffer *buf, uint8_t remove) +{ + uint8_t *cp = BLAST(buf); + if (cp && *cp == remove) + { + *cp = '\0'; + --buf->len; + } +} + +/* + * force a null termination even it requires + * truncation of the last char. + */ +void +buf_null_terminate (struct buffer *buf) +{ + char *last = (char *) BLAST (buf); + if (last && *last == '\0') /* already terminated? */ + return; + + if (!buf_safe (buf, 1)) /* make space for trailing null */ + buf_inc_len (buf, -1); + + buf_write_u8 (buf, 0); +} + +/* + * Remove trailing \r and \n chars and ensure + * null termination. + */ +void +buf_chomp (struct buffer *buf) +{ + while (true) + { + char *last = (char *) BLAST (buf); + if (!last) + break; + if (char_class (*last, CC_CRLF|CC_NULL)) + { + if (!buf_inc_len (buf, -1)) + break; + } + else + break; + } + buf_null_terminate (buf); +} + +/* + * like buf_null_terminate, but operate on strings + */ +void +string_null_terminate (char *str, int len, int capacity) +{ + ASSERT (len >= 0 && len <= capacity && capacity > 0); + if (len < capacity) + *(str + len) = '\0'; + else if (len == capacity) + *(str + len - 1) = '\0'; +} + +/* + * Remove trailing \r and \n chars. + */ +void +chomp (char *str) +{ + bool modified; + do { + const int len = strlen (str); + modified = false; + if (len > 0) + { + char *cp = str + (len - 1); + if (*cp == '\n' || *cp == '\r') + { + *cp = '\0'; + modified = true; + } + } + } while (modified); +} + +/* + * Allocate a string + */ +char * +#ifdef DMALLOC +string_alloc_debug (const char *str, struct gc_arena *gc, const char *file, int line) +#else +string_alloc (const char *str, struct gc_arena *gc) +#endif +{ + if (str) + { + const int n = strlen (str) + 1; + char *ret; + +#ifdef DMALLOC + ret = (char *) gc_malloc_debug (n, false, gc, file, line); +#else + ret = (char *) gc_malloc (n, false, gc); +#endif + memcpy (ret, str, n); + return ret; + } + else + return NULL; +} + +/* + * Allocate a string inside a buffer + */ +struct buffer +#ifdef DMALLOC +string_alloc_buf_debug (const char *str, struct gc_arena *gc, const char *file, int line) +#else +string_alloc_buf (const char *str, struct gc_arena *gc) +#endif +{ + struct buffer buf; + + ASSERT (str); + +#ifdef DMALLOC + buf_set_read (&buf, (uint8_t*) string_alloc_debug (str, gc, file, line), strlen (str) + 1); +#else + buf_set_read (&buf, (uint8_t*) string_alloc (str, gc), strlen (str) + 1); +#endif + + if (buf.len > 0) /* Don't count trailing '\0' as part of length */ + --buf.len; + + return buf; +} + +/* + * String comparison + */ + +bool +buf_string_match_head_str (const struct buffer *src, const char *match) +{ + const int size = strlen (match); + if (size < 0 || size > src->len) + return false; + return memcmp (BPTR (src), match, size) == 0; +} + +bool +buf_string_compare_advance (struct buffer *src, const char *match) +{ + if (buf_string_match_head_str (src, match)) + { + buf_advance (src, strlen (match)); + return true; + } + else + return false; +} + +int +buf_substring_len (const struct buffer *buf, int delim) +{ + int i = 0; + struct buffer tmp = *buf; + int c; + + while ((c = buf_read_u8 (&tmp)) >= 0) + { + ++i; + if (c == delim) + return i; + } + return -1; +} + +/* + * String parsing + */ + +bool +buf_parse (struct buffer *buf, const int delim, char *line, const int size) +{ + bool eol = false; + int n = 0; + int c; + + ASSERT (size > 0); + + do + { + c = buf_read_u8 (buf); + if (c < 0) + eol = true; + if (c <= 0 || c == delim) + c = 0; + if (n >= size) + break; + line[n++] = c; + } + while (c); + + line[size-1] = '\0'; + return !(eol && !strlen (line)); +} + +/* + * Classify and mutate strings based on character types. + */ + +bool +char_class (const char c, const unsigned int flags) +{ + if (!flags) + return false; + if (flags & CC_ANY) + return true; + + if ((flags & CC_NULL) && c == '\0') + return true; + + if ((flags & CC_ALNUM) && isalnum (c)) + return true; + if ((flags & CC_ALPHA) && isalpha (c)) + return true; + if ((flags & CC_ASCII) && isascii (c)) + return true; + if ((flags & CC_CNTRL) && iscntrl (c)) + return true; + if ((flags & CC_DIGIT) && isdigit (c)) + return true; + if ((flags & CC_PRINT) && isprint (c)) + return true; + if ((flags & CC_PUNCT) && ispunct (c)) + return true; + if ((flags & CC_SPACE) && isspace (c)) + return true; + if ((flags & CC_XDIGIT) && isxdigit (c)) + return true; + + if ((flags & CC_BLANK) && (c == ' ' || c == '\t')) + return true; + if ((flags & CC_NEWLINE) && c == '\n') + return true; + if ((flags & CC_CR) && c == '\r') + return true; + + if ((flags & CC_BACKSLASH) && c == '\\') + return true; + if ((flags & CC_UNDERBAR) && c == '_') + return true; + if ((flags & CC_DASH) && c == '-') + return true; + if ((flags & CC_DOT) && c == '.') + return true; + if ((flags & CC_COMMA) && c == ',') + return true; + if ((flags & CC_COLON) && c == ':') + return true; + if ((flags & CC_SLASH) && c == '/') + return true; + if ((flags & CC_SINGLE_QUOTE) && c == '\'') + return true; + if ((flags & CC_DOUBLE_QUOTE) && c == '\"') + return true; + if ((flags & CC_REVERSE_QUOTE) && c == '`') + return true; + if ((flags & CC_AT) && c == '@') + return true; + if ((flags & CC_EQUAL) && c == '=') + return true; + + return false; +} + +static inline bool +char_inc_exc (const char c, const unsigned int inclusive, const unsigned int exclusive) +{ + return char_class (c, inclusive) && !char_class (c, exclusive); +} + +bool +string_class (const char *str, const unsigned int inclusive, const unsigned int exclusive) +{ + char c; + ASSERT (str); + while ((c = *str++)) + { + if (!char_inc_exc (c, inclusive, exclusive)) + return false; + } + return true; +} + +/* + * Modify string in place. + * Guaranteed to not increase string length. + */ +bool +string_mod (char *str, const unsigned int inclusive, const unsigned int exclusive, const char replace) +{ + const char *in = str; + bool ret = true; + + ASSERT (str); + + while (true) + { + char c = *in++; + if (c) + { + if (!char_inc_exc (c, inclusive, exclusive)) + { + c = replace; + ret = false; + } + if (c) + *str++ = c; + } + else + { + *str = '\0'; + break; + } + } + return ret; +} + +const char * +string_mod_const (const char *str, + const unsigned int inclusive, + const unsigned int exclusive, + const char replace, + struct gc_arena *gc) +{ + if (str) + { + char *buf = string_alloc (str, gc); + string_mod (buf, inclusive, exclusive, replace); + return buf; + } + else + return NULL; +} + +#ifdef CHARACTER_CLASS_DEBUG + +#define CC_INCLUDE (CC_PRINT) +#define CC_EXCLUDE (0) +#define CC_REPLACE ('.') + +void +character_class_debug (void) +{ + char buf[256]; + + while (fgets (buf, sizeof (buf), stdin) != NULL) + { + string_mod (buf, CC_INCLUDE, CC_EXCLUDE, CC_REPLACE); + printf ("%s", buf); + } +} + +#endif + +#ifdef VERIFY_ALIGNMENT +void +valign4 (const struct buffer *buf, const char *file, const int line) +{ + if (buf && buf->len) + { + int msglevel = D_ALIGN_DEBUG; + const unsigned int u = (unsigned int) BPTR (buf); + + if (u & (PAYLOAD_ALIGN-1)) + msglevel = D_ALIGN_ERRORS; + + msg (msglevel, "%sAlignment at %s/%d ptr=" ptr_format " OLC=%d/%d/%d I=%s/%d", + (msglevel == D_ALIGN_ERRORS) ? "ERROR: " : "", + file, + line, + (ptr_type)buf->data, + buf->offset, + buf->len, + buf->capacity, + buf_debug_file (buf), + buf_debug_line (buf)); + } +} +#endif diff --git a/buffer.h b/buffer.h new file mode 100644 index 0000000..1e5266b --- /dev/null +++ b/buffer.h @@ -0,0 +1,712 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef BUFFER_H +#define BUFFER_H + +#include "basic.h" +#include "thread.h" + +/* + * Define verify_align function, otherwise + * it will be a noop. + */ +/* #define VERIFY_ALIGNMENT */ + +/* + * Keep track of source file/line of buf_init calls + */ +#ifdef VERIFY_ALIGNMENT +#define BUF_INIT_TRACKING +#endif + +/* basic buffer class for OpenVPN */ + +struct buffer +{ + int capacity; /* size of buffer allocated by malloc */ + int offset; /* data starts at data + offset, offset > 0 to allow for efficient prepending */ + int len; /* length of data that starts at data + offset */ + uint8_t *data; + +#ifdef BUF_INIT_TRACKING + const char *debug_file; + int debug_line; +#endif +}; + +/* for garbage collection */ + +struct gc_entry +{ + struct gc_entry *next; +}; + +struct gc_arena +{ + struct gc_entry *list; +}; + +#define BPTR(buf) ((buf)->data + (buf)->offset) +#define BEND(buf) (BPTR(buf) + (buf)->len) +#define BLAST(buf) (((buf)->data && (buf)->len) ? (BPTR(buf) + (buf)->len - 1) : NULL) +#define BLEN(buf) ((buf)->len) +#define BDEF(buf) ((buf)->data != NULL) +#define BSTR(buf) ((char *)BPTR(buf)) +#define BCAP(buf) (buf_forward_capacity (buf)) + +void buf_clear (struct buffer *buf); + +struct buffer clear_buf (void); +void free_buf (struct buffer *buf); + +bool buf_assign (struct buffer *dest, const struct buffer *src); + + + +/* for dmalloc debugging */ + +#ifdef DMALLOC + +#define alloc_buf(size) alloc_buf_debug (size, __FILE__, __LINE__) +#define alloc_buf_gc(size, gc) alloc_buf_gc_debug (size, gc, __FILE__, __LINE__); +#define clone_buf(buf) clone_buf_debug (buf, __FILE__, __LINE__); +#define gc_malloc(size, clear, arena) gc_malloc_debug (size, clear, arena, __FILE__, __LINE__) +#define string_alloc(str, gc) string_alloc_debug (str, gc, __FILE__, __LINE__) +#define string_alloc_buf(str, gc) string_alloc_buf_debug (str, gc, __FILE__, __LINE__) + +struct buffer alloc_buf_debug (size_t size, const char *file, int line); +struct buffer alloc_buf_gc_debug (size_t size, struct gc_arena *gc, const char *file, int line); +struct buffer clone_buf_debug (const struct buffer* buf, const char *file, int line); +void *gc_malloc_debug (size_t size, bool clear, struct gc_arena *a, const char *file, int line); +char *string_alloc_debug (const char *str, struct gc_arena *gc, const char *file, int line); +struct buffer string_alloc_buf_debug (const char *str, struct gc_arena *gc, const char *file, int line); + +#else + +struct buffer alloc_buf (size_t size); +struct buffer alloc_buf_gc (size_t size, struct gc_arena *gc); /* allocate buffer with garbage collection */ +struct buffer clone_buf (const struct buffer* buf); +void *gc_malloc (size_t size, bool clear, struct gc_arena *a); +char *string_alloc (const char *str, struct gc_arena *gc); +struct buffer string_alloc_buf (const char *str, struct gc_arena *gc); + +#endif + +#ifdef BUF_INIT_TRACKING +#define buf_init(buf, offset) buf_init_debug (buf, offset, __FILE__, __LINE__) +bool buf_init_debug (struct buffer *buf, int offset, const char *file, int line); +#else +#define buf_init(buf, offset) buf_init_dowork (buf, offset) +#endif + + +/* inline functions */ + +static inline void +buf_reset (struct buffer *buf) +{ + buf->capacity = 0; + buf->offset = 0; + buf->len = 0; + buf->data = NULL; +} + +static inline bool +buf_init_dowork (struct buffer *buf, int offset) +{ + if (offset < 0 || offset > buf->capacity || buf->data == NULL) + return false; + buf->len = 0; + buf->offset = offset; + return true; +} + +static inline bool +buf_defined (struct buffer *buf) +{ + return buf->data != NULL; +} + +static inline void +buf_set_write (struct buffer *buf, uint8_t *data, int size) +{ + buf->len = 0; + buf->offset = 0; + buf->capacity = size; + buf->data = data; + if (size > 0 && data) + *data = 0; +} + +static inline void +buf_set_read (struct buffer *buf, const uint8_t *data, int size) +{ + buf->len = buf->capacity = size; + buf->offset = 0; + buf->data = (uint8_t *)data; +} + +/* Like strncpy but makes sure dest is always null terminated */ +static inline void +strncpynt (char *dest, const char *src, size_t maxlen) +{ + strncpy (dest, src, maxlen); + if (maxlen > 0) + dest[maxlen - 1] = 0; +} + +/* return true if string contains at least one numerical digit */ +static inline bool +has_digit (const char* src) +{ + char c; + while ((c = *src++)) + { + if (isdigit(c)) + return true; + } + return false; +} + +/* + * printf append to a buffer with overflow check + */ +void buf_printf (struct buffer *buf, const char *format, ...) +#ifdef __GNUC__ + __attribute__ ((format (printf, 2, 3))) +#endif + ; + +/* + * Like snprintf but guarantees null termination for size > 0 + */ +int openvpn_snprintf(char *str, size_t size, const char *format, ...) +#ifdef __GNUC__ + __attribute__ ((format (printf, 3, 4))) +#endif + ; + +/* + * remove/add trailing characters + */ + +void buf_null_terminate (struct buffer *buf); +void buf_chomp (struct buffer *buf); +void buf_rmtail (struct buffer *buf, uint8_t remove); + +/* + * non-buffer string functions + */ +void chomp (char *str); +void string_null_terminate (char *str, int len, int capacity); + +/* + * Write string in buf to file descriptor fd. + * NOTE: requires that string be null terminated. + */ +void buf_write_string_file (const struct buffer *buf, const char *filename, int fd); + +/* + * write a string to the end of a buffer that was + * truncated by buf_printf + */ +void buf_catrunc (struct buffer *buf, const char *str); + +/* + * convert a multi-line output to one line + */ +void convert_to_one_line (struct buffer *buf); + +/* + * Parse a string based on a given delimiter char + */ +bool buf_parse (struct buffer *buf, const int delim, char *line, const int size); + +/* + * Hex dump -- Output a binary buffer to a hex string and return it. + */ +char * +format_hex_ex (const uint8_t *data, int size, int maxoutput, + int space_break, const char* separator, + struct gc_arena *gc); + +static inline char * +format_hex (const uint8_t *data, int size, int maxoutput, struct gc_arena *gc) +{ + return format_hex_ex (data, size, maxoutput, 4, " ", gc); +} + +/* + * Return a buffer that is a subset of another buffer. + */ +struct buffer buf_sub (struct buffer *buf, int size, bool prepend); + +/* + * Check if sufficient space to append to buffer. + */ + +static inline bool +buf_safe (const struct buffer *buf, int len) +{ + return len >= 0 && buf->offset + buf->len + len <= buf->capacity; +} + +static inline bool +buf_safe_bidir (const struct buffer *buf, int len) +{ + const int newlen = buf->len + len; + return newlen >= 0 && buf->offset + newlen <= buf->capacity; +} + +static inline int +buf_forward_capacity (const struct buffer *buf) +{ + int ret = buf->capacity - (buf->offset + buf->len); + if (ret < 0) + ret = 0; + return ret; +} + +static inline int +buf_forward_capacity_total (const struct buffer *buf) +{ + int ret = buf->capacity - buf->offset; + if (ret < 0) + ret = 0; + return ret; +} + +static inline int +buf_reverse_capacity (const struct buffer *buf) +{ + return buf->offset; +} + +static inline bool +buf_inc_len (struct buffer *buf, int inc) +{ + if (!buf_safe_bidir (buf, inc)) + return false; + buf->len += inc; + return true; +} + +/* + * Make space to prepend to a buffer. + * Return NULL if no space. + */ + +static inline uint8_t * +buf_prepend (struct buffer *buf, int size) +{ + if (size < 0 || size > buf->offset) + return NULL; + buf->offset -= size; + buf->len += size; + return BPTR (buf); +} + +static inline bool +buf_advance (struct buffer *buf, int size) +{ + if (size < 0 || buf->len < size) + return false; + buf->offset += size; + buf->len -= size; + return true; +} + +/* + * Return a pointer to allocated space inside a buffer. + * Return NULL if no space. + */ + +static inline uint8_t * +buf_write_alloc (struct buffer *buf, int size) +{ + uint8_t *ret; + if (!buf_safe (buf, size)) + return NULL; + ret = BPTR (buf) + buf->len; + buf->len += size; + return ret; +} + +static inline uint8_t * +buf_write_alloc_prepend (struct buffer *buf, int size, bool prepend) +{ + return prepend ? buf_prepend (buf, size) : buf_write_alloc (buf, size); +} + +static inline uint8_t * +buf_read_alloc (struct buffer *buf, int size) +{ + uint8_t *ret; + if (size < 0 || buf->len < size) + return NULL; + ret = BPTR (buf); + buf->offset += size; + buf->len -= size; + return ret; +} + +static inline bool +buf_write (struct buffer *dest, const void *src, int size) +{ + uint8_t *cp = buf_write_alloc (dest, size); + if (!cp) + return false; + memcpy (cp, src, size); + return true; +} + +static inline bool +buf_write_prepend (struct buffer *dest, const void *src, int size) +{ + uint8_t *cp = buf_prepend (dest, size); + if (!cp) + return false; + memcpy (cp, src, size); + return true; +} + +static inline bool +buf_write_u8 (struct buffer *dest, int data) +{ + uint8_t u8 = (uint8_t) data; + return buf_write (dest, &u8, sizeof (uint8_t)); +} + +static inline bool +buf_write_u16 (struct buffer *dest, int data) +{ + uint16_t u16 = htons ((uint16_t) data); + return buf_write (dest, &u16, sizeof (uint16_t)); +} + +static inline bool +buf_write_u32 (struct buffer *dest, int data) +{ + uint32_t u32 = htonl ((uint32_t) data); + return buf_write (dest, &u32, sizeof (uint32_t)); +} + +static inline bool +buf_copy (struct buffer *dest, const struct buffer *src) +{ + return buf_write (dest, BPTR (src), BLEN (src)); +} + +static inline bool +buf_copy_n (struct buffer *dest, struct buffer *src, int n) +{ + uint8_t *cp = buf_read_alloc (src, n); + if (!cp) + return false; + return buf_write (dest, cp, n); +} + +static inline bool +buf_copy_range (struct buffer *dest, + int dest_index, + const struct buffer *src, + int src_index, + int src_len) +{ + if (src_index < 0 + || src_len < 0 + || src_index + src_len > src->len + || dest_index < 0 + || dest->offset + dest_index + src_len > dest->capacity) + return false; + memcpy (dest->data + dest->offset + dest_index, src->data + src->offset + src_index, src_len); + if (dest_index + src_len > dest->len) + dest->len = dest_index + src_len; + return true; +} + +/* truncate src to len, copy excess data beyond len to dest */ +static inline bool +buf_copy_excess (struct buffer *dest, + struct buffer *src, + int len) +{ + if (len < 0) + return false; + if (src->len > len) + { + struct buffer b = *src; + src->len = len; + if (!buf_advance (&b, len)) + return false; + return buf_copy (dest, &b); + } + else + { + return true; + } +} + +static inline bool +buf_read (struct buffer *src, void *dest, int size) +{ + uint8_t *cp = buf_read_alloc (src, size); + if (!cp) + return false; + memcpy (dest, cp, size); + return true; +} + +static inline int +buf_read_u8 (struct buffer *buf) +{ + int ret; + if (BLEN (buf) < 1) + return -1; + ret = *BPTR(buf); + buf_advance (buf, 1); + return ret; +} + +static inline int +buf_read_u16 (struct buffer *buf) +{ + uint16_t ret; + if (!buf_read (buf, &ret, sizeof (uint16_t))) + return -1; + return ntohs (ret); +} + +static inline uint32_t +buf_read_u32 (struct buffer *buf, bool *good) +{ + uint32_t ret; + if (!buf_read (buf, &ret, sizeof (uint32_t))) + { + if (good) + *good = false; + return 0; + } + else + { + if (good) + *good = true; + return ntohl (ret); + } +} + +static inline bool +buf_string_match (const struct buffer *src, const void *match, int size) +{ + if (size != src->len) + return false; + return memcmp (BPTR (src), match, size) == 0; +} + +static inline bool +buf_string_match_head (const struct buffer *src, const void *match, int size) +{ + if (size < 0 || size > src->len) + return false; + return memcmp (BPTR (src), match, size) == 0; +} + +bool buf_string_match_head_str (const struct buffer *src, const char *match); +bool buf_string_compare_advance (struct buffer *src, const char *match); +int buf_substring_len (const struct buffer *buf, int delim); + +/* + * Bitwise operations + */ +static inline void +xor (uint8_t *dest, const uint8_t *src, int len) +{ + while (len-- > 0) + *dest++ ^= *src++; +} + +/* + * Classify and mutate strings based on character types. + */ + +/*#define CHARACTER_CLASS_DEBUG*/ + +/* character classes */ + +#define CC_ANY (1<<0) +#define CC_NULL (1<<1) + +#define CC_ALNUM (1<<2) +#define CC_ALPHA (1<<3) +#define CC_ASCII (1<<4) +#define CC_CNTRL (1<<5) +#define CC_DIGIT (1<<6) +#define CC_PRINT (1<<7) +#define CC_PUNCT (1<<8) +#define CC_SPACE (1<<9) +#define CC_XDIGIT (1<<10) + +#define CC_BLANK (1<<11) +#define CC_NEWLINE (1<<12) +#define CC_CR (1<<13) + +#define CC_BACKSLASH (1<<14) +#define CC_UNDERBAR (1<<15) +#define CC_DASH (1<<16) +#define CC_DOT (1<<17) +#define CC_COMMA (1<<18) +#define CC_COLON (1<<19) +#define CC_SLASH (1<<20) +#define CC_SINGLE_QUOTE (1<<21) +#define CC_DOUBLE_QUOTE (1<<22) +#define CC_REVERSE_QUOTE (1<<23) +#define CC_AT (1<<24) +#define CC_EQUAL (1<<25) + +/* macro classes */ +#define CC_NAME (CC_ALNUM|CC_UNDERBAR) +#define CC_CRLF (CC_CR|CC_NEWLINE) + +bool char_class (const char c, const unsigned int flags); +bool string_class (const char *str, const unsigned int inclusive, const unsigned int exclusive); +bool string_mod (char *str, const unsigned int inclusive, const unsigned int exclusive, const char replace); + +const char *string_mod_const (const char *str, + const unsigned int inclusive, + const unsigned int exclusive, + const char replace, + struct gc_arena *gc); + +#ifdef CHARACTER_CLASS_DEBUG +void character_class_debug (void); +#endif + +/* + * Verify that a pointer is correctly aligned + */ +#ifdef VERIFY_ALIGNMENT + void valign4 (const struct buffer *buf, const char *file, const int line); +# define verify_align_4(ptr) valign4(buf, __FILE__, __LINE__) +#else +# define verify_align_4(ptr) +#endif + +/* + * Very basic garbage collection, mostly for routines that return + * char ptrs to malloced strings. + */ + +void x_gc_free (struct gc_arena *a); + +static inline void +gc_init (struct gc_arena *a) +{ + a->list = NULL; +} + +static inline void +gc_detach (struct gc_arena *a) +{ + gc_init (a); +} + +static inline struct gc_arena +gc_new (void) +{ + struct gc_arena ret; + ret.list = NULL; + return ret; +} + +static inline void +gc_free (struct gc_arena *a) +{ + if (a->list) + x_gc_free (a); +} + +static inline void +gc_reset (struct gc_arena *a) +{ + gc_free (a); +} + +/* + * Allocate memory to hold a structure + */ + +void out_of_memory (void); + +#define ALLOC_OBJ(dptr, type) \ +{ \ + check_malloc_return ((dptr) = (type *) malloc (sizeof (type))); \ +} + +#define ALLOC_OBJ_CLEAR(dptr, type) \ +{ \ + ALLOC_OBJ (dptr, type); \ + memset ((dptr), 0, sizeof(type)); \ +} + +#define ALLOC_ARRAY(dptr, type, n) \ +{ \ + check_malloc_return ((dptr) = (type *) malloc (sizeof (type) * (n))); \ +} + +#define ALLOC_ARRAY_GC(dptr, type, n, gc) \ +{ \ + (dptr) = (type *) gc_malloc (sizeof (type) * (n), false, (gc)); \ +} + +#define ALLOC_ARRAY_CLEAR(dptr, type, n) \ +{ \ + ALLOC_ARRAY (dptr, type, n); \ + memset ((dptr), 0, (sizeof(type) * (n))); \ +} + +#define ALLOC_ARRAY_CLEAR_GC(dptr, type, n, gc) \ +{ \ + (dptr) = (type *) gc_malloc (sizeof (type) * (n), true, (gc)); \ +} + +#define ALLOC_OBJ_GC(dptr, type, gc) \ +{ \ + (dptr) = (type *) gc_malloc (sizeof (type), false, (gc)); \ +} + +#define ALLOC_OBJ_CLEAR_GC(dptr, type, gc) \ +{ \ + (dptr) = (type *) gc_malloc (sizeof (type), true, (gc)); \ +} + +static inline void +check_malloc_return (void *p) +{ + void out_of_memory (void); + if (!p) + out_of_memory (); +} + +#endif /* BUFFER_H */ diff --git a/circ_list.h b/circ_list.h new file mode 100644 index 0000000..3859199 --- /dev/null +++ b/circ_list.h @@ -0,0 +1,78 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef CIRC_LIST_H +#define CIRC_LIST_H + +#include "basic.h" +#include "integer.h" +#include "error.h" + +#define CIRC_LIST(name, type) \ +struct name { \ + int x_head; \ + int x_size; \ + int x_cap; \ + int x_sizeof; \ + type x_list[EMPTY_ARRAY_SIZE]; \ +} + +#define CIRC_LIST_PUSH(obj, item) \ +{ \ + (obj)->x_head = modulo_add ((obj)->x_head, -1, (obj)->x_cap); \ + (obj)->x_list[(obj)->x_head] = (item); \ + (obj)->x_size = min_int ((obj)->x_size + 1, (obj)->x_cap); \ +} + +#define CIRC_LIST_SIZE(obj) \ + ((obj)->x_size) + +#define CIRC_LIST_INDEX(obj, index) \ + modulo_add ((obj)->x_head, \ + index_verify ((index), (obj)->x_size, __FILE__, __LINE__), \ + (obj)->x_cap) + +#define CIRC_LIST_ITEM(obj, index) \ + ((obj)->x_list[CIRC_LIST_INDEX((obj), (index))]) + +#define CIRC_LIST_RESET(obj) \ +{ \ + (obj)->x_head = 0; \ + (obj)->x_size = 0; \ +} + +#define CIRC_LIST_ALLOC(dest, list_type, size) \ +{ \ + const int so = sizeof (list_type) + sizeof ((dest)->x_list[0]) * (size); \ + (dest) = (list_type *) malloc (so); \ + check_malloc_return (dest); \ + memset ((dest), 0, so); \ + (dest)->x_cap = size; \ + (dest)->x_sizeof = so; \ +} + +#define CIRC_LIST_FREE(dest) \ + free (dest) + +#endif diff --git a/common.h b/common.h new file mode 100644 index 0000000..3239dec --- /dev/null +++ b/common.h @@ -0,0 +1,67 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef COMMON_H +#define COMMON_H + +/* + * Statistics counters. + */ +typedef unsigned long counter_type; + +/* + * Time intervals + */ +typedef int interval_t; + +/* + * Used as an upper bound for timeouts. + */ +#define BIG_TIMEOUT (60*60*24*7) /* one week (in seconds) */ + +/* + * Printf formats for special types + */ +#define counter_format "%lu" +#define ptr_format "0x%08lx" +#define time_format "%lu" +#define fragment_header_format "0x%08x" + +/* these are used to cast the arguments + * and MUST match the formats above */ +typedef unsigned long time_type; +typedef unsigned long ptr_type; + +/* the --client-config-dir default file */ +#define CCD_DEFAULT "DEFAULT" + +/* + * This parameter controls the TLS channel buffer size. Among + * other things, this buffer must be large enough to contain + * the full --push/--pull list. If you increase it, do so + * on both server and client. + */ +#define TLS_CHANNEL_BUF_SIZE 1024 + +#endif diff --git a/config-win32.h.in b/config-win32.h.in new file mode 100644 index 0000000..1a3ce9f --- /dev/null +++ b/config-win32.h.in @@ -0,0 +1,309 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Configuration header for Win32 using the mingw environment. + * Manually edited based on linux version as generated by autoconf. + * + * config-win32.h is normally generated by copying + * config-win32.h.in -> config-win32.h and replacing + * [ampersand] VERSION [ampersand] + * with the appropriate version #. This is normally + * done automatically by configure.ac + */ + +#include <windows.h> +#include <winsock2.h> + +#define sleep(x) Sleep((x)*1000) + +#define random rand +#define srandom srand + +typedef unsigned long in_addr_t; + +#ifndef _SSIZE_T_ +#define _SSIZE_T_ + typedef unsigned int ssize_t; +#endif + +/* Append a label to program startup title */ +/*#define DEBUG_LABEL "DEBUG1"*/ + +/* Should we print debug info from driver? */ +/*#define TAP_WIN32_DEBUG*/ + +/* + * Minimum TAP-Win32 version number expected by userspace + * + * The TAP-Win32 version number is defined in tap-win32/SOURCES + */ +#define TAP_WIN32_MIN_MAJOR 8 +#define TAP_WIN32_MIN_MINOR 1 + +/* Allow --askpass and --auth-user-pass passwords to be read from a file */ +/* #undef ENABLE_PASSWORD_SAVE */ + +/* Enable client/server capability */ +#define ENABLE_CLIENT_SERVER 1 + +/* Enable client capability only */ +/* #undef ENABLE_CLIENT_ONLY */ + +/* Enable management server capability */ +#define ENABLE_MANAGEMENT 1 + +/* Enable HTTP proxy support */ +#define ENABLE_HTTP_PROXY 1 + +/* Enable Socks proxy support */ +#define ENABLE_SOCKS 1 + +/* Enable internal fragmentation support */ +#define ENABLE_FRAGMENT 1 + +/* Enable smaller executable size */ +/* #undef ENABLE_SMALL */ + +/* Enable debugging support */ +#define ENABLE_DEBUG 1 + +/* if defined, will allow usage of the --plugin directive */ +#define USE_LOAD_LIBRARY + +/* Dimension size to use for empty array declaration */ +#define EMPTY_ARRAY_SIZE 0 + +/* Define to 1 if you have the <openssl/engine.h> header file. */ +#define HAVE_OPENSSL_ENGINE_H 1 + +/* Define to 1 if you have the `ENGINE_load_builtin_engines' function. */ +#define HAVE_ENGINE_LOAD_BUILTIN_ENGINES 1 + +/* Define to 1 if you have the `ENGINE_register_all_complete' function. */ +#define HAVE_ENGINE_REGISTER_ALL_COMPLETE 1 + +/* Define to 1 if you have the `ENGINE_cleanup' function. */ +#define HAVE_ENGINE_CLEANUP 1 + +/* gettimeofday() is implemented in otime.c for Windows */ +#define HAVE_GETTIMEOFDAY 1 + +/* Define to 1 if you have the 'chsize' function. */ +#define HAVE_CHSIZE 1 + +/* Define to 1 if you have the `chdir' function. */ +#define HAVE_CHDIR 1 + +/* Define to 1 if your compiler supports GNU GCC-style variadic macros */ +#ifndef _MSC_VER /* Defines MSFT compiler version. Defined as 1200 for MSVC++ 6.0. */ +#define HAVE_CPP_VARARG_MACRO_GCC 1 +#endif + +/* Define to 1 if you have the <ctype.h> header file. */ +#define HAVE_CTYPE_H 1 + +/* Define to 1 if you have the <errno.h> header file. */ +#define HAVE_ERRNO_H 1 + +/* Define to 1 if you have the `EVP_CIPHER_CTX_set_key_length' function. */ +#define HAVE_EVP_CIPHER_CTX_SET_KEY_LENGTH 1 + +/* Define to 1 if you have the <fcntl.h> header file. */ +#define HAVE_FCNTL_H 1 + +/* Define to 1 if you have the `getsockopt' function. */ +#define HAVE_GETSOCKOPT 1 + +/* Define to 1 if you have the `inet_ntoa' function. */ +#define HAVE_INET_NTOA 1 + +/* Define to 1 if your system has a GNU libc compatible `malloc' function, and + to 0 otherwise. */ +#define HAVE_MALLOC 1 + +/* Define to 1 if you have the `memset' function. */ +#define HAVE_MEMSET 1 + +/* Define to 1 if you have the `setsockopt' function. */ +#define HAVE_SETSOCKOPT 1 + +/* Define to 1 if you have the `socket' function. */ +#define HAVE_SOCKET 1 + +/* Define to 1 if you have the <stdarg.h> header file. */ +#define HAVE_STDARG_H 1 + +/* Define to 1 if you have the <stdint.h> header file. */ +#ifndef _MSC_VER +#define HAVE_STDINT_H 1 +#endif + +/* Define to 1 if you have the <stdio.h> header file. */ +#define HAVE_STDIO_H 1 + +/* Define to 1 if you have the <stdlib.h> header file. */ +#define HAVE_STDLIB_H 1 + +/* Define to 1 if you have the `strerror' function. */ +#define HAVE_STRERROR 1 + +/* Define to 1 if you have the <strings.h> header file. */ +#define HAVE_STRINGS_H 1 + +/* Define to 1 if you have the <string.h> header file. */ +#define HAVE_STRING_H 1 + +/* Define to 1 if you have the `system' function. */ +#define HAVE_SYSTEM 1 + +/* Define to 1 if you have the <sys/file.h> header file. */ +#ifndef _MSC_VER +#define HAVE_SYS_FILE_H 1 +#endif + +/* Define to 1 if you have the <sys/stat.h> header file. */ +#define HAVE_SYS_STAT_H 1 + +/* Define to 1 if you have the <sys/time.h> header file. */ +#ifndef _MSC_VER +#define HAVE_SYS_TIME_H 1 +#endif + +/* Define to 1 if you have the <sys/types.h> header file. */ +#define HAVE_SYS_TYPES_H 1 + +/* Define to 1 if you have the `time' function. */ +#define HAVE_TIME 1 + +/* Define to 1 if you have the <unistd.h> header file. */ +#ifndef _MSC_VER +#define HAVE_UNISTD_H 1 +#endif + +/* Define to 1 if you have the `vsnprintf' function. */ +#define HAVE_VSNPRINTF 1 + +/* Special Windows version of getpass() defined in io.c */ +#define HAVE_GETPASS 1 + +/* Name of package */ +#define PACKAGE "openvpn" + +/* Define to the address where bug reports for this package should be sent. */ +#define PACKAGE_BUGREPORT "openvpn-users@lists.sourceforge.net" + +/* Define to the full name of this package. */ +#define PACKAGE_NAME "OpenVPN" + +/* Define to the one symbol short name of this package. */ +#define PACKAGE_TARNAME "openvpn" + +/* Define to the version of this package. */ +#define PACKAGE_VERSION "@VERSION@" /* AUTO_VERSION */ + +/* Define to the full name and version of this package. */ +#ifdef DEBUG_LABEL +#define PACKAGE_STRING "OpenVPN " PACKAGE_VERSION " " DEBUG_LABEL +#else +#define PACKAGE_STRING "OpenVPN " PACKAGE_VERSION +#endif + +/* Define as the return type of signal handlers (`int' or `void'). */ +#define RETSIGTYPE void + +/* The size of a `unsigned int', as computed by sizeof. */ +#define SIZEOF_UNSIGNED_INT 4 + +/* The size of a `unsigned long', as computed by sizeof. */ +#define SIZEOF_UNSIGNED_LONG 4 + +/* Define to 1 if you have the ANSI C header files. */ +#define STDC_HEADERS 1 + +/* A string representing our target */ +#ifdef _MSC_VER +#define TARGET_ALIAS "Win32-MSVC++" +#else +#define TARGET_ALIAS "Win32-MinGW" +#endif + +/* Define to 1 if you can safely include both <sys/time.h> and <time.h>. */ +#ifndef _MSC_VER +#define TIME_WITH_SYS_TIME 1 +#endif + +/* Use OpenSSL crypto library */ +#define USE_CRYPTO 1 + +/* Use LZO compression library */ +#define USE_LZO 1 + +/* Use OpenSSL SSL library */ +#define USE_SSL 1 + +/* Version number of package */ +#define VERSION PACKAGE_VERSION + +/* Define as `__inline' if that's what the C compiler calls it, or to nothing + if it is not supported. */ +#define inline __inline + +/* type to use in place of socklen_t if not defined */ +#define socklen_t unsigned int + +/* 32-bit unsigned type */ +#define uint32_t unsigned int + +/* 16-bit unsigned type */ +#define uint16_t unsigned short + +/* 8-bit unsigned type */ +#define uint8_t unsigned char + +/* Route command */ +#define ROUTE_PATH "route" + +/* Windows doesn't support PTHREAD yet */ +#ifdef USE_PTHREAD +#error The Windows version of OpenVPN does not support PTHREAD yet +#endif + +#ifdef _MSC_VER +/* MSVC++ hacks */ +#include <io.h> +#include <direct.h> +#define vsnprintf _vsnprintf +#define vsnwprintf _vsnwprintf +#define snwprintf _snwprintf +#define write _write +#define open _open +#define read _read +#define close _close +#define chdir _chdir +#define S_IRUSR 0 +#define S_IWUSR 0 +typedef int intptr_t; +#undef S_NORMAL +#endif diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..2b09280 --- /dev/null +++ b/configure.ac @@ -0,0 +1,636 @@ +dnl OpenVPN -- An application to securely tunnel IP networks +dnl over a single UDP port, with support for SSL/TLS-based +dnl session authentication and key exchange, +dnl packet encryption, packet authentication, and +dnl packet compression. +dnl +dnl Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> +dnl +dnl This program is free software; you can redistribute it and/or modify +dnl it under the terms of the GNU General Public License as published by +dnl the Free Software Foundation; either version 2 of the License, or +dnl (at your option) any later version. +dnl +dnl This program is distributed in the hope that it will be useful, +dnl but WITHOUT ANY WARRANTY; without even the implied warranty of +dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +dnl GNU General Public License for more details. +dnl +dnl You should have received a copy of the GNU General Public License +dnl along with this program (see the file COPYING included with this +dnl distribution); if not, write to the Free Software Foundation, Inc., +dnl 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +dnl Process this file with autoconf to produce a configure script. + +AC_PREREQ(2.50) + +AC_INIT([OpenVPN], [2.0.3_rc1], [openvpn-users@lists.sourceforge.net], [openvpn]) +AM_CONFIG_HEADER(config.h) +AC_CONFIG_SRCDIR(syshead.h) + +AC_ARG_ENABLE(lzo, + [ --disable-lzo Disable LZO compression support], + [LZO="$enableval"], + [LZO="yes"] +) + +AC_ARG_ENABLE(crypto, + [ --disable-crypto Disable OpenSSL crypto support], + [CRYPTO="$enableval"], + [CRYPTO="yes"] +) + +AC_ARG_ENABLE(ssl, + [ --disable-ssl Disable OpenSSL SSL support for TLS-based key exchange], + [SSL="$enableval"], + [SSL="yes"] +) + +AC_ARG_ENABLE(multi, + [ --disable-multi Disable client/server support (--mode server + client mode)], + [MULTI="$enableval"], + [MULTI="yes"] +) + +AC_ARG_ENABLE(server, + [ --disable-server Disable server support only (but retain client support)], + [MULTI_SERVER="$enableval"], + [MULTI_SERVER="yes"] +) + +AC_ARG_ENABLE(plugins, + [ --disable-plugins Disable plug-in support], + [PLUGINS="$enableval"], + [PLUGINS="yes"] +) + +AC_ARG_ENABLE(management, + [ --disable-management Disable management server support], + [MANAGEMENT="$enableval"], + [MANAGEMENT="yes"] +) + +AC_ARG_ENABLE(socks, + [ --disable-socks Disable Socks support], + [SOCKS="$enableval"], + [SOCKS="yes"] +) + +AC_ARG_ENABLE(http, + [ --disable-http Disable HTTP proxy support], + [HTTP_PROXY="$enableval"], + [HTTP_PROXY="yes"] +) + +AC_ARG_ENABLE(fragment, + [ --disable-fragment Disable internal fragmentation support (--fragment)], + [FRAGMENT="$enableval"], + [FRAGMENT="yes"] +) + +AC_ARG_ENABLE(debug, + [ --disable-debug Disable debugging support (disable gremlin and verb 7+ messages)], + [DEBUG="$enableval"], + [DEBUG="yes"] +) + +AC_ARG_ENABLE(small, + [ --enable-small Enable smaller executable size (disable OCC, usage message, and verb 4 parm list)], + [SMALL="$enableval"], + [SMALL="no"] +) + +AC_ARG_ENABLE(pthread, + [ --enable-pthread Enable pthread support (Experimental for OpenVPN 2.0)], + [PTHREAD="$enableval"], + [PTHREAD="no"] +) + +AC_ARG_ENABLE(password-save, + [ --enable-password-save Allow --askpass and --auth-user-pass passwords to be read from a file], + [PASSWORD_SAVE="$enableval"], + [PASSWORD_SAVE="no"] +) + +AC_ARG_ENABLE(iproute2, + [ --enable-iproute2 Enable support for iproute2], + AC_DEFINE(CONFIG_FEATURE_IPROUTE, 1, [enable iproute2 support]) +) + +AC_ARG_ENABLE(strict, + [ --enable-strict Enable strict compiler warnings (debugging option)], + [STRICT="$enableval"], + [STRICT="no"] +) + +AC_ARG_ENABLE(pedantic, + [ --enable-pedantic Enable pedantic compiler warnings, will not generate a working executable (debugging option)], + [PEDANTIC="$enableval"], + [PEDANTIC="no"] +) + +AC_ARG_ENABLE(profiling, + [ --enable-profiling Enable profiling (debugging option)], + [PROFILE="$enableval"], + [PROFILE="no"] +) + +AC_ARG_ENABLE(strict-options, + [ --enable-strict-options Enable strict options check between peers (debugging option)], + [STRICT_OPTIONS="$enableval"], + [STRICT_OPTIONS="no"] +) + +AC_ARG_WITH(ssl-headers, + [ --with-ssl-headers=DIR Crypto/SSL Include files location], + [CS_HDR_DIR="$withval"] + [CPPFLAGS="$CPPFLAGS -I$withval"] +) + +AC_ARG_WITH(ssl-lib, + [ --with-ssl-lib=DIR Crypto/SSL Library location], + [LDFLAGS="$LDFLAGS -L$withval"] +) + +AC_ARG_WITH(lzo-headers, + [ --with-lzo-headers=DIR LZO Include files location], + [LZO_HDR_DIR="$withval"] + [CPPFLAGS="$CPPFLAGS -I$withval"] +) + +AC_ARG_WITH(lzo-lib, + [ --with-lzo-lib=DIR LZO Library location], + [LDFLAGS="$LDFLAGS -L$withval"] +) + +AC_ARG_WITH(ifconfig-path, + [ --with-ifconfig-path=PATH Path to ifconfig tool], + [IFCONFIG="$withval"], + [AC_PATH_PROG([IFCONFIG], [ifconfig], [ifconfig], [$PATH:/usr/local/sbin:/usr/sbin:/sbin])] +) +AC_DEFINE_UNQUOTED(IFCONFIG_PATH, "$IFCONFIG", [Path to ifconfig tool]) + +AC_ARG_WITH(iproute-path, + [ --with-iproute-path=PATH Path to iproute tool], + [IPROUTE="$withval"], + [AC_PATH_PROG([IPROUTE], [ip], [ip], [$PATH:/usr/local/sbin:/usr/sbin:/sbin])] +) +AC_DEFINE_UNQUOTED(IPROUTE_PATH, "$IPROUTE", [Path to iproute tool]) + + +AC_ARG_WITH(route-path, + [ --with-route-path=PATH Path to route tool], + [ROUTE="$withval"], + [AC_PATH_PROG([ROUTE], [route], [route], [$PATH:/usr/local/sbin:/usr/sbin:/sbin])] +) +AC_DEFINE_UNQUOTED(ROUTE_PATH, "$ROUTE", [Path to route tool]) + +AC_ARG_WITH(mem-check, + [ --with-mem-check=TYPE Build with debug memory checking, TYPE = dmalloc or valgrind], + [MEMCHECK="$withval"] +) + +dnl Guess host type. +AC_CANONICAL_HOST +AC_CANONICAL_SYSTEM +AM_INIT_AUTOMAKE(openvpn, [$PACKAGE_VERSION]) + +dnl fix search path, to allow compilers to find syshead.h +CPPFLAGS="$CPPFLAGS -I${srcdir}" + +dnl check target OS +openvpn_target=$target +if test $target_alias; then + openvpn_target=$target_alias +fi +AC_DEFINE_UNQUOTED(TARGET_ALIAS, "$openvpn_target", [A string representing our target]) +case "$target" in +*linux*) + AC_DEFINE(TARGET_LINUX, 1, [Are we running on Linux?]) + dnl RH9 SSL headers workaround + if test -z $CS_HDR_DIR && test "$CRYPTO" = "yes"; then + CPPFLAGS="$CPPFLAGS $(pkg-config --cflags openssl 2>/dev/null)" + fi + ;; +*solaris*) + AC_DEFINE(TARGET_SOLARIS, 1, [Are we running on Solaris?]) + ;; +*openbsd*) + AC_DEFINE(TARGET_OPENBSD, 1, [Are we running on OpenBSD?]) + ;; +*freebsd*) + AC_DEFINE(TARGET_FREEBSD, 1, [Are we running on FreeBSD?]) + ;; +*netbsd*) + AC_DEFINE(TARGET_NETBSD, 1, [Are we running NetBSD?]) + ;; +*darwin*) + dnl some Mac OS X tendering (we use vararg macros...) + AC_DEFINE(TARGET_DARWIN, 1, [Are we running on Mac OS X?]) + CPPFLAGS="$CPPFLAGS -no-cpp-precomp" + ;; +*mingw*) + AC_MSG_RESULT([WARNING: configure support for mingw is incomplete]) + AC_MSG_RESULT([WARNING: use makefile.w32 instead]) + OPENVPN_ADD_LIBS(-lgdi32) + OPENVPN_ADD_LIBS(-lwsock32) + ;; + +esac + +dnl Checks for programs. +AC_PROG_CC +AC_PROG_INSTALL +AC_PROG_GCC_TRADITIONAL + +dnl Checks for header files. +AC_HEADER_STDC + +dnl Checks for typedefs, structures, and compiler characteristics. +AC_C_CONST +AC_C_INLINE +AC_C_VOLATILE +AC_TYPE_OFF_T +AC_TYPE_PID_T +AC_TYPE_SIZE_T +AC_TYPE_UID_T +AC_HEADER_TIME +AX_CPP_VARARG_MACRO_ISO +AX_CPP_VARARG_MACRO_GCC +AX_EMPTY_ARRAY + +dnl Check for more header files. +AC_HEADER_SYS_WAIT +AC_CHECK_HEADERS(sys/time.h sys/socket.h sys/ioctl.h sys/stat.h dnl + sys/mman.h fcntl.h sys/file.h stdlib.h stdint.h dnl + stdarg.h unistd.h signal.h stdio.h string.h dnl + strings.h ctype.h errno.h syslog.h pwd.h grp.h dnl + net/if_tun.h net/if.h stropts.h sys/sockio.h dnl + netinet/in.h netinet/in_systm.h netinet/ip.h dnl + netinet/if_ether.h netinet/tcp.h resolv.h arpa/inet.h dnl + netdb.h sys/uio.h linux/if_tun.h linux/sockios.h dnl + linux/types.h sys/poll.h sys/epoll.h dnl +) +AC_CHECK_HEADERS(linux/errqueue.h,,, + [#ifdef HAVE_LINUX_TYPES_H + # include <linux/types.h> + #endif + ]) +AC_CACHE_SAVE + +dnl check that in_addr_t is defined +AC_CHECK_TYPE( + [in_addr_t], + [], + [AC_DEFINE(in_addr_t, uint32_t, [Some systems don't define in_addr_t])], + [#include "syshead.h"]) + +dnl check for basic types +AC_CHECK_TYPE( + [uint8_t], + [], + [AC_DEFINE(uint8_t, unsigned char, [8-bit unsigned type])], + [#include "syshead.h"]) +AC_CHECK_TYPE( + [uint16_t], + [], + [AC_DEFINE(uint16_t, unsigned char, [16-bit unsigned type])], + [#include "syshead.h"]) +AC_CHECK_TYPE( + [uint32_t], + [], + [AC_DEFINE(uint32_t, unsigned long, [32-bit unsigned type])], + [#include "syshead.h"]) + +dnl check for IPv6 types +AC_CHECK_TYPE( + [struct tun_pi], + [AC_DEFINE(HAVE_TUN_PI, 1, [struct tun_pi needed for IPv6 support])], + [], + [#include "syshead.h"]) +AC_CHECK_TYPE( + [struct iphdr], + [AC_DEFINE(HAVE_IPHDR, 1, [struct iphdr needed for IPv6 support])], + [], + [#include "syshead.h"]) +AC_CHECK_TYPE( + [struct iovec], + [AC_DEFINE(HAVE_IOVEC, 1, [struct iovec needed for IPv6 support])], + [], + [#include "syshead.h"]) + +dnl check for extended socket error types +AC_CHECK_TYPE( + [struct sock_extended_err], + [AC_DEFINE(HAVE_SOCK_EXTENDED_ERR, 1, [struct sock_extended_err needed for extended socket error support])], + [], + [#include "syshead.h"]) +AC_CHECK_TYPE( + [struct msghdr], + [AC_DEFINE(HAVE_MSGHDR, 1, [struct msghdr needed for extended socket error support])], + [], + [#include "syshead.h"]) +AC_CHECK_TYPE( + [struct cmsghdr], + [AC_DEFINE(HAVE_CMSGHDR, 1, [struct cmsghdr needed for extended socket error support])], + [], + [#include "syshead.h"]) + +AC_CHECK_SIZEOF(unsigned int) +AC_CHECK_SIZEOF(unsigned long) + +AC_CACHE_SAVE + +dnl check for other types +TYPE_SOCKLEN_T +AC_TYPE_SIGNAL + +dnl Check for libsocket +AC_SEARCH_LIBS(socket, socket) + +dnl Check for libnsl +AC_SEARCH_LIBS(inet_ntoa, nsl) + +dnl Check for libresolv +AC_SEARCH_LIBS(gethostbyname, resolv nsl) + +dnl optional library functions +AC_FUNC_FORK +AC_CHECK_FUNCS(daemon chroot getpwnam setuid nice system getpid dup dup2 dnl + getpass strerror syslog openlog mlockall getgrnam setgid dnl + setgroups stat flock readv writev setsockopt getsockopt dnl + setsid chdir gettimeofday putenv getpeername unlink dnl + poll chsize ftruncate) +AC_CACHE_SAVE + +dnl Required library functions +AC_FUNC_MEMCMP + +AC_CHECK_FUNCS(socket recv recvfrom send sendto listen dnl + accept connect bind select gethostbyname dnl + inet_ntoa time ctime memset vsnprintf, [], + [AC_MSG_ERROR([Required library function not found])]) + +dnl +dnl check libraries +dnl + +dnl Checking for a working epoll +AC_CHECKING([for working epoll implementation]) +OLDLDFLAGS="$LDFLAGS" +LDFLAGS="$LDFLAGS -Wl,--fatal-warnings" +AC_CHECK_FUNCS(epoll_create, AC_DEFINE([HAVE_EPOLL_CREATE], 1, [])) +LDFLAGS="$OLDLDFLAGS" + +dnl +dnl check for valgrind tool +dnl + +if test "$MEMCHECK" = "valgrind"; then + AC_CHECKING([for valgrind tool and Header files]) + AC_CHECK_HEADER(valgrind/memcheck.h, + [ + AC_DEFINE(USE_VALGRIND, 1, [Use valgrind memory debugging library]) + CFLAGS="-g -fno-inline" + ], + [AC_MSG_ERROR([valgrind headers not found.])] + ) +fi + +dnl +dnl check for pthread library +dnl + +if test "$PTHREAD" = "yes"; then + AC_CHECKING([for pthread support]) + AC_MSG_RESULT([********* WARNING: pthread support is experimental for OpenVPN 2.0]) + ACX_PTHREAD( + [ + case "$target" in + *openbsd*) + AC_MSG_RESULT([WARNING: pthread support on OpenBSD is unstable!]) + CFLAGS="$CFLAGS -pthread" + ;; + esac + LIBS="$PTHREAD_LIBS $LIBS" + CFLAGS="$CFLAGS $PTHREAD_CFLAGS" + CC="$PTHREAD_CC" + AC_DEFINE(USE_PTHREAD, 1, [Use pthread-based multithreading]) + ], + [ + AC_MSG_RESULT([I don't know how to build with pthread support on this platform.]) + AC_MSG_ERROR([try ./configure --disable-pthread]) + ]) +fi + +dnl +dnl check for dmalloc library +dnl + +if test "$MEMCHECK" = "dmalloc"; then + AC_CHECKING([for dmalloc Library and Header files]) + AC_CHECK_HEADER(dmalloc.h, + [AC_CHECK_LIB(dmalloc, malloc, + [ + if test "$PTHREAD" = "yes"; then + OPENVPN_ADD_LIBS(-ldmallocth) + else + OPENVPN_ADD_LIBS(-ldmalloc) + fi + AC_DEFINE(DMALLOC, 1, [Use dmalloc memory debugging library]) + ], + [AC_MSG_ERROR([dmalloc library not found.])] + )], + [AC_MSG_ERROR([dmalloc headers not found.])] + ) +fi + +dnl +dnl Check for dlopen -- first try libc then libdl. +dnl +if test "$PLUGINS" = "yes"; then + AC_CHECKING([for libdl Library and Header files]) + AC_CHECK_HEADER(dlfcn.h, + [AC_CHECK_FUNC(dlopen, + [AC_DEFINE(USE_LIBDL, 1, [Use libdl for dynamic library loading])], + [AC_CHECK_LIB(dl, dlopen, + [ + OPENVPN_ADD_LIBS(-ldl) + AC_DEFINE(USE_LIBDL, 1, [Use libdl for dynamic library loading]) + ], + [AC_MSG_RESULT([libdl library not found.])] + )], + )], + [AC_MSG_RESULT([libdl headers not found.])] + ) +fi + +dnl +dnl check for LZO library +dnl + +if test "$LZO" = "yes"; then + LZO_H="" + AC_CHECKING([for LZO Library and Header files]) + AC_CHECK_HEADER(lzo/lzo1x.h, + [ LZO_H="2" + lzolibs="lzo2 lzo" + AC_DEFINE(LZO_HEADER_DIR, 1, [Use lzo/ directory prefix for LZO header files (for LZO 2.0)]) + ], + [ AC_CHECK_HEADER(lzo1x.h, [ LZO_H="1" ; lzolibs=lzo ]) ] + ) + + if test -n "$LZO_H"; then + havelzolib=0 + for i in $lzolibs ; do + if test $havelzolib = 1 ; then break ; fi + AC_CHECK_LIB($i, lzo1x_1_15_compress, + [ + OPENVPN_ADD_LIBS(-l$i) + AC_DEFINE(USE_LZO, 1, [Use LZO compression library]) + havelzolib=1 + ] + ) + done + if test $havelzolib = 0 ; then + AC_MSG_ERROR([LZO headers were found but LZO library was not found]) + fi + else + AC_MSG_RESULT([LZO headers were not found]) + AC_MSG_RESULT([LZO library available from http://www.oberhumer.com/opensource/lzo/]) + AC_MSG_ERROR([Or try ./configure --disable-lzo]) + fi +fi + +dnl +dnl check for OpenSSL-crypto library +dnl + +if test "$CRYPTO" = "yes"; then + AC_CHECKING([for OpenSSL Crypto Library and Header files]) + AC_CHECK_HEADER(openssl/evp.h, + [AC_CHECK_LIB(crypto, EVP_CIPHER_CTX_init, + [ + AC_CHECKING([that OpenSSL Library is at least version 0.9.6]) + AC_EGREP_CPP(yes, + [ + #include "openssl/evp.h" + #if SSLEAY_VERSION_NUMBER >= 0x00906000L + yes + #endif + ], + [ + AC_DEFINE(USE_CRYPTO, 1, [Use OpenSSL crypto library]) + OPENVPN_ADD_LIBS(-lcrypto) + AC_CHECK_FUNCS(EVP_CIPHER_CTX_set_key_length) + + dnl check for OpenSSL crypto acceleration capability + AC_CHECK_HEADERS(openssl/engine.h) + AC_CHECK_FUNCS(ENGINE_load_builtin_engines) + AC_CHECK_FUNCS(ENGINE_register_all_complete) + AC_CHECK_FUNCS(ENGINE_cleanup) + ], + [AC_MSG_ERROR([OpenSSL crypto Library is too old.])] + ) + ], + [AC_MSG_ERROR([OpenSSL Crypto library not found.])] + )], + [AC_MSG_ERROR([OpenSSL Crypto headers not found.])] + ) + +dnl +dnl check for OpenSSL-SSL library +dnl + + if test "$SSL" = "yes"; then + AC_CHECKING([for OpenSSL SSL Library and Header files]) + AC_CHECK_HEADER(openssl/ssl.h, + [AC_CHECK_LIB(ssl, SSL_CTX_new, + [ + if test "$MEMCHECK" = "ssl"; then + AC_CHECKING([for Memory Debugging Capabilities in OpenSSL Library]) + AC_CHECK_LIB(ssl, CRYPTO_mem_ctrl, + [ + AC_DEFINE(CRYPTO_MDEBUG, 1, [Use memory debugging function in OpenSSL]) + AC_MSG_RESULT([NOTE: OpenSSL library must be compiled with CRYPTO_MDEBUG]) + ], + [AC_MSG_ERROR([Memory Debugging function in OpenSSL library not found.])] + ) + fi + ], + [AC_MSG_ERROR([OpenSSL SSL library not found.])] + )], + [AC_MSG_ERROR([OpenSSL SSL headers not found.])] + ) + AC_DEFINE(USE_SSL, 1, [Use OpenSSL SSL library]) + OPENVPN_ADD_LIBS(-lssl) + fi +fi + +dnl enable multi-client mode +if test "$MULTI" = "yes"; then + AC_DEFINE(ENABLE_CLIENT_SERVER, 1, [Enable client/server capability]) +fi + +dnl enable client mode only, not server +if test "$MULTI_SERVER" = "no"; then + AC_DEFINE(ENABLE_CLIENT_ONLY, 1, [Enable client capability only]) +fi + +dnl enable management server capability +if test "$MANAGEMENT" = "yes"; then + AC_DEFINE(ENABLE_MANAGEMENT, 1, [Enable management server capability]) +fi + +dnl enable socks +if test "$SOCKS" = "yes"; then + AC_DEFINE(ENABLE_SOCKS, 1, [Enable Socks proxy support]) +fi + +dnl enable HTTP proxy +if test "$HTTP_PROXY" = "yes"; then + AC_DEFINE(ENABLE_HTTP_PROXY, 1, [Enable HTTP proxy support]) +fi + +dnl enable debugging +if test "$DEBUG" = "yes"; then + AC_DEFINE(ENABLE_DEBUG, 1, [Enable debugging support]) +fi + +dnl enable small size optimizations +if test "$SMALL" = "yes"; then + AC_DEFINE(ENABLE_SMALL, 1, [Enable smaller executable size]) +fi + +dnl enable --fragment +if test "$FRAGMENT" = "yes"; then + AC_DEFINE(ENABLE_FRAGMENT, 1, [Enable internal fragmentation support]) +fi + +dnl enable strict compiler warnings +if test "$STRICT" = "yes"; then + CFLAGS="$CFLAGS -Wall -Wpointer-arith -Wsign-compare -Wno-unused-parameter -Wno-unused-function" +fi + +dnl enable pedantic compiler warnings +if test "$PEDANTIC" = "yes"; then + CFLAGS="$CFLAGS -ansi -pedantic" +fi + +dnl enable profiling +if test "$PROFILE" = "yes"; then + CFLAGS="$CFLAGS -pg -DENABLE_PROFILING" +fi + +dnl enable strict options check between peers +if test "$STRICT_OPTIONS" = "yes"; then + AC_DEFINE(STRICT_OPTIONS_CHECK, 1, [Enable strict options check between peers]) +fi + +dnl enable password save +if test "$PASSWORD_SAVE" = "yes"; then + AC_DEFINE(ENABLE_PASSWORD_SAVE, 1, [Allow --askpass and --auth-user-pass passwords to be read from a file]) +fi + +AC_OUTPUT(Makefile openvpn.spec config-win32.h install-win32/openvpn.nsi) diff --git a/contrib/README b/contrib/README new file mode 100644 index 0000000..e1a57d0 --- /dev/null +++ b/contrib/README @@ -0,0 +1,2 @@ +This directory contains scripts and patches contributed +by users. diff --git a/contrib/multilevel-init.patch b/contrib/multilevel-init.patch new file mode 100644 index 0000000..8d48fbc --- /dev/null +++ b/contrib/multilevel-init.patch @@ -0,0 +1,79 @@ +--- /etc/init.d/openvpn 2004-05-12 20:30:06.000000000 +0200 ++++ openvpn 2004-05-12 20:34:33.000000000 +0200 +@@ -58,13 +58,13 @@ + # returning success or failure status to caller (James Yonan). + + # Location of openvpn binary +-openvpn="/usr/sbin/openvpn" ++openvpn=/usr/sbin/openvpn + + # Lockfile +-lock="/var/lock/subsys/openvpn" ++lock=/var/lock/subsys/openvpn + + # PID directory +-piddir="/var/run/openvpn" ++piddir=/var/run/openvpn + + # Our working directory + work=/etc/openvpn +@@ -106,7 +106,7 @@ + + if [ -f $lock ]; then + # we were not shut down correctly +- for pidf in `/bin/ls $piddir/*.pid $piddir/*/*.pid 2>/dev/null`; do ++ for pidf in `find $piddir -name "*.pid" 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi +@@ -116,12 +116,12 @@ + sleep 2 + fi + +- rm -f $piddir/*.pid $piddir/*/*.pid ++ find $piddir -name "*.pid"|xargs rm -f + + # Start every .conf in $work and run .sh if exists + errors=0 + successes=0 +- for c in `/bin/ls *.conf */*.conf 2>/dev/null`; do ++ for c in `find * -name "*.conf" 2>/dev/null`; do + bn=${c%%.conf} + if [ -f "$bn.sh" ]; then + . $bn.sh +@@ -147,7 +147,7 @@ + ;; + stop) + echo -n $"Shutting down openvpn: " +- for pidf in `/bin/ls $piddir/*.pid $piddir/*/*.pid 2>/dev/null`; do ++ for pidf in `find $piddir -name "*.pid" 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi +@@ -163,7 +163,7 @@ + ;; + reload) + if [ -f $lock ]; then +- for pidf in `/bin/ls $piddir/*.pid $piddir/*/*.pid 2>/dev/null`; do ++ for pidf in `find $piddir -name "*.pid" 2>/dev/null`; do + if [ -s $pidf ]; then + kill -HUP `cat $pidf` >/dev/null 2>&1 + fi +@@ -175,7 +175,7 @@ + ;; + reopen) + if [ -f $lock ]; then +- for pidf in `/bin/ls $piddir/*.pid $piddir/*/*.pid 2>/dev/null`; do ++ for pidf in `find $piddir -name "*.pid" 2>/dev/null`; do + if [ -s $pidf ]; then + kill -USR1 `cat $pidf` >/dev/null 2>&1 + fi +@@ -195,7 +195,7 @@ + ;; + status) + if [ -f $lock ]; then +- for pidf in `/bin/ls $piddir/*.pid $piddir/*/*.pid 2>/dev/null`; do ++ for pidf in `find $piddir -name "*.pid" 2>/dev/null`; do + if [ -s $pidf ]; then + kill -USR2 `cat $pidf` >/dev/null 2>&1 + fi diff --git a/contrib/openvpn-fwmarkroute-1.00/README b/contrib/openvpn-fwmarkroute-1.00/README new file mode 100644 index 0000000..66fe61a --- /dev/null +++ b/contrib/openvpn-fwmarkroute-1.00/README @@ -0,0 +1,44 @@ +OpenVPN fwmark Routing +Sean Reifschneider, <jafo@tummy.com> +Thursday November 27, 2003 +========================== + +These scripts can be used with OpenVPN up and down scripts to set up +routing on a Linux system such that the VPN traffic is sent via normal +network connectivity, but other traffic to that network runs over the VPN. +The idea is to allow encryption of data to the network the remote host is +on, without interfering with the VPN traffic. You can't simply add a route +to the remote network, becaues that will cause the VPN traffic to also try +to run over the VPN, and breaks the VPN. + +These scripts use the Linux "fwmark" iptables rules to specify routing +based not only on IP address, but also by port and protocol. This allows +you to effectively say "if the packet is to this IP address on this port +using this protocol, then use the normal default gateway, otherwise use the +VPN gateway. + +This is set up on the client VPN system, not the VPN server. These scripts +also set up all ICMP echo-responses to run across the VPN. You can +comment the lines in the scripts to disable this, but I find this useful +at coffee shops which have networks that block ICMP. + +To configure this, you need to set up these scripts as your up and down +scripts in the config file. You will need to set these values in the +config file: + + up /etc/openvpn/fwmarkroute.up + down /etc/openvpn/fwmarkroute.down + up-restart + up-delay + + setenv remote_netmask_bits 24 + +Note: For this to work, you can't set the "user" or "group" config options, +because then the scripts will not run as root. + +The last setting allows you to control the size of the network the remote +system is on. The remote end has to be set up to route, probably with +masquerading or NAT. The network this netmask relates to is calculated +using the value of "remote" in the conf file. + +Sean diff --git a/contrib/openvpn-fwmarkroute-1.00/fwmarkroute.down b/contrib/openvpn-fwmarkroute-1.00/fwmarkroute.down new file mode 100755 index 0000000..87d67d4 --- /dev/null +++ b/contrib/openvpn-fwmarkroute-1.00/fwmarkroute.down @@ -0,0 +1,22 @@ +#!/bin/sh +# +# Bring down vpn routing. + +# calculate the network address +remote_network=`ipcalc -n "$remote"/"$remote_netmask_bits"` +remote_network="${remote_network#*=}" + +# clear routing via VPN +ip route del "$remote_network"/"$remote_netmask_bits" via "$5" table vpn.out +ip route del table vpnonly.out via "$5" +iptables -D OUTPUT -t mangle -p "$proto" \ + -d "$remote_network"/"$remote_netmask_bits" \ + --dport "$remote_port" -j ACCEPT +iptables -D OUTPUT -t mangle -d "$remote" -j MARK --set-mark 2 + +# undo the ICMP ping tunneling +iptables -D OUTPUT -t mangle --protocol icmp --icmp-type echo-request \ + -j MARK --set-mark 3 + +# flush route cache +ip route flush cache diff --git a/contrib/openvpn-fwmarkroute-1.00/fwmarkroute.up b/contrib/openvpn-fwmarkroute-1.00/fwmarkroute.up new file mode 100755 index 0000000..661ec31 --- /dev/null +++ b/contrib/openvpn-fwmarkroute-1.00/fwmarkroute.up @@ -0,0 +1,49 @@ +#!/bin/sh +# +# Bring up vpn routing. + +# calculate the network address +remote_network=`ipcalc -n "$remote"/"$remote_netmask_bits"` +remote_network="${remote_network#*=}" + +# add the stuff that doesn't change if it's not already there +grep -q '^202 ' /etc/iproute2/rt_tables +if [ "$?" -ne 0 ] +then + echo 202 vpn.out >> /etc/iproute2/rt_tables +fi +grep -q '^203 ' /etc/iproute2/rt_tables +if [ "$?" -ne 0 ] +then + echo 203 vpnonly.out >> /etc/iproute2/rt_tables +fi +ip rule ls | grep -q 'lookup vpn.out *$' +if [ "$?" -ne 0 ] +then + ip rule add fwmark 2 table vpn.out +fi +ip rule ls | grep -q 'lookup vpnonly.out *$' +if [ "$?" -ne 0 ] +then + ip rule add fwmark 3 table vpnonly.out +fi + +# route VPN traffic using the normal table +iptables -A OUTPUT -t mangle -p "$proto" -d "$remote" --dport "$remote_port" \ + -j ACCEPT + +# route all other traffic to that host via VPN +iptables -A OUTPUT -t mangle -d "$remote_network"/"$remote_netmask_bits" \ + -j MARK --set-mark 2 + +# route all ICMP pings over the VPN +iptables -A OUTPUT -t mangle --protocol icmp --icmp-type echo-request \ + -j MARK --set-mark 3 + +# NAT traffic going over the VPN, so it doesn't have an unknown address +iptables -t nat -A POSTROUTING -o "$1" -j SNAT --to-source "$4" + +# add routing commands +ip route add "$remote_network"/"$remote_netmask_bits" via "$5" table vpn.out +ip route add table vpnonly.out via "$5" +ip route flush cache diff --git a/contrib/pull-resolv-conf/client.down b/contrib/pull-resolv-conf/client.down new file mode 100644 index 0000000..d51472f --- /dev/null +++ b/contrib/pull-resolv-conf/client.down @@ -0,0 +1,76 @@ +#!/bin/bash + +# Copyright (c) 2005 by OpenVPN Solutions LLC +# Licensed under the GPL version 2 + +# First version by Jesse Adelman +# someone at boldandbusted dink com +# http://www.boldandbusted.com/ + +# PURPOSE: This script automatically removes the /etc/resolv.conf entries previously +# set by the companion script "client.up". + +# INSTALL NOTES: +# Place this in /etc/openvpn/client.down +# Then, add the following to your /etc/openvpn/<clientconfig>.conf: +# client +# pull dhcp-options +# up /etc/openvpn/client.up +# down /etc/openvpn/client.down +# Next, "chmod a+x /etc/openvpn/client.down" + +# USAGE NOTES: +# Note that this script is best served with the companion "client.up" +# script. + +# Only tested on Gentoo Linux 2005.0 with OpenVPN 2.0 +# It should work with any GNU/Linux with /etc/resolv.conf + +# This runs with the context of the OpenVPN UID/GID +# at the time of execution. This generally means that +# the client "up" script will run fine, but the "down" script +# will require the use of the OpenVPN "down-root" plugin +# which is in the plugins/ directory of the OpenVPN source tree + +# A horrid work around, from a security perspective, +# is to run OpenVPN as root. THIS IS NOT RECOMMENDED. You have +# been WARNED. + +# init variables + +i=1 +j=1 +unset fopt +unset dns +unset opt + +# Convert ENVs to an array + +while fopt=foreign_option_$i; [ -n "${!fopt}" ]; do +{ + opt[i-1]=${!fopt} + case ${opt[i-1]} in + *DOMAIN* ) domain=`echo ${opt[i-1]} | \ + sed -e 's/dhcp-option DOMAIN //g'` ;; + *DNS* ) dns[j-1]=`echo ${opt[i-1]} | \ + sed -e 's/dhcp-option DNS //g'` + let j++ ;; + esac + let i++ +} +done + +# Now, do the work + +if [ -n "${dns[*]}" ]; then + for i in "${dns[@]}"; do + sed -i -e "/nameserver ${i}/D" /etc/resolv.conf || die + done +fi + +if [ -n "${domain}" ]; then + sed -i -e "/search ${domain}/D" /etc/resolv.conf || die +fi + +# all done... +exit 0 diff --git a/contrib/pull-resolv-conf/client.up b/contrib/pull-resolv-conf/client.up new file mode 100644 index 0000000..48b1a39 --- /dev/null +++ b/contrib/pull-resolv-conf/client.up @@ -0,0 +1,75 @@ +#!/bin/bash + +# Copyright (c) 2005 by OpenVPN Solutions LLC +# Licensed under the GPL version 2 + +# First version by Jesse Adelman +# someone at boldandbusted dink com +# http://www.boldandbusted.com/ + +# PURPOSE: This script automatically sets the proper /etc/resolv.conf entries +# as pulled down from an OpenVPN server. + +# INSTALL NOTES: +# Place this in /etc/openvpn/client.up +# Then, add the following to your /etc/openvpn/<clientconfig>.conf: +# client +# pull dhcp-options +# up /etc/openvpn/client.up +# Next, "chmod a+x /etc/openvpn/client.up" + +# USAGE NOTES: +# Note that this script is best served with the companion "client.down" +# script. + +# Only tested on Gentoo Linux 2005.0 with OpenVPN 2.0 +# It should work with any GNU/Linux with /etc/resolv.conf + +# This runs with the context of the OpenVPN UID/GID +# at the time of execution. This generally means that +# the client "up" script will run fine, but the "down" script +# will require the use of the OpenVPN "down-root" plugin +# which is in the plugins/ directory of the OpenVPN source tree + +# A horrid work around, from a security perspective, +# is to run OpenVPN as root. THIS IS NOT RECOMMENDED. You have +# been WARNED. + +# init variables + +i=1 +j=1 +unset fopt +unset dns +unset opt + +# Convert ENVs to an array + +while fopt=foreign_option_$i; [ -n "${!fopt}" ]; do +{ + opt[i-1]=${!fopt} + case ${opt[i-1]} in + *DOMAIN* ) domain=`echo ${opt[i-1]} | \ + sed -e 's/dhcp-option DOMAIN //g'` ;; + *DNS* ) dns[j-1]=`echo ${opt[i-1]} | \ + sed -e 's/dhcp-option DNS //g'` + let j++ ;; + esac + let i++ +} +done + +# Now, do the work + +if [ -n "${dns[*]}" ]; then + for i in "${dns[@]}"; do + sed -i -e "1,1 i nameserver ${i}" /etc/resolv.conf || die + done +fi + +if [ -n "${domain}" ]; then + sed -i -e "$j,1 i search ${domain}" /etc/resolv.conf || die +fi + +# all done... +exit 0 diff --git a/crypto.c b/crypto.c new file mode 100644 index 0000000..4f07651 --- /dev/null +++ b/crypto.c @@ -0,0 +1,1724 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#ifdef USE_CRYPTO + +#include "syshead.h" + +#include "crypto.h" +#include "error.h" +#include "misc.h" +#include "thread.h" + +#include "memdbg.h" + +/* + * Check for key size creepage. + */ + +#if MAX_CIPHER_KEY_LENGTH < EVP_MAX_KEY_LENGTH +#warning Some OpenSSL EVP ciphers now support key lengths greater than MAX_CIPHER_KEY_LENGTH -- consider increasing MAX_CIPHER_KEY_LENGTH +#endif + +#if MAX_HMAC_KEY_LENGTH < EVP_MAX_MD_SIZE +#warning Some OpenSSL HMAC message digests now support key lengths greater than MAX_HMAC_KEY_LENGTH -- consider increasing MAX_HMAC_KEY_LENGTH +#endif + +/* + * Encryption and Compression Routines. + * + * On entry, buf contains the input data and length. + * On exit, it should be set to the output data and length. + * + * If buf->len is <= 0 we should return + * If buf->len is set to 0 on exit it tells the caller to ignore the packet. + * + * work is a workspace buffer we are given of size BUF_SIZE. + * work may be used to return output data, or the input buffer + * may be modified and returned as output. If output data is + * returned in work, the data should start after FRAME_HEADROOM bytes + * of padding to leave room for downstream routines to prepend. + * + * Up to a total of FRAME_HEADROOM bytes may be prepended to the input buf + * by all routines (encryption, decryption, compression, and decompression). + * + * Note that the buf_prepend return will assert if we try to + * make a header bigger than FRAME_HEADROOM. This should not + * happen unless the frame parameters are wrong. + */ + +#define CRYPT_ERROR(format) \ + do { msg (D_CRYPT_ERRORS, "%s: " format, error_prefix); goto error_exit; } while (false) + +void +openvpn_encrypt (struct buffer *buf, struct buffer work, + const struct crypto_options *opt, + const struct frame* frame) +{ + struct gc_arena gc; + gc_init (&gc); + + if (buf->len > 0 && opt->key_ctx_bi) + { + struct key_ctx *ctx = &opt->key_ctx_bi->encrypt; + + /* Do Encrypt from buf -> work */ + if (ctx->cipher) + { + uint8_t iv_buf[EVP_MAX_IV_LENGTH]; + const int iv_size = EVP_CIPHER_CTX_iv_length (ctx->cipher); + const unsigned int mode = EVP_CIPHER_CTX_mode (ctx->cipher); + int outlen; + + if (mode == EVP_CIPH_CBC_MODE) + { + CLEAR (iv_buf); + + /* generate pseudo-random IV */ + if (opt->flags & CO_USE_IV) + prng_bytes (iv_buf, iv_size); + + /* Put packet ID in plaintext buffer or IV, depending on cipher mode */ + if (opt->packet_id) + { + struct packet_id_net pin; + packet_id_alloc_outgoing (&opt->packet_id->send, &pin, BOOL_CAST (opt->flags & CO_PACKET_ID_LONG_FORM)); + ASSERT (packet_id_write (&pin, buf, BOOL_CAST (opt->flags & CO_PACKET_ID_LONG_FORM), true)); + } + } + else if (mode == EVP_CIPH_CFB_MODE || mode == EVP_CIPH_OFB_MODE) + { + struct packet_id_net pin; + struct buffer b; + + ASSERT (opt->flags & CO_USE_IV); /* IV and packet-ID required */ + ASSERT (opt->packet_id); /* for this mode. */ + + packet_id_alloc_outgoing (&opt->packet_id->send, &pin, true); + memset (iv_buf, 0, iv_size); + buf_set_write (&b, iv_buf, iv_size); + ASSERT (packet_id_write (&pin, &b, true, false)); + } + else /* We only support CBC, CFB, or OFB modes right now */ + { + ASSERT (0); + } + + /* initialize work buffer with FRAME_HEADROOM bytes of prepend capacity */ + ASSERT (buf_init (&work, FRAME_HEADROOM (frame))); + + /* set the IV pseudo-randomly */ + if (opt->flags & CO_USE_IV) + dmsg (D_PACKET_CONTENT, "ENCRYPT IV: %s", format_hex (iv_buf, iv_size, 0, &gc)); + + dmsg (D_PACKET_CONTENT, "ENCRYPT FROM: %s", + format_hex (BPTR (buf), BLEN (buf), 80, &gc)); + + /* cipher_ctx was already initialized with key & keylen */ + ASSERT (EVP_CipherInit_ov (ctx->cipher, NULL, NULL, iv_buf, DO_ENCRYPT)); + + /* Buffer overflow check */ + if (!buf_safe (&work, buf->len + EVP_CIPHER_CTX_block_size (ctx->cipher))) + { + msg (D_CRYPT_ERRORS, "ENCRYPT: buffer size error, bc=%d bo=%d bl=%d wc=%d wo=%d wl=%d cbs=%d", + buf->capacity, + buf->offset, + buf->len, + work.capacity, + work.offset, + work.len, + EVP_CIPHER_CTX_block_size (ctx->cipher)); + goto err; + } + + /* Encrypt packet ID, payload */ + ASSERT (EVP_CipherUpdate_ov (ctx->cipher, BPTR (&work), &outlen, BPTR (buf), BLEN (buf))); + work.len += outlen; + + /* Flush the encryption buffer */ + ASSERT (EVP_CipherFinal (ctx->cipher, BPTR (&work) + outlen, &outlen)); + work.len += outlen; + ASSERT (outlen == iv_size); + + /* prepend the IV to the ciphertext */ + if (opt->flags & CO_USE_IV) + { + uint8_t *output = buf_prepend (&work, iv_size); + ASSERT (output); + memcpy (output, iv_buf, iv_size); + } + + dmsg (D_PACKET_CONTENT, "ENCRYPT TO: %s", + format_hex (BPTR (&work), BLEN (&work), 80, &gc)); + } + else /* No Encryption */ + { + if (opt->packet_id) + { + struct packet_id_net pin; + packet_id_alloc_outgoing (&opt->packet_id->send, &pin, BOOL_CAST (opt->flags & CO_PACKET_ID_LONG_FORM)); + ASSERT (packet_id_write (&pin, buf, BOOL_CAST (opt->flags & CO_PACKET_ID_LONG_FORM), true)); + } + work = *buf; + } + + /* HMAC the ciphertext (or plaintext if !cipher) */ + if (ctx->hmac) + { + int hmac_len; + uint8_t *output; + + HMAC_Init_ex (ctx->hmac, NULL, 0, NULL, NULL); + HMAC_Update (ctx->hmac, BPTR (&work), BLEN (&work)); + output = buf_prepend (&work, HMAC_size (ctx->hmac)); + ASSERT (output); + HMAC_Final (ctx->hmac, output, (unsigned int *)&hmac_len); + ASSERT (hmac_len == HMAC_size (ctx->hmac)); + } + + *buf = work; + } + + gc_free (&gc); + return; + + err: + ERR_clear_error (); + buf->len = 0; + gc_free (&gc); + return; +} + +/* + * If (opt->flags & CO_USE_IV) is not NULL, we will read an IV from the packet. + * + * Set buf->len to 0 and return false on decrypt error. + * + * On success, buf is set to point to plaintext, true + * is returned. + */ +bool +openvpn_decrypt (struct buffer *buf, struct buffer work, + const struct crypto_options *opt, + const struct frame* frame) +{ + static const char error_prefix[] = "Authenticate/Decrypt packet error"; + struct gc_arena gc; + gc_init (&gc); + + if (buf->len > 0 && opt->key_ctx_bi) + { + struct key_ctx *ctx = &opt->key_ctx_bi->decrypt; + struct packet_id_net pin; + bool have_pin = false; + + /* Verify the HMAC */ + if (ctx->hmac) + { + int hmac_len; + uint8_t local_hmac[MAX_HMAC_KEY_LENGTH]; /* HMAC of ciphertext computed locally */ + int in_hmac_len; + + HMAC_Init_ex (ctx->hmac, NULL, 0, NULL, NULL); + + /* Assume the length of the input HMAC */ + hmac_len = HMAC_size (ctx->hmac); + + /* Authentication fails if insufficient data in packet for HMAC */ + if (buf->len < hmac_len) + CRYPT_ERROR ("missing authentication info"); + + HMAC_Update (ctx->hmac, BPTR (buf) + hmac_len, + BLEN (buf) - hmac_len); + HMAC_Final (ctx->hmac, local_hmac, (unsigned int *)&in_hmac_len); + ASSERT (hmac_len == in_hmac_len); + + /* Compare locally computed HMAC with packet HMAC */ + if (memcmp (local_hmac, BPTR (buf), hmac_len)) + CRYPT_ERROR ("packet HMAC authentication failed"); + + ASSERT (buf_advance (buf, hmac_len)); + } + + /* Decrypt packet ID + payload */ + + if (ctx->cipher) + { + const unsigned int mode = EVP_CIPHER_CTX_mode (ctx->cipher); + const int iv_size = EVP_CIPHER_CTX_iv_length (ctx->cipher); + uint8_t iv_buf[EVP_MAX_IV_LENGTH]; + int outlen; + + /* initialize work buffer with FRAME_HEADROOM bytes of prepend capacity */ + ASSERT (buf_init (&work, FRAME_HEADROOM_ADJ (frame, FRAME_HEADROOM_MARKER_DECRYPT))); + + /* use IV if user requested it */ + CLEAR (iv_buf); + if (opt->flags & CO_USE_IV) + { + if (buf->len < iv_size) + CRYPT_ERROR ("missing IV info"); + memcpy (iv_buf, BPTR (buf), iv_size); + ASSERT (buf_advance (buf, iv_size)); + } + + /* show the IV's initial state */ + if (opt->flags & CO_USE_IV) + dmsg (D_PACKET_CONTENT, "DECRYPT IV: %s", format_hex (iv_buf, iv_size, 0, &gc)); + + if (buf->len < 1) + CRYPT_ERROR ("missing payload"); + + /* ctx->cipher was already initialized with key & keylen */ + if (!EVP_CipherInit_ov (ctx->cipher, NULL, NULL, iv_buf, DO_DECRYPT)) + CRYPT_ERROR ("cipher init failed"); + + /* Buffer overflow check (should never happen) */ + if (!buf_safe (&work, buf->len)) + CRYPT_ERROR ("buffer overflow"); + + /* Decrypt packet ID, payload */ + if (!EVP_CipherUpdate_ov (ctx->cipher, BPTR (&work), &outlen, BPTR (buf), BLEN (buf))) + CRYPT_ERROR ("cipher update failed"); + work.len += outlen; + + /* Flush the decryption buffer */ + if (!EVP_CipherFinal (ctx->cipher, BPTR (&work) + outlen, &outlen)) + CRYPT_ERROR ("cipher final failed"); + work.len += outlen; + + dmsg (D_PACKET_CONTENT, "DECRYPT TO: %s", + format_hex (BPTR (&work), BLEN (&work), 80, &gc)); + + /* Get packet ID from plaintext buffer or IV, depending on cipher mode */ + { + if (mode == EVP_CIPH_CBC_MODE) + { + if (opt->packet_id) + { + if (!packet_id_read (&pin, &work, BOOL_CAST (opt->flags & CO_PACKET_ID_LONG_FORM))) + CRYPT_ERROR ("error reading CBC packet-id"); + have_pin = true; + } + } + else if (mode == EVP_CIPH_CFB_MODE || mode == EVP_CIPH_OFB_MODE) + { + struct buffer b; + + ASSERT (opt->flags & CO_USE_IV); /* IV and packet-ID required */ + ASSERT (opt->packet_id); /* for this mode. */ + + buf_set_read (&b, iv_buf, iv_size); + if (!packet_id_read (&pin, &b, true)) + CRYPT_ERROR ("error reading CFB/OFB packet-id"); + have_pin = true; + } + else /* We only support CBC, CFB, or OFB modes right now */ + { + ASSERT (0); + } + } + } + else + { + work = *buf; + if (opt->packet_id) + { + if (!packet_id_read (&pin, &work, BOOL_CAST (opt->flags & CO_PACKET_ID_LONG_FORM))) + CRYPT_ERROR ("error reading packet-id"); + have_pin = !BOOL_CAST (opt->flags & CO_IGNORE_PACKET_ID); + } + } + + if (have_pin) + { + packet_id_reap_test (&opt->packet_id->rec); + if (packet_id_test (&opt->packet_id->rec, &pin)) + { + packet_id_add (&opt->packet_id->rec, &pin); + if (opt->pid_persist && (opt->flags & CO_PACKET_ID_LONG_FORM)) + packet_id_persist_save_obj (opt->pid_persist, opt->packet_id); + } + else + { + if (!(opt->flags & CO_MUTE_REPLAY_WARNINGS)) + msg (D_REPLAY_ERRORS, "%s: bad packet ID (may be a replay): %s -- see the man page entry for --no-replay and --replay-window for more info or silence this warning with --mute-replay-warnings", + error_prefix, packet_id_net_print (&pin, true, &gc)); + goto error_exit; + } + } + *buf = work; + } + + gc_free (&gc); + return true; + + error_exit: + ERR_clear_error (); + buf->len = 0; + gc_free (&gc); + return false; +} + +/* + * How many bytes will we add to frame buffer for a given + * set of crypto options? + */ +void +crypto_adjust_frame_parameters(struct frame *frame, + const struct key_type* kt, + bool cipher_defined, + bool use_iv, + bool packet_id, + bool packet_id_long_form) +{ + frame_add_to_extra_frame (frame, + (packet_id ? packet_id_size (packet_id_long_form) : 0) + + ((cipher_defined && use_iv) ? EVP_CIPHER_iv_length (kt->cipher) : 0) + + (cipher_defined ? EVP_CIPHER_block_size (kt->cipher) : 0) + /* worst case padding expansion */ + kt->hmac_length); +} + +static const EVP_CIPHER * +get_cipher (const char *ciphername) +{ + const EVP_CIPHER *cipher = NULL; + ASSERT (ciphername); + cipher = EVP_get_cipherbyname (ciphername); + if ( !(cipher && cipher_ok (OBJ_nid2sn (EVP_CIPHER_nid (cipher))))) + msg (M_SSLERR, "Cipher algorithm '%s' not found", ciphername); + if (EVP_CIPHER_key_length (cipher) > MAX_CIPHER_KEY_LENGTH) + msg (M_FATAL, "Cipher algorithm '%s' uses a default key size (%d bytes) which is larger than " PACKAGE_NAME "'s current maximum key size (%d bytes)", + ciphername, + EVP_CIPHER_key_length (cipher), + MAX_CIPHER_KEY_LENGTH); + return cipher; +} + +static const EVP_MD * +get_md (const char *digest) +{ + const EVP_MD *md = NULL; + ASSERT (digest); + md = EVP_get_digestbyname (digest); + if (!md) + msg (M_SSLERR, "Message hash algorithm '%s' not found", digest); + if (EVP_MD_size (md) > MAX_HMAC_KEY_LENGTH) + msg (M_FATAL, "Message hash algorithm '%s' uses a default hash size (%d bytes) which is larger than " PACKAGE_NAME "'s current maximum hash size (%d bytes)", + digest, + EVP_MD_size (md), + MAX_HMAC_KEY_LENGTH); + return md; +} + +static void +init_cipher (EVP_CIPHER_CTX *ctx, const EVP_CIPHER *cipher, + struct key *key, const struct key_type *kt, int enc, + const char *prefix) +{ + struct gc_arena gc = gc_new (); + + EVP_CIPHER_CTX_init (ctx); + if (!EVP_CipherInit_ov (ctx, cipher, NULL, NULL, enc)) + msg (M_SSLERR, "EVP cipher init #1"); +#ifdef HAVE_EVP_CIPHER_CTX_SET_KEY_LENGTH + if (!EVP_CIPHER_CTX_set_key_length (ctx, kt->cipher_length)) + msg (M_SSLERR, "EVP set key size"); +#endif + if (!EVP_CipherInit_ov (ctx, NULL, key->cipher, NULL, enc)) + msg (M_SSLERR, "EVP cipher init #2"); + + msg (D_HANDSHAKE, "%s: Cipher '%s' initialized with %d bit key", + prefix, + OBJ_nid2sn (EVP_CIPHER_CTX_nid (ctx)), + EVP_CIPHER_CTX_key_length (ctx) * 8); + + /* make sure we used a big enough key */ + ASSERT (EVP_CIPHER_CTX_key_length (ctx) <= kt->cipher_length); + + dmsg (D_SHOW_KEYS, "%s: CIPHER KEY: %s", prefix, + format_hex (key->cipher, kt->cipher_length, 0, &gc)); + dmsg (D_CRYPTO_DEBUG, "%s: CIPHER block_size=%d iv_size=%d", + prefix, + EVP_CIPHER_CTX_block_size (ctx), + EVP_CIPHER_CTX_iv_length (ctx)); + + gc_free (&gc); +} + +static void +init_hmac (HMAC_CTX *ctx, const EVP_MD *digest, + struct key *key, const struct key_type *kt, const char *prefix) +{ + struct gc_arena gc = gc_new (); + + HMAC_CTX_init (ctx); + HMAC_Init_ex (ctx, key->hmac, kt->hmac_length, digest, NULL); + msg (D_HANDSHAKE, + "%s: Using %d bit message hash '%s' for HMAC authentication", + prefix, HMAC_size (ctx) * 8, OBJ_nid2sn (EVP_MD_type (digest))); + + /* make sure we used a big enough key */ + ASSERT (HMAC_size (ctx) <= kt->hmac_length); + + dmsg (D_SHOW_KEYS, "%s: HMAC KEY: %s", prefix, + format_hex (key->hmac, kt->hmac_length, 0, &gc)); + dmsg (D_CRYPTO_DEBUG, "%s: HMAC size=%d block_size=%d", + prefix, + EVP_MD_size (digest), + EVP_MD_block_size (digest)); + + gc_free (&gc); +} + +/* + * Build a struct key_type. + */ +void +init_key_type (struct key_type *kt, const char *ciphername, + bool ciphername_defined, const char *authname, + bool authname_defined, int keysize, + bool cfb_ofb_allowed, bool warn) +{ + CLEAR (*kt); + if (ciphername && ciphername_defined) + { + kt->cipher = get_cipher (ciphername); + kt->cipher_length = EVP_CIPHER_key_length (kt->cipher); + if (keysize > 0 && keysize <= MAX_CIPHER_KEY_LENGTH) + kt->cipher_length = keysize; + + /* check legal cipher mode */ + { + const unsigned int mode = EVP_CIPHER_mode (kt->cipher); + if (!(mode == EVP_CIPH_CBC_MODE +#ifdef ALLOW_NON_CBC_CIPHERS + || (cfb_ofb_allowed && (mode == EVP_CIPH_CFB_MODE || mode == EVP_CIPH_OFB_MODE)) +#endif + )) +#ifdef ENABLE_SMALL + msg (M_FATAL, "Cipher '%s' mode not supported", ciphername); +#else + msg (M_FATAL, "Cipher '%s' uses a mode not supported by " PACKAGE_NAME " in your current configuration. CBC mode is always supported, while CFB and OFB modes are supported only when using SSL/TLS authentication and key exchange mode, and when " PACKAGE_NAME " has been built with ALLOW_NON_CBC_CIPHERS.", ciphername); +#endif + } + } + else + { + if (warn) + msg (M_WARN, "******* WARNING *******: null cipher specified, no encryption will be used"); + } + if (authname && authname_defined) + { + kt->digest = get_md (authname); + kt->hmac_length = EVP_MD_size (kt->digest); + } + else + { + if (warn) + msg (M_WARN, "******* WARNING *******: null MAC specified, no authentication will be used"); + } +} + +const char * +kt_cipher_name (const struct key_type *kt) +{ + if (kt->cipher) + return EVP_CIPHER_name (kt->cipher); + else + return "[null-cipher]"; +} + +const char * +kt_digest_name (const struct key_type *kt) +{ + if (kt->digest) + return EVP_MD_name (kt->digest); + else + return "[null-digest]"; +} + +int +kt_key_size (const struct key_type *kt) +{ + if (kt->cipher_length) + return kt->cipher_length * 8; + else if (kt->cipher) + return EVP_CIPHER_key_length (kt->cipher) * 8; + else + return 0; +} + +/* given a key and key_type, build a key_ctx */ +void +init_key_ctx (struct key_ctx *ctx, struct key *key, + const struct key_type *kt, int enc, + const char *prefix) +{ + CLEAR (*ctx); + if (kt->cipher && kt->cipher_length > 0) + { + ALLOC_OBJ (ctx->cipher, EVP_CIPHER_CTX); + init_cipher (ctx->cipher, kt->cipher, key, kt, enc, prefix); + } + if (kt->digest && kt->hmac_length > 0) + { + ALLOC_OBJ (ctx->hmac, HMAC_CTX); + init_hmac (ctx->hmac, kt->digest, key, kt, prefix); + } +} + +void +free_key_ctx (struct key_ctx *ctx) +{ + if (ctx->cipher) + { + EVP_CIPHER_CTX_cleanup (ctx->cipher); + free (ctx->cipher); + ctx->cipher = NULL; + } + if (ctx->hmac) + { + HMAC_CTX_cleanup (ctx->hmac); + free (ctx->hmac); + ctx->hmac = NULL; + } +} + +void +free_key_ctx_bi (struct key_ctx_bi *ctx) +{ + free_key_ctx(&ctx->encrypt); + free_key_ctx(&ctx->decrypt); +} + +/* + * Return number of DES cblocks for the current + * key type or 0 if not a DES cipher. + */ +static int +n_DES_cblocks (const struct key_type *kt) +{ + int ret = 0; + const char *name = OBJ_nid2sn (EVP_CIPHER_nid (kt->cipher)); + if (name) + { + if (!strncmp (name, "DES-", 4)) + { + ret = EVP_CIPHER_key_length (kt->cipher) / sizeof (DES_cblock); + } + else if (!strncmp (name, "DESX-", 5)) + { + ret = 1; + } + } + dmsg (D_CRYPTO_DEBUG, "CRYPTO INFO: n_DES_cblocks=%d", ret); + return ret; +} + +static bool +check_key_DES (struct key *key, const struct key_type *kt, int ndc) +{ + int i; + struct buffer b; + + buf_set_read (&b, key->cipher, kt->cipher_length); + + for (i = 0; i < ndc; ++i) + { + DES_cblock *dc = (DES_cblock*) buf_read_alloc (&b, sizeof (DES_cblock)); + if (!dc) + { + msg (D_CRYPT_ERRORS, "CRYPTO INFO: check_key_DES: insufficient key material"); + goto err; + } + if (DES_is_weak_key(dc)) + { + msg (D_CRYPT_ERRORS, "CRYPTO INFO: check_key_DES: weak key detected"); + goto err; + } + if (!DES_check_key_parity (dc)) + { + msg (D_CRYPT_ERRORS, "CRYPTO INFO: check_key_DES: bad parity detected"); + goto err; + } + } + return true; + + err: + ERR_clear_error (); + return false; +} + +static void +fixup_key_DES (struct key *key, const struct key_type *kt, int ndc) +{ + int i; + struct buffer b; + + buf_set_read (&b, key->cipher, kt->cipher_length); + for (i = 0; i < ndc; ++i) + { + DES_cblock *dc = (DES_cblock*) buf_read_alloc(&b, sizeof(DES_cblock)); + if (!dc) + { + msg (D_CRYPT_ERRORS, "CRYPTO INFO: fixup_key_DES: insufficient key material"); + ERR_clear_error (); + return; + } + DES_set_odd_parity (dc); + } +} + +static bool +key_is_zero (struct key *key, const struct key_type *kt) +{ + int i; + for (i = 0; i < kt->cipher_length; ++i) + if (key->cipher[i]) + return false; + msg (D_CRYPT_ERRORS, "CRYPTO INFO: WARNING: zero key detected"); + return true; +} + +/* + * Make sure that cipher key is a valid key for current key_type. + */ +bool +check_key (struct key *key, const struct key_type *kt) +{ + if (kt->cipher) + { + /* + * Check for zero key + */ + if (key_is_zero(key, kt)) + return false; + + /* + * Check for weak or semi-weak DES keys. + */ + { + const int ndc = n_DES_cblocks (kt); + if (ndc) + return check_key_DES (key, kt, ndc); + else + return true; + } + } + return true; +} + +/* + * Make safe mutations to key to ensure it is valid, + * such as ensuring correct parity on DES keys. + * + * This routine cannot guarantee it will generate a good + * key. You must always call check_key after this routine + * to make sure. + */ +void +fixup_key (struct key *key, const struct key_type *kt) +{ + struct gc_arena gc = gc_new (); + if (kt->cipher) + { +#ifdef ENABLE_DEBUG + const struct key orig = *key; +#endif + const int ndc = n_DES_cblocks (kt); + + if (ndc) + fixup_key_DES (key, kt, ndc); + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_CRYPTO_DEBUG)) + { + if (memcmp (orig.cipher, key->cipher, kt->cipher_length)) + dmsg (D_CRYPTO_DEBUG, "CRYPTO INFO: fixup_key: before=%s after=%s", + format_hex (orig.cipher, kt->cipher_length, 0, &gc), + format_hex (key->cipher, kt->cipher_length, 0, &gc)); + } +#endif + } + gc_free (&gc); +} + +void +check_replay_iv_consistency (const struct key_type *kt, bool packet_id, bool use_iv) +{ + if (cfb_ofb_mode (kt) && !(packet_id && use_iv)) + msg (M_FATAL, "--no-replay or --no-iv cannot be used with a CFB or OFB mode cipher"); +} + +bool +cfb_ofb_mode (const struct key_type* kt) +{ + if (kt->cipher) { + const unsigned int mode = EVP_CIPHER_mode (kt->cipher); + return mode == EVP_CIPH_CFB_MODE || mode == EVP_CIPH_OFB_MODE; + } else + return false; +} + +/* + * Generate a random key. If key_type is provided, make + * sure generated key is valid for key_type. + */ +void +generate_key_random (struct key *key, const struct key_type *kt) +{ + int cipher_len = MAX_CIPHER_KEY_LENGTH; + int hmac_len = MAX_HMAC_KEY_LENGTH; + + struct gc_arena gc = gc_new (); + + do { + CLEAR (*key); + if (kt) + { + if (kt->cipher && kt->cipher_length > 0 && kt->cipher_length <= cipher_len) + cipher_len = kt->cipher_length; + + if (kt->digest && kt->hmac_length > 0 && kt->hmac_length <= hmac_len) + hmac_len = kt->hmac_length; + } + if (!RAND_bytes (key->cipher, cipher_len) + || !RAND_bytes (key->hmac, hmac_len)) + msg (M_FATAL, "ERROR: Random number generator cannot obtain entropy for key generation"); + + dmsg (D_SHOW_KEY_SOURCE, "Cipher source entropy: %s", format_hex (key->cipher, cipher_len, 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, "HMAC source entropy: %s", format_hex (key->hmac, hmac_len, 0, &gc)); + + if (kt) + fixup_key (key, kt); + } while (kt && !check_key (key, kt)); + + gc_free (&gc); +} + +/* + * Print key material + */ +void +key2_print (const struct key2* k, + const struct key_type *kt, + const char* prefix0, + const char* prefix1) +{ + struct gc_arena gc = gc_new (); + ASSERT (k->n == 2); + dmsg (D_SHOW_KEY_SOURCE, "%s (cipher): %s", + prefix0, + format_hex (k->keys[0].cipher, kt->cipher_length, 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, "%s (hmac): %s", + prefix0, + format_hex (k->keys[0].hmac, kt->hmac_length, 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, "%s (cipher): %s", + prefix1, + format_hex (k->keys[1].cipher, kt->cipher_length, 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, "%s (hmac): %s", + prefix1, + format_hex (k->keys[1].hmac, kt->hmac_length, 0, &gc)); + gc_free (&gc); +} + +void +test_crypto (const struct crypto_options *co, struct frame* frame) +{ + int i, j; + struct gc_arena gc = gc_new (); + struct buffer src = alloc_buf_gc (TUN_MTU_SIZE (frame), &gc); + struct buffer work = alloc_buf_gc (BUF_SIZE (frame), &gc); + struct buffer encrypt_workspace = alloc_buf_gc (BUF_SIZE (frame), &gc); + struct buffer decrypt_workspace = alloc_buf_gc (BUF_SIZE (frame), &gc); + struct buffer buf = clear_buf(); + + /* init work */ + ASSERT (buf_init (&work, FRAME_HEADROOM (frame))); + + msg (M_INFO, "Entering " PACKAGE_NAME " crypto self-test mode."); + for (i = 1; i <= TUN_MTU_SIZE (frame); ++i) + { + update_time (); + + msg (M_INFO, "TESTING ENCRYPT/DECRYPT of packet length=%d", i); + + /* + * Load src with random data. + */ + ASSERT (buf_init (&src, 0)); + ASSERT (i <= src.capacity); + src.len = i; + ASSERT (RAND_pseudo_bytes (BPTR (&src), BLEN (&src))); + + /* copy source to input buf */ + buf = work; + memcpy (buf_write_alloc (&buf, BLEN (&src)), BPTR (&src), BLEN (&src)); + + /* encrypt */ + openvpn_encrypt (&buf, encrypt_workspace, co, frame); + + /* decrypt */ + openvpn_decrypt (&buf, decrypt_workspace, co, frame); + + /* compare */ + if (buf.len != src.len) + msg (M_FATAL, "SELF TEST FAILED, src.len=%d buf.len=%d", src.len, buf.len); + for (j = 0; j < i; ++j) + { + const uint8_t in = *(BPTR (&src) + j); + const uint8_t out = *(BPTR (&buf) + j); + if (in != out) + msg (M_FATAL, "SELF TEST FAILED, pos=%d in=%d out=%d", j, in, out); + } + } + msg (M_INFO, PACKAGE_NAME " crypto self-test mode SUCCEEDED."); + gc_free (&gc); +} + +#ifdef USE_SSL +void +get_tls_handshake_key (const struct key_type *key_type, + struct key_ctx_bi *ctx, + const char *passphrase_file, + bool key_direction) +{ + if (passphrase_file && key_type->hmac_length) + { + struct key2 key2; + struct key_type kt = *key_type; + struct key_direction_state kds; + + /* for control channel we are only authenticating, not encrypting */ + kt.cipher_length = 0; + kt.cipher = NULL; + + /* first try to parse as an OpenVPN static key file */ + read_key_file (&key2, passphrase_file, false); + + /* succeeded? */ + if (key2.n == 2) + { + msg (M_INFO, + "Control Channel Authentication: using '%s' as a " PACKAGE_NAME " static key file", + passphrase_file); + } + else + { + int hash_size; + + CLEAR (key2); + + /* failed, now try to get hash from a freeform file */ + hash_size = read_passphrase_hash (passphrase_file, + kt.digest, + key2.keys[0].hmac, + MAX_HMAC_KEY_LENGTH); + ASSERT (hash_size == kt.hmac_length); + + /* suceeded */ + key2.n = 1; + + msg (M_INFO, + "Control Channel Authentication: using '%s' as a free-form passphrase file", + passphrase_file); + } + + /* handle key direction */ + + key_direction_state_init (&kds, key_direction); + must_have_n_keys (passphrase_file, "tls-auth", &key2, kds.need_keys); + + /* initialize hmac key in both directions */ + + init_key_ctx (&ctx->encrypt, &key2.keys[kds.out_key], &kt, DO_ENCRYPT, + "Outgoing Control Channel Authentication"); + init_key_ctx (&ctx->decrypt, &key2.keys[kds.in_key], &kt, DO_DECRYPT, + "Incoming Control Channel Authentication"); + + CLEAR (key2); + } + else + { + CLEAR (*ctx); + } +} +#endif + +/* header and footer for static key file */ +static const char static_key_head[] = "-----BEGIN " PACKAGE_NAME " Static key V1-----"; +static const char static_key_foot[] = "-----END " PACKAGE_NAME " Static key V1-----"; + +static const char printable_char_fmt[] = + "Non-Hex character ('%c') found at line %d in key file '%s' (%d/%d/%d bytes found/min/max)"; + +static const char unprintable_char_fmt[] = + "Non-Hex, unprintable character (0x%02x) found at line %d in key file '%s' (%d/%d/%d bytes found/min/max)"; + +/* read key from file */ +void +read_key_file (struct key2 *key2, const char *filename, bool must_succeed) +{ + struct gc_arena gc = gc_new (); + struct buffer in = alloc_buf_gc (64, &gc); + int fd, size; + uint8_t hex_byte[3] = {0, 0, 0}; + + /* parse info */ + int hb_index = 0; + int line_num = 1; + int line_index = 0; + int match = 0; + + /* output */ + uint8_t* out = (uint8_t*) &key2->keys; + const int keylen = sizeof (key2->keys); + int count = 0; + + /* parse states */ +# define PARSE_INITIAL 0 +# define PARSE_HEAD 1 +# define PARSE_DATA 2 +# define PARSE_DATA_COMPLETE 3 +# define PARSE_FOOT 4 +# define PARSE_FINISHED 5 + int state = PARSE_INITIAL; + + /* constants */ + const int hlen = strlen (static_key_head); + const int flen = strlen (static_key_foot); + const int onekeylen = sizeof (key2->keys[0]); + + CLEAR (*key2); + + fd = open (filename, O_RDONLY); + if (fd == -1) + msg (M_ERR, "Cannot open file key file '%s'", filename); + + while ((size = read (fd, in.data, in.capacity))) + { + const char *cp = (char *)in.data; + while (size) + { + const char c = *cp; + +#if 0 + msg (M_INFO, "char='%c' s=%d ln=%d li=%d m=%d c=%d", + c, state, line_num, line_index, match, count); +#endif + + if (c == '\n') + { + line_index = match = 0; + ++line_num; + } + else + { + /* first char of new line */ + if (!line_index) + { + /* first char of line after header line? */ + if (state == PARSE_HEAD) + state = PARSE_DATA; + + /* first char of footer */ + if ((state == PARSE_DATA || state == PARSE_DATA_COMPLETE) && c == '-') + state = PARSE_FOOT; + } + + /* compare read chars with header line */ + if (state == PARSE_INITIAL) + { + if (line_index < hlen && c == static_key_head[line_index]) + { + if (++match == hlen) + state = PARSE_HEAD; + } + } + + /* compare read chars with footer line */ + if (state == PARSE_FOOT) + { + if (line_index < flen && c == static_key_foot[line_index]) + { + if (++match == flen) + state = PARSE_FINISHED; + } + } + + /* reading key */ + if (state == PARSE_DATA) + { + if (isxdigit(c)) + { + ASSERT (hb_index >= 0 && hb_index < 2); + hex_byte[hb_index++] = c; + if (hb_index == 2) + { + unsigned int u; + ASSERT(sscanf((const char *)hex_byte, "%x", &u) == 1); + *out++ = u; + hb_index = 0; + if (++count == keylen) + state = PARSE_DATA_COMPLETE; + } + } + else if (isspace(c)) + ; + else + { + msg (M_FATAL, + (isprint (c) ? printable_char_fmt : unprintable_char_fmt), + c, line_num, filename, count, onekeylen, keylen); + } + } + ++line_index; + } + ++cp; + --size; + } + } + + close (fd); + + /* + * Normally we will read either 1 or 2 keys from file. + */ + key2->n = count / onekeylen; + + ASSERT (key2->n >= 0 && key2->n <= (int) SIZE (key2->keys)); + + if (must_succeed) + { + if (!key2->n) + msg (M_FATAL, "Insufficient key material or header text not found found in file '%s' (%d/%d/%d bytes found/min/max)", + filename, count, onekeylen, keylen); + + if (state != PARSE_FINISHED) + msg (M_FATAL, "Footer text not found in file '%s' (%d/%d/%d bytes found/min/max)", + filename, count, onekeylen, keylen); + } + + /* zero file read buffer */ + buf_clear (&in); + + if (key2->n) + warn_if_group_others_accessible (filename); + +#if 0 + /* DEBUGGING */ + { + int i; + printf ("KEY READ, n=%d\n", key2->n); + for (i = 0; i < (int) SIZE (key2->keys); ++i) + { + /* format key as ascii */ + const char *fmt = format_hex_ex ((const uint8_t*)&key2->keys[i], + sizeof (key2->keys[i]), + 0, + 16, + "\n", + &gc); + printf ("[%d]\n%s\n\n", i, fmt); + } + } +#endif + + /* pop our garbage collection level */ + gc_free (&gc); +} + +int +read_passphrase_hash (const char *passphrase_file, + const EVP_MD *digest, + uint8_t *output, + int len) +{ + unsigned int outlen = 0; + EVP_MD_CTX md; + + ASSERT (len >= EVP_MD_size (digest)); + memset (output, 0, len); + + EVP_DigestInit (&md, digest); + + /* read passphrase file */ + { + const int min_passphrase_size = 8; + uint8_t buf[64]; + int total_size = 0; + int fd = open (passphrase_file, O_RDONLY); + + if (fd == -1) + msg (M_ERR, "Cannot open passphrase file: '%s'", passphrase_file); + + for (;;) + { + int size = read (fd, buf, sizeof (buf)); + if (size == 0) + break; + if (size == -1) + msg (M_ERR, "Read error on passphrase file: '%s'", + passphrase_file); + EVP_DigestUpdate (&md, buf, size); + total_size += size; + } + close (fd); + + warn_if_group_others_accessible (passphrase_file); + + if (total_size < min_passphrase_size) + msg (M_FATAL, + "Passphrase file '%s' is too small (must have at least %d characters)", + passphrase_file, min_passphrase_size); + } + + EVP_DigestFinal (&md, output, &outlen); + EVP_MD_CTX_cleanup (&md); + return outlen; +} + +/* + * Write key to file, return number of random bits + * written. + */ +int +write_key_file (const int nkeys, const char *filename) +{ + struct gc_arena gc = gc_new (); + + int fd, i; + int nbits = 0; + + /* must be large enough to hold full key file */ + struct buffer out = alloc_buf_gc (2048, &gc); + struct buffer nbits_head_text = alloc_buf_gc (128, &gc); + + /* how to format the ascii file representation of key */ + const int bytes_per_line = 16; + + /* open key file */ + fd = open (filename, O_CREAT | O_TRUNC | O_WRONLY, S_IRUSR | S_IWUSR); + + if (fd == -1) + msg (M_ERR, "Cannot open shared secret file '%s' for write", filename); + + buf_printf (&out, "%s\n", static_key_head); + + for (i = 0; i < nkeys; ++i) + { + struct key key; + char* fmt; + + /* generate random bits */ + generate_key_random (&key, NULL); + + /* format key as ascii */ + fmt = format_hex_ex ((const uint8_t*)&key, + sizeof (key), + 0, + bytes_per_line, + "\n", + &gc); + + /* increment random bits counter */ + nbits += sizeof (key) * 8; + + /* write to holding buffer */ + buf_printf (&out, "%s\n", fmt); + + /* zero memory which held key component (will be freed by GC) */ + memset (fmt, 0, strlen(fmt)); + CLEAR (key); + } + + buf_printf (&out, "%s\n", static_key_foot); + + /* write number of bits */ + buf_printf (&nbits_head_text, "#\n# %d bit " PACKAGE_NAME " static key\n#\n", nbits); + buf_write_string_file (&nbits_head_text, filename, fd); + + /* write key file, now formatted in out, to file */ + buf_write_string_file (&out, filename, fd); + + if (close (fd)) + msg (M_ERR, "Close error on shared secret file %s", filename); + + /* zero memory which held file content (memory will be freed by GC) */ + buf_clear (&out); + + /* pop our garbage collection level */ + gc_free (&gc); + + return nbits; +} + +void +must_have_n_keys (const char *filename, const char *option, const struct key2 *key2, int n) +{ + if (key2->n < n) + { +#ifdef ENABLE_SMALL + msg (M_FATAL, "Key file '%s' used in --%s contains insufficient key material [keys found=%d required=%d]", filename, option, key2->n, n); +#else + msg (M_FATAL, "Key file '%s' used in --%s contains insufficient key material [keys found=%d required=%d] -- try generating a new key file with '" PACKAGE " --genkey --secret [file]', or use the existing key file in bidirectional mode by specifying --%s without a key direction parameter", filename, option, key2->n, n, option); +#endif + } +} + +int +ascii2keydirection (int msglevel, const char *str) +{ + if (!str) + return KEY_DIRECTION_BIDIRECTIONAL; + else if (!strcmp (str, "0")) + return KEY_DIRECTION_NORMAL; + else if (!strcmp (str, "1")) + return KEY_DIRECTION_INVERSE; + else + { + msg (msglevel, "Unknown key direction '%s' -- must be '0' or '1'", str); + return -1; + } + return KEY_DIRECTION_BIDIRECTIONAL; /* NOTREACHED */ +} + +const char * +keydirection2ascii (int kd, bool remote) +{ + if (kd == KEY_DIRECTION_BIDIRECTIONAL) + return NULL; + else if (kd == KEY_DIRECTION_NORMAL) + return remote ? "1" : "0"; + else if (kd == KEY_DIRECTION_INVERSE) + return remote ? "0" : "1"; + else + { + ASSERT (0); + } + return NULL; /* NOTREACHED */ +} + +void +key_direction_state_init (struct key_direction_state *kds, int key_direction) +{ + CLEAR (*kds); + switch (key_direction) + { + case KEY_DIRECTION_NORMAL: + kds->out_key = 0; + kds->in_key = 1; + kds->need_keys = 2; + break; + case KEY_DIRECTION_INVERSE: + kds->out_key = 1; + kds->in_key = 0; + kds->need_keys = 2; + break; + case KEY_DIRECTION_BIDIRECTIONAL: + kds->out_key = 0; + kds->in_key = 0; + kds->need_keys = 1; + break; + default: + ASSERT (0); + } +} + +void +verify_fix_key2 (struct key2 *key2, const struct key_type *kt, const char *shared_secret_file) +{ + int i; + + for (i = 0; i < key2->n; ++i) + { + /* Fix parity for DES keys and make sure not a weak key */ + fixup_key (&key2->keys[i], kt); + + /* This should be a very improbable failure */ + if (!check_key (&key2->keys[i], kt)) + msg (M_FATAL, "Key #%d in '%s' is bad. Try making a new key with --genkey.", + i+1, shared_secret_file); + } +} + +/* given a key and key_type, write key to buffer */ +bool +write_key (const struct key *key, const struct key_type *kt, + struct buffer *buf) +{ + ASSERT (kt->cipher_length <= MAX_CIPHER_KEY_LENGTH + && kt->hmac_length <= MAX_HMAC_KEY_LENGTH); + + if (!buf_write (buf, &kt->cipher_length, 1)) + return false; + if (!buf_write (buf, &kt->hmac_length, 1)) + return false; + if (!buf_write (buf, key->cipher, kt->cipher_length)) + return false; + if (!buf_write (buf, key->hmac, kt->hmac_length)) + return false; + + return true; +} + +/* + * Given a key_type and buffer, read key from buffer. + * Return: 1 on success + * -1 read failure + * 0 on key length mismatch + */ +int +read_key (struct key *key, const struct key_type *kt, struct buffer *buf) +{ + uint8_t cipher_length; + uint8_t hmac_length; + + CLEAR (*key); + if (!buf_read (buf, &cipher_length, 1)) + goto read_err; + if (!buf_read (buf, &hmac_length, 1)) + goto read_err; + + if (!buf_read (buf, key->cipher, cipher_length)) + goto read_err; + if (!buf_read (buf, key->hmac, hmac_length)) + goto read_err; + + if (cipher_length != kt->cipher_length || hmac_length != kt->hmac_length) + goto key_len_err; + + return 1; + +read_err: + msg (D_TLS_ERRORS, "TLS Error: error reading key from remote"); + return -1; + +key_len_err: + msg (D_TLS_ERRORS, + "TLS Error: key length mismatch, local cipher/hmac %d/%d, remote cipher/hmac %d/%d", + kt->cipher_length, kt->hmac_length, cipher_length, hmac_length); + return 0; +} + +void +show_available_ciphers () +{ + int nid; + + +#ifndef ENABLE_SMALL + printf ("The following ciphers and cipher modes are available\n" + "for use with " PACKAGE_NAME ". Each cipher shown below may be\n" + "used as a parameter to the --cipher option. The default\n" + "key size is shown as well as whether or not it can be\n" + "changed with the --keysize directive. Using a CBC mode\n" + "is recommended.\n\n"); +#endif + + for (nid = 0; nid < 10000; ++nid) /* is there a better way to get the size of the nid list? */ + { + const EVP_CIPHER *cipher = EVP_get_cipherbynid (nid); + if (cipher && cipher_ok (OBJ_nid2sn (nid))) + { + const unsigned int mode = EVP_CIPHER_mode (cipher); + if (mode == EVP_CIPH_CBC_MODE +#ifdef ALLOW_NON_CBC_CIPHERS + || mode == EVP_CIPH_CFB_MODE || mode == EVP_CIPH_OFB_MODE +#endif + ) + printf ("%s %d bit default key (%s)\n", + OBJ_nid2sn (nid), + EVP_CIPHER_key_length (cipher) * 8, + ((EVP_CIPHER_flags (cipher) & EVP_CIPH_VARIABLE_LENGTH) ? + "variable" : "fixed")); + } + } + printf ("\n"); +} + +void +show_available_digests () +{ + int nid; + +#ifndef ENABLE_SMALL + printf ("The following message digests are available for use with\n" + PACKAGE_NAME ". A message digest is used in conjunction with\n" + "the HMAC function, to authenticate received packets.\n" + "You can specify a message digest as parameter to\n" + "the --auth option.\n\n"); +#endif + + for (nid = 0; nid < 10000; ++nid) + { + const EVP_MD *digest = EVP_get_digestbynid (nid); + if (digest) + { + printf ("%s %d bit digest size\n", + OBJ_nid2sn (nid), EVP_MD_size (digest) * 8); + } + } + printf ("\n"); +} + +void +show_available_engines () +{ +#if CRYPTO_ENGINE + ENGINE *e; + + printf ("OpenSSL Crypto Engines\n\n"); + + ENGINE_load_builtin_engines (); + + e = ENGINE_get_first (); + while (e) + { + printf ("%s [%s]\n", + ENGINE_get_name (e), + ENGINE_get_id (e)); + e = ENGINE_get_next (e); + } + ENGINE_cleanup (); +#else + printf ("Sorry, OpenSSL hardware crypto engine functionality is not available.\n"); +#endif +} + +/* + * Enable crypto acceleration, if available + */ + +static bool engine_initialized = false; /* GLOBAL */ + +#if CRYPTO_ENGINE + +static ENGINE *engine_persist = NULL; /* GLOBAL */ + +/* Try to load an engine in a shareable library */ +static ENGINE * +try_load_engine (const char *engine) +{ + ENGINE *e = ENGINE_by_id ("dynamic"); + if (e) + { + if (!ENGINE_ctrl_cmd_string (e, "SO_PATH", engine, 0) + || !ENGINE_ctrl_cmd_string (e, "LOAD", NULL, 0)) + { + ENGINE_free (e); + e = NULL; + } + } + return e; +} + +static ENGINE * +setup_engine (const char *engine) +{ + ENGINE *e = NULL; + + ENGINE_load_builtin_engines (); + + if (engine) + { + if (strcmp (engine, "auto") == 0) + { + msg (M_INFO, "Initializing OpenSSL auto engine support"); + ENGINE_register_all_complete (); + return NULL; + } + if ((e = ENGINE_by_id (engine)) == NULL + && (e = try_load_engine (engine)) == NULL) + { + msg (M_FATAL, "OpenSSL error: cannot load engine '%s'", engine); + } + + if (!ENGINE_set_default (e, ENGINE_METHOD_ALL)) + { + msg (M_FATAL, "OpenSSL error: ENGINE_set_default failed on engine '%s'", + engine); + } + + msg (M_INFO, "Initializing OpenSSL support for engine '%s'", + ENGINE_get_id (e)); + } + return e; +} +#endif + +void +init_crypto_lib_engine (const char *engine_name) +{ + if (!engine_initialized) + { +#if CRYPTO_ENGINE + ASSERT (engine_name); + ASSERT (!engine_persist); + engine_persist = setup_engine (engine_name); +#else + msg (M_WARN, "Note: OpenSSL hardware crypto engine functionality is not available"); +#endif + engine_initialized = true; + } +} + +/* + * This routine should have additional OpenSSL crypto library initialisations + * used by both crypto and ssl components of OpenVPN. + */ +void init_crypto_lib () +{ +} + +void uninit_crypto_lib () +{ +#if CRYPTO_ENGINE + if (engine_initialized) + { + ENGINE_cleanup (); + engine_persist = NULL; + engine_initialized = false; + } +#endif +} + +/* + * Random number functions, used in cases where we want + * reasonably strong cryptographic random number generation + * without depleting our entropy pool. Used for random + * IV values and a number of other miscellaneous tasks. + */ + +#define NONCE_SECRET_LEN 16 + +static uint8_t nonce_data [SHA_DIGEST_LENGTH + NONCE_SECRET_LEN]; /* GLOBAL */ + +void +prng_init (void) +{ + if (!RAND_bytes (nonce_data, sizeof(nonce_data))) + msg (M_FATAL, "ERROR: Random number generator cannot obtain entropy for PRNG"); +} + +void +prng_bytes (uint8_t *output, int len) +{ + SHA_CTX ctx; + mutex_lock_static (L_PRNG); + while (len > 0) + { + const int blen = min_int (len, SHA_DIGEST_LENGTH); + SHA1_Init (&ctx); + SHA1_Update (&ctx, nonce_data, sizeof (nonce_data)); + SHA1_Final (nonce_data, &ctx); + memcpy (output, nonce_data, blen); + output += blen; + len -= blen; + } + mutex_unlock_static (L_PRNG); +} + +/* an analogue to the random() function, but use prng_bytes */ +long int +get_random() +{ + long int l; + prng_bytes ((unsigned char *)&l, sizeof(l)); + if (l < 0) + l = -l; + return l; +} + +const char * +md5sum (uint8_t *buf, int len, int n_print_chars, struct gc_arena *gc) +{ + uint8_t digest[MD5_DIGEST_LENGTH]; + MD5 (buf, len, digest); + return format_hex (digest, MD5_DIGEST_LENGTH, n_print_chars, gc); +} + +/* + * OpenSSL memory debugging. If dmalloc debugging is enabled, tell + * OpenSSL to use our private malloc/realloc/free functions so that + * we can dispatch them to dmalloc. + */ + +#ifdef DMALLOC + +static void * +crypto_malloc (size_t size, const char *file, int line) +{ + return dmalloc_malloc(file, line, size, DMALLOC_FUNC_MALLOC, 0, 0); +} + +static void * +crypto_realloc (void *ptr, size_t size, const char *file, int line) +{ + return dmalloc_realloc(file, line, ptr, size, DMALLOC_FUNC_REALLOC, 0); +} + +static void +crypto_free (void *ptr) +{ + dmalloc_free (__FILE__, __LINE__, ptr, DMALLOC_FUNC_FREE); +} + +void +openssl_dmalloc_init (void) +{ + CRYPTO_set_mem_ex_functions (crypto_malloc, + crypto_realloc, + crypto_free); +} + +#endif /* DMALLOC */ + +#ifndef USE_SSL + +void +init_ssl_lib (void) +{ + ERR_load_crypto_strings (); + OpenSSL_add_all_algorithms (); + init_crypto_lib (); +} + +void +free_ssl_lib (void) +{ + uninit_crypto_lib (); + EVP_cleanup (); + ERR_free_strings (); +} + +#endif /* USE_SSL */ +#endif /* USE_CRYPTO */ diff --git a/crypto.h b/crypto.h new file mode 100644 index 0000000..bf81595 --- /dev/null +++ b/crypto.h @@ -0,0 +1,393 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef CRYPTO_H +#define CRYPTO_H +#ifdef USE_CRYPTO + +/* + * Does our OpenSSL library support crypto hardware acceleration? + */ +#if defined(HAVE_OPENSSL_ENGINE_H) && defined(HAVE_ENGINE_LOAD_BUILTIN_ENGINES) && defined(HAVE_ENGINE_REGISTER_ALL_COMPLETE) && defined(HAVE_ENGINE_CLEANUP) +#define CRYPTO_ENGINE 1 +#else +#define CRYPTO_ENGINE 0 +#endif + +#include <openssl/objects.h> +#include <openssl/rand.h> +#include <openssl/evp.h> +#include <openssl/hmac.h> +#include <openssl/des.h> +#include <openssl/md5.h> +#if NTLM +#include <openssl/md4.h> +#endif +#include <openssl/sha.h> +#include <openssl/err.h> + +#if CRYPTO_ENGINE +#include <openssl/engine.h> +#endif + +#if SSLEAY_VERSION_NUMBER >= 0x00907000L +#include <openssl/des_old.h> +#endif + +#include "basic.h" +#include "buffer.h" +#include "packet_id.h" +#include "mtu.h" + +/* + * Workarounds for incompatibilites between OpenSSL libraries. + * Right now we accept OpenSSL libraries from 0.9.5 to 0.9.7. + */ + +#if SSLEAY_VERSION_NUMBER < 0x00907000L + +/* Workaround: EVP_CIPHER_mode is defined wrong in OpenSSL 0.9.6 but is fixed in 0.9.7 */ +#undef EVP_CIPHER_mode +#define EVP_CIPHER_mode(e) (((e)->flags) & EVP_CIPH_MODE) + +#define DES_cblock des_cblock +#define DES_is_weak_key des_is_weak_key +#define DES_check_key_parity des_check_key_parity +#define DES_set_odd_parity des_set_odd_parity + +#define HMAC_CTX_init(ctx) CLEAR (*ctx) +#define HMAC_Init_ex(ctx,sec,len,md,impl) HMAC_Init(ctx, sec, len, md) +#define HMAC_CTX_cleanup(ctx) HMAC_cleanup(ctx) +#define EVP_MD_CTX_cleanup(md) CLEAR (*md) + +#define INFO_CALLBACK_SSL_CONST + +#endif + +#ifndef INFO_CALLBACK_SSL_CONST +#define INFO_CALLBACK_SSL_CONST const +#endif + +#if SSLEAY_VERSION_NUMBER < 0x00906000 + +#undef EVP_CIPHER_mode +#define EVP_CIPHER_mode(x) 1 +#define EVP_CIPHER_CTX_mode(x) 1 +#define EVP_CIPHER_flags(x) 0 + +#define EVP_CIPH_CBC_MODE 1 +#define EVP_CIPH_CFB_MODE 0 +#define EVP_CIPH_OFB_MODE 0 +#define EVP_CIPH_VARIABLE_LENGTH 0 + +#define OPENSSL_malloc(x) malloc(x) +#define OPENSSL_free(x) free(x) + +static inline int +EVP_CipherInit_ov (EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type, uint8_t *key, uint8_t *iv, int enc) +{ + EVP_CipherInit (ctx, type, key, iv, enc); + return 1; +} + +static inline int +EVP_CipherUpdate_ov (EVP_CIPHER_CTX *ctx, uint8_t *out, int *outl, uint8_t *in, int inl) +{ + EVP_CipherUpdate (ctx, out, outl, in, inl); + return 1; +} + +static inline bool +cipher_ok (const char* name) +{ + const int i = strlen (name) - 4; + if (i >= 0) + return !strcmp (name + i, "-CBC"); + else + return false; +} + +#else + +static inline int +EVP_CipherInit_ov (EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type, uint8_t *key, uint8_t *iv, int enc) +{ + return EVP_CipherInit (ctx, type, key, iv, enc); +} + +static inline int +EVP_CipherUpdate_ov (EVP_CIPHER_CTX *ctx, uint8_t *out, int *outl, uint8_t *in, int inl) +{ + return EVP_CipherUpdate (ctx, out, outl, in, inl); +} + +static inline bool +cipher_ok (const char* name) +{ + return true; +} + +#endif + +#if SSLEAY_VERSION_NUMBER < 0x0090581f +#undef DES_check_key_parity +#define DES_check_key_parity(x) 1 +#endif + +#ifndef EVP_CIPHER_name +#define EVP_CIPHER_name(e) OBJ_nid2sn(EVP_CIPHER_nid(e)) +#endif + +#ifndef EVP_MD_name +#define EVP_MD_name(e) OBJ_nid2sn(EVP_MD_type(e)) +#endif + +/* + * Max size in bytes of any cipher key that might conceivably be used. + * + * This value is checked at compile time in crypto.c to make sure + * it is always at least EVP_MAX_KEY_LENGTH. + * + * We define our own value, since this parameter + * is used to control the size of static key files. + * If the OpenSSL library increases EVP_MAX_KEY_LENGTH, + * we don't want our key files to be suddenly rendered + * unusable. + */ +#define MAX_CIPHER_KEY_LENGTH 64 + +/* + * Max size in bytes of any HMAC key that might conceivably be used. + * + * This value is checked at compile time in crypto.c to make sure + * it is always at least EVP_MAX_MD_SIZE. We define our own value + * for the same reason as above. + */ +#define MAX_HMAC_KEY_LENGTH 64 + +/* + * Defines a key type and key length for both cipher and HMAC. + */ +struct key_type +{ + uint8_t cipher_length; + uint8_t hmac_length; + const EVP_CIPHER *cipher; + const EVP_MD *digest; +}; + +/* + * A random key. + */ +struct key +{ + uint8_t cipher[MAX_CIPHER_KEY_LENGTH]; + uint8_t hmac[MAX_HMAC_KEY_LENGTH]; +}; + +#define KEY_DIRECTION_BIDIRECTIONAL 0 /* same keys for both directions */ +#define KEY_DIRECTION_NORMAL 1 /* encrypt with keys[0], decrypt with keys[1] */ +#define KEY_DIRECTION_INVERSE 2 /* encrypt with keys[1], decrypt with keys[0] */ + +/* + * Dual random keys (for encrypt/decrypt) + */ +struct key2 +{ + int n; + struct key keys[2]; +}; + +/* + * Used for controlling bidirectional keys + * vs. a separate key for each direction. + */ +struct key_direction_state +{ + int out_key; + int in_key; + int need_keys; +}; + +/* + * A key context for cipher and/or HMAC. + */ +struct key_ctx +{ + EVP_CIPHER_CTX *cipher; + HMAC_CTX *hmac; +}; + +/* + * Cipher/HMAC key context for both sending and receiving + * directions. + */ +struct key_ctx_bi +{ + struct key_ctx encrypt; + struct key_ctx decrypt; +}; + +/* + * Options for encrypt/decrypt. + */ +struct crypto_options +{ + struct key_ctx_bi *key_ctx_bi; + struct packet_id *packet_id; + struct packet_id_persist *pid_persist; + +# define CO_PACKET_ID_LONG_FORM (1<<0) +# define CO_USE_IV (1<<1) +# define CO_IGNORE_PACKET_ID (1<<2) +# define CO_MUTE_REPLAY_WARNINGS (1<<3) + unsigned int flags; +}; + +void init_key_type (struct key_type *kt, const char *ciphername, + bool ciphername_defined, const char *authname, + bool authname_defined, int keysize, + bool cfb_ofb_allowed, bool warn); + +void read_key_file (struct key2 *key2, const char *filename, bool must_succeed); + +int write_key_file (const int nkeys, const char *filename); + +int read_passphrase_hash (const char *passphrase_file, + const EVP_MD *digest, + uint8_t *output, + int len); + +void generate_key_random (struct key *key, const struct key_type *kt); + +void check_replay_iv_consistency(const struct key_type *kt, bool packet_id, bool use_iv); + +bool check_key (struct key *key, const struct key_type *kt); + +void fixup_key (struct key *key, const struct key_type *kt); + +bool write_key (const struct key *key, const struct key_type *kt, + struct buffer *buf); + +int read_key (struct key *key, const struct key_type *kt, struct buffer *buf); + +bool cfb_ofb_mode (const struct key_type* kt); + +const char *kt_cipher_name (const struct key_type *kt); +const char *kt_digest_name (const struct key_type *kt); +int kt_key_size (const struct key_type *kt); + +/* enc parameter in init_key_ctx */ +#define DO_ENCRYPT 1 +#define DO_DECRYPT 0 + +void init_key_ctx (struct key_ctx *ctx, struct key *key, + const struct key_type *kt, int enc, + const char *prefix); + +void free_key_ctx (struct key_ctx *ctx); +void free_key_ctx_bi (struct key_ctx_bi *ctx); + +void openvpn_encrypt (struct buffer *buf, struct buffer work, + const struct crypto_options *opt, + const struct frame* frame); + +bool openvpn_decrypt (struct buffer *buf, struct buffer work, + const struct crypto_options *opt, + const struct frame* frame); + + +void crypto_adjust_frame_parameters(struct frame *frame, + const struct key_type* kt, + bool cipher_defined, + bool use_iv, + bool packet_id, + bool packet_id_long_form); + +void prng_init (void); +void prng_bytes (uint8_t *output, int len); + +void test_crypto (const struct crypto_options *co, struct frame* f); + +const char *md5sum(uint8_t *buf, int len, int n_print_chars, struct gc_arena *gc); + +void show_available_ciphers (void); + +void show_available_digests (void); + +void show_available_engines (void); + +void init_crypto_lib_engine (const char *engine_name); + +void init_crypto_lib (void); + +void uninit_crypto_lib (void); + +/* key direction functions */ + +void key_direction_state_init (struct key_direction_state *kds, int key_direction); + +void verify_fix_key2 (struct key2 *key2, const struct key_type *kt, const char *shared_secret_file); + +void must_have_n_keys (const char *filename, const char *option, const struct key2 *key2, int n); + +int ascii2keydirection (int msglevel, const char *str); + +const char *keydirection2ascii (int kd, bool remote); + +/* print keys */ +void key2_print (const struct key2* k, + const struct key_type *kt, + const char* prefix0, + const char* prefix1); + +/* memory debugging */ +void openssl_dmalloc_init (void); + +#ifdef USE_SSL + +void get_tls_handshake_key (const struct key_type *key_type, + struct key_ctx_bi *ctx, + const char *passphrase_file, + bool key_direction); + +#else + +void init_ssl_lib (void); +void free_ssl_lib (void); + +#endif /* USE_SSL */ + +/* + * Inline functions + */ + +static inline bool +key_ctx_bi_defined(const struct key_ctx_bi* key) +{ + return key->encrypt.cipher || key->encrypt.hmac || key->decrypt.cipher || key->decrypt.hmac; +} + +#endif /* USE_CRYPTO */ +#endif /* CRYPTO_H */ diff --git a/cryptoapi.c b/cryptoapi.c new file mode 100644 index 0000000..275fec9 --- /dev/null +++ b/cryptoapi.c @@ -0,0 +1,463 @@ +/* + * Copyright (c) 2004 Peter 'Luna' Runestig <peter@runestig.com> + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modifi- + * cation, are permitted provided that the following conditions are met: + * + * o Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * o Redistributions in binary form must reproduce the above copyright no- + * tice, this list of conditions and the following disclaimer in the do- + * cumentation and/or other materials provided with the distribution. + * + * o The names of the contributors may not be used to endorse or promote + * products derived from this software without specific prior written + * permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LI- + * ABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUEN- + * TIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEV- + * ER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABI- + * LITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#include <windows.h> +#include <wincrypt.h> +#include <stdio.h> +#include <ctype.h> +#include <assert.h> +#include <openssl/ssl.h> +#include <openssl/err.h> + +#ifdef __MINGW32_VERSION +/* MinGW w32api is incomplete when it comes to CryptoAPI, as per version 3.1 + * anyway. This is a hack around that problem. */ +#define CALG_SSL3_SHAMD5 (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SSL3SHAMD5) +#define CERT_SYSTEM_STORE_LOCATION_SHIFT 16 +#define CERT_SYSTEM_STORE_CURRENT_USER_ID 1 +#define CERT_SYSTEM_STORE_CURRENT_USER (CERT_SYSTEM_STORE_CURRENT_USER_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) +#define CERT_STORE_READONLY_FLAG 0x00008000 +#define CERT_STORE_OPEN_EXISTING_FLAG 0x00004000 +#define CRYPT_ACQUIRE_COMPARE_KEY_FLAG 0x00000004 +static HINSTANCE crypt32dll = NULL; +static BOOL WINAPI (*CryptAcquireCertificatePrivateKey) (PCCERT_CONTEXT pCert, DWORD dwFlags, + void *pvReserved, HCRYPTPROV *phCryptProv, DWORD *pdwKeySpec, BOOL *pfCallerFreeProv) = NULL; +#endif + +/* Size of an SSL signature: MD5+SHA1 */ +#define SSL_SIG_LENGTH 36 + +/* try to funnel any Windows/CryptoAPI error messages to OpenSSL ERR_... */ +#define ERR_LIB_CRYPTOAPI (ERR_LIB_USER + 69) /* 69 is just a number... */ +#define CRYPTOAPIerr(f) err_put_ms_error(GetLastError(), (f), __FILE__, __LINE__) +#define CRYPTOAPI_F_CERT_OPEN_SYSTEM_STORE 100 +#define CRYPTOAPI_F_CERT_FIND_CERTIFICATE_IN_STORE 101 +#define CRYPTOAPI_F_CRYPT_ACQUIRE_CERTIFICATE_PRIVATE_KEY 102 +#define CRYPTOAPI_F_CRYPT_CREATE_HASH 103 +#define CRYPTOAPI_F_CRYPT_GET_HASH_PARAM 104 +#define CRYPTOAPI_F_CRYPT_SET_HASH_PARAM 105 +#define CRYPTOAPI_F_CRYPT_SIGN_HASH 106 +#define CRYPTOAPI_F_LOAD_LIBRARY 107 +#define CRYPTOAPI_F_GET_PROC_ADDRESS 108 + +static ERR_STRING_DATA CRYPTOAPI_str_functs[] = { + { ERR_PACK(ERR_LIB_CRYPTOAPI, 0, 0), "microsoft cryptoapi"}, + { ERR_PACK(0, CRYPTOAPI_F_CERT_OPEN_SYSTEM_STORE, 0), "CertOpenSystemStore" }, + { ERR_PACK(0, CRYPTOAPI_F_CERT_FIND_CERTIFICATE_IN_STORE, 0), "CertFindCertificateInStore" }, + { ERR_PACK(0, CRYPTOAPI_F_CRYPT_ACQUIRE_CERTIFICATE_PRIVATE_KEY, 0), "CryptAcquireCertificatePrivateKey" }, + { ERR_PACK(0, CRYPTOAPI_F_CRYPT_CREATE_HASH, 0), "CryptCreateHash" }, + { ERR_PACK(0, CRYPTOAPI_F_CRYPT_GET_HASH_PARAM, 0), "CryptGetHashParam" }, + { ERR_PACK(0, CRYPTOAPI_F_CRYPT_SET_HASH_PARAM, 0), "CryptSetHashParam" }, + { ERR_PACK(0, CRYPTOAPI_F_CRYPT_SIGN_HASH, 0), "CryptSignHash" }, + { ERR_PACK(0, CRYPTOAPI_F_LOAD_LIBRARY, 0), "LoadLibrary" }, + { ERR_PACK(0, CRYPTOAPI_F_GET_PROC_ADDRESS, 0), "GetProcAddress" }, + { 0, NULL } +}; + +typedef struct _CAPI_DATA { + const CERT_CONTEXT *cert_context; + HCRYPTPROV crypt_prov; + DWORD key_spec; + BOOL free_crypt_prov; +} CAPI_DATA; + +static char *ms_error_text(DWORD ms_err) +{ + LPVOID lpMsgBuf = NULL; + char *rv = NULL; + + FormatMessage( + FORMAT_MESSAGE_ALLOCATE_BUFFER | + FORMAT_MESSAGE_FROM_SYSTEM | + FORMAT_MESSAGE_IGNORE_INSERTS, + NULL, ms_err, + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), /* Default language */ + (LPTSTR) &lpMsgBuf, 0, NULL); + if (lpMsgBuf) { + char *p; + rv = strdup(lpMsgBuf); + LocalFree(lpMsgBuf); + /* trim to the left */ + if (rv) + for (p = rv + strlen(rv) - 1; p >= rv; p--) { + if (isspace(*p)) + *p = '\0'; + else + break; + } + } + return rv; +} + +static void err_put_ms_error(DWORD ms_err, int func, const char *file, int line) +{ + static int init = 0; +# define ERR_MAP_SZ 16 + static struct { + int err; + DWORD ms_err; /* I don't think we get more than 16 *different* errors */ + } err_map[ERR_MAP_SZ]; /* in here, before we give up the whole thing... */ + int i; + + if (ms_err == 0) + /* 0 is not an error */ + return; + if (!init) { + ERR_load_strings(ERR_LIB_CRYPTOAPI, CRYPTOAPI_str_functs); + memset(&err_map, 0, sizeof(err_map)); + init++; + } + /* since MS error codes are 32 bit, and the ones in the ERR_... system is + * only 12, we must have a mapping table between them. */ + for (i = 0; i < ERR_MAP_SZ; i++) { + if (err_map[i].ms_err == ms_err) { + ERR_PUT_error(ERR_LIB_CRYPTOAPI, func, err_map[i].err, file, line); + break; + } else if (err_map[i].ms_err == 0 ) { + /* end of table, add new entry */ + ERR_STRING_DATA *esd = calloc(2, sizeof(*esd)); + if (esd == NULL) + break; + err_map[i].ms_err = ms_err; + err_map[i].err = esd->error = i + 100; + esd->string = ms_error_text(ms_err); + ERR_load_strings(ERR_LIB_CRYPTOAPI, esd); + ERR_PUT_error(ERR_LIB_CRYPTOAPI, func, err_map[i].err, file, line); + break; + } + } +} + +/* encrypt */ +static int rsa_pub_enc(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding) +{ + /* I haven't been able to trigger this one, but I want to know if it happens... */ + assert(0); + + return 0; +} + +/* verify arbitrary data */ +static int rsa_pub_dec(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding) +{ + /* I haven't been able to trigger this one, but I want to know if it happens... */ + assert(0); + + return 0; +} + +/* sign arbitrary data */ +static int rsa_priv_enc(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding) +{ + CAPI_DATA *cd = (CAPI_DATA *) rsa->meth->app_data; + HCRYPTHASH hash; + DWORD hash_size, len, i; + unsigned char *buf; + + if (cd == NULL) { + RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT, ERR_R_PASSED_NULL_PARAMETER); + return 0; + } + if (padding != RSA_PKCS1_PADDING) { + /* AFAICS, CryptSignHash() *always* uses PKCS1 padding. */ + RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT, RSA_R_UNKNOWN_PADDING_TYPE); + return 0; + } + /* Unfortunately, there is no "CryptSign()" function in CryptoAPI, that would + * be way to straightforward for M$, I guess... So we have to do it this + * tricky way instead, by creating a "Hash", and load the already-made hash + * from 'from' into it. */ + /* For now, we only support NID_md5_sha1 */ + if (flen != SSL_SIG_LENGTH) { + RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT, RSA_R_INVALID_MESSAGE_LENGTH); + return 0; + } + if (!CryptCreateHash(cd->crypt_prov, CALG_SSL3_SHAMD5, 0, 0, &hash)) { + CRYPTOAPIerr(CRYPTOAPI_F_CRYPT_CREATE_HASH); + return 0; + } + len = sizeof(hash_size); + if (!CryptGetHashParam(hash, HP_HASHSIZE, (BYTE *) &hash_size, &len, 0)) { + CRYPTOAPIerr(CRYPTOAPI_F_CRYPT_GET_HASH_PARAM); + CryptDestroyHash(hash); + return 0; + } + if ((int) hash_size != flen) { + RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT, RSA_R_INVALID_MESSAGE_LENGTH); + CryptDestroyHash(hash); + return 0; + } + if (!CryptSetHashParam(hash, HP_HASHVAL, (BYTE * ) from, 0)) { + CRYPTOAPIerr(CRYPTOAPI_F_CRYPT_SET_HASH_PARAM); + CryptDestroyHash(hash); + return 0; + } + + len = RSA_size(rsa); + buf = malloc(len); + if (buf == NULL) { + RSAerr(RSA_F_RSA_EAY_PRIVATE_ENCRYPT, ERR_R_MALLOC_FAILURE); + CryptDestroyHash(hash); + return 0; + } + if (!CryptSignHash(hash, cd->key_spec, NULL, 0, buf, &len)) { + CRYPTOAPIerr(CRYPTOAPI_F_CRYPT_SIGN_HASH); + CryptDestroyHash(hash); + free(buf); + return 0; + } + /* and now, we have to reverse the byte-order in the result from CryptSignHash()... */ + for (i = 0; i < len; i++) + to[i] = buf[len - i - 1]; + free(buf); + + CryptDestroyHash(hash); + return len; +} + +/* decrypt */ +static int rsa_priv_dec(int flen, const unsigned char *from, unsigned char *to, RSA *rsa, int padding) +{ + /* I haven't been able to trigger this one, but I want to know if it happens... */ + assert(0); + + return 0; +} + +/* called at RSA_new */ +static int init(RSA *rsa) +{ + + return 0; +} + +/* called at RSA_free */ +static int finish(RSA *rsa) +{ + CAPI_DATA *cd = (CAPI_DATA *) rsa->meth->app_data; + + if (cd == NULL) + return 0; + if (cd->crypt_prov && cd->free_crypt_prov) + CryptReleaseContext(cd->crypt_prov, 0); + if (cd->cert_context) + CertFreeCertificateContext(cd->cert_context); + free(rsa->meth->app_data); + free((char *) rsa->meth); + rsa->meth = NULL; + return 1; +} + +static const CERT_CONTEXT *find_certificate_in_store(const char *cert_prop, HCERTSTORE cert_store) +{ + /* Find, and use, the desired certificate from the store. The + * 'cert_prop' certificate search string can look like this: + * SUBJ:<certificate substring to match> + * THUMB:<certificate thumbprint hex value>, e.g. + * THUMB:f6 49 24 41 01 b4 fb 44 0c ce f4 36 ae d0 c4 c9 df 7a b6 28 + */ + const CERT_CONTEXT *rv = NULL; + + if (!strncmp(cert_prop, "SUBJ:", 5)) { + /* skip the tag */ + cert_prop += 5; + rv = CertFindCertificateInStore(cert_store, X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, + 0, CERT_FIND_SUBJECT_STR_A, cert_prop, NULL); + + } else if (!strncmp(cert_prop, "THUMB:", 6)) { + unsigned char hash[255]; + char *p; + int i, x = 0; + CRYPT_HASH_BLOB blob; + + /* skip the tag */ + cert_prop += 6; + for (p = (char *) cert_prop, i = 0; *p && i < sizeof(hash); i++) { + if (*p >= '0' && *p <= '9') + x = (*p - '0') << 4; + else if (*p >= 'A' && *p <= 'F') + x = (*p - 'A' + 10) << 4; + else if (*p >= 'a' && *p <= 'f') + x = (*p - 'a' + 10) << 4; + if (!*++p) /* unexpected end of string */ + break; + if (*p >= '0' && *p <= '9') + x += *p - '0'; + else if (*p >= 'A' && *p <= 'F') + x += *p - 'A' + 10; + else if (*p >= 'a' && *p <= 'f') + x += *p - 'a' + 10; + hash[i] = x; + /* skip any space(s) between hex numbers */ + for (p++; *p && *p == ' '; p++); + } + blob.cbData = i; + blob.pbData = (unsigned char *) &hash; + rv = CertFindCertificateInStore(cert_store, X509_ASN_ENCODING | PKCS_7_ASN_ENCODING, + 0, CERT_FIND_HASH, &blob, NULL); + + } + + return rv; +} + +int SSL_CTX_use_CryptoAPI_certificate(SSL_CTX *ssl_ctx, const char *cert_prop) +{ + HCERTSTORE cs; + X509 *cert = NULL; + RSA *rsa = NULL, *pub_rsa; + CAPI_DATA *cd = calloc(1, sizeof(*cd)); + RSA_METHOD *my_rsa_method = calloc(1, sizeof(*my_rsa_method)); + + if (cd == NULL || my_rsa_method == NULL) { + SSLerr(SSL_F_SSL_CTX_USE_CERTIFICATE_FILE, ERR_R_MALLOC_FAILURE); + goto err; + } + /* search CURRENT_USER first, then LOCAL_MACHINE */ + cs = CertOpenStore((LPCSTR) CERT_STORE_PROV_SYSTEM, 0, 0, CERT_SYSTEM_STORE_CURRENT_USER | + CERT_STORE_OPEN_EXISTING_FLAG | CERT_STORE_READONLY_FLAG, L"MY"); + if (cs == NULL) { + CRYPTOAPIerr(CRYPTOAPI_F_CERT_OPEN_SYSTEM_STORE); + goto err; + } + cd->cert_context = find_certificate_in_store(cert_prop, cs); + CertCloseStore(cs, 0); + if (!cd->cert_context) { + cs = CertOpenStore((LPCSTR) CERT_STORE_PROV_SYSTEM, 0, 0, CERT_SYSTEM_STORE_LOCAL_MACHINE | + CERT_STORE_OPEN_EXISTING_FLAG | CERT_STORE_READONLY_FLAG, L"MY"); + if (cs == NULL) { + CRYPTOAPIerr(CRYPTOAPI_F_CERT_OPEN_SYSTEM_STORE); + goto err; + } + cd->cert_context = find_certificate_in_store(cert_prop, cs); + CertCloseStore(cs, 0); + if (cd->cert_context == NULL) { + CRYPTOAPIerr(CRYPTOAPI_F_CERT_FIND_CERTIFICATE_IN_STORE); + goto err; + } + } + + /* cert_context->pbCertEncoded is the cert X509 DER encoded. */ + cert = d2i_X509(NULL, (unsigned char **) &cd->cert_context->pbCertEncoded, + cd->cert_context->cbCertEncoded); + if (cert == NULL) { + SSLerr(SSL_F_SSL_CTX_USE_CERTIFICATE_FILE, ERR_R_ASN1_LIB); + goto err; + } + + /* set up stuff to use the private key */ +#ifdef __MINGW32_VERSION + /* MinGW w32api is incomplete when it comes to CryptoAPI, as per version 3.1 + * anyway. This is a hack around that problem. */ + if (crypt32dll == NULL) { + crypt32dll = LoadLibrary("crypt32"); + if (crypt32dll == NULL) { + CRYPTOAPIerr(CRYPTOAPI_F_LOAD_LIBRARY); + goto err; + } + } + if (CryptAcquireCertificatePrivateKey == NULL) { + CryptAcquireCertificatePrivateKey = GetProcAddress(crypt32dll, + "CryptAcquireCertificatePrivateKey"); + if (CryptAcquireCertificatePrivateKey == NULL) { + CRYPTOAPIerr(CRYPTOAPI_F_GET_PROC_ADDRESS); + goto err; + } + } +#endif + if (!CryptAcquireCertificatePrivateKey(cd->cert_context, CRYPT_ACQUIRE_COMPARE_KEY_FLAG, + NULL, &cd->crypt_prov, &cd->key_spec, &cd->free_crypt_prov)) { + /* if we don't have a smart card reader here, and we try to access a + * smart card certificate, we get: + * "Error 1223: The operation was canceled by the user." */ + CRYPTOAPIerr(CRYPTOAPI_F_CRYPT_ACQUIRE_CERTIFICATE_PRIVATE_KEY); + goto err; + } + /* here we don't need to do CryptGetUserKey() or anything; all necessary key + * info is in cd->cert_context, and then, in cd->crypt_prov. */ + + my_rsa_method->name = "Microsoft CryptoAPI RSA Method"; + my_rsa_method->rsa_pub_enc = rsa_pub_enc; + my_rsa_method->rsa_pub_dec = rsa_pub_dec; + my_rsa_method->rsa_priv_enc = rsa_priv_enc; + my_rsa_method->rsa_priv_dec = rsa_priv_dec; + /* my_rsa_method->init = init; */ + my_rsa_method->finish = finish; + my_rsa_method->flags = RSA_METHOD_FLAG_NO_CHECK; + my_rsa_method->app_data = (char *) cd; + + rsa = RSA_new(); + if (rsa == NULL) { + SSLerr(SSL_F_SSL_CTX_USE_CERTIFICATE_FILE, ERR_R_MALLOC_FAILURE); + goto err; + } + + /* cert->cert_info->key->pkey is NULL until we call SSL_CTX_use_certificate(), + * so we do it here then... */ + if (!SSL_CTX_use_certificate(ssl_ctx, cert)) + goto err; + /* the public key */ + pub_rsa = cert->cert_info->key->pkey->pkey.rsa; + /* SSL_CTX_use_certificate() increased the reference count in 'cert', so + * we decrease it here with X509_free(), or it will never be cleaned up. */ + X509_free(cert); + cert = NULL; + + /* I'm not sure about what we have to fill in in the RSA, trying out stuff... */ + /* rsa->n indicates the key size */ + rsa->n = BN_dup(pub_rsa->n); + rsa->flags |= RSA_FLAG_EXT_PKEY; + if (!RSA_set_method(rsa, my_rsa_method)) + goto err; + + if (!SSL_CTX_use_RSAPrivateKey(ssl_ctx, rsa)) + goto err; + /* SSL_CTX_use_RSAPrivateKey() increased the reference count in 'rsa', so + * we decrease it here with RSA_free(), or it will never be cleaned up. */ + RSA_free(rsa); + return 1; + + err: + if (cert) + X509_free(cert); + if (rsa) + RSA_free(rsa); + else { + if (my_rsa_method) + free(my_rsa_method); + if (cd) { + if (cd->free_crypt_prov && cd->crypt_prov) + CryptReleaseContext(cd->crypt_prov, 0); + if (cd->cert_context) + CertFreeCertificateContext(cd->cert_context); + free(cd); + } + } + return 0; +} diff --git a/cryptoapi.h b/cryptoapi.h new file mode 100644 index 0000000..8ac6db3 --- /dev/null +++ b/cryptoapi.h @@ -0,0 +1,7 @@ +#ifndef _CRYPTOAPI_H_ +#define _CRYPTOAPI_H_ + +int SSL_CTX_use_CryptoAPI_certificate(SSL_CTX *ssl_ctx, const char *cert_prop); + + +#endif /* !_CRYPTOAPI_H_ */ diff --git a/debug/valgrind-suppress b/debug/valgrind-suppress new file mode 100644 index 0000000..48fa55f --- /dev/null +++ b/debug/valgrind-suppress @@ -0,0 +1,310 @@ +# Valgrind suppressions file for OpenVPN. +# +# Mostly deal with uninitialized data warnings +# in OpenSSL. + +{ + test1 + Memcheck:Cond + fun:BN_* +} + +{ + test2 + Memcheck:Value4 + fun:BN_* +} + +{ + test3 + Memcheck:Cond + fun:bn_* +} + +{ + test4 + Memcheck:Value4 + fun:bn_* +} + +{ + test5 + Memcheck:Cond + fun:getrn +} + +{ + test6 + Memcheck:Value4 + fun:getrn +} + +{ + test7 + Memcheck:Value4 + fun:lh_retrieve +} + +{ + test8 + Memcheck:Cond + fun:lh_retrieve +} + +{ + test10 + Memcheck:Cond + fun:RSA_verify +} + +{ + test11 + Memcheck:Value4 + fun:RSA_verify +} + +{ + test12 + Memcheck:Value4 + fun:AES_set_encrypt_key +} + +{ + test13 + Memcheck:Value4 + fun:AES_set_decrypt_key +} + +{ + test14 + Memcheck:Value4 + fun:AES_decrypt +} + +{ + test15 + Memcheck:Value4 + fun:BF_encrypt +} + +{ + test16 + Memcheck:Cond + fun:tls1_enc +} + +{ + test17 + Memcheck:Value4 + fun:tls1_enc +} + +{ + test18 + Memcheck:Cond + fun:ssl3_read_bytes +} + +{ + test19 + Memcheck:Cond + fun:SHA1_Update +} + +{ + test20 + Memcheck:Value4 + fun:SHA1_Update +} + +{ + test21 + Memcheck:Cond + fun:SHA1_Final +} + +{ + test22 + Memcheck:Value4 + fun:SHA1_Final +} + +{ + test23 + Memcheck:Value4 + fun:ssl3_read_bytes +} + +{ + test24 + Memcheck:Cond + fun:ssl3_get_message +} + +{ + test25 + Memcheck:Cond + fun:BUF_MEM_grow_clean +} + +{ + test26 + Memcheck:Cond + fun:memcpy + fun:ssl3_read_bytes +} + +{ + test27 + Memcheck:Value4 + fun:memcpy + fun:ssl3_read_bytes +} + +{ + test28 + Memcheck:Cond + fun:MD5_Update +} + +{ + test29 + Memcheck:Value4 + fun:MD5_Update +} + +{ + test30 + Memcheck:Cond + fun:ssl3_get_finished +} + +{ + test31 + Memcheck:Value4 + fun:ssl3_get_finished +} + +{ + test32 + Memcheck:Cond + fun:MD5_Final +} + +{ + test33 + Memcheck:Value4 + fun:MD5_Final +} + +{ + test34 + Memcheck:Value4 + fun:AES_encrypt +} + +{ + test35 + Memcheck:Cond + fun:sha1_block_asm_data_order +} + +{ + test36 + Memcheck:Cond + fun:ssl3_read +} + +{ + test37 + Memcheck:Cond + fun:SSL_get_error +} + +{ + test38 + Memcheck:Cond + fun:BIO_read +} + +{ + test39 + Memcheck:Value4 + fun:memset +} + +{ + test40 + Memcheck:Cond + fun:ssl_read +} + +{ + test41 + Memcheck:Cond + fun:memset +} + +{ + test42 + Memcheck:Cond + fun:ssl3_read_internal +} + +{ + test43 + Memcheck:Cond + fun:ssl3_get_cert_verify +} + +{ + test44 + Memcheck:Leak + fun:malloc + fun:gc_malloc + fun:alloc_buf_gc + fun:construct_name_value +} + +{ + test45 + Memcheck:Leak + fun:malloc + fun:default_malloc_ex +} + +{ + test46 + Memcheck:Leak + fun:malloc + fun:gc_malloc + fun:add_env_item + fun:manage_env +} + +{ + test47 + Memcheck:Cond + fun:lzo1x_1_15_compress +} + +{ + test48 + Memcheck:Value4 + fun:DES_set_key_unchecked +} + +{ + test49 + Memcheck:Value4 + fun:DES_encrypt2 +} + +{ + test50 + Memcheck:Leak + fun:malloc + fun:_IO_getdelim + fun:getline + fun:getpass +} @@ -0,0 +1,16 @@ +#!/bin/sh + +# Let's have a fresh start. Remove all files +# which are not source files. +# +# Run this script, then: +# touch * +# [apply any patches here] +# autoreconf -i -v +# ./configure +# make +# make install + +rm -f *.o openvpn config.cache configure Makefile Makefile.in stamp-h* config.guess config.sub depcomp missing mkinstalldirs config.log config.status config.h config.h.in aclocal.m4 openvpn.spec config-win32.h install-sh install-win32/openvpn.nsi + +rm -rf autom4te*.cache .deps diff --git a/easy-rsa/README b/easy-rsa/README new file mode 100644 index 0000000..fd424ef --- /dev/null +++ b/easy-rsa/README @@ -0,0 +1,161 @@ +This is a small RSA key management package, +based on the openssl command line tool, that +can be found in the easy-rsa subdirectory +of the OpenVPN distribution. + +These are reference notes. For step +by step instructions, see the HOWTO: + +http://openvpn.net/howto.html + +INSTALL + +1. Edit vars. +2. Set KEY_CONFIG to point to the openssl.cnf file + included in this distribution. +3. Set KEY_DIR to point to a directory which will + contain all keys, certificates, etc. This + directory need not exist, and if it does, + it will be deleted with rm -rf, so BE + CAREFUL how you set KEY_DIR. +4. (Optional) Edit other fields in vars + per your site data. You may want to + increase KEY_SIZE to 2048 if you are + paranoid and don't mind slower key + processing, but certainly 1024 is + fine for testing purposes. KEY_SIZE + must be compatible across both peers + participating in a secure SSL/TLS + connection. +5 . vars +6. ./clean-all +7. As you create certificates, keys, and + certificate signing requests, understand that + only .key files should be kept confidential. + .crt and .csr files can be sent over insecure + channels such as plaintext email. +8. You should never need to copy a .key file + between computers. Normally each computer + will have its own certificate/key pair. + +BUILD YOUR OWN ROOT CERTIFICATE AUTHORITY (CA) CERTIFICATE/KEY + +1. ./build-ca +2. ca.crt and ca.key will be built in your KEY_DIR + directory + +BUILD AN INTERMEDIATE CERTIFICATE AUTHORITY CERTIFICATE/KEY (optional) + +1. ./build-inter inter +2. inter.crt and inter.key will be built in your KEY_DIR + directory and signed with your root certificate. + +BUILD DIFFIE-HELLMAN PARAMETERS (necessary for +the server end of a SSL/TLS connection). + +1. ./build-dh + +BUILD A CERTIFICATE SIGNING REQUEST (If +you want to sign your certificate with a root +certificate controlled by another individual +or organization, or residing on a different machine). + +1. Get ca.crt (the root certificate) from your + certificate authority. Though this + transfer can be over an insecure channel, to prevent + man-in-the-middle attacks you must confirm that + ca.crt was not tampered with. Large CAs solve this + problem by hardwiring their root certificates into + popular web browsers. A simple way to verify a root + CA is to call the issuer on the telephone and confirm + that the md5sum or sha1sum signatures on the ca.crt + files match (such as with the command: "md5sum ca.crt"). +2. Choose a name for your certificate such as your computer + name. In our example we will use "mycert". +3. ./build-req mycert +4. You can ignore most of the fields, but set + "Common Name" to something unique such as your + computer's host name. Leave all password + fields blank, unless you want your private key + to be protected by password. Using a password + is not required -- it will make your key more secure + but also more inconvenient to use, because you will + need to supply your password anytime the key is used. + NOTE: if you are using a password, use ./build-req-pass + instead of ./build-req +5. Your key will be written to $KEY_DIR/mycert.key +6. Your certificate signing request will be written to + to $KEY_DIR/mycert.csr +7. Email mycert.csr to the individual or organization + which controls the root certificate. This can be + done over an insecure channel. +8. After the .csr file is signed by the root certificate + authority, you will receive a file mycert.crt + (your certificate). Place mycert.crt in your + KEY_DIR directory. +9. The combined files of mycert.crt, mycert.key, + and ca.crt can now be used to secure one end of + an SSL/TLS connection. + +SIGN A CERTIFICATE SIGNING REQUEST + +1. ./sign-req mycert +2. mycert.crt will be built in your KEY_DIR + directory using mycert.csr and your root CA + file as input. + +BUILD AND SIGN A CERTIFICATE SIGNING REQUEST +USING A LOCALLY INSTALLED ROOT CERTIFICATE/KEY -- this +script generates and signs a certificate in one step, +but it requires that the generated certificate and private +key files be copied to the destination host over a +secure channel. + +1. ./build-key mycert (no password protection) +2. OR ./build-key-pass mycert (with password protection) +3. OR ./build-key-pkcs12 mycert (PKCS #12 format) +4. OR ./build-key-server mycert (with nsCertType=server) +5. mycert.crt and mycert.key will be built in your + KEY_DIR directory, and mycert.crt will be signed + by your root CA. If ./build-key-pkcs12 was used a + mycert.p12 file will also be created including the + private key, certificate and the ca certificate. + +IMPORTANT + +To avoid a possible Man-in-the-Middle attack where an authorized +client tries to connect to another client by impersonating the +server, make sure to enforce some kind of server certificate +verification by clients. There are currently four different ways +of accomplishing this, listed in the order of preference: + +(1) Build your server certificates with the build-key-server + script. This will designate the certificate as a + server-only certificate by setting nsCertType=server. + Now add the following line to your client configuration: + + ns-cert-type server + + This will block clients from connecting to any + server which lacks the nsCertType=server designation + in its certificate, even if the certificate has been + signed by the CA which is cited in the OpenVPN configuration + file (--ca directive). + +(2) Use the --tls-remote directive on the client to + accept/reject the server connection based on the common + name of the server certificate. + +(3) Use a --tls-verify script or plugin to accept/reject the + server connection based on a custom test of the server + certificate's embedded X509 subject details. + +(4) Sign server certificates with one CA and client certificates + with a different CA. The client config "ca" directive should + reference the server-signing CA while the server config "ca" + directive should reference the client-signing CA. + +NOTES + +Show certificate fields: + openssl x509 -in cert.crt -text diff --git a/easy-rsa/Windows/README.txt b/easy-rsa/Windows/README.txt new file mode 100644 index 0000000..2ede7b1 --- /dev/null +++ b/easy-rsa/Windows/README.txt @@ -0,0 +1,44 @@ +Extract all zip'd files to the OpenVPN home directory, +including the openssl.cnf file from the top-level +"easy-rsa" directory. + +First run init-config.bat + +Next, edit vars.bat to adapt it to your environment, and +create the directory that will hold your key files. + +To generate TLS keys: + +Create new empty index and serial files (once only) +1. vars +2. clean-all + +Build a CA key (once only) +1. vars +2. build-ca + +Build a DH file (for server side, once only) +1. vars +2. build-dh + +Build a private key/certficate for the openvpn server +1. vars +2. build-key-server <machine-name> + +Build key files in PEM format (for each client machine) +1. vars +2. build-key <machine-name> + (use <machine name> for specific name within script) + +or + +Build key files in PKCS #12 format (for each client machine) +1. vars +2. build-key-pkcs12 <machine-name> + (use <machine name> for specific name within script) + +To revoke a TLS certificate and generate a CRL file: +1. vars +2. revoke-full <machine-name> +3. verify last line of output confirms revokation +4. copy crl.pem to server directory and ensure config file uses "crl-verify <crl filename>" diff --git a/easy-rsa/Windows/build-ca.bat b/easy-rsa/Windows/build-ca.bat new file mode 100644 index 0000000..a3f234b --- /dev/null +++ b/easy-rsa/Windows/build-ca.bat @@ -0,0 +1,4 @@ +@echo off +cd %HOME% +rem build a cert authority valid for ten years, starting now +openssl req -days 3650 -nodes -new -x509 -keyout %KEY_DIR%\ca.key -out %KEY_DIR%\ca.crt -config %KEY_CONFIG% diff --git a/easy-rsa/Windows/build-dh.bat b/easy-rsa/Windows/build-dh.bat new file mode 100644 index 0000000..74bc603 --- /dev/null +++ b/easy-rsa/Windows/build-dh.bat @@ -0,0 +1,4 @@ +@echo off +cd %HOME% +rem build a dh file for the server side +openssl dhparam -out %KEY_DIR%/dh%KEY_SIZE%.pem %KEY_SIZE% diff --git a/easy-rsa/Windows/build-key-pkcs12.bat b/easy-rsa/Windows/build-key-pkcs12.bat new file mode 100644 index 0000000..1fc083e --- /dev/null +++ b/easy-rsa/Windows/build-key-pkcs12.bat @@ -0,0 +1,10 @@ +@echo off +cd %HOME% +rem build a request for a cert that will be valid for ten years +openssl req -days 3650 -nodes -new -keyout %KEY_DIR%\%1.key -out %KEY_DIR%\%1.csr -config %KEY_CONFIG% +rem sign the cert request with our ca, creating a cert/key pair +openssl ca -days 3650 -out %KEY_DIR%\%1.crt -in %KEY_DIR%\%1.csr -config %KEY_CONFIG% +rem convert the key/cert and embed the ca cert into a pkcs12 file. +openssl pkcs12 -export -inkey %KEY_DIR%\%1.key -in %KEY_DIR%\%1.crt -certfile %KEY_DIR%\ca.crt -out %KEY_DIR%\%1.p12 +rem delete any .old files created in this process, to avoid future file creation errors +del /q %KEY_DIR%\*.old diff --git a/easy-rsa/Windows/build-key-server.bat b/easy-rsa/Windows/build-key-server.bat new file mode 100644 index 0000000..20e3605 --- /dev/null +++ b/easy-rsa/Windows/build-key-server.bat @@ -0,0 +1,8 @@ +@echo off +cd %HOME% +rem build a request for a cert that will be valid for ten years +openssl req -days 3650 -nodes -new -keyout %KEY_DIR%\%1.key -out %KEY_DIR%\%1.csr -config %KEY_CONFIG% +rem sign the cert request with our ca, creating a cert/key pair +openssl ca -days 3650 -out %KEY_DIR%\%1.crt -in %KEY_DIR%\%1.csr -extensions server -config %KEY_CONFIG% +rem delete any .old files created in this process, to avoid future file creation errors +del /q %KEY_DIR%\*.old diff --git a/easy-rsa/Windows/build-key.bat b/easy-rsa/Windows/build-key.bat new file mode 100644 index 0000000..c040904 --- /dev/null +++ b/easy-rsa/Windows/build-key.bat @@ -0,0 +1,8 @@ +@echo off +cd %HOME% +rem build a request for a cert that will be valid for ten years +openssl req -days 3650 -nodes -new -keyout %KEY_DIR%\%1.key -out %KEY_DIR%\%1.csr -config %KEY_CONFIG% +rem sign the cert request with our ca, creating a cert/key pair +openssl ca -days 3650 -out %KEY_DIR%\%1.crt -in %KEY_DIR%\%1.csr -config %KEY_CONFIG% +rem delete any .old files created in this process, to avoid future file creation errors +del /q %KEY_DIR%\*.old diff --git a/easy-rsa/Windows/clean-all.bat b/easy-rsa/Windows/clean-all.bat new file mode 100644 index 0000000..71cbf4d --- /dev/null +++ b/easy-rsa/Windows/clean-all.bat @@ -0,0 +1,13 @@ +@echo off +rem move to the HOME directory specified in VARS script +cd %HOME% +rem set a temporary KEY_DIR variable +set d=%KEY_DIR% +rem delete the KEY_DIR and any subdirs quietly +rmdir /s /q %d% +rem make a new KEY_DIR +mkdir %d% +rem copy in a fesh index file so we begin with an empty database +copy index.txt.start %d%\index.txt +rem copy in a fresh serial file so we begin generating keys at index 01 +copy serial.start %d%\serial. diff --git a/easy-rsa/Windows/index.txt.start b/easy-rsa/Windows/index.txt.start new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/easy-rsa/Windows/index.txt.start diff --git a/easy-rsa/Windows/init-config.bat b/easy-rsa/Windows/init-config.bat new file mode 100755 index 0000000..048d558 --- /dev/null +++ b/easy-rsa/Windows/init-config.bat @@ -0,0 +1,2 @@ +copy vars.bat.sample vars.bat +copy openssl.cnf.sample openssl.cnf diff --git a/easy-rsa/Windows/revoke-full.bat b/easy-rsa/Windows/revoke-full.bat new file mode 100644 index 0000000..ef2e4b5 --- /dev/null +++ b/easy-rsa/Windows/revoke-full.bat @@ -0,0 +1,13 @@ +@echo off +cd %HOME% +rem revoke cert +openssl ca -revoke %KEY_DIR%\%1.crt -config %KEY_CONFIG% +rem generate new crl +openssl ca -gencrl -out %KEY_DIR%\crl.pem -config %KEY_CONFIG% +rem test revocation +rem first concatinate ca cert with newly generated crl +copy %KEY_DIR%\ca.crt+%KEY_DIR%\crl.pem %KEY_DIR%\revoke_test_file.pem +rem now verify the revocation +openssl verify -CAfile %KEY_DIR%\revoke_test_file.pem -crl_check %KEY_DIR%\%1.crt +rem delete temporary test file +del /q %KEY_DIR%\revoke_test_file.pem diff --git a/easy-rsa/Windows/serial.start b/easy-rsa/Windows/serial.start new file mode 100644 index 0000000..8a0f05e --- /dev/null +++ b/easy-rsa/Windows/serial.start @@ -0,0 +1 @@ +01 diff --git a/easy-rsa/Windows/vars.bat.sample b/easy-rsa/Windows/vars.bat.sample new file mode 100644 index 0000000..8ab65e1 --- /dev/null +++ b/easy-rsa/Windows/vars.bat.sample @@ -0,0 +1,35 @@ +@echo off +rem Edit this variable to point to +rem the openssl.cnf file included +rem with easy-rsa. + +set HOME=%ProgramFiles%\OpenVPN\easy-rsa +set KEY_CONFIG=openssl.cnf + +rem Edit this variable to point to +rem your soon-to-be-created key +rem directory. +rem +rem WARNING: clean-all will do +rem a rm -rf on this directory +rem so make sure you define +rem it correctly! +set KEY_DIR=keys + +rem Increase this to 2048 if you +rem are paranoid. This will slow +rem down TLS negotiation performance +rem as well as the one-time DH parms +rem generation process. +set KEY_SIZE=1024 + +rem These are the default values for fields +rem which will be placed in the certificate. +rem Change these to reflect your site. +rem Don't leave any of these parms blank. + +set KEY_COUNTRY=US +set KEY_PROVINCE=CA +set KEY_CITY=SanFrancisco +set KEY_ORG=FortFunston +set KEY_EMAIL=mail@host.domain diff --git a/easy-rsa/build-ca b/easy-rsa/build-ca new file mode 100755 index 0000000..5ad59cc --- /dev/null +++ b/easy-rsa/build-ca @@ -0,0 +1,13 @@ +#!/bin/sh + +# +# Build a root certificate +# + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -nodes -new -x509 -keyout ca.key -out ca.crt -config $KEY_CONFIG && \ + chmod 0600 ca.key +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-dh b/easy-rsa/build-dh new file mode 100755 index 0000000..6de4baf --- /dev/null +++ b/easy-rsa/build-dh @@ -0,0 +1,12 @@ +#!/bin/sh + +# +# Build Diffie-Hellman parameters for the server side +# of an SSL/TLS connection. +# + +if test $KEY_DIR; then + openssl dhparam -out ${KEY_DIR}/dh${KEY_SIZE}.pem ${KEY_SIZE} +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-inter b/easy-rsa/build-inter new file mode 100755 index 0000000..8b3a6b2 --- /dev/null +++ b/easy-rsa/build-inter @@ -0,0 +1,19 @@ +#!/bin/sh + +# +# Make an intermediate CA certificate/private key pair using a locally generated +# root certificate. +# + +if test $# -ne 1; then + echo "usage: build-inter <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -nodes -new -keyout $1.key -out $1.csr -config $KEY_CONFIG && \ + openssl ca -extensions v3_ca -days 3650 -out $1.crt -in $1.csr -config $KEY_CONFIG +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-key b/easy-rsa/build-key new file mode 100755 index 0000000..3159d2b --- /dev/null +++ b/easy-rsa/build-key @@ -0,0 +1,20 @@ +#!/bin/sh + +# +# Make a certificate/private key pair using a locally generated +# root certificate. +# + +if test $# -ne 1; then + echo "usage: build-key <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -nodes -new -keyout $1.key -out $1.csr -config $KEY_CONFIG && \ + openssl ca -days 3650 -out $1.crt -in $1.csr -config $KEY_CONFIG && \ + chmod 0600 $1.key +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-key-pass b/easy-rsa/build-key-pass new file mode 100755 index 0000000..03ab304 --- /dev/null +++ b/easy-rsa/build-key-pass @@ -0,0 +1,20 @@ +#!/bin/sh + +# +# Similar to build-key, but protect the private key +# with a password. +# + +if test $# -ne 1; then + echo "usage: build-key-pass <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -new -keyout $1.key -out $1.csr -config $KEY_CONFIG && \ + openssl ca -days 3650 -out $1.crt -in $1.csr -config $KEY_CONFIG && \ + chmod 0600 $1.key +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-key-pkcs12 b/easy-rsa/build-key-pkcs12 new file mode 100755 index 0000000..f8a057b --- /dev/null +++ b/easy-rsa/build-key-pkcs12 @@ -0,0 +1,21 @@ +#!/bin/sh + +# +# Make a certificate/private key pair using a locally generated +# root certificate and convert it to a PKCS #12 file including the +# the CA certificate as well. + +if test $# -ne 1; then + echo "usage: build-key-pkcs12 <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -nodes -new -keyout $1.key -out $1.csr -config $KEY_CONFIG && \ + openssl ca -days 3650 -out $1.crt -in $1.csr -config $KEY_CONFIG && \ + openssl pkcs12 -export -inkey $1.key -in $1.crt -certfile ca.crt -out $1.p12 && \ + chmod 0600 $1.key $1.p12 +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-key-server b/easy-rsa/build-key-server new file mode 100755 index 0000000..30dc41e --- /dev/null +++ b/easy-rsa/build-key-server @@ -0,0 +1,22 @@ +#!/bin/sh + +# +# Make a certificate/private key pair using a locally generated +# root certificate. +# +# Explicitly set nsCertType to server using the "server" +# extension in the openssl.cnf file. + +if test $# -ne 1; then + echo "usage: build-key-server <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -nodes -new -keyout $1.key -out $1.csr -extensions server -config $KEY_CONFIG && \ + openssl ca -days 3650 -out $1.crt -in $1.csr -extensions server -config $KEY_CONFIG && \ + chmod 0600 $1.key +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-req b/easy-rsa/build-req new file mode 100755 index 0000000..30f62f5 --- /dev/null +++ b/easy-rsa/build-req @@ -0,0 +1,18 @@ +#!/bin/sh + +# +# Build a certificate signing request and private key. Use this +# when your root certificate and key is not available locally. +# + +if test $# -ne 1; then + echo "usage: build-req <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -nodes -new -keyout $1.key -out $1.csr -config $KEY_CONFIG +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/build-req-pass b/easy-rsa/build-req-pass new file mode 100755 index 0000000..829b286 --- /dev/null +++ b/easy-rsa/build-req-pass @@ -0,0 +1,18 @@ +#!/bin/sh + +# +# Like build-req, but protect your private key +# with a password. +# + +if test $# -ne 1; then + echo "usage: build-req-pass <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl req -days 3650 -new -keyout $1.key -out $1.csr -config $KEY_CONFIG +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/clean-all b/easy-rsa/clean-all new file mode 100755 index 0000000..d10aef5 --- /dev/null +++ b/easy-rsa/clean-all @@ -0,0 +1,19 @@ +#!/bin/sh + +# +# Initialize the $KEY_DIR directory. +# Note that this script does a +# rm -rf on $KEY_DIR so be careful! +# + +d=$KEY_DIR + +if test $d; then + rm -rf $d + mkdir $d && \ + chmod go-rwx $d && \ + touch $d/index.txt && \ + echo 01 >$d/serial +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/list-crl b/easy-rsa/list-crl new file mode 100644 index 0000000..b214dbd --- /dev/null +++ b/easy-rsa/list-crl @@ -0,0 +1,18 @@ +#!/bin/sh + +# +# list revoked certificates +# +# + +if test $# -ne 1; then + echo "usage: list-crl <crlfile.pem>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl crl -text -noout -in $1 +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/make-crl b/easy-rsa/make-crl new file mode 100644 index 0000000..62fe6c1 --- /dev/null +++ b/easy-rsa/make-crl @@ -0,0 +1,18 @@ +#!/bin/sh + +# +# generate a CRL +# +# + +if test $# -ne 1; then + echo "usage: make-crl <crlfile.pem>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl ca -gencrl -out $1 -config $KEY_CONFIG +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/openssl.cnf b/easy-rsa/openssl.cnf new file mode 100644 index 0000000..270b069 --- /dev/null +++ b/easy-rsa/openssl.cnf @@ -0,0 +1,255 @@ +# +# OpenSSL example configuration file. +# This is mostly being used for generation of certificate requests. +# + +# This definition stops the following lines choking if HOME isn't +# defined. +HOME = . +RANDFILE = $ENV::HOME/.rnd + +# Extra OBJECT IDENTIFIER info: +#oid_file = $ENV::HOME/.oid +oid_section = new_oids + +# To use this configuration file with the "-extfile" option of the +# "openssl x509" utility, name here the section containing the +# X.509v3 extensions to use: +# extensions = +# (Alternatively, use a configuration file that has only +# X.509v3 extensions in its main [= default] section.) + +[ new_oids ] + +# We can add new OIDs in here for use by 'ca' and 'req'. +# Add a simple OID like this: +# testoid1=1.2.3.4 +# Or use config file substitution like this: +# testoid2=${testoid1}.5.6 + +#################################################################### +[ ca ] +default_ca = CA_default # The default ca section + +#################################################################### +[ CA_default ] + +dir = $ENV::KEY_DIR # Where everything is kept +certs = $dir # Where the issued certs are kept +crl_dir = $dir # Where the issued crl are kept +database = $dir/index.txt # database index file. +new_certs_dir = $dir # default place for new certs. + +certificate = $dir/ca.crt # The CA certificate +serial = $dir/serial # The current serial number +crl = $dir/crl.pem # The current CRL +private_key = $dir/ca.key # The private key +RANDFILE = $dir/.rand # private random number file + +x509_extensions = usr_cert # The extentions to add to the cert + +# Extensions to add to a CRL. Note: Netscape communicator chokes on V2 CRLs +# so this is commented out by default to leave a V1 CRL. +# crl_extensions = crl_ext + +default_days = 3650 # how long to certify for +default_crl_days= 30 # how long before next CRL +default_md = md5 # which md to use. +preserve = no # keep passed DN ordering + +# A few difference way of specifying how similar the request should look +# For type CA, the listed attributes must be the same, and the optional +# and supplied fields are just that :-) +policy = policy_match + +# For the CA policy +[ policy_match ] +countryName = match +stateOrProvinceName = match +organizationName = match +organizationalUnitName = optional +commonName = supplied +emailAddress = optional + +# For the 'anything' policy +# At this point in time, you must list all acceptable 'object' +# types. +[ policy_anything ] +countryName = optional +stateOrProvinceName = optional +localityName = optional +organizationName = optional +organizationalUnitName = optional +commonName = supplied +emailAddress = optional + +#################################################################### +[ req ] +default_bits = $ENV::KEY_SIZE +default_keyfile = privkey.pem +distinguished_name = req_distinguished_name +attributes = req_attributes +x509_extensions = v3_ca # The extentions to add to the self signed cert + +# Passwords for private keys if not present they will be prompted for +# input_password = secret +# output_password = secret + +# This sets a mask for permitted string types. There are several options. +# default: PrintableString, T61String, BMPString. +# pkix : PrintableString, BMPString. +# utf8only: only UTF8Strings. +# nombstr : PrintableString, T61String (no BMPStrings or UTF8Strings). +# MASK:XXXX a literal mask value. +# WARNING: current versions of Netscape crash on BMPStrings or UTF8Strings +# so use this option with caution! +string_mask = nombstr + +# req_extensions = v3_req # The extensions to add to a certificate request + +[ req_distinguished_name ] +countryName = Country Name (2 letter code) +countryName_default = $ENV::KEY_COUNTRY +countryName_min = 2 +countryName_max = 2 + +stateOrProvinceName = State or Province Name (full name) +stateOrProvinceName_default = $ENV::KEY_PROVINCE + +localityName = Locality Name (eg, city) +localityName_default = $ENV::KEY_CITY + +0.organizationName = Organization Name (eg, company) +0.organizationName_default = $ENV::KEY_ORG + +# we can do this but it is not needed normally :-) +#1.organizationName = Second Organization Name (eg, company) +#1.organizationName_default = World Wide Web Pty Ltd + +organizationalUnitName = Organizational Unit Name (eg, section) +#organizationalUnitName_default = + +commonName = Common Name (eg, your name or your server\'s hostname) +commonName_max = 64 + +emailAddress = Email Address +emailAddress_default = $ENV::KEY_EMAIL +emailAddress_max = 40 + +# SET-ex3 = SET extension number 3 + +[ req_attributes ] +challengePassword = A challenge password +challengePassword_min = 4 +challengePassword_max = 20 + +unstructuredName = An optional company name + +[ usr_cert ] + +# These extensions are added when 'ca' signs a request. + +# This goes against PKIX guidelines but some CAs do it and some software +# requires this to avoid interpreting an end user certificate as a CA. + +basicConstraints=CA:FALSE + +# Here are some examples of the usage of nsCertType. If it is omitted +# the certificate can be used for anything *except* object signing. + +# This is OK for an SSL server. +# nsCertType = server + +# For an object signing certificate this would be used. +# nsCertType = objsign + +# For normal client use this is typical +# nsCertType = client, email + +# and for everything including object signing: +# nsCertType = client, email, objsign + +# This is typical in keyUsage for a client certificate. +# keyUsage = nonRepudiation, digitalSignature, keyEncipherment + +# This will be displayed in Netscape's comment listbox. +nsComment = "OpenSSL Generated Certificate" + +# PKIX recommendations harmless if included in all certificates. +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid,issuer:always + +# This stuff is for subjectAltName and issuerAltname. +# Import the email address. +# subjectAltName=email:copy + +# Copy subject details +# issuerAltName=issuer:copy + +#nsCaRevocationUrl = http://www.domain.dom/ca-crl.pem +#nsBaseUrl +#nsRevocationUrl +#nsRenewalUrl +#nsCaPolicyUrl +#nsSslServerName + +[ server ] + +# JY ADDED -- Make a cert with nsCertType set to "server" +basicConstraints=CA:FALSE +nsCertType = server +nsComment = "OpenSSL Generated Server Certificate" +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid,issuer:always + +[ v3_req ] + +# Extensions to add to a certificate request + +basicConstraints = CA:FALSE +keyUsage = nonRepudiation, digitalSignature, keyEncipherment + +[ v3_ca ] + + +# Extensions for a typical CA + + +# PKIX recommendation. + +subjectKeyIdentifier=hash + +authorityKeyIdentifier=keyid:always,issuer:always + +# This is what PKIX recommends but some broken software chokes on critical +# extensions. +#basicConstraints = critical,CA:true +# So we do this instead. +basicConstraints = CA:true + +# Key usage: this is typical for a CA certificate. However since it will +# prevent it being used as an test self-signed certificate it is best +# left out by default. +# keyUsage = cRLSign, keyCertSign + +# Some might want this also +# nsCertType = sslCA, emailCA + +# Include email address in subject alt name: another PKIX recommendation +# subjectAltName=email:copy +# Copy issuer details +# issuerAltName=issuer:copy + +# DER hex encoding of an extension: beware experts only! +# obj=DER:02:03 +# Where 'obj' is a standard or added object +# You can even override a supported extension: +# basicConstraints= critical, DER:30:03:01:01:FF + +[ crl_ext ] + +# CRL extensions. +# Only issuerAltName and authorityKeyIdentifier make any sense in a CRL. + +# issuerAltName=issuer:copy +authorityKeyIdentifier=keyid:always,issuer:always diff --git a/easy-rsa/revoke-crt b/easy-rsa/revoke-crt new file mode 100644 index 0000000..35b071a --- /dev/null +++ b/easy-rsa/revoke-crt @@ -0,0 +1,18 @@ +#!/bin/sh + +# +# revoke a certificate +# +# + +if test $# -ne 1; then + echo "usage: revoke-crt <file.crt>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl ca -revoke $1 -config $KEY_CONFIG +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/revoke-full b/easy-rsa/revoke-full new file mode 100755 index 0000000..66ea03f --- /dev/null +++ b/easy-rsa/revoke-full @@ -0,0 +1,29 @@ +#!/bin/sh + +# revoke a certificate, regenerate CRL, +# and verify revocation + +CRL=crl.pem +RT=revoke-test.pem + +if test $# -ne 1; then + echo "usage: revoke-full <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR + rm -f $RT + + # revoke key and generate a new CRL + openssl ca -revoke $1.crt -config $KEY_CONFIG + + # generate a new CRL + openssl ca -gencrl -out $CRL -config $KEY_CONFIG + cat ca.crt $CRL >$RT + + # verify the revocation + openssl verify -CAfile $RT -crl_check $1.crt +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/sign-req b/easy-rsa/sign-req new file mode 100755 index 0000000..59edc42 --- /dev/null +++ b/easy-rsa/sign-req @@ -0,0 +1,18 @@ +#!/bin/sh + +# +# Sign a certificate signing request (a .csr file) +# with a local root certificate and key. +# + +if test $# -ne 1; then + echo "usage: sign-req <name>"; + exit 1 +fi + +if test $KEY_DIR; then + cd $KEY_DIR && \ + openssl ca -days 3650 -out $1.crt -in $1.csr -config $KEY_CONFIG +else + echo you must define KEY_DIR +fi diff --git a/easy-rsa/vars b/easy-rsa/vars new file mode 100644 index 0000000..da89cd2 --- /dev/null +++ b/easy-rsa/vars @@ -0,0 +1,49 @@ +# easy-rsa parameter settings + +# NOTE: If you installed from an RPM, +# don't edit this file in place in +# /usr/share/openvpn/easy-rsa -- +# instead, you should copy the whole +# easy-rsa directory to another location +# (such as /etc/openvpn) so that your +# edits will not be wiped out by a future +# OpenVPN package upgrade. + +# This variable should point to +# the top level of the easy-rsa +# tree. +export D=`pwd` + +# This variable should point to +# the openssl.cnf file included +# with easy-rsa. +export KEY_CONFIG=$D/openssl.cnf + +# Edit this variable to point to +# your soon-to-be-created key +# directory. +# +# WARNING: clean-all will do +# a rm -rf on this directory +# so make sure you define +# it correctly! +export KEY_DIR=$D/keys + +# Issue rm -rf warning +echo NOTE: when you run ./clean-all, I will be doing a rm -rf on $KEY_DIR + +# Increase this to 2048 if you +# are paranoid. This will slow +# down TLS negotiation performance +# as well as the one-time DH parms +# generation process. +export KEY_SIZE=1024 + +# These are the default values for fields +# which will be placed in the certificate. +# Don't leave any of these fields blank. +export KEY_COUNTRY=KG +export KEY_PROVINCE=NA +export KEY_CITY=BISHKEK +export KEY_ORG="OpenVPN-TEST" +export KEY_EMAIL="me@myhost.mydomain" diff --git a/errlevel.h b/errlevel.h new file mode 100644 index 0000000..225705f --- /dev/null +++ b/errlevel.h @@ -0,0 +1,161 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef ERRLEVEL_H +#define ERRLEVEL_H + +#include "error.h" + +/* + * Debug level at and above where we + * display time to microsecond resolution. + */ +#define DEBUG_LEVEL_USEC_TIME 4 + +/* + * In non-server modes, delay n milliseconds after certain kinds + * of non-fatal network errors to avoid a barrage of errors. + * + * To disable all delays, set to 0. + */ +#define P2P_ERROR_DELAY_MS 0 + +/* + * Enable D_LOG_RW + */ +#define LOG_RW + +/* + * Debugging levels for various kinds + * of output. + */ + +#define M_VERB0 LOGLEV(0, 0, 0) /* Messages displayed even at --verb 0 (fatal errors only) */ + +#define M_INFO LOGLEV(1, 0, 0) /* default informational messages */ + +#define D_LINK_ERRORS LOGLEV(1, 1, M_NONFATAL) /* show link errors from main event loop */ +#define D_CRYPT_ERRORS LOGLEV(1, 2, M_NONFATAL) /* show errors from encrypt/decrypt */ +#define D_TLS_ERRORS LOGLEV(1, 3, M_NONFATAL) /* show TLS control channel errors */ +#define D_RESOLVE_ERRORS LOGLEV(1, 4, M_NONFATAL) /* show hostname resolve errors */ +#define D_COMP_ERRORS LOGLEV(1, 5, M_NONFATAL) /* show compression errors */ +#define D_REPLAY_ERRORS LOGLEV(1, 6, M_NONFATAL) /* show packet replay errors */ +#define D_STREAM_ERRORS LOGLEV(1, 7, M_NONFATAL) /* TCP stream error requiring restart */ +#define D_IMPORT_ERRORS LOGLEV(1, 8, M_NONFATAL) /* show server import option errors */ +#define D_MULTI_ERRORS LOGLEV(1, 9, M_NONFATAL) /* show multi-client server errors */ +#define D_EVENT_ERRORS LOGLEV(1, 10, M_NONFATAL) /* show event.[ch] errors */ +#define D_PUSH_ERRORS LOGLEV(1, 11, M_NONFATAL) /* show push/pull errors */ +#define D_PID_PERSIST LOGLEV(1, 12, M_NONFATAL) /* show packet_id persist errors */ +#define D_FRAG_ERRORS LOGLEV(1, 13, M_NONFATAL) /* show fragmentation errors */ +#define D_ALIGN_ERRORS LOGLEV(1, 14, M_NONFATAL) /* show bad struct alignments */ + +#define D_HANDSHAKE LOGLEV(2, 20, 0) /* show data & control channel handshakes */ +#define D_MTU_INFO LOGLEV(2, 21, 0) /* show terse MTU info */ +#define D_CLOSE LOGLEV(2, 22, 0) /* show socket and TUN/TAP close */ +#define D_SHOW_OCC_HASH LOGLEV(2, 23, 0) /* show MD5 hash of option compatibility string */ +#define D_PROXY LOGLEV(2, 24, 0) /* show http proxy control packets */ + +#define D_TLS_DEBUG_LOW LOGLEV(3, 20, 0) /* low frequency info from tls_session routines */ +#define D_GREMLIN LOGLEV(3, 30, 0) /* show simulated outage info from gremlin module */ +#define D_GENKEY LOGLEV(3, 31, 0) /* print message after key generation */ +#define D_ROUTE LOGLEV(3, 0, 0) /* show routes added and deleted (don't mute) */ +#define D_TUNTAP_INFO LOGLEV(3, 32, 0) /* show debugging info from TUN/TAP driver */ +#define D_RESTART LOGLEV(3, 33, 0) /* show certain restart messages */ +#define D_PUSH LOGLEV(3, 34, 0) /* show push/pull info */ +#define D_IFCONFIG_POOL LOGLEV(3, 35, 0) /* show ifconfig pool info */ +#define D_BACKTRACK LOGLEV(3, 36, 0) /* show replay backtracks */ +#define D_AUTH LOGLEV(3, 37, 0) /* show user/pass auth info */ +#define D_MULTI_LOW LOGLEV(3, 38, 0) /* show point-to-multipoint low-freq debug info */ +#define D_MULTI_DROPPED LOGLEV(3, 39, 0) /* show point-to-multipoint packet drops */ +#define D_PLUGIN LOGLEV(3, 40, 0) /* show plugin calls */ +#define D_MANAGEMENT LOGLEV(3, 41, 0) /* show --management info */ +#define D_SCHED_EXIT LOGLEV(3, 42, 0) /* show arming of scheduled exit */ +#define D_ROUTE_QUOTA LOGLEV(3, 43, 0) /* show route quota exceeded messages */ + +#define D_SHOW_PARMS LOGLEV(4, 50, 0) /* show all parameters on program initiation */ +#define D_SHOW_OCC LOGLEV(4, 51, 0) /* show options compatibility string */ +#define D_LOW LOGLEV(4, 52, 0) /* miscellaneous low-frequency debug info */ +#define D_DHCP_OPT LOGLEV(4, 53, 0) /* show DHCP options binary string */ +#define D_OSBUF LOGLEV(4, 54, 0) /* show socket/tun/tap buffer sizes */ +#define D_MBUF LOGLEV(4, 55, 0) /* mbuf.[ch] routines */ + +#define D_LOG_RW LOGLEV(5, 0, 0) /* Print 'R' or 'W' to stdout for read/write */ + +#define D_LINK_RW LOGLEV(6, 60, M_DEBUG) /* show TCP/UDP reads/writes (terse) */ +#define D_TAP_WIN32_DEBUG LOGLEV(6, 60, M_DEBUG) /* show TAP-Win32 driver debug info */ + +#define D_SHOW_KEYS LOGLEV(7, 70, M_DEBUG) /* show data channel encryption keys */ +#define D_SHOW_KEY_SOURCE LOGLEV(7, 70, M_DEBUG) /* show data channel key source entropy */ +#define D_REL_LOW LOGLEV(7, 70, M_DEBUG) /* show low frequency info from reliable layer */ +#define D_FRAG_DEBUG LOGLEV(7, 70, M_DEBUG) /* show fragment debugging info */ +#define D_WIN32_IO_LOW LOGLEV(7, 70, M_DEBUG) /* low freq win32 I/O debugging info */ +#define D_MTU_DEBUG LOGLEV(7, 70, M_DEBUG) /* show MTU debugging info */ +#define D_PID_DEBUG_LOW LOGLEV(7, 70, M_DEBUG) /* show low-freq packet-id debugging info */ +#define D_MULTI_DEBUG LOGLEV(7, 70, M_DEBUG) /* show medium-freq multi debugging info */ +#define D_MSS LOGLEV(7, 70, M_DEBUG) /* show MSS adjustments */ +#define D_COMP_LOW LOGLEV(7, 70, M_DEBUG) /* show adaptive compression state changes */ +#define D_REMOTE_LIST LOGLEV(7, 70, M_DEBUG) /* show --remote list */ +#define D_SCRIPT LOGLEV(7, 70, M_DEBUG) /* show parms & env vars passed to scripts */ +#define D_SHOW_NET LOGLEV(7, 70, M_DEBUG) /* show routing table and adapter list */ +#define D_ROUTE_DEBUG LOGLEV(7, 70, M_DEBUG) /* show verbose route.[ch] output */ +#define D_TLS_STATE_ERRORS LOGLEV(7, 70, M_DEBUG) /* no TLS state for client */ +#define D_SEMAPHORE_LOW LOGLEV(7, 70, M_DEBUG) /* show Win32 semaphore waits (low freq) */ +#define D_SEMAPHORE LOGLEV(7, 70, M_DEBUG) /* show Win32 semaphore waits */ +#define D_TEST_FILE LOGLEV(7, 70, M_DEBUG) /* show test_file() calls */ +#define D_MANAGEMENT_DEBUG LOGLEV(7, 70, M_DEBUG) /* show --management debug info */ +#define D_PLUGIN_DEBUG LOGLEV(7, 70, M_DEBUG) /* show verbose plugin calls */ +#define D_SOCKET_DEBUG LOGLEV(7, 70, M_DEBUG) /* show socket.[ch] debugging info */ +#define D_ALIGN_DEBUG LOGLEV(7, 70, M_DEBUG) /* show verbose struct alignment info */ + +#define D_HANDSHAKE_VERBOSE LOGLEV(8, 70, M_DEBUG) /* show detailed description of each handshake */ +#define D_TLS_DEBUG_MED LOGLEV(8, 70, M_DEBUG) /* limited info from tls_session routines */ +#define D_INTERVAL LOGLEV(8, 70, M_DEBUG) /* show interval.h debugging info */ +#define D_SCHEDULER LOGLEV(8, 70, M_DEBUG) /* show scheduler debugging info */ +#define D_GREMLIN_VERBOSE LOGLEV(8, 70, M_DEBUG) /* show verbose info from gremlin module */ +#define D_REL_DEBUG LOGLEV(8, 70, M_DEBUG) /* show detailed info from reliable routines */ +#define D_EVENT_WAIT LOGLEV(8, 70, M_DEBUG) /* show detailed info from event waits */ +#define D_TUN_RW LOGLEV(8, 70, M_DEBUG) /* show TUN/TAP reads/writes */ +#define D_MULTI_TCP LOGLEV(8, 70, M_DEBUG) /* show debug info from mtcp.c */ + +#define D_TLS_DEBUG LOGLEV(9, 70, M_DEBUG) /* show detailed info from TLS routines */ +#define D_CRYPTO_DEBUG LOGLEV(9, 70, M_DEBUG) /* show detailed info from crypto.c routines */ +#define D_COMP LOGLEV(9, 70, M_DEBUG) /* show compression info */ +#define D_READ_WRITE LOGLEV(9, 70, M_DEBUG) /* show all tun/tcp/udp reads/writes/opens */ +#define D_PACKET_CONTENT LOGLEV(9, 70, M_DEBUG) /* show before/after encryption packet content */ +#define D_TLS_NO_SEND_KEY LOGLEV(9, 70, M_DEBUG) /* show when no data channel send-key exists */ +#define D_PID_DEBUG LOGLEV(9, 70, M_DEBUG) /* show packet-id debugging info */ +#define D_PID_PERSIST_DEBUG LOGLEV(9, 70, M_DEBUG) /* show packet-id persist debugging info */ +#define D_LINK_RW_VERBOSE LOGLEV(9, 70, M_DEBUG) /* show link reads/writes with greater verbosity */ +#define D_STREAM_DEBUG LOGLEV(9, 70, M_DEBUG) /* show TCP stream debug info */ +#define D_WIN32_IO LOGLEV(9, 70, M_DEBUG) /* win32 I/O debugging info */ + +#define D_SHAPER_DEBUG LOGLEV(10, 70, M_DEBUG) /* show traffic shaper info */ + +#define D_REGISTRY LOGLEV(11, 70, M_DEBUG) /* win32 registry debugging info */ +#define D_OPENSSL_LOCK LOGLEV(11, 70, M_DEBUG) /* show OpenSSL locks */ + +#define D_THREAD_DEBUG LOGLEV(4, 70, M_DEBUG) /* JYFIXME -- show pthread debug information */ + + +#endif @@ -0,0 +1,852 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "error.h" +#include "buffer.h" +#include "thread.h" +#include "misc.h" +#include "win32.h" +#include "socket.h" +#include "tun.h" +#include "otime.h" +#include "perf.h" +#include "status.h" +#include "integer.h" + +#ifdef USE_CRYPTO +#include <openssl/err.h> +#endif + +#include "memdbg.h" + +#if SYSLOG_CAPABILITY +#ifndef LOG_OPENVPN +#define LOG_OPENVPN LOG_DAEMON +#endif +#endif + +/* Globals */ +unsigned int x_debug_level; /* GLOBAL */ + +/* Mute state */ +static int mute_cutoff; /* GLOBAL */ +static int mute_count; /* GLOBAL */ +static int mute_category; /* GLOBAL */ + +/* + * Output mode priorities are as follows: + * + * (1) --log-x overrides everything + * (2) syslog is used if --daemon or --inetd is defined and not --log-x + * (3) if OPENVPN_DEBUG_COMMAND_LINE is defined, output + * to constant logfile name. + * (4) Output to stdout. + */ + +/* If true, indicates that stdin/stdout/stderr + have been redirected due to --log */ +static bool std_redir; /* GLOBAL */ + +/* Should messages be written to the syslog? */ +static bool use_syslog; /* GLOBAL */ + +/* Should timestamps be included on messages to stdout/stderr? */ +static bool suppress_timestamps; /* GLOBAL */ + +/* The program name passed to syslog */ +static char *pgmname_syslog; /* GLOBAL */ + +/* If non-null, messages should be written here (used for debugging only) */ +static FILE *msgfp; /* GLOBAL */ + +bool +set_debug_level (const int level, const unsigned int flags) +{ + const int ceiling = 15; + + if (level >= 0 && level <= ceiling) + { + x_debug_level = level; + return true; + } + else if (flags & SDL_CONSTRAIN) + { + x_debug_level = constrain_int (level, 0, ceiling); + return true; + } + return false; +} + +bool +set_mute_cutoff (const int cutoff) +{ + if (cutoff >= 0) + { + mute_cutoff = cutoff; + return true; + } + else + return false; +} + +int +get_debug_level (void) +{ + return x_debug_level; +} + +int +get_mute_cutoff (void) +{ + return mute_cutoff; +} + +void +set_suppress_timestamps (bool suppressed) +{ + suppress_timestamps = suppressed; +} + +void +error_reset () +{ + use_syslog = std_redir = false; + suppress_timestamps = false; + x_debug_level = 1; + mute_cutoff = 0; + mute_count = 0; + mute_category = 0; + +#ifdef OPENVPN_DEBUG_COMMAND_LINE + msgfp = fopen (OPENVPN_DEBUG_FILE, "w"); + if (!msgfp) + openvpn_exit (OPENVPN_EXIT_STATUS_CANNOT_OPEN_DEBUG_FILE); /* exit point */ +#else + msgfp = NULL; +#endif +} + +/* + * Return a file to print messages to before syslog is opened. + */ +FILE * +msg_fp() +{ + FILE *fp = msgfp; + if (!fp) + fp = OPENVPN_MSG_FP; + if (!fp) + openvpn_exit (OPENVPN_EXIT_STATUS_CANNOT_OPEN_DEBUG_FILE); /* exit point */ + return fp; +} + +#define SWAP { tmp = m1; m1 = m2; m2 = tmp; } + +int x_msg_line_num; /* GLOBAL */ + +void x_msg (const unsigned int flags, const char *format, ...) +{ + struct gc_arena gc; + va_list arglist; +#if SYSLOG_CAPABILITY + int level; +#endif + char *m1; + char *m2; + char *tmp; + int e; + const char *prefix; + const char *prefix_sep; + + void usage_small (void); + +#ifndef HAVE_VARARG_MACROS + /* the macro has checked this otherwise */ + if (!MSG_TEST (flags)) + return; +#endif + + if (flags & M_ERRNO_SOCK) + e = openvpn_errno_socket (); + else + e = openvpn_errno (); + + /* + * Apply muting filter. + */ +#ifndef HAVE_VARARG_MACROS + /* the macro has checked this otherwise */ + if (!dont_mute (flags)) + return; +#endif + + gc_init (&gc); + + mutex_lock_static (L_MSG); + + m1 = (char *) gc_malloc (ERR_BUF_SIZE, false, &gc); + m2 = (char *) gc_malloc (ERR_BUF_SIZE, false, &gc); + + va_start (arglist, format); + vsnprintf (m1, ERR_BUF_SIZE, format, arglist); + va_end (arglist); + m1[ERR_BUF_SIZE - 1] = 0; /* windows vsnprintf needs this */ + + if ((flags & (M_ERRNO|M_ERRNO_SOCK)) && e) + { + openvpn_snprintf (m2, ERR_BUF_SIZE, "%s: %s (errno=%d)", + m1, strerror_ts (e, &gc), e); + SWAP; + } + +#ifdef USE_CRYPTO + if (flags & M_SSL) + { + int nerrs = 0; + int err; + while ((err = ERR_get_error ())) + { + openvpn_snprintf (m2, ERR_BUF_SIZE, "%s: %s", + m1, ERR_error_string (err, NULL)); + SWAP; + ++nerrs; + } + if (!nerrs) + { + openvpn_snprintf (m2, ERR_BUF_SIZE, "%s (OpenSSL)", m1); + SWAP; + } + } +#endif + + if (flags & M_OPTERR) + { + openvpn_snprintf (m2, ERR_BUF_SIZE, "Options error: %s", m1); + SWAP; + } + +#if SYSLOG_CAPABILITY + if (flags & (M_FATAL|M_NONFATAL|M_USAGE_SMALL)) + level = LOG_ERR; + else if (flags & M_WARN) + level = LOG_WARNING; + else + level = LOG_NOTICE; +#endif + + /* set up client prefix */ + prefix = msg_get_prefix (); + prefix_sep = " "; + if (!prefix) + prefix_sep = prefix = ""; + + /* virtual output capability used to copy output to management subsystem */ + { + const struct virtual_output *vo = msg_get_virtual_output (); + if (vo) + { + openvpn_snprintf (m2, ERR_BUF_SIZE, "%s%s%s", + prefix, + prefix_sep, + m1); + virtual_output_print (vo, flags, m2); + } + } + + if (!(flags & M_MSG_VIRT_OUT)) + { + if (use_syslog && !std_redir) + { +#if SYSLOG_CAPABILITY + syslog (level, "%s%s%s", + prefix, + prefix_sep, + m1); +#endif + } + else + { + FILE *fp = msg_fp(); + const bool show_usec = check_debug_level (DEBUG_LEVEL_USEC_TIME); + + if ((flags & M_NOPREFIX) || suppress_timestamps) + { + fprintf (fp, "%s%s%s\n", + prefix, + prefix_sep, + m1); + } + else + { +#ifdef USE_PTHREAD + fprintf (fp, "%s [%d] %s%s%s\n", + time_string (0, 0, show_usec, &gc), + (int) openvpn_thread_self (), + prefix, + prefix_sep, + m1); +#else + fprintf (fp, "%s %s%s%s\n", + time_string (0, 0, show_usec, &gc), + prefix, + prefix_sep, + m1); +#endif + } + fflush(fp); + ++x_msg_line_num; + } + } + + if (flags & M_FATAL) + msg (M_INFO, "Exiting"); + + mutex_unlock_static (L_MSG); + + if (flags & M_FATAL) + openvpn_exit (OPENVPN_EXIT_STATUS_ERROR); /* exit point */ + + if (flags & M_USAGE_SMALL) + usage_small (); + + gc_free (&gc); +} + +/* + * Apply muting filter. + */ +bool +dont_mute (unsigned int flags) +{ + bool ret = true; + if (mute_cutoff > 0 && !(flags & M_NOMUTE)) + { + const int mute_level = DECODE_MUTE_LEVEL (flags); + if (mute_level > 0 && mute_level == mute_category) + { + if (mute_count == mute_cutoff) + msg (M_INFO | M_NOMUTE, "NOTE: --mute triggered..."); + if (++mute_count > mute_cutoff) + ret = false; + } + else + { + const int suppressed = mute_count - mute_cutoff; + if (suppressed > 0) + msg (M_INFO | M_NOMUTE, + "%d variation(s) on previous %d message(s) suppressed by --mute", + suppressed, + mute_cutoff); + mute_count = 1; + mute_category = mute_level; + } + } + return ret; +} + +void +assert_failed (const char *filename, int line) +{ + msg (M_FATAL, "Assertion failed at %s:%d", filename, line); +} + +/* + * Fail memory allocation. Don't use msg() because it tries + * to allocate memory as part of its operation. + */ +void +out_of_memory (void) +{ + fprintf (stderr, PACKAGE_NAME ": Out of Memory\n"); + exit (1); +} + +void +open_syslog (const char *pgmname, bool stdio_to_null) +{ +#if SYSLOG_CAPABILITY + if (!msgfp && !std_redir) + { + if (!use_syslog) + { + pgmname_syslog = string_alloc (pgmname ? pgmname : PACKAGE, NULL); + openlog (pgmname_syslog, LOG_PID, LOG_OPENVPN); + use_syslog = true; + + /* Better idea: somehow pipe stdout/stderr output to msg() */ + if (stdio_to_null) + set_std_files_to_null (false); + } + } +#else + msg (M_WARN, "Warning on use of --daemon/--inetd: this operating system lacks daemon logging features, therefore when I become a daemon, I won't be able to log status or error messages"); +#endif +} + +void +close_syslog () +{ +#if SYSLOG_CAPABILITY + if (use_syslog) + { + closelog(); + use_syslog = false; + if (pgmname_syslog) + { + free (pgmname_syslog); + pgmname_syslog = NULL; + } + } +#endif +} + +#ifdef WIN32 + +static HANDLE orig_stderr; + +HANDLE +get_orig_stderr (void) +{ + if (orig_stderr) + return orig_stderr; + else + return GetStdHandle (STD_ERROR_HANDLE); +} + +#endif + +void +redirect_stdout_stderr (const char *file, bool append) +{ +#if defined(WIN32) + if (!std_redir) + { + HANDLE log_handle; + int log_fd; + struct security_attributes sa; + + init_security_attributes_allow_all (&sa); + + log_handle = CreateFile (file, + GENERIC_WRITE, + FILE_SHARE_READ, + &sa.sa, + append ? OPEN_ALWAYS : CREATE_ALWAYS, + FILE_ATTRIBUTE_NORMAL, + NULL); + + if (log_handle == INVALID_HANDLE_VALUE) + { + msg (M_WARN|M_ERRNO, "Warning: cannot open --log file: %s", file); + return; + } + + /* append to logfile? */ + if (append) + { + if (SetFilePointer (log_handle, 0, NULL, FILE_END) == INVALID_SET_FILE_POINTER) + msg (M_ERR, "Error: cannot seek to end of --log file: %s", file); + } + + /* save original stderr for password prompts */ + orig_stderr = GetStdHandle (STD_ERROR_HANDLE); + + /* set up for redirection */ + if (!SetStdHandle (STD_OUTPUT_HANDLE, log_handle) + || !SetStdHandle (STD_ERROR_HANDLE, log_handle)) + msg (M_ERR, "Error: cannot redirect stdout/stderr to --log file: %s", file); + + /* direct stdout/stderr to point to log_handle */ + log_fd = _open_osfhandle ((intptr_t)log_handle, _O_TEXT); + if (log_fd == -1) + msg (M_ERR, "Error: --log redirect failed due to _open_osfhandle failure"); + + /* open log_handle as FILE stream */ + ASSERT (msgfp == NULL); + msgfp = _fdopen (log_fd, "w"); + if (msgfp == NULL) + msg (M_ERR, "Error: --log redirect failed due to _fdopen"); + + std_redir = true; + } +#elif defined(HAVE_DUP2) + if (!std_redir) + { + int out = open (file, + O_CREAT | O_WRONLY | (append ? O_APPEND : O_TRUNC), + S_IRUSR | S_IWUSR); + + if (out < 0) + { + msg (M_WARN|M_ERRNO, "Warning: Error redirecting stdout/stderr to --log file: %s", file); + return; + } + + if (dup2 (out, 1) == -1) + msg (M_ERR, "--log file redirection error on stdout"); + if (dup2 (out, 2) == -1) + msg (M_ERR, "--log file redirection error on stderr"); + + if (out > 2) + close (out); + + std_redir = true; + } + +#else + msg (M_WARN, "WARNING: The --log option is not supported on this OS because it lacks the dup2 function"); +#endif +} + +/* + * Functions used to check return status + * of I/O operations. + */ + +unsigned int x_cs_info_level; /* GLOBAL */ +unsigned int x_cs_verbose_level; /* GLOBAL */ +unsigned int x_cs_err_delay_ms; /* GLOBAL */ + +void +reset_check_status () +{ + x_cs_info_level = 0; + x_cs_verbose_level = 0; +} + +void +set_check_status (unsigned int info_level, unsigned int verbose_level) +{ + x_cs_info_level = info_level; + x_cs_verbose_level = verbose_level; +} + +/* + * Called after most socket or tun/tap operations, via the inline + * function check_status(). + * + * Decide if we should print an error message, and see if we can + * extract any useful info from the error, such as a Path MTU hint + * from the OS. + */ +void +x_check_status (int status, + const char *description, + struct link_socket *sock, + struct tuntap *tt) +{ + const int my_errno = (sock ? openvpn_errno_socket () : openvpn_errno ()); + const char *extended_msg = NULL; + + msg (x_cs_verbose_level, "%s %s returned %d", + sock ? proto2ascii (sock->info.proto, true) : "", + description, + status); + + if (status < 0) + { + struct gc_arena gc = gc_new (); +#if EXTENDED_SOCKET_ERROR_CAPABILITY + /* get extended socket error message and possible PMTU hint from OS */ + if (sock) + { + int mtu; + extended_msg = format_extended_socket_error (sock->sd, &mtu, &gc); + if (mtu > 0 && sock->mtu != mtu) + { + sock->mtu = mtu; + sock->info.mtu_changed = true; + } + } +#elif defined(WIN32) + /* get possible driver error from TAP-Win32 driver */ + extended_msg = tap_win32_getinfo (tt, &gc); +#endif + if (!ignore_sys_error (my_errno)) + { + if (extended_msg) + msg (x_cs_info_level, "%s %s [%s]: %s (code=%d)", + description, + sock ? proto2ascii (sock->info.proto, true) : "", + extended_msg, + strerror_ts (my_errno, &gc), + my_errno); + else + msg (x_cs_info_level, "%s %s: %s (code=%d)", + description, + sock ? proto2ascii (sock->info.proto, true) : "", + strerror_ts (my_errno, &gc), + my_errno); + + if (x_cs_err_delay_ms) + sleep_milliseconds (x_cs_err_delay_ms); + } + gc_free (&gc); + } +} + +/* + * In multiclient mode, put a client-specific prefix + * before each message. + */ +const char *x_msg_prefix; /* GLOBAL */ + +#ifdef USE_PTHREAD +pthread_key_t x_msg_prefix_key; /* GLOBAL */ +#endif + +/* + * Allow MSG to be redirected through a virtual_output object + */ + +const struct virtual_output *x_msg_virtual_output; /* GLOBAL */ + +/* + * Init thread-local variables + */ + +void +msg_thread_init (void) +{ +#ifdef USE_PTHREAD + ASSERT (!pthread_key_create (&x_msg_prefix_key, NULL)); +#endif +} + +void +msg_thread_uninit (void) +{ +#ifdef USE_PTHREAD + pthread_key_delete (x_msg_prefix_key); +#endif +} + +/* + * Exiting. + */ + +void +openvpn_exit (const int status) +{ +#ifdef ENABLE_PLUGIN + void plugin_abort (void); +#endif + +#ifdef WIN32 + uninit_win32 (); +#endif + + close_syslog (); + +#ifdef ENABLE_PLUGIN + plugin_abort (); +#endif + +#ifdef ABORT_ON_ERROR + if (status == OPENVPN_EXIT_STATUS_ERROR) + abort (); +#endif + + if (status == OPENVPN_EXIT_STATUS_GOOD) + perf_output_results (); + + exit (status); +} + +/* + * Translate msg flags into a string + */ +const char * +msg_flags_string (const unsigned int flags, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (16, gc); + if (flags == M_INFO) + buf_printf (&out, "I"); + if (flags & M_FATAL) + buf_printf (&out, "F"); + if (flags & M_NONFATAL) + buf_printf (&out, "N"); + if (flags & M_WARN) + buf_printf (&out, "W"); + if (flags & M_DEBUG) + buf_printf (&out, "D"); + return BSTR (&out); +} + +#ifdef WIN32 + +const char * +strerror_win32 (DWORD errnum, struct gc_arena *gc) +{ + /* + * This code can be omitted, though often the Windows + * WSA error messages are less informative than the + * Posix equivalents. + */ +#if 1 + switch (errnum) { + /* + * When the TAP-Win32 driver returns STATUS_UNSUCCESSFUL, this code + * gets returned to user space. + */ + case ERROR_GEN_FAILURE: + return "General failure (ERROR_GEN_FAILURE)"; + case ERROR_IO_PENDING: + return "I/O Operation in progress (ERROR_IO_PENDING)"; + case WSA_IO_INCOMPLETE: + return "I/O Operation in progress (WSA_IO_INCOMPLETE)"; + case WSAEINTR: + return "Interrupted system call (WSAEINTR)"; + case WSAEBADF: + return "Bad file number (WSAEBADF)"; + case WSAEACCES: + return "Permission denied (WSAEACCES)"; + case WSAEFAULT: + return "Bad address (WSAEFAULT)"; + case WSAEINVAL: + return "Invalid argument (WSAEINVAL)"; + case WSAEMFILE: + return "Too many open files (WSAEMFILE)"; + case WSAEWOULDBLOCK: + return "Operation would block (WSAEWOULDBLOCK)"; + case WSAEINPROGRESS: + return "Operation now in progress (WSAEINPROGRESS)"; + case WSAEALREADY: + return "Operation already in progress (WSAEALREADY)"; + case WSAEDESTADDRREQ: + return "Destination address required (WSAEDESTADDRREQ)"; + case WSAEMSGSIZE: + return "Message too long (WSAEMSGSIZE)"; + case WSAEPROTOTYPE: + return "Protocol wrong type for socket (WSAEPROTOTYPE)"; + case WSAENOPROTOOPT: + return "Bad protocol option (WSAENOPROTOOPT)"; + case WSAEPROTONOSUPPORT: + return "Protocol not supported (WSAEPROTONOSUPPORT)"; + case WSAESOCKTNOSUPPORT: + return "Socket type not supported (WSAESOCKTNOSUPPORT)"; + case WSAEOPNOTSUPP: + return "Operation not supported on socket (WSAEOPNOTSUPP)"; + case WSAEPFNOSUPPORT: + return "Protocol family not supported (WSAEPFNOSUPPORT)"; + case WSAEAFNOSUPPORT: + return "Address family not supported by protocol family (WSAEAFNOSUPPORT)"; + case WSAEADDRINUSE: + return "Address already in use (WSAEADDRINUSE)"; + case WSAENETDOWN: + return "Network is down (WSAENETDOWN)"; + case WSAENETUNREACH: + return "Network is unreachable (WSAENETUNREACH)"; + case WSAENETRESET: + return "Net dropped connection or reset (WSAENETRESET)"; + case WSAECONNABORTED: + return "Software caused connection abort (WSAECONNABORTED)"; + case WSAECONNRESET: + return "Connection reset by peer (WSAECONNRESET)"; + case WSAENOBUFS: + return "No buffer space available (WSAENOBUFS)"; + case WSAEISCONN: + return "Socket is already connected (WSAEISCONN)"; + case WSAENOTCONN: + return "Socket is not connected (WSAENOTCONN)"; + case WSAETIMEDOUT: + return "Connection timed out (WSAETIMEDOUT)"; + case WSAECONNREFUSED: + return "Connection refused (WSAECONNREFUSED)"; + case WSAELOOP: + return "Too many levels of symbolic links (WSAELOOP)"; + case WSAENAMETOOLONG: + return "File name too long (WSAENAMETOOLONG)"; + case WSAEHOSTDOWN: + return "Host is down (WSAEHOSTDOWN)"; + case WSAEHOSTUNREACH: + return "No Route to Host (WSAEHOSTUNREACH)"; + case WSAENOTEMPTY: + return "Directory not empty (WSAENOTEMPTY)"; + case WSAEPROCLIM: + return "Too many processes (WSAEPROCLIM)"; + case WSAEUSERS: + return "Too many users (WSAEUSERS)"; + case WSAEDQUOT: + return "Disc Quota Exceeded (WSAEDQUOT)"; + case WSAESTALE: + return "Stale NFS file handle (WSAESTALE)"; + case WSASYSNOTREADY: + return "Network SubSystem is unavailable (WSASYSNOTREADY)"; + case WSAVERNOTSUPPORTED: + return "WINSOCK DLL Version out of range (WSAVERNOTSUPPORTED)"; + case WSANOTINITIALISED: + return "Successful WSASTARTUP not yet performed (WSANOTINITIALISED)"; + case WSAEREMOTE: + return "Too many levels of remote in path (WSAEREMOTE)"; + case WSAHOST_NOT_FOUND: + return "Host not found (WSAHOST_NOT_FOUND)"; + default: + break; + } +#endif + + /* format a windows error message */ + { + char message[256]; + struct buffer out = alloc_buf_gc (256, gc); + const int status = FormatMessage ( + FORMAT_MESSAGE_IGNORE_INSERTS + | FORMAT_MESSAGE_FROM_SYSTEM + | FORMAT_MESSAGE_ARGUMENT_ARRAY, + NULL, + errnum, + 0, + message, + sizeof (message), + NULL); + if (!status) + { + buf_printf (&out, "[Unknown Win32 Error]"); + } + else + { + char *cp; + for (cp = message; *cp != '\0'; ++cp) + { + if (*cp == '\n' || *cp == '\r') + *cp = ' '; + } + + buf_printf(&out, "%s", message); + } + + return BSTR (&out); + } +} + +#endif @@ -0,0 +1,342 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef ERROR_H +#define ERROR_H + +#include "basic.h" +#include "thread.h" + +/* #define ABORT_ON_ERROR */ + +#define ERR_BUF_SIZE 1024 + +struct gc_arena; + +/* + * Where should messages be printed before syslog is opened? + * Not used if OPENVPN_DEBUG_COMMAND_LINE is defined. + */ +#define OPENVPN_MSG_FP stdout + +/* + * Exit status codes + */ + +#define OPENVPN_EXIT_STATUS_GOOD 0 +#define OPENVPN_EXIT_STATUS_ERROR 1 +#define OPENVPN_EXIT_STATUS_USAGE 1 +#define OPENVPN_EXIT_STATUS_CANNOT_OPEN_DEBUG_FILE 1 + +/* + * Special command line debugging mode. + * If OPENVPN_DEBUG_COMMAND_LINE + * is defined, contents of argc/argv will + * be dumped to OPENVPN_DEBUG_FILE as well + * as all other OpenVPN messages. + */ + +/* #define OPENVPN_DEBUG_COMMAND_LINE */ +#define OPENVPN_DEBUG_FILE PACKAGE ".log" + +/* String and Error functions */ + +#ifdef WIN32 +# define openvpn_errno() GetLastError() +# define openvpn_errno_socket() WSAGetLastError() +# define openvpn_strerror(e, gc) strerror_win32(e, gc) + const char *strerror_win32 (DWORD errnum, struct gc_arena *gc); +#else +# define openvpn_errno() errno +# define openvpn_errno_socket() errno +# define openvpn_strerror(x, gc) strerror(x) +#endif + +/* + * These globals should not be accessed directly, + * but rather through macros or inline functions defined below. + */ +extern unsigned int x_debug_level; +extern int x_msg_line_num; + +/* msg() flags */ + +#define M_DEBUG_LEVEL (0x0F) /* debug level mask */ + +#define M_FATAL (1<<4) /* exit program */ +#define M_NONFATAL (1<<5) /* non-fatal error */ +#define M_WARN (1<<6) /* call syslog with LOG_WARNING */ +#define M_DEBUG (1<<7) + +#define M_ERRNO (1<<8) /* show errno description */ +#define M_ERRNO_SOCK (1<<9) /* show socket errno description */ +#define M_SSL (1<<10) /* show SSL error */ +#define M_NOMUTE (1<<11) /* don't do mute processing */ +#define M_NOPREFIX (1<<12) /* don't show date/time prefix */ +#define M_USAGE_SMALL (1<<13) /* fatal options error, call usage_small */ +#define M_MSG_VIRT_OUT (1<<14) /* output message through msg_status_output callback */ +#define M_OPTERR (1<<15) /* print "Options error:" prefix */ + +/* flag combinations which are frequently used */ +#define M_ERR (M_FATAL | M_ERRNO) +#define M_SOCKERR (M_FATAL | M_ERRNO_SOCK) +#define M_SSLERR (M_FATAL | M_SSL) +#define M_USAGE (M_USAGE_SMALL | M_NOPREFIX | M_OPTERR) +#define M_CLIENT (M_MSG_VIRT_OUT|M_NOMUTE) + +/* + * Mute levels are designed to avoid large numbers of + * mostly similar messages clogging the log file. + * + * A mute level of 0 is always printed. + */ +#define MUTE_LEVEL_SHIFT 16 +#define MUTE_LEVEL_MASK 0xFF + +#define ENCODE_MUTE_LEVEL(mute_level) (((mute_level) & MUTE_LEVEL_MASK) << MUTE_LEVEL_SHIFT) +#define DECODE_MUTE_LEVEL(flags) (((flags) >> MUTE_LEVEL_SHIFT) & MUTE_LEVEL_MASK) + +/* + * log_level: verbosity level n (--verb n) must be >= log_level to print. + * mute_level: don't print more than n (--mute n) consecutive messages at + * a given mute level, or if 0 disable muting and print everything. + */ +#define LOGLEV(log_level, mute_level, other) ((log_level) | ENCODE_MUTE_LEVEL(mute_level) | other) + +/* + * If compiler supports variable arguments in macros, define + * msg() as a macro for optimization win. + */ + +bool dont_mute (unsigned int flags); /* check muting filter */ + +#define MSG_TEST(flags) (((((unsigned int)flags) & M_DEBUG_LEVEL) <= x_debug_level) && dont_mute (flags)) + +#if defined(HAVE_CPP_VARARG_MACRO_ISO) && !defined(__LCLINT__) +# define HAVE_VARARG_MACROS +# define msg(flags, ...) do { if (MSG_TEST(flags)) x_msg((flags), __VA_ARGS__); } while (false) +# ifdef ENABLE_DEBUG +# define dmsg(flags, ...) do { if (MSG_TEST(flags)) x_msg((flags), __VA_ARGS__); } while (false) +# else +# define dmsg(flags, ...) +# endif +#elif defined(HAVE_CPP_VARARG_MACRO_GCC) && !defined(__LCLINT__) +# define HAVE_VARARG_MACROS +# define msg(flags, args...) do { if (MSG_TEST(flags)) x_msg((flags), args); } while (false) +# ifdef ENABLE_DEBUG +# define dmsg(flags, args...) do { if (MSG_TEST(flags)) x_msg((flags), args); } while (false) +# else +# define dmsg(flags, args...) +# endif +#else +# if !PEDANTIC +# ifdef _MSC_VER +# pragma message("this compiler appears to lack vararg macros which will cause a significant degradation in efficiency") +# else +# warning this compiler appears to lack vararg macros which will cause a significant degradation in efficiency (you can ignore this warning if you are using LCLINT) +# endif +# endif +# define msg x_msg +# define dmsg x_msg +#endif + +void x_msg (const unsigned int flags, const char *format, ...) +#ifdef __GNUC__ + __attribute__ ((format (printf, 2, 3))) +#endif + ; /* should be called via msg above */ + +/* + * Function prototypes + */ + +void error_reset (void); +void set_suppress_timestamps (bool suppressed); + +#define SDL_CONSTRAIN (1<<0) +bool set_debug_level (const int level, const unsigned int flags); + +bool set_mute_cutoff (const int cutoff); + +int get_debug_level (void); +int get_mute_cutoff (void); + +const char *msg_flags_string (const unsigned int flags, struct gc_arena *gc); + +/* + * File to print messages to before syslog is opened. + */ +FILE *msg_fp(void); + +/* Fatal logic errors */ +#define ASSERT(x) do { if (!(x)) assert_failed(__FILE__, __LINE__); } while (false) + +void assert_failed (const char *filename, int line); + +/* Inline functions */ + +static inline bool +check_debug_level (unsigned int level) +{ + return (level & M_DEBUG_LEVEL) <= x_debug_level; +} + +/* syslog output */ + +void open_syslog (const char *pgmname, bool stdio_to_null); +void close_syslog (); + +/* log file output */ +void redirect_stdout_stderr (const char *file, bool append); + +#ifdef WIN32 +/* get original stderr handle, even if redirected by --log/--log-append */ +HANDLE get_orig_stderr (void); +#endif + +/* exit program */ +void openvpn_exit (const int status); + +/* + * Check the return status of read/write routines. + */ + +struct link_socket; +struct tuntap; + +extern unsigned int x_cs_info_level; +extern unsigned int x_cs_verbose_level; +extern unsigned int x_cs_err_delay_ms; + +void reset_check_status (void); +void set_check_status (unsigned int info_level, unsigned int verbose_level); + +void x_check_status (int status, + const char *description, + struct link_socket *sock, + struct tuntap *tt); + +static inline void +check_status (int status, const char *description, struct link_socket *sock, struct tuntap *tt) +{ + if (status < 0 || check_debug_level (x_cs_verbose_level)) + x_check_status (status, description, sock, tt); +} + +static inline void +set_check_status_error_delay (unsigned int milliseconds) +{ + x_cs_err_delay_ms = milliseconds; +} + +/* + * In multiclient mode, put a client-specific prefix + * before each message. + * + * TODO: x_msg_prefix should be thread-local + */ + +extern const char *x_msg_prefix; + +#ifdef USE_PTHREAD +extern pthread_key_t x_msg_prefix_key; +#endif + +void msg_thread_init (void); +void msg_thread_uninit (void); + +static inline void +msg_set_prefix (const char *prefix) +{ +#ifdef USE_PTHREAD + if (openvpn_thread_enabled ()) + { + ASSERT (!pthread_setspecific (x_msg_prefix_key, prefix)); + } + else +#endif + x_msg_prefix = prefix; +} + +static inline const char * +msg_get_prefix (void) +{ +#ifdef USE_PTHREAD + if (openvpn_thread_enabled ()) + return (const char *) pthread_getspecific (x_msg_prefix_key); + else +#endif + return x_msg_prefix; +} + +/* + * Allow MSG to be redirected through a virtual_output object + */ + +struct virtual_output; + +extern const struct virtual_output *x_msg_virtual_output; + +static inline void +msg_set_virtual_output (const struct virtual_output *vo) +{ + x_msg_virtual_output = vo; +} + +static inline const struct virtual_output * +msg_get_virtual_output (void) +{ + return x_msg_virtual_output; +} + +/* + * Return true if this is a system error + * which can be safely ignored. + */ +static inline bool +ignore_sys_error (const int err) +{ + /* I/O operation pending */ +#ifdef WIN32 + if (err == WSAEWOULDBLOCK || err == WSAEINVAL) + return true; +#else + if (err == EAGAIN) + return true; +#endif + +#if 0 /* if enabled, suppress ENOBUFS errors */ +#ifdef ENOBUFS + /* No buffer space available */ + if (err == ENOBUFS) + return true; +#endif +#endif + + return false; +} + +#include "errlevel.h" + +#endif @@ -0,0 +1,1061 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "buffer.h" +#include "error.h" +#include "integer.h" +#include "event.h" + +#include "memdbg.h" + +/* + * Some OSes will prefer select() over poll() + * when both are available. + */ +#if defined(TARGET_DARWIN) +#define SELECT_PREFERRED_OVER_POLL +#endif + +/* + * All non-windows OSes are assumed to have select() + */ +#ifdef WIN32 +#define SELECT 0 +#else +#define SELECT 1 +#endif + +/* + * This should be set to the highest file descriptor + * which can be used in one of the FD_ macros. + */ +#ifdef FD_SETSIZE +#define SELECT_MAX_FDS FD_SETSIZE +#else +#define SELECT_MAX_FDS 256 +#endif + +static inline int +tv_to_ms_timeout (const struct timeval *tv) +{ + if (tv->tv_sec == 0 && tv->tv_usec == 0) + return 0; + else + return max_int (tv->tv_sec * 1000 + (tv->tv_usec + 500) / 1000, 1); +} + +#ifdef WIN32 + +struct we_set +{ + struct event_set_functions func; + bool fast; + HANDLE *events; + struct event_set_return *esr; + int n_events; + int capacity; +}; + +static inline void +we_set_event (struct we_set *wes, int i, event_t event, unsigned int rwflags, void *arg) +{ + ASSERT (i >= 0 && i < wes->capacity); + + if (rwflags == EVENT_READ) + { + ASSERT (event->read != NULL); + wes->events[i] = event->read; + } + else if (rwflags == EVENT_WRITE) + { + ASSERT (event->write != NULL); + wes->events[i] = event->write; + } + else + msg (M_FATAL, "fatal error in we_set_events: rwflags=%d", rwflags); + + wes->esr[i].rwflags = rwflags; + wes->esr[i].arg = arg; +} + +static inline bool +we_append_event (struct we_set *wes, event_t event, unsigned int rwflags, void *arg) +{ + if (rwflags & EVENT_WRITE) + { + if (wes->n_events < wes->capacity) + { + we_set_event (wes, wes->n_events, event, EVENT_WRITE, arg); + ++wes->n_events; + } + else + return false; + } + if (rwflags & EVENT_READ) + { + if (wes->n_events < wes->capacity) + { + we_set_event (wes, wes->n_events, event, EVENT_READ, arg); + ++wes->n_events; + } + else + return false; + } + return true; +} + +static void +we_del_event (struct we_set *wes, event_t event) +{ + int i, j = 0; + const int len = wes->n_events; + + for (i = 0; i < len; ++i) + { + const HANDLE h = wes->events[i]; + if (h == event->read || h == event->write) + --wes->n_events; + else + { + if (i != j) + { + wes->events[j] = wes->events[i]; + wes->esr[j] = wes->esr[i]; + } + ++j; + } + } +} + +static void +we_del_index (struct we_set *wes, int index) +{ + int i; + ASSERT (index >= 0 && index < wes->n_events); + for (i = index; i < wes->n_events - 1; ++i) + { + wes->events[i] = wes->events[i+1]; + wes->esr[i] = wes->esr[i+1]; + } + --wes->n_events; +} + +static void +we_get_rw_indices (struct we_set *wes, event_t event, int *ri, int *wi) +{ + int i; + *ri = *wi = -1; + for (i = 0; i < wes->n_events; ++i) + { + const HANDLE h = wes->events[i]; + if (h == event->read) + { + ASSERT (*ri == -1); + *ri = i; + } + else if (h == event->write) + { + ASSERT (*wi == -1); + *wi = i; + } + } +} + +static void +we_free (struct event_set *es) +{ + struct we_set *wes = (struct we_set *) es; + free (wes->events); + free (wes->esr); + free (wes); +} + +static void +we_reset (struct event_set *es) +{ + struct we_set *wes = (struct we_set *) es; + ASSERT (wes->fast); + wes->n_events = 0; +} + +static void +we_del (struct event_set *es, event_t event) +{ + struct we_set *wes = (struct we_set *) es; + ASSERT (!wes->fast); + we_del_event (wes, event); +} + +static void +we_ctl (struct event_set *es, event_t event, unsigned int rwflags, void *arg) +{ + struct we_set *wes = (struct we_set *) es; + + dmsg (D_EVENT_WAIT, "WE_CTL n=%d ev=0x%08x rwflags=0x%04x arg=" ptr_format, + wes->n_events, + (unsigned int)event, + rwflags, + (ptr_type)arg); + + if (wes->fast) + { + if (!we_append_event (wes, event, rwflags, arg)) + goto err; + } + else + { + int ri, wi; + int one = -1; + int n = 0; + + we_get_rw_indices (wes, event, &ri, &wi); + if (wi >= 0) + { + one = wi; + ++n; + } + if (ri >= 0) + { + one = ri; + ++n; + } + switch (rwflags) + { + case 0: + switch (n) + { + case 0: + break; + case 1: + we_del_index (wes, one); + break; + case 2: + we_del_event (wes, event); + break; + default: + ASSERT (0); + } + break; + case EVENT_READ: + switch (n) + { + case 0: + if (!we_append_event (wes, event, EVENT_READ, arg)) + goto err; + break; + case 1: + we_set_event (wes, one, event, EVENT_READ, arg); + break; + case 2: + we_del_index (wes, wi); + break; + default: + ASSERT (0); + } + break; + case EVENT_WRITE: + switch (n) + { + case 0: + if (!we_append_event (wes, event, EVENT_WRITE, arg)) + goto err; + break; + case 1: + we_set_event (wes, one, event, EVENT_WRITE, arg); + break; + case 2: + we_del_index (wes, ri); + break; + default: + ASSERT (0); + } + break; + case EVENT_READ|EVENT_WRITE: + switch (n) + { + case 0: + if (!we_append_event (wes, event, EVENT_READ|EVENT_WRITE, arg)) + goto err; + break; + case 1: + if (ri == -1) + { + ASSERT (wi != -1); + if (!we_append_event (wes, event, EVENT_READ, arg)) + goto err; + } + else if (wi == -1) + { + if (!we_append_event (wes, event, EVENT_WRITE, arg)) + goto err; + } + else + ASSERT (0); + break; + case 2: + break; + default: + ASSERT (0); + } + break; + default: + msg (M_FATAL, "fatal error in we_ctl: rwflags=%d", rwflags); + } + } + return; + + err: + msg (D_EVENT_ERRORS, "Error: Windows resource limit WSA_MAXIMUM_WAIT_EVENTS (%d) has been exceeded", WSA_MAXIMUM_WAIT_EVENTS); +} + +static int +we_wait (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen) +{ + struct we_set *wes = (struct we_set *) es; + const int timeout = tv_to_ms_timeout (tv); + DWORD status; + + dmsg (D_EVENT_WAIT, "WE_WAIT enter n=%d to=%d", wes->n_events, timeout); + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_EVENT_WAIT)) { + int i; + for (i = 0; i < wes->n_events; ++i) + dmsg (D_EVENT_WAIT, "[%d] ev=0x%08x rwflags=0x%04x arg=" ptr_format, + i, + (unsigned int)wes->events[i], + wes->esr[i].rwflags, + (ptr_type)wes->esr[i].arg); + } +#endif + + /* + * First poll our event list with 0 timeout + */ + status = WSAWaitForMultipleEvents( + (DWORD) wes->n_events, + wes->events, + FALSE, + (DWORD) 0, + FALSE); + + /* + * If at least one event is already set, we must + * individually poll the whole list. + */ + if (status >= WSA_WAIT_EVENT_0 && status < WSA_WAIT_EVENT_0 + (DWORD) wes->n_events) + { + int i; + int j = 0; + for (i = 0; i < wes->n_events; ++i) + { + if (j >= outlen) + break; + if (WaitForSingleObject (wes->events[i], 0) == WAIT_OBJECT_0) + { + *out = wes->esr[i]; + dmsg (D_EVENT_WAIT, "WE_WAIT leave [%d,%d] rwflags=0x%04x arg=" ptr_format, + i, j, out->rwflags, (ptr_type)out->arg); + ++j; + ++out; + } + } + return j; + } + else + { + /* + * If caller specified timeout > 0, we know at this point + * that no events are set, so wait only for the first event + * (or timeout) and return at most one event_set_return object. + * + * If caller specified timeout == 0, the second call to + * WSAWaitForMultipleEvents would be redundant -- just + * return 0 indicating timeout. + */ + if (timeout > 0) + status = WSAWaitForMultipleEvents( + (DWORD) wes->n_events, + wes->events, + FALSE, + (DWORD) timeout, + FALSE); + + if (outlen >= 1 && status >= WSA_WAIT_EVENT_0 && status < WSA_WAIT_EVENT_0 + (DWORD) wes->n_events) + { + *out = wes->esr[status - WSA_WAIT_EVENT_0]; + dmsg (D_EVENT_WAIT, "WE_WAIT leave rwflags=0x%04x arg=" ptr_format, + out->rwflags, (ptr_type)out->arg); + return 1; + } + else if (status == WSA_WAIT_TIMEOUT) + return 0; + else + return -1; + } +} + +static struct event_set * +we_init (int *maxevents, unsigned int flags) +{ + struct we_set *wes; + + dmsg (D_EVENT_WAIT, "WE_INIT maxevents=%d flags=0x%08x", *maxevents, flags); + + ALLOC_OBJ_CLEAR (wes, struct we_set); + + /* set dispatch functions */ + wes->func.free = we_free; + wes->func.reset = we_reset; + wes->func.del = we_del; + wes->func.ctl = we_ctl; + wes->func.wait = we_wait; + + if (flags & EVENT_METHOD_FAST) + wes->fast = true; + wes->n_events = 0; + + /* Figure our event capacity */ + ASSERT (*maxevents > 0); + wes->capacity = min_int (*maxevents * 2, WSA_MAXIMUM_WAIT_EVENTS); + *maxevents = min_int (*maxevents, WSA_MAXIMUM_WAIT_EVENTS); + + /* Allocate space for Win32 event handles */ + ALLOC_ARRAY_CLEAR (wes->events, HANDLE, wes->capacity); + + /* Allocate space for event_set_return objects */ + ALLOC_ARRAY_CLEAR (wes->esr, struct event_set_return, wes->capacity); + + dmsg (D_EVENT_WAIT, "WE_INIT maxevents=%d capacity=%d", + *maxevents, wes->capacity); + + return (struct event_set *) wes; +} + +#endif /* WIN32 */ + +#if EPOLL + +struct ep_set +{ + struct event_set_functions func; + bool fast; + int epfd; + int maxevents; + struct epoll_event *events; +}; + +static void +ep_free (struct event_set *es) +{ + struct ep_set *eps = (struct ep_set *) es; + close (eps->epfd); + free (eps->events); + free (eps); +} + +static void +ep_reset (struct event_set *es) +{ + const struct ep_set *eps = (struct ep_set *) es; + ASSERT (eps->fast); +} + +static void +ep_del (struct event_set *es, event_t event) +{ + struct epoll_event ev; + struct ep_set *eps = (struct ep_set *) es; + + dmsg (D_EVENT_WAIT, "EP_DEL ev=%d", (int)event); + + ASSERT (!eps->fast); + CLEAR (ev); + epoll_ctl (eps->epfd, EPOLL_CTL_DEL, event, &ev); +} + +static void +ep_ctl (struct event_set *es, event_t event, unsigned int rwflags, void *arg) +{ + struct ep_set *eps = (struct ep_set *) es; + struct epoll_event ev; + + CLEAR (ev); + + ev.data.ptr = arg; + if (rwflags & EVENT_READ) + ev.events |= EPOLLIN; + if (rwflags & EVENT_WRITE) + ev.events |= EPOLLOUT; + + dmsg (D_EVENT_WAIT, "EP_CTL fd=%d rwflags=0x%04x ev=0x%08x arg=" ptr_format, + (int)event, + rwflags, + (unsigned int)ev.events, + (ptr_type)ev.data.ptr); + + if (epoll_ctl (eps->epfd, EPOLL_CTL_MOD, event, &ev) < 0) + { + if (errno == ENOENT) + { + if (epoll_ctl (eps->epfd, EPOLL_CTL_ADD, event, &ev) < 0) + msg (M_ERR, "EVENT: epoll_ctl EPOLL_CTL_ADD failed"); + } + else + msg (M_ERR, "EVENT: epoll_ctl EPOLL_CTL_MOD failed"); + } +} + +static int +ep_wait (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen) +{ + struct ep_set *eps = (struct ep_set *) es; + int stat; + + if (outlen > eps->maxevents) + outlen = eps->maxevents; + + stat = epoll_wait (eps->epfd, eps->events, outlen, tv_to_ms_timeout (tv)); + ASSERT (stat <= outlen); + + if (stat > 0) + { + int i; + const struct epoll_event *ev = eps->events; + struct event_set_return *esr = out; + for (i = 0; i < stat; ++i) + { + esr->rwflags = 0; + if (ev->events & (EPOLLIN|EPOLLPRI|EPOLLERR)) + esr->rwflags |= EVENT_READ; + if (ev->events & EPOLLOUT) + esr->rwflags |= EVENT_WRITE; + esr->arg = ev->data.ptr; + dmsg (D_EVENT_WAIT, "EP_WAIT[%d] rwflags=0x%04x ev=0x%08x arg=" ptr_format, + i, esr->rwflags, ev->events, (ptr_type)ev->data.ptr); + ++ev; + ++esr; + } + } + return stat; +} + +static struct event_set * +ep_init (int *maxevents, unsigned int flags) +{ + struct ep_set *eps; + int fd; + + dmsg (D_EVENT_WAIT, "EP_INIT maxevents=%d flags=0x%08x", *maxevents, flags); + + /* open epoll file descriptor */ + fd = epoll_create (*maxevents); + if (fd < 0) + return NULL; + + ALLOC_OBJ_CLEAR (eps, struct ep_set); + + /* set dispatch functions */ + eps->func.free = ep_free; + eps->func.reset = ep_reset; + eps->func.del = ep_del; + eps->func.ctl = ep_ctl; + eps->func.wait = ep_wait; + + /* fast method ("sort of") corresponds to epoll one-shot */ + if (flags & EVENT_METHOD_FAST) + eps->fast = true; + + /* allocate space for epoll_wait return */ + ASSERT (*maxevents > 0); + eps->maxevents = *maxevents; + ALLOC_ARRAY_CLEAR (eps->events, struct epoll_event, eps->maxevents); + + /* set epoll control fd */ + eps->epfd = fd; + + return (struct event_set *) eps; +} +#endif /* EPOLL */ + +#if POLL + +struct po_set +{ + struct event_set_functions func; + bool fast; + struct pollfd *events; + void **args; + int n_events; + int capacity; +}; + +static void +po_free (struct event_set *es) +{ + struct po_set *pos = (struct po_set *) es; + free (pos->events); + free (pos->args); + free (pos); +} + +static void +po_reset (struct event_set *es) +{ + struct po_set *pos = (struct po_set *) es; + ASSERT (pos->fast); + pos->n_events = 0; +} + +static void +po_del (struct event_set *es, event_t event) +{ + struct po_set *pos = (struct po_set *) es; + int i; + + dmsg (D_EVENT_WAIT, "PO_DEL ev=%d", (int)event); + + ASSERT (!pos->fast); + for (i = 0; i < pos->n_events; ++i) + { + if (pos->events[i].fd == event) + { + int j; + for (j = i; j < pos->n_events - 1; ++j) + { + pos->events[j] = pos->events[j+1]; + pos->args[j] = pos->args[j+1]; + } + --pos->n_events; + break; + } + } +} + +static inline void +po_set_pollfd_events (struct pollfd *pfdp, unsigned int rwflags) +{ + pfdp->events = 0; + if (rwflags & EVENT_WRITE) + pfdp->events |= POLLOUT; + if (rwflags & EVENT_READ) + pfdp->events |= (POLLIN|POLLPRI); +} + +static inline bool +po_append_event (struct po_set *pos, event_t event, unsigned int rwflags, void *arg) +{ + if (pos->n_events < pos->capacity) + { + struct pollfd *pfdp = &pos->events[pos->n_events]; + pfdp->fd = event; + pos->args[pos->n_events] = arg; + po_set_pollfd_events (pfdp, rwflags); + ++pos->n_events; + return true; + } + else + return false; +} + +static void +po_ctl (struct event_set *es, event_t event, unsigned int rwflags, void *arg) +{ + struct po_set *pos = (struct po_set *) es; + + dmsg (D_EVENT_WAIT, "PO_CTL rwflags=0x%04x ev=%d arg=" ptr_format, + rwflags, (int)event, (ptr_type)arg); + + if (pos->fast) + { + if (!po_append_event (pos, event, rwflags, arg)) + goto err; + } + else + { + int i; + for (i = 0; i < pos->n_events; ++i) + { + struct pollfd *pfdp = &pos->events[i]; + if (pfdp->fd == event) + { + pos->args[i] = arg; + po_set_pollfd_events (pfdp, rwflags); + goto done; + } + } + if (!po_append_event (pos, event, rwflags, arg)) + goto err; + } + + done: + return; + + err: + msg (D_EVENT_ERRORS, "Error: poll: too many I/O wait events"); +} + +static int +po_wait (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen) +{ + struct po_set *pos = (struct po_set *) es; + int stat; + + stat = poll (pos->events, pos->n_events, tv_to_ms_timeout (tv)); + + ASSERT (stat <= pos->n_events); + + if (stat > 0) + { + int i, j=0; + const struct pollfd *pfdp = pos->events; + for (i = 0; i < pos->n_events && j < outlen; ++i) + { + if (pfdp->revents & (POLLIN|POLLPRI|POLLERR|POLLHUP|POLLOUT)) + { + out->rwflags = 0; + if (pfdp->revents & (POLLIN|POLLPRI|POLLERR|POLLHUP)) + out->rwflags |= EVENT_READ; + if (pfdp->revents & POLLOUT) + out->rwflags |= EVENT_WRITE; + out->arg = pos->args[i]; + dmsg (D_EVENT_WAIT, "PO_WAIT[%d,%d] fd=%d rev=0x%08x rwflags=0x%04x arg=" ptr_format " %s", + i, j, pfdp->fd, pfdp->revents, out->rwflags, (ptr_type)out->arg, pos->fast ? "" : "[scalable]"); + ++out; + ++j; + } + else if (pfdp->revents) + { + msg (D_EVENT_ERRORS, "Error: poll: unknown revents=0x%04x", (unsigned int)pfdp->revents); + } + ++pfdp; + } + return j; + } + return stat; +} + +static struct event_set * +po_init (int *maxevents, unsigned int flags) +{ + struct po_set *pos; + + dmsg (D_EVENT_WAIT, "PO_INIT maxevents=%d flags=0x%08x", *maxevents, flags); + + ALLOC_OBJ_CLEAR (pos, struct po_set); + + /* set dispatch functions */ + pos->func.free = po_free; + pos->func.reset = po_reset; + pos->func.del = po_del; + pos->func.ctl = po_ctl; + pos->func.wait = po_wait; + + if (flags & EVENT_METHOD_FAST) + pos->fast = true; + + pos->n_events = 0; + + /* Figure our event capacity */ + ASSERT (*maxevents > 0); + pos->capacity = *maxevents; + + /* Allocate space for pollfd structures to be passed to poll() */ + ALLOC_ARRAY_CLEAR (pos->events, struct pollfd, pos->capacity); + + /* Allocate space for event_set_return objects */ + ALLOC_ARRAY_CLEAR (pos->args, void *, pos->capacity); + + return (struct event_set *) pos; +} +#endif /* POLL */ + +#if SELECT + +struct se_set +{ + struct event_set_functions func; + bool fast; + fd_set readfds; + fd_set writefds; + void **args; /* allocated to capacity size */ + int maxfd; /* largest fd seen so far, always < capacity */ + int capacity; /* fixed largest fd + 1 */ +}; + +static void +se_free (struct event_set *es) +{ + struct se_set *ses = (struct se_set *) es; + free (ses->args); + free (ses); +} + +static void +se_reset (struct event_set *es) +{ + struct se_set *ses = (struct se_set *) es; + int i; + ASSERT (ses->fast); + + dmsg (D_EVENT_WAIT, "SE_RESET"); + + FD_ZERO (&ses->readfds); + FD_ZERO (&ses->writefds); + for (i = 0; i <= ses->maxfd; ++i) + ses->args[i] = NULL; + ses->maxfd = -1; +} + +static void +se_del (struct event_set *es, event_t event) +{ + struct se_set *ses = (struct se_set *) es; + ASSERT (!ses->fast); + + dmsg (D_EVENT_WAIT, "SE_DEL ev=%d", (int)event); + + if (event >= 0 && event < ses->capacity) + { + FD_CLR (event, &ses->readfds); + FD_CLR (event, &ses->writefds); + ses->args[event] = NULL; + } + else + msg (D_EVENT_ERRORS, "Error: select/se_del: too many I/O wait events"); + return; +} + +static void +se_ctl (struct event_set *es, event_t event, unsigned int rwflags, void *arg) +{ + struct se_set *ses = (struct se_set *) es; + + dmsg (D_EVENT_WAIT, "SE_CTL rwflags=0x%04x ev=%d fast=%d cap=%d maxfd=%d arg=" ptr_format, + rwflags, (int)event, (int)ses->fast, ses->capacity, ses->maxfd, (ptr_type)arg); + + if (event >= 0 && event < ses->capacity) + { + ses->maxfd = max_int (event, ses->maxfd); + ses->args[event] = arg; + if (ses->fast) + { + if (rwflags & EVENT_READ) + FD_SET (event, &ses->readfds); + if (rwflags & EVENT_WRITE) + FD_SET (event, &ses->writefds); + } + else + { + if (rwflags & EVENT_READ) + FD_SET (event, &ses->readfds); + else + FD_CLR (event, &ses->readfds); + if (rwflags & EVENT_WRITE) + FD_SET (event, &ses->writefds); + else + FD_CLR (event, &ses->writefds); + } + } + else + { + msg (D_EVENT_ERRORS, "Error: select: too many I/O wait events, fd=%d cap=%d", + (int) event, + ses->capacity); + } +} + +static int +se_wait_return (struct se_set *ses, + fd_set *read, + fd_set *write, + struct event_set_return *out, + int outlen) +{ + int i, j = 0; + for (i = 0; i <= ses->maxfd && j < outlen; ++i) + { + const bool r = FD_ISSET (i, read); + const bool w = FD_ISSET (i, write); + if (r || w) + { + out->rwflags = 0; + if (r) + out->rwflags |= EVENT_READ; + if (w) + out->rwflags |= EVENT_WRITE; + out->arg = ses->args[i]; + dmsg (D_EVENT_WAIT, "SE_WAIT[%d,%d] rwflags=0x%04x arg=" ptr_format, + i, j, out->rwflags, (ptr_type)out->arg); + ++out; + ++j; + } + } + return j; +} + +static int +se_wait_fast (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen) +{ + struct se_set *ses = (struct se_set *) es; + struct timeval tv_tmp = *tv; + int stat; + + dmsg (D_EVENT_WAIT, "SE_WAIT_FAST maxfd=%d tv=%d/%d", + ses->maxfd, + (int)tv_tmp.tv_sec, + (int)tv_tmp.tv_usec); + + stat = select (ses->maxfd + 1, &ses->readfds, &ses->writefds, NULL, &tv_tmp); + + if (stat > 0) + stat = se_wait_return (ses, &ses->readfds, &ses->writefds, out, outlen); + + return stat; +} + +static int +se_wait_scalable (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen) +{ + struct se_set *ses = (struct se_set *) es; + struct timeval tv_tmp = *tv; + fd_set read = ses->readfds; + fd_set write = ses->writefds; + int stat; + + dmsg (D_EVENT_WAIT, "SE_WAIT_SCALEABLE maxfd=%d tv=%d/%d", + ses->maxfd, (int)tv_tmp.tv_sec, (int)tv_tmp.tv_usec); + + stat = select (ses->maxfd + 1, &read, &write, NULL, &tv_tmp); + + if (stat > 0) + stat = se_wait_return (ses, &read, &write, out, outlen); + + return stat; +} + +static struct event_set * +se_init (int *maxevents, unsigned int flags) +{ + struct se_set *ses; + + dmsg (D_EVENT_WAIT, "SE_INIT maxevents=%d flags=0x%08x", *maxevents, flags); + + ALLOC_OBJ_CLEAR (ses, struct se_set); + + /* set dispatch functions */ + ses->func.free = se_free; + ses->func.reset = se_reset; + ses->func.del = se_del; + ses->func.ctl = se_ctl; + ses->func.wait = se_wait_scalable; + + if (flags & EVENT_METHOD_FAST) + { + ses->fast = true; + ses->func.wait = se_wait_fast; + } + + /* Select needs to be passed this value + 1 */ + ses->maxfd = -1; + + /* Set our event capacity */ + ASSERT (*maxevents > 0); + *maxevents = min_int (*maxevents, SELECT_MAX_FDS); + ses->capacity = SELECT_MAX_FDS; + + /* Allocate space for event_set_return void * args */ + ALLOC_ARRAY_CLEAR (ses->args, void *, ses->capacity); + + return (struct event_set *) ses; +} +#endif /* SELECT */ + +static struct event_set * +event_set_init_simple (int *maxevents, unsigned int flags) +{ + struct event_set *ret = NULL; +#ifdef WIN32 + ret = we_init (maxevents, flags); +#elif POLL && SELECT +#if 0 /* Define to 1 if EVENT_METHOD_US_TIMEOUT should cause select to be favored over poll */ + if (flags & EVENT_METHOD_US_TIMEOUT) + ret = se_init (maxevents, flags); +#endif +# ifdef SELECT_PREFERRED_OVER_POLL + if (!ret) + ret = se_init (maxevents, flags); + if (!ret) + ret = po_init (maxevents, flags); +# else + if (!ret) + ret = po_init (maxevents, flags); + if (!ret) + ret = se_init (maxevents, flags); +# endif +#elif POLL + ret = po_init (maxevents, flags); +#elif SELECT + ret = se_init (maxevents, flags); +#else +#error At least one of poll, select, or WSAWaitForMultipleEvents must be supported by the kernel +#endif + ASSERT (ret); + return ret; +} + +static struct event_set * +event_set_init_scalable (int *maxevents, unsigned int flags) +{ + struct event_set *ret = NULL; +#if EPOLL + ret = ep_init (maxevents, flags); + if (!ret) + { + msg (M_WARN, "Note: sys_epoll API is unavailable, falling back to poll/select API"); + ret = event_set_init_simple (maxevents, flags); + } +#else + ret = event_set_init_simple (maxevents, flags); +#endif + ASSERT (ret); + return ret; +} + +struct event_set * +event_set_init (int *maxevents, unsigned int flags) +{ + if (flags & EVENT_METHOD_FAST) + return event_set_init_simple (maxevents, flags); + else + return event_set_init_scalable (maxevents, flags); +} @@ -0,0 +1,157 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef EVENT_H +#define EVENT_H + +#include "win32.h" +#include "sig.h" +#include "perf.h" + +/* + * rwflags passed to event_ctl and returned by + * struct event_set_return. + */ +#define EVENT_READ (1<<0) +#define EVENT_WRITE (1<<1) + +/* + * Initialization flags passed to event_set_init + */ +#define EVENT_METHOD_US_TIMEOUT (1<<0) +#define EVENT_METHOD_FAST (1<<1) + +#ifdef WIN32 + +typedef const struct rw_handle *event_t; + +#define UNDEFINED_EVENT (NULL) + +#else + +typedef int event_t; + +#define UNDEFINED_EVENT (-1) + +#endif + +struct event_set; +struct event_set_return; + +struct event_set_functions +{ + void (*free)(struct event_set *es); + void (*reset)(struct event_set *es); + void (*del)(struct event_set *es, event_t event); + void (*ctl)(struct event_set *es, event_t event, unsigned int rwflags, void *arg); + + /* + * Return status for wait: + * -1 on signal or error + * 0 on timeout + * length of event_set_return if at least 1 event is returned + */ + int (*wait)(struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen); +}; + +struct event_set_return +{ + unsigned int rwflags; + void *arg; +}; + +struct event_set +{ + struct event_set_functions func; +}; + +/* + * maxevents on input: desired max number of event_t descriptors + * simultaneously set with event_ctl + * maxevents on output: may be modified down, depending on limitations + * of underlying API + * flags: EVENT_METHOD_x flags + */ +struct event_set *event_set_init (int *maxevents, unsigned int flags); + +static inline void +event_free (struct event_set *es) +{ + (*es->func.free)(es); +} + +static inline void +event_reset (struct event_set *es) +{ + (*es->func.reset)(es); +} + +static inline void +event_del (struct event_set *es, event_t event) +{ + (*es->func.del)(es, event); +} + +static inline void +event_ctl (struct event_set *es, event_t event, unsigned int rwflags, void *arg) +{ + (*es->func.ctl)(es, event, rwflags, arg); +} + +static inline int +event_wait (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen) +{ + int ret; + perf_push (PERF_IO_WAIT); + ret = (*es->func.wait)(es, tv, out, outlen); + perf_pop (); + return ret; +} + +static inline void +event_set_return_init (struct event_set_return *esr) +{ + esr->rwflags = 0; + esr->arg = NULL; +} + +#ifdef WIN32 + +static inline void +wait_signal (struct event_set *es, void *arg) +{ + if (HANDLE_DEFINED (win32_signal.in.read)) + event_ctl (es, &win32_signal.in, EVENT_READ, arg); +} + +#else + +static inline void +wait_signal (struct event_set *es, void *arg) +{ +} + +#endif + +#endif diff --git a/fdmisc.c b/fdmisc.c new file mode 100644 index 0000000..8c8b91e --- /dev/null +++ b/fdmisc.c @@ -0,0 +1,60 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "fdmisc.h" +#include "error.h" + +#include "memdbg.h" + +/* Set a file descriptor to non-blocking */ +void +set_nonblock (int fd) +{ +#ifdef WIN32 + u_long arg = 1; + if (ioctlsocket (fd, FIONBIO, &arg)) + msg (M_SOCKERR, "Set socket to non-blocking mode failed"); +#else + if (fcntl (fd, F_SETFL, O_NONBLOCK) < 0) + msg (M_ERR, "Set file descriptor to non-blocking mode failed"); +#endif +} + +/* Set a file descriptor to not be passed across execs */ +void +set_cloexec (int fd) +{ +#ifndef WIN32 + if (fcntl (fd, F_SETFD, FD_CLOEXEC) < 0) + msg (M_ERR, "Set FD_CLOEXEC flag on file descriptor failed"); +#endif +} diff --git a/fdmisc.h b/fdmisc.h new file mode 100644 index 0000000..5019cc2 --- /dev/null +++ b/fdmisc.h @@ -0,0 +1,26 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +void set_nonblock (int fd); +void set_cloexec (int fd); diff --git a/forward-inline.h b/forward-inline.h new file mode 100644 index 0000000..0ba0b23 --- /dev/null +++ b/forward-inline.h @@ -0,0 +1,276 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef FORWARD_INLINE_H +#define FORWARD_INLINE_H + +/* + * Inline functions + */ + +/* + * Does TLS session need service? + */ +static inline void +check_tls (struct context *c) +{ +#if defined(USE_CRYPTO) && defined(USE_SSL) + void check_tls_dowork (struct context *c); + if (c->c2.tls_multi) + check_tls_dowork (c); +#endif +} + +/* + * TLS errors are fatal in TCP mode. + * Also check for --tls-exit trigger. + */ +static inline void +check_tls_errors (struct context *c) +{ +#if defined(USE_CRYPTO) && defined(USE_SSL) + void check_tls_errors_co (struct context *c); + void check_tls_errors_nco (struct context *c); + if (c->c2.tls_multi && c->c2.tls_exit_signal) + { + if (link_socket_connection_oriented (c->c2.link_socket)) + { + if (c->c2.tls_multi->n_soft_errors) + check_tls_errors_co (c); + } + else + { + if (c->c2.tls_multi->n_hard_errors) + check_tls_errors_nco (c); + } + } +#endif +} + +/* + * Check for possible incoming configuration + * messages on the control channel. + */ +static inline void +check_incoming_control_channel (struct context *c) +{ +#if P2MP + void check_incoming_control_channel_dowork (struct context *c); + if (tls_test_payload_len (c->c2.tls_multi) > 0) + check_incoming_control_channel_dowork (c); +#endif +} + +/* + * Options like --up-delay need to be triggered by this function which + * checks for connection establishment. + */ +static inline void +check_connection_established (struct context *c) +{ + void check_connection_established_dowork (struct context *c); + if (event_timeout_defined (&c->c2.wait_for_connect)) + check_connection_established_dowork (c); +} + +/* + * Should we add routes? + */ +static inline void +check_add_routes (struct context *c) +{ + void check_add_routes_dowork (struct context *c); + if (event_timeout_trigger (&c->c2.route_wakeup, &c->c2.timeval, ETT_DEFAULT)) + check_add_routes_dowork (c); +} + +/* + * Should we exit due to inactivity timeout? + */ +static inline void +check_inactivity_timeout (struct context *c) +{ + void check_inactivity_timeout_dowork (struct context *c); + + if (c->options.inactivity_timeout + && event_timeout_trigger (&c->c2.inactivity_interval, &c->c2.timeval, ETT_DEFAULT)) + check_inactivity_timeout_dowork (c); +} + +#if P2MP +/* + * Scheduled exit? + */ +static inline void +check_scheduled_exit (struct context *c) +{ + void check_scheduled_exit_dowork (struct context *c); + + if (event_timeout_defined (&c->c2.scheduled_exit)) + { + if (event_timeout_trigger (&c->c2.scheduled_exit, &c->c2.timeval, ETT_DEFAULT)) + check_scheduled_exit_dowork (c); + } +} +#endif + +/* + * Should we write timer-triggered status file. + */ +static inline void +check_status_file (struct context *c) +{ + void check_status_file_dowork (struct context *c); + + if (c->c1.status_output) + { + if (status_trigger_tv (c->c1.status_output, &c->c2.timeval)) + check_status_file_dowork (c); + } +} + +#ifdef ENABLE_FRAGMENT +/* + * Should we deliver a datagram fragment to remote? + */ +static inline void +check_fragment (struct context *c) +{ + void check_fragment_dowork (struct context *c); + if (c->c2.fragment) + check_fragment_dowork (c); +} +#endif + +#if P2MP + +/* + * see if we should send a push_request in response to --pull + */ +static inline void +check_push_request (struct context *c) +{ + void check_push_request_dowork (struct context *c); + if (event_timeout_trigger (&c->c2.push_request_interval, &c->c2.timeval, ETT_DEFAULT)) + check_push_request_dowork (c); +} + +#endif + +#ifdef USE_CRYPTO +/* + * Should we persist our anti-replay packet ID state to disk? + */ +static inline void +check_packet_id_persist_flush (struct context *c) +{ + if (packet_id_persist_enabled (&c->c1.pid_persist) + && event_timeout_trigger (&c->c2.packet_id_persist_interval, &c->c2.timeval, ETT_DEFAULT)) + packet_id_persist_save (&c->c1.pid_persist); +} +#endif + +/* + * Set our wakeup to 0 seconds, so we will be rescheduled + * immediately. + */ +static inline void +context_immediate_reschedule (struct context *c) +{ + c->c2.timeval.tv_sec = 0; /* ZERO-TIMEOUT */ + c->c2.timeval.tv_usec = 0; +} + +static inline void +context_reschedule_sec (struct context *c, int sec) +{ + if (sec < 0) + sec = 0; + if (sec < c->c2.timeval.tv_sec) + { + c->c2.timeval.tv_sec = sec; + c->c2.timeval.tv_usec = 0; + } +} + +static inline struct link_socket_info * +get_link_socket_info (struct context *c) +{ + if (c->c2.link_socket_info) + return c->c2.link_socket_info; + else + return &c->c2.link_socket->info; +} + +static inline void +register_activity (struct context *c) +{ + if (c->options.inactivity_timeout) + event_timeout_reset (&c->c2.inactivity_interval); +} + +/* + * Return the io_wait() flags appropriate for + * a point-to-point tunnel. + */ +static inline unsigned int +p2p_iow_flags (const struct context *c) +{ + unsigned int flags = (IOW_SHAPER|IOW_CHECK_RESIDUAL|IOW_FRAG|IOW_READ|IOW_WAIT_SIGNAL); + if (c->c2.to_link.len > 0) + flags |= IOW_TO_LINK; + if (c->c2.to_tun.len > 0) + flags |= IOW_TO_TUN; + return flags; +} + +/* + * This is the core I/O wait function, used for all I/O waits except + * for TCP in server mode. + */ +static inline void +io_wait (struct context *c, const unsigned int flags) +{ + void io_wait_dowork (struct context *c, const unsigned int flags); + + if (c->c2.fast_io && (flags & (IOW_TO_TUN|IOW_TO_LINK|IOW_MBUF))) + { + /* fast path -- only for TUN/TAP/UDP writes */ + unsigned int ret = 0; + if (flags & IOW_TO_TUN) + ret |= TUN_WRITE; + if (flags & (IOW_TO_LINK|IOW_MBUF)) + ret |= SOCKET_WRITE; + c->c2.event_set_status = ret; + } + else + { + /* slow path */ + io_wait_dowork (c, flags); + } +} + +#define CONNECTION_ESTABLISHED(c) (get_link_socket_info(c)->connection_established) + +#endif /* EVENT_INLINE_H */ diff --git a/forward.c b/forward.c new file mode 100644 index 0000000..4c0aff8 --- /dev/null +++ b/forward.c @@ -0,0 +1,1402 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "forward.h" +#include "init.h" +#include "push.h" +#include "gremlin.h" +#include "mss.h" +#include "event.h" + +#include "memdbg.h" + +#include "forward-inline.h" +#include "occ-inline.h" +#include "ping-inline.h" + +/* show event wait debugging info */ + +#ifdef ENABLE_DEBUG + +const char * +wait_status_string (struct context *c, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + buf_printf (&out, "I/O WAIT %s|%s|%s|%s %s", + tun_stat (c->c1.tuntap, EVENT_READ, gc), + tun_stat (c->c1.tuntap, EVENT_WRITE, gc), + socket_stat (c->c2.link_socket, EVENT_READ, gc), + socket_stat (c->c2.link_socket, EVENT_WRITE, gc), + tv_string (&c->c2.timeval, gc)); + return BSTR (&out); +} + +void +show_wait_status (struct context *c) +{ + struct gc_arena gc = gc_new (); + dmsg (D_EVENT_WAIT, "%s", wait_status_string (c, &gc)); + gc_free (&gc); +} + +#endif + +/* + * In TLS mode, let TLS level respond to any control-channel + * packets which were received, or prepare any packets for + * transmission. + * + * tmp_int is purely an optimization that allows us to call + * tls_multi_process less frequently when there's not much + * traffic on the control-channel. + * + */ +#if defined(USE_CRYPTO) && defined(USE_SSL) +void +check_tls_dowork (struct context *c) +{ + interval_t wakeup = BIG_TIMEOUT; + + if (interval_test (&c->c2.tmp_int)) + { + if (tls_multi_process + (c->c2.tls_multi, &c->c2.to_link, &c->c2.to_link_addr, + get_link_socket_info (c), &wakeup)) + { + update_time (); + interval_action (&c->c2.tmp_int); + } + + interval_future_trigger (&c->c2.tmp_int, wakeup); + } + + interval_schedule_wakeup (&c->c2.tmp_int, &wakeup); + + if (wakeup) + context_reschedule_sec (c, wakeup); +} +#endif + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +void +check_tls_errors_co (struct context *c) +{ + msg (D_STREAM_ERRORS, "Fatal TLS error (check_tls_errors_co), restarting"); + c->sig->signal_received = c->c2.tls_exit_signal; /* SOFT-SIGUSR1 -- TLS error */ + c->sig->signal_text = "tls-error"; +} + +void +check_tls_errors_nco (struct context *c) +{ + c->sig->signal_received = c->c2.tls_exit_signal; /* SOFT-SIGUSR1 -- TLS error */ + c->sig->signal_text = "tls-error"; +} + +#endif + +#if P2MP + +/* + * Handle incoming configuration + * messages on the control channel. + */ +void +check_incoming_control_channel_dowork (struct context *c) +{ + const int len = tls_test_payload_len (c->c2.tls_multi); + if (len) + { + struct gc_arena gc = gc_new (); + struct buffer buf = alloc_buf_gc (len, &gc); + if (tls_rec_payload (c->c2.tls_multi, &buf)) + { + /* force null termination of message */ + buf_null_terminate (&buf); + + /* enforce character class restrictions */ + string_mod (BSTR (&buf), CC_PRINT, CC_CRLF, 0); + + if (buf_string_match_head_str (&buf, "AUTH_FAILED")) + receive_auth_failed (c, &buf); + else if (buf_string_match_head_str (&buf, "PUSH_")) + incoming_push_message (c, &buf); + else + msg (D_PUSH_ERRORS, "WARNING: Received unknown control message: %s", BSTR (&buf)); + } + else + { + msg (D_PUSH_ERRORS, "WARNING: Receive control message failed"); + } + + gc_free (&gc); + } +} + +/* + * Periodically resend PUSH_REQUEST until PUSH message received + */ +void +check_push_request_dowork (struct context *c) +{ + send_push_request (c); +} + +#endif + +/* + * Things that need to happen immediately after connection initiation should go here. + */ +void +check_connection_established_dowork (struct context *c) +{ + if (event_timeout_trigger (&c->c2.wait_for_connect, &c->c2.timeval, ETT_DEFAULT)) + { + if (CONNECTION_ESTABLISHED (c)) + { +#if P2MP + /* if --pull was specified, send a push request to server */ + if (c->c2.tls_multi && c->options.pull) + { +#ifdef ENABLE_MANAGEMENT + if (management) + { + management_set_state (management, + OPENVPN_STATE_GET_CONFIG, + NULL, + 0); + } +#endif + send_push_request (c); + + /* if no reply, try again in 5 sec */ + event_timeout_init (&c->c2.push_request_interval, 5, now); + reset_coarse_timers (c); + } + else +#endif + { + do_up (c, false, 0); + } + + event_timeout_clear (&c->c2.wait_for_connect); + } + } +} + +/* + * Send a string to remote over the TLS control channel. + * Used for push/pull messages, passing username/password, + * etc. + */ +bool +send_control_channel_string (struct context *c, const char *str, int msglevel) +{ +#if defined(USE_CRYPTO) && defined(USE_SSL) + + if (c->c2.tls_multi) { + bool stat; + + /* buffered cleartext write onto TLS control channel */ + stat = tls_send_payload (c->c2.tls_multi, (uint8_t*) str, strlen (str) + 1); + + /* reschedule tls_multi_process */ + interval_action (&c->c2.tmp_int); + context_immediate_reschedule (c); /* ZERO-TIMEOUT */ + + msg (msglevel, "SENT CONTROL [%s]: '%s' (status=%d)", + tls_common_name (c->c2.tls_multi, false), + str, + (int) stat); + + return stat; + } +#endif + return true; +} + +/* + * Add routes. + */ + +static void +check_add_routes_action (struct context *c, const bool errors) +{ + do_route (&c->options, c->c1.route_list, c->c1.tuntap, c->c1.plugins, c->c2.es); + update_time (); + event_timeout_clear (&c->c2.route_wakeup); + event_timeout_clear (&c->c2.route_wakeup_expire); + initialization_sequence_completed (c, errors ? ISC_ERRORS : 0); /* client/p2p --route-delay was defined */ +} + +void +check_add_routes_dowork (struct context *c) +{ + if (test_routes (c->c1.route_list, c->c1.tuntap)) + { + check_add_routes_action (c, false); + } + else if (event_timeout_trigger (&c->c2.route_wakeup_expire, &c->c2.timeval, ETT_DEFAULT)) + { + check_add_routes_action (c, true); + } + else + { + msg (D_ROUTE, "Route: Waiting for TUN/TAP interface to come up..."); + if (c->c2.route_wakeup.n != 1) + event_timeout_init (&c->c2.route_wakeup, 1, now); + } +} + +/* + * Should we exit due to inactivity timeout? + */ +void +check_inactivity_timeout_dowork (struct context *c) +{ + msg (M_INFO, "Inactivity timeout (--inactive), exiting"); + c->sig->signal_received = SIGTERM; + c->sig->signal_text = "inactive"; +} + +#if P2MP + +/* + * Schedule a SIGTERM n_seconds from now. + */ +void +schedule_exit (struct context *c, const int n_seconds) +{ + update_time (); + reset_coarse_timers (c); + event_timeout_init (&c->c2.scheduled_exit, n_seconds, now); + msg (D_SCHED_EXIT, "Delayed exit in %d seconds", n_seconds); +} + +/* + * Scheduled exit? + */ +void +check_scheduled_exit_dowork (struct context *c) +{ + c->sig->signal_received = SIGTERM; + c->sig->signal_text = "delayed-exit"; +} + +#endif + +/* + * Should we write timer-triggered status file. + */ +void +check_status_file_dowork (struct context *c) +{ + if (c->c1.status_output) + print_status (c, c->c1.status_output); +} + +#ifdef ENABLE_FRAGMENT +/* + * Should we deliver a datagram fragment to remote? + */ +void +check_fragment_dowork (struct context *c) +{ + struct link_socket_info *lsi = get_link_socket_info (c); + + /* OS MTU Hint? */ + if (lsi->mtu_changed && c->c2.ipv4_tun) + { + frame_adjust_path_mtu (&c->c2.frame_fragment, c->c2.link_socket->mtu, + c->options.proto); + lsi->mtu_changed = false; + } + + if (fragment_outgoing_defined (c->c2.fragment)) + { + if (!c->c2.to_link.len) + { + /* encrypt a fragment for output to TCP/UDP port */ + ASSERT (fragment_ready_to_send (c->c2.fragment, &c->c2.buf, &c->c2.frame_fragment)); + encrypt_sign (c, false); + } + } + + fragment_housekeeping (c->c2.fragment, &c->c2.frame_fragment, &c->c2.timeval); +} +#endif + +/* + * Buffer reallocation, for use with null encryption. + */ +static inline void +buffer_turnover (const uint8_t *orig_buf, struct buffer *dest_stub, struct buffer *src_stub, struct buffer *storage) +{ + if (orig_buf == src_stub->data && src_stub->data != storage->data) + { + buf_assign (storage, src_stub); + *dest_stub = *storage; + } + else + { + *dest_stub = *src_stub; + } +} + +/* + * Compress, fragment, encrypt and HMAC-sign an outgoing packet. + * Input: c->c2.buf + * Output: c->c2.to_link + */ +void +encrypt_sign (struct context *c, bool comp_frag) +{ + struct context_buffers *b = c->c2.buffers; + const uint8_t *orig_buf = c->c2.buf.data; + +#if P2MP_SERVER + /* + * Drop non-TLS outgoing packet if client-connect script/plugin + * has not yet succeeded. + */ + if (c->c2.context_auth != CAS_SUCCEEDED) + c->c2.buf.len = 0; +#endif + + if (comp_frag) + { +#ifdef USE_LZO + /* Compress the packet. */ + if (c->options.comp_lzo) + lzo_compress (&c->c2.buf, b->lzo_compress_buf, &c->c2.lzo_compwork, &c->c2.frame); +#endif +#ifdef ENABLE_FRAGMENT + if (c->c2.fragment) + fragment_outgoing (c->c2.fragment, &c->c2.buf, &c->c2.frame_fragment); +#endif + } + +#ifdef USE_CRYPTO +#ifdef USE_SSL + /* + * If TLS mode, get the key we will use to encrypt + * the packet. + */ + if (c->c2.tls_multi) + { + /*tls_mutex_lock (c->c2.tls_multi);*/ + tls_pre_encrypt (c->c2.tls_multi, &c->c2.buf, &c->c2.crypto_options); + } +#endif + + /* + * Encrypt the packet and write an optional + * HMAC signature. + */ + openvpn_encrypt (&c->c2.buf, b->encrypt_buf, &c->c2.crypto_options, &c->c2.frame); +#endif + /* + * Get the address we will be sending the packet to. + */ + link_socket_get_outgoing_addr (&c->c2.buf, get_link_socket_info (c), + &c->c2.to_link_addr); +#ifdef USE_CRYPTO +#ifdef USE_SSL + /* + * In TLS mode, prepend the appropriate one-byte opcode + * to the packet which identifies it as a data channel + * packet and gives the low-permutation version of + * the key-id to the recipient so it knows which + * decrypt key to use. + */ + if (c->c2.tls_multi) + { + tls_post_encrypt (c->c2.tls_multi, &c->c2.buf); + /*tls_mutex_unlock (c->c2.tls_multi);*/ + } +#endif +#endif + + /* if null encryption, copy result to read_tun_buf */ + buffer_turnover (orig_buf, &c->c2.to_link, &c->c2.buf, &b->read_tun_buf); +} + +/* + * Coarse timers work to 1 second resolution. + */ +static void +process_coarse_timers (struct context *c) +{ +#ifdef USE_CRYPTO + /* flush current packet-id to file once per 60 + seconds if --replay-persist was specified */ + check_packet_id_persist_flush (c); +#endif + + /* should we update status file? */ + check_status_file (c); + + /* process connection establishment items */ + check_connection_established (c); + +#if P2MP + /* see if we should send a push_request in response to --pull */ + check_push_request (c); +#endif + + /* process --route options */ + check_add_routes (c); + + /* possibly exit due to --inactive */ + check_inactivity_timeout (c); + if (c->sig->signal_received) + return; + + /* restart if ping not received */ + check_ping_restart (c); + if (c->sig->signal_received) + return; + +#if P2MP + check_scheduled_exit (c); + if (c->sig->signal_received) + return; +#endif + +#ifdef ENABLE_OCC + /* Should we send an OCC_REQUEST message? */ + check_send_occ_req (c); + + /* Should we send an MTU load test? */ + check_send_occ_load_test (c); + + /* Should we send an OCC_EXIT message to remote? */ + if (c->c2.explicit_exit_notification_time_wait) + process_explicit_exit_notification_timer_wakeup (c); +#endif + + /* Should we ping the remote? */ + check_ping_send (c); +} + +static void +check_coarse_timers_dowork (struct context *c) +{ + const struct timeval save = c->c2.timeval; + c->c2.timeval.tv_sec = BIG_TIMEOUT; + c->c2.timeval.tv_usec = 0; + process_coarse_timers (c); + c->c2.coarse_timer_wakeup = now + c->c2.timeval.tv_sec; + + dmsg (D_INTERVAL, "TIMER: coarse timer wakeup %d seconds", (int) c->c2.timeval.tv_sec); + + /* Is the coarse timeout NOT the earliest one? */ + if (c->c2.timeval.tv_sec > save.tv_sec) + c->c2.timeval = save; +} + +static inline void +check_coarse_timers (struct context *c) +{ + const time_t local_now = now; + if (local_now >= c->c2.coarse_timer_wakeup) + check_coarse_timers_dowork (c); + else + context_reschedule_sec (c, c->c2.coarse_timer_wakeup - local_now); +} + +static void +check_timeout_random_component_dowork (struct context *c) +{ + const int update_interval = 10; /* seconds */ + c->c2.update_timeout_random_component = now + update_interval; + c->c2.timeout_random_component.tv_usec = (time_t) get_random () & 0x0003FFFF; + c->c2.timeout_random_component.tv_sec = 0; + + dmsg (D_INTERVAL, "RANDOM USEC=%d", (int) c->c2.timeout_random_component.tv_usec); +} + +static inline void +check_timeout_random_component (struct context *c) +{ + if (now >= c->c2.update_timeout_random_component) + check_timeout_random_component_dowork (c); + if (c->c2.timeval.tv_sec >= 1) + tv_add (&c->c2.timeval, &c->c2.timeout_random_component); +} + +#ifdef ENABLE_SOCKS + +/* + * Handle addition and removal of the 10-byte Socks5 header + * in UDP packets. + */ + +static inline void +socks_postprocess_incoming_link (struct context *c) +{ + if (c->c2.link_socket->socks_proxy && c->c2.link_socket->info.proto == PROTO_UDPv4) + socks_process_incoming_udp (&c->c2.buf, &c->c2.from); +} + +static inline void +socks_preprocess_outgoing_link (struct context *c, + struct sockaddr_in **to_addr, + int *size_delta) +{ + if (c->c2.link_socket->socks_proxy && c->c2.link_socket->info.proto == PROTO_UDPv4) + { + *size_delta += socks_process_outgoing_udp (&c->c2.to_link, &c->c2.to_link_addr); + *to_addr = &c->c2.link_socket->socks_relay; + } +} + +/* undo effect of socks_preprocess_outgoing_link */ +static inline void +link_socket_write_post_size_adjust (int *size, + int size_delta, + struct buffer *buf) +{ + if (size_delta > 0 && *size > size_delta) + { + *size -= size_delta; + if (!buf_advance (buf, size_delta)) + *size = 0; + } +} +#endif + +/* + * Output: c->c2.buf + */ + +void +read_incoming_link (struct context *c) +{ + /* + * Set up for recvfrom call to read datagram + * sent to our TCP/UDP port. + */ + int status; + + perf_push (PERF_READ_IN_LINK); + + ASSERT (!c->c2.to_tun.len); + + c->c2.buf = c->c2.buffers->read_link_buf; + ASSERT (buf_init (&c->c2.buf, FRAME_HEADROOM_ADJ (&c->c2.frame, FRAME_HEADROOM_MARKER_READ_LINK))); + status = link_socket_read (c->c2.link_socket, &c->c2.buf, MAX_RW_SIZE_LINK (&c->c2.frame), &c->c2.from); + + if (socket_connection_reset (c->c2.link_socket, status)) + { + /* received a disconnect from a connection-oriented protocol */ + if (c->options.inetd) + { + c->sig->signal_received = SIGTERM; + msg (D_STREAM_ERRORS, "Connection reset, inetd/xinetd exit [%d]", status); + } + else + { + c->sig->signal_received = SIGUSR1; /* SOFT-SIGUSR1 -- TCP connection reset */ + msg (D_STREAM_ERRORS, "Connection reset, restarting [%d]", status); + } + c->sig->signal_text = "connection-reset"; + perf_pop (); + return; + } + + /* check recvfrom status */ + check_status (status, "read", c->c2.link_socket, NULL); + +#ifdef ENABLE_SOCKS + /* Remove socks header if applicable */ + socks_postprocess_incoming_link (c); +#endif + + perf_pop (); +} + +/* + * Input: c->c2.buf + * Output: c->c2.to_tun + */ + +void +process_incoming_link (struct context *c) +{ + struct gc_arena gc = gc_new (); + bool decrypt_status; + struct link_socket_info *lsi = get_link_socket_info (c); + const uint8_t *orig_buf = c->c2.buf.data; + + perf_push (PERF_PROC_IN_LINK); + + if (c->c2.buf.len > 0) + { + c->c2.link_read_bytes += c->c2.buf.len; + c->c2.original_recv_size = c->c2.buf.len; + } + else + c->c2.original_recv_size = 0; + +#ifdef ENABLE_DEBUG + /* take action to corrupt packet if we are in gremlin test mode */ + if (c->options.gremlin) { + if (!ask_gremlin (c->options.gremlin)) + c->c2.buf.len = 0; + corrupt_gremlin (&c->c2.buf, c->options.gremlin); + } +#endif + + /* log incoming packet */ +#ifdef LOG_RW + if (c->c2.log_rw) + fprintf (stderr, "R"); +#endif + msg (D_LINK_RW, "%s READ [%d] from %s: %s", + proto2ascii (lsi->proto, true), + BLEN (&c->c2.buf), + print_sockaddr (&c->c2.from, &gc), + PROTO_DUMP (&c->c2.buf, &gc)); + + /* + * Good, non-zero length packet received. + * Commence multi-stage processing of packet, + * such as authenticate, decrypt, decompress. + * If any stage fails, it sets buf.len to 0 or -1, + * telling downstream stages to ignore the packet. + */ + if (c->c2.buf.len > 0) + { + if (!link_socket_verify_incoming_addr (&c->c2.buf, lsi, &c->c2.from)) + link_socket_bad_incoming_addr (&c->c2.buf, lsi, &c->c2.from); + +#ifdef USE_CRYPTO +#ifdef USE_SSL + if (c->c2.tls_multi) + { + /* + * If tls_pre_decrypt returns true, it means the incoming + * packet was a good TLS control channel packet. If so, TLS code + * will deal with the packet and set buf.len to 0 so downstream + * stages ignore it. + * + * If the packet is a data channel packet, tls_pre_decrypt + * will load crypto_options with the correct encryption key + * and return false. + */ + /*tls_mutex_lock (c->c2.tls_multi);*/ + if (tls_pre_decrypt (c->c2.tls_multi, &c->c2.from, &c->c2.buf, &c->c2.crypto_options)) + { + interval_action (&c->c2.tmp_int); + + /* reset packet received timer if TLS packet */ + if (c->options.ping_rec_timeout) + event_timeout_reset (&c->c2.ping_rec_interval); + } + } +#if P2MP_SERVER + /* + * Drop non-TLS packet if client-connect script/plugin has not + * yet succeeded. + */ + if (c->c2.context_auth != CAS_SUCCEEDED) + c->c2.buf.len = 0; +#endif +#endif /* USE_SSL */ + + /* authenticate and decrypt the incoming packet */ + decrypt_status = openvpn_decrypt (&c->c2.buf, c->c2.buffers->decrypt_buf, &c->c2.crypto_options, &c->c2.frame); + +#ifdef USE_SSL + if (c->c2.tls_multi) + { + /*tls_mutex_unlock (c->c2.tls_multi);*/ + } +#endif + + if (!decrypt_status && link_socket_connection_oriented (c->c2.link_socket)) + { + /* decryption errors are fatal in TCP mode */ + c->sig->signal_received = SIGUSR1; /* SOFT-SIGUSR1 -- decryption error in TCP mode */ + c->sig->signal_text = "decryption-error"; + msg (D_STREAM_ERRORS, "Fatal decryption error (process_incoming_link), restarting"); + goto done; + } + +#endif /* USE_CRYPTO */ + +#ifdef ENABLE_FRAGMENT + if (c->c2.fragment) + fragment_incoming (c->c2.fragment, &c->c2.buf, &c->c2.frame_fragment); +#endif + +#ifdef USE_LZO + /* decompress the incoming packet */ + if (c->options.comp_lzo) + lzo_decompress (&c->c2.buf, c->c2.buffers->lzo_decompress_buf, &c->c2.lzo_compwork, &c->c2.frame); +#endif + /* + * Set our "official" outgoing address, since + * if buf.len is non-zero, we know the packet + * authenticated. In TLS mode we do nothing + * because TLS mode takes care of source address + * authentication. + * + * Also, update the persisted version of our packet-id. + */ + if (!TLS_MODE (c)) + link_socket_set_outgoing_addr (&c->c2.buf, lsi, &c->c2.from, NULL, c->c2.es); + + /* reset packet received timer */ + if (c->options.ping_rec_timeout && c->c2.buf.len > 0) + event_timeout_reset (&c->c2.ping_rec_interval); + + /* increment authenticated receive byte count */ + if (c->c2.buf.len > 0) + { + c->c2.link_read_bytes_auth += c->c2.buf.len; + c->c2.max_recv_size_local = max_int (c->c2.original_recv_size, c->c2.max_recv_size_local); + } + + /* Did we just receive an openvpn ping packet? */ + if (is_ping_msg (&c->c2.buf)) + { + dmsg (D_PACKET_CONTENT, "RECEIVED PING PACKET"); + c->c2.buf.len = 0; /* drop packet */ + } + +#ifdef ENABLE_OCC + /* Did we just receive an OCC packet? */ + if (is_occ_msg (&c->c2.buf)) + process_received_occ_msg (c); +#endif + + buffer_turnover (orig_buf, &c->c2.to_tun, &c->c2.buf, &c->c2.buffers->read_link_buf); + + /* to_tun defined + unopened tuntap can cause deadlock */ + if (!tuntap_defined (c->c1.tuntap)) + c->c2.to_tun.len = 0; + } + else + { + buf_reset (&c->c2.to_tun); + } + done: + perf_pop (); + gc_free (&gc); +} + +/* + * Output: c->c2.buf + */ + +void +read_incoming_tun (struct context *c) +{ + perf_push (PERF_READ_IN_TUN); + + /* + * Setup for read() call on TUN/TAP device. + */ + ASSERT (!c->c2.to_link.len); + + c->c2.buf = c->c2.buffers->read_tun_buf; +#ifdef TUN_PASS_BUFFER + read_tun_buffered (c->c1.tuntap, &c->c2.buf, MAX_RW_SIZE_TUN (&c->c2.frame)); +#else + ASSERT (buf_init (&c->c2.buf, FRAME_HEADROOM (&c->c2.frame))); + ASSERT (buf_safe (&c->c2.buf, MAX_RW_SIZE_TUN (&c->c2.frame))); + c->c2.buf.len = read_tun (c->c1.tuntap, BPTR (&c->c2.buf), MAX_RW_SIZE_TUN (&c->c2.frame)); +#endif + + /* Was TUN/TAP interface stopped? */ + if (tuntap_stop (c->c2.buf.len)) + { + c->sig->signal_received = SIGTERM; + c->sig->signal_text = "tun-stop"; + msg (M_INFO, "TUN/TAP interface has been stopped, exiting"); + perf_pop (); + return; + } + + /* Check the status return from read() */ + check_status (c->c2.buf.len, "read from TUN/TAP", NULL, c->c1.tuntap); + + perf_pop (); +} + +/* + * Input: c->c2.buf + * Output: c->c2.to_link + */ + +void +process_incoming_tun (struct context *c) +{ + struct gc_arena gc = gc_new (); + + perf_push (PERF_PROC_IN_TUN); + + if (c->c2.buf.len > 0) + c->c2.tun_read_bytes += c->c2.buf.len; + +#ifdef LOG_RW + if (c->c2.log_rw) + fprintf (stderr, "r"); +#endif + + /* Show packet content */ + dmsg (D_TUN_RW, "TUN READ [%d]: %s md5=%s", + BLEN (&c->c2.buf), + format_hex (BPTR (&c->c2.buf), BLEN (&c->c2.buf), 80, &gc), + MD5SUM (BPTR (&c->c2.buf), BLEN (&c->c2.buf), &gc)); + + if (c->c2.buf.len > 0) + { + /* + * The --passtos and --mssfix options require + * us to examine the IPv4 header. + */ + process_ipv4_header (c, PIPV4_PASSTOS|PIPV4_MSSFIX, &c->c2.buf); + encrypt_sign (c, true); + } + else + { + buf_reset (&c->c2.to_link); + } + perf_pop (); + gc_free (&gc); +} + +void +process_ipv4_header (struct context *c, unsigned int flags, struct buffer *buf) +{ + if (!c->options.mssfix) + flags &= ~PIPV4_MSSFIX; +#if PASSTOS_CAPABILITY + if (!c->options.passtos) + flags &= ~PIPV4_PASSTOS; +#endif + + if (buf->len > 0) + { + /* + * The --passtos and --mssfix options require + * us to examine the IPv4 header. + */ +#if PASSTOS_CAPABILITY + if (flags & (PIPV4_PASSTOS|PIPV4_MSSFIX)) +#else + if (flags & PIPV4_MSSFIX) +#endif + { + struct buffer ipbuf = *buf; + if (is_ipv4 (TUNNEL_TYPE (c->c1.tuntap), &ipbuf)) + { +#if PASSTOS_CAPABILITY + /* extract TOS from IP header */ + if (flags & PIPV4_PASSTOS) + link_socket_extract_tos (c->c2.link_socket, &ipbuf); +#endif + + /* possibly alter the TCP MSS */ + if (flags & PIPV4_MSSFIX) + mss_fixup (&ipbuf, MTU_TO_MSS (TUN_MTU_SIZE_DYNAMIC (&c->c2.frame))); + } + } + } +} + +/* + * Input: c->c2.to_link + */ + +void +process_outgoing_link (struct context *c) +{ + struct gc_arena gc = gc_new (); + + perf_push (PERF_PROC_OUT_LINK); + + if (c->c2.to_link.len > 0 && c->c2.to_link.len <= EXPANDED_SIZE (&c->c2.frame)) + { + /* + * Setup for call to send/sendto which will send + * packet to remote over the TCP/UDP port. + */ + int size = 0; + ASSERT (addr_defined (&c->c2.to_link_addr)); + +#ifdef ENABLE_DEBUG + /* In gremlin-test mode, we may choose to drop this packet */ + if (!c->options.gremlin || ask_gremlin (c->options.gremlin)) +#endif + { + /* + * Let the traffic shaper know how many bytes + * we wrote. + */ +#ifdef HAVE_GETTIMEOFDAY + if (c->options.shaper) + shaper_wrote_bytes (&c->c2.shaper, BLEN (&c->c2.to_link) + + datagram_overhead (c->options.proto)); +#endif + /* + * Let the pinger know that we sent a packet. + */ + if (c->options.ping_send_timeout) + event_timeout_reset (&c->c2.ping_send_interval); + +#if PASSTOS_CAPABILITY + /* Set TOS */ + link_socket_set_tos (c->c2.link_socket); +#endif + + /* Log packet send */ +#ifdef LOG_RW + if (c->c2.log_rw) + fprintf (stderr, "W"); +#endif + msg (D_LINK_RW, "%s WRITE [%d] to %s: %s", + proto2ascii (c->c2.link_socket->info.proto, true), + BLEN (&c->c2.to_link), + print_sockaddr (&c->c2.to_link_addr, &gc), + PROTO_DUMP (&c->c2.to_link, &gc)); + + /* Packet send complexified by possible Socks5 usage */ + { + struct sockaddr_in *to_addr = &c->c2.to_link_addr; +#ifdef ENABLE_SOCKS + int size_delta = 0; +#endif + +#ifdef ENABLE_SOCKS + /* If Socks5 over UDP, prepend header */ + socks_preprocess_outgoing_link (c, &to_addr, &size_delta); +#endif + /* Send packet */ + size = link_socket_write (c->c2.link_socket, &c->c2.to_link, to_addr); + +#ifdef ENABLE_SOCKS + /* Undo effect of prepend */ + link_socket_write_post_size_adjust (&size, size_delta, &c->c2.to_link); +#endif + } + + if (size > 0) + { + c->c2.max_send_size_local = max_int (size, c->c2.max_send_size_local); + c->c2.link_write_bytes += size; + } + } + + /* Check return status */ + check_status (size, "write", c->c2.link_socket, NULL); + + if (size > 0) + { + /* Did we write a different size packet than we intended? */ + if (size != BLEN (&c->c2.to_link)) + msg (D_LINK_ERRORS, + "TCP/UDP packet was truncated/expanded on write to %s (tried=%d,actual=%d)", + print_sockaddr (&c->c2.to_link_addr, &gc), + BLEN (&c->c2.to_link), + size); + } + } + else + { + if (c->c2.to_link.len > 0) + msg (D_LINK_ERRORS, "TCP/UDP packet too large on write to %s (tried=%d,max=%d)", + print_sockaddr (&c->c2.to_link_addr, &gc), + c->c2.to_link.len, + EXPANDED_SIZE (&c->c2.frame)); + } + + buf_reset (&c->c2.to_link); + + perf_pop (); + gc_free (&gc); +} + +/* + * Input: c->c2.to_tun + */ + +void +process_outgoing_tun (struct context *c) +{ + struct gc_arena gc = gc_new (); + + perf_push (PERF_PROC_OUT_TUN); + + /* + * Set up for write() call to TUN/TAP + * device. + */ + ASSERT (c->c2.to_tun.len > 0); + + /* + * The --mssfix option requires + * us to examine the IPv4 header. + */ + process_ipv4_header (c, PIPV4_MSSFIX, &c->c2.to_tun); + + if (c->c2.to_tun.len <= MAX_RW_SIZE_TUN (&c->c2.frame)) + { + /* + * Write to TUN/TAP device. + */ + int size; + +#ifdef LOG_RW + if (c->c2.log_rw) + fprintf (stderr, "w"); +#endif + dmsg (D_TUN_RW, "TUN WRITE [%d]: %s md5=%s", + BLEN (&c->c2.to_tun), + format_hex (BPTR (&c->c2.to_tun), BLEN (&c->c2.to_tun), 80, &gc), + MD5SUM (BPTR (&c->c2.to_tun), BLEN (&c->c2.to_tun), &gc)); + +#ifdef TUN_PASS_BUFFER + size = write_tun_buffered (c->c1.tuntap, &c->c2.to_tun); +#else + size = write_tun (c->c1.tuntap, BPTR (&c->c2.to_tun), BLEN (&c->c2.to_tun)); +#endif + + if (size > 0) + c->c2.tun_write_bytes += size; + check_status (size, "write to TUN/TAP", NULL, c->c1.tuntap); + + /* check written packet size */ + if (size > 0) + { + /* Did we write a different size packet than we intended? */ + if (size != BLEN (&c->c2.to_tun)) + msg (D_LINK_ERRORS, + "TUN/TAP packet was destructively fragmented on write to %s (tried=%d,actual=%d)", + c->c1.tuntap->actual_name, + BLEN (&c->c2.to_tun), + size); + } + } + else + { + /* + * This should never happen, probably indicates some kind + * of MTU mismatch. + */ + msg (D_LINK_ERRORS, "tun packet too large on write (tried=%d,max=%d)", + c->c2.to_tun.len, + MAX_RW_SIZE_TUN (&c->c2.frame)); + } + + /* + * Putting the --inactive timeout reset here, ensures that we will timeout + * if the remote goes away, even if we are trying to send data to the + * remote and failing. + */ + register_activity (c); + + buf_reset (&c->c2.to_tun); + + perf_pop (); + gc_free (&gc); +} + +void +pre_select (struct context *c) +{ + /* make sure current time (now) is updated on function entry */ + + /* + * Start with an effectively infinite timeout, then let it + * reduce to a timeout that reflects the component which + * needs the earliest service. + */ + c->c2.timeval.tv_sec = BIG_TIMEOUT; + c->c2.timeval.tv_usec = 0; + +#if defined(WIN32) + if (check_debug_level (D_TAP_WIN32_DEBUG)) + { + c->c2.timeval.tv_sec = 1; + if (tuntap_defined (c->c1.tuntap)) + tun_show_debug (c->c1.tuntap); + } +#endif + + /* check coarse timers? */ + check_coarse_timers (c); + if (c->sig->signal_received) + return; + + /* Does TLS need service? */ + check_tls (c); + + /* In certain cases, TLS errors will require a restart */ + check_tls_errors (c); + if (c->sig->signal_received) + return; + + /* check for incoming configuration info on the control channel */ + check_incoming_control_channel (c); + +#ifdef ENABLE_OCC + /* Should we send an OCC message? */ + check_send_occ_msg (c); +#endif + +#ifdef ENABLE_FRAGMENT + /* Should we deliver a datagram fragment to remote? */ + check_fragment (c); +#endif + + /* Update random component of timeout */ + check_timeout_random_component (c); +} + +/* + * Wait for I/O events. Used for both TCP & UDP sockets + * in point-to-point mode and for UDP sockets in + * point-to-multipoint mode. + */ + +void +io_wait_dowork (struct context *c, const unsigned int flags) +{ + unsigned int socket = 0; + unsigned int tuntap = 0; + struct event_set_return esr[4]; + + /* These shifts all depend on EVENT_READ and EVENT_WRITE */ + static const int socket_shift = 0; /* depends on SOCKET_READ and SOCKET_WRITE */ + static const int tun_shift = 2; /* depends on TUN_READ and TUN_WRITE */ + static const int err_shift = 4; /* depends on ES_ERROR */ +#ifdef ENABLE_MANAGEMENT + static const int management_shift = 6; /* depends on MANAGEMENT_READ and MANAGEMENT_WRITE */ +#endif + + /* + * Decide what kind of events we want to wait for. + */ + event_reset (c->c2.event_set); + + /* + * On win32 we use the keyboard or an event object as a source + * of asynchronous signals. + */ + if (flags & IOW_WAIT_SIGNAL) + wait_signal (c->c2.event_set, (void*)&err_shift); + + /* + * If outgoing data (for TCP/UDP port) pending, wait for ready-to-send + * status from TCP/UDP port. Otherwise, wait for incoming data on + * TUN/TAP device. + */ + if (flags & IOW_TO_LINK) + { + if (flags & IOW_SHAPER) + { + /* + * If sending this packet would put us over our traffic shaping + * quota, don't send -- instead compute the delay we must wait + * until it will be OK to send the packet. + */ +#ifdef HAVE_GETTIMEOFDAY + int delay = 0; + + /* set traffic shaping delay in microseconds */ + if (c->options.shaper) + delay = max_int (delay, shaper_delay (&c->c2.shaper)); + + if (delay < 1000) + { + socket |= EVENT_WRITE; + } + else + { + shaper_soonest_event (&c->c2.timeval, delay); + } +#else /* HAVE_GETTIMEOFDAY */ + socket |= EVENT_WRITE; +#endif /* HAVE_GETTIMEOFDAY */ + } + else + { + socket |= EVENT_WRITE; + } + } + else if (!((flags & IOW_FRAG) && TO_LINK_FRAG (c))) + { + if (flags & IOW_READ_TUN) + tuntap |= EVENT_READ; + } + + /* + * If outgoing data (for TUN/TAP device) pending, wait for ready-to-send status + * from device. Otherwise, wait for incoming data on TCP/UDP port. + */ + if (flags & IOW_TO_TUN) + { + tuntap |= EVENT_WRITE; + } + else + { + if (flags & IOW_READ_LINK) + socket |= EVENT_READ; + } + + /* + * outgoing bcast buffer waiting to be sent? + */ + if (flags & IOW_MBUF) + socket |= EVENT_WRITE; + + /* + * Force wait on TUN input, even if also waiting on TCP/UDP output + */ + if (flags & IOW_READ_TUN_FORCE) + tuntap |= EVENT_READ; + + /* + * Configure event wait based on socket, tuntap flags. + */ + socket_set (c->c2.link_socket, c->c2.event_set, socket, (void*)&socket_shift, NULL); + tun_set (c->c1.tuntap, c->c2.event_set, tuntap, (void*)&tun_shift, NULL); + +#ifdef ENABLE_MANAGEMENT + if (management) + management_socket_set (management, c->c2.event_set, (void*)&management_shift, NULL); +#endif + + /* + * Possible scenarios: + * (1) tcp/udp port has data available to read + * (2) tcp/udp port is ready to accept more data to write + * (3) tun dev has data available to read + * (4) tun dev is ready to accept more data to write + * (5) we received a signal (handler sets signal_received) + * (6) timeout (tv) expired + */ + + c->c2.event_set_status = ES_ERROR; + + if (!c->sig->signal_received) + { + if (!(flags & IOW_CHECK_RESIDUAL) || !socket_read_residual (c->c2.link_socket)) + { + int status; + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_EVENT_WAIT)) + show_wait_status (c); +#endif + + /* + * Wait for something to happen. + */ + status = event_wait (c->c2.event_set, &c->c2.timeval, esr, SIZE(esr)); + + check_status (status, "event_wait", NULL, NULL); + + if (status > 0) + { + int i; + c->c2.event_set_status = 0; + for (i = 0; i < status; ++i) + { + const struct event_set_return *e = &esr[i]; + c->c2.event_set_status |= ((e->rwflags & 3) << *((int*)e->arg)); + } + } + else if (status == 0) + { + c->c2.event_set_status = ES_TIMEOUT; + } + } + else + { + c->c2.event_set_status = SOCKET_READ; + } + } + + /* 'now' should always be a reasonably up-to-date timestamp */ + update_time (); + + /* set signal_received if a signal was received */ + if (c->c2.event_set_status & ES_ERROR) + get_signal (&c->sig->signal_received); + + dmsg (D_EVENT_WAIT, "I/O WAIT status=0x%04x", c->c2.event_set_status); +} + +void +process_io (struct context *c) +{ + const unsigned int status = c->c2.event_set_status; + +#ifdef ENABLE_MANAGEMENT + if (status & (MANAGEMENT_READ|MANAGEMENT_WRITE)) + { + ASSERT (management); + management_io (management); + } +#endif + + /* TCP/UDP port ready to accept write */ + if (status & SOCKET_WRITE) + { + process_outgoing_link (c); + } + /* TUN device ready to accept write */ + else if (status & TUN_WRITE) + { + process_outgoing_tun (c); + } + /* Incoming data on TCP/UDP port */ + else if (status & SOCKET_READ) + { + read_incoming_link (c); + if (!IS_SIG (c)) + process_incoming_link (c); + } + /* Incoming data on TUN device */ + else if (status & TUN_READ) + { + read_incoming_tun (c); + if (!IS_SIG (c)) + process_incoming_tun (c); + } +} diff --git a/forward.h b/forward.h new file mode 100644 index 0000000..1d37aae --- /dev/null +++ b/forward.h @@ -0,0 +1,84 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef FORWARD_H +#define FORWARD_H + +#include "openvpn.h" +#include "occ.h" +#include "ping.h" + +#define TUN_OUT(c) (BLEN(&(c)->c2.to_tun) > 0) +#define LINK_OUT(c) (BLEN(&(c)->c2.to_link) > 0) +#define ANY_OUT(c) (TUN_OUT(c) || LINK_OUT(c)) + +#ifdef ENABLE_FRAGMENT +#define TO_LINK_FRAG(c) ((c)->c2.fragment && fragment_outgoing_defined ((c)->c2.fragment)) +#else +#define TO_LINK_FRAG(c) (false) +#endif + +#define TO_LINK_DEF(c) (LINK_OUT(c) || TO_LINK_FRAG(c)) + +#define IOW_TO_TUN (1<<0) +#define IOW_TO_LINK (1<<1) +#define IOW_READ_TUN (1<<2) +#define IOW_READ_LINK (1<<3) +#define IOW_SHAPER (1<<4) +#define IOW_CHECK_RESIDUAL (1<<5) +#define IOW_FRAG (1<<6) +#define IOW_MBUF (1<<7) +#define IOW_READ_TUN_FORCE (1<<8) +#define IOW_WAIT_SIGNAL (1<<9) + +#define IOW_READ (IOW_READ_TUN|IOW_READ_LINK) + +void pre_select (struct context *c); + +void process_io (struct context *c); + +void encrypt_sign (struct context *c, bool comp_frag); + +const char *wait_status_string (struct context *c, struct gc_arena *gc); +void show_wait_status (struct context *c); + +void read_incoming_link (struct context *c); +void process_incoming_link (struct context *c); +void read_incoming_tun (struct context *c); +void process_incoming_tun (struct context *c); +void process_outgoing_link (struct context *c); +void process_outgoing_tun (struct context *c); + +bool send_control_channel_string (struct context *c, const char *str, int msglevel); + +#define PIPV4_PASSTOS (1<<0) +#define PIPV4_MSSFIX (1<<1) + +void process_ipv4_header (struct context *c, unsigned int flags, struct buffer *buf); + +#if P2MP +void schedule_exit (struct context *c, const int n_seconds); +#endif + +#endif /* FORWARD_H */ diff --git a/fragment.c b/fragment.c new file mode 100644 index 0000000..ead098a --- /dev/null +++ b/fragment.c @@ -0,0 +1,414 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#ifdef ENABLE_FRAGMENT + +#include "misc.h" +#include "fragment.h" +#include "integer.h" +#include "memdbg.h" + +#define FRAG_ERR(s) { errmsg = s; goto error; } + +static void +fragment_list_buf_init (struct fragment_list *list, const struct frame *frame) +{ + int i; + for (i = 0; i < N_FRAG_BUF; ++i) + list->fragments[i].buf = alloc_buf (BUF_SIZE (frame)); +} + +static void +fragment_list_buf_free (struct fragment_list *list) +{ + int i; + for (i = 0; i < N_FRAG_BUF; ++i) + free_buf (&list->fragments[i].buf); +} + +/* + * Given a sequence ID number, get a fragment buffer. Use a sliding window, + * similar to packet_id code. + */ +static struct fragment * +fragment_list_get_buf (struct fragment_list *list, int seq_id) +{ + int diff; + if (abs (diff = modulo_subtract (seq_id, list->seq_id, N_SEQ_ID)) >= N_FRAG_BUF) + { + int i; + for (i = 0; i < N_FRAG_BUF; ++i) + list->fragments[i].defined = false; + list->index = 0; + list->seq_id = seq_id; + diff = 0; + } + while (diff > 0) + { + list->fragments[list->index = modulo_add (list->index, 1, N_FRAG_BUF)].defined = false; + list->seq_id = modulo_add (list->seq_id, 1, N_SEQ_ID); + --diff; + } + return &list->fragments[modulo_add (list->index, diff, N_FRAG_BUF)]; +} + +struct fragment_master * +fragment_init (struct frame *frame) +{ + struct fragment_master *ret; + + /* code that initializes other parts of + fragment_master assume an initial CLEAR */ + ALLOC_OBJ_CLEAR (ret, struct fragment_master); + + /* add in the size of our contribution to the expanded frame size */ + frame_add_to_extra_frame (frame, sizeof(fragment_header_type)); + + /* + * Outgoing sequence ID is randomized to reduce + * the probability of sequence number collisions + * when openvpn sessions are restarted. This is + * not done out of any need for security, as all + * fragmentation control information resides + * inside of the encrypted/authenticated envelope. + */ + ret->outgoing_seq_id = (int)get_random() & (N_SEQ_ID - 1); + + event_timeout_init (&ret->wakeup, FRAG_WAKEUP_INTERVAL, now); + + return ret; +} + +void +fragment_free (struct fragment_master *f) +{ + fragment_list_buf_free (&f->incoming); + free_buf (&f->outgoing); + free_buf (&f->outgoing_return); + free (f); +} + +void +fragment_frame_init (struct fragment_master *f, const struct frame *frame) +{ + fragment_list_buf_init (&f->incoming, frame); + f->outgoing = alloc_buf (BUF_SIZE (frame)); + f->outgoing_return = alloc_buf (BUF_SIZE (frame)); +} + +/* + * Accept an incoming datagram (which may be a fragment) from remote. + * If the datagram is whole (i.e not a fragment), pass through. + * If the datagram is a fragment, join with other fragments received so far. + * If a fragment fully completes the datagram, return the datagram. + */ +void +fragment_incoming (struct fragment_master *f, struct buffer *buf, + const struct frame* frame) +{ + const char *errmsg = NULL; + fragment_header_type flags = 0; + int frag_type = 0; + + if (buf->len > 0) + { + /* get flags from packet head */ + if (!buf_read (buf, &flags, sizeof (flags))) + FRAG_ERR ("flags not found in packet"); + flags = ntoh_fragment_header_type (flags); + + /* get fragment type from flags */ + frag_type = ((flags >> FRAG_TYPE_SHIFT) & FRAG_TYPE_MASK); + +#if 0 + /* + * If you want to extract FRAG_EXTRA_MASK/FRAG_EXTRA_SHIFT bits, + * do it here. + */ + if (frag_type == FRAG_WHOLE || frag_type == FRAG_YES_NOTLAST) + { + } +#endif + + /* handle the fragment type */ + if (frag_type == FRAG_WHOLE) + { + dmsg (D_FRAG_DEBUG, + "FRAG_IN buf->len=%d type=FRAG_WHOLE flags=" + fragment_header_format, + buf->len, + flags); + + if (flags & (FRAG_SEQ_ID_MASK | FRAG_ID_MASK)) + FRAG_ERR ("spurrious FRAG_WHOLE flags"); + } + else if (frag_type == FRAG_YES_NOTLAST || frag_type == FRAG_YES_LAST) + { + const int seq_id = ((flags >> FRAG_SEQ_ID_SHIFT) & FRAG_SEQ_ID_MASK); + const int n = ((flags >> FRAG_ID_SHIFT) & FRAG_ID_MASK); + const int size = ((frag_type == FRAG_YES_LAST) + ? (int)(((flags >> FRAG_SIZE_SHIFT) & FRAG_SIZE_MASK) << FRAG_SIZE_ROUND_SHIFT) + : buf->len); + + /* get the appropriate fragment buffer based on received seq_id */ + struct fragment *frag = fragment_list_get_buf (&f->incoming, seq_id); + + dmsg (D_FRAG_DEBUG, + "FRAG_IN len=%d type=%d seq_id=%d frag_id=%d size=%d flags=" + fragment_header_format, + buf->len, + frag_type, + seq_id, + n, + size, + flags); + + /* make sure that size is an even multiple of 1<<FRAG_SIZE_ROUND_SHIFT */ + if (size & FRAG_SIZE_ROUND_MASK) + FRAG_ERR ("bad fragment size"); + + /* is this the first fragment for our sequence number? */ + if (!frag->defined || (frag->defined && frag->max_frag_size != size)) + { + frag->defined = true; + frag->max_frag_size = size; + frag->map = 0; + ASSERT (buf_init (&frag->buf, FRAME_HEADROOM_ADJ (frame, FRAME_HEADROOM_MARKER_FRAGMENT))); + } + + /* copy the data to fragment buffer */ + if (!buf_copy_range (&frag->buf, n * size, buf, 0, buf->len)) + FRAG_ERR ("fragment buffer overflow"); + + /* set elements in bit array to reflect which fragments have been received */ + frag->map |= (((frag_type == FRAG_YES_LAST) ? FRAG_MAP_MASK : 1) << n); + + /* update timestamp on partially built datagram */ + frag->timestamp = now; + + /* received full datagram? */ + if ((frag->map & FRAG_MAP_MASK) == FRAG_MAP_MASK) + { + frag->defined = false; + *buf = frag->buf; + } + else + { + buf->len = 0; + } + } + else if (frag_type == FRAG_TEST) + { + FRAG_ERR ("FRAG_TEST not implemented"); + } + else + { + FRAG_ERR ("unknown fragment type"); + } + } + + return; + + error: + if (errmsg) + msg (D_FRAG_ERRORS, "FRAG_IN error flags=" fragment_header_format ": %s", flags, errmsg); + buf->len = 0; + return; +} + +/* pack fragment parms into a uint32_t and prepend to buffer */ +static void +fragment_prepend_flags (struct buffer *buf, + int type, + int seq_id, + int frag_id, + int frag_size) +{ + fragment_header_type flags = ((type & FRAG_TYPE_MASK) << FRAG_TYPE_SHIFT) + | ((seq_id & FRAG_SEQ_ID_MASK) << FRAG_SEQ_ID_SHIFT) + | ((frag_id & FRAG_ID_MASK) << FRAG_ID_SHIFT); + + if (type == FRAG_WHOLE || type == FRAG_YES_NOTLAST) + { + /* + * If you want to set FRAG_EXTRA_MASK/FRAG_EXTRA_SHIFT bits, + * do it here. + */ + dmsg (D_FRAG_DEBUG, + "FRAG_OUT len=%d type=%d seq_id=%d frag_id=%d frag_size=%d flags=" + fragment_header_format, + buf->len, type, seq_id, frag_id, frag_size, flags); + } + else + { + flags |= (((frag_size >> FRAG_SIZE_ROUND_SHIFT) & FRAG_SIZE_MASK) << FRAG_SIZE_SHIFT); + + dmsg (D_FRAG_DEBUG, + "FRAG_OUT len=%d type=%d seq_id=%d frag_id=%d frag_size=%d flags=" + fragment_header_format, + buf->len, type, seq_id, frag_id, frag_size, flags); + } + + flags = hton_fragment_header_type (flags); + ASSERT (buf_write_prepend (buf, &flags, sizeof (flags))); +} + +/* + * Without changing the number of fragments, return a possibly smaller + * max fragment size that will allow for the last fragment to be of + * similar size as previous fragments. + */ +static inline int +optimal_fragment_size (int len, int max_frag_size) +{ + const int mfs_aligned = (max_frag_size & ~FRAG_SIZE_ROUND_MASK); + const int div = len / mfs_aligned; + const int mod = len % mfs_aligned; + + if (div > 0 && mod > 0 && mod < mfs_aligned * 3 / 4) + return min_int (mfs_aligned, (max_frag_size - ((max_frag_size - mod) / (div + 1)) + + FRAG_SIZE_ROUND_MASK) & ~FRAG_SIZE_ROUND_MASK); + else + return mfs_aligned; +} + +/* process an outgoing datagram, possibly breaking it up into fragments */ +void +fragment_outgoing (struct fragment_master *f, struct buffer *buf, + const struct frame* frame) +{ + const char *errmsg = NULL; + if (buf->len > 0) + { + /* The outgoing buffer should be empty so we can put new data in it */ + if (f->outgoing.len) + msg (D_FRAG_ERRORS, "FRAG: outgoing buffer is not empty, len=[%d,%d]", + buf->len, f->outgoing.len); + if (buf->len > PAYLOAD_SIZE_DYNAMIC(frame)) /* should we fragment? */ + { + /* + * Send the datagram as a series of 2 or more fragments. + */ + f->outgoing_frag_size = optimal_fragment_size (buf->len, PAYLOAD_SIZE_DYNAMIC(frame)); + if (buf->len > f->outgoing_frag_size * MAX_FRAGS) + FRAG_ERR ("too many fragments would be required to send datagram"); + ASSERT (buf_init (&f->outgoing, FRAME_HEADROOM (frame))); + ASSERT (buf_copy (&f->outgoing, buf)); + f->outgoing_seq_id = modulo_add (f->outgoing_seq_id, 1, N_SEQ_ID); + f->outgoing_frag_id = 0; + buf->len = 0; + ASSERT (fragment_ready_to_send (f, buf, frame)); + } + else + { + /* + * Send the datagram whole. + */ + fragment_prepend_flags (buf, + FRAG_WHOLE, + 0, + 0, + 0); + } + } + return; + + error: + if (errmsg) + msg (D_FRAG_ERRORS, "FRAG_OUT error, len=%d frag_size=%d MAX_FRAGS=%d: %s", + buf->len, f->outgoing_frag_size, MAX_FRAGS, errmsg); + buf->len = 0; + return; +} + +/* return true (and set buf) if we have an outgoing fragment which is ready to send */ +bool +fragment_ready_to_send (struct fragment_master *f, struct buffer *buf, + const struct frame* frame) +{ + if (fragment_outgoing_defined (f)) + { + /* get fragment size, and determine if it is the last fragment */ + int size = f->outgoing_frag_size; + int last = false; + if (f->outgoing.len <= size) + { + size = f->outgoing.len; + last = true; + } + + /* initialize return buffer */ + *buf = f->outgoing_return; + ASSERT (buf_init (buf, FRAME_HEADROOM (frame))); + ASSERT (buf_copy_n (buf, &f->outgoing, size)); + + /* fragment flags differ based on whether or not we are sending the last fragment */ + fragment_prepend_flags (buf, + last ? FRAG_YES_LAST : FRAG_YES_NOTLAST, + f->outgoing_seq_id, + f->outgoing_frag_id++, + f->outgoing_frag_size); + + ASSERT (!last || !f->outgoing.len); /* outgoing buffer length should be zero after last fragment sent */ + + return true; + } + else + return false; +} + +static void +fragment_ttl_reap (struct fragment_master *f) +{ + int i; + for (i = 0; i < N_FRAG_BUF; ++i) + { + struct fragment *frag = &f->incoming.fragments[i]; + if (frag->defined && frag->timestamp + FRAG_TTL_SEC <= now) + { + msg (D_FRAG_ERRORS, "FRAG TTL expired i=%d", i); + frag->defined = false; + } + } +} + +/* called every FRAG_WAKEUP_INTERVAL seconds */ +void +fragment_wakeup (struct fragment_master *f, struct frame *frame) +{ + /* delete fragments with expired TTLs */ + fragment_ttl_reap (f); +} + +#else +static void dummy(void) {} +#endif diff --git a/fragment.h b/fragment.h new file mode 100644 index 0000000..f5b8948 --- /dev/null +++ b/fragment.h @@ -0,0 +1,188 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef FRAGMENT_H +#define FRAGMENT_H + +#ifdef ENABLE_FRAGMENT + +#include "common.h" +#include "buffer.h" +#include "interval.h" +#include "mtu.h" +#include "shaper.h" +#include "error.h" + +#define N_FRAG_BUF 25 /* number of packet buffers */ +#define FRAG_TTL_SEC 10 /* number of seconds time-to-live for a fragment */ +#define FRAG_WAKEUP_INTERVAL 5 /* wakeup code called once per n seconds */ + +struct fragment { + bool defined; + + int max_frag_size; /* maximum size of each fragment */ + + /* + * 32 bit array corresponding to each fragment. A 1 bit in element n means that + * the fragment n has been received. Needs to have at least MAX_FRAGS bits. + */ +# define FRAG_MAP_MASK 0xFFFFFFFF +# define MAX_FRAGS 32 /* maximum number of fragments per packet */ + unsigned int map; + + time_t timestamp; /* timestamp for time-to-live purposes */ + + struct buffer buf; /* fragment assembly buffer for received datagrams */ +}; + +struct fragment_list { + int seq_id; + int index; + struct fragment fragments[N_FRAG_BUF]; +}; + +struct fragment_master { + struct event_timeout wakeup; /* when should main openvpn event loop wake us up */ + + /* true if the OS has explicitly recommended an MTU value */ + bool received_os_mtu_hint; + + /* a sequence ID describes a set of fragments that make up one datagram */ +# define N_SEQ_ID 256 /* sequence number wraps to 0 at this value (should be a power of 2) */ + int outgoing_seq_id; /* sent as FRAG_SEQ_ID below */ + + /* outgoing packet is possibly sent as a series of fragments */ + +# define MAX_FRAG_PKT_SIZE 65536 /* maximum packet size */ + int outgoing_frag_size; /* sent to peer via FRAG_SIZE when FRAG_YES_LAST set */ + + int outgoing_frag_id; /* each fragment in a datagram is numbered 0 to MAX_FRAGS-1 */ + + struct buffer outgoing; /* outgoing datagram, free if current_frag_id == 0 */ + struct buffer outgoing_return; /* buffer to return outgoing fragment */ + + /* incoming fragments from remote */ + struct fragment_list incoming; +}; + +/* + * Fragment header sent over the wire. + */ + +typedef uint32_t fragment_header_type; + +/* convert a fragment_header_type from host to network order */ +#define hton_fragment_header_type(x) htonl(x) + +/* convert a fragment_header_type from network to host order */ +#define ntoh_fragment_header_type(x) ntohl(x) + +/* FRAG_TYPE 2 bits */ +#define FRAG_TYPE_MASK 0x00000003 +#define FRAG_TYPE_SHIFT 0 + +#define FRAG_WHOLE 0 /* packet is whole, FRAG_N_PACKETS_RECEIVED echoed back to peer */ +#define FRAG_YES_NOTLAST 1 /* packet is a fragment, but is not the last fragment, + FRAG_N_PACKETS_RECEIVED set as above */ +#define FRAG_YES_LAST 2 /* packet is the last fragment, FRAG_SIZE = size of non-last frags */ +#define FRAG_TEST 3 /* control packet for establishing MTU size (not implemented yet) */ + +/* FRAG_SEQ_ID 8 bits */ +#define FRAG_SEQ_ID_MASK 0x000000ff +#define FRAG_SEQ_ID_SHIFT 2 + +/* FRAG_ID 5 bits */ +#define FRAG_ID_MASK 0x0000001f +#define FRAG_ID_SHIFT 10 + +/* + * FRAG_SIZE 14 bits + * + * IF FRAG_YES_LAST (FRAG_SIZE): + * The max size of a fragment. If a fragment is not the last fragment in the packet, + * then the fragment size is guaranteed to be equal to the max fragment size. Therefore, + * max_frag_size is only sent over the wire if FRAG_LAST is set. Otherwise it is assumed + * to be the actual fragment size received. + */ + +/* FRAG_SIZE 14 bits */ +#define FRAG_SIZE_MASK 0x00003fff +#define FRAG_SIZE_SHIFT 15 +#define FRAG_SIZE_ROUND_SHIFT 2 /* fragment/datagram sizes represented as multiple of 4 */ + +#define FRAG_SIZE_ROUND_MASK ((1 << FRAG_SIZE_ROUND_SHIFT) - 1) + +/* + * FRAG_EXTRA 16 bits + * + * IF FRAG_WHOLE or FRAG_YES_NOTLAST, these 16 bits are available (not currently used) + */ + +/* FRAG_EXTRA 16 bits */ +#define FRAG_EXTRA_MASK 0x0000ffff +#define FRAG_EXTRA_SHIFT 15 + +/* + * Public functions + */ + +struct fragment_master *fragment_init (struct frame *frame); + +void fragment_frame_init (struct fragment_master *f, const struct frame *frame); + +void fragment_free (struct fragment_master *f); + +void fragment_incoming (struct fragment_master *f, struct buffer *buf, + const struct frame* frame); + +void fragment_outgoing (struct fragment_master *f, struct buffer *buf, + const struct frame* frame); + +bool fragment_ready_to_send (struct fragment_master *f, struct buffer *buf, + const struct frame* frame); + +/* + * Private functions. + */ +void fragment_wakeup (struct fragment_master *f, struct frame *frame); + +/* + * Inline functions + */ + +static inline void +fragment_housekeeping (struct fragment_master *f, struct frame *frame, struct timeval *tv) +{ + if (event_timeout_trigger (&f->wakeup, tv, ETT_DEFAULT)) + fragment_wakeup (f, frame); +} + +static inline bool +fragment_outgoing_defined (struct fragment_master *f) +{ + return f->outgoing.len > 0; +} + +#endif +#endif diff --git a/gentoo/openvpn.init b/gentoo/openvpn.init new file mode 100755 index 0000000..99fa8b2 --- /dev/null +++ b/gentoo/openvpn.init @@ -0,0 +1,111 @@ +#!/sbin/runscript + +# OpenVPN start/stop script +# Adapted to Gentoo by James Yonan + +# Originally Contributed to the OpenVPN project by +# Douglas Keller <doug@voidstar.dyndns.org> +# 2002.05.15 + +# This script does the following: +# +# - Starts an openvpn process for each .conf file it finds in +# /etc/openvpn. +# +# - If /etc/openvpn/xxx.sh exists for a xxx.conf file then it executes +# it before starting openvpn (useful for doing openvpn --mktun...). + +# - In addition to start/stop you can do: +# +# service openvpn reload - SIGHUP +# service openvpn reopen - SIGUSR1 +# service openvpn status - SIGUSR2 + +# Location of openvpn binary +openvpn=/usr/local/sbin/openvpn + +# PID directory +piddir=/var/run/openvpn + +# Our working directory (.conf files should be here) +work=/etc/openvpn + +# Our options +opts="start stop restart condrestart" + +depend() { + need net + use dns +} + +start() { + ebegin "Starting OpenVPN" + + # Load the TUN/TAP module + /sbin/modprobe tun >/dev/null 2>&1 + + if [ ! -d $piddir ]; then + mkdir $piddir + fi + + cd $work + + # Start every .conf in $work and run .sh if exists + local errors=0 + local successes=0 + local retstatus=0 + for c in `/bin/ls *.conf 2>/dev/null`; do + bn=${c%%.conf} + if [ -f "$bn.sh" ]; then + . $bn.sh + fi + rm -f $piddir/$bn.pid + $openvpn --daemon openvpn-$bn --writepid $piddir/$bn.pid --config $c --cd $work + if [ $? = 0 ]; then + successes=1 + else + errors=1 + fi + done + + # Decide status based on errors/successes. + # If at least one tunnel succeeded, we return success. + # If some tunnels succeeded and some failed, we return + # success but give a warning. + if [ $successes = 1 ]; then + if [ $errors = 1 ]; then + ewarn "Note: At least one OpenVPN tunnel failed to start" + fi + else + retstatus=1 + if [ $errors = 0 ]; then + ewarn "Note: No OpenVPN configuration files were found in $work" + fi + fi + eend $retstatus "Error starting OpenVPN" +} + +stop() { + ebegin "Stopping OpenVPN" + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi + rm -f $pidf + done + eend 0 +} + +# this should really be in runscript.sh +started() { + if [ -L "${svcdir}/started/${myservice}" ]; then + return 1 + else + return 0 + fi +} + +# attempt to restart ONLY if we are already started +condrestart() { + started || restart +} diff --git a/gremlin.c b/gremlin.c new file mode 100644 index 0000000..0a3cf19 --- /dev/null +++ b/gremlin.c @@ -0,0 +1,221 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Test protocol robustness by simulating dropped packets and + * network outages when the --gremlin option is used. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#ifdef ENABLE_DEBUG + +#include "error.h" +#include "common.h" +#include "misc.h" +#include "otime.h" +#include "gremlin.h" + +#include "memdbg.h" + +/* + * Parameters for packet corruption and droppage. + * Each parameter has 4 possible levels, 0 = disabled, + * while 1, 2, and 3 are enumerated in the below arrays. + * The parameter is a 2-bit field within the --gremlin + * parameter. + */ + +/* + * Probability that we will drop a packet is 1 / n + */ +static const int drop_freq[] = { 500, 100, 50 }; + +/* + * Probability that we will corrupt a packet is 1 / n + */ +static const int corrupt_freq[] = { 500, 100, 50 }; + +/* + * When network goes up, it will be up for between + * UP_LOW and UP_HIGH seconds. + */ +static const int up_low[] = { 60, 10, 5 }; +static const int up_high[] = { 600, 60, 10 }; + +/* + * When network goes down, it will be down for between + * DOWN_LOW and DOWN_HIGH seconds. + */ +static const int down_low[] = { 5, 10, 10 }; +static const int down_high[] = { 10, 60, 120 }; + +/* + * Packet flood levels: + * { number of packets, packet size } + */ +static const struct packet_flood_parms packet_flood_data[] = + {{10, 100}, {10, 1500}, {100, 1500}}; + +struct packet_flood_parms +get_packet_flood_parms (int level) +{ + ASSERT (level > 0 && level < 4); + return packet_flood_data [level - 1]; +} + +/* + * Return true with probability 1/n + */ +static bool flip(int n) { + return (get_random() % n) == 0; +} + +/* + * Return uniformly distributed random number between + * low and high. + */ +static int roll(int low, int high) { + int ret; + ASSERT (low <= high); + ret = low + (get_random() % (high - low + 1)); + ASSERT (ret >= low && ret <= high); + return ret; +} + +static bool initialized; /* GLOBAL */ +static bool up; /* GLOBAL */ +static time_t next; /* GLOBAL */ + +/* + * Return false if we should drop a packet. + */ +bool +ask_gremlin (int flags) +{ + const int up_down_level = GREMLIN_UP_DOWN_LEVEL (flags); + const int drop_level = GREMLIN_DROP_LEVEL (flags); + + if (!initialized) + { + initialized = true; + + if (up_down_level) + up = false; + else + up = true; + + next = now; + } + + if (up_down_level) /* change up/down state? */ + { + if (now >= next) + { + int delta; + if (up) + { + delta = roll (down_low[up_down_level-1], down_high[up_down_level-1]); + up = false; + } + else + { + delta = roll (up_low[up_down_level-1], up_high[up_down_level-1]); + up = true; + } + + msg (D_GREMLIN, + "GREMLIN: CONNECTION GOING %s FOR %d SECONDS", + (up ? "UP" : "DOWN"), + delta); + next = now + delta; + } + } + + if (drop_level) + { + if (up && flip (drop_freq[drop_level-1])) + { + dmsg (D_GREMLIN_VERBOSE, "GREMLIN: Random packet drop"); + return false; + } + } + + return up; +} + +/* + * Possibly corrupt a packet. + */ +void corrupt_gremlin (struct buffer *buf, int flags) { + const int corrupt_level = GREMLIN_CORRUPT_LEVEL (flags); + if (corrupt_level) + { + if (flip (corrupt_freq[corrupt_level-1])) + { + do + { + if (buf->len > 0) + { + uint8_t r = roll (0, 255); + int method = roll (0, 5); + + switch (method) { + case 0: /* corrupt the first byte */ + *BPTR (buf) = r; + break; + case 1: /* corrupt the last byte */ + *(BPTR (buf) + buf->len - 1) = r; + break; + case 2: /* corrupt a random byte */ + *(BPTR(buf) + roll (0, buf->len - 1)) = r; + break; + case 3: /* append a random byte */ + buf_write (buf, &r, 1); + break; + case 4: /* reduce length by 1 */ + --buf->len; + break; + case 5: /* reduce length by a random amount */ + buf->len -= roll (0, buf->len - 1); + break; + } + dmsg (D_GREMLIN_VERBOSE, "GREMLIN: Packet Corruption, method=%d", method); + } + else + break; + } while (flip (2)); /* a 50% chance we will corrupt again */ + } + } +} + +#else +static void dummy(void) {} +#endif diff --git a/gremlin.h b/gremlin.h new file mode 100644 index 0000000..9b34880 --- /dev/null +++ b/gremlin.h @@ -0,0 +1,70 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef GREMLIN_H +#define GREMLIN_H + +#ifdef ENABLE_DEBUG + +/* + * Gremlin options, presented as bitmask argument to --gremlin directive + */ + +#define GREMLIN_CONNECTION_FLOOD_SHIFT (0) +#define GREMLIN_CONNECTION_FLOOD_MASK (0x07) + +#define GREMLIN_PACKET_FLOOD_SHIFT (3) +#define GREMLIN_PACKET_FLOOD_MASK (0x03) + +#define GREMLIN_CORRUPT_SHIFT (5) +#define GREMLIN_CORRUPT_MASK (0x03) + +#define GREMLIN_UP_DOWN_SHIFT (7) +#define GREMLIN_UP_DOWN_MASK (0x03) + +#define GREMLIN_DROP_SHIFT (9) +#define GREMLIN_DROP_MASK (0x03) + +/* extract gremlin parms */ + +#define GREMLIN_CONNECTION_FLOOD_LEVEL(x) (((x)>>GREMLIN_CONNECTION_FLOOD_SHIFT) & GREMLIN_CONNECTION_FLOOD_MASK) +#define GREMLIN_PACKET_FLOOD_LEVEL(x) (((x)>>GREMLIN_PACKET_FLOOD_SHIFT) & GREMLIN_PACKET_FLOOD_MASK) +#define GREMLIN_CORRUPT_LEVEL(x) (((x)>>GREMLIN_CORRUPT_SHIFT) & GREMLIN_CORRUPT_MASK) +#define GREMLIN_UP_DOWN_LEVEL(x) (((x)>>GREMLIN_UP_DOWN_SHIFT) & GREMLIN_UP_DOWN_MASK) +#define GREMLIN_DROP_LEVEL(x) (((x)>>GREMLIN_DROP_SHIFT) & GREMLIN_DROP_MASK) + +#include "buffer.h" + +struct packet_flood_parms +{ + int n_packets; + int packet_size; +}; + +bool ask_gremlin (int flags); +void corrupt_gremlin (struct buffer* buf, int flags); +struct packet_flood_parms get_packet_flood_parms (int level); + +#endif +#endif diff --git a/helper.c b/helper.c new file mode 100644 index 0000000..1eb230b --- /dev/null +++ b/helper.c @@ -0,0 +1,369 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "forward.h" +#include "helper.h" +#include "pool.h" +#include "push.h" + +#include "memdbg.h" + +#if P2MP_SERVER + +static const char * +print_netmask (int netbits, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (128, gc); + const in_addr_t netmask = netbits_to_netmask (netbits); + + buf_printf (&out, "%s (/%d)", print_in_addr_t (netmask, 0, gc), netbits); + + return BSTR (&out); +} + +static const char * +print_opt_route_gateway (const in_addr_t route_gateway, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (128, gc); + ASSERT (route_gateway); + buf_printf (&out, "route-gateway %s", print_in_addr_t (route_gateway, 0, gc)); + return BSTR (&out); +} + +static const char * +print_opt_route (const in_addr_t network, const in_addr_t netmask, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (128, gc); + ASSERT (network); + + if (netmask) + buf_printf (&out, "route %s %s", + print_in_addr_t (network, 0, gc), + print_in_addr_t (netmask, 0, gc)); + else + buf_printf (&out, "route %s", + print_in_addr_t (network, 0, gc)); + + return BSTR (&out); +} + +static const char * +print_str_int (const char *str, const int i, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (128, gc); + buf_printf (&out, "%s %d", str, i); + return BSTR (&out); +} + +static void +helper_add_route (const in_addr_t network, const in_addr_t netmask, struct options *o) +{ + rol_check_alloc (o); + add_route_to_option_list (o->routes, + print_in_addr_t (network, 0, &o->gc), + print_in_addr_t (netmask, 0, &o->gc), + NULL, + NULL); +} + +static void +verify_common_subnet (const char *opt, const in_addr_t a, const in_addr_t b, const in_addr_t subnet) +{ + struct gc_arena gc = gc_new (); + if ((a & subnet) != (b & subnet)) + msg (M_USAGE, "%s IP addresses %s and %s are not in the same %s subnet", + opt, + print_in_addr_t (a, 0, &gc), + print_in_addr_t (b, 0, &gc), + print_in_addr_t (subnet, 0, &gc)); + gc_free (&gc); +} + +#endif + +/* + * Process server, server-bridge, and client helper + * directives after the parameters themselves have been + * parsed and placed in struct options. + */ +void +helper_client_server (struct options *o) +{ + struct gc_arena gc = gc_new (); + +#if P2MP +#if P2MP_SERVER + /* + * + * HELPER DIRECTIVE: + * + * server 10.8.0.0 255.255.255.0 + * + * EXPANDS TO: + * + * mode server + * tls-server + * + * if tun: + * ifconfig 10.8.0.1 10.8.0.2 + * ifconfig-pool 10.8.0.4 10.8.0.251 + * route 10.8.0.0 255.255.255.0 + * if client-to-client: + * push "route 10.8.0.0 255.255.255.0" + * else if !linear-addr: + * push "route 10.8.0.1" + * + * if tap: + * ifconfig 10.8.0.1 255.255.255.0 + * ifconfig-pool 10.8.0.2 10.8.0.254 255.255.255.0 + * push "route-gateway 10.8.0.1" + */ + + /* + * Get tun/tap/null device type + */ + const int dev = dev_type_enum (o->dev, o->dev_type); + + if (o->server_defined) + { + int netbits = -2; + bool status = false; + + if (o->client) + msg (M_USAGE, "--server and --client cannot be used together"); + + if (o->server_bridge_defined) + msg (M_USAGE, "--server and --server-bridge cannot be used together"); + + if (o->shared_secret_file) + msg (M_USAGE, "--server and --secret cannot be used together (you must use SSL/TLS keys)"); + + if (o->ifconfig_pool_defined) + msg (M_USAGE, "--server already defines an ifconfig-pool, so you can't also specify --ifconfig-pool explicitly"); + + if (!(dev == DEV_TYPE_TAP || dev == DEV_TYPE_TUN)) + msg (M_USAGE, "--server directive only makes sense with --dev tun or --dev tap"); + + status = netmask_to_netbits (o->server_network, o->server_netmask, &netbits); + if (!status) + msg (M_USAGE, "--server directive network/netmask combination is invalid"); + + if (netbits < 0) + msg (M_USAGE, "--server directive netmask is invalid"); + + if (netbits < IFCONFIG_POOL_MIN_NETBITS) + msg (M_USAGE, "--server directive netmask allows for too many host addresses (subnet must be %s or higher)", + print_netmask (IFCONFIG_POOL_MIN_NETBITS, &gc)); + + if (dev == DEV_TYPE_TUN) + { + int pool_end_reserve = 4; + + if (netbits > 29) + msg (M_USAGE, "--server directive when used with --dev tun must define a subnet of %s or lower", + print_netmask (29, &gc)); + + if (netbits == 29) + pool_end_reserve = 0; + + o->mode = MODE_SERVER; + o->tls_server = true; + o->ifconfig_local = print_in_addr_t (o->server_network + 1, 0, &o->gc); + o->ifconfig_remote_netmask = print_in_addr_t (o->server_network + 2, 0, &o->gc); + o->ifconfig_pool_defined = true; + o->ifconfig_pool_start = o->server_network + 4; + o->ifconfig_pool_end = (o->server_network | ~o->server_netmask) - pool_end_reserve; + helper_add_route (o->server_network, o->server_netmask, o); + if (o->enable_c2c) + push_option (o, print_opt_route (o->server_network, o->server_netmask, &o->gc), M_USAGE); + else if (!o->ifconfig_pool_linear) + push_option (o, print_opt_route (o->server_network + 1, 0, &o->gc), M_USAGE); + } + else if (dev == DEV_TYPE_TAP) + { + if (netbits >= 30) + msg (M_USAGE, "--server directive when used with --dev tap must define a subnet of %s or lower", + print_netmask (30, &gc)); + + o->mode = MODE_SERVER; + o->tls_server = true; + o->ifconfig_local = print_in_addr_t (o->server_network + 1, 0, &o->gc); + o->ifconfig_remote_netmask = print_in_addr_t (o->server_netmask, 0, &o->gc); + o->ifconfig_pool_defined = true; + o->ifconfig_pool_start = o->server_network + 2; + o->ifconfig_pool_end = (o->server_network | ~o->server_netmask) - 1; + o->ifconfig_pool_netmask = o->server_netmask; + push_option (o, print_opt_route_gateway (o->server_network + 1, &o->gc), M_USAGE); + } + else + { + ASSERT (0); + } + + if (o->proto == PROTO_TCPv4) + o->proto = PROTO_TCPv4_SERVER; + } + + /* + * HELPER DIRECTIVE: + * + * server-bridge 10.8.0.4 255.255.255.0 10.8.0.128 10.8.0.254 + * + * EXPANDS TO: + * + * mode server + * tls-server + * + * ifconfig-pool 10.8.0.128 10.8.0.254 255.255.255.0 + * push "route-gateway 10.8.0.4" + */ + else if (o->server_bridge_defined) + { + if (o->client) + msg (M_USAGE, "--server-bridge and --client cannot be used together"); + + if (o->ifconfig_pool_defined) + msg (M_USAGE, "--server-bridge already defines an ifconfig-pool, so you can't also specify --ifconfig-pool explicitly"); + + if (o->shared_secret_file) + msg (M_USAGE, "--server-bridge and --secret cannot be used together (you must use SSL/TLS keys)"); + + if (dev != DEV_TYPE_TAP) + msg (M_USAGE, "--server-bridge directive only makes sense with --dev tap"); + + verify_common_subnet ("--server-bridge", o->server_bridge_ip, o->server_bridge_pool_start, o->server_bridge_netmask); + verify_common_subnet ("--server-bridge", o->server_bridge_pool_start, o->server_bridge_pool_end, o->server_bridge_netmask); + verify_common_subnet ("--server-bridge", o->server_bridge_ip, o->server_bridge_pool_end, o->server_bridge_netmask); + + o->mode = MODE_SERVER; + o->tls_server = true; + o->ifconfig_pool_defined = true; + o->ifconfig_pool_start = o->server_bridge_pool_start; + o->ifconfig_pool_end = o->server_bridge_pool_end; + o->ifconfig_pool_netmask = o->server_bridge_netmask; + push_option (o, print_opt_route_gateway (o->server_bridge_ip, &o->gc), M_USAGE); + + if (o->proto == PROTO_TCPv4) + o->proto = PROTO_TCPv4_SERVER; + } + else +#endif /* P2MP_SERVER */ + + /* + * HELPER DIRECTIVE: + * + * client + * + * EXPANDS TO: + * + * pull + * tls-client + */ + if (o->client) + { + if (o->key_method != 2) + msg (M_USAGE, "--client requires --key-method 2"); + + o->pull = true; + o->tls_client = true; + + if (o->proto == PROTO_TCPv4) + o->proto = PROTO_TCPv4_CLIENT; + } + +#endif /* P2MP */ + + if (o->proto == PROTO_TCPv4) + msg (M_USAGE, "--proto tcp is ambiguous in this context. Please specify --proto tcp-server or --proto tcp-client"); + + gc_free (&gc); +} + +/* + * + * HELPER DIRECTIVE: + * + * keepalive 10 60 + * + * EXPANDS TO: + * + * if mode server: + * ping 10 + * ping-restart 120 + * push "ping 10" + * push "ping-restart 60" + * else + * ping 10 + * ping-restart 60 + */ +void +helper_keepalive (struct options *o) +{ + if (o->keepalive_ping || o->keepalive_timeout) + { + /* + * Sanity checks. + */ + if (o->keepalive_ping <= 0 || o->keepalive_timeout <= 0) + msg (M_USAGE, "--keepalive parameters must be > 0"); + if (o->keepalive_ping * 2 > o->keepalive_timeout) + msg (M_USAGE, "the second parameter to --keepalive (restart timeout=%d) must be at least twice the value of the first parameter (ping interval=%d). A ratio of 1:5 or 1:6 would be even better. Recommended setting is --keepalive 10 60.", + o->keepalive_timeout, + o->keepalive_ping); + if (o->ping_send_timeout || o->ping_rec_timeout) + msg (M_USAGE, "--keepalive conflicts with --ping, --ping-exit, or --ping-restart. If you use --keepalive, you don't need any of the other --ping directives."); + + /* + * Expand. + */ + if (o->mode == MODE_POINT_TO_POINT) + { + o->ping_rec_timeout_action = PING_RESTART; + o->ping_send_timeout = o->keepalive_ping; + o->ping_rec_timeout = o->keepalive_timeout; + } +#if P2MP_SERVER + else if (o->mode == MODE_SERVER) + { + o->ping_rec_timeout_action = PING_RESTART; + o->ping_send_timeout = o->keepalive_ping; + o->ping_rec_timeout = o->keepalive_timeout * 2; + push_option (o, print_str_int ("ping", o->keepalive_ping, &o->gc), M_USAGE); + push_option (o, print_str_int ("ping-restart", o->keepalive_timeout, &o->gc), M_USAGE); + } +#endif + else + { + ASSERT (0); + } + } +} diff --git a/helper.h b/helper.h new file mode 100644 index 0000000..7e9501c --- /dev/null +++ b/helper.h @@ -0,0 +1,37 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Process helper directives such as server, client, and keepalive. + */ + +#ifndef HELPER_H +#define HELPER_H + +#include "options.h" + +void helper_keepalive (struct options *o); +void helper_client_server (struct options *o); + +#endif diff --git a/images/install-whirl.bmp b/images/install-whirl.bmp Binary files differnew file mode 100755 index 0000000..07133e3 --- /dev/null +++ b/images/install-whirl.bmp diff --git a/images/openvpn.ico b/images/openvpn.ico Binary files differnew file mode 100755 index 0000000..86599f4 --- /dev/null +++ b/images/openvpn.ico @@ -0,0 +1,2727 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "win32.h" +#include "init.h" +#include "sig.h" +#include "occ.h" +#include "list.h" +#include "otime.h" +#include "pool.h" +#include "gremlin.h" + +#include "memdbg.h" + +#include "occ-inline.h" + +/* + * Crypto initialization flags + */ +#define CF_LOAD_PERSISTED_PACKET_ID (1<<0) +#define CF_INIT_TLS_MULTI (1<<1) +#define CF_INIT_TLS_AUTH_STANDALONE (1<<2) + +static void do_init_first_time (struct context *c); + +void +context_clear (struct context *c) +{ + CLEAR (*c); +} + +void +context_clear_1 (struct context *c) +{ + CLEAR (c->c1); +} + +void +context_clear_2 (struct context *c) +{ + CLEAR (c->c2); +} + +void +context_clear_all_except_first_time (struct context *c) +{ + const bool first_time_save = c->first_time; + context_clear (c); + c->first_time = first_time_save; +} + +/* + * Initialize and possibly randomize remote list. + */ +static void +init_remote_list (struct context *c) +{ + c->c1.remote_list = NULL; + + if (c->options.remote_list) + { + struct remote_list *l; + ALLOC_OBJ_GC (c->c1.remote_list, struct remote_list, &c->gc); + l = c->c1.remote_list; + *l = *c->options.remote_list; + l->current = -1; + if (c->options.remote_random) + remote_list_randomize (l); + } +} + +void +context_init_1 (struct context *c) +{ + context_clear_1 (c); + + packet_id_persist_init (&c->c1.pid_persist); + init_remote_list (c); + +#if defined(USE_CRYPTO) && defined(USE_SSL) + /* Certificate password input */ + if (c->options.key_pass_file) + pem_password_setup (c->options.key_pass_file); +#endif + +#if P2MP + /* Auth user/pass input */ + if (c->options.auth_user_pass_file) + { + auth_user_pass_setup (c->options.auth_user_pass_file); + } +#endif + +#ifdef ENABLE_HTTP_PROXY + if (c->options.http_proxy_options) + { + /* Possible HTTP proxy user/pass input */ + c->c1.http_proxy = new_http_proxy (c->options.http_proxy_options, + &c->gc); + } +#endif + +#ifdef ENABLE_SOCKS + if (c->options.socks_proxy_server) + { + c->c1.socks_proxy = new_socks_proxy (c->options.socks_proxy_server, + c->options.socks_proxy_port, + c->options.socks_proxy_retry, + &c->gc); + } +#endif +} + +void +context_gc_free (struct context *c) +{ + gc_free (&c->c2.gc); + gc_free (&c->options.gc); + gc_free (&c->gc); +} + +bool +init_static (void) +{ +#if defined(USE_CRYPTO) && defined(DMALLOC) + openssl_dmalloc_init (); +#endif + + init_random_seed (); /* init random() function, only used as + source for weak random numbers */ + error_reset (); /* initialize error.c */ + reset_check_status (); /* initialize status check code in socket.c */ + +#ifdef WIN32 + init_win32 (); +#endif + +#ifdef OPENVPN_DEBUG_COMMAND_LINE + { + int i; + for (i = 0; i < argc; ++i) + msg (M_INFO, "argv[%d] = '%s'", i, argv[i]); + } +#endif + + update_time (); + +#ifdef USE_CRYPTO + init_ssl_lib (); + + /* init PRNG used for IV generation */ + /* When forking, copy this to more places in the code to avoid fork + random-state predictability */ + prng_init (); +#endif + +#ifdef PID_TEST + packet_id_interactive_test (); /* test the sequence number code */ + return false; +#endif + +#ifdef SCHEDULE_TEST + schedule_test (); + return false; +#endif + +#ifdef LIST_TEST + list_test (); + return false; +#endif + +#ifdef IFCONFIG_POOL_TEST + ifconfig_pool_test (0x0A010004, 0x0A0100FF); + return false; +#endif + +#ifdef CHARACTER_CLASS_DEBUG + character_class_debug (); + return false; +#endif + +#ifdef EXTRACT_X509_FIELD_TEST + extract_x509_field_test (); + return false; +#endif + + return true; +} + +void +uninit_static (void) +{ + openvpn_thread_cleanup (); + +#ifdef USE_CRYPTO + free_ssl_lib (); +#endif + +#if defined(MEASURE_TLS_HANDSHAKE_STATS) && defined(USE_CRYPTO) && defined(USE_SSL) + show_tls_performance_stats (); +#endif +} + +void +init_verb_mute (struct context *c, unsigned int flags) +{ + if (flags & IVM_LEVEL_1) + { + /* set verbosity and mute levels */ + set_check_status (D_LINK_ERRORS, D_READ_WRITE); + set_debug_level (c->options.verbosity, SDL_CONSTRAIN); + set_mute_cutoff (c->options.mute); + } + + /* special D_LOG_RW mode */ + if (flags & IVM_LEVEL_2) + c->c2.log_rw = (check_debug_level (D_LOG_RW) && !check_debug_level (D_LOG_RW + 1)); +} + +/* + * Possibly set --dev based on --dev-node. + * For example, if --dev-node /tmp/foo/tun, and --dev undefined, + * set --dev to tun. + */ +void +init_options_dev (struct options *options) +{ + if (!options->dev) + options->dev = dev_component_in_dev_node (options->dev_node); +} + +bool +print_openssl_info (const struct options *options) +{ + /* + * OpenSSL info print mode? + */ +#ifdef USE_CRYPTO + if (options->show_ciphers || options->show_digests || options->show_engines +#ifdef USE_SSL + || options->show_tls_ciphers +#endif + ) + { + if (options->show_ciphers) + show_available_ciphers (); + if (options->show_digests) + show_available_digests (); + if (options->show_engines) + show_available_engines (); +#ifdef USE_SSL + if (options->show_tls_ciphers) + show_available_tls_ciphers (); +#endif + return true; + } +#endif + return false; +} + +/* + * Static pre-shared key generation mode? + */ +bool +do_genkey (const struct options * options) +{ +#ifdef USE_CRYPTO + if (options->genkey) + { + int nbits_written; + + notnull (options->shared_secret_file, + "shared secret output file (--secret)"); + + if (options->mlock) /* should we disable paging? */ + do_mlockall (true); + + nbits_written = write_key_file (2, options->shared_secret_file); + + msg (D_GENKEY | M_NOPREFIX, + "Randomly generated %d bit key written to %s", nbits_written, + options->shared_secret_file); + return true; + } +#endif + return false; +} + +/* + * Persistent TUN/TAP device management mode? + */ +bool +do_persist_tuntap (const struct options *options) +{ +#ifdef TUNSETPERSIST + if (options->persist_config) + { + /* sanity check on options for --mktun or --rmtun */ + notnull (options->dev, "TUN/TAP device (--dev)"); + if (options->remote_list || options->ifconfig_local + || options->ifconfig_remote_netmask +#ifdef USE_CRYPTO + || options->shared_secret_file +#ifdef USE_SSL + || options->tls_server || options->tls_client +#endif +#endif + ) + msg (M_FATAL|M_OPTERR, + "options --mktun or --rmtun should only be used together with --dev"); + tuncfg (options->dev, options->dev_type, options->dev_node, + options->tun_ipv6, options->persist_mode); + return true; + } +#endif + return false; +} + +/* + * Should we become a daemon? + * Return true if we did it. + */ +static bool +possibly_become_daemon (const struct options *options, const bool first_time) +{ + bool ret = false; + if (first_time && options->daemon) + { + ASSERT (!options->inetd); + if (daemon (options->cd_dir != NULL, options->log) < 0) + msg (M_ERR, "daemon() failed"); + if (options->log) + set_std_files_to_null (true); + ret = true; + } + return ret; +} + +/* + * Actually do UID/GID downgrade, and chroot, if requested. + */ +static void +do_uid_gid_chroot (struct context *c, bool no_delay) +{ + static const char why_not[] = "will be delayed because of --client, --pull, or --up-delay"; + + if (c->first_time && !c->c2.uid_gid_set) + { + /* chroot if requested */ + if (c->options.chroot_dir) + { + if (no_delay) + do_chroot (c->options.chroot_dir); + else + msg (M_INFO, "NOTE: chroot %s", why_not); + } + + /* set user and/or group that we want to setuid/setgid to */ + if (no_delay) + { + set_group (&c->c2.group_state); + set_user (&c->c2.user_state); + c->c2.uid_gid_set = true; + } + else if (c->c2.uid_gid_specified) + { + msg (M_INFO, "NOTE: UID/GID downgrade %s", why_not); + } + } +} + +/* + * Return common name in a way that is formatted for + * prepending to msg() output. + */ +const char * +format_common_name (struct context *c, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); +#if defined(USE_CRYPTO) && defined(USE_SSL) + if (c->c2.tls_multi) + { + buf_printf (&out, "[%s] ", tls_common_name (c->c2.tls_multi, false)); + } +#endif + return BSTR (&out); +} + +void +pre_setup (const struct options *options) +{ +#ifdef WIN32 + if (options->exit_event_name) + { + win32_signal_open (&win32_signal, + WSO_FORCE_SERVICE, + options->exit_event_name, + options->exit_event_initial_state); + } + else + { + win32_signal_open (&win32_signal, + WSO_FORCE_CONSOLE, + NULL, + false); + + /* put a title on the top window bar */ + if (win32_signal.mode == WSO_MODE_CONSOLE) + { + window_title_save (&window_title); + window_title_generate (options->config); + } + } +#endif +} + +void +reset_coarse_timers (struct context *c) +{ + c->c2.coarse_timer_wakeup = 0; +} + +/* + * Initialize timers + */ +static void +do_init_timers (struct context *c, bool deferred) +{ + update_time (); + reset_coarse_timers (c); + + /* initialize inactivity timeout */ + if (c->options.inactivity_timeout) + event_timeout_init (&c->c2.inactivity_interval, c->options.inactivity_timeout, now); + + /* initialize pings */ + + if (c->options.ping_send_timeout) + event_timeout_init (&c->c2.ping_send_interval, c->options.ping_send_timeout, 0); + + if (c->options.ping_rec_timeout) + event_timeout_init (&c->c2.ping_rec_interval, c->options.ping_rec_timeout, now); + + if (!deferred) + { + /* initialize connection establishment timer */ + event_timeout_init (&c->c2.wait_for_connect, 1, now); + +#ifdef ENABLE_OCC + /* initialize occ timers */ + + if (c->options.occ + && !TLS_MODE (c) + && c->c2.options_string_local && c->c2.options_string_remote) + event_timeout_init (&c->c2.occ_interval, OCC_INTERVAL_SECONDS, now); + + if (c->options.mtu_test) + event_timeout_init (&c->c2.occ_mtu_load_test_interval, OCC_MTU_LOAD_INTERVAL_SECONDS, now); +#endif + + /* initialize packet_id persistence timer */ +#ifdef USE_CRYPTO + if (c->options.packet_id_file) + event_timeout_init (&c->c2.packet_id_persist_interval, 60, now); +#endif + +#if defined(USE_CRYPTO) && defined(USE_SSL) + /* initialize tmp_int optimization that limits the number of times we call + tls_multi_process in the main event loop */ + interval_init (&c->c2.tmp_int, TLS_MULTI_HORIZON, TLS_MULTI_REFRESH); +#endif + } +} + +/* + * Initialize traffic shaper. + */ +static void +do_init_traffic_shaper (struct context *c) +{ +#ifdef HAVE_GETTIMEOFDAY + /* initialize traffic shaper (i.e. transmit bandwidth limiter) */ + if (c->options.shaper) + { + shaper_init (&c->c2.shaper, c->options.shaper); + shaper_msg (&c->c2.shaper); + } +#endif +} + +/* + * Allocate a route list structure if at least one + * --route option was specified. + */ +static void +do_alloc_route_list (struct context *c) +{ + if (c->options.routes && !c->c1.route_list) + c->c1.route_list = new_route_list (&c->gc); +} + + +/* + * Initialize the route list, resolving any DNS names in route + * options and saving routes in the environment. + */ +static void +do_init_route_list (const struct options *options, + struct route_list *route_list, + const struct link_socket_info *link_socket_info, + bool fatal, + struct env_set *es) +{ + const char *gw = NULL; + int dev = dev_type_enum (options->dev, options->dev_type); + + if (dev == DEV_TYPE_TUN) + gw = options->ifconfig_remote_netmask; + if (options->route_default_gateway) + gw = options->route_default_gateway; + + if (!init_route_list (route_list, + options->routes, + gw, + link_socket_current_remote (link_socket_info), + es)) + { + if (fatal) + openvpn_exit (OPENVPN_EXIT_STATUS_ERROR); /* exit point */ + } + else + { + /* copy routes to environment */ + setenv_routes (es, route_list); + } +} + +/* + * Called after all initialization has been completed. + */ +void +initialization_sequence_completed (struct context *c, const unsigned int flags) +{ + static const char message[] = "Initialization Sequence Completed"; + + /* If we delayed UID/GID downgrade or chroot, do it now */ + do_uid_gid_chroot (c, true); + + /* Test if errors */ + if (flags & ISC_ERRORS) +#ifdef WIN32 + msg (M_INFO, "%s With Errors ( see http://openvpn.net/faq.html#dhcpclientserv )", message); +#else + msg (M_INFO, "%s With Errors", message); +#endif + else + msg (M_INFO, "%s", message); + + /* Flag remote_list that we initialized */ + if ((flags & (ISC_ERRORS|ISC_SERVER)) == 0 && c->c1.remote_list && c->c1.remote_list->len > 1) + c->c1.remote_list->no_advance = true; + +#ifdef ENABLE_MANAGEMENT + /* Tell management interface that we initialized */ + if (management) + { + in_addr_t tun_local = 0; + const char *detail = "SUCCESS"; + if (c->c1.tuntap) + tun_local = c->c1.tuntap->local; + if (flags & ISC_ERRORS) + detail = "ERROR"; + management_set_state (management, + OPENVPN_STATE_CONNECTED, + detail, + tun_local); + if (tun_local) + management_post_tunnel_open (management, tun_local); + } +#endif + +} + +/* + * Possibly add routes and/or call route-up script + * based on options. + */ +void +do_route (const struct options *options, + struct route_list *route_list, + const struct tuntap *tt, + const struct plugin_list *plugins, + struct env_set *es) +{ + if (!options->route_noexec && route_list) + add_routes (route_list, tt, ROUTE_OPTION_FLAGS (options), es); + + if (plugin_defined (plugins, OPENVPN_PLUGIN_ROUTE_UP)) + { + if (plugin_call (plugins, OPENVPN_PLUGIN_ROUTE_UP, NULL, es)) + msg (M_WARN, "WARNING: route-up plugin call failed"); + } + + if (options->route_script) + { + setenv_str (es, "script_type", "route-up"); + system_check (options->route_script, es, S_SCRIPT, "Route script failed"); + } + +#ifdef WIN32 + if (options->show_net_up) + { + show_routes (M_INFO|M_NOPREFIX); + show_adapters (M_INFO|M_NOPREFIX); + } + else if (check_debug_level (D_SHOW_NET)) + { + show_routes (D_SHOW_NET|M_NOPREFIX); + show_adapters (D_SHOW_NET|M_NOPREFIX); + } +#endif +} + +/* + * Save current pulled options string in the c1 context store, so we can + * compare against it after possible future restarts. + */ +#if P2MP +static void +save_pulled_options_string (struct context *c, const char *newstring) +{ + if (c->c1.pulled_options_string_save) + free (c->c1.pulled_options_string_save); + + c->c1.pulled_options_string_save = NULL; + + if (newstring) + c->c1.pulled_options_string_save = string_alloc (newstring, NULL); +} +#endif + +/* + * initialize tun/tap device object + */ +static void +do_init_tun (struct context *c) +{ + c->c1.tuntap = init_tun (c->options.dev, + c->options.dev_type, + c->options.ifconfig_local, + c->options.ifconfig_remote_netmask, + addr_host (&c->c1.link_socket_addr.local), + addr_host (&c->c1.link_socket_addr.remote), + !c->options.ifconfig_nowarn, + c->c2.es); + + init_tun_post (c->c1.tuntap, + &c->c2.frame, + &c->options.tuntap_options); + + c->c1.tuntap_owned = true; +} + +/* + * Open tun/tap device, ifconfig, call up script, etc. + */ + +static bool +do_open_tun (struct context *c) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + + c->c2.ipv4_tun = (!c->options.tun_ipv6 + && is_dev_type (c->options.dev, c->options.dev_type, "tun")); + + if (!c->c1.tuntap) + { + /* initialize (but do not open) tun/tap object */ + do_init_tun (c); + + /* allocate route list structure */ + do_alloc_route_list (c); + + /* parse and resolve the route option list */ + if (c->c1.route_list && c->c2.link_socket) + do_init_route_list (&c->options, c->c1.route_list, &c->c2.link_socket->info, false, c->c2.es); + + /* do ifconfig */ + if (!c->options.ifconfig_noexec + && ifconfig_order () == IFCONFIG_BEFORE_TUN_OPEN) + { + /* guess actual tun/tap unit number that will be returned + by open_tun */ + const char *guess = guess_tuntap_dev (c->options.dev, + c->options.dev_type, + c->options.dev_node, + &gc); + do_ifconfig (c->c1.tuntap, guess, TUN_MTU_SIZE (&c->c2.frame), c->c2.es); + } + + /* open the tun device */ + open_tun (c->options.dev, c->options.dev_type, c->options.dev_node, + c->options.tun_ipv6, c->c1.tuntap); + + /* do ifconfig */ + if (!c->options.ifconfig_noexec + && ifconfig_order () == IFCONFIG_AFTER_TUN_OPEN) + { + do_ifconfig (c->c1.tuntap, c->c1.tuntap->actual_name, TUN_MTU_SIZE (&c->c2.frame), c->c2.es); + } + + /* run the up script */ + run_up_down (c->options.up_script, + c->c1.plugins, + OPENVPN_PLUGIN_UP, + c->c1.tuntap->actual_name, + TUN_MTU_SIZE (&c->c2.frame), + EXPANDED_SIZE (&c->c2.frame), + print_in_addr_t (c->c1.tuntap->local, IA_EMPTY_IF_UNDEF, &gc), + print_in_addr_t (c->c1.tuntap->remote_netmask, IA_EMPTY_IF_UNDEF, &gc), + "init", + NULL, + "up", + c->c2.es); + + /* possibly add routes */ + if (!c->options.route_delay_defined) + do_route (&c->options, c->c1.route_list, c->c1.tuntap, c->c1.plugins, c->c2.es); + + /* + * Did tun/tap driver give us an MTU? + */ + if (c->c1.tuntap->post_open_mtu) + frame_set_mtu_dynamic (&c->c2.frame, + c->c1.tuntap->post_open_mtu, + SET_MTU_TUN | SET_MTU_UPPER_BOUND); + + ret = true; + } + else + { + msg (M_INFO, "Preserving previous TUN/TAP instance: %s", + c->c1.tuntap->actual_name); + + /* run the up script if user specified --up-restart */ + if (c->options.up_restart) + run_up_down (c->options.up_script, + c->c1.plugins, + OPENVPN_PLUGIN_UP, + c->c1.tuntap->actual_name, + TUN_MTU_SIZE (&c->c2.frame), + EXPANDED_SIZE (&c->c2.frame), + print_in_addr_t (c->c1.tuntap->local, IA_EMPTY_IF_UNDEF, &gc), + print_in_addr_t (c->c1.tuntap->remote_netmask, IA_EMPTY_IF_UNDEF, &gc), + "restart", + NULL, + "up", + c->c2.es); + } + gc_free (&gc); + return ret; +} + +/* + * Close TUN/TAP device + */ + +static void +do_close_tun_simple (struct context *c) +{ + msg (D_CLOSE, "Closing TUN/TAP interface"); + close_tun (c->c1.tuntap); + c->c1.tuntap = NULL; + c->c1.tuntap_owned = false; +#if P2MP + save_pulled_options_string (c, NULL); /* delete C1-saved pulled_options_string */ +#endif +} + +static void +do_close_tun (struct context *c, bool force) +{ + struct gc_arena gc = gc_new (); + if (c->c1.tuntap && c->c1.tuntap_owned) + { + const char *tuntap_actual = string_alloc (c->c1.tuntap->actual_name, &gc); + const in_addr_t local = c->c1.tuntap->local; + const in_addr_t remote_netmask = c->c1.tuntap->remote_netmask; + + if (force || !(c->sig->signal_received == SIGUSR1 && c->options.persist_tun)) + { +#ifdef ENABLE_MANAGEMENT + /* tell management layer we are about to close the TUN/TAP device */ + if (management) + management_pre_tunnel_close (management); +#endif + + /* delete any routes we added */ + if (c->c1.route_list) + delete_routes (c->c1.route_list, c->c1.tuntap, ROUTE_OPTION_FLAGS (&c->options), c->c2.es); + + /* actually close tun/tap device based on --down-pre flag */ + if (!c->options.down_pre) + do_close_tun_simple (c); + + /* Run the down script -- note that it will run at reduced + privilege if, for example, "--user nobody" was used. */ + run_up_down (c->options.down_script, + c->c1.plugins, + OPENVPN_PLUGIN_DOWN, + tuntap_actual, + TUN_MTU_SIZE (&c->c2.frame), + EXPANDED_SIZE (&c->c2.frame), + print_in_addr_t (local, IA_EMPTY_IF_UNDEF, &gc), + print_in_addr_t (remote_netmask, IA_EMPTY_IF_UNDEF, &gc), + "init", + signal_description (c->sig->signal_received, + c->sig->signal_text), + "down", + c->c2.es); + + /* actually close tun/tap device based on --down-pre flag */ + if (c->options.down_pre) + do_close_tun_simple (c); + } + else + { + /* run the down script on this restart if --up-restart was specified */ + if (c->options.up_restart) + run_up_down (c->options.down_script, + c->c1.plugins, + OPENVPN_PLUGIN_DOWN, + tuntap_actual, + TUN_MTU_SIZE (&c->c2.frame), + EXPANDED_SIZE (&c->c2.frame), + print_in_addr_t (local, IA_EMPTY_IF_UNDEF, &gc), + print_in_addr_t (remote_netmask, IA_EMPTY_IF_UNDEF, &gc), + "restart", + signal_description (c->sig->signal_received, + c->sig->signal_text), + "down", + c->c2.es); + } + } + gc_free (&gc); +} + +/* + * Handle delayed tun/tap interface bringup due to --up-delay or --pull + */ + +void +do_up (struct context *c, bool pulled_options, unsigned int option_types_found) +{ + if (!c->c2.do_up_ran) + { + reset_coarse_timers (c); + + if (pulled_options && option_types_found) + do_deferred_options (c, option_types_found); + + /* if --up-delay specified, open tun, do ifconfig, and run up script now */ + if (c->options.up_delay || PULL_DEFINED (&c->options)) + { + c->c2.did_open_tun = do_open_tun (c); + update_time (); + +#if P2MP + /* + * Was tun interface object persisted from previous restart iteration, + * and if so did pulled options string change from previous iteration? + */ + if (!c->c2.did_open_tun + && PULL_DEFINED (&c->options) + && c->c1.tuntap + && (!c->c1.pulled_options_string_save || !c->c2.pulled_options_string + || strcmp (c->c1.pulled_options_string_save, c->c2.pulled_options_string))) + { + /* if so, close tun, delete routes, then reinitialize tun and add routes */ + msg (M_INFO, "NOTE: Pulled options changed on restart, will need to close and reopen TUN/TAP device."); + do_close_tun (c, true); + openvpn_sleep (1); + c->c2.did_open_tun = do_open_tun (c); + update_time (); + } +#endif + } + + if (c->c2.did_open_tun) + { +#if P2MP + save_pulled_options_string (c, c->c2.pulled_options_string); +#endif + + /* if --route-delay was specified, start timer */ + if (c->options.route_delay_defined) + { + event_timeout_init (&c->c2.route_wakeup, c->options.route_delay, now); + event_timeout_init (&c->c2.route_wakeup_expire, c->options.route_delay + c->options.route_delay_window, now); + } + else + { + initialization_sequence_completed (c, 0); /* client/p2p --route-delay undefined */ + } + } + else if (c->options.mode == MODE_POINT_TO_POINT) + { + initialization_sequence_completed (c, 0); /* client/p2p restart with --persist-tun */ + } + + c->c2.do_up_ran = true; + } +} + +/* + * These are the option categories which will be accepted by pull. + */ +unsigned int +pull_permission_mask (void) +{ + return ( OPT_P_UP + | OPT_P_ROUTE + | OPT_P_IPWIN32 + | OPT_P_SETENV + | OPT_P_SHAPER + | OPT_P_TIMER + | OPT_P_PERSIST + | OPT_P_MESSAGES + | OPT_P_EXPLICIT_NOTIFY + | OPT_P_ECHO); +} + +/* + * Handle non-tun-related pulled options. + */ +void +do_deferred_options (struct context *c, const unsigned int found) +{ + if (found & OPT_P_MESSAGES) + { + init_verb_mute (c, IVM_LEVEL_1|IVM_LEVEL_2); + msg (D_PUSH, "OPTIONS IMPORT: --verb and/or --mute level changed"); + } + if (found & OPT_P_TIMER) + { + do_init_timers (c, true); + msg (D_PUSH, "OPTIONS IMPORT: timers and/or timeouts modified"); + } + +#ifdef ENABLE_OCC + if (found & OPT_P_EXPLICIT_NOTIFY) + { + if (c->options.proto != PROTO_UDPv4 && c->options.explicit_exit_notification) + { + msg (D_PUSH, "OPTIONS IMPORT: --explicit-exit-notify can only be used with --proto udp"); + c->options.explicit_exit_notification = 0; + } + else + msg (D_PUSH, "OPTIONS IMPORT: explicit notify parm(s) modified"); + } +#endif + + if (found & OPT_P_SHAPER) + { + msg (D_PUSH, "OPTIONS IMPORT: traffic shaper enabled"); + do_init_traffic_shaper (c); + } + + if (found & OPT_P_PERSIST) + msg (D_PUSH, "OPTIONS IMPORT: --persist options modified"); + if (found & OPT_P_UP) + msg (D_PUSH, "OPTIONS IMPORT: --ifconfig/up options modified"); + if (found & OPT_P_ROUTE) + msg (D_PUSH, "OPTIONS IMPORT: route options modified"); + if (found & OPT_P_IPWIN32) + msg (D_PUSH, "OPTIONS IMPORT: --ip-win32 and/or --dhcp-option options modified"); + if (found & OPT_P_SETENV) + msg (D_PUSH, "OPTIONS IMPORT: environment modified"); +} + +/* + * Possible hold on initialization + */ +static bool +do_hold (struct context *c) +{ +#ifdef ENABLE_MANAGEMENT + if (management) + { + /* if c is defined, daemonize before hold */ + if (c && c->options.daemon && management_would_hold (management)) + do_init_first_time (c); + + /* block until management hold is released */ + if (management_hold (management)) + return true; + } +#endif + return false; +} + +/* + * Sleep before restart. + */ +static void +socket_restart_pause (struct context *c) +{ + bool proxy = false; + int sec = 2; + +#ifdef ENABLE_HTTP_PROXY + if (c->options.http_proxy_options) + proxy = true; +#endif +#ifdef ENABLE_SOCKS + if (c->options.socks_proxy_server) + proxy = true; +#endif + + switch (c->options.proto) + { + case PROTO_UDPv4: + if (proxy) + sec = c->options.connect_retry_seconds; + break; + case PROTO_TCPv4_SERVER: + sec = 1; + break; + case PROTO_TCPv4_CLIENT: + sec = c->options.connect_retry_seconds; + break; + } + +#ifdef ENABLE_DEBUG + if (GREMLIN_CONNECTION_FLOOD_LEVEL (c->options.gremlin)) + sec = 0; +#endif + +#if P2MP + if (auth_retry_get () == AR_NOINTERACT) + sec = 10; +#endif + + if (do_hold (NULL)) + sec = 0; + + if (sec) + { + msg (D_RESTART, "Restart pause, %d second(s)", sec); + openvpn_sleep (sec); + } +} + +/* + * Do a possible pause on context_2 initialization. + */ +static void +do_startup_pause (struct context *c) +{ + if (!c->first_time) + socket_restart_pause (c); + else + do_hold (NULL); +} + +/* + * Finalize MTU parameters based on command line or config file options. + */ +static void +frame_finalize_options (struct context *c, const struct options *o) +{ + if (!o) + o = &c->options; + + /* + * Set adjustment factor for buffer alignment when no + * cipher is used. + */ + if (!CIPHER_ENABLED (c)) + { + frame_align_to_extra_frame (&c->c2.frame); + frame_or_align_flags (&c->c2.frame, + FRAME_HEADROOM_MARKER_FRAGMENT + |FRAME_HEADROOM_MARKER_READ_LINK + |FRAME_HEADROOM_MARKER_READ_STREAM); + } + + frame_finalize (&c->c2.frame, + o->link_mtu_defined, + o->link_mtu, + o->tun_mtu_defined, + o->tun_mtu); +} + +/* + * Free a key schedule, including OpenSSL components. + */ +static void +key_schedule_free (struct key_schedule *ks, bool free_ssl_ctx) +{ +#ifdef USE_CRYPTO + free_key_ctx_bi (&ks->static_key); +#ifdef USE_SSL + if (ks->ssl_ctx && free_ssl_ctx) + { + SSL_CTX_free (ks->ssl_ctx); + free_key_ctx_bi (&ks->tls_auth_key); + } +#endif /* USE_SSL */ +#endif /* USE_CRYPTO */ + CLEAR (*ks); +} + +#ifdef USE_CRYPTO + +static void +init_crypto_pre (struct context *c, const unsigned int flags) +{ + if (c->options.engine) + init_crypto_lib_engine (c->options.engine); + + if (flags & CF_LOAD_PERSISTED_PACKET_ID) + { + /* load a persisted packet-id for cross-session replay-protection */ + if (c->options.packet_id_file) + packet_id_persist_load (&c->c1.pid_persist, c->options.packet_id_file); + } + + /* Initialize crypto options */ + + if (c->options.use_iv) + c->c2.crypto_options.flags |= CO_USE_IV; + + if (c->options.mute_replay_warnings) + c->c2.crypto_options.flags |= CO_MUTE_REPLAY_WARNINGS; +} + +/* + * Static Key Mode (using a pre-shared key) + */ +static void +do_init_crypto_static (struct context *c, const unsigned int flags) +{ + const struct options *options = &c->options; + ASSERT (options->shared_secret_file); + + init_crypto_pre (c, flags); + + /* Initialize packet ID tracking */ + if (options->replay) + { + packet_id_init (&c->c2.packet_id, options->replay_window, + options->replay_time); + c->c2.crypto_options.packet_id = &c->c2.packet_id; + c->c2.crypto_options.pid_persist = &c->c1.pid_persist; + c->c2.crypto_options.flags |= CO_PACKET_ID_LONG_FORM; + packet_id_persist_load_obj (&c->c1.pid_persist, + c->c2.crypto_options.packet_id); + } + + if (!key_ctx_bi_defined (&c->c1.ks.static_key)) + { + struct key2 key2; + struct key_direction_state kds; + + /* Get cipher & hash algorithms */ + init_key_type (&c->c1.ks.key_type, options->ciphername, + options->ciphername_defined, options->authname, + options->authname_defined, options->keysize, + options->test_crypto, true); + + /* Read cipher and hmac keys from shared secret file */ + read_key_file (&key2, options->shared_secret_file, true); + + /* Check for and fix highly unlikely key problems */ + verify_fix_key2 (&key2, &c->c1.ks.key_type, + options->shared_secret_file); + + /* Initialize OpenSSL key objects */ + key_direction_state_init (&kds, options->key_direction); + must_have_n_keys (options->shared_secret_file, "secret", &key2, + kds.need_keys); + init_key_ctx (&c->c1.ks.static_key.encrypt, &key2.keys[kds.out_key], + &c->c1.ks.key_type, DO_ENCRYPT, "Static Encrypt"); + init_key_ctx (&c->c1.ks.static_key.decrypt, &key2.keys[kds.in_key], + &c->c1.ks.key_type, DO_DECRYPT, "Static Decrypt"); + + /* Erase the temporary copy of key */ + CLEAR (key2); + } + else + { + msg (M_INFO, "Re-using pre-shared static key"); + } + + /* Get key schedule */ + c->c2.crypto_options.key_ctx_bi = &c->c1.ks.static_key; + + /* Compute MTU parameters */ + crypto_adjust_frame_parameters (&c->c2.frame, + &c->c1.ks.key_type, + options->ciphername_defined, + options->use_iv, options->replay, true); + + /* Sanity check on IV, sequence number, and cipher mode options */ + check_replay_iv_consistency (&c->c1.ks.key_type, options->replay, + options->use_iv); +} + +#ifdef USE_SSL + +/* + * Initialize the persistent component of OpenVPN's TLS mode, + * which is preserved across SIGUSR1 resets. + */ +static void +do_init_crypto_tls_c1 (struct context *c) +{ + const struct options *options = &c->options; + + if (!c->c1.ks.ssl_ctx) + { + /* + * Initialize the OpenSSL library's global + * SSL context. + */ + c->c1.ks.ssl_ctx = init_ssl (options); + if (!c->c1.ks.ssl_ctx) + { +#if P2MP + switch (auth_retry_get ()) + { + case AR_NONE: + msg (M_FATAL, "Error: private key password verification failed"); + break; + case AR_INTERACT: + ssl_purge_auth (); + case AR_NOINTERACT: + c->sig->signal_received = SIGUSR1; /* SOFT-SIGUSR1 -- Password failure error */ + break; + default: + ASSERT (0); + } + c->sig->signal_text = "private-key-password-failure"; + return; +#else + msg (M_FATAL, "Error: private key password verification failed"); +#endif + } + + /* Get cipher & hash algorithms */ + init_key_type (&c->c1.ks.key_type, options->ciphername, + options->ciphername_defined, options->authname, + options->authname_defined, options->keysize, true, true); + + /* TLS handshake authentication (--tls-auth) */ + if (options->tls_auth_file) + get_tls_handshake_key (&c->c1.ks.key_type, + &c->c1.ks.tls_auth_key, + options->tls_auth_file, + options->key_direction); + } + else + { + msg (M_INFO, "Re-using SSL/TLS context"); + } +} + +static void +do_init_crypto_tls (struct context *c, const unsigned int flags) +{ + const struct options *options = &c->options; + struct tls_options to; + bool packet_id_long_form; + + ASSERT (options->tls_server || options->tls_client); + ASSERT (!options->test_crypto); + + init_crypto_pre (c, flags); + + /* Make sure we are either a TLS client or server but not both */ + ASSERT (options->tls_server == !options->tls_client); + + /* initialize persistent component */ + do_init_crypto_tls_c1 (c); + if (IS_SIG (c)) + return; + + /* Sanity check on IV, sequence number, and cipher mode options */ + check_replay_iv_consistency (&c->c1.ks.key_type, options->replay, + options->use_iv); + + /* In short form, unique datagram identifier is 32 bits, in long form 64 bits */ + packet_id_long_form = cfb_ofb_mode (&c->c1.ks.key_type); + + /* Compute MTU parameters */ + crypto_adjust_frame_parameters (&c->c2.frame, + &c->c1.ks.key_type, + options->ciphername_defined, + options->use_iv, + options->replay, packet_id_long_form); + tls_adjust_frame_parameters (&c->c2.frame); + + /* Set all command-line TLS-related options */ + CLEAR (to); + + to.crypto_flags_and = ~(CO_PACKET_ID_LONG_FORM); + if (packet_id_long_form) + to.crypto_flags_or = CO_PACKET_ID_LONG_FORM; + + to.ssl_ctx = c->c1.ks.ssl_ctx; + to.key_type = c->c1.ks.key_type; + to.server = options->tls_server; + to.key_method = options->key_method; + to.replay = options->replay; + to.replay_window = options->replay_window; + to.replay_time = options->replay_time; + to.transition_window = options->transition_window; + to.handshake_window = options->handshake_window; + to.packet_timeout = options->tls_timeout; + to.renegotiate_bytes = options->renegotiate_bytes; + to.renegotiate_packets = options->renegotiate_packets; + to.renegotiate_seconds = options->renegotiate_seconds; + to.single_session = options->single_session; + +#ifdef ENABLE_OCC + to.disable_occ = !options->occ; +#endif + + to.verify_command = options->tls_verify; + to.verify_x509name = options->tls_remote; + to.crl_file = options->crl_file; + to.ns_cert_type = options->ns_cert_type; + to.es = c->c2.es; + +#ifdef ENABLE_DEBUG + to.gremlin = c->options.gremlin; +#endif + + to.plugins = c->c1.plugins; + +#if P2MP_SERVER + to.auth_user_pass_verify_script = options->auth_user_pass_verify_script; + to.auth_user_pass_verify_script_via_file = options->auth_user_pass_verify_script_via_file; + to.tmp_dir = options->tmp_dir; + to.username_as_common_name = options->username_as_common_name; + if (options->ccd_exclusive) + to.client_config_dir_exclusive = options->client_config_dir; +#endif + + /* TLS handshake authentication (--tls-auth) */ + if (options->tls_auth_file) + { + to.tls_auth_key = c->c1.ks.tls_auth_key; + to.tls_auth.pid_persist = &c->c1.pid_persist; + to.tls_auth.flags |= CO_PACKET_ID_LONG_FORM; + crypto_adjust_frame_parameters (&to.frame, + &c->c1.ks.key_type, + false, false, true, true); + } + + /* If we are running over TCP, allow for + length prefix */ + socket_adjust_frame_parameters (&to.frame, options->proto); + + /* + * Initialize OpenVPN's master TLS-mode object. + */ + if (flags & CF_INIT_TLS_MULTI) + c->c2.tls_multi = tls_multi_init (&to); + + if (flags & CF_INIT_TLS_AUTH_STANDALONE) + c->c2.tls_auth_standalone = tls_auth_standalone_init (&to, &c->c2.gc); +} + +static void +do_init_finalize_tls_frame (struct context *c) +{ + if (c->c2.tls_multi) + { + tls_multi_init_finalize (c->c2.tls_multi, &c->c2.frame); + ASSERT (EXPANDED_SIZE (&c->c2.tls_multi->opt.frame) <= + EXPANDED_SIZE (&c->c2.frame)); + frame_print (&c->c2.tls_multi->opt.frame, D_MTU_INFO, + "Control Channel MTU parms"); + } + if (c->c2.tls_auth_standalone) + { + tls_auth_standalone_finalize (c->c2.tls_auth_standalone, &c->c2.frame); + frame_print (&c->c2.tls_auth_standalone->frame, D_MTU_INFO, + "TLS-Auth MTU parms"); + } +} + +#endif /* USE_SSL */ +#endif /* USE_CRYPTO */ + +#ifdef USE_CRYPTO +/* + * No encryption or authentication. + */ +static void +do_init_crypto_none (const struct context *c) +{ + ASSERT (!c->options.test_crypto); + msg (M_WARN, + "******* WARNING *******: all encryption and authentication features disabled -- all data will be tunnelled as cleartext"); +} +#endif + +static void +do_init_crypto (struct context *c, const unsigned int flags) +{ +#ifdef USE_CRYPTO + if (c->options.shared_secret_file) + do_init_crypto_static (c, flags); +#ifdef USE_SSL + else if (c->options.tls_server || c->options.tls_client) + do_init_crypto_tls (c, flags); +#endif + else /* no encryption or authentication. */ + do_init_crypto_none (c); +#else /* USE_CRYPTO */ + msg (M_WARN, + "******* WARNING *******: " PACKAGE_NAME + " built without OpenSSL -- encryption and authentication features disabled -- all data will be tunnelled as cleartext"); +#endif /* USE_CRYPTO */ +} + +static void +do_init_frame (struct context *c) +{ +#ifdef USE_LZO + /* + * Initialize LZO compression library. + */ + if (c->options.comp_lzo) + { + lzo_adjust_frame_parameters (&c->c2.frame); + + /* + * LZO usage affects buffer alignment. + */ + if (CIPHER_ENABLED (c)) + { + frame_add_to_align_adjust (&c->c2.frame, LZO_PREFIX_LEN); + frame_or_align_flags (&c->c2.frame, + FRAME_HEADROOM_MARKER_FRAGMENT + |FRAME_HEADROOM_MARKER_DECRYPT); + } + +#ifdef ENABLE_FRAGMENT + lzo_adjust_frame_parameters (&c->c2.frame_fragment_omit); /* omit LZO frame delta from final frame_fragment */ +#endif + } +#endif + +#ifdef ENABLE_SOCKS + /* + * Adjust frame size for UDP Socks support. + */ + if (c->options.socks_proxy_server) + socks_adjust_frame_parameters (&c->c2.frame, c->options.proto); +#endif + + /* + * Adjust frame size based on the --tun-mtu-extra parameter. + */ + if (c->options.tun_mtu_extra_defined) + tun_adjust_frame_parameters (&c->c2.frame, c->options.tun_mtu_extra); + + /* + * Adjust frame size based on link socket parameters. + * (Since TCP is a stream protocol, we need to insert + * a packet length uint16_t in the buffer.) + */ + socket_adjust_frame_parameters (&c->c2.frame, c->options.proto); + + /* + * Fill in the blanks in the frame parameters structure, + * make sure values are rational, etc. + */ + frame_finalize_options (c, NULL); + +#ifdef ENABLE_FRAGMENT + /* + * Set frame parameter for fragment code. This is necessary because + * the fragmentation code deals with payloads which have already been + * passed through the compression code. + */ + c->c2.frame_fragment = c->c2.frame; + frame_subtract_extra (&c->c2.frame_fragment, &c->c2.frame_fragment_omit); +#endif + +#if defined(ENABLE_FRAGMENT) && defined(ENABLE_OCC) + /* + * MTU advisories + */ + if (c->options.fragment && c->options.mtu_test) + msg (M_WARN, + "WARNING: using --fragment and --mtu-test together may produce an inaccurate MTU test result"); +#endif + +#ifdef ENABLE_FRAGMENT + if ((c->options.mssfix || c->options.fragment) + && TUN_MTU_SIZE (&c->c2.frame_fragment) != ETHERNET_MTU) + msg (M_WARN, + "WARNING: normally if you use --mssfix and/or --fragment, you should also set --tun-mtu %d (currently it is %d)", + ETHERNET_MTU, TUN_MTU_SIZE (&c->c2.frame_fragment)); +#endif +} + +static void +do_option_warnings (struct context *c) +{ + const struct options *o = &c->options; + +#if 1 /* JYFIXME -- port warning */ + if (!o->port_option_used && (o->local_port == OPENVPN_PORT && o->remote_port == OPENVPN_PORT)) + msg (M_WARN, "IMPORTANT: OpenVPN's default port number is now %d, based on an official port number assignment by IANA. OpenVPN 2.0-beta16 and earlier used 5000 as the default port.", + OPENVPN_PORT); +#endif + + if (o->ping_send_timeout && !o->ping_rec_timeout) + msg (M_WARN, "WARNING: --ping should normally be used with --ping-restart or --ping-exit"); + + if ((o->username || o->groupname || o->chroot_dir) && (!o->persist_tun || !o->persist_key)) + msg (M_WARN, "WARNING: you are using user/group/chroot without persist-key/persist-tun -- this may cause restarts to fail"); + +#if P2MP + if (o->pull && o->ifconfig_local && c->first_time) + msg (M_WARN, "WARNING: using --pull/--client and --ifconfig together is probably not what you want"); + +#if P2MP_SERVER + if (o->mode == MODE_SERVER) + { + if (o->duplicate_cn && o->client_config_dir) + msg (M_WARN, "WARNING: using --duplicate-cn and --client-config-dir together is probably not what you want"); + if (o->duplicate_cn && o->ifconfig_pool_persist_filename) + msg (M_WARN, "WARNING: --ifconfig-pool-persist will not work with --duplicate-cn"); + if (!o->keepalive_ping || !o->keepalive_timeout) + msg (M_WARN, "WARNING: --keepalive option is missing from server config"); + } +#endif +#endif + +#ifdef USE_CRYPTO + if (!o->replay) + msg (M_WARN, "WARNING: You have disabled Replay Protection (--no-replay) which may make " PACKAGE_NAME " less secure"); + if (!o->use_iv) + msg (M_WARN, "WARNING: You have disabled Crypto IVs (--no-iv) which may make " PACKAGE_NAME " less secure"); + +#ifdef USE_SSL + if (o->tls_client + && !o->tls_verify + && !o->tls_remote + && !(o->ns_cert_type & NS_SSL_SERVER)) + msg (M_WARN, "WARNING: No server certificate verification method has been enabled. See http://openvpn.net/howto.html#mitm for more info."); +#endif + +#endif +} + +static void +do_init_frame_tls (struct context *c) +{ +#if defined(USE_CRYPTO) && defined(USE_SSL) + do_init_finalize_tls_frame (c); +#endif +} + +struct context_buffers * +init_context_buffers (const struct frame *frame) +{ + struct context_buffers *b; + + ALLOC_OBJ_CLEAR (b, struct context_buffers); + + b->read_link_buf = alloc_buf (BUF_SIZE (frame)); + b->read_tun_buf = alloc_buf (BUF_SIZE (frame)); + + b->aux_buf = alloc_buf (BUF_SIZE (frame)); + +#ifdef USE_CRYPTO + b->encrypt_buf = alloc_buf (BUF_SIZE (frame)); + b->decrypt_buf = alloc_buf (BUF_SIZE (frame)); +#endif + +#ifdef USE_LZO + b->lzo_compress_buf = alloc_buf (BUF_SIZE (frame)); + b->lzo_decompress_buf = alloc_buf (BUF_SIZE (frame)); +#endif + + return b; +} + +void +free_context_buffers (struct context_buffers *b) +{ + if (b) + { + free_buf (&b->read_link_buf); + free_buf (&b->read_tun_buf); + free_buf (&b->aux_buf); + +#ifdef USE_LZO + free_buf (&b->lzo_compress_buf); + free_buf (&b->lzo_decompress_buf); +#endif + +#ifdef USE_CRYPTO + free_buf (&b->encrypt_buf); + free_buf (&b->decrypt_buf); +#endif + + free (b); + } +} + +/* + * Now that we know all frame parameters, initialize + * our buffers. + */ +static void +do_init_buffers (struct context *c) +{ + c->c2.buffers = init_context_buffers (&c->c2.frame); + c->c2.buffers_owned = true; +} + +#ifdef ENABLE_FRAGMENT +/* + * Fragmenting code has buffers to initialize + * once frame parameters are known. + */ +static void +do_init_fragment (struct context *c) +{ + ASSERT (c->options.fragment); + frame_set_mtu_dynamic (&c->c2.frame_fragment, + c->options.fragment, SET_MTU_UPPER_BOUND); + fragment_frame_init (c->c2.fragment, &c->c2.frame_fragment); +} +#endif + +/* + * Set the --mssfix option. + */ +static void +do_init_mssfix (struct context *c) +{ + if (c->options.mssfix) + { + frame_set_mtu_dynamic (&c->c2.frame, + c->options.mssfix, SET_MTU_UPPER_BOUND); + } +} + +/* + * Allocate our socket object. + */ +static void +do_link_socket_new (struct context *c) +{ + ASSERT (!c->c2.link_socket); + c->c2.link_socket = link_socket_new (); + c->c2.link_socket_owned = true; +} + +/* + * bind the TCP/UDP socket + */ +static void +do_init_socket_1 (struct context *c, int mode) +{ + link_socket_init_phase1 (c->c2.link_socket, + c->options.local, + c->c1.remote_list, + c->options.local_port, + c->options.proto, + mode, + c->c2.accept_from, +#ifdef ENABLE_HTTP_PROXY + c->c1.http_proxy, +#endif +#ifdef ENABLE_SOCKS + c->c1.socks_proxy, +#endif +#ifdef ENABLE_DEBUG + c->options.gremlin, +#endif + c->options.bind_local, + c->options.remote_float, + c->options.inetd, + &c->c1.link_socket_addr, + c->options.ipchange, + c->c1.plugins, + c->options.resolve_retry_seconds, + c->options.connect_retry_seconds, + c->options.mtu_discover_type, + c->options.rcvbuf, + c->options.sndbuf); +} + +/* + * finalize the TCP/UDP socket + */ +static void +do_init_socket_2 (struct context *c) +{ + link_socket_init_phase2 (c->c2.link_socket, &c->c2.frame, + &c->sig->signal_received); +} + +/* + * Print MTU INFO + */ +static void +do_print_data_channel_mtu_parms (struct context *c) +{ + frame_print (&c->c2.frame, D_MTU_INFO, "Data Channel MTU parms"); +#ifdef ENABLE_FRAGMENT + if (c->c2.fragment) + frame_print (&c->c2.frame_fragment, D_MTU_INFO, + "Fragmentation MTU parms"); +#endif +} + +#ifdef ENABLE_OCC +/* + * Get local and remote options compatibility strings. + */ +static void +do_compute_occ_strings (struct context *c) +{ + struct gc_arena gc = gc_new (); + + c->c2.options_string_local = + options_string (&c->options, &c->c2.frame, c->c1.tuntap, false, &gc); + c->c2.options_string_remote = + options_string (&c->options, &c->c2.frame, c->c1.tuntap, true, &gc); + + msg (D_SHOW_OCC, "Local Options String: '%s'", c->c2.options_string_local); + msg (D_SHOW_OCC, "Expected Remote Options String: '%s'", + c->c2.options_string_remote); + +#ifdef USE_CRYPTO + msg (D_SHOW_OCC_HASH, "Local Options hash (VER=%s): '%s'", + options_string_version (c->c2.options_string_local, &gc), + md5sum ((uint8_t*)c->c2.options_string_local, + strlen (c->c2.options_string_local), 9, &gc)); + msg (D_SHOW_OCC_HASH, "Expected Remote Options hash (VER=%s): '%s'", + options_string_version (c->c2.options_string_remote, &gc), + md5sum ((uint8_t*)c->c2.options_string_remote, + strlen (c->c2.options_string_remote), 9, &gc)); +#endif + +#if defined(USE_CRYPTO) && defined(USE_SSL) + if (c->c2.tls_multi) + tls_multi_init_set_options (c->c2.tls_multi, + c->c2.options_string_local, + c->c2.options_string_remote); +#endif + + gc_free (&gc); +} +#endif + +/* + * These things can only be executed once per program instantiation. + * Set up for possible UID/GID downgrade, but don't do it yet. + * Daemonize if requested. + */ +static void +do_init_first_time (struct context *c) +{ + if (c->first_time && !c->c2.did_we_daemonize) + { + /* get user and/or group that we want to setuid/setgid to */ + c->c2.uid_gid_specified = + get_group (c->options.groupname, &c->c2.group_state) | + get_user (c->options.username, &c->c2.user_state); + + /* get --writepid file descriptor */ + get_pid_file (c->options.writepid, &c->c2.pid_state); + + /* become a daemon if --daemon */ + c->c2.did_we_daemonize = possibly_become_daemon (&c->options, c->first_time); + + /* should we disable paging? */ + if (c->options.mlock && c->c2.did_we_daemonize) + do_mlockall (true); /* call again in case we daemonized */ + + /* save process ID in a file */ + write_pid (&c->c2.pid_state); + + /* should we change scheduling priority? */ + set_nice (c->options.nice); + } +} + +/* + * If xinetd/inetd mode, don't allow restart. + */ +static void +do_close_check_if_restart_permitted (struct context *c) +{ + if (c->options.inetd + && (c->sig->signal_received == SIGHUP + || c->sig->signal_received == SIGUSR1)) + { + c->sig->signal_received = SIGTERM; + msg (M_INFO, + PACKAGE_NAME + " started by inetd/xinetd cannot restart... Exiting."); + } +} + +/* + * free buffers + */ +static void +do_close_free_buf (struct context *c) +{ + if (c->c2.buffers_owned) + { + free_context_buffers (c->c2.buffers); + c->c2.buffers = NULL; + c->c2.buffers_owned = false; + } +} + +/* + * close TLS + */ +static void +do_close_tls (struct context *c) +{ +#if defined(USE_CRYPTO) && defined(USE_SSL) + if (c->c2.tls_multi) + { + tls_multi_free (c->c2.tls_multi, true); + c->c2.tls_multi = NULL; + } + +#ifdef ENABLE_OCC + /* free options compatibility strings */ + if (c->c2.options_string_local) + free (c->c2.options_string_local); + if (c->c2.options_string_remote) + free (c->c2.options_string_remote); + c->c2.options_string_local = c->c2.options_string_remote = NULL; +#endif +#endif +} + +/* + * Free key schedules + */ +static void +do_close_free_key_schedule (struct context *c, bool free_ssl_ctx) +{ + if (!(c->sig->signal_received == SIGUSR1 && c->options.persist_key)) + key_schedule_free (&c->c1.ks, free_ssl_ctx); +} + +/* + * Close TCP/UDP connection + */ +static void +do_close_link_socket (struct context *c) +{ + if (c->c2.link_socket && c->c2.link_socket_owned) + { + link_socket_close (c->c2.link_socket); + c->c2.link_socket = NULL; + } + + if (!(c->sig->signal_received == SIGUSR1 && c->options.persist_remote_ip)) + { + CLEAR (c->c1.link_socket_addr.remote); + CLEAR (c->c1.link_socket_addr.actual); + } + + if (!(c->sig->signal_received == SIGUSR1 && c->options.persist_local_ip)) + CLEAR (c->c1.link_socket_addr.local); +} + +/* + * Close packet-id persistance file + */ +static void +do_close_packet_id (struct context *c) +{ +#ifdef USE_CRYPTO + packet_id_free (&c->c2.packet_id); + packet_id_persist_save (&c->c1.pid_persist); + if (!(c->sig->signal_received == SIGUSR1)) + packet_id_persist_close (&c->c1.pid_persist); +#endif +} + +#ifdef ENABLE_FRAGMENT +/* + * Close fragmentation handler. + */ +static void +do_close_fragment (struct context *c) +{ + if (c->c2.fragment) + { + fragment_free (c->c2.fragment); + c->c2.fragment = NULL; + } +} +#endif + +/* + * Open and close our event objects. + */ + +static void +do_event_set_init (struct context *c, + bool need_us_timeout) +{ + unsigned int flags = 0; + + c->c2.event_set_max = BASE_N_EVENTS; + + flags |= EVENT_METHOD_FAST; + + if (need_us_timeout) + flags |= EVENT_METHOD_US_TIMEOUT; + + c->c2.event_set = event_set_init (&c->c2.event_set_max, flags); + c->c2.event_set_owned = true; +} + +static void +do_close_event_set (struct context *c) +{ + if (c->c2.event_set && c->c2.event_set_owned) + { + event_free (c->c2.event_set); + c->c2.event_set = NULL; + c->c2.event_set_owned = false; + } +} + +/* + * Open and close --status file + */ + +static void +do_open_status_output (struct context *c) +{ + if (!c->c1.status_output) + { + c->c1.status_output = status_open (c->options.status_file, + c->options.status_file_update_freq, + -1, + NULL, + STATUS_OUTPUT_WRITE); + c->c1.status_output_owned = true; + } +} + +static void +do_close_status_output (struct context *c) +{ + if (!(c->sig->signal_received == SIGUSR1)) + { + if (c->c1.status_output_owned && c->c1.status_output) + { + status_close (c->c1.status_output); + c->c1.status_output = NULL; + c->c1.status_output_owned = false; + } + } +} + +/* + * Handle ifconfig-pool persistance object. + */ +static void +do_open_ifconfig_pool_persist (struct context *c) +{ +#if P2MP_SERVER + if (!c->c1.ifconfig_pool_persist && c->options.ifconfig_pool_persist_filename) + { + c->c1.ifconfig_pool_persist = ifconfig_pool_persist_init (c->options.ifconfig_pool_persist_filename, + c->options.ifconfig_pool_persist_refresh_freq); + c->c1.ifconfig_pool_persist_owned = true; + } +#endif +} + +static void +do_close_ifconfig_pool_persist (struct context *c) +{ +#if P2MP_SERVER + if (!(c->sig->signal_received == SIGUSR1)) + { + if (c->c1.ifconfig_pool_persist && c->c1.ifconfig_pool_persist_owned) + { + ifconfig_pool_persist_close (c->c1.ifconfig_pool_persist); + c->c1.ifconfig_pool_persist = NULL; + c->c1.ifconfig_pool_persist_owned = false; + } + } +#endif +} + +/* + * Inherit environmental variables + */ + +static void +do_inherit_env (struct context *c, const struct env_set *src) +{ + c->c2.es = env_set_create (&c->c2.gc); + env_set_inherit (c->c2.es, src); +} + +/* + * Fast I/O setup. Fast I/O is an optimization which only works + * if all of the following are true: + * + * (1) The platform is not Windows + * (2) --proto udp is enabled + * (3) --shaper is disabled + */ +static void +do_setup_fast_io (struct context *c) +{ + if (c->options.fast_io) + { +#ifdef WIN32 + msg (M_INFO, "NOTE: --fast-io is disabled since we are running on Windows"); +#else + if (c->options.proto != PROTO_UDPv4) + msg (M_INFO, "NOTE: --fast-io is disabled since we are not using UDP"); + else + { + if (c->options.shaper) + msg (M_INFO, "NOTE: --fast-io is disabled since we are using --shaper"); + else + { + c->c2.fast_io = true; + } + } +#endif + } +} + +static void +do_signal_on_tls_errors (struct context *c) +{ +#if defined(USE_CRYPTO) && defined(USE_SSL) + if (c->options.tls_exit) + c->c2.tls_exit_signal = SIGTERM; + else + c->c2.tls_exit_signal = SIGUSR1; +#endif +} + + +static void +do_open_plugins (struct context *c) +{ +#ifdef ENABLE_PLUGIN + if (c->options.plugin_list && !c->c1.plugins) + { + c->c1.plugins = plugin_list_open (c->options.plugin_list, c->c2.es); + c->c1.plugins_owned = true; + } +#endif +} + +static void +do_close_plugins (struct context *c) +{ +#ifdef ENABLE_PLUGIN + if (c->c1.plugins && c->c1.plugins_owned && !(c->sig->signal_received == SIGUSR1)) + { + plugin_list_close (c->c1.plugins); + c->c1.plugins = NULL; + c->c1.plugins_owned = false; + } +#endif +} + +#ifdef ENABLE_MANAGEMENT + +static void +management_callback_status_p2p (void *arg, const int version, struct status_output *so) +{ + struct context *c = (struct context *) arg; + print_status (c, so); +} + +void +management_show_net_callback (void *arg, const int msglevel) +{ +#ifdef WIN32 + show_routes (msglevel); + show_adapters (msglevel); + msg (msglevel, "END"); +#else + msg (msglevel, "ERROR: Sorry, this command is currently only implemented on Windows"); +#endif +} + +#endif + +void +init_management_callback_p2p (struct context *c) +{ +#ifdef ENABLE_MANAGEMENT + if (management) + { + struct management_callback cb; + CLEAR (cb); + cb.arg = c; + cb.status = management_callback_status_p2p; + cb.show_net = management_show_net_callback; + management_set_callback (management, &cb); + } +#endif +} + +#ifdef ENABLE_MANAGEMENT + +void +init_management (struct context *c) +{ + if (!management) + management = management_init (); +} + +bool +open_management (struct context *c) +{ + /* initialize management layer */ + if (management) + { + if (c->options.management_addr) + { + if (management_open (management, + c->options.management_addr, + c->options.management_port, + c->options.management_user_pass, + c->options.mode == MODE_SERVER, + c->options.management_query_passwords, + c->options.management_log_history_cache, + c->options.management_echo_buffer_size, + c->options.management_state_buffer_size, + c->options.management_hold)) + { + management_set_state (management, + OPENVPN_STATE_CONNECTING, + NULL, + (in_addr_t)0); + } + + /* possible wait */ + do_hold (c); + if (IS_SIG (c)) + { + msg (M_WARN, "Signal received from management interface, exiting"); + return false; + } + } + else + close_management (); + } + return true; +} + +void +close_management (void) +{ + if (management) + { + management_close (management); + management = NULL; + } +} + +#endif + + +void +uninit_management_callback (void) +{ +#ifdef ENABLE_MANAGEMENT + if (management) + { + management_clear_callback (management); + } +#endif +} + +/* + * Initialize a tunnel instance, handle pre and post-init + * signal settings. + */ +void +init_instance_handle_signals (struct context *c, const struct env_set *env, const unsigned int flags) +{ + pre_init_signal_catch (); + init_instance (c, env, flags); + post_init_signal_catch (); +} + +/* + * Initialize a tunnel instance. + */ +void +init_instance (struct context *c, const struct env_set *env, const unsigned int flags) +{ + const struct options *options = &c->options; + const bool child = (c->mode == CM_CHILD_TCP || c->mode == CM_CHILD_UDP); + int link_socket_mode = LS_MODE_DEFAULT; + + /* init garbage collection level */ + gc_init (&c->c2.gc); + + /* signals caught here will abort */ + c->sig->signal_received = 0; + c->sig->signal_text = NULL; + c->sig->hard = false; + + /* link_socket_mode allows CM_CHILD_TCP + instances to inherit acceptable fds + from a top-level parent */ + if (c->options.proto == PROTO_TCPv4_SERVER) + { + if (c->mode == CM_TOP) + link_socket_mode = LS_MODE_TCP_LISTEN; + else if (c->mode == CM_CHILD_TCP) + link_socket_mode = LS_MODE_TCP_ACCEPT_FROM; + } + + /* should we disable paging? */ + if (c->first_time && options->mlock) + do_mlockall (true); + + /* possible sleep or management hold if restart */ + if (c->mode == CM_P2P || c->mode == CM_TOP) + { + do_startup_pause (c); + if (IS_SIG (c)) + goto sig; + } + + /* initialize context level 2 --verb/--mute parms */ + init_verb_mute (c, IVM_LEVEL_2); + + /* set error message delay for non-server modes */ + if (c->mode == CM_P2P) + set_check_status_error_delay (P2P_ERROR_DELAY_MS); + + /* warn about inconsistent options */ + if (c->mode == CM_P2P || c->mode == CM_TOP) + do_option_warnings (c); + + /* inherit environmental variables */ + if (env) + do_inherit_env (c, env); + + /* initialize plugins */ + if (c->mode == CM_P2P || c->mode == CM_TOP) + do_open_plugins (c); + + /* should we enable fast I/O? */ + if (c->mode == CM_P2P || c->mode == CM_TOP) + do_setup_fast_io (c); + + /* should we throw a signal on TLS errors? */ + do_signal_on_tls_errors (c); + + /* open --status file */ + if (c->mode == CM_P2P || c->mode == CM_TOP) + do_open_status_output (c); + + /* open --ifconfig-pool-persist file */ + if (c->mode == CM_TOP) + do_open_ifconfig_pool_persist (c); + +#ifdef ENABLE_OCC + /* reset OCC state */ + if (c->mode == CM_P2P || child) + c->c2.occ_op = occ_reset_op (); +#endif + + /* our wait-for-i/o objects, different for posix vs. win32 */ + if (c->mode == CM_P2P) + do_event_set_init (c, SHAPER_DEFINED (&c->options)); + else if (c->mode == CM_CHILD_TCP) + do_event_set_init (c, false); + + /* allocate our socket object */ + if (c->mode == CM_P2P || c->mode == CM_TOP || c->mode == CM_CHILD_TCP) + do_link_socket_new (c); + +#ifdef ENABLE_FRAGMENT + /* initialize internal fragmentation object */ + if (options->fragment && (c->mode == CM_P2P || child)) + c->c2.fragment = fragment_init (&c->c2.frame); +#endif + + /* init crypto layer */ + { + unsigned int crypto_flags = 0; + if (c->mode == CM_TOP) + crypto_flags = CF_INIT_TLS_AUTH_STANDALONE; + else if (c->mode == CM_P2P) + crypto_flags = CF_LOAD_PERSISTED_PACKET_ID | CF_INIT_TLS_MULTI; + else if (child) + crypto_flags = CF_INIT_TLS_MULTI; + do_init_crypto (c, crypto_flags); + if (IS_SIG (c)) + goto sig; + } + +#ifdef USE_LZO + /* initialize LZO compression library. */ + if (options->comp_lzo && (c->mode == CM_P2P || child)) + lzo_compress_init (&c->c2.lzo_compwork, options->comp_lzo_adaptive); +#endif + + /* initialize MTU variables */ + do_init_frame (c); + + /* initialize TLS MTU variables */ + do_init_frame_tls (c); + + /* init workspace buffers whose size is derived from frame size */ + if (c->mode == CM_P2P || c->mode == CM_CHILD_TCP) + do_init_buffers (c); + +#ifdef ENABLE_FRAGMENT + /* initialize internal fragmentation capability with known frame size */ + if (options->fragment && (c->mode == CM_P2P || child)) + do_init_fragment (c); +#endif + + /* initialize dynamic MTU variable */ + do_init_mssfix (c); + + /* bind the TCP/UDP socket */ + if (c->mode == CM_P2P || c->mode == CM_TOP || c->mode == CM_CHILD_TCP) + do_init_socket_1 (c, link_socket_mode); + + /* initialize tun/tap device object, + open tun/tap device, ifconfig, run up script, etc. */ + if (!(options->up_delay || PULL_DEFINED (options)) && (c->mode == CM_P2P || c->mode == CM_TOP)) + c->c2.did_open_tun = do_open_tun (c); + + /* print MTU info */ + do_print_data_channel_mtu_parms (c); + +#ifdef ENABLE_OCC + /* get local and remote options compatibility strings */ + if (c->mode == CM_P2P || child) + do_compute_occ_strings (c); +#endif + + /* initialize output speed limiter */ + if (c->mode == CM_P2P) + do_init_traffic_shaper (c); + + /* do one-time inits, and possibily become a daemon here */ + do_init_first_time (c); + + /* + * Actually do UID/GID downgrade, and chroot, if requested. + * May be delayed by --client, --pull, or --up-delay. + */ + do_uid_gid_chroot (c, c->c2.did_open_tun); + + /* finalize the TCP/UDP socket */ + if (c->mode == CM_P2P || c->mode == CM_TOP || c->mode == CM_CHILD_TCP) + do_init_socket_2 (c); + + /* initialize timers */ + if (c->mode == CM_P2P || child) + do_init_timers (c, false); + + /* Check for signals */ + if (IS_SIG (c)) + goto sig; + + return; + + sig: + c->sig->signal_text = "init_instance"; + close_context (c, -1, flags); + return; +} + +/* + * Close a tunnel instance. + */ +void +close_instance (struct context *c) +{ + /* close event objects */ + do_close_event_set (c); + + if (c->mode == CM_P2P + || c->mode == CM_CHILD_TCP + || c->mode == CM_CHILD_UDP + || c->mode == CM_TOP) + { + /* if xinetd/inetd mode, don't allow restart */ + do_close_check_if_restart_permitted (c); + +#ifdef USE_LZO + if (c->options.comp_lzo) + lzo_compress_uninit (&c->c2.lzo_compwork); +#endif + + /* free buffers */ + do_close_free_buf (c); + + /* close TLS */ + do_close_tls (c); + + /* free key schedules */ + do_close_free_key_schedule (c, (c->mode == CM_P2P || c->mode == CM_TOP)); + + /* close TCP/UDP connection */ + do_close_link_socket (c); + + /* close TUN/TAP device */ + do_close_tun (c, false); + + /* call plugin close functions and unload */ + do_close_plugins (c); + + /* close packet-id persistance file */ + do_close_packet_id (c); + + /* close --status file */ + do_close_status_output (c); + +#ifdef ENABLE_FRAGMENT + /* close fragmentation handler */ + do_close_fragment (c); +#endif + + /* close --ifconfig-pool-persist obj */ + do_close_ifconfig_pool_persist (c); + + /* garbage collect */ + gc_free (&c->c2.gc); + } +} + +void +inherit_context_child (struct context *dest, + const struct context *src) +{ + CLEAR (*dest); + + switch (src->options.proto) + { + case PROTO_UDPv4: + dest->mode = CM_CHILD_UDP; + break; + case PROTO_TCPv4_SERVER: + dest->mode = CM_CHILD_TCP; + break; + default: + ASSERT (0); + } + + dest->first_time = false; + + dest->gc = gc_new (); + + ALLOC_OBJ_CLEAR_GC (dest->sig, struct signal_info, &dest->gc); + + /* c1 init */ + packet_id_persist_init (&dest->c1.pid_persist); + +#ifdef USE_CRYPTO + dest->c1.ks.key_type = src->c1.ks.key_type; +#ifdef USE_SSL + /* inherit SSL context */ + dest->c1.ks.ssl_ctx = src->c1.ks.ssl_ctx; + dest->c1.ks.tls_auth_key = src->c1.ks.tls_auth_key; +#endif +#endif + + /* options */ + dest->options = src->options; + options_detach (&dest->options); + + if (dest->mode == CM_CHILD_TCP) + { + /* + * The CM_TOP context does the socket listen(), + * and the CM_CHILD_TCP context does the accept(). + */ + dest->c2.accept_from = src->c2.link_socket; + } + + /* inherit plugins */ + dest->c1.plugins = src->c1.plugins; + + /* context init */ + init_instance (dest, src->c2.es, CC_USR1_TO_HUP | CC_GC_FREE); + if (IS_SIG (dest)) + return; + + /* inherit tun/tap interface object */ + dest->c1.tuntap = src->c1.tuntap; + + /* UDP inherits some extra things which TCP does not */ + if (dest->mode == CM_CHILD_UDP) + { + /* inherit buffers */ + dest->c2.buffers = src->c2.buffers; + + /* inherit parent link_socket and tuntap */ + dest->c2.link_socket = src->c2.link_socket; + + ALLOC_OBJ_GC (dest->c2.link_socket_info, struct link_socket_info, &dest->gc); + *dest->c2.link_socket_info = src->c2.link_socket->info; + + /* locally override some link_socket_info fields */ + dest->c2.link_socket_info->lsa = &dest->c1.link_socket_addr; + dest->c2.link_socket_info->connection_established = false; + } +} + +void +inherit_context_top (struct context *dest, + const struct context *src) +{ + /* copy parent */ + *dest = *src; + + /* + * CM_TOP_CLONE will prevent close_instance from freeing or closing + * resources owned by the parent. + * + * Also note that CM_TOP_CLONE context objects are + * closed by multi_top_free in multi.c. + */ + dest->mode = CM_TOP_CLONE; + + dest->first_time = false; + + options_detach (&dest->options); + gc_detach (&dest->gc); + gc_detach (&dest->c2.gc); + +#if defined(USE_CRYPTO) && defined(USE_SSL) + dest->c2.tls_multi = NULL; +#endif + + dest->c1.tuntap_owned = false; + dest->c1.status_output_owned = false; +#if P2MP_SERVER + dest->c1.ifconfig_pool_persist_owned = false; +#endif + dest->c2.event_set_owned = false; + dest->c2.link_socket_owned = false; + dest->c2.buffers_owned = false; + + dest->c2.event_set = NULL; + if (src->options.proto == PROTO_UDPv4) + do_event_set_init (dest, false); +} + +void +close_context (struct context *c, int sig, unsigned int flags) +{ + if (sig >= 0) + c->sig->signal_received = sig; + + if (c->sig->signal_received == SIGUSR1) + { + if ((flags & CC_USR1_TO_HUP) + || (c->sig->hard && (flags & CC_HARD_USR1_TO_HUP))) + c->sig->signal_received = SIGHUP; + } + + close_instance (c); + + if (flags & CC_GC_FREE) + context_gc_free (c); +} + +#ifdef USE_CRYPTO + +static void +test_malloc (void) +{ + int i, j; + msg (M_INFO, "Multithreaded malloc test..."); + for (i = 0; i < 25; ++i) + { + struct gc_arena gc = gc_new (); + const int limit = get_random () & 0x03FF; + for (j = 0; j < limit; ++j) + { + gc_malloc (get_random () & 0x03FF, false, &gc); + } + gc_free (&gc); + } +} + +/* + * Do a loopback test + * on the crypto subsystem. + */ +static void * +test_crypto_thread (void *arg) +{ + struct context *c = (struct context *) arg; + const struct options *options = &c->options; +#if defined(USE_PTHREAD) + struct context *child = NULL; + openvpn_thread_t child_id = 0; +#endif + + ASSERT (options->test_crypto); + init_verb_mute (c, IVM_LEVEL_1); + context_init_1 (c); + do_init_crypto_static (c, 0); + +#if defined(USE_PTHREAD) + { + if (c->first_time && options->n_threads > 1) + { + if (options->n_threads > 2) + msg (M_FATAL, "ERROR: --test-crypto option only works with --threads set to 1 or 2"); + openvpn_thread_init (); + ALLOC_OBJ (child, struct context); + context_clear (child); + child->options = *options; + options_detach (&child->options); + child->first_time = false; + child_id = openvpn_thread_create (test_crypto_thread, (void *) child); + } + } +#endif + frame_finalize_options (c, options); + +#if defined(USE_PTHREAD) + if (options->n_threads == 2) + test_malloc (); +#endif + + test_crypto (&c->c2.crypto_options, &c->c2.frame); + + key_schedule_free (&c->c1.ks, true); + packet_id_free (&c->c2.packet_id); + +#if defined(USE_PTHREAD) + if (c->first_time && options->n_threads > 1) + openvpn_thread_join (child_id); + if (child) + free (child); +#endif + context_gc_free (c); + return NULL; +} + +#endif + +bool +do_test_crypto (const struct options *o) +{ +#ifdef USE_CRYPTO + if (o->test_crypto) + { + struct context c; + + /* print version number */ + msg (M_INFO, "%s", title_string); + + context_clear (&c); + c.options = *o; + options_detach (&c.options); + c.first_time = true; + test_crypto_thread ((void *) &c); + return true; + } +#endif + return false; +} @@ -0,0 +1,120 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef INIT_H +#define INIT_H + +#include "openvpn.h" + +/* + * Baseline maximum number of events + * to wait for. + */ +#define BASE_N_EVENTS 4 + +void context_clear (struct context *c); +void context_clear_1 (struct context *c); +void context_clear_2 (struct context *c); +void context_init_1 (struct context *c); +void context_clear_all_except_first_time (struct context *c); + +bool init_static (void); + +void uninit_static (void); + +#define IVM_LEVEL_1 (1<<0) +#define IVM_LEVEL_2 (1<<1) +void init_verb_mute (struct context *c, unsigned int flags); + +void init_options_dev (struct options *options); + +bool print_openssl_info (const struct options *options); + +bool do_genkey (const struct options *options); + +bool do_persist_tuntap (const struct options *options); + +void pre_setup (const struct options *options); + +void init_instance_handle_signals (struct context *c, const struct env_set *env, const unsigned int flags); + +void init_instance (struct context *c, const struct env_set *env, const unsigned int flags); + +void do_route (const struct options *options, + struct route_list *route_list, + const struct tuntap *tt, + const struct plugin_list *plugins, + struct env_set *es); + +void close_instance (struct context *c); + +bool do_test_crypto (const struct options *o); + +void context_gc_free (struct context *c); + +void do_up (struct context *c, + bool pulled_options, + unsigned int option_types_found); + +unsigned int pull_permission_mask (void); + +const char *format_common_name (struct context *c, struct gc_arena *gc); + +void reset_coarse_timers (struct context *c); + +void do_deferred_options (struct context *c, const unsigned int found); + +void inherit_context_child (struct context *dest, + const struct context *src); + +void inherit_context_top (struct context *dest, + const struct context *src); + +#define CC_GC_FREE (1<<0) +#define CC_USR1_TO_HUP (1<<1) +#define CC_HARD_USR1_TO_HUP (1<<2) +void close_context (struct context *c, int sig, unsigned int flags); + +struct context_buffers *init_context_buffers (const struct frame *frame); + +void free_context_buffers (struct context_buffers *b); + +#define ISC_ERRORS (1<<0) +#define ISC_SERVER (1<<1) +void initialization_sequence_completed (struct context *c, const unsigned int flags); + +#ifdef ENABLE_MANAGEMENT + +void init_management (struct context *c); +bool open_management (struct context *c); +void close_management (void); + +void management_show_net_callback (void *arg, const int msglevel); + +#endif + +void init_management_callback_p2p (struct context *c); +void uninit_management_callback (void); + +#endif diff --git a/install-win32/buildopensslpath.bat b/install-win32/buildopensslpath.bat new file mode 100755 index 0000000..b77ce12 --- /dev/null +++ b/install-win32/buildopensslpath.bat @@ -0,0 +1,3 @@ +REM set path for OpenSSL build + +set PATH=c:\bin;C:\Perl\bin\;C:\WINDOWS\system32;C:\WINDOWS;C:\WINDOWS\System32\Wbem;c:\MinGW\bin;c:\msys\1.0\bin diff --git a/install-win32/openssl.bat b/install-win32/openssl.bat new file mode 100755 index 0000000..c3492e0 --- /dev/null +++ b/install-win32/openssl.bat @@ -0,0 +1,5 @@ +REM Build openssl.exe with DLL linkage to OpenSSL library +REM Run this script from top level of OpenSSL source tree +REM eg.: cp /y/openvpn/20/openvpn/install-win32/openssl.bat . + +gcc -o openssl tmp\verify.o tmp\asn1pars.o tmp\req.o tmp\dgst.o tmp\dh.o tmp\dhparam.o tmp\enc.o tmp\passwd.o tmp\gendh.o tmp\errstr.o tmp\ca.o tmp\pkcs7.o tmp\crl2p7.o tmp\crl.o tmp\rsa.o tmp\rsautl.o tmp\dsa.o tmp\dsaparam.o tmp\x509.o tmp\genrsa.o tmp\gendsa.o tmp\s_server.o tmp\s_client.o tmp\speed.o tmp\s_time.o tmp\apps.o tmp\s_cb.o tmp\s_socket.o tmp\app_rand.o tmp\version.o tmp\sess_id.o tmp\ciphers.o tmp\nseq.o tmp\pkcs12.o tmp\pkcs8.o tmp\spkac.o tmp\smime.o tmp\rand.o tmp\engine.o tmp\ocsp.o tmp\prime.o tmp\openssl.o -leay32 -lssl32 -L. -lwsock32 -lgdi32 diff --git a/install-win32/openvpn.nsi.in b/install-win32/openvpn.nsi.in new file mode 100755 index 0000000..076479b --- /dev/null +++ b/install-win32/openvpn.nsi.in @@ -0,0 +1,570 @@ +; **************************************************************************** +; * Copyright (C) 2002-2005 OpenVPN Solutions LLC * +; * This program is free software; you can redistribute it and/or modify * +; * it under the terms of the GNU General Public License version 2 * +; * as published by the Free Software Foundation. * +; **************************************************************************** + +; OpenVPN install script for Windows, using NSIS + +!include "MUI.nsh" +!include "setpath.nsi" + +!define HOME "c:\src\openvpn" +!define BIN "${HOME}\bin" + +!define PRODUCT_NAME "OpenVPN" +!define VERSION "@VERSION@" # AUTO_VERSION + +!define TAP "tap0801" +!define TAPDRV "${TAP}.sys" + +; something like "-DBG2" +!define OUTFILE_LABEL "" + +; something like "DEBUG2" +!define TITLE_LABEL "" + +; Default service settings +!define SERV_CONFIG_DIR "$INSTDIR\config" +!define SERV_CONFIG_EXT "ovpn" +!define SERV_EXE_PATH "$INSTDIR\bin\openvpn.exe" +!define SERV_LOG_DIR "$INSTDIR\log" +!define SERV_PRIORITY "NORMAL_PRIORITY_CLASS" +!define SERV_LOG_APPEND "0" + +;-------------------------------- +;Configuration + + ;General + + OutFile "openvpn-${VERSION}${OUTFILE_LABEL}-install.exe" + + SetCompressor bzip2 + + ShowInstDetails show + ShowUninstDetails show + + ;Folder selection page + InstallDir "$PROGRAMFILES\${PRODUCT_NAME}" + + ;Remember install folder + InstallDirRegKey HKCU "Software\${PRODUCT_NAME}" "" + +;-------------------------------- +;Modern UI Configuration + + Name "${PRODUCT_NAME} ${VERSION} ${TITLE_LABEL}" + + !define MUI_WELCOMEPAGE_TEXT "This wizard will guide you through the installation of OpenVPN, an Open Source VPN package by James Yonan.\r\n\r\nNote that the Windows version of OpenVPN will only run on Win 2000, XP, or higher.\r\n\r\n\r\n" + + !define MUI_COMPONENTSPAGE_TEXT_TOP "Select the components to install/upgrade. Stop any OpenVPN processes or the OpenVPN service if it is running. All DLLs are installed locally." + + !define MUI_COMPONENTSPAGE_SMALLDESC + !define MUI_FINISHPAGE_SHOWREADME "$INSTDIR\INSTALL-win32.txt" + !define MUI_FINISHPAGE_NOAUTOCLOSE + !define MUI_FINISHPAGE_SHOWREADME_NOTCHECKED + !define MUI_ABORTWARNING + !define MUI_ICON "${HOME}\install-win32\openvpn.ico" + !define MUI_UNICON "${HOME}\install-win32\openvpn.ico" + !define MUI_HEADERIMAGE + !define MUI_HEADERIMAGE_BITMAP "${HOME}\install-win32\install-whirl.bmp" + !define MUI_UNFINISHPAGE_NOAUTOCLOSE + + !insertmacro MUI_PAGE_WELCOME + !insertmacro MUI_PAGE_LICENSE "${HOME}\install-win32\license.txt" + !insertmacro MUI_PAGE_COMPONENTS + !insertmacro MUI_PAGE_DIRECTORY + !insertmacro MUI_PAGE_INSTFILES + !insertmacro MUI_PAGE_FINISH + + !insertmacro MUI_UNPAGE_CONFIRM + !insertmacro MUI_UNPAGE_INSTFILES + !insertmacro MUI_UNPAGE_FINISH + + +;-------------------------------- +;Languages + + !insertmacro MUI_LANGUAGE "English" + +;-------------------------------- +;Language Strings + + LangString DESC_SecOpenVPNUserSpace ${LANG_ENGLISH} "Install OpenVPN user-space components, including openvpn.exe." + + LangString DESC_SecOpenVPNEasyRSA ${LANG_ENGLISH} "Install OpenVPN RSA scripts for X509 certificate management." + + LangString DESC_SecOpenSSLDLLs ${LANG_ENGLISH} "Install OpenSSL DLLs locally (may be omitted if DLLs are already installed globally)." + + LangString DESC_SecTAP ${LANG_ENGLISH} "Install/Upgrade the TAP-Win32 virtual device driver. Will not interfere with CIPE." + + LangString DESC_SecService ${LANG_ENGLISH} "Install the OpenVPN service wrapper (openvpnserv.exe)" + + LangString DESC_SecOpenSSLUtilities ${LANG_ENGLISH} "Install the OpenSSL Utilities (used for generating public/private key pairs)." + + LangString DESC_SecAddPath ${LANG_ENGLISH} "Add OpenVPN executable directory to the current user's PATH." + + LangString DESC_SecAddShortcuts ${LANG_ENGLISH} "Add OpenVPN shortcuts to the current user's Start Menu." + + LangString DESC_SecFileAssociation ${LANG_ENGLISH} "Register OpenVPN config file association (*.${SERV_CONFIG_EXT})" + +;-------------------------------- +;Reserve Files + + ;Things that need to be extracted on first (keep these lines before any File command!) + ;Only useful for BZIP2 compression + + ReserveFile "${HOME}\install-win32\install-whirl.bmp" + +;-------------------------------- +;Macros + +!macro WriteRegStringIfUndef ROOT SUBKEY KEY VALUE +Push $R0 +ReadRegStr $R0 "${ROOT}" "${SUBKEY}" "${KEY}" +StrCmp $R0 "" +1 +2 +WriteRegStr "${ROOT}" "${SUBKEY}" "${KEY}" '${VALUE}' +Pop $R0 +!macroend + +!macro DelRegStringIfUnchanged ROOT SUBKEY KEY VALUE +Push $R0 +ReadRegStr $R0 "${ROOT}" "${SUBKEY}" "${KEY}" +StrCmp $R0 '${VALUE}' +1 +2 +DeleteRegValue "${ROOT}" "${SUBKEY}" "${KEY}" +Pop $R0 +!macroend + +!macro DelRegKeyIfUnchanged ROOT SUBKEY VALUE +Push $R0 +ReadRegStr $R0 "${ROOT}" "${SUBKEY}" "" +StrCmp $R0 '${VALUE}' +1 +2 +DeleteRegKey "${ROOT}" "${SUBKEY}" +Pop $R0 +!macroend + +!macro DelRegKeyIfEmpty ROOT SUBKEY +Push $R0 +EnumRegValue $R0 "${ROOT}" "${SUBKEY}" 1 +StrCmp $R0 "" +1 +2 +DeleteRegKey /ifempty "${ROOT}" "${SUBKEY}" +Pop $R0 +!macroend + +;------------------------------------------ +;Set reboot flag based on tapinstall return + +Function CheckReboot + IntCmp $R0 1 "" noreboot noreboot + IntOp $R0 0 & 0 + SetRebootFlag true + DetailPrint "REBOOT flag set" + noreboot: +FunctionEnd + +;-------------------------------- +;Installer Sections + +Function .onInit + ClearErrors + UserInfo::GetName + IfErrors ok + Pop $R0 + UserInfo::GetAccountType + Pop $R1 + StrCmp $R1 "Admin" ok + Messagebox MB_OK "Administrator privileges required to install OpenVPN [$R0/$R1]" + Abort + ok: +FunctionEnd + +!define SF_SELECTED 1 + +Section "OpenVPN User-Space Components" SecOpenVPNUserSpace + + SetOverwrite on + SetOutPath "$INSTDIR\bin" + + File "${HOME}\openvpn.exe" + +SectionEnd + +Section "OpenVPN RSA Certificate Management Scripts" SecOpenVPNEasyRSA + + SetOverwrite on + SetOutPath "$INSTDIR\easy-rsa" + + File "${HOME}\install-win32\openssl.cnf.sample" + File "${HOME}\easy-rsa\Windows\vars.bat.sample" + + File "${HOME}\easy-rsa\Windows\init-config.bat" + + File "${HOME}\easy-rsa\Windows\README.txt" + File "${HOME}\easy-rsa\Windows\build-ca.bat" + File "${HOME}\easy-rsa\Windows\build-dh.bat" + File "${HOME}\easy-rsa\Windows\build-key-server.bat" + File "${HOME}\easy-rsa\Windows\build-key.bat" + File "${HOME}\easy-rsa\Windows\build-key-pkcs12.bat" + File "${HOME}\easy-rsa\Windows\clean-all.bat" + File "${HOME}\easy-rsa\Windows\index.txt.start" + File "${HOME}\easy-rsa\Windows\revoke-full.bat" + File "${HOME}\easy-rsa\Windows\serial.start" + +SectionEnd + +Section "OpenVPN Service" SecService + + SetOverwrite on + + SetOutPath "$INSTDIR\bin" + File "${HOME}\service-win32\openvpnserv.exe" + + SetOutPath "$INSTDIR\config" + + FileOpen $R0 "$INSTDIR\config\README.txt" w + FileWrite $R0 "This directory should contain OpenVPN configuration files$\r$\n" + FileWrite $R0 "each having an extension of .${SERV_CONFIG_EXT}$\r$\n" + FileWrite $R0 "$\r$\n" + FileWrite $R0 "When OpenVPN is started as a service, a separate OpenVPN$\r$\n" + FileWrite $R0 "process will be instantiated for each configuration file.$\r$\n" + FileClose $R0 + + SetOutPath "$INSTDIR\sample-config" + File "${HOME}\install-win32\sample.${SERV_CONFIG_EXT}" + File "${HOME}\install-win32\client.${SERV_CONFIG_EXT}" + File "${HOME}\install-win32\server.${SERV_CONFIG_EXT}" + + CreateDirectory "$INSTDIR\log" + FileOpen $R0 "$INSTDIR\log\README.txt" w + FileWrite $R0 "This directory will contain the log files for OpenVPN$\r$\n" + FileWrite $R0 "sessions which are being run as a service.$\r$\n" + FileClose $R0 + +SectionEnd + +Section "OpenVPN File Associations" SecFileAssociation +SectionEnd + +Section "OpenSSL DLLs" SecOpenSSLDLLs + + SetOverwrite on + SetOutPath "$INSTDIR\bin" + File "${BIN}\libeay32.dll" + File "${BIN}\libssl32.dll" + +SectionEnd + +Section "OpenSSL Utilities" SecOpenSSLUtilities + + SetOverwrite on + SetOutPath "$INSTDIR\bin" + File "${BIN}\openssl.exe" + +SectionEnd + +Section "TAP-Win32 Virtual Ethernet Adapter" SecTAP + + SetOverwrite on + SetOutPath "$INSTDIR\bin" + File "${BIN}\ti3790\tapinstall.exe" + + FileOpen $R0 "$INSTDIR\bin\addtap.bat" w + FileWrite $R0 "rem Add a new TAP-Win32 virtual ethernet adapter$\r$\n" + FileWrite $R0 '"$INSTDIR\bin\tapinstall.exe" install "$INSTDIR\driver\OemWin2k.inf" ${TAP}$\r$\n' + FileWrite $R0 "pause$\r$\n" + FileClose $R0 + + FileOpen $R0 "$INSTDIR\bin\deltapall.bat" w + FileWrite $R0 "echo WARNING: this script will delete ALL TAP-Win32 virtual adapters (use the device manager to delete adapters one at a time)$\r$\n" + FileWrite $R0 "pause$\r$\n" + FileWrite $R0 '"$INSTDIR\bin\tapinstall.exe" remove ${TAP}$\r$\n' + FileWrite $R0 "pause$\r$\n" + FileClose $R0 + + SetOutPath "$INSTDIR\driver" + File "${HOME}\tap-win32\i386\OemWin2k.inf" + File "${HOME}\tap-win32\i386\${TAPDRV}" + +SectionEnd + +Section "Add OpenVPN to PATH" SecAddPath + + ; remove previously set path (if any) + Push "$INSTDIR\bin" + Call RemoveFromPath + + ; append our bin directory to end of current user path + Push "$INSTDIR\bin" + Call AddToPath + +SectionEnd + +Section "Add Shortcuts to Start Menu" SecAddShortcuts + + SetOverwrite on + CreateDirectory "$SMPROGRAMS\OpenVPN" + WriteINIStr "$SMPROGRAMS\OpenVPN\OpenVPN Windows Notes.url" "InternetShortcut" "URL" "http://openvpn.net/INSTALL-win32.html" + WriteINIStr "$SMPROGRAMS\OpenVPN\OpenVPN Manual Page.url" "InternetShortcut" "URL" "http://openvpn.net/man.html" + WriteINIStr "$SMPROGRAMS\OpenVPN\OpenVPN HOWTO.url" "InternetShortcut" "URL" "http://openvpn.net/howto.html" + WriteINIStr "$SMPROGRAMS\OpenVPN\OpenVPN Web Site.url" "InternetShortcut" "URL" "http://openvpn.net/" + CreateShortCut "$SMPROGRAMS\OpenVPN\Uninstall OpenVPN.lnk" "$INSTDIR\Uninstall.exe" + +SectionEnd + +;-------------------- +;Post-install section + +Section -post + + ; delete old devcon.exe + Delete "$INSTDIR\bin\devcon.exe" + + ; + ; install/upgrade TAP-Win32 driver if selected, using tapinstall.exe + ; + SectionGetFlags ${SecTAP} $R0 + IntOp $R0 $R0 & ${SF_SELECTED} + IntCmp $R0 ${SF_SELECTED} "" notap notap + ; TAP install/update was selected. + ; Should we install or update? + ; If tapinstall error occurred, $5 will + ; be nonzero. + IntOp $5 0 & 0 + nsExec::ExecToStack '"$INSTDIR\bin\tapinstall.exe" hwids ${TAP}' + Pop $R0 # return value/error/timeout + IntOp $5 $5 | $R0 + DetailPrint "tapinstall hwids returned: $R0" + + ; If tapinstall output string contains "${TAP}" we assume + ; that TAP device has been previously installed, + ; therefore we will update, not install. + Push "${TAP}" + Call StrStr + Pop $R0 + + IntCmp $5 0 "" tapinstall_check_error tapinstall_check_error + IntCmp $R0 -1 tapinstall + + ;tapupdate: + DetailPrint "TAP-Win32 UPDATE" + nsExec::ExecToLog '"$INSTDIR\bin\tapinstall.exe" update "$INSTDIR\driver\OemWin2k.inf" ${TAP}' + Pop $R0 # return value/error/timeout + Call CheckReboot + IntOp $5 $5 | $R0 + DetailPrint "tapinstall update returned: $R0" + Goto tapinstall_check_error + + tapinstall: + DetailPrint "TAP-Win32 REMOVE OLD TAP" + nsExec::ExecToLog '"$INSTDIR\bin\tapinstall.exe" remove TAP' + Pop $R0 # return value/error/timeout + DetailPrint "tapinstall remove TAP returned: $R0" + nsExec::ExecToLog '"$INSTDIR\bin\tapinstall.exe" remove TAPDEV' + Pop $R0 # return value/error/timeout + DetailPrint "tapinstall remove TAPDEV returned: $R0" + + DetailPrint "TAP-Win32 INSTALL (${TAP})" + nsExec::ExecToLog '"$INSTDIR\bin\tapinstall.exe" install "$INSTDIR\driver\OemWin2k.inf" ${TAP}' + Pop $R0 # return value/error/timeout + Call CheckReboot + IntOp $5 $5 | $R0 + DetailPrint "tapinstall install returned: $R0" + + tapinstall_check_error: + DetailPrint "tapinstall cumulative status: $5" + IntCmp $5 0 notap + MessageBox MB_OK "An error occurred installing the TAP-Win32 device driver." + + notap: + + ; Store install folder in registry + WriteRegStr HKLM SOFTWARE\OpenVPN "" $INSTDIR + + ; install as a service if requested + SectionGetFlags ${SecService} $R0 + IntOp $R0 $R0 & ${SF_SELECTED} + IntCmp $R0 ${SF_SELECTED} "" noserv noserv + + ; set registry parameters for openvpnserv + !insertmacro WriteRegStringIfUndef HKLM "SOFTWARE\OpenVPN" "config_dir" "${SERV_CONFIG_DIR}" + !insertmacro WriteRegStringIfUndef HKLM "SOFTWARE\OpenVPN" "config_ext" "${SERV_CONFIG_EXT}" + !insertmacro WriteRegStringIfUndef HKLM "SOFTWARE\OpenVPN" "exe_path" "${SERV_EXE_PATH}" + !insertmacro WriteRegStringIfUndef HKLM "SOFTWARE\OpenVPN" "log_dir" "${SERV_LOG_DIR}" + !insertmacro WriteRegStringIfUndef HKLM "SOFTWARE\OpenVPN" "priority" "${SERV_PRIORITY}" + !insertmacro WriteRegStringIfUndef HKLM "SOFTWARE\OpenVPN" "log_append" "${SERV_LOG_APPEND}" + + ; install openvpnserv as a service + DetailPrint "Previous Service REMOVE (if exists)" + nsExec::ExecToLog '"$INSTDIR\bin\openvpnserv.exe" -remove' + Pop $R0 # return value/error/timeout + DetailPrint "Service INSTALL" + nsExec::ExecToLog '"$INSTDIR\bin\openvpnserv.exe" -install' + Pop $R0 # return value/error/timeout + + noserv: + ; Store README, license, icon + SetOverwrite on + SetOutPath $INSTDIR + File "${HOME}\install-win32\INSTALL-win32.txt" + File "${HOME}\install-win32\license.txt" + File "${HOME}\install-win32\openvpn.ico" + + ; Create file association if requested + SectionGetFlags ${SecFileAssociation} $R0 + IntOp $R0 $R0 & ${SF_SELECTED} + IntCmp $R0 ${SF_SELECTED} "" noass noass + !insertmacro WriteRegStringIfUndef HKCR ".${SERV_CONFIG_EXT}" "" "OpenVPNFile" + !insertmacro WriteRegStringIfUndef HKCR "OpenVPNFile" "" "OpenVPN Config File" + !insertmacro WriteRegStringIfUndef HKCR "OpenVPNFile\shell" "" "open" + !insertmacro WriteRegStringIfUndef HKCR "OpenVPNFile\DefaultIcon" "" "$INSTDIR\openvpn.ico,0" + !insertmacro WriteRegStringIfUndef HKCR "OpenVPNFile\shell\open\command" "" 'notepad.exe "%1"' + !insertmacro WriteRegStringIfUndef HKCR "OpenVPNFile\shell\run" "" "Start OpenVPN on this config file" + !insertmacro WriteRegStringIfUndef HKCR "OpenVPNFile\shell\run\command" "" '"$INSTDIR\bin\openvpn.exe" --pause-exit --config "%1"' + + ; Create start menu shortcuts to addtap.bat and deltapall.bat + noass: + IfFileExists "$INSTDIR\bin\addtap.bat" "" trydeltap + CreateShortCut "$SMPROGRAMS\OpenVPN\Add a new TAP-Win32 virtual ethernet adapter.lnk" "$INSTDIR\bin\addtap.bat" "" + + trydeltap: + IfFileExists "$INSTDIR\bin\deltapall.bat" "" config_shortcut + CreateShortCut "$SMPROGRAMS\OpenVPN\Delete ALL TAP-Win32 virtual ethernet adapters.lnk" "$INSTDIR\bin\deltapall.bat" "" + + ; Create start menu shortcuts for config and log directories + config_shortcut: + IfFileExists "$INSTDIR\config" "" log_shortcut + CreateShortCut "$SMPROGRAMS\OpenVPN\OpenVPN configuration file directory.lnk" "$INSTDIR\config" "" + + log_shortcut: + IfFileExists "$INSTDIR\log" "" samp_shortcut + CreateShortCut "$SMPROGRAMS\OpenVPN\OpenVPN log file directory.lnk" "$INSTDIR\log" "" + + samp_shortcut: + IfFileExists "$INSTDIR\sample-config" "" genkey_shortcut + CreateShortCut "$SMPROGRAMS\OpenVPN\OpenVPN Sample Configuration Files.lnk" "$INSTDIR\sample-config" "" + + genkey_shortcut: + IfFileExists "$INSTDIR\bin\openvpn.exe" "" noshortcuts + IfFileExists "$INSTDIR\config" "" noshortcuts + CreateShortCut "$SMPROGRAMS\OpenVPN\Generate a static OpenVPN key.lnk" "$INSTDIR\bin\openvpn.exe" '--pause-exit --verb 3 --genkey --secret "$INSTDIR\config\key.txt"' "$INSTDIR\openvpn.ico" 0 + + noshortcuts: + ; Create uninstaller + WriteUninstaller "$INSTDIR\Uninstall.exe" + + ; Show up in Add/Remove programs + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${PRODUCT_NAME}" "DisplayName" "${PRODUCT_NAME} ${VERSION}" + WriteRegExpandStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${PRODUCT_NAME}" "UninstallString" "$INSTDIR\Uninstall.exe" + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${PRODUCT_NAME}" "DisplayIcon" "$INSTDIR\openvpn.ico" + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${PRODUCT_NAME}" "DisplayVersion" "${VERSION}" + + ; Advise a reboot + ;Messagebox MB_OK "IMPORTANT: Rebooting the system is advised in order to finalize TAP-Win32 driver installation/upgrade (this is an informational message only, pressing OK will not reboot)." + +SectionEnd + +;-------------------------------- +;Descriptions + +!insertmacro MUI_FUNCTION_DESCRIPTION_BEGIN + !insertmacro MUI_DESCRIPTION_TEXT ${SecOpenVPNUserSpace} $(DESC_SecOpenVPNUserSpace) + !insertmacro MUI_DESCRIPTION_TEXT ${SecOpenVPNEasyRSA} $(DESC_SecOpenVPNEasyRSA) + !insertmacro MUI_DESCRIPTION_TEXT ${SecTAP} $(DESC_SecTAP) + !insertmacro MUI_DESCRIPTION_TEXT ${SecOpenSSLUtilities} $(DESC_SecOpenSSLUtilities) + !insertmacro MUI_DESCRIPTION_TEXT ${SecOpenSSLDLLs} $(DESC_SecOpenSSLDLLs) + !insertmacro MUI_DESCRIPTION_TEXT ${SecAddPath} $(DESC_SecAddPath) + !insertmacro MUI_DESCRIPTION_TEXT ${SecAddShortcuts} $(DESC_SecAddShortcuts) + !insertmacro MUI_DESCRIPTION_TEXT ${SecService} $(DESC_SecService) + !insertmacro MUI_DESCRIPTION_TEXT ${SecFileAssociation} $(DESC_SecFileAssociation) +!insertmacro MUI_FUNCTION_DESCRIPTION_END + +;-------------------------------- +;Uninstaller Section + +Function un.onInit + ClearErrors + UserInfo::GetName + IfErrors ok + Pop $R0 + UserInfo::GetAccountType + Pop $R1 + StrCmp $R1 "Admin" ok + Messagebox MB_OK "Administrator privileges required to uninstall OpenVPN [$R0/$R1]" + Abort + ok: +FunctionEnd + +Section "Uninstall" + + DetailPrint "Service REMOVE" + nsExec::ExecToLog '"$INSTDIR\bin\openvpnserv.exe" -remove' + Pop $R0 # return value/error/timeout + + Sleep 2000 + + DetailPrint "TAP-Win32 REMOVE" + nsExec::ExecToLog '"$INSTDIR\bin\tapinstall.exe" remove ${TAP}' + Pop $R0 # return value/error/timeout + DetailPrint "tapinstall remove returned: $R0" + + Push "$INSTDIR\bin" + Call un.RemoveFromPath + + RMDir /r $SMPROGRAMS\OpenVPN + + Delete "$INSTDIR\bin\openvpn.exe" + Delete "$INSTDIR\bin\openvpnserv.exe" + Delete "$INSTDIR\bin\libeay32.dll" + Delete "$INSTDIR\bin\libssl32.dll" + Delete "$INSTDIR\bin\tapinstall.exe" + Delete "$INSTDIR\bin\addtap.bat" + Delete "$INSTDIR\bin\deltapall.bat" + + Delete "$INSTDIR\config\README.txt" + Delete "$INSTDIR\config\sample.${SERV_CONFIG_EXT}.txt" + + Delete "$INSTDIR\log\README.txt" + + Delete "$INSTDIR\driver\OemWin2k.inf" + Delete "$INSTDIR\driver\${TAPDRV}" + + Delete "$INSTDIR\bin\openssl.exe" + + Delete "$INSTDIR\INSTALL-win32.txt" + Delete "$INSTDIR\openvpn.ico" + Delete "$INSTDIR\license.txt" + Delete "$INSTDIR\Uninstall.exe" + + Delete "$INSTDIR\easy-rsa\openssl.cnf.sample" + Delete "$INSTDIR\easy-rsa\vars.bat.sample" + Delete "$INSTDIR\easy-rsa\init-config.bat" + Delete "$INSTDIR\easy-rsa\README.txt" + Delete "$INSTDIR\easy-rsa\build-ca.bat" + Delete "$INSTDIR\easy-rsa\build-dh.bat" + Delete "$INSTDIR\easy-rsa\build-key-server.bat" + Delete "$INSTDIR\easy-rsa\build-key.bat" + Delete "$INSTDIR\easy-rsa\build-key-pkcs12.bat" + Delete "$INSTDIR\easy-rsa\clean-all.bat" + Delete "$INSTDIR\easy-rsa\index.txt.start" + Delete "$INSTDIR\easy-rsa\revoke-key.bat" + Delete "$INSTDIR\easy-rsa\revoke-full.bat" + Delete "$INSTDIR\easy-rsa\serial.start" + + Delete "$INSTDIR\sample-config\*.ovpn" + + RMDir "$INSTDIR\bin" + RMDir "$INSTDIR\driver" + RMDir "$INSTDIR\easy-rsa" + RMDir "$INSTDIR\sample-config" + RMDir "$INSTDIR" + + !insertmacro DelRegKeyIfUnchanged HKCR ".${SERV_CONFIG_EXT}" "OpenVPNFile" + DeleteRegKey HKCR "OpenVPNFile" + DeleteRegKey HKLM SOFTWARE\OpenVPN + DeleteRegKey HKCU "Software\${PRODUCT_NAME}" + DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\OpenVPN" + + ;Messagebox MB_OK "IMPORTANT: If you intend on reinstalling OpenVPN after this uninstall, and you are running Win2K, you are strongly urged to reboot before reinstalling (this is an informational message only, pressing OK will not reboot)." + +SectionEnd diff --git a/install-win32/prebuild b/install-win32/prebuild new file mode 100755 index 0000000..bd3e699 --- /dev/null +++ b/install-win32/prebuild @@ -0,0 +1,145 @@ +# Given a standard OpenVPN tarball tree, +# build a Windows tree which is NSIS-ready. +# +# Requires: +# MinGW +# MSYS GNU shell environment +# See other requirements below + +# Top level directory. +H=/c/src + +# Output NSIS-ready tree here (will be deleted +# if already exists). +OUT=$H/openvpn-build + +# Source distribution is here. Can be the top +# level directory of exploded tarball. +IN=/y/openvpn/20/openvpn + +# Already built OpenSSL tree. +SSL=$H/openssl-0.9.7g + +# Already built LZO tree. +LZO=$H/lzo-1.08 + +# Already built dmalloc tree. +# Optional, but leave defined even if you are not using +# dmalloc. +DMALLOC=$H/dmalloc-5.4.2 + +# TAP binaries should be here: tap0801.sys and tapinstall.exe +# These must be built with MS DDK. +TAPBIN=$H/tapbin + +# u2d.c should exist here. +SCRIPTS=$IN/install-win32 + +# Put service.[ch] here from MS Platform SDK. +SVC_TEMPLATE=$H/svc-template + +# Misc files/directories which should be copied to OUT (optional) +MISC=$H/add + +# Temporary directory +TMP=/tmp + +# End of user-defined parameters. + +U2D=$TMP/u2d + +echo BUILD u2d +gcc -O2 $SCRIPTS/u2d.c -o $U2D + +echo BUILD output dir from source +rm -rf $OUT +mkdir $OUT + +cp $IN/*.[ch] $OUT +rm -f $OUT/config.h + +if [ $MISC ]; then + cp $MISC/*.* $OUT +fi + +echo BUILD makefile + +sed "s#^OPENSSL = .*\$#OPENSSL = $SSL#" <$IN/makefile.w32 | \ +sed "s#^LZO = .*\$#LZO = $LZO#" | \ +sed "s#^DMALLOC = .*\$#DMALLOC = $DMALLOC#" >$OUT/Makefile + +echo BUILD bin + +mkdir $OUT/bin +for f in libeay32.dll libssl32.dll openssl.exe ; do + cp $SSL/$f $OUT/bin + strip $OUT/bin/$f +done + +echo BUILD install-win32 + +mkdir $OUT/install-win32 + +cp $IN/install-win32/openvpn.nsi $OUT/install-win32 +cp $IN/install-win32/setpath.nsi $OUT/install-win32 +cp $IN/images/install-whirl.bmp $OUT/install-win32 +cp $IN/images/openvpn.ico $OUT/install-win32 +cp $IN/INSTALL-win32.txt $OUT/install-win32 +cat $IN/COPYING $IN/COPYRIGHT.GPL | $U2D >$OUT/install-win32/license.txt + +$U2D <$IN/sample-config-files/client.conf >$OUT/install-win32/client.ovpn +$U2D <$IN/sample-config-files/server.conf >$OUT/install-win32/server.ovpn +cp $IN/install-win32/sample.ovpn $OUT/install-win32 +$U2D <$IN/easy-rsa/openssl.cnf >$OUT/install-win32/openssl.cnf.sample + +echo BUILD tap-win32 + +mkdir $OUT/tap-win32 +cp $IN/tap-win32/*.[ch] $OUT/tap-win32 +cp $IN/tap-win32/*.rc $OUT/tap-win32 +cp $IN/tap-win32/MAKEFILE $OUT/tap-win32 +cp $IN/tap-win32/SOURCES $OUT/tap-win32 + +mkdir $OUT/tap-win32/i386 +cp $IN/tap-win32/i386/OemWin2k.inf $OUT/tap-win32/i386 +cp $IN/tap-win32/i386/tap.cat $OUT/tap-win32/i386 + +cp $TAPBIN/tap0801.sys $OUT/tap-win32/i386 + +mkdir $OUT/bin/ti3790 +cp $TAPBIN/tapinstall.exe $OUT/bin/ti3790 + +echo BUILD service-win32 + +mkdir $OUT/service-win32 +cp $IN/service-win32/Makefile $OUT/service-win32 +cp $IN/service-win32/mkpatch $OUT/service-win32 +cp $IN/service-win32/openvpnserv.c $OUT/service-win32 +cp $IN/service-win32/service.patch $OUT/service-win32 + +cp $SVC_TEMPLATE/service.[ch] $OUT/service-win32 +cp $OUT/service-win32/service.h $OUT/service-win32/service.h.orig +cp $OUT/service-win32/service.c $OUT/service-win32/service.c.orig + +pushd $OUT/service-win32 +patch <service.patch +popd + +echo BUILD easy-rsa +cp -a $IN/easy-rsa $OUT + +echo BUILD sample-keys +cp -a $IN/sample-keys $OUT + +echo COMPILE OpenVPN +pushd $OUT +make +strip openvpn.exe +popd + +echo COMPILE OpenVPN Service +pushd $OUT/service-win32 +make clean +make +strip openvpnserv.exe +popd diff --git a/install-win32/sample.ovpn b/install-win32/sample.ovpn new file mode 100755 index 0000000..5accd57 --- /dev/null +++ b/install-win32/sample.ovpn @@ -0,0 +1,103 @@ +# Edit this file, and save to a .ovpn extension +# so that OpenVPN will activate it when run +# as a service. + +# Change 'myremote' to be your remote host, +# or comment out to enter a listening +# server mode. +remote myremote + +# Uncomment this line to use a different +# port number than the default of 1194. +; port 1194 + +# Choose one of three protocols supported by +# OpenVPN. If left commented out, defaults +# to udp. +; proto [tcp-server | tcp-client | udp] + +# You must specify one of two possible network +# protocols, 'dev tap' or 'dev tun' to be used +# on both sides of the connection. 'tap' creates +# a VPN using the ethernet protocol while 'tun' +# uses the IP protocol. You must use 'tap' +# if you are ethernet bridging or want to route +# broadcasts. 'tun' is somewhat more efficient +# but requires configuration of client software +# to not depend on broadcasts. Some platforms +# such as Solaris, OpenBSD, and Mac OS X only +# support 'tun' interfaces, so if you are +# connecting to such a platform, you must also +# use a 'tun' interface on the Windows side. + +# Enable 'dev tap' or 'dev tun' but not both! +dev tap + +# This is a 'dev tap' ifconfig that creates +# a virtual ethernet subnet. +# 10.3.0.1 is the local VPN IP address +# and 255.255.255.0 is the VPN subnet. +# Only define this option for 'dev tap'. +ifconfig 10.3.0.1 255.255.255.0 + +# This is a 'dev tun' ifconfig that creates +# a point-to-point IP link. +# 10.3.0.1 is the local VPN IP address and +# 10.3.0.2 is the remote VPN IP address. +# Only define this option for 'dev tun'. +# Make sure to include the "tun-mtu" option +# on the remote machine, but swap the order +# of the ifconfig addresses. +;tun-mtu 1500 +;ifconfig 10.3.0.1 10.3.0.2 + +# If you have fragmentation issues or misconfigured +# routers in the path which block Path MTU discovery, +# lower the TCP MSS and internally fragment non-TCP +# protocols. +;fragment 1300 +;mssfix + +# If you have set up more than one TAP-Win32 adapter +# on your system, you must refer to it by name. +;dev-node my-tap + +# You can generate a static OpenVPN key +# by selecting the Generate Key option +# in the start menu. +# +# You can also generate key.txt manually +# with the following command: +# openvpn --genkey --secret key.txt +# +# key must match on both ends of the connection, +# so you should generate it on one machine and +# copy it to the other over a secure medium. +# Place key.txt in the same directory as this +# config file. +secret key.txt + +# Uncomment this section for a more reliable +# detection when a system loses its connection. +# For example, dial-ups or laptops that travel +# to other locations. +# +# If this section is enabled and "myremote" +# above is a dynamic DNS name (i.e. dyndns.org), +# OpenVPN will dynamically "follow" the IP +# address of "myremote" if it changes. +; ping-restart 60 +; ping-timer-rem +; persist-tun +; persist-key +; resolv-retry 86400 + +# keep-alive ping +ping 10 + +# enable LZO compression +comp-lzo + +# moderate verbosity +verb 4 +mute 10 diff --git a/install-win32/setpath.nsi b/install-win32/setpath.nsi new file mode 100755 index 0000000..a9626c3 --- /dev/null +++ b/install-win32/setpath.nsi @@ -0,0 +1,231 @@ +; Modify the user's PATH variable. +; +; Modified by JY to have both a RemoveFromPath +; and an un.RemoveFromPath which are basically +; copies of each other. Why does NSIS demand +; this nonsense? +; +; Modified Feb 14, 2005 by Mathias Sundman: +; Added code to remove the semicolon at the end of the path +; when uninstalling. +; +; Added code to make sure we don't insert an extra semicolon +; before our path if there already exist one at the end of +; the original path. +; +; Removed duplicated "un. and install" functions and made +; macros to duplicate the code instead. + +; example usage +; +;Section "Add to path" +; Push $INSTDIR +; Call AddToPath +;SectionEnd +; +;# ... +; +;Section "uninstall" +; # ... +; Push $INSTDIR +; Call un.RemoveFromPath +; # ... +;SectionEnd + +!verbose 3 +!include "WinMessages.NSH" +!verbose 4 + +;==================================================== +; AddToPath - Adds the given dir to the search path. +; Input - head of the stack +; Note - Win9x systems requires reboot +;==================================================== +Function AddToPath + Exch $0 + Push $1 + Push $2 + + Call IsNT + Pop $1 + StrCmp $1 1 AddToPath_NT + ; Not on NT + StrCpy $1 $WINDIR 2 + FileOpen $1 "$1\autoexec.bat" a + FileSeek $1 0 END + GetFullPathName /SHORT $0 $0 + FileWrite $1 "$\r$\nSET PATH=%PATH%;$0$\r$\n" + FileClose $1 + Goto AddToPath_done + + AddToPath_NT: + ReadRegStr $1 HKCU "Environment" "PATH" + StrCpy $2 $1 1 -1 # copy last char + StrCmp $2 ";" 0 +2 # if last char == ; + StrCpy $1 $1 -1 # remove last char + + StrCmp $1 "" AddToPath_NTdoIt + StrCpy $0 "$1;$0" + Goto AddToPath_NTdoIt + AddToPath_NTdoIt: + WriteRegExpandStr HKCU "Environment" "PATH" $0 + SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} 0 "STR:Environment" /TIMEOUT=5000 + + AddToPath_done: + Pop $2 + Pop $1 + Pop $0 +FunctionEnd + +;==================================================== +; RemoveFromPath - Remove a given dir from the path +; Input: head of the stack +;==================================================== +!macro RemoveFromPath un +Function ${un}RemoveFromPath + Exch $0 + Push $1 + Push $2 + Push $3 + Push $4 + Push $5 + + Call ${un}IsNT + Pop $1 + StrCmp $1 1 RemoveFromPath_NT + ; Not on NT + StrCpy $1 $WINDIR 2 + FileOpen $1 "$1\autoexec.bat" r + GetTempFileName $4 + FileOpen $2 $4 w + GetFullPathName /SHORT $0 $0 + StrCpy $0 "SET PATH=%PATH%;$0" + SetRebootFlag true + Goto RemoveFromPath_dosLoop + + RemoveFromPath_dosLoop: + FileRead $1 $3 + StrCmp $3 "$0$\r$\n" RemoveFromPath_dosLoop + StrCmp $3 "$0$\n" RemoveFromPath_dosLoop + StrCmp $3 "$0" RemoveFromPath_dosLoop + StrCmp $3 "" RemoveFromPath_dosLoopEnd + FileWrite $2 $3 + Goto RemoveFromPath_dosLoop + + RemoveFromPath_dosLoopEnd: + FileClose $2 + FileClose $1 + StrCpy $1 $WINDIR 2 + Delete "$1\autoexec.bat" + CopyFiles /SILENT $4 "$1\autoexec.bat" + Delete $4 + Goto RemoveFromPath_done + + RemoveFromPath_NT: + StrLen $2 $0 + ReadRegStr $1 HKCU "Environment" "PATH" + Push $1 + Push $0 + Call ${un}StrStr ; Find $0 in $1 + Pop $0 ; pos of our dir + IntCmp $0 -1 RemoveFromPath_done + ; else, it is in path + StrCpy $3 $1 $0 ; $3 now has the part of the path before our dir + IntOp $2 $2 + $0 ; $2 now contains the pos after our dir in the path (';') + IntOp $2 $2 + 1 ; $2 now containts the pos after our dir and the semicolon. + StrLen $0 $1 + StrCpy $1 $1 $0 $2 + StrCpy $3 "$3$1" + + StrCpy $5 $3 1 -1 # copy last char + StrCmp $5 ";" 0 +2 # if last char == ; + StrCpy $3 $3 -1 # remove last char + + WriteRegExpandStr HKCU "Environment" "PATH" $3 + SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} 0 "STR:Environment" /TIMEOUT=5000 + + RemoveFromPath_done: + Pop $5 + Pop $4 + Pop $3 + Pop $2 + Pop $1 + Pop $0 +FunctionEnd +!macroend +!insertmacro RemoveFromPath "" +!insertmacro RemoveFromPath "un." + + +;==================================================== +; StrStr - Finds a given string in another given string. +; Returns -1 if not found and the pos if found. +; Input: head of the stack - string to find +; second in the stack - string to find in +; Output: head of the stack +;==================================================== +!macro StrStr un +Function ${un}StrStr + Push $0 + Exch + Pop $0 ; $0 now have the string to find + Push $1 + Exch 2 + Pop $1 ; $1 now have the string to find in + Exch + Push $2 + Push $3 + Push $4 + Push $5 + + StrCpy $2 -1 + StrLen $3 $0 + StrLen $4 $1 + IntOp $4 $4 - $3 + + StrStr_loop: + IntOp $2 $2 + 1 + IntCmp $2 $4 0 0 StrStrReturn_notFound + StrCpy $5 $1 $3 $2 + StrCmp $5 $0 StrStr_done StrStr_loop + + StrStrReturn_notFound: + StrCpy $2 -1 + + StrStr_done: + Pop $5 + Pop $4 + Pop $3 + Exch $2 + Exch 2 + Pop $0 + Pop $1 +FunctionEnd +!macroend +!insertmacro StrStr "" +!insertmacro StrStr "un." + +;==================================================== +; IsNT - Returns 1 if the current system is NT, 0 +; otherwise. +; Output: head of the stack +;==================================================== +!macro IsNT un +Function ${un}IsNT + Push $0 + ReadRegStr $0 HKLM "SOFTWARE\Microsoft\Windows NT\CurrentVersion" CurrentVersion + StrCmp $0 "" 0 IsNT_yes + ; we are not NT. + Pop $0 + Push 0 + Return + + IsNT_yes: + ; NT!!! + Pop $0 + Push 1 +FunctionEnd +!macroend +!insertmacro IsNT "" +!insertmacro IsNT "un." + diff --git a/install-win32/u2d.c b/install-win32/u2d.c new file mode 100755 index 0000000..bf1f5e8 --- /dev/null +++ b/install-win32/u2d.c @@ -0,0 +1,20 @@ +#include <stdio.h> + +int +main (int argc, char *argv[]) +{ + int c; + int enable = 1; + + while ((c = getchar()) != EOF) + { +#if 0 + if (c == '\r') + enable = 0; + if (enable && c == '\n') + putchar ('\r'); +#endif + putchar (c); + } + return 0; +} diff --git a/integer.h b/integer.h new file mode 100644 index 0000000..68cf40f --- /dev/null +++ b/integer.h @@ -0,0 +1,114 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef INTEGER_H +#define INTEGER_H + +#include "error.h" + +/* + * min/max functions + */ + +static inline int +max_int (int x, int y) +{ + if (x > y) + return x; + else + return y; +} + +static inline int +min_int (int x, int y) +{ + if (x < y) + return x; + else + return y; +} + +static inline int +constrain_int (int x, int min, int max) +{ + if (min > max) + return min; + if (x < min) + return min; + else if (x > max) + return max; + else + return x; +} + +/* + * Functions used for circular buffer index arithmetic. + */ + +/* + * Return x - y on a circle of circumference mod by shortest path. + * + * 0 <= x < mod + * 0 <= y < mod + */ +static inline int +modulo_subtract(int x, int y, int mod) +{ + const int d1 = x - y; + const int d2 = (x > y ? -mod : mod) + d1; + ASSERT (0 <= x && x < mod && 0 <= y && y < mod); + return abs(d1) > abs(d2) ? d2 : d1; +} + +/* + * Return x + y on a circle of circumference mod. + * + * 0 <= x < mod + * -mod <= y <= mod + */ +static inline int +modulo_add(int x, int y, int mod) +{ + int sum = x + y; + ASSERT (0 <= x && x < mod && -mod <= y && y <= mod); + if (sum >= mod) + sum -= mod; + if (sum < 0) + sum += mod; + return sum; +} + +static inline int +index_verify (int index, int size, const char *file, int line) +{ + if (index < 0 || index >= size) + msg (M_FATAL, "Assertion Failed: Array index=%d out of bounds for array size=%d in %s:%d", + index, + size, + file, + line); + return index; +} + +#endif diff --git a/interval.c b/interval.c new file mode 100644 index 0000000..7221e03 --- /dev/null +++ b/interval.c @@ -0,0 +1,83 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "interval.h" + +#include "memdbg.h" + +void +interval_init (struct interval *top, int horizon, int refresh) +{ + CLEAR (*top); + top->refresh = refresh; + top->horizon = horizon; +} + +bool +event_timeout_trigger (struct event_timeout *et, + struct timeval *tv, + const int et_const_retry) +{ + bool ret = false; + const time_t local_now = now; + + if (et->defined) + { + int wakeup = (int) et->last + et->n - local_now; + if (wakeup <= 0) + { +#if INTERVAL_DEBUG + dmsg (D_INTERVAL, "EVENT event_timeout_trigger (%d) etcr=%d", et->n, et_const_retry); +#endif + if (et_const_retry < 0) + { + et->last = local_now; + wakeup = et->n; + ret = true; + } + else + { + wakeup = et_const_retry; + } + } + + if (tv && wakeup < tv->tv_sec) + { +#if INTERVAL_DEBUG + dmsg (D_INTERVAL, "EVENT event_timeout_wakeup (%d/%d) etcr=%d", wakeup, et->n, et_const_retry); +#endif + tv->tv_sec = wakeup; + tv->tv_usec = 0; + } + } + return ret; +} diff --git a/interval.h b/interval.h new file mode 100644 index 0000000..9845066 --- /dev/null +++ b/interval.h @@ -0,0 +1,239 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * The interval_ routines are designed to optimize the calling of a routine + * (normally tls_multi_process()) which can be called less frequently + * between triggers. + */ + +#ifndef INTERVAL_H +#define INTERVAL_H + +#include "otime.h" + +#define INTERVAL_DEBUG 0 + +/* + * Designed to limit calls to expensive functions that need to be called + * regularly. + */ + +struct interval +{ + interval_t refresh; + interval_t horizon; + time_t future_trigger; + time_t last_action; + time_t last_test_true; +}; + +void interval_init (struct interval *top, int horizon, int refresh); + +/* + * IF + * last_action less than horizon seconds ago + * OR last_test_true more than refresh seconds ago + * OR hit future_trigger + * THEN + * return true + * ELSE + * set wakeup to the number of seconds until a true return + * return false + */ + +static inline bool +interval_test (struct interval* top) +{ + bool trigger = false; + const time_t local_now = now; + + if (top->future_trigger && local_now >= top->future_trigger) + { + trigger = true; + top->future_trigger = 0; + } + + if (top->last_action + top->horizon > local_now || + top->last_test_true + top->refresh <= local_now || + trigger) + { + top->last_test_true = local_now; +#if INTERVAL_DEBUG + dmsg (D_INTERVAL, "INTERVAL interval_test true"); +#endif + return true; + } + else + { + return false; + } +} + +static inline void +interval_schedule_wakeup (struct interval* top, interval_t *wakeup) +{ + const time_t local_now = now; + interval_earliest_wakeup (wakeup, top->last_test_true + top->refresh, local_now); + interval_earliest_wakeup (wakeup, top->future_trigger, local_now); +#if INTERVAL_DEBUG + dmsg (D_INTERVAL, "INTERVAL interval_schedule wakeup=%d", (int)*wakeup); +#endif +} + +/* + * In wakeup seconds, interval_test will return true once. + */ +static inline void +interval_future_trigger (struct interval* top, interval_t wakeup) { + if (wakeup) + { +#if INTERVAL_DEBUG + dmsg (D_INTERVAL, "INTERVAL interval_future_trigger %d", (int)wakeup); +#endif + top->future_trigger = now + wakeup; + } +} + +/* + * Once an action is triggered, interval_test will remain true for + * horizon seconds. + */ +static inline void +interval_action (struct interval* top) +{ +#if INTERVAL_DEBUG + dmsg (D_INTERVAL, "INTERVAL action"); +#endif + top->last_action = now; +} + +/* + * Measure when n seconds beyond an event have elapsed + */ + +struct event_timeout +{ + bool defined; + interval_t n; + time_t last; /* time of last event */ +}; + +static inline bool +event_timeout_defined (const struct event_timeout* et) +{ + return et->defined; +} + +static inline void +event_timeout_clear (struct event_timeout* et) +{ + et->defined = false; + et->n = 0; + et->last = 0; +} + +static inline struct event_timeout +event_timeout_clear_ret () +{ + struct event_timeout ret; + event_timeout_clear (&ret); + return ret; +} + +static inline void +event_timeout_init (struct event_timeout* et, interval_t n, const time_t local_now) +{ + et->defined = true; + et->n = (n >= 0) ? n : 0; + et->last = local_now; +} + +static inline void +event_timeout_reset (struct event_timeout* et) +{ + if (et->defined) + et->last = now; +} + +/* + * This is the principal function for testing and triggering recurring + * timers and will return true on a timer signal event. + * If et_const_retry == ETT_DEFAULT and a signal occurs, + * the function will return true and *et will be armed for the + * next event. If et_const_retry >= 0 and a signal occurs, + * *et will not be touched, but *tv will be set to + * minimum (*tv, et_const_retry) for a future re-test, + * and the function will return true. + */ + +#define ETT_DEFAULT (-1) + +bool event_timeout_trigger (struct event_timeout *et, + struct timeval *tv, + const int et_const_retry); + +/* + * Measure time intervals in microseconds + */ + +#define USEC_TIMER_MAX 60 /* maximum interval size in seconds */ + +#define USEC_TIMER_MAX_USEC (USEC_TIMER_MAX * 1000000) + +struct usec_timer { + struct timeval start; + struct timeval end; +}; + +#ifdef HAVE_GETTIMEOFDAY + +static inline void +usec_timer_start (struct usec_timer *obj) +{ + CLEAR (*obj); + gettimeofday (&obj->start, NULL); +} + +static inline void +usec_timer_end (struct usec_timer *obj) +{ + gettimeofday (&obj->end, NULL); +} + +#endif /* HAVE_GETTIMEOFDAY */ + +static inline bool +usec_timer_interval_defined (struct usec_timer *obj) +{ + return obj->start.tv_sec && obj->end.tv_sec; +} + +static inline int +usec_timer_interval (struct usec_timer *obj) +{ + return tv_subtract (&obj->end, &obj->start, USEC_TIMER_MAX); +} + +#endif /* INTERVAL_H */ @@ -0,0 +1,664 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP_SERVER + +#include "list.h" +#include "misc.h" + +#include "memdbg.h" + +struct hash * +hash_init (const int n_buckets, + uint32_t (*hash_function)(const void *key, uint32_t iv), + bool (*compare_function)(const void *key1, const void *key2)) +{ + struct hash *h; + int i; + + ASSERT (n_buckets > 0); + ALLOC_OBJ_CLEAR (h, struct hash); + h->n_buckets = (int) adjust_power_of_2 (n_buckets); + h->mask = h->n_buckets - 1; + h->hash_function = hash_function; + h->compare_function = compare_function; + h->iv = get_random (); + ALLOC_ARRAY (h->buckets, struct hash_bucket, h->n_buckets); + for (i = 0; i < h->n_buckets; ++i) + { + struct hash_bucket *b = &h->buckets[i]; + b->list = NULL; + mutex_init (&b->mutex); + } + return h; +} + +void +hash_free (struct hash *hash) +{ + int i; + for (i = 0; i < hash->n_buckets; ++i) + { + struct hash_bucket *b = &hash->buckets[i]; + struct hash_element *he = b->list; + + mutex_destroy (&b->mutex); + while (he) + { + struct hash_element *next = he->next; + free (he); + he = next; + } + } + free (hash->buckets); + free (hash); +} + +struct hash_element * +hash_lookup_fast (struct hash *hash, + struct hash_bucket *bucket, + const void *key, + uint32_t hv) +{ + struct hash_element *he; + struct hash_element *prev = NULL; + + he = bucket->list; + + while (he) + { + if (hv == he->hash_value && (*hash->compare_function)(key, he->key)) + { + /* move to head of list */ + if (prev) + { + prev->next = he->next; + he->next = bucket->list; + bucket->list = he; + } + return he; + } + prev = he; + he = he->next; + } + + return NULL; +} + +bool +hash_remove_fast (struct hash *hash, + struct hash_bucket *bucket, + const void *key, + uint32_t hv) +{ + struct hash_element *he; + struct hash_element *prev = NULL; + + he = bucket->list; + + while (he) + { + if (hv == he->hash_value && (*hash->compare_function)(key, he->key)) + { + if (prev) + prev->next = he->next; + else + bucket->list = he->next; + free (he); + --hash->n_elements; + return true; + } + prev = he; + he = he->next; + } + return false; +} + +bool +hash_add (struct hash *hash, const void *key, void *value, bool replace) +{ + uint32_t hv; + struct hash_bucket *bucket; + struct hash_element *he; + bool ret = false; + + hv = hash_value (hash, key); + bucket = &hash->buckets[hv & hash->mask]; + mutex_lock (&bucket->mutex); + + if ((he = hash_lookup_fast (hash, bucket, key, hv))) /* already exists? */ + { + if (replace) + { + he->value = value; + ret = true; + } + } + else + { + hash_add_fast (hash, bucket, key, hv, value); + ret = true; + } + + mutex_unlock (&bucket->mutex); + + return ret; +} + +void +hash_remove_by_value (struct hash *hash, void *value, bool autolock) +{ + struct hash_iterator hi; + struct hash_element *he; + + hash_iterator_init (hash, &hi, autolock); + while ((he = hash_iterator_next (&hi))) + { + if (he->value == value) + hash_iterator_delete_element (&hi); + } + hash_iterator_free (&hi); +} + +static void +hash_remove_marked (struct hash *hash, struct hash_bucket *bucket) +{ + struct hash_element *prev = NULL; + struct hash_element *he = bucket->list; + + while (he) + { + if (!he->key) /* marked? */ + { + struct hash_element *newhe; + if (prev) + newhe = prev->next = he->next; + else + newhe = bucket->list = he->next; + free (he); + --hash->n_elements; + he = newhe; + } + else + { + prev = he; + he = he->next; + } + } +} + +uint32_t +void_ptr_hash_function (const void *key, uint32_t iv) +{ + return hash_func ((const void *)&key, sizeof (key), iv); +} + +bool +void_ptr_compare_function (const void *key1, const void *key2) +{ + return key1 == key2; +} + +void +hash_iterator_init_range (struct hash *hash, + struct hash_iterator *hi, + bool autolock, + int start_bucket, + int end_bucket) +{ + if (end_bucket > hash->n_buckets) + end_bucket = hash->n_buckets; + + ASSERT (start_bucket >= 0 && start_bucket <= end_bucket); + + hi->hash = hash; + hi->elem = NULL; + hi->bucket = NULL; + hi->autolock = autolock; + hi->last = NULL; + hi->bucket_marked = false; + hi->bucket_index_start = start_bucket; + hi->bucket_index_end = end_bucket; + hi->bucket_index = hi->bucket_index_start - 1; +} + +void +hash_iterator_init (struct hash *hash, + struct hash_iterator *hi, + bool autolock) +{ + hash_iterator_init_range (hash, hi, autolock, 0, hash->n_buckets); +} + +static inline void +hash_iterator_lock (struct hash_iterator *hi, struct hash_bucket *b) +{ + if (hi->autolock) + { + mutex_lock (&b->mutex); + } + hi->bucket = b; + hi->last = NULL; + hi->bucket_marked = false; +} + +static inline void +hash_iterator_unlock (struct hash_iterator *hi) +{ + if (hi->bucket) + { + if (hi->bucket_marked) + { + hash_remove_marked (hi->hash, hi->bucket); + hi->bucket_marked = false; + } + if (hi->autolock) + { + mutex_unlock (&hi->bucket->mutex); + } + hi->bucket = NULL; + hi->last = NULL; + } +} + +static inline void +hash_iterator_advance (struct hash_iterator *hi) +{ + hi->last = hi->elem; + hi->elem = hi->elem->next; +} + +void +hash_iterator_free (struct hash_iterator *hi) +{ + hash_iterator_unlock (hi); +} + +struct hash_element * +hash_iterator_next (struct hash_iterator *hi) +{ + struct hash_element *ret = NULL; + if (hi->elem) + { + ret = hi->elem; + hash_iterator_advance (hi); + } + else + { + while (++hi->bucket_index < hi->bucket_index_end) + { + struct hash_bucket *b; + hash_iterator_unlock (hi); + b = &hi->hash->buckets[hi->bucket_index]; + if (b->list) + { + hash_iterator_lock (hi, b); + hi->elem = b->list; + if (hi->elem) + { + ret = hi->elem; + hash_iterator_advance (hi); + break; + } + } + } + } + return ret; +} + +void +hash_iterator_delete_element (struct hash_iterator *hi) +{ + ASSERT (hi->last); + hi->last->key = NULL; + hi->bucket_marked = true; +} + + +#ifdef LIST_TEST + +/* + * Test the hash code by implementing a simple + * word frequency algorithm. + */ + +struct word +{ + const char *word; + int n; +}; + +static uint32_t +word_hash_function (const void *key, uint32_t iv) +{ + const char *str = (const char *) key; + const int len = strlen (str); + return hash_func ((const uint8_t *)str, len, iv); +} + +static bool +word_compare_function (const void *key1, const void *key2) +{ + return strcmp ((const char *)key1, (const char *)key2) == 0; +} + +static void +print_nhash (struct hash *hash) +{ + struct hash_iterator hi; + struct hash_element *he; + int count = 0; + + hash_iterator_init (hash, &hi, true); + + while ((he = hash_iterator_next (&hi))) + { + printf ("%d ", (int) he->value); + ++count; + } + printf ("\n"); + + hash_iterator_free (&hi); + ASSERT (count == hash_n_elements (hash)); +} + +static void +rmhash (struct hash *hash, const char *word) +{ + hash_remove (hash, word); +} + +void +list_test (void) +{ + openvpn_thread_init (); + + { + struct gc_arena gc = gc_new (); + struct hash *hash = hash_init (10000, word_hash_function, word_compare_function); + struct hash *nhash = hash_init (256, word_hash_function, word_compare_function); + + printf ("hash_init n_buckets=%d mask=0x%08x\n", hash->n_buckets, hash->mask); + + /* parse words from stdin */ + while (true) + { + char buf[256]; + char wordbuf[256]; + int wbi; + int bi; + char c; + + if (!fgets(buf, sizeof(buf), stdin)) + break; + + bi = wbi = 0; + do + { + c = buf[bi++]; + if (isalnum (c) || c == '_') + { + ASSERT (wbi < (int) sizeof (wordbuf)); + wordbuf[wbi++] = c; + } + else + { + if (wbi) + { + struct word *w; + ASSERT (wbi < (int) sizeof (wordbuf)); + wordbuf[wbi++] = '\0'; + + /* word is parsed from stdin */ + + /* does it already exist in table? */ + w = (struct word *) hash_lookup (hash, wordbuf); + + if (w) + { + /* yes, increment count */ + ++w->n; + } + else + { + /* no, make a new object */ + ALLOC_OBJ_GC (w, struct word, &gc); + w->word = string_alloc (wordbuf, &gc); + w->n = 1; + ASSERT (hash_add (hash, w->word, w, false)); + ASSERT (hash_add (nhash, w->word, (void*) ((random() & 0x0F) + 1), false)); + } + } + wbi = 0; + } + } while (c); + } + +#if 1 + /* remove some words from the table */ + { + rmhash (hash, "true"); + rmhash (hash, "false"); + } +#endif + + /* output contents of hash table */ + { + int base; + int inc = 0; + int count = 0; + + for (base = 0; base < hash_n_buckets (hash); base += inc) { + struct hash_iterator hi; + struct hash_element *he; + inc = (get_random () % 3) + 1; + hash_iterator_init_range (hash, &hi, true, base, base + inc); + + while ((he = hash_iterator_next (&hi))) + { + struct word *w = (struct word *) he->value; + printf ("%6d '%s'\n", w->n, w->word); + ++count; + } + + hash_iterator_free (&hi); + } + ASSERT (count == hash_n_elements (hash)); + } + +#if 1 + /* test hash_remove_by_value function */ + { + int i; + for (i = 1; i <= 16; ++i) + { + printf ("[%d] ***********************************\n", i); + print_nhash (nhash); + hash_remove_by_value (nhash, (void *) i, true); + } + printf ("FINAL **************************\n"); + print_nhash (nhash); + } +#endif + + hash_free (hash); + hash_free (nhash); + gc_free (&gc); + } + + openvpn_thread_cleanup (); +} + +#endif + +/* +-------------------------------------------------------------------- +hash() -- hash a variable-length key into a 32-bit value + k : the key (the unaligned variable-length array of bytes) + len : the length of the key, counting by bytes + level : can be any 4-byte value +Returns a 32-bit value. Every bit of the key affects every bit of +the return value. Every 1-bit and 2-bit delta achieves avalanche. +About 36+6len instructions. + +The best hash table sizes are powers of 2. There is no need to do +mod a prime (mod is sooo slow!). If you need less than 32 bits, +use a bitmask. For example, if you need only 10 bits, do + h = (h & hashmask(10)); +In which case, the hash table should have hashsize(10) elements. + +If you are hashing n strings (uint8_t **)k, do it like this: + for (i=0, h=0; i<n; ++i) h = hash( k[i], len[i], h); + +By Bob Jenkins, 1996. bob_jenkins@burtleburtle.net. You may use this +code any way you wish, private, educational, or commercial. It's free. + +See http://burlteburtle.net/bob/hash/evahash.html +Use for hash table lookup, or anything where one collision in 2^32 is +acceptable. Do NOT use for cryptographic purposes. + +-------------------------------------------------------------------- + +mix -- mix 3 32-bit values reversibly. +For every delta with one or two bit set, and the deltas of all three + high bits or all three low bits, whether the original value of a,b,c + is almost all zero or is uniformly distributed, +* If mix() is run forward or backward, at least 32 bits in a,b,c + have at least 1/4 probability of changing. +* If mix() is run forward, every bit of c will change between 1/3 and + 2/3 of the time. (Well, 22/100 and 78/100 for some 2-bit deltas.) +mix() was built out of 36 single-cycle latency instructions in a + structure that could supported 2x parallelism, like so: + a -= b; + a -= c; x = (c>>13); + b -= c; a ^= x; + b -= a; x = (a<<8); + c -= a; b ^= x; + c -= b; x = (b>>13); + ... + Unfortunately, superscalar Pentiums and Sparcs can't take advantage + of that parallelism. They've also turned some of those single-cycle + latency instructions into multi-cycle latency instructions. Still, + this is the fastest good hash I could find. There were about 2^^68 + to choose from. I only looked at a billion or so. + +James Yonan Notes: + +* This function is faster than it looks, and appears to be + appropriate for our usage in OpenVPN which is primarily + for hash-table based address lookup (IPv4, IPv6, and Ethernet MAC). + NOTE: This function is never used for cryptographic purposes, only + to produce evenly-distributed indexes into hash tables. + +* Benchmark results: 11.39 machine cycles per byte on a P2 266Mhz, + and 12.1 machine cycles per byte on a + 2.2 Ghz P4 when hashing a 6 byte string. +-------------------------------------------------------------------- +*/ + +#define mix(a,b,c) \ +{ \ + a -= b; a -= c; a ^= (c>>13); \ + b -= c; b -= a; b ^= (a<<8); \ + c -= a; c -= b; c ^= (b>>13); \ + a -= b; a -= c; a ^= (c>>12); \ + b -= c; b -= a; b ^= (a<<16); \ + c -= a; c -= b; c ^= (b>>5); \ + a -= b; a -= c; a ^= (c>>3); \ + b -= c; b -= a; b ^= (a<<10); \ + c -= a; c -= b; c ^= (b>>15); \ +} + +uint32_t +hash_func (const uint8_t *k, uint32_t length, uint32_t initval) +{ + uint32_t a, b, c, len; + + /* Set up the internal state */ + len = length; + a = b = 0x9e3779b9; /* the golden ratio; an arbitrary value */ + c = initval; /* the previous hash value */ + + /*---------------------------------------- handle most of the key */ + while (len >= 12) + { + a += (k[0] + ((uint32_t) k[1] << 8) + + ((uint32_t) k[2] << 16) + + ((uint32_t) k[3] << 24)); + b += (k[4] + ((uint32_t) k[5] << 8) + + ((uint32_t) k[6] << 16) + + ((uint32_t) k[7] << 24)); + c += (k[8] + ((uint32_t) k[9] << 8) + + ((uint32_t) k[10] << 16) + + ((uint32_t) k[11] << 24)); + mix (a, b, c); + k += 12; + len -= 12; + } + + /*------------------------------------- handle the last 11 bytes */ + c += length; + switch (len) /* all the case statements fall through */ + { + case 11: + c += ((uint32_t) k[10] << 24); + case 10: + c += ((uint32_t) k[9] << 16); + case 9: + c += ((uint32_t) k[8] << 8); + /* the first byte of c is reserved for the length */ + case 8: + b += ((uint32_t) k[7] << 24); + case 7: + b += ((uint32_t) k[6] << 16); + case 6: + b += ((uint32_t) k[5] << 8); + case 5: + b += k[4]; + case 4: + a += ((uint32_t) k[3] << 24); + case 3: + a += ((uint32_t) k[2] << 16); + case 2: + a += ((uint32_t) k[1] << 8); + case 1: + a += k[0]; + /* case 0: nothing left to add */ + } + mix (a, b, c); + /*-------------------------------------- report the result */ + return c; +} + +#else +static void dummy(void) {} +#endif /* P2MP_SERVER */ @@ -0,0 +1,220 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef LIST_H +#define LIST_H + +/* + * This code is a fairly straightforward hash + * table implementation using Bob Jenkins' + * hash function. + * + * Hash tables are used in OpenVPN to keep track of + * client instances over various key spaces. + */ + +#if P2MP_SERVER + +/* define this to enable special list test mode */ +/*#define LIST_TEST*/ + +#include "basic.h" +#include "thread.h" +#include "buffer.h" + +#define hashsize(n) ((uint32_t)1<<(n)) +#define hashmask(n) (hashsize(n)-1) + +struct hash_element +{ + void *value; + const void *key; + unsigned int hash_value; + struct hash_element *next; +}; + +struct hash_bucket +{ + MUTEX_DEFINE (mutex); + struct hash_element * volatile list; +}; + +struct hash +{ + int n_buckets; + int n_elements; + int mask; + uint32_t iv; + uint32_t (*hash_function)(const void *key, uint32_t iv); + bool (*compare_function)(const void *key1, const void *key2); /* return true if equal */ + struct hash_bucket *buckets; +}; + +struct hash *hash_init (const int n_buckets, + uint32_t (*hash_function)(const void *key, uint32_t iv), + bool (*compare_function)(const void *key1, const void *key2)); + +void hash_free (struct hash *hash); + +bool hash_add (struct hash *hash, const void *key, void *value, bool replace); + +struct hash_element *hash_lookup_fast (struct hash *hash, + struct hash_bucket *bucket, + const void *key, + uint32_t hv); + +bool hash_remove_fast (struct hash *hash, + struct hash_bucket *bucket, + const void *key, + uint32_t hv); + +void hash_remove_by_value (struct hash *hash, void *value, bool autolock); + +struct hash_iterator +{ + struct hash *hash; + int bucket_index; + struct hash_bucket *bucket; + struct hash_element *elem; + struct hash_element *last; + bool bucket_marked; + bool autolock; + int bucket_index_start; + int bucket_index_end; +}; + +void hash_iterator_init_range (struct hash *hash, + struct hash_iterator *hi, + bool autolock, + int start_bucket, + int end_bucket); + +void hash_iterator_init (struct hash *hash, struct hash_iterator *iter, bool autolock); +struct hash_element *hash_iterator_next (struct hash_iterator *hi); +void hash_iterator_delete_element (struct hash_iterator *hi); +void hash_iterator_free (struct hash_iterator *hi); + +uint32_t hash_func (const uint8_t *k, uint32_t length, uint32_t initval); + +uint32_t void_ptr_hash_function (const void *key, uint32_t iv); +bool void_ptr_compare_function (const void *key1, const void *key2); + +#ifdef LIST_TEST +void list_test (void); +#endif + +static inline uint32_t +hash_value (const struct hash *hash, const void *key) +{ + return (*hash->hash_function)(key, hash->iv); +} + +static inline int +hash_n_elements (const struct hash *hash) +{ + return hash->n_elements; +} + +static inline int +hash_n_buckets (const struct hash *hash) +{ + return hash->n_buckets; +} + +static inline struct hash_bucket * +hash_bucket (struct hash *hash, uint32_t hv) +{ + return &hash->buckets[hv & hash->mask]; +} + +static inline void +hash_bucket_lock (struct hash_bucket *bucket) +{ + mutex_lock (&bucket->mutex); +} + +static inline void +hash_bucket_unlock (struct hash_bucket *bucket) +{ + mutex_unlock (&bucket->mutex); +} + +static inline void * +hash_lookup_lock (struct hash *hash, const void *key, uint32_t hv) +{ + void *ret = NULL; + struct hash_element *he; + struct hash_bucket *bucket = &hash->buckets[hv & hash->mask]; + + mutex_lock (&bucket->mutex); + he = hash_lookup_fast (hash, bucket, key, hv); + if (he) + ret = he->value; + mutex_unlock (&bucket->mutex); + + return ret; +} + +static inline void * +hash_lookup (struct hash *hash, const void *key) +{ + return hash_lookup_lock (hash, key, hash_value (hash, key)); +} + +/* NOTE: assumes that key is not a duplicate */ +static inline void +hash_add_fast (struct hash *hash, + struct hash_bucket *bucket, + const void *key, + uint32_t hv, + void *value) +{ + struct hash_element *he; + + ALLOC_OBJ (he, struct hash_element); + he->value = value; + he->key = key; + he->hash_value = hv; + he->next = bucket->list; + bucket->list = he; + ++hash->n_elements; +} + +static inline bool +hash_remove (struct hash *hash, const void *key) +{ + uint32_t hv; + struct hash_bucket *bucket; + bool ret; + + hv = hash_value (hash, key); + bucket = &hash->buckets[hv & hash->mask]; + mutex_lock (&bucket->mutex); + ret = hash_remove_fast (hash, bucket, key, hv); + mutex_unlock (&bucket->mutex); + return ret; +} + +#endif /* P2MP_SERVER */ +#endif /* LIST */ @@ -0,0 +1,251 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#ifdef USE_LZO + +#include "syshead.h" + +#include "lzo.h" +#include "error.h" +#include "otime.h" + +#include "memdbg.h" + +static bool +lzo_adaptive_compress_test (struct lzo_adaptive_compress *ac) +{ + const bool save = ac->compress_state; + const time_t local_now = now; + + if (!ac->enabled) + return true; + + if (!ac->compress_state) + { + if (local_now >= ac->next) + { + if (ac->n_total > AC_MIN_BYTES + && (ac->n_total - ac->n_comp) < (ac->n_total / (100 / AC_SAVE_PCT))) + { + ac->compress_state = true; + ac->next = local_now + AC_OFF_SEC; + } + else + { + ac->next = local_now + AC_SAMP_SEC; + } + dmsg (D_COMP, "lzo_adaptive_compress_test: comp=%d total=%d", ac->n_comp, ac->n_total); + ac->n_total = ac->n_comp = 0; + } + } + else + { + if (local_now >= ac->next) + { + ac->next = local_now + AC_SAMP_SEC; + ac->n_total = ac->n_comp = 0; + ac->compress_state = false; + } + } + + if (ac->compress_state != save) + dmsg (D_COMP_LOW, "Adaptive compression state %s", (ac->compress_state ? "OFF" : "ON")); + + return !ac->compress_state; +} + +inline static void +lzo_adaptive_compress_data (struct lzo_adaptive_compress *ac, int n_total, int n_comp) +{ + if (ac->enabled) + { + ac->n_total += n_total; + ac->n_comp += n_comp; + } +} + +void lzo_adjust_frame_parameters (struct frame *frame) +{ + /* Leave room for our one-byte compressed/didn't-compress prefix byte. */ + frame_add_to_extra_frame (frame, LZO_PREFIX_LEN); + + /* Leave room for compression buffer to expand in worst case scenario + where data is totally uncompressible */ + frame_add_to_extra_buffer (frame, LZO_EXTRA_BUFFER (EXPANDED_SIZE(frame))); +} + +void +lzo_compress_init (struct lzo_compress_workspace *lzowork, bool adaptive) +{ + CLEAR (*lzowork); + + lzowork->wmem_size = LZO_WORKSPACE; + lzowork->ac.enabled = adaptive; + + if (lzo_init () != LZO_E_OK) + msg (M_FATAL, "Cannot initialize LZO compression library"); + lzowork->wmem = (lzo_voidp) lzo_malloc (lzowork->wmem_size); + check_malloc_return (lzowork->wmem); + msg (M_INFO, "LZO compression initialized"); +} + +void +lzo_compress_uninit (struct lzo_compress_workspace *lzowork) +{ + if (lzowork) + { + lzo_free (lzowork->wmem); + lzowork->wmem = NULL; + } +} + +/* Magic numbers to tell our peer if we compressed or not */ +#define YES_COMPRESS 0x66 +#define NO_COMPRESS 0xFA + +void +lzo_compress (struct buffer *buf, struct buffer work, + struct lzo_compress_workspace *lzowork, + const struct frame* frame) +{ + lzo_uint zlen = 0; + int err; + bool compressed = false; + + if (buf->len <= 0) + return; + + /* + * In order to attempt compression, length must be at least COMPRESS_THRESHOLD, + * and our adaptive level must give the OK. + */ + if (buf->len >= COMPRESS_THRESHOLD && lzo_adaptive_compress_test (&lzowork->ac)) + { + ASSERT (buf_init (&work, FRAME_HEADROOM (frame))); + ASSERT (buf_safe (&work, LZO_EXTRA_BUFFER (PAYLOAD_SIZE (frame)))); + ASSERT (buf->len <= PAYLOAD_SIZE (frame)); + + err = LZO_COMPRESS (BPTR (buf), BLEN (buf), BPTR (&work), &zlen, lzowork->wmem); + if (err != LZO_E_OK) + { + dmsg (D_COMP_ERRORS, "LZO compression error: %d", err); + buf->len = 0; + return; + } + + ASSERT (buf_safe (&work, zlen)); + work.len = zlen; + compressed = true; + + dmsg (D_COMP, "compress %d -> %d", buf->len, work.len); + lzowork->pre_compress += buf->len; + lzowork->post_compress += work.len; + + /* tell adaptive level about our success or lack thereof in getting any size reduction */ + lzo_adaptive_compress_data(&lzowork->ac, buf->len, work.len); + } + + /* did compression save us anything ? */ + if (compressed && work.len < buf->len) + { + uint8_t *header = buf_prepend (&work, 1); + *header = YES_COMPRESS; + *buf = work; + } + else + { + uint8_t *header = buf_prepend (buf, 1); + *header = NO_COMPRESS; + } +} + +void +lzo_decompress (struct buffer *buf, struct buffer work, + struct lzo_compress_workspace *lzowork, + const struct frame* frame) +{ + lzo_uint zlen = EXPANDED_SIZE (frame); + uint8_t c; /* flag indicating whether or not our peer compressed */ + int err; + + if (buf->len <= 0) + return; + + ASSERT (buf_init (&work, FRAME_HEADROOM (frame))); + + c = *BPTR (buf); + ASSERT (buf_advance (buf, 1)); + + if (c == YES_COMPRESS) /* packet was compressed */ + { + ASSERT (buf_safe (&work, zlen)); + err = LZO_DECOMPRESS (BPTR (buf), BLEN (buf), BPTR (&work), &zlen, + lzowork->wmem); + if (err != LZO_E_OK) + { + dmsg (D_COMP_ERRORS, "LZO decompression error: %d", err); + buf->len = 0; + return; + } + + ASSERT (buf_safe (&work, zlen)); + work.len = zlen; + + dmsg (D_COMP, "decompress %d -> %d", buf->len, work.len); + lzowork->pre_decompress += buf->len; + lzowork->post_decompress += work.len; + + *buf = work; + } + else if (c == NO_COMPRESS) /* packet was not compressed */ + { + ; + } + else + { + dmsg (D_COMP_ERRORS, "Bad LZO decompression header byte: %d", c); + buf->len = 0; + } +} + +/* + * Print statistics + */ +void lzo_print_stats (const struct lzo_compress_workspace *lzo_compwork, struct status_output *so) +{ + status_printf (so, "pre-compress bytes," counter_format, lzo_compwork->pre_compress); + status_printf (so, "post-compress bytes," counter_format, lzo_compwork->post_compress); + status_printf (so, "pre-decompress bytes," counter_format, lzo_compwork->pre_decompress); + status_printf (so, "post-decompress bytes," counter_format, lzo_compwork->post_decompress); +} + +#else +static void dummy(void) {} +#endif /* USE_LZO */ @@ -0,0 +1,117 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef USE_LZO + +#ifdef LZO_HEADER_DIR +#include "lzo/lzoutil.h" +#include "lzo/lzo1x.h" +#else +#include "lzoutil.h" +#include "lzo1x.h" +#endif + +#include "buffer.h" +#include "mtu.h" +#include "common.h" +#include "status.h" + +/* + * Use LZO compress routine lzo1x_1_15_compress which is described + * as faster but needs a bit more memory than the standard routine. + * Use safe decompress (i.e. check for buffer overflows). + * You may want to use the non-safe version + * of decompress if speed is essential and if you know + * that you will always be using a MAC to verify the + * integrity of incoming packets. + */ +#define LZO_COMPRESS lzo1x_1_15_compress +#define LZO_WORKSPACE LZO1X_1_15_MEM_COMPRESS +#define LZO_DECOMPRESS lzo1x_decompress_safe + +#define LZO_EXTRA_BUFFER(len) ((len)/8 + 128 + 3) /* LZO 2.0 worst case size expansion. */ + +/* + * Don't try to compress any packet smaller than this. + */ +#define COMPRESS_THRESHOLD 100 + +/* + * Length of prepended prefix on LZO packets + */ +#define LZO_PREFIX_LEN 1 + +/* + * Adaptive compress parameters + */ +#define AC_SAMP_SEC 2 /* number of seconds in sample period */ +#define AC_MIN_BYTES 1000 /* sample period must have at least n bytes + to be valid for testing */ +#define AC_SAVE_PCT 5 /* turn off compress if we didn't save at + least this % during sample period */ +#define AC_OFF_SEC 60 /* if we turn off compression, don't do sample + retest for n seconds */ + +struct lzo_adaptive_compress { + bool enabled; + bool compress_state; + time_t next; + int n_total; + int n_comp; +}; + +/* + * Compress and Uncompress routines. + */ + +struct lzo_compress_workspace +{ + lzo_voidp wmem; + int wmem_size; + struct lzo_adaptive_compress ac; + + /* statistics */ + counter_type pre_decompress; + counter_type post_decompress; + counter_type pre_compress; + counter_type post_compress; +}; + +void lzo_adjust_frame_parameters(struct frame *frame); + +void lzo_compress_init (struct lzo_compress_workspace *lzowork, bool adaptive); + +void lzo_compress_uninit (struct lzo_compress_workspace *lzowork); + +void lzo_compress (struct buffer *buf, struct buffer work, + struct lzo_compress_workspace *lzowork, + const struct frame* frame); + +void lzo_decompress (struct buffer *buf, struct buffer work, + struct lzo_compress_workspace *lzowork, + const struct frame* frame); + +void lzo_print_stats (const struct lzo_compress_workspace *lzo_compwork, struct status_output *so); + +#endif /* USE_LZO */ diff --git a/makefile.w32 b/makefile.w32 new file mode 100755 index 0000000..6ce111f --- /dev/null +++ b/makefile.w32 @@ -0,0 +1,197 @@ +# This Makefile builds the user-mode component +# of OpenVPN for WIN32 in the MinGW environment. +# +# Build Dependencies: +# mingw (GNU C compiler for windows) +# msys (GNU utilities and shell for windows) +# OpenSSL (SSL/TLS/crypto library) +# LZO (real-time compression library) +# Dmalloc (debugging only) +# +# Targets: +# static -- link statically with OpenSSL +# dynamic -- link dynamically with OpenSSL +# dmalloc -- enable memory debugging using the dmalloc library +# +# Note that LZO is always linked statically. +# +# To build openssl-0.9.7d, remember to edit ms\mw.bat +# adding '--win32' flag to make command: +# +# make --win32 -f ms/mingw32.mak +# +# Now cd to top level openssl directory in a Windows +# command-prompt window, and type: +# +# ms\mw +# +# See additional .bat scripts in install-win32 for OpenSSL +# build setup. +# +# If you are building with dmalloc debugging support +# see windbg.h for additional dmalloc notes. + +######################################################### +# Change these to point to your OpenSSL, LZO, and +# (optionally) dmalloc top-level directories. + +OPENSSL = /c/src/openssl-0.9.7g +LZO = /c/src/lzo-1.08 +DMALLOC = /c/src/dmalloc-5.4.2 + +######################################################### + +CC = gcc -g -O2 -Wall -Wno-unused-function -Wno-unused-variable -mno-cygwin + +CC_DMALLOC = gcc -g -O2 -Wall -Wno-unused-function -Wno-unused-variable -mno-cygwin -fno-inline -DDMALLOC + +INCLUDE_DIRS = -I${OPENSSL}/include -I${LZO}/include + +INCLUDE_DIRS_DMALLOC = ${INCLUDE_DIRS} -I${DMALLOC} + +LIBS = -llzo -lcrypt32 -lws2_32 -lgdi32 -liphlpapi -lwinmm + +LIBS_DMALLOC = ${LIBS} -ldmalloc + +LIB_DIRS = -L${OPENSSL}/out -L${LZO} + +LIB_DIRS_DMALLOC = ${LIB_DIRS} -L${DMALLOC} + +EXE = openvpn.exe + +HEADERS = \ + base64.h \ + basic.h \ + buffer.h \ + circ_list.h \ + common.h \ + tap-win32/common.h \ + config-win32.h \ + crypto.h \ + cryptoapi.h \ + errlevel.h \ + error.h \ + event.h \ + fdmisc.h \ + forward-inline.h \ + forward.h \ + fragment.h \ + gremlin.h \ + helper.h \ + init.h \ + integer.h \ + interval.h \ + list.h \ + lzo.h \ + manage.h \ + mbuf.h \ + memdbg.h \ + misc.h \ + mroute.h \ + mss.h \ + mtcp.h \ + mtu.h \ + mudp.h \ + multi.h \ + ntlm.h \ + occ-inline.h \ + occ.h \ + openvpn.h \ + openvpn-plugin.h \ + options.h \ + otime.h \ + packet_id.h \ + perf.h \ + ping-inline.h \ + ping.h \ + plugin.h \ + pool.h \ + proto.h \ + proxy.h \ + push.h \ + reliable.h \ + route.h \ + schedule.h \ + session_id.h \ + shaper.h \ + sig.h \ + socket.h \ + socks.h \ + ssl.h \ + status.h \ + syshead.h \ + thread.h \ + tun.h \ + win32.h + +OBJS = base64.o \ + buffer.o \ + crypto.o \ + cryptoapi.o \ + error.o \ + event.o \ + fdmisc.o \ + forward.o \ + fragment.o \ + gremlin.o \ + helper.o \ + init.o \ + interval.o \ + list.o \ + lzo.o \ + manage.o \ + mbuf.o \ + misc.o \ + mroute.o \ + mss.o \ + mtcp.o \ + mtu.o \ + mudp.o \ + multi.o \ + ntlm.o \ + occ.o \ + openvpn.o \ + options.o \ + otime.o \ + packet_id.o \ + perf.o \ + ping.o \ + plugin.o \ + pool.o \ + proto.o \ + proxy.o \ + push.o \ + reliable.o \ + route.o \ + schedule.o \ + session_id.o \ + shaper.o \ + sig.o \ + socket.o \ + socks.o \ + ssl.o \ + status.o \ + thread.o \ + tun.o \ + win32.o + +dynamic : MY_CC = ${CC} +dynamic : MY_INCLUDE_DIRS = ${INCLUDE_DIRS} +dynamic : ${OBJS} + ${MY_CC} -o ${EXE} ${OBJS} ${LIB_DIRS} -lssl32 -leay32 ${LIBS} + +static : MY_CC = ${CC} +static : MY_INCLUDE_DIRS = ${INCLUDE_DIRS} +static : ${OBJS} + ${CC} -o ${EXE} ${OBJS} ${LIB_DIRS} -lssl -lcrypto ${LIBS} + +dmalloc : MY_CC = ${CC_DMALLOC} +dmalloc : MY_INCLUDE_DIRS = ${INCLUDE_DIRS_DMALLOC} +dmalloc : ${OBJS} + ${MY_CC} -o ${EXE} ${OBJS} ${LIB_DIRS_DMALLOC} -lssl32 -leay32 ${LIBS_DMALLOC} + +clean : + rm -f ${OBJS} ${EXE} + +%.o : %.c ${HEADERS} + ${MY_CC} ${MY_INCLUDE_DIRS} -c $< -o $@ diff --git a/makefile.w32-vc b/makefile.w32-vc new file mode 100644 index 0000000..e37c8c8 --- /dev/null +++ b/makefile.w32-vc @@ -0,0 +1,179 @@ +# This makefile builds the user-mode component +# of OpenVPN for WIN32 in the MSVC++ environment. +# +# Build Dependencies: +# OpenSSL (SSL/TLS/crypto library) +# LZO (real-time compression library) +# +# Targets: +# static -- link statically with OpenSSL +# dynamic -- link dynamically with OpenSSL +# +# Note that LZO is always linked statically. + +# Change these to point to your OpenSSL and LZO top-level +# directories. + +OPENSSL = \src\openssl-0.9.7d +OPENSSL_STATIC = libeay32s.lib ssleay32s.lib +#OPENSSL_STATIC = libeay32sd.lib ssleay32sd.lib +OPENSSL_DYNAMIC = libeay32.lib ssleay32.lib +#OPENSSL_DYNAMIC = libeay32d.lib ssleay32d.lib + +LZO = \src\lzo-1.08.vc + +INCLUDE_DIRS = -I$(OPENSSL)/include -I$(LZO)/include + +LIBS = lzo.lib ws2_32.lib crypt32.lib iphlpapi.lib winmm.lib gdi32.lib advapi32.lib + +LIB_DIRS = -LIBPATH:$(OPENSSL)\out -LIBPATH:$(LZO) + +EXE = openvpn.exe + +CPP=cl.exe +# release: +CPP_PROJ=/nologo /MD /W3 /G5 /O2 -DNDEBUG -DWIN32 -DWIN32_LEAN_AND_MEAN -D_CONSOLE -D_MBCS $(INCLUDE_DIRS) /FD /c +# debug: +#CPP_PROJ=/nologo /MDd /W3 /G5 /Zi /Od -D_DEBUG -DWIN32 -DWIN32_LEAN_AND_MEAN -D_CONSOLE -D_MBCS $(INCLUDE_DIRS) /FD /c + +LINK32=link.exe +# release: +LINK32_FLAGS=/nologo /subsystem:console /incremental:no /out:"$(EXE)" +# debug: +#LINK32_FLAGS=/nologo /subsystem:console /incremental:no /debug /out:"$(EXE)" + +# Make sure the HEADERS and OBJS definitions below match the same +# definitions in makefile.w32. + +HEADERS = \ + base64.h \ + basic.h \ + buffer.h \ + circ_list.h common.h \ + tap-win32/common.h \ + config-win32.h \ + crypto.h \ + cryptoapi.h \ + errlevel.h \ + error.h \ + event.h \ + fdmisc.h \ + forward-inline.h \ + forward.h \ + fragment.h \ + gremlin.h \ + helper.h \ + init.h \ + integer.h \ + interval.h \ + list.h \ + lzo.h \ + manage.h \ + mbuf.h \ + memdbg.h \ + misc.h \ + mroute.h \ + mss.h \ + mtcp.h \ + mtu.h \ + mudp.h \ + multi.h \ + ntlm.h \ + occ-inline.h \ + occ.h \ + openvpn.h \ + openvpn-plugin.h \ + options.h \ + otime.h \ + packet_id.h \ + perf.h \ + ping-inline.h \ + ping.h \ + plugin.h \ + pool.h \ + proto.h \ + proxy.h \ + push.h \ + reliable.h \ + route.h \ + schedule.h \ + session_id.h \ + shaper.h \ + sig.h \ + socket.h \ + socks.h \ + ssl.h \ + status.h \ + syshead.h \ + thread.h \ + tun.h \ + win32.h + +OBJS = base64.obj \ + buffer.obj \ + crypto.obj \ + cryptoapi.obj \ + error.obj \ + event.obj \ + fdmisc.obj \ + forward.obj \ + fragment.obj \ + gremlin.obj \ + helper.obj \ + init.obj \ + interval.obj \ + list.obj \ + lzo.obj \ + manage.obj \ + mbuf.obj \ + misc.obj \ + mroute.obj \ + mss.obj \ + mtcp.obj \ + mtu.obj \ + mudp.obj \ + multi.obj \ + ntlm.obj \ + occ.obj \ + openvpn.obj \ + options.obj \ + otime.obj \ + packet_id.obj \ + perf.obj \ + ping.obj \ + plugin.obj \ + pool.obj \ + proto.obj \ + proxy.obj \ + push.obj \ + reliable.obj \ + route.obj \ + schedule.obj \ + session_id.obj \ + shaper.obj \ + sig.obj \ + socket.obj \ + socks.obj \ + ssl.obj \ + status.obj \ + thread.obj \ + tun.obj \ + win32.obj + +dynamic : $(OBJS) + $(LINK32) @<< + $(LINK32_FLAGS) $(LIB_DIRS) $(LIBS) $(OPENSSL_DYNAMIC) $(OBJS) +<< + +static : $(OBJS) + $(LINK32) @<< + $(LINK32_FLAGS) $(LIB_DIRS) $(LIBS) $(OPENSSL_STATIC) $(OBJS) +<< + +clean : + del /Q $(OBJS) $(EXE) *.idb *.pdb + +.c.obj:: + $(CPP) @<< + $(CPP_PROJ) $< +<< diff --git a/manage.c b/manage.c new file mode 100644 index 0000000..f9ec934 --- /dev/null +++ b/manage.c @@ -0,0 +1,2143 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#ifdef ENABLE_MANAGEMENT + +#include "error.h" +#include "fdmisc.h" +#include "options.h" +#include "sig.h" +#include "event.h" +#include "otime.h" +#include "integer.h" +#include "manage.h" + +#include "memdbg.h" + +struct management *management; /* GLOBAL */ + +/* static forward declarations */ +static void man_output_standalone (struct management *man, volatile int *signal_received); +static void man_reset_client_socket (struct management *man, const bool listen); + +static void +man_help () +{ + msg (M_CLIENT, "Management Interface for %s", title_string); + msg (M_CLIENT, "Commands:"); + msg (M_CLIENT, "auth-retry t : Auth failure retry mode (none,interact,nointeract)."); + msg (M_CLIENT, "echo [on|off] [N|all] : Like log, but only show messages in echo buffer."); + msg (M_CLIENT, "exit|quit : Close management session."); + msg (M_CLIENT, "help : Print this message."); + msg (M_CLIENT, "hold [on|off|release] : Set/show hold flag to on/off state, or"); + msg (M_CLIENT, " release current hold and start tunnel."); + msg (M_CLIENT, "kill cn : Kill the client instance(s) having common name cn."); + msg (M_CLIENT, "kill IP:port : Kill the client instance connecting from IP:port."); + msg (M_CLIENT, "log [on|off] [N|all] : Turn on/off realtime log display"); + msg (M_CLIENT, " + show last N lines or 'all' for entire history."); + msg (M_CLIENT, "mute [n] : Set log mute level to n, or show level if n is absent."); + msg (M_CLIENT, "net : (Windows only) Show network info and routing table."); + msg (M_CLIENT, "password type p : Enter password p for a queried OpenVPN password."); + msg (M_CLIENT, "signal s : Send signal s to daemon,"); + msg (M_CLIENT, " s = SIGHUP|SIGTERM|SIGUSR1|SIGUSR2."); + msg (M_CLIENT, "state [on|off] [N|all] : Like log, but show state history."); + msg (M_CLIENT, "status [n] : Show current daemon status info using format #n."); + msg (M_CLIENT, "test n : Produce n lines of output for testing/debugging."); + msg (M_CLIENT, "username type u : Enter username u for a queried OpenVPN username."); + msg (M_CLIENT, "verb [n] : Set log verbosity level to n, or show if n is absent."); + msg (M_CLIENT, "version : Show current version number."); + msg (M_CLIENT, "END"); +} + +static const char * +man_state_name (const int state) +{ + switch (state) + { + case OPENVPN_STATE_INITIAL: + return "INITIAL"; + case OPENVPN_STATE_CONNECTING: + return "CONNECTING"; + case OPENVPN_STATE_WAIT: + return "WAIT"; + case OPENVPN_STATE_AUTH: + return "AUTH"; + case OPENVPN_STATE_GET_CONFIG: + return "GET_CONFIG"; + case OPENVPN_STATE_ASSIGN_IP: + return "ASSIGN_IP"; + case OPENVPN_STATE_ADD_ROUTES: + return "ADD_ROUTES"; + case OPENVPN_STATE_CONNECTED: + return "CONNECTED"; + case OPENVPN_STATE_RECONNECTING: + return "RECONNECTING"; + case OPENVPN_STATE_EXITING: + return "EXITING"; + default: + return "?"; + } +} + +static void +man_welcome (struct management *man) +{ + msg (M_CLIENT, ">INFO:OpenVPN Management Interface Version %d -- type 'help' for more info", + MANAGEMENT_VERSION); + if (man->persist.special_state_msg) + msg (M_CLIENT, "%s", man->persist.special_state_msg); +} + +static inline bool +man_password_needed (struct management *man) +{ + return man->settings.up.defined && !man->connection.password_verified; +} + +static void +man_check_password (struct management *man, const char *line) +{ + if (man_password_needed (man)) + { + if (streq (line, man->settings.up.password)) + { + man->connection.password_verified = true; + msg (M_CLIENT, "SUCCESS: password is correct"); + man_welcome (man); + } + else + { + man->connection.password_verified = false; + msg (M_CLIENT, "ERROR: bad password"); + if (++man->connection.password_tries >= MANAGEMENT_N_PASSWORD_RETRIES) + { + msg (M_WARN, "MAN: client connection rejected after %d failed password attempts", + MANAGEMENT_N_PASSWORD_RETRIES); + man->connection.halt = true; + } + } + } +} + +static void +man_update_io_state (struct management *man) +{ + if (socket_defined (man->connection.sd_cli)) + { + if (output_list_defined (man->connection.out)) + { + man->connection.state = MS_CC_WAIT_WRITE; + } + else + { + man->connection.state = MS_CC_WAIT_READ; + } + } +} + +static void +man_output_list_push (struct management *man, const char *str) +{ + if (management_connected (man)) + { + if (str) + output_list_push (man->connection.out, (const unsigned char *) str); + man_update_io_state (man); + if (!man->persist.standalone_disabled) + man_output_standalone (man, NULL); + } +} + +static void +man_prompt (struct management *man) +{ + if (man_password_needed (man)) + man_output_list_push (man, "ENTER PASSWORD:"); +#if 0 /* should we use prompt? */ + else + man_output_list_push (man, PACKAGE_NAME ">"); +#endif +} + +static void +man_close_socket (struct management *man, const socket_descriptor_t sd) +{ +#ifndef WIN32 + /* + * Windows doesn't need this because the ne32 event is permanently + * enabled at struct management scope. + */ + if (man->persist.callback.delete_event) + (*man->persist.callback.delete_event) (man->persist.callback.arg, sd); +#endif + openvpn_close_socket (sd); +} + +static void +virtual_output_callback_func (void *arg, const unsigned int flags, const char *str) +{ + static int recursive_level = 0; /* GLOBAL */ + + if (!recursive_level) /* don't allow recursion */ + { + struct gc_arena gc = gc_new (); + struct management *man = (struct management *) arg; + struct log_entry e; + const char *out = NULL; + + ++recursive_level; + + CLEAR (e); + update_time (); + e.timestamp = now; + e.u.msg_flags = flags; + e.string = str; + + if (flags & M_FATAL) + man->persist.standalone_disabled = false; + + if (flags != M_CLIENT) + log_history_add (man->persist.log, &e); + + if (!man_password_needed (man)) + { + if (flags == M_CLIENT) + out = log_entry_print (&e, LOG_PRINT_CRLF, &gc); + else if (man->connection.log_realtime) + out = log_entry_print (&e, LOG_PRINT_INT_DATE + | LOG_PRINT_MSG_FLAGS + | LOG_PRINT_LOG_PREFIX + | LOG_PRINT_CRLF, &gc); + if (out) + man_output_list_push (man, out); + if (flags & M_FATAL) + { + out = log_entry_print (&e, LOG_FATAL_NOTIFY|LOG_PRINT_CRLF, &gc); + if (out) + { + man_output_list_push (man, out); + man_reset_client_socket (man, false); + } + } + } + + --recursive_level; + gc_free (&gc); + } +} + +static void +man_signal (struct management *man, const char *name) +{ + const int sig = parse_signal (name); + if (sig >= 0) + { + throw_signal (sig); + msg (M_CLIENT, "SUCCESS: signal %s thrown", signal_name (sig, true)); + } + else + { + msg (M_CLIENT, "ERROR: signal '%s' is not a known signal type", name); + } +} + +static void +man_status (struct management *man, const int version, struct status_output *so) +{ + if (man->persist.callback.status) + { + (*man->persist.callback.status) (man->persist.callback.arg, version, so); + } + else + { + msg (M_CLIENT, "ERROR: The 'status' command is not supported by the current daemon mode"); + } +} + +static void +man_kill (struct management *man, const char *victim) +{ + struct gc_arena gc = gc_new (); + + if (man->persist.callback.kill_by_cn && man->persist.callback.kill_by_addr) + { + struct buffer buf; + char p1[128]; + char p2[128]; + int n_killed; + + buf_set_read (&buf, (uint8_t*) victim, strlen (victim) + 1); + buf_parse (&buf, ':', p1, sizeof (p1)); + buf_parse (&buf, ':', p2, sizeof (p2)); + + if (strlen (p1) && strlen (p2)) + { + /* IP:port specified */ + bool status; + const in_addr_t addr = getaddr (GETADDR_HOST_ORDER|GETADDR_MSG_VIRT_OUT, p1, 0, &status, NULL); + if (status) + { + const int port = atoi (p2); + if (port > 0 && port < 65536) + { + n_killed = (*man->persist.callback.kill_by_addr) (man->persist.callback.arg, addr, port); + if (n_killed > 0) + { + msg (M_CLIENT, "SUCCESS: %d client(s) at address %s:%d killed", + n_killed, + print_in_addr_t (addr, 0, &gc), + port); + } + else + { + msg (M_CLIENT, "ERROR: client at address %s:%d not found", + print_in_addr_t (addr, 0, &gc), + port); + } + } + else + { + msg (M_CLIENT, "ERROR: port number is out of range: %s", p2); + } + } + else + { + msg (M_CLIENT, "ERROR: error parsing IP address: %s", p1); + } + } + else if (strlen (p1)) + { + /* common name specified */ + n_killed = (*man->persist.callback.kill_by_cn) (man->persist.callback.arg, p1); + if (n_killed > 0) + { + msg (M_CLIENT, "SUCCESS: common name '%s' found, %d client(s) killed", p1, n_killed); + } + else + { + msg (M_CLIENT, "ERROR: common name '%s' not found", p1); + } + } + else + { + msg (M_CLIENT, "ERROR: kill parse"); + } + } + else + { + msg (M_CLIENT, "ERROR: The 'kill' command is not supported by the current daemon mode"); + } + + gc_free (&gc); +} + +/* + * General-purpose history command handler + * for the log and echo commands. + */ +static void +man_history (struct management *man, + const char *parm, + const char *type, + struct log_history *log, + bool *realtime, + const unsigned int lep_flags) +{ + struct gc_arena gc = gc_new (); + int n = 0; + + if (streq (parm, "on")) + { + *realtime = true; + msg (M_CLIENT, "SUCCESS: real-time %s notification set to ON", type); + } + else if (streq (parm, "off")) + { + *realtime = false; + msg (M_CLIENT, "SUCCESS: real-time %s notification set to OFF", type); + } + else if (streq (parm, "all") || (n = atoi (parm)) > 0) + { + const int size = log_history_size (log); + const int start = (n ? n : size) - 1; + int i; + + for (i = start; i >= 0; --i) + { + const struct log_entry *e = log_history_ref (log, i); + if (e) + { + const char *out = log_entry_print (e, lep_flags, &gc); + virtual_output_callback_func (man, M_CLIENT, out); + } + } + msg (M_CLIENT, "END"); + } + else + { + msg (M_CLIENT, "ERROR: %s parameter must be 'on' or 'off' or some number n or 'all'", type); + } + + gc_free (&gc); +} + +static void +man_log (struct management *man, const char *parm) +{ + man_history (man, + parm, + "log", + man->persist.log, + &man->connection.log_realtime, + LOG_PRINT_INT_DATE|LOG_PRINT_MSG_FLAGS); +} + +static void +man_echo (struct management *man, const char *parm) +{ + man_history (man, + parm, + "echo", + man->persist.echo, + &man->connection.echo_realtime, + LOG_PRINT_INT_DATE); +} + +static void +man_state (struct management *man, const char *parm) +{ + man_history (man, + parm, + "state", + man->persist.state, + &man->connection.state_realtime, + LOG_PRINT_INT_DATE|LOG_PRINT_STATE|LOG_PRINT_LOCAL_IP); +} + +static void +man_up_finalize (struct management *man) +{ + switch (man->connection.up_query_mode) + { + case UP_QUERY_DISABLED: + man->connection.up_query.defined = false; + break; + case UP_QUERY_USER_PASS: + if (strlen (man->connection.up_query.username) && strlen (man->connection.up_query.password)) + man->connection.up_query.defined = true; + break; + case UP_QUERY_PASS: + if (strlen (man->connection.up_query.password)) + man->connection.up_query.defined = true; + break; + default: + ASSERT (0); + } +} + +static void +man_query_user_pass (struct management *man, + const char *type, + const char *string, + const bool needed, + const char *prompt, + char *dest, + int len) +{ + if (needed) + { + ASSERT (man->connection.up_query_type); + if (streq (man->connection.up_query_type, type)) + { + strncpynt (dest, string, len); + man_up_finalize (man); + msg (M_CLIENT, "SUCCESS: '%s' %s entered, but not yet verified", + type, + prompt); + } + else + msg (M_CLIENT, "ERROR: %s of type '%s' entered, but we need one of type '%s'", + prompt, + type, + man->connection.up_query_type); + } + else + { + msg (M_CLIENT, "ERROR: no %s is currently needed at this time", prompt); + } +} + +static void +man_query_username (struct management *man, const char *type, const char *string) +{ + const bool needed = (man->connection.up_query_mode == UP_QUERY_USER_PASS && man->connection.up_query_type); + man_query_user_pass (man, type, string, needed, "username", man->connection.up_query.username, USER_PASS_LEN); +} + +static void +man_query_password (struct management *man, const char *type, const char *string) +{ + const bool needed = ((man->connection.up_query_mode == UP_QUERY_USER_PASS + || man->connection.up_query_mode == UP_QUERY_PASS) + && man->connection.up_query_type); + man_query_user_pass (man, type, string, needed, "password", man->connection.up_query.password, USER_PASS_LEN); +} + +static void +man_net (struct management *man) +{ + if (man->persist.callback.show_net) + { + (*man->persist.callback.show_net) (man->persist.callback.arg, M_CLIENT); + } + else + { + msg (M_CLIENT, "ERROR: The 'net' command is not supported by the current daemon mode"); + } +} + +static void +man_hold (struct management *man, const char *cmd) +{ + if (cmd) + { + if (streq (cmd, "on")) + { + man->settings.hold = true; + msg (M_CLIENT, "SUCCESS: hold flag set to ON"); + } + else if (streq (cmd, "off")) + { + man->settings.hold = false; + msg (M_CLIENT, "SUCCESS: hold flag set to OFF"); + } + else if (streq (cmd, "release")) + { + man->persist.hold_release = true; + msg (M_CLIENT, "SUCCESS: hold release succeeded"); + } + else + { + msg (M_CLIENT, "ERROR: bad hold command parameter"); + } + } + else + msg (M_CLIENT, "SUCCESS: hold=%d", (int) man->settings.hold); +} + +#define MN_AT_LEAST (1<<0) + +static bool +man_need (struct management *man, const char **p, const int n, unsigned int flags) +{ + int i; + ASSERT (p[0]); + for (i = 1; i <= n; ++i) + { + if (!p[i]) + { + msg (M_CLIENT, "ERROR: the '%s' command requires %s%d parameter%s", + p[0], + (flags & MN_AT_LEAST) ? "at least " : "", + n, + n > 1 ? "s" : ""); + return false; + } + } + return true; +} + +static void +man_dispatch_command (struct management *man, struct status_output *so, const char **p, const int nparms) +{ + struct gc_arena gc = gc_new (); + + ASSERT (p[0]); + if (streq (p[0], "exit") || streq (p[0], "quit")) + { + man->connection.halt = true; + goto done; + } + else if (streq (p[0], "help")) + { + man_help (); + } + else if (streq (p[0], "version")) + { + msg (M_CLIENT, "OpenVPN Version: %s", title_string); + msg (M_CLIENT, "Management Version: %d", MANAGEMENT_VERSION); + msg (M_CLIENT, "END"); + } + else if (streq (p[0], "signal")) + { + if (man_need (man, p, 1, 0)) + man_signal (man, p[1]); + } + else if (streq (p[0], "status")) + { + int version = 0; + if (p[1]) + version = atoi (p[1]); + man_status (man, version, so); + } + else if (streq (p[0], "kill")) + { + if (man_need (man, p, 1, 0)) + man_kill (man, p[1]); + } + else if (streq (p[0], "verb")) + { + if (p[1]) + { + const int level = atoi(p[1]); + if (set_debug_level (level, 0)) + msg (M_CLIENT, "SUCCESS: verb level changed"); + else + msg (M_CLIENT, "ERROR: verb level is out of range"); + } + else + msg (M_CLIENT, "SUCCESS: verb=%d", get_debug_level ()); + } + else if (streq (p[0], "mute")) + { + if (p[1]) + { + const int level = atoi(p[1]); + if (set_mute_cutoff (level)) + msg (M_CLIENT, "SUCCESS: mute level changed"); + else + msg (M_CLIENT, "ERROR: mute level is out of range"); + } + else + msg (M_CLIENT, "SUCCESS: mute=%d", get_mute_cutoff ()); + } + else if (streq (p[0], "auth-retry")) + { +#if P2MP + if (p[1]) + { + if (auth_retry_set (M_CLIENT, p[1])) + msg (M_CLIENT, "SUCCESS: auth-retry parameter changed"); + else + msg (M_CLIENT, "ERROR: bad auth-retry parameter"); + } + else + msg (M_CLIENT, "SUCCESS: auth-retry=%s", auth_retry_print ()); +#else + msg (M_CLIENT, "ERROR: auth-retry feature is unavailable"); +#endif + } + else if (streq (p[0], "state")) + { + if (!p[1]) + { + man_state (man, "1"); + } + else + { + if (p[1]) + man_state (man, p[1]); + if (p[2]) + man_state (man, p[2]); + } + } + else if (streq (p[0], "log")) + { + if (man_need (man, p, 1, MN_AT_LEAST)) + { + if (p[1]) + man_log (man, p[1]); + if (p[2]) + man_log (man, p[2]); + } + } + else if (streq (p[0], "echo")) + { + if (man_need (man, p, 1, MN_AT_LEAST)) + { + if (p[1]) + man_echo (man, p[1]); + if (p[2]) + man_echo (man, p[2]); + } + } + else if (streq (p[0], "username")) + { + if (man_need (man, p, 2, 0)) + man_query_username (man, p[1], p[2]); + } + else if (streq (p[0], "password")) + { + if (man_need (man, p, 2, 0)) + man_query_password (man, p[1], p[2]); + } + else if (streq (p[0], "net")) + { + man_net (man); + } + else if (streq (p[0], "hold")) + { + man_hold (man, p[1]); + } +#if 1 + else if (streq (p[0], "test")) + { + if (man_need (man, p, 1, 0)) + { + int i; + const int n = atoi (p[1]); + for (i = 0; i < n; ++i) + { + msg (M_CLIENT, "[%d] The purpose of this command is to generate large amounts of output.", i); + } + } + } +#endif + else + { + msg (M_CLIENT, "ERROR: unknown command, enter 'help' for more options"); + } + + done: + gc_free (&gc); +} + +#ifdef WIN32 + +static void +man_start_ne32 (struct management *man) +{ + switch (man->connection.state) + { + case MS_LISTEN: + net_event_win32_start (&man->connection.ne32, FD_ACCEPT, man->connection.sd_top); + break; + case MS_CC_WAIT_READ: + case MS_CC_WAIT_WRITE: + net_event_win32_start (&man->connection.ne32, FD_READ|FD_WRITE|FD_CLOSE, man->connection.sd_cli); + break; + default: + ASSERT (0); + } +} + +static void +man_stop_ne32 (struct management *man) +{ + net_event_win32_stop (&man->connection.ne32); +} + +#endif + +static void +man_accept (struct management *man) +{ + struct gc_arena gc = gc_new (); + + /* + * Accept the TCP client. + */ + man->connection.sd_cli = socket_do_accept (man->connection.sd_top, &man->connection.remote, false); + if (socket_defined (man->connection.sd_cli)) + { + if (socket_defined (man->connection.sd_top)) + { +#ifdef WIN32 + man_stop_ne32 (man); +#endif + } + + /* + * Set misc socket properties + */ + set_nonblock (man->connection.sd_cli); + set_cloexec (man->connection.sd_cli); + + man->connection.state_realtime = false; + man->connection.log_realtime = false; + man->connection.echo_realtime = false; + man->connection.password_verified = false; + man->connection.password_tries = 0; + man->connection.halt = false; + man->connection.state = MS_CC_WAIT_WRITE; + +#ifdef WIN32 + man_start_ne32 (man); +#endif + + msg (D_MANAGEMENT, "MANAGEMENT: Client connected from %s", + print_sockaddr (&man->settings.local, &gc)); + + output_list_reset (man->connection.out); + + if (!man_password_needed (man)) + man_welcome (man); + man_prompt (man); + man_update_io_state (man); + } + + gc_free (&gc); +} + +static void +man_listen (struct management *man) +{ + struct gc_arena gc = gc_new (); + + /* + * Initialize state + */ + man->connection.state = MS_LISTEN; + man->connection.sd_cli = SOCKET_UNDEFINED; + + /* + * Initialize listening socket + */ + if (man->connection.sd_top == SOCKET_UNDEFINED) + { + man->connection.sd_top = create_socket_tcp (); + + /* + * Bind socket + */ + if (bind (man->connection.sd_top, (struct sockaddr *) &man->settings.local, sizeof (man->settings.local))) + msg (M_SOCKERR, "MANAGEMENT: Cannot bind TCP socket on %s", + print_sockaddr (&man->settings.local, &gc)); + + /* + * Listen for connection + */ + if (listen (man->connection.sd_top, 1)) + msg (M_SOCKERR, "MANAGEMENT: listen() failed"); + + /* + * Set misc socket properties + */ + set_nonblock (man->connection.sd_top); + set_cloexec (man->connection.sd_top); + + msg (D_MANAGEMENT, "MANAGEMENT: TCP Socket listening on %s", + print_sockaddr (&man->settings.local, &gc)); + } + +#ifdef WIN32 + man_start_ne32 (man); +#endif + + gc_free (&gc); +} + +static void +man_reset_client_socket (struct management *man, const bool listen) +{ + if (socket_defined (man->connection.sd_cli)) + { + msg (D_MANAGEMENT, "MANAGEMENT: Client disconnected"); +#ifdef WIN32 + man_stop_ne32 (man); +#endif + man_close_socket (man, man->connection.sd_cli); + command_line_reset (man->connection.in); + output_list_reset (man->connection.out); + } + if (listen) + man_listen (man); +} + +static void +man_process_command (struct management *man, const char *line) +{ + struct gc_arena gc = gc_new (); + struct status_output *so; + int nparms; + char *parms[MAX_PARMS+1]; + + CLEAR (parms); + so = status_open (NULL, 0, -1, &man->persist.vout, 0); + + if (man_password_needed (man)) + { + man_check_password (man, line); + } + else + { + nparms = parse_line (line, parms, MAX_PARMS, "TCP", 0, M_CLIENT, &gc); + if (parms[0] && streq (parms[0], "password")) + msg (D_MANAGEMENT_DEBUG, "MANAGEMENT: CMD 'password [...]'"); + else + msg (D_MANAGEMENT_DEBUG, "MANAGEMENT: CMD '%s'", line); + +#if 0 + /* DEBUGGING -- print args */ + { + int i; + for (i = 0; i < nparms; ++i) + msg (M_INFO, "[%d] '%s'", i, parms[i]); + } +#endif + + if (nparms > 0) + man_dispatch_command (man, so, (const char **)parms, nparms); + } + + CLEAR (parms); + status_close (so); + gc_free (&gc); +} + +static bool +man_io_error (struct management *man, const char *prefix) +{ + const int err = openvpn_errno_socket (); + + if (!ignore_sys_error (err)) + { + struct gc_arena gc = gc_new (); + msg (D_MANAGEMENT, "MANAGEMENT: TCP %s error: %s", + prefix, + strerror_ts (err, &gc)); + gc_free (&gc); + return true; + } + else + return false; +} + +static int +man_read (struct management *man) +{ + /* + * read command line from socket + */ + unsigned char buf[256]; + int len = 0; + + len = recv (man->connection.sd_cli, buf, sizeof (buf), MSG_NOSIGNAL); + if (len == 0) + { + man_reset_client_socket (man, true); + } + else if (len > 0) + { + bool processed_command = false; + + ASSERT (len <= (int) sizeof (buf)); + command_line_add (man->connection.in, buf, len); + + /* + * Reset output object + */ + output_list_reset (man->connection.out); + + /* + * process command line if complete + */ + { + const unsigned char *line; + while ((line = command_line_get (man->connection.in))) + { + man_process_command (man, (char *) line); + if (man->connection.halt) + break; + command_line_next (man->connection.in); + processed_command = true; + } + } + + /* + * Reset output state to MS_CC_WAIT_(READ|WRITE) + */ + if (man->connection.halt) + { + man_reset_client_socket (man, true); + len = 0; + } + else + { + if (processed_command) + man_prompt (man); + man_update_io_state (man); + } + } + else /* len < 0 */ + { + if (man_io_error (man, "recv")) + man_reset_client_socket (man, true); + } + return len; +} + +static int +man_write (struct management *man) +{ + const int max_send = 256; + int sent = 0; + + const struct buffer *buf = output_list_peek (man->connection.out); + if (buf && BLEN (buf)) + { + const int len = min_int (max_send, BLEN (buf)); + sent = send (man->connection.sd_cli, BPTR (buf), len, MSG_NOSIGNAL); + if (sent >= 0) + { + output_list_advance (man->connection.out, sent); + } + else if (sent < 0) + { + if (man_io_error (man, "send")) + man_reset_client_socket (man, true); + } + } + + /* + * Reset output state to MS_CC_WAIT_(READ|WRITE) + */ + man_update_io_state (man); + + return sent; +} + +static void +man_connection_clear (struct man_connection *mc) +{ + CLEAR (*mc); + + /* set initial state */ + mc->state = MS_INITIAL; + + /* clear socket descriptors */ + mc->sd_top = SOCKET_UNDEFINED; + mc->sd_cli = SOCKET_UNDEFINED; +} + +static void +man_persist_init (struct management *man, + const int log_history_cache, + const int echo_buffer_size, + const int state_buffer_size) +{ + struct man_persist *mp = &man->persist; + if (!mp->defined) + { + CLEAR (*mp); + + /* initialize log history store */ + mp->log = log_history_init (log_history_cache); + + /* + * Initialize virtual output object, so that functions + * which write to a virtual_output object can be redirected + * here to the management object. + */ + mp->vout.func = virtual_output_callback_func; + mp->vout.arg = man; + mp->vout.flags_default = M_CLIENT; + msg_set_virtual_output (&mp->vout); + + /* + * Initialize --echo list + */ + man->persist.echo = log_history_init (echo_buffer_size); + + /* + * Initialize --state list + */ + man->persist.state = log_history_init (state_buffer_size); + + mp->defined = true; + } +} + +static void +man_persist_close (struct man_persist *mp) +{ + if (mp->log) + { + msg_set_virtual_output (NULL); + log_history_close (mp->log); + } + + if (mp->echo) + log_history_close (mp->echo); + + if (mp->state) + log_history_close (mp->state); + + CLEAR (*mp); +} + +static void +man_settings_init (struct man_settings *ms, + const char *addr, + const int port, + const char *pass_file, + const bool server, + const bool query_passwords, + const int log_history_cache, + const int echo_buffer_size, + const int state_buffer_size, + const bool hold) +{ + if (!ms->defined) + { + CLEAR (*ms); + + /* + * Are we a server? If so, it will influence + * the way we handle state transitions. + */ + ms->server = server; + + /* + * Get username/password + */ + if (pass_file) + get_user_pass (&ms->up, pass_file, true, "Management", 0); + + /* + * Should OpenVPN query the management layer for + * passwords? + */ + ms->up_query_passwords = query_passwords; + + /* + * Should OpenVPN hibernate on startup? + */ + ms->hold = hold; + + /* + * Initialize socket address + */ + ms->local.sin_family = AF_INET; + ms->local.sin_addr.s_addr = 0; + ms->local.sin_port = htons (port); + + /* + * Run management over tunnel, or + * separate channel? + */ + if (streq (addr, "tunnel")) + { + ms->management_over_tunnel = true; + } + else + { + ms->local.sin_addr.s_addr = getaddr + (GETADDR_RESOLVE|GETADDR_WARN_ON_SIGNAL|GETADDR_FATAL, addr, 0, NULL, NULL); + } + + /* + * Log history and echo buffer may need to be resized + */ + ms->log_history_cache = log_history_cache; + ms->echo_buffer_size = echo_buffer_size; + ms->state_buffer_size = state_buffer_size; + + ms->defined = true; + } +} + +static void +man_settings_close (struct man_settings *ms) +{ + CLEAR (*ms); +} + + +static void +man_connection_init (struct management *man) +{ + if (man->connection.state == MS_INITIAL) + { +#ifdef WIN32 + /* + * This object is a sort of TCP/IP helper + * for Windows. + */ + net_event_win32_init (&man->connection.ne32); +#endif + + /* + * Allocate helper objects for command line input and + * command output from/to the socket. + */ + man->connection.in = command_line_new (256); + man->connection.out = output_list_new (0); + + /* + * Initialize event set for standalone usage, when we are + * running outside of the primary event loop. + */ + { + int maxevents = 1; + man->connection.es = event_set_init (&maxevents, EVENT_METHOD_FAST); + } + + /* + * Listen on socket + */ + man_listen (man); + } +} + +static void +man_connection_close (struct management *man) +{ + struct man_connection *mc = &man->connection; + + if (mc->es) + event_free (mc->es); +#ifdef WIN32 + net_event_win32_close (&mc->ne32); +#endif + if (socket_defined (mc->sd_top)) + man_close_socket (man, mc->sd_top); + if (socket_defined (mc->sd_cli)) + man_close_socket (man, mc->sd_cli); + if (mc->in) + command_line_free (mc->in); + if (mc->out) + output_list_free (mc->out); + man_connection_clear (mc); +} + +struct management * +management_init (void) +{ + struct management *man; + ALLOC_OBJ_CLEAR (man, struct management); + + man_persist_init (man, + MANAGEMENT_LOG_HISTORY_INITIAL_SIZE, + MANAGEMENT_ECHO_BUFFER_SIZE, + MANAGEMENT_STATE_BUFFER_SIZE); + + man_connection_clear (&man->connection); + + return man; +} + +bool +management_open (struct management *man, + const char *addr, + const int port, + const char *pass_file, + const bool server, + const bool query_passwords, + const int log_history_cache, + const int echo_buffer_size, + const int state_buffer_size, + const bool hold) +{ + bool ret = false; + + /* + * Save the settings only if they have not + * been saved before. + */ + man_settings_init (&man->settings, + addr, + port, + pass_file, + server, + query_passwords, + log_history_cache, + echo_buffer_size, + state_buffer_size, + hold); + + /* + * The log is initially sized to MANAGEMENT_LOG_HISTORY_INITIAL_SIZE, + * but may be changed here. Ditto for echo and state buffers. + */ + log_history_resize (man->persist.log, man->settings.log_history_cache); + log_history_resize (man->persist.echo, man->settings.echo_buffer_size); + log_history_resize (man->persist.state, man->settings.state_buffer_size); + + /* + * If connection object is uninitialized and we are not doing + * over-the-tunnel management, then open (listening) connection. + */ + if (man->connection.state == MS_INITIAL) + { + if (!man->settings.management_over_tunnel) + { + man_connection_init (man); + ret = true; + } + } + + return ret; +} + +void +management_close (struct management *man) +{ + man_connection_close (man); + man_settings_close (&man->settings); + man_persist_close (&man->persist); + free (man); +} + +void +management_set_callback (struct management *man, + const struct management_callback *cb) +{ + man->persist.standalone_disabled = true; + man->persist.callback = *cb; +} + +void +management_clear_callback (struct management *man) +{ + man->persist.standalone_disabled = false; + man->persist.hold_release = false; + CLEAR (man->persist.callback); + man_output_list_push (man, NULL); /* flush output queue */ +} + +void +management_set_state (struct management *man, + const int state, + const char *detail, + const in_addr_t tun_local_ip) +{ + if (man->persist.state && (!man->settings.server || state < OPENVPN_STATE_CLIENT_BASE)) + { + struct gc_arena gc = gc_new (); + struct log_entry e; + const char *out = NULL; + + update_time (); + CLEAR (e); + e.timestamp = now; + e.u.state = state; + e.string = detail; + e.local_ip = tun_local_ip; + + log_history_add (man->persist.state, &e); + + if (man->connection.state_realtime) + out = log_entry_print (&e, LOG_PRINT_STATE_PREFIX + | LOG_PRINT_INT_DATE + | LOG_PRINT_STATE + | LOG_PRINT_LOCAL_IP + | LOG_PRINT_CRLF, &gc); + + if (out) + man_output_list_push (man, out); + + gc_free (&gc); + } +} + +void +management_echo (struct management *man, const char *string) +{ + if (man->persist.echo) + { + struct gc_arena gc = gc_new (); + struct log_entry e; + const char *out = NULL; + + update_time (); + CLEAR (e); + e.timestamp = now; + e.u.msg_flags = 0; + e.string = string; + + log_history_add (man->persist.echo, &e); + + if (man->connection.echo_realtime) + out = log_entry_print (&e, LOG_PRINT_INT_DATE|LOG_PRINT_ECHO_PREFIX|LOG_PRINT_CRLF, &gc); + + if (out) + man_output_list_push (man, out); + + gc_free (&gc); + } +} + +void +management_post_tunnel_open (struct management *man, const in_addr_t tun_local_ip) +{ + /* + * If we are running management over the tunnel, + * this is the place to initialize the connection. + */ + if (man->settings.management_over_tunnel + && man->connection.state == MS_INITIAL) + { + /* listen on our local TUN/TAP IP address */ + man->settings.local.sin_addr.s_addr = htonl (tun_local_ip); + man_connection_init (man); + } + +} + +void +management_pre_tunnel_close (struct management *man) +{ + if (man->settings.management_over_tunnel) + man_connection_close (man); +} + +void +management_auth_failure (struct management *man, const char *type) +{ + msg (M_CLIENT, ">PASSWORD:Verification Failed: '%s'", type); +} + +static inline bool +man_persist_state (unsigned int *persistent, const int n) +{ + if (persistent) + { + if (*persistent == (unsigned int)n) + return false; + *persistent = n; + } + return true; +} + +#ifdef WIN32 + +void +management_socket_set (struct management *man, + struct event_set *es, + void *arg, + unsigned int *persistent) +{ + if (man->connection.state != MS_INITIAL) + { + event_t ev = net_event_win32_get_event (&man->connection.ne32); + net_event_win32_reset_write (&man->connection.ne32); + + switch (man->connection.state) + { + case MS_LISTEN: + if (man_persist_state (persistent, 1)) + event_ctl (es, ev, EVENT_READ, arg); + break; + case MS_CC_WAIT_READ: + if (man_persist_state (persistent, 2)) + event_ctl (es, ev, EVENT_READ, arg); + break; + case MS_CC_WAIT_WRITE: + if (man_persist_state (persistent, 3)) + event_ctl (es, ev, EVENT_READ|EVENT_WRITE, arg); + break; + default: + ASSERT (0); + } + } +} + +void +management_io (struct management *man) +{ + if (man->connection.state != MS_INITIAL) + { + long net_events; + net_event_win32_reset (&man->connection.ne32); + net_events = net_event_win32_get_event_mask (&man->connection.ne32); + + if (net_events & FD_CLOSE) + { + man_reset_client_socket (man, true); + } + else + { + if (man->connection.state == MS_LISTEN) + { + if (net_events & FD_ACCEPT) + { + man_accept (man); + net_event_win32_clear_selected_events (&man->connection.ne32, FD_ACCEPT); + } + } + else if (man->connection.state == MS_CC_WAIT_READ) + { + if (net_events & FD_READ) + { + man_read (man); + net_event_win32_clear_selected_events (&man->connection.ne32, FD_READ); + } + } + + if (man->connection.state == MS_CC_WAIT_WRITE) + { + if (net_events & FD_WRITE) + { + int status; + /* dmsg (M_INFO, "FD_WRITE set"); */ + status = man_write (man); + if (status < 0 && WSAGetLastError() == WSAEWOULDBLOCK) + { + /* dmsg (M_INFO, "FD_WRITE cleared"); */ + net_event_win32_clear_selected_events (&man->connection.ne32, FD_WRITE); + } + } + } + } + } +} + +#else + +void +management_socket_set (struct management *man, + struct event_set *es, + void *arg, + unsigned int *persistent) +{ + switch (man->connection.state) + { + case MS_LISTEN: + if (man_persist_state (persistent, 1)) + event_ctl (es, man->connection.sd_top, EVENT_READ, arg); + break; + case MS_CC_WAIT_READ: + if (man_persist_state (persistent, 2)) + event_ctl (es, man->connection.sd_cli, EVENT_READ, arg); + break; + case MS_CC_WAIT_WRITE: + if (man_persist_state (persistent, 3)) + event_ctl (es, man->connection.sd_cli, EVENT_WRITE, arg); + break; + case MS_INITIAL: + break; + default: + ASSERT (0); + } +} + +void +management_io (struct management *man) +{ + switch (man->connection.state) + { + case MS_LISTEN: + man_accept (man); + break; + case MS_CC_WAIT_READ: + man_read (man); + break; + case MS_CC_WAIT_WRITE: + man_write (man); + break; + case MS_INITIAL: + break; + default: + ASSERT (0); + } +} + +#endif + +inline bool +man_standalone_ok (const struct management *man) +{ + return !man->settings.management_over_tunnel && man->connection.state != MS_INITIAL; +} + +/* + * Wait for socket I/O when outside primary event loop + */ +static int +man_block (struct management *man, volatile int *signal_received, const time_t expire) +{ + struct timeval tv; + struct event_set_return esr; + int status = -1; + + if (man_standalone_ok (man)) + { + do + { + event_reset (man->connection.es); + management_socket_set (man, man->connection.es, NULL, NULL); + tv.tv_usec = 0; + tv.tv_sec = 1; + status = event_wait (man->connection.es, &tv, &esr, 1); + update_time (); + if (signal_received) + { + get_signal (signal_received); + if (*signal_received) + { + status = -1; + break; + } + } + /* set SIGINT signal if expiration time exceeded */ + if (expire && now >= expire) + { + status = 0; + if (signal_received) + *signal_received = SIGINT; + break; + } + } while (status != 1); + } + return status; +} + +/* + * Perform management socket output outside primary event loop + */ +static void +man_output_standalone (struct management *man, volatile int *signal_received) +{ + if (man_standalone_ok (man)) + { + while (man->connection.state == MS_CC_WAIT_WRITE) + { + management_io (man); + if (man->connection.state == MS_CC_WAIT_WRITE) + man_block (man, signal_received, 0); + if (signal_received && *signal_received) + break; + } + } +} + +/* + * Process management event loop outside primary event loop + */ +static int +man_standalone_event_loop (struct management *man, volatile int *signal_received, const time_t expire) +{ + int status; + ASSERT (man_standalone_ok (man)); + status = man_block (man, signal_received, expire); + if (status > 0) + management_io (man); + return status; +} + +#define MWCC_PASSWORD_WAIT (1<<0) +#define MWCC_HOLD_WAIT (1<<1) + +/* + * Block until client connects + */ +static void +man_wait_for_client_connection (struct management *man, + volatile int *signal_received, + const time_t expire, + unsigned int flags) +{ + ASSERT (man_standalone_ok (man)); + if (man->connection.state == MS_LISTEN) + { + if (flags & MWCC_PASSWORD_WAIT) + msg (D_MANAGEMENT, "Need password(s) from management interface, waiting..."); + if (flags & MWCC_HOLD_WAIT) + msg (D_MANAGEMENT, "Need hold release from management interface, waiting..."); + do { + man_standalone_event_loop (man, signal_received, expire); + if (signal_received && *signal_received) + break; + } while (man->connection.state == MS_LISTEN || man_password_needed (man)); + } +} + +/* + * Process the management event loop for sec seconds + */ +void +management_event_loop_n_seconds (struct management *man, int sec) +{ + if (man_standalone_ok (man)) + { + volatile int signal_received = 0; + const bool standalone_disabled_save = man->persist.standalone_disabled; + time_t expire; + + man->persist.standalone_disabled = false; /* This is so M_CLIENT messages will be correctly passed through msg() */ + + /* set expire time */ + update_time (); + expire = now + sec; + + /* if no client connection, wait for one */ + man_wait_for_client_connection (man, &signal_received, expire, 0); + if (signal_received) + return; + + /* run command processing event loop until we get our username/password */ + while (true) + { + man_standalone_event_loop (man, &signal_received, expire); + if (signal_received) + return; + } + + /* revert state */ + man->persist.standalone_disabled = standalone_disabled_save; + } + else + { + sleep (sec); + } +} + +/* + * Get a username/password from management channel in standalone mode. + */ +bool +management_query_user_pass (struct management *man, + struct user_pass *up, + const char *type, + const bool password_only) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + + if (man_standalone_ok (man)) + { + volatile int signal_received = 0; + const bool standalone_disabled_save = man->persist.standalone_disabled; + struct buffer alert_msg = alloc_buf_gc (128, &gc); + + ret = true; + man->persist.standalone_disabled = false; /* This is so M_CLIENT messages will be correctly passed through msg() */ + man->persist.special_state_msg = NULL; + + CLEAR (man->connection.up_query); + + buf_printf (&alert_msg, ">PASSWORD:Need '%s' %s", + type, + password_only ? "password" : "username/password"); + + man_wait_for_client_connection (man, &signal_received, 0, MWCC_PASSWORD_WAIT); + if (signal_received) + ret = false; + + if (ret) + { + man->persist.special_state_msg = BSTR (&alert_msg); + msg (M_CLIENT, "%s", man->persist.special_state_msg); + + /* tell command line parser which info we need */ + man->connection.up_query_mode = password_only ? UP_QUERY_PASS : UP_QUERY_USER_PASS; + man->connection.up_query_type = type; + + /* run command processing event loop until we get our username/password */ + do + { + man_standalone_event_loop (man, &signal_received, 0); + if (signal_received) + { + ret = false; + break; + } + } while (!man->connection.up_query.defined); + } + + /* revert state */ + man->connection.up_query_mode = UP_QUERY_DISABLED; + man->connection.up_query_type = NULL; + man->persist.standalone_disabled = standalone_disabled_save; + man->persist.special_state_msg = NULL; + + /* + * Transfer u/p to return object, zero any record + * we hold in the management object. + */ + if (ret) + { + man->connection.up_query.nocache = up->nocache; /* preserve caller's nocache setting */ + *up = man->connection.up_query; + } + CLEAR (man->connection.up_query); + } + + gc_free (&gc); + return ret; +} + +/* + * Return true if management_hold() would block + */ +bool +management_would_hold (struct management *man) +{ + return man->settings.hold && !man->persist.hold_release && man_standalone_ok (man); +} + +/* + * If the hold flag is enabled, hibernate until a management client releases the hold. + * Return true if the caller should not sleep for an additional time interval. + */ +bool +management_hold (struct management *man) +{ + if (management_would_hold (man)) + { + volatile int signal_received = 0; + const bool standalone_disabled_save = man->persist.standalone_disabled; + + man->persist.standalone_disabled = false; /* This is so M_CLIENT messages will be correctly passed through msg() */ + man->persist.special_state_msg = NULL; + + man_wait_for_client_connection (man, &signal_received, 0, MWCC_HOLD_WAIT); + + if (!signal_received) + { + man->persist.special_state_msg = ">HOLD:Waiting for hold release"; + msg (M_CLIENT, "%s", man->persist.special_state_msg); + + /* run command processing event loop until we get our username/password */ + do + { + man_standalone_event_loop (man, &signal_received, 0); + if (signal_received) + break; + } while (!man->persist.hold_release); + } + + /* revert state */ + man->persist.standalone_disabled = standalone_disabled_save; + man->persist.special_state_msg = NULL; + + return true; + } + return false; +} + +/* + * struct command_line + */ + +struct command_line * +command_line_new (const int buf_len) +{ + struct command_line *cl; + ALLOC_OBJ_CLEAR (cl, struct command_line); + cl->buf = alloc_buf (buf_len); + cl->residual = alloc_buf (buf_len); + return cl; +} + +void +command_line_reset (struct command_line *cl) +{ + buf_clear (&cl->buf); + buf_clear (&cl->residual); +} + +void +command_line_free (struct command_line *cl) +{ + command_line_reset (cl); + free_buf (&cl->buf); + free_buf (&cl->residual); + free (cl); +} + +void +command_line_add (struct command_line *cl, const unsigned char *buf, const int len) +{ + int i; + for (i = 0; i < len; ++i) + { + if (buf[i] && (isprint(buf[i]) || buf[i] == '\n')) + { + if (!buf_write_u8 (&cl->buf, buf[i])) + buf_clear (&cl->buf); + } + } +} + +const unsigned char * +command_line_get (struct command_line *cl) +{ + int i; + const unsigned char *ret = NULL; + + i = buf_substring_len (&cl->buf, '\n'); + if (i >= 0) + { + buf_copy_excess (&cl->residual, &cl->buf, i); + buf_chomp (&cl->buf); + ret = (const unsigned char *) BSTR (&cl->buf); + } + return ret; +} + +void +command_line_next (struct command_line *cl) +{ + buf_clear (&cl->buf); + buf_copy (&cl->buf, &cl->residual); + buf_clear (&cl->residual); +} + +/* + * struct output_list + */ + +struct output_list * +output_list_new (const int max_size) +{ + struct output_list *ret; + ALLOC_OBJ_CLEAR (ret, struct output_list); + ret->max_size = max_size; + ret->size = 0; + return ret; +} + +void +output_list_free (struct output_list *ol) +{ + output_list_reset (ol); + free (ol); +} + +bool +output_list_defined (const struct output_list *ol) +{ + return ol->head != NULL; +} + +void +output_list_reset (struct output_list *ol) +{ + struct output_entry *e = ol->head; + while (e) + { + struct output_entry *next = e->next; + free_buf (&e->buf); + free (e); + e = next; + } + ol->head = ol->tail = NULL; + ol->size = 0; +} + +void +output_list_push (struct output_list *ol, const unsigned char *str) +{ + if (!ol->max_size || ol->size < ol->max_size) + { + struct output_entry *e; + ALLOC_OBJ_CLEAR (e, struct output_entry); + + ++ol->size; + if (ol->tail) + { + ASSERT (ol->head); + ol->tail->next = e; + } + else + { + ASSERT (!ol->head); + ol->head = e; + } + e->buf = string_alloc_buf ((const char *) str, NULL); + ol->tail = e; + } +} + +const struct buffer * +output_list_peek (struct output_list *ol) +{ + if (ol->head) + return &ol->head->buf; + else + return NULL; +} + +static void +output_list_pop (struct output_list *ol) +{ + if (ol->head) + { + struct output_entry *e = ol->head->next; + free_buf (&ol->head->buf); + free (ol->head); + ol->head = e; + --ol->size; + if (!e) + ol->tail = NULL; + } +} + +void +output_list_advance (struct output_list *ol, int n) +{ + if (ol->head) + { + struct buffer *buf = &ol->head->buf; + ASSERT (buf_advance (buf, n)); + if (!BLEN (buf)) + output_list_pop (ol); + } +} + +/* + * struct log_entry + */ + +const char * +log_entry_print (const struct log_entry *e, unsigned int flags, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (ERR_BUF_SIZE, gc); + if (flags & LOG_FATAL_NOTIFY) + buf_printf (&out, ">FATAL:"); + if (flags & LOG_PRINT_LOG_PREFIX) + buf_printf (&out, ">LOG:"); + if (flags & LOG_PRINT_ECHO_PREFIX) + buf_printf (&out, ">ECHO:"); + if (flags & LOG_PRINT_STATE_PREFIX) + buf_printf (&out, ">STATE:"); + if (flags & LOG_PRINT_INT_DATE) + buf_printf (&out, "%u,", (unsigned int)e->timestamp); + if (flags & LOG_PRINT_MSG_FLAGS) + buf_printf (&out, "%s,", msg_flags_string (e->u.msg_flags, gc)); + if (flags & LOG_PRINT_STATE) + buf_printf (&out, "%s,", man_state_name (e->u.state)); + if (e->string) + buf_printf (&out, "%s", e->string); + if (flags & LOG_PRINT_LOCAL_IP) + buf_printf (&out, ",%s", print_in_addr_t (e->local_ip, IA_EMPTY_IF_UNDEF, gc)); + if (flags & LOG_PRINT_CRLF) + buf_printf (&out, "\r\n"); + return BSTR (&out); +} + +static void +log_entry_free_contents (struct log_entry *e) +{ + if (e->string) + free ((char *)e->string); + CLEAR (*e); +} + +/* + * struct log_history + */ + +static inline int +log_index (const struct log_history *h, int i) +{ + return modulo_add (h->base, i, h->capacity); +} + +static void +log_history_obj_init (struct log_history *h, int capacity) +{ + CLEAR (*h); + h->capacity = capacity; + ALLOC_ARRAY_CLEAR (h->array, struct log_entry, capacity); +} + +struct log_history * +log_history_init (const int capacity) +{ + struct log_history *h; + ASSERT (capacity > 0); + ALLOC_OBJ (h, struct log_history); + log_history_obj_init (h, capacity); + return h; +} + +static void +log_history_free_contents (struct log_history *h) +{ + int i; + for (i = 0; i < h->size; ++i) + log_entry_free_contents (&h->array[log_index(h, i)]); + free (h->array); +} + +void +log_history_close (struct log_history *h) +{ + log_history_free_contents (h); + free (h); +} + +void +log_history_add (struct log_history *h, const struct log_entry *le) +{ + struct log_entry *e; + ASSERT (h->size >= 0 && h->size <= h->capacity); + if (h->size == h->capacity) + { + e = &h->array[h->base]; + log_entry_free_contents (e); + h->base = log_index (h, 1); + } + else + { + e = &h->array[log_index(h, h->size)]; + ++h->size; + } + + *e = *le; + e->string = string_alloc (le->string, NULL); +} + +void +log_history_resize (struct log_history *h, const int capacity) +{ + if (capacity != h->capacity) + { + struct log_history newlog; + int i; + + ASSERT (capacity > 0); + log_history_obj_init (&newlog, capacity); + + for (i = 0; i < h->size; ++i) + log_history_add (&newlog, &h->array[log_index(h, i)]); + + log_history_free_contents (h); + *h = newlog; + } +} + +const struct log_entry * +log_history_ref (const struct log_history *h, const int index) +{ + if (index >= 0 && index < h->size) + return &h->array[log_index(h, (h->size - 1) - index)]; + else + return NULL; +} + +#else +static void dummy(void) {} +#endif /* ENABLE_MANAGEMENT */ diff --git a/manage.h b/manage.h new file mode 100644 index 0000000..d2dfd04 --- /dev/null +++ b/manage.h @@ -0,0 +1,340 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MANAGE_H +#define MANAGE_H + +#ifdef ENABLE_MANAGEMENT + +#include "misc.h" +#include "event.h" +#include "socket.h" + +#define MANAGEMENT_VERSION 1 +#define MANAGEMENT_N_PASSWORD_RETRIES 3 +#define MANAGEMENT_LOG_HISTORY_INITIAL_SIZE 100 +#define MANAGEMENT_ECHO_BUFFER_SIZE 100 +#define MANAGEMENT_STATE_BUFFER_SIZE 100 + +/* + * Manage build-up of command line + */ +struct command_line +{ + struct buffer buf; + struct buffer residual; +}; + +struct command_line *command_line_new (const int buf_len); +void command_line_free (struct command_line *cl); + +void command_line_add (struct command_line *cl, const unsigned char *buf, const int len); +const unsigned char *command_line_get (struct command_line *cl); +void command_line_reset (struct command_line *cl); +void command_line_next (struct command_line *cl); + +/* + * Manage lists of output strings + */ + +struct output_entry +{ + struct buffer buf; + struct output_entry *next; +}; + +struct output_list +{ + struct output_entry *head; /* next item to pop/peek */ + struct output_entry *tail; /* last item pushed */ + int size; /* current number of entries */ + int max_size; /* maximum size list should grow to */ +}; + +struct output_list *output_list_new (const int max_size); +void output_list_free (struct output_list *ol); + +bool output_list_defined (const struct output_list *ol); +void output_list_reset (struct output_list *ol); + +void output_list_push (struct output_list *ol, const unsigned char *str); +const struct buffer *output_list_peek (struct output_list *ol); +void output_list_advance (struct output_list *ol, int n); + +/* + * Manage log file history + */ + +union log_entry_union { + unsigned int msg_flags; + int state; +}; + +struct log_entry +{ + time_t timestamp; + const char *string; + in_addr_t local_ip; + union log_entry_union u; +}; + +#define LOG_PRINT_LOG_PREFIX (1<<0) +#define LOG_PRINT_ECHO_PREFIX (1<<1) +#define LOG_PRINT_STATE_PREFIX (1<<2) + +#define LOG_PRINT_INT_DATE (1<<3) +#define LOG_PRINT_MSG_FLAGS (1<<4) +#define LOG_PRINT_STATE (1<<5) +#define LOG_PRINT_LOCAL_IP (1<<6) + +#define LOG_PRINT_CRLF (1<<7) +#define LOG_FATAL_NOTIFY (1<<8) + +const char *log_entry_print (const struct log_entry *e, unsigned int flags, struct gc_arena *gc); + +struct log_history +{ + int base; + int size; + int capacity; + struct log_entry *array; +}; + +struct log_history *log_history_init (const int capacity); +void log_history_close (struct log_history *h); +void log_history_add (struct log_history *h, const struct log_entry *le); +void log_history_resize (struct log_history *h, const int capacity); +const struct log_entry *log_history_ref (const struct log_history *h, const int index); + +static inline int +log_history_size (const struct log_history *h) +{ + return h->size; +} + +static inline int +log_history_capacity (const struct log_history *h) +{ + return h->capacity; +} + +/* + * Callbacks for 'status' and 'kill' commands + */ +struct management_callback +{ + void *arg; + void (*status) (void *arg, const int version, struct status_output *so); + void (*show_net) (void *arg, const int msglevel); + int (*kill_by_cn) (void *arg, const char *common_name); + int (*kill_by_addr) (void *arg, const in_addr_t addr, const int port); + void (*delete_event) (void *arg, event_t event); +}; + +/* + * Management object, split into three components: + * + * struct man_persist : Data elements which are persistent across + * man_connection open and close. + * + * struct man_settings : management parameters. + * + * struct man_connection : created on socket binding and listen, + * deleted on socket unbind, may + * handle multiple sequential client + * connections. + */ + +struct man_persist { + bool defined; + + struct log_history *log; + struct virtual_output vout; + + bool standalone_disabled; + struct management_callback callback; + + struct log_history *echo; /* saved --echo strings */ + struct log_history *state; + + bool hold_release; + + const char *special_state_msg; +}; + +struct man_settings { + bool defined; + struct sockaddr_in local; + bool up_query_passwords; + bool management_over_tunnel; + struct user_pass up; + int log_history_cache; + int echo_buffer_size; + int state_buffer_size; + bool server; + bool hold; +}; + +/* up_query modes */ +#define UP_QUERY_DISABLED 0 +#define UP_QUERY_USER_PASS 1 +#define UP_QUERY_PASS 2 + +/* states */ +#define MS_INITIAL 0 /* all sockets are closed */ +#define MS_LISTEN 1 /* no client is connected */ +#define MS_CC_WAIT_READ 2 /* client is connected, waiting for read on socket */ +#define MS_CC_WAIT_WRITE 3 /* client is connected, waiting for ability to write to socket */ + +struct man_connection { + int state; + + socket_descriptor_t sd_top; + socket_descriptor_t sd_cli; + struct sockaddr_in remote; + +#ifdef WIN32 + struct net_event_win32 ne32; +#endif + + bool halt; + bool password_verified; + int password_tries; + + struct command_line *in; + struct output_list *out; + + struct event_set *es; + + bool state_realtime; + bool log_realtime; + bool echo_realtime; + + const char *up_query_type; + int up_query_mode; + struct user_pass up_query; +}; + +struct management +{ + struct man_persist persist; + struct man_settings settings; + struct man_connection connection; +}; + +extern struct management *management; + +struct user_pass; + +struct management *management_init (void); + +bool management_open (struct management *man, + const char *addr, + const int port, + const char *pass_file, + const bool server, + const bool query_passwords, + const int log_history_cache, + const int echo_buffer_size, + const int state_buffer_size, + const bool hold); + + +void management_close (struct management *man); + +void management_post_tunnel_open (struct management *man, const in_addr_t tun_local_ip); + +void management_pre_tunnel_close (struct management *man); + +void management_socket_set (struct management *man, + struct event_set *es, + void *arg, + unsigned int *persistent); + +void management_io (struct management *man); + +void management_set_callback (struct management *man, + const struct management_callback *cb); + +void management_clear_callback (struct management *man); + +bool management_query_user_pass (struct management *man, struct user_pass *up, const char *type, const bool password_only); + +bool management_would_hold (struct management *man); +bool management_hold (struct management *man); + +void management_event_loop_n_seconds (struct management *man, int sec); + +static inline bool +management_connected (const struct management *man) +{ + return man->connection.state == MS_CC_WAIT_READ || man->connection.state == MS_CC_WAIT_WRITE; +} + +static inline bool +management_query_user_pass_enabled (const struct management *man) +{ + return man->settings.up_query_passwords; +} + +/* + * OpenVPN tells the management layer what state it's in + */ + +/* client/server states */ +#define OPENVPN_STATE_INITIAL 0 /* Initial, undefined state */ +#define OPENVPN_STATE_CONNECTING 1 /* Management interface has been initialized */ +#define OPENVPN_STATE_ASSIGN_IP 2 /* Assigning IP address to virtual network interface */ +#define OPENVPN_STATE_ADD_ROUTES 3 /* Adding routes to system */ +#define OPENVPN_STATE_CONNECTED 4 /* Initialization sequence completed */ +#define OPENVPN_STATE_RECONNECTING 5 /* Restart */ +#define OPENVPN_STATE_EXITING 6 /* Exit */ + +/* client-only states */ +#define OPENVPN_STATE_WAIT 7 /* Waiting for initial response from server */ +#define OPENVPN_STATE_AUTH 8 /* Authenticating with server */ +#define OPENVPN_STATE_GET_CONFIG 9 /* Downloading configuration from server */ + +#define OPENVPN_STATE_CLIENT_BASE 7 /* Base index of client-only states */ + +void management_set_state (struct management *man, + const int state, + const char *detail, + const in_addr_t tun_local_ip); + +/* + * The management object keeps track of OpenVPN --echo + * parameters. + */ +void management_echo (struct management *man, const char *string); + +/* + * OpenVPN calls here to indicate a password failure + */ + +void management_auth_failure (struct management *man, const char *type); + +#endif + +#endif diff --git a/management/management-notes.txt b/management/management-notes.txt new file mode 100644 index 0000000..06fc8c1 --- /dev/null +++ b/management/management-notes.txt @@ -0,0 +1,436 @@ +OpenVPN Management Interface Notes +---------------------------------- + +The OpenVPN Management interface allows OpenVPN to +be administratively controlled from an external program via +a TCP socket. + +The interface has been specifically designed for GUI developers +and those who would like to programmatically or remotely control +an OpenVPN daemon. + +The management interface is implemented using a client/server TCP +connection, where OpenVPN will listen on a provided IP address +and port for incoming management client connections. + +The management protocol is currently cleartext without an explicit +security layer. For this reason, it is recommended that the +management interface either listen on localhost (127.0.0.1) +or on the local VPN address. It's possible to remotely connect +to the management interface over the VPN itself, though some +capabilities will be limited in this mode, such as the ability +to provide private key passwords. + +Future versions of the management interface may allow out-of-band +connections (i.e. not over the VPN) and secured with SSL/TLS. + +The management interface is enabled in the OpenVPN +configuration file using the following directives: + +--management +--management-query-passwords +--management-log-cache + +See the man page for documentation on these directives. + +Once OpenVPN has started with the management layer enabled, +you can telnet to the management port (make sure to use +a telnet client which understands "raw" mode). + +Once connected to the management port, you can use +the "help" command to list all commands. + +COMMAND -- echo +--------------- + +The echo capability is used to allow GUI-specific +parameters to be either embedded in the OpenVPN config file +or pushed to an OpenVPN client from a server. + +Command examples: + + echo on -- turn on real-time notification of echo messages + echo all -- print the current echo history list + echo off -- turn off real-time notification of echo messages + echo on all -- atomically enable real-time notification, + plus show any messages in history buffer + +For example, suppose you are developing a OpenVPN GUI and +you want to give the OpenVPN server the ability to ask +the GUI to forget any saved passwords. + +In the OpenVPN server config file, add: + + push "echo forget-passwords" + +When the OpenVPN client receives its pulled list of directives +from the server, the "echo forget-passwords" directive will +be in the list, and it will cause the management interface +to save the "forget-passwords" string in its list of echo +parameters. + +The management client can use "echo all" to output the full +list of echoed parameters, "echo on" to turn on real-time +notification of echoed parameters via the ">ECHO:" prefix, +or "echo off" to turn off real-time notification. + +When the GUI connects to the OpenVPN management socket, it +can issue an "echo all" command, which would produce output +like this: + + 1101519562,forget-passwords + END + +Essentially the echo command allowed us to pass parameters from +the OpenVPN server to the OpenVPN client, and then to the +management client (such as a GUI). The large integer is the +unix date/time when the echo parameter was received. + +If the management client had issued the command "echo on", +it would have enabled real-time notifications of echo +parameters. In this case, our "forget-passwords" message +would be output like this: + + >ECHO:1101519562,forget-passwords + +Like the log command, the echo command can atomically show +history while simultaneously activating real-time updates: + + echo on all + +The size of the echo buffer is currently hardcoded to 100 +messages. + +COMMAND -- exit, quit +--------------------- + +Close the managment session, and resume listening on the +management port for connections from other clients. Currently, +the OpenVPN daemon can at most support a single management client +any one time. + +COMMAND -- help +--------------- + +Print a summary of commands. + +COMMAND -- hold +--------------- + +The hold command can be used to manipulate the hold flag, +or release OpenVPN from a hold state. + +If the hold flag is set on initial startup or +restart, OpenVPN will hibernate prior to initializing +the tunnel until the management interface receives +a "hold release" command. + +The --management-hold directive of OpenVPN can be used +to start OpenVPN with the hold flag set. + +The hold flag setting is persistent and will not +be reset by restarts. + +OpenVPN will indicate that it is in a hold state by +sending a real-time notification to the management +client: + + >HOLD:Waiting for hold release + +Command examples: + + hold -- show current hold flag, 0=off, 1=on. + hold on -- turn on hold flag so that future restarts + will hold. + hold off -- turn off hold flag so that future restarts will + not hold. + hold release -- leave hold state and start OpenVPN, but + do not alter the current hold flag setting. + +COMMAND -- kill +--------------- + +In server mode, kill a particlar client instance. + +Command examples: + + kill Test-Client -- kill the client instance having a + common name of "Test-Client". + kill 1.2.3.4:4000 -- kill the client instance having a + source address and port of 1.2.3.4:4000 + +Use the "status" command to see which clients are connected. + +COMMAND -- log +-------------- + +Show the OpenVPN log file. Only the most recent n lines +of the log file are cached by the management interface, where +n is controlled by the OpenVPN --management-log-cache directive. + +Command examples: + + log on -- Enable real-time output of log messages. + log all -- Show currently cached log file history. + log on all -- Atomically show all currently cached log file + history then enable real-time notification of + new log file messages. + log off -- Turn off real-time notification of log messages. + log 20 -- Show the most recent 20 lines of log file history. + +Real-time notification format: + +Real-time log messages begin with the ">LOG:" prefix followed +by the following comma-separated fields: + + (a) unix integer date/time, + (b) zero or more message flags in a single string: + I -- informational + F -- fatal error + N -- non-fatal error + W -- warning + D -- debug, and + (c) message text. + +COMMAND -- mute +--------------- + +Change the OpenVPN --mute parameter. The mute parameter is +used to silence repeating messages of the same message +category. + +Command examples: + + mute 40 -- change the mute parameter to 40 + mute -- show the current mute setting + +COMMAND -- net +-------------- + +(Windows Only) Produce output equivalent to the OpenVPN +--show-net directive. The output includes OpenVPN's view +of the system network adapter list and routing table based +on information returned by the Windows IP helper API. + +COMMAND -- password and username +-------------------------------- + + The password command is used to pass passwords to OpenVPN. + + If OpenVPN is run with the --management-query-passwords + directive, it will query the management interface for RSA + private key passwords and the --auth-user-pass + username/password. + + When OpenVPN needs a password from the management interface, + it will produce a real-time ">PASSWORD:" message. + + Example 1: + + >PASSWORD:Need 'Private Key' password + + OpenVPN is indicating that it needs a password of type + "Private Key". + + The management client should respond to this query as follows: + + password "Private Key" foo + + Example 2: + + >PASSWORD:Need 'Auth' username/password + + OpenVPN needs a --auth-user-pass password. The management + client should respond: + + username "Auth" foo + password "Auth" bar + + The username/password itself can be in quotes, and special + characters such as double quote or backslash must be escaped, + for example, + + password "Private Key" "foo\"bar" + + The escaping rules are the same as for the config file. + See the "Command Parsing" section below for more info. + + The PASSWORD real-time message type can also be used to + indicate password or other types of authentication failure: + + Example 3: The private key password is incorrect and OpenVPN + is exiting: + + >PASSWORD:Verification Failed: 'Private Key' + + Example 4: The --auth-user-pass username/password failed, + and OpenVPN is exiting: + + >PASSWORD:Verification Failed: 'Auth' + +COMMAND -- signal +----------------- + +The signal command will send a signal to the OpenVPN daemon. +The signal can be one of SIGHUP, SIGTERM, SIGUSR1, or SIGUSR2. + +Command example: + + signal SIGUSR1 -- send a SIGUSR1 signal to daemon + +COMMAND -- state +---------------- + +Show the current OpenVPN state, show state history, or +enable real-time notification of state changes. + +These are the OpenVPN states: + +CONNECTING -- OpenVPN's initial state. +WAIT -- (Client only) Waiting for initial response + from server. +AUTH -- (Client only) Authenticating with server. +GET_CONFIG -- (Client only) Downloading configuration options + from server. +ASSIGN_IP -- Assigning IP address to virtual network + interface. +ADD_ROUTES -- Adding routes to system. +CONNECTED -- Initialization Sequence Completed. +RECONNECTING -- A restart has occurred. +EXITING -- A graceful exit is in progress. + +Command examples: + + state -- Print current OpenVPN state. + state on -- Enable real-time notification of state changes. + state off -- Disable real-time notification of state changes. + state all -- Print current state history. + state 3 -- Print the 3 most recent state transitions. + state on all -- Atomically show state history while at the + same time enable real-time state notification + of future state transitions. + +The output format consists of 4 comma-separated parameters: + (a) the integer unix date/time, + (b) the state name, + (c) optional descriptive string (used mostly on RECONNECTING + and EXITING to show the reason for the disconnect), and + (d) optional TUN/TAP local IP address (shown for ASSIGN_IP + and CONNECTED). + +Real-time state notifications will have a ">STATE:" prefix +prepended to them. + +COMMAND -- status +----------------- + +Show current daemon status information, in the same format as +that produced by the OpenVPN --status directive. + +Command examples: + +status -- Show status information using the default status + format version. + +status 2 -- Show status information using status format version 2. + +COMMAND -- username +------------------- + +See the "password" section above. + +COMMAND -- verb +--------------- + +Change the OpenVPN --verb parameter. The verb parameter +controls the output verbosity, and may range from 0 (no output) +to 15 (maximum output). See the OpenVPN man page for additional +info on verbosity levels. + +Command examples: + + verb 4 -- change the verb parameter to 4 + mute -- show the current verb setting + +COMMAND -- version +------------------ + +Show the current OpenVPN and Management Interface versions. + + +COMMAND -- auth-retry +--------------------- + +Set the --auth-retry setting to control how OpenVPN responds to +username/password authentication errors. See the manual page +for more info. + +Command examples: + + auth-retry interact -- Don't exit when bad username/passwords are entered. + Query for new input and retry. + +OUTPUT FORMAT +------------- + +(1) Command success/failure indicated by "SUCCESS: [text]" or + "ERROR: [text]". + +(2) For commands which print multiple lines of output, + the last line will be "END". + +(3) Real-time messages will be in the form ">[source]:[text]", + where source is "ECHO", "FATAL", "HOLD", "INFO", "LOG", + "PASSWORD", or "STATE". + +REAL-TIME MESSAGE FORMAT +------------------------ + +The OpenVPN management interface produces two kinds of +output: (a) output from a command, or (b) asynchronous, +real-time output which can be generated at any time. + +Real-time messages start with a '>' character in the first +column and are immediately followed by a type keyword +indicating the type of real-time message. The following +types are currently defined: + +ECHO -- Echo messages as controlled by the "echo" command. + +FATAL -- A fatal error which is output to the log file just + prior to OpenVPN exiting. + +HOLD -- Used to indicate that OpenVPN is in a holding state + and will not start until it receives a + "hold release" command. + +INFO -- Informational messages such as the welcome message. + +LOG -- Log message output as controlled by the "log" command. + +PASSWORD -- Used to tell the management client that OpenVPN + needs a password, also to indicate password + verification failure. + +STATE -- Shows the current OpenVPN state, as controlled + by the "state" command. + +Command Parsing +--------------- + +OpenVPN uses the same command line lexical analyzer as is used +by the OpenVPN config file parser. + +Whitespace is a parameter separator. + +Double quotation characters ("") can be used to enclose +parameters containing whitespace + +Backslash-based shell escaping is performed, using the following +mappings + +\\ Maps to a single backslash character (\). +\" Pass a literal doublequote character ("), don't + interpret it as enclosing a parameter. +\[SPACE] Pass a literal space or tab character, don't + interpret it as a parameter delimiter. @@ -0,0 +1,187 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP + +#include "buffer.h" +#include "error.h" +#include "misc.h" +#include "mbuf.h" + +#include "memdbg.h" + +struct mbuf_set * +mbuf_init (unsigned int size) +{ + struct mbuf_set *ret; + ALLOC_OBJ_CLEAR (ret, struct mbuf_set); + mutex_init (&ret->mutex); + ret->capacity = adjust_power_of_2 (size); + ALLOC_ARRAY (ret->array, struct mbuf_item, ret->capacity); + return ret; +} + +void +mbuf_free (struct mbuf_set *ms) +{ + if (ms) + { + int i; + for (i = 0; i < (int) ms->len; ++i) + { + struct mbuf_item *item = &ms->array[MBUF_INDEX(ms->head, i, ms->capacity)]; + mbuf_free_buf (item->buffer); + } + free (ms->array); + mutex_destroy (&ms->mutex); + free (ms); + } +} + +struct mbuf_buffer * +mbuf_alloc_buf (const struct buffer *buf) +{ + struct mbuf_buffer *ret; + ALLOC_OBJ (ret, struct mbuf_buffer); + ret->buf = clone_buf (buf); + ret->refcount = 1; + ret->flags = 0; + return ret; +} + +void +mbuf_free_buf (struct mbuf_buffer *mb) +{ + if (mb) + { + if (--mb->refcount <= 0) + { + free_buf (&mb->buf); + free (mb); + } + } +} + +void +mbuf_add_item (struct mbuf_set *ms, const struct mbuf_item *item) +{ + ASSERT (ms); + mutex_lock (&ms->mutex); + if (ms->len == ms->capacity) + { + struct mbuf_item rm; + ASSERT (mbuf_extract_item (ms, &rm, false)); + mbuf_free_buf (rm.buffer); + msg (D_MULTI_DROPPED, "MBUF: mbuf packet dropped"); + } + + ASSERT (ms->len < ms->capacity); + + ms->array[MBUF_INDEX(ms->head, ms->len, ms->capacity)] = *item; + if (++ms->len > ms->max_queued) + ms->max_queued = ms->len; + ++item->buffer->refcount; + mutex_unlock (&ms->mutex); +} + +bool +mbuf_extract_item (struct mbuf_set *ms, struct mbuf_item *item, const bool lock) +{ + bool ret = false; + if (ms) + { + if (lock) + mutex_lock (&ms->mutex); + while (ms->len) + { + *item = ms->array[ms->head]; + ms->head = MBUF_INDEX(ms->head, 1, ms->capacity); + --ms->len; + if (item->instance) /* ignore dereferenced instances */ + { + ret = true; + break; + } + } + if (lock) + mutex_unlock (&ms->mutex); + } + return ret; +} + +struct multi_instance * +mbuf_peek_dowork (struct mbuf_set *ms) +{ + struct multi_instance *ret = NULL; + if (ms) + { + int i; + mutex_lock (&ms->mutex); + for (i = 0; i < (int) ms->len; ++i) + { + struct mbuf_item *item = &ms->array[MBUF_INDEX(ms->head, i, ms->capacity)]; + if (item->instance) + { + ret = item->instance; + break; + } + } + mutex_unlock (&ms->mutex); + } + return ret; +} + +void +mbuf_dereference_instance (struct mbuf_set *ms, struct multi_instance *mi) +{ + if (ms) + { + int i; + mutex_lock (&ms->mutex); + for (i = 0; i < (int) ms->len; ++i) + { + struct mbuf_item *item = &ms->array[MBUF_INDEX(ms->head, i, ms->capacity)]; + if (item->instance == mi) + { + mbuf_free_buf (item->buffer); + item->buffer = NULL; + item->instance = NULL; + msg (D_MBUF, "MBUF: dereferenced queued packet"); + } + } + mutex_unlock (&ms->mutex); + } +} + +#else +static void dummy(void) {} +#endif /* P2MP */ @@ -0,0 +1,110 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MBUF_H +#define MBUF_H + +/* + * Handle both multicast and broadcast functions. + */ + +#if P2MP + +/* define this to enable special test mode */ +/*#define MBUF_TEST*/ + +#include "basic.h" +#include "buffer.h" + +struct multi_instance; + +#define MBUF_INDEX(head, offset, size) (((head) + (offset)) & ((size)-1)) + +struct mbuf_buffer +{ + struct buffer buf; + int refcount; + +# define MF_UNICAST (1<<0) + unsigned int flags; +}; + +struct mbuf_item +{ + struct mbuf_buffer *buffer; + struct multi_instance *instance; +}; + +struct mbuf_set +{ + MUTEX_DEFINE (mutex); + unsigned int head; + unsigned int len; + unsigned int capacity; + unsigned int max_queued; + struct mbuf_item *array; +}; + +struct mbuf_set *mbuf_init (unsigned int size); +void mbuf_free (struct mbuf_set *ms); + +struct mbuf_buffer *mbuf_alloc_buf (const struct buffer *buf); +void mbuf_free_buf (struct mbuf_buffer *mb); + +void mbuf_add_item (struct mbuf_set *ms, const struct mbuf_item *item); + +bool mbuf_extract_item (struct mbuf_set *ms, struct mbuf_item *item, const bool lock); + +void mbuf_dereference_instance (struct mbuf_set *ms, struct multi_instance *mi); + +static inline bool +mbuf_defined (const struct mbuf_set *ms) +{ + return ms && ms->len; +} + +static inline bool +mbuf_len (const struct mbuf_set *ms) +{ + return ms->len; +} + +static inline int +mbuf_maximum_queued (const struct mbuf_set *ms) +{ + return (int) ms->max_queued; +} + +static inline struct multi_instance * +mbuf_peek (struct mbuf_set *ms) +{ + struct multi_instance *mbuf_peek_dowork (struct mbuf_set *ms); + if (mbuf_defined (ms)) + return mbuf_peek_dowork (ms); + else + return NULL; +} + +#endif +#endif diff --git a/memcmp.c b/memcmp.c new file mode 100644 index 0000000..0b1fbd2 --- /dev/null +++ b/memcmp.c @@ -0,0 +1,40 @@ +/* memcmp.c -- Replacement memcmp.c + * + * Useful on systems that don't have a working memcmp, such as SunOS + * 4.1.3 and NeXT x86 OpenStep. + * + * Copyright (C) 2002 - 2003 Matthias Andree <matthias.andree@gmx.de> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or (at + * your option) any later version. + * + * This program is distributed in the hope that it will be useful, but + * WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#include <string.h> + +int +memcmp (const void *s1, const void *s2, size_t n) +{ + register unsigned const char *p1 = s1, *p2 = s2; + int d; + + if (n) + while (n-- > 0) + { + d = *p1++ - *p2++; + if (d != 0) + return d; + } + return 0; +} diff --git a/memdbg.h b/memdbg.h new file mode 100644 index 0000000..1aa54b3 --- /dev/null +++ b/memdbg.h @@ -0,0 +1,112 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MEMDBG_H +#define MEMDBG_H + +/* + * Valgrind debugging support. + * + * Valgrind is a great tool for debugging memory issues, + * though it seems to generate a lot of warnings in OpenSSL + * about uninitialized data. To silence these warnings, + * I've put together a suppressions file + * in debug/valgrind-suppress. + * + * Also, grep for VALGRIND_MAKE_READABLE in the OpenVPN source. + * Because valgrind thinks that some of the data passed from + * OpenSSL back to OpenVPN is tainted due to being sourced + * from uninitialized data, we need to untaint it before use -- + * otherwise we will get a lot of useless warnings. + * + * valgrind --tool=memcheck --error-limit=no --suppressions=debug/valgrind-suppress --gen-suppressions=yes ./openvpn ... + */ + +#ifdef USE_VALGRIND + +#include "valgrind/memcheck.h" + +#else + +#define VALGRIND_MAKE_READABLE(addr, len) + +#endif + +#ifdef DMALLOC /* see ./configure options to enable */ + +/* + * See ./configure options to enable dmalloc + * support for memory leak checking. + * + * The dmalloc package can be downloaded from: + * + * http://dmalloc.com/ + * + * When dmalloc is installed and enabled, + * use this command prior to running openvpn: + * + * dmalloc -l dlog -i 100 low -p log-unknown + * + * Also, put this in your .bashrc file: + * + * function dmalloc { eval `command dmalloc -b $*`; } + * + * Or take a more low-level approach: + * + * export DMALLOC_OPTIONS="debug=0x4e48503,inter=100,log=dlog" + * + * NOTE: When building dmalloc you need to add something + * like this to dmalloc's settings.h -- it will allocate a static + * buffer to be used as the malloc arena: + * + * #define INTERNAL_MEMORY_SPACE (1024 * 1024 * 50) + */ + +#include "dmalloc.h" + +#define openvpn_dmalloc(file, line, size) dmalloc_malloc((file), (line), (size), DMALLOC_FUNC_MALLOC, 0, 0) + +/* + * This #define will put the line number of the log + * file position where leaked memory was allocated instead + * of the source code file and line number. Make sure + * to increase the size of dmalloc's info tables, + * (MEMORY_TABLE_SIZE in settings.h) + * otherwise it might get overwhelmed by the large + * number of unique file/line combinations. + */ +#if 0 +#undef malloc +#define malloc(size) openvpn_dmalloc("logfile", x_msg_line_num, (size)) +#endif + +#endif /* DMALLOC */ + +/* + * Force buffers to be zeroed after allocation. + * For debugging only. + */ +/*#define ZERO_BUFFER_ON_ALLOC*/ + +#endif /* MEMDBG_H */ @@ -0,0 +1,1359 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "buffer.h" +#include "misc.h" +#include "tun.h" +#include "error.h" +#include "thread.h" +#include "otime.h" +#include "plugin.h" +#include "options.h" +#include "manage.h" + +#include "memdbg.h" + +/* Redefine the top level directory of the filesystem + to restrict access to files for security */ +void +do_chroot (const char *path) +{ + if (path) + { +#ifdef HAVE_CHROOT + const char *top = "/"; + if (chroot (path)) + msg (M_ERR, "chroot to '%s' failed", path); + if (openvpn_chdir (top)) + msg (M_ERR, "cd to '%s' failed", top); + msg (M_INFO, "chroot to '%s' and cd to '%s' succeeded", path, top); +#else + msg (M_FATAL, "Sorry but I can't chroot to '%s' because this operating system doesn't appear to support the chroot() system call", path); +#endif + } +} + +/* Get/Set UID of process */ + +bool +get_user (const char *username, struct user_state *state) +{ + bool ret = false; + CLEAR (*state); + if (username) + { +#if defined(HAVE_GETPWNAM) && defined(HAVE_SETUID) + state->pw = getpwnam (username); + if (!state->pw) + msg (M_ERR, "failed to find UID for user %s", username); + state->username = username; + ret = true; +#else + msg (M_FATAL, "Sorry but I can't setuid to '%s' because this operating system doesn't appear to support the getpwname() or setuid() system calls", username); +#endif + } + return ret; +} + +void +set_user (const struct user_state *state) +{ +#if defined(HAVE_GETPWNAM) && defined(HAVE_SETUID) + if (state->username && state->pw) + { + if (setuid (state->pw->pw_uid)) + msg (M_ERR, "setuid('%s') failed", state->username); + msg (M_INFO, "UID set to %s", state->username); + } +#endif +} + +/* Get/Set GID of process */ + +bool +get_group (const char *groupname, struct group_state *state) +{ + bool ret = false; + CLEAR (*state); + if (groupname) + { +#if defined(HAVE_GETGRNAM) && defined(HAVE_SETGID) + state->gr = getgrnam (groupname); + if (!state->gr) + msg (M_ERR, "failed to find GID for group %s", groupname); + state->groupname = groupname; + ret = true; +#else + msg (M_FATAL, "Sorry but I can't setgid to '%s' because this operating system doesn't appear to support the getgrnam() or setgid() system calls", groupname); +#endif + } + return ret; +} + +void +set_group (const struct group_state *state) +{ +#if defined(HAVE_GETGRNAM) && defined(HAVE_SETGID) + if (state->groupname && state->gr) + { + if (setgid (state->gr->gr_gid)) + msg (M_ERR, "setgid('%s') failed", state->groupname); + msg (M_INFO, "GID set to %s", state->groupname); +#ifdef HAVE_SETGROUPS + { + gid_t gr_list[1]; + gr_list[0] = state->gr->gr_gid; + if (setgroups (1, gr_list)) + msg (M_ERR, "setgroups('%s') failed", state->groupname); + } +#endif + } +#endif +} + +/* Change process priority */ +void +set_nice (int niceval) +{ + if (niceval) + { +#ifdef HAVE_NICE + errno = 0; + nice (niceval); + if (errno != 0) + msg (M_WARN | M_ERRNO, "WARNING: nice %d failed", niceval); + else + msg (M_INFO, "nice %d succeeded", niceval); +#else + msg (M_WARN, "WARNING: nice %d failed (function not implemented)", niceval); +#endif + } +} + +/* + * Pass tunnel endpoint and MTU parms to a user-supplied script. + * Used to execute the up/down script/plugins. + */ +void +run_up_down (const char *command, + const struct plugin_list *plugins, + int plugin_type, + const char *arg, + int tun_mtu, + int link_mtu, + const char *ifconfig_local, + const char* ifconfig_remote, + const char *context, + const char *signal_text, + const char *script_type, + struct env_set *es) +{ + struct gc_arena gc = gc_new (); + + if (signal_text) + setenv_str (es, "signal", signal_text); + setenv_str (es, "script_context", context); + setenv_int (es, "tun_mtu", tun_mtu); + setenv_int (es, "link_mtu", link_mtu); + setenv_str (es, "dev", arg); + + if (!ifconfig_local) + ifconfig_local = ""; + if (!ifconfig_remote) + ifconfig_remote = ""; + if (!context) + context = ""; + + if (plugin_defined (plugins, plugin_type)) + { + struct buffer cmd = alloc_buf_gc (256, &gc); + + ASSERT (arg); + + buf_printf (&cmd, + "%s %d %d %s %s %s", + arg, + tun_mtu, link_mtu, + ifconfig_local, ifconfig_remote, + context); + + if (plugin_call (plugins, plugin_type, BSTR (&cmd), es)) + msg (M_FATAL, "ERROR: up/down plugin call failed"); + } + + if (command) + { + struct buffer cmd = alloc_buf_gc (256, &gc); + + ASSERT (arg); + + setenv_str (es, "script_type", script_type); + + buf_printf (&cmd, + "%s %s %d %d %s %s %s", + command, + arg, + tun_mtu, link_mtu, + ifconfig_local, ifconfig_remote, + context); + msg (M_INFO, "%s", BSTR (&cmd)); + system_check (BSTR (&cmd), es, S_SCRIPT|S_FATAL, "script failed"); + } + + gc_free (&gc); +} + +/* Get the file we will later write our process ID to */ +void +get_pid_file (const char* filename, struct pid_state *state) +{ + CLEAR (*state); + if (filename) + { + state->fp = fopen (filename, "w"); + if (!state->fp) + msg (M_ERR, "Open error on pid file %s", filename); + state->filename = filename; + } +} + +/* Write our PID to a file */ +void +write_pid (const struct pid_state *state) +{ + if (state->filename && state->fp) + { + unsigned int pid = openvpn_getpid (); + fprintf(state->fp, "%u\n", pid); + if (fclose (state->fp)) + msg (M_ERR, "Close error on pid file %s", state->filename); + } +} + +/* Get current PID */ +unsigned int +openvpn_getpid () +{ +#ifdef WIN32 + return (unsigned int) GetCurrentProcessId (); +#else +#ifdef HAVE_GETPID + return (unsigned int) getpid (); +#else + return 0; +#endif +#endif +} + +/* Disable paging */ +void +do_mlockall(bool print_msg) +{ +#ifdef HAVE_MLOCKALL + if (mlockall (MCL_CURRENT | MCL_FUTURE)) + msg (M_WARN | M_ERRNO, "WARNING: mlockall call failed"); + else if (print_msg) + msg (M_INFO, "mlockall call succeeded"); +#else + msg (M_WARN, "WARNING: mlockall call failed (function not implemented)"); +#endif +} + +#ifndef HAVE_DAEMON + +int +daemon(int nochdir, int noclose) +{ +#if defined(HAVE_FORK) && defined(HAVE_SETSID) + switch (fork()) + { + case -1: + return (-1); + case 0: + break; + default: + openvpn_exit (OPENVPN_EXIT_STATUS_GOOD); /* exit point */ + } + + if (setsid() == -1) + return (-1); + + if (!nochdir) + openvpn_chdir ("/"); + + if (!noclose) + set_std_files_to_null (false); +#else + msg (M_FATAL, "Sorry but I can't become a daemon because this operating system doesn't appear to support either the daemon() or fork() system calls"); +#endif + return (0); +} + +#endif + +/* + * Set standard file descriptors to /dev/null + */ +void +set_std_files_to_null (bool stdin_only) +{ +#if defined(HAVE_DUP) && defined(HAVE_DUP2) + int fd; + if ((fd = open ("/dev/null", O_RDWR, 0)) != -1) + { + dup2 (fd, 0); + if (!stdin_only) + { + dup2 (fd, 1); + dup2 (fd, 2); + } + if (fd > 2) + close (fd); + } +#endif +} + +/* + * Wrapper for chdir library function + */ +int +openvpn_chdir (const char* dir) +{ +#ifdef HAVE_CHDIR + return chdir (dir); +#else + return -1; +#endif +} + +/* + * dup inetd/xinetd socket descriptor and save + */ + +int inetd_socket_descriptor = SOCKET_UNDEFINED; /* GLOBAL */ + +void +save_inetd_socket_descriptor (void) +{ + inetd_socket_descriptor = INETD_SOCKET_DESCRIPTOR; +#if defined(HAVE_DUP) && defined(HAVE_DUP2) + /* use handle passed by inetd/xinetd */ + if ((inetd_socket_descriptor = dup (INETD_SOCKET_DESCRIPTOR)) < 0) + msg (M_ERR, "INETD_SOCKET_DESCRIPTOR dup(%d) failed", INETD_SOCKET_DESCRIPTOR); + set_std_files_to_null (true); +#endif +} + +/* + * Wrapper around the system() call. + */ +int +openvpn_system (const char *command, const struct env_set *es, unsigned int flags) +{ +#ifdef HAVE_SYSTEM + int ret; + + /* + * We need to bracket this code by mutex because system() doesn't + * accept an environment list, so we have to use the process-wide + * list which is shared between all threads. + */ + mutex_lock_static (L_SYSTEM); + perf_push (PERF_SCRIPT); + + /* + * add env_set to environment. + */ + if (flags & S_SCRIPT) + env_set_add_to_environment (es); + + + /* debugging */ + dmsg (D_SCRIPT, "SYSTEM[%u] '%s'", flags, command); + if (flags & S_SCRIPT) + env_set_print (D_SCRIPT, es); + + /* + * execute the command + */ + ret = system (command); + + /* debugging */ + dmsg (D_SCRIPT, "SYSTEM return=%u", ret); + + /* + * remove env_set from environment + */ + if (flags & S_SCRIPT) + env_set_remove_from_environment (es); + + perf_pop (); + mutex_unlock_static (L_SYSTEM); + return ret; + +#else + msg (M_FATAL, "Sorry but I can't execute the shell command '%s' because this operating system doesn't appear to support the system() call", command); + return -1; /* NOTREACHED */ +#endif +} + +/* + * Warn if a given file is group/others accessible. + */ +void +warn_if_group_others_accessible (const char* filename) +{ +#ifdef HAVE_STAT + struct stat st; + if (stat (filename, &st)) + { + msg (M_WARN | M_ERRNO, "WARNING: cannot stat file '%s'", filename); + } + else + { + if (st.st_mode & (S_IRWXG|S_IRWXO)) + msg (M_WARN, "WARNING: file '%s' is group or others accessible", filename); + } +#endif +} + +/* + * convert system() return into a success/failure value + */ +bool +system_ok (int stat) +{ +#ifdef WIN32 + return stat == 0; +#else + return stat != -1 && WIFEXITED (stat) && WEXITSTATUS (stat) == 0; +#endif +} + +/* + * did system() call execute the given command? + */ +bool +system_executed (int stat) +{ +#ifdef WIN32 + return stat != -1; +#else + return stat != -1 && WEXITSTATUS (stat) != 127; +#endif +} + +/* + * Print an error message based on the status code returned by system(). + */ +const char * +system_error_message (int stat, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); +#ifdef WIN32 + if (stat == -1) + buf_printf (&out, "shell command did not execute -- "); + buf_printf (&out, "system() returned error code %d", stat); +#else + if (stat == -1) + buf_printf (&out, "shell command fork failed"); + else if (!WIFEXITED (stat)) + buf_printf (&out, "shell command did not exit normally"); + else + { + const int cmd_ret = WEXITSTATUS (stat); + if (!cmd_ret) + buf_printf (&out, "shell command exited normally"); + else if (cmd_ret == 127) + buf_printf (&out, "could not execute shell command"); + else + buf_printf (&out, "shell command exited with error status: %d", cmd_ret); + } +#endif + return (const char *)out.data; +} + +/* + * Run system(), exiting on error. + */ +bool +system_check (const char *command, const struct env_set *es, unsigned int flags, const char *error_message) +{ + struct gc_arena gc = gc_new (); + const int stat = openvpn_system (command, es, flags); + int ret = false; + + if (system_ok (stat)) + ret = true; + else + { + if (error_message) + msg (((flags & S_FATAL) ? M_FATAL : M_WARN), "%s: %s", + error_message, + system_error_message (stat, &gc)); + } + gc_free (&gc); + return ret; +} + +/* + * Initialize random number seed. random() is only used + * when "weak" random numbers are acceptable. + * OpenSSL routines are always used when cryptographically + * strong random numbers are required. + */ + +void +init_random_seed(void) +{ +#ifdef HAVE_GETTIMEOFDAY + struct timeval tv; + + if (!gettimeofday (&tv, NULL)) + { + const unsigned int seed = (unsigned int) tv.tv_sec ^ tv.tv_usec; + srandom (seed); + } +#else /* HAVE_GETTIMEOFDAY */ + const time_t current = time (NULL); + srandom ((unsigned int)current); +#endif /* HAVE_GETTIMEOFDAY */ +} + +/* thread-safe strerror */ + +const char * +strerror_ts (int errnum, struct gc_arena *gc) +{ +#ifdef HAVE_STRERROR + struct buffer out = alloc_buf_gc (256, gc); + + mutex_lock_static (L_STRERR); + buf_printf (&out, "%s", openvpn_strerror (errnum, gc)); + mutex_unlock_static (L_STRERR); + return BSTR (&out); +#else + return "[error string unavailable]"; +#endif +} + +/* + * Set environmental variable (int or string). + * + * On Posix, we use putenv for portability, + * and put up with its painful semantics + * that require all the support code below. + */ + +/* General-purpose environmental variable set functions */ + +static char * +construct_name_value (const char *name, const char *value, struct gc_arena *gc) +{ + struct buffer out; + + ASSERT (name); + if (!value) + value = ""; + out = alloc_buf_gc (strlen (name) + strlen (value) + 2, gc); + buf_printf (&out, "%s=%s", name, value); + return BSTR (&out); +} + +bool +deconstruct_name_value (const char *str, const char **name, const char **value, struct gc_arena *gc) +{ + char *cp; + + ASSERT (str); + ASSERT (name && value); + + *name = cp = string_alloc (str, gc); + *value = NULL; + + while ((*cp)) + { + if (*cp == '=' && !*value) + { + *cp = 0; + *value = cp + 1; + } + ++cp; + } + return *name && *value; +} + +static bool +env_string_equal (const char *s1, const char *s2) +{ + int c1, c2; + ASSERT (s1); + ASSERT (s2); + + while (true) + { + c1 = *s1++; + c2 = *s2++; + if (c1 == '=') + c1 = 0; + if (c2 == '=') + c2 = 0; + if (!c1 && !c2) + return true; + if (c1 != c2) + break; + } + return false; +} + +static bool +remove_env_item (const char *str, const bool do_free, struct env_item **list) +{ + struct env_item *current, *prev; + + ASSERT (str); + ASSERT (list); + + for (current = *list, prev = NULL; current != NULL; current = current->next) + { + if (env_string_equal (current->string, str)) + { + if (prev) + prev->next = current->next; + else + *list = current->next; + if (do_free) + { + memset (current->string, 0, strlen (current->string)); + free (current->string); + free (current); + } + return true; + } + prev = current; + } + return false; +} + +static void +add_env_item (char *str, const bool do_alloc, struct env_item **list, struct gc_arena *gc) +{ + struct env_item *item; + + ASSERT (str); + ASSERT (list); + + ALLOC_OBJ_GC (item, struct env_item, gc); + item->string = do_alloc ? string_alloc (str, gc): str; + item->next = *list; + *list = item; +} + +/* struct env_set functions */ + +static bool +env_set_del_nolock (struct env_set *es, const char *str) +{ + return remove_env_item (str, false, &es->list); +} + +static void +env_set_add_nolock (struct env_set *es, const char *str) +{ + remove_env_item (str, false, &es->list); + add_env_item ((char *)str, true, &es->list, es->gc); +} + +struct env_set * +env_set_create (struct gc_arena *gc) +{ + struct env_set *es; + ASSERT (gc); + mutex_lock_static (L_ENV_SET); + ALLOC_OBJ_CLEAR_GC (es, struct env_set, gc); + es->list = NULL; + es->gc = gc; + mutex_unlock_static (L_ENV_SET); + return es; +} + +bool +env_set_del (struct env_set *es, const char *str) +{ + bool ret; + ASSERT (es); + ASSERT (str); + mutex_lock_static (L_ENV_SET); + ret = env_set_del_nolock (es, str); + mutex_unlock_static (L_ENV_SET); + return ret; +} + +void +env_set_add (struct env_set *es, const char *str) +{ + ASSERT (es); + ASSERT (str); + mutex_lock_static (L_ENV_SET); + env_set_add_nolock (es, str); + mutex_unlock_static (L_ENV_SET); +} + +void +env_set_print (int msglevel, const struct env_set *es) +{ + if (check_debug_level (msglevel)) + { + const struct env_item *e; + int i; + + if (es) + { + mutex_lock_static (L_ENV_SET); + e = es->list; + i = 0; + + while (e) + { + msg (msglevel, "ENV [%d] '%s'", i, e->string); + ++i; + e = e->next; + } + mutex_unlock_static (L_ENV_SET); + } + } +} + +void +env_set_inherit (struct env_set *es, const struct env_set *src) +{ + const struct env_item *e; + + ASSERT (es); + + if (src) + { + mutex_lock_static (L_ENV_SET); + e = src->list; + while (e) + { + env_set_add_nolock (es, e->string); + e = e->next; + } + mutex_unlock_static (L_ENV_SET); + } +} + +void +env_set_add_to_environment (const struct env_set *es) +{ + if (es) + { + struct gc_arena gc = gc_new (); + const struct env_item *e; + + mutex_lock_static (L_ENV_SET); + e = es->list; + + while (e) + { + const char *name; + const char *value; + + if (deconstruct_name_value (e->string, &name, &value, &gc)) + setenv_str (NULL, name, value); + + e = e->next; + } + mutex_unlock_static (L_ENV_SET); + gc_free (&gc); + } +} + +void +env_set_remove_from_environment (const struct env_set *es) +{ + if (es) + { + struct gc_arena gc = gc_new (); + const struct env_item *e; + + mutex_lock_static (L_ENV_SET); + e = es->list; + + while (e) + { + const char *name; + const char *value; + + if (deconstruct_name_value (e->string, &name, &value, &gc)) + setenv_del (NULL, name); + + e = e->next; + } + mutex_unlock_static (L_ENV_SET); + gc_free (&gc); + } +} + +#ifdef HAVE_PUTENV + +/* companion functions to putenv */ + +static struct env_item *global_env = NULL; /* GLOBAL */ + +static void +manage_env (char *str) +{ + remove_env_item (str, true, &global_env); + add_env_item (str, false, &global_env, NULL); +} + +#endif + +/* add/modify/delete environmental strings */ + +void +setenv_int (struct env_set *es, const char *name, int value) +{ + char buf[64]; + openvpn_snprintf (buf, sizeof(buf), "%d", value); + setenv_str (es, name, buf); +} + +void +setenv_str (struct env_set *es, const char *name, const char *value) +{ + setenv_str_ex (es, name, value, CC_NAME, 0, 0, CC_PRINT, 0, 0); +} + +void +setenv_del (struct env_set *es, const char *name) +{ + ASSERT (name); + setenv_str (es, name, NULL); +} + +void +setenv_str_ex (struct env_set *es, + const char *name, + const char *value, + const unsigned int name_include, + const unsigned int name_exclude, + const char name_replace, + const unsigned int value_include, + const unsigned int value_exclude, + const char value_replace) +{ + struct gc_arena gc = gc_new (); + const char *name_tmp; + const char *val_tmp = NULL; + + ASSERT (name && strlen (name) > 1); + + name_tmp = string_mod_const (name, name_include, name_exclude, name_replace, &gc); + + if (value) + val_tmp = string_mod_const (value, value_include, value_exclude, value_replace, &gc); + + if (es) + { + if (val_tmp) + { + const char *str = construct_name_value (name_tmp, val_tmp, &gc); + env_set_add (es, str); + } + else + env_set_del (es, name_tmp); + } + else + { +#if defined(WIN32) + { + /*msg (M_INFO, "SetEnvironmentVariable '%s' '%s'", name_tmp, val_tmp ? val_tmp : "NULL");*/ + if (!SetEnvironmentVariable (name_tmp, val_tmp)) + msg (M_WARN | M_ERRNO, "SetEnvironmentVariable failed, name='%s', value='%s'", + name_tmp, + val_tmp ? val_tmp : "NULL"); + } +#elif defined(HAVE_PUTENV) + { + char *str = construct_name_value (name_tmp, val_tmp, NULL); + int status; + + mutex_lock_static (L_PUTENV); + status = putenv (str); + /*msg (M_INFO, "PUTENV '%s'", str);*/ + if (!status) + manage_env (str); + mutex_unlock_static (L_PUTENV); + if (status) + msg (M_WARN | M_ERRNO, "putenv('%s') failed", str); + } +#endif + } + + gc_free (&gc); +} + +/* + * taken from busybox networking/ifupdown.c + */ +unsigned int +count_bits(unsigned int a) +{ + unsigned int result; + result = (a & 0x55) + ((a >> 1) & 0x55); + result = (result & 0x33) + ((result >> 2) & 0x33); + return((result & 0x0F) + ((result >> 4) & 0x0F)); +} + +int +count_netmask_bits(const char *dotted_quad) +{ + unsigned int result, a, b, c, d; + /* Found a netmask... Check if it is dotted quad */ + if (sscanf(dotted_quad, "%u.%u.%u.%u", &a, &b, &c, &d) != 4) + return -1; + result = count_bits(a); + result += count_bits(b); + result += count_bits(c); + result += count_bits(d); + return ((int)result); +} + +/* + * Go to sleep for n milliseconds. + */ +void +sleep_milliseconds (unsigned int n) +{ +#ifdef WIN32 + Sleep (n); +#else + struct timeval tv; + tv.tv_sec = n / 1000; + tv.tv_usec = (n % 1000) * 1000; + select (0, NULL, NULL, NULL, &tv); +#endif +} + +/* + * Go to sleep indefinitely. + */ +void +sleep_until_signal (void) +{ +#ifdef WIN32 + ASSERT (0); +#else + select (0, NULL, NULL, NULL, NULL); +#endif +} + +/* return true if filename can be opened for read */ +bool +test_file (const char *filename) +{ + bool ret = false; + if (filename) + { + FILE *fp = fopen (filename, "r"); + if (fp) + { + fclose (fp); + ret = true; + } + } + + dmsg (D_TEST_FILE, "TEST FILE '%s' [%d]", + filename ? filename : "UNDEF", + ret); + + return ret; +} + +/* create a temporary filename in directory */ +const char * +create_temp_filename (const char *directory, struct gc_arena *gc) +{ + static unsigned int counter; + struct buffer fname = alloc_buf_gc (256, gc); + + mutex_lock_static (L_CREATE_TEMP); + ++counter; + mutex_unlock_static (L_CREATE_TEMP); + + buf_printf (&fname, PACKAGE "_%u_%u.tmp", + openvpn_getpid (), + counter); + + return gen_path (directory, BSTR (&fname), gc); +} + +/* + * Put a directory and filename together. + */ +const char * +gen_path (const char *directory, const char *filename, struct gc_arena *gc) +{ + const char *safe_filename = string_mod_const (filename, CC_ALNUM|CC_UNDERBAR|CC_DASH|CC_DOT|CC_AT, 0, '_', gc); + + if (safe_filename + && strcmp (safe_filename, ".") + && strcmp (safe_filename, "..")) + { + struct buffer out = alloc_buf_gc (256, gc); + char dirsep[2]; + + dirsep[0] = OS_SPECIFIC_DIRSEP; + dirsep[1] = '\0'; + + if (directory) + buf_printf (&out, "%s%s", directory, dirsep); + buf_printf (&out, "%s", safe_filename); + + return BSTR (&out); + } + else + return NULL; +} + +/* delete a file, return true if succeeded */ +bool +delete_file (const char *filename) +{ +#if defined(WIN32) + return (DeleteFile (filename) != 0); +#elif defined(HAVE_UNLINK) + return (unlink (filename) == 0); +#else + return false; +#endif +} + +/* + * Return the next largest power of 2 + * or u if u is a power of 2. + */ +unsigned int +adjust_power_of_2 (unsigned int u) +{ + unsigned int ret = 1; + + while (ret < u) + { + ret <<= 1; + ASSERT (ret > 0); + } + + return ret; +} + +#ifdef HAVE_GETPASS + +static FILE * +open_tty (const bool write) +{ + FILE *ret; + ret = fopen ("/dev/tty", write ? "w" : "r"); + if (!ret) + ret = write ? stderr : stdin; + return ret; +} + +static void +close_tty (FILE *fp) +{ + if (fp != stderr && fp != stdin) + fclose (fp); +} + +#endif + +/* + * Get input from console + */ +bool +get_console_input (const char *prompt, const bool echo, char *input, const int capacity) +{ + bool ret = false; + ASSERT (prompt); + ASSERT (input); + ASSERT (capacity > 0); + input[0] = '\0'; + +#if defined(WIN32) + return get_console_input_win32 (prompt, echo, input, capacity); +#elif defined(HAVE_GETPASS) + if (echo) + { + FILE *fp; + + fp = open_tty (true); + fprintf (fp, "%s", prompt); + fflush (fp); + close_tty (fp); + + fp = open_tty (false); + if (fgets (input, capacity, fp) != NULL) + { + chomp (input); + ret = true; + } + close_tty (fp); + } + else + { + char *gp = getpass (prompt); + if (gp) + { + strncpynt (input, gp, capacity); + memset (gp, 0, strlen (gp)); + ret = true; + } + } +#else + msg (M_FATAL, "Sorry, but I can't get console input on this OS"); +#endif + return ret; +} + +/* + * Get and store a username/password + */ + +void +get_user_pass (struct user_pass *up, + const char *auth_file, + const bool password_only, + const char *prefix, + const unsigned int flags) +{ + struct gc_arena gc = gc_new (); + + if (!up->defined) + { + const bool from_stdin = (!auth_file || !strcmp (auth_file, "stdin")); + +#ifdef ENABLE_MANAGEMENT + /* + * Get username/password from standard input? + */ + if (management + && ((auth_file && streq (auth_file, "management")) || (from_stdin && (flags & GET_USER_PASS_MANAGEMENT))) + && management_query_user_pass_enabled (management)) + { + if (!management_query_user_pass (management, up, prefix, password_only)) + msg (M_FATAL, "ERROR: could not read %s username/password from management interface", prefix); + } + else +#endif + /* + * Get username/password from standard input? + */ + if (from_stdin) + { + struct buffer user_prompt = alloc_buf_gc (128, &gc); + struct buffer pass_prompt = alloc_buf_gc (128, &gc); + + buf_printf (&user_prompt, "Enter %s Username:", prefix); + buf_printf (&pass_prompt, "Enter %s Password:", prefix); + + if (!password_only) + { + if (!get_console_input (BSTR (&user_prompt), true, up->username, USER_PASS_LEN)) + msg (M_FATAL, "ERROR: could not read %s username from stdin", prefix); + if (strlen (up->username) == 0) + msg (M_FATAL, "ERROR: %s username is empty", prefix); + } + + if (!get_console_input (BSTR (&pass_prompt), false, up->password, USER_PASS_LEN)) + msg (M_FATAL, "ERROR: could not not read %s password from stdin", prefix); + } + else + { + /* + * Get username/password from a file. + */ + FILE *fp; + +#ifndef ENABLE_PASSWORD_SAVE + /* + * Unless ENABLE_PASSWORD_SAVE is defined, don't allow sensitive passwords + * to be read from a file. + */ + if (flags & GET_USER_PASS_SENSITIVE) + msg (M_FATAL, "Sorry, '%s' password cannot be read from a file", prefix); +#endif + + warn_if_group_others_accessible (auth_file); + + fp = fopen (auth_file, "r"); + if (!fp) + msg (M_ERR, "Error opening '%s' auth file: %s", prefix, auth_file); + + if (password_only) + { + if (fgets (up->password, USER_PASS_LEN, fp) == NULL) + msg (M_FATAL, "Error reading password from %s authfile: %s", + prefix, + auth_file); + } + else + { + if (fgets (up->username, USER_PASS_LEN, fp) == NULL + || fgets (up->password, USER_PASS_LEN, fp) == NULL) + msg (M_FATAL, "Error reading username and password (must be on two consecutive lines) from %s authfile: %s", + prefix, + auth_file); + } + + fclose (fp); + + chomp (up->username); + chomp (up->password); + + if (!password_only && strlen (up->username) == 0) + msg (M_FATAL, "ERROR: username from %s authfile '%s' is empty", prefix, auth_file); + } + + string_mod (up->username, CC_PRINT, CC_CRLF, 0); + string_mod (up->password, CC_PRINT, CC_CRLF, 0); + + up->defined = true; + } + +#if 0 + msg (M_INFO, "GET_USER_PASS %s u='%s' p='%s'", prefix, up->username, up->password); +#endif + + gc_free (&gc); +} + +void +purge_user_pass (struct user_pass *up, const bool force) +{ + const bool nocache = up->nocache; + if (nocache || force) + { + CLEAR (*up); + up->nocache = nocache; + } +} + +/* + * Process string received by untrusted peer before + * printing to console or log file. + * + * Assumes that string has been null terminated. + */ +const char * +safe_print (const char *str, struct gc_arena *gc) +{ + return string_mod_const (str, CC_PRINT, CC_CRLF, '.', gc); +} + +/* Make arrays of strings */ + +const char ** +make_env_array (const struct env_set *es, struct gc_arena *gc) +{ + char **ret = NULL; + struct env_item *e = NULL; + int i = 0, n = 0; + + /* figure length of es */ + if (es) + { + for (e = es->list; e != NULL; e = e->next) + ++n; + } + + /* alloc return array */ + ALLOC_ARRAY_CLEAR_GC (ret, char *, n+1, gc); + + /* fill return array */ + if (es) + { + e = es->list; + for (i = 0; i < n; ++i) + { + ASSERT (e); + ret[i] = e->string; + e = e->next; + } + } + + ret[i] = NULL; + return (const char **)ret; +} + +const char ** +make_arg_array (const char *first, const char *parms, struct gc_arena *gc) +{ + char **ret = NULL; + int base = 0; + const int max_parms = MAX_PARMS + 2; + int n = 0; + + /* alloc return array */ + ALLOC_ARRAY_CLEAR_GC (ret, char *, max_parms, gc); + + /* process first parameter, if provided */ + if (first) + { + ret[base++] = string_alloc (first, gc); + } + + if (parms) + { + n = parse_line (parms, &ret[base], max_parms - base - 1, "make_arg_array", 0, M_WARN, gc); + ASSERT (n >= 0 && n + base + 1 <= max_parms); + } + ret[base + n] = NULL; + + return (const char **)ret; +} + +void +openvpn_sleep (const int n) +{ +#ifdef ENABLE_MANAGEMENT + if (management) + { + management_event_loop_n_seconds (management, n); + return; + } +#endif + sleep (n); +} @@ -0,0 +1,256 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MISC_H +#define MISC_H + +#include "basic.h" +#include "common.h" +#include "integer.h" +#include "buffer.h" + +/* socket descriptor passed by inetd/xinetd server to us */ +#define INETD_SOCKET_DESCRIPTOR 0 + +/* forward declarations */ +struct plugin_list; + +/* + * Handle environmental variable lists + */ + +struct env_item { + char *string; + struct env_item *next; +}; + +struct env_set { + struct gc_arena *gc; + struct env_item *list; +}; + +/* Get/Set UID of process */ + +struct user_state { +#if defined(HAVE_GETPWNAM) && defined(HAVE_SETUID) + const char *username; + struct passwd *pw; +#else + int dummy; +#endif +}; + +bool get_user (const char *username, struct user_state *state); +void set_user (const struct user_state *state); + +/* Get/Set GID of process */ + +struct group_state { +#if defined(HAVE_GETGRNAM) && defined(HAVE_SETGID) + const char *groupname; + struct group *gr; +#else + int dummy; +#endif +}; + +bool get_group (const char *groupname, struct group_state *state); +void set_group (const struct group_state *state); + +void set_nice (int niceval); +void do_chroot (const char *path); + +void run_up_down (const char *command, + const struct plugin_list *plugins, + int plugin_type, + const char *arg, + int tun_mtu, + int link_mtu, + const char *ifconfig_local, + const char* ifconfig_remote, + const char *context, + const char *signal_text, + const char *script_type, + struct env_set *es); + +/* workspace for get_pid_file/write_pid */ +struct pid_state { + FILE *fp; + const char *filename; +}; + +void get_pid_file (const char* filename, struct pid_state *state); +void write_pid (const struct pid_state *state); +unsigned int openvpn_getpid (void); + +void do_mlockall (bool print_msg); /* Disable paging */ + +#ifndef HAVE_DAEMON +int daemon (int nochdir, int noclose); +#endif + +/* check file protections */ +void warn_if_group_others_accessible(const char* filename); + +/* system flags */ +#define S_SCRIPT (1<<0) +#define S_FATAL (1<<1) + +/* wrapper around the system() call. */ +int openvpn_system (const char *command, const struct env_set *es, unsigned int flags); + +/* interpret the status code returned by system() */ +bool system_ok(int); +int system_executed (int stat); +const char *system_error_message (int, struct gc_arena *gc); + +/* run system() with error check, return true if success, + false if error, exit if error and fatal==true */ +bool system_check (const char *command, const struct env_set *es, unsigned int flags, const char *error_message); + +#ifdef HAVE_STRERROR +/* a thread-safe version of strerror */ +const char* strerror_ts (int errnum, struct gc_arena *gc); +#endif + +/* Set standard file descriptors to /dev/null */ +void set_std_files_to_null (bool stdin_only); + +/* Wrapper for chdir library function */ +int openvpn_chdir (const char* dir); + +/* dup inetd/xinetd socket descriptor and save */ +extern int inetd_socket_descriptor; +void save_inetd_socket_descriptor (void); + +/* init random() function, only used as source for weak random numbers, when !USE_CRYPTO */ +void init_random_seed(void); + +/* set/delete environmental variable */ +void setenv_str_ex (struct env_set *es, + const char *name, + const char *value, + const unsigned int name_include, + const unsigned int name_exclude, + const char name_replace, + const unsigned int value_include, + const unsigned int value_exclude, + const char value_replace); + +void setenv_int (struct env_set *es, const char *name, int value); +void setenv_str (struct env_set *es, const char *name, const char *value); +void setenv_del (struct env_set *es, const char *name); + +/* struct env_set functions */ + +struct env_set *env_set_create (struct gc_arena *gc); +bool env_set_del (struct env_set *es, const char *str); +void env_set_add (struct env_set *es, const char *str); + +void env_set_print (int msglevel, const struct env_set *es); + +void env_set_inherit (struct env_set *es, const struct env_set *src); + +void env_set_add_to_environment (const struct env_set *es); +void env_set_remove_from_environment (const struct env_set *es); + +/* Make arrays of strings */ + +const char **make_env_array (const struct env_set *es, struct gc_arena *gc); +const char **make_arg_array (const char *first, const char *parms, struct gc_arena *gc); + +/* convert netmasks for iproute2 */ +int count_netmask_bits(const char *); +unsigned int count_bits(unsigned int ); + +/* go to sleep for n milliseconds */ +void sleep_milliseconds (unsigned int n); + +/* go to sleep indefinitely */ +void sleep_until_signal (void); + +/* an analogue to the random() function, but use OpenSSL functions if available */ +#ifdef USE_CRYPTO +long int get_random(void); +#else +#define get_random random +#endif + +/* return true if filename can be opened for read */ +bool test_file (const char *filename); + +/* create a temporary filename in directory */ +const char *create_temp_filename (const char *directory, struct gc_arena *gc); + +/* put a directory and filename together */ +const char *gen_path (const char *directory, const char *filename, struct gc_arena *gc); + +/* delete a file, return true if succeeded */ +bool delete_file (const char *filename); + +/* return the next largest power of 2 */ +unsigned int adjust_power_of_2 (unsigned int u); + +/* + * Get and store a username/password + */ + +struct user_pass +{ + bool defined; + bool nocache; + +/* max length of username/password */ +# define USER_PASS_LEN 128 + char username[USER_PASS_LEN]; + char password[USER_PASS_LEN]; +}; + +bool get_console_input (const char *prompt, const bool echo, char *input, const int capacity); + +#define GET_USER_PASS_MANAGEMENT (1<<0) +#define GET_USER_PASS_SENSITIVE (1<<1) + +void get_user_pass (struct user_pass *up, + const char *auth_file, + const bool password_only, + const char *prefix, + const unsigned int flags); + +void purge_user_pass (struct user_pass *up, const bool force); + +/* + * Process string received by untrusted peer before + * printing to console or log file. + * Assumes that string has been null terminated. + */ +const char *safe_print (const char *str, struct gc_arena *gc); + +/* + * A sleep function that services the management layer for n + * seconds rather than doing nothing. + */ +void openvpn_sleep (const int n); + +#endif diff --git a/mroute.c b/mroute.c new file mode 100644 index 0000000..0a7bcf6 --- /dev/null +++ b/mroute.c @@ -0,0 +1,365 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP_SERVER + +#include "mroute.h" +#include "proto.h" +#include "error.h" +#include "socket.h" + +#include "memdbg.h" + +void +mroute_addr_init (struct mroute_addr *addr) +{ + CLEAR (*addr); +} + +/* + * Ethernet multicast addresses. + */ + +static inline bool +is_mac_mcast_addr (const uint8_t *mac) +{ + return (bool) mac[0] & 1; +} + +static inline bool +is_mac_mcast_maddr (const struct mroute_addr *addr) +{ + return (addr->type & MR_ADDR_MASK) == MR_ADDR_ETHER && is_mac_mcast_addr (addr->addr); +} + +/* + * Don't learn certain addresses. + */ +bool +mroute_learnable_address (const struct mroute_addr *addr) +{ + int i; + bool not_all_zeros = false; + bool not_all_ones = false; + + for (i = 0; i < addr->len; ++i) + { + int b = addr->addr[i]; + if (b != 0x00) + not_all_zeros = true; + if (b != 0xFF) + not_all_ones = true; + } + return not_all_zeros && not_all_ones && !is_mac_mcast_maddr (addr); +} + +/* + * Given a raw packet in buf, return the src and dest + * addresses of the packet. + */ +unsigned int +mroute_extract_addr_from_packet (struct mroute_addr *src, + struct mroute_addr *dest, + struct buffer *buf, + int tunnel_type) +{ + unsigned int ret = 0; + verify_align_4 (buf); + if (tunnel_type == DEV_TYPE_TUN) + { + if (BLEN (buf) >= 1) + { + switch (OPENVPN_IPH_GET_VER (*BPTR(buf))) + { + case 4: + if (BLEN (buf) >= (int) sizeof (struct openvpn_iphdr)) + { + const struct openvpn_iphdr *ip = (const struct openvpn_iphdr *) BPTR (buf); + if (src) + { + src->type = MR_ADDR_IPV4; + src->netbits = 0; + src->len = 4; + memcpy (src->addr, &ip->saddr, 4); + } + if (dest) + { + dest->type = MR_ADDR_IPV4; + dest->netbits = 0; + dest->len = 4; + memcpy (dest->addr, &ip->daddr, 4); + + /* mcast address? */ + if ((ip->daddr & htonl(IP_MCAST_SUBNET_MASK)) == htonl(IP_MCAST_NETWORK)) + ret |= MROUTE_EXTRACT_MCAST; + + /* IGMP message? */ + if (ip->protocol == OPENVPN_IPPROTO_IGMP) + ret |= MROUTE_EXTRACT_IGMP; + } + ret |= MROUTE_EXTRACT_SUCCEEDED; + } + break; + case 6: + { + msg (M_WARN, "Need IPv6 code in mroute_extract_addr_from_packet"); + break; + } + } + } + } + else if (tunnel_type == DEV_TYPE_TAP) + { + if (BLEN (buf) >= (int) sizeof (struct openvpn_ethhdr)) + { + const struct openvpn_ethhdr *eth = (const struct openvpn_ethhdr *) BPTR (buf); + if (src) + { + src->type = MR_ADDR_ETHER; + src->netbits = 0; + src->len = 6; + memcpy (src->addr, eth->source, 6); + } + if (dest) + { + dest->type = MR_ADDR_ETHER; + dest->netbits = 0; + dest->len = 6; + memcpy (dest->addr, eth->dest, 6); + + /* ethernet broadcast/multicast packet? */ + if (is_mac_mcast_addr (eth->dest)) + ret |= MROUTE_EXTRACT_BCAST; + } + + ret |= MROUTE_EXTRACT_SUCCEEDED; + } + } + return ret; +} + +/* + * Translate a struct sockaddr_in (saddr) + * to a struct mroute_addr (addr). + */ +bool +mroute_extract_sockaddr_in (struct mroute_addr *addr, const struct sockaddr_in *saddr, bool use_port) +{ + if (saddr->sin_family == AF_INET) + { + if (use_port) + { + addr->type = MR_ADDR_IPV4 | MR_WITH_PORT; + addr->netbits = 0; + addr->len = 6; + memcpy (addr->addr, &saddr->sin_addr.s_addr, 4); + memcpy (addr->addr + 4, &saddr->sin_port, 2); + } + else + { + addr->type = MR_ADDR_IPV4; + addr->netbits = 0; + addr->len = 4; + memcpy (addr->addr, &saddr->sin_addr.s_addr, 4); + } + return true; + } + return false; +} + +/* + * Zero off the host bits in an address, leaving + * only the network bits, using the netbits member of + * struct mroute_addr as the controlling parameter. + */ +void +mroute_addr_mask_host_bits (struct mroute_addr *ma) +{ + in_addr_t addr = ntohl(*(in_addr_t*)ma->addr); + ASSERT ((ma->type & MR_ADDR_MASK) == MR_ADDR_IPV4); + addr &= netbits_to_netmask (ma->netbits); + *(in_addr_t*)ma->addr = htonl (addr); +} + +/* + * The mroute_addr hash function takes into account the + * address type, number of bits in the network address, + * and the actual address. + */ +uint32_t +mroute_addr_hash_function (const void *key, uint32_t iv) +{ + return hash_func (mroute_addr_hash_ptr ((const struct mroute_addr *) key), + mroute_addr_hash_len ((const struct mroute_addr *) key), + iv); +} + +bool +mroute_addr_compare_function (const void *key1, const void *key2) +{ + return mroute_addr_equal ((const struct mroute_addr *) key1, + (const struct mroute_addr *) key2); +} + +const char * +mroute_addr_print (const struct mroute_addr *ma, + struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + if (ma) + { + struct mroute_addr maddr = *ma; + + switch (maddr.type & MR_ADDR_MASK) + { + case MR_ADDR_ETHER: + buf_printf (&out, "%s", format_hex_ex (ma->addr, 6, 0, 1, ":", gc)); + break; + case MR_ADDR_IPV4: + { + struct buffer buf; + in_addr_t addr; + int port; + bool status; + buf_set_read (&buf, maddr.addr, maddr.len); + addr = buf_read_u32 (&buf, &status); + if (status) + { + buf_printf (&out, "%s", print_in_addr_t (addr, IA_EMPTY_IF_UNDEF, gc)); + if (maddr.type & MR_WITH_NETBITS) + buf_printf (&out, "/%d", maddr.netbits); + } + if (maddr.type & MR_WITH_PORT) + { + port = buf_read_u16 (&buf); + if (port >= 0) + buf_printf (&out, ":%d", port); + } + } + break; + case MR_ADDR_IPV6: + buf_printf (&out, "IPV6"); + break; + default: + buf_printf (&out, "UNKNOWN"); + break; + } + return BSTR (&out); + } + else + return "[NULL]"; +} + +/* + * mroute_helper's main job is keeping track of + * currently used CIDR netlengths, so we don't + * have to cycle through all 33. + */ + +struct mroute_helper * +mroute_helper_init (int ageable_ttl_secs) +{ + struct mroute_helper *mh; + ALLOC_OBJ_CLEAR (mh, struct mroute_helper); + /*mutex_init (&mh->mutex);*/ + mh->ageable_ttl_secs = ageable_ttl_secs; + return mh; +} + +static void +mroute_helper_regenerate (struct mroute_helper *mh) +{ + int i, j = 0; + for (i = MR_HELPER_NET_LEN - 1; i >= 0; --i) + { + if (mh->net_len_refcount[i] > 0) + mh->net_len[j++] = (uint8_t) i; + } + mh->n_net_len = j; + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_MULTI_DEBUG)) + { + struct gc_arena gc = gc_new (); + struct buffer out = alloc_buf_gc (256, &gc); + buf_printf (&out, "MROUTE CIDR netlen:"); + for (i = 0; i < mh->n_net_len; ++i) + { + buf_printf (&out, " /%d", mh->net_len[i]); + } + dmsg (D_MULTI_DEBUG, "%s", BSTR (&out)); + gc_free (&gc); + } +#endif +} + +void +mroute_helper_add_iroute (struct mroute_helper *mh, const struct iroute *ir) +{ + if (ir->netbits >= 0) + { + ASSERT (ir->netbits < MR_HELPER_NET_LEN); + mroute_helper_lock (mh); + ++mh->cache_generation; + ++mh->net_len_refcount[ir->netbits]; + if (mh->net_len_refcount[ir->netbits] == 1) + mroute_helper_regenerate (mh); + mroute_helper_unlock (mh); + } +} + +void +mroute_helper_del_iroute (struct mroute_helper *mh, const struct iroute *ir) +{ + if (ir->netbits >= 0) + { + ASSERT (ir->netbits < MR_HELPER_NET_LEN); + mroute_helper_lock (mh); + ++mh->cache_generation; + --mh->net_len_refcount[ir->netbits]; + ASSERT (mh->net_len_refcount[ir->netbits] >= 0); + if (!mh->net_len_refcount[ir->netbits]) + mroute_helper_regenerate (mh); + mroute_helper_unlock (mh); + } +} + +void +mroute_helper_free (struct mroute_helper *mh) +{ + /*mutex_destroy (&mh->mutex);*/ + free (mh); +} + +#else +static void dummy(void) {} +#endif /* P2MP_SERVER */ diff --git a/mroute.h b/mroute.h new file mode 100644 index 0000000..87e952c --- /dev/null +++ b/mroute.h @@ -0,0 +1,165 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MROUTE_H +#define MROUTE_H + +#if P2MP_SERVER + +#include "buffer.h" +#include "list.h" +#include "route.h" + +#define IP_MCAST_SUBNET_MASK ((in_addr_t)240<<24) +#define IP_MCAST_NETWORK ((in_addr_t)224<<24) + +/* Return status values for mroute_extract_addr_from_packet */ +#define MROUTE_EXTRACT_SUCCEEDED (1<<1) +#define MROUTE_EXTRACT_BCAST (1<<2) +#define MROUTE_EXTRACT_MCAST (1<<3) +#define MROUTE_EXTRACT_IGMP (1<<4) + +/* + * Choose the largest address possible with + * any of our supported types, which is IPv6 + * with port number. + */ +#define MR_MAX_ADDR_LEN 20 + +/* + * Address Types + */ +#define MR_ADDR_NONE 0 +#define MR_ADDR_ETHER 1 +#define MR_ADDR_IPV4 2 +#define MR_ADDR_IPV6 3 +#define MR_ADDR_MASK 3 + +/* Address type mask indicating that port # is part of address */ +#define MR_WITH_PORT 4 + +/* Address type mask indicating that netbits is part of address */ +#define MR_WITH_NETBITS 8 + +struct mroute_addr { + uint8_t len; /* length of address */ + uint8_t unused; + uint8_t type; /* MR_ADDR/MR_WITH flags */ + uint8_t netbits; /* number of bits in network part of address, + valid if MR_WITH_NETBITS is set */ + uint8_t addr[MR_MAX_ADDR_LEN]; /* actual address */ +}; + +/* + * Number of bits in an address. Should be raised for + * IPv6. + */ +#define MR_HELPER_NET_LEN 32 + +/* + * Used to help maintain CIDR routing table. + */ +struct mroute_helper { + /*MUTEX_DEFINE (mutex);*/ + unsigned int cache_generation; /* incremented when route added */ + int ageable_ttl_secs; /* host route cache entry time-to-live*/ + int n_net_len; /* length of net_len array */ + uint8_t net_len[MR_HELPER_NET_LEN]; /* CIDR netlengths in descending order */ + int net_len_refcount[MR_HELPER_NET_LEN]; /* refcount of each netlength */ +}; + +unsigned int mroute_extract_addr_from_packet (struct mroute_addr *src, + struct mroute_addr *dest, + struct buffer *buf, + int tunnel_type); + +bool mroute_extract_sockaddr_in (struct mroute_addr *addr, + const struct sockaddr_in *saddr, + bool use_port); + +bool mroute_learnable_address (const struct mroute_addr *addr); + +uint32_t mroute_addr_hash_function (const void *key, uint32_t iv); +bool mroute_addr_compare_function (const void *key1, const void *key2); + +void mroute_addr_init (struct mroute_addr *addr); + +const char *mroute_addr_print (const struct mroute_addr *ma, + struct gc_arena *gc); + +void mroute_addr_mask_host_bits (struct mroute_addr *ma); + +struct mroute_helper *mroute_helper_init (int ageable_ttl_secs); +void mroute_helper_free (struct mroute_helper *mh); +void mroute_helper_add_iroute (struct mroute_helper *mh, const struct iroute *ir); +void mroute_helper_del_iroute (struct mroute_helper *mh, const struct iroute *ir); + +static inline void +mroute_helper_lock (struct mroute_helper *mh) +{ + /*mutex_lock (&mh->mutex);*/ +} + +static inline void +mroute_helper_unlock (struct mroute_helper *mh) +{ + /*mutex_unlock (&mh->mutex);*/ +} + +static inline bool +mroute_addr_equal (const struct mroute_addr *a1, const struct mroute_addr *a2) +{ + if (a1->type != a2->type) + return false; + if (a1->netbits != a2->netbits) + return false; + if (a1->len != a2->len) + return false; + return memcmp (a1->addr, a2->addr, a1->len) == 0; +} + +static inline const uint8_t * +mroute_addr_hash_ptr (const struct mroute_addr *a) +{ + /* NOTE: depends on ordering of struct mroute_addr */ + return (uint8_t *) &a->type; +} + +static inline uint32_t +mroute_addr_hash_len (const struct mroute_addr *a) +{ + return (uint32_t) a->len + 2; +} + +static inline void +mroute_extract_in_addr_t (struct mroute_addr *dest, const in_addr_t src) +{ + dest->type = MR_ADDR_IPV4; + dest->netbits = 0; + dest->len = 4; + *(in_addr_t*)dest->addr = htonl (src); +} + +#endif /* P2MP_SERVER */ +#endif /* MROUTE_H */ @@ -0,0 +1,120 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" +#include "error.h" +#include "mss.h" +#include "memdbg.h" + +/* + * Lower MSS on TCP SYN packets to fix MTU + * problems which arise from protocol + * encapsulation. + */ +void +mss_fixup (struct buffer *buf, int maxmss) +{ + const struct openvpn_iphdr *pip; + int hlen; + + if (BLEN (buf) < (int) sizeof (struct openvpn_iphdr)) + return; + + verify_align_4 (buf); + pip = (struct openvpn_iphdr *) BPTR (buf); + + hlen = OPENVPN_IPH_GET_LEN (pip->version_len); + + if (pip->protocol == OPENVPN_IPPROTO_TCP + && ntohs (pip->tot_len) == BLEN (buf) + && (ntohs (pip->frag_off) & OPENVPN_IP_OFFMASK) == 0 + && hlen <= BLEN (buf) + && BLEN (buf) - hlen + >= (int) sizeof (struct openvpn_tcphdr)) + { + struct buffer newbuf = *buf; + if (buf_advance (&newbuf, hlen)) + { + struct openvpn_tcphdr *tc = (struct openvpn_tcphdr *) BPTR (&newbuf); + if (tc->flags & OPENVPN_TCPH_SYN_MASK) + mss_fixup_dowork (&newbuf, (uint16_t) maxmss); + } + } +} + +void +mss_fixup_dowork (struct buffer *buf, uint16_t maxmss) +{ + int hlen, olen, optlen; + uint8_t *opt; + uint16_t *mss; + int accumulate; + struct openvpn_tcphdr *tc; + + ASSERT (BLEN (buf) >= (int) sizeof (struct openvpn_tcphdr)); + + verify_align_4 (buf); + tc = (struct openvpn_tcphdr *) BPTR (buf); + hlen = OPENVPN_TCPH_GET_DOFF (tc->doff_res); + + /* Invalid header length or header without options. */ + if (hlen <= (int) sizeof (struct openvpn_tcphdr) + || hlen > BLEN (buf)) + return; + + for (olen = hlen - sizeof (struct openvpn_tcphdr), + opt = (uint8_t *)(tc + 1); + olen > 0; + olen -= optlen, opt += optlen) { + if (*opt == OPENVPN_TCPOPT_EOL) + break; + else if (*opt == OPENVPN_TCPOPT_NOP) + optlen = 1; + else { + optlen = *(opt + 1); + if (optlen <= 0 || optlen > olen) + break; + if (*opt == OPENVPN_TCPOPT_MAXSEG) { + if (optlen != OPENVPN_TCPOLEN_MAXSEG) + continue; + mss = (uint16_t *)(opt + 2); + if (ntohs (*mss) > maxmss) { + dmsg (D_MSS, "MSS: %d -> %d", + (int) ntohs (*mss), + (int) maxmss); + accumulate = *mss; + *mss = htons (maxmss); + accumulate -= *mss; + ADJUST_CHECKSUM (accumulate, tc->check); + } + } + } + } +} @@ -0,0 +1,34 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MSS_H +#define MSS_H + +#include "proto.h" +#include "error.h" + +void mss_fixup (struct buffer *buf, int maxmss); +void mss_fixup_dowork (struct buffer *buf, uint16_t maxmss); + +#endif @@ -0,0 +1,727 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP_SERVER + +#include "multi.h" +#include "forward-inline.h" + +#include "memdbg.h" + +/* + * TCP States + */ +#define TA_UNDEF 0 +#define TA_SOCKET_READ 1 +#define TA_SOCKET_READ_RESIDUAL 2 +#define TA_SOCKET_WRITE 3 +#define TA_SOCKET_WRITE_READY 4 +#define TA_SOCKET_WRITE_DEFERRED 5 +#define TA_TUN_READ 6 +#define TA_TUN_WRITE 7 +#define TA_INITIAL 8 +#define TA_TIMEOUT 9 +#define TA_TUN_WRITE_TIMEOUT 10 + +/* + * Special tags passed to event.[ch] functions + */ +#define MTCP_SOCKET ((void*)1) +#define MTCP_TUN ((void*)2) +#define MTCP_SIG ((void*)3) /* Only on Windows */ +#ifdef ENABLE_MANAGEMENT +# define MTCP_MANAGEMENT ((void*)4) +#endif + +#define MTCP_N ((void*)16) /* upper bound on MTCP_x */ + +struct ta_iow_flags +{ + unsigned int flags; + unsigned int ret; + unsigned int tun; + unsigned int sock; +}; + +static const char * +pract (int action) +{ + switch (action) + { + case TA_UNDEF: + return "TA_UNDEF"; + case TA_SOCKET_READ: + return "TA_SOCKET_READ"; + case TA_SOCKET_READ_RESIDUAL: + return "TA_SOCKET_READ_RESIDUAL"; + case TA_SOCKET_WRITE: + return "TA_SOCKET_WRITE"; + case TA_SOCKET_WRITE_READY: + return "TA_SOCKET_WRITE_READY"; + case TA_SOCKET_WRITE_DEFERRED: + return "TA_SOCKET_WRITE_DEFERRED"; + case TA_TUN_READ: + return "TA_TUN_READ"; + case TA_TUN_WRITE: + return "TA_TUN_WRITE"; + case TA_INITIAL: + return "TA_INITIAL"; + case TA_TIMEOUT: + return "TA_TIMEOUT"; + case TA_TUN_WRITE_TIMEOUT: + return "TA_TUN_WRITE_TIMEOUT"; + default: + return "?"; + } +} + +static struct multi_instance * +multi_create_instance_tcp (struct multi_context *m) +{ + struct gc_arena gc = gc_new (); + struct multi_instance *mi = NULL; + struct hash *hash = m->hash; + + mi = multi_create_instance (m, NULL); + if (mi) + { + struct hash_element *he; + const uint32_t hv = hash_value (hash, &mi->real); + struct hash_bucket *bucket = hash_bucket (hash, hv); + + hash_bucket_lock (bucket); + he = hash_lookup_fast (hash, bucket, &mi->real, hv); + + if (he) + { + struct multi_instance *oldmi = (struct multi_instance *) he->value; + msg (D_MULTI_LOW, "MULTI TCP: new incoming client address matches existing client address -- new client takes precedence"); + oldmi->did_real_hash = false; + multi_close_instance (m, oldmi, false); + he->key = &mi->real; + he->value = mi; + } + else + hash_add_fast (hash, bucket, &mi->real, hv, mi); + + mi->did_real_hash = true; + + hash_bucket_unlock (bucket); + } + +#ifdef ENABLE_DEBUG + if (mi) + dmsg (D_MULTI_DEBUG, "MULTI TCP: instance added: %s", mroute_addr_print (&mi->real, &gc)); + else + dmsg (D_MULTI_DEBUG, "MULTI TCP: new client instance failed"); +#endif + + gc_free (&gc); + ASSERT (!(mi && mi->halt)); + return mi; +} + +bool +multi_tcp_instance_specific_init (struct multi_context *m, struct multi_instance *mi) +{ + /* buffer for queued TCP socket output packets */ + mi->tcp_link_out_deferred = mbuf_init (m->top.options.n_bcast_buf); + + ASSERT (mi->context.c2.link_socket); + ASSERT (mi->context.c2.link_socket->info.lsa); + ASSERT (mi->context.c2.link_socket->mode == LS_MODE_TCP_ACCEPT_FROM); + if (!mroute_extract_sockaddr_in (&mi->real, &mi->context.c2.link_socket->info.lsa->actual, true)) + { + msg (D_MULTI_ERRORS, "MULTI TCP: TCP client address is undefined"); + return false; + } + return true; +} + +void +multi_tcp_instance_specific_free (struct multi_instance *mi) +{ + mbuf_free (mi->tcp_link_out_deferred); +} + +struct multi_tcp * +multi_tcp_init (int maxevents, int *maxclients) +{ + struct multi_tcp *mtcp; + const int extra_events = BASE_N_EVENTS; + + ASSERT (maxevents >= 1); + ASSERT (maxclients); + + ALLOC_OBJ_CLEAR (mtcp, struct multi_tcp); + mtcp->maxevents = maxevents + extra_events; + mtcp->es = event_set_init (&mtcp->maxevents, 0); + wait_signal (mtcp->es, MTCP_SIG); + ALLOC_ARRAY (mtcp->esr, struct event_set_return, mtcp->maxevents); + *maxclients = max_int (min_int (mtcp->maxevents - extra_events, *maxclients), 1); + msg (D_MULTI_LOW, "MULTI: TCP INIT maxclients=%d maxevents=%d", *maxclients, mtcp->maxevents); + return mtcp; +} + +void +multi_tcp_delete_event (struct multi_tcp *mtcp, event_t event) +{ + if (mtcp && mtcp->es) + event_del (mtcp->es, event); +} + +void +multi_tcp_free (struct multi_tcp *mtcp) +{ + if (mtcp) + { + event_free (mtcp->es); + if (mtcp->esr) + free (mtcp->esr); + free (mtcp); + } +} + +void +multi_tcp_dereference_instance (struct multi_tcp *mtcp, struct multi_instance *mi) +{ + struct link_socket *ls = mi->context.c2.link_socket; + if (ls && mi->socket_set_called) + event_del (mtcp->es, socket_event_handle (ls)); + mtcp->n_esr = 0; +} + +static inline void +multi_tcp_set_global_rw_flags (struct multi_context *m, struct multi_instance *mi) +{ + if (mi) + { + mi->socket_set_called = true; + socket_set (mi->context.c2.link_socket, + m->mtcp->es, + mbuf_defined (mi->tcp_link_out_deferred) ? EVENT_WRITE : EVENT_READ, + mi, + &mi->tcp_rwflags); + } +} + +static inline int +multi_tcp_wait (const struct context *c, + struct multi_tcp *mtcp) +{ + int status; + socket_set_listen_persistent (c->c2.link_socket, mtcp->es, MTCP_SOCKET); + tun_set (c->c1.tuntap, mtcp->es, EVENT_READ, MTCP_TUN, &mtcp->tun_rwflags); +#ifdef ENABLE_MANAGEMENT + if (management) + management_socket_set (management, mtcp->es, MTCP_MANAGEMENT, &mtcp->management_persist_flags); +#endif + status = event_wait (mtcp->es, &c->c2.timeval, mtcp->esr, mtcp->maxevents); + update_time (); + mtcp->n_esr = 0; + if (status > 0) + mtcp->n_esr = status; + return status; +} + +static inline struct context * +multi_tcp_context (struct multi_context *m, struct multi_instance *mi) +{ + if (mi) + return &mi->context; + else + return &m->top; +} + +static bool +multi_tcp_process_outgoing_link_ready (struct multi_context *m, struct multi_instance *mi, const unsigned int mpp_flags) +{ + struct mbuf_item item; + bool ret = true; + ASSERT (mi); + + /* extract from queue */ + if (mbuf_extract_item (mi->tcp_link_out_deferred, &item, true)) /* ciphertext IP packet */ + { + dmsg (D_MULTI_TCP, "MULTI TCP: transmitting previously deferred packet"); + + ASSERT (mi == item.instance); + mi->context.c2.to_link = item.buffer->buf; + ret = multi_process_outgoing_link_dowork (m, mi, mpp_flags); + if (!ret) + mi = NULL; + mbuf_free_buf (item.buffer); + } + return ret; +} + +static bool +multi_tcp_process_outgoing_link (struct multi_context *m, bool defer, const unsigned int mpp_flags) +{ + struct multi_instance *mi = multi_process_outgoing_link_pre (m); + bool ret = true; + + if (mi) + { + if (defer || mbuf_defined (mi->tcp_link_out_deferred)) + { + /* save to queue */ + struct buffer *buf = &mi->context.c2.to_link; + if (BLEN (buf) > 0) + { + struct mbuf_buffer *mb = mbuf_alloc_buf (buf); + struct mbuf_item item; + + set_prefix (mi); + dmsg (D_MULTI_TCP, "MULTI TCP: queuing deferred packet"); + item.buffer = mb; + item.instance = mi; + mbuf_add_item (mi->tcp_link_out_deferred, &item); + mbuf_free_buf (mb); + buf_reset (buf); + ret = multi_process_post (m, mi, mpp_flags); + if (!ret) + mi = NULL; + clear_prefix (); + } + } + else + { + ret = multi_process_outgoing_link_dowork (m, mi, mpp_flags); + if (!ret) + mi = NULL; + } + } + return ret; +} + +static int +multi_tcp_wait_lite (struct multi_context *m, struct multi_instance *mi, const int action, bool *tun_input_pending) +{ + struct context *c = multi_tcp_context (m, mi); + unsigned int looking_for = 0; + + dmsg (D_MULTI_DEBUG, "MULTI TCP: multi_tcp_wait_lite a=%s mi=" ptr_format, + pract(action), + (ptr_type)mi); + + tv_clear (&c->c2.timeval); /* ZERO-TIMEOUT */ + + switch (action) + { + case TA_TUN_READ: + looking_for = TUN_READ; + tun_input_pending = NULL; + io_wait (c, IOW_READ_TUN); + break; + case TA_SOCKET_READ: + looking_for = SOCKET_READ; + tun_input_pending = NULL; + io_wait (c, IOW_READ_LINK); + break; + case TA_TUN_WRITE: + looking_for = TUN_WRITE; + tun_input_pending = NULL; + c->c2.timeval.tv_sec = 1; /* For some reason, the Linux 2.2 TUN/TAP driver hits this timeout */ + perf_push (PERF_PROC_OUT_TUN_MTCP); + io_wait (c, IOW_TO_TUN); + perf_pop (); + break; + case TA_SOCKET_WRITE: + looking_for = SOCKET_WRITE; + io_wait (c, IOW_TO_LINK|IOW_READ_TUN_FORCE); + break; + default: + msg (M_FATAL, "MULTI TCP: multi_tcp_wait_lite, unhandled action=%d", action); + } + + if (tun_input_pending && (c->c2.event_set_status & TUN_READ)) + *tun_input_pending = true; + + if (c->c2.event_set_status & looking_for) + { + return action; + } + else + { + switch (action) + { + /* TCP socket output buffer is full */ + case TA_SOCKET_WRITE: + return TA_SOCKET_WRITE_DEFERRED; + + /* TUN device timed out on accepting write */ + case TA_TUN_WRITE: + return TA_TUN_WRITE_TIMEOUT; + } + + return TA_UNDEF; + } +} + +static struct multi_instance * +multi_tcp_dispatch (struct multi_context *m, struct multi_instance *mi, const int action) +{ + const unsigned int mpp_flags = MPP_PRE_SELECT|MPP_RECORD_TOUCH; + struct multi_instance *touched = mi; + m->mpp_touched = &touched; + + dmsg (D_MULTI_DEBUG, "MULTI TCP: multi_tcp_dispatch a=%s mi=" ptr_format, + pract(action), + (ptr_type)mi); + + switch (action) + { + case TA_TUN_READ: + read_incoming_tun (&m->top); + if (!IS_SIG (&m->top)) + multi_process_incoming_tun (m, mpp_flags); + break; + case TA_SOCKET_READ: + case TA_SOCKET_READ_RESIDUAL: + ASSERT (mi); + ASSERT (mi->context.c2.link_socket); + set_prefix (mi); + read_incoming_link (&mi->context); + clear_prefix (); + if (!IS_SIG (&mi->context)) + { + multi_process_incoming_link (m, mi, mpp_flags); + if (!IS_SIG (&mi->context)) + stream_buf_read_setup (mi->context.c2.link_socket); + } + break; + case TA_TIMEOUT: + multi_process_timeout (m, mpp_flags); + break; + case TA_TUN_WRITE: + multi_process_outgoing_tun (m, mpp_flags); + break; + case TA_TUN_WRITE_TIMEOUT: + multi_process_drop_outgoing_tun (m, mpp_flags); + break; + case TA_SOCKET_WRITE_READY: + ASSERT (mi); + multi_tcp_process_outgoing_link_ready (m, mi, mpp_flags); + break; + case TA_SOCKET_WRITE: + multi_tcp_process_outgoing_link (m, false, mpp_flags); + break; + case TA_SOCKET_WRITE_DEFERRED: + multi_tcp_process_outgoing_link (m, true, mpp_flags); + break; + case TA_INITIAL: + ASSERT (mi); + multi_tcp_set_global_rw_flags (m, mi); + multi_process_post (m, mi, mpp_flags); + break; + default: + msg (M_FATAL, "MULTI TCP: multi_tcp_dispatch, unhandled action=%d", action); + } + + m->mpp_touched = NULL; + return touched; +} + +int +multi_tcp_post (struct multi_context *m, struct multi_instance *mi, const int action) +{ + struct context *c = multi_tcp_context (m, mi); + int newaction = TA_UNDEF; + +# define MTP_NONE 0 +# define MTP_TUN_OUT (1<<0) +# define MTP_LINK_OUT (1<<1) + unsigned int flags = MTP_NONE; + + if (TUN_OUT(c)) + flags |= MTP_TUN_OUT; + if (LINK_OUT(c)) + flags |= MTP_LINK_OUT; + + switch (flags) + { + case MTP_TUN_OUT|MTP_LINK_OUT: + case MTP_TUN_OUT: + newaction = TA_TUN_WRITE; + break; + case MTP_LINK_OUT: + newaction = TA_SOCKET_WRITE; + break; + case MTP_NONE: + if (mi && socket_read_residual (c->c2.link_socket)) + newaction = TA_SOCKET_READ_RESIDUAL; + else + multi_tcp_set_global_rw_flags (m, mi); + break; + default: + { + struct gc_arena gc = gc_new (); + msg (M_FATAL, "MULTI TCP: multi_tcp_post bad state, mi=%s flags=%d", + multi_instance_string (mi, false, &gc), + flags); + gc_free (&gc); + break; + } + } + + dmsg (D_MULTI_DEBUG, "MULTI TCP: multi_tcp_post %s -> %s", + pract(action), + pract(newaction)); + + return newaction; +} + +static void +multi_tcp_action (struct multi_context *m, struct multi_instance *mi, int action, bool poll) +{ + bool tun_input_pending = false; + + do { + dmsg (D_MULTI_DEBUG, "MULTI TCP: multi_tcp_action a=%s p=%d", + pract(action), + poll); + + /* + * If TA_SOCKET_READ_RESIDUAL, it means we still have pending + * input packets which were read by a prior TCP recv. + * + * Otherwise do a "lite" wait, which means we wait with 0 timeout + * on I/O events only related to the current instance, not + * the big list of events. + * + * On our first pass, poll will be false because we already know + * that input is available, and to call io_wait would be redundant. + */ + if (poll && action != TA_SOCKET_READ_RESIDUAL) + { + const int orig_action = action; + action = multi_tcp_wait_lite (m, mi, action, &tun_input_pending); + if (action == TA_UNDEF) + msg (M_FATAL, "MULTI TCP: I/O wait required blocking in multi_tcp_action, action=%d", orig_action); + } + + /* + * Dispatch the action + */ + { + struct multi_instance *touched = multi_tcp_dispatch (m, mi, action); + + /* + * Signal received or TCP connection + * reset by peer? + */ + if (touched && IS_SIG (&touched->context)) + { + if (mi == touched) + mi = NULL; + multi_close_instance_on_signal (m, touched); + } + } + + /* + * If dispatch produced any pending output + * for a particular instance, point to + * that instance. + */ + if (m->pending) + mi = m->pending; + + /* + * Based on the effects of the action, + * such as generating pending output, + * possibly transition to a new action state. + */ + action = multi_tcp_post (m, mi, action); + + /* + * If we are finished processing the original action, + * check if we have any TUN input. If so, transition + * our action state to processing this input. + */ + if (tun_input_pending && action == TA_UNDEF) + { + action = TA_TUN_READ; + mi = NULL; + tun_input_pending = false; + poll = false; + } + else + poll = true; + + } while (action != TA_UNDEF); +} + +static void +multi_tcp_process_io (struct multi_context *m) +{ + struct multi_tcp *mtcp = m->mtcp; + int i; + + for (i = 0; i < mtcp->n_esr; ++i) + { + struct event_set_return *e = &mtcp->esr[i]; + + /* incoming data for instance? */ + if (e->arg >= MTCP_N) + { + struct multi_instance *mi = (struct multi_instance *) e->arg; + if (mi) + { + if (e->rwflags & EVENT_WRITE) + multi_tcp_action (m, mi, TA_SOCKET_WRITE_READY, false); + else if (e->rwflags & EVENT_READ) + multi_tcp_action (m, mi, TA_SOCKET_READ, false); + } + } + else + { +#ifdef ENABLE_MANAGEMENT + if (e->arg == MTCP_MANAGEMENT) + { + ASSERT (management); + management_io (management); + } + else +#endif + /* incoming data on TUN? */ + if (e->arg == MTCP_TUN) + { + if (e->rwflags & EVENT_WRITE) + multi_tcp_action (m, NULL, TA_TUN_WRITE, false); + else if (e->rwflags & EVENT_READ) + multi_tcp_action (m, NULL, TA_TUN_READ, false); + } + /* new incoming TCP client attempting to connect? */ + else if (e->arg == MTCP_SOCKET) + { + struct multi_instance *mi; + ASSERT (m->top.c2.link_socket); + socket_reset_listen_persistent (m->top.c2.link_socket); + mi = multi_create_instance_tcp (m); + if (mi) + multi_tcp_action (m, mi, TA_INITIAL, false); + } + /* signal received? */ + else if (e->arg == MTCP_SIG) + { + get_signal (&m->top.sig->signal_received); + } + } + if (IS_SIG (&m->top)) + break; + } + mtcp->n_esr = 0; + + /* + * Process queued mbuf packets destined for TCP socket + */ + { + struct multi_instance *mi; + while (!IS_SIG (&m->top) && (mi = mbuf_peek (m->mbuf)) != NULL) + { + multi_tcp_action (m, mi, TA_SOCKET_WRITE, true); + } + } +} + +/* + * Top level event loop for single-threaded operation. + * TCP mode. + */ +void +tunnel_server_tcp (struct context *top) +{ + struct multi_context multi; + int status; + + top->mode = CM_TOP; + context_clear_2 (top); + + /* initialize top-tunnel instance */ + init_instance_handle_signals (top, top->es, CC_HARD_USR1_TO_HUP); + if (IS_SIG (top)) + return; + + /* initialize global multi_context object */ + multi_init (&multi, top, true, MC_SINGLE_THREADED); + + /* initialize our cloned top object */ + multi_top_init (&multi, top, true); + + /* initialize management interface */ + init_management_callback_multi (&multi); + + /* finished with initialization */ + initialization_sequence_completed (top, ISC_SERVER); /* --mode server --proto tcp-server */ + + /* per-packet event loop */ + while (true) + { + perf_push (PERF_EVENT_LOOP); + + /* wait on tun/socket list */ + multi_get_timeout (&multi, &multi.top.c2.timeval); + status = multi_tcp_wait (&multi.top, multi.mtcp); + MULTI_CHECK_SIG (&multi); + + /* check on status of coarse timers */ + multi_process_per_second_timers (&multi); + + /* timeout? */ + if (status > 0) + { + /* process the I/O which triggered select */ + multi_tcp_process_io (&multi); + MULTI_CHECK_SIG (&multi); + } + else if (status == 0) + { + multi_tcp_action (&multi, NULL, TA_TIMEOUT, false); + } + + perf_pop (); + } + + /* shut down management interface */ + uninit_management_callback_multi (&multi); + + /* save ifconfig-pool */ + multi_ifconfig_pool_persist (&multi, true); + + /* tear down tunnel instance (unless --persist-tun) */ + multi_uninit (&multi); + multi_top_free (&multi); + close_instance (top); +} + +#endif @@ -0,0 +1,68 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * TCP specific code for --mode server + */ + +#ifndef MTCP_H +#define MTCP_H + +#if P2MP_SERVER + +#include "event.h" + +/* + * Extra state info needed for TCP mode + */ +struct multi_tcp +{ + struct event_set *es; + struct event_set_return *esr; + int n_esr; + int maxevents; + unsigned int tun_rwflags; +#ifdef ENABLE_MANAGEMENT + unsigned int management_persist_flags; +#endif +}; + +struct multi_instance; +struct context; + +struct multi_tcp *multi_tcp_init (int maxevents, int *maxclients); +void multi_tcp_free (struct multi_tcp *mtcp); +void multi_tcp_dereference_instance (struct multi_tcp *mtcp, struct multi_instance *mi); + +bool multi_tcp_instance_specific_init (struct multi_context *m, struct multi_instance *mi); +void multi_tcp_instance_specific_free (struct multi_instance *mi); + +void multi_tcp_link_out_deferred (struct multi_context *m, struct multi_instance *mi); + +void tunnel_server_tcp (struct context *top); + +void multi_tcp_delete_event (struct multi_tcp *mtcp, event_t event); + +#endif +#endif @@ -0,0 +1,303 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "common.h" +#include "buffer.h" +#include "error.h" +#include "integer.h" +#include "mtu.h" + +#include "memdbg.h" + +/* allocate a buffer for socket or tun layer */ +void +alloc_buf_sock_tun (struct buffer *buf, + const struct frame *frame, + const bool tuntap_buffer, + const unsigned int align_mask) +{ + /* allocate buffer for overlapped I/O */ + *buf = alloc_buf (BUF_SIZE (frame)); + ASSERT (buf_init (buf, FRAME_HEADROOM_ADJ (frame, align_mask))); + buf->len = tuntap_buffer ? MAX_RW_SIZE_TUN (frame) : MAX_RW_SIZE_LINK (frame); + ASSERT (buf_safe (buf, 0)); +} + +void +frame_finalize (struct frame *frame, + bool link_mtu_defined, + int link_mtu, + bool tun_mtu_defined, + int tun_mtu) +{ + /* Set link_mtu based on command line options */ + if (tun_mtu_defined) + { + ASSERT (!link_mtu_defined); + frame->link_mtu = tun_mtu + TUN_LINK_DELTA (frame); + } + else + { + ASSERT (link_mtu_defined); + frame->link_mtu = link_mtu; + } + + if (TUN_MTU_SIZE (frame) < TUN_MTU_MIN) + { + msg (M_WARN, "TUN MTU value (%d) must be at least %d", TUN_MTU_SIZE (frame), TUN_MTU_MIN); + frame_print (frame, M_FATAL, "MTU is too small"); + } + + frame->link_mtu_dynamic = frame->link_mtu; + + frame->extra_buffer += PAYLOAD_ALIGN; +} + +/* + * Set the tun MTU dynamically. + */ +void +frame_set_mtu_dynamic (struct frame *frame, int mtu, unsigned int flags) +{ + +#ifdef ENABLE_DEBUG + const int orig_mtu = mtu; + const int orig_link_mtu_dynamic = frame->link_mtu_dynamic; +#endif + + ASSERT (mtu >= 0); + + if (flags & SET_MTU_TUN) + mtu += TUN_LINK_DELTA (frame); + + if (!(flags & SET_MTU_UPPER_BOUND) || mtu < frame->link_mtu_dynamic) + { + frame->link_mtu_dynamic = constrain_int ( + mtu, + EXPANDED_SIZE_MIN (frame), + EXPANDED_SIZE (frame)); + } + + dmsg (D_MTU_DEBUG, "MTU DYNAMIC mtu=%d, flags=%u, %d -> %d", + orig_mtu, + flags, + orig_link_mtu_dynamic, + frame->link_mtu_dynamic); +} + +/* + * Move extra_frame octets into extra_tun. Used by fragmenting code + * to adjust frame relative to its position in the buffer processing + * queue. + */ +void +frame_subtract_extra (struct frame *frame, const struct frame *src) +{ + frame->extra_frame -= src->extra_frame; + frame->extra_tun += src->extra_frame; +} + +void +frame_print (const struct frame *frame, + int level, + const char *prefix) +{ + struct gc_arena gc = gc_new (); + struct buffer out = alloc_buf_gc (256, &gc); + if (prefix) + buf_printf (&out, "%s ", prefix); + buf_printf (&out, "["); + buf_printf (&out, " L:%d", frame->link_mtu); + buf_printf (&out, " D:%d", frame->link_mtu_dynamic); + buf_printf (&out, " EF:%d", frame->extra_frame); + buf_printf (&out, " EB:%d", frame->extra_buffer); + buf_printf (&out, " ET:%d", frame->extra_tun); + buf_printf (&out, " EL:%d", frame->extra_link); + if (frame->align_flags && frame->align_adjust) + buf_printf (&out, " AF:%u/%d", frame->align_flags, frame->align_adjust); + buf_printf (&out, " ]"); + + msg (level, "%s", out.data); + gc_free (&gc); +} + +#define MTUDISC_NOT_SUPPORTED_MSG "--mtu-disc is not supported on this OS" + +void +set_mtu_discover_type (int sd, int mtu_type) +{ + if (mtu_type >= 0) + { +#if defined(HAVE_SETSOCKOPT) && defined(SOL_IP) && defined(IP_MTU_DISCOVER) + if (setsockopt + (sd, SOL_IP, IP_MTU_DISCOVER, &mtu_type, sizeof (mtu_type))) + msg (M_ERR, "Error setting IP_MTU_DISCOVER type=%d on TCP/UDP socket", + mtu_type); +#else + msg (M_FATAL, MTUDISC_NOT_SUPPORTED_MSG); +#endif + } +} + +int +translate_mtu_discover_type_name (const char *name) +{ +#if defined(IP_PMTUDISC_DONT) && defined(IP_PMTUDISC_WANT) && defined(IP_PMTUDISC_DO) + if (!strcmp (name, "yes")) + return IP_PMTUDISC_DO; + if (!strcmp (name, "maybe")) + return IP_PMTUDISC_WANT; + if (!strcmp (name, "no")) + return IP_PMTUDISC_DONT; + msg (M_FATAL, + "invalid --mtu-disc type: '%s' -- valid types are 'yes', 'maybe', or 'no'", + name); +#else + msg (M_FATAL, MTUDISC_NOT_SUPPORTED_MSG); +#endif + return -1; /* NOTREACHED */ +} + +#if EXTENDED_SOCKET_ERROR_CAPABILITY + +/* + * + * The following code is adapted from tracepath + * under the terms of the GPL. + * Copyright (C) Alexey Kuznetsov, <kuznet@ms2.inr.ac.ru>. + */ + +struct probehdr +{ + uint32_t ttl; + struct timeval tv; +}; + +const char * +format_extended_socket_error (int fd, int *mtu, struct gc_arena *gc) +{ + int res; + struct probehdr rcvbuf; + struct iovec iov; + struct msghdr msg; + struct cmsghdr *cmsg; + struct sock_extended_err *e; + struct sockaddr_in addr; + struct buffer out = alloc_buf_gc (256, gc); + char *cbuf = (char *) gc_malloc (256, false, gc); + + *mtu = 0; + + while (true) + { + memset (&rcvbuf, -1, sizeof (rcvbuf)); + iov.iov_base = &rcvbuf; + iov.iov_len = sizeof (rcvbuf); + msg.msg_name = (uint8_t *) &addr; + msg.msg_namelen = sizeof (addr); + msg.msg_iov = &iov; + msg.msg_iovlen = 1; + msg.msg_flags = 0; + msg.msg_control = cbuf; + msg.msg_controllen = 256; /* size of cbuf */ + + res = recvmsg (fd, &msg, MSG_ERRQUEUE); + if (res < 0) + goto exit; + + e = NULL; + + for (cmsg = CMSG_FIRSTHDR (&msg); cmsg; cmsg = CMSG_NXTHDR (&msg, cmsg)) + { + if (cmsg->cmsg_level == SOL_IP) + { + if (cmsg->cmsg_type == IP_RECVERR) + { + e = (struct sock_extended_err *) CMSG_DATA (cmsg); + } + else + { + buf_printf (&out ,"CMSG=%d|", cmsg->cmsg_type); + } + } + } + if (e == NULL) + { + buf_printf (&out, "NO-INFO|"); + goto exit; + } + + switch (e->ee_errno) + { + case ETIMEDOUT: + buf_printf (&out, "ETIMEDOUT|"); + break; + case EMSGSIZE: + buf_printf (&out, "EMSGSIZE Path-MTU=%d|", e->ee_info); + *mtu = e->ee_info; + break; + case ECONNREFUSED: + buf_printf (&out, "ECONNREFUSED|"); + break; + case EPROTO: + buf_printf (&out, "EPROTO|"); + break; + case EHOSTUNREACH: + buf_printf (&out, "EHOSTUNREACH|"); + break; + case ENETUNREACH: + buf_printf (&out, "ENETUNREACH|"); + break; + case EACCES: + buf_printf (&out, "EACCES|"); + break; + default: + buf_printf (&out, "UNKNOWN|"); + break; + } + } + + exit: + buf_rmtail (&out, '|'); + return BSTR (&out); +} + +void +set_sock_extended_error_passing (int sd) +{ + int on = 1; + if (setsockopt (sd, SOL_IP, IP_RECVERR, &on, sizeof (on))) + msg (M_WARN | M_ERRNO, + "Note: enable extended error passing on TCP/UDP socket failed (IP_RECVERR)"); +} + +#endif @@ -0,0 +1,304 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MTU_H +#define MTU_H + +#include "buffer.h" + +/* + * + * Packet maninipulation routes such as encrypt, decrypt, compress, decompress + * are passed a frame buffer that looks like this: + * + * [extra_frame bytes] [mtu bytes] [extra_frame_bytes] [compression overflow bytes] + * ^ + * Pointer passed to function points here so that routine + * can make use of extra_frame bytes before pointer + * to prepend headers, etc. + * + * extra_frame bytes is large enough for all encryption related overhead. + * + * mtu bytes will be the MTU size set in the ifconfig statement that configures + * the TUN or TAP device such as: + * + * ifconfig $1 10.1.0.2 pointopoint 10.1.0.1 mtu 1450 + * + * Compression overflow bytes is the worst-case size expansion that would be + * expected if we tried to compress mtu + extra_frame bytes of uncompressible data. + */ + +/* + * Standard ethernet MTU + */ +#define ETHERNET_MTU 1500 + +/* + * It is a fatal error if mtu is less than + * this value for tun device. + */ +#define TUN_MTU_MIN 100 + +/* + * Default MTU of network over which tunnel data will pass by TCP/UDP. + */ +#define LINK_MTU_DEFAULT 1500 + +/* + * Default MTU of tunnel device. + */ +#define TUN_MTU_DEFAULT 1500 + +/* + * MTU Defaults for TAP devices + */ +#define TAP_MTU_EXTRA_DEFAULT 32 + +/* + * Default MSSFIX value, used for reducing TCP MTU size + */ +#define MSSFIX_DEFAULT 1450 + +/* + * Alignment of payload data such as IP packet or + * ethernet frame. + */ +#define PAYLOAD_ALIGN 4 + +struct frame { + /* + * Maximum datagram size to be sent over the tunnel TCP/UDP channel. + */ + int link_mtu; + int link_mtu_dynamic; + + /* + * How many extra bytes might each subsystem (crypto, TLS, or, compression) + * add to frame in worst case? + * + * mtu + extra_frame = MTU of TCP/UDP transport + */ + int extra_frame; + + /* + * Worst case size added to internal buffer due to functions + * such as compression which can potentially expand the size of uncompressible + * data. + */ + int extra_buffer; + + /* + * Max number of bytes in excess of tun mtu size that we might read + * or write from TUN/TAP device. + */ + int extra_tun; + + /* + * Max number of bytes in excess of link mtu size that we might read + * or write from UDP/TCP link. + */ + int extra_link; + + /* + * Alignment control + */ +# define FRAME_HEADROOM_MARKER_DECRYPT (1<<0) +# define FRAME_HEADROOM_MARKER_FRAGMENT (1<<1) +# define FRAME_HEADROOM_MARKER_READ_LINK (1<<2) +# define FRAME_HEADROOM_MARKER_READ_STREAM (1<<3) + unsigned int align_flags; + int align_adjust; +}; + +/* Routines which read struct frame should use the macros below */ + +/* + * Overhead added to packet payload due to encapsulation + */ +#define EXTRA_FRAME(f) ((f)->extra_frame) + +/* + * Delta between tun payload size and final TCP/UDP datagram size + * (not including extra_link additions) + */ +#define TUN_LINK_DELTA(f) ((f)->extra_frame + (f)->extra_tun) + +/* + * This is the size to "ifconfig" the tun or tap device. + */ +#define TUN_MTU_SIZE(f) ((f)->link_mtu - TUN_LINK_DELTA(f)) +#define TUN_MTU_SIZE_DYNAMIC(f) ((f)->link_mtu_dynamic - TUN_LINK_DELTA(f)) + +/* + * This is the maximum packet size that we need to be able to + * read from or write to a tun or tap device. For example, + * a tap device ifconfiged to an MTU of 1200 might actually want + * to return a packet size of 1214 on a read(). + */ +#define PAYLOAD_SIZE(f) ((f)->link_mtu - (f)->extra_frame) +#define PAYLOAD_SIZE_DYNAMIC(f) ((f)->link_mtu_dynamic - (f)->extra_frame) + +/* + * Max size of a payload packet after encryption, compression, etc. + * overhead is added. + */ +#define EXPANDED_SIZE(f) ((f)->link_mtu) +#define EXPANDED_SIZE_DYNAMIC(f) ((f)->link_mtu_dynamic) +#define EXPANDED_SIZE_MIN(f) (TUN_MTU_MIN + TUN_LINK_DELTA(f)) + +/* + * These values are used as maximum size constraints + * on read() or write() from TUN/TAP device or TCP/UDP port. + */ +#define MAX_RW_SIZE_TUN(f) (PAYLOAD_SIZE(f)) +#define MAX_RW_SIZE_LINK(f) (EXPANDED_SIZE(f) + (f)->extra_link) + +/* + * Control buffer headroom allocations to allow for efficient prepending. + */ +#define FRAME_HEADROOM_BASE(f) (TUN_LINK_DELTA(f) + (f)->extra_buffer + (f)->extra_link) +#define FRAME_HEADROOM(f) frame_headroom(f, 0) +#define FRAME_HEADROOM_ADJ(f, fm) frame_headroom(f, fm) + +/* + * Max size of a buffer used to build a packet for output to + * the TCP/UDP port. + */ +#define BUF_SIZE(f) (TUN_MTU_SIZE(f) + FRAME_HEADROOM_BASE(f) * 2) + +/* + * Function prototypes. + */ + +void frame_finalize (struct frame *frame, + bool link_mtu_defined, + int link_mtu, + bool tun_mtu_defined, + int tun_mtu); + +void frame_subtract_extra (struct frame *frame, const struct frame *src); + +void frame_print (const struct frame *frame, + int level, + const char *prefix); + +void set_mtu_discover_type (int sd, int mtu_type); +int translate_mtu_discover_type_name (const char *name); + +/* + * frame_set_mtu_dynamic and flags + */ + +#define SET_MTU_TUN (1<<0) /* use tun/tap rather than link sizing */ +#define SET_MTU_UPPER_BOUND (1<<1) /* only decrease dynamic MTU */ + +void frame_set_mtu_dynamic (struct frame *frame, int mtu, unsigned int flags); + +/* + * allocate a buffer for socket or tun layer + */ +void alloc_buf_sock_tun (struct buffer *buf, + const struct frame *frame, + const bool tuntap_buffer, + const unsigned int align_mask); + +/* + * EXTENDED_SOCKET_ERROR_CAPABILITY functions -- print extra error info + * on socket errors, such as PMTU size. As of 2003.05.11, only works + * on Linux 2.4+. + */ + +#if EXTENDED_SOCKET_ERROR_CAPABILITY + +void set_sock_extended_error_passing (int sd); +const char *format_extended_socket_error (int fd, int *mtu, struct gc_arena *gc); + +#endif + +/* + * Calculate a starting offset into a buffer object, dealing with + * headroom and alignment issues. + */ +static inline int +frame_headroom (const struct frame *f, const unsigned int flag_mask) +{ + const int offset = FRAME_HEADROOM_BASE (f); + const int adjust = (flag_mask & f->align_flags) ? f->align_adjust : 0; + const int delta = ((PAYLOAD_ALIGN << 24) - (offset + adjust)) & (PAYLOAD_ALIGN - 1); + return offset + delta; +} + +/* + * frame member adjustment functions + */ + +static inline void +frame_add_to_extra_frame (struct frame *frame, const int increment) +{ + frame->extra_frame += increment; +} + +static inline void +frame_add_to_extra_tun (struct frame *frame, const int increment) +{ + frame->extra_tun += increment; +} + +static inline void +frame_add_to_extra_link (struct frame *frame, const int increment) +{ + frame->extra_link += increment; +} + +static inline void +frame_add_to_extra_buffer (struct frame *frame, const int increment) +{ + frame->extra_buffer += increment; +} + +static inline void +frame_add_to_align_adjust (struct frame *frame, const int increment) +{ + frame->align_adjust += increment; +} + +static inline void +frame_align_to_extra_frame (struct frame *frame) +{ + frame->align_adjust = frame->extra_frame + frame->extra_link; +} + +static inline void +frame_or_align_flags (struct frame *frame, const unsigned int flag_mask) +{ + frame->align_flags |= flag_mask; +} + +static inline bool +frame_defined (const struct frame *frame) +{ + return frame->link_mtu > 0; +} + +#endif @@ -0,0 +1,286 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP_SERVER + +#include "multi.h" +#include "forward-inline.h" + +#include "memdbg.h" + +/* + * Get a client instance based on real address. If + * the instance doesn't exist, create it while + * maintaining real address hash table atomicity. + */ + +struct multi_instance * +multi_get_create_instance_udp (struct multi_context *m) +{ + struct gc_arena gc = gc_new (); + struct mroute_addr real; + struct multi_instance *mi = NULL; + struct hash *hash = m->hash; + + if (mroute_extract_sockaddr_in (&real, &m->top.c2.from, true)) + { + struct hash_element *he; + const uint32_t hv = hash_value (hash, &real); + struct hash_bucket *bucket = hash_bucket (hash, hv); + + hash_bucket_lock (bucket); + he = hash_lookup_fast (hash, bucket, &real, hv); + + if (he) + { + mi = (struct multi_instance *) he->value; + } + else + { + if (!m->top.c2.tls_auth_standalone + || tls_pre_decrypt_lite (m->top.c2.tls_auth_standalone, &m->top.c2.from, &m->top.c2.buf)) + { + if (frequency_limit_event_allowed (m->new_connection_limiter)) + { + mi = multi_create_instance (m, &real); + if (mi) + { + hash_add_fast (hash, bucket, &mi->real, hv, mi); + mi->did_real_hash = true; + } + } + else + { + msg (D_MULTI_ERRORS, + "MULTI: Connection from %s would exceed new connection frequency limit as controlled by --connect-freq", + mroute_addr_print (&real, &gc)); + } + } + } + + hash_bucket_unlock (bucket); + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_MULTI_DEBUG)) + { + const char *status; + + if (he && mi) + status = "[succeeded]"; + else if (!he && mi) + status = "[created]"; + else + status = "[failed]"; + + dmsg (D_MULTI_DEBUG, "GET INST BY REAL: %s %s", + mroute_addr_print (&real, &gc), + status); + } +#endif + } + + gc_free (&gc); + ASSERT (!(mi && mi->halt)); + return mi; +} + +/* + * Send a packet to TCP/UDP socket. + */ +static inline void +multi_process_outgoing_link (struct multi_context *m, const unsigned int mpp_flags) +{ + struct multi_instance *mi = multi_process_outgoing_link_pre (m); + if (mi) + multi_process_outgoing_link_dowork (m, mi, mpp_flags); +} + +/* + * Process an I/O event. + */ +static void +multi_process_io_udp (struct multi_context *m) +{ + const unsigned int status = m->top.c2.event_set_status; + const unsigned int mpp_flags = m->top.c2.fast_io + ? (MPP_CONDITIONAL_PRE_SELECT | MPP_CLOSE_ON_SIGNAL) + : (MPP_PRE_SELECT | MPP_CLOSE_ON_SIGNAL); + +#ifdef MULTI_DEBUG_EVENT_LOOP + char buf[16]; + buf[0] = 0; + if (status & SOCKET_READ) + strcat (buf, "SR/"); + else if (status & SOCKET_WRITE) + strcat (buf, "SW/"); + else if (status & TUN_READ) + strcat (buf, "TR/"); + else if (status & TUN_WRITE) + strcat (buf, "TW/"); + printf ("IO %s\n", buf); +#endif + +#ifdef ENABLE_MANAGEMENT + if (status & (MANAGEMENT_READ|MANAGEMENT_WRITE)) + { + ASSERT (management); + management_io (management); + } +#endif + + /* UDP port ready to accept write */ + if (status & SOCKET_WRITE) + { + multi_process_outgoing_link (m, mpp_flags); + } + /* TUN device ready to accept write */ + else if (status & TUN_WRITE) + { + multi_process_outgoing_tun (m, mpp_flags); + } + /* Incoming data on UDP port */ + else if (status & SOCKET_READ) + { + read_incoming_link (&m->top); + multi_release_io_lock (m); + if (!IS_SIG (&m->top)) + multi_process_incoming_link (m, NULL, mpp_flags); + } + /* Incoming data on TUN device */ + else if (status & TUN_READ) + { + read_incoming_tun (&m->top); + multi_release_io_lock (m); + if (!IS_SIG (&m->top)) + multi_process_incoming_tun (m, mpp_flags); + } +} + +/* + * Return the io_wait() flags appropriate for + * a point-to-multipoint tunnel. + */ +static inline unsigned int +p2mp_iow_flags (const struct multi_context *m) +{ + unsigned int flags = IOW_WAIT_SIGNAL; + if (m->pending) + { + if (TUN_OUT (&m->pending->context)) + flags |= IOW_TO_TUN; + if (LINK_OUT (&m->pending->context)) + flags |= IOW_TO_LINK; + } + else if (mbuf_defined (m->mbuf)) + flags |= IOW_MBUF; + else + flags |= IOW_READ; + + return flags; +} + +/* + * Top level event loop for single-threaded operation. + * UDP mode. + */ +static void +tunnel_server_udp_single_threaded (struct context *top) +{ + struct multi_context multi; + + top->mode = CM_TOP; + context_clear_2 (top); + + /* initialize top-tunnel instance */ + init_instance_handle_signals (top, top->es, CC_HARD_USR1_TO_HUP); + if (IS_SIG (top)) + return; + + /* initialize global multi_context object */ + multi_init (&multi, top, false, MC_SINGLE_THREADED); + + /* initialize our cloned top object */ + multi_top_init (&multi, top, true); + + /* initialize management interface */ + init_management_callback_multi (&multi); + + /* finished with initialization */ + initialization_sequence_completed (top, ISC_SERVER); /* --mode server --proto udp */ + + /* per-packet event loop */ + while (true) + { + perf_push (PERF_EVENT_LOOP); + + /* set up and do the io_wait() */ + multi_get_timeout (&multi, &multi.top.c2.timeval); + io_wait (&multi.top, p2mp_iow_flags (&multi)); + MULTI_CHECK_SIG (&multi); + + /* check on status of coarse timers */ + multi_process_per_second_timers (&multi); + + /* timeout? */ + if (multi.top.c2.event_set_status == ES_TIMEOUT) + { + multi_process_timeout (&multi, MPP_PRE_SELECT|MPP_CLOSE_ON_SIGNAL); + } + else + { + /* process I/O */ + multi_process_io_udp (&multi); + MULTI_CHECK_SIG (&multi); + } + + perf_pop (); + } + + /* shut down management interface */ + uninit_management_callback_multi (&multi); + + /* save ifconfig-pool */ + multi_ifconfig_pool_persist (&multi, true); + + /* tear down tunnel instance (unless --persist-tun) */ + multi_uninit (&multi); + multi_top_free (&multi); + close_instance (top); +} + +void +tunnel_server_udp (struct context *top) +{ + tunnel_server_udp_single_threaded (top); +} + +#endif @@ -0,0 +1,42 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * UDP specific code for --mode server + */ + +#ifndef MUDP_H +#define MUDP_H + +#if P2MP_SERVER + +struct context; +struct multi_context; + +void tunnel_server_udp (struct context *top); + +struct multi_instance *multi_get_create_instance_udp (struct multi_context *m); + +#endif +#endif @@ -0,0 +1,2129 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP_SERVER + +#include "multi.h" +#include "push.h" +#include "misc.h" +#include "otime.h" +#include "gremlin.h" + +#include "memdbg.h" + +#include "forward-inline.h" + +/*#define MULTI_DEBUG_EVENT_LOOP*/ + +#ifdef MULTI_DEBUG_EVENT_LOOP +static const char * +id (struct multi_instance *mi) +{ + if (mi) + return tls_common_name (mi->context.c2.tls_multi, false); + else + return "NULL"; +} +#endif + +static bool +learn_address_script (const struct multi_context *m, + const struct multi_instance *mi, + const char *op, + const struct mroute_addr *addr) +{ + struct gc_arena gc = gc_new (); + struct env_set *es; + bool ret = true; + + /* get environmental variable source */ + if (mi && mi->context.c2.es) + es = mi->context.c2.es; + else + es = env_set_create (&gc); + + if (plugin_defined (m->top.c1.plugins, OPENVPN_PLUGIN_LEARN_ADDRESS)) + { + struct buffer cmd = alloc_buf_gc (256, &gc); + + buf_printf (&cmd, "\"%s\" \"%s\"", + op, + mroute_addr_print (addr, &gc)); + if (mi) + buf_printf (&cmd, " \"%s\"", tls_common_name (mi->context.c2.tls_multi, false)); + + if (plugin_call (m->top.c1.plugins, OPENVPN_PLUGIN_LEARN_ADDRESS, BSTR (&cmd), es)) + { + msg (M_WARN, "WARNING: learn-address plugin call failed"); + ret = false; + } + } + + if (m->top.options.learn_address_script) + { + struct buffer cmd = alloc_buf_gc (256, &gc); + + setenv_str (es, "script_type", "learn-address"); + + buf_printf (&cmd, "%s \"%s\" \"%s\"", + m->top.options.learn_address_script, + op, + mroute_addr_print (addr, &gc)); + if (mi) + buf_printf (&cmd, " \"%s\"", tls_common_name (mi->context.c2.tls_multi, false)); + + if (!system_check (BSTR (&cmd), es, S_SCRIPT, "WARNING: learn-address command failed")) + ret = false; + } + + gc_free (&gc); + return ret; +} + +void +multi_ifconfig_pool_persist (struct multi_context *m, bool force) +{ + /* write pool data to file */ + if (m->ifconfig_pool + && m->top.c1.ifconfig_pool_persist + && (force || ifconfig_pool_write_trigger (m->top.c1.ifconfig_pool_persist))) + { + ifconfig_pool_write (m->top.c1.ifconfig_pool_persist, m->ifconfig_pool); + } +} + +static void +multi_reap_range (const struct multi_context *m, + int start_bucket, + int end_bucket) +{ + struct gc_arena gc = gc_new (); + struct hash_iterator hi; + struct hash_element *he; + + if (start_bucket < 0) + { + start_bucket = 0; + end_bucket = hash_n_buckets (m->vhash); + } + + dmsg (D_MULTI_DEBUG, "MULTI: REAP range %d -> %d", start_bucket, end_bucket); + hash_iterator_init_range (m->vhash, &hi, true, start_bucket, end_bucket); + while ((he = hash_iterator_next (&hi)) != NULL) + { + struct multi_route *r = (struct multi_route *) he->value; + if (!multi_route_defined (m, r)) + { + dmsg (D_MULTI_DEBUG, "MULTI: REAP DEL %s", + mroute_addr_print (&r->addr, &gc)); + learn_address_script (m, NULL, "delete", &r->addr); + multi_route_del (r); + hash_iterator_delete_element (&hi); + } + } + hash_iterator_free (&hi); + gc_free (&gc); +} + +static void +multi_reap_all (const struct multi_context *m) +{ + multi_reap_range (m, -1, 0); +} + +static struct multi_reap * +multi_reap_new (int buckets_per_pass) +{ + struct multi_reap *mr; + ALLOC_OBJ (mr, struct multi_reap); + mr->bucket_base = 0; + mr->buckets_per_pass = buckets_per_pass; + mr->last_call = now; + return mr; +} + +void +multi_reap_process_dowork (const struct multi_context *m) +{ + struct multi_reap *mr = m->reaper; + if (mr->bucket_base >= hash_n_buckets (m->vhash)) + mr->bucket_base = 0; + multi_reap_range (m, mr->bucket_base, mr->bucket_base + mr->buckets_per_pass); + mr->bucket_base += mr->buckets_per_pass; + mr->last_call = now; +} + +static void +multi_reap_free (struct multi_reap *mr) +{ + free (mr); +} + +/* + * How many buckets in vhash to reap per pass. + */ +static int +reap_buckets_per_pass (int n_buckets) +{ + return constrain_int (n_buckets / REAP_DIVISOR, REAP_MIN, REAP_MAX); +} + +/* + * Main initialization function, init multi_context object. + */ +void +multi_init (struct multi_context *m, struct context *t, bool tcp_mode, int thread_mode) +{ + int dev = DEV_TYPE_UNDEF; + + msg (D_MULTI_LOW, "MULTI: multi_init called, r=%d v=%d", + t->options.real_hash_size, + t->options.virtual_hash_size); + + /* + * Get tun/tap/null device type + */ + dev = dev_type_enum (t->options.dev, t->options.dev_type); + + /* + * Init our multi_context object. + */ + CLEAR (*m); + + m->thread_mode = thread_mode; + + /* + * Real address hash table (source port number is + * considered to be part of the address). Used + * to determine which client sent an incoming packet + * which is seen on the TCP/UDP socket. + */ + m->hash = hash_init (t->options.real_hash_size, + mroute_addr_hash_function, + mroute_addr_compare_function); + + /* + * Virtual address hash table. Used to determine + * which client to route a packet to. + */ + m->vhash = hash_init (t->options.virtual_hash_size, + mroute_addr_hash_function, + mroute_addr_compare_function); + + /* + * This hash table is a clone of m->hash but with a + * bucket size of one so that it can be used + * for fast iteration through the list. + */ + m->iter = hash_init (1, + mroute_addr_hash_function, + mroute_addr_compare_function); + + /* + * This is our scheduler, for time-based wakeup + * events. + */ + m->schedule = schedule_init (); + + /* + * Limit frequency of incoming connections to control + * DoS. + */ + m->new_connection_limiter = frequency_limit_init (t->options.cf_max, + t->options.cf_per); + + /* + * Allocate broadcast/multicast buffer list + */ + m->mbuf = mbuf_init (t->options.n_bcast_buf); + + /* + * Different status file format options are available + */ + m->status_file_version = t->options.status_file_version; + + /* + * Possibly allocate an ifconfig pool, do it + * differently based on whether a tun or tap style + * tunnel. + */ + if (t->options.ifconfig_pool_defined) + { + if (dev == DEV_TYPE_TAP || t->options.ifconfig_pool_linear) + { + m->ifconfig_pool = ifconfig_pool_init (IFCONFIG_POOL_INDIV, + t->options.ifconfig_pool_start, + t->options.ifconfig_pool_end, + t->options.duplicate_cn); + } + else if (dev == DEV_TYPE_TUN) + { + m->ifconfig_pool = ifconfig_pool_init (IFCONFIG_POOL_30NET, + t->options.ifconfig_pool_start, + t->options.ifconfig_pool_end, + t->options.duplicate_cn); + } + else + { + ASSERT (0); + } + + /* reload pool data from file */ + if (t->c1.ifconfig_pool_persist) + ifconfig_pool_read (t->c1.ifconfig_pool_persist, m->ifconfig_pool); + } + + /* + * Help us keep track of routing table. + */ + m->route_helper = mroute_helper_init (MULTI_CACHE_ROUTE_TTL); + + /* + * Initialize route and instance reaper. + */ + m->reaper = multi_reap_new (reap_buckets_per_pass (t->options.virtual_hash_size)); + + /* + * Get local ifconfig address + */ + CLEAR (m->local); + ASSERT (t->c1.tuntap); + mroute_extract_in_addr_t (&m->local, t->c1.tuntap->local); + + /* + * Per-client limits + */ + m->max_clients = t->options.max_clients; + + /* + * Initialize multi-socket TCP I/O wait object + */ + if (tcp_mode) + m->mtcp = multi_tcp_init (t->options.max_clients, &m->max_clients); + m->tcp_queue_limit = t->options.tcp_queue_limit; + + /* + * Allow client <-> client communication, without going through + * tun/tap interface and network stack? + */ + m->enable_c2c = t->options.enable_c2c; +} + +const char * +multi_instance_string (const struct multi_instance *mi, bool null, struct gc_arena *gc) +{ + if (mi) + { + struct buffer out = alloc_buf_gc (256, gc); + const char *cn = tls_common_name (mi->context.c2.tls_multi, true); + + if (cn) + buf_printf (&out, "%s/", cn); + buf_printf (&out, "%s", mroute_addr_print (&mi->real, gc)); + return BSTR (&out); + } + else if (null) + return NULL; + else + return "UNDEF"; +} + +void +generate_prefix (struct multi_instance *mi) +{ + mi->msg_prefix = multi_instance_string (mi, true, &mi->gc); + set_prefix (mi); +} + +void +ungenerate_prefix (struct multi_instance *mi) +{ + mi->msg_prefix = NULL; + set_prefix (mi); +} + +/* + * Tell the route helper about deleted iroutes so + * that it can update its mask of currently used + * CIDR netlengths. + */ +static void +multi_del_iroutes (struct multi_context *m, + struct multi_instance *mi) +{ + const struct iroute *ir; + if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN) + { + for (ir = mi->context.options.iroutes; ir != NULL; ir = ir->next) + mroute_helper_del_iroute (m->route_helper, ir); + } +} + +static void +multi_client_disconnect_setenv (struct multi_context *m, + struct multi_instance *mi) +{ + /* setenv client real IP address */ + setenv_trusted (mi->context.c2.es, get_link_socket_info (&mi->context)); + + /* setenv stats */ + setenv_int (mi->context.c2.es, "bytes_received", mi->context.c2.link_read_bytes); + setenv_int (mi->context.c2.es, "bytes_sent", mi->context.c2.link_write_bytes); + +} + +static void +multi_client_disconnect_script (struct multi_context *m, + struct multi_instance *mi) +{ + if (mi->context.c2.context_auth == CAS_SUCCEEDED || mi->context.c2.context_auth == CAS_PARTIAL) + { + multi_client_disconnect_setenv (m, mi); + + if (plugin_defined (m->top.c1.plugins, OPENVPN_PLUGIN_CLIENT_DISCONNECT)) + { + if (plugin_call (m->top.c1.plugins, OPENVPN_PLUGIN_CLIENT_DISCONNECT, NULL, mi->context.c2.es)) + msg (M_WARN, "WARNING: client-disconnect plugin call failed"); + } + + if (mi->context.options.client_disconnect_script) + { + struct gc_arena gc = gc_new (); + struct buffer cmd = alloc_buf_gc (256, &gc); + + setenv_str (mi->context.c2.es, "script_type", "client-disconnect"); + + buf_printf (&cmd, "%s", mi->context.options.client_disconnect_script); + + system_check (BSTR (&cmd), mi->context.c2.es, S_SCRIPT, "client-disconnect command failed"); + + gc_free (&gc); + } + } +} + +void +multi_close_instance (struct multi_context *m, + struct multi_instance *mi, + bool shutdown) +{ + perf_push (PERF_MULTI_CLOSE_INSTANCE); + + ASSERT (!mi->halt); + mi->halt = true; + + dmsg (D_MULTI_DEBUG, "MULTI: multi_close_instance called"); + + /* prevent dangling pointers */ + if (m->pending == mi) + multi_set_pending (m, NULL); + if (m->earliest_wakeup == mi) + m->earliest_wakeup = NULL; + + if (!shutdown) + { + if (mi->did_real_hash) + { + ASSERT (hash_remove (m->hash, &mi->real)); + } + if (mi->did_iter) + { + ASSERT (hash_remove (m->iter, &mi->real)); + } + + schedule_remove_entry (m->schedule, (struct schedule_entry *) mi); + + ifconfig_pool_release (m->ifconfig_pool, mi->vaddr_handle, false); + + if (mi->did_iroutes) + { + multi_del_iroutes (m, mi); + mi->did_iroutes = false; + } + + if (m->mtcp) + multi_tcp_dereference_instance (m->mtcp, mi); + + mbuf_dereference_instance (m->mbuf, mi); + } + + multi_client_disconnect_script (m, mi); + + if (mi->did_open_context) + close_context (&mi->context, SIGTERM, CC_GC_FREE); + + multi_tcp_instance_specific_free (mi); + + ungenerate_prefix (mi); + + /* + * Don't actually delete the instance memory allocation yet, + * because virtual routes may still point to it. Let the + * vhash reaper deal with it. + */ + multi_instance_dec_refcount (mi); + + perf_pop (); +} + +/* + * Called on shutdown or restart. + */ +void +multi_uninit (struct multi_context *m) +{ + if (m->thread_mode & MC_WORK_THREAD) + { + multi_top_free (m); + m->thread_mode = MC_UNDEF; + } + else if (m->thread_mode) + { + if (m->hash) + { + struct hash_iterator hi; + struct hash_element *he; + + hash_iterator_init (m->iter, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct multi_instance *mi = (struct multi_instance *) he->value; + mi->did_iter = false; + multi_close_instance (m, mi, true); + } + hash_iterator_free (&hi); + + multi_reap_all (m); + + hash_free (m->hash); + hash_free (m->vhash); + hash_free (m->iter); + m->hash = NULL; + + schedule_free (m->schedule); + mbuf_free (m->mbuf); + ifconfig_pool_free (m->ifconfig_pool); + frequency_limit_free (m->new_connection_limiter); + multi_reap_free (m->reaper); + mroute_helper_free (m->route_helper); + multi_tcp_free (m->mtcp); + m->thread_mode = MC_UNDEF; + } + } +} + +/* + * Create a client instance object for a newly connected client. + */ +struct multi_instance * +multi_create_instance (struct multi_context *m, const struct mroute_addr *real) +{ + struct gc_arena gc = gc_new (); + struct multi_instance *mi; + + perf_push (PERF_MULTI_CREATE_INSTANCE); + + msg (D_MULTI_LOW, "MULTI: multi_create_instance called"); + + ALLOC_OBJ_CLEAR (mi, struct multi_instance); + + mutex_init (&mi->mutex); + mi->gc = gc_new (); + multi_instance_inc_refcount (mi); + mi->vaddr_handle = -1; + mi->created = now; + mroute_addr_init (&mi->real); + + if (real) + { + mi->real = *real; + generate_prefix (mi); + } + + inherit_context_child (&mi->context, &m->top); + if (IS_SIG (&mi->context)) + goto err; + mi->did_open_context = true; + + mi->context.c2.context_auth = CAS_PENDING; + + if (hash_n_elements (m->hash) >= m->max_clients) + { + msg (D_MULTI_ERRORS, "MULTI: new incoming connection would exceed maximum number of clients (%d)", m->max_clients); + goto err; + } + + if (!real) /* TCP mode? */ + { + if (!multi_tcp_instance_specific_init (m, mi)) + goto err; + generate_prefix (mi); + } + + if (!hash_add (m->iter, &mi->real, mi, false)) + { + msg (D_MULTI_LOW, "MULTI: unable to add real address [%s] to iterator hash table", + mroute_addr_print (&mi->real, &gc)); + goto err; + } + mi->did_iter = true; + + mi->context.c2.push_reply_deferred = true; + + if (!multi_process_post (m, mi, MPP_PRE_SELECT)) + { + msg (D_MULTI_ERRORS, "MULTI: signal occurred during client instance initialization"); + goto err; + } + + perf_pop (); + gc_free (&gc); + return mi; + + err: + multi_close_instance (m, mi, false); + perf_pop (); + gc_free (&gc); + return NULL; +} + +/* + * Dump tables -- triggered by SIGUSR2. + * If status file is defined, write to file. + * If status file is NULL, write to syslog. + */ +void +multi_print_status (struct multi_context *m, struct status_output *so, const int version) +{ + if (m->hash) + { + struct gc_arena gc_top = gc_new (); + struct hash_iterator hi; + const struct hash_element *he; + + status_reset (so); + + if (version == 1) /* WAS: m->status_file_version */ + { + /* + * Status file version 1 + */ + status_printf (so, PACKAGE_NAME " CLIENT LIST"); + status_printf (so, "Updated,%s", time_string (0, 0, false, &gc_top)); + status_printf (so, "Common Name,Real Address,Bytes Received,Bytes Sent,Connected Since"); + hash_iterator_init (m->hash, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct gc_arena gc = gc_new (); + const struct multi_instance *mi = (struct multi_instance *) he->value; + + if (!mi->halt) + { + status_printf (so, "%s,%s," counter_format "," counter_format ",%s", + tls_common_name (mi->context.c2.tls_multi, false), + mroute_addr_print (&mi->real, &gc), + mi->context.c2.link_read_bytes, + mi->context.c2.link_write_bytes, + time_string (mi->created, 0, false, &gc)); + } + gc_free (&gc); + } + hash_iterator_free (&hi); + + status_printf (so, "ROUTING TABLE"); + status_printf (so, "Virtual Address,Common Name,Real Address,Last Ref"); + hash_iterator_init (m->vhash, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct gc_arena gc = gc_new (); + const struct multi_route *route = (struct multi_route *) he->value; + + if (multi_route_defined (m, route)) + { + const struct multi_instance *mi = route->instance; + const struct mroute_addr *ma = &route->addr; + char flags[2] = {0, 0}; + + if (route->flags & MULTI_ROUTE_CACHE) + flags[0] = 'C'; + status_printf (so, "%s%s,%s,%s,%s", + mroute_addr_print (ma, &gc), + flags, + tls_common_name (mi->context.c2.tls_multi, false), + mroute_addr_print (&mi->real, &gc), + time_string (route->last_reference, 0, false, &gc)); + } + gc_free (&gc); + } + hash_iterator_free (&hi); + + status_printf (so, "GLOBAL STATS"); + if (m->mbuf) + status_printf (so, "Max bcast/mcast queue length,%d", + mbuf_maximum_queued (m->mbuf)); + + status_printf (so, "END"); + } + else if (version == 2) + { + /* + * Status file version 2 + */ + status_printf (so, "TITLE,%s", title_string); + status_printf (so, "TIME,%s,%u", time_string (now, 0, false, &gc_top), (unsigned int)now); + status_printf (so, "HEADER,CLIENT_LIST,Common Name,Real Address,Virtual Address,Bytes Received,Bytes Sent,Connected Since,Connected Since (time_t)"); + hash_iterator_init (m->hash, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct gc_arena gc = gc_new (); + const struct multi_instance *mi = (struct multi_instance *) he->value; + + if (!mi->halt) + { + status_printf (so, "CLIENT_LIST,%s,%s,%s," counter_format "," counter_format ",%s,%u", + tls_common_name (mi->context.c2.tls_multi, false), + mroute_addr_print (&mi->real, &gc), + print_in_addr_t (mi->reporting_addr, IA_EMPTY_IF_UNDEF, &gc), + mi->context.c2.link_read_bytes, + mi->context.c2.link_write_bytes, + time_string (mi->created, 0, false, &gc), + (unsigned int)mi->created); + } + gc_free (&gc); + } + hash_iterator_free (&hi); + + status_printf (so, "HEADER,ROUTING_TABLE,Virtual Address,Common Name,Real Address,Last Ref,Last Ref (time_t)"); + hash_iterator_init (m->vhash, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct gc_arena gc = gc_new (); + const struct multi_route *route = (struct multi_route *) he->value; + + if (multi_route_defined (m, route)) + { + const struct multi_instance *mi = route->instance; + const struct mroute_addr *ma = &route->addr; + char flags[2] = {0, 0}; + + if (route->flags & MULTI_ROUTE_CACHE) + flags[0] = 'C'; + status_printf (so, "ROUTING_TABLE,%s%s,%s,%s,%s,%u", + mroute_addr_print (ma, &gc), + flags, + tls_common_name (mi->context.c2.tls_multi, false), + mroute_addr_print (&mi->real, &gc), + time_string (route->last_reference, 0, false, &gc), + (unsigned int)route->last_reference); + } + gc_free (&gc); + } + hash_iterator_free (&hi); + + if (m->mbuf) + status_printf (so, "GLOBAL_STATS,Max bcast/mcast queue length,%d", + mbuf_maximum_queued (m->mbuf)); + + status_printf (so, "END"); + } + else + { + status_printf (so, "ERROR: bad status format version number"); + } + status_flush (so); + gc_free (&gc_top); + } +} + +/* + * Learn a virtual address or route. + * The learn will fail if the learn address + * script/plugin fails. In this case the + * return value may be != mi. + * Return the instance which owns this route, + * or NULL if none. + */ +static struct multi_instance * +multi_learn_addr (struct multi_context *m, + struct multi_instance *mi, + const struct mroute_addr *addr, + const unsigned int flags) +{ + struct hash_element *he; + const uint32_t hv = hash_value (m->vhash, addr); + struct hash_bucket *bucket = hash_bucket (m->vhash, hv); + struct multi_route *oldroute = NULL; + struct multi_instance *owner = NULL; + + hash_bucket_lock (bucket); + + /* if route currently exists, get the instance which owns it */ + he = hash_lookup_fast (m->vhash, bucket, addr, hv); + if (he) + oldroute = (struct multi_route *) he->value; + if (oldroute && multi_route_defined (m, oldroute)) + owner = oldroute->instance; + + /* do we need to add address to hash table? */ + if ((!owner || owner != mi) + && mroute_learnable_address (addr) + && !mroute_addr_equal (addr, &m->local)) + { + struct gc_arena gc = gc_new (); + struct multi_route *newroute; + bool learn_succeeded = false; + + ALLOC_OBJ (newroute, struct multi_route); + newroute->addr = *addr; + newroute->instance = mi; + newroute->flags = flags; + newroute->last_reference = now; + newroute->cache_generation = 0; + + /* The cache is invalidated when cache_generation is incremented */ + if (flags & MULTI_ROUTE_CACHE) + newroute->cache_generation = m->route_helper->cache_generation; + + if (oldroute) /* route already exists? */ + { + if (route_quota_test (m, mi) && learn_address_script (m, mi, "update", &newroute->addr)) + { + learn_succeeded = true; + owner = mi; + multi_instance_inc_refcount (mi); + route_quota_inc (mi); + + /* delete old route */ + multi_route_del (oldroute); + + /* modify hash table entry, replacing old route */ + he->key = &newroute->addr; + he->value = newroute; + } + } + else + { + if (route_quota_test (m, mi) && learn_address_script (m, mi, "add", &newroute->addr)) + { + learn_succeeded = true; + owner = mi; + multi_instance_inc_refcount (mi); + route_quota_inc (mi); + + /* add new route */ + hash_add_fast (m->vhash, bucket, &newroute->addr, hv, newroute); + } + } + + msg (D_MULTI_LOW, "MULTI: Learn%s: %s -> %s", + learn_succeeded ? "" : " FAILED", + mroute_addr_print (&newroute->addr, &gc), + multi_instance_string (mi, false, &gc)); + + if (!learn_succeeded) + free (newroute); + + gc_free (&gc); + } + + hash_bucket_unlock (bucket); + return owner; +} + +/* + * Get client instance based on virtual address. + */ +static struct multi_instance * +multi_get_instance_by_virtual_addr (struct multi_context *m, + const struct mroute_addr *addr, + bool cidr_routing) +{ + struct multi_route *route; + struct multi_instance *ret = NULL; + + /* check for local address */ + if (mroute_addr_equal (addr, &m->local)) + return NULL; + + route = (struct multi_route *) hash_lookup (m->vhash, addr); + + /* does host route (possible cached) exist? */ + if (route && multi_route_defined (m, route)) + { + struct multi_instance *mi = route->instance; + route->last_reference = now; + ret = mi; + } + else if (cidr_routing) /* do we need to regenerate a host route cache entry? */ + { + struct mroute_helper *rh = m->route_helper; + struct mroute_addr tryaddr; + int i; + + mroute_helper_lock (rh); + + /* cycle through each CIDR length */ + for (i = 0; i < rh->n_net_len; ++i) + { + tryaddr = *addr; + tryaddr.type |= MR_WITH_NETBITS; + tryaddr.netbits = rh->net_len[i]; + mroute_addr_mask_host_bits (&tryaddr); + + /* look up a possible route with netbits netmask */ + route = (struct multi_route *) hash_lookup (m->vhash, &tryaddr); + + if (route && multi_route_defined (m, route)) + { + /* found an applicable route, cache host route */ + struct multi_instance *mi = route->instance; + multi_learn_addr (m, mi, addr, MULTI_ROUTE_CACHE|MULTI_ROUTE_AGEABLE); + ret = mi; + break; + } + } + + mroute_helper_unlock (rh); + } + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_MULTI_DEBUG)) + { + struct gc_arena gc = gc_new (); + const char *addr_text = mroute_addr_print (addr, &gc); + if (ret) + { + dmsg (D_MULTI_DEBUG, "GET INST BY VIRT: %s -> %s via %s", + addr_text, + multi_instance_string (ret, false, &gc), + mroute_addr_print (&route->addr, &gc)); + } + else + { + dmsg (D_MULTI_DEBUG, "GET INST BY VIRT: %s [failed]", + addr_text); + } + gc_free (&gc); + } +#endif + + ASSERT (!(ret && ret->halt)); + return ret; +} + +/* + * Helper function to multi_learn_addr(). + */ +static struct multi_instance * +multi_learn_in_addr_t (struct multi_context *m, + struct multi_instance *mi, + in_addr_t a, + int netbits) /* -1 if host route, otherwise # of network bits in address */ +{ + struct sockaddr_in remote_si; + struct mroute_addr addr; + + CLEAR (remote_si); + remote_si.sin_family = AF_INET; + remote_si.sin_addr.s_addr = htonl (a); + ASSERT (mroute_extract_sockaddr_in (&addr, &remote_si, false)); + + if (netbits >= 0) + { + addr.type |= MR_WITH_NETBITS; + addr.netbits = (uint8_t) netbits; + } + return multi_learn_addr (m, mi, &addr, 0); +} + +/* + * A new client has connected, add routes (server -> client) + * to internal routing table. + */ +static void +multi_add_iroutes (struct multi_context *m, + struct multi_instance *mi) +{ + struct gc_arena gc = gc_new (); + const struct iroute *ir; + if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN) + { + mi->did_iroutes = true; + for (ir = mi->context.options.iroutes; ir != NULL; ir = ir->next) + { + if (ir->netbits >= 0) + msg (D_MULTI_LOW, "MULTI: internal route %s/%d -> %s", + print_in_addr_t (ir->network, 0, &gc), + ir->netbits, + multi_instance_string (mi, false, &gc)); + else + msg (D_MULTI_LOW, "MULTI: internal route %s -> %s", + print_in_addr_t (ir->network, 0, &gc), + multi_instance_string (mi, false, &gc)); + + mroute_helper_add_iroute (m->route_helper, ir); + + multi_learn_in_addr_t (m, mi, ir->network, ir->netbits); + } + } + gc_free (&gc); +} + +/* + * Given an instance (new_mi), delete all other instances which use the + * same common name. + */ +static void +multi_delete_dup (struct multi_context *m, struct multi_instance *new_mi) +{ + if (new_mi) + { + const char *new_cn = tls_common_name (new_mi->context.c2.tls_multi, true); + if (new_cn) + { + struct hash_iterator hi; + struct hash_element *he; + + hash_iterator_init (m->iter, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct multi_instance *mi = (struct multi_instance *) he->value; + if (mi != new_mi && !mi->halt) + { + const char *cn = tls_common_name (mi->context.c2.tls_multi, true); + if (cn && !strcmp (cn, new_cn)) + { + mi->did_iter = false; + multi_close_instance (m, mi, false); + hash_iterator_delete_element (&hi); + } + } + } + hash_iterator_free (&hi); + } + } +} + +/* + * Select a virtual address for a new client instance. + * Use an --ifconfig-push directive, if given (static IP). + * Otherwise use an --ifconfig-pool address (dynamic IP). + */ +static void +multi_select_virtual_addr (struct multi_context *m, struct multi_instance *mi) +{ + struct gc_arena gc = gc_new (); + + /* + * If ifconfig addresses were set by dynamic config file, + * release pool addresses, otherwise keep them. + */ + if (mi->context.options.push_ifconfig_defined) + { + /* ifconfig addresses were set statically, + release dynamic allocation */ + if (mi->vaddr_handle >= 0) + { + ifconfig_pool_release (m->ifconfig_pool, mi->vaddr_handle, true); + mi->vaddr_handle = -1; + } + + mi->context.c2.push_ifconfig_defined = true; + mi->context.c2.push_ifconfig_local = mi->context.options.push_ifconfig_local; + mi->context.c2.push_ifconfig_remote_netmask = mi->context.options.push_ifconfig_remote_netmask; + } + else if (m->ifconfig_pool && mi->vaddr_handle < 0) /* otherwise, choose a pool address */ + { + in_addr_t local=0, remote=0; + const char *cn = NULL; + + if (!mi->context.options.duplicate_cn) + cn = tls_common_name (mi->context.c2.tls_multi, true); + + mi->vaddr_handle = ifconfig_pool_acquire (m->ifconfig_pool, &local, &remote, cn); + if (mi->vaddr_handle >= 0) + { + /* use pool ifconfig address(es) */ + mi->context.c2.push_ifconfig_local = remote; + if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN) + { + if (mi->context.options.ifconfig_pool_linear) + mi->context.c2.push_ifconfig_remote_netmask = mi->context.c1.tuntap->local; + else + mi->context.c2.push_ifconfig_remote_netmask = local; + mi->context.c2.push_ifconfig_defined = true; + } + else if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TAP) + { + mi->context.c2.push_ifconfig_remote_netmask = mi->context.options.ifconfig_pool_netmask; + if (!mi->context.c2.push_ifconfig_remote_netmask) + mi->context.c2.push_ifconfig_remote_netmask = mi->context.c1.tuntap->remote_netmask; + if (mi->context.c2.push_ifconfig_remote_netmask) + mi->context.c2.push_ifconfig_defined = true; + else + msg (D_MULTI_ERRORS, "MULTI: no --ifconfig-pool netmask parameter is available to push to %s", + multi_instance_string (mi, false, &gc)); + } + } + else + { + msg (D_MULTI_ERRORS, "MULTI: no free --ifconfig-pool addresses are available"); + } + } + gc_free (&gc); +} + +/* + * Set virtual address environmental variables. + */ +static void +multi_set_virtual_addr_env (struct multi_context *m, struct multi_instance *mi) +{ + setenv_del (mi->context.c2.es, "ifconfig_pool_local_ip"); + setenv_del (mi->context.c2.es, "ifconfig_pool_remote_ip"); + setenv_del (mi->context.c2.es, "ifconfig_pool_netmask"); + + if (mi->context.c2.push_ifconfig_defined) + { + setenv_in_addr_t (mi->context.c2.es, + "ifconfig_pool_remote_ip", + mi->context.c2.push_ifconfig_local, + SA_SET_IF_NONZERO); + + if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN) + { + setenv_in_addr_t (mi->context.c2.es, + "ifconfig_pool_local_ip", + mi->context.c2.push_ifconfig_remote_netmask, + SA_SET_IF_NONZERO); + } + else if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TAP) + { + setenv_in_addr_t (mi->context.c2.es, + "ifconfig_pool_netmask", + mi->context.c2.push_ifconfig_remote_netmask, + SA_SET_IF_NONZERO); + } + } +} + +/* + * Called after client-connect script or plug-in is called + */ +static void +multi_client_connect_post (struct multi_context *m, + struct multi_instance *mi, + const char *dc_file, + unsigned int option_permissions_mask, + unsigned int *option_types_found) +{ + /* Did script generate a dynamic config file? */ + if (test_file (dc_file)) + { + options_server_import (&mi->context.options, + dc_file, + D_IMPORT_ERRORS|M_OPTERR, + option_permissions_mask, + option_types_found, + mi->context.c2.es); + + if (!delete_file (dc_file)) + msg (D_MULTI_ERRORS, "MULTI: problem deleting temporary file: %s", + dc_file); + + /* + * If the --client-connect script generates a config file + * with an --ifconfig-push directive, it will override any + * --ifconfig-push directive from the --client-config-dir + * directory or any --ifconfig-pool dynamic address. + */ + multi_select_virtual_addr (m, mi); + multi_set_virtual_addr_env (m, mi); + } +} + +/* + * Called as soon as the SSL/TLS connection authenticates. + * + * Instance-specific directives to be processed: + * + * iroute start-ip end-ip + * ifconfig-push local remote-netmask + * push + */ +static void +multi_connection_established (struct multi_context *m, struct multi_instance *mi) +{ + if (tls_authenticated (mi->context.c2.tls_multi)) + { + struct gc_arena gc = gc_new (); + unsigned int option_types_found = 0; + const unsigned int option_permissions_mask = OPT_P_INSTANCE|OPT_P_INHERIT|OPT_P_PUSH|OPT_P_TIMER|OPT_P_CONFIG|OPT_P_ECHO; + int cc_succeeded = true; /* client connect script status */ + int cc_succeeded_count = 0; + + ASSERT (mi->context.c1.tuntap); + + /* lock down the common name so it can't change during future TLS renegotiations */ + tls_lock_common_name (mi->context.c2.tls_multi); + + /* generate a msg() prefix for this client instance */ + generate_prefix (mi); + + /* delete instances of previous clients with same common-name */ + if (!mi->context.options.duplicate_cn) + multi_delete_dup (m, mi); + + /* reset pool handle to null */ + mi->vaddr_handle = -1; + + /* + * Try to source a dynamic config file from the + * --client-config-dir directory. + */ + if (mi->context.options.client_config_dir) + { + const char *ccd_file; + + ccd_file = gen_path (mi->context.options.client_config_dir, + tls_common_name (mi->context.c2.tls_multi, false), + &gc); + + /* try common-name file */ + if (test_file (ccd_file)) + { + options_server_import (&mi->context.options, + ccd_file, + D_IMPORT_ERRORS|M_OPTERR, + option_permissions_mask, + &option_types_found, + mi->context.c2.es); + } + else /* try default file */ + { + ccd_file = gen_path (mi->context.options.client_config_dir, + CCD_DEFAULT, + &gc); + + if (test_file (ccd_file)) + { + options_server_import (&mi->context.options, + ccd_file, + D_IMPORT_ERRORS|M_OPTERR, + option_permissions_mask, + &option_types_found, + mi->context.c2.es); + } + } + } + + /* + * Select a virtual address from either --ifconfig-push in --client-config-dir file + * or --ifconfig-pool. + */ + multi_select_virtual_addr (m, mi); + + /* setenv incoming cert common name for script */ + setenv_str (mi->context.c2.es, "common_name", tls_common_name (mi->context.c2.tls_multi, true)); + + /* setenv client real IP address */ + setenv_trusted (mi->context.c2.es, get_link_socket_info (&mi->context)); + + /* setenv client virtual IP address */ + multi_set_virtual_addr_env (m, mi); + + /* + * Call client-connect plug-in. + */ + if (plugin_defined (m->top.c1.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT)) + { + const char *dc_file = create_temp_filename (mi->context.options.tmp_dir, &gc); + + delete_file (dc_file); + + if (plugin_call (m->top.c1.plugins, OPENVPN_PLUGIN_CLIENT_CONNECT, dc_file, mi->context.c2.es)) + { + msg (M_WARN, "WARNING: client-connect plugin call failed"); + cc_succeeded = false; + } + else + { + multi_client_connect_post (m, mi, dc_file, option_permissions_mask, &option_types_found); + ++cc_succeeded_count; + } + } + + /* + * Run --client-connect script. + */ + if (mi->context.options.client_connect_script && cc_succeeded) + { + struct buffer cmd = alloc_buf_gc (256, &gc); + const char *dc_file = NULL; + + setenv_str (mi->context.c2.es, "script_type", "client-connect"); + + dc_file = create_temp_filename (mi->context.options.tmp_dir, &gc); + + delete_file (dc_file); + + buf_printf (&cmd, "%s %s", + mi->context.options.client_connect_script, + dc_file); + + if (system_check (BSTR (&cmd), mi->context.c2.es, S_SCRIPT, "client-connect command failed")) + { + multi_client_connect_post (m, mi, dc_file, option_permissions_mask, &option_types_found); + ++cc_succeeded_count; + } + else + cc_succeeded = false; + } + + /* + * Check for "disable" directive in client-config-dir file + * or config file generated by --client-connect script. + */ + if (mi->context.options.disable) + { + msg (D_MULTI_ERRORS, "MULTI: client has been rejected due to 'disable' directive"); + cc_succeeded = false; + } + + if (cc_succeeded) + { + /* + * Process sourced options. + */ + do_deferred_options (&mi->context, option_types_found); + + /* + * make sure we got ifconfig settings from somewhere + */ + if (!mi->context.c2.push_ifconfig_defined) + { + msg (D_MULTI_ERRORS, "MULTI: no dynamic or static remote --ifconfig address is available for %s", + multi_instance_string (mi, false, &gc)); + } + + /* + * For routed tunnels, set up internal route to endpoint + * plus add all iroute routes. + */ + if (TUNNEL_TYPE (mi->context.c1.tuntap) == DEV_TYPE_TUN) + { + if (mi->context.c2.push_ifconfig_defined) + { + multi_learn_in_addr_t (m, mi, mi->context.c2.push_ifconfig_local, -1); + msg (D_MULTI_LOW, "MULTI: primary virtual IP for %s: %s", + multi_instance_string (mi, false, &gc), + print_in_addr_t (mi->context.c2.push_ifconfig_local, 0, &gc)); + } + + /* add routes locally, pointing to new client, if + --iroute options have been specified */ + multi_add_iroutes (m, mi); + + /* + * iroutes represent subnets which are "owned" by a particular + * client. Therefore, do not actually push a route to a client + * if it matches one of the client's iroutes. + */ + remove_iroutes_from_push_route_list (&mi->context.options); + } + else if (mi->context.options.iroutes) + { + msg (D_MULTI_ERRORS, "MULTI: --iroute options rejected for %s -- iroute only works with tun-style tunnels", + multi_instance_string (mi, false, &gc)); + } + + /* set our client's VPN endpoint for status reporting purposes */ + mi->reporting_addr = mi->context.c2.push_ifconfig_local; + + /* set context-level authentication flag */ + mi->context.c2.context_auth = CAS_SUCCEEDED; + } + else + { + /* set context-level authentication flag */ + mi->context.c2.context_auth = cc_succeeded_count ? CAS_PARTIAL : CAS_FAILED; + } + + /* set flag so we don't get called again */ + mi->connection_established_flag = true; + + gc_free (&gc); + } + + /* + * Reply now to client's PUSH_REQUEST query + */ + mi->context.c2.push_reply_deferred = false; +} + +/* + * Add a mbuf buffer to a particular + * instance. + */ +void +multi_add_mbuf (struct multi_context *m, + struct multi_instance *mi, + struct mbuf_buffer *mb) +{ + if (multi_output_queue_ready (m, mi)) + { + struct mbuf_item item; + item.buffer = mb; + item.instance = mi; + mbuf_add_item (m->mbuf, &item); + } + else + { + msg (D_MULTI_DROPPED, "MULTI: packet dropped due to output saturation (multi_add_mbuf)"); + } +} + +/* + * Add a packet to a client instance output queue. + */ +static inline void +multi_unicast (struct multi_context *m, + const struct buffer *buf, + struct multi_instance *mi) +{ + struct mbuf_buffer *mb; + + if (BLEN (buf) > 0) + { + mb = mbuf_alloc_buf (buf); + mb->flags = MF_UNICAST; + multi_add_mbuf (m, mi, mb); + mbuf_free_buf (mb); + } +} + +/* + * Broadcast a packet to all clients. + */ +void +multi_bcast (struct multi_context *m, + const struct buffer *buf, + struct multi_instance *omit) +{ + struct hash_iterator hi; + struct hash_element *he; + struct multi_instance *mi; + struct mbuf_buffer *mb; + + if (BLEN (buf) > 0) + { + perf_push (PERF_MULTI_BCAST); +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("BCAST len=%d\n", BLEN (buf)); +#endif + mb = mbuf_alloc_buf (buf); + hash_iterator_init (m->iter, &hi, true); + + while ((he = hash_iterator_next (&hi))) + { + mi = (struct multi_instance *) he->value; + if (mi != omit && !mi->halt) + multi_add_mbuf (m, mi, mb); + } + + hash_iterator_free (&hi); + mbuf_free_buf (mb); + perf_pop (); + } +} + +/* + * Given a time delta, indicating that we wish to be + * awoken by the scheduler at time now + delta, figure + * a sigma parameter (in microseconds) that represents + * a sort of fuzz factor around delta, so that we're + * really telling the scheduler to wake us up any time + * between now + delta - sigma and now + delta + sigma. + * + * The sigma parameter helps the scheduler to run more efficiently. + * Sigma should be no larger than TV_WITHIN_SIGMA_MAX_USEC + */ +static inline unsigned int +compute_wakeup_sigma (const struct timeval *delta) +{ + if (delta->tv_sec < 1) + { + /* if < 1 sec, fuzz = # of microseconds / 8 */ + return delta->tv_usec >> 3; + } + else + { + /* if < 10 minutes, fuzz = 13.1% of timeout */ + if (delta->tv_sec < 600) + return delta->tv_sec << 17; + else + return 120000000; /* if >= 10 minutes, fuzz = 2 minutes */ + } +} + +/* + * Figure instance-specific timers, convert + * earliest to absolute time in mi->wakeup, + * call scheduler with our future wakeup time. + * + * Also close context on signal. + */ +bool +multi_process_post (struct multi_context *m, struct multi_instance *mi, const unsigned int flags) +{ + bool ret = true; + + if (!IS_SIG (&mi->context) && ((flags & MPP_PRE_SELECT) || ((flags & MPP_CONDITIONAL_PRE_SELECT) && !ANY_OUT (&mi->context)))) + { + /* figure timeouts and fetch possible outgoing + to_link packets (such as ping or TLS control) */ + pre_select (&mi->context); + + if (!IS_SIG (&mi->context)) + { + /* calculate an absolute wakeup time */ + ASSERT (!gettimeofday (&mi->wakeup, NULL)); + tv_add (&mi->wakeup, &mi->context.c2.timeval); + + /* tell scheduler to wake us up at some point in the future */ + schedule_add_entry (m->schedule, + (struct schedule_entry *) mi, + &mi->wakeup, + compute_wakeup_sigma (&mi->context.c2.timeval)); + + /* connection is "established" when SSL/TLS key negotiation succeeds + and (if specified) auth user/pass succeeds */ + if (!mi->connection_established_flag && CONNECTION_ESTABLISHED (&mi->context)) + multi_connection_established (m, mi); + } + } + + if (IS_SIG (&mi->context)) + { + if (flags & MPP_CLOSE_ON_SIGNAL) + { + multi_close_instance_on_signal (m, mi); + ret = false; + } + } + else + { + /* continue to pend on output? */ + multi_set_pending (m, ANY_OUT (&mi->context) ? mi : NULL); + +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("POST %s[%d] to=%d lo=%d/%d w=%d/%d\n", + id(mi), + (int) (mi == m->pending), + mi ? mi->context.c2.to_tun.len : -1, + mi ? mi->context.c2.to_link.len : -1, + (mi && mi->context.c2.fragment) ? mi->context.c2.fragment->outgoing.len : -1, + (int)mi->context.c2.timeval.tv_sec, + (int)mi->context.c2.timeval.tv_usec); +#endif + } + + if ((flags & MPP_RECORD_TOUCH) && m->mpp_touched) + *m->mpp_touched = mi; + + return ret; +} + +/* + * Process packets in the TCP/UDP socket -> TUN/TAP interface direction, + * i.e. client -> server direction. + */ +bool +multi_process_incoming_link (struct multi_context *m, struct multi_instance *instance, const unsigned int mpp_flags) +{ + struct gc_arena gc = gc_new (); + + struct context *c; + struct mroute_addr src, dest; + unsigned int mroute_flags; + struct multi_instance *mi; + bool ret = true; + + ASSERT (!m->pending); + + if (!instance) + { +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("TCP/UDP -> TUN [%d]\n", BLEN (&m->top.c2.buf)); +#endif + multi_set_pending (m, multi_get_create_instance_udp (m)); + } + else + multi_set_pending (m, instance); + + if (m->pending) + { + set_prefix (m->pending); + + /* get instance context */ + c = &m->pending->context; + + if (!instance) + { + /* transfer packet pointer from top-level context buffer to instance */ + c->c2.buf = m->top.c2.buf; + + /* transfer from-addr from top-level context buffer to instance */ + c->c2.from = m->top.c2.from; + } + + if (BLEN (&c->c2.buf) > 0) + { + /* decrypt in instance context */ + process_incoming_link (c); + + if (TUNNEL_TYPE (m->top.c1.tuntap) == DEV_TYPE_TUN) + { + /* extract packet source and dest addresses */ + mroute_flags = mroute_extract_addr_from_packet (&src, + &dest, + &c->c2.to_tun, + DEV_TYPE_TUN); + + /* drop packet if extract failed */ + if (!(mroute_flags & MROUTE_EXTRACT_SUCCEEDED)) + { + c->c2.to_tun.len = 0; + } + /* make sure that source address is associated with this client */ + else if (multi_get_instance_by_virtual_addr (m, &src, true) != m->pending) + { + msg (D_MULTI_DROPPED, "MULTI: bad source address from client [%s], packet dropped", + mroute_addr_print (&src, &gc)); + c->c2.to_tun.len = 0; + } + /* client-to-client communication enabled? */ + else if (m->enable_c2c) + { + /* multicast? */ + if (mroute_flags & MROUTE_EXTRACT_MCAST) + { + /* for now, treat multicast as broadcast */ + multi_bcast (m, &c->c2.to_tun, m->pending); + } + else /* possible client to client routing */ + { + ASSERT (!(mroute_flags & MROUTE_EXTRACT_BCAST)); + mi = multi_get_instance_by_virtual_addr (m, &dest, true); + + /* if dest addr is a known client, route to it */ + if (mi) + { + multi_unicast (m, &c->c2.to_tun, mi); + register_activity (c); + c->c2.to_tun.len = 0; + } + } + } + } + else if (TUNNEL_TYPE (m->top.c1.tuntap) == DEV_TYPE_TAP) + { + /* extract packet source and dest addresses */ + mroute_flags = mroute_extract_addr_from_packet (&src, + &dest, + &c->c2.to_tun, + DEV_TYPE_TAP); + + if (mroute_flags & MROUTE_EXTRACT_SUCCEEDED) + { + if (multi_learn_addr (m, m->pending, &src, 0) == m->pending) + { + /* check for broadcast */ + if (m->enable_c2c) + { + if (mroute_flags & (MROUTE_EXTRACT_BCAST|MROUTE_EXTRACT_MCAST)) + { + multi_bcast (m, &c->c2.to_tun, m->pending); + } + else /* try client-to-client routing */ + { + mi = multi_get_instance_by_virtual_addr (m, &dest, false); + + /* if dest addr is a known client, route to it */ + if (mi) + { + multi_unicast (m, &c->c2.to_tun, mi); + register_activity (c); + c->c2.to_tun.len = 0; + } + } + } + } + else + { + msg (D_MULTI_DROPPED, "MULTI: bad source address from client [%s], packet dropped", + mroute_addr_print (&src, &gc)); + c->c2.to_tun.len = 0; + } + } + else + { + c->c2.to_tun.len = 0; + } + } + } + + /* postprocess and set wakeup */ + ret = multi_process_post (m, m->pending, mpp_flags); + + clear_prefix (); + } + + gc_free (&gc); + return ret; +} + +/* + * Process packets in the TUN/TAP interface -> TCP/UDP socket direction, + * i.e. server -> client direction. + */ +bool +multi_process_incoming_tun (struct multi_context *m, const unsigned int mpp_flags) +{ + struct gc_arena gc = gc_new (); + bool ret = true; + + if (BLEN (&m->top.c2.buf) > 0) + { + unsigned int mroute_flags; + struct mroute_addr src, dest; + const int dev_type = TUNNEL_TYPE (m->top.c1.tuntap); + +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("TUN -> TCP/UDP [%d]\n", BLEN (&m->top.c2.buf)); +#endif + + ASSERT (!m->pending); + + /* + * Route an incoming tun/tap packet to + * the appropriate multi_instance object. + */ + + mroute_flags = mroute_extract_addr_from_packet (&src, + &dest, + &m->top.c2.buf, + dev_type); + + if (mroute_flags & MROUTE_EXTRACT_SUCCEEDED) + { + struct context *c; + + /* broadcast or multicast dest addr? */ + if (mroute_flags & (MROUTE_EXTRACT_BCAST|MROUTE_EXTRACT_MCAST)) + { + /* for now, treat multicast as broadcast */ + multi_bcast (m, &m->top.c2.buf, NULL); + } + else + { + multi_set_pending (m, multi_get_instance_by_virtual_addr (m, &dest, dev_type == DEV_TYPE_TUN)); + + if (m->pending) + { + /* get instance context */ + c = &m->pending->context; + + set_prefix (m->pending); + + if (multi_output_queue_ready (m, m->pending)) + { + /* transfer packet pointer from top-level context buffer to instance */ + c->c2.buf = m->top.c2.buf; + } + else + { + /* drop packet */ + msg (D_MULTI_DROPPED, "MULTI: packet dropped due to output saturation (multi_process_incoming_tun)"); + buf_clear (&c->c2.buf); + } + + /* encrypt in instance context */ + process_incoming_tun (c); + + /* postprocess and set wakeup */ + ret = multi_process_post (m, m->pending, mpp_flags); + + clear_prefix (); + } + } + } + } + gc_free (&gc); + return ret; +} + +/* + * Process a possible client-to-client/bcast/mcast message in the + * queue. + */ +struct multi_instance * +multi_get_queue (struct mbuf_set *ms) +{ + struct mbuf_item item; + + if (mbuf_extract_item (ms, &item, true)) /* cleartext IP packet */ + { + unsigned int pipv4_flags = PIPV4_PASSTOS; + + set_prefix (item.instance); + item.instance->context.c2.buf = item.buffer->buf; + if (item.buffer->flags & MF_UNICAST) /* --mssfix doesn't make sense for broadcast or multicast */ + pipv4_flags |= PIPV4_MSSFIX; + process_ipv4_header (&item.instance->context, pipv4_flags, &item.instance->context.c2.buf); + encrypt_sign (&item.instance->context, true); + mbuf_free_buf (item.buffer); + + dmsg (D_MULTI_DEBUG, "MULTI: C2C/MCAST/BCAST"); + + clear_prefix (); + return item.instance; + } + else + { + return NULL; + } +} + +/* + * Called when an I/O wait times out. Usually means that a particular + * client instance object needs timer-based service. + */ +bool +multi_process_timeout (struct multi_context *m, const unsigned int mpp_flags) +{ + bool ret = true; + +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("%s -> TIMEOUT\n", id(m->earliest_wakeup)); +#endif + + /* instance marked for wakeup? */ + if (m->earliest_wakeup) + { + set_prefix (m->earliest_wakeup); + ret = multi_process_post (m, m->earliest_wakeup, mpp_flags); + m->earliest_wakeup = NULL; + clear_prefix (); + } + return ret; +} + +/* + * Drop a TUN/TAP outgoing packet.. + */ +void +multi_process_drop_outgoing_tun (struct multi_context *m, const unsigned int mpp_flags) +{ + struct multi_instance *mi = m->pending; + + ASSERT (mi); + + set_prefix (mi); + + msg (D_MULTI_ERRORS, "MULTI: Outgoing TUN queue full, dropped packet len=%d", + mi->context.c2.to_tun.len); + + buf_reset (&mi->context.c2.to_tun); + + multi_process_post (m, mi, mpp_flags); + clear_prefix (); +} + +/* + * Per-client route quota management + */ + +void +route_quota_exceeded (const struct multi_context *m, const struct multi_instance *mi) +{ + struct gc_arena gc = gc_new (); + msg (D_ROUTE_QUOTA, "MULTI ROUTE: route quota (%d) exceeded for %s (see --max-routes-per-client option)", + mi->context.options.max_routes_per_client, + multi_instance_string (mi, false, &gc)); + gc_free (&gc); +} + +#ifdef ENABLE_DEBUG +/* + * Flood clients with random packets + */ +static void +gremlin_flood_clients (struct multi_context *m) +{ + const int level = GREMLIN_PACKET_FLOOD_LEVEL (m->top.options.gremlin); + if (level) + { + struct gc_arena gc = gc_new (); + struct buffer buf = alloc_buf_gc (BUF_SIZE (&m->top.c2.frame), &gc); + struct packet_flood_parms parm = get_packet_flood_parms (level); + int i; + + ASSERT (buf_init (&buf, FRAME_HEADROOM (&m->top.c2.frame))); + parm.packet_size = min_int (parm.packet_size, MAX_RW_SIZE_TUN (&m->top.c2.frame)); + + msg (D_GREMLIN, "GREMLIN_FLOOD_CLIENTS: flooding clients with %d packets of size %d", + parm.n_packets, + parm.packet_size); + + for (i = 0; i < parm.packet_size; ++i) + ASSERT (buf_write_u8 (&buf, get_random () & 0xFF)); + + for (i = 0; i < parm.n_packets; ++i) + multi_bcast (m, &buf, NULL); + + gc_free (&gc); + } +} +#endif + +/* + * Process timers in the top-level context + */ +void +multi_process_per_second_timers_dowork (struct multi_context *m) +{ + /* possibly reap instances/routes in vhash */ + multi_reap_process (m); + + /* possibly print to status log */ + if (m->top.c1.status_output) + { + if (status_trigger (m->top.c1.status_output)) + multi_print_status (m, m->top.c1.status_output, m->status_file_version); + } + + /* possibly flush ifconfig-pool file */ + multi_ifconfig_pool_persist (m, false); + +#ifdef ENABLE_DEBUG + gremlin_flood_clients (m); +#endif +} + +void +multi_top_init (struct multi_context *m, const struct context *top, const bool alloc_buffers) +{ + inherit_context_top (&m->top, top); + m->top.c2.buffers = NULL; + if (alloc_buffers) + m->top.c2.buffers = init_context_buffers (&top->c2.frame); +} + +void +multi_top_free (struct multi_context *m) +{ + close_context (&m->top, -1, CC_GC_FREE); + free_context_buffers (m->top.c2.buffers); +} + +/* + * Return true if event loop should break, + * false if it should continue. + */ +bool +multi_process_signal (struct multi_context *m) +{ + if (m->top.sig->signal_received == SIGUSR2) + { + struct status_output *so = status_open (NULL, 0, M_INFO, NULL, 0); + multi_print_status (m, so, m->status_file_version); + status_close (so); + m->top.sig->signal_received = 0; + return false; + } + return true; +} + +/* + * Called when an instance should be closed due to the + * reception of a soft signal. + */ +void +multi_close_instance_on_signal (struct multi_context *m, struct multi_instance *mi) +{ + remap_signal (&mi->context); + set_prefix (mi); + print_signal (mi->context.sig, "client-instance", D_MULTI_LOW); + clear_prefix (); + multi_close_instance (m, mi, false); +} + +static void +multi_signal_instance (struct multi_context *m, struct multi_instance *mi, const int sig) +{ + mi->context.sig->signal_received = sig; + multi_close_instance_on_signal (m, mi); +} + +/* + * Management subsystem callbacks + */ + +#ifdef ENABLE_MANAGEMENT + +static void +management_callback_status (void *arg, const int version, struct status_output *so) +{ + struct multi_context *m = (struct multi_context *) arg; + + if (!version) + multi_print_status (m, so, m->status_file_version); + else + multi_print_status (m, so, version); +} + +static int +management_callback_kill_by_cn (void *arg, const char *del_cn) +{ + struct multi_context *m = (struct multi_context *) arg; + struct hash_iterator hi; + struct hash_element *he; + int count = 0; + + hash_iterator_init (m->iter, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct multi_instance *mi = (struct multi_instance *) he->value; + if (!mi->halt) + { + const char *cn = tls_common_name (mi->context.c2.tls_multi, false); + if (cn && !strcmp (cn, del_cn)) + { + multi_signal_instance (m, mi, SIGTERM); + ++count; + } + } + } + hash_iterator_free (&hi); + return count; +} + +static int +management_callback_kill_by_addr (void *arg, const in_addr_t addr, const int port) +{ + struct multi_context *m = (struct multi_context *) arg; + struct hash_iterator hi; + struct hash_element *he; + struct sockaddr_in saddr; + struct mroute_addr maddr; + int count = 0; + + CLEAR (saddr); + saddr.sin_family = AF_INET; + saddr.sin_addr.s_addr = htonl (addr); + saddr.sin_port = htons (port); + if (mroute_extract_sockaddr_in (&maddr, &saddr, true)) + { + hash_iterator_init (m->iter, &hi, true); + while ((he = hash_iterator_next (&hi))) + { + struct multi_instance *mi = (struct multi_instance *) he->value; + if (!mi->halt && mroute_addr_equal (&maddr, &mi->real)) + { + multi_signal_instance (m, mi, SIGTERM); + ++count; + } + } + hash_iterator_free (&hi); + } + return count; +} + +static void +management_delete_event (void *arg, event_t event) +{ + struct multi_context *m = (struct multi_context *) arg; + if (m->mtcp) + multi_tcp_delete_event (m->mtcp, event); +} + +#endif + +void +init_management_callback_multi (struct multi_context *m) +{ +#ifdef ENABLE_MANAGEMENT + if (management) + { + struct management_callback cb; + CLEAR (cb); + cb.arg = m; + cb.status = management_callback_status; + cb.show_net = management_show_net_callback; + cb.kill_by_cn = management_callback_kill_by_cn; + cb.kill_by_addr = management_callback_kill_by_addr; + cb.delete_event = management_delete_event; + management_set_callback (management, &cb); + } +#endif +} + +void +uninit_management_callback_multi (struct multi_context *m) +{ + uninit_management_callback (); +} + +/* + * Top level event loop. + */ +void +tunnel_server (struct context *top) +{ + ASSERT (top->options.mode == MODE_SERVER); + + switch (top->options.proto) { + case PROTO_UDPv4: + tunnel_server_udp (top); + break; + case PROTO_TCPv4_SERVER: + tunnel_server_tcp (top); + break; + default: + ASSERT (0); + } +} + +#else +static void dummy(void) {} +#endif /* P2MP_SERVER */ @@ -0,0 +1,445 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MULTI_H +#define MULTI_H + +#if P2MP_SERVER + +#include "init.h" +#include "forward.h" +#include "mroute.h" +#include "mbuf.h" +#include "list.h" +#include "schedule.h" +#include "pool.h" +#include "mudp.h" +#include "mtcp.h" +#include "perf.h" + +/* + * Walk (don't run) through the routing table, + * deleting old entries, and possibly multi_instance + * structs as well which have been marked for deletion. + */ +struct multi_reap +{ + int bucket_base; + int buckets_per_pass; + time_t last_call; +}; + +/* + * One multi_instance object per client instance. + */ +struct multi_instance { + struct schedule_entry se; /* this must be the first element of the structure */ + struct gc_arena gc; + MUTEX_DEFINE (mutex); + bool defined; + bool halt; + int refcount; + int route_count; /* number of routes (including cached routes) owned by this instance */ + time_t created; + struct timeval wakeup; /* absolute time */ + struct mroute_addr real; + ifconfig_pool_handle vaddr_handle; + const char *msg_prefix; + + /* queued outgoing data in Server/TCP mode */ + unsigned int tcp_rwflags; + struct mbuf_set *tcp_link_out_deferred; + bool socket_set_called; + + in_addr_t reporting_addr; /* IP address shown in status listing */ + + bool did_open_context; + bool did_real_hash; + bool did_iter; + bool connection_established_flag; + bool did_iroutes; + + struct context context; +}; + +/* + * One multi_context object per server daemon thread. + */ +struct multi_context { +# define MC_UNDEF 0 +# define MC_SINGLE_THREADED (1<<0) +# define MC_MULTI_THREADED_MASTER (1<<1) +# define MC_MULTI_THREADED_WORKER (1<<2) +# define MC_MULTI_THREADED_SCHEDULER (1<<3) +# define MC_WORK_THREAD (MC_MULTI_THREADED_WORKER|MC_MULTI_THREADED_SCHEDULER) + int thread_mode; + + struct hash *hash; /* client instances indexed by real address */ + struct hash *vhash; /* client instances indexed by virtual address */ + struct hash *iter; /* like real address hash but optimized for iteration */ + struct schedule *schedule; + struct mbuf_set *mbuf; + struct multi_tcp *mtcp; + struct ifconfig_pool *ifconfig_pool; + struct frequency_limit *new_connection_limiter; + struct mroute_helper *route_helper; + struct multi_reap *reaper; + struct mroute_addr local; + bool enable_c2c; + int max_clients; + int tcp_queue_limit; + int status_file_version; + + struct multi_instance *pending; + struct multi_instance *earliest_wakeup; + struct multi_instance **mpp_touched; + struct context_buffers *context_buffers; + time_t per_second_trigger; + + struct context top; +}; + +/* + * Host route + */ +struct multi_route +{ + struct mroute_addr addr; + struct multi_instance *instance; + +# define MULTI_ROUTE_CACHE (1<<0) +# define MULTI_ROUTE_AGEABLE (1<<1) + unsigned int flags; + + unsigned int cache_generation; + time_t last_reference; +}; + +/* + * top level function, called by openvpn.c + */ +void tunnel_server (struct context *top); + +const char *multi_instance_string (const struct multi_instance *mi, bool null, struct gc_arena *gc); + +void multi_bcast (struct multi_context *m, + const struct buffer *buf, + struct multi_instance *omit); + +/* + * Called by mtcp.c, mudp.c, or other (to be written) protocol drivers + */ + +void multi_init (struct multi_context *m, struct context *t, bool tcp_mode, int thread_mode); +void multi_uninit (struct multi_context *m); + +void multi_top_init (struct multi_context *m, const struct context *top, const bool alloc_buffers); +void multi_top_free (struct multi_context *m); + +struct multi_instance *multi_create_instance (struct multi_context *m, const struct mroute_addr *real); +void multi_close_instance (struct multi_context *m, struct multi_instance *mi, bool shutdown); + +bool multi_process_timeout (struct multi_context *m, const unsigned int mpp_flags); + +#define MPP_PRE_SELECT (1<<0) +#define MPP_CONDITIONAL_PRE_SELECT (1<<1) +#define MPP_CLOSE_ON_SIGNAL (1<<2) +#define MPP_RECORD_TOUCH (1<<3) +bool multi_process_post (struct multi_context *m, struct multi_instance *mi, const unsigned int flags); + +bool multi_process_incoming_link (struct multi_context *m, struct multi_instance *instance, const unsigned int mpp_flags); +bool multi_process_incoming_tun (struct multi_context *m, const unsigned int mpp_flags); + +void multi_process_drop_outgoing_tun (struct multi_context *m, const unsigned int mpp_flags); + +void multi_print_status (struct multi_context *m, struct status_output *so, const int version); + +struct multi_instance *multi_get_queue (struct mbuf_set *ms); + +void multi_add_mbuf (struct multi_context *m, + struct multi_instance *mi, + struct mbuf_buffer *mb); + +void multi_ifconfig_pool_persist (struct multi_context *m, bool force); + +bool multi_process_signal (struct multi_context *m); + +void multi_close_instance_on_signal (struct multi_context *m, struct multi_instance *mi); + +void init_management_callback_multi (struct multi_context *m); +void uninit_management_callback_multi (struct multi_context *m); + +/* + * Return true if our output queue is not full + */ +static inline bool +multi_output_queue_ready (const struct multi_context *m, + const struct multi_instance *mi) +{ + if (mi->tcp_link_out_deferred) + return mbuf_len (mi->tcp_link_out_deferred) <= m->tcp_queue_limit; + else + return true; +} + +/* + * Determine which instance has pending output + * and prepare the output for sending in + * the to_link buffer. + */ +static inline struct multi_instance * +multi_process_outgoing_link_pre (struct multi_context *m) +{ + struct multi_instance *mi = NULL; + + if (m->pending) + mi = m->pending; + else if (mbuf_defined (m->mbuf)) + mi = multi_get_queue (m->mbuf); + return mi; +} + +/* + * Per-client route quota management + */ + +void route_quota_exceeded (const struct multi_context *m, const struct multi_instance *mi); + +static inline void +route_quota_inc (struct multi_instance *mi) +{ + ++mi->route_count; +} + +static inline void +route_quota_dec (struct multi_instance *mi) +{ + --mi->route_count; +} + +/* can we add a new route? */ +static inline bool +route_quota_test (const struct multi_context *m, const struct multi_instance *mi) +{ + if (mi->route_count >= mi->context.options.max_routes_per_client) + { + route_quota_exceeded (m, mi); + return false; + } + else + return true; +} + +/* + * Instance reference counting + */ + +static inline void +multi_instance_inc_refcount (struct multi_instance *mi) +{ + ++mi->refcount; +} + +static inline void +multi_instance_dec_refcount (struct multi_instance *mi) +{ + if (--mi->refcount <= 0) + { + gc_free (&mi->gc); + mutex_destroy (&mi->mutex); + free (mi); + } +} + +static inline void +multi_route_del (struct multi_route *route) +{ + struct multi_instance *mi = route->instance; + route_quota_dec (mi); + multi_instance_dec_refcount (mi); + free (route); +} + +static inline bool +multi_route_defined (const struct multi_context *m, + const struct multi_route *r) +{ + if (r->instance->halt) + return false; + else if ((r->flags & MULTI_ROUTE_CACHE) + && r->cache_generation != m->route_helper->cache_generation) + return false; + else if ((r->flags & MULTI_ROUTE_AGEABLE) + && r->last_reference + m->route_helper->ageable_ttl_secs < now) + return false; + else + return true; +} + +/* + * Set a msg() function prefix with our current client instance ID. + */ + +static inline void +set_prefix (struct multi_instance *mi) +{ +#ifdef MULTI_DEBUG_EVENT_LOOP + if (mi->msg_prefix) + printf ("[%s]\n", mi->msg_prefix); +#endif + msg_set_prefix (mi->msg_prefix); +} + +static inline void +clear_prefix (void) +{ +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("[NULL]\n"); +#endif + msg_set_prefix (NULL); +} + +/* + * Instance Reaper + * + * Reaper constants. The reaper is the process where the virtual address + * and virtual route hash table is scanned for dead entries which are + * then removed. The hash table could potentially be quite large, so we + * don't want to reap in a single pass. + */ + +#define REAP_MAX_WAKEUP 10 /* Do reap pass at least once per n seconds */ +#define REAP_DIVISOR 256 /* How many passes to cover whole hash table */ +#define REAP_MIN 16 /* Minimum number of buckets per pass */ +#define REAP_MAX 1024 /* Maximum number of buckets per pass */ + +/* + * Mark a cached host route for deletion after this + * many seconds without any references. + */ +#define MULTI_CACHE_ROUTE_TTL 60 + +static inline void +multi_reap_process (const struct multi_context *m) +{ + void multi_reap_process_dowork (const struct multi_context *m); + if (m->reaper->last_call != now) + multi_reap_process_dowork (m); +} + +static inline void +multi_process_per_second_timers (struct multi_context *m) +{ + if (m->per_second_trigger != now) + { + void multi_process_per_second_timers_dowork (struct multi_context *m); + multi_process_per_second_timers_dowork (m); + m->per_second_trigger = now; + } +} + +/* + * Compute earliest timeout expiry from the set of + * all instances. Output: + * + * m->earliest_wakeup : instance needing the earliest service. + * dest : earliest timeout as a delta in relation + * to current time. + */ +static inline void +multi_get_timeout (struct multi_context *m, struct timeval *dest) +{ + struct timeval tv, current; + + CLEAR (tv); + m->earliest_wakeup = (struct multi_instance *) schedule_get_earliest_wakeup (m->schedule, &tv); + if (m->earliest_wakeup) + { + ASSERT (!gettimeofday (¤t, NULL)); + tv_delta (dest, ¤t, &tv); + if (dest->tv_sec >= REAP_MAX_WAKEUP) + { + m->earliest_wakeup = NULL; + dest->tv_sec = REAP_MAX_WAKEUP; + dest->tv_usec = 0; + } + } + else + { + dest->tv_sec = REAP_MAX_WAKEUP; + dest->tv_usec = 0; + } +} + +/* + * Send a packet to TUN/TAP interface. + */ +static inline bool +multi_process_outgoing_tun (struct multi_context *m, const unsigned int mpp_flags) +{ + struct multi_instance *mi = m->pending; + bool ret = true; + + ASSERT (mi); +#ifdef MULTI_DEBUG_EVENT_LOOP + printf ("%s -> TUN len=%d\n", + id(mi), + mi->context.c2.to_tun.len); +#endif + set_prefix (mi); + process_outgoing_tun (&mi->context); + ret = multi_process_post (m, mi, mpp_flags); + clear_prefix (); + return ret; +} + +static inline bool +multi_process_outgoing_link_dowork (struct multi_context *m, struct multi_instance *mi, const unsigned int mpp_flags) +{ + bool ret = true; + set_prefix (mi); + process_outgoing_link (&mi->context); + ret = multi_process_post (m, mi, mpp_flags); + clear_prefix (); + return ret; +} + +/* + * Check for signals. + */ +#define MULTI_CHECK_SIG(m) EVENT_LOOP_CHECK_SIGNAL (&(m)->top, multi_process_signal, (m)) + +static inline void +multi_set_pending (struct multi_context *m, struct multi_instance *mi) +{ + m->pending = mi; +} + +static inline void +multi_release_io_lock (struct multi_context *m) +{ +} + +#endif /* P2MP_SERVER */ +#endif /* MULTI_H */ @@ -0,0 +1,188 @@ +/* + * ntlm proxy support for OpenVPN + * + * Copyright (C) 2004 William Preston + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if NTLM + +#include "common.h" +#include "buffer.h" +#include "misc.h" +#include "socket.h" +#include "fdmisc.h" +#include "proxy.h" +#include "ntlm.h" +#include "base64.h" +#include "crypto.h" + +#include "memdbg.h" + +static void +create_des_keys(const unsigned char *hash, unsigned char *key) +{ + key[0] = hash[0]; + key[1] = ((hash[0]&1)<<7)|(hash[1]>>1); + key[2] = ((hash[1]&3)<<6)|(hash[2]>>2); + key[3] = ((hash[2]&7)<<5)|(hash[3]>>3); + key[4] = ((hash[3]&15)<<4)|(hash[4]>>4); + key[5] = ((hash[4]&31)<<3)|(hash[5]>>5); + key[6] = ((hash[5]&63)<<2)|(hash[6]>>6); + key[7] = ((hash[6]&127)<<1); + des_set_odd_parity((des_cblock *)key); +} + +static void +gen_md4_hash (const char* data, int data_len, char *result) +{ + /* result is 16 byte md4 hash */ + + MD4_CTX c; + char md[16]; + + MD4_Init (&c); + MD4_Update (&c, data, data_len); + MD4_Final ((unsigned char *)md, &c); + + memcpy (result, md, 16); +} + +static int +unicodize (char *dst, const char *src) +{ + /* not really unicode... */ + int i = 0; + do + { + dst[i++] = *src; + dst[i++] = 0; + } + while (*src++); + + return i; +} + +const char * +ntlm_phase_1 (const struct http_proxy_info *p, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (96, gc); + /* try a minimal NTLM handshake + * + * http://davenport.sourceforge.net/ntlm.html + * + * This message contains only the NTLMSSP signature, + * the NTLM message type, + * and the minimal set of flags (Negotiate NTLM and Negotiate OEM). + * + */ + buf_printf (&out, "%s", "TlRMTVNTUAABAAAAAgIAAA=="); + return (BSTR (&out)); +} + +const char * +ntlm_phase_3 (const struct http_proxy_info *p, const char *phase_2, struct gc_arena *gc) +{ + char pwbuf[sizeof (p->up.password) * 2]; /* for unicode password */ + char buf2[128]; /* decoded reply from proxy */ + char phase3[146]; + + char md4_hash[21]; + char challenge[8], response[24]; + int i, ret_val, buflen; + des_cblock key1, key2, key3; + des_key_schedule sched1, sched2, sched3; + + /* try a minimal NTLM handshake + * + * http://davenport.sourceforge.net/ntlm.html + * + */ + ASSERT (strlen (p->up.username) > 0); + ASSERT (strlen (p->up.password) > 0); + + /* fill 1st 16 bytes with md4 hash, disregard terminating null */ + gen_md4_hash (pwbuf, unicodize (pwbuf, p->up.password) - 2, md4_hash); + + /* pad to 21 bytes */ + memset (md4_hash + 16, 0, 5); + + ret_val = base64_decode( phase_2, (void *)buf2); + /* we can be sure that phase_2 is less than 128 + * therefore buf2 needs to be (3/4 * 128) */ + + /* extract the challenge from bytes 24-31 */ + for (i=0; i<8; i++) + { + challenge[i] = buf2[i+24]; + } + + create_des_keys ((unsigned char *)md4_hash, key1); + des_set_key_unchecked ((des_cblock *)key1, sched1); + des_ecb_encrypt ((des_cblock *)challenge, (des_cblock *)response, sched1, DES_ENCRYPT); + + create_des_keys ((unsigned char *)&(md4_hash[7]), key2); + des_set_key_unchecked ((des_cblock *)key2, sched2); + des_ecb_encrypt ((des_cblock *)challenge, (des_cblock *)&(response[8]), sched2, DES_ENCRYPT); + + create_des_keys ((unsigned char *)&(md4_hash[14]), key3); + des_set_key_unchecked ((des_cblock *)key3, sched3); + des_ecb_encrypt ((des_cblock *)challenge, (des_cblock *)&(response[16]), sched3, DES_ENCRYPT); + + /* clear reply */ + memset (phase3, 0, sizeof (phase3)); + + strcpy (phase3, "NTLMSSP\0"); + phase3[8] = 3; /* type 3 */ + + buflen = 0x58 + strlen (p->up.username); + if (buflen > (int) sizeof (phase3)) + buflen = sizeof (phase3); + + phase3[0x10] = buflen; /* lm not used */ + phase3[0x20] = buflen; /* default domain (i.e. proxy's domain) */ + phase3[0x30] = buflen; /* no workstation name supplied */ + phase3[0x38] = buflen; /* no session key */ + + phase3[0x14] = 24; /* ntlm response is 24 bytes long */ + phase3[0x16] = phase3[0x14]; + phase3[0x18] = 0x40; /* ntlm offset */ + memcpy (&(phase3[0x40]), response, 24); + + + phase3[0x24] = strlen (p->up.username); /* username in ascii */ + phase3[0x26] = phase3[0x24]; + phase3[0x28] = 0x58; + strncpy (&(phase3[0x58]), p->up.username, sizeof (phase3) - 0x58); + + phase3[0x3c] = 0x02; /* negotiate oem */ + phase3[0x3d] = 0x02; /* negotiate ntlm */ + + return ((const char *)make_base64_string2 ((unsigned char *)phase3, buflen, gc)); +} + +#else +static void dummy(void) {} +#endif @@ -0,0 +1,11 @@ +#ifndef NTLM_H +#define NTLM_H + +#if NTLM + +const char *ntlm_phase_1 (const struct http_proxy_info *p, struct gc_arena *gc); +const char *ntlm_phase_3 (const struct http_proxy_info *p, const char *phase_2, struct gc_arena *gc); + +#endif + +#endif diff --git a/occ-inline.h b/occ-inline.h new file mode 100644 index 0000000..dc7e1c3 --- /dev/null +++ b/occ-inline.h @@ -0,0 +1,85 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef OCC_INLINE_H +#define OCC_INLINE_H + +#ifdef ENABLE_OCC + +/* + * Inline functions + */ + +static inline int +occ_reset_op () +{ + return -1; +} + +/* + * Should we send an OCC_REQUEST message? + */ +static inline void +check_send_occ_req (struct context *c) +{ + void check_send_occ_req_dowork (struct context *c); + if (event_timeout_defined (&c->c2.occ_interval) + && event_timeout_trigger (&c->c2.occ_interval, + &c->c2.timeval, + (!TO_LINK_DEF(c) && c->c2.occ_op < 0) ? ETT_DEFAULT : 0)) + check_send_occ_req_dowork (c); +} + +/* + * Should we send an MTU load test? + */ +static inline void +check_send_occ_load_test (struct context *c) +{ + void check_send_occ_load_test_dowork (struct context *c); + if (event_timeout_defined (&c->c2.occ_mtu_load_test_interval) + && event_timeout_trigger (&c->c2.occ_mtu_load_test_interval, + &c->c2.timeval, + (!TO_LINK_DEF(c) && c->c2.occ_op < 0) ? ETT_DEFAULT : 0)) + check_send_occ_load_test_dowork (c); +} + +/* + * Should we send an OCC message? + */ +static inline void +check_send_occ_msg (struct context *c) +{ + void check_send_occ_msg_dowork (struct context *c); + if (c->c2.occ_op >= 0) + { + if (!TO_LINK_DEF(c)) + check_send_occ_msg_dowork (c); + else + tv_clear (&c->c2.timeval); /* ZERO-TIMEOUT */ + } +} + +#endif +#endif @@ -0,0 +1,396 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#ifdef ENABLE_OCC + +#include "occ.h" + +#include "memdbg.h" + +#include "forward-inline.h" +#include "occ-inline.h" + +/* + * This random string identifies an OpenVPN + * Configuration Control packet. + * It should be of sufficient length and randomness + * so as not to collide with other tunnel data. + * + * The OCC protocol is as follows: + * + * occ_magic -- (16 octets) + * + * type [OCC_REQUEST | OCC_REPLY] (1 octet) + * null terminated options string if OCC_REPLY (variable) + * + * When encryption is used, the OCC packet + * is encapsulated within the encrypted + * envelope. + * + * OCC_STRING_SIZE must be set to sizeof (occ_magic) + */ + +const uint8_t occ_magic[] = { + 0x28, 0x7f, 0x34, 0x6b, 0xd4, 0xef, 0x7a, 0x81, + 0x2d, 0x56, 0xb8, 0xd3, 0xaf, 0xc5, 0x45, 0x9c +}; + +static const struct mtu_load_test mtu_load_test_sequence[] = { + + {OCC_MTU_LOAD_REQUEST, -1000}, + {OCC_MTU_LOAD, -1000}, + {OCC_MTU_LOAD_REQUEST, -1000}, + {OCC_MTU_LOAD, -1000}, + {OCC_MTU_LOAD_REQUEST, -1000}, + {OCC_MTU_LOAD, -1000}, + + {OCC_MTU_LOAD_REQUEST, -750}, + {OCC_MTU_LOAD, -750}, + {OCC_MTU_LOAD_REQUEST, -750}, + {OCC_MTU_LOAD, -750}, + {OCC_MTU_LOAD_REQUEST, -750}, + {OCC_MTU_LOAD, -750}, + + {OCC_MTU_LOAD_REQUEST, -500}, + {OCC_MTU_LOAD, -500}, + {OCC_MTU_LOAD_REQUEST, -500}, + {OCC_MTU_LOAD, -500}, + {OCC_MTU_LOAD_REQUEST, -500}, + {OCC_MTU_LOAD, -500}, + + {OCC_MTU_LOAD_REQUEST, -400}, + {OCC_MTU_LOAD, -400}, + {OCC_MTU_LOAD_REQUEST, -400}, + {OCC_MTU_LOAD, -400}, + {OCC_MTU_LOAD_REQUEST, -400}, + {OCC_MTU_LOAD, -400}, + + {OCC_MTU_LOAD_REQUEST, -300}, + {OCC_MTU_LOAD, -300}, + {OCC_MTU_LOAD_REQUEST, -300}, + {OCC_MTU_LOAD, -300}, + {OCC_MTU_LOAD_REQUEST, -300}, + {OCC_MTU_LOAD, -300}, + + {OCC_MTU_LOAD_REQUEST, -200}, + {OCC_MTU_LOAD, -200}, + {OCC_MTU_LOAD_REQUEST, -200}, + {OCC_MTU_LOAD, -200}, + {OCC_MTU_LOAD_REQUEST, -200}, + {OCC_MTU_LOAD, -200}, + + {OCC_MTU_LOAD_REQUEST, -150}, + {OCC_MTU_LOAD, -150}, + {OCC_MTU_LOAD_REQUEST, -150}, + {OCC_MTU_LOAD, -150}, + {OCC_MTU_LOAD_REQUEST, -150}, + {OCC_MTU_LOAD, -150}, + + {OCC_MTU_LOAD_REQUEST, -100}, + {OCC_MTU_LOAD, -100}, + {OCC_MTU_LOAD_REQUEST, -100}, + {OCC_MTU_LOAD, -100}, + {OCC_MTU_LOAD_REQUEST, -100}, + {OCC_MTU_LOAD, -100}, + + {OCC_MTU_LOAD_REQUEST, -50}, + {OCC_MTU_LOAD, -50}, + {OCC_MTU_LOAD_REQUEST, -50}, + {OCC_MTU_LOAD, -50}, + {OCC_MTU_LOAD_REQUEST, -50}, + {OCC_MTU_LOAD, -50}, + + {OCC_MTU_LOAD_REQUEST, 0}, + {OCC_MTU_LOAD, 0}, + {OCC_MTU_LOAD_REQUEST, 0}, + {OCC_MTU_LOAD, 0}, + {OCC_MTU_LOAD_REQUEST, 0}, + {OCC_MTU_LOAD, 0}, + + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + {OCC_MTU_REQUEST, 0}, + + {-1, 0} +}; + +void +check_send_occ_req_dowork (struct context *c) +{ + if (++c->c2.occ_n_tries >= OCC_N_TRIES) + { + if (c->options.remote_list) + /* + * No OCC_REPLY from peer after repeated attempts. + * Give up. + */ + msg (D_SHOW_OCC, + "NOTE: failed to obtain options consistency info from peer -- this could occur if the remote peer is running a version of " + PACKAGE_NAME + " before 1.5-beta8 or if there is a network connectivity problem, and will not necessarily prevent " + PACKAGE_NAME + " from running (%u bytes received from peer, %u bytes authenticated data channel traffic) -- you can disable the options consistency check with --disable-occ.", + (unsigned int) c->c2.link_read_bytes, + (unsigned int) c->c2.link_read_bytes_auth); + event_timeout_clear (&c->c2.occ_interval); + } + else + { + c->c2.occ_op = OCC_REQUEST; + + /* + * If we don't hear back from peer, send another + * OCC_REQUEST in OCC_INTERVAL_SECONDS. + */ + event_timeout_reset (&c->c2.occ_interval); + } +} + +void +check_send_occ_load_test_dowork (struct context *c) +{ + if (CONNECTION_ESTABLISHED (c)) + { + const struct mtu_load_test *entry; + + if (!c->c2.occ_mtu_load_n_tries) + msg (M_INFO, + "NOTE: Beginning empirical MTU test -- results should be available in 3 to 4 minutes."); + + entry = &mtu_load_test_sequence[c->c2.occ_mtu_load_n_tries++]; + if (entry->op >= 0) + { + c->c2.occ_op = entry->op; + c->c2.occ_mtu_load_size = + EXPANDED_SIZE (&c->c2.frame) + entry->delta; + } + else + { + msg (M_INFO, + "NOTE: failed to empirically measure MTU (requires " PACKAGE_NAME " 1.5 or higher at other end of connection)."); + event_timeout_clear (&c->c2.occ_mtu_load_test_interval); + c->c2.occ_mtu_load_n_tries = 0; + } + } +} + +void +check_send_occ_msg_dowork (struct context *c) +{ + bool doit = false; + + c->c2.buf = c->c2.buffers->aux_buf; + ASSERT (buf_init (&c->c2.buf, FRAME_HEADROOM (&c->c2.frame))); + ASSERT (buf_safe (&c->c2.buf, MAX_RW_SIZE_TUN (&c->c2.frame))); + ASSERT (buf_write (&c->c2.buf, occ_magic, OCC_STRING_SIZE)); + + switch (c->c2.occ_op) + { + case OCC_REQUEST: + if (!buf_write_u8 (&c->c2.buf, OCC_REQUEST)) + break; + dmsg (D_PACKET_CONTENT, "SENT OCC_REQUEST"); + doit = true; + break; + + case OCC_REPLY: + if (!c->c2.options_string_local) + break; + if (!buf_write_u8 (&c->c2.buf, OCC_REPLY)) + break; + if (!buf_write (&c->c2.buf, c->c2.options_string_local, + strlen (c->c2.options_string_local) + 1)) + break; + dmsg (D_PACKET_CONTENT, "SENT OCC_REPLY"); + doit = true; + break; + + case OCC_MTU_REQUEST: + if (!buf_write_u8 (&c->c2.buf, OCC_MTU_REQUEST)) + break; + dmsg (D_PACKET_CONTENT, "SENT OCC_MTU_REQUEST"); + doit = true; + break; + + case OCC_MTU_REPLY: + if (!buf_write_u8 (&c->c2.buf, OCC_MTU_REPLY)) + break; + if (!buf_write_u16 (&c->c2.buf, c->c2.max_recv_size_local)) + break; + if (!buf_write_u16 (&c->c2.buf, c->c2.max_send_size_local)) + break; + dmsg (D_PACKET_CONTENT, "SENT OCC_MTU_REPLY"); + doit = true; + break; + + case OCC_MTU_LOAD_REQUEST: + if (!buf_write_u8 (&c->c2.buf, OCC_MTU_LOAD_REQUEST)) + break; + if (!buf_write_u16 (&c->c2.buf, c->c2.occ_mtu_load_size)) + break; + dmsg (D_PACKET_CONTENT, "SENT OCC_MTU_LOAD_REQUEST"); + doit = true; + break; + + case OCC_MTU_LOAD: + { + int need_to_add; + + if (!buf_write_u8 (&c->c2.buf, OCC_MTU_LOAD)) + break; + need_to_add = min_int (c->c2.occ_mtu_load_size, EXPANDED_SIZE (&c->c2.frame)) + - OCC_STRING_SIZE + - sizeof (uint8_t) + - EXTRA_FRAME (&c->c2.frame); + + while (need_to_add > 0) + { + /* + * Fill the load test packet with pseudo-random bytes. + */ + if (!buf_write_u8 (&c->c2.buf, get_random () & 0xFF)) + break; + --need_to_add; + } + dmsg (D_PACKET_CONTENT, "SENT OCC_MTU_LOAD min_int(%d-%d-%d-%d,%d) size=%d", + c->c2.occ_mtu_load_size, + OCC_STRING_SIZE, + (int) sizeof (uint8_t), + EXTRA_FRAME (&c->c2.frame), + MAX_RW_SIZE_TUN (&c->c2.frame), + BLEN (&c->c2.buf)); + doit = true; + } + break; + + case OCC_EXIT: + if (!buf_write_u8 (&c->c2.buf, OCC_EXIT)) + break; + dmsg (D_PACKET_CONTENT, "SENT OCC_EXIT"); + doit = true; + break; + } + + if (doit) + { + /* + * We will treat the packet like any other outgoing packet, + * compress, encrypt, sign, etc. + */ + encrypt_sign (c, true); + } + + c->c2.occ_op = -1; +} + +void +process_received_occ_msg (struct context *c) +{ + ASSERT (buf_advance (&c->c2.buf, OCC_STRING_SIZE)); + switch (buf_read_u8 (&c->c2.buf)) + { + case OCC_REQUEST: + dmsg (D_PACKET_CONTENT, "RECEIVED OCC_REQUEST"); + c->c2.occ_op = OCC_REPLY; + break; + + case OCC_MTU_REQUEST: + dmsg (D_PACKET_CONTENT, "RECEIVED OCC_MTU_REQUEST"); + c->c2.occ_op = OCC_MTU_REPLY; + break; + + case OCC_MTU_LOAD_REQUEST: + dmsg (D_PACKET_CONTENT, "RECEIVED OCC_MTU_LOAD_REQUEST"); + c->c2.occ_mtu_load_size = buf_read_u16 (&c->c2.buf); + if (c->c2.occ_mtu_load_size >= 0) + c->c2.occ_op = OCC_MTU_LOAD; + break; + + case OCC_REPLY: + dmsg (D_PACKET_CONTENT, "RECEIVED OCC_REPLY"); + if (c->options.occ && !TLS_MODE (c) && c->c2.options_string_remote) + { + if (!options_cmp_equal_safe ((char *) BPTR (&c->c2.buf), + c->c2.options_string_remote, + c->c2.buf.len)) + { + options_warning_safe ((char *) BPTR (&c->c2.buf), + c->c2.options_string_remote, + c->c2.buf.len); + } + } + event_timeout_clear (&c->c2.occ_interval); + break; + + case OCC_MTU_REPLY: + dmsg (D_PACKET_CONTENT, "RECEIVED OCC_MTU_REPLY"); + c->c2.max_recv_size_remote = buf_read_u16 (&c->c2.buf); + c->c2.max_send_size_remote = buf_read_u16 (&c->c2.buf); + if (c->options.mtu_test + && c->c2.max_recv_size_remote > 0 + && c->c2.max_send_size_remote > 0) + { + msg (M_INFO, "NOTE: Empirical MTU test completed [Tried,Actual] local->remote=[%d,%d] remote->local=[%d,%d]", + c->c2.max_send_size_local, + c->c2.max_recv_size_remote, + c->c2.max_send_size_remote, + c->c2.max_recv_size_local); + if (!c->options.fragment + && c->options.proto == PROTO_UDPv4 + && c->c2.max_send_size_local > TUN_MTU_MIN + && (c->c2.max_recv_size_remote < c->c2.max_send_size_local + || c->c2.max_recv_size_local < c->c2.max_send_size_remote)) + msg (M_INFO, "NOTE: This connection is unable to accomodate a UDP packet size of %d. Consider using --fragment or --mssfix options as a workaround.", + c->c2.max_send_size_local); + } + event_timeout_clear (&c->c2.occ_mtu_load_test_interval); + break; + + case OCC_EXIT: + dmsg (D_PACKET_CONTENT, "RECEIVED OCC_EXIT"); + c->sig->signal_received = SIGTERM; + c->sig->signal_text = "remote-exit"; + break; + } + c->c2.buf.len = 0; /* don't pass packet on */ +} + +#else +static void dummy(void) {} +#endif @@ -0,0 +1,95 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef OCC_H +#define OCC_H + +#ifdef ENABLE_OCC + +#include "forward.h" + +/* OCC_STRING_SIZE must be set to sizeof (occ_magic) */ +#define OCC_STRING_SIZE 16 + +/* + * OCC (OpenVPN Configuration Control) protocol opcodes. + */ + +#define OCC_REQUEST 0 /* request options string from peer */ +#define OCC_REPLY 1 /* deliver options string to peer */ + +/* + * Send an OCC_REQUEST once every OCC_INTERVAL + * seconds until a reply is received. + * + * If we haven't received a reply after + * OCC_N_TRIES, give up. + */ +#define OCC_INTERVAL_SECONDS 10 +#define OCC_N_TRIES 12 + +/* + * Other OCC protocol opcodes used to estimate the MTU empirically. + */ +#define OCC_MTU_LOAD_REQUEST 2 /* Ask peer to send a big packet to us */ +#define OCC_MTU_LOAD 3 /* Send a big packet to peer */ +#define OCC_MTU_REQUEST 4 /* Ask peer to tell us the largest + packet it has received from us so far */ +#define OCC_MTU_REPLY 5 /* Send largest packet size to peer */ + +/* + * Process one command from mtu_load_test_sequence + * once every n seconds, if --mtu-test is specified. + */ +#define OCC_MTU_LOAD_INTERVAL_SECONDS 3 + +/* + * Send an exit message to remote. + */ +#define OCC_EXIT 6 + +/* + * Used to conduct a load test command sequence + * of UDP connection for empirical MTU measurement. + */ +struct mtu_load_test +{ + int op; /* OCC opcode to send to peer */ + int delta; /* determine packet size to send by using + this delta against currently + configured MTU */ +}; + +extern const uint8_t occ_magic[]; + +static inline bool +is_occ_msg (const struct buffer* buf) +{ + return buf_string_match_head (buf, occ_magic, OCC_STRING_SIZE); +} + +void process_received_occ_msg (struct context *c); + +#endif +#endif diff --git a/openvpn-plugin.h b/openvpn-plugin.h new file mode 100644 index 0000000..fcd823e --- /dev/null +++ b/openvpn-plugin.h @@ -0,0 +1,211 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Plug-in types. These types correspond to the set of script callbacks + * supported by OpenVPN. + */ +#define OPENVPN_PLUGIN_UP 0 +#define OPENVPN_PLUGIN_DOWN 1 +#define OPENVPN_PLUGIN_ROUTE_UP 2 +#define OPENVPN_PLUGIN_IPCHANGE 3 +#define OPENVPN_PLUGIN_TLS_VERIFY 4 +#define OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY 5 +#define OPENVPN_PLUGIN_CLIENT_CONNECT 6 +#define OPENVPN_PLUGIN_CLIENT_DISCONNECT 7 +#define OPENVPN_PLUGIN_LEARN_ADDRESS 8 +#define OPENVPN_PLUGIN_N 9 + +/* + * Build a mask out of a set of plug-in types. + */ +#define OPENVPN_PLUGIN_MASK(x) (1<<(x)) + +/* + * A pointer to a plugin-defined object which contains + * the object state. + */ +typedef void *openvpn_plugin_handle_t; + +/* + * Return value for openvpn_plugin_func_v1 function + */ +#define OPENVPN_PLUGIN_FUNC_SUCCESS 0 +#define OPENVPN_PLUGIN_FUNC_ERROR 1 + +/* + * For Windows (needs to be modified for MSVC) + */ +#if defined(__MINGW32_VERSION) && !defined(OPENVPN_PLUGIN_H) +# define OPENVPN_EXPORT __declspec(dllexport) +#else +# define OPENVPN_EXPORT +#endif + +/* + * If OPENVPN_PLUGIN_H is defined, we know that we are being + * included in an OpenVPN compile, rather than a plugin compile. + */ +#ifdef OPENVPN_PLUGIN_H + +/* + * We are compiling OpenVPN. + */ +#define OPENVPN_PLUGIN_DEF typedef +#define OPENVPN_PLUGIN_FUNC(name) (*name) + +#else + +/* + * We are compiling plugin. + */ +#define OPENVPN_PLUGIN_DEF OPENVPN_EXPORT +#define OPENVPN_PLUGIN_FUNC(name) name + +#endif + +/* + * Multiple plugin modules can be cascaded, and modules can be + * used in tandem with scripts. The order of operation is that + * the module func() functions are called in the order that + * the modules were specified in the config file. If a script + * was specified as well, it will be called last. If the + * return code of the module/script controls an authentication + * function (such as tls-verify or auth-user-pass-verify), then + * every module and script must return success (0) in order for + * the connection to be authenticated. + * + * Notes: + * + * Plugins which use a privilege-separation model (by forking in + * their initialization function before the main OpenVPN process + * downgrades root privileges and/or executes a chroot) must + * daemonize after a fork if the "daemon" environmental variable is + * set. In addition, if the "daemon_log_redirect" variable is set, + * the plugin should preserve stdout/stderr across the daemon() + * syscall. See the daemonize() function in plugin/auth-pam/auth-pam.c + * for an example. + */ + +/* + * Prototypes for functions which OpenVPN plug-ins must define. + */ + +/* + * FUNCTION: openvpn_plugin_open_v1 + * + * REQUIRED: YES + * + * Called on initial plug-in load. OpenVPN will preserve plug-in state + * across SIGUSR1 restarts but not across SIGHUP restarts. A SIGHUP reset + * will cause the plugin to be closed and reopened. + * + * ARGUMENTS + * + * *type_mask : Set by OpenVPN to the logical OR of all script + * types which this version of OpenVPN supports. The plug-in + * should set this value to the logical OR of all script types + * which the plug-in wants to intercept. For example, if the + * script wants to intercept the client-connect and + * client-disconnect script types: + * + * *type_mask = OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_CONNECT) + * | OPENVPN_PLUGIN_MASK(OPENVPN_PLUGIN_CLIENT_DISCONNECT) + * + * argv : a NULL-terminated array of options provided to the OpenVPN + * "plug-in" directive. argv[0] is the dynamic library pathname. + * + * envp : a NULL-terminated array of OpenVPN-set environmental + * variables in "name=value" format. Note that for security reasons, + * these variables are not actually written to the "official" + * environmental variable store of the process. + * + * RETURN VALUE + * + * An openvpn_plugin_handle_t value on success, NULL on failure + */ +OPENVPN_PLUGIN_DEF openvpn_plugin_handle_t OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v1) + (unsigned int *type_mask, const char *argv[], const char *envp[]); + +/* + * FUNCTION: openvpn_plugin_func_v1 + * + * Called to perform the work of a given script type. + * + * REQUIRED: YES + * + * ARGUMENTS + * + * handle : the openvpn_plugin_handle_t value which was returned by + * openvpn_plugin_open_v1. + * + * type : one of the PLUGIN_x types + * + * argv : a NULL-terminated array of "command line" options which + * would normally be passed to the script. argv[0] is the dynamic + * library pathname. + * + * envp : a NULL-terminated array of OpenVPN-set environmental + * variables in "name=value" format. Note that for security reasons, + * these variables are not actually written to the "official" + * environmental variable store of the process. + * + * RETURN VALUE + * + * OPENVPN_PLUGIN_FUNC_SUCCESS on success, OPENVPN_PLUGIN_FUNC_ERROR on failure + */ +OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_func_v1) + (openvpn_plugin_handle_t handle, const int type, const char *argv[], const char *envp[]); + +/* + * FUNCTION: openvpn_plugin_close_v1 + * + * REQUIRED: YES + * + * ARGUMENTS + * + * handle : the openvpn_plugin_handle_t value which was returned by + * openvpn_plugin_open_v1. + * + * Called immediately prior to plug-in unload. + */ +OPENVPN_PLUGIN_DEF void OPENVPN_PLUGIN_FUNC(openvpn_plugin_close_v1) + (openvpn_plugin_handle_t handle); + +/* + * FUNCTION: openvpn_plugin_abort_v1 + * + * REQUIRED: NO + * + * ARGUMENTS + * + * handle : the openvpn_plugin_handle_t value which was returned by + * openvpn_plugin_open_v1. + * + * Called when OpenVPN is in the process of aborting due to a fatal error. + * Will only be called on an open context returned by a prior successful + * openvpn_plugin_open_v1 callback. + */ +OPENVPN_PLUGIN_DEF void OPENVPN_PLUGIN_FUNC(openvpn_plugin_abort_v1) + (openvpn_plugin_handle_t handle); diff --git a/openvpn.8 b/openvpn.8 new file mode 100644 index 0000000..ce7bfc8 --- /dev/null +++ b/openvpn.8 @@ -0,0 +1,5104 @@ +.\" OpenVPN -- An application to securely tunnel IP networks +.\" over a single TCP/UDP port, with support for SSL/TLS-based +.\" session authentication and key exchange, +.\" packet encryption, packet authentication, and +.\" packet compression. +.\" +.\" Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License version 2 +.\" 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 (see the file COPYING included with this +.\" distribution); if not, write to the Free Software Foundation, Inc., +.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +.\" +.\" Manual page for openvpn +.\" SH section heading +.\" SS subsection heading +.\" LP paragraph +.\" IP indented paragraph +.\" TP hanging label +.TH openvpn 8 "3 August 2005" +.\"********************************************************* +.SH NAME +openvpn \- secure IP tunnel daemon. +.\"********************************************************* +.SH SYNOPSIS +.LP +.nh +.in +4 +.ti -4 +.B openvpn +[\ \fB\-\-help\fR\ ] +.in -4 +.ti +4 +.hy + +.nh +.in +4 +.ti -4 +.B openvpn +[\ \fB\-\-config\fR\ \fIfile\fR\ ] +.in -4 +.ti +4 +.hy + +.nh +.in +4 +.ti -4 +.B openvpn +[\ \fB\-\-genkey\fR\ ] +[\ \fB\-\-secret\fR\ \fIfile\fR\ ] +.in -4 +.ti +4 +.hy + +.nh +.in +4 +.ti -4 +.B openvpn +[\ \fB\-\-mktun\fR\ ] +[\ \fB\-\-rmtun\fR\ ] +[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\fR\ ] +[\ \fB\-\-dev\-type\fR\ \fIdevice\-type\fR\ ] +[\ \fB\-\-dev\-node\fR\ \fInode\fR\ ] +.in -4 +.ti +4 +.hy + +.nh +.in +4 +.ti -4 +.B openvpn +[\ \fB\-\-test\-crypto\fR\ ] +[\ \fB\-\-secret\fR\ \fIfile\fR\ ] +[\ \fB\-\-auth\fR\ \fIalg\fR\ ] +[\ \fB\-\-cipher\fR\ \fIalg\fR\ ] +[\ \fB\-\-engine\fR\ ] +[\ \fB\-\-keysize\fR\ \fIn\fR\ ] +[\ \fB\-\-no\-replay\fR\ ] +[\ \fB\-\-no\-iv\fR\ ] +.in -4 +.ti +4 +.hy + +.nh +.in +4 +.ti -4 +.B openvpn +[\ \fB\-\-askpass\fR\ \fI[file]\fR\ ] +[\ \fB\-\-auth\-nocache\fR\ ] +[\ \fB\-\-auth\-retry\fR\ \fItype\fR\ ] +[\ \fB\-\-auth\-user\-pass\-verify\fR\ \fIscript\fR\ ] +[\ \fB\-\-auth\-user\-pass\fR\ \fIup\fR\ ] +[\ \fB\-\-auth\fR\ \fIalg\fR\ ] +[\ \fB\-\-bcast\-buffers\fR\ \fIn\fR\ ] +[\ \fB\-\-ca\fR\ \fIfile\fR\ ] +[\ \fB\-\-ccd\-exclusive\fR\ ] +[\ \fB\-\-cd\fR\ \fIdir\fR\ ] +[\ \fB\-\-cert\fR\ \fIfile\fR\ ] +[\ \fB\-\-chroot\fR\ \fIdir\fR\ ] +[\ \fB\-\-cipher\fR\ \fIalg\fR\ ] +[\ \fB\-\-client\-cert\-not\-required\fR\ ] +[\ \fB\-\-client\-config\-dir\fR\ \fIdir\fR\ ] +[\ \fB\-\-client\-connect\fR\ \fIscript\fR\ ] +[\ \fB\-\-client\-disconnect\fR\ ] +[\ \fB\-\-client\-to\-client\fR\ ] +[\ \fB\-\-client\fR\ ] +[\ \fB\-\-comp\-lzo\fR\ ] +[\ \fB\-\-comp\-noadapt\fR\ ] +[\ \fB\-\-config\fR\ \fIfile\fR\ ] +[\ \fB\-\-connect\-freq\fR\ \fIn\ sec\fR\ ] +[\ \fB\-\-connect\-retry\fR\ \fIn\fR\ ] +[\ \fB\-\-crl\-verify\fR\ \fIcrl\fR\ ] +[\ \fB\-\-cryptoapicert\fR\ \fIselect\-string\fR\ ] +[\ \fB\-\-daemon\fR\ \fI[progname]\fR\ ] +[\ \fB\-\-dev\-node\fR\ \fInode\fR\ ] +[\ \fB\-\-dev\-type\fR\ \fIdevice\-type\fR\ ] +[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\ |\ null\fR\ ] +[\ \fB\-\-dev\fR\ \fItunX\ |\ tapX\fR\ ] +[\ \fB\-\-dh\fR\ \fIfile\fR\ ] +[\ \fB\-\-dhcp\-option\fR\ \fItype\ [parm]\fR\ ] +[\ \fB\-\-dhcp\-release\fR\ ] +[\ \fB\-\-dhcp\-renew\fR\ ] +[\ \fB\-\-disable\-occ\fR\ ] +[\ \fB\-\-disable\fR\ ] +[\ \fB\-\-down\-pre\fR\ ] +[\ \fB\-\-down\fR\ \fIcmd\fR\ ] +[\ \fB\-\-duplicate\-cn\fR\ ] +[\ \fB\-\-echo\fR\ \fI[parms...]\fR\ ] +[\ \fB\-\-engine\fR\ \fI[engine\-name]\fR\ ] +[\ \fB\-\-explicit\-exit\-notify\fR\ \fI[n]\fR\ ] +[\ \fB\-\-fast\-io\fR\ ] +[\ \fB\-\-float\fR\ ] +[\ \fB\-\-fragment\fR\ \fImax\fR\ ] +[\ \fB\-\-genkey\fR\ ] +[\ \fB\-\-group\fR\ \fIgroup\fR\ ] +[\ \fB\-\-hand\-window\fR\ \fIn\fR\ ] +[\ \fB\-\-hash\-size\fR\ \fIr\ v\fR\ ] +[\ \fB\-\-help\fR\ ] +[\ \fB\-\-http\-proxy\-option\fR\ \fItype\ [parm]\fR\ ] +[\ \fB\-\-http\-proxy\-retry\fR\ ] +[\ \fB\-\-http\-proxy\-timeout\fR\ \fIn\fR\ ] +[\ \fB\-\-http\-proxy\fR\ \fIserver\ port\ [authfile]\ [auth\-method]\fR\ ] +[\ \fB\-\-ifconfig\-noexec\fR\ ] +[\ \fB\-\-ifconfig\-nowarn\fR\ ] +[\ \fB\-\-ifconfig\-pool\-linear\fR\ ] +[\ \fB\-\-ifconfig\-pool\-persist\fR\ \fIfile\ [seconds]\fR\ ] +[\ \fB\-\-ifconfig\-pool\fR\ \fIstart\-IP\ end\-IP\ [netmask]\fR\ ] +[\ \fB\-\-ifconfig\-push\fR\ \fIlocal\ remote\-netmask\fR\ ] +[\ \fB\-\-ifconfig\fR\ \fIl\ rn\fR\ ] +[\ \fB\-\-inactive\fR\ \fIn\fR\ ] +[\ \fB\-\-inetd\fR\ \fI[wait|nowait]\ [progname]\fR\ ] +[\ \fB\-\-ip\-win32\fR\ \fImethod\fR\ ] +[\ \fB\-\-ipchange\fR\ \fIcmd\fR\ ] +[\ \fB\-\-iroute\fR\ \fInetwork\ [netmask]\fR\ ] +[\ \fB\-\-keepalive\fR\ \fIn\ m\fR\ ] +[\ \fB\-\-key\-method\fR\ \fIm\fR\ ] +[\ \fB\-\-key\fR\ \fIfile\fR\ ] +[\ \fB\-\-keysize\fR\ \fIn\fR\ ] +[\ \fB\-\-learn\-address\fR\ \fIcmd\fR\ ] +[\ \fB\-\-link\-mtu\fR\ \fIn\fR\ ] +[\ \fB\-\-local\fR\ \fIhost\fR\ ] +[\ \fB\-\-log\-append\fR\ \fIfile\fR\ ] +[\ \fB\-\-log\fR\ \fIfile\fR\ ] +[\ \fB\-\-suppress-timestamps\fR\ ] +[\ \fB\-\-lport\fR\ \fIport\fR\ ] +[\ \fB\-\-management\-hold\fR\ ] +[\ \fB\-\-management\-log\-cache\fR\ \fIn\fR\ ] +[\ \fB\-\-management\-query\-passwords\fR\ ] +[\ \fB\-\-management\fR\ \fIIP\ port\ [pw\-file]\fR\ ] +[\ \fB\-\-max\-clients\fR\ \fIn\fR\ ] +[\ \fB\-\-max\-routes\-per\-client\fR\ \fIn\fR\ ] +[\ \fB\-\-mktun\fR\ ] +[\ \fB\-\-mlock\fR\ ] +[\ \fB\-\-mode\fR\ \fIm\fR\ ] +[\ \fB\-\-mssfix\fR\ \fImax\fR\ ] +[\ \fB\-\-mtu\-disc\fR\ \fItype\fR\ ] +[\ \fB\-\-mtu\-test\fR\ ] +[\ \fB\-\-mute\-replay\-warnings\fR\ ] +[\ \fB\-\-mute\fR\ \fIn\fR\ ] +[\ \fB\-\-nice\fR\ \fIn\fR\ ] +[\ \fB\-\-no\-iv\fR\ ] +[\ \fB\-\-no\-replay\fR\ ] +[\ \fB\-\-nobind\fR\ ] +[\ \fB\-\-ns\-cert\-type\fR\ \fIclient|server\fR\ ] +[\ \fB\-\-passtos\fR\ ] +[\ \fB\-\-pause\-exit\fR\ ] +[\ \fB\-\-persist\-key\fR\ ] +[\ \fB\-\-persist\-local\-ip\fR\ ] +[\ \fB\-\-persist\-remote\-ip\fR\ ] +[\ \fB\-\-persist\-tun\fR\ ] +[\ \fB\-\-ping\-exit\fR\ \fIn\fR\ ] +[\ \fB\-\-ping\-restart\fR\ \fIn\fR\ ] +[\ \fB\-\-ping\-timer\-rem\fR\ ] +[\ \fB\-\-ping\fR\ \fIn\fR\ ] +[\ \fB\-\-pkcs12\fR\ \fIfile\fR\ ] +[\ \fB\-\-plugin\fR\ \fImodule\-pathname\ init\-string\fR\ ] +[\ \fB\-\-port\fR\ \fIport\fR\ ] +[\ \fB\-\-proto\fR\ \fIp\fR\ ] +[\ \fB\-\-pull\fR\ ] +[\ \fB\-\-push\-reset\fR\ ] +[\ \fB\-\-push\fR\ \fI"option"\fR\ ] +[\ \fB\-\-rcvbuf\fR\ \fIsize\fR\ ] +[\ \fB\-\-redirect\-gateway\fR\ \fI["local"]\ ["def1"]\fR\ ] +[\ \fB\-\-remap\-usr1\fR\ \fIsignal\fR\ ] +[\ \fB\-\-remote\-random\fR\ ] +[\ \fB\-\-remote\fR\ \fIhost\ [port]\fR\ ] +[\ \fB\-\-reneg\-bytes\fR\ \fIn\fR\ ] +[\ \fB\-\-reneg\-pkts\fR\ \fIn\fR\ ] +[\ \fB\-\-reneg\-sec\fR\ \fIn\fR\ ] +[\ \fB\-\-replay\-persist\fR\ \fIfile\fR\ ] +[\ \fB\-\-replay\-window\fR\ \fIn\ [t]\fR\ ] +[\ \fB\-\-resolv\-retry\fR\ \fIn\fR\ ] +[\ \fB\-\-rmtun\fR\ ] +[\ \fB\-\-route\-delay\fR\ \fI[n]\ [w]\fR\ ] +[\ \fB\-\-route\-gateway\fR\ \fIgw\fR\ ] +[\ \fB\-\-route\-method\fR\ \fIm\fR\ ] +[\ \fB\-\-route\-noexec\fR\ ] +[\ \fB\-\-route\-up\fR\ \fIcmd\fR\ ] +[\ \fB\-\-route\fR\ \fInetwork\ [netmask]\ [gateway]\ [metric]\fR\ ] +[\ \fB\-\-rport\fR\ \fIport\fR\ ] +[\ \fB\-\-secret\fR\ \fIfile\ [direction]\fR\ ] +[\ \fB\-\-secret\fR\ \fIfile\fR\ ] +[\ \fB\-\-server\-bridge\fR\ \fIgateway\ netmask\ pool\-start\-IP\ pool\-end\-IP\fR\ ] +[\ \fB\-\-server\fR\ \fInetwork\ netmask\fR\ ] +[\ \fB\-\-service\fR\ \fIexit\-event\ [0|1]\fR\ ] +[\ \fB\-\-setenv\fR\ \fIname\ value\fR\ ] +[\ \fB\-\-shaper\fR\ \fIn\fR\ ] +[\ \fB\-\-show\-adapters\fR\ ] +[\ \fB\-\-show\-ciphers\fR\ ] +[\ \fB\-\-show\-digests\fR\ ] +[\ \fB\-\-show\-engines\fR\ ] +[\ \fB\-\-show\-net\-up\fR\ ] +[\ \fB\-\-show\-net\fR\ ] +[\ \fB\-\-show\-tls\fR\ ] +[\ \fB\-\-show\-valid\-subnets\fR\ ] +[\ \fB\-\-single\-session\fR\ ] +[\ \fB\-\-sndbuf\fR\ \fIsize\fR\ ] +[\ \fB\-\-socks\-proxy\-retry\fR\ ] +[\ \fB\-\-socks\-proxy\fR\ \fIserver\ [port]\fR\ ] +[\ \fB\-\-status\fR\ \fIfile\ [n]\fR\ ] +[\ \fB\-\-status\-version\fR\ \fIn\fR\ ] +[\ \fB\-\-syslog\fR\ \fI[progname]\fR\ ] +[\ \fB\-\-tap\-sleep\fR\ \fIn\fR\ ] +[\ \fB\-\-tcp\-queue\-limit\fR\ \fIn\fR\ ] +[\ \fB\-\-test\-crypto\fR\ ] +[\ \fB\-\-tls\-auth\fR\ \fIfile\ [direction]\fR\ ] +[\ \fB\-\-tls\-cipher\fR\ \fIl\fR\ ] +[\ \fB\-\-tls\-client\fR\ ] +[\ \fB\-\-tls\-exit\fR\ ] +[\ \fB\-\-tls\-remote\fR\ \fIx509name\fR\ ] +[\ \fB\-\-tls\-server\fR\ ] +[\ \fB\-\-tls\-timeout\fR\ \fIn\fR\ ] +[\ \fB\-\-tls\-verify\fR\ \fIcmd\fR\ ] +[\ \fB\-\-tmp\-dir\fR\ \fIdir\fR\ ] +[\ \fB\-\-tran\-window\fR\ \fIn\fR\ ] +[\ \fB\-\-tun\-ipv6\fR\ ] +[\ \fB\-\-tun\-mtu\-extra\fR\ \fIn\fR\ ] +[\ \fB\-\-tun\-mtu\fR\ \fIn\fR\ ] +[\ \fB\-\-txqueuelen\fR\ \fIn\fR\ ] +[\ \fB\-\-up\-delay\fR\ ] +[\ \fB\-\-up\-restart\fR\ ] +[\ \fB\-\-up\fR\ \fIcmd\fR\ ] +[\ \fB\-\-user\fR\ \fIuser\fR\ ] +[\ \fB\-\-username\-as\-common\-name\fR\ ] +[\ \fB\-\-verb\fR\ \fIn\fR\ ] +[\ \fB\-\-writepid\fR\ \fIfile\fR\ ] +.in -4 +.ti +4 +.hy +.\"********************************************************* +.SH INTRODUCTION +.LP +OpenVPN is an open source VPN daemon by James Yonan. +Because OpenVPN tries to +be a universal VPN tool offering a great deal of flexibility, +there are a lot of options on this manual page. +If you're new to OpenVPN, you might want to skip ahead to the +examples section where you will see how to construct simple +VPNs on the command line without even needing a configuration file. + +Also note that there's more documentation and examples on +the OpenVPN web site: +.I http://openvpn.net/ + +And if you would like to see a shorter version of this manual, +see the openvpn usage message which can be obtained by +running +.B openvpn +without any parameters. +.\"********************************************************* +.SH DESCRIPTION +.LP +OpenVPN is a robust and highly flexible VPN daemon. +OpenVPN supports SSL/TLS security, ethernet bridging, +TCP or UDP tunnel transport through proxies or NAT, +support for dynamic IP addresses and DHCP, +scalability to hundreds or thousands of users, +and portability to most major OS platforms. + +OpenVPN is tightly bound to the OpenSSL library, and derives much +of its crypto capabilities from it. + +OpenVPN supports +conventional encryption +using a pre-shared secret key +.B (Static Key mode) +or +public key security +.B (SSL/TLS mode) +using client & server certificates. +OpenVPN also +supports non-encrypted TCP/UDP tunnels. + +OpenVPN is designed to work with the +.B TUN/TAP +virtual networking interface that exists on most platforms. + +Overall, OpenVPN aims to offer many of the key features of IPSec but +with a relatively lightweight footprint. +.\"********************************************************* +.SH OPTIONS +OpenVPN allows any option to be placed either on the command line +or in a configuration file. Though all command line options are preceded +by a double-leading-dash ("--"), this prefix can be removed when +an option is placed in a configuration file. +.\"********************************************************* +.TP +.B --help +Show options. +.\"********************************************************* +.TP +.B --config file +Load additional config options from +.B file +where each line corresponds to one command line option, +but with the leading '--' removed. + +If +.B --config file +is the only option to the openvpn command, +the +.B --config +can be removed, and the command can be given as +.B openvpn file + +Note that +configuration files can be nested to a reasonable depth. + +Double quotation characters ("") can be used +to enclose single parameters containing whitespace, +and "#" or ";" characters in the first column +can be used to denote comments. + +Note that OpenVPN 2.0 and higher performs backslash-based shell +escaping, so the following mappings should be observed: + +.RS +.ft 3 +.nf +.sp +\\\\ Maps to a single backslash character (\\). +\\" Pass a literal doublequote character ("), don't + interpret it as enclosing a parameter. +\\[SPACE] Pass a literal space or tab character, don't + interpret it as a parameter delimiter. +.ft +.LP +.RE +.fi + +For example on Windows, use double backslashes to +represent pathnames: + +.RS +.ft 3 +.nf +.sp +secret "c:\\\\OpenVPN\\\\secret.key" +.ft +.LP +.RE +.fi + +For examples of configuration files, +see +.I http://openvpn.net/examples.html + +Here is an example configuration file: +.RS +.ft 3 +.nf +.sp +# +# Sample OpenVPN configuration file for +# using a pre-shared static key. +# +# '#' or ';' may be used to delimit comments. + +# Use a dynamic tun device. +dev tun + +# Our remote peer +remote mypeer.mydomain + +# 10.1.0.1 is our local VPN endpoint +# 10.1.0.2 is our remote VPN endpoint +ifconfig 10.1.0.1 10.1.0.2 + +# Our pre-shared static key +secret static.key +.ft +.LP +.RE +.fi +.\"********************************************************* +.SS Tunnel Options: +.TP +.B --mode m +Set OpenVPN major mode. By default, OpenVPN runs in +point-to-point mode ("p2p"). OpenVPN 2.0 introduces +a new mode ("server") which implements a multi-client +server capability. +.\"********************************************************* +.TP +.B --local host +Local host name or IP address. +If specified, OpenVPN will bind to this address only. +If unspecified, OpenVPN will bind to all interfaces. +.\"********************************************************* +.TP +.B --remote host [port] +Remote host name or IP address. Multiple +.B --remote +options may be specified for redundancy, each referring +to a different OpenVPN server. + +The OpenVPN client will try to connect to a server at +.B host:port +in the order specified by the list of +.B --remote +options. + +The client will move on to the next host in the list, +in the event of connection failure. +Note that at any given time, the OpenVPN client +will at most be connected to +one server. + +Also, note that since UDP is connectionless, connection failure +is defined by the +.B --ping +and +.B --ping-restart +options. + +If +.B --remote +is unspecified, OpenVPN will listen +for packets from any IP address, but will not act on those packets unless +they pass all authentication tests. This requirement for authentication +is binding on all potential peers, even those from known and supposedly +trusted IP addresses (it is very easy to forge a source IP address on +a UDP packet). + +When used in TCP mode, +.B --remote +will act as a filter, rejecting connections from any host which does +not match +.B host. + +If +.B host +is a DNS name which resolves to multiple IP addresses, +one will be randomly +chosen, providing a sort of basic load-balancing and +failover capability. +.\"********************************************************* +.TP +.B --remote-random +When multiple +.B --remote +address/ports are specified, initially randomize the order of the list +as a kind of basic load-balancing measure. +.\"********************************************************* +.TP +.B --proto p +Use protocol +.B p +for communicating with remote host. +.B p +can be +.B udp, +.B tcp-client, +or +.B tcp-server. + +The default protocol is +.B udp +when +.B --proto +is not specified. + +For UDP operation, +.B --proto udp +should be specified on both peers. + +For TCP operation, one peer must use +.B --proto tcp-server +and the other must use +.B --proto tcp-client. +A peer started with +.B tcp-server +will wait indefinitely for an incoming connection. A peer +started with +.B tcp-client +will attempt to connect, and if that fails, will sleep for 5 +seconds (adjustable via the +.B --connect-retry +option) and try again. Both TCP client and server will simulate +a SIGUSR1 restart signal if either side resets the connection. + +OpenVPN is designed to operate optimally over UDP, but TCP capability is provided +for situations where UDP cannot be used. +In comparison with UDP, TCP will usually be +somewhat less efficient and less robust when used over unreliable or congested +networks. + +This article outlines some of problems with tunneling IP over TCP: + +.I http://sites.inka.de/sites/bigred/devel/tcp-tcp.html + +There are certain cases, however, where using TCP may be advantageous from +a security and robustness perspective, such as tunneling non-IP or +application-level UDP protocols, or tunneling protocols which don't +possess a built-in reliability layer. +.\"********************************************************* +.TP +.B --connect-retry n +For +.B --proto tcp-client, +take +.B n +as the +number of seconds to wait +between connection retries (default=5). +.\"********************************************************* +.TP +.B --http-proxy server port [authfile] [auth-method] +Connect to remote host through an HTTP proxy at address +.B server +and port +.B port. +If HTTP Proxy-Authenticate is required, +.B authfile +is a file containing a username and password on 2 lines, or +"stdin" to prompt from console. + +.B auth-method +should be one of "none", "basic", or "ntlm". +.\"********************************************************* +.TP +.B --http-proxy-retry +Retry indefinitely on HTTP proxy errors. If an HTTP proxy error +occurs, simulate a SIGUSR1 reset. +.\"********************************************************* +.TP +.B --http-proxy-timeout n +Set proxy timeout to +.B n +seconds, default=5. +.\"********************************************************* +.TP +.B --http-proxy-option type [parm] +Set extended HTTP proxy options. +Repeat to set multiple options. + +.B VERSION version -- +Set HTTP version number to +.B version +(default=1.0). + +.B AGENT user-agent -- +Set HTTP "User-Agent" string to +.B user-agent. +.\"********************************************************* +.TP +.B --socks-proxy server [port] +Connect to remote host through a Socks5 proxy at address +.B server +and port +.B port +(default=1080). +.\"********************************************************* +.TP +.B --socks-proxy-retry +Retry indefinitely on Socks proxy errors. If a Socks proxy error +occurs, simulate a SIGUSR1 reset. +.\"********************************************************* +.TP +.B --resolv-retry n +If hostname resolve fails for +.B --remote, +retry resolve for +.B n +seconds before failing. + +Set +.B n +to "infinite" to retry indefinitely. + +By default, +.B --resolv-retry infinite +is enabled. You can disable by setting n=0. +.\"********************************************************* +.TP +.B --float +Allow remote peer to change its IP address and/or port number, such as due to +DHCP (this is the default if +.B --remote +is not used). +.B --float +when specified with +.B --remote +allows an OpenVPN session to initially connect to a peer +at a known address, however if packets arrive from a new +address and pass all authentication tests, the new address +will take control of the session. This is useful when +you are connecting to a peer which holds a dynamic address +such as a dial-in user or DHCP client. + +Essentially, +.B --float +tells OpenVPN to accept authenticated packets +from any address, not only the address which was specified in the +.B --remote +option. +.\"********************************************************* +.TP +.B --ipchange cmd +Execute shell command +.B cmd +when our remote ip-address is initially authenticated or +changes. + +Execute as: + +.B cmd ip_address port_number + +Don't use +.B --ipchange +in +.B --mode server +mode. Use a +.B --client-connect +script instead. + +See the "Environmental Variables" section below for +additional parameters passed as environmental variables. + +Note that +.B cmd +can be a shell command with multiple arguments, in which +case all OpenVPN-generated arguments will be appended +to +.B cmd +to build a command line which will be passed to the script. + +If you are running in a dynamic IP address environment where +the IP addresses of either peer could change without notice, +you can use this script, for example, to edit the +.I /etc/hosts +file with the current address of the peer. The script will +be run every time the remote peer changes its IP address. + +Similarly if +.I our +IP address changes due to DHCP, we should configure +our IP address change script (see man page for +.BR dhcpcd (8) +) to deliver a +.B SIGHUP +or +.B SIGUSR1 +signal to OpenVPN. OpenVPN will then +reestablish a connection with its most recently authenticated +peer on its new IP address. +.\"********************************************************* +.TP +.B --port port +TCP/UDP port number for both local and remote. The current +default of 1194 represents the official IANA port number +assignment for OpenVPN and has been used since version 2.0-beta17. +Previous versions used port 5000 as the default. +.\"********************************************************* +.TP +.B --lport port +TCP/UDP port number for local. +.\"********************************************************* +.TP +.B --rport port +TCP/UDP port number for remote. +.\"********************************************************* +.TP +.B --nobind +Do not bind to local address and port. The IP stack will allocate +a dynamic port for returning packets. Since the value of the dynamic port +could not be known in advance by a peer, this option is only suitable for +peers which will be initiating connections by using the +.B --remote +option. +.\"********************************************************* +.TP +.B --dev tunX | tapX | null +TUN/TAP virtual network device ( +.B X +can be omitted for a dynamic device.) + +See examples section below +for an example on setting up a TUN device. + +You must use either tun devices on both ends of the connection +or tap devices on both ends. You cannot mix them, as they +represent different underlying protocols. + +.B tun +devices encapsulate IPv4 while +.B tap +devices encapsulate ethernet 802.3. +.\"********************************************************* +.TP +.B --dev-type device-type +Which device type are we using? +.B device-type +should be +.B tun +or +.B tap. +Use this option only if the TUN/TAP device used with +.B --dev +does not begin with +.B tun +or +.B tap. +.\"********************************************************* +.TP +.B --tun-ipv6 +Build a tun link capable of forwarding IPv6 traffic. +Should be used in conjunction with +.B --dev tun +or +.B --dev tunX. +A warning will be displayed +if no specific IPv6 TUN support for your OS has been compiled into OpenVPN. +.\"********************************************************* +.TP +.B --dev-node node +Explicitly set the device node rather than using +/dev/net/tun, /dev/tun, /dev/tap, etc. If OpenVPN +cannot figure out whether +.B node +is a TUN or TAP device based on the name, you should +also specify +.B --dev-type tun +or +.B --dev-type tap. + +On Windows systems, select the TAP-Win32 adapter which +is named +.B node +in the Network Connections Control Panel or the +raw GUID of the adapter enclosed by braces. +The +.B --show-adapters +option under Windows can also be used +to enumerate all available TAP-Win32 +adapters and will show both the network +connections control panel name and the GUID for +each TAP-Win32 adapter. +.\"********************************************************* +.TP +.B --ifconfig l rn +Set TUN/TAP adapter parameters. +.B l +is the IP address of the local VPN endpoint. +For TUN devices, +.B rn +is the IP address of the remote VPN endpoint. +For TAP devices, +.B rn +is the subnet mask of the virtual ethernet segment +which is being created or connected to. + +For TUN devices, which facilitate virtual +point-to-point IP connections, +the proper usage of +.B --ifconfig +is to use two private IP addresses +which are not a member of any +existing subnet which is in use. +The IP addresses may be consecutive +and should have their order reversed +on the remote peer. After the VPN +is established, by pinging +.B rn, +you will be pinging across the VPN. + +For TAP devices, which provide +the ability to create virtual +ethernet segments, +.B --ifconfig +is used to set an IP address and +subnet mask just as a physical +ethernet adapter would be +similarly configured. If you are +attempting to connect to a remote +ethernet bridge, the IP address +and subnet should be set to values +which would be valid on the +the bridged ethernet segment (note +also that DHCP can be used for the +same purpose). + +This option, while primarily a proxy for the +.BR ifconfig (8) +command, is designed to simplify TUN/TAP +tunnel configuration by providing a +standard interface to the different +ifconfig implementations on different +platforms. + +.B --ifconfig +parameters which are IP addresses can +also be specified as a DNS or /etc/hosts +file resolvable name. + +For TAP devices, +.B --ifconfig +should not be used if the TAP interface will be +getting an IP address lease from a DHCP +server. +.\"********************************************************* +.TP +.B --ifconfig-noexec +Don't actually execute ifconfig/netsh commands, instead +pass +.B --ifconfig +parameters to scripts using environmental variables. +.\"********************************************************* +.TP +.B --ifconfig-nowarn +Don't output an options consistency check warning +if the +.B --ifconfig +option on this side of the +connection doesn't match the remote side. This is useful +when you want to retain the overall benefits of the +options consistency check (also see +.B --disable-occ +option) while only disabling the ifconfig component of +the check. + +For example, +if you have a configuration where the local host uses +.B --ifconfig +but the remote host does not, use +.B --ifconfig-nowarn +on the local host. + +This option will also silence warnings about potential +address conflicts which occasionally annoy more experienced +users by triggering "false positive" warnings. +.\"********************************************************* +.TP +.B --route network/IP [netmask] [gateway] [metric] +Add route to routing table after connection is established. +Multiple routes can be specified. Routes will be +automatically torn down in reverse order prior to +TUN/TAP device close. + +This option is intended as +a convenience proxy for the +.BR route (8) +shell command, +while at the same time providing portable semantics +across OpenVPN's platform space. + +.B netmask +default -- 255.255.255.255 + +.B gateway +default -- taken from +.B --route-gateway +or the second parameter to +.B --ifconfig +when +.B --dev tun +is specified. + +The default can be specified by leaving an option blank or setting +it to "default". + +The +.B network +and +.B gateway +parameters can +also be specified as a DNS or /etc/hosts +file resolvable name, or as one of three special keywords: + +.B vpn_gateway +-- The remote VPN endpoint address +(derived either from +.B --route-gateway +or the second parameter to +.B --ifconfig +when +.B --dev tun +is specified). + +.B net_gateway +-- The pre-existing IP default gateway, read from the routing +table (not supported on all OSes). + +.B remote_host +-- The +.B --remote +address if OpenVPN is being run in client mode, and is undefined in server mode. +.\"********************************************************* +.TP +.B --route-gateway gw +Specify a default gateway +.B gw +for use with +.B --route. +.\"********************************************************* +.TP +.B --route-delay [n] [w] +Delay +.B n +seconds (default=0) after connection +establishment, before adding routes. If +.B n +is 0, routes will be added immediately upon connection +establishment. If +.B --route-delay +is omitted, routes will be added immediately after TUN/TAP device +open and +.B --up +script execution, before any +.B --user +or +.B --group +privilege downgrade (or +.B --chroot +execution.) + +This option is designed to be useful in scenarios where DHCP is +used to set +tap adapter addresses. The delay will give the DHCP handshake +time to complete before routes are added. + +On Windows, +.B --route-delay +tries to be more intelligent by waiting +.B w +seconds (w=30 by default) +for the TAP-Win32 adapter to come up before adding routes. +.\"********************************************************* +.TP +.B --route-up cmd +Execute shell command +.B cmd +after routes are added, subject to +.B --route-delay. + +See the "Environmental Variables" section below for +additional parameters passed as environmental variables. + +Note that +.B cmd +can be a shell command with multiple arguments. +.\"********************************************************* +.TP +.B --route-noexec +Don't add or remove routes automatically. Instead pass routes to +.B --route-up +script using environmental variables. +.\"********************************************************* +.TP +.B --redirect-gateway ["local"] ["def1"] +(Experimental) Automatically execute routing commands to cause all outgoing IP traffic +to be redirected over the VPN. + +This option performs three steps: + +.B (1) +Create a static route for the +.B --remote +address which forwards to the pre-existing default gateway. +This is done so that +.B (3) +will not create a routing loop. + +.B (2) +Delete the default gateway route. + +.B (3) +Set the new default gateway to be the VPN endpoint address (derived either from +.B --route-gateway +or the second parameter to +.B --ifconfig +when +.B --dev tun +is specified). + +When the tunnel is torn down, all of the above steps are reversed so +that the original default route is restored. + +Add the +.B local +flag if both OpenVPN servers are directly connected via a common subnet, +such as with wireless. The +.B local +flag will cause step +.B 1 +above to be omitted. + +Add the +.B def1 +flag to override +the default gateway by using 0.0.0.0/1 and 128.0.0.0/1 +rather than 0.0.0.0/0. This has the benefit of overriding +but not wiping out the original default gateway. + +Using the def1 flag is highly recommended, and is currently +planned to become the default by OpenVPN 2.1. +.\"********************************************************* +.TP +.B --link-mtu n +Sets an upper bound on the size of UDP packets which are sent +between OpenVPN peers. It's best not to set this parameter unless +you know what you're doing. +.\"********************************************************* +.TP +.B --tun-mtu n +Take the TUN device MTU to be +.B n +and derive the link MTU +from it (default=1500). In most cases, you will probably want to +leave this parameter set to its default value. + +The MTU (Maximum Transmission Units) is +the maximum datagram size in bytes that can be sent unfragmented +over a particular network path. OpenVPN requires that packets +on the control or data channels be sent unfragmented. + +MTU problems often manifest themselves as connections which +hang during periods of active usage. + +It's best to use the +.B --fragment +and/or +.B --mssfix +options to deal with MTU sizing issues. +.\"********************************************************* +.TP +.B --tun-mtu-extra n +Assume that the TUN/TAP device might return as many as +.B n +bytes more than the +.B --tun-mtu +size on read. This parameter defaults to 0, which is sufficient for +most TUN devices. TAP devices may introduce additional overhead in excess +of the MTU size, and a setting of 32 is the default when TAP devices are used. +This parameter only controls internal OpenVPN buffer sizing, +so there is no transmission overhead associated with using a larger value. +.\"********************************************************* +.TP +.B --mtu-disc type +Should we do Path MTU discovery on TCP/UDP channel? Only supported on OSes such +as Linux that supports the necessary system call to set. + +.B 'no' +-- Never send DF (Don't Fragment) frames +.br +.B 'maybe' +-- Use per-route hints +.br +.B 'yes' +-- Always DF (Don't Fragment) +.br +.\"********************************************************* +.TP +.B --mtu-test +To empirically measure MTU on connection startup, +add the +.B --mtu-test +option to your configuration. +OpenVPN will send ping packets of various sizes +to the remote peer and measure the largest packets +which were successfully received. The +.B --mtu-test +process normally takes about 3 minutes to complete. +.\"********************************************************* +.TP +.B --fragment max +Enable internal datagram fragmentation so +that no UDP datagrams are sent which +are larger than +.B max +bytes. + +The +.B max +parameter is interpreted in the same way as the +.B --link-mtu +parameter, i.e. the UDP packet size after encapsulation +overhead has been added in, but not including +the UDP header itself. + +The +.B --fragment +option only makes sense when you are using the UDP protocol ( +.B --proto udp +). + +.B --fragment +adds 4 bytes of overhead per datagram. + +See the +.B --mssfix +option below for an important related option to +.B --fragment. + +It should also be noted that this option is not meant to replace +UDP fragmentation at the IP stack level. It is only meant as a +last resort when path MTU discovery is broken. Using this option +is less efficient than fixing path MTU discovery for your IP link and +using native IP fragmentation instead. + +Having said that, there are circumstances where using OpenVPN's +internal fragmentation capability may be your only option, such +as tunneling a UDP multicast stream which requires fragmentation. +.\"********************************************************* +.TP +.B --mssfix max +Announce to TCP sessions running over the tunnel that they should limit +their send packet sizes such that after OpenVPN has encapsulated them, +the resulting UDP packet size that OpenVPN sends to its peer will not +exceed +.B max +bytes. + +The +.B max +parameter is interpreted in the same way as the +.B --link-mtu +parameter, i.e. the UDP packet size after encapsulation +overhead has been added in, but not including +the UDP header itself. + +The +.B --mssfix +option only makes sense when you are using the UDP protocol +for OpenVPN peer-to-peer communication, i.e. +.B --proto udp. + +.B --mssfix +and +.B --fragment +can be ideally used together, where +.B --mssfix +will try to keep TCP from needing +packet fragmentation in the first place, +and if big packets come through anyhow +(from protocols other than TCP), +.B --fragment +will internally fragment them. + +Both +.B --fragment +and +.B --mssfix +are designed to work around cases where Path MTU discovery +is broken on the network path between OpenVPN peers. + +The usual symptom of such a breakdown is an OpenVPN +connection which successfully starts, but then stalls +during active usage. + +If +.B --fragment +and +.B --mssfix +are used together, +.B --mssfix +will take its default +.B max +parameter from the +.B --fragment max +option. + +Therefore, one could lower the maximum UDP packet size +to 1300 (a good first try for solving MTU-related +connection problems) with the following options: + +.B --tun-mtu 1500 --fragment 1300 --mssfix +.\"********************************************************* +.TP +.B --sndbuf size +Set the TCP/UDP socket send buffer size. +Currently defaults to 65536 bytes. +.\"********************************************************* +.TP +.B --rcvbuf size +Set the TCP/UDP socket receive buffer size. +Currently defaults to 65536 bytes. +.\"********************************************************* +.TP +.B --txqueuelen n +(Linux only) Set the TX queue length on the TUN/TAP interface. +Currently defaults to 100. +.\"********************************************************* +.TP +.B --shaper n +Limit bandwidth of outgoing tunnel data to +.B n +bytes per second on the TCP/UDP port. +If you want to limit the bandwidth +in both directions, use this option on both peers. + +OpenVPN uses the following algorithm to implement +traffic shaping: Given a shaper rate of +.I n +bytes per second, after a datagram write of +.I b +bytes is queued on the TCP/UDP port, wait a minimum of +.I (b / n) +seconds before queuing the next write. + +It should be noted that OpenVPN supports multiple +tunnels between the same two peers, allowing you +to construct full-speed and reduced bandwidth tunnels +at the same time, +routing low-priority data such as off-site backups +over the reduced bandwidth tunnel, and other data +over the full-speed tunnel. + +Also note that for low bandwidth tunnels +(under 1000 bytes per second), you should probably +use lower MTU values as well (see above), otherwise +the packet latency will grow so large as to trigger +timeouts in the TLS layer and TCP connections running +over the tunnel. + +OpenVPN allows +.B n +to be between 100 bytes/sec and 100 Mbytes/sec. +.\"********************************************************* +.TP +.B --inactive n +(Experimental) Causes OpenVPN to exit after +.B n +seconds of inactivity on the TUN/TAP device. The time length +of inactivity is measured since the last incoming tunnel packet. +.\"********************************************************* +.TP +.B --ping n +Ping remote over the TCP/UDP control channel +if no packets have been sent for at least +.B n +seconds (specify +.B --ping +on both peers to cause ping packets to be sent in both directions since +OpenVPN ping packets are not echoed like IP ping packets). +When used in one of OpenVPN's secure modes (where +.B --secret, --tls-server, +or +.B --tls-client +is specified), the ping packet +will be cryptographically secure. + +This option has two intended uses: + +(1) Compatibility +with stateful firewalls. The periodic ping will ensure that +a stateful firewall rule which allows OpenVPN UDP packets to +pass will not time out. + +(2) To provide a basis for the remote to test the existence +of its peer using the +.B --ping-exit +option. +.\"********************************************************* +.TP +.B --ping-exit n +Causes OpenVPN to exit after +.B n +seconds pass without reception of a ping +or other packet from remote. +This option can be combined with +.B --inactive, --ping, +and +.B --ping-exit +to create a two-tiered inactivity disconnect. + +For example, + +.B openvpn [options...] --inactive 3600 --ping 10 --ping-exit 60 + +when used on both peers will cause OpenVPN to exit within 60 +seconds if its peer disconnects, but will exit after one +hour if no actual tunnel data is exchanged. +.\"********************************************************* +.TP +.B --ping-restart n +Similar to +.B --ping-exit, +but trigger a +.B SIGUSR1 +restart after +.B n +seconds pass without reception of a ping +or other packet from remote. + +This option is useful in cases +where the remote peer has a dynamic IP address and +a low-TTL DNS name is used to track the IP address using +a service such as +.I http://dyndns.org/ ++ a dynamic DNS client such +as +.B ddclient. + +If the peer cannot be reached, a restart will be triggered, causing +the hostname used with +.B --remote +to be re-resolved (if +.B --resolv-retry +is also specified). + +In server mode, +.B --ping-restart, --inactive, +or any other type of internally generated signal will always be +applied to +individual client instance objects, never to whole server itself. +Note also in server mode that any internally generated signal +which would normally cause a restart, will cause the deletion +of the client instance object instead. + +In client mode, the +.B --ping-restart +parameter is set to 120 seconds by default. This default will +hold until the client pulls a replacement value from the server, based on +the +.B --keepalive +setting in the server configuration. +To disable the 120 second default, set +.B --ping-restart 0 +on the client. + +See the signals section below for more information +on +.B SIGUSR1. + +Note that the behavior of +.B SIGUSR1 +can be modified by the +.B --persist-tun, --persist-key, --persist-local-ip, +and +.B --persist-remote-ip +options. + +Also note that +.B --ping-exit +and +.B --ping-restart +are mutually exclusive and cannot be used together. +.\"********************************************************* +.TP +.B --keepalive n m +A helper directive designed to simplify the expression of +.B --ping +and +.B --ping-restart +in server mode configurations. + +For example, +.B --keepalive 10 60 +expands as follows: + +.RS +.ft 3 +.nf +.sp + if mode server: + ping 10 + ping-restart 120 + push "ping 10" + push "ping-restart 60" + else + ping 10 + ping-restart 60 +.ft +.LP +.RE +.fi +.\"********************************************************* +.TP +.B --ping-timer-rem +Run the +.B --ping-exit +/ +.B --ping-restart +timer only if we have a remote address. Use this option if you are +starting the daemon in listen mode (i.e. without an explicit +.B --remote +peer), and you don't want to start clocking timeouts until a remote +peer connects. +.\"********************************************************* +.TP +.B --persist-tun +Don't close and reopen TUN/TAP device or run up/down scripts +across +.B SIGUSR1 +or +.B --ping-restart +restarts. + +.B SIGUSR1 +is a restart signal similar to +.B SIGHUP, +but which offers finer-grained control over +reset options. +.\"********************************************************* +.TP +.B --persist-key +Don't re-read key files across +.B SIGUSR1 +or +.B --ping-restart. + +This option can be combined with +.B --user nobody +to allow restarts triggered by the +.B SIGUSR1 +signal. +Normally if you drop root privileges in OpenVPN, +the daemon cannot be restarted since it will now be unable to re-read protected +key files. + +This option solves the problem by persisting keys across +.B SIGUSR1 +resets, so they don't need to be re-read. +.\"********************************************************* +.TP +.B --persist-local-ip +Preserve initially resolved local IP address and port number +across +.B SIGUSR1 +or +.B --ping-restart +restarts. +.\"********************************************************* +.TP +.B --persist-remote-ip +Preserve most recently authenticated remote IP address and port number +across +.B SIGUSR1 +or +.B --ping-restart +restarts. +.\"********************************************************* +.TP +.B --mlock +Disable paging by calling the POSIX mlockall function. +Requires that OpenVPN be initially run as root (though +OpenVPN can subsequently downgrade its UID using the +.B --user +option). + +Using this option ensures that key material and tunnel +data are never written to disk due to virtual +memory paging operations which occur under most +modern operating systems. It ensures that even if an +attacker was able to crack the box running OpenVPN, he +would not be able to scan the system swap file to +recover previously used +ephemeral keys, which are used for a period of time +governed by the +.B --reneg +options (see below), then are discarded. + +The downside +of using +.B --mlock +is that it will reduce the amount of physical +memory available to other applications. +.\"********************************************************* +.TP +.B --up cmd +Shell command to run after successful TUN/TAP device open +(pre +.B --user +UID change). The up script is useful for specifying route +commands which route IP traffic destined for +private subnets which exist at the other +end of the VPN connection into the tunnel. + +For +.B --dev tun +execute as: + +.B cmd tun_dev tun_mtu link_mtu ifconfig_local_ip ifconfig_remote_ip [ init | restart ] + +For +.B --dev tap +execute as: + +.B cmd tap_dev tap_mtu link_mtu ifconfig_local_ip ifconfig_netmask [ init | restart ] + +See the "Environmental Variables" section below for +additional parameters passed as environmental variables. + +Note that +.B cmd +can be a shell command with multiple arguments, in which +case all OpenVPN-generated arguments will be appended +to +.B cmd +to build a command line which will be passed to the shell. + +Typically, +.B cmd +will run a script to add routes to the tunnel. + +Normally the up script is called after the TUN/TAP device is opened. +In this context, the last command line parameter passed to the script +will be +.I init. +If the +.B --up-restart +option is also used, the up script will be called for restarts as +well. A restart is considered to be a partial reinitialization +of OpenVPN where the TUN/TAP instance is preserved (the +.B --persist-tun +option will enable such preservation). A restart +can be generated by a SIGUSR1 signal, a +.B --ping-restart +timeout, or a connection reset when the TCP protocol is enabled +with the +.B --proto +option. If a restart occurs, and +.B --up-restart +has been specified, the up script will be called with +.I restart +as the last parameter. + +The following standalone example shows how the +.B --up +script can be called in both an initialization and restart context. +(NOTE: for security reasons, don't run the following example unless UDP port +9999 is blocked by your firewall. Also, the example will run indefinitely, +so you should abort with control-c). + +.B openvpn --dev tun --port 9999 --verb 4 --ping-restart 10 --up 'echo up' --down 'echo down' --persist-tun --up-restart + +Note that OpenVPN also provides the +.B --ifconfig +option to automatically ifconfig the TUN device, +eliminating the need to define an +.B --up +script, unless you also want to configure routes +in the +.B --up +script. + +If +.B --ifconfig +is also specified, OpenVPN will pass the ifconfig local +and remote endpoints on the command line to the +.B --up +script so that they can be used to configure routes such as: + +.B route add -net 10.0.0.0 netmask 255.255.255.0 gw $5 +.\"********************************************************* +.TP +.B --up-delay +Delay TUN/TAP open and possible +.B --up +script execution +until after TCP/UDP connection establishment with peer. + +In +.B --proto udp +mode, this option normally requires the use of +.B --ping +to allow connection initiation to be sensed in the absence +of tunnel data, since UDP is a "connectionless" protocol. + +On Windows, this option will delay the TAP-Win32 media state +transitioning to "connected" until connection establishment, +i.e. the receipt of the first authenticated packet from the peer. +.\"********************************************************* +.TP +.B --down cmd +Shell command to run after TUN/TAP device close +(post +.B --user +UID change and/or +.B --chroot +). Called with the same parameters and environmental +variables as the +.B --up +option above. + +Note that if you reduce privileges by using +.B --user +and/or +.B --group, +your +.B --down +script will also run at reduced privilege. +.\"********************************************************* +.TP +.B --down-pre +Call +.B --down +cmd/script before, rather than after, TUN/TAP close. +.\"********************************************************* +.TP +.B --up-restart +Enable the +.B --up +and +.B --down +scripts to be called for restarts as well as initial program start. +This option is described more fully above in the +.B --up +option documentation. +.\"********************************************************* +.TP +.B --setenv name value +Set a custom environmental variable +.B name=value +to pass to script. +.\"********************************************************* +.TP +.B --disable-occ +Don't output a warning message if option inconsistencies are detected between +peers. An example of an option inconsistency would be where one peer uses +.B --dev tun +while the other peer uses +.B --dev tap. + +Use of this option is discouraged, but is provided as +a temporary fix in situations where a recent version of OpenVPN must +connect to an old version. +.\"********************************************************* +.TP +.B --user user +Change the user ID of the OpenVPN process to +.B user +after initialization, dropping privileges in the process. +This option is useful to protect the system +in the event that some hostile party was able to gain control of +an OpenVPN session. Though OpenVPN's security features make +this unlikely, it is provided as a second line of defense. + +By setting +.B user +to +.I nobody +or somebody similarly unprivileged, the hostile party would be +limited in what damage they could cause. Of course once +you take away privileges, you cannot return them +to an OpenVPN session. This means, for example, that if +you want to reset an OpenVPN daemon with a +.B SIGUSR1 +signal +(for example in response +to a DHCP reset), you should make use of one or more of the +.B --persist +options to ensure that OpenVPN doesn't need to execute any privileged +operations in order to restart (such as re-reading key files +or running +.BR ifconfig +on the TUN device). +.\"********************************************************* +.TP +.B --group group +Similar to the +.B --user +option, +this option changes the group ID of the OpenVPN process to +.B group +after initialization. +.\"********************************************************* +.TP +.B --cd dir +Change directory to +.B dir +prior to reading any files such as +configuration files, key files, scripts, etc. +.B dir +should be an absolute path, with a leading "/", +and without any references +to the current directory such as "." or "..". + +This option is useful when you are running +OpenVPN in +.B --daemon +mode, and you want to consolidate all of +your OpenVPN control files in one location. +.\"********************************************************* +.TP +.B --chroot dir +Chroot to +.B dir +after initialization. +.B --chroot +essentially redefines +.B dir +as being the top +level directory tree (/). OpenVPN will therefore +be unable to access any files outside this tree. +This can be desirable from a security standpoint. + +Since the chroot operation is delayed until after +initialization, most OpenVPN options that reference +files will operate in a pre-chroot context. + +In many cases, the +.B dir +parameter can point to an empty directory, however +complications can result when scripts or restarts +are executed after the chroot operation. +.\"********************************************************* +.TP +.B --daemon [progname] +Become a daemon after all initialization functions are completed. +This option will cause all message and error output to +be sent to the syslog file (such as /var/log/messages), +except for the output of shell scripts and +ifconfig commands, +which will go to /dev/null unless otherwise redirected. +The syslog redirection occurs immediately at the point +that +.B --daemon +is parsed on the command line even though +the daemonization point occurs later. If one of the +.B --log +options is present, it will supercede syslog +redirection. + +The optional +.B progname +parameter will cause OpenVPN to report its program name +to the system logger as +.B progname. +This can be useful in linking OpenVPN messages +in the syslog file with specific tunnels. +When unspecified, +.B progname +defaults to "openvpn". + +When OpenVPN is run with the +.B --daemon +option, it will try to delay daemonization until the majority of initialization +functions which are capable of generating fatal errors are complete. This means +that initialization scripts can test the return status of the +openvpn command for a fairly reliable indication of whether the command +has correctly initialized and entered the packet forwarding event loop. + +In OpenVPN, the vast majority of errors which occur after initialization are non-fatal. +.\"********************************************************* +.TP +.B --syslog [progname] +Direct log output to system logger, but do not become a daemon. +See +.B --daemon +directive above for description of +.B progname +parameter. +.\"********************************************************* +.TP +.B --passtos +Set the TOS field of the tunnel packet to what the payload's TOS is. +.\"********************************************************* +.TP +.B --inetd [wait|nowait] [progname] +Use this option when OpenVPN is being run from the inetd or +.BR xinetd(8) +server. + +The +.B wait/nowait +option must match what is specified in the inetd/xinetd +config file. The +.B nowait +mode can only be used with +.B --proto tcp-server. +The default is +.B wait. +The +.B nowait +mode can be used to instantiate the OpenVPN daemon as a classic TCP server, +where client connection requests are serviced on a single +port number. For additional information on this kind of configuration, +see the OpenVPN FAQ: +.I http://openvpn.net/faq.html#oneport + +This option precludes the use of +.B --daemon, --local, +or +.B --remote. +Note that this option causes message and error output to be handled in the same +way as the +.B --daemon +option. The optional +.B progname +parameter is also handled exactly as in +.B --daemon. + +Also note that in +.B wait +mode, each OpenVPN tunnel requires a separate TCP/UDP port and +a separate inetd or xinetd entry. See the OpenVPN 1.x HOWTO for an example +on using OpenVPN with xinetd: +.I http://openvpn.net/1xhowto.html +.\"********************************************************* +.TP +.B --log file +Output logging messages to +.B file, +including output to stdout/stderr which +is generated by called scripts. +If +.B file +already exists it will be truncated. +This option takes effect +immediately when it is parsed in the command line +and will supercede syslog output if +.B --daemon +or +.B --inetd +is also specified. +This option is persistent over the entire course of +an OpenVPN instantiation and will not be reset by SIGHUP, +SIGUSR1, or +.B --ping-restart. + +Note that on Windows, when OpenVPN is started as a service, +logging occurs by default without the need to specify +this option. +.\"********************************************************* +.TP +.B --log-append file +Append logging messages to +.B file. +If +.B file +does not exist, it will be created. +This option behaves exactly like +.B --log +except that it appends to rather +than truncating the log file. +.\"********************************************************* +.TP +.B --suppress-timestamps +Avoid writing timestamps to log messages, even when they +otherwise would be prepended. In particular, this applies to +log messages sent to stdout. +.\"********************************************************* +.TP +.B --writepid file +Write OpenVPN's main process ID to +.B file. +.\"********************************************************* +.TP +.B --nice n +Change process priority after initialization +( +.B n +greater than 0 is lower priority, +.B n +less than zero is higher priority). +.\"********************************************************* +.\".TP +.\".B --nice-work n +.\"Change priority of background TLS work thread. The TLS thread +.\"feature is enabled when OpenVPN is built +.\"with pthread support, and you are running OpenVPN +.\"in TLS mode (i.e. with +.\".B --tls-client +.\"or +.\".B --tls-server +.\"specified). +.\" +.\"Using a TLS thread offloads the CPU-intensive process of SSL/TLS-based +.\"key exchange to a background thread so that it does not become +.\"a latency bottleneck in the tunnel packet forwarding process. +.\" +.\"The parameter +.\".B n +.\"is interpreted exactly as with the +.\".B --nice +.\"option above, but in relation to the work thread rather +.\"than the main thread. +.\"********************************************************* +.TP +.B --fast-io +(Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding +a call to poll/epoll/select prior to the write operation. The purpose +of such a call would normally be to block until the device +or socket is ready to accept the write. Such blocking is unnecessary +on some platforms which don't support write blocking on UDP sockets +or TUN/TAP devices. In such cases, one can optimize the event loop +by avoiding the poll/epoll/select call, improving CPU efficiency +by 5% to 10%. + +This option can only be used on non-Windows systems, when +.B --proto udp +is specified, and when +.B --shaper +is NOT specified. +.\"********************************************************* +.TP +.B --echo [parms...] +Echo +.B parms +to log output. + +Designed to be used to send messages to a controlling application +which is receiving the OpenVPN log output. +.\"********************************************************* +.TP +.B --remap-usr1 signal +Control whether internally or externally +generated SIGUSR1 signals are remapped to +SIGHUP (restart without persisting state) or +SIGTERM (exit). + +.B signal +can be set to "SIGHUP" or "SIGTERM". By default, no remapping +occurs. +.\"********************************************************* +.TP +.B --verb n +Set output verbosity to +.B n +(default=1). Each level shows all info from the previous levels. +Level 3 is recommended if you want a good summary +of what's happening without being swamped by output. + +.B 0 -- +No output except fatal errors. +.br +.B 1 to 4 -- +Normal usage range. +.br +.B 5 -- +Output +.B R +and +.B W +characters to the console for each packet read and write, uppercase is +used for TCP/UDP packets and lowercase is used for TUN/TAP packets. +.br +.B 6 to 11 -- +Debug info range (see errlevel.h for additional +information on debug levels). +.\"********************************************************* +.TP +.B --status file [n] +Write operational status to +.B file +every +.B n +seconds. + +Status can also be written to the syslog by sending a +.B SIGUSR2 +signal. +.\"********************************************************* +.TP +.B --status-version [n] +Choose the status file format version number. Currently +.B n +can be 1 or 2 and defaults to 1. +.\"********************************************************* +.TP +.B --mute n +Log at most +.B n +consecutive messages in the same category. This is useful to +limit repetitive logging of similar message types. +.\"********************************************************* +.TP +.B --comp-lzo +Use fast LZO compression -- may add up to 1 byte per +packet for incompressible data. +.\"********************************************************* +.TP +.B --comp-noadapt +When used in conjunction with +.B --comp-lzo, +this option will disable OpenVPN's adaptive compression algorithm. +Normally, adaptive compression is enabled with +.B --comp-lzo. + +Adaptive compression tries to optimize the case where you have +compression enabled, but you are sending predominantly uncompressible +(or pre-compressed) packets over the tunnel, such as an FTP or rsync transfer +of a large, compressed file. With adaptive compression, +OpenVPN will periodically sample the compression process to measure its +efficiency. If the data being sent over the tunnel is already compressed, +the compression efficiency will be very low, triggering openvpn to disable +compression for a period of time until the next re-sample test. +.\"********************************************************* +.TP +.B --management IP port [pw-file] +Enable a TCP server on +.B IP:port +to handle daemon management functions. +.B pw-file, +if specified, +is a password file (password on first line) +or "stdin" to prompt from standard input. The password +provided will set the password which TCP clients will need +to provide in order to access management functions. + +The management interface provides a special mode where the TCP +management link can operate over the tunnel itself. To enable this mode, +set +.B IP += "tunnel". Tunnel mode will cause the management interface +to listen for a TCP connection on the local VPN address of the +TUN/TAP interface. + +While the management port is designed for programmatic control +of OpenVPN by other applications, it is possible to telnet +to the port, using a telnet client in "raw" mode. Once connected, +type "help" for a list of commands. + +For detailed documentation on the management interface, see +the management-notes.txt file in the +.B management +folder of +the OpenVPN source distribution. + +It is strongly recommended that +.B IP +be set to 127.0.0.1 +(localhost) to restrict accessibility of the management +server to local clients. +.\"********************************************************* +.TP +.B --management-query-passwords +Query management channel for private key password and +.B --auth-user-pass +username/password. Only query the management channel +for inputs which ordinarily would have been queried from the +console. +.\"********************************************************* +.TP +.B --management-hold +Start OpenVPN in a hibernating state, until a client +of the management interface explicitly starts it +with the +.B hold release +command. +.\"********************************************************* +.TP +.B --management-log-cache n +Cache the most recent +.B n +lines of log file history for usage +by the management channel. +.\"********************************************************* +.TP +.B --plugin module-pathname [init-string] +Load plug-in module from the file +.B module-pathname, +passing +.B init-string +as an argument +to the module initialization function. Multiple +plugin modules may be loaded into one OpenVPN +process. + +For more information and examples on how to build OpenVPN +plug-in modules, see the README file in the +.B plugin +folder of the OpenVPN source distribution. + +If you are using an RPM install of OpenVPN, see +/usr/share/openvpn/plugin. The documentation is +in +.B doc +and the actual plugin modules are in +.B lib. + +Multiple plugin modules can be cascaded, and modules can be +used in tandem with scripts. The modules will be called by +OpenVPN in the order that they are declared in the config +file. If both a plugin and script are configured for the same +callback, the script will be called last. If the +return code of the module/script controls an authentication +function (such as tls-verify, auth-user-pass-verify, or +client-connect), then +every module and script must return success (0) in order for +the connection to be authenticated. +.\"********************************************************* +.SS Server Mode +Starting with OpenVPN 2.0, a multi-client TCP/UDP server mode +is supported, and can be enabled with the +.B --mode server +option. In server mode, OpenVPN will listen on a single +port for incoming client connections. All client +connections will be routed through a single tun or tap +interface. This mode is designed for scalability and should +be able to support hundreds or even thousands of clients +on sufficiently fast hardware. SSL/TLS authentication must +be used in this mode. +.\"********************************************************* +.TP +.B --server network netmask +A helper directive designed to simplify the configuration +of OpenVPN's server mode. This directive will set up an +OpenVPN server which will allocate addresses to clients +out of the given network/netmask. The server itself +will take the ".1" address of the given network +for use as the server-side endpoint of the local +TUN/TAP interface. + +For example, +.B --server 10.8.0.0 255.255.255.0 +expands as follows: + +.RS +.ft 3 +.nf +.sp + mode server + tls-server + + if dev tun: + ifconfig 10.8.0.1 10.8.0.2 + ifconfig-pool 10.8.0.4 10.8.0.251 + route 10.8.0.0 255.255.255.0 + if client-to-client: + push "route 10.8.0.0 255.255.255.0" + else + push "route 10.8.0.1" + + if dev tap: + ifconfig 10.8.0.1 255.255.255.0 + ifconfig-pool 10.8.0.2 10.8.0.254 255.255.255.0 + push "route-gateway 10.8.0.1" +.ft +.LP +.RE +.fi + +Don't use +.B --server +if you are ethernet bridging. Use +.B --server-bridge +instead. +.\"********************************************************* +.TP +.B --server-bridge gateway netmask pool-start-IP pool-end-IP + +A helper directive similar to +.B --server +which is designed to simplify the configuration +of OpenVPN's server mode in ethernet bridging configurations. + +To configure ethernet bridging, you +must first use your OS's bridging capability +to bridge the TAP interface with the ethernet +NIC interface. For example, on Linux this is done +with the +.B brctl +tool, and with Windows XP it is done in the Network +Connections Panel by selecting the ethernet and +TAP adapters and right-clicking on "Bridge Connections". + +Next you you must manually set the +IP/netmask on the bridge interface. The +.B gateway +and +.B netmask +parameters to +.B --server-bridge +can be set to either the IP/netmask of the +bridge interface, or the IP/netmask of the +default gateway/router on the bridged +subnet. + +Finally, set aside a IP range in the bridged +subnet, +denoted by +.B pool-start-IP +and +.B pool-end-IP, +for OpenVPN to allocate to connecting +clients. + +For example, +.B server-bridge 10.8.0.4 255.255.255.0 10.8.0.128 10.8.0.254 +expands as follows: + +.RS +.ft 3 +.nf +.sp +mode server +tls-server + +ifconfig-pool 10.8.0.128 10.8.0.254 255.255.255.0 +push "route-gateway 10.8.0.4" +.ft +.LP +.RE +.fi +.\"********************************************************* +.TP +.B --push "option" +Push a config file option back to the client for remote +execution. Note that +.B +option +must be enclosed in double quotes (""). The client must specify +.B --pull +in its config file. The set of options which can be +pushed is limited by both feasibility and security. +Some options such as those which would execute scripts +are banned, since they would effectively allow a compromised +server to execute arbitrary code on the client. +Other options such as TLS or MTU parameters +cannot be pushed because the client needs to know +them before the connection to the server can be initiated. + +This is a partial list of options which can currently be pushed: +.B --route, --route-gateway, --route-delay, --redirect-gateway, +.B --ip-win32, --dhcp-option, +.B --inactive, --ping, --ping-exit, --ping-restart, +.B --setenv, +.B --persist-key, --persist-tun, --echo +.\"********************************************************* +.TP +.B --push-reset +Don't inherit the global push list for a specific client instance. +Specify this option in a client-specific context such +as with a +.B --client-config-dir +configuration file. This option will ignore +.B --push +options at the global config file level. +.\"********************************************************* +.TP +.B --disable +Disable a particular client (based on the common name) +from connecting. Don't use this option to disable a client +due to key or password compromise. Use a CRL (certificate +revocation list) instead (see the +.B --crl-verify +option). + +This option must be associated with a specific client instance, +which means that it must be specified either in a client +instance config file using +.B --client-config-dir +or dynamically generated using a +.B --client-connect +script. +.\"********************************************************* +.TP +.B --ifconfig-pool start-IP end-IP [netmask] +Set aside a pool of subnets to be +dynamically allocated to connecting clients, similar +to a DHCP server. For tun-style +tunnels, each client will be given a /30 subnet (for +interoperability with Windows clients). For tap-style +tunnels, individual addresses will be allocated, and the +optional +.B netmask +parameter will also be pushed to clients. + +.\"********************************************************* +.TP +.B --ifconfig-pool-persist file [seconds] +Persist/unpersist ifconfig-pool +data to +.B file, +at +.B seconds +intervals (default=600), as well as on program startup and +shutdown. + +The goal of this option is to provide a long-term association +between clients (denoted by their common name) and the virtual +IP address assigned to them from the ifconfig-pool. +Maintaining a long-term +association is good for clients because it allows them +to effectively use the +.B --persist-tun +option. + +.B file +is a comma-delimited ASCII file, formatted as +<Common-Name>,<IP-address>. + +If +.B seconds += 0, +.B file +will be treated as read-only. This is useful if +you would like to treat +.B file +as a configuration file. + +Note that the entries in this file are treated by OpenVPN as +suggestions only, based on past associations between +a common name and IP address. They do not guarantee that the given common +name will always receive the given IP address. If you want guaranteed +assignment, use +.B --ifconfig-push +.\"********************************************************* +.TP +.B --ifconfig-pool-linear +Modifies the +.B --ifconfig-pool +directive to +allocate individual TUN interface addresses for +clients rather than /30 subnets. NOTE: This option +is incompatible with Windows clients. +.\"********************************************************* +.TP +.B --ifconfig-push local remote-netmask +Push virtual IP endpoints for client tunnel, +overriding the --ifconfig-pool dynamic allocation. + +The parameters +.B local +and +.B remote-netmask +are set according to the +.B --ifconfig +directive which you want to execute on the client machine to +configure the remote end of the tunnel. Note that the parameters +.B local +and +.B remote-netmask +are from the perspective of the client, not the server. They may be +DNS names rather than IP addresses, in which case they will be resolved +on the server at the time of client connection. + +This option must be associated with a specific client instance, +which means that it must be specified either in a client +instance config file using +.B --client-config-dir +or dynamically generated using a +.B --client-connect +script. + +Remember also to include a +.B --route +directive in the main OpenVPN config file which encloses +.B local, +so that the kernel will know to route it +to the server's TUN/TAP interface. + +OpenVPN's internal client IP address selection algorithm works as +follows: + +.B 1 +-- Use +.B --client-connect script +generated file for static IP (first choice). +.br +.B 2 +-- Use +.B --client-config-dir +file for static IP (next choice). +.br +.B 3 +-- Use +.B --ifconfig-pool +allocation for dynamic IP (last choice). +.br +.\"********************************************************* +.TP +.B --iroute network [netmask] +Generate an internal route to a specific +client. The +.B netmask +parameter, if omitted, defaults to 255.255.255.255. + +This directive can be used to route a fixed subnet from +the server to a particular client, regardless +of where the client is connecting from. Remember +that you must also add the route to the system +routing table as well (such as by using the +.B --route +directive). The reason why two routes are needed +is that the +.B --route +directive routes the packet from the kernel +to OpenVPN. Once in OpenVPN, the +.B --iroute +directive routes to the specific client. + +This option must be specified either in a client +instance config file using +.B --client-config-dir +or dynamically generated using a +.B --client-connect +script. + +The +.B --iroute +directive also has an important interaction with +.B --push +"route ...". +.B --iroute +essentially defines a subnet which is owned by a +particular client (we will call this client A). +If you would like other clients to be able to reach A's +subnet, you can use +.B --push +"route ..." +together with +.B --client-to-client +to effect this. In order for all clients to see +A's subnet, OpenVPN must push this route to all clients +EXCEPT for A, since the subnet is already owned by A. +OpenVPN accomplishes this by not +not pushing a route to a client +if it matches one of the client's iroutes. +.\"********************************************************* +.TP +.B --client-to-client +Because the OpenVPN server mode handles multiple clients +through a single tun or tap interface, it is effectively +a router. The +.B --client-to-client +flag tells OpenVPN to internally route client-to-client +traffic rather than pushing all client-originating traffic +to the TUN/TAP interface. + +When this option is used, each client will "see" the other +clients which are currently connected. Otherwise, each +client will only see the server. Don't use this option +if you want to firewall tunnel traffic using +custom, per-client rules. +.\"********************************************************* +.TP +.B --duplicate-cn +Allow multiple clients with the same common name to concurrently connect. +In the absence of this option, OpenVPN will disconnect a client instance +upon connection of a new client having the same common name. +.\"********************************************************* +.TP +.B --client-connect script +Run +.B script +on client connection. The script is passed the common name +and IP address of the just-authenticated client +as environmental variables (see environmental variable section +below). The script is also passed +the pathname of a not-yet-created temporary file as $1 +(i.e. the first command line argument), to be used by the script +to pass dynamically generated config file directives back to OpenVPN. + +If the script wants to generate a dynamic config file +to be applied on the server when the client connects, +it should write it to the file named by $1. + +See the +.B --client-config-dir +option below for options which +can be legally used in a dynamically generated config file. + +Note that the return value of +.B script +is significant. If +.B script +returns a non-zero error status, it will cause the client +to be disconnected. +.\"********************************************************* +.TP +.B --client-disconnect +Like +.B --client-connect +but called on client instance shutdown. Will not be called +unless the +.B --client-connect +script and plugins (if defined) +were previously called on this instance with +successful (0) status returns. + +The exception to this rule is if the +.B --client-disconnect +script or plugins are cascaded, and at least one client-connect +function succeeded, then ALL of the client-disconnect functions for +scripts and plugins will be called on client instance object deletion, +even in cases where some of the related client-connect functions returned +an error status. +.B +.\"********************************************************* +.TP +.B --client-config-dir dir +Specify a directory +.B dir +for custom client config files. After +a connecting client has been authenticated, OpenVPN will +look in this directory for a file having the same name +as the client's X509 common name. If a matching file +exists, it will be opened and parsed for client-specific +configuration options. If no matching file is found, OpenVPN +will instead try to open and parse a default file called +"DEFAULT", which may be provided but is not required. + +This file can specify a fixed IP address for a given +client using +.B --ifconfig-push, +as well as fixed subnets owned by the client using +.B --iroute. + +One of the useful properties of this option is that it +allows client configuration files to be conveniently +created, edited, or removed while the server is live, +without needing to restart the server. + +The following +options are legal in a client-specific context: +.B --push, --push-reset, --iroute, --ifconfig-push, +and +.B --config. +.\"********************************************************* +.TP +.B --ccd-exclusive +Require, as a +condition of authentication, that a connecting client has a +.B --client-config-dir +file. +.\"********************************************************* +.TP +.B --tmp-dir dir +Specify a directory +.B dir +for temporary files. This directory will be used by +.B --client-connect +scripts to dynamically generate client-specific +configuration files. +.\"********************************************************* +.TP +.B --hash-size r v +Set the size of the real address hash table to +.B r +and the virtual address table to +.B v. +By default, both tables are sized at 256 buckets. +.\"********************************************************* +.TP +.B --bcast-buffers n +Allocate +.B n +buffers for broadcast datagrams (default=256). +.\"********************************************************* +.TP +.B --tcp-queue-limit n +Maximum number of queued TCP output packets (default=64). + +When OpenVPN is tunneling data from a TUN/TAP device to a +remote client over a TCP connection, it is possible that the TUN/TAP device +might produce data at a faster rate than the TCP connection +can support. When the number of queued TCP output packets reaches +this limit for a given client connection, +OpenVPN will start to drop outgoing packets directed +at this client. +.\"********************************************************* +.TP +.B --max-clients n +Limit server to a maximum of +.B n +concurrent clients. +.\"********************************************************* +.TP +.B --max-routes-per-client n +Allow a maximum of +.B n +internal routes per client (default=256). +This is designed to +help contain DoS attacks where an authenticated client floods the +server with packets appearing to come from many unique MAC addresses, +forcing the server to deplete +virtual memory as its internal routing table expands. +This directive can be used in a +.B --client-config-dir +file or auto-generated by a +.B --client-connect +script to override the global value for a particular client. + +Note that this +directive affects OpenVPN's internal routing table, not the +kernel routing table. +.\"********************************************************* +.TP +.B --connect-freq n sec +Allow a maximum of +.B n +new connections per +.B sec +seconds from clients. This is designed to contain DoS attacks which flood +the server with connection requests using certificates which +will ultimately fail to authenticate. + +This is an imperfect solution however, because in a real +DoS scenario, legitimate connections might also be refused. + +For the best protection against DoS attacks in server mode, +use +.B --proto udp +and +.B --tls-auth. +.\"********************************************************* +.TP +.B --learn-address cmd +Run script or shell command +.B cmd +to validate client virtual addresses or routes. + +.B cmd +will be executed with 3 parameters: + +.B [1] operation -- +"add", "update", or "delete" based on whether or not +the address is being added to, modified, or deleted from +OpenVPN's internal routing table. +.br +.B [2] address -- +The address being learned or unlearned. This can be +an IPv4 address such as "198.162.10.14", an IPv4 subnet +such as "198.162.10.0/24", or an ethernet MAC address (when +.B --dev tap +is being used) such as "00:FF:01:02:03:04". +.br +.B [3] common name -- +The common name on the certificate associated with the +client linked to this address. Only present for "add" +or "update" operations, not "delete". + +On "add" or "update" methods, if the script returns +a failure code (non-zero), OpenVPN will reject the address +and will not modify its internal routing table. + +Normally, the +.B cmd +script will use the information provided above to set +appropriate firewall entries on the VPN TUN/TAP interface. +Since OpenVPN provides the association between virtual IP +or MAC address and the client's authenticated common name, +it allows a user-defined script to configure firewall access +policies with regard to the client's high-level common name, +rather than the low level client virtual addresses. +.\"********************************************************* +.TP +.B --auth-user-pass-verify script method +Require the client to provide a username/password (possibly +in addition to a client certificate) for authentication. + +OpenVPN will execute +.B script +as a shell command to validate the username/password +provided by the client. + +If +.B method +is set to "via-env", OpenVPN will call +.B script +with the environmental variables +.B username +and +.B password +set to the username/password strings provided by the client. +Be aware that this method is insecure on some platforms which +make the environment of a process publicly visible to other +unprivileged processes. + +If +.B method +is set to "via-file", OpenVPN will write the username and +password to the first two lines of a temporary file. The filename +will be passed as an argument to +.B script, +and the file will be automatically deleted by OpenVPN after +the script returns. The location of the temporary file is +controlled by the +.B --tmp-dir +option, and will default to the current directory if unspecified. +For security, consider setting +.B --tmp-dir +to a volatile storage medium such as +.B /dev/shm +(if available) to prevent the username/password file from touching the hard drive. + +The script should examine the username +and password, +returning a success exit code (0) if the +client's authentication request is to be accepted, or a failure +code (1) to reject the client. + +This directive is designed to enable a plugin-style interface +for extending OpenVPN's authentication capabilities. + +To protect against a client passing a maliciously formed +username or password string, the username string must +consist only of these characters: alphanumeric, underbar +('_'), dash ('-'), dot ('.'), or at ('@'). The password +string can consist of any printable characters except for +CR or LF. Any illegal characters in either the username +or password string will be converted to underbar ('_'). + +Care must be taken by any user-defined scripts to avoid +creating a security vulnerability in the way that these +strings are handled. Never use these strings in such a way +that they might be escaped or evaluated by a shell interpreter. + +For a sample script that performs PAM authentication, see +.B sample-scripts/auth-pam.pl +in the OpenVPN source distribution. +.\"********************************************************* +.TP +.B --client-cert-not-required +Don't require client certificate, client will authenticate +using username/password only. Be aware that using this directive +is less secure than requiring certificates from all clients. + +If you use this directive, the +entire responsibility of authentication will rest on your +.B --auth-user-pass-verify +script, so keep in mind that bugs in your script +could potentially compromise the security of your VPN. + +If you don't use this directive, but you also specify an +.B --auth-user-pass-verify +script, then OpenVPN will perform double authentication. The +client certificate verification AND the +.B --auth-user-pass-verify +script will need to succeed in order for a client to be +authenticated and accepted onto the VPN. +.\"********************************************************* +.TP +.B --username-as-common-name +For +.B --auth-user-pass-verify +authentication, use +the authenticated username as the common name, +rather than the common name from the client cert. +.\"********************************************************* +.SS Client Mode +Use client mode when connecting to an OpenVPN server +which has +.B --server, --server-bridge, +or +.B --mode server +in it's configuration. +.\"********************************************************* +.TP +.B --client +A helper directive designed to simplify the configuration +of OpenVPN's client mode. This directive is equivalent to: + +.RS +.ft 3 +.nf +.sp + pull + tls-client +.ft +.LP +.RE +.fi +.\"********************************************************* +.TP +.B --pull +This option must be used on a client which is connecting +to a multi-client server. It indicates to OpenVPN that it +should accept options pushed by the server, provided they +are part of the legal set of pushable options. +.\"********************************************************* +.TP +.B --auth-user-pass [up] +Authenticate with server using username/password. +.B up +is a file containing username/password on 2 lines (Note: OpenVPN +will only read passwords from a file if it has been built +with the --enable-password-save configure option, or on Windows +by defining ENABLE_PASSWORD_SAVE in config-win32.h). + +If +.B up +is omitted, username/password will be prompted from the +console. + +The server configuration must specify an +.B --auth-user-pass-verify +script to verify the username/password provided by +the client. +.\"********************************************************* +.TP +.B --auth-retry type +Controls how OpenVPN responds to username/password verification +errors such as the client-side response to an AUTH_FAILED message from the server +or verification failure of the private key password. + +Normally used to prevent auth errors from being fatal +on the client side, and to permit username/password requeries in case +of error. + +An AUTH_FAILED message is generated by the server if the client +fails +.B --auth-user-pass +authentication, or if the server-side +.B --client-connect +script returns an error status when the client +tries to connect. + +.B type +can be one of: + +.B none -- +Client will exit with a fatal error (this is the default). +.br +.B nointeract -- +Client will retry the connection without requerying for an +.B --auth-user-pass +username/password. Use this option for unattended clients. +.br +.B interact -- +Client will requery for an +.B --auth-user-pass +username/password and/or private key password before attempting a reconnection. + +Note that while this option cannot be pushed, it can be controlled +from the management interface. +.\"********************************************************* +.TP +.B --explicit-exit-notify [n] +In UDP client mode or point-to-point mode, send server/peer an exit notification +if tunnel is restarted or OpenVPN process is exited. In client mode, on +exit/restart, this +option will tell the server to immediately close its client instance object +rather than waiting for a timeout. The +.B n +parameter (default=1) controls the maximum number of retries that the client +will attempt to resend the exit notification message. +.\"********************************************************* +.SS Data Channel Encryption Options: +These options are meaningful for both Static & TLS-negotiated key modes +(must be compatible between peers). +.\"********************************************************* +.TP +.B --secret file [direction] +Enable Static Key encryption mode (non-TLS). +Use pre-shared secret +.B file +which was generated with +.B --genkey. + +The optional +.B direction +parameter enables the use of 4 distinct keys +(HMAC-send, cipher-encrypt, HMAC-receive, cipher-decrypt), so that +each data flow direction has a different set of HMAC and cipher keys. +This has a number of desirable security properties including +eliminating certain kinds of DoS and message replay attacks. + +When the +.B direction +parameter is omitted, 2 keys are used bidirectionally, one for HMAC +and the other for encryption/decryption. + +The +.B direction +parameter should always be complementary on either side of the connection, +i.e. one side should use "0" and the other should use "1", or both sides +should omit it altogether. + +The +.B direction +parameter requires that +.B file +contains a 2048 bit key. While pre-1.5 versions of OpenVPN +generate 1024 bit key files, any version of OpenVPN which +supports the +.B direction +parameter, will also support 2048 bit key file generation +using the +.B --genkey +option. + +Static key encryption mode has certain advantages, +the primary being ease of configuration. + +There are no certificates +or certificate authorities or complicated negotiation handshakes and protocols. +The only requirement is that you have a pre-existing secure channel with +your peer (such as +.B ssh +) to initially copy the key. This requirement, along with the +fact that your key never changes unless you manually generate a new one, +makes it somewhat less secure than TLS mode (see below). If an attacker +manages to steal your key, everything that was ever encrypted with +it is compromised. Contrast that to the perfect forward secrecy features of +TLS mode (using Diffie Hellman key exchange), where even if an attacker +was able to steal your private key, he would gain no information to help +him decrypt past sessions. + +Another advantageous aspect of Static Key encryption mode is that +it is a handshake-free protocol +without any distinguishing signature or feature +(such as a header or protocol handshake sequence) +that would mark the ciphertext packets as being +generated by OpenVPN. Anyone eavesdropping on the wire +would see nothing +but random-looking data. +.\"********************************************************* +.TP +.B --auth alg +Authenticate packets with HMAC using message +digest algorithm +.B alg. +(The default is +.B SHA1 +). +HMAC is a commonly used message authentication algorithm (MAC) that uses +a data string, a secure hash algorithm, and a key, to produce +a digital signature. + +OpenVPN's usage of HMAC is to first encrypt a packet, then HMAC the resulting ciphertext. + +In static-key encryption mode, the HMAC key +is included in the key file generated by +.B --genkey. +In TLS mode, the HMAC key is dynamically generated and shared +between peers via the TLS control channel. If OpenVPN receives a packet with +a bad HMAC it will drop the packet. +HMAC usually adds 16 or 20 bytes per packet. +Set +.B alg=none +to disable authentication. + +For more information on HMAC see +.I http://www.cs.ucsd.edu/users/mihir/papers/hmac.html +.\"********************************************************* +.TP +.B --cipher alg +Encrypt packets with cipher algorithm +.B alg. +The default is +.B BF-CBC, +an abbreviation for Blowfish in Cipher Block Chaining mode. +Blowfish has the advantages of being fast, very secure, and allowing key sizes +of up to 448 bits. Blowfish is designed to be used in situations where +keys are changed infrequently. + +For more information on blowfish, see +.I http://www.counterpane.com/blowfish.html + +To see other ciphers that are available with +OpenVPN, use the +.B --show-ciphers +option. + +OpenVPN supports the CBC, CFB, and OFB cipher modes. + +Set +.B alg=none +to disable encryption. +.\"********************************************************* +.TP +.B --keysize n +Size of cipher key in bits (optional). +If unspecified, defaults to cipher-specific default. The +.B --show-ciphers +option (see below) shows all available OpenSSL ciphers, +their default key sizes, and whether the key size can +be changed. Use care in changing a cipher's default +key size. Many ciphers have not been extensively +cryptanalyzed with non-standard key lengths, and a +larger key may offer no real guarantee of greater +security, or may even reduce security. +.\"********************************************************* +.TP +.B --engine [engine-name] +Enable OpenSSL hardware-based crypto engine functionality. + +If +.B engine-name +is specified, +use a specific crypto engine. Use the +.B --show-engines +standalone option to list the crypto engines which are +supported by OpenSSL. +.\"********************************************************* +.TP +.B --no-replay +Disable OpenVPN's protection against replay attacks. +Don't use this option unless you are prepared to make +a tradeoff of greater efficiency in exchange for less +security. + +OpenVPN provides datagram replay protection by default. + +Replay protection is accomplished +by tagging each outgoing datagram with an identifier +that is guaranteed to be unique for the key being used. +The peer that receives the datagram will check for +the uniqueness of the identifier. If the identifier +was already received in a previous datagram, OpenVPN +will drop the packet. Replay protection is important +to defeat attacks such as a SYN flood attack, where +the attacker listens in the wire, intercepts a TCP +SYN packet (identifying it by the context in which +it occurs in relation to other packets), then floods +the receiving peer with copies of this packet. + +OpenVPN's replay protection is implemented in slightly +different ways, depending on the key management mode +you have selected. + +In Static Key mode +or when using an CFB or OFB mode cipher, OpenVPN uses a +64 bit unique identifier that combines a time stamp with +an incrementing sequence number. + +When using TLS mode for key exchange and a CBC cipher +mode, OpenVPN uses only a 32 bit sequence number without +a time stamp, since OpenVPN can guarantee the uniqueness +of this value for each key. As in IPSec, if the sequence number is +close to wrapping back to zero, OpenVPN will trigger +a new key exchange. + +To check for replays, OpenVPN uses +the +.I sliding window +algorithm used +by IPSec. +.\"********************************************************* +.TP +.B --replay-window n [t] +Use a replay protection sliding-window of size +.B n +and a time window of +.B t +seconds. + +By default +.B n +is 64 (the IPSec default) and +.B t +is 15 seconds. + +This option is only relevant in UDP mode, i.e. +when either +.B --proto udp +is specifed, or no +.B --proto +option is specified. + +When OpenVPN tunnels IP packets over UDP, there is the possibility that +packets might be dropped or delivered out of order. Because OpenVPN, like IPSec, +is emulating the physical network layer, +it will accept an out-of-order packet sequence, and +will deliver such packets in the same order they were received to +the TCP/IP protocol stack, provided they satisfy several constraints. + +.B (a) +The packet cannot be a replay (unless +.B --no-replay +is specified, which disables replay protection altogether). + +.B (b) +If a packet arrives out of order, it will only be accepted if the difference +between its sequence number and the highest sequence number received +so far is less than +.B n. + +.B (c) +If a packet arrives out of order, it will only be accepted if it arrives no later +than +.B t +seconds after any packet containing a higher sequence number. + +If you are using a network link with a large pipeline (meaning that +the product of bandwidth and latency is high), you may want to use +a larger value for +.B n. +Satellite links in particular often require this. + +If you run OpenVPN at +.B --verb 4, +you will see the message "Replay-window backtrack occurred [x]" +every time the maximum sequence number backtrack seen thus far +increases. This can be used to calibrate +.B n. + +There is some controversy on the appropriate method of handling packet +reordering at the security layer. + +Namely, to what extent should the +security layer protect the encapsulated protocol from attacks which masquerade +as the kinds of normal packet loss and reordering that occur over IP networks? + +The IPSec and OpenVPN approach is to allow packet reordering within a certain +fixed sequence number window. + +OpenVPN adds to the IPSec model by limiting the window size in time as well as +sequence space. + +OpenVPN also adds TCP transport as an option (not offered by IPSec) in which +case OpenVPN can adopt a very strict attitude towards message deletion and +reordering: Don't allow it. Since TCP guarantees reliability, any packet +loss or reordering event can be assumed to be an attack. + +In this sense, it could be argued that TCP tunnel transport is preferred when +tunneling non-IP or UDP application protocols which might be vulnerable to a +message deletion or reordering attack which falls within the normal +operational parameters of IP networks. + +So I would make the statement that one should never tunnel a non-IP protocol +or UDP application protocol over UDP, if the protocol might be vulnerable to a +message deletion or reordering attack that falls within the normal operating +parameters of what is to be expected from the physical IP layer. The problem +is easily fixed by simply using TCP as the VPN transport layer. +.\"********************************************************* +.TP +.B --mute-replay-warnings +Silence the output of replay warnings, which are a common +false alarm on WiFi networks. This option preserves +the security of the replay protection code without +the verbosity associated with warnings about duplicate +packets. +.\"********************************************************* +.TP +.B --replay-persist file +Persist replay-protection state across sessions using +.B file +to save and reload the state. + +This option will strengthen protection against replay attacks, +especially when you are using OpenVPN in a dynamic context (such +as with +.B --inetd) +when OpenVPN sessions are frequently started and stopped. + +This option will keep a disk copy of the current replay protection +state (i.e. the most recent packet timestamp and sequence number +received from the remote peer), so that if an OpenVPN session +is stopped and restarted, it will reject any replays of packets +which were already received by the prior session. + +This option only makes sense when replay protection is enabled +(the default) and you are using either +.B --secret +(shared-secret key mode) or TLS mode with +.B --tls-auth. +.\"********************************************************* +.TP +.B --no-iv +Disable OpenVPN's use of IV (cipher initialization vector). +Don't use this option unless you are prepared to make +a tradeoff of greater efficiency in exchange for less +security. + +OpenVPN uses an IV by default, and requires it for CFB and +OFB cipher modes (which are totally insecure without it). +Using an IV is important for security when multiple +messages are being encrypted/decrypted with the same key. + +IV is implemented differently depending on the cipher mode used. + +In CBC mode, OpenVPN uses a pseudo-random IV for each packet. + +In CFB/OFB mode, OpenVPN uses a unique sequence number and time stamp +as the IV. In fact, in CFB/OFB mode, OpenVPN uses a datagram +space-saving optimization that uses the unique identifier for +datagram replay protection as the IV. +.\"********************************************************* +.TP +.B --test-crypto +Do a self-test of OpenVPN's crypto options by encrypting and +decrypting test packets using the data channel encryption options +specified above. This option does not require a peer to function, +and therefore can be specified without +.B --dev +or +.B --remote. + +The typical usage of +.B --test-crypto +would be something like this: + +.B openvpn --test-crypto --secret key + +or + +.B openvpn --test-crypto --secret key --verb 9 + +This option is very useful to test OpenVPN after it has been ported to +a new platform, or to isolate problems in the compiler, OpenSSL +crypto library, or OpenVPN's crypto code. Since it is a self-test mode, +problems with encryption and authentication can be debugged independently +of network and tunnel issues. +.\"********************************************************* +.SS TLS Mode Options: +TLS mode is the most powerful crypto mode of OpenVPN in both security and flexibility. +TLS mode works by establishing control and +data channels which are multiplexed over a single TCP/UDP port. OpenVPN initiates +a TLS session over the control channel and uses it to exchange cipher +and HMAC keys to protect the data channel. TLS mode uses a robust reliability +layer over the UDP connection for all control channel communication, while +the data channel, over which encrypted tunnel data passes, is forwarded without +any mediation. The result is the best of both worlds: a fast data channel +that forwards over UDP with only the overhead of encrypt, +decrypt, and HMAC functions, +and a control channel that provides all of the security features of TLS, +including certificate-based authentication and Diffie Hellman forward secrecy. + +To use TLS mode, each peer that runs OpenVPN should have its own local +certificate/key pair ( +.B --cert +and +.B --key +), signed by the root certificate which is specified +in +.B --ca. + +When two OpenVPN peers connect, each presents its local certificate to the +other. Each peer will then check that its partner peer presented a +certificate which was signed by the master root certificate as specified in +.B --ca. + +If that check on both peers succeeds, then the TLS negotiation +will succeed, both OpenVPN +peers will exchange temporary session keys, and the tunnel will begin +passing data. + +The OpenVPN distribution contains a set of scripts for +managing RSA certificates & keys, +located in the +.I easy-rsa +subdirectory. + +The easy-rsa package is also rendered in web form here: +.I http://openvpn.net/easyrsa.html +.\"********************************************************* +.TP +.B --tls-server +Enable TLS and assume server role during TLS handshake. Note that +OpenVPN is designed as a peer-to-peer application. The designation +of client or server is only for the purpose of negotiating the TLS +control channel. +.\"********************************************************* +.TP +.B --tls-client +Enable TLS and assume client role during TLS handshake. +.\"********************************************************* +.TP +.B --ca file +Certificate authority (CA) file in .pem format, also referred to as the +.I root +certificate. This file can have multiple +certificates in .pem format, concatenated together. You can construct your own +certificate authority certificate and private key by using a command such as: + +.B openssl req -nodes -new -x509 -keyout tmp-ca.key -out tmp-ca.crt + +Then edit your openssl.cnf file and edit the +.B certificate +variable to point to your new root certificate +.B tmp-ca.crt. + +For testing purposes only, the OpenVPN distribution includes a sample +CA certificate (tmp-ca.crt). +Of course you should never use +the test certificates and test keys distributed with OpenVPN in a +production environment, since by virtue of the fact that +they are distributed with OpenVPN, they are totally insecure. +.\"********************************************************* +.TP +.B --dh file +File containing Diffie Hellman parameters +in .pem format (required for +.B --tls-server +only). Use + +.B openssl dhparam -out dh1024.pem 1024 + +to generate your own, or use the existing dh1024.pem file +included with the OpenVPN distribution. Diffie Hellman parameters +may be considered public. +.\"********************************************************* +.TP +.B --cert file +Local peer's signed certificate in .pem format -- must be signed +by a certificate authority whose certificate is in +.B --ca file. +Each peer in an OpenVPN link running in TLS mode should have its own +certificate and private key file. In addition, each certificate should +have been signed by the key of a certificate +authority whose public key resides in the +.B --ca +certificate authority file. +You can easily make your own certificate authority (see above) or pay money +to use a commercial service such as thawte.com (in which case you will be +helping to finance the world's second space tourist :). +To generate a certificate, +you can use a command such as: + +.B openssl req -nodes -new -keyout mycert.key -out mycert.csr + +If your certificate authority private key lives on another machine, copy +the certificate signing request (mycert.csr) to this other machine (this can +be done over an insecure channel such as email). Now sign the certificate +with a command such as: + +.B openssl ca -out mycert.crt -in mycert.csr + +Now copy the certificate (mycert.crt) +back to the peer which initially generated the .csr file (this +can be over a public medium). +Note that the +.B openssl ca +command reads the location of the certificate authority key from its +configuration file such as +.B /usr/share/ssl/openssl.cnf +-- note also +that for certificate authority functions, you must set up the files +.B index.txt +(may be empty) and +.B serial +(initialize to +.B +01 +). +.\"********************************************************* +.TP +.B --key file +Local peer's private key in .pem format. Use the private key which was generated +when you built your peer's certificate (see +.B -cert file +above). +.\"********************************************************* +.TP +.B --pkcs12 file +Specify a PKCS #12 file containing local private key, +local certificate, and root CA certificate. +This option can be used instead of +.B --ca, --cert, +and +.B --key. +.\"********************************************************* +.TP +.B --cryptoapicert select-string +Load the certificate and private key from the +Windows Certificate System Store (Windows Only). + +Use this option instead of +.B --cert +and +.B --key. + +This makes +it possible to use any smart card, supported by Windows, but also any +kind of certificate, residing in the Cert Store, where you have access to +the private key. This option has been tested with a couple of different +smart cards (GemSAFE, Cryptoflex, and Swedish Post Office eID) on the +client side, and also an imported PKCS12 software certificate on the +server side. + +To select a certificate, based on a substring search in the +certificate's subject: + +.B cryptoapicert +"SUBJ:Peter Runestig" + +To select a certificate, based on certificate's thumbprint: + +.B cryptoapicert +"THUMB:f6 49 24 41 01 b4 ..." + +The thumbprint hex string can easily be copy-and-pasted from the Windows +Certificate Store GUI. + +.\"********************************************************* +.TP +.B --key-method m +Use data channel key negotiation method +.B m. +The key method must match on both sides of the connection. + +After OpenVPN negotiates a TLS session, a new set of keys +for protecting the tunnel data channel is generated and +exchanged over the TLS session. + +In method 1 (the default for OpenVPN 1.x), both sides generate +random encrypt and HMAC-send keys which are forwarded to +the other host over the TLS channel. + +In method 2, (the default for OpenVPN 2.0) +the client generates a random key. Both client +and server also generate some random seed material. All key source +material is exchanged over the TLS channel. The actual +keys are generated using the TLS PRF function, taking source +entropy from both client and server. Method 2 is designed to +closely parallel the key generation process used by TLS 1.0. + +Note that in TLS mode, two separate levels +of keying occur: + +(1) The TLS connection is initially negotiated, with both sides +of the connection producing certificates and verifying the certificate +(or other authentication info provided) of +the other side. The +.B --key-method +parameter has no effect on this process. + +(2) After the TLS connection is established, the tunnel session keys are +separately negotiated over the existing secure TLS channel. Here, +.B --key-method +determines the derivation of the tunnel session keys. +.\"********************************************************* +.TP +.B --tls-cipher l +A list +.B l +of allowable TLS ciphers delimited by a colon (":"). +If you require a high level of security, +you may want to set this parameter manually, to prevent a +version rollback attack where a man-in-the-middle attacker tries +to force two peers to negotiate to the lowest level +of security they both support. +Use +.B --show-tls +to see a list of supported TLS ciphers. +.\"********************************************************* +.TP +.B --tls-timeout n +Packet retransmit timeout on TLS control channel +if no acknowledgment from remote within +.B n +seconds (default=2). When OpenVPN sends a control +packet to its peer, it will expect to receive an +acknowledgement within +.B n +seconds or it will retransmit the packet, subject +to a TCP-like exponential backoff algorithm. This parameter +only applies to control channel packets. Data channel +packets (which carry encrypted tunnel data) are never +acknowledged, sequenced, or retransmitted by OpenVPN because +the higher level network protocols running on top of the tunnel +such as TCP expect this role to be left to them. +.\"********************************************************* +.TP +.B --reneg-bytes n +Renegotiate data channel key after +.B n +bytes sent or received (disabled by default). +OpenVPN allows the lifetime of a key +to be expressed as a number of bytes encrypted/decrypted, a number of packets, or +a number of seconds. A key renegotiation will be forced +if any of these three criteria are met by either peer. +.\"********************************************************* +.TP +.B --reneg-pkts n +Renegotiate data channel key after +.B n +packets sent and received (disabled by default). +.\"********************************************************* +.TP +.B --reneg-sec n +Renegotiate data channel key after +.B n +seconds (default=3600). +.\"********************************************************* +.TP +.B --hand-window n +Handshake Window -- the TLS-based key exchange must finalize within +.B n +seconds +of handshake initiation by any peer (default = 60 seconds). +If the handshake fails +we will attempt to reset our connection with our peer and try again. +Even in the event of handshake failure we will still use +our expiring key for up to +.B --tran-window +seconds to maintain continuity of transmission of tunnel +data. +.\"********************************************************* +.TP +.B --tran-window n +Transition window -- our old key can live this many seconds +after a new a key renegotiation begins (default = 3600 seconds). +This feature allows for a graceful transition from old to new +key, and removes the key renegotiation sequence from the critical +path of tunnel data forwarding. +.\"********************************************************* +.TP +.B --single-session +After initially connecting to a remote peer, disallow any new connections. +Using this +option means that a remote peer cannot connect, disconnect, and then +reconnect. + +If the daemon is reset by a signal or +.B --ping-restart, +it will allow one new connection. + +.B --single-session +can be used with +.B --ping-exit +or +.B --inactive +to create a single dynamic session that will exit when finished. +.\"********************************************************* +.TP +.B --tls-exit +Exit on TLS negotiation failure. +.\"********************************************************* +.TP +.B --tls-auth file [direction] +Add an additional layer of HMAC authentication on top of the TLS +control channel to protect against DoS attacks. + +In a nutshell, +.B --tls-auth +enables a kind of "HMAC firewall" on OpenVPN's TCP/UDP port, +where TLS control channel packets +bearing an incorrect HMAC signature can be dropped immediately without +response. + +.B file +(required) is a key file which can be in one of two formats: + +.B (1) +An OpenVPN static key file generated by +.B --genkey +(required if +.B direction +parameter is used). + +.B (2) +A freeform passphrase file. In this case the HMAC key will +be derived by taking a secure hash of this file, similar to +the +.BR md5sum (1) +or +.BR sha1sum (1) +commands. + +OpenVPN will first try format (1), and if the file fails to parse as +a static key file, format (2) will be used. + +See the +.B --secret +option for more information on the optional +.B direction +parameter. + +.B --tls-auth +is recommended when you are running OpenVPN in a mode where +it is listening for packets from any IP address, such as when +.B --remote +is not specified, or +.B --remote +is specified with +.B --float. + +The rationale for +this feature is as follows. TLS requires a multi-packet exchange +before it is able to authenticate a peer. During this time +before authentication, OpenVPN is allocating resources (memory +and CPU) to this potential peer. The potential peer is also +exposing many parts of OpenVPN and the OpenSSL library to the packets +it is sending. Most successful network attacks today seek +to either exploit bugs in programs (such as buffer overflow attacks) or +force a program to consume so many resources that it becomes unusable. +Of course the first line of defense is always to produce clean, +well-audited code. OpenVPN has been written with buffer overflow +attack prevention as a top priority. +But as history has shown, many of the most widely used +network applications have, from time to time, +fallen to buffer overflow attacks. + +So as a second line of defense, OpenVPN offers +this special layer of authentication on top of the TLS control channel so that +every packet on the control channel is authenticated by an +HMAC signature and a unique ID for replay protection. +This signature will also help protect against DoS (Denial of Service) attacks. +An important rule of thumb in reducing vulnerability to DoS attacks is to +minimize the amount of resources a potential, but as yet unauthenticated, +client is able to consume. + +.B --tls-auth +does this by signing every TLS control channel packet with an HMAC signature, +including packets which are sent before the TLS level has had a chance +to authenticate the peer. +The result is that packets without +the correct signature can be dropped immediately upon reception, +before they have a chance to consume additional system resources +such as by initiating a TLS handshake. +.B --tls-auth +can be strengthened by adding the +.B --replay-persist +option which will keep OpenVPN's replay protection state +in a file so that it is not lost across restarts. + +It should be emphasized that this feature is optional and that the +passphrase/key file used with +.B --tls-auth +gives a peer nothing more than the power to initiate a TLS +handshake. It is not used to encrypt or authenticate any tunnel data. +.\"********************************************************* +.TP +.B --askpass [file] +Get certificate password from console or +.B file +before we daemonize. + +For the extremely +security conscious, it is possible to protect your private key with +a password. Of course this means that every time the OpenVPN +daemon is started you must be there to type the password. The +.B --askpass +option allows you to start OpenVPN from the command line. It will +query you for a password before it daemonizes. To protect a private +key with a password you should omit the +.B -nodes +option when you use the +.B openssl +command line tool to manage certificates and private keys. + +If +.B file +is specified, read the password from the first line of +.B file. +Keep in mind that storing your password in a file +to a certain extent invalidates the extra security provided by +using an encrypted key (Note: OpenVPN +will only read passwords from a file if it has been built +with the --enable-password-save configure option, or on Windows +by defining ENABLE_PASSWORD_SAVE in config-win32.h). +.\"********************************************************* +.TP +.B --auth-nocache +Don't cache +.B --askpass +or +.B --auth-user-pass +username/passwords in virtual memory. + +If specified, this directive will cause OpenVPN to immediately +forget username/password inputs after they are used. As a result, +when OpenVPN needs a username/password, it will prompt for input +from stdin, which may be multiple times during the duration of an +OpenVPN session. + +This directive does not affect the +.B --http-proxy +username/password. It is always cached. +.\"********************************************************* +.TP +.B --tls-verify cmd +Execute shell command +.B cmd +to verify the X509 name of a +pending TLS connection that has otherwise passed all other +tests of certification (except for revocation via +.B --crl-verify +directive; the revocation test occurs after the +.B --tls-verify +test). + +.B cmd +should return 0 to allow the TLS handshake to proceed, or 1 to fail. +.B cmd +is executed as + +.B cmd certificate_depth X509_NAME_oneline + +This feature is useful if the peer you want to trust has a certificate +which was signed by a certificate authority who also signed many +other certificates, where you don't necessarily want to trust all of them, +but rather be selective about which +peer certificate you will accept. This feature allows you to write a script +which will test the X509 name on a certificate and decide whether or +not it should be accepted. For a simple perl script which will test +the common name field on the certificate, see the file +.B verify-cn +in the OpenVPN distribution. + +See the "Environmental Variables" section below for +additional parameters passed as environmental variables. + +Note that +.B cmd +can be a shell command with multiple arguments, in which +case all OpenVPN-generated arguments will be appended +to +.B cmd +to build a command line which will be passed to the script. +.\"********************************************************* +.TP +.B --tls-remote name +Accept connections only from a host with X509 name +or common name equal to +.B name. +The remote host must also pass all other tests +of verification. + +Name can also be a common name prefix, for example if you +want a client to only accept connections to "Server-1", +"Server-2", etc., you can simply use +.B --tls-remote Server + +Using a common name prefix is a useful alternative to managing +a CRL (Certificate Revocation List) on the client, since it allows the client +to refuse all certificates except for those associated +with designated servers. + +.B --tls-remote +is a useful replacement for the +.B --tls-verify +option to verify the remote host, because +.B --tls-remote +works in a +.B --chroot +environment too. +.\"********************************************************* +.TP +.B --ns-cert-type client|server +Require that peer certificate was signed with an explicit +.B nsCertType +designation of "client" or "server". + +This is a useful security option for clients, to ensure that +the host they connect with is a designated server. + +See the easy-rsa/build-key-server script for an example +of how to generate a certificate with the +.B nsCertType +field set to "server". + +If the server certificate's nsCertType field is set +to "server", then the clients can verify this with +.B --ns-cert-type server. + +This is an important security precaution to protect against +a man-in-the-middle attack where an authorized client +attempts to connect to another client by impersonating the server. +The attack is easily prevented by having clients verify +the server certificate using any one of +.B --ns-cert-type, --tls-remote, +or +.B --tls-verify. +.\"********************************************************* +.TP +.B --crl-verify crl +Check peer certificate against the file +.B crl +in PEM format. + +A CRL (certificate revocation list) is used when a particular key is +compromised but when the overall PKI is still intact. + +Suppose you had a PKI consisting of a CA, root certificate, and a number of +client certificates. Suppose a laptop computer containing a client key and +certificate was stolen. By adding the stolen certificate to the CRL file, +you could reject any connection which attempts to use it, while preserving the +overall integrity of the PKI. + +The only time when it would be necessary to rebuild the entire PKI from scratch would be +if the root certificate key itself was compromised. +.\"********************************************************* +.SS SSL Library information: +.\"********************************************************* +.TP +.B --show-ciphers +(Standalone) +Show all cipher algorithms to use with the +.B --cipher +option. +.\"********************************************************* +.TP +.B --show-digests +(Standalone) +Show all message digest algorithms to use with the +.B --auth +option. +.\"********************************************************* +.TP +.B --show-tls +(Standalone) +Show all TLS ciphers (TLS used only as a control channel). The TLS +ciphers will be sorted from highest preference (most secure) to +lowest. +.\"********************************************************* +.TP +.B --show-engines +(Standalone) +Show currently available hardware-based crypto acceleration +engines supported by the OpenSSL library. +.\"********************************************************* +.SS Generate a random key: +Used only for non-TLS static key encryption mode. +.\"********************************************************* +.TP +.B --genkey +(Standalone) +Generate a random key to be used as a shared secret, +for use with the +.B --secret +option. This file must be shared with the +peer over a pre-existing secure channel such as +.BR scp (1) +. +.\"********************************************************* +.TP +.B --secret file +Write key to +.B file. +.\"********************************************************* +.SS TUN/TAP persistent tunnel config mode: +Available with linux 2.4.7+. These options comprise a standalone mode +of OpenVPN which can be used to create and delete persistent tunnels. +.\"********************************************************* +.TP +.B --mktun +(Standalone) +Create a persistent tunnel on platforms which support them such +as Linux. Normally TUN/TAP tunnels exist only for +the period of time that an application has them open. This option +takes advantage of the TUN/TAP driver's ability to build persistent +tunnels that live through multiple instantiations of OpenVPN and die +only when they are deleted or the machine is rebooted. + +One of the advantages of persistent tunnels is that they eliminate the +need for separate +.B --up +and +.B --down +scripts to run the appropriate +.BR ifconfig (8) +and +.BR route (8) +commands. These commands can be placed in the the same shell script +which starts or terminates an OpenVPN session. + +Another advantage is that open connections through the TUN/TAP-based tunnel +will not be reset if the OpenVPN peer restarts. This can be useful to +provide uninterrupted connectivity through the tunnel in the event of a DHCP +reset of the peer's public IP address (see the +.B --ipchange +option above). + +One disadvantage of persistent tunnels is that it is harder to automatically +configure their MTU value (see +.B --link-mtu +and +.B --tun-mtu +above). + +On some platforms such as Windows, TAP-Win32 tunnels are persistent by +default. +.\"********************************************************* +.TP +.B --rmtun +(Standalone) +Remove a persistent tunnel. +.\"********************************************************* +.TP +.B --dev tunX | tapX +TUN/TAP device +.\"********************************************************* +.SS Windows-Specific Options: +.\"********************************************************* +.TP +.B --ip-win32 method +When using +.B --ifconfig +on Windows, set the TAP-Win32 adapter +IP address and netmask using +.B method. +Don't use this option unless you are also using +.B --ifconfig. + +.B manual -- +Don't set the IP address or netmask automatically. +Instead output a message +to the console telling the user to configure the +adapter manually and indicating the IP/netmask which +OpenVPN expects the adapter to be set to. + +.B dynamic [offset] [lease-time] -- +(Default) Automatically set the IP address and netmask by replying to +DHCP query messages generated by the kernel. This mode is +probably the "cleanest" solution +for setting the TCP/IP properties since it uses the well-known +DHCP protocol. There are, however, two prerequisites for using +this mode: (1) The TCP/IP properties for the TAP-Win32 +adapter must be set to "Obtain an IP address automatically," and +(2) OpenVPN needs to claim an IP address in the subnet for use +as the virtual DHCP server address. By default in +.B --dev tap +mode, OpenVPN will +take the normally unused first address in the subnet. For example, +if your subnet is 192.168.4.0 netmask 255.255.255.0, then +OpenVPN will take the IP address 192.168.4.0 to use as the +virtual DHCP server address. In +.B --dev tun +mode, OpenVPN will cause the DHCP server to masquerade as if it were +coming from the remote endpoint. The optional offset parameter is +an integer which is > -256 and < 256 and which defaults to 0. +If offset is positive, the DHCP server will masquerade as the IP +address at network address + offset. +If offset is negative, the DHCP server will masquerade as the IP +address at broadcast address + offset. The Windows +.B ipconfig /all +command can be used to show what Windows thinks the DHCP server +address is. OpenVPN will "claim" this address, so make sure to +use a free address. Having said that, different OpenVPN instantiations, +including different ends of the same connection, can share the same +virtual DHCP server address. The +.B lease-time +parameter controls the lease time of the DHCP assignment given to +the TAP-Win32 adapter, and is denoted in seconds. +Normally a very long lease time is preferred +because it prevents routes involving the TAP-Win32 adapter from +being lost when the system goes to sleep. The default +lease time is one year. + +.B netsh -- +Automatically set the IP address and netmask using +the Windows command-line "netsh" +command. This method appears to work correctly on +Windows XP but not Windows 2000. + +.B ipapi -- +Automatically set the IP address and netmask using the +Windows IP Helper API. This approach +does not have ideal semantics, though testing has indicated +that it works okay in practice. If you use this option, +it is best to leave the TCP/IP properties for the TAP-Win32 +adapter in their default state, i.e. "Obtain an IP address +automatically." +.\"********************************************************* +.TP +.B --route-method m +Which method +.B m +to use for adding routes on Windows? + +.B ipapi +(default) -- Use IP helper API. +.br +.B exe +-- Call the route.exe shell command. +.\"********************************************************* +.TP +.B --dhcp-option type [parm] +Set extended TAP-Win32 TCP/IP properties, must +be used with +.B --ip-win32 dynamic. +This option can be used to set additional TCP/IP properties +on the TAP-Win32 adapter, and is particularly useful for +configuring an OpenVPN client to access a Samba server +across the VPN. + +.B DOMAIN name -- +Set Connection-specific DNS Suffix. + +.B DNS addr -- +Set primary domain name server address. Repeat +this option to set secondary DNS server addresses. + +.B WINS addr -- +Set primary WINS server address (NetBIOS over TCP/IP Name Server). +Repeat this option to set secondary WINS server addresses. + +.B NBDD addr -- +Set primary NBDD server address (NetBIOS over TCP/IP Datagram Distribution Server) +Repeat this option +to set secondary NBDD server addresses. + +.B NTP addr -- +Set primary NTP server address (Network Time Protocol). +Repeat this option +to set secondary NTP server addresses. + +.B NBT type -- +Set NetBIOS over TCP/IP Node type. Possible options: +.B 1 += b-node (broadcasts), +.B 2 += p-node (point-to-point +name queries to a WINS server), +.B 4 += m-node (broadcast +then query name server), and +.B 8 += h-node (query name server, then broadcast). + +.B NBS scope-id -- +Set NetBIOS over TCP/IP Scope. A NetBIOS Scope ID provides an extended +naming service for the NetBIOS over TCP/IP (Known as NBT) module. The +primary purpose of a NetBIOS scope ID is to isolate NetBIOS traffic on +a single network to only those nodes with the same NetBIOS scope ID. +The NetBIOS scope ID is a character string that is appended to the NetBIOS +name. The NetBIOS scope ID on two hosts must match, or the two hosts +will not be able to communicate. The NetBIOS Scope ID also allows +computers to use the same computer name, as they have different +scope IDs. The Scope ID becomes a part of the NetBIOS name, making the name unique. +(This description of NetBIOS scopes courtesy of NeonSurge@abyss.com) + +.B DISABLE-NBT -- +Disable Netbios-over-TCP/IP. + +Note that if +.B --dhcp-option +is pushed via +.B --push +to a non-windows client, the option will be saved in the client's +environment before the up script is called, under +the name "foreign_option_{n}". +.\"********************************************************* +.TP +.B --tap-sleep n +Cause OpenVPN to sleep for +.B n +seconds immediately after the TAP-Win32 adapter state +is set to "connected". + +This option is intended to be used to troubleshoot problems +with the +.B --ifconfig +and +.B --ip-win32 +options, and is used to give +the TAP-Win32 adapter time to come up before +Windows IP Helper API operations are applied to it. +.\"********************************************************* +.TP +.B --show-net-up +Output OpenVPN's view of the system routing table and network +adapter list to the syslog or log file after the TUN/TAP adapter +has been brought up and any routes have been added. +.\"********************************************************* +.TP +.B --dhcp-renew +Ask Windows to renew the TAP adapter lease on startup. +This option is normally unnecessary, as Windows automatically +triggers a DHCP renegotiation on the TAP adapter when it +comes up, however if you set the TAP-Win32 adapter +Media Status property to "Always Connected", you may need this +flag. +.\"********************************************************* +.TP +.B --dhcp-release +Ask Windows to release the TAP adapter lease on shutdown. +This option has the same caveats as +.B --dhcp-renew +above. +.\"********************************************************* +.TP +.B --pause-exit +Put up a "press any key to continue" message on the console prior +to OpenVPN program exit. This option is automatically used by the +Windows explorer when OpenVPN is run on a configuration +file using the right-click explorer menu. +.\"********************************************************* +.TP +.B --service exit-event [0|1] +Should be used when OpenVPN is being automatically executed by another +program in such +a context that no interaction with the user via display or keyboard +is possible. In general, end-users should never need to explicitly +use this option, as it is automatically added by the OpenVPN service wrapper +when a given OpenVPN configuration is being run as a service. + +.B exit-event +is the name of a Windows global event object, and OpenVPN will continuously +monitor the state of this event object and exit when it becomes signaled. + +The second parameter indicates the initial state of +.B exit-event +and normally defaults to 0. + +Multiple OpenVPN processes can be simultaneously executed with the same +.B exit-event +parameter. In any case, the controlling process can signal +.B exit-event, +causing all such OpenVPN processes to exit. + +When executing an OpenVPN process using the +.B --service +directive, OpenVPN will probably not have a console +window to output status/error +messages, therefore it is useful to use +.B --log +or +.B --log-append +to write these messages to a file. +.\"********************************************************* +.TP +.B --show-adapters +(Standalone) +Show available TAP-Win32 adapters which can be selected using the +.B --dev-node +option. On non-Windows systems, the +.BR ifconfig (8) +command provides similar functionality. +.\"********************************************************* +.TP +.B --show-valid-subnets +(Standalone) +Show valid subnets for +.B --dev tun +emulation. Since the TAP-Win32 driver +exports an ethernet interface to Windows, and since TUN devices are +point-to-point in nature, it is necessary for the TAP-Win32 driver +to impose certain constraints on TUN endpoint address selection. + +Namely, the point-to-point endpoints used in TUN device emulation +must be the middle two addresses of a /30 subnet (netmask 255.255.255.252). +.\"********************************************************* +.TP +.B --show-net +(Standalone) +Show OpenVPN's view of the system routing table and network +adapter list. +.\"********************************************************* +.SH SCRIPTING AND ENVIRONMENTAL VARIABLES +OpenVPN exports a series +of environmental variables for use by user-defined scripts. +.\"********************************************************* +.SS Script Order of Execution +.\"********************************************************* +.TP +.B --up +Executed after TCP/UDP socket bind and TUN/TAP open. +.\"********************************************************* +.TP +.B --tls-verify +Executed when we have a still untrusted remote peer. +.\"********************************************************* +.TP +.B --ipchange +Executed after connection authentication, or remote IP address change. +.\"********************************************************* +.TP +.B --client-connect +Executed in +.B --mode server +mode immediately after client authentication. +.\"********************************************************* +.TP +.B --route-up +Executed after connection authentication, either +immediately after, or some number of seconds after +as defined by the +.B --route-delay +option. +.\"********************************************************* +.TP +.B --client-disconnect +Executed in +.B --mode server +mode on client instance shutdown. +.\"********************************************************* +.TP +.B --down +Executed after TCP/UDP and TUN/TAP close. +.\"********************************************************* +.TP +.B --learn-address +Executed in +.B --mode server +mode whenever an IPv4 address/route or MAC address is added to OpenVPN's +internal routing table. +.\"********************************************************* +.TP +.B --auth-user-pass-verify +Executed in +.B --mode server +mode on new client connections, when the client is +still untrusted. +.\"********************************************************* +.SS String Types and Remapping +In certain cases, OpenVPN will perform remapping of characters +in strings. Essentially, any characters outside the set of +permitted characters for each string type will be converted +to underbar ('_'). + +.B Q: +Why is string remapping necessary? + +.B A: +It's an important security feature to prevent the malicious coding of +strings from untrusted sources to be passed as parameters to scripts, +saved in the environment, used as a common name, translated to a filename, +etc. + +Here is a brief rundown of OpenVPN's current string types and the +permitted character class for each string: + +.B X509 Names: +Alphanumeric, underbar ('_'), dash ('-'), dot ('.'), at +('@'), colon (':'), slash ('/'), and equal ('='). Alphanumeric is defined +as a character which will cause the C library isalnum() function to return +true. + +.B Common Names: +Alphanumeric, underbar ('_'), dash ('-'), dot ('.'), and at +('@'). + +.B --auth-user-pass username: +Same as Common Name, with one exception: starting with OpenVPN 2.0.1, +the username is passed to the OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY plugin in its raw form, +without string remapping. + +.B --auth-user-pass password: +Any "printable" character except CR or LF. +Printable is defined to be a character which will cause the C library +isprint() function to return true. + +.B --client-config-dir filename as derived from common name or username: +Alphanumeric, underbar ('_'), dash ('-'), and dot ('.') except for "." or +".." as standalone strings. As of 2.0.1-rc6, the at ('@') character has +been added as well for compatibility with the common name character class. + +.B Environmental variable names: +Alphanumeric or underbar ('_'). + +.B Environmental variable values: +Any printable character. + +For all cases, characters in a string which are not members of the legal +character class for that string type will be remapped to underbar ('_'). +.\"********************************************************* +.SS Environmental Variables +Once set, a variable is persisted +indefinitely until it is reset by a new value or a restart, + +As of OpenVPN 2.0-beta12, in server mode, environmental +variables set by OpenVPN +are scoped according to the client objects +they are +associated with, so there should not be any issues with +scripts having access to stale, previously set variables +which refer to different client instances. +.\"********************************************************* +.TP +.B bytes_received +Total number of bytes received from client during VPN session. +Set prior to execution of the +.B --client-disconnect +script. +.\"********************************************************* +.TP +.B bytes_sent +Total number of bytes sent to client during VPN session. +Set prior to execution of the +.B --client-disconnect +script. +.\"********************************************************* +.TP +.B common_name +The X509 common name of an authenticated client. +Set prior to execution of +.B --client-connect, --client-disconnect, +and +.B --auth-user-pass-verify +scripts. +.\"********************************************************* +.TP +.B config +Name of first +.B --config +file. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B daemon +Set to "1" if the +.B --daemon +directive is specified, or "0" otherwise. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B daemon_log_redirect +Set to "1" if the +.B --log +or +.B --log-append +directives are specified, or "0" otherwise. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B dev +The actual name of the TUN/TAP device, including +a unit number if it exists. +Set prior to +.B --up +or +.B --down +script execution. +.\"********************************************************* +.TP +.B foreign_option_{n} +An option pushed via +.B --push +to a client which does not natively support it, +such as +.B --dhcp-option +on a non-Windows system, will be recorded to this +environmental variable sequence prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B ifconfig_broadcast +The broadcast address for the virtual +ethernet segment which is derived from the +.B --ifconfig +option when +.B --dev tap +is used. +Set prior to OpenVPN calling the +.I ifconfig +or +.I netsh +(windows version of ifconfig) commands which +normally occurs prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B ifconfig_local +The local VPN endpoint IP address specified in the +.B --ifconfig +option (first parameter). +Set prior to OpenVPN calling the +.I ifconfig +or +.I netsh +(windows version of ifconfig) commands which +normally occurs prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B ifconfig_remote +The remote VPN endpoint IP address specified in the +.B --ifconfig +option (second parameter) when +.B --dev tun +is used. +Set prior to OpenVPN calling the +.I ifconfig +or +.I netsh +(windows version of ifconfig) commands which +normally occurs prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B ifconfig_netmask +The subnet mask of the virtual ethernet segment +that is specified as the second parameter to +.B --ifconfig +when +.B --dev tap +is being used. +Set prior to OpenVPN calling the +.I ifconfig +or +.I netsh +(windows version of ifconfig) commands which +normally occurs prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B ifconfig_pool_local_ip +The local +virtual IP address for the TUN/TAP tunnel taken from an +.B --ifconfig-push +directive if specified, or otherwise from +the ifconfig pool (controlled by the +.B --ifconfig-pool +config file directive). +Only set for +.B --dev tun +tunnels. +This option is set on the server prior to execution +of the +.B --client-connect +and +.B --client-disconnect +scripts. +.\"********************************************************* +.TP +.B ifconfig_pool_netmask +The +virtual IP netmask for the TUN/TAP tunnel taken from an +.B --ifconfig-push +directive if specified, or otherwise from +the ifconfig pool (controlled by the +.B --ifconfig-pool +config file directive). +Only set for +.B --dev tap +tunnels. +This option is set on the server prior to execution +of the +.B --client-connect +and +.B --client-disconnect +scripts. +.\"********************************************************* +.TP +.B ifconfig_pool_remote_ip +The remote +virtual IP address for the TUN/TAP tunnel taken from an +.B --ifconfig-push +directive if specified, or otherwise from +the ifconfig pool (controlled by the +.B --ifconfig-pool +config file directive). +This option is set on the server prior to execution +of the +.B --client-connect +and +.B --client-disconnect +scripts. +.\"********************************************************* +.TP +.B link_mtu +The maximum packet size (not including the IP header) +of tunnel data in UDP tunnel transport mode. +Set prior to +.B --up +or +.B --down +script execution. +.\"********************************************************* +.TP +.B local +The +.B --local +parameter. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B local_port +The local port number, specified by +.B --port +or +.B --lport. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B password +The password provided by a connecting client. +Set prior to +.B --auth-user-pass-verify +script execution only when the +.B via-env +modifier is specified, and deleted from the environment +after the script returns. +.\"********************************************************* +.TP +.B proto +The +.B --proto +parameter. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B remote_{n} +The +.B --remote +parameter. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B remote_port_{n} +The remote port number, specified by +.B --port +or +.B --rport. +Set on program initiation and reset on SIGHUP. +.\"********************************************************* +.TP +.B route_net_gateway +The pre-existing default IP gateway in the system routing +table. +Set prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B route_vpn_gateway +The default gateway used by +.B --route +options, as specified in either the +.B --route-gateway +option or the second parameter to +.B --ifconfig +when +.B --dev tun +is specified. +Set prior to +.B --up +script execution. +.\"********************************************************* +.TP +.B route_{parm}_{n} +A set of variables which define each route to be added, and +are set prior to +.B --up +script execution. + +.B parm +will be one of "network", "netmask", "gateway", or "metric". + +.B n +is the OpenVPN route number, starting from 1. + +If the network or gateway are resolvable DNS names, +their IP address translations will be recorded rather +than their names as denoted on the command line +or configuration file. +.\"********************************************************* +.TP +.B script_context +Set to "init" or "restart" prior to up/down script execution. +For more information, see +documentation for +.B --up. +.\"********************************************************* +.TP +.B script_type +One of +.B up, down, ipchange, route-up, tls-verify, auth-user-pass-verify, +.B client-connect, client-disconnect, +or +.B learn-address. +Set prior to execution of any script. +.\"********************************************************* +.TP +.B signal +The reason for exit or restart. Can be one of +.B sigusr1, sighup, sigterm, sigint, inactive +(controlled by +.B --inactive +option), +.B ping-exit +(controlled by +.B --ping-exit +option), +.B ping-restart +(controlled by +.B --ping-restart +option), +.B connection-reset +(triggered on TCP connection reset), +.B error, +or +.B unknown +(unknown signal). This variable is set just prior to down script execution. +.\"********************************************************* +.TP +.B tls_id_{n} +A series of certificate fields from the remote peer, +where +.B n +is the verification level. Only set for TLS connections. Set prior +to execution of +.B --tls-verify +script. +.\"********************************************************* +.TP +.B tls_serial_{n} +The serial number of the certificate from the remote peer, +where +.B n +is the verification level. Only set for TLS connections. Set prior +to execution of +.B --tls-verify +script. +.\"********************************************************* +.TP +.B tun_mtu +The MTU of the TUN/TAP device. +Set prior to +.B --up +or +.B --down +script execution. +.\"********************************************************* +.TP +.B trusted_ip +Actual IP address of connecting client or peer which has been authenticated. +Set prior to execution of +.B --ipchange, --client-connect, +and +.B --client-disconnect +scripts. +.\"********************************************************* +.TP +.B trusted_port +Actual port number of connecting client or peer which has been authenticated. +Set prior to execution of +.B --ipchange, --client-connect, +and +.B --client-disconnect +scripts. +.\"********************************************************* +.TP +.B untrusted_ip +Actual IP address of connecting client or peer which has not been authenticated +yet. Sometimes used to +.B nmap +the connecting host in a +.B --tls-verify +script to ensure it is firewalled properly. +Set prior to execution of +.B --tls-verify +and +.B --auth-user-pass-verify +scripts. +.\"********************************************************* +.TP +.B untrusted_port +Actual port number of connecting client or peer which has not been authenticated +yet. +Set prior to execution of +.B --tls-verify +and +.B --auth-user-pass-verify +scripts. +.\"********************************************************* +.TP +.B username +The username provided by a connecting client. +Set prior to +.B --auth-user-pass-verify +script execution only when the +.B via-env +modifier is specified. +.\"********************************************************* +.SH SIGNALS +.TP +.B SIGHUP +Cause OpenVPN to close all TUN/TAP and +network connections, +restart, re-read the configuration file (if any), +and reopen TUN/TAP and network connections. +.\"********************************************************* +.TP +.B SIGUSR1 +Like +.B SIGHUP, +except don't re-read configuration file, and possibly don't close and reopen TUN/TAP +device, re-read key files, preserve local IP address/port, or preserve most recently authenticated +remote IP address/port based on +.B --persist-tun, --persist-key, --persist-local-ip, +and +.B --persist-remote-ip +options respectively (see above). + +This signal may also be internally generated by a timeout condition, governed +by the +.B --ping-restart +option. + +This signal, when combined with +.B --persist-remote-ip, +may be +sent when the underlying parameters of the host's network interface change +such as when the host is a DHCP client and is assigned a new IP address. +See +.B --ipchange +above for more information. +.\"********************************************************* +.TP +.B SIGUSR2 +Causes OpenVPN to display its current statistics (to the syslog +file if +.B --daemon +is used, or stdout otherwise). +.\"********************************************************* +.TP +.B SIGINT, SIGTERM +Causes OpenVPN to exit gracefully. +.\"********************************************************* +.SH TUN/TAP DRIVER SETUP +If you are running Linux 2.4.7 or higher, you probably have the TUN/TAP driver +already installed. If so, there are still a few things you need to do: + +Make device: +.B mknod /dev/net/tun c 10 200 + +Load driver: +.B modprobe tun + +If you have Linux 2.2 or earlier, you should obtain version 1.1 of the +TUN/TAP driver from +.I http://vtun.sourceforge.net/tun/ +and follow the installation instructions. +.\"********************************************************* +.SH EXAMPLES +Prior to running these examples, you should have OpenVPN installed on two +machines with network connectivity between them. If you have not +yet installed OpenVPN, consult the INSTALL file included in the OpenVPN +distribution. +.\"********************************************************* +.SS TUN/TAP Setup: +If you are using Linux 2.4 or higher, +make the tun device node and load the tun module: +.IP +.B mknod /dev/net/tun c 10 200 +.LP +.IP +.B modprobe tun +.LP +If you installed from RPM, the +.B mknod +step may be omitted, because the RPM install does that for you. + +If you have Linux 2.2, you should obtain version 1.1 of the +TUN/TAP driver from +.I http://vtun.sourceforge.net/tun/ +and follow the installation instructions. + +For other platforms, consult the INSTALL file at +.I http://openvpn.net/install.html +for more information. +.\"********************************************************* +.SS Firewall Setup: +If firewalls exist between +the two machines, they should be set to forward UDP port 1194 +in both directions. If you do not have control over the firewalls +between the two machines, you may still be able to use OpenVPN by adding +.B --ping 15 +to each of the +.B openvpn +commands used below in the examples (this will cause each peer to send out +a UDP ping to its remote peer once every 15 seconds which will cause many +stateful firewalls to forward packets in both directions +without an explicit firewall rule). + +If you are using a Linux iptables-based firewall, you may need to enter +the following command to allow incoming packets on the TUN device: +.IP +.B iptables -A INPUT -i tun+ -j ACCEPT +.LP +See the firewalls section below for more information on configuring firewalls +for use with OpenVPN. +.\"********************************************************* +.SS VPN Address Setup: +For purposes +of our example, our two machines will be called +.B may.kg +and +.B june.kg. +If you are constructing a VPN over the internet, then replace +.B may.kg +and +.B june.kg +with the internet hostname or IP address that each machine will use +to contact the other over the internet. + +Now we will choose the tunnel endpoints. Tunnel endpoints are +private IP addresses that only have meaning in the context of +the VPN. Each machine will use the tunnel endpoint of the other +machine to access it over the VPN. In our example, +the tunnel endpoint for may.kg +will be 10.4.0.1 and for june.kg, 10.4.0.2. + +Once the VPN is established, you have essentially +created a secure alternate path between the two hosts +which is addressed by using the tunnel endpoints. You can +control which network +traffic passes between the hosts +(a) over the VPN or (b) independently of the VPN, by choosing whether to use +(a) the VPN endpoint address or (b) the public internet address, +to access the remote host. For example if you are on may.kg and you wish to connect to june.kg +via +.B ssh +without using the VPN (since +.B ssh +has its own built-in security) you would use the command +.B ssh june.kg. +However in the same scenario, you could also use the command +.B telnet 10.4.0.2 +to create a telnet session with june.kg over the VPN, that would +use the VPN to secure the session rather than +.B ssh. + +You can use any address you wish for the +tunnel endpoints +but make sure that they are private addresses +(such as those that begin with 10 or 192.168) and that they are +not part of any existing subnet on the networks of +either peer, unless you are bridging. If you use an address that is part of +your local subnet for either of the tunnel endpoints, +you will get a weird feedback loop. +.\"********************************************************* +.SS Example 1: A simple tunnel without security +.LP +On may: +.IP +.B openvpn --remote june.kg --dev tun1 --ifconfig 10.4.0.1 10.4.0.2 --verb 9 +.LP +On june: +.IP +.B openvpn --remote may.kg --dev tun1 --ifconfig 10.4.0.2 10.4.0.1 --verb 9 +.LP +Now verify the tunnel is working by pinging across the tunnel. +.LP +On may: +.IP +.B ping 10.4.0.2 +.LP +On june: +.IP +.B ping 10.4.0.1 +.LP +The +.B --verb 9 +option will produce verbose output, similar to the +.BR tcpdump (8) +program. Omit the +.B --verb 9 +option to have OpenVPN run quietly. +.\"********************************************************* +.SS Example 2: A tunnel with static-key security (i.e. using a pre-shared secret) +First build a static key on may. +.IP +.B openvpn --genkey --secret key +.LP +This command will build a random key file called +.B key +(in ascii format). +Now copy +.B key +to june over a secure medium such as by +using the +.BR scp (1) +program. +.LP +On may: +.IP +.B openvpn --remote june.kg --dev tun1 --ifconfig 10.4.0.1 10.4.0.2 --verb 5 --secret key +.LP +On june: +.IP +.B openvpn --remote may.kg --dev tun1 --ifconfig 10.4.0.2 10.4.0.1 --verb 5 --secret key +.LP +Now verify the tunnel is working by pinging across the tunnel. +.LP +On may: +.IP +.B ping 10.4.0.2 +.LP +On june: +.IP +.B ping 10.4.0.1 +.\"********************************************************* +.SS Example 3: A tunnel with full TLS-based security +For this test, we will designate +.B may +as the TLS client and +.B june +as the TLS server. +.I Note that client or server designation only has meaning for the TLS subsystem. It has no bearing on OpenVPN's peer-to-peer, UDP-based communication model. + +First, build a separate certificate/key pair +for both may and june (see above where +.B --cert +is discussed for more info). Then construct +Diffie Hellman parameters (see above where +.B --dh +is discussed for more info). You can also use the +included test files client.crt, client.key, +server.crt, server.key and tmp-ca.crt. +The .crt files are certificates/public-keys, the .key +files are private keys, and tmp-ca.crt is a certification +authority who has signed both +client.crt and server.crt. For Diffie Hellman +parameters you can use the included file dh1024.pem. +.I Note that all client, server, and certificate authority certificates and keys included in the OpenVPN distribution are totally insecure and should be used for testing only. +.LP +On may: +.IP +.B openvpn --remote june.kg --dev tun1 --ifconfig 10.4.0.1 10.4.0.2 --tls-client --ca tmp-ca.crt --cert client.crt --key client.key --reneg-sec 60 --verb 5 +.LP +On june: +.IP +.B openvpn --remote may.kg --dev tun1 --ifconfig 10.4.0.2 10.4.0.1 --tls-server --dh dh1024.pem --ca tmp-ca.crt --cert server.crt --key server.key --reneg-sec 60 --verb 5 +.LP +Now verify the tunnel is working by pinging across the tunnel. +.LP +On may: +.IP +.B ping 10.4.0.2 +.LP +On june: +.IP +.B ping 10.4.0.1 +.LP +Notice the +.B --reneg-sec 60 +option we used above. That tells OpenVPN to renegotiate +the data channel keys every minute. +Since we used +.B --verb 5 +above, you will see status information on each new key negotiation. + +For production operations, a key renegotiation interval of 60 seconds +is probably too frequent. Omit the +.B --reneg-sec 60 +option to use OpenVPN's default key renegotiation interval of one hour. +.\"********************************************************* +.SS Routing: +Assuming you can ping across the tunnel, +the next step is to route a real subnet over +the secure tunnel. Suppose that may and june have two network +interfaces each, one connected +to the internet, and the other to a private +network. Our goal is to securely connect +both private networks. We will assume that may's private subnet +is 10.0.0.0/24 and june's is 10.0.1.0/24. +.LP +First, ensure that IP forwarding is enabled on both peers. +On Linux, enable routing: +.IP +.B echo 1 > /proc/sys/net/ipv4/ip_forward +.LP +and enable TUN packet forwarding through the firewall: +.IP +.B iptables -A FORWARD -i tun+ -j ACCEPT +.LP +On may: +.IP +.B route add -net 10.0.1.0 netmask 255.255.255.0 gw 10.4.0.2 +.LP +On june: +.IP +.B route add -net 10.0.0.0 netmask 255.255.255.0 gw 10.4.0.1 +.LP +Now any machine on the 10.0.0.0/24 subnet can +access any machine on the 10.0.1.0/24 subnet +over the secure tunnel (or vice versa). + +In a production environment, you could put the route command(s) +in a shell script and execute with the +.B --up +option. +.\"********************************************************* +.SH FIREWALLS +OpenVPN's usage of a single UDP port makes it fairly firewall-friendly. +You should add an entry to your firewall rules to allow incoming OpenVPN +packets. On Linux 2.4+: +.IP +.B iptables -A INPUT -p udp -s 1.2.3.4 --dport 1194 -j ACCEPT +.LP +This will allow incoming packets on UDP port 1194 (OpenVPN's default UDP port) +from an OpenVPN peer at 1.2.3.4. + +If you are using HMAC-based packet authentication (the default in any of +OpenVPN's secure modes), having the firewall filter on source +address can be considered optional, since HMAC packet authentication +is a much more secure method of verifying the authenticity of +a packet source. In that case: +.IP +.B iptables -A INPUT -p udp --dport 1194 -j ACCEPT +.LP +would be adequate and would not render the host inflexible with +respect to its peer having a dynamic IP address. + +OpenVPN also works well on stateful firewalls. In some cases, you may +not need to add any static rules to the firewall list if you are +using a stateful firewall that knows how to track UDP connections. +If you specify +.B --ping n, +OpenVPN will be guaranteed +to send a packet to its peer at least once every +.B n +seconds. If +.B n +is less than the stateful firewall connection timeout, you can +maintain an OpenVPN connection indefinitely without explicit +firewall rules. + +You should also add firewall rules to allow incoming IP traffic on +TUN or TAP devices such as: +.IP +.B iptables -A INPUT -i tun+ -j ACCEPT +.LP +to allow input packets from tun devices, +.IP +.B iptables -A FORWARD -i tun+ -j ACCEPT +.LP +to allow input packets from tun devices to be forwarded to +other hosts on the local network, +.IP +.B iptables -A INPUT -i tap+ -j ACCEPT +.LP +to allow input packets from tap devices, and +.IP +.B iptables -A FORWARD -i tap+ -j ACCEPT +.LP +to allow input packets from tap devices to be forwarded to +other hosts on the local network. + +These rules are secure if you use packet authentication, +since no incoming packets will arrive on a TUN or TAP +virtual device +unless they first pass an HMAC authentication test. +.\"********************************************************* +.SH FAQ +.I http://openvpn.net/faq.html +.\"********************************************************* +.SH HOWTO +For a more comprehensive guide to setting up OpenVPN +in a production setting, see the OpenVPN HOWTO at +.I http://openvpn.net/howto.html +.\"********************************************************* +.SH PROTOCOL +For a description of OpenVPN's underlying protocol, +see +.I http://openvpn.net/security.html +.\"********************************************************* +.SH WEB +OpenVPN's web site is at +.I http://openvpn.net/ + +Go here to download the latest version of OpenVPN, subscribe +to the mailing lists, read the mailing list +archives, or browse the CVS repository. +.\"********************************************************* +.SH BUGS +Report all bugs to the OpenVPN users list <openvpn-users@lists.sourceforge.net>. +To subscribe to the list or see the archives, go to +.I http://openvpn.net/mail.html +.\"********************************************************* +.SH "SEE ALSO" +.BR dhcpcd (8), +.BR ifconfig (8), +.BR openssl (1), +.BR route (8), +.BR scp (1) +.BR ssh (1) +.\"********************************************************* +.SH NOTES +.LP +This product includes software developed by the +OpenSSL Project ( +.I http://www.openssl.org/ +) + +For more information on the TLS protocol, see +.I http://www.ietf.org/rfc/rfc2246.txt + +For more information on the LZO real-time compression library see +.I http://www.oberhumer.com/opensource/lzo/ +.\"********************************************************* +.SH COPYRIGHT +Copyright (C) 2002-2005 OpenVPN Solutions LLC. This program is free software; +you can redistribute it and/or modify +it under the terms of the GNU General Public License version 2 +as published by the Free Software Foundation. +.\"********************************************************* +.SH AUTHORS +James Yonan <jim@yonan.net> diff --git a/openvpn.c b/openvpn.c new file mode 100644 index 0000000..47701f9 --- /dev/null +++ b/openvpn.c @@ -0,0 +1,242 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "init.h" +#include "forward.h" +#include "multi.h" + +#include "memdbg.h" + +#include "forward-inline.h" + +#define P2P_CHECK_SIG() EVENT_LOOP_CHECK_SIGNAL (c, process_signal_p2p, c); + +static bool +process_signal_p2p (struct context *c) +{ + remap_signal (c); + return process_signal (c); +} + +static void +tunnel_point_to_point (struct context *c) +{ + context_clear_2 (c); + + /* set point-to-point mode */ + c->mode = CM_P2P; + + /* initialize tunnel instance */ + init_instance_handle_signals (c, c->es, CC_HARD_USR1_TO_HUP); + if (IS_SIG (c)) + return; + + init_management_callback_p2p (c); + + /* main event loop */ + while (true) + { + perf_push (PERF_EVENT_LOOP); + + /* process timers, TLS, etc. */ + pre_select (c); + P2P_CHECK_SIG(); + + /* set up and do the I/O wait */ + io_wait (c, p2p_iow_flags (c)); + P2P_CHECK_SIG(); + + /* timeout? */ + if (c->c2.event_set_status == ES_TIMEOUT) + { + perf_pop (); + continue; + } + + /* process the I/O which triggered select */ + process_io (c); + P2P_CHECK_SIG(); + + perf_pop (); + } + + uninit_management_callback (); + + /* tear down tunnel instance (unless --persist-tun) */ + close_instance (c); +} + +#undef PROCESS_SIGNAL_P2P + +int +main (int argc, char *argv[]) +{ + struct context c; + +#if PEDANTIC + fprintf (stderr, "Sorry, I was built with --enable-pedantic and I am incapable of doing any real work!\n"); + return 1; +#endif + + CLEAR (c); + + /* signify first time for components which can + only be initialized once per program instantiation. */ + c.first_time = true; + + /* initialize program-wide statics */ + if (init_static ()) + { + /* + * This loop is initially executed on startup and then + * once per SIGHUP. + */ + do + { + /* zero context struct but leave first_time member alone */ + context_clear_all_except_first_time (&c); + + /* static signal info object */ + CLEAR (siginfo_static); + c.sig = &siginfo_static; + + /* initialize garbage collector scoped to context object */ + gc_init (&c.gc); + + /* initialize environmental variable store */ + c.es = env_set_create (&c.gc); + +#ifdef ENABLE_MANAGEMENT + /* initialize management subsystem */ + init_management (&c); +#endif + + /* initialize options to default state */ + init_options (&c.options); + + /* parse command line options, and read configuration file */ + parse_argv (&c.options, argc, argv, M_USAGE, OPT_P_DEFAULT, NULL, c.es); + + /* init verbosity and mute levels */ + init_verb_mute (&c, IVM_LEVEL_1); + + /* set dev options */ + init_options_dev (&c.options); + + /* openssl print info? */ + if (print_openssl_info (&c.options)) + break; + + /* --genkey mode? */ + if (do_genkey (&c.options)) + break; + + /* tun/tap persist command? */ + if (do_persist_tuntap (&c.options)) + break; + + /* sanity check on options */ + options_postprocess (&c.options, c.first_time); + + /* show all option settings */ + show_settings (&c.options); + + /* print version number */ + msg (M_INFO, "%s", title_string); + + /* misc stuff */ + pre_setup (&c.options); + + /* test crypto? */ + if (do_test_crypto (&c.options)) + break; + +#ifdef ENABLE_MANAGEMENT + /* open management subsystem */ + if (!open_management (&c)) + break; +#endif + + /* set certain options as environmental variables */ + setenv_settings (c.es, &c.options); + + /* finish context init */ + context_init_1 (&c); + + do + { + /* run tunnel depending on mode */ + switch (c.options.mode) + { + case MODE_POINT_TO_POINT: + tunnel_point_to_point (&c); + break; +#if P2MP_SERVER + case MODE_SERVER: + tunnel_server (&c); + break; +#endif + default: + ASSERT (0); + } + + /* indicates first iteration -- has program-wide scope */ + c.first_time = false; + + /* any signals received? */ + if (IS_SIG (&c)) + print_signal (c.sig, NULL, M_INFO); + + /* pass restart status to management subsystem */ + signal_restart_status (c.sig); + } + while (c.sig->signal_received == SIGUSR1); + + uninit_options (&c.options); + gc_reset (&c.gc); + } + while (c.sig->signal_received == SIGHUP); + } + + context_gc_free (&c); + +#ifdef ENABLE_MANAGEMENT + /* close management interface */ + close_management (); +#endif + + /* uninitialize program-wide statics */ + uninit_static (); + + openvpn_exit (OPENVPN_EXIT_STATUS_GOOD); /* exit point */ + return 0; /* NOTREACHED */ +} diff --git a/openvpn.h b/openvpn.h new file mode 100644 index 0000000..1ddcd59 --- /dev/null +++ b/openvpn.h @@ -0,0 +1,504 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef OPENVPN_H +#define OPENVPN_H + +#include "buffer.h" +#include "options.h" +#include "socket.h" +#include "crypto.h" +#include "ssl.h" +#include "packet_id.h" +#include "lzo.h" +#include "tun.h" +#include "interval.h" +#include "status.h" +#include "fragment.h" +#include "shaper.h" +#include "route.h" +#include "proxy.h" +#include "socks.h" +#include "sig.h" +#include "misc.h" +#include "mbuf.h" +#include "pool.h" +#include "plugin.h" +#include "manage.h" + +/* + * Our global key schedules, packaged thusly + * to facilitate --persist-key. + */ + +struct key_schedule +{ +#ifdef USE_CRYPTO + /* which cipher, HMAC digest, and key sizes are we using? */ + struct key_type key_type; + + /* pre-shared static key, read from a file */ + struct key_ctx_bi static_key; + +#ifdef USE_SSL + /* our global SSL context */ + SSL_CTX *ssl_ctx; + + /* optional authentication HMAC key for TLS control channel */ + struct key_ctx_bi tls_auth_key; + +#endif /* USE_SSL */ +#else /* USE_CRYPTO */ + int dummy; +#endif /* USE_CRYPTO */ +}; + +/* + * struct packet_id_persist should be empty if we are not + * building with crypto. + */ +#ifndef PACKET_ID_H +struct packet_id_persist +{ + int dummy; +}; +static inline void +packet_id_persist_init (struct packet_id_persist *p) +{ +} +#endif + +/* + * Packet processing buffers. + */ +struct context_buffers +{ + /* miscellaneous buffer, used by ping, occ, etc. */ + struct buffer aux_buf; + + /* workspace buffers used by crypto routines */ +#ifdef USE_CRYPTO + struct buffer encrypt_buf; + struct buffer decrypt_buf; +#endif + + /* workspace buffers for LZO compression */ +#ifdef USE_LZO + struct buffer lzo_compress_buf; + struct buffer lzo_decompress_buf; +#endif + + /* + * Buffers used to read from TUN device + * and TCP/UDP port. + */ + struct buffer read_link_buf; + struct buffer read_tun_buf; +}; + +/* + * Contains the persist-across-restart OpenVPN tunnel instance state. + * Reset only for SIGHUP restarts. + */ +struct context_1 +{ + /* local and remote addresses */ + struct link_socket_addr link_socket_addr; + + /* tunnel session keys */ + struct key_schedule ks; + + /* persist crypto sequence number to/from file */ + struct packet_id_persist pid_persist; + + /* array of remote addresses */ + struct remote_list *remote_list; + + /* TUN/TAP interface */ + struct tuntap *tuntap; + bool tuntap_owned; + + /* list of --route directives */ + struct route_list *route_list; + + /* --status file */ + struct status_output *status_output; + bool status_output_owned; + +#ifdef ENABLE_HTTP_PROXY + /* HTTP proxy object */ + struct http_proxy_info *http_proxy; +#endif + +#ifdef ENABLE_SOCKS + /* SOCKS proxy object */ + struct socks_proxy_info *socks_proxy; +#endif + + /* shared object plugins */ + struct plugin_list *plugins; + bool plugins_owned; + +#if P2MP + +#if P2MP_SERVER + /* persist --ifconfig-pool db to file */ + struct ifconfig_pool_persist *ifconfig_pool_persist; + bool ifconfig_pool_persist_owned; +#endif + + /* if client mode, option strings we pulled from server */ + char *pulled_options_string_save; + + /* save user/pass for authentication */ + struct user_pass *auth_user_pass; +#endif +}; + +/* + * Contains the OpenVPN tunnel instance state, wiped across + * SIGUSR1 and SIGHUP restarts. + */ +struct context_2 +{ + /* garbage collection arena for context_2 scope */ + struct gc_arena gc; + + /* our global wait events */ + struct event_set *event_set; + int event_set_max; + bool event_set_owned; + + /* event flags returned by io_wait */ +# define SOCKET_READ (1<<0) +# define SOCKET_WRITE (1<<1) +# define TUN_READ (1<<2) +# define TUN_WRITE (1<<3) +# define ES_ERROR (1<<4) +# define ES_TIMEOUT (1<<5) +# ifdef ENABLE_MANAGEMENT +# define MANAGEMENT_READ (1<<6) +# define MANAGEMENT_WRITE (1<<7) +# endif + + unsigned int event_set_status; + + struct link_socket *link_socket; /* socket used for TCP/UDP connection to remote */ + bool link_socket_owned; + struct link_socket_info *link_socket_info; + const struct link_socket *accept_from; /* possibly do accept() on a parent link_socket */ + + struct sockaddr_in to_link_addr; /* IP address of remote */ + struct sockaddr_in from; /* address of incoming datagram */ + + /* MTU frame parameters */ + struct frame frame; + +#ifdef ENABLE_FRAGMENT + /* Object to handle advanced MTU negotiation and datagram fragmentation */ + struct fragment_master *fragment; + struct frame frame_fragment; + struct frame frame_fragment_omit; +#endif + +#ifdef HAVE_GETTIMEOFDAY + /* + * Traffic shaper object. + */ + struct shaper shaper; +#endif + + /* + * Statistics + */ + counter_type tun_read_bytes; + counter_type tun_write_bytes; + counter_type link_read_bytes; + counter_type link_read_bytes_auth; + counter_type link_write_bytes; + + /* + * Timer objects for ping and inactivity + * timeout features. + */ + struct event_timeout wait_for_connect; + struct event_timeout inactivity_interval; + struct event_timeout ping_send_interval; + struct event_timeout ping_rec_interval; + +#ifdef ENABLE_OCC + /* the option strings must match across peers */ + char *options_string_local; + char *options_string_remote; + + int occ_op; /* INIT to -1 */ + int occ_n_tries; + struct event_timeout occ_interval; +#endif + + /* + * Keep track of maximum packet size received so far + * (of authenticated packets). + */ + int original_recv_size; /* temporary */ + int max_recv_size_local; /* max packet size received */ + int max_recv_size_remote; /* max packet size received by remote */ + int max_send_size_local; /* max packet size sent */ + int max_send_size_remote; /* max packet size sent by remote */ + +#ifdef ENABLE_OCC + /* remote wants us to send back a load test packet of this size */ + int occ_mtu_load_size; + + struct event_timeout occ_mtu_load_test_interval; + int occ_mtu_load_n_tries; +#endif + +#ifdef USE_CRYPTO + + /* + * TLS-mode crypto objects. + */ +#ifdef USE_SSL + + /* master OpenVPN SSL/TLS object */ + struct tls_multi *tls_multi; + + /* check --tls-auth signature without needing + a full-size tls_multi object */ + struct tls_auth_standalone *tls_auth_standalone; + + /* used to optimize calls to tls_multi_process */ + struct interval tmp_int; + + /* throw this signal on TLS errors */ + int tls_exit_signal; + +#endif /* USE_SSL */ + + /* passed to encrypt or decrypt, contains all + crypto-related command line options related + to data channel encryption/decryption */ + struct crypto_options crypto_options; + + /* used to keep track of data channel packet sequence numbers */ + struct packet_id packet_id; + struct event_timeout packet_id_persist_interval; + +#endif /* USE_CRYPTO */ + + /* + * LZO compression library workspace. + */ +#ifdef USE_LZO + struct lzo_compress_workspace lzo_compwork; +#endif + + /* + * Buffers used for packet processing. + */ + struct context_buffers *buffers; + bool buffers_owned; /* if true, we should free all buffers on close */ + + /* + * These buffers don't actually allocate storage, they are used + * as pointers to the allocated buffers in + * struct context_buffers. + */ + struct buffer buf; + struct buffer to_tun; + struct buffer to_link; + + /* + * IPv4 TUN device? + */ + bool ipv4_tun; + + /* workspace for get_pid_file/write_pid */ + struct pid_state pid_state; + + /* workspace for --user/--group */ + bool uid_gid_specified; + bool uid_gid_set; + struct user_state user_state; + struct group_state group_state; + + /* temporary variable */ + bool did_we_daemonize; + + /* should we print R|W|r|w to console on packet transfers? */ + bool log_rw; + + /* route stuff */ + struct event_timeout route_wakeup; + struct event_timeout route_wakeup_expire; + + /* did we open tun/tap dev during this cycle? */ + bool did_open_tun; + + /* + * Event loop info + */ + + /* how long to wait on link/tun read before we will need to be serviced */ + struct timeval timeval; + + /* next wakeup for processing coarse timers (>1 sec resolution) */ + time_t coarse_timer_wakeup; + + /* maintain a random delta to add to timeouts to avoid contexts + waking up simultaneously */ + time_t update_timeout_random_component; + struct timeval timeout_random_component; + + /* indicates that the do_up_delay function has run */ + bool do_up_ran; + +#ifdef ENABLE_OCC + /* indicates that we have received a SIGTERM when + options->explicit_exit_notification is enabled, + but we have not exited yet */ + time_t explicit_exit_notification_time_wait; + struct event_timeout explicit_exit_notification_interval; +#endif + + /* environmental variables to pass to scripts */ + struct env_set *es; + + /* don't wait for TUN/TAP/UDP to be ready to accept write */ + bool fast_io; + +#if P2MP + +#if P2MP_SERVER + /* --ifconfig endpoints to be pushed to client */ + bool push_reply_deferred; + bool push_ifconfig_defined; + in_addr_t push_ifconfig_local; + in_addr_t push_ifconfig_remote_netmask; + + /* client authentication state */ +# define CAS_SUCCEEDED 0 +# define CAS_PENDING 1 +# define CAS_FAILED 2 +# define CAS_PARTIAL 3 /* at least one client-connect script/plugin + succeeded while a later one in the chain failed */ + int context_auth; +#endif + + struct event_timeout push_request_interval; + const char *pulled_options_string; + + struct event_timeout scheduled_exit; + +#endif +}; + +/* + * Contains all state information for one tunnel. + */ +struct context +{ + /* command line or config file options */ + struct options options; + + /* true on initial VPN iteration */ + bool first_time; + + /* used by multi-client code to lock the context */ + /*MUTEX_DEFINE (mutex);*/ + + /* context modes */ +# define CM_P2P 0 /* standalone point-to-point session or client */ +# define CM_TOP 1 /* top level of a multi-client or point-to-multipoint server */ +# define CM_TOP_CLONE 2 /* clone of a CM_TOP context for one thread */ +# define CM_CHILD_UDP 3 /* child context of a CM_TOP or CM_THREAD */ +# define CM_CHILD_TCP 4 /* child context of a CM_TOP or CM_THREAD */ + int mode; + + /* garbage collection for context scope + allocations */ + struct gc_arena gc; + + /* environmental variable settings */ + struct env_set *es; + + /* signal info */ + struct signal_info *sig; + + /* level 1 context is preserved for + SIGUSR1 restarts, but initialized + for SIGHUP restarts */ + struct context_1 c1; + + /* level 2 context is initialized for all + restarts (SIGUSR1 and SIGHUP) */ + struct context_2 c2; +}; + +/* + * Check for a signal when inside an event loop + */ +#define EVENT_LOOP_CHECK_SIGNAL(c, func, arg) \ + if (IS_SIG (c)) \ + { \ + const int brk = func (arg); \ + perf_pop (); \ + if (brk) \ + break; \ + else \ + continue; \ + } + +/* + * Macros for referencing objects which may not + * have been compiled in. + */ + +#if defined(USE_CRYPTO) && defined(USE_SSL) +#define TLS_MODE(c) ((c)->c2.tls_multi != NULL) +#define PROTO_DUMP_FLAGS (check_debug_level (D_LINK_RW_VERBOSE) ? (PD_SHOW_DATA|PD_VERBOSE) : 0) +#define PROTO_DUMP(buf, gc) protocol_dump((buf), \ + PROTO_DUMP_FLAGS | \ + (c->c2.tls_multi ? PD_TLS : 0) | \ + (c->options.tls_auth_file ? c->c1.ks.key_type.hmac_length : 0), \ + gc) +#else +#define TLS_MODE(c) (false) +#define PROTO_DUMP(buf, gc) format_hex (BPTR (buf), BLEN (buf), 80, gc) +#endif + +#ifdef USE_CRYPTO +#define MD5SUM(buf, len, gc) md5sum((buf), (len), 0, (gc)) +#else +#define MD5SUM(buf, len, gc) "[unavailable]" +#endif + +#ifdef USE_CRYPTO +#define CIPHER_ENABLED(c) (c->c1.ks.key_type.cipher != NULL) +#else +#define CIPHER_ENABLED(c) (false) +#endif + +#endif diff --git a/openvpn.spec.in b/openvpn.spec.in new file mode 100644 index 0000000..041ffdd --- /dev/null +++ b/openvpn.spec.in @@ -0,0 +1,273 @@ +# OpenVPN spec file, used to drive rpmbuild + +# OPTIONS +# +# Disable LZO +# rpmbuild -tb [openvpn.x.tar.gz] --define 'without_lzo 1' +# +# Disable PAM plugin +# rpmbuild -tb [openvpn.x.tar.gz] --define 'without_pam 1' +# +# Allow passwords to be read from files +# rpmbuild -tb [openvpn.x.tar.gz] --define 'with_password_save 1' +# +# Use this on RH9 and RHEL3 +# rpmbuild -tb [openvpn.x.tar.gz] --define 'with_kerberos 1' + +Summary: OpenVPN is a robust and highly flexible VPN daemon by James Yonan. +Name: @PACKAGE@ +Version: @VERSION@ +Release: 1 +URL: http://openvpn.net/ +Source0: http://prdownloads.sourceforge.net/openvpn/%{name}-%{version}.tar.gz + +License: GPL +Group: Applications/Internet +Vendor: James Yonan <jim@yonan.net> +Packager: James Yonan <jim@yonan.net> +BuildRoot: %{_tmppath}/%{name}-%(id -un) + +# +# Include dependencies manually +# + +AutoReq: 0 + +BuildRequires: openssl-devel >= 0.9.6 +Requires: openssl >= 0.9.6 + +%if "%{_vendor}" == "Mandrakesoft" +%{!?without_lzo:BuildRequires: liblzo1-devel >= 1.07} +%{!?without_lzo:Requires: liblzo1 >= 1.07} +%else +%if "%{_vendor}" == "MandrakeSoft" +%{!?without_lzo:BuildRequires: liblzo1-devel >= 1.07} +%{!?without_lzo:Requires: liblzo1 >= 1.07} +%else +%{!?without_lzo:BuildRequires: lzo-devel >= 1.07} +%{!?without_lzo:Requires: lzo >= 1.07} +%endif +%endif + +%{!?without_pam:BuildRequires: pam-devel} +%{!?without_pam:Requires: pam} + +# +# Description +# + +%description +OpenVPN is a robust and highly flexible VPN daemon by James Yonan. +OpenVPN supports SSL/TLS security, +ethernet bridging, +TCP or UDP tunnel transport through proxies or NAT, +support for dynamic IP addresses and DHCP, +scalability to hundreds or thousands of users, +and portability to most major OS platforms. + +# +# Define vendor type +# + +%if "%{_vendor}" == "suse" || "%{_vendor}" == "pc" +%define VENDOR SuSE +%else +%define VENDOR %_vendor +%endif + +# +# Should we build the auth-pam module? +# + +%define build_auth_pam 1 +%{?without_pam:%define build_auth_pam 0} + +# +# Other definitions +# + +%define debug_package %{nil} + +# +# Build OpenVPN binary +# + +%prep +%setup -q + +%build +%configure --disable-dependency-tracking %{?with_password_save:--enable-password-save} %{?without_lzo:--disable-lzo} %{?with_kerberos:--with-ssl-headers=/usr/kerberos/include} +%__make +%__strip %{name} + +# Build down-root plugin +pushd plugin/down-root +%__make +popd + +# Build auth-pam plugin +%if %{build_auth_pam} +pushd plugin/auth-pam +%__make +popd +%endif + +# +# Installation section +# + +%install +[ %{buildroot} != "/" ] && rm -rf %{buildroot} + +# Install man page +%__install -c -d -m 755 %{buildroot}%{_mandir}/man8 +%__install -c -m 755 %{name}.8 %{buildroot}%{_mandir}/man8 + +# Install binary +%__install -c -d -m 755 %{buildroot}%{_sbindir} +%__install -c -m 755 %{name} %{buildroot}%{_sbindir} + +# Install init script +%if "%{VENDOR}" == "SuSE" +%__install -c -d -m 755 %{buildroot}/etc/init.d +%__sed -e 's#openvpn=\"/usr/local/sbin/openvpn\"#openvpn=\"/usr/sbin/openvpn\"#' < suse/%{name}.init > %{_tmppath}/%{name}.init +%__install -c -m 755 %{_tmppath}/%{name}.init %{buildroot}/etc/init.d/%{name} +%__rm %{_tmppath}/%{name}.init +%else +%__install -c -d -m 755 %{buildroot}/etc/rc.d/init.d +%__install -c -m 755 sample-scripts/%{name}.init %{buildroot}/etc/rc.d/init.d/%{name} +%endif + +# Install /etc/openvpn +%__install -c -d -m 755 %{buildroot}/etc/%{name} + +# +# Build /usr/share/openvpn +# + +%__mkdir_p %{buildroot}%{_datadir}/%{name} + +# +# Install the plugins +# + +%__mkdir_p %{buildroot}%{_datadir}/%{name}/plugin/lib + +for pi in auth-pam down-root; do + %__mv -f plugin/$pi/README plugin/README.$pi + if [ -e plugin/$pi/openvpn-$pi.so ]; then + %__install -c -m 755 plugin/$pi/openvpn-$pi.so %{buildroot}%{_datadir}/openvpn/plugin/lib/openvpn-$pi.so + fi +done + +%__mv -f plugin/README plugin/README.plugins + +# +# Clean section +# + +%clean +[ %{buildroot} != "/" ] && rm -rf %{buildroot} + +# +# On Linux 2.4, make the device node +# + +%post +case "`uname -r`" in +2.4*) + /bin/mkdir /dev/net >/dev/null 2>&1 + /bin/mknod /dev/net/tun c 10 200 >/dev/null 2>&1 + ;; +esac + +# +# Handle the init script +# + +/sbin/chkconfig --add %{name} +%if "%{VENDOR}" == "SuSE" +/etc/init.d/openvpn restart +%else +/sbin/service %{name} condrestart +%endif +%preun +if [ "$1" = 0 ] +then + %if "%{VENDOR}" == "SuSE" + /etc/init.d/openvpn stop + %else + /sbin/service %{name} stop + %endif + /sbin/chkconfig --del %{name} +fi + +# +# Files section +# + +%files +%defattr(-,root,root) +%doc AUTHORS ChangeLog COPYING COPYRIGHT.GPL INSTALL NEWS PORTS README +%{_mandir}/man8/%{name}.8* +%{_sbindir}/%{name} +%{_datadir}/%{name} +%dir /etc/%{name} +%if "%{VENDOR}" == "SuSE" +/etc/init.d/%{name} +%else +/etc/rc.d/init.d/%{name} +%endif + +# Install extra %doc stuff +%doc contrib/ easy-rsa/ management/ sample-*/ plugin/README.* + +%changelog + +* Mon Aug 2 2005 James Yonan +- Fixed build problem with --define 'without_pam 1' + +* Mon Apr 4 2005 James Yonan +- Moved some files from /usr/share/openvpn to %doc for compatibility + with Dag Wieers' RPM repository + +* Sat Mar 12 2005 Tom Walsh +- Added MandrakeSoft liblzo1 require + +* Fri Dec 10 2004 James Yonan +- Added AutoReq: 0 for manual dependencies + +* Fri Dec 10 2004 James Yonan +- Packaged the plugins + +* Sun Nov 7 2004 Umberto Nicoletti +- SuSE support + +* Wed Aug 18 2004 Bishop Clark (LC957) <bishop@platypus.bc.ca> +- restrict what we claim in /etc/ to avoid ownership conflicts + +* Sun Feb 23 2003 Matthias Andree <matthias.andree@gmx.de> 1.3.2.14-1. +- Have the version number filled in by autoconf. + +* Wed Jul 10 2002 James Yonan <jim@yonan.net> 1.3.1-1 +- Fixed %preun to only remove service on final uninstall + +* Mon Jun 17 2002 bishop clark (LC957) <bishop@platypus.bc.ca> 1.2.2-1 +- Added condrestart to openvpn.spec & openvpn.init. + +* Wed May 22 2002 James Yonan <jim@yonan.net> 1.2.0-1 +- Added mknod for Linux 2.4. + +* Wed May 15 2002 Doug Keller <dsk@voidstar.dyndns.org> 1.1.1.16-2 +- Added init scripts +- Added conf file support + +* Mon May 13 2002 bishop clark (LC957) <bishop@platypus.bc.ca> 1.1.1.14-1 +- Added new directories for config examples and such + +* Sun May 12 2002 bishop clark (LC957) <bishop@platypus.bc.ca> 1.1.1.13-1 +- Updated buildroot directive and cleanup command +- added easy-rsa utilities + +* Mon Mar 25 2002 bishop clark (LC957) <bishop@platypus.bc.ca> 1.0-1 +- Initial build. diff --git a/options.c b/options.c new file mode 100644 index 0000000..23383ba --- /dev/null +++ b/options.c @@ -0,0 +1,4561 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * 2004-01-28: Added Socks5 proxy support + * (Christof Meerwald, http://cmeerw.org) + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "buffer.h" +#include "error.h" +#include "common.h" +#include "shaper.h" +#include "crypto.h" +#include "ssl.h" +#include "options.h" +#include "misc.h" +#include "socket.h" +#include "packet_id.h" +#include "win32.h" +#include "push.h" +#include "pool.h" +#include "helper.h" +#include "manage.h" + +#include "memdbg.h" + +const char title_string[] = + PACKAGE_STRING + " " TARGET_ALIAS +#ifdef USE_CRYPTO +#ifdef USE_SSL + " [SSL]" +#else + " [CRYPTO]" +#endif +#endif +#ifdef USE_LZO + " [LZO]" +#endif +#if EPOLL + " [EPOLL]" +#endif +#ifdef USE_PTHREAD + " [PTHREAD]" +#endif + " built on " __DATE__ +; + +#ifndef ENABLE_SMALL + +static const char usage_message[] = + "%s\n" + "\n" + "General Options:\n" + "--config file : Read configuration options from file.\n" + "--help : Show options.\n" + "--version : Show copyright and version information.\n" + "\n" + "Tunnel Options:\n" + "--local host : Local host name or ip address.\n" + "--remote host [port] : Remote host name or ip address.\n" + "--remote-random : If multiple --remote options specified, choose one randomly.\n" + "--mode m : Major mode, m = 'p2p' (default, point-to-point) or 'server'.\n" + "--proto p : Use protocol p for communicating with peer.\n" + " p = udp (default), tcp-server, or tcp-client\n" + "--connect-retry n : For --proto tcp-client, number of seconds to wait\n" + " between connection retries (default=%d).\n" +#ifdef ENABLE_HTTP_PROXY + "--http-proxy s p [up] [auth] : Connect to remote host through an HTTP proxy at\n" + " address s and port p. If proxy authentication is required,\n" + " up is a file containing username/password on 2 lines, or\n" + " 'stdin' to prompt from console. Add auth='ntlm' if\n" + " the proxy requires NTLM authentication.\n" + "--http-proxy-retry : Retry indefinitely on HTTP proxy errors.\n" + "--http-proxy-timeout n : Proxy timeout in seconds, default=5.\n" + "--http-proxy-option type [parm] : Set extended HTTP proxy options.\n" + " Repeat to set multiple options.\n" + " VERSION version (default=1.0)\n" + " AGENT user-agent\n" +#endif +#ifdef ENABLE_SOCKS + "--socks-proxy s [p]: Connect to remote host through a Socks5 proxy at address\n" + " s and port p (default port = 1080).\n" + "--socks-proxy-retry : Retry indefinitely on Socks proxy errors.\n" +#endif + "--resolv-retry n: If hostname resolve fails for --remote, retry\n" + " resolve for n seconds before failing (disabled by default).\n" + " Set n=\"infinite\" to retry indefinitely.\n" + "--float : Allow remote to change its IP address/port, such as through\n" + " DHCP (this is the default if --remote is not used).\n" + "--ipchange cmd : Execute shell command cmd on remote ip address initial\n" + " setting or change -- execute as: cmd ip-address port#\n" + "--port port : TCP/UDP port # for both local and remote.\n" + "--lport port : TCP/UDP port # for local (default=%d).\n" + "--rport port : TCP/UDP port # for remote (default=%d).\n" + "--nobind : Do not bind to local address and port.\n" + "--dev tunX|tapX : tun/tap device (X can be omitted for dynamic device.\n" + "--dev-type dt : Which device type are we using? (dt = tun or tap) Use\n" + " this option only if the tun/tap device used with --dev\n" + " does not begin with \"tun\" or \"tap\".\n" + "--dev-node node : Explicitly set the device node rather than using\n" + " /dev/net/tun, /dev/tun, /dev/tap, etc.\n" + "--tun-ipv6 : Build tun link capable of forwarding IPv6 traffic.\n" + "--ifconfig l rn : TUN: configure device to use IP address l as a local\n" + " endpoint and rn as a remote endpoint. l & rn should be\n" + " swapped on the other peer. l & rn must be private\n" + " addresses outside of the subnets used by either peer.\n" + " TAP: configure device to use IP address l as a local\n" + " endpoint and rn as a subnet mask.\n" + "--ifconfig-noexec : Don't actually execute ifconfig/netsh command, instead\n" + " pass --ifconfig parms by environment to scripts.\n" + "--ifconfig-nowarn : Don't warn if the --ifconfig option on this side of the\n" + " connection doesn't match the remote side.\n" + "--route network [netmask] [gateway] [metric] :\n" + " Add route to routing table after connection\n" + " is established. Multiple routes can be specified.\n" + " netmask default: 255.255.255.255\n" + " gateway default: taken from --route-gateway or --ifconfig\n" + " Specify default by leaving blank or setting to \"nil\".\n" + "--route-gateway gw : Specify a default gateway for use with --route.\n" + "--route-delay n [w] : Delay n seconds after connection initiation before\n" + " adding routes (may be 0). If not specified, routes will\n" + " be added immediately after tun/tap open. On Windows, wait\n" + " up to w seconds for TUN/TAP adapter to come up.\n" + "--route-up cmd : Execute shell cmd after routes are added.\n" + "--route-noexec : Don't add routes automatically. Instead pass routes to\n" + " --route-up script using environmental variables.\n" + "--redirect-gateway [flags]: (Experimental) Automatically execute routing\n" + " commands to redirect all outgoing IP traffic through the\n" + " VPN. Add 'local' flag if both " PACKAGE_NAME " servers are directly\n" + " connected via a common subnet, such as with WiFi.\n" + " Add 'def1' flag to set default route using using 0.0.0.0/1\n" + " and 128.0.0.0/1 rather than 0.0.0.0/0.\n" + "--setenv name value : Set a custom environmental variable to pass to script.\n" + "--shaper n : Restrict output to peer to n bytes per second.\n" + "--keepalive n m : Helper option for setting timeouts in server mode. Send\n" + " ping once every n seconds, restart if ping not received\n" + " for m seconds.\n" + "--inactive n : Exit after n seconds of inactivity on tun/tap device.\n" + "--ping-exit n : Exit if n seconds pass without reception of remote ping.\n" + "--ping-restart n: Restart if n seconds pass without reception of remote ping.\n" + "--ping-timer-rem: Run the --ping-exit/--ping-restart timer only if we have a\n" + " remote address.\n" + "--ping n : Ping remote once every n seconds over TCP/UDP port.\n" + "--fast-io : (experimental) Optimize TUN/TAP/UDP writes.\n" + "--remap-usr1 s : On SIGUSR1 signals, remap signal (s='SIGHUP' or 'SIGTERM').\n" + "--persist-tun : Keep tun/tap device open across SIGUSR1 or --ping-restart.\n" + "--persist-remote-ip : Keep remote IP address across SIGUSR1 or --ping-restart.\n" + "--persist-local-ip : Keep local IP address across SIGUSR1 or --ping-restart.\n" + "--persist-key : Don't re-read key files across SIGUSR1 or --ping-restart.\n" +#if PASSTOS_CAPABILITY + "--passtos : TOS passthrough (applies to IPv4 only).\n" +#endif + "--tun-mtu n : Take the tun/tap device MTU to be n and derive the\n" + " TCP/UDP MTU from it (default=%d).\n" + "--tun-mtu-extra n : Assume that tun/tap device might return as many\n" + " as n bytes more than the tun-mtu size on read\n" + " (default TUN=0 TAP=%d).\n" + "--link-mtu n : Take the TCP/UDP device MTU to be n and derive the tun MTU\n" + " from it.\n" + "--mtu-disc type : Should we do Path MTU discovery on TCP/UDP channel?\n" + " 'no' -- Never send DF (Don't Fragment) frames\n" + " 'maybe' -- Use per-route hints\n" + " 'yes' -- Always DF (Don't Fragment)\n" +#ifdef ENABLE_OCC + "--mtu-test : Empirically measure and report MTU.\n" +#endif +#ifdef ENABLE_FRAGMENT + "--fragment max : Enable internal datagram fragmentation so that no UDP\n" + " datagrams are sent which are larger than max bytes.\n" + " Adds 4 bytes of overhead per datagram.\n" +#endif + "--mssfix [n] : Set upper bound on TCP MSS, default = tun-mtu size\n" + " or --fragment max value, whichever is lower.\n" + "--sndbuf size : Set the TCP/UDP send buffer size.\n" + "--rcvbuf size : Set the TCP/UDP receive buffer size.\n" + "--txqueuelen n : Set the tun/tap TX queue length to n (Linux only).\n" + "--mlock : Disable Paging -- ensures key material and tunnel\n" + " data will never be written to disk.\n" + "--up cmd : Shell cmd to execute after successful tun device open.\n" + " Execute as: cmd tun/tap-dev tun-mtu link-mtu \\\n" + " ifconfig-local-ip ifconfig-remote-ip\n" + " (pre --user or --group UID/GID change)\n" + "--up-delay : Delay tun/tap open and possible --up script execution\n" + " until after TCP/UDP connection establishment with peer.\n" + "--down cmd : Shell cmd to run after tun device close.\n" + " (post --user/--group UID/GID change and/or --chroot)\n" + " (script parameters are same as --up option)\n" + "--down-pre : Call --down cmd/script before TUN/TAP close.\n" + "--up-restart : Run up/down scripts for all restarts including those\n" + " caused by --ping-restart or SIGUSR1\n" + "--user user : Set UID to user after initialization.\n" + "--group group : Set GID to group after initialization.\n" + "--chroot dir : Chroot to this directory after initialization.\n" + "--cd dir : Change to this directory before initialization.\n" + "--daemon [name] : Become a daemon after initialization.\n" + " The optional 'name' parameter will be passed\n" + " as the program name to the system logger.\n" + "--syslog [name] : Output to syslog, but do not become a daemon.\n" + " See --daemon above for a description of the 'name' parm.\n" + "--inetd [name] ['wait'|'nowait'] : Run as an inetd or xinetd server.\n" + " See --daemon above for a description of the 'name' parm.\n" + "--log file : Output log to file which is created/truncated on open.\n" + "--log-append file : Append log to file, or create file if nonexistent.\n" + "--suppress-timestamps : Don't log timestamps to stdout/stderr.\n" + "--writepid file : Write main process ID to file.\n" + "--nice n : Change process priority (>0 = lower, <0 = higher).\n" +#if 0 +#ifdef USE_PTHREAD + "--nice-work n : Change thread priority of work thread. The work\n" + " thread is used for background processing such as\n" + " RSA key number crunching.\n" +#endif +#endif + "--echo [parms ...] : Echo parameters to log output.\n" + "--verb n : Set output verbosity to n (default=%d):\n" + " (Level 3 is recommended if you want a good summary\n" + " of what's happening without being swamped by output).\n" + " : 0 -- no output except fatal errors\n" + " : 1 -- startup info + connection initiated messages +\n" + " non-fatal encryption & net errors\n" + " : 2,3 -- show TLS negotiations & route info\n" + " : 4 -- show parameters\n" + " : 5 -- show 'RrWw' chars on console for each packet sent\n" + " and received from TCP/UDP (caps) or tun/tap (lc)\n" + " : 6 to 11 -- debug messages of increasing verbosity\n" + "--mute n : Log at most n consecutive messages in the same category.\n" + "--status file n : Write operational status to file every n seconds.\n" + "--status-version [n] : Choose the status file format version number.\n" + " Currently, n can be 1 or 2 (default=1).\n" +#ifdef ENABLE_OCC + "--disable-occ : Disable options consistency check between peers.\n" +#endif +#ifdef ENABLE_DEBUG + "--gremlin mask : Special stress testing mode (for debugging only).\n" +#endif +#ifdef USE_LZO + "--comp-lzo : Use fast LZO compression -- may add up to 1 byte per\n" + " packet for uncompressible data.\n" + "--comp-noadapt : Don't use adaptive compression when --comp-lzo\n" + " is specified.\n" +#endif +#ifdef ENABLE_MANAGEMENT + "--management ip port [pass] : Enable a TCP server on ip:port to handle\n" + " management functions. pass is a password file\n" + " or 'stdin' to prompt from console.\n" + "--management-query-passwords : Query management channel for private key\n" + " and auth-user-pass passwords.\n" + "--management-hold : Start " PACKAGE_NAME " in a hibernating state, until a client\n" + " of the management interface explicitly starts it.\n" + "--management-log-cache n : Cache n lines of log file history for usage\n" + " by the management channel.\n" +#endif +#ifdef ENABLE_PLUGIN + "--plugin m [str]: Load plug-in module m passing str as an argument\n" + " to its initialization function.\n" +#endif +#if P2MP +#if P2MP_SERVER + "\n" + "Multi-Client Server options (when --mode server is used):\n" + "--server network netmask : Helper option to easily configure server mode.\n" + "--server-bridge IP netmask pool-start-IP pool-end-IP : Helper option to\n" + " easily configure ethernet bridging server mode.\n" + "--push \"option\" : Push a config file option back to the peer for remote\n" + " execution. Peer must specify --pull in its config file.\n" + "--push-reset : Don't inherit global push list for specific\n" + " client instance.\n" + "--ifconfig-pool start-IP end-IP [netmask] : Set aside a pool of subnets\n" + " to be dynamically allocated to connecting clients.\n" + "--ifconfig-pool-linear : Use individual addresses rather than /30 subnets\n" + " in tun mode. Not compatible with Windows clients.\n" + "--ifconfig-pool-persist file [seconds] : Persist/unpersist ifconfig-pool\n" + " data to file, at seconds intervals (default=600).\n" + " If seconds=0, file will be treated as read-only.\n" + "--ifconfig-push local remote-netmask : Push an ifconfig option to remote,\n" + " overrides --ifconfig-pool dynamic allocation.\n" + " Only valid in a client-specific config file.\n" + "--iroute network [netmask] : Route subnet to client.\n" + " Sets up internal routes only.\n" + " Only valid in a client-specific config file.\n" + "--disable : Client is disabled.\n" + " Only valid in a client-specific config file.\n" + "--client-cert-not-required : Don't require client certificate, client\n" + " will authenticate using username/password.\n" + "--username-as-common-name : For auth-user-pass authentication, use\n" + " the authenticated username as the common name,\n" + " rather than the common name from the client cert.\n" + "--auth-user-pass-verify cmd method: Query client for username/password and\n" + " run script cmd to verify. If method='via-env', pass\n" + " user/pass via environment, if method='via-file', pass\n" + " user/pass via temporary file.\n" + "--client-to-client : Internally route client-to-client traffic.\n" + "--duplicate-cn : Allow multiple clients with the same common name to\n" + " concurrently connect.\n" + "--client-connect cmd : Run script cmd on client connection.\n" + "--client-disconnect cmd : Run script cmd on client disconnection.\n" + "--client-config-dir dir : Directory for custom client config files.\n" + "--ccd-exclusive : Refuse connection unless custom client config is found.\n" + "--tmp-dir dir : Temporary directory, used for --client-connect return file.\n" + "--hash-size r v : Set the size of the real address hash table to r and the\n" + " virtual address table to v.\n" + "--bcast-buffers n : Allocate n broadcast buffers.\n" + "--tcp-queue-limit n : Maximum number of queued TCP output packets.\n" + "--learn-address cmd : Run script cmd to validate client virtual addresses.\n" + "--connect-freq n s : Allow a maximum of n new connections per s seconds.\n" + "--max-clients n : Allow a maximum of n simultaneously connected clients.\n" + "--max-routes-per-client n : Allow a maximum of n internal routes per client.\n" +#endif + "\n" + "Client options (when connecting to a multi-client server):\n" + "--client : Helper option to easily configure client mode.\n" + "--auth-user-pass [up] : Authenticate with server using username/password.\n" + " up is a file containing username/password on 2 lines,\n" + " or omit to prompt from console.\n" + "--pull : Accept certain config file options from the peer as if they\n" + " were part of the local config file. Must be specified\n" + " when connecting to a '--mode server' remote host.\n" + "--auth-retry t : How to handle auth failures. Set t to\n" + " none (default), interact, or nointeract.\n" +#endif +#ifdef ENABLE_OCC + "--explicit-exit-notify [n] : On exit/restart, send exit signal to\n" + " server/remote. n = # of retries, default=1.\n" +#endif +#ifdef USE_CRYPTO + "\n" + "Data Channel Encryption Options (must be compatible between peers):\n" + "(These options are meaningful for both Static Key & TLS-mode)\n" + "--secret f [d] : Enable Static Key encryption mode (non-TLS).\n" + " Use shared secret file f, generate with --genkey.\n" + " The optional d parameter controls key directionality.\n" + " If d is specified, use separate keys for each\n" + " direction, set d=0 on one side of the connection,\n" + " and d=1 on the other side.\n" + "--auth alg : Authenticate packets with HMAC using message\n" + " digest algorithm alg (default=%s).\n" + " (usually adds 16 or 20 bytes per packet)\n" + " Set alg=none to disable authentication.\n" + "--cipher alg : Encrypt packets with cipher algorithm alg\n" + " (default=%s).\n" + " Set alg=none to disable encryption.\n" +#ifdef HAVE_EVP_CIPHER_CTX_SET_KEY_LENGTH + "--keysize n : Size of cipher key in bits (optional).\n" + " If unspecified, defaults to cipher-specific default.\n" +#endif + "--engine [name] : Enable OpenSSL hardware crypto engine functionality.\n" + "--no-replay : Disable replay protection.\n" + "--mute-replay-warnings : Silence the output of replay warnings to log file.\n" + "--replay-window n [t] : Use a replay protection sliding window of size n\n" + " and a time window of t seconds.\n" + " Default n=%d t=%d\n" + "--no-iv : Disable cipher IV -- only allowed with CBC mode ciphers.\n" + "--replay-persist file : Persist replay-protection state across sessions\n" + " using file.\n" + "--test-crypto : Run a self-test of crypto features enabled.\n" + " For debugging only.\n" +#ifdef USE_SSL + "\n" + "TLS Key Negotiation Options:\n" + "(These options are meaningful only for TLS-mode)\n" + "--tls-server : Enable TLS and assume server role during TLS handshake.\n" + "--tls-client : Enable TLS and assume client role during TLS handshake.\n" + "--key-method m : Data channel key exchange method. m should be a method\n" + " number, such as 1 (default), 2, etc.\n" + "--ca file : Certificate authority file in .pem format containing\n" + " root certificate.\n" + "--dh file : File containing Diffie Hellman parameters\n" + " in .pem format (for --tls-server only).\n" + " Use \"openssl dhparam -out dh1024.pem 1024\" to generate.\n" + "--cert file : Local certificate in .pem format -- must be signed\n" + " by a Certificate Authority in --ca file.\n" + "--key file : Local private key in .pem format.\n" + "--pkcs12 file : PKCS#12 file containing local private key, local certificate\n" + " and root CA certificate.\n" +#ifdef WIN32 + "--cryptoapicert select-string : Load the certificate and private key from the\n" + " Windows Certificate System Store.\n" +#endif + "--tls-cipher l : A list l of allowable TLS ciphers separated by : (optional).\n" + " : Use --show-tls to see a list of supported TLS ciphers.\n" + "--tls-timeout n : Packet retransmit timeout on TLS control channel\n" + " if no ACK from remote within n seconds (default=%d).\n" + "--reneg-bytes n : Renegotiate data chan. key after n bytes sent and recvd.\n" + "--reneg-pkts n : Renegotiate data chan. key after n packets sent and recvd.\n" + "--reneg-sec n : Renegotiate data chan. key after n seconds (default=%d).\n" + "--hand-window n : Data channel key exchange must finalize within n seconds\n" + " of handshake initiation by any peer (default=%d).\n" + "--tran-window n : Transition window -- old key can live this many seconds\n" + " after new key renegotiation begins (default=%d).\n" + "--single-session: Allow only one session (reset state on restart).\n" + "--tls-exit : Exit on TLS negotiation failure.\n" + "--tls-auth f [d]: Add an additional layer of authentication on top of the TLS\n" + " control channel to protect against DoS attacks.\n" + " f (required) is a shared-secret passphrase file.\n" + " The optional d parameter controls key directionality,\n" + " see --secret option for more info.\n" + "--askpass [file]: Get PEM password from controlling tty before we daemonize.\n" + "--auth-nocache : Don't cache --askpass or --auth-user-pass passwords.\n" + "--crl-verify crl: Check peer certificate against a CRL.\n" + "--tls-verify cmd: Execute shell command cmd to verify the X509 name of a\n" + " pending TLS connection that has otherwise passed all other\n" + " tests of certification. cmd should return 0 to allow\n" + " TLS handshake to proceed, or 1 to fail. (cmd is\n" + " executed as 'cmd certificate_depth X509_NAME_oneline')\n" + "--tls-remote x509name: Accept connections only from a host with X509 name\n" + " x509name. The remote host must also pass all other tests\n" + " of verification.\n" + "--ns-cert-type t: Require that peer certificate was signed with an explicit\n" + " nsCertType designation t = 'client' | 'server'.\n" +#endif /* USE_SSL */ + "\n" + "SSL Library information:\n" + "--show-ciphers : Show cipher algorithms to use with --cipher option.\n" + "--show-digests : Show message digest algorithms to use with --auth option.\n" + "--show-engines : Show hardware crypto accelerator engines (if available).\n" +#ifdef USE_SSL + "--show-tls : Show all TLS ciphers (TLS used only as a control channel).\n" +#endif +#ifdef WIN32 + "\n" + "Windows Specific:\n" + "--ip-win32 method : When using --ifconfig on Windows, set TAP-Win32 adapter\n" + " IP address using method = manual, netsh, ipapi, or\n" + " dynamic (default = ipapi).\n" + " Dynamic method allows two optional parameters:\n" + " offset: DHCP server address offset (> -256 and < 256).\n" + " If 0, use network address, if >0, take nth\n" + " address forward from network address, if <0,\n" + " take nth address backward from broadcast\n" + " address.\n" + " Default is 0.\n" + " lease-time: Lease time in seconds.\n" + " Default is one year.\n" + "--route-method : Which method to use for adding routes on Windows?\n" + " ipapi (default) -- Use IP helper API.\n" + " exe -- Call the route.exe shell command.\n" + "--dhcp-option type [parm] : Set extended TAP-Win32 properties, must\n" + " be used with --ip-win32 dynamic. For options\n" + " which allow multiple addresses,\n" + " --dhcp-option must be repeated.\n" + " DOMAIN name : Set DNS suffix\n" + " DNS addr : Set domain name server address(es)\n" + " NTP : Set NTP server address(es)\n" + " NBDD : Set NBDD server address(es)\n" + " WINS addr : Set WINS server address(es)\n" + " NBT type : Set NetBIOS over TCP/IP Node type\n" + " 1: B, 2: P, 4: M, 8: H\n" + " NBS id : Set NetBIOS scope ID\n" + " DISABLE-NBT : Disable Netbios-over-TCP/IP.\n" + "--dhcp-renew : Ask Windows to renew the TAP adapter lease on startup.\n" + "--dhcp-pre-release : Ask Windows to release the previous TAP adapter lease on\n" +" startup.\n" + "--dhcp-release : Ask Windows to release the TAP adapter lease on shutdown.\n" + "--tap-sleep n : Sleep for n seconds after TAP adapter open before\n" + " attempting to set adapter properties.\n" + "--pause-exit : When run from a console window, pause before exiting.\n" + "--service ex [0|1] : For use when " PACKAGE_NAME " is being instantiated by a\n" + " service, and should not be used directly by end-users.\n" + " ex is the name of an event object which, when\n" + " signaled, will cause " PACKAGE_NAME " to exit. A second\n" + " optional parameter controls the initial state of ex.\n" + "--show-net-up : Show " PACKAGE_NAME "'s view of routing table and net adapter list\n" + " after TAP adapter is up and routes have been added.\n" + "Windows Standalone Options:\n" + "\n" + "--show-adapters : Show all TAP-Win32 adapters.\n" + "--show-net : Show " PACKAGE_NAME "'s view of routing table and net adapter list.\n" + "--show-valid-subnets : Show valid subnets for --dev tun emulation.\n" +#endif + "\n" + "Generate a random key (only for non-TLS static key encryption mode):\n" + "--genkey : Generate a random key to be used as a shared secret,\n" + " for use with the --secret option.\n" + "--secret file : Write key to file.\n" +#endif /* USE_CRYPTO */ +#ifdef TUNSETPERSIST + "\n" + "Tun/tap config mode (available with linux 2.4+):\n" + "--mktun : Create a persistent tunnel.\n" + "--rmtun : Remove a persistent tunnel.\n" + "--dev tunX|tapX : tun/tap device\n" + "--dev-type dt : Device type. See tunnel options above for details.\n" +#endif + ; + +#endif /* !ENABLE_SMALL */ + +/* + * This is where the options defaults go. + * Any option not explicitly set here + * will be set to 0. + */ +void +init_options (struct options *o) +{ + CLEAR (*o); + gc_init (&o->gc); + o->mode = MODE_POINT_TO_POINT; + o->proto = PROTO_UDPv4; + o->connect_retry_seconds = 5; + o->local_port = o->remote_port = OPENVPN_PORT; + o->verbosity = 1; + o->status_file_update_freq = 60; + o->status_file_version = 1; + o->bind_local = true; + o->tun_mtu = TUN_MTU_DEFAULT; + o->link_mtu = LINK_MTU_DEFAULT; + o->mtu_discover_type = -1; + o->mssfix = MSSFIX_DEFAULT; + o->route_delay_window = 30; + o->resolve_retry_seconds = RESOLV_RETRY_INFINITE; +#ifdef ENABLE_OCC + o->occ = true; +#endif +#ifdef ENABLE_MANAGEMENT + o->management_log_history_cache = 250; + o->management_echo_buffer_size = 100; + o->management_state_buffer_size = 100; +#endif +#ifdef TUNSETPERSIST + o->persist_mode = 1; +#endif +#ifndef WIN32 + o->rcvbuf = 65536; + o->sndbuf = 65536; +#endif +#ifdef USE_LZO + o->comp_lzo_adaptive = true; +#endif +#ifdef TARGET_LINUX + o->tuntap_options.txqueuelen = 100; +#endif +#ifdef WIN32 + o->tuntap_options.ip_win32_type = IPW32_SET_DHCP_MASQ; + o->tuntap_options.dhcp_lease_time = 31536000; /* one year */ + o->tuntap_options.dhcp_masq_offset = 0; /* use network address as internal DHCP server address */ + o->route_method = ROUTE_METHOD_IPAPI; +#endif +#ifdef USE_PTHREAD + o->n_threads = 1; +#endif +#if P2MP_SERVER + o->real_hash_size = 256; + o->virtual_hash_size = 256; + o->n_bcast_buf = 256; + o->tcp_queue_limit = 64; + o->max_clients = 1024; + o->max_routes_per_client = 256; + o->ifconfig_pool_persist_refresh_freq = 600; +#endif +#if P2MP + o->scheduled_exit_interval = 5; +#endif +#ifdef USE_CRYPTO + o->ciphername = "BF-CBC"; + o->ciphername_defined = true; + o->authname = "SHA1"; + o->authname_defined = true; + o->replay = true; + o->replay_window = DEFAULT_SEQ_BACKTRACK; + o->replay_time = DEFAULT_TIME_BACKTRACK; + o->use_iv = true; + o->key_direction = KEY_DIRECTION_BIDIRECTIONAL; +#ifdef USE_SSL + o->key_method = 2; + o->tls_timeout = 2; + o->renegotiate_seconds = 3600; + o->handshake_window = 60; + o->transition_window = 3600; +#endif +#endif +} + +void +uninit_options (struct options *o) +{ + gc_free (&o->gc); +} + +#ifdef ENABLE_DEBUG + +#define SHOW_PARM(name, value, format) msg(D_SHOW_PARMS, " " #name " = " format, (value)) +#define SHOW_STR(var) SHOW_PARM(var, (o->var ? o->var : "[UNDEF]"), "'%s'") +#define SHOW_INT(var) SHOW_PARM(var, o->var, "%d") +#define SHOW_UINT(var) SHOW_PARM(var, o->var, "%u") +#define SHOW_UNSIGNED(var) SHOW_PARM(var, o->var, "0x%08x") +#define SHOW_BOOL(var) SHOW_PARM(var, (o->var ? "ENABLED" : "DISABLED"), "%s"); + +#endif + +void +setenv_settings (struct env_set *es, const struct options *o) +{ + setenv_str (es, "config", o->config); + setenv_str (es, "proto", proto2ascii (o->proto, false)); + setenv_str (es, "local", o->local); + setenv_int (es, "local_port", o->local_port); + setenv_int (es, "verb", o->verbosity); + setenv_int (es, "daemon", o->daemon); + setenv_int (es, "daemon_log_redirect", o->log); + + if (o->remote_list) + { + int i; + + for (i = 0; i < o->remote_list->len; ++i) + { + char remote_string[64]; + char remote_port_string[64]; + + openvpn_snprintf (remote_string, sizeof (remote_string), "remote_%d", i+1); + openvpn_snprintf (remote_port_string, sizeof (remote_port_string), "remote_port_%d", i+1); + + setenv_str (es, remote_string, o->remote_list->array[i].hostname); + setenv_int (es, remote_port_string, o->remote_list->array[i].port); + } + } +} + +static in_addr_t +get_ip_addr (const char *ip_string, int msglevel, bool *error) +{ + unsigned int flags = GETADDR_HOST_ORDER; + bool succeeded = false; + in_addr_t ret; + + if (msglevel & M_FATAL) + flags |= GETADDR_FATAL; + + ret = getaddr (flags, ip_string, 0, &succeeded, NULL); + if (!succeeded && error) + *error = true; + return ret; +} + +static char * +string_substitute (const char *src, int from, int to, struct gc_arena *gc) +{ + char *ret = (char *) gc_malloc (strlen (src) + 1, true, gc); + char *dest = ret; + char c; + + do + { + c = *src++; + if (c == from) + c = to; + *dest++ = c; + } + while (c); + return ret; +} + +bool +is_persist_option (const struct options *o) +{ + return o->persist_tun + || o->persist_key + || o->persist_local_ip + || o->persist_remote_ip +#ifdef USE_PTHREAD + || o->n_threads >= 2 +#endif + ; +} + +bool +is_stateful_restart (const struct options *o) +{ + return is_persist_option (o) || (o->remote_list && o->remote_list->len > 1); +} + +#ifdef WIN32 + +#ifdef ENABLE_DEBUG + +static void +show_dhcp_option_addrs (const char *name, const in_addr_t *array, int len) +{ + struct gc_arena gc = gc_new (); + int i; + for (i = 0; i < len; ++i) + { + msg (D_SHOW_PARMS, " %s[%d] = %s", + name, + i, + print_in_addr_t (array[i], 0, &gc)); + } + gc_free (&gc); +} + +static void +show_tuntap_options (const struct tuntap_options *o) +{ + SHOW_BOOL (ip_win32_defined); + SHOW_INT (ip_win32_type); + SHOW_INT (dhcp_masq_offset); + SHOW_INT (dhcp_lease_time); + SHOW_INT (tap_sleep); + SHOW_BOOL (dhcp_options); + SHOW_BOOL (dhcp_renew); + SHOW_BOOL (dhcp_pre_release); + SHOW_BOOL (dhcp_release); + SHOW_STR (domain); + SHOW_STR (netbios_scope); + SHOW_INT (netbios_node_type); + SHOW_BOOL (disable_nbt); + + show_dhcp_option_addrs ("DNS", o->dns, o->dns_len); + show_dhcp_option_addrs ("WINS", o->wins, o->wins_len); + show_dhcp_option_addrs ("NTP", o->ntp, o->ntp_len); + show_dhcp_option_addrs ("NBDD", o->nbdd, o->nbdd_len); +} + +#endif + +static void +dhcp_option_address_parse (const char *name, const char *parm, in_addr_t *array, int *len, int msglevel) +{ + if (*len >= N_DHCP_ADDR) + { + msg (msglevel, "--dhcp-option %s: maximum of %d %s servers can be specified", + name, + N_DHCP_ADDR, + name); + } + else + { + bool error = false; + const in_addr_t addr = get_ip_addr (parm, msglevel, &error); + if (!error) + array[(*len)++] = addr; + } +} + +#endif + +#if P2MP + +#ifdef ENABLE_DEBUG + +static void +show_p2mp_parms (const struct options *o) +{ + struct gc_arena gc = gc_new (); + +#if P2MP_SERVER + msg (D_SHOW_PARMS, " server_network = %s", print_in_addr_t (o->server_network, 0, &gc)); + msg (D_SHOW_PARMS, " server_netmask = %s", print_in_addr_t (o->server_netmask, 0, &gc)); + msg (D_SHOW_PARMS, " server_bridge_ip = %s", print_in_addr_t (o->server_bridge_ip, 0, &gc)); + msg (D_SHOW_PARMS, " server_bridge_netmask = %s", print_in_addr_t (o->server_bridge_netmask, 0, &gc)); + msg (D_SHOW_PARMS, " server_bridge_pool_start = %s", print_in_addr_t (o->server_bridge_pool_start, 0, &gc)); + msg (D_SHOW_PARMS, " server_bridge_pool_end = %s", print_in_addr_t (o->server_bridge_pool_end, 0, &gc)); + if (o->push_list) + { + const struct push_list *l = o->push_list; + const char *printable_push_list = l->options; + msg (D_SHOW_PARMS, " push_list = '%s'", printable_push_list); + } + SHOW_BOOL (ifconfig_pool_defined); + msg (D_SHOW_PARMS, " ifconfig_pool_start = %s", print_in_addr_t (o->ifconfig_pool_start, 0, &gc)); + msg (D_SHOW_PARMS, " ifconfig_pool_end = %s", print_in_addr_t (o->ifconfig_pool_end, 0, &gc)); + msg (D_SHOW_PARMS, " ifconfig_pool_netmask = %s", print_in_addr_t (o->ifconfig_pool_netmask, 0, &gc)); + SHOW_STR (ifconfig_pool_persist_filename); + SHOW_INT (ifconfig_pool_persist_refresh_freq); + SHOW_BOOL (ifconfig_pool_linear); + SHOW_INT (n_bcast_buf); + SHOW_INT (tcp_queue_limit); + SHOW_INT (real_hash_size); + SHOW_INT (virtual_hash_size); + SHOW_STR (client_connect_script); + SHOW_STR (learn_address_script); + SHOW_STR (client_disconnect_script); + SHOW_STR (client_config_dir); + SHOW_BOOL (ccd_exclusive); + SHOW_STR (tmp_dir); + SHOW_BOOL (push_ifconfig_defined); + msg (D_SHOW_PARMS, " push_ifconfig_local = %s", print_in_addr_t (o->push_ifconfig_local, 0, &gc)); + msg (D_SHOW_PARMS, " push_ifconfig_remote_netmask = %s", print_in_addr_t (o->push_ifconfig_remote_netmask, 0, &gc)); + SHOW_BOOL (enable_c2c); + SHOW_BOOL (duplicate_cn); + SHOW_INT (cf_max); + SHOW_INT (cf_per); + SHOW_INT (max_clients); + SHOW_INT (max_routes_per_client); + SHOW_BOOL (client_cert_not_required); + SHOW_BOOL (username_as_common_name) + SHOW_STR (auth_user_pass_verify_script); + SHOW_BOOL (auth_user_pass_verify_script_via_file); +#endif /* P2MP_SERVER */ + + SHOW_BOOL (client); + SHOW_BOOL (pull); + SHOW_STR (auth_user_pass_file); + + gc_free (&gc); +} + +#endif /* ENABLE_DEBUG */ + +#if P2MP_SERVER + +static void +option_iroute (struct options *o, + const char *network_str, + const char *netmask_str, + int msglevel) +{ + struct iroute *ir; + + ALLOC_OBJ_GC (ir, struct iroute, &o->gc); + ir->network = getaddr (GETADDR_HOST_ORDER, network_str, 0, NULL, NULL); + ir->netbits = -1; + + if (netmask_str) + { + const in_addr_t netmask = getaddr (GETADDR_HOST_ORDER, netmask_str, 0, NULL, NULL); + if (!netmask_to_netbits (ir->network, netmask, &ir->netbits)) + { + msg (msglevel, "in --iroute %s %s : Bad network/subnet specification", + network_str, + netmask_str); + return; + } + } + + ir->next = o->iroutes; + o->iroutes = ir; +} + +#endif /* P2MP_SERVER */ +#endif /* P2MP */ + +#ifdef ENABLE_DEBUG +static void +show_remote_list (const struct remote_list *l) +{ + if (l) + { + int i; + for (i = 0; i < l->len; ++i) + { + msg (D_SHOW_PARMS, " remote_list[%d] = {'%s', %d}", + i, l->array[i].hostname, l->array[i].port); + } + } + else + { + msg (D_SHOW_PARMS, " remote_list = NULL"); + } +} +#endif + +#if defined(ENABLE_HTTP_PROXY) && defined (ENABLE_DEBUG) +static void +show_http_proxy_options (const struct http_proxy_options *o) +{ + msg (D_SHOW_PARMS, "BEGIN http_proxy"); + SHOW_STR (server); + SHOW_INT (port); + SHOW_STR (auth_method_string); + SHOW_STR (auth_file); + SHOW_BOOL (retry); + SHOW_INT (timeout); + SHOW_STR (http_version); + SHOW_STR (user_agent); + msg (D_SHOW_PARMS, "END http_proxy"); +} +#endif + +void +options_detach (struct options *o) +{ + gc_detach (&o->gc); + o->routes = NULL; +#if P2MP_SERVER + if (o->push_list) /* clone push_list */ + { + const struct push_list *old = o->push_list; + ALLOC_OBJ_GC (o->push_list, struct push_list, &o->gc); + strcpy (o->push_list->options, old->options); + } +#endif +} + +void +rol_check_alloc (struct options *options) +{ + if (!options->routes) + options->routes = new_route_option_list (&options->gc); +} + +void +show_settings (const struct options *o) +{ +#ifdef ENABLE_DEBUG + msg (D_SHOW_PARMS, "Current Parameter Settings:"); + + SHOW_STR (config); + + SHOW_INT (mode); + +#ifdef TUNSETPERSIST + SHOW_BOOL (persist_config); + SHOW_INT (persist_mode); +#endif + +#ifdef USE_CRYPTO + SHOW_BOOL (show_ciphers); + SHOW_BOOL (show_digests); + SHOW_BOOL (show_engines); + SHOW_BOOL (genkey); +#ifdef USE_SSL + SHOW_STR (key_pass_file); + SHOW_BOOL (show_tls_ciphers); +#endif +#endif + + SHOW_INT (proto); + SHOW_STR (local); + show_remote_list (o->remote_list); + SHOW_BOOL (remote_random); + + SHOW_INT (local_port); + SHOW_INT (remote_port); + SHOW_BOOL (remote_float); + SHOW_STR (ipchange); + SHOW_BOOL (bind_local); + SHOW_STR (dev); + SHOW_STR (dev_type); + SHOW_STR (dev_node); + SHOW_BOOL (tun_ipv6); + SHOW_STR (ifconfig_local); + SHOW_STR (ifconfig_remote_netmask); + SHOW_BOOL (ifconfig_noexec); + SHOW_BOOL (ifconfig_nowarn); + +#ifdef HAVE_GETTIMEOFDAY + SHOW_INT (shaper); +#endif + SHOW_INT (tun_mtu); + SHOW_BOOL (tun_mtu_defined); + SHOW_INT (link_mtu); + SHOW_BOOL (link_mtu_defined); + SHOW_INT (tun_mtu_extra); + SHOW_BOOL (tun_mtu_extra_defined); + +#ifdef ENABLE_FRAGMENT + SHOW_INT (fragment); +#endif + + SHOW_INT (mtu_discover_type); + +#ifdef ENABLE_OCC + SHOW_INT (mtu_test); +#endif + + SHOW_BOOL (mlock); + + SHOW_INT (keepalive_ping); + SHOW_INT (keepalive_timeout); + SHOW_INT (inactivity_timeout); + SHOW_INT (ping_send_timeout); + SHOW_INT (ping_rec_timeout); + SHOW_INT (ping_rec_timeout_action); + SHOW_BOOL (ping_timer_remote); + SHOW_INT (remap_sigusr1); +#ifdef ENABLE_OCC + SHOW_INT (explicit_exit_notification); +#endif + SHOW_BOOL (persist_tun); + SHOW_BOOL (persist_local_ip); + SHOW_BOOL (persist_remote_ip); + SHOW_BOOL (persist_key); + + SHOW_INT (mssfix); + +#if PASSTOS_CAPABILITY + SHOW_BOOL (passtos); +#endif + + SHOW_INT (resolve_retry_seconds); + SHOW_INT (connect_retry_seconds); + + SHOW_STR (username); + SHOW_STR (groupname); + SHOW_STR (chroot_dir); + SHOW_STR (cd_dir); + SHOW_STR (writepid); + SHOW_STR (up_script); + SHOW_STR (down_script); + SHOW_BOOL (down_pre); + SHOW_BOOL (up_restart); + SHOW_BOOL (up_delay); + SHOW_BOOL (daemon); + SHOW_INT (inetd); + SHOW_BOOL (log); + SHOW_BOOL (suppress_timestamps); + SHOW_INT (nice); + SHOW_INT (verbosity); + SHOW_INT (mute); +#ifdef ENABLE_DEBUG + SHOW_INT (gremlin); +#endif + SHOW_STR (status_file); + SHOW_INT (status_file_version); + SHOW_INT (status_file_update_freq); + +#ifdef ENABLE_OCC + SHOW_BOOL (occ); +#endif + SHOW_INT (rcvbuf); + SHOW_INT (sndbuf); + +#ifdef ENABLE_HTTP_PROXY + if (o->http_proxy_options) + show_http_proxy_options (o->http_proxy_options); +#endif + +#ifdef ENABLE_SOCKS + SHOW_STR (socks_proxy_server); + SHOW_INT (socks_proxy_port); + SHOW_BOOL (socks_proxy_retry); +#endif + + SHOW_BOOL (fast_io); + +#ifdef USE_LZO + SHOW_BOOL (comp_lzo); + SHOW_BOOL (comp_lzo_adaptive); +#endif + + SHOW_STR (route_script); + SHOW_STR (route_default_gateway); + SHOW_BOOL (route_noexec); + SHOW_INT (route_delay); + SHOW_INT (route_delay_window); + SHOW_BOOL (route_delay_defined); + if (o->routes) + print_route_options (o->routes, D_SHOW_PARMS); + +#ifdef ENABLE_MANAGEMENT + SHOW_STR (management_addr); + SHOW_INT (management_port); + SHOW_STR (management_user_pass); + SHOW_INT (management_log_history_cache); + SHOW_INT (management_echo_buffer_size); + SHOW_BOOL (management_query_passwords); + SHOW_BOOL (management_hold); +#endif +#ifdef ENABLE_PLUGIN + if (o->plugin_list) + plugin_option_list_print (o->plugin_list, D_SHOW_PARMS); +#endif + +#ifdef USE_CRYPTO + SHOW_STR (shared_secret_file); + SHOW_INT (key_direction); + SHOW_BOOL (ciphername_defined); + SHOW_STR (ciphername); + SHOW_BOOL (authname_defined); + SHOW_STR (authname); + SHOW_INT (keysize); + SHOW_BOOL (engine); + SHOW_BOOL (replay); + SHOW_BOOL (mute_replay_warnings); + SHOW_INT (replay_window); + SHOW_INT (replay_time); + SHOW_STR (packet_id_file); + SHOW_BOOL (use_iv); + SHOW_BOOL (test_crypto); + +#ifdef USE_SSL + SHOW_BOOL (tls_server); + SHOW_BOOL (tls_client); + SHOW_INT (key_method); + SHOW_STR (ca_file); + SHOW_STR (dh_file); + SHOW_STR (cert_file); + SHOW_STR (priv_key_file); + SHOW_STR (pkcs12_file); +#ifdef WIN32 + SHOW_STR (cryptoapi_cert); +#endif + SHOW_STR (cipher_list); + SHOW_STR (tls_verify); + SHOW_STR (tls_remote); + SHOW_STR (crl_file); + SHOW_INT (ns_cert_type); + + SHOW_INT (tls_timeout); + + SHOW_INT (renegotiate_bytes); + SHOW_INT (renegotiate_packets); + SHOW_INT (renegotiate_seconds); + + SHOW_INT (handshake_window); + SHOW_INT (transition_window); + + SHOW_BOOL (single_session); + SHOW_BOOL (tls_exit); + + SHOW_STR (tls_auth_file); +#endif +#endif + +#if P2MP + show_p2mp_parms (o); +#endif + +#ifdef WIN32 + SHOW_BOOL (show_net_up); + SHOW_INT (route_method); + show_tuntap_options (&o->tuntap_options); +#endif +#endif +} + +#undef SHOW_PARM +#undef SHOW_STR +#undef SHOW_INT +#undef SHOW_BOOL + +#ifdef ENABLE_HTTP_PROXY + +struct http_proxy_options * +init_http_options_if_undefined (struct options *o) +{ + if (!o->http_proxy_options) + { + ALLOC_OBJ_CLEAR_GC (o->http_proxy_options, struct http_proxy_options, &o->gc); + /* http proxy defaults */ + o->http_proxy_options->timeout = 5; + o->http_proxy_options->http_version = "1.0"; + } + return o->http_proxy_options; +} + +#endif + +/* + * Sanity check on options. + * Also set some options based on other + * options. + */ +void +options_postprocess (struct options *options, bool first_time) +{ + struct options defaults; + int dev = DEV_TYPE_UNDEF; + int i; + bool pull = false; + + init_options (&defaults); + +#ifdef USE_CRYPTO + if (options->test_crypto) + { + notnull (options->shared_secret_file, "key file (--secret)"); + } + else +#endif + notnull (options->dev, "TUN/TAP device (--dev)"); + + /* + * Get tun/tap/null device type + */ + dev = dev_type_enum (options->dev, options->dev_type); + + /* + * Fill in default port number for --remote list + */ + if (options->remote_list) + { + for (i = 0; i < options->remote_list->len; ++i) + { + struct remote_entry *e = &options->remote_list->array[i]; + if (e->port < 0) + e->port = options->remote_port; + } + } + + /* + * If --mssfix is supplied without a parameter, default + * it to --fragment value, if --fragment is specified. + */ + if (options->mssfix_default) + { +#ifdef ENABLE_FRAGMENT + if (options->fragment) + options->mssfix = options->fragment; +#else + msg (M_USAGE, "--mssfix must specify a parameter"); +#endif + } + + /* + * Sanity check on daemon/inetd modes + */ + + if (options->daemon && options->inetd) + msg (M_USAGE, "only one of --daemon or --inetd may be specified"); + + if (options->inetd && (options->local || options->remote_list)) + msg (M_USAGE, "--local or --remote cannot be used with --inetd"); + + if (options->inetd && options->proto == PROTO_TCPv4_CLIENT) + msg (M_USAGE, "--proto tcp-client cannot be used with --inetd"); + + if (options->inetd == INETD_NOWAIT && options->proto != PROTO_TCPv4_SERVER) + msg (M_USAGE, "--inetd nowait can only be used with --proto tcp-server"); + + if (options->inetd == INETD_NOWAIT +#if defined(USE_CRYPTO) && defined(USE_SSL) + && !(options->tls_server || options->tls_client) +#endif + ) + msg (M_USAGE, "--inetd nowait can only be used in TLS mode"); + + if (options->inetd == INETD_NOWAIT && dev != DEV_TYPE_TAP) + msg (M_USAGE, "--inetd nowait only makes sense in --dev tap mode"); + + /* + * In forking TCP server mode, you don't need to ifconfig + * the tap device (the assumption is that it will be bridged). + */ + if (options->inetd == INETD_NOWAIT) + options->ifconfig_noexec = true; + + /* + * Sanity check on TCP mode options + */ + + if (options->connect_retry_defined && options->proto != PROTO_TCPv4_CLIENT) + msg (M_USAGE, "--connect-retry doesn't make sense unless also used with --proto tcp-client"); + + /* + * Sanity check on MTU parameters + */ + if (options->tun_mtu_defined && options->link_mtu_defined) + msg (M_USAGE, "only one of --tun-mtu or --link-mtu may be defined (note that --ifconfig implies --link-mtu %d)", LINK_MTU_DEFAULT); + +#ifdef ENABLE_OCC + if (options->proto != PROTO_UDPv4 && options->mtu_test) + msg (M_USAGE, "--mtu-test only makes sense with --proto udp"); +#endif + + /* + * Set MTU defaults + */ + { + if (!options->tun_mtu_defined && !options->link_mtu_defined) + { + options->tun_mtu_defined = true; + } + if ((dev == DEV_TYPE_TAP) && !options->tun_mtu_extra_defined) + { + options->tun_mtu_extra_defined = true; + options->tun_mtu_extra = TAP_MTU_EXTRA_DEFAULT; + } + } + + /* + * Process helper-type options which map to other, more complex + * sequences of options. + */ + helper_client_server (options); + helper_keepalive (options); + + /* will we be pulling options from server? */ +#if P2MP + pull = options->pull; +#endif + + /* + * Sanity check on --local, --remote, and --ifconfig + */ + + if (options->remote_list) + { + int i; + struct remote_list *l = options->remote_list; + + for (i = 0; i < l->len; ++i) + { + const char *remote = l->array[i].hostname; + const int remote_port = l->array[i].port; + + if (string_defined_equal (options->local, remote) + && options->local_port == remote_port) + msg (M_USAGE, "--remote and --local addresses are the same"); + + if (string_defined_equal (remote, options->ifconfig_local) + || string_defined_equal (remote, options->ifconfig_remote_netmask)) + msg (M_USAGE, "--local and --remote addresses must be distinct from --ifconfig addresses"); + } + } + + if (string_defined_equal (options->local, options->ifconfig_local) + || string_defined_equal (options->local, options->ifconfig_remote_netmask)) + msg (M_USAGE, "--local addresses must be distinct from --ifconfig addresses"); + + if (string_defined_equal (options->ifconfig_local, options->ifconfig_remote_netmask)) + msg (M_USAGE, "local and remote/netmask --ifconfig addresses must be different"); + + if (options->local_port_defined && !options->bind_local) + msg (M_USAGE, "--lport and --nobind don't make sense when used together"); + + if (!options->remote_list && !options->bind_local) + msg (M_USAGE, "--nobind doesn't make sense unless used with --remote"); + + /* + * Check for consistency of management options + */ +#ifdef ENABLE_MANAGEMENT + if (!options->management_addr && + (options->management_query_passwords || options->management_hold + || options->management_log_history_cache != defaults.management_log_history_cache)) + msg (M_USAGE, "--management is not specified, however one or more options which modify the behavior of --management were specified"); +#endif + + /* + * Windows-specific options. + */ + +#ifdef WIN32 + if (dev == DEV_TYPE_TUN && !(pull || (options->ifconfig_local && options->ifconfig_remote_netmask))) + msg (M_USAGE, "On Windows, --ifconfig is required when --dev tun is used"); + + if ((options->tuntap_options.ip_win32_defined) + && !(pull || (options->ifconfig_local && options->ifconfig_remote_netmask))) + msg (M_USAGE, "On Windows, --ip-win32 doesn't make sense unless --ifconfig is also used"); + + if (options->tuntap_options.dhcp_options && + options->tuntap_options.ip_win32_type != IPW32_SET_DHCP_MASQ) + msg (M_USAGE, "--dhcp-options requires --ip-win32 dynamic"); + + if ((dev == DEV_TYPE_TUN || dev == DEV_TYPE_TAP) && !options->route_delay_defined) + { + options->route_delay_defined = true; + options->route_delay = 0; + } + + if (options->ifconfig_noexec) + { + options->tuntap_options.ip_win32_type = IPW32_SET_MANUAL; + options->ifconfig_noexec = false; + } +#endif + + /* + * Check that protocol options make sense. + */ + +#ifdef ENABLE_FRAGMENT + if (options->proto != PROTO_UDPv4 && options->fragment) + msg (M_USAGE, "--fragment can only be used with --proto udp"); +#endif + +#ifdef ENABLE_OCC + if (options->proto != PROTO_UDPv4 && options->explicit_exit_notification) + msg (M_USAGE, "--explicit-exit-notify can only be used with --proto udp"); +#endif + + if (!options->remote_list && options->proto == PROTO_TCPv4_CLIENT) + msg (M_USAGE, "--remote MUST be used in TCP Client mode"); + +#ifdef ENABLE_HTTP_PROXY + if (options->http_proxy_options && options->proto != PROTO_TCPv4_CLIENT) + msg (M_USAGE, "--http-proxy MUST be used in TCP Client mode (i.e. --proto tcp-client)"); +#endif + +#if defined(ENABLE_HTTP_PROXY) && defined(ENABLE_SOCKS) + if (options->http_proxy_options && options->socks_proxy_server) + msg (M_USAGE, "--http-proxy can not be used together with --socks-proxy"); +#endif + +#ifdef ENABLE_SOCKS + if (options->socks_proxy_server && options->proto == PROTO_TCPv4_SERVER) + msg (M_USAGE, "--socks-proxy can not be used in TCP Server mode"); +#endif + + if (options->proto == PROTO_TCPv4_SERVER && remote_list_len (options->remote_list) > 1) + msg (M_USAGE, "TCP server mode allows at most one --remote address"); + +#if P2MP_SERVER + + /* + * Check consistency of --mode server options. + */ + if (options->mode == MODE_SERVER) + { +#ifdef WIN32 + /* + * We need to explicitly set --tap-sleep because + * we do not schedule event timers in the top-level context. + */ + options->tuntap_options.tap_sleep = 10; + if (options->route_delay_defined && options->route_delay) + options->tuntap_options.tap_sleep = options->route_delay; + options->route_delay_defined = false; +#endif + + if (!(dev == DEV_TYPE_TUN || dev == DEV_TYPE_TAP)) + msg (M_USAGE, "--mode server only works with --dev tun or --dev tap"); + if (options->pull) + msg (M_USAGE, "--pull cannot be used with --mode server"); + if (!(options->proto == PROTO_UDPv4 || options->proto == PROTO_TCPv4_SERVER)) + msg (M_USAGE, "--mode server currently only supports --proto udp or --proto tcp-server"); + if (!options->tls_server) + msg (M_USAGE, "--mode server requires --tls-server"); + if (options->remote_list) + msg (M_USAGE, "--remote cannot be used with --mode server"); + if (!options->bind_local) + msg (M_USAGE, "--nobind cannot be used with --mode server"); +#ifdef ENABLE_HTTP_PROXY + if (options->http_proxy_options) + msg (M_USAGE, "--http-proxy cannot be used with --mode server"); +#endif +#ifdef ENABLE_SOCKS + if (options->socks_proxy_server) + msg (M_USAGE, "--socks-proxy cannot be used with --mode server"); +#endif + if (options->tun_ipv6) + msg (M_USAGE, "--tun-ipv6 cannot be used with --mode server"); + if (options->shaper) + msg (M_USAGE, "--shaper cannot be used with --mode server"); + if (options->inetd) + msg (M_USAGE, "--inetd cannot be used with --mode server"); + if (options->ipchange) + msg (M_USAGE, "--ipchange cannot be used with --mode server (use --client-connect instead)"); + if (!(options->proto == PROTO_UDPv4 || options->proto == PROTO_TCPv4_SERVER)) + msg (M_USAGE, "--mode server currently only supports --proto udp or --proto tcp-server"); + if (options->proto != PROTO_UDPv4 && (options->cf_max || options->cf_per)) + msg (M_USAGE, "--connect-freq only works with --mode server --proto udp. Try --max-clients instead."); + if (dev != DEV_TYPE_TAP && options->ifconfig_pool_netmask) + msg (M_USAGE, "The third parameter to --ifconfig-pool (netmask) is only valid in --dev tap mode"); +#ifdef ENABLE_OCC + if (options->explicit_exit_notification) + msg (M_USAGE, "--explicit-exit-notify cannot be used with --mode server"); +#endif + if (options->routes && options->routes->redirect_default_gateway) + msg (M_USAGE, "--redirect-gateway cannot be used with --mode server (however --push \"redirect-gateway\" is fine)"); + if (options->route_delay_defined) + msg (M_USAGE, "--route-delay cannot be used with --mode server"); + if (options->up_delay) + msg (M_USAGE, "--up-delay cannot be used with --mode server"); + if (!options->ifconfig_pool_defined && options->ifconfig_pool_persist_filename) + msg (M_USAGE, "--ifconfig-pool-persist must be used with --ifconfig-pool"); + if (options->auth_user_pass_file) + msg (M_USAGE, "--auth-user-pass cannot be used with --mode server (it should be used on the client side only)"); + if (options->ccd_exclusive && !options->client_config_dir) + msg (M_USAGE, "--ccd-exclusive must be used with --client-config-dir"); + if (options->key_method != 2) + msg (M_USAGE, "--mode server requires --key-method 2"); + + if (PLUGIN_OPTION_LIST (options) == NULL) + { + if (options->client_cert_not_required && !options->auth_user_pass_verify_script) + msg (M_USAGE, "--client-cert-not-required must be used with an --auth-user-pass-verify script"); + if (options->username_as_common_name && !options->auth_user_pass_verify_script) + msg (M_USAGE, "--username-as-common-name must be used with an --auth-user-pass-verify script"); + } + } + else + { + /* + * When not in server mode, err if parameters are + * specified which require --mode server. + */ + if (options->ifconfig_pool_defined || options->ifconfig_pool_persist_filename) + msg (M_USAGE, "--ifconfig-pool/--ifconfig-pool-persist requires --mode server"); + if (options->real_hash_size != defaults.real_hash_size + || options->virtual_hash_size != defaults.virtual_hash_size) + msg (M_USAGE, "--hash-size requires --mode server"); + if (options->learn_address_script) + msg (M_USAGE, "--learn-address requires --mode server"); + if (options->client_connect_script) + msg (M_USAGE, "--client-connect requires --mode server"); + if (options->client_disconnect_script) + msg (M_USAGE, "--client-disconnect requires --mode server"); + if (options->tmp_dir) + msg (M_USAGE, "--tmp-dir requires --mode server"); + if (options->client_config_dir || options->ccd_exclusive) + msg (M_USAGE, "--client-config-dir/--ccd-exclusive requires --mode server"); + if (options->enable_c2c) + msg (M_USAGE, "--client-to-client requires --mode server"); + if (options->duplicate_cn) + msg (M_USAGE, "--duplicate-cn requires --mode server"); + if (options->cf_max || options->cf_per) + msg (M_USAGE, "--connect-freq requires --mode server"); + if (options->client_cert_not_required) + msg (M_USAGE, "--client-cert-not-required requires --mode server"); + if (options->username_as_common_name) + msg (M_USAGE, "--username-as-common-name requires --mode server"); + if (options->auth_user_pass_verify_script) + msg (M_USAGE, "--auth-user-pass-verify requires --mode server"); + if (options->ifconfig_pool_linear) + msg (M_USAGE, "--ifconfig-pool-linear requires --mode server"); + } +#endif /* P2MP_SERVER */ + +#ifdef USE_CRYPTO + + /* + * Check consistency of replay options + */ + if ((options->proto != PROTO_UDPv4) + && (options->replay_window != defaults.replay_window + || options->replay_time != defaults.replay_time)) + msg (M_USAGE, "--replay-window only makes sense with --proto udp"); + + if (!options->replay + && (options->replay_window != defaults.replay_window + || options->replay_time != defaults.replay_time)) + msg (M_USAGE, "--replay-window doesn't make sense when replay protection is disabled with --no-replay"); + + /* + * Don't use replay window for TCP mode (i.e. require that packets + * be strictly in sequence). + */ + if (link_socket_proto_connection_oriented (options->proto)) + options->replay_window = options->replay_time = 0; + + /* + * SSL/TLS mode sanity checks. + */ + +#ifdef USE_SSL + if (options->tls_server + options->tls_client + + (options->shared_secret_file != NULL) > 1) + msg (M_USAGE, "specify only one of --tls-server, --tls-client, or --secret"); + + if (options->tls_server) + { + notnull (options->dh_file, "DH file (--dh)"); + } + if (options->tls_server || options->tls_client) + { +#ifdef WIN32 + if (options->cryptoapi_cert) + { + notnull (options->ca_file, "CA file (--ca)"); + if (options->cert_file) + msg(M_USAGE, "Parameter --cert cannot be used when --cryptoapicert is also specified."); + if (options->priv_key_file) + msg(M_USAGE, "Parameter --key cannot be used when --cryptoapicert is also specified."); + if (options->pkcs12_file) + msg(M_USAGE, "Parameter --pkcs12 cannot be used when --cryptoapicert is also specified."); + } + else +#endif + if (options->pkcs12_file) + { + if (options->ca_file) + msg(M_USAGE, "Parameter --ca cannot be used when --pkcs12 is also specified."); + if (options->cert_file) + msg(M_USAGE, "Parameter --cert cannot be used when --pkcs12 is also specified."); + if (options->priv_key_file) + msg(M_USAGE, "Parameter --key cannot be used when --pkcs12 is also specified."); + } + else + { + notnull (options->ca_file, "CA file (--ca) or PKCS#12 file (--pkcs12)"); + if (pull) + { + const int sum = (options->cert_file != NULL) + (options->priv_key_file != NULL); + if (sum == 0) + { +#if P2MP + if (!options->auth_user_pass_file) +#endif + msg (M_USAGE, "No client-side authentication method is specified. You must use either --cert/--key, --pkcs12, or --auth-user-pass"); + } + else if (sum == 2) + ; + else + { + msg (M_USAGE, "If you use one of --cert or --key, you must use them both"); + } + } + else + { + notnull (options->cert_file, "certificate file (--cert) or PKCS#12 file (--pkcs12)"); + notnull (options->priv_key_file, "private key file (--key) or PKCS#12 file (--pkcs12)"); + } + } + } + else + { + /* + * Make sure user doesn't specify any TLS options + * when in non-TLS mode. + */ + +#define MUST_BE_UNDEF(parm) if (options->parm != defaults.parm) msg (M_USAGE, err, #parm); + + const char err[] = "Parameter %s can only be specified in TLS-mode, i.e. where --tls-server or --tls-client is also specified."; + + MUST_BE_UNDEF (ca_file); + MUST_BE_UNDEF (dh_file); + MUST_BE_UNDEF (cert_file); + MUST_BE_UNDEF (priv_key_file); + MUST_BE_UNDEF (pkcs12_file); + MUST_BE_UNDEF (cipher_list); + MUST_BE_UNDEF (tls_verify); + MUST_BE_UNDEF (tls_remote); + MUST_BE_UNDEF (tls_timeout); + MUST_BE_UNDEF (renegotiate_bytes); + MUST_BE_UNDEF (renegotiate_packets); + MUST_BE_UNDEF (renegotiate_seconds); + MUST_BE_UNDEF (handshake_window); + MUST_BE_UNDEF (transition_window); + MUST_BE_UNDEF (tls_auth_file); + MUST_BE_UNDEF (single_session); + MUST_BE_UNDEF (tls_exit); + MUST_BE_UNDEF (crl_file); + MUST_BE_UNDEF (key_method); + MUST_BE_UNDEF (ns_cert_type); + + if (pull) + msg (M_USAGE, err, "--pull"); + } +#undef MUST_BE_UNDEF +#endif /* USE_CRYPTO */ +#endif /* USE_SSL */ + +#if P2MP + /* + * In pull mode, we usually import --ping/--ping-restart parameters from + * the server. However we should also set an initial default --ping-restart + * for the period of time before we pull the --ping-restart parameter + * from the server. + */ + if (options->pull + && options->ping_rec_timeout_action == PING_UNDEF + && options->proto == PROTO_UDPv4) + { + options->ping_rec_timeout = PRE_PULL_INITIAL_PING_RESTART; + options->ping_rec_timeout_action = PING_RESTART; + } + + if (options->auth_user_pass_file && !options->pull) + msg (M_USAGE, "--auth-user-pass requires --pull"); + + /* + * Save certain parms before modifying options via --pull + */ + pre_pull_save (options); +#endif +} + +#if P2MP + +/* + * Save/Restore certain option defaults before --pull is applied. + */ + +void +pre_pull_save (struct options *o) +{ + if (o->pull) + { + ALLOC_OBJ_CLEAR_GC (o->pre_pull, struct options_pre_pull, &o->gc); + o->pre_pull->tuntap_options = o->tuntap_options; + o->pre_pull->tuntap_options_defined = true; + o->pre_pull->foreign_option_index = o->foreign_option_index; + if (o->routes) + { + o->pre_pull->routes = *o->routes; + o->pre_pull->routes_defined = true; + } + } +} + +void +pre_pull_restore (struct options *o) +{ + const struct options_pre_pull *pp = o->pre_pull; + if (pp) + { + CLEAR (o->tuntap_options); + if (pp->tuntap_options_defined) + o->tuntap_options = pp->tuntap_options; + + if (pp->routes_defined) + { + rol_check_alloc (o); + *o->routes = pp->routes; + } + else + o->routes = NULL; + + o->foreign_option_index = pp->foreign_option_index; + } +} + +#endif + +#ifdef ENABLE_OCC + +/* + * Build an options string to represent data channel encryption options. + * This string must match exactly between peers. The keysize is checked + * separately by read_key(). + * + * The following options must match on both peers: + * + * Tunnel options: + * + * --dev tun|tap [unit number need not match] + * --dev-type tun|tap + * --link-mtu + * --udp-mtu + * --tun-mtu + * --proto udp + * --proto tcp-client [matched with --proto tcp-server + * on the other end of the connection] + * --proto tcp-server [matched with --proto tcp-client on + * the other end of the connection] + * --tun-ipv6 + * --ifconfig x y [matched with --ifconfig y x on + * the other end of the connection] + * + * --comp-lzo + * --fragment + * + * Crypto Options: + * + * --cipher + * --auth + * --keysize + * --secret + * --no-replay + * --no-iv + * + * SSL Options: + * + * --tls-auth + * --tls-client [matched with --tls-server on + * the other end of the connection] + * --tls-server [matched with --tls-client on + * the other end of the connection] + */ + +char * +options_string (const struct options *o, + const struct frame *frame, + struct tuntap *tt, + bool remote, + struct gc_arena *gc) +{ + struct buffer out = alloc_buf (OPTION_LINE_SIZE); + bool tt_local = false; + + buf_printf (&out, "V4"); + + /* + * Tunnel Options + */ + + buf_printf (&out, ",dev-type %s", dev_type_string (o->dev, o->dev_type)); + buf_printf (&out, ",link-mtu %d", EXPANDED_SIZE (frame)); + buf_printf (&out, ",tun-mtu %d", PAYLOAD_SIZE (frame)); + buf_printf (&out, ",proto %s", proto2ascii (proto_remote (o->proto, remote), true)); + if (o->tun_ipv6) + buf_printf (&out, ",tun-ipv6"); + + /* + * Try to get ifconfig parameters into the options string. + * If tt is undefined, make a temporary instantiation. + */ + if (!tt) + { + tt = init_tun (o->dev, + o->dev_type, + o->ifconfig_local, + o->ifconfig_remote_netmask, + (in_addr_t)0, + (in_addr_t)0, + false, + NULL); + if (tt) + tt_local = true; + } + + if (tt && o->mode == MODE_POINT_TO_POINT && !PULL_DEFINED(o)) + { + const char *ios = ifconfig_options_string (tt, remote, o->ifconfig_nowarn, gc); + if (ios && strlen (ios)) + buf_printf (&out, ",ifconfig %s", ios); + } + if (tt_local) + { + free (tt); + tt = NULL; + } + +#ifdef USE_LZO + if (o->comp_lzo) + buf_printf (&out, ",comp-lzo"); +#endif + +#ifdef ENABLE_FRAGMENT + if (o->fragment) + buf_printf (&out, ",mtu-dynamic"); +#endif + +#ifdef USE_CRYPTO + +#ifdef USE_SSL +#define TLS_CLIENT (o->tls_client) +#define TLS_SERVER (o->tls_server) +#else +#define TLS_CLIENT (false) +#define TLS_SERVER (false) +#endif + + /* + * Key direction + */ + { + const char *kd = keydirection2ascii (o->key_direction, remote); + if (kd) + buf_printf (&out, ",keydir %s", kd); + } + + /* + * Crypto Options + */ + if (o->shared_secret_file || TLS_CLIENT || TLS_SERVER) + { + struct key_type kt; + + ASSERT ((o->shared_secret_file != NULL) + + (TLS_CLIENT == true) + + (TLS_SERVER == true) + <= 1); + + init_key_type (&kt, o->ciphername, o->ciphername_defined, + o->authname, o->authname_defined, + o->keysize, true, false); + + buf_printf (&out, ",cipher %s", kt_cipher_name (&kt)); + buf_printf (&out, ",auth %s", kt_digest_name (&kt)); + buf_printf (&out, ",keysize %d", kt_key_size (&kt)); + if (o->shared_secret_file) + buf_printf (&out, ",secret"); + if (!o->replay) + buf_printf (&out, ",no-replay"); + if (!o->use_iv) + buf_printf (&out, ",no-iv"); + } + +#ifdef USE_SSL + /* + * SSL Options + */ + { + if (TLS_CLIENT || TLS_SERVER) + { + if (o->tls_auth_file) + buf_printf (&out, ",tls-auth"); + + if (o->key_method > 1) + buf_printf (&out, ",key-method %d", o->key_method); + } + + if (remote) + { + if (TLS_CLIENT) + buf_printf (&out, ",tls-server"); + else if (TLS_SERVER) + buf_printf (&out, ",tls-client"); + } + else + { + if (TLS_CLIENT) + buf_printf (&out, ",tls-client"); + else if (TLS_SERVER) + buf_printf (&out, ",tls-server"); + } + } +#endif /* USE_SSL */ + +#undef TLS_CLIENT +#undef TLS_SERVER + +#endif /* USE_CRYPTO */ + + return BSTR (&out); +} + +/* + * Compare option strings for equality. + * If the first two chars of the strings differ, it means that + * we are looking at different versions of the options string, + * therefore don't compare them and return true. + */ + +bool +options_cmp_equal (char *actual, const char *expected) +{ + return options_cmp_equal_safe (actual, expected, strlen (actual) + 1); +} + +void +options_warning (char *actual, const char *expected) +{ + options_warning_safe (actual, expected, strlen (actual) + 1); +} + +static const char * +options_warning_extract_parm1 (const char *option_string, + struct gc_arena *gc_ret) +{ + struct gc_arena gc = gc_new (); + struct buffer b = string_alloc_buf (option_string, &gc); + char *p = gc_malloc (OPTION_PARM_SIZE, false, &gc); + const char *ret; + + buf_parse (&b, ' ', p, OPTION_PARM_SIZE); + ret = string_alloc (p, gc_ret); + gc_free (&gc); + return ret; +} + +static void +options_warning_safe_scan2 (const int msglevel, + const int delim, + const bool report_inconsistent, + const char *p1, + const struct buffer *b2_src, + const char *b1_name, + const char *b2_name) +{ + if (strlen (p1) > 0) + { + struct gc_arena gc = gc_new (); + struct buffer b2 = *b2_src; + const char *p1_prefix = options_warning_extract_parm1 (p1, &gc); + char *p2 = gc_malloc (OPTION_PARM_SIZE, false, &gc); + + while (buf_parse (&b2, delim, p2, OPTION_PARM_SIZE)) + { + if (strlen (p2)) + { + const char *p2_prefix = options_warning_extract_parm1 (p2, &gc); + + if (!strcmp (p1, p2)) + goto done; + if (!strcmp (p1_prefix, p2_prefix)) + { + if (report_inconsistent) + msg (msglevel, "WARNING: '%s' is used inconsistently, %s='%s', %s='%s'", + safe_print (p1_prefix, &gc), + b1_name, + safe_print (p1, &gc), + b2_name, + safe_print (p2, &gc)); + goto done; + } + } + } + + msg (msglevel, "WARNING: '%s' is present in %s config but missing in %s config, %s='%s'", + safe_print (p1_prefix, &gc), + b1_name, + b2_name, + b1_name, + safe_print (p1, &gc)); + + done: + gc_free (&gc); + } +} + +static void +options_warning_safe_scan1 (const int msglevel, + const int delim, + const bool report_inconsistent, + const struct buffer *b1_src, + const struct buffer *b2_src, + const char *b1_name, + const char *b2_name) +{ + struct gc_arena gc = gc_new (); + struct buffer b = *b1_src; + char *p = gc_malloc (OPTION_PARM_SIZE, true, &gc); + + while (buf_parse (&b, delim, p, OPTION_PARM_SIZE)) + options_warning_safe_scan2 (msglevel, delim, report_inconsistent, p, b2_src, b1_name, b2_name); + + gc_free (&gc); +} + +static void +options_warning_safe_ml (const int msglevel, char *actual, const char *expected, size_t actual_n) +{ + struct gc_arena gc = gc_new (); + + if (actual_n > 0) + { + struct buffer local = alloc_buf_gc (OPTION_PARM_SIZE + 16, &gc); + struct buffer remote = alloc_buf_gc (OPTION_PARM_SIZE + 16, &gc); + actual[actual_n - 1] = 0; + + buf_printf (&local, "version %s", expected); + buf_printf (&remote, "version %s", actual); + + options_warning_safe_scan1 (msglevel, ',', true, + &local, &remote, + "local", "remote"); + + options_warning_safe_scan1 (msglevel, ',', false, + &remote, &local, + "remote", "local"); + } + + gc_free (&gc); +} + +bool +options_cmp_equal_safe (char *actual, const char *expected, size_t actual_n) +{ + struct gc_arena gc = gc_new (); + bool ret = true; + + if (actual_n > 0) + { + actual[actual_n - 1] = 0; +#ifndef STRICT_OPTIONS_CHECK + if (strncmp (actual, expected, 2)) + { + msg (D_SHOW_OCC, "NOTE: Options consistency check may be skewed by version differences"); + options_warning_safe_ml (D_SHOW_OCC, actual, expected, actual_n); + } + else +#endif + ret = !strcmp (actual, expected); + } + gc_free (&gc); + return ret; +} + +void +options_warning_safe (char *actual, const char *expected, size_t actual_n) +{ + options_warning_safe_ml (M_WARN, actual, expected, actual_n); +} + +const char * +options_string_version (const char* s, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (4, gc); + strncpynt ((char *) BPTR (&out), s, 3); + return BSTR (&out); +} + +#endif /* ENABLE_OCC */ + +static void +foreign_option (struct options *o, char *argv[], int len, struct env_set *es) +{ + if (len > 0) + { + struct gc_arena gc = gc_new(); + struct buffer name = alloc_buf_gc (OPTION_PARM_SIZE, &gc); + struct buffer value = alloc_buf_gc (OPTION_PARM_SIZE, &gc); + int i; + bool first = true; + + buf_printf (&name, "foreign_option_%d", o->foreign_option_index + 1); + ++o->foreign_option_index; + for (i = 0; i < len; ++i) + { + if (argv[i]) + { + if (!first) + buf_printf (&value, " "); + buf_printf (&value, argv[i]); + first = false; + } + } + setenv_str (es, BSTR(&name), BSTR(&value)); + gc_free (&gc); + } +} + +#if P2MP + +/* + * Manage auth-retry variable + */ + +static int global_auth_retry; /* GLOBAL */ + +int +auth_retry_get (void) +{ + return global_auth_retry; +} + +bool +auth_retry_set (const int msglevel, const char *option) +{ + if (streq (option, "interact")) + global_auth_retry = AR_INTERACT; + else if (streq (option, "nointeract")) + global_auth_retry = AR_NOINTERACT; + else if (streq (option, "none")) + global_auth_retry = AR_NONE; + else + { + msg (msglevel, "--auth-retry method must be 'interact', 'nointeract', or 'none'"); + return false; + } + return true; +} + +const char * +auth_retry_print (void) +{ + switch (global_auth_retry) + { + case AR_NONE: + return "none"; + case AR_NOINTERACT: + return "nointeract"; + case AR_INTERACT: + return "interact"; + default: + return "???"; + } +} + +#endif + +/* + * Print the help message. + */ +static void +usage (void) +{ + FILE *fp = msg_fp(); + +#ifdef ENABLE_SMALL + + fprintf (fp, "Usage message not available\n"); + +#else + + struct options o; + init_options (&o); + +#if defined(USE_CRYPTO) && defined(USE_SSL) + fprintf (fp, usage_message, + title_string, + o.connect_retry_seconds, + o.local_port, o.remote_port, + TUN_MTU_DEFAULT, TAP_MTU_EXTRA_DEFAULT, + o.verbosity, + o.authname, o.ciphername, + o.replay_window, o.replay_time, + o.tls_timeout, o.renegotiate_seconds, + o.handshake_window, o.transition_window); +#elif defined(USE_CRYPTO) + fprintf (fp, usage_message, + title_string, + o.connect_retry_seconds, + o.local_port, o.remote_port, + TUN_MTU_DEFAULT, TAP_MTU_EXTRA_DEFAULT, + o.verbosity, + o.authname, o.ciphername, + o.replay_window, o.replay_time); +#else + fprintf (fp, usage_message, + title_string, + o.connect_retry_seconds, + o.local_port, o.remote_port, + TUN_MTU_DEFAULT, TAP_MTU_EXTRA_DEFAULT, + o.verbosity); +#endif + fflush(fp); + +#endif /* ENABLE_SMALL */ + + openvpn_exit (OPENVPN_EXIT_STATUS_USAGE); /* exit point */ +} + +void +usage_small (void) +{ + msg (M_WARN|M_NOPREFIX, "Use --help for more information."); + openvpn_exit (OPENVPN_EXIT_STATUS_USAGE); /* exit point */ +} + +static void +usage_version (void) +{ + msg (M_INFO|M_NOPREFIX, "%s", title_string); + msg (M_INFO|M_NOPREFIX, "Developed by James Yonan"); + msg (M_INFO|M_NOPREFIX, "Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net>"); + openvpn_exit (OPENVPN_EXIT_STATUS_USAGE); /* exit point */ +} + +void +notnull (const char *arg, const char *description) +{ + if (!arg) + msg (M_USAGE, "You must define %s", description); +} + +bool +string_defined_equal (const char *s1, const char *s2) +{ + if (s1 && s2) + return !strcmp (s1, s2); + else + return false; +} + +#if 0 +static void +ping_rec_err (int msglevel) +{ + msg (msglevel, "only one of --ping-exit or --ping-restart options may be specified"); +} +#endif + +static int +positive_atoi (const char *str) +{ + const int i = atoi (str); + return i < 0 ? 0 : i; +} + +static inline bool +space (char c) +{ + return c == '\0' || isspace (c); +} + +int +parse_line (const char *line, + char *p[], + const int n, + const char *file, + const int line_num, + int msglevel, + struct gc_arena *gc) +{ + const int STATE_INITIAL = 0; + const int STATE_READING_QUOTED_PARM = 1; + const int STATE_READING_UNQUOTED_PARM = 2; + const int STATE_DONE = 3; + + const char *error_prefix = ""; + + int ret = 0; + const char *c = line; + int state = STATE_INITIAL; + bool backslash = false; + char in, out; + + char parm[OPTION_PARM_SIZE]; + unsigned int parm_len = 0; + + msglevel &= ~M_OPTERR; + + if (msglevel & M_MSG_VIRT_OUT) + error_prefix = "ERROR: "; + + do + { + in = *c; + out = 0; + + if (!backslash && in == '\\') + { + backslash = true; + } + else + { + if (state == STATE_INITIAL) + { + if (!space (in)) + { + if (in == ';' || in == '#') /* comment */ + break; + if (!backslash && in == '\"') + state = STATE_READING_QUOTED_PARM; + else + { + out = in; + state = STATE_READING_UNQUOTED_PARM; + } + } + } + else if (state == STATE_READING_UNQUOTED_PARM) + { + if (!backslash && space (in)) + state = STATE_DONE; + else + out = in; + } + else if (state == STATE_READING_QUOTED_PARM) + { + if (!backslash && in == '\"') + state = STATE_DONE; + else + out = in; + } + if (state == STATE_DONE) + { + /* ASSERT (parm_len > 0); */ + p[ret] = gc_malloc (parm_len + 1, true, gc); + memcpy (p[ret], parm, parm_len); + p[ret][parm_len] = '\0'; + state = STATE_INITIAL; + parm_len = 0; + ++ret; + } + + if (backslash && out) + { + if (!(out == '\\' || out == '\"' || space (out))) +#ifdef ENABLE_SMALL + msg (msglevel, "%sOptions warning: Bad backslash ('\\') usage in %s:%d", error_prefix, file, line_num); +#else + msg (msglevel, "%sOptions warning: Bad backslash ('\\') usage in %s:%d: remember that backslashes are treated as shell-escapes and if you need to pass backslash characters as part of a Windows filename, you should use double backslashes such as \"c:\\\\" PACKAGE "\\\\static.key\"", error_prefix, file, line_num); +#endif + } + backslash = false; + } + + /* store parameter character */ + if (out) + { + if (parm_len >= SIZE (parm)) + { + parm[SIZE (parm) - 1] = 0; + msg (msglevel, "%sOptions error: Parameter at %s:%d is too long (%d chars max): %s", + error_prefix, file, line_num, (int) SIZE (parm), parm); + return 0; + } + parm[parm_len++] = out; + } + + /* avoid overflow if too many parms in one config file line */ + if (ret >= n) + break; + + } while (*c++ != '\0'); + + if (state == STATE_READING_QUOTED_PARM) + { + msg (msglevel, "%sOptions error: No closing quotation (\") in %s:%d", error_prefix, file, line_num); + return 0; + } + if (state != STATE_INITIAL) + { + msg (msglevel, "%sOptions error: Residual parse state (%d) in %s:%d", error_prefix, state, file, line_num); + return 0; + } +#if 0 + { + int i; + for (i = 0; i < ret; ++i) + { + msg (M_INFO|M_NOPREFIX, "%s:%d ARG[%d] '%s'", file, line_num, i, p[i]); + } + } +#endif + return ret; +} + +static int +add_option (struct options *options, + int i, + char *p[], + const char *file, + int line, + const int level, + const int msglevel, + const unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es); + +static void +read_config_file (struct options *options, + const char *file, + int level, + const char *top_file, + const int top_line, + const int msglevel, + const unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es) +{ + const int max_recursive_levels = 10; + FILE *fp; + int line_num; + char line[OPTION_LINE_SIZE]; + + ++level; + if (level <= max_recursive_levels) + { + fp = fopen (file, "r"); + if (fp) + { + line_num = 0; + while (fgets(line, sizeof (line), fp)) + { + char *p[MAX_PARMS]; + CLEAR (p); + ++line_num; + if (parse_line (line, p, SIZE (p), file, line_num, msglevel, &options->gc)) + { + if (strlen (p[0]) >= 3 && !strncmp (p[0], "--", 2)) + p[0] += 2; + add_option (options, 0, p, file, line_num, level, msglevel, permission_mask, option_types_found, es); + } + } + fclose (fp); + } + else + { + msg (msglevel, "In %s:%d: Error opening configuration file: %s", top_file, top_line, file); + } + } + else + { + msg (msglevel, "In %s:%d: Maximum recursive include levels exceeded in include attempt of file %s -- probably you have a configuration file that tries to include itself.", top_file, top_line, file); + } +} + +void +parse_argv (struct options *options, + const int argc, + char *argv[], + const int msglevel, + const unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es) +{ + int i, j; + + /* usage message */ + if (argc <= 1) + usage (); + + /* config filename specified only? */ + if (argc == 2 && strncmp (argv[1], "--", 2)) + { + char *p[MAX_PARMS]; + CLEAR (p); + p[0] = "config"; + p[1] = argv[1]; + add_option (options, 0, p, NULL, 0, 0, msglevel, permission_mask, option_types_found, es); + } + else + { + /* parse command line */ + for (i = 1; i < argc; ++i) + { + char *p[MAX_PARMS]; + CLEAR (p); + p[0] = argv[i]; + if (strncmp(p[0], "--", 2)) + { + msg (msglevel, "I'm trying to parse \"%s\" as an --option parameter but I don't see a leading '--'", p[0]); + } + else + p[0] += 2; + + for (j = 1; j < MAX_PARMS; ++j) + { + if (i + j < argc) + { + char *arg = argv[i + j]; + if (strncmp (arg, "--", 2)) + p[j] = arg; + else + break; + } + } + i = add_option (options, i, p, NULL, 0, 0, msglevel, permission_mask, option_types_found, es); + } + } +} + +bool +apply_push_options (struct options *options, + struct buffer *buf, + unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es) +{ + char line[OPTION_PARM_SIZE]; + int line_num = 0; + const char *file = "[PUSH-OPTIONS]"; + const int msglevel = D_PUSH_ERRORS|M_OPTERR; + + while (buf_parse (buf, ',', line, sizeof (line))) + { + char *p[MAX_PARMS]; + CLEAR (p); + ++line_num; + if (parse_line (line, p, SIZE (p), file, line_num, msglevel, &options->gc)) + { + add_option (options, 0, p, file, line_num, 0, msglevel, permission_mask, option_types_found, es); + } + } + return true; +} + +void +options_server_import (struct options *o, + const char *filename, + int msglevel, + unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es) +{ + msg (D_PUSH, "OPTIONS IMPORT: reading client specific options from: %s", filename); + read_config_file (o, + filename, + 0, + filename, + 0, + msglevel, + permission_mask, + option_types_found, + es); +} + +#if P2MP + +#define VERIFY_PERMISSION(mask) { if (!verify_permission(p[0], (mask), permission_mask, option_types_found, msglevel)) goto err; } + +static bool +verify_permission (const char *name, + const unsigned int type, + const unsigned int allowed, + unsigned int *found, + const int msglevel) +{ + if (!(type & allowed)) + { + msg (msglevel, "option '%s' cannot be used in this context", name); + return false; + } + else + { + if (found) + *found |= type; + return true; + } +} + +#else + +#define VERIFY_PERMISSION(mask) + +#endif + +/* + * Return the length of a string array + */ +static int +string_array_len (char *array[]) +{ + int i = 0; + if (array) + { + while (array[i]) + ++i; + } + return i; +} + +/* + * Check that an option doesn't have too + * many parameters. + */ + +#define NM_QUOTE_HINT (1<<0) + +static bool +no_more_than_n_args (const int msglevel, + char *p[], + const int max, + const unsigned int flags) +{ + const int len = string_array_len (p); + + if (!len) + return false; + + if (len > max) + { + msg (msglevel, "the --%s directive should have at most %d parameter%s.%s", + p[0], + max - 1, + max >= 3 ? "s" : "", + (flags & NM_QUOTE_HINT) ? " To pass a list of arguments as one of the parameters, try enclosing them in double quotes (\"\")." : ""); + return false; + } + else + return true; +} + +static int +add_option (struct options *options, + int i, + char *p[], + const char *file, + int line, + const int level, + const int msglevel, + const unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es) +{ + struct gc_arena gc = gc_new (); + ASSERT (MAX_PARMS >= 5); + + if (!file) + { + file = "[CMD-LINE]"; + line = 1; + } + if (streq (p[0], "help")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + usage (); + } + if (streq (p[0], "version")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + usage_version (); + } + else if (streq (p[0], "config") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_CONFIG); + + /* save first config file only in options */ + if (!options->config) + options->config = p[1]; + + read_config_file (options, p[1], level, file, line, msglevel, permission_mask, option_types_found, es); + } + else if (streq (p[0], "echo")) + { + struct buffer string = alloc_buf_gc (OPTION_PARM_SIZE, &gc); + int j; + VERIFY_PERMISSION (OPT_P_ECHO); + + for (j = 1; j < MAX_PARMS; ++j) + { + if (!p[j]) + break; + ++i; + if (j > 1) + buf_printf (&string, " "); + buf_printf (&string, "%s", p[j]); + } + msg (M_INFO, "ECHO:%s", BSTR (&string)); +#ifdef ENABLE_MANAGEMENT + if (management) + management_echo (management, BSTR (&string)); +#endif + } +#ifdef ENABLE_MANAGEMENT + else if (streq (p[0], "management") && p[1] && p[2]) + { + int port; + + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + port = atoi (p[2]); + if (!legal_ipv4_port (port)) + { + msg (msglevel, "port number associated with --management directive is out of range"); + goto err; + } + + options->management_addr = p[1]; + options->management_port = port; + if (p[3]) + { + ++i; + options->management_user_pass = p[3]; + } + } + else if (streq (p[0], "management-query-passwords")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->management_query_passwords = true; + } + else if (streq (p[0], "management-hold")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->management_hold = true; + } + else if (streq (p[0], "management-log-cache") && p[1]) + { + int cache; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + cache = atoi (p[1]); + if (cache < 1) + { + msg (msglevel, "--management-log-cache parameter is out of range"); + goto err; + } + options->management_log_history_cache = cache; + } +#endif +#ifdef ENABLE_PLUGIN + else if (streq (p[0], "plugin") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (p[2]) + ++i; + if (!no_more_than_n_args (msglevel, p, 3, NM_QUOTE_HINT)) + goto err; + if (!options->plugin_list) + options->plugin_list = plugin_option_list_new (&options->gc); + if (!plugin_option_list_add (options->plugin_list, p[1], p[2])) + { + msg (msglevel, "plugin add failed: %s", p[1]); + goto err; + } + } +#endif + else if (streq (p[0], "mode") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (streq (p[1], "p2p")) + options->mode = MODE_POINT_TO_POINT; +#if P2MP_SERVER + else if (streq (p[1], "server")) + options->mode = MODE_SERVER; +#endif + else + { + msg (msglevel, "Bad --mode parameter: %s", p[1]); + goto err; + } + } + else if (streq (p[0], "dev") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->dev = p[1]; + } + else if (streq (p[0], "dev-type") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->dev_type = p[1]; + } + else if (streq (p[0], "dev-node") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->dev_node = p[1]; + } + else if (streq (p[0], "tun-ipv6")) + { + VERIFY_PERMISSION (OPT_P_UP); + options->tun_ipv6 = true; + } + else if (streq (p[0], "ifconfig") && p[1] && p[2]) + { + i += 2; + VERIFY_PERMISSION (OPT_P_UP); + options->ifconfig_local = p[1]; + options->ifconfig_remote_netmask = p[2]; + } + else if (streq (p[0], "ifconfig-noexec")) + { + VERIFY_PERMISSION (OPT_P_UP); + options->ifconfig_noexec = true; + } + else if (streq (p[0], "ifconfig-nowarn")) + { + VERIFY_PERMISSION (OPT_P_UP); + options->ifconfig_nowarn = true; + } + else if (streq (p[0], "local") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->local = p[1]; + } + else if (streq (p[0], "remote-random")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->remote_random = true; + } + else if (streq (p[0], "remote") && p[1]) + { + struct remote_list *l; + struct remote_entry e; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (!options->remote_list) + ALLOC_OBJ_CLEAR_GC (options->remote_list, struct remote_list, &options->gc); + l = options->remote_list; + if (l->len >= REMOTE_LIST_SIZE) + { + msg (msglevel, "Maximum number of --remote options (%d) exceeded", REMOTE_LIST_SIZE); + goto err; + } + e.hostname = p[1]; + if (p[2]) + { + ++i; + e.port = atoi (p[2]); + if (!legal_ipv4_port (e.port)) + { + msg (msglevel, "port number associated with host %s is out of range", e.hostname); + goto err; + } + } + else + e.port = -1; + l->array[l->len++] = e; + } + else if (streq (p[0], "resolv-retry") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (streq (p[1], "infinite")) + options->resolve_retry_seconds = RESOLV_RETRY_INFINITE; + else + options->resolve_retry_seconds = positive_atoi (p[1]); + } + else if (streq (p[0], "connect-retry") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->connect_retry_seconds = positive_atoi (p[1]); + options->connect_retry_defined = true; + } + else if (streq (p[0], "ipchange") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->ipchange = string_substitute (p[1], ',', ' ', &options->gc); + } + else if (streq (p[0], "float")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->remote_float = true; + } +#ifdef ENABLE_DEBUG + else if (streq (p[0], "gremlin") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->gremlin = positive_atoi (p[1]); + } +#endif + else if (streq (p[0], "chroot") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->chroot_dir = p[1]; + } + else if (streq (p[0], "cd") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (openvpn_chdir (p[1])) + { + msg (M_ERR, "cd to '%s' failed", p[1]); + goto err; + } + options->cd_dir = p[1]; + } + else if (streq (p[0], "writepid") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->writepid = p[1]; + } + else if (streq (p[0], "up") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->up_script = p[1]; + } + else if (streq (p[0], "down") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->down_script = p[1]; + } + else if (streq (p[0], "down-pre")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->down_pre = true; + } + else if (streq (p[0], "up-delay")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->up_delay = true; + } + else if (streq (p[0], "up-restart")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->up_restart = true; + } + else if (streq (p[0], "syslog")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[1]) + ++i; + open_syslog (p[1], false); + } + else if (streq (p[0], "daemon")) + { + bool didit = false; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (!options->daemon) + { + options->daemon = didit = true; + open_syslog (p[1], false); + } + if (p[1]) + { + ++i; + if (!didit) + { + msg (M_WARN, "WARNING: Multiple --daemon directives specified, ignoring --daemon %s. (Note that initscripts sometimes add their own --daemon directive.)", p[1]); + goto err; + } + } + } + else if (streq (p[0], "inetd")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + if (!options->inetd) + { + int z; + const char *name = NULL; + const char *opterr = "when --inetd is used with two parameters, one of them must be 'wait' or 'nowait' and the other must be a daemon name to use for system logging"; + + options->inetd = -1; + + for (z = 1; z <= 2; ++z) + { + if (p[z]) + { + ++i; + if (streq (p[z], "wait")) + { + if (options->inetd != -1) + { + msg (msglevel, opterr); + goto err; + } + else + options->inetd = INETD_WAIT; + } + else if (streq (p[z], "nowait")) + { + if (options->inetd != -1) + { + msg (msglevel, opterr); + goto err; + } + else + options->inetd = INETD_NOWAIT; + } + else + { + if (name != NULL) + { + msg (msglevel, opterr); + goto err; + } + name = p[z]; + } + } + } + + /* default */ + if (options->inetd == -1) + options->inetd = INETD_WAIT; + + save_inetd_socket_descriptor (); + open_syslog (name, true); + } + } + else if (streq (p[0], "log") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->log = true; + redirect_stdout_stderr (p[1], false); + } + else if (streq (p[0], "suppress-timestamps")) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->suppress_timestamps = true; + set_suppress_timestamps(true); + } + else if (streq (p[0], "log-append") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->log = true; + redirect_stdout_stderr (p[1], true); + } + else if (streq (p[0], "mlock")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->mlock = true; + } + else if (streq (p[0], "verb") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MESSAGES); + options->verbosity = positive_atoi (p[1]); + } + else if (streq (p[0], "mute") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MESSAGES); + options->mute = positive_atoi (p[1]); + } + else if (streq (p[0], "status") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->status_file = p[1]; + if (p[2]) + { + ++i; + options->status_file_update_freq = positive_atoi (p[2]); + } + } + else if (streq (p[0], "status-version") && p[1]) + { + int version; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + version = atoi (p[1]); + if (version < 1 || version > 2) + { + msg (msglevel, "--status-version must be 1 or 2"); + goto err; + } + options->status_file_version = version; + } + else if (streq (p[0], "remap-usr1") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (streq (p[1], "SIGHUP")) + options->remap_sigusr1 = SIGHUP; + else if (streq (p[1], "SIGTERM")) + options->remap_sigusr1 = SIGTERM; + else + { + msg (msglevel, "--remap-usr1 parm must be 'SIGHUP' or 'SIGTERM'"); + goto err; + } + } + else if ((streq (p[0], "link-mtu") || streq (p[0], "udp-mtu")) && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MTU); + options->link_mtu = positive_atoi (p[1]); + options->link_mtu_defined = true; + } + else if (streq (p[0], "tun-mtu") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MTU); + options->tun_mtu = positive_atoi (p[1]); + options->tun_mtu_defined = true; + } + else if (streq (p[0], "tun-mtu-extra") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MTU); + options->tun_mtu_extra = positive_atoi (p[1]); + options->tun_mtu_extra_defined = true; + } +#ifdef ENABLE_FRAGMENT + else if (streq (p[0], "mtu-dynamic")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + msg (msglevel, "--mtu-dynamic has been replaced by --fragment"); + goto err; + } + else if (streq (p[0], "fragment") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MTU); + options->fragment = positive_atoi (p[1]); + } +#endif + else if (streq (p[0], "mtu-disc") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_MTU); + options->mtu_discover_type = translate_mtu_discover_type_name (p[1]); + } +#ifdef ENABLE_OCC + else if (streq (p[0], "mtu-test")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->mtu_test = true; + } +#endif + else if (streq (p[0], "nice") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_NICE); + options->nice = atoi (p[1]); + } + else if (streq (p[0], "rcvbuf") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->rcvbuf = positive_atoi (p[1]); + } + else if (streq (p[0], "sndbuf") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->sndbuf = positive_atoi (p[1]); + } + else if (streq (p[0], "txqueuelen") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); +#ifdef TARGET_LINUX + options->tuntap_options.txqueuelen = positive_atoi (p[1]); +#else + msg (msglevel, "--txqueuelen not supported on this OS"); + goto err; +#endif + } +#ifdef USE_PTHREAD + else if (streq (p[0], "nice-work") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_NICE); + options->nice_work = atoi (p[1]); + } + else if (streq (p[0], "threads") && p[1]) + { + int n_threads; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + n_threads = positive_atoi (p[1]); + if (n_threads < 1) + { + msg (msglevel, "--threads parameter must be at least 1"); + goto err; + } + options->n_threads = n_threads; + } +#endif + else if (streq (p[0], "shaper") && p[1]) + { +#ifdef HAVE_GETTIMEOFDAY + int shaper; + + ++i; + VERIFY_PERMISSION (OPT_P_SHAPER); + shaper = atoi (p[1]); + if (shaper < SHAPER_MIN || shaper > SHAPER_MAX) + { + msg (msglevel, "Bad shaper value, must be between %d and %d", + SHAPER_MIN, SHAPER_MAX); + goto err; + } + options->shaper = shaper; +#else /* HAVE_GETTIMEOFDAY */ + VERIFY_PERMISSION (OPT_P_GENERAL); + msg (msglevel, "--shaper requires the gettimeofday() function which is missing"); + goto err; +#endif /* HAVE_GETTIMEOFDAY */ + } + else if (streq (p[0], "port") && p[1]) + { + int port; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + port = atoi (p[1]); + if (!legal_ipv4_port (port)) + { + msg (msglevel, "Bad port number: %s", p[1]); + goto err; + } + options->port_option_used = true; + options->local_port = options->remote_port = port; + } + else if (streq (p[0], "lport") && p[1]) + { + int port; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + port = atoi (p[1]); + if (!legal_ipv4_port (port)) + { + msg (msglevel, "Bad local port number: %s", p[1]); + goto err; + } + options->local_port_defined = true; + options->port_option_used = true; + options->local_port = port; + } + else if (streq (p[0], "rport") && p[1]) + { + int port; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + port = atoi (p[1]); + if (!legal_ipv4_port (port)) + { + msg (msglevel, "Bad remote port number: %s", p[1]); + goto err; + } + options->port_option_used = true; + options->remote_port = port; + } + else if (streq (p[0], "nobind")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->bind_local = false; + } + else if (streq (p[0], "fast-io")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->fast_io = true; + } + else if (streq (p[0], "inactive") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TIMER); + options->inactivity_timeout = positive_atoi (p[1]); + } + else if (streq (p[0], "proto") && p[1]) + { + int proto; + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + proto = ascii2proto (p[1]); + if (proto < 0) + { + msg (msglevel, "Bad protocol: '%s'. Allowed protocols with --proto option: %s", + p[1], + proto2ascii_all (&gc)); + goto err; + } + options->proto = proto; + } +#ifdef ENABLE_HTTP_PROXY + else if (streq (p[0], "http-proxy") && p[1] && p[2]) + { + int port; + struct http_proxy_options *ho; + + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + port = atoi (p[2]); + if (!legal_ipv4_port (port)) + { + msg (msglevel, "Bad http-proxy port number: %s", p[2]); + goto err; + } + + ho = init_http_options_if_undefined (options); + + ho->server = p[1]; + ho->port = port; + if (p[3]) + { + ++i; + ho->auth_method_string = "basic"; + ho->auth_file = p[3]; + + if (p[4]) + { + ++i; + ho->auth_method_string = p[4]; + } + } + else + { + ho->auth_method_string = "none"; + } + } + else if (streq (p[0], "http-proxy-retry")) + { + struct http_proxy_options *ho; + VERIFY_PERMISSION (OPT_P_GENERAL); + ho = init_http_options_if_undefined (options); + ho->retry = true; + } + else if (streq (p[0], "http-proxy-timeout") && p[1]) + { + struct http_proxy_options *ho; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + ho = init_http_options_if_undefined (options); + ho->timeout = positive_atoi (p[1]); + } + else if (streq (p[0], "http-proxy-option") && p[1]) + { + struct http_proxy_options *ho; + + ++i; + if (p[2]) + ++i; + + VERIFY_PERMISSION (OPT_P_GENERAL); + ho = init_http_options_if_undefined (options); + + if (streq (p[1], "VERSION") && p[2]) + { + ho->http_version = p[2]; + } + else if (streq (p[1], "AGENT") && p[2]) + { + ho->user_agent = p[2]; + } + else + { + msg (msglevel, "Bad http-proxy-option or missing parameter: '%s'", p[1]); + } + } +#endif +#ifdef ENABLE_SOCKS + else if (streq (p[0], "socks-proxy") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + + if (p[2]) + { + int port; + ++i; + port = atoi (p[2]); + if (!legal_ipv4_port (port)) + { + msg (msglevel, "Bad socks-proxy port number: %s", p[2]); + goto err; + } + options->socks_proxy_port = port; + } + else + { + options->socks_proxy_port = 1080; + } + options->socks_proxy_server = p[1]; + } + else if (streq (p[0], "socks-proxy-retry")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->socks_proxy_retry = true; + } +#endif + else if (streq (p[0], "keepalive") && p[1] && p[2]) + { + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->keepalive_ping = atoi (p[1]); + options->keepalive_timeout = atoi (p[2]); + } + else if (streq (p[0], "ping") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TIMER); + options->ping_send_timeout = positive_atoi (p[1]); + } + else if (streq (p[0], "ping-exit") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TIMER); + options->ping_rec_timeout = positive_atoi (p[1]); + options->ping_rec_timeout_action = PING_EXIT; + } + else if (streq (p[0], "ping-restart") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TIMER); + options->ping_rec_timeout = positive_atoi (p[1]); + options->ping_rec_timeout_action = PING_RESTART; + } + else if (streq (p[0], "ping-timer-rem")) + { + VERIFY_PERMISSION (OPT_P_TIMER); + options->ping_timer_remote = true; + } +#ifdef ENABLE_OCC + else if (streq (p[0], "explicit-exit-notify")) + { + VERIFY_PERMISSION (OPT_P_EXPLICIT_NOTIFY); + if (p[1]) + { + ++i; + options->explicit_exit_notification = positive_atoi (p[1]); + } + else + { + options->explicit_exit_notification = 1; + } + } +#endif + else if (streq (p[0], "persist-tun")) + { + VERIFY_PERMISSION (OPT_P_PERSIST); + options->persist_tun = true; + } + else if (streq (p[0], "persist-key")) + { + VERIFY_PERMISSION (OPT_P_PERSIST); + options->persist_key = true; + } + else if (streq (p[0], "persist-local-ip")) + { + VERIFY_PERMISSION (OPT_P_PERSIST_IP); + options->persist_local_ip = true; + } + else if (streq (p[0], "persist-remote-ip")) + { + VERIFY_PERMISSION (OPT_P_PERSIST_IP); + options->persist_remote_ip = true; + } + else if (streq (p[0], "route") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_ROUTE); + if (p[2]) + ++i; + if (p[3]) + ++i; + if (p[4]) + ++i; + rol_check_alloc (options); + add_route_to_option_list (options->routes, p[1], p[2], p[3], p[4]); + } + else if (streq (p[0], "route-gateway") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_ROUTE); + options->route_default_gateway = p[1]; + } + else if (streq (p[0], "route-delay")) + { + VERIFY_PERMISSION (OPT_P_ROUTE); + options->route_delay_defined = true; + if (p[1]) + { + ++i; + options->route_delay = positive_atoi (p[1]); + if (p[2]) + { + ++i; + options->route_delay_window = positive_atoi (p[2]); + } + } + else + { + options->route_delay = 0; + } + } + else if (streq (p[0], "route-up") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->route_script = p[1]; + } + else if (streq (p[0], "route-noexec")) + { + VERIFY_PERMISSION (OPT_P_SCRIPT); + options->route_noexec = true; + } + else if (streq (p[0], "redirect-gateway")) + { + int j; + VERIFY_PERMISSION (OPT_P_ROUTE); + rol_check_alloc (options); + for (j = 1; j < MAX_PARMS && p[j] != NULL; ++j) + { + ++i; + if (streq (p[j], "local")) + options->routes->redirect_local = true; + else if (streq (p[j], "def1")) + options->routes->redirect_def1 = true; + else + { + msg (msglevel, "unknown --redirect-gateway flag: %s", p[j]); + goto err; + } + } + options->routes->redirect_default_gateway = true; + } + else if (streq (p[0], "setenv") && p[1] && p[2]) + { + i += 2; + VERIFY_PERMISSION (OPT_P_SETENV); + setenv_str (es, p[1], p[2]); + } + else if (streq (p[0], "mssfix")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[1]) + { + ++i; + options->mssfix = positive_atoi (p[1]); + } + else + options->mssfix_default = true; + + } +#ifdef ENABLE_OCC + else if (streq (p[0], "disable-occ")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->occ = false; + } +#endif +#if P2MP +#if P2MP_SERVER + else if (streq (p[0], "server") && p[1] && p[2]) + { + const int lev = M_WARN; + bool error = false; + in_addr_t network, netmask; + + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + network = get_ip_addr (p[1], lev, &error); + netmask = get_ip_addr (p[2], lev, &error); + if (error || !network || !netmask) + { + msg (msglevel, "error parsing --server parameters"); + goto err; + } + options->server_defined = true; + options->server_network = network; + options->server_netmask = netmask; + } + else if (streq (p[0], "server-bridge") && p[1] && p[2] && p[3] && p[4]) + { + const int lev = M_WARN; + bool error = false; + in_addr_t ip, netmask, pool_start, pool_end; + + i += 4; + VERIFY_PERMISSION (OPT_P_GENERAL); + ip = get_ip_addr (p[1], lev, &error); + netmask = get_ip_addr (p[2], lev, &error); + pool_start = get_ip_addr (p[3], lev, &error); + pool_end = get_ip_addr (p[4], lev, &error); + if (error || !ip || !netmask || !pool_start || !pool_end) + { + msg (msglevel, "error parsing --server-bridge parameters"); + goto err; + } + options->server_bridge_defined = true; + options->server_bridge_ip = ip; + options->server_bridge_netmask = netmask; + options->server_bridge_pool_start = pool_start; + options->server_bridge_pool_end = pool_end; + } + else if (streq (p[0], "push") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_PUSH); + push_option (options, p[1], msglevel); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + } + else if (streq (p[0], "push-reset")) + { + VERIFY_PERMISSION (OPT_P_INSTANCE); + push_reset (options); + } + else if (streq (p[0], "ifconfig-pool") && p[1] && p[2]) + { + const int lev = M_WARN; + bool error = false; + in_addr_t start, end, netmask=0; + + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + start = get_ip_addr (p[1], lev, &error); + end = get_ip_addr (p[2], lev, &error); + if (p[3]) + { + ++i; + netmask = get_ip_addr (p[3], lev, &error); + } + if (error) + { + msg (msglevel, "error parsing --ifconfig-pool parameters"); + goto err; + } + if (start > end) + { + msg (msglevel, "--ifconfig-pool start IP is greater than end IP"); + goto err; + } + if (end - start >= IFCONFIG_POOL_MAX) + { + msg (msglevel, "--ifconfig-pool address range is too large. Current maximum is %d addresses.", + IFCONFIG_POOL_MAX); + goto err; + } + + options->ifconfig_pool_defined = true; + options->ifconfig_pool_start = start; + options->ifconfig_pool_end = end; + options->ifconfig_pool_netmask = netmask; + } + else if (streq (p[0], "ifconfig-pool-persist") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->ifconfig_pool_persist_filename = p[1]; + if (p[2]) + { + ++i; + options->ifconfig_pool_persist_refresh_freq = positive_atoi (p[2]); + } + } + else if (streq (p[0], "ifconfig-pool-linear")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->ifconfig_pool_linear = true; + } + else if (streq (p[0], "hash-size") && p[1] && p[2]) + { + int real, virtual; + + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + real = atoi (p[1]); + virtual = atoi (p[2]); + if (real < 1 || virtual < 1) + { + msg (msglevel, "--hash-size sizes must be >= 1 (preferably a power of 2)"); + goto err; + } + options->real_hash_size = real; + options->virtual_hash_size = real; + } + else if (streq (p[0], "connect-freq") && p[1] && p[2]) + { + int cf_max, cf_per; + + i += 2; + VERIFY_PERMISSION (OPT_P_GENERAL); + cf_max = atoi (p[1]); + cf_per = atoi (p[2]); + if (cf_max < 0 || cf_per < 0) + { + msg (msglevel, "--connect-freq parms must be > 0"); + goto err; + } + options->cf_max = cf_max; + options->cf_per = cf_per; + } + else if (streq (p[0], "max-clients") && p[1]) + { + int max_clients; + + i += 1; + VERIFY_PERMISSION (OPT_P_GENERAL); + max_clients = atoi (p[1]); + if (max_clients < 0) + { + msg (msglevel, "--max-clients must be at least 1"); + goto err; + } + options->max_clients = max_clients; + } + else if (streq (p[0], "max-routes-per-client") && p[1]) + { + i += 1; + VERIFY_PERMISSION (OPT_P_INHERIT); + options->max_routes_per_client = max_int (atoi (p[1]), 1); + } + else if (streq (p[0], "client-cert-not-required")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->client_cert_not_required = true; + } + else if (streq (p[0], "username-as-common-name")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->username_as_common_name = true; + } + else if (streq (p[0], "auth-user-pass-verify") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 3, NM_QUOTE_HINT)) + goto err; + if (p[2]) + { + ++i; + if (streq (p[2], "via-env")) + options->auth_user_pass_verify_script_via_file = false; + else if (streq (p[2], "via-file")) + options->auth_user_pass_verify_script_via_file = true; + else + { + msg (msglevel, "second parm to --auth-user-pass-verify must be 'via-env' or 'via-file'"); + goto err; + } + } + else + { + msg (msglevel, "--auth-user-pass-verify requires a second parameter ('via-env' or 'via-file')"); + goto err; + } + options->auth_user_pass_verify_script = p[1]; + } + else if (streq (p[0], "client-connect") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->client_connect_script = p[1]; + } + else if (streq (p[0], "client-disconnect") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->client_disconnect_script = p[1]; + } + else if (streq (p[0], "learn-address") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->learn_address_script = p[1]; + } + else if (streq (p[0], "tmp-dir") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->tmp_dir = p[1]; + } + else if (streq (p[0], "client-config-dir") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->client_config_dir = p[1]; + } + else if (streq (p[0], "ccd-exclusive")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->ccd_exclusive = true; + } + else if (streq (p[0], "bcast-buffers") && p[1]) + { + int n_bcast_buf; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + n_bcast_buf = atoi (p[1]); + if (n_bcast_buf < 1) + msg (msglevel, "--bcast-buffers parameter must be > 0"); + options->n_bcast_buf = n_bcast_buf; + } + else if (streq (p[0], "tcp-queue-limit") && p[1]) + { + int tcp_queue_limit; + + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + tcp_queue_limit = atoi (p[1]); + if (tcp_queue_limit < 1) + msg (msglevel, "--tcp-queue-limit parameter must be > 0"); + options->tcp_queue_limit = tcp_queue_limit; + } + else if (streq (p[0], "client-to-client")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->enable_c2c = true; + } + else if (streq (p[0], "duplicate-cn")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->duplicate_cn = true; + } + else if (streq (p[0], "iroute") && p[1]) + { + const char *netmask = NULL; + + ++i; + VERIFY_PERMISSION (OPT_P_INSTANCE); + if (p[2]) + { + ++i; + netmask = p[2]; + } + option_iroute (options, p[1], netmask, msglevel); + } + else if (streq (p[0], "ifconfig-push") && p[1] && p[2]) + { + in_addr_t local, remote_netmask; + + i += 2; + VERIFY_PERMISSION (OPT_P_INSTANCE); + local = getaddr (GETADDR_HOST_ORDER|GETADDR_RESOLVE, p[1], 0, NULL, NULL); + remote_netmask = getaddr (GETADDR_HOST_ORDER|GETADDR_RESOLVE, p[2], 0, NULL, NULL); + if (local && remote_netmask) + { + options->push_ifconfig_defined = true; + options->push_ifconfig_local = local; + options->push_ifconfig_remote_netmask = remote_netmask; + } + else + { + msg (msglevel, "cannot parse --ifconfig-push addresses"); + goto err; + } + } + else if (streq (p[0], "disable")) + { + VERIFY_PERMISSION (OPT_P_INSTANCE); + options->disable = true; + } +#endif /* P2MP_SERVER */ + + else if (streq (p[0], "client")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->client = true; + } + else if (streq (p[0], "pull")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->pull = true; + } + else if (streq (p[0], "auth-user-pass")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[1]) + { + ++i; + options->auth_user_pass_file = p[1]; + } + else + options->auth_user_pass_file = "stdin"; + } + else if (streq (p[0], "auth-retry") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + auth_retry_set (msglevel, p[1]); + } +#endif +#ifdef WIN32 + else if (streq (p[0], "route-method") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_ROUTE); + if (streq (p[1], "ipapi")) + options->route_method = ROUTE_METHOD_IPAPI; + else if (streq (p[1], "exe")) + options->route_method = ROUTE_METHOD_EXE; + else + { + msg (msglevel, "--route method must be 'ipapi' or 'exe'"); + goto err; + } + } + else if (streq (p[0], "ip-win32") && p[1]) + { + const int index = ascii2ipset (p[1]); + struct tuntap_options *to = &options->tuntap_options; + + ++i; + VERIFY_PERMISSION (OPT_P_IPWIN32); + + if (index < 0) + { + msg (msglevel, + "Bad --ip-win32 method: '%s'. Allowed methods: %s", + p[1], + ipset2ascii_all (&gc)); + goto err; + } + + if (index == IPW32_SET_DHCP_MASQ) + { + if (p[2]) + { + ++i; + if (!streq (p[2], "default")) + { + int offset = atoi (p[2]); + + if (!(offset > -256 && offset < 256)) + { + msg (msglevel, "--ip-win32 dynamic [offset] [lease-time]: offset (%d) must be > -256 and < 256", offset); + goto err; + } + + to->dhcp_masq_custom_offset = true; + to->dhcp_masq_offset = offset; + } + + if (p[3]) + { + const int min_lease = 30; + int lease_time; + ++i; + lease_time = atoi (p[3]); + if (lease_time < min_lease) + { + msg (msglevel, "--ip-win32 dynamic [offset] [lease-time]: lease time parameter (%d) must be at least %d seconds", lease_time, min_lease); + goto err; + } + to->dhcp_lease_time = lease_time; + } + } + } + to->ip_win32_type = index; + to->ip_win32_defined = true; + } + else if (streq (p[0], "dhcp-option") && p[1]) + { + struct tuntap_options *o = &options->tuntap_options; + ++i; + VERIFY_PERMISSION (OPT_P_IPWIN32); + + if (streq (p[1], "DOMAIN") && p[2]) + { + ++i; + o->domain = p[2]; + } + else if (streq (p[1], "NBS") && p[2]) + { + ++i; + o->netbios_scope = p[2]; + } + else if (streq (p[1], "NBT") && p[2]) + { + int t; + ++i; + t = atoi (p[2]); + if (!(t == 1 || t == 2 || t == 4 || t == 8)) + { + msg (msglevel, "--dhcp-option NBT: parameter (%d) must be 1, 2, 4, or 8", t); + goto err; + } + o->netbios_node_type = t; + } + else if (streq (p[1], "DNS") && p[2]) + { + ++i; + dhcp_option_address_parse ("DNS", p[2], o->dns, &o->dns_len, msglevel); + } + else if (streq (p[1], "WINS") && p[2]) + { + ++i; + dhcp_option_address_parse ("WINS", p[2], o->wins, &o->wins_len, msglevel); + } + else if (streq (p[1], "NTP") && p[2]) + { + ++i; + dhcp_option_address_parse ("NTP", p[2], o->ntp, &o->ntp_len, msglevel); + } + else if (streq (p[1], "NBDD") && p[2]) + { + ++i; + dhcp_option_address_parse ("NBDD", p[2], o->nbdd, &o->nbdd_len, msglevel); + } + else if (streq (p[1], "DISABLE-NBT")) + { + o->disable_nbt = 1; + } + else + { + msg (msglevel, "--dhcp-option: unknown option type '%s' or missing parameter", p[1]); + goto err; + } + o->dhcp_options = true; + } + else if (streq (p[0], "show-adapters")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + show_tap_win32_adapters (M_INFO|M_NOPREFIX, M_WARN|M_NOPREFIX); + openvpn_exit (OPENVPN_EXIT_STATUS_GOOD); /* exit point */ + } + else if (streq (p[0], "show-net")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + show_routes (M_INFO|M_NOPREFIX); + show_adapters (M_INFO|M_NOPREFIX); + openvpn_exit (OPENVPN_EXIT_STATUS_GOOD); /* exit point */ + } + else if (streq (p[0], "show-net-up")) + { + VERIFY_PERMISSION (OPT_P_UP); + options->show_net_up = true; + } + else if (streq (p[0], "tap-sleep") && p[1]) + { + int s; + ++i; + VERIFY_PERMISSION (OPT_P_IPWIN32); + s = atoi (p[1]); + if (s < 0 || s >= 256) + { + msg (msglevel, "--tap-sleep parameter must be between 0 and 255"); + goto err; + } + options->tuntap_options.tap_sleep = s; + } + else if (streq (p[0], "dhcp-renew")) + { + VERIFY_PERMISSION (OPT_P_IPWIN32); + options->tuntap_options.dhcp_renew = true; + } + else if (streq (p[0], "dhcp-pre-release")) + { + VERIFY_PERMISSION (OPT_P_IPWIN32); + options->tuntap_options.dhcp_pre_release = true; + } + else if (streq (p[0], "dhcp-release")) + { + VERIFY_PERMISSION (OPT_P_IPWIN32); + options->tuntap_options.dhcp_release = true; + } + else if (streq (p[0], "show-valid-subnets")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + show_valid_win32_tun_subnets (); + openvpn_exit (OPENVPN_EXIT_STATUS_USAGE); /* exit point */ + } + else if (streq (p[0], "pause-exit")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + set_pause_exit_win32 (); + } + else if (streq (p[0], "service") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->exit_event_name = p[1]; + if (p[2]) + { + ++i; + options->exit_event_initial_state = (atoi(p[2]) != 0); + } + } + else if (streq (p[0], "user") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + msg (M_WARN, "NOTE: --user option is not implemented on Windows"); + } + else if (streq (p[0], "group") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + msg (M_WARN, "NOTE: --group option is not implemented on Windows"); + } +#else + else if (streq (p[0], "user") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->username = p[1]; + } + else if (streq (p[0], "group") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->groupname = p[1]; + } + else if (streq (p[0], "dhcp-option") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_IPWIN32); + if (p[2]) + ++i; + foreign_option (options, p, 3, es); + } + else if (streq (p[0], "route-method") && p[1]) /* ignore when pushed to non-Windows OS */ + { + ++i; + VERIFY_PERMISSION (OPT_P_ROUTE); + } +#endif +#if PASSTOS_CAPABILITY + else if (streq (p[0], "passtos")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->passtos = true; + } +#endif +#ifdef USE_LZO + else if (streq (p[0], "comp-lzo")) + { + VERIFY_PERMISSION (OPT_P_COMP); + options->comp_lzo = true; + } + else if (streq (p[0], "comp-noadapt")) + { + VERIFY_PERMISSION (OPT_P_COMP); + options->comp_lzo_adaptive = false; + } +#endif /* USE_LZO */ +#ifdef USE_CRYPTO + else if (streq (p[0], "show-ciphers")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->show_ciphers = true; + } + else if (streq (p[0], "show-digests")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->show_digests = true; + } + else if (streq (p[0], "show-engines")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->show_engines = true; + } + else if (streq (p[0], "secret") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[2]) + { + int key_direction; + + ++i; + key_direction = ascii2keydirection (msglevel, p[2]); + if (key_direction >= 0) + options->key_direction = key_direction; + else + goto err; + } + options->shared_secret_file = p[1]; + } + else if (streq (p[0], "genkey")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->genkey = true; + } + else if (streq (p[0], "auth") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->authname_defined = true; + options->authname = p[1]; + if (streq (options->authname, "none")) + { + options->authname_defined = false; + options->authname = NULL; + } + } + else if (streq (p[0], "auth")) + { + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->authname_defined = true; + } + else if (streq (p[0], "cipher") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->ciphername_defined = true; + options->ciphername = p[1]; + if (streq (options->ciphername, "none")) + { + options->ciphername_defined = false; + options->ciphername = NULL; + } + } + else if (streq (p[0], "cipher")) + { + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->ciphername_defined = true; + } + else if (streq (p[0], "no-replay")) + { + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->replay = false; + } + else if (streq (p[0], "replay-window")) + { + VERIFY_PERMISSION (OPT_P_CRYPTO); + if (p[1]) + { + int replay_window; + + ++i; + replay_window = atoi (p[1]); + if (!(MIN_SEQ_BACKTRACK <= replay_window && replay_window <= MAX_SEQ_BACKTRACK)) + { + msg (msglevel, "replay-window window size parameter (%d) must be between %d and %d", + replay_window, + MIN_SEQ_BACKTRACK, + MAX_SEQ_BACKTRACK); + goto err; + } + options->replay_window = replay_window; + + if (p[2]) + { + int replay_time; + + ++i; + replay_time = atoi (p[2]); + if (!(MIN_TIME_BACKTRACK <= replay_time && replay_time <= MAX_TIME_BACKTRACK)) + { + msg (msglevel, "replay-window time window parameter (%d) must be between %d and %d", + replay_time, + MIN_TIME_BACKTRACK, + MAX_TIME_BACKTRACK); + goto err; + } + options->replay_time = replay_time; + } + } + else + { + msg (msglevel, "replay-window option is missing window size parameter"); + goto err; + } + } + else if (streq (p[0], "mute-replay-warnings")) + { + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->mute_replay_warnings = true; + } + else if (streq (p[0], "no-iv")) + { + VERIFY_PERMISSION (OPT_P_CRYPTO); + options->use_iv = false; + } + else if (streq (p[0], "replay-persist") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->packet_id_file = p[1]; + } + else if (streq (p[0], "test-crypto")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->test_crypto = true; + } + else if (streq (p[0], "engine")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[1]) + { + ++i; + options->engine = p[1]; + } + else + options->engine = "auto"; + } +#ifdef HAVE_EVP_CIPHER_CTX_SET_KEY_LENGTH + else if (streq (p[0], "keysize") && p[1]) + { + int keysize; + + ++i; + VERIFY_PERMISSION (OPT_P_CRYPTO); + keysize = atoi (p[1]) / 8; + if (keysize < 0 || keysize > MAX_CIPHER_KEY_LENGTH) + { + msg (msglevel, "Bad keysize: %s", p[1]); + goto err; + } + options->keysize = keysize; + } +#endif +#ifdef USE_SSL + else if (streq (p[0], "show-tls")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->show_tls_ciphers = true; + } + else if (streq (p[0], "tls-server")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->tls_server = true; + } + else if (streq (p[0], "tls-client")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->tls_client = true; + } + else if (streq (p[0], "ca") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->ca_file = p[1]; + } + else if (streq (p[0], "dh") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->dh_file = p[1]; + } + else if (streq (p[0], "cert") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->cert_file = p[1]; + } +#ifdef WIN32 + else if (streq (p[0], "cryptoapicert") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->cryptoapi_cert = p[1]; + } +#endif + else if (streq (p[0], "key") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->priv_key_file = p[1]; + } + else if (streq (p[0], "pkcs12") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->pkcs12_file = p[1]; + } + else if (streq (p[0], "askpass")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[1]) + { + ++i; + options->key_pass_file = p[1]; + } + else + options->key_pass_file = "stdin"; + } + else if (streq (p[0], "auth-nocache")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + ssl_set_auth_nocache (); + } + else if (streq (p[0], "single-session")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->single_session = true; + } + else if (streq (p[0], "tls-exit")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->tls_exit = true; + } + else if (streq (p[0], "tls-cipher") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->cipher_list = p[1]; + } + else if (streq (p[0], "crl-verify") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->crl_file = p[1]; + } + else if (streq (p[0], "tls-verify") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_SCRIPT); + if (!no_more_than_n_args (msglevel, p, 2, NM_QUOTE_HINT)) + goto err; + options->tls_verify = string_substitute (p[1], ',', ' ', &options->gc); + } + else if (streq (p[0], "tls-remote") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + options->tls_remote = p[1]; + } + else if (streq (p[0], "ns-cert-type") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (streq (p[1], "server")) + options->ns_cert_type = NS_SSL_SERVER; + else if (streq (p[1], "client")) + options->ns_cert_type = NS_SSL_CLIENT; + else + { + msg (msglevel, "--ns-cert-type must be 'client' or 'server'"); + goto err; + } + } + else if (streq (p[0], "tls-timeout") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TLS_PARMS); + options->tls_timeout = positive_atoi (p[1]); + } + else if (streq (p[0], "reneg-bytes") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TLS_PARMS); + options->renegotiate_bytes = positive_atoi (p[1]); + } + else if (streq (p[0], "reneg-pkts") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TLS_PARMS); + options->renegotiate_packets = positive_atoi (p[1]); + } + else if (streq (p[0], "reneg-sec") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TLS_PARMS); + options->renegotiate_seconds = positive_atoi (p[1]); + } + else if (streq (p[0], "hand-window") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TLS_PARMS); + options->handshake_window = positive_atoi (p[1]); + } + else if (streq (p[0], "tran-window") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_TLS_PARMS); + options->transition_window = positive_atoi (p[1]); + } + else if (streq (p[0], "tls-auth") && p[1]) + { + ++i; + VERIFY_PERMISSION (OPT_P_GENERAL); + if (p[2]) + { + int key_direction; + + ++i; + key_direction = ascii2keydirection (msglevel, p[2]); + if (key_direction >= 0) + options->key_direction = key_direction; + else + goto err; + } + options->tls_auth_file = p[1]; + } + else if (streq (p[0], "key-method") && p[1]) + { + int key_method; + ++i; + + VERIFY_PERMISSION (OPT_P_GENERAL); + key_method = atoi (p[1]); + if (key_method < KEY_METHOD_MIN || key_method > KEY_METHOD_MAX) + { + msg (msglevel, "key_method parameter (%d) must be >= %d and <= %d", + key_method, + KEY_METHOD_MIN, + KEY_METHOD_MAX); + goto err; + } + options->key_method = key_method; + } +#endif /* USE_SSL */ +#endif /* USE_CRYPTO */ +#ifdef TUNSETPERSIST + else if (streq (p[0], "rmtun")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->persist_config = true; + options->persist_mode = 0; + } + else if (streq (p[0], "mktun")) + { + VERIFY_PERMISSION (OPT_P_GENERAL); + options->persist_config = true; + options->persist_mode = 1; + } +#endif + else + { + if (file) + msg (msglevel, "Unrecognized option or missing parameter(s) in %s:%d: %s (%s)", file, line, p[0], PACKAGE_VERSION); + else + msg (msglevel, "Unrecognized option or missing parameter(s): --%s (%s)", p[0], PACKAGE_VERSION); + } + err: + gc_free (&gc); + return i; +} diff --git a/options.h b/options.h new file mode 100644 index 0000000..c7294be --- /dev/null +++ b/options.h @@ -0,0 +1,564 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * 2004-01-28: Added Socks5 proxy support + * (Christof Meerwald, http://cmeerw.org) + */ + +#ifndef OPTIONS_H +#define OPTIONS_H + +#include "basic.h" +#include "common.h" +#include "mtu.h" +#include "route.h" +#include "tun.h" +#include "socket.h" +#include "plugin.h" +#include "manage.h" +#include "proxy.h" + +/* + * Maximum number of parameters associated with an option, + * including the option name itself. + */ +#define MAX_PARMS 16 + +/* + * Max size of options line and parameter. + */ +#define OPTION_PARM_SIZE 256 +#define OPTION_LINE_SIZE 256 + +extern const char title_string[]; + +#if P2MP + +#if P2MP_SERVER +/* parameters to be pushed to peer */ + +#define MAX_PUSH_LIST_LEN TLS_CHANNEL_BUF_SIZE /* This parm is related to PLAINTEXT_BUFFER_SIZE in ssl.h */ + +struct push_list { + /* newline delimited options, like config file */ + char options[MAX_PUSH_LIST_LEN]; +}; +#endif + +/* certain options are saved before --pull modifications are applied */ +struct options_pre_pull +{ + bool tuntap_options_defined; + struct tuntap_options tuntap_options; + + bool routes_defined; + struct route_option_list routes; + + int foreign_option_index; +}; + +#endif + +/* Command line options */ +struct options +{ + struct gc_arena gc; + + /* first config file */ + const char *config; + + /* major mode */ +# define MODE_POINT_TO_POINT 0 +# define MODE_SERVER 1 + int mode; + + /* persist parms */ + bool persist_config; + int persist_mode; + +#ifdef USE_CRYPTO + const char *key_pass_file; + bool show_ciphers; + bool show_digests; + bool show_engines; +#ifdef USE_SSL + bool show_tls_ciphers; +#endif + bool genkey; +#endif + + /* Networking parms */ + const char *local; + int local_port; + bool local_port_defined; + int remote_port; + bool port_option_used; + bool remote_float; + struct remote_list *remote_list; + bool remote_random; + const char *ipchange; + bool bind_local; + const char *dev; + const char *dev_type; + const char *dev_node; + const char *ifconfig_local; + const char *ifconfig_remote_netmask; + bool ifconfig_noexec; + bool ifconfig_nowarn; +#ifdef HAVE_GETTIMEOFDAY + int shaper; +#endif + int tun_mtu; /* MTU of tun device */ + int tun_mtu_extra; + bool tun_mtu_extra_defined; + int link_mtu; /* MTU of device over which tunnel packets pass via TCP/UDP */ + bool tun_mtu_defined; /* true if user overriding parm with command line option */ + bool link_mtu_defined; /* true if user overriding parm with command line option */ + + /* Protocol type (PROTO_UDP or PROTO_TCP) */ + int proto; + int connect_retry_seconds; + bool connect_retry_defined; + + /* Advanced MTU negotiation and datagram fragmentation options */ + int mtu_discover_type; /* used if OS supports setting Path MTU discovery options on socket */ + +#ifdef ENABLE_OCC + bool mtu_test; +#endif + + int fragment; /* internal fragmentation size */ + + bool mlock; + + int keepalive_ping; /* a proxy for ping/ping-restart */ + int keepalive_timeout; + + int inactivity_timeout; + int ping_send_timeout; /* Send a TCP/UDP ping to remote every n seconds */ + int ping_rec_timeout; /* Expect a TCP/UDP ping from remote at least once every n seconds */ + bool ping_timer_remote; /* Run ping timer only if we have a remote address */ + bool tun_ipv6; /* Build tun dev that supports IPv6 */ + +# define PING_UNDEF 0 +# define PING_EXIT 1 +# define PING_RESTART 2 + int ping_rec_timeout_action; /* What action to take on ping_rec_timeout (exit or restart)? */ + +#ifdef ENABLE_OCC + int explicit_exit_notification; /* Explicitly tell peer when we are exiting via OCC_EXIT message */ +#endif + + bool persist_tun; /* Don't close/reopen TUN/TAP dev on SIGUSR1 or PING_RESTART */ + bool persist_local_ip; /* Don't re-resolve local address on SIGUSR1 or PING_RESTART */ + bool persist_remote_ip; /* Don't re-resolve remote address on SIGUSR1 or PING_RESTART */ + bool persist_key; /* Don't re-read key files on SIGUSR1 or PING_RESTART */ + + int mssfix; /* Upper bound on TCP MSS */ + bool mssfix_default; /* true if --mssfix was supplied without a parameter */ + +#if PASSTOS_CAPABILITY + bool passtos; +#endif + + int resolve_retry_seconds; /* If hostname resolve fails, retry for n seconds */ + + struct tuntap_options tuntap_options; + + /* Misc parms */ + const char *username; + const char *groupname; + const char *chroot_dir; + const char *cd_dir; + const char *writepid; + const char *up_script; + const char *down_script; + bool down_pre; + bool up_delay; + bool up_restart; + bool daemon; + + int remap_sigusr1; + + /* inetd modes defined in socket.h */ + int inetd; + + bool log; + bool suppress_timestamps; + int nice; + int verbosity; + int mute; + +#ifdef ENABLE_DEBUG + int gremlin; +#endif + + const char *status_file; + int status_file_version; + int status_file_update_freq; + + /* optimize TUN/TAP/UDP writes */ + bool fast_io; + +#ifdef USE_LZO + bool comp_lzo; + bool comp_lzo_adaptive; +#endif + + /* buffer sizes */ + int rcvbuf; + int sndbuf; + + /* route management */ + const char *route_script; + const char *route_default_gateway; + bool route_noexec; + int route_delay; + int route_delay_window; + bool route_delay_defined; + struct route_option_list *routes; + +#ifdef ENABLE_HTTP_PROXY + struct http_proxy_options *http_proxy_options; +#endif + +#ifdef ENABLE_SOCKS + /* socks proxy */ + const char *socks_proxy_server; + int socks_proxy_port; + bool socks_proxy_retry; +#endif + +#ifdef ENABLE_OCC + /* Enable options consistency check between peers */ + bool occ; +#endif + +#ifdef ENABLE_MANAGEMENT + const char *management_addr; + int management_port; + const char *management_user_pass; + int management_log_history_cache; + int management_echo_buffer_size; + int management_state_buffer_size; + bool management_query_passwords; + bool management_hold; +#endif + +#ifdef ENABLE_PLUGIN + struct plugin_option_list *plugin_list; +#endif + +#ifdef USE_PTHREAD + int n_threads; + int nice_work; +#endif + +#if P2MP + +#if P2MP_SERVER + bool server_defined; + in_addr_t server_network; + in_addr_t server_netmask; + + bool server_bridge_defined; + in_addr_t server_bridge_ip; + in_addr_t server_bridge_netmask; + in_addr_t server_bridge_pool_start; + in_addr_t server_bridge_pool_end; + + struct push_list *push_list; + bool ifconfig_pool_defined; + in_addr_t ifconfig_pool_start; + in_addr_t ifconfig_pool_end; + in_addr_t ifconfig_pool_netmask; + const char *ifconfig_pool_persist_filename; + int ifconfig_pool_persist_refresh_freq; + bool ifconfig_pool_linear; + int real_hash_size; + int virtual_hash_size; + const char *client_connect_script; + const char *client_disconnect_script; + const char *learn_address_script; + const char *tmp_dir; + const char *client_config_dir; + bool ccd_exclusive; + bool disable; + int n_bcast_buf; + int tcp_queue_limit; + struct iroute *iroutes; + bool push_ifconfig_defined; + in_addr_t push_ifconfig_local; + in_addr_t push_ifconfig_remote_netmask; + bool enable_c2c; + bool duplicate_cn; + int cf_max; + int cf_per; + int max_clients; + int max_routes_per_client; + + bool client_cert_not_required; + bool username_as_common_name; + const char *auth_user_pass_verify_script; + bool auth_user_pass_verify_script_via_file; +#endif + + bool client; + bool pull; /* client pull of config options from server */ + const char *auth_user_pass_file; + struct options_pre_pull *pre_pull; + + int scheduled_exit_interval; + +#endif + +#ifdef USE_CRYPTO + /* Cipher parms */ + const char *shared_secret_file; + int key_direction; + bool ciphername_defined; + const char *ciphername; + bool authname_defined; + const char *authname; + int keysize; + const char *engine; + bool replay; + bool mute_replay_warnings; + int replay_window; + int replay_time; + const char *packet_id_file; + bool use_iv; + bool test_crypto; + +#ifdef USE_SSL + /* TLS (control channel) parms */ + bool tls_server; + bool tls_client; + const char *ca_file; + const char *dh_file; + const char *cert_file; + const char *priv_key_file; + const char *pkcs12_file; + const char *cipher_list; + const char *tls_verify; + const char *tls_remote; + const char *crl_file; + int ns_cert_type; /* set to 0, NS_SSL_SERVER, or NS_SSL_CLIENT */ +#ifdef WIN32 + const char *cryptoapi_cert; +#endif + + /* data channel key exchange method */ + int key_method; + + /* Per-packet timeout on control channel */ + int tls_timeout; + + /* Data channel key renegotiation parameters */ + int renegotiate_bytes; + int renegotiate_packets; + int renegotiate_seconds; + + /* Data channel key handshake must finalize + within n seconds of handshake initiation. */ + int handshake_window; + + /* Old key allowed to live n seconds after new key goes active */ + int transition_window; + + /* Special authentication MAC for TLS control channel */ + const char *tls_auth_file; /* shared secret */ + + /* Allow only one session */ + bool single_session; + + bool tls_exit; + +#endif /* USE_SSL */ +#endif /* USE_CRYPTO */ + + /* special state parms */ + int foreign_option_index; + +#ifdef WIN32 + const char *exit_event_name; + bool exit_event_initial_state; + bool show_net_up; + int route_method; +#endif +}; + +#define streq(x, y) (!strcmp((x), (y))) + +/* + * Option classes. + */ +#define OPT_P_GENERAL (1<<0) +#define OPT_P_UP (1<<1) +#define OPT_P_ROUTE (1<<2) +#define OPT_P_IPWIN32 (1<<3) +#define OPT_P_SCRIPT (1<<4) +#define OPT_P_SETENV (1<<5) +#define OPT_P_SHAPER (1<<6) +#define OPT_P_TIMER (1<<7) +#define OPT_P_PERSIST (1<<8) +#define OPT_P_PERSIST_IP (1<<9) +#define OPT_P_COMP (1<<10) /* TODO */ +#define OPT_P_MESSAGES (1<<11) +#define OPT_P_CRYPTO (1<<12) /* TODO */ +#define OPT_P_TLS_PARMS (1<<13) /* TODO */ +#define OPT_P_MTU (1<<14) /* TODO */ +#define OPT_P_NICE (1<<15) +#define OPT_P_PUSH (1<<16) +#define OPT_P_INSTANCE (1<<17) +#define OPT_P_CONFIG (1<<18) +#define OPT_P_EXPLICIT_NOTIFY (1<<19) +#define OPT_P_ECHO (1<<20) +#define OPT_P_INHERIT (1<<21) + +#define OPT_P_DEFAULT (~OPT_P_INSTANCE) + +#if P2MP +#define PULL_DEFINED(opt) ((opt)->pull) +#if P2MP_SERVER +#define PUSH_DEFINED(opt) ((opt)->push_list) +#endif +#endif + +#ifndef PULL_DEFINED +#define PULL_DEFINED(opt) (false) +#endif + +#ifndef PUSH_DEFINED +#define PUSH_DEFINED(opt) (false) +#endif + +#ifdef WIN32 +#define ROUTE_OPTION_FLAGS(o) ((o)->route_method & ROUTE_METHOD_MASK) +#else +#define ROUTE_OPTION_FLAGS(o) (0) +#endif + +#ifdef HAVE_GETTIMEOFDAY +#define SHAPER_DEFINED(opt) ((opt)->shaper) +#else +#define SHAPER_DEFINED(opt) (false) +#endif + +#ifdef ENABLE_PLUGIN +#define PLUGIN_OPTION_LIST(opt) ((opt)->plugin_list) +#else +#define PLUGIN_OPTION_LIST(opt) (NULL) +#endif + +void parse_argv (struct options *options, + const int argc, + char *argv[], + const int msglevel, + const unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es); + +void notnull (const char *arg, const char *description); + +void usage_small (void); + +void init_options (struct options *o); +void uninit_options (struct options *o); + +void setenv_settings (struct env_set *es, const struct options *o); +void show_settings (const struct options *o); + +bool string_defined_equal (const char *s1, const char *s2); + +#ifdef ENABLE_OCC + +const char *options_string_version (const char* s, struct gc_arena *gc); + +char *options_string (const struct options *o, + const struct frame *frame, + struct tuntap *tt, + bool remote, + struct gc_arena *gc); + +int options_cmp_equal_safe (char *actual, const char *expected, size_t actual_n); +void options_warning_safe (char *actual, const char *expected, size_t actual_n); +int options_cmp_equal (char *actual, const char *expected); +void options_warning (char *actual, const char *expected); + +#endif + +void options_postprocess (struct options *options, bool first_time); + +void pre_pull_save (struct options *o); +void pre_pull_restore (struct options *o); + +bool apply_push_options (struct options *options, + struct buffer *buf, + unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es); + +bool is_persist_option (const struct options *o); +bool is_stateful_restart (const struct options *o); + +void options_detach (struct options *o); + +void options_server_import (struct options *o, + const char *filename, + int msglevel, + unsigned int permission_mask, + unsigned int *option_types_found, + struct env_set *es); + +void pre_pull_default (struct options *o); + +void rol_check_alloc (struct options *options); + +int parse_line (const char *line, + char *p[], + const int n, + const char *file, + const int line_num, + int msglevel, + struct gc_arena *gc); + +/* + * Manage auth-retry variable + */ + +#if P2MP + +#define AR_NONE 0 +#define AR_INTERACT 1 +#define AR_NOINTERACT 2 + +int auth_retry_get (void); +bool auth_retry_set (const int msglevel, const char *option); +const char *auth_retry_print (void); + +#endif + +#endif @@ -0,0 +1,198 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "otime.h" + +#include "memdbg.h" + +volatile time_t now; /* GLOBAL */ + +/* + * Return a numerical string describing a struct timeval. + */ +const char * +tv_string (const struct timeval *tv, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + buf_printf (&out, "[%d/%d]", + (int) tv->tv_sec, + (int )tv->tv_usec); + return BSTR (&out); +} + +/* + * Return an ascii string describing an absolute + * date/time in a struct timeval. + * + */ +const char * +tv_string_abs (const struct timeval *tv, struct gc_arena *gc) +{ + return time_string ((time_t) tv->tv_sec, + (int) tv->tv_usec, + true, + gc); +} + +/* format a time_t as ascii, or use current time if 0 */ + +const char * +time_string (time_t t, int usec, bool show_usec, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + struct timeval tv; + + if (t) + { + tv.tv_sec = t; + tv.tv_usec = usec; + } + else + { +#ifdef HAVE_GETTIMEOFDAY + if (gettimeofday (&tv, NULL)) +#endif + { + tv.tv_sec = time (NULL); + tv.tv_usec = 0; + } + } + + mutex_lock_static (L_CTIME); + buf_printf (&out, "%s", ctime ((const time_t *)&tv.tv_sec)); + mutex_unlock_static (L_CTIME); + buf_rmtail (&out, '\n'); + + if (show_usec && tv.tv_usec) + buf_printf (&out, " us=%d", (int)tv.tv_usec); + + return BSTR (&out); +} + +/* + * Limit the frequency of an event stream. + * + * Used to control maximum rate of new + * incoming connections. + */ + +struct frequency_limit * +frequency_limit_init (int max, int per) +{ + struct frequency_limit *f; + + ASSERT (max >= 0 && per >= 0); + + ALLOC_OBJ (f, struct frequency_limit); + f->max = max; + f->per = per; + f->n = 0; + f->reset = 0; + return f; +} + +void +frequency_limit_free (struct frequency_limit *f) +{ + free (f); +} + +bool +frequency_limit_event_allowed (struct frequency_limit *f) +{ + if (f->per) + { + bool ret; + if (now >= f->reset + f->per) + { + f->reset = now; + f->n = 0; + } + ret = (++f->n <= f->max); + return ret; + } + else + return true; +} + +#ifdef WIN32 + +static double counterPerMicrosecond = -1.0; /* GLOBAL */ +static unsigned __int64 frequency = 0; /* GLOBAL */ +static unsigned __int64 timeSecOffset = 0; /* GLOBAL */ +static unsigned __int64 startPerformanceCounter = 0; /* GLOBAL */ + +/* + * gettimeofday for windows + * + * CounterPerMicrosecond is the number of counts per microsecond. + * Double is required if we have less than 1 counter per microsecond. This has not been tested. + * On a PIII 700, I get about 3.579545. This is guaranteed not to change while the processor is running. + * We really don't need to check for loop detection. On my machine it would take about 59645564 days to loop. + * (2^64) / frequency / 60 / 60 / 24. + * + */ +int +gettimeofday(struct timeval *tv, void *tz) +{ + unsigned __int64 counter; + + QueryPerformanceCounter((LARGE_INTEGER *) &counter); + + if (counter < startPerformanceCounter || counterPerMicrosecond == -1.0) + { + time_t t; + mutex_lock (L_GETTIMEOFDAY); + + QueryPerformanceFrequency((LARGE_INTEGER *) &frequency); + + counterPerMicrosecond = (double) ((__int64) frequency) / 1000000.0f; + + time(&t); + QueryPerformanceCounter((LARGE_INTEGER *) &counter); + startPerformanceCounter = counter; + + counter /= frequency; + + timeSecOffset = t - counter; + + mutex_unlock (L_GETTIMEOFDAY); + QueryPerformanceCounter((LARGE_INTEGER *) &counter); + } + + tv->tv_sec = (counter / frequency) + timeSecOffset; + tv->tv_usec = ((__int64) (((__int64) counter) / counterPerMicrosecond) % 1000000); + + return 0; +} + +#endif /* WIN32 */ @@ -0,0 +1,206 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef OTIME_H +#define OTIME_H + +#include "common.h" +#include "integer.h" +#include "buffer.h" +#include "thread.h" + +struct frequency_limit +{ + int max; + int per; + int n; + time_t reset; +}; + +struct frequency_limit *frequency_limit_init (int max, int per); +void frequency_limit_free (struct frequency_limit *f); +bool frequency_limit_event_allowed (struct frequency_limit *f); + +#ifdef WIN32 +int gettimeofday(struct timeval *tv, void *tz); +#endif + +/* format a time_t as ascii, or use current time if 0 */ +const char* time_string (time_t t, int usec, bool show_usec, struct gc_arena *gc); + +/* struct timeval functions */ + +const char *tv_string (const struct timeval *tv, struct gc_arena *gc); +const char *tv_string_abs (const struct timeval *tv, struct gc_arena *gc); + +extern volatile time_t now; /* updated frequently to time(NULL) */ + +static inline void +update_time (void) +{ + const time_t real_time = time (NULL); + if (real_time != now) + now = real_time; +} + +static inline void +tv_clear (struct timeval *tv) +{ + tv->tv_sec = 0; + tv->tv_usec = 0; +} + +static inline bool +tv_defined (const struct timeval *tv) +{ + return tv->tv_sec > 0 && tv->tv_usec > 0; +} + +/* return tv1 - tv2 in usec, constrained by max_seconds */ +static inline int +tv_subtract (const struct timeval *tv1, const struct timeval *tv2, const unsigned int max_seconds) +{ + const int max_usec = max_seconds * 1000000; + const int sec_diff = tv1->tv_sec - tv2->tv_sec; + + if (sec_diff > ((int)max_seconds + 10)) + return max_usec; + else if (sec_diff < -((int)max_seconds + 10)) + return -max_usec; + return constrain_int (sec_diff * 1000000 + (tv1->tv_usec - tv2->tv_usec), -max_usec, max_usec); +} + +static inline void +tv_add (struct timeval *dest, const struct timeval *src) +{ + dest->tv_sec += src->tv_sec; + dest->tv_usec += src->tv_usec; + dest->tv_sec += (dest->tv_usec >> 20); + dest->tv_usec &= 0x000FFFFF; + if (dest->tv_usec >= 1000000) + { + dest->tv_usec -= 1000000; + dest->tv_sec += 1; + } +} + +static inline bool +tv_lt (const struct timeval *t1, const struct timeval *t2) +{ + if (t1->tv_sec < t2->tv_sec) + return true; + else if (t1->tv_sec > t2->tv_sec) + return false; + else + return t1->tv_usec < t2->tv_usec; +} + +static inline bool +tv_le (const struct timeval *t1, const struct timeval *t2) +{ + if (t1->tv_sec < t2->tv_sec) + return true; + else if (t1->tv_sec > t2->tv_sec) + return false; + else + return t1->tv_usec <= t2->tv_usec; +} + +static inline bool +tv_ge (const struct timeval *t1, const struct timeval *t2) +{ + if (t1->tv_sec > t2->tv_sec) + return true; + else if (t1->tv_sec < t2->tv_sec) + return false; + else + return t1->tv_usec >= t2->tv_usec; +} + +static inline bool +tv_gt (const struct timeval *t1, const struct timeval *t2) +{ + if (t1->tv_sec > t2->tv_sec) + return true; + else if (t1->tv_sec < t2->tv_sec) + return false; + else + return t1->tv_usec > t2->tv_usec; +} + +static inline bool +tv_eq (const struct timeval *t1, const struct timeval *t2) +{ + return t1->tv_sec == t2->tv_sec && t1->tv_usec == t2->tv_usec; +} + +static inline void +tv_delta (struct timeval *dest, const struct timeval *t1, const struct timeval *t2) +{ + int sec = t2->tv_sec - t1->tv_sec; + int usec = t2->tv_usec - t1->tv_usec; + + while (usec < 0) + { + usec += 1000000; + sec -= 1; + } + + if (sec < 0) + usec = sec = 0; + + dest->tv_sec = sec; + dest->tv_usec = usec; +} + +#define TV_WITHIN_SIGMA_MAX_SEC 600 +#define TV_WITHIN_SIGMA_MAX_USEC (TV_WITHIN_SIGMA_MAX_SEC * 1000000) + +/* + * Is t1 and t2 within sigma microseconds of each other? + */ +static inline bool +tv_within_sigma (const struct timeval *t1, const struct timeval *t2, unsigned int sigma) +{ + const int delta = tv_subtract (t1, t2, TV_WITHIN_SIGMA_MAX_SEC); /* sigma should be less than 10 minutes */ + return -(int)sigma <= delta && delta <= (int)sigma; +} + +/* + * Used to determine in how many seconds we should be + * called again. + */ +static inline void +interval_earliest_wakeup (interval_t *wakeup, time_t at, time_t current) { + if (at > current) + { + const interval_t delta = (interval_t) (at - current); + if (delta < *wakeup) + *wakeup = delta; + if (*wakeup < 0) + *wakeup = 0; + } +} + +#endif diff --git a/packet_id.c b/packet_id.c new file mode 100644 index 0000000..6bc5b6b --- /dev/null +++ b/packet_id.c @@ -0,0 +1,492 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * These routines are designed to catch replay attacks, + * where a man-in-the-middle captures packets and then + * attempts to replay them back later. + * + * We use the "sliding-window" algorithm, similar + * to IPSec. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#ifdef USE_CRYPTO + +#include "syshead.h" + +#include "packet_id.h" +#include "misc.h" +#include "integer.h" + +#include "memdbg.h" + +/* + * Special time_t value that indicates that + * sequence number has expired. + */ +#define SEQ_UNSEEN ((time_t)0) +#define SEQ_EXPIRED ((time_t)1) + +void +packet_id_init (struct packet_id *p, int seq_backtrack, int time_backtrack) +{ + dmsg (D_PID_DEBUG_LOW, "PID packet_id_init seq_backtrack=%d time_backtrack=%d", + seq_backtrack, + time_backtrack); + + ASSERT (p); + CLEAR (*p); + + if (seq_backtrack) + { + ASSERT (MIN_SEQ_BACKTRACK <= seq_backtrack && seq_backtrack <= MAX_SEQ_BACKTRACK); + ASSERT (MIN_TIME_BACKTRACK <= time_backtrack && time_backtrack <= MAX_TIME_BACKTRACK); + CIRC_LIST_ALLOC (p->rec.seq_list, struct seq_list, seq_backtrack); + p->rec.seq_backtrack = seq_backtrack; + p->rec.time_backtrack = time_backtrack; + } + p->rec.initialized = true; +} + +void +packet_id_free (struct packet_id *p) +{ + if (p) + { + dmsg (D_PID_DEBUG_LOW, "PID packet_id_free"); + if (p->rec.seq_list) + free (p->rec.seq_list); + CLEAR (*p); + } +} + +void +packet_id_add (struct packet_id_rec *p, const struct packet_id_net *pin) +{ + const time_t local_now = now; + if (p->seq_list) + { + packet_id_type diff; + + /* + * If time value increases, start a new + * sequence number sequence. + */ + if (!CIRC_LIST_SIZE (p->seq_list) + || pin->time > p->time + || (pin->id >= (packet_id_type)p->seq_backtrack + && pin->id - (packet_id_type)p->seq_backtrack > p->id)) + { + p->time = pin->time; + p->id = 0; + if (pin->id > (packet_id_type)p->seq_backtrack) + p->id = pin->id - (packet_id_type)p->seq_backtrack; + CIRC_LIST_RESET (p->seq_list); + } + + while (p->id < pin->id) + { + CIRC_LIST_PUSH (p->seq_list, SEQ_UNSEEN); + ++p->id; + } + + diff = p->id - pin->id; + if (diff < (packet_id_type) CIRC_LIST_SIZE (p->seq_list) + && local_now > SEQ_EXPIRED) + CIRC_LIST_ITEM (p->seq_list, diff) = local_now; + } + else + { + p->time = pin->time; + p->id = pin->id; + } +} + +/* + * Expire sequence numbers which can no longer + * be accepted because they would violate + * time_backtrack. + */ +void +packet_id_reap (struct packet_id_rec *p) +{ + const time_t local_now = now; + if (p->time_backtrack) + { + int i; + bool expire = false; + for (i = 0; i < CIRC_LIST_SIZE (p->seq_list); ++i) + { + const time_t t = CIRC_LIST_ITEM (p->seq_list, i); + if (t == SEQ_EXPIRED) + break; + if (!expire && t && t + p->time_backtrack < local_now) + expire = true; + if (expire) + CIRC_LIST_ITEM (p->seq_list, i) = SEQ_EXPIRED; + } + } + p->last_reap = local_now; +} + +/* + * Return true if packet id is ok, or false if + * it is a replay. + */ +bool +packet_id_test (const struct packet_id_rec *p, + const struct packet_id_net *pin) +{ + static int max_backtrack_stat; + packet_id_type diff; + + dmsg (D_PID_DEBUG, + "PID TEST " time_format ":" packet_id_format " " time_format ":" packet_id_format "", + (time_type)p->time, (packet_id_print_type)p->id, (time_type)pin->time, + (packet_id_print_type)pin->id); + + ASSERT (p->initialized); + + if (!pin->id) + return false; + + if (p->seq_backtrack) + { + /* + * In backtrack mode, we allow packet reordering subject + * to the seq_backtrack and time_backtrack constraints. + * + * This mode is used with UDP. + */ + if (pin->time == p->time) + { + /* is packet-id greater than any one we've seen yet? */ + if (pin->id > p->id) + return true; + + /* check packet-id sliding window for original/replay status */ + diff = p->id - pin->id; + + /* keep track of maximum backtrack seen for debugging purposes */ + if ((int)diff > max_backtrack_stat) + { + max_backtrack_stat = (int)diff; + msg (D_BACKTRACK, "Replay-window backtrack occurred [%d]", max_backtrack_stat); + } + + if (diff >= (packet_id_type) CIRC_LIST_SIZE (p->seq_list)) + return false; + + return CIRC_LIST_ITEM (p->seq_list, diff) == 0; + } + else if (pin->time < p->time) /* if time goes back, reject */ + return false; + else /* time moved forward */ + return true; + } + else + { + /* + * In non-backtrack mode, all sequence number series must + * begin at 1 and must increment linearly without gaps. + * + * This mode is used with TCP. + */ + if (pin->time == p->time) + return pin->id == p->id + 1; + else if (pin->time < p->time) /* if time goes back, reject */ + return false; + else /* time moved forward */ + return pin->id == 1; + } +} + +/* + * Read/write a packet ID to/from the buffer. Short form is sequence number + * only. Long form is sequence number and timestamp. + */ + +bool +packet_id_read (struct packet_id_net *pin, struct buffer *buf, bool long_form) +{ + packet_id_type net_id; + net_time_t net_time; + + pin->id = 0; + pin->time = 0; + + if (!buf_read (buf, &net_id, sizeof (net_id))) + return false; + pin->id = ntohpid (net_id); + if (long_form) + { + if (!buf_read (buf, &net_time, sizeof (net_time))) + return false; + pin->time = ntohtime (net_time); + } + return true; +} + +bool +packet_id_write (const struct packet_id_net *pin, struct buffer *buf, bool long_form, bool prepend) +{ + packet_id_type net_id = htonpid (pin->id); + net_time_t net_time = htontime (pin->time); + + if (prepend) + { + if (long_form) + { + if (!buf_write_prepend (buf, &net_time, sizeof (net_time))) + return false; + } + if (!buf_write_prepend (buf, &net_id, sizeof (net_id))) + return false; + } + else + { + if (!buf_write (buf, &net_id, sizeof (net_id))) + return false; + if (long_form) + { + if (!buf_write (buf, &net_time, sizeof (net_time))) + return false; + } + } + return true; +} + +const char * +packet_id_net_print (const struct packet_id_net *pin, bool print_timestamp, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + + buf_printf (&out, "[ #" packet_id_format, (packet_id_print_type)pin->id); + if (print_timestamp && pin->time) + buf_printf (&out, " / time = (" packet_id_format ") %s", + (packet_id_print_type)pin->time, + time_string (pin->time, 0, false, gc)); + + buf_printf (&out, " ]"); + return BSTR (&out); +} + +/* initialize the packet_id_persist structure in a disabled state */ +void +packet_id_persist_init (struct packet_id_persist *p) +{ + p->filename = NULL; + p->fd = -1; + p->time = p->time_last_written = 0; + p->id = p->id_last_written = 0; +} + +/* close the file descriptor if it is open, and switch to disabled state */ +void +packet_id_persist_close (struct packet_id_persist *p) +{ + if (packet_id_persist_enabled (p)) + { + if (close (p->fd)) + msg (D_PID_PERSIST | M_ERRNO, "Close error on --replay-persist file %s", p->filename); + packet_id_persist_init (p); + } +} + +/* load persisted rec packet_id (time and id) only once from file, and set state to enabled */ +void +packet_id_persist_load (struct packet_id_persist *p, const char *filename) +{ + struct gc_arena gc = gc_new (); + if (!packet_id_persist_enabled (p)) + { + /* open packet-id persist file for both read and write */ + p->fd = open (filename, + O_CREAT | O_RDWR | O_BINARY, + S_IRUSR | S_IWUSR); + if (p->fd == -1) + { + msg (D_PID_PERSIST | M_ERRNO, + "Cannot open --replay-persist file %s for read/write", + filename); + } + else + { + struct packet_id_persist_file_image image; + ssize_t n; + +#if defined(HAVE_FLOCK) && defined(LOCK_EX) && defined(LOCK_NB) + if (flock (p->fd, LOCK_EX | LOCK_NB)) + msg (M_ERR, "Cannot obtain exclusive lock on --replay-persist file %s", filename); +#endif + + p->filename = filename; + n = read (p->fd, &image, sizeof(image)); + if (n == sizeof(image)) + { + p->time = p->time_last_written = image.time; + p->id = p->id_last_written = image.id; + dmsg (D_PID_PERSIST_DEBUG, "PID Persist Read from %s: %s", + p->filename, packet_id_persist_print (p, &gc)); + } + else if (n == -1) + { + msg (D_PID_PERSIST | M_ERRNO, + "Read error on --replay-persist file %s", + p->filename); + } + } + } + gc_free (&gc); +} + +/* save persisted rec packet_id (time and id) to file (only if enabled state) */ +void +packet_id_persist_save (struct packet_id_persist *p) +{ + if (packet_id_persist_enabled (p) && p->time && (p->time != p->time_last_written || + p->id != p->id_last_written)) + { + struct packet_id_persist_file_image image; + ssize_t n; + off_t seek_ret; + struct gc_arena gc = gc_new (); + + image.time = p->time; + image.id = p->id; + seek_ret = lseek(p->fd, (off_t)0, SEEK_SET); + if (seek_ret == (off_t)0) + { + n = write(p->fd, &image, sizeof(image)); + if (n == sizeof(image)) + { + p->time_last_written = p->time; + p->id_last_written = p->id; + dmsg (D_PID_PERSIST_DEBUG, "PID Persist Write to %s: %s", + p->filename, packet_id_persist_print (p, &gc)); + } + else + { + msg (D_PID_PERSIST | M_ERRNO, + "Cannot write to --replay-persist file %s", + p->filename); + } + } + else + { + msg (D_PID_PERSIST | M_ERRNO, + "Cannot seek to beginning of --replay-persist file %s", + p->filename); + } + gc_free (&gc); + } +} + +/* transfer packet_id_persist -> packet_id */ +void +packet_id_persist_load_obj (const struct packet_id_persist *p, struct packet_id *pid) +{ + if (p && pid && packet_id_persist_enabled (p) && p->time) + { + pid->rec.time = p->time; + pid->rec.id = p->id; + } +} + +const char * +packet_id_persist_print (const struct packet_id_persist *p, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + + buf_printf (&out, "["); + + if (packet_id_persist_enabled (p)) + { + buf_printf (&out, " #" packet_id_format, (packet_id_print_type)p->id); + if (p->time) + buf_printf (&out, " / time = (" packet_id_format ") %s", + (packet_id_print_type)p->time, + time_string (p->time, 0, false, gc)); + } + + buf_printf (&out, " ]"); + return (char *)out.data; +} + +#ifdef PID_TEST + +void +packet_id_interactive_test () +{ + struct packet_id pid; + struct packet_id_net pin; + bool long_form; + bool count = 0; + bool test; + + const int seq_backtrack = 10; + const int time_backtrack = 10; + + packet_id_init (&pid, seq_backtrack, time_backtrack); + + while (true) { + char buf[80]; + if (!fgets(buf, sizeof(buf), stdin)) + break; + update_time (); + if (sscanf (buf, "%lu,%u", &pin.time, &pin.id) == 2) + { + packet_id_reap_test (&pid.rec); + test = packet_id_test (&pid.rec, &pin); + printf ("packet_id_test (" time_format ", " packet_id_format ") returned %d\n", + (time_type)pin.time, + (packet_id_print_type)pin.id, + test); + if (test) + packet_id_add (&pid.rec, &pin); + } + else + { + long_form = (count < 20); + packet_id_alloc_outgoing (&pid.send, &pin, long_form); + printf ("(" time_format "(" packet_id_format "), %d)\n", + (time_type)pin.time, + (packet_id_print_type)pin.id, + long_form); + if (pid.send.id == 10) + pid.send.id = 0xFFFFFFF8; + ++count; + } + } + packet_id_free (&pid); +} +#endif + +#endif /* USE_CRYPTO */ diff --git a/packet_id.h b/packet_id.h new file mode 100644 index 0000000..d35d8bc --- /dev/null +++ b/packet_id.h @@ -0,0 +1,335 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * These routines are designed to catch replay attacks, + * where a man-in-the-middle captures packets and then + * attempts to replay them back later. + */ + +#ifdef USE_CRYPTO + +#ifndef PACKET_ID_H +#define PACKET_ID_H + +#include "circ_list.h" +#include "buffer.h" +#include "error.h" +#include "otime.h" + +/* + * Enables OpenVPN to be compiled in special packet_id test mode. + */ +/*#define PID_TEST*/ + +#if 1 +/* + * These are the types that members of + * a struct packet_id_net are converted + * to for network transmission. + */ +typedef uint32_t packet_id_type; +typedef uint32_t net_time_t; + +/* + * In TLS mode, when a packet ID gets to this level, + * start thinking about triggering a new + * SSL/TLS handshake. + */ +#define PACKET_ID_WRAP_TRIGGER 0xFF000000 + +/* convert a packet_id_type from host to network order */ +#define htonpid(x) htonl(x) + +/* convert a packet_id_type from network to host order */ +#define ntohpid(x) ntohl(x) + +/* convert a time_t in host order to a net_time_t in network order */ +#define htontime(x) htonl((net_time_t)x) + +/* convert a net_time_t in network order to a time_t in host order */ +#define ntohtime(x) ((time_t)ntohl(x)) + +#else + +/* + * DEBUGGING ONLY. + * Make packet_id_type and net_time_t small + * to test wraparound logic and corner cases. + */ + +typedef uint8_t packet_id_type; +typedef uint16_t net_time_t; + +#define PACKET_ID_WRAP_TRIGGER 0x80 + +#define htonpid(x) (x) +#define ntohpid(x) (x) +#define htontime(x) htons((net_time_t)x) +#define ntohtime(x) ((time_t)ntohs(x)) + +#endif + +/* + * Printf formats for special types + */ +#define packet_id_format "%u" +typedef unsigned int packet_id_print_type; + +/* + * Maximum allowed backtrack in + * sequence number due to packets arriving + * out of order. + */ +#define MIN_SEQ_BACKTRACK 0 +#define MAX_SEQ_BACKTRACK 65536 +#define DEFAULT_SEQ_BACKTRACK 64 + +/* + * Maximum allowed backtrack in + * seconds due to packets arriving + * out of order. + */ +#define MIN_TIME_BACKTRACK 0 +#define MAX_TIME_BACKTRACK 600 +#define DEFAULT_TIME_BACKTRACK 15 + +/* + * Do a reap pass through the sequence number + * array once every n seconds in order to + * expire sequence numbers which can no longer + * be accepted because they would violate + * TIME_BACKTRACK. + */ +#define SEQ_REAP_INTERVAL 5 + +CIRC_LIST (seq_list, time_t); + +/* + * This is the data structure we keep on the receiving side, + * to check that no packet-id (i.e. sequence number + optional timestamp) + * is accepted more than once. + */ +struct packet_id_rec +{ + time_t last_reap; /* last call of packet_id_reap */ + time_t time; /* highest time stamp received */ + packet_id_type id; /* highest sequence number received */ + int seq_backtrack; /* set from --replay-window */ + int time_backtrack; /* set from --replay-window */ + bool initialized; /* true if packet_id_init was called */ + struct seq_list *seq_list; /* packet-id "memory" */ +}; + +/* + * file to facilitate cross-session persistence + * of time/id + */ +struct packet_id_persist +{ + const char *filename; + int fd; + time_t time; /* time stamp */ + packet_id_type id; /* sequence number */ + time_t time_last_written; + packet_id_type id_last_written; +}; + +struct packet_id_persist_file_image +{ + time_t time; /* time stamp */ + packet_id_type id; /* sequence number */ +}; + +/* + * Keep a record of our current packet-id state + * on the sending side. + */ +struct packet_id_send +{ + packet_id_type id; + time_t time; +}; + +/* + * Communicate packet-id over the wire. + * A short packet-id is just a 32 bit + * sequence number. A long packet-id + * includes a timestamp as well. + * + * Long packet-ids are used as IVs for + * CFB/OFB ciphers. + * + * This data structure is always sent + * over the net in network byte order, + * by calling htonpid, ntohpid, + * htontime, and ntohtime on the + * data elements to change them + * to and from standard sizes. + * + * In addition, time is converted to + * a net_time_t before sending, + * since openvpn always + * uses a 32-bit time_t but some + * 64 bit platforms use a + * 64 bit time_t. + */ +struct packet_id_net +{ + packet_id_type id; + time_t time; /* converted to net_time_t before transmission */ +}; + +struct packet_id +{ + struct packet_id_send send; + struct packet_id_rec rec; +}; + +void packet_id_init (struct packet_id *p, int seq_backtrack, int time_backtrack); +void packet_id_free (struct packet_id *p); + +/* should we accept an incoming packet id ? */ +bool packet_id_test (const struct packet_id_rec *p, + const struct packet_id_net *pin); + +/* change our current state to reflect an accepted packet id */ +void packet_id_add (struct packet_id_rec *p, + const struct packet_id_net *pin); + +/* expire TIME_BACKTRACK sequence numbers */ +void packet_id_reap (struct packet_id_rec *p); + +/* + * packet ID persistence + */ + +/* initialize the packet_id_persist structure in a disabled state */ +void packet_id_persist_init (struct packet_id_persist *p); + +/* close the file descriptor if it is open, and switch to disabled state */ +void packet_id_persist_close (struct packet_id_persist *p); + +/* load persisted rec packet_id (time and id) only once from file, and set state to enabled */ +void packet_id_persist_load (struct packet_id_persist *p, const char *filename); + +/* save persisted rec packet_id (time and id) to file (only if enabled state) */ +void packet_id_persist_save (struct packet_id_persist *p); + +/* transfer packet_id_persist -> packet_id */ +void packet_id_persist_load_obj (const struct packet_id_persist *p, struct packet_id* pid); + +/* return an ascii string representing a packet_id_persist object */ +const char *packet_id_persist_print (const struct packet_id_persist *p, struct gc_arena *gc); + +/* + * Read/write a packet ID to/from the buffer. Short form is sequence number + * only. Long form is sequence number and timestamp. + */ + +bool packet_id_read (struct packet_id_net *pin, struct buffer *buf, bool long_form); +bool packet_id_write (const struct packet_id_net *pin, struct buffer *buf, bool long_form, bool prepend); + +/* + * Inline functions. + */ + +/* are we in enabled state? */ +static inline bool +packet_id_persist_enabled (const struct packet_id_persist *p) +{ + return p->fd >= 0; +} + +/* transfer packet_id -> packet_id_persist */ +static inline void +packet_id_persist_save_obj (struct packet_id_persist *p, const struct packet_id* pid) +{ + if (packet_id_persist_enabled (p) && pid->rec.time) + { + p->time = pid->rec.time; + p->id = pid->rec.id; + } +} + +const char* packet_id_net_print(const struct packet_id_net *pin, bool print_timestamp, struct gc_arena *gc); + +#ifdef PID_TEST +void packet_id_interactive_test(); +#endif + +static inline int +packet_id_size (bool long_form) +{ + return sizeof (packet_id_type) + (long_form ? sizeof (net_time_t) : 0); +} + +static inline bool +packet_id_close_to_wrapping (const struct packet_id_send *p) +{ + return p->id >= PACKET_ID_WRAP_TRIGGER; +} + +/* + * Allocate an outgoing packet id. + * Sequence number ranges from 1 to 2^32-1. + * In long_form, a time_t is added as well. + */ +static inline void +packet_id_alloc_outgoing (struct packet_id_send *p, struct packet_id_net *pin, bool long_form) +{ + if (!p->time) + p->time = now; + pin->id = ++p->id; + if (!pin->id) + { + ASSERT (long_form); + p->time = now; + pin->id = p->id = 1; + } + pin->time = p->time; +} + +static inline bool +check_timestamp_delta (time_t remote, unsigned int max_delta) +{ + unsigned int abs; + const time_t local_now = now; + + if (local_now >= remote) + abs = local_now - remote; + else + abs = remote - local_now; + return abs <= max_delta; +} + +static inline void +packet_id_reap_test (struct packet_id_rec *p) +{ + if (p->last_reap + SEQ_REAP_INTERVAL <= now) + packet_id_reap (p); +} + +#endif /* PACKET_ID_H */ +#endif /* USE_CRYPTO */ @@ -0,0 +1,301 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "perf.h" + +#ifdef ENABLE_PERFORMANCE_METRICS + +#include "error.h" +#include "otime.h" + +#include "memdbg.h" + +#ifdef USE_PTHREAD +#error ENABLE_PERFORMANCE_METRICS is incompatible with USE_PTHREAD +#endif + +static const char *metric_names[] = { + "PERF_BIO_READ_PLAINTEXT", + "PERF_BIO_WRITE_PLAINTEXT", + "PERF_BIO_READ_CIPHERTEXT", + "PERF_BIO_WRITE_CIPHERTEXT", + "PERF_TLS_MULTI_PROCESS", + "PERF_IO_WAIT", + "PERF_EVENT_LOOP", + "PERF_MULTI_CREATE_INSTANCE", + "PERF_MULTI_CLOSE_INSTANCE", + "PERF_MULTI_SHOW_STATS", + "PERF_MULTI_BCAST", + "PERF_MULTI_MCAST", + "PERF_SCRIPT", + "PERF_READ_IN_LINK", + "PERF_PROC_IN_LINK", + "PERF_READ_IN_TUN", + "PERF_PROC_IN_TUN", + "PERF_PROC_OUT_LINK", + "PERF_PROC_OUT_TUN", + "PERF_PROC_OUT_TUN_MTCP" +}; + +struct perf +{ +# define PS_INITIAL 0 +# define PS_METER_RUNNING 1 +# define PS_METER_INTERRUPTED 2 + int state; + + struct timeval start; + double sofar; + double sum; + double max; + double count; +}; + +struct perf_set +{ + int stack_len; + int stack[STACK_N]; + struct perf perf[PERF_N]; +}; + +static struct perf_set perf_set; + +static void perf_print_state (int lev); + +static inline int +get_stack_index (int sdelta) +{ + const int sindex = perf_set.stack_len + sdelta; + if (sindex >= 0 && sindex < STACK_N) + return sindex; + else + return -1; +} + +static int +get_perf_index (int sdelta) +{ + const int sindex = get_stack_index (sdelta); + if (sindex >= 0) + { + const int pindex = perf_set.stack[sindex]; + if (pindex >= 0 && pindex < PERF_N) + return pindex; + else + return -1; + } + else + return -1; +} + +static struct perf * +get_perf (int sdelta) +{ + const int pindex = get_perf_index (sdelta); + if (pindex >= 0) + return &perf_set.perf[pindex]; + else + return NULL; +} + +static void +push_perf_index (int pindex) +{ + const int sindex = get_stack_index (0); + const int newlen = get_stack_index (1); + if (sindex >= 0 && newlen >= 0 + && pindex >= 0 && pindex < PERF_N) + { + int i; + for (i = 0; i < sindex; ++i) + if (perf_set.stack[i] == pindex) + { + perf_print_state (M_INFO); + msg (M_FATAL, "PERF: push_perf_index %s failed", + metric_names [pindex]); + } + + perf_set.stack[sindex] = pindex; + perf_set.stack_len = newlen; + } + else + msg (M_FATAL, "PERF: push_perf_index: stack push error"); +} + +static void +pop_perf_index (void) +{ + const int newlen = get_stack_index (-1); + if (newlen >= 0) + { + perf_set.stack_len = newlen; + } + else + msg (M_FATAL, "PERF: pop_perf_index: stack pop error"); +} + +static void +state_must_be (const struct perf *p, const int wanted) +{ + if (p->state != wanted) + msg (M_FATAL, "PERF: bad state actual=%d wanted=%d", + p->state, + wanted); +} + +static void +update_sofar (struct perf *p) +{ + struct timeval current; + ASSERT (!gettimeofday (¤t, NULL)); + p->sofar += (double) tv_subtract (¤t, &p->start, 600) / 1000000.0; + tv_clear (&p->start); +} + +static void +perf_start (struct perf *p) +{ + state_must_be (p, PS_INITIAL); + ASSERT (!gettimeofday (&p->start, NULL)); + p->sofar = 0.0; + p->state = PS_METER_RUNNING; +} + +static void +perf_stop (struct perf *p) +{ + state_must_be (p, PS_METER_RUNNING); + update_sofar (p); + p->sum += p->sofar; + if (p->sofar > p->max) + p->max = p->sofar; + p->count += 1.0; + p->sofar = 0.0; + p->state = PS_INITIAL; +} + +static void +perf_interrupt (struct perf *p) +{ + state_must_be (p, PS_METER_RUNNING); + update_sofar (p); + p->state = PS_METER_INTERRUPTED; +} + +static void +perf_resume (struct perf *p) +{ + state_must_be (p, PS_METER_INTERRUPTED); + ASSERT (!gettimeofday (&p->start, NULL)); + p->state = PS_METER_RUNNING; +} + +void +perf_push (int type) +{ + struct perf *prev; + struct perf *cur; + + ASSERT (SIZE(metric_names) == PERF_N); + push_perf_index (type); + + prev = get_perf (-2); + cur = get_perf (-1); + + ASSERT (cur); + + if (prev) + perf_interrupt (prev); + perf_start (cur); +} + +void +perf_pop (void) +{ + struct perf *prev; + struct perf *cur; + + prev = get_perf (-2); + cur = get_perf (-1); + + ASSERT (cur); + perf_stop (cur); + + if (prev) + perf_resume (prev); + + pop_perf_index (); +} + +void +perf_output_results (void) +{ + int i; + msg (M_INFO, "LATENCY PROFILE (mean and max are in milliseconds)"); + for (i = 0; i < PERF_N; ++i) + { + struct perf *p = &perf_set.perf[i]; + if (p->count > 0.0) + { + const double mean = p->sum / p->count; + msg (M_INFO, "%s n=%.0f mean=%.3f max=%.3f", metric_names[i], p->count, mean*1000.0, p->max*1000.0); + } + } +} + +static void +perf_print_state (int lev) +{ + struct gc_arena gc = gc_new (); + int i; + msg (lev, "PERF STATE"); + msg (lev, "Stack:"); + for (i = 0; i < perf_set.stack_len; ++i) + { + const int j = perf_set.stack[i]; + const struct perf *p = &perf_set.perf[j]; + msg (lev, "[%d] %s state=%d start=%s sofar=%f sum=%f max=%f count=%f", + i, + metric_names[j], + p->state, + tv_string (&p->start, &gc), + p->sofar, + p->sum, + p->max, + p->count); + } + gc_free (&gc); +} + +#else +static void dummy(void) {} +#endif @@ -0,0 +1,82 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * The interval_ routines are designed to optimize the calling of a routine + * (normally tls_multi_process()) which can be called less frequently + * between triggers. + */ + +#ifndef PERF_H +#define PERF_H + +/*#define ENABLE_PERFORMANCE_METRICS*/ + +/* + * Metrics + */ +#define PERF_BIO_READ_PLAINTEXT 0 +#define PERF_BIO_WRITE_PLAINTEXT 1 +#define PERF_BIO_READ_CIPHERTEXT 2 +#define PERF_BIO_WRITE_CIPHERTEXT 3 +#define PERF_TLS_MULTI_PROCESS 4 +#define PERF_IO_WAIT 5 +#define PERF_EVENT_LOOP 6 +#define PERF_MULTI_CREATE_INSTANCE 7 +#define PERF_MULTI_CLOSE_INSTANCE 8 +#define PERF_MULTI_SHOW_STATS 9 +#define PERF_MULTI_BCAST 10 +#define PERF_MULTI_MCAST 11 +#define PERF_SCRIPT 12 +#define PERF_READ_IN_LINK 13 +#define PERF_PROC_IN_LINK 14 +#define PERF_READ_IN_TUN 15 +#define PERF_PROC_IN_TUN 16 +#define PERF_PROC_OUT_LINK 17 +#define PERF_PROC_OUT_TUN 18 +#define PERF_PROC_OUT_TUN_MTCP 19 +#define PERF_N 20 + +#ifdef ENABLE_PERFORMANCE_METRICS + +#include "basic.h" + +/* + * Stack size + */ +#define STACK_N 64 + +void perf_push (int type); +void perf_pop (void); +void perf_output_results (void); + +#else + +static inline void perf_push (int type) {} +static inline void perf_pop (void) {} +static inline void perf_output_results (void) {} + +#endif + +#endif diff --git a/ping-inline.h b/ping-inline.h new file mode 100644 index 0000000..bf7fd81 --- /dev/null +++ b/ping-inline.h @@ -0,0 +1,59 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef PING_INLINE_H +#define PING_INLINE_H + +/* + * Should we exit or restart due to ping (or other authenticated packet) + * not received in n seconds? + */ +static inline void +check_ping_restart (struct context *c) +{ + void check_ping_restart_dowork (struct context *c); + if (c->options.ping_rec_timeout + && event_timeout_trigger (&c->c2.ping_rec_interval, + &c->c2.timeval, + (!c->options.ping_timer_remote + || addr_defined (&c->c1.link_socket_addr.actual)) + ? ETT_DEFAULT : 15)) + check_ping_restart_dowork (c); +} + +/* + * Should we ping the remote? + */ +static inline void +check_ping_send (struct context *c) +{ + void check_ping_send_dowork (struct context *c); + if (c->options.ping_send_timeout + && event_timeout_trigger (&c->c2.ping_send_interval, + &c->c2.timeval, + !TO_LINK_DEF(c) ? ETT_DEFAULT : 1)) + check_ping_send_dowork (c); +} + +#endif @@ -0,0 +1,96 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "ping.h" + +#include "memdbg.h" + +#include "ping-inline.h" + +/* + * This random string identifies an OpenVPN ping packet. + * It should be of sufficient length and randomness + * so as not to collide with other tunnel data. + * + * PING_STRING_SIZE must be sizeof (ping_string) + */ +const uint8_t ping_string[] = { + 0x2a, 0x18, 0x7b, 0xf3, 0x64, 0x1e, 0xb4, 0xcb, + 0x07, 0xed, 0x2d, 0x0a, 0x98, 0x1f, 0xc7, 0x48 +}; + +/* + * Should we exit or restart due to ping (or other authenticated packet) + * not received in n seconds? + */ +void +check_ping_restart_dowork (struct context *c) +{ + struct gc_arena gc = gc_new (); + switch (c->options.ping_rec_timeout_action) + { + case PING_EXIT: + msg (M_INFO, "%sInactivity timeout (--ping-exit), exiting", + format_common_name (c, &gc)); + c->sig->signal_received = SIGTERM; + c->sig->signal_text = "ping-exit"; + break; + case PING_RESTART: + msg (M_INFO, "%sInactivity timeout (--ping-restart), restarting", + format_common_name (c, &gc)); + c->sig->signal_received = SIGUSR1; /* SOFT-SIGUSR1 -- Ping Restart */ + c->sig->signal_text = "ping-restart"; + break; + default: + ASSERT (0); + } + gc_free (&gc); +} + +/* + * Should we ping the remote? + */ +void +check_ping_send_dowork (struct context *c) +{ + c->c2.buf = c->c2.buffers->aux_buf; + ASSERT (buf_init (&c->c2.buf, FRAME_HEADROOM (&c->c2.frame))); + ASSERT (buf_safe (&c->c2.buf, MAX_RW_SIZE_TUN (&c->c2.frame))); + ASSERT (buf_write (&c->c2.buf, ping_string, sizeof (ping_string))); + + /* + * We will treat the ping like any other outgoing packet, + * encrypt, sign, etc. + */ + encrypt_sign (c, true); + dmsg (D_PACKET_CONTENT, "SENT PING"); +} @@ -0,0 +1,47 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef PING_H +#define PING_H + +#include "init.h" +#include "forward.h" + +/* + * Initial default --ping-restart before --pull + */ +#define PRE_PULL_INITIAL_PING_RESTART 120 /* in seconds */ + +extern const uint8_t ping_string[]; + +/* PING_STRING_SIZE must be sizeof (ping_string) */ +#define PING_STRING_SIZE 16 + +static inline bool +is_ping_msg (const struct buffer* buf) +{ + return buf_string_match (buf, ping_string, PING_STRING_SIZE); +} + +#endif diff --git a/plugin.c b/plugin.c new file mode 100644 index 0000000..f0d14ba --- /dev/null +++ b/plugin.c @@ -0,0 +1,394 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#ifdef ENABLE_PLUGIN + +#include "buffer.h" +#include "error.h" +#include "misc.h" +#include "plugin.h" + +#include "memdbg.h" + +#define PLUGIN_SYMBOL_REQUIRED (1<<0) + +/* used only for program aborts */ +static struct plugin_list *static_plugin_list = NULL; /* GLOBAL */ + +static void +plugin_show_string_array (int msglevel, const char *name, const char *array[]) +{ + int i; + for (i = 0; array[i]; ++i) + msg (msglevel, "%s[%d] = '%s'", name, i, array[i]); +} + +static void +plugin_show_args_env (int msglevel, const char *argv[], const char *envp[]) +{ + if (check_debug_level (msglevel)) + { + plugin_show_string_array (msglevel, "ARGV", argv); + plugin_show_string_array (msglevel, "ENVP", envp); + } +} + +static const char * +plugin_type_name (const int type) +{ + switch (type) + { + case OPENVPN_PLUGIN_UP: + return "PLUGIN_UP"; + case OPENVPN_PLUGIN_DOWN: + return "PLUGIN_DOWN"; + case OPENVPN_PLUGIN_ROUTE_UP: + return "PLUGIN_ROUTE_UP"; + case OPENVPN_PLUGIN_IPCHANGE: + return "PLUGIN_IPCHANGE"; + case OPENVPN_PLUGIN_TLS_VERIFY: + return "PLUGIN_TLS_VERIFY"; + case OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY: + return "PLUGIN_AUTH_USER_PASS_VERIFY"; + case OPENVPN_PLUGIN_CLIENT_CONNECT: + return "PLUGIN_CLIENT_CONNECT"; + case OPENVPN_PLUGIN_CLIENT_DISCONNECT: + return "PLUGIN_CLIENT_DISCONNECT"; + case OPENVPN_PLUGIN_LEARN_ADDRESS: + return "PLUGIN_LEARN_ADDRESS"; + default: + return "PLUGIN_???"; + } +} + +static const char * +plugin_mask_string (const unsigned int type_mask, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + bool first = true; + int i; + + for (i = 0; i < OPENVPN_PLUGIN_N; ++i) + { + if (OPENVPN_PLUGIN_MASK (i) & type_mask) + { + if (!first) + buf_printf (&out, "|"); + buf_printf (&out, "%s", plugin_type_name (i)); + first = false; + } + } + return BSTR (&out); +} + +static inline unsigned int +plugin_supported_types (void) +{ + return ((1<<OPENVPN_PLUGIN_N)-1); +} + +struct plugin_option_list * +plugin_option_list_new (struct gc_arena *gc) +{ + struct plugin_option_list *ret; + ALLOC_OBJ_CLEAR_GC (ret, struct plugin_option_list, gc); + return ret; +} + +bool +plugin_option_list_add (struct plugin_option_list *list, const char *so_pathname, const char *args) +{ + if (list->n < MAX_PLUGINS) + { + struct plugin_option *o = &list->plugins[list->n++]; + o->so_pathname = so_pathname; + o->args = args; + return true; + } + else + return false; +} + +#ifdef ENABLE_DEBUG +void +plugin_option_list_print (const struct plugin_option_list *list, int msglevel) +{ + int i; + for (i = 0; i < list->n; ++i) + { + const struct plugin_option *o = &list->plugins[i]; + msg (msglevel, " plugin[%d] %s '%s'", i, o->so_pathname, o->args); + } +} +#endif + +#if defined(USE_LIBDL) + +static void +libdl_resolve_symbol (void *handle, void **dest, const char *symbol, const char *plugin_name, const unsigned int flags) +{ + *dest = dlsym (handle, symbol); + if ((flags & PLUGIN_SYMBOL_REQUIRED) && !*dest) + msg (M_FATAL, "PLUGIN: could not find required symbol '%s' in plugin shared object %s: %s", symbol, plugin_name, dlerror()); +} + +#elif defined(USE_LOAD_LIBRARY) + +static void +dll_resolve_symbol (HMODULE module, void **dest, const char *symbol, const char *plugin_name, const unsigned int flags) +{ + *dest = GetProcAddress (module, symbol); + if ((flags & PLUGIN_SYMBOL_REQUIRED) && !*dest) + msg (M_FATAL, "PLUGIN: could not find required symbol '%s' in plugin DLL %s", symbol, plugin_name); +} + +#endif + +static void +plugin_init_item (struct plugin *p, const struct plugin_option *o, const char **envp) +{ + struct gc_arena gc = gc_new (); + const char **argv = make_arg_array (o->so_pathname, o->args, &gc); + p->so_pathname = o->so_pathname; + p->plugin_type_mask = plugin_supported_types (); + +#if defined(USE_LIBDL) + p->handle = dlopen (p->so_pathname, RTLD_NOW); + if (!p->handle) + msg (M_ERR, "PLUGIN_INIT: could not load plugin shared object %s: %s", p->so_pathname, dlerror()); + libdl_resolve_symbol (p->handle, (void*)&p->open, "openvpn_plugin_open_v1", p->so_pathname, PLUGIN_SYMBOL_REQUIRED); + libdl_resolve_symbol (p->handle, (void*)&p->func, "openvpn_plugin_func_v1", p->so_pathname, PLUGIN_SYMBOL_REQUIRED); + libdl_resolve_symbol (p->handle, (void*)&p->close, "openvpn_plugin_close_v1", p->so_pathname, PLUGIN_SYMBOL_REQUIRED); + libdl_resolve_symbol (p->handle, (void*)&p->abort, "openvpn_plugin_abort_v1", p->so_pathname, 0); +#elif defined(USE_LOAD_LIBRARY) + p->module = LoadLibrary (p->so_pathname); + if (!p->module) + msg (M_ERR, "PLUGIN_INIT: could not load plugin DLL: %s", p->so_pathname); + dll_resolve_symbol (p->module, (void*)&p->open, "openvpn_plugin_open_v1", p->so_pathname, PLUGIN_SYMBOL_REQUIRED); + dll_resolve_symbol (p->module, (void*)&p->func, "openvpn_plugin_func_v1", p->so_pathname, PLUGIN_SYMBOL_REQUIRED); + dll_resolve_symbol (p->module, (void*)&p->close, "openvpn_plugin_close_v1", p->so_pathname, PLUGIN_SYMBOL_REQUIRED); + dll_resolve_symbol (p->module, (void*)&p->abort, "openvpn_plugin_abort_v1", p->so_pathname, 0); +#endif + + dmsg (D_PLUGIN_DEBUG, "PLUGIN_INIT: PRE"); + plugin_show_args_env (D_PLUGIN_DEBUG, argv, envp); + + /* + * Call the plugin initialization + */ + p->plugin_handle = (*p->open)(&p->plugin_type_mask, argv, envp); + + msg (D_PLUGIN, "PLUGIN_INIT: POST %s '%s' intercepted=%s", + p->so_pathname, + o->args ? o->args : "[NULL]", + plugin_mask_string (p->plugin_type_mask, &gc)); + + if ((p->plugin_type_mask | plugin_supported_types()) != plugin_supported_types()) + msg (M_FATAL, "PLUGIN_INIT: plugin %s expressed interest in unsupported plugin types: [want=0x%08x, have=0x%08x]", + p->so_pathname, + p->plugin_type_mask, + plugin_supported_types()); + + if (p->plugin_handle == NULL) + msg (M_FATAL, "PLUGIN_INIT: plugin initialization function failed: %s", + p->so_pathname); + + gc_free (&gc); +} + +static int +plugin_call_item (const struct plugin *p, const int type, const char *args, const char **envp) +{ + int status = OPENVPN_PLUGIN_FUNC_SUCCESS; + + if (p->plugin_type_mask & OPENVPN_PLUGIN_MASK (type)) + { + struct gc_arena gc = gc_new (); + const char **argv = make_arg_array (p->so_pathname, args, &gc); + + dmsg (D_PLUGIN_DEBUG, "PLUGIN_CALL: PRE type=%s", plugin_type_name (type)); + plugin_show_args_env (D_PLUGIN_DEBUG, argv, envp); + + /* + * Call the plugin work function + */ + status = (*p->func)(p->plugin_handle, type, argv, envp); + + msg (D_PLUGIN, "PLUGIN_CALL: POST %s/%s status=%d", + p->so_pathname, + plugin_type_name (type), + status); + + if (status != OPENVPN_PLUGIN_FUNC_SUCCESS) + msg (M_WARN, "PLUGIN_CALL: plugin function %s failed with status %d: %s", + plugin_type_name (type), + status, + p->so_pathname); + + gc_free (&gc); + } + return status; +} + +static void +plugin_close_item (const struct plugin *p) +{ + msg (D_PLUGIN, "PLUGIN_CLOSE: %s", p->so_pathname); + + /* + * Call the plugin close function + */ + (*p->close)(p->plugin_handle); + +#if defined(USE_LIBDL) + if (dlclose (p->handle)) + msg (M_WARN, "PLUGIN_CLOSE: dlclose() failed on plugin: %s", p->so_pathname); +#elif defined(USE_LOAD_LIBRARY) + if (!FreeLibrary (p->module)) + msg (M_WARN, "PLUGIN_CLOSE: FreeLibrary() failed on plugin: %s", p->so_pathname); +#endif +} + +static void +plugin_abort_item (const struct plugin *p) +{ + /* + * Call the plugin abort function + */ + if (p->abort) + (*p->abort)(p->plugin_handle); +} + +struct plugin_list * +plugin_list_open (const struct plugin_option_list *list, const struct env_set *es) +{ + struct gc_arena gc = gc_new (); + int i; + struct plugin_list *pl; + const char **envp; + + ALLOC_OBJ_CLEAR (pl, struct plugin_list); + static_plugin_list = pl; + + envp = make_env_array (es, &gc); + + for (i = 0; i < list->n; ++i) + { + plugin_init_item (&pl->plugins[i], &list->plugins[i], envp); + pl->n = i + 1; + } + + gc_free (&gc); + return pl; +} + +int +plugin_call (const struct plugin_list *pl, const int type, const char *args, struct env_set *es) +{ + int count = 0; + + if (plugin_defined (pl, type)) + { + struct gc_arena gc = gc_new (); + int i; + const char **envp; + + mutex_lock_static (L_PLUGIN); + + setenv_del (es, "script_type"); + envp = make_env_array (es, &gc); + + for (i = 0; i < pl->n; ++i) + { + if (!plugin_call_item (&pl->plugins[i], type, args, envp)) + ++count; + } + + mutex_unlock_static (L_PLUGIN); + + gc_free (&gc); + } + + return count == pl->n ? 0 : 1; /* if any one plugin in the chain failed, return failure (1) */ +} + +void +plugin_list_close (struct plugin_list *pl) +{ + static_plugin_list = NULL; + if (pl) + { + int i; + + for (i = 0; i < pl->n; ++i) + plugin_close_item (&pl->plugins[i]); + free (pl); + } +} + +void +plugin_abort (void) +{ + struct plugin_list *pl = static_plugin_list; + static_plugin_list = NULL; + if (pl) + { + int i; + + for (i = 0; i < pl->n; ++i) + plugin_abort_item (&pl->plugins[i]); + } +} + +bool +plugin_defined (const struct plugin_list *pl, const int type) +{ + bool ret = false; + if (pl) + { + int i; + const unsigned int mask = OPENVPN_PLUGIN_MASK (type); + for (i = 0; i < pl->n; ++i) + { + if (pl->plugins[i].plugin_type_mask & mask) + { + ret = true; + break; + } + } + } + return ret; +} + +#else +static void dummy(void) {} +#endif /* ENABLE_PLUGIN */ diff --git a/plugin.h b/plugin.h new file mode 100644 index 0000000..7d710b0 --- /dev/null +++ b/plugin.h @@ -0,0 +1,101 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * plug-in support, using dynamically loaded libraries + */ + +#ifndef OPENVPN_PLUGIN_H +#define OPENVPN_PLUGIN_H + +#include "openvpn-plugin.h" + +#ifdef ENABLE_PLUGIN + +#include "misc.h" + +#define MAX_PLUGINS 32 + +struct plugin_option { + const char *so_pathname; + const char *args; +}; + +struct plugin_option_list { + int n; + struct plugin_option plugins[MAX_PLUGINS]; +}; + +struct plugin { + const char *so_pathname; + unsigned int plugin_type_mask; +#if defined(USE_LIBDL) + void *handle; +#elif defined(USE_LOAD_LIBRARY) + HMODULE module; +#endif + openvpn_plugin_open_v1 open; + openvpn_plugin_func_v1 func; + openvpn_plugin_close_v1 close; + openvpn_plugin_abort_v1 abort; + + openvpn_plugin_handle_t plugin_handle; +}; + +struct plugin_list { + int n; + struct plugin plugins[MAX_PLUGINS]; +}; + +struct plugin_option_list *plugin_option_list_new (struct gc_arena *gc); +bool plugin_option_list_add (struct plugin_option_list *list, const char *so_pathname, const char *args); + +#ifdef ENABLE_DEBUG +void plugin_option_list_print (const struct plugin_option_list *list, int msglevel); +#endif + +struct plugin_list *plugin_list_open (const struct plugin_option_list *list, const struct env_set *es); +int plugin_call (const struct plugin_list *pl, const int type, const char *args, struct env_set *es); +void plugin_list_close (struct plugin_list *pl); +bool plugin_defined (const struct plugin_list *pl, const int type); + +#else + +struct plugin_list { int dummy; }; + +static inline bool +plugin_defined (const struct plugin_list *pl, const int type) +{ + return false; +} + +static inline int +plugin_call (const struct plugin_list *pl, const int type, const char *args, struct env_set *es) +{ + return 0; +} + +#endif /* ENABLE_PLUGIN */ + +#endif /* OPENVPN_PLUGIN_H */ diff --git a/plugin/README b/plugin/README new file mode 100644 index 0000000..6e490c5 --- /dev/null +++ b/plugin/README @@ -0,0 +1,47 @@ +OpenVPN Plugins +--------------- + +Starting with OpenVPN 2.0-beta17, compiled plugin modules are +supported on any *nix OS which includes libdl or on Windows. +One or more modules may be loaded into OpenVPN using +the --plugin directive, and each plugin module is capable of +intercepting any of the script callbacks which OpenVPN supports: + +(1) up +(2) down +(3) route-up +(4) ipchange +(5) tls-verify +(6) auth-user-pass-verify +(7) client-connect +(8) client-disconnect +(9) learn-address + +See the openvpn-plugin.h file in the top-level directory of the +OpenVPN source distribution for more detailed information +on the plugin interface. + +Included Plugins +---------------- + +auth-pam -- Authenticate using PAM and a split privilege + execution model which functions even if + root privileges or the execution environment + have been altered with --user/--group/--chroot. + Tested on Linux only. + +down-root -- Enable the running of down scripts with root privileges + even if --user/--group/--chroot have been used + to drop root privileges or change the execution + environment. Not applicable on Windows. + +examples -- A simple example that demonstrates a portable + plugin, i.e. one which can be built for *nix + or Windows from the same source. + +Building Plugins +---------------- + +cd to the top-level directory of a plugin, and use the +"make" command to build it. The examples plugin is +built using a build script, not a makefile. diff --git a/plugin/auth-pam/Makefile b/plugin/auth-pam/Makefile new file mode 100755 index 0000000..3e7c6ce --- /dev/null +++ b/plugin/auth-pam/Makefile @@ -0,0 +1,30 @@ +# +# Build the OpenVPN auth-pam plugin module. +# + +# If PAM modules are not linked against libpam.so, set DLOPEN_PAM to 1. This +# must be done on SUSE 9.1, at least. +DLOPEN_PAM=1 + +ifeq ($(DLOPEN_PAM),1) + LIBPAM=-ldl +else + LIBPAM=-lpam +endif + +# This directory is where we will look for openvpn-plugin.h +INCLUDE=-I../.. + +CC_FLAGS=-O2 -Wall -DDLOPEN_PAM=$(DLOPEN_PAM) + +openvpn-auth-pam.so : auth-pam.o pamdl.o + gcc ${CC_FLAGS} -fPIC -shared -Wl,-soname,openvpn-auth-pam.so -o openvpn-auth-pam.so auth-pam.o pamdl.o -lc $(LIBPAM) + +auth-pam.o : auth-pam.c pamdl.h + gcc ${CC_FLAGS} -fPIC -c ${INCLUDE} auth-pam.c + +pamdl.o : pamdl.c pamdl.h + gcc ${CC_FLAGS} -fPIC -c ${INCLUDE} pamdl.c + +clean : + rm -f *.o *.so diff --git a/plugin/auth-pam/README b/plugin/auth-pam/README new file mode 100644 index 0000000..c957c02 --- /dev/null +++ b/plugin/auth-pam/README @@ -0,0 +1,74 @@ +openvpn-auth-pam + +SYNOPSIS + +The openvpn-auth-pam module implements username/password +authentication via PAM, and essentially allows any authentication +method supported by PAM (such as LDAP, RADIUS, or Linux Shadow +passwords) to be used with OpenVPN. While PAM supports +username/password authentication, this can be combined with X509 +certificates to provide two indepedent levels of authentication. + +This module uses a split privilege execution model which will +function even if you drop openvpn daemon privileges using the user, +group, or chroot directives. + +BUILD + +To build openvpn-auth-pam, you will need to have the pam-devel +package installed. + +Build with the "make" command. The module will be named +openvpn-auth-pam.so + +USAGE + +To use this plugin module, add to your OpenVPN config file: + + plugin openvpn-auth-pam.so service-type + +The required service-type parameter corresponds to +the PAM service definition file usually found +in /etc/pam.d. + +This plugin also supports the usage of a list of name/value +pairs to answer PAM module queries. + +For example: + + plugin openvpn-auth-pam.so "login login USERNAME password PASSWORD" + +tells auth-pam to (a) use the "login" PAM module, (b) answer a +"login" query with the username given by the OpenVPN client, and +(c) answer a "password" query with the password given by the +OpenVPN client. This provides flexibility in dealing with the different +types of query strings which different PAM modules might generate. +For example, suppose you were using a PAM module called +"test" which queried for "name" rather than "login": + + plugin openvpn-auth-pam.so "test name USERNAME password PASSWORD" + +While "USERNAME" and "PASSWORD" are special strings which substitute +to client-supplied values, it is also possible to name literal values +to use as PAM module query responses. For example, suppose that the +login module queried for a third parameter, "domain" which +is to be answered with the constant value "mydomain.com": + + plugin openvpn-auth-pam.so "login login USERNAME password PASSWORD domain mydomain.com" + +The following OpenVPN directives can also influence +the operation of this plugin: + + client-cert-not-required + username-as-common-name + +Run OpenVPN with --verb 7 or higher to get debugging output from +this plugin, including the list of queries presented by the +underlying PAM module. This is a useful debugging tool to figure +out which queries a given PAM module is making, so that you can +craft the appropriate plugin directive to answer it. + +CAVEATS + +This module will only work on *nix systems which support PAM, +not Windows. diff --git a/plugin/auth-pam/auth-pam.c b/plugin/auth-pam/auth-pam.c new file mode 100644 index 0000000..5047b34 --- /dev/null +++ b/plugin/auth-pam/auth-pam.c @@ -0,0 +1,755 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * OpenVPN plugin module to do PAM authentication using a split + * privilege model. + */ + +#if DLOPEN_PAM +#include <dlfcn.h> +#include "pamdl.h" +#else +#include <security/pam_appl.h> +#endif + +#include <stdio.h> +#include <string.h> +#include <ctype.h> +#include <unistd.h> +#include <stdlib.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <sys/wait.h> +#include <fcntl.h> +#include <signal.h> +#include <syslog.h> + +#include "openvpn-plugin.h" + +#define DEBUG(verb) ((verb) >= 7) + +/* Command codes for foreground -> background communication */ +#define COMMAND_VERIFY 0 +#define COMMAND_EXIT 1 + +/* Response codes for background -> foreground communication */ +#define RESPONSE_INIT_SUCCEEDED 10 +#define RESPONSE_INIT_FAILED 11 +#define RESPONSE_VERIFY_SUCCEEDED 12 +#define RESPONSE_VERIFY_FAILED 13 + +/* + * Plugin state, used by foreground + */ +struct auth_pam_context +{ + /* Foreground's socket to background process */ + int foreground_fd; + + /* Process ID of background process */ + pid_t background_pid; + + /* Verbosity level of OpenVPN */ + int verb; +}; + +/* + * Name/Value pairs for conversation function. + * Special Values: + * + * "USERNAME" -- substitute client-supplied username + * "PASSWORD" -- substitute client-specified password + */ + +#define N_NAME_VALUE 16 + +struct name_value { + const char *name; + const char *value; +}; + +struct name_value_list { + int len; + struct name_value data[N_NAME_VALUE]; +}; + +/* + * Used to pass the username/password + * to the PAM conversation function. + */ +struct user_pass { + int verb; + + char username[128]; + char password[128]; + + const struct name_value_list *name_value_list; +}; + +/* Background process function */ +static void pam_server (int fd, const char *service, int verb, const struct name_value_list *name_value_list); + +/* + * Given an environmental variable name, search + * the envp array for its value, returning it + * if found or NULL otherwise. + */ +static const char * +get_env (const char *name, const char *envp[]) +{ + if (envp) + { + int i; + const int namelen = strlen (name); + for (i = 0; envp[i]; ++i) + { + if (!strncmp (envp[i], name, namelen)) + { + const char *cp = envp[i] + namelen; + if (*cp == '=') + return cp + 1; + } + } + } + return NULL; +} + +/* + * Return the length of a string array + */ +static int +string_array_len (const char *array[]) +{ + int i = 0; + if (array) + { + while (array[i]) + ++i; + } + return i; +} + +/* + * Socket read/write functions. + */ + +static int +recv_control (int fd) +{ + unsigned char c; + const ssize_t size = read (fd, &c, sizeof (c)); + if (size == sizeof (c)) + return c; + else + { + /*fprintf (stderr, "AUTH-PAM: DEBUG recv_control.read=%d\n", (int)size);*/ + return -1; + } +} + +static int +send_control (int fd, int code) +{ + unsigned char c = (unsigned char) code; + const ssize_t size = write (fd, &c, sizeof (c)); + if (size == sizeof (c)) + return (int) size; + else + return -1; +} + +static int +recv_string (int fd, char *buffer, int len) +{ + if (len > 0) + { + ssize_t size; + memset (buffer, 0, len); + size = read (fd, buffer, len); + buffer[len-1] = 0; + if (size >= 1) + return (int)size; + } + return -1; +} + +static int +send_string (int fd, const char *string) +{ + const int len = strlen (string) + 1; + const ssize_t size = write (fd, string, len); + if (size == len) + return (int) size; + else + return -1; +} + +/* + * Daemonize if "daemon" env var is true. + * Preserve stderr across daemonization if + * "daemon_log_redirect" env var is true. + */ +static void +daemonize (const char *envp[]) +{ + const char *daemon_string = get_env ("daemon", envp); + if (daemon_string && daemon_string[0] == '1') + { + const char *log_redirect = get_env ("daemon_log_redirect", envp); + int fd = -1; + if (log_redirect && log_redirect[0] == '1') + fd = dup (2); + if (daemon (0, 0) < 0) + { + fprintf (stderr, "AUTH-PAM: daemonization failed\n"); + } + else if (fd >= 3) + { + dup2 (fd, 2); + close (fd); + } + } +} + +/* + * Close most of parent's fds. + * Keep stdin/stdout/stderr, plus one + * other fd which is presumed to be + * our pipe back to parent. + * Admittedly, a bit of a kludge, + * but posix doesn't give us a kind + * of FD_CLOEXEC which will stop + * fds from crossing a fork(). + */ +static void +close_fds_except (int keep) +{ + int i; + closelog (); + for (i = 3; i <= 100; ++i) + { + if (i != keep) + close (i); + } +} + +/* + * Usually we ignore signals, because our parent will + * deal with them. + */ +static void +set_signals (void) +{ + signal (SIGTERM, SIG_DFL); + + signal (SIGINT, SIG_IGN); + signal (SIGHUP, SIG_IGN); + signal (SIGUSR1, SIG_IGN); + signal (SIGUSR2, SIG_IGN); + signal (SIGPIPE, SIG_IGN); +} + +/* + * Return 1 if query matches match. + */ +static int +name_value_match (const char *query, const char *match) +{ + while (!isalnum (*query)) + { + if (*query == '\0') + return 0; + ++query; + } + return strncasecmp (match, query, strlen (match)) == 0; +} + +OPENVPN_EXPORT openvpn_plugin_handle_t +openvpn_plugin_open_v1 (unsigned int *type_mask, const char *argv[], const char *envp[]) +{ + pid_t pid; + int fd[2]; + + struct auth_pam_context *context; + struct name_value_list name_value_list; + + const int base_parms = 2; + + /* + * Allocate our context + */ + context = (struct auth_pam_context *) calloc (1, sizeof (struct auth_pam_context)); + context->foreground_fd = -1; + + /* + * Intercept the --auth-user-pass-verify callback. + */ + *type_mask = OPENVPN_PLUGIN_MASK (OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY); + + /* + * Make sure we have two string arguments: the first is the .so name, + * the second is the PAM service type. + */ + if (string_array_len (argv) < base_parms) + { + fprintf (stderr, "AUTH-PAM: need PAM service parameter\n"); + goto error; + } + + /* + * See if we have optional name/value pairs to match against + * PAM module queried fields in the conversation function. + */ + name_value_list.len = 0; + if (string_array_len (argv) > base_parms) + { + const int nv_len = string_array_len (argv) - base_parms; + int i; + + if ((nv_len & 1) == 1 || (nv_len / 2) > N_NAME_VALUE) + { + fprintf (stderr, "AUTH-PAM: bad name/value list length\n"); + goto error; + } + + name_value_list.len = nv_len / 2; + for (i = 0; i < name_value_list.len; ++i) + { + const int base = base_parms + i * 2; + name_value_list.data[i].name = argv[base]; + name_value_list.data[i].value = argv[base+1]; + } + } + + /* + * Get verbosity level from environment + */ + { + const char *verb_string = get_env ("verb", envp); + if (verb_string) + context->verb = atoi (verb_string); + } + + /* + * Make a socket for foreground and background processes + * to communicate. + */ + if (socketpair (PF_UNIX, SOCK_DGRAM, 0, fd) == -1) + { + fprintf (stderr, "AUTH-PAM: socketpair call failed\n"); + goto error; + } + + /* + * Fork off the privileged process. It will remain privileged + * even after the foreground process drops its privileges. + */ + pid = fork (); + + if (pid) + { + int status; + + /* + * Foreground Process + */ + + context->background_pid = pid; + + /* close our copy of child's socket */ + close (fd[1]); + + /* don't let future subprocesses inherit child socket */ + if (fcntl (fd[0], F_SETFD, FD_CLOEXEC) < 0) + fprintf (stderr, "AUTH-PAM: Set FD_CLOEXEC flag on socket file descriptor failed\n"); + + /* wait for background child process to initialize */ + status = recv_control (fd[0]); + if (status == RESPONSE_INIT_SUCCEEDED) + { + context->foreground_fd = fd[0]; + return (openvpn_plugin_handle_t) context; + } + } + else + { + /* + * Background Process + */ + + /* close all parent fds except our socket back to parent */ + close_fds_except (fd[1]); + + /* Ignore most signals (the parent will receive them) */ + set_signals (); + + /* Daemonize if --daemon option is set. */ + daemonize (envp); + + /* execute the event loop */ + pam_server (fd[1], argv[1], context->verb, &name_value_list); + + close (fd[1]); + + exit (0); + return 0; /* NOTREACHED */ + } + + error: + if (context) + free (context); + return NULL; +} + +OPENVPN_EXPORT int +openvpn_plugin_func_v1 (openvpn_plugin_handle_t handle, const int type, const char *argv[], const char *envp[]) +{ + struct auth_pam_context *context = (struct auth_pam_context *) handle; + + if (type == OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY && context->foreground_fd >= 0) + { + /* get username/password from envp string array */ + const char *username = get_env ("username", envp); + const char *password = get_env ("password", envp); + + if (username && strlen (username) > 0 && password) + { + if (send_control (context->foreground_fd, COMMAND_VERIFY) == -1 + || send_string (context->foreground_fd, username) == -1 + || send_string (context->foreground_fd, password) == -1) + { + fprintf (stderr, "AUTH-PAM: Error sending auth info to background process\n"); + } + else + { + const int status = recv_control (context->foreground_fd); + if (status == RESPONSE_VERIFY_SUCCEEDED) + return OPENVPN_PLUGIN_FUNC_SUCCESS; + if (status == -1) + fprintf (stderr, "AUTH-PAM: Error receiving auth confirmation from background process\n"); + } + } + } + return OPENVPN_PLUGIN_FUNC_ERROR; +} + +OPENVPN_EXPORT void +openvpn_plugin_close_v1 (openvpn_plugin_handle_t handle) +{ + struct auth_pam_context *context = (struct auth_pam_context *) handle; + + if (DEBUG (context->verb)) + fprintf (stderr, "AUTH-PAM: close\n"); + + if (context->foreground_fd >= 0) + { + /* tell background process to exit */ + if (send_control (context->foreground_fd, COMMAND_EXIT) == -1) + fprintf (stderr, "AUTH-PAM: Error signaling background process to exit\n"); + + /* wait for background process to exit */ + if (context->background_pid > 0) + waitpid (context->background_pid, NULL, 0); + + close (context->foreground_fd); + context->foreground_fd = -1; + } + + free (context); +} + +OPENVPN_EXPORT void +openvpn_plugin_abort_v1 (openvpn_plugin_handle_t handle) +{ + struct auth_pam_context *context = (struct auth_pam_context *) handle; + + /* tell background process to exit */ + if (context->foreground_fd >= 0) + { + send_control (context->foreground_fd, COMMAND_EXIT); + close (context->foreground_fd); + context->foreground_fd = -1; + } +} + +/* + * PAM conversation function + */ +static int +my_conv (int n, const struct pam_message **msg_array, + struct pam_response **response_array, void *appdata_ptr) +{ + const struct user_pass *up = ( const struct user_pass *) appdata_ptr; + struct pam_response *aresp; + int i; + int ret = PAM_SUCCESS; + + *response_array = NULL; + + if (n <= 0 || n > PAM_MAX_NUM_MSG) + return (PAM_CONV_ERR); + if ((aresp = calloc (n, sizeof *aresp)) == NULL) + return (PAM_BUF_ERR); + + /* loop through each PAM-module query */ + for (i = 0; i < n; ++i) + { + const struct pam_message *msg = msg_array[i]; + aresp[i].resp_retcode = 0; + aresp[i].resp = NULL; + + if (DEBUG (up->verb)) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: my_conv[%d] query='%s' style=%d\n", + i, + msg->msg ? msg->msg : "NULL", + msg->msg_style); + } + + if (up->name_value_list && up->name_value_list->len > 0) + { + /* use name/value list match method */ + const struct name_value_list *list = up->name_value_list; + int j; + + /* loop through name/value pairs */ + for (j = 0; j < list->len; ++j) + { + const char *match_name = list->data[j].name; + const char *match_value = list->data[j].value; + + if (name_value_match (msg->msg, match_name)) + { + /* found name/value match */ + const char *return_value = NULL; + + if (DEBUG (up->verb)) + fprintf (stderr, "AUTH-PAM: BACKGROUND: name match found, query/match-string ['%s', '%s'] = '%s'\n", + msg->msg, + match_name, + match_value); + + if (!strcmp (match_value, "USERNAME")) + return_value = up->username; + else if (!strcmp (match_value, "PASSWORD")) + return_value = up->password; + else + return_value = match_value; + + aresp[i].resp = strdup (return_value); + if (aresp[i].resp == NULL) + ret = PAM_CONV_ERR; + break; + } + } + + if (j == list->len) + ret = PAM_CONV_ERR; + } + else + { + /* use PAM_PROMPT_ECHO_x hints */ + switch (msg->msg_style) + { + case PAM_PROMPT_ECHO_OFF: + aresp[i].resp = strdup (up->password); + if (aresp[i].resp == NULL) + ret = PAM_CONV_ERR; + break; + + case PAM_PROMPT_ECHO_ON: + aresp[i].resp = strdup (up->username); + if (aresp[i].resp == NULL) + ret = PAM_CONV_ERR; + break; + + case PAM_ERROR_MSG: + case PAM_TEXT_INFO: + break; + + default: + ret = PAM_CONV_ERR; + break; + } + } + } + + if (ret == PAM_SUCCESS) + *response_array = aresp; + return ret; +} + +/* + * Return 1 if authenticated and 0 if failed. + * Called once for every username/password + * to be authenticated. + */ +static int +pam_auth (const char *service, const struct user_pass *up) +{ + struct pam_conv conv; + pam_handle_t *pamh = NULL; + int status = PAM_SUCCESS; + int ret = 0; + const int name_value_list_provided = (up->name_value_list && up->name_value_list->len > 0); + + /* Initialize PAM */ + conv.conv = my_conv; + conv.appdata_ptr = (void *)up; + status = pam_start (service, name_value_list_provided ? NULL : up->username, &conv, &pamh); + if (status == PAM_SUCCESS) + { + /* Call PAM to verify username/password */ + status = pam_authenticate(pamh, 0); + if (status == PAM_SUCCESS) + status = pam_acct_mgmt (pamh, 0); + if (status == PAM_SUCCESS) + ret = 1; + + /* Output error message if failed */ + if (!ret) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: user '%s' failed to authenticate: %s\n", + up->username, + pam_strerror (pamh, status)); + } + + /* Close PAM */ + pam_end (pamh, status); + } + + return ret; +} + +/* + * Background process -- runs with privilege. + */ +static void +pam_server (int fd, const char *service, int verb, const struct name_value_list *name_value_list) +{ + struct user_pass up; + int command; +#if DLOPEN_PAM + static const char pam_so[] = "libpam.so"; +#endif + + /* + * Do initialization + */ + if (DEBUG (verb)) + fprintf (stderr, "AUTH-PAM: BACKGROUND: INIT service='%s'\n", service); + +#if DLOPEN_PAM + /* + * Load PAM shared object + */ + if (!dlopen_pam (pam_so)) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: could not load PAM lib %s: %s\n", pam_so, dlerror()); + send_control (fd, RESPONSE_INIT_FAILED); + goto done; + } +#endif + + /* + * Tell foreground that we initialized successfully + */ + if (send_control (fd, RESPONSE_INIT_SUCCEEDED) == -1) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: write error on response socket [1]\n"); + goto done; + } + + /* + * Event loop + */ + while (1) + { + memset (&up, 0, sizeof (up)); + up.verb = verb; + up.name_value_list = name_value_list; + + /* get a command from foreground process */ + command = recv_control (fd); + + if (DEBUG (verb)) + fprintf (stderr, "AUTH-PAM: BACKGROUND: received command code: %d\n", command); + + switch (command) + { + case COMMAND_VERIFY: + if (recv_string (fd, up.username, sizeof (up.username)) == -1 + || recv_string (fd, up.password, sizeof (up.password)) == -1) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: read error on command channel: code=%d, exiting\n", + command); + goto done; + } + + if (DEBUG (verb)) + fprintf (stderr, "AUTH-PAM: BACKGROUND: USER/PASS: %s/%s\n", + up.username, up.password); + + if (pam_auth (service, &up)) /* Succeeded */ + { + if (send_control (fd, RESPONSE_VERIFY_SUCCEEDED) == -1) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: write error on response socket [2]\n"); + goto done; + } + } + else /* Failed */ + { + if (send_control (fd, RESPONSE_VERIFY_FAILED) == -1) + { + fprintf (stderr, "AUTH-PAM: BACKGROUND: write error on response socket [3]\n"); + goto done; + } + } + break; + + case COMMAND_EXIT: + goto done; + + case -1: + fprintf (stderr, "AUTH-PAM: BACKGROUND: read error on command channel\n"); + goto done; + + default: + fprintf (stderr, "AUTH-PAM: BACKGROUND: unknown command code: code=%d, exiting\n", + command); + goto done; + } + } + done: + +#if DLOPEN_PAM + dlclose_pam (); +#endif + if (DEBUG (verb)) + fprintf (stderr, "AUTH-PAM: BACKGROUND: EXIT\n"); + + return; +} diff --git a/plugin/auth-pam/pamdl.c b/plugin/auth-pam/pamdl.c new file mode 100644 index 0000000..aaac240 --- /dev/null +++ b/plugin/auth-pam/pamdl.c @@ -0,0 +1,181 @@ +#if DLOPEN_PAM +/* + * If you want to dynamically load libpam using dlopen() or something, + * then dlopen( ' this shared object ' ); It takes care of exporting + * the right symbols to any modules loaded by libpam. + * + * Modified by JY for use with openvpn-pam-auth + */ + +#include <stdio.h> +#include <dlfcn.h> +#include <security/pam_appl.h> +#include <security/_pam_macros.h> + +#include "pamdl.h" + +static void *libpam_h = NULL; + +#define RESOLVE_PAM_FUNCTION(x, y, z, err) \ + { \ + union { const void *tpointer; y (*fn) z ; } fptr; \ + fptr.tpointer = dlsym(libpam_h, #x); real_##x = fptr.fn; \ + if (real_##x == NULL) { \ + fprintf (stderr, "PAMDL: unable to resolve '%s': %s\n", #x, dlerror()); \ + return err; \ + } \ + } + +int +dlopen_pam (const char *so) +{ + if (libpam_h == NULL) + { + libpam_h = dlopen(so, RTLD_GLOBAL|RTLD_NOW); + } + return libpam_h != NULL; +} + +void +dlclose_pam (void) +{ + if (libpam_h != NULL) + { + dlclose(libpam_h); + libpam_h = NULL; + } +} + +int pam_start(const char *service_name, const char *user, + const struct pam_conv *pam_conversation, + pam_handle_t **pamh) +{ + int (*real_pam_start)(const char *, const char *, + const struct pam_conv *, + pam_handle_t **); + RESOLVE_PAM_FUNCTION(pam_start, int, (const char *, const char *, + const struct pam_conv *, + pam_handle_t **), PAM_ABORT); + return real_pam_start(service_name, user, pam_conversation, pamh); +} + +int pam_end(pam_handle_t *pamh, int pam_status) +{ + int (*real_pam_end)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_end, int, (pam_handle_t *, int), PAM_ABORT); + return real_pam_end(pamh, pam_status); +} + +int pam_set_item(pam_handle_t *pamh, int item_type, const void *item) +{ + int (*real_pam_set_item)(pam_handle_t *, int, const void *); + RESOLVE_PAM_FUNCTION(pam_set_item, int, + (pam_handle_t *, int, const void *), PAM_ABORT); + return real_pam_set_item(pamh, item_type, item); +} + +int pam_get_item(const pam_handle_t *pamh, int item_type, const void **item) +{ + int (*real_pam_get_item)(const pam_handle_t *, int, const void **); + RESOLVE_PAM_FUNCTION(pam_get_item, int, + (const pam_handle_t *, int, const void **), + PAM_ABORT); + return real_pam_get_item(pamh, item_type, item); +} + +int pam_fail_delay(pam_handle_t *pamh, unsigned int musec_delay) +{ + int (*real_pam_fail_delay)(pam_handle_t *, unsigned int); + RESOLVE_PAM_FUNCTION(pam_fail_delay, int, (pam_handle_t *, unsigned int), + PAM_ABORT); + return real_pam_fail_delay(pamh, musec_delay); +} + +typedef const char * const_char_pointer; + +const_char_pointer pam_strerror(pam_handle_t *pamh, int errnum) +{ + const_char_pointer (*real_pam_strerror)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_strerror, const_char_pointer, + (pam_handle_t *, int), NULL); + return real_pam_strerror(pamh, errnum); +} + +int pam_putenv(pam_handle_t *pamh, const char *name_value) +{ + int (*real_pam_putenv)(pam_handle_t *, const char *); + RESOLVE_PAM_FUNCTION(pam_putenv, int, (pam_handle_t *, const char *), + PAM_ABORT); + return real_pam_putenv(pamh, name_value); +} + +const_char_pointer pam_getenv(pam_handle_t *pamh, const char *name) +{ + const_char_pointer (*real_pam_getenv)(pam_handle_t *, const char *); + RESOLVE_PAM_FUNCTION(pam_getenv, const_char_pointer, + (pam_handle_t *, const char *), NULL); + return real_pam_getenv(pamh, name); +} + +typedef char ** char_ppointer; +char_ppointer pam_getenvlist(pam_handle_t *pamh) +{ + char_ppointer (*real_pam_getenvlist)(pam_handle_t *); + RESOLVE_PAM_FUNCTION(pam_getenvlist, char_ppointer, (pam_handle_t *), + NULL); + return real_pam_getenvlist(pamh); +} + +/* Authentication management */ + +int pam_authenticate(pam_handle_t *pamh, int flags) +{ + int (*real_pam_authenticate)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_authenticate, int, (pam_handle_t *, int), + PAM_ABORT); + return real_pam_authenticate(pamh, flags); +} + +int pam_setcred(pam_handle_t *pamh, int flags) +{ + int (*real_pam_setcred)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_setcred, int, (pam_handle_t *, int), PAM_ABORT); + return real_pam_setcred(pamh, flags); +} + +/* Account Management API's */ + +int pam_acct_mgmt(pam_handle_t *pamh, int flags) +{ + int (*real_pam_acct_mgmt)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_acct_mgmt, int, (pam_handle_t *, int), PAM_ABORT); + return real_pam_acct_mgmt(pamh, flags); +} + +/* Session Management API's */ + +int pam_open_session(pam_handle_t *pamh, int flags) +{ + int (*real_pam_open_session)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_open_session, int, (pam_handle_t *, int), + PAM_ABORT); + return real_pam_open_session(pamh, flags); +} + +int pam_close_session(pam_handle_t *pamh, int flags) +{ + int (*real_pam_close_session)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_close_session, int, (pam_handle_t *, int), + PAM_ABORT); + return real_pam_close_session(pamh, flags); +} + +/* Password Management API's */ + +int pam_chauthtok(pam_handle_t *pamh, int flags) +{ + int (*real_pam_chauthtok)(pam_handle_t *, int); + RESOLVE_PAM_FUNCTION(pam_chauthtok, int, (pam_handle_t *, int), PAM_ABORT); + return real_pam_chauthtok(pamh, flags); +} +#endif diff --git a/plugin/auth-pam/pamdl.h b/plugin/auth-pam/pamdl.h new file mode 100644 index 0000000..b10b035 --- /dev/null +++ b/plugin/auth-pam/pamdl.h @@ -0,0 +1,7 @@ +#if DLOPEN_PAM +#include <security/pam_appl.h> + +/* Dynamically load and unload the PAM library */ +int dlopen_pam (const char *so); +void dlclose_pam (void); +#endif diff --git a/plugin/down-root/Makefile b/plugin/down-root/Makefile new file mode 100755 index 0000000..5ce4ffb --- /dev/null +++ b/plugin/down-root/Makefile @@ -0,0 +1,17 @@ +# +# Build the OpenVPN down-root plugin module. +# + +# This directory is where we will look for openvpn-plugin.h +INCLUDE=-I../.. + +CC_FLAGS=-O2 -Wall + +down-root.so : down-root.o + gcc ${CC_FLAGS} -fPIC -shared -Wl,-soname,openvpn-down-root.so -o openvpn-down-root.so down-root.o -lc + +down-root.o : down-root.c + gcc ${CC_FLAGS} -fPIC -c ${INCLUDE} down-root.c + +clean : + rm -f *.o *.so diff --git a/plugin/down-root/README b/plugin/down-root/README new file mode 100644 index 0000000..d337ffe --- /dev/null +++ b/plugin/down-root/README @@ -0,0 +1,29 @@ +down-root -- an OpenVPN Plugin Module + +SYNOPSIS + +The down-root module allows an OpenVPN configuration to +call a down script with root privileges, even when privileges +have been dropped using --user/--group/--chroot. + +This module uses a split privilege execution model which will +fork() before OpenVPN drops root privileges, at the point where +the --up script is usually called. The module will then remain +in a wait state until it receives a message from OpenVPN via +pipe to execute the down script. Thus, the down script will be +run in the same execution environment as the up script. + +BUILD + +Build this module with the "make" command. The plugin +module will be named openvpn-down-root.so + +USAGE + +To use this module, add to your OpenVPN config file: + + plugin openvpn-down-root.so "command ..." + +CAVEATS + +This module will only work on *nix systems, not Windows. diff --git a/plugin/down-root/down-root.c b/plugin/down-root/down-root.c new file mode 100644 index 0000000..f19d857 --- /dev/null +++ b/plugin/down-root/down-root.c @@ -0,0 +1,551 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * OpenVPN plugin module to do privileged down-script execution. + */ + +#include <stdio.h> +#include <string.h> +#include <unistd.h> +#include <stdlib.h> +#include <sys/types.h> +#include <sys/socket.h> +#include <sys/wait.h> +#include <fcntl.h> +#include <signal.h> +#include <syslog.h> + +#include "openvpn-plugin.h" + +#define DEBUG(verb) ((verb) >= 7) + +/* Command codes for foreground -> background communication */ +#define COMMAND_RUN_SCRIPT 0 +#define COMMAND_EXIT 1 + +/* Response codes for background -> foreground communication */ +#define RESPONSE_INIT_SUCCEEDED 10 +#define RESPONSE_INIT_FAILED 11 +#define RESPONSE_SCRIPT_SUCCEEDED 12 +#define RESPONSE_SCRIPT_FAILED 13 + +/* Background process function */ +static void down_root_server (const int fd, char *command, const char *argv[], const char *envp[], const int verb); + +/* + * Plugin state, used by foreground + */ +struct down_root_context +{ + /* Foreground's socket to background process */ + int foreground_fd; + + /* Process ID of background process */ + pid_t background_pid; + + /* Verbosity level of OpenVPN */ + int verb; + + /* down command */ + char *command; +}; + +/* + * Given an environmental variable name, search + * the envp array for its value, returning it + * if found or NULL otherwise. + */ +static const char * +get_env (const char *name, const char *envp[]) +{ + if (envp) + { + int i; + const int namelen = strlen (name); + for (i = 0; envp[i]; ++i) + { + if (!strncmp (envp[i], name, namelen)) + { + const char *cp = envp[i] + namelen; + if (*cp == '=') + return cp + 1; + } + } + } + return NULL; +} + +/* + * Return the length of a string array + */ +static int +string_array_len (const char *array[]) +{ + int i = 0; + if (array) + { + while (array[i]) + ++i; + } + return i; +} + +/* + * Socket read/write functions. + */ + +static int +recv_control (int fd) +{ + unsigned char c; + const ssize_t size = read (fd, &c, sizeof (c)); + if (size == sizeof (c)) + return c; + else + return -1; +} + +static int +send_control (int fd, int code) +{ + unsigned char c = (unsigned char) code; + const ssize_t size = write (fd, &c, sizeof (c)); + if (size == sizeof (c)) + return (int) size; + else + return -1; +} + +/* + * Daemonize if "daemon" env var is true. + * Preserve stderr across daemonization if + * "daemon_log_redirect" env var is true. + */ +static void +daemonize (const char *envp[]) +{ + const char *daemon_string = get_env ("daemon", envp); + if (daemon_string && daemon_string[0] == '1') + { + const char *log_redirect = get_env ("daemon_log_redirect", envp); + int fd = -1; + if (log_redirect && log_redirect[0] == '1') + fd = dup (2); + if (daemon (0, 0) < 0) + { + fprintf (stderr, "DOWN-ROOT: daemonization failed\n"); + } + else if (fd >= 3) + { + dup2 (fd, 2); + close (fd); + } + } +} + +/* + * Close most of parent's fds. + * Keep stdin/stdout/stderr, plus one + * other fd which is presumed to be + * our pipe back to parent. + * Admittedly, a bit of a kludge, + * but posix doesn't give us a kind + * of FD_CLOEXEC which will stop + * fds from crossing a fork(). + */ +static void +close_fds_except (int keep) +{ + int i; + closelog (); + for (i = 3; i <= 100; ++i) + { + if (i != keep) + close (i); + } +} + +/* + * Usually we ignore signals, because our parent will + * deal with them. + */ +static void +set_signals (void) +{ + signal (SIGTERM, SIG_DFL); + + signal (SIGINT, SIG_IGN); + signal (SIGHUP, SIG_IGN); + signal (SIGUSR1, SIG_IGN); + signal (SIGUSR2, SIG_IGN); + signal (SIGPIPE, SIG_IGN); +} + +/* + * convert system() return into a success/failure value + */ +int +system_ok (int stat) +{ +#ifdef WIN32 + return stat == 0; +#else + return stat != -1 && WIFEXITED (stat) && WEXITSTATUS (stat) == 0; +#endif +} + +static char * +build_command_line (const char *argv[]) +{ + int size = 0; + int n = 0; + int i; + char *string; + + /* precompute size */ + if (argv) + { + for (i = 0; argv[i]; ++i) + { + size += (strlen (argv[i]) + 1); /* string length plus trailing space */ + ++n; + } + } + ++size; /* for null terminator */ + + /* allocate memory */ + string = (char *) malloc (size); + if (!string) + { + fprintf (stderr, "DOWN-ROOT: out of memory\n"); + exit (1); + } + string[0] = '\0'; + + /* build string */ + for (i = 0; i < n; ++i) + { + strcat (string, argv[i]); + if (i + 1 < n) + strcat (string, " "); + } + return string; +} + +static void +free_context (struct down_root_context *context) +{ + if (context) + { + if (context->command) + free (context->command); + free (context); + } +} + +OPENVPN_EXPORT openvpn_plugin_handle_t +openvpn_plugin_open_v1 (unsigned int *type_mask, const char *argv[], const char *envp[]) +{ + struct down_root_context *context; + + /* + * Allocate our context + */ + context = (struct down_root_context *) calloc (1, sizeof (struct down_root_context)); + context->foreground_fd = -1; + + /* + * Intercept the --up and --down callbacks + */ + *type_mask = OPENVPN_PLUGIN_MASK (OPENVPN_PLUGIN_UP) | OPENVPN_PLUGIN_MASK (OPENVPN_PLUGIN_DOWN); + + /* + * Make sure we have two string arguments: the first is the .so name, + * the second is the script command. + */ + if (string_array_len (argv) < 2) + { + fprintf (stderr, "DOWN-ROOT: need down script command\n"); + goto error; + } + + /* + * Save our argument in context + */ + context->command = build_command_line (&argv[1]); + + /* + * Get verbosity level from environment + */ + { + const char *verb_string = get_env ("verb", envp); + if (verb_string) + context->verb = atoi (verb_string); + } + + return (openvpn_plugin_handle_t) context; + + error: + free_context (context); + return NULL; +} + +OPENVPN_EXPORT int +openvpn_plugin_func_v1 (openvpn_plugin_handle_t handle, const int type, const char *argv[], const char *envp[]) +{ + struct down_root_context *context = (struct down_root_context *) handle; + + if (type == OPENVPN_PLUGIN_UP && context->foreground_fd == -1) /* fork off a process to hold onto root */ + { + pid_t pid; + int fd[2]; + + /* + * Make a socket for foreground and background processes + * to communicate. + */ + if (socketpair (PF_UNIX, SOCK_DGRAM, 0, fd) == -1) + { + fprintf (stderr, "DOWN-ROOT: socketpair call failed\n"); + return OPENVPN_PLUGIN_FUNC_ERROR; + } + + /* + * Fork off the privileged process. It will remain privileged + * even after the foreground process drops its privileges. + */ + pid = fork (); + + if (pid) + { + int status; + + /* + * Foreground Process + */ + + context->background_pid = pid; + + /* close our copy of child's socket */ + close (fd[1]); + + /* don't let future subprocesses inherit child socket */ + if (fcntl (fd[0], F_SETFD, FD_CLOEXEC) < 0) + fprintf (stderr, "DOWN-ROOT: Set FD_CLOEXEC flag on socket file descriptor failed\n"); + + /* wait for background child process to initialize */ + status = recv_control (fd[0]); + if (status == RESPONSE_INIT_SUCCEEDED) + { + context->foreground_fd = fd[0]; + return OPENVPN_PLUGIN_FUNC_SUCCESS; + } + } + else + { + /* + * Background Process + */ + + /* close all parent fds except our socket back to parent */ + close_fds_except (fd[1]); + + /* Ignore most signals (the parent will receive them) */ + set_signals (); + + /* Daemonize if --daemon option is set. */ + daemonize (envp); + + /* execute the event loop */ + down_root_server (fd[1], context->command, argv, envp, context->verb); + + close (fd[1]); + exit (0); + return 0; /* NOTREACHED */ + } + } + else if (type == OPENVPN_PLUGIN_DOWN && context->foreground_fd >= 0) + { + if (send_control (context->foreground_fd, COMMAND_RUN_SCRIPT) == -1) + { + fprintf (stderr, "DOWN-ROOT: Error sending script execution signal to background process\n"); + } + else + { + const int status = recv_control (context->foreground_fd); + if (status == RESPONSE_SCRIPT_SUCCEEDED) + return OPENVPN_PLUGIN_FUNC_SUCCESS; + if (status == -1) + fprintf (stderr, "DOWN-ROOT: Error receiving script execution confirmation from background process\n"); + } + } + return OPENVPN_PLUGIN_FUNC_ERROR; +} + +OPENVPN_EXPORT void +openvpn_plugin_close_v1 (openvpn_plugin_handle_t handle) +{ + struct down_root_context *context = (struct down_root_context *) handle; + + if (DEBUG (context->verb)) + fprintf (stderr, "DOWN-ROOT: close\n"); + + if (context->foreground_fd >= 0) + { + /* tell background process to exit */ + if (send_control (context->foreground_fd, COMMAND_EXIT) == -1) + fprintf (stderr, "DOWN-ROOT: Error signaling background process to exit\n"); + + /* wait for background process to exit */ + if (context->background_pid > 0) + waitpid (context->background_pid, NULL, 0); + + close (context->foreground_fd); + context->foreground_fd = -1; + } + + free_context (context); +} + +OPENVPN_EXPORT void +openvpn_plugin_abort_v1 (openvpn_plugin_handle_t handle) +{ + struct down_root_context *context = (struct down_root_context *) handle; + + if (context->foreground_fd >= 0) + { + /* tell background process to exit */ + send_control (context->foreground_fd, COMMAND_EXIT); + close (context->foreground_fd); + context->foreground_fd = -1; + } +} + +/* + * Background process -- runs with privilege. + */ +static void +down_root_server (const int fd, char *command, const char *argv[], const char *envp[], const int verb) +{ + const char *p[3]; + char *command_line = NULL; + char *argv_cat = NULL; + int i; + + /* + * Do initialization + */ + if (DEBUG (verb)) + fprintf (stderr, "DOWN-ROOT: BACKGROUND: INIT command='%s'\n", command); + + /* + * Tell foreground that we initialized successfully + */ + if (send_control (fd, RESPONSE_INIT_SUCCEEDED) == -1) + { + fprintf (stderr, "DOWN-ROOT: BACKGROUND: write error on response socket [1]\n"); + goto done; + } + + /* + * Build command line + */ + if (string_array_len (argv) >= 2) + argv_cat = build_command_line (&argv[1]); + else + argv_cat = build_command_line (NULL); + p[0] = command; + p[1] = argv_cat; + p[2] = NULL; + command_line = build_command_line (p); + + /* + * Save envp in environment + */ + for (i = 0; envp[i]; ++i) + { + putenv ((char *)envp[i]); + } + + /* + * Event loop + */ + while (1) + { + int command_code; + int status; + + /* get a command from foreground process */ + command_code = recv_control (fd); + + if (DEBUG (verb)) + fprintf (stderr, "DOWN-ROOT: BACKGROUND: received command code: %d\n", command_code); + + switch (command_code) + { + case COMMAND_RUN_SCRIPT: + status = system (command_line); + if (system_ok (status)) /* Succeeded */ + { + if (send_control (fd, RESPONSE_SCRIPT_SUCCEEDED) == -1) + { + fprintf (stderr, "DOWN-ROOT: BACKGROUND: write error on response socket [2]\n"); + goto done; + } + } + else /* Failed */ + { + if (send_control (fd, RESPONSE_SCRIPT_FAILED) == -1) + { + fprintf (stderr, "DOWN-ROOT: BACKGROUND: write error on response socket [3]\n"); + goto done; + } + } + break; + + case COMMAND_EXIT: + goto done; + + case -1: + fprintf (stderr, "DOWN-ROOT: BACKGROUND: read error on command channel\n"); + goto done; + + default: + fprintf (stderr, "DOWN-ROOT: BACKGROUND: unknown command code: code=%d, exiting\n", + command_code); + goto done; + } + } + + done: + if (argv_cat) + free (argv_cat); + if (command_line) + free (command_line); + if (DEBUG (verb)) + fprintf (stderr, "DOWN-ROOT: BACKGROUND: EXIT\n"); + + return; +} diff --git a/plugin/examples/README b/plugin/examples/README new file mode 100644 index 0000000..4400cd3 --- /dev/null +++ b/plugin/examples/README @@ -0,0 +1,16 @@ +OpenVPN plugin examples. + +Examples provided: + +simple.c -- using the --auth-user-pass-verify callback, verify + that the username/password is "foo"/"bar". + +To build: + + ./build simple (Linux/BSD/etc.) + ./winbuild simple (MinGW on Windows) + +To use in OpenVPN, add to config file: + + plugin simple.so (Linux/BSD/etc.) + plugin simple.dll (MinGW on Windows) diff --git a/plugin/examples/build b/plugin/examples/build new file mode 100755 index 0000000..8b628a2 --- /dev/null +++ b/plugin/examples/build @@ -0,0 +1,14 @@ +#!/bin/sh + +# +# Build an OpenVPN plugin module on *nix. The argument should +# be the base name of the C source file (without the .c). +# + +# This directory is where we will look for openvpn-plugin.h +INCLUDE="-I../.." + +CC_FLAGS="-O2 -Wall" + +gcc $CC_FLAGS -fPIC -c $INCLUDE $1.c && \ +gcc -fPIC -shared -Wl,-soname,$1.so -o $1.so $1.o -lc diff --git a/plugin/examples/simple.c b/plugin/examples/simple.c new file mode 100644 index 0000000..aa823b7 --- /dev/null +++ b/plugin/examples/simple.c @@ -0,0 +1,120 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * This file implements a simple OpenVPN plugin module which + * will examine the username/password provided by a client, + * and make an accept/deny determination. Will run + * on Windows or *nix. + * + * See the README file for build instructions. + */ + +#include <stdio.h> +#include <string.h> +#include <stdlib.h> + +#include "openvpn-plugin.h" + +/* + * Our context, where we keep our state. + */ +struct plugin_context { + const char *username; + const char *password; +}; + +/* + * Given an environmental variable name, search + * the envp array for its value, returning it + * if found or NULL otherwise. + */ +static const char * +get_env (const char *name, const char *envp[]) +{ + if (envp) + { + int i; + const int namelen = strlen (name); + for (i = 0; envp[i]; ++i) + { + if (!strncmp (envp[i], name, namelen)) + { + const char *cp = envp[i] + namelen; + if (*cp == '=') + return cp + 1; + } + } + } + return NULL; +} + +OPENVPN_EXPORT openvpn_plugin_handle_t +openvpn_plugin_open_v1 (unsigned int *type_mask, const char *argv[], const char *envp[]) +{ + struct plugin_context *context; + + /* + * Allocate our context + */ + context = (struct plugin_context *) calloc (1, sizeof (struct plugin_context)); + + /* + * Set the username/password we will require. + */ + context->username = "foo"; + context->password = "bar"; + + /* + * We are only interested in intercepting the + * --auth-user-pass-verify callback. + */ + *type_mask = OPENVPN_PLUGIN_MASK (OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY); + + return (openvpn_plugin_handle_t) context; +} + +OPENVPN_EXPORT int +openvpn_plugin_func_v1 (openvpn_plugin_handle_t handle, const int type, const char *argv[], const char *envp[]) +{ + struct plugin_context *context = (struct plugin_context *) handle; + + /* get username/password from envp string array */ + const char *username = get_env ("username", envp); + const char *password = get_env ("password", envp); + + /* check entered username/password against what we require */ + if (username && !strcmp (username, context->username) + && password && !strcmp (password, context->password)) + return OPENVPN_PLUGIN_FUNC_SUCCESS; + else + return OPENVPN_PLUGIN_FUNC_ERROR; +} + +OPENVPN_EXPORT void +openvpn_plugin_close_v1 (openvpn_plugin_handle_t handle) +{ + struct plugin_context *context = (struct plugin_context *) handle; + free (context); +} diff --git a/plugin/examples/simple.def b/plugin/examples/simple.def new file mode 100755 index 0000000..a87507d --- /dev/null +++ b/plugin/examples/simple.def @@ -0,0 +1,6 @@ +LIBRARY OpenVPN_PLUGIN_SAMPLE +DESCRIPTION "Sample OpenVPN plug-in module." +EXPORTS + openvpn_plugin_open_v1 @1 + openvpn_plugin_func_v1 @2 + openvpn_plugin_close_v1 @3 diff --git a/plugin/examples/winbuild b/plugin/examples/winbuild new file mode 100755 index 0000000..97e724a --- /dev/null +++ b/plugin/examples/winbuild @@ -0,0 +1,18 @@ +# +# Build an OpenVPN plugin module on Windows/MinGW. +# The argument should be the base name of the C source file +# (without the .c). +# + +# This directory is where we will look for openvpn-plugin.h +INCLUDE="-I.." + +CC_FLAGS="-O2 -Wall" + +gcc -DBUILD_DLL $CC_FLAGS $INCLUDE -c $1.c +gcc --disable-stdcall-fixup -mdll -DBUILD_DLL -o junk.tmp -Wl,--base-file,base.tmp $1.o +rm junk.tmp +dlltool --dllname $1.dll --base-file base.tmp --output-exp temp.exp --input-def $1.def +rm base.tmp +gcc --enable-stdcall-fixup -mdll -DBUILD_DLL -o $1.dll $1.o -Wl,temp.exp +rm temp.exp @@ -0,0 +1,505 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "pool.h" +#include "buffer.h" +#include "error.h" +#include "socket.h" +#include "otime.h" + +#include "memdbg.h" + +#if P2MP + +static void +ifconfig_pool_entry_free (struct ifconfig_pool_entry *ipe, bool hard) +{ + ipe->in_use = false; + if (hard && ipe->common_name) + { + free (ipe->common_name); + ipe->common_name = NULL; + } + if (hard) + ipe->last_release = 0; + else + ipe->last_release = now; +} + +static int +ifconfig_pool_find (struct ifconfig_pool *pool, const char *common_name) +{ + int i; + time_t earliest_release = 0; + int previous_usage = -1; + int new_usage = -1; + + for (i = 0; i < pool->size; ++i) + { + struct ifconfig_pool_entry *ipe = &pool->list[i]; + if (!ipe->in_use) + { + /* + * If duplicate_cn mode, take first available IP address + */ + if (pool->duplicate_cn) + { + new_usage = i; + break; + } + + /* + * Keep track of the unused IP address entry which + * was released earliest. + */ + if ((new_usage == -1 || ipe->last_release < earliest_release) && !ipe->fixed) + { + earliest_release = ipe->last_release; + new_usage = i; + } + + /* + * Keep track of a possible allocation to us + * from an earlier session. + */ + if (previous_usage < 0 + && common_name + && ipe->common_name + && !strcmp (common_name, ipe->common_name)) + previous_usage = i; + + } + } + + if (previous_usage >= 0) + return previous_usage; + + if (new_usage >= 0) + return new_usage; + + return -1; +} + + +struct ifconfig_pool * +ifconfig_pool_init (int type, in_addr_t start, in_addr_t end, const bool duplicate_cn) +{ + struct gc_arena gc = gc_new (); + struct ifconfig_pool *pool = NULL; + + ASSERT (start <= end && end - start < IFCONFIG_POOL_MAX); + ALLOC_OBJ_CLEAR (pool, struct ifconfig_pool); + + pool->type = type; + pool->duplicate_cn = duplicate_cn; + + switch (type) + { + case IFCONFIG_POOL_30NET: + pool->base = start & ~3; + pool->size = (((end | 3) + 1) - pool->base) >> 2; + break; + case IFCONFIG_POOL_INDIV: + pool->base = start; + pool->size = end - start + 1; + break; + default: + ASSERT (0); + } + + ALLOC_ARRAY_CLEAR (pool->list, struct ifconfig_pool_entry, pool->size); + + msg (D_IFCONFIG_POOL, "IFCONFIG POOL: base=%s size=%d", + print_in_addr_t (pool->base, 0, &gc), + pool->size); + + gc_free (&gc); + return pool; +} + +void +ifconfig_pool_free (struct ifconfig_pool *pool) +{ + if (pool) + { + int i; + for (i = 0; i < pool->size; ++i) + ifconfig_pool_entry_free (&pool->list[i], true); + free (pool->list); + free (pool); + } +} + +ifconfig_pool_handle +ifconfig_pool_acquire (struct ifconfig_pool *pool, in_addr_t *local, in_addr_t *remote, const char *common_name) +{ + int i; + + i = ifconfig_pool_find (pool, common_name); + if (i >= 0) + { + struct ifconfig_pool_entry *ipe = &pool->list[i]; + ASSERT (!ipe->in_use); + ifconfig_pool_entry_free (ipe, true); + ipe->in_use = true; + if (common_name) + ipe->common_name = string_alloc (common_name, NULL); + + switch (pool->type) + { + case IFCONFIG_POOL_30NET: + { + in_addr_t b = pool->base + (i << 2); + *local = b + 1; + *remote = b + 2; + break; + } + case IFCONFIG_POOL_INDIV: + { + in_addr_t b = pool->base + i; + *local = 0; + *remote = b; + break; + } + default: + ASSERT (0); + } + } + return i; +} + +bool +ifconfig_pool_release (struct ifconfig_pool* pool, ifconfig_pool_handle hand, const bool hard) +{ + bool ret = false; + if (pool && hand >= 0 && hand < pool->size) + { + ifconfig_pool_entry_free (&pool->list[hand], hard); + ret = true; + } + return ret; +} + +/* + * private access functions + */ + +static ifconfig_pool_handle +ifconfig_pool_ip_base_to_handle (const struct ifconfig_pool* pool, const in_addr_t addr) +{ + ifconfig_pool_handle ret = -1; + + switch (pool->type) + { + case IFCONFIG_POOL_30NET: + { + ret = (addr - pool->base) >> 2; + break; + } + case IFCONFIG_POOL_INDIV: + { + ret = (addr - pool->base); + break; + } + default: + ASSERT (0); + } + + if (ret < 0 || ret >= pool->size) + ret = -1; + + return ret; +} + +static in_addr_t +ifconfig_pool_handle_to_ip_base (const struct ifconfig_pool* pool, ifconfig_pool_handle hand) +{ + in_addr_t ret = 0; + + if (hand >= 0 && hand < pool->size) + { + switch (pool->type) + { + case IFCONFIG_POOL_30NET: + { + ret = pool->base + (hand << 2);; + break; + } + case IFCONFIG_POOL_INDIV: + { + ret = pool->base + hand; + break; + } + default: + ASSERT (0); + } + } + + return ret; +} + +static void +ifconfig_pool_set (struct ifconfig_pool* pool, const char *cn, const in_addr_t addr, const bool fixed) +{ + ifconfig_pool_handle h = ifconfig_pool_ip_base_to_handle (pool, addr); + if (h >= 0) + { + struct ifconfig_pool_entry *e = &pool->list[h]; + ifconfig_pool_entry_free (e, true); + e->in_use = false; + e->common_name = string_alloc (cn, NULL); + e->last_release = now; + e->fixed = fixed; + } +} + +static void +ifconfig_pool_list (const struct ifconfig_pool* pool, struct status_output *out) +{ + if (pool && out) + { + struct gc_arena gc = gc_new (); + int i; + + for (i = 0; i < pool->size; ++i) + { + const struct ifconfig_pool_entry *e = &pool->list[i]; + if (e->common_name) + { + const in_addr_t ip = ifconfig_pool_handle_to_ip_base (pool, i); + status_printf (out, "%s,%s", + e->common_name, + print_in_addr_t (ip, 0, &gc)); + } + } + gc_free (&gc); + } +} + +static void +ifconfig_pool_msg (const struct ifconfig_pool* pool, int msglevel) +{ + struct status_output *so = status_open (NULL, 0, msglevel, NULL, 0); + ASSERT (so); + status_printf (so, "IFCONFIG POOL LIST"); + ifconfig_pool_list (pool, so); + status_close (so); +} + +/* + * Deal with reading/writing the ifconfig pool database to a file + */ + +struct ifconfig_pool_persist * +ifconfig_pool_persist_init (const char *filename, int refresh_freq) +{ + struct ifconfig_pool_persist *ret; + + ASSERT (filename); + + ALLOC_OBJ_CLEAR (ret, struct ifconfig_pool_persist); + if (refresh_freq > 0) + { + ret->fixed = false; + ret->file = status_open (filename, refresh_freq, -1, NULL, STATUS_OUTPUT_READ|STATUS_OUTPUT_WRITE); + } + else + { + ret->fixed = true; + ret->file = status_open (filename, 0, -1, NULL, STATUS_OUTPUT_READ); + } + return ret; +} + +void +ifconfig_pool_persist_close (struct ifconfig_pool_persist *persist) +{ + if (persist) + { + if (persist->file) + status_close (persist->file); + free (persist); + } +} + +bool +ifconfig_pool_write_trigger (struct ifconfig_pool_persist *persist) +{ + if (persist->file) + return status_trigger (persist->file); + else + return false; +} + +void +ifconfig_pool_read (struct ifconfig_pool_persist *persist, struct ifconfig_pool *pool) +{ + const int buf_size = 128; + + update_time (); + if (persist && persist->file && pool) + { + struct gc_arena gc = gc_new (); + struct buffer in = alloc_buf_gc (256, &gc); + char *cn_buf; + char *ip_buf; + int line = 0; + + ALLOC_ARRAY_CLEAR_GC (cn_buf, char, buf_size, &gc); + ALLOC_ARRAY_CLEAR_GC (ip_buf, char, buf_size, &gc); + + while (true) + { + ASSERT (buf_init (&in, 0)); + if (!status_read (persist->file, &in)) + break; + ++line; + if (BLEN (&in)) + { + int c = *BSTR(&in); + if (c == '#' || c == ';') + continue; + if (buf_parse (&in, ',', cn_buf, buf_size) + && buf_parse (&in, ',', ip_buf, buf_size)) + { + bool succeeded; + const in_addr_t addr = getaddr (GETADDR_HOST_ORDER, ip_buf, 0, &succeeded, NULL); + if (succeeded) + { + ifconfig_pool_set (pool, cn_buf, addr, persist->fixed); + } + } + } + } + + ifconfig_pool_msg (pool, D_IFCONFIG_POOL); + + gc_free (&gc); + } +} + +void +ifconfig_pool_write (struct ifconfig_pool_persist *persist, const struct ifconfig_pool *pool) +{ + if (persist && persist->file && (status_rw_flags (persist->file) & STATUS_OUTPUT_WRITE) && pool) + { + status_reset (persist->file); + ifconfig_pool_list (pool, persist->file); + status_flush (persist->file); + } +} + +/* + * TESTING ONLY + */ + +#ifdef IFCONFIG_POOL_TEST + +#define DUP_CN + +void +ifconfig_pool_test (in_addr_t start, in_addr_t end) +{ + struct gc_arena gc = gc_new (); + struct ifconfig_pool *p = ifconfig_pool_init (IFCONFIG_POOL_30NET, start, end); + /*struct ifconfig_pool *p = ifconfig_pool_init (IFCONFIG_POOL_INDIV, start, end);*/ + ifconfig_pool_handle array[256]; + int i; + + CLEAR (array); + + msg (M_INFO | M_NOPREFIX, "************ 1"); + for (i = 0; i < (int) SIZE (array); ++i) + { + char *cn; + ifconfig_pool_handle h; + in_addr_t local, remote; + char buf[256]; + openvpn_snprintf (buf, sizeof(buf), "common-name-%d", i); +#ifdef DUP_CN + cn = NULL; +#else + cn = buf; +#endif + h = ifconfig_pool_acquire (p, &local, &remote, cn); + if (h < 0) + break; + msg (M_INFO | M_NOPREFIX, "IFCONFIG_POOL TEST pass 1: l=%s r=%s cn=%s", + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote, 0, &gc), + cn); + array[i] = h; + + } + + msg (M_INFO | M_NOPREFIX, "************* 2"); + for (i = (int) SIZE (array) / 16; i < (int) SIZE (array) / 8; ++i) + { + msg (M_INFO, "Attempt to release %d cn=%s", array[i], p->list[i].common_name); + if (!ifconfig_pool_release (p, array[i])) + break; + msg (M_INFO, "Succeeded"); + } + + CLEAR (array); + + msg (M_INFO | M_NOPREFIX, "**************** 3"); + for (i = 0; i < (int) SIZE (array); ++i) + { + char *cn; + ifconfig_pool_handle h; + in_addr_t local, remote; + char buf[256]; + snprintf (buf, sizeof(buf), "common-name-%d", i+24); +#ifdef DUP_CN + cn = NULL; +#else + cn = buf; +#endif + h = ifconfig_pool_acquire (p, &local, &remote, cn); + if (h < 0) + break; + msg (M_INFO | M_NOPREFIX, "IFCONFIG_POOL TEST pass 3: l=%s r=%s cn=%s", + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote, 0, &gc), + cn); + array[i] = h; + + } + + ifconfig_pool_free (p); + gc_free (&gc); +} + +#endif + +#endif @@ -0,0 +1,87 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef POOL_H +#define POOL_H + +#if P2MP + +/*#define IFCONFIG_POOL_TEST*/ + +#include "basic.h" +#include "status.h" +#include "thread.h" + +#define IFCONFIG_POOL_MAX 65536 +#define IFCONFIG_POOL_MIN_NETBITS 16 + +#define IFCONFIG_POOL_30NET 0 +#define IFCONFIG_POOL_INDIV 1 + +struct ifconfig_pool_entry +{ + bool in_use; + char *common_name; + time_t last_release; + bool fixed; +}; + +struct ifconfig_pool +{ + in_addr_t base; + int size; + int type; + bool duplicate_cn; + struct ifconfig_pool_entry *list; +}; + +struct ifconfig_pool_persist +{ + struct status_output *file; + bool fixed; +}; + +typedef int ifconfig_pool_handle; + +struct ifconfig_pool *ifconfig_pool_init (int type, in_addr_t start, in_addr_t end, const bool duplicate_cn); + +void ifconfig_pool_free (struct ifconfig_pool *pool); + +ifconfig_pool_handle ifconfig_pool_acquire (struct ifconfig_pool *pool, in_addr_t *local, in_addr_t *remote, const char *common_name); + +bool ifconfig_pool_release (struct ifconfig_pool* pool, ifconfig_pool_handle hand, const bool hard); + +struct ifconfig_pool_persist *ifconfig_pool_persist_init (const char *filename, int refresh_freq); +void ifconfig_pool_persist_close (struct ifconfig_pool_persist *persist); +bool ifconfig_pool_write_trigger (struct ifconfig_pool_persist *persist); + +void ifconfig_pool_read (struct ifconfig_pool_persist *persist, struct ifconfig_pool *pool); +void ifconfig_pool_write (struct ifconfig_pool_persist *persist, const struct ifconfig_pool *pool); + +#ifdef IFCONFIG_POOL_TEST +void ifconfig_pool_test (in_addr_t start, in_addr_t end); +#endif + +#endif +#endif @@ -0,0 +1,74 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "proto.h" + +#include "memdbg.h" + +/* + * If raw tunnel packet is IPv4, return true and increment + * buffer offset to start of IP header. + */ +bool +is_ipv4 (int tunnel_type, struct buffer *buf) +{ + int offset; + const struct openvpn_iphdr *ih; + + verify_align_4 (buf); + if (tunnel_type == DEV_TYPE_TUN) + { + if (BLEN (buf) < (int) sizeof (struct openvpn_iphdr)) + return false; + offset = 0; + } + else if (tunnel_type == DEV_TYPE_TAP) + { + const struct openvpn_ethhdr *eh; + if (BLEN (buf) < (int)(sizeof (struct openvpn_ethhdr) + + sizeof (struct openvpn_iphdr))) + return false; + eh = (const struct openvpn_ethhdr *) BPTR (buf); + if (ntohs (eh->proto) != OPENVPN_ETH_P_IPV4) + return false; + offset = sizeof (struct openvpn_ethhdr); + } + else + return false; + + ih = (const struct openvpn_iphdr *) (BPTR (buf) + offset); + + if (OPENVPN_IPH_GET_VER (ih->version_len) == 4) + return buf_advance (buf, offset); + else + return false; +} @@ -0,0 +1,163 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef PROTO_H +#define PROTO_H + +#include "buffer.h" + +/* + * Tunnel types + */ +#define DEV_TYPE_UNDEF 0 +#define DEV_TYPE_NULL 1 +#define DEV_TYPE_TUN 2 /* point-to-point IP tunnel */ +#define DEV_TYPE_TAP 3 /* ethernet (802.3) tunnel */ + +/* + * IP and Ethernet protocol structs. For portability, + * OpenVPN needs its own definitions of these structs, and + * names have been adjusted to avoid collisions with + * native structs. + */ + +#define OPENVPN_ETH_ALEN 6 /* ethernet address length */ +struct openvpn_ethhdr +{ + uint8_t dest[OPENVPN_ETH_ALEN]; /* destination ethernet addr */ + uint8_t source[OPENVPN_ETH_ALEN]; /* source ethernet addr */ + +# define OPENVPN_ETH_P_IPV4 0x0800 /* IPv4 protocol */ +# define OPENVPN_ETH_P_IPV6 0x86DD /* IPv6 protocol */ +# define OPENVPN_ETH_P_ARP 0x0806 /* ARP protocol */ + uint16_t proto; /* packet type ID field */ +}; + +struct openvpn_iphdr { +# define OPENVPN_IPH_GET_VER(v) (((v) >> 4) & 0x0F) +# define OPENVPN_IPH_GET_LEN(v) (((v) & 0x0F) << 2) + uint8_t version_len; + + uint8_t tos; + uint16_t tot_len; + uint16_t id; + +# define OPENVPN_IP_OFFMASK 0x1fff + uint16_t frag_off; + + uint8_t ttl; + +# define OPENVPN_IPPROTO_IGMP 2 /* IGMP protocol */ +# define OPENVPN_IPPROTO_TCP 6 /* TCP protocol */ +# define OPENVPN_IPPROTO_UDP 17 /* UDP protocol */ + uint8_t protocol; + + uint16_t check; + uint32_t saddr; + uint32_t daddr; + /*The options start here. */ +}; + +/* + * UDP header + */ +struct openvpn_udphdr { + uint16_t source; + uint16_t dest; + uint16_t len; + uint16_t check; +}; + +/* + * TCP header, per RFC 793. + */ +struct openvpn_tcphdr { + uint16_t source; /* source port */ + uint16_t dest; /* destination port */ + uint32_t seq; /* sequence number */ + uint32_t ack_seq; /* acknowledgement number */ + +# define OPENVPN_TCPH_GET_DOFF(d) (((d) & 0xF0) >> 2) + uint8_t doff_res; + +# define OPENVPN_TCPH_FIN_MASK (1<<0) +# define OPENVPN_TCPH_SYN_MASK (1<<1) +# define OPENVPN_TCPH_RST_MASK (1<<2) +# define OPENVPN_TCPH_PSH_MASK (1<<3) +# define OPENVPN_TCPH_ACK_MASK (1<<4) +# define OPENVPN_TCPH_URG_MASK (1<<5) +# define OPENVPN_TCPH_ECE_MASK (1<<6) +# define OPENVPN_TCPH_CWR_MASK (1<<7) + uint8_t flags; + + uint16_t window; + uint16_t check; + uint16_t urg_ptr; +}; + +#define OPENVPN_TCPOPT_EOL 0 +#define OPENVPN_TCPOPT_NOP 1 +#define OPENVPN_TCPOPT_MAXSEG 2 +#define OPENVPN_TCPOLEN_MAXSEG 4 + +/* + * The following macro is used to update an + * internet checksum. "acc" is a 32-bit + * accumulation of all the changes to the + * checksum (adding in old 16-bit words and + * subtracting out new words), and "cksum" + * is the checksum value to be updated. + */ +#define ADJUST_CHECKSUM(acc, cksum) { \ + (acc) += (cksum); \ + if ((acc) < 0) { \ + (acc) = -(acc); \ + (acc) = ((acc) >> 16) + ((acc) & 0xffff); \ + (acc) += (acc) >> 16; \ + (cksum) = (uint16_t) ~(acc); \ + } else { \ + (acc) = ((acc) >> 16) + ((acc) & 0xffff); \ + (acc) += (acc) >> 16; \ + (cksum) = (uint16_t) (acc); \ + } \ +} + +/* + * We are in a "liberal" position with respect to MSS, + * i.e. we assume that MSS can be calculated from MTU + * by subtracting out only the IP and TCP header sizes + * without options. + * + * (RFC 879, section 7). + */ +#define MTU_TO_MSS(mtu) (mtu - sizeof(struct openvpn_iphdr) \ + - sizeof(struct openvpn_tcphdr)) + +/* + * If raw tunnel packet is IPv4, return true and increment + * buffer offset to start of IP header. + */ +bool is_ipv4 (int tunnel_type, struct buffer *buf); + +#endif @@ -0,0 +1,519 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#ifdef ENABLE_HTTP_PROXY + +#include "syshead.h" + +#include "common.h" +#include "misc.h" +#include "win32.h" +#include "socket.h" +#include "fdmisc.h" +#include "proxy.h" +#include "ntlm.h" + +#include "memdbg.h" + +/* cached proxy username/password */ +static struct user_pass static_proxy_user_pass; + +static bool +recv_line (socket_descriptor_t sd, + char *buf, + int len, + const int timeout_sec, + const bool verbose, + struct buffer *lookahead, + volatile int *signal_received) +{ + struct buffer la; + int lastc = 0; + + CLEAR (la); + if (lookahead) + la = *lookahead; + + while (true) + { + int status; + ssize_t size; + fd_set reads; + struct timeval tv; + uint8_t c; + + if (buf_defined (&la)) + { + ASSERT (buf_init (&la, 0)); + } + + FD_ZERO (&reads); + FD_SET (sd, &reads); + tv.tv_sec = timeout_sec; + tv.tv_usec = 0; + + status = select (sd + 1, &reads, NULL, NULL, &tv); + + get_signal (signal_received); + if (*signal_received) + goto error; + + /* timeout? */ + if (status == 0) + { + if (verbose) + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_line: TCP port read timeout expired"); + goto error; + } + + /* error */ + if (status < 0) + { + if (verbose) + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_line: TCP port read failed on select()"); + goto error; + } + + /* read single char */ + size = recv (sd, &c, 1, MSG_NOSIGNAL); + + /* error? */ + if (size != 1) + { + if (verbose) + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_line: TCP port read failed on recv()"); + goto error; + } + +#if 0 + if (isprint(c)) + msg (M_INFO, "PROXY: read '%c' (%d)", c, (int)c); + else + msg (M_INFO, "PROXY: read (%d)", (int)c); +#endif + + /* store char in buffer */ + if (len > 1) + { + *buf++ = c; + --len; + } + + /* also store char in lookahead buffer */ + if (buf_defined (&la)) + { + buf_write_u8 (&la, c); + if (!isprint(c) && !isspace(c)) /* not ascii? */ + { + if (verbose) + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_line: Non-ASCII character (%d) read on recv()", (int)c); + *lookahead = la; + return false; + } + } + + /* end of line? */ + if (lastc == '\r' && c == '\n') + break; + + lastc = c; + } + + /* append trailing null */ + if (len > 0) + *buf++ = '\0'; + + return true; + + error: + return false; +} + +static bool +send_line (socket_descriptor_t sd, + const char *buf) +{ + const ssize_t size = send (sd, buf, strlen (buf), MSG_NOSIGNAL); + if (size != (ssize_t) strlen (buf)) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "send_line: TCP port write failed on send()"); + return false; + } + return true; +} + +static bool +send_line_crlf (socket_descriptor_t sd, + const char *src) +{ + bool ret; + + struct buffer buf = alloc_buf (strlen (src) + 3); + ASSERT (buf_write (&buf, src, strlen (src))); + ASSERT (buf_write (&buf, "\r\n", 3)); + ret = send_line (sd, BSTR (&buf)); + free_buf (&buf); + return ret; +} + +static bool +send_crlf (socket_descriptor_t sd) +{ + return send_line_crlf (sd, ""); +} + +uint8_t * +make_base64_string2 (const uint8_t *str, int src_len, struct gc_arena *gc) +{ + static const char base64_table[] = + "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; + + uint8_t *buf; + const uint8_t *src; + uint8_t *dst; + int bits, data, dst_len; + + /* make base64 string */ + dst_len = (src_len + 2) / 3 * 4; + buf = gc_malloc (dst_len + 1, false, gc); + bits = data = 0; + src = str; + dst = buf; + while (dst_len--) + { + if (bits < 6) + { + data = (data << 8) | *src; + bits += 8; + src++; + } + *dst++ = base64_table[0x3F & (data >> (bits - 6))]; + bits -= 6; + } + *dst = '\0'; + + /* fix-up tail padding */ + switch (src_len % 3) + { + case 1: + *--dst = '='; + case 2: + *--dst = '='; + } + return buf; +} + +uint8_t * +make_base64_string (const uint8_t *str, struct gc_arena *gc) +{ + return make_base64_string2 (str, strlen ((const char *)str), gc); +} + +static const char * +username_password_as_base64 (const struct http_proxy_info *p, + struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (strlen (p->up.username) + strlen (p->up.password) + 2, gc); + ASSERT (strlen (p->up.username) > 0); + buf_printf (&out, "%s:%s", p->up.username, p->up.password); + return (const char *)make_base64_string ((const uint8_t*)BSTR (&out), gc); +} + +struct http_proxy_info * +new_http_proxy (const struct http_proxy_options *o, + struct gc_arena *gc) +{ + struct http_proxy_info *p; + ALLOC_OBJ_CLEAR_GC (p, struct http_proxy_info, gc); + + if (!o->server) + msg (M_FATAL, "HTTP_PROXY: server not specified"); + + ASSERT (legal_ipv4_port (o->port)); + + p->options = *o; + + /* parse authentication method */ + p->auth_method = HTTP_AUTH_NONE; + if (o->auth_method_string) + { + if (!strcmp (o->auth_method_string, "none")) + p->auth_method = HTTP_AUTH_NONE; + else if (!strcmp (o->auth_method_string, "basic")) + p->auth_method = HTTP_AUTH_BASIC; + else if (!strcmp (o->auth_method_string, "ntlm")) + p->auth_method = HTTP_AUTH_NTLM; + else + msg (M_FATAL, "ERROR: unknown HTTP authentication method: '%s' -- only the 'none', 'basic', or 'ntlm' methods are currently supported", + o->auth_method_string); + } + + /* only basic and NTLM authentication supported so far */ + if (p->auth_method == HTTP_AUTH_BASIC || p->auth_method == HTTP_AUTH_NTLM) + { + get_user_pass (&static_proxy_user_pass, + o->auth_file, + false, + "HTTP Proxy", + GET_USER_PASS_MANAGEMENT); + p->up = static_proxy_user_pass; + } + +#if !NTLM + if (p->auth_method == HTTP_AUTH_NTLM) + msg (M_FATAL, "Sorry, this version of " PACKAGE_NAME " was built without NTLM Proxy support."); +#endif + + p->defined = true; + return p; +} + +void +establish_http_proxy_passthru (struct http_proxy_info *p, + socket_descriptor_t sd, /* already open to proxy */ + const char *host, /* openvpn server remote */ + const int port, /* openvpn server port */ + struct buffer *lookahead, + volatile int *signal_received) +{ + struct gc_arena gc = gc_new (); + char buf[256]; + char buf2[128]; + char get[80]; + int status; + int nparms; + + /* format HTTP CONNECT message */ + openvpn_snprintf (buf, sizeof(buf), "CONNECT %s:%d HTTP/%s", + host, + port, + p->options.http_version); + + msg (D_PROXY, "Send to HTTP proxy: '%s'", buf); + + /* send HTTP CONNECT message to proxy */ + if (!send_line_crlf (sd, buf)) + goto error; + + /* send User-Agent string if provided */ + if (p->options.user_agent) + { + openvpn_snprintf (buf, sizeof(buf), "User-Agent: %s", + p->options.user_agent); + if (!send_line_crlf (sd, buf)) + goto error; + } + + /* auth specified? */ + switch (p->auth_method) + { + case HTTP_AUTH_NONE: + break; + + case HTTP_AUTH_BASIC: + openvpn_snprintf (buf, sizeof(buf), "Proxy-Authorization: Basic %s", + username_password_as_base64 (p, &gc)); + msg (D_PROXY, "Attempting Basic Proxy-Authorization"); + dmsg (D_SHOW_KEYS, "Send to HTTP proxy: '%s'", buf); + openvpn_sleep (1); + if (!send_line_crlf (sd, buf)) + goto error; + break; + +#if NTLM + case HTTP_AUTH_NTLM: + openvpn_snprintf (buf, sizeof(buf), "Proxy-Authorization: NTLM %s", + ntlm_phase_1 (p, &gc)); + msg (D_PROXY, "Attempting NTLM Proxy-Authorization phase 1"); + dmsg (D_SHOW_KEYS, "Send to HTTP proxy: '%s'", buf); + openvpn_sleep (1); + if (!send_line_crlf (sd, buf)) + goto error; + break; +#endif + + default: + ASSERT (0); + } + + /* send empty CR, LF */ + openvpn_sleep (1); + if (!send_crlf (sd)) + goto error; + + /* receive reply from proxy */ + if (!recv_line (sd, buf, sizeof(buf), p->options.timeout, true, NULL, signal_received)) + goto error; + + /* remove trailing CR, LF */ + chomp (buf); + + msg (D_PROXY, "HTTP proxy returned: '%s'", buf); + + /* parse return string */ + nparms = sscanf (buf, "%*s %d", &status); + + /* check for a "407 Proxy Authentication Required" response */ + if (nparms >= 1 && status == 407) + { + msg (D_PROXY, "Proxy requires authentication"); + + /* check for NTLM */ + if (p->auth_method == HTTP_AUTH_NTLM) + { +#if NTLM + /* look for the phase 2 response */ + + while (true) + { + if (!recv_line (sd, buf, sizeof(buf), p->options.timeout, true, NULL, signal_received)) + goto error; + chomp (buf); + msg (D_PROXY, "HTTP proxy returned: '%s'", buf); + + openvpn_snprintf (get, sizeof get, "%%*s NTLM %%%ds", (int) sizeof (buf2) - 1); + nparms = sscanf (buf, get, buf2); + buf2[127] = 0; /* we only need the beginning - ensure it's null terminated. */ + + /* check for "Proxy-Authenticate: NTLM TlRM..." */ + if (nparms == 1) + { + /* parse buf2 */ + msg (D_PROXY, "auth string: '%s'", buf2); + break; + } + } + /* if we are here then auth string was got */ + msg (D_PROXY, "Received NTLM Proxy-Authorization phase 2 response"); + + /* receive and discard everything else */ + while (recv_line (sd, NULL, 0, p->options.timeout, true, NULL, signal_received)) + ; + + /* now send the phase 3 reply */ + + /* format HTTP CONNECT message */ + openvpn_snprintf (buf, sizeof(buf), "CONNECT %s:%d HTTP/%s", + host, + port, + p->options.http_version); + + msg (D_PROXY, "Send to HTTP proxy: '%s'", buf); + + /* send HTTP CONNECT message to proxy */ + if (!send_line_crlf (sd, buf)) + goto error; + + /* send HOST etc, */ + openvpn_sleep (1); + openvpn_snprintf (buf, sizeof(buf), "Host: %s", host); + msg (D_PROXY, "Send to HTTP proxy: '%s'", buf); + if (!send_line_crlf (sd, buf)) + goto error; + + openvpn_snprintf (buf, sizeof(buf), "Proxy-Authorization: NTLM %s", + ntlm_phase_3 (p, buf2, &gc)); + msg (D_PROXY, "Attempting NTLM Proxy-Authorization phase 3"); + msg (D_PROXY, "Send to HTTP proxy: '%s'", buf); + openvpn_sleep (1); + if (!send_line_crlf (sd, buf)) + goto error; + /* ok so far... */ + /* send empty CR, LF */ + openvpn_sleep (1); + if (!send_crlf (sd)) + goto error; + + /* receive reply from proxy */ + if (!recv_line (sd, buf, sizeof(buf), p->options.timeout, true, NULL, signal_received)) + goto error; + + /* remove trailing CR, LF */ + chomp (buf); + + msg (D_PROXY, "HTTP proxy returned: '%s'", buf); + + /* parse return string */ + nparms = sscanf (buf, "%*s %d", &status); +#else + ASSERT (0); /* No NTLM support */ +#endif + } + else goto error; + } + + + /* check return code, success = 200 */ + if (nparms < 1 || status != 200) + { + msg (D_LINK_ERRORS, "HTTP proxy returned bad status"); +#if 0 + /* DEBUGGING -- show a multi-line HTTP error response */ + while (true) + { + if (!recv_line (sd, buf, sizeof (buf), p->options.timeout, true, NULL, signal_received)) + goto error; + chomp (buf); + msg (D_PROXY, "HTTP proxy returned: '%s'", buf); + } +#endif + goto error; + } + + /* receive line from proxy and discard */ + if (!recv_line (sd, NULL, 0, p->options.timeout, true, NULL, signal_received)) + goto error; + + /* + * Toss out any extraneous chars, but don't throw away the + * start of the OpenVPN data stream (put it in lookahead). + */ + while (recv_line (sd, NULL, 0, 2, false, lookahead, signal_received)) + ; + +#if 0 + if (lookahead && BLEN (lookahead)) + msg (M_INFO, "HTTP PROXY: lookahead: %s", format_hex (BPTR (lookahead), BLEN (lookahead), 0)); +#endif + + gc_free (&gc); + return; + + error: + /* on error, should we exit or restart? */ + if (!*signal_received) + *signal_received = (p->options.retry ? SIGUSR1 : SIGTERM); /* SOFT-SIGUSR1 -- HTTP proxy error */ + gc_free (&gc); + return; +} + +#else +static void dummy(void) {} +#endif /* ENABLE_HTTP_PROXY */ @@ -0,0 +1,71 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef PROXY_H +#define PROXY_H + +#ifdef ENABLE_HTTP_PROXY + +#include "buffer.h" +#include "misc.h" + +/* HTTP CONNECT authentication methods */ +#define HTTP_AUTH_NONE 0 +#define HTTP_AUTH_BASIC 1 +#define HTTP_AUTH_NTLM 2 +#define HTTP_AUTH_N 3 + +struct http_proxy_options { + const char *server; + int port; + bool retry; + int timeout; + const char *auth_method_string; + const char *auth_file; + const char *http_version; + const char *user_agent; +}; + +struct http_proxy_info { + bool defined; + int auth_method; + struct http_proxy_options options; + struct user_pass up; +}; + +struct http_proxy_info *new_http_proxy (const struct http_proxy_options *o, + struct gc_arena *gc); + +void establish_http_proxy_passthru (struct http_proxy_info *p, + socket_descriptor_t sd, /* already open to proxy */ + const char *host, /* openvpn server remote */ + const int port, /* openvpn server port */ + struct buffer *lookahead, + volatile int *signal_received); + +uint8_t *make_base64_string2 (const uint8_t *str, int str_len, struct gc_arena *gc); +uint8_t *make_base64_string (const uint8_t *str, struct gc_arena *gc); + +#endif +#endif @@ -0,0 +1,326 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "push.h" +#include "options.h" +#include "ssl.h" +#include "manage.h" + +#include "memdbg.h" + +#if P2MP + +/* + * Auth username/password + * + * Client received an authentication failed message from server. + * Runs on client. + */ +void +receive_auth_failed (struct context *c, const struct buffer *buffer) +{ + msg (M_VERB0, "AUTH: Received AUTH_FAILED control message"); + if (c->options.pull) + { + switch (auth_retry_get ()) + { + case AR_NONE: + c->sig->signal_received = SIGTERM; /* SOFT-SIGTERM -- Auth failure error */ + break; + case AR_INTERACT: + ssl_purge_auth (); + case AR_NOINTERACT: + c->sig->signal_received = SIGUSR1; /* SOFT-SIGUSR1 -- Auth failure error */ + break; + default: + ASSERT (0); + } + c->sig->signal_text = "auth-failure"; +#ifdef ENABLE_MANAGEMENT + if (management) + management_auth_failure (management, UP_TYPE_AUTH); +#endif + } +} + +#if P2MP_SERVER +/* + * Send auth failed message from server to client. + */ +bool +send_auth_failed (struct context *c) +{ + return send_control_channel_string (c, "AUTH_FAILED", D_PUSH); +} +#endif + +/* + * Push/Pull + */ + +void +incoming_push_message (struct context *c, const struct buffer *buffer) +{ + struct gc_arena gc = gc_new (); + unsigned int option_types_found = 0; + int status; + + msg (D_PUSH, "PUSH: Received control message: '%s'", BSTR (buffer)); + + status = process_incoming_push_msg (c, + buffer, + c->options.pull, + pull_permission_mask (), + &option_types_found); + + if (status == PUSH_MSG_ERROR) + msg (D_PUSH_ERRORS, "WARNING: Received bad push/pull message: %s", BSTR (buffer)); + else if (status == PUSH_MSG_REPLY) + { + do_up (c, true, option_types_found); /* delay bringing tun/tap up until --push parms received from remote */ + event_timeout_clear (&c->c2.push_request_interval); + } + + gc_free (&gc); +} + +bool +send_push_request (struct context *c) +{ + return send_control_channel_string (c, "PUSH_REQUEST", D_PUSH); +} + +#if P2MP_SERVER +bool +send_push_reply (struct context *c) +{ + struct gc_arena gc = gc_new (); + struct buffer buf = alloc_buf_gc (MAX_PUSH_LIST_LEN + 256, &gc); + bool ret = false; + + buf_printf (&buf, "PUSH_REPLY"); + + if (c->options.push_list && strlen (c->options.push_list->options)) + buf_printf (&buf, ",%s", c->options.push_list->options); + + if (c->c2.push_ifconfig_defined && c->c2.push_ifconfig_local && c->c2.push_ifconfig_remote_netmask) + buf_printf (&buf, ",ifconfig %s %s", + print_in_addr_t (c->c2.push_ifconfig_local, 0, &gc), + print_in_addr_t (c->c2.push_ifconfig_remote_netmask, 0, &gc)); + + if (strlen (BSTR (&buf)) < MAX_PUSH_LIST_LEN) + ret = send_control_channel_string (c, BSTR (&buf), D_PUSH); + else + msg (M_WARN, "Maximum length of --push buffer (%d) has been exceeded", MAX_PUSH_LIST_LEN); + + gc_free (&gc); + return ret; +} + +void +push_option (struct options *o, const char *opt, int msglevel) +{ + int len; + bool first = false; + + if (!string_class (opt, CC_ANY, CC_COMMA)) + { + msg (msglevel, "PUSH OPTION FAILED (illegal comma (',') in string): '%s'", opt); + } + else + { + if (!o->push_list) + { + ALLOC_OBJ_CLEAR_GC (o->push_list, struct push_list, &o->gc); + first = true; + } + + len = strlen (o->push_list->options); + if (len + strlen (opt) + 2 >= MAX_PUSH_LIST_LEN) + { + msg (msglevel, "Maximum length of --push buffer (%d) has been exceeded", MAX_PUSH_LIST_LEN); + } + else + { + if (!first) + strcat (o->push_list->options, ","); + strcat (o->push_list->options, opt); + } + } +} + +void +push_reset (struct options *o) +{ + o->push_list = NULL; +} +#endif + +int +process_incoming_push_msg (struct context *c, + const struct buffer *buffer, + bool honor_received_options, + unsigned int permission_mask, + unsigned int *option_types_found) +{ + int ret = PUSH_MSG_ERROR; + struct buffer buf = *buffer; + +#if P2MP_SERVER + if (buf_string_compare_advance (&buf, "PUSH_REQUEST")) + { + if (!tls_authenticated (c->c2.tls_multi) || c->c2.context_auth == CAS_FAILED) + { + send_auth_failed (c); + schedule_exit (c, c->options.scheduled_exit_interval); + ret = PUSH_MSG_AUTH_FAILURE; + } + else if (!c->c2.push_reply_deferred && c->c2.context_auth == CAS_SUCCEEDED) + { + if (send_push_reply (c)) + ret = PUSH_MSG_REQUEST; + } + else + { + ret = PUSH_MSG_REQUEST_DEFERRED; + } + } + else +#endif + + if (honor_received_options && buf_string_compare_advance (&buf, "PUSH_REPLY")) + { + const uint8_t ch = buf_read_u8 (&buf); + if (ch == ',') + { + pre_pull_restore (&c->options); + c->c2.pulled_options_string = string_alloc (BSTR (&buf), &c->c2.gc); + if (apply_push_options (&c->options, + &buf, + permission_mask, + option_types_found, + c->c2.es)) + ret = PUSH_MSG_REPLY; + } + else if (ch == '\0') + { + ret = PUSH_MSG_REPLY; + } + /* show_settings (&c->options); */ + } + return ret; +} + +#if P2MP_SERVER +/* + * Remove iroutes from the push_list. + */ +void +remove_iroutes_from_push_route_list (struct options *o) +{ + if (o && o->push_list && o->iroutes) + { + struct gc_arena gc = gc_new (); + struct push_list *pl; + struct buffer in, out; + char *line; + bool first = true; + + /* prepare input and output buffers */ + ALLOC_OBJ_CLEAR_GC (pl, struct push_list, &gc); + ALLOC_ARRAY_CLEAR_GC (line, char, MAX_PUSH_LIST_LEN, &gc); + + buf_set_read (&in, (const uint8_t*) o->push_list->options, strlen (o->push_list->options)); + buf_set_write (&out, (uint8_t*) pl->options, sizeof (pl->options)); + + /* cycle through the push list */ + while (buf_parse (&in, ',', line, MAX_PUSH_LIST_LEN)) + { + char *p[MAX_PARMS]; + bool copy = true; + + /* parse the push item */ + CLEAR (p); + if (parse_line (line, p, SIZE (p), "[PUSH_ROUTE_REMOVE]", 1, D_ROUTE_DEBUG, &gc)) + { + /* is the push item a route directive? */ + if (p[0] && p[1] && p[2] && !strcmp (p[0], "route")) + { + /* get route parameters */ + bool status1, status2; + const in_addr_t network = getaddr (GETADDR_HOST_ORDER, p[1], 0, &status1, NULL); + const in_addr_t netmask = getaddr (GETADDR_HOST_ORDER, p[2], 0, &status2, NULL); + + /* did route parameters parse correctly? */ + if (status1 && status2) + { + const struct iroute *ir; + + /* does route match an iroute? */ + for (ir = o->iroutes; ir != NULL; ir = ir->next) + { + if (network == ir->network && netmask == netbits_to_netmask (ir->netbits)) + { + copy = false; + break; + } + } + } + } + } + + /* should we copy the push item? */ + if (copy) + { + if (!first) + buf_printf (&out, ","); + buf_printf (&out, "%s", line); + first = false; + } + else + msg (D_PUSH, "REMOVE PUSH ROUTE: '%s'", line); + } + +#if 0 + msg (M_INFO, "BEFORE: '%s'", o->push_list->options); + msg (M_INFO, "AFTER: '%s'", pl->options); +#endif + + /* copy new push list back to options */ + *o->push_list = *pl; + + gc_free (&gc); + } +} +#endif + +#endif @@ -0,0 +1,65 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef PUSH_H +#define PUSH_H + +#if P2MP + +#include "forward.h" + +#define PUSH_MSG_ERROR 0 +#define PUSH_MSG_REQUEST 1 +#define PUSH_MSG_REPLY 2 +#define PUSH_MSG_REQUEST_DEFERRED 3 +#define PUSH_MSG_AUTH_FAILURE 4 + +void incoming_push_message (struct context *c, + const struct buffer *buffer); + +int process_incoming_push_msg (struct context *c, + const struct buffer *buffer, + bool honor_received_options, + unsigned int permission_mask, + unsigned int *option_types_found); + +bool send_push_request (struct context *c); + +void receive_auth_failed (struct context *c, const struct buffer *buffer); + +#if P2MP_SERVER + +void push_option (struct options *o, const char *opt, int msglevel); + +void push_reset (struct options *o); + +bool send_push_reply (struct context *c); + +void remove_iroutes_from_push_route_list (struct options *o); + +bool send_auth_failed (struct context *c); + +#endif +#endif +#endif diff --git a/reliable.c b/reliable.c new file mode 100644 index 0000000..ca83b2b --- /dev/null +++ b/reliable.c @@ -0,0 +1,700 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * These routines implement a reliability layer on top of UDP, + * so that SSL/TLS can be run over UDP. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +#include "syshead.h" + +#include "buffer.h" +#include "error.h" +#include "common.h" +#include "reliable.h" + +#include "memdbg.h" + +/* check if a particular packet_id is present in ack */ +static inline bool +reliable_ack_packet_id_present (struct reliable_ack *ack, packet_id_type pid) +{ + int i; + for (i = 0; i < ack->len; ++i) + if (ack->packet_id[i] == pid) + return true; + return false; +} + +/* get a packet_id from buf */ +bool +reliable_ack_read_packet_id (struct buffer *buf, packet_id_type *pid) +{ + packet_id_type net_pid; + + if (buf_read (buf, &net_pid, sizeof (net_pid))) + { + *pid = ntohpid (net_pid); + dmsg (D_REL_DEBUG, "ACK read ID " packet_id_format " (buf->len=%d)", + (packet_id_print_type)*pid, buf->len); + return true; + } + + dmsg (D_REL_LOW, "ACK read ID FAILED (buf->len=%d)", buf->len); + return false; +} + +/* acknowledge a packet_id by adding it to a struct reliable_ack */ +bool +reliable_ack_acknowledge_packet_id (struct reliable_ack *ack, packet_id_type pid) +{ + if (!reliable_ack_packet_id_present (ack, pid) && ack->len < RELIABLE_ACK_SIZE) + { + ack->packet_id[ack->len++] = pid; + dmsg (D_REL_DEBUG, "ACK acknowledge ID " packet_id_format " (ack->len=%d)", + (packet_id_print_type)pid, ack->len); + return true; + } + + dmsg (D_REL_LOW, "ACK acknowledge ID " packet_id_format " FAILED (ack->len=%d)", + (packet_id_print_type)pid, ack->len); + return false; +} + +/* read a packet ID acknowledgement record from buf into ack */ +bool +reliable_ack_read (struct reliable_ack * ack, + struct buffer * buf, const struct session_id * sid) +{ + struct gc_arena gc = gc_new (); + int i; + uint8_t count; + packet_id_type net_pid; + packet_id_type pid; + struct session_id session_id_remote; + + if (!buf_read (buf, &count, sizeof (count))) + goto error; + for (i = 0; i < count; ++i) + { + if (!buf_read (buf, &net_pid, sizeof (net_pid))) + goto error; + if (ack->len >= RELIABLE_ACK_SIZE) + goto error; + pid = ntohpid (net_pid); + ack->packet_id[ack->len++] = pid; + } + if (count) + { + if (!session_id_read (&session_id_remote, buf)) + goto error; + if (!session_id_defined (&session_id_remote) || + !session_id_equal (&session_id_remote, sid)) + { + dmsg (D_REL_LOW, + "ACK read BAD SESSION-ID FROM REMOTE, local=%s, remote=%s", + session_id_print (sid, &gc), session_id_print (&session_id_remote, &gc)); + goto error; + } + } + gc_free (&gc); + return true; + +error: + gc_free (&gc); + return false; +} + +#define ACK_SIZE(n) (sizeof (uint8_t) + ((n) ? SID_SIZE : 0) + sizeof (packet_id_type) * (n)) + +/* write a packet ID acknowledgement record to buf, */ +/* removing all acknowledged entries from ack */ +bool +reliable_ack_write (struct reliable_ack * ack, + struct buffer * buf, + const struct session_id * sid, int max, bool prepend) +{ + int i, j; + uint8_t n; + struct buffer sub; + + n = ack->len; + if (n > max) + n = max; + sub = buf_sub (buf, ACK_SIZE(n), prepend); + if (!BDEF (&sub)) + goto error; + ASSERT (buf_write (&sub, &n, sizeof (n))); + for (i = 0; i < n; ++i) + { + packet_id_type pid = ack->packet_id[i]; + packet_id_type net_pid = htonpid (pid); + ASSERT (buf_write (&sub, &net_pid, sizeof (net_pid))); + dmsg (D_REL_DEBUG, "ACK write ID " packet_id_format " (ack->len=%d, n=%d)", (packet_id_print_type)pid, ack->len, n); + } + if (n) + { + ASSERT (session_id_defined (sid)); + ASSERT (session_id_write (sid, &sub)); + for (i = 0, j = n; j < ack->len;) + ack->packet_id[i++] = ack->packet_id[j++]; + ack->len = i; + } + + return true; + +error: + return false; +} + +/* add to extra_frame the maximum number of bytes we will need for reliable_ack_write */ +void +reliable_ack_adjust_frame_parameters (struct frame* frame, int max) +{ + frame_add_to_extra_frame (frame, ACK_SIZE (max)); +} + +/* print a reliable ACK record coming off the wire */ +const char * +reliable_ack_print (struct buffer *buf, bool verbose, struct gc_arena *gc) +{ + int i; + uint8_t n_ack; + struct session_id sid_ack; + packet_id_type pid; + struct buffer out = alloc_buf_gc (256, gc); + + buf_printf (&out, "["); + if (!buf_read (buf, &n_ack, sizeof (n_ack))) + goto done; + for (i = 0; i < n_ack; ++i) + { + if (!buf_read (buf, &pid, sizeof (pid))) + goto done; + pid = ntohpid (pid); + buf_printf (&out, " " packet_id_format, (packet_id_print_type)pid); + } + if (n_ack) + { + if (!session_id_read (&sid_ack, buf)) + goto done; + if (verbose) + buf_printf (&out, " sid=%s", session_id_print (&sid_ack, gc)); + } + + done: + buf_printf (&out, " ]"); + return BSTR (&out); +} + +/* + * struct reliable member functions. + */ + +void +reliable_init (struct reliable *rel, int buf_size, int offset, int array_size) +{ + int i; + + CLEAR (*rel); + ASSERT (array_size > 0 && array_size <= RELIABLE_CAPACITY); + rel->size = array_size; + rel->offset = offset; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + e->buf = alloc_buf (buf_size); + ASSERT (buf_init (&e->buf, offset)); + } +} + +void +reliable_free (struct reliable *rel) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + free_buf (&e->buf); + } +} + +/* no active buffers? */ +bool +reliable_empty (const struct reliable *rel) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active) + return false; + } + return true; +} + +/* del acknowledged items from send buf */ +void +reliable_send_purge (struct reliable *rel, struct reliable_ack *ack) +{ + int i, j; + for (i = 0; i < ack->len; ++i) + { + packet_id_type pid = ack->packet_id[i]; + for (j = 0; j < rel->size; ++j) + { + struct reliable_entry *e = &rel->array[j]; + if (e->active && e->packet_id == pid) + { + dmsg (D_REL_DEBUG, + "ACK received for pid " packet_id_format ", deleting from send buffer", + (packet_id_print_type)pid); +#if 0 + /* DEBUGGING -- how close were we timing out on ACK failure and resending? */ + { + if (e->next_try) + { + const interval_t wake = e->next_try - now; + msg (M_INFO, "ACK " packet_id_format ", wake=%d", pid, wake); + } + } +#endif + e->active = false; + break; + } + } + } +} + +/* print the current sequence of active packet IDs */ +static const char * +reliable_print_ids (const struct reliable *rel, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + int i; + + buf_printf (&out, "[" packet_id_format "]", (packet_id_print_type)rel->packet_id); + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active) + buf_printf (&out, " " packet_id_format, (packet_id_print_type)e->packet_id); + } + return BSTR (&out); +} + +/* true if at least one free buffer available */ +bool +reliable_can_get (const struct reliable *rel) +{ + struct gc_arena gc = gc_new (); + int i; + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (!e->active) + return true; + } + dmsg (D_REL_LOW, "ACK no free receive buffer available: %s", reliable_print_ids (rel, &gc)); + gc_free (&gc); + return false; +} + +/* make sure that incoming packet ID isn't a replay */ +bool +reliable_not_replay (const struct reliable *rel, packet_id_type id) +{ + struct gc_arena gc = gc_new (); + int i; + if (id < rel->packet_id) + goto bad; + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active && e->packet_id == id) + goto bad; + } + gc_free (&gc); + return true; + + bad: + dmsg (D_REL_DEBUG, "ACK " packet_id_format " is a replay: %s", (packet_id_print_type)id, reliable_print_ids (rel, &gc)); + gc_free (&gc); + return false; +} + +/* make sure that incoming packet ID won't deadlock the receive buffer */ +bool +reliable_wont_break_sequentiality (const struct reliable *rel, packet_id_type id) +{ + struct gc_arena gc = gc_new (); + int ret; + + if ((int)id < (int)rel->packet_id + rel->size) + { + ret = true; + } + else + { + dmsg (D_REL_LOW, "ACK " packet_id_format " breaks sequentiality: %s", + (packet_id_print_type)id, reliable_print_ids (rel, &gc)); + ret = false; + } + gc_free (&gc); + return ret; +} + +/* grab a free buffer */ +struct buffer * +reliable_get_buf (struct reliable *rel) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (!e->active) + { + ASSERT (buf_init (&e->buf, rel->offset)); + return &e->buf; + } + } + return NULL; +} + +/* grab a free buffer, fail if buffer clogged by unacknowledged low packet IDs */ +struct buffer * +reliable_get_buf_output_sequenced (struct reliable *rel) +{ + struct gc_arena gc = gc_new (); + int i; + packet_id_type min_id = 0; + bool min_id_defined = false; + struct buffer *ret = NULL; + + /* find minimum active packet_id */ + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active) + { + if (!min_id_defined || e->packet_id < min_id) + { + min_id_defined = true; + min_id = e->packet_id; + } + } + } + + if (!min_id_defined || (int)(rel->packet_id - min_id) < rel->size) + { + ret = reliable_get_buf (rel); + } + else + { + dmsg (D_REL_LOW, "ACK output sequence broken: %s", reliable_print_ids (rel, &gc)); + } + gc_free (&gc); + return ret; +} + +/* get active buffer for next sequentially increasing key ID */ +struct buffer * +reliable_get_buf_sequenced (struct reliable *rel) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (e->active && e->packet_id == rel->packet_id) + { + return &e->buf; + } + } + return NULL; +} + +/* return true if reliable_send would return a non-NULL result */ +bool +reliable_can_send (const struct reliable *rel) +{ + struct gc_arena gc = gc_new (); + int i; + int n_active = 0, n_current = 0; + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active) + { + ++n_active; + if (now >= e->next_try) + ++n_current; + } + } + dmsg (D_REL_DEBUG, "ACK reliable_can_send active=%d current=%d : %s", + n_active, + n_current, + reliable_print_ids (rel, &gc)); + + gc_free (&gc); + return n_current > 0; +} + +/* return a unique point-in-time to trigger retry */ +static time_t +reliable_unique_retry (struct reliable *rel, time_t retry) +{ + int i; + while (true) + { + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (e->active && e->next_try == retry) + goto again; + } + break; + again: + ++retry; + } + return retry; +} + +/* return next buffer to send to remote */ +struct buffer * +reliable_send (struct reliable *rel, int *opcode) +{ + int i; + struct reliable_entry *best = NULL; + const time_t local_now = now; + + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (e->active && local_now >= e->next_try) + { + if (!best || e->packet_id < best->packet_id) + best = e; + } + } + if (best) + { +#ifdef EXPONENTIAL_BACKOFF + /* exponential backoff */ + best->next_try = reliable_unique_retry (rel, local_now + best->timeout); + best->timeout *= 2; +#else + /* constant timeout, no backoff */ + best->next_try = local_now + best->timeout; +#endif + *opcode = best->opcode; + dmsg (D_REL_DEBUG, "ACK reliable_send ID " packet_id_format " (size=%d to=%d)", + (packet_id_print_type)best->packet_id, best->buf.len, + (int)(best->next_try - local_now)); + return &best->buf; + } + return NULL; +} + +/* schedule all pending packets for immediate retransmit */ +void +reliable_schedule_now (struct reliable *rel) +{ + int i; + dmsg (D_REL_DEBUG, "ACK reliable_schedule_now"); + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (e->active) + { + e->next_try = now; + e->timeout = rel->initial_timeout; + } + } +} + +/* in how many seconds should we wake up to check for timeout */ +/* if we return BIG_TIMEOUT, nothing to wait for */ +interval_t +reliable_send_timeout (const struct reliable *rel) +{ + struct gc_arena gc = gc_new (); + interval_t ret = BIG_TIMEOUT; + int i; + const time_t local_now = now; + + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active) + { + if (e->next_try <= local_now) + { + ret = 0; + break; + } + else + { + ret = min_int (ret, e->next_try - local_now); + } + } + } + + dmsg (D_REL_DEBUG, "ACK reliable_send_timeout %d %s", + (int) ret, + reliable_print_ids (rel, &gc)); + + gc_free (&gc); + return ret; +} + +/* + * Enable an incoming buffer previously returned by a get function as active. + */ + +void +reliable_mark_active_incoming (struct reliable *rel, struct buffer *buf, + packet_id_type pid, int opcode) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (buf == &e->buf) + { + e->active = true; + + /* packets may not arrive in sequential order */ + e->packet_id = pid; + + /* check for replay */ + ASSERT (pid >= rel->packet_id); + + e->opcode = opcode; + e->next_try = 0; + e->timeout = 0; + dmsg (D_REL_DEBUG, "ACK mark active incoming ID " packet_id_format, (packet_id_print_type)e->packet_id); + return; + } + } + ASSERT (0); /* buf not found in rel */ +} + +/* + * Enable an outgoing buffer previously returned by a get function as active. + */ + +void +reliable_mark_active_outgoing (struct reliable *rel, struct buffer *buf, int opcode) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (buf == &e->buf) + { + /* Write mode, increment packet_id (i.e. sequence number) + linearly and prepend id to packet */ + packet_id_type net_pid; + e->packet_id = rel->packet_id++; + net_pid = htonpid (e->packet_id); + ASSERT (buf_write_prepend (buf, &net_pid, sizeof (net_pid))); + e->active = true; + e->opcode = opcode; + e->next_try = 0; + e->timeout = rel->initial_timeout; + dmsg (D_REL_DEBUG, "ACK mark active outgoing ID " packet_id_format, (packet_id_print_type)e->packet_id); + return; + } + } + ASSERT (0); /* buf not found in rel */ +} + +/* delete a buffer previously activated by reliable_mark_active() */ +void +reliable_mark_deleted (struct reliable *rel, struct buffer *buf, bool inc_pid) +{ + int i; + for (i = 0; i < rel->size; ++i) + { + struct reliable_entry *e = &rel->array[i]; + if (buf == &e->buf) + { + e->active = false; + if (inc_pid) + rel->packet_id = e->packet_id + 1; + return; + } + } + ASSERT (0); +} + +#if 0 + +void +reliable_ack_debug_print (const struct reliable_ack *ack, char *desc) +{ + int i; + + printf ("********* struct reliable_ack %s\n", desc); + for (i = 0; i < ack->len; ++i) + { + printf (" %d: " packet_id_format "\n", i, (packet_id_print_type) ack->packet_id[i]); + } +} + +void +reliable_debug_print (const struct reliable *rel, char *desc) +{ + int i; + update_time (); + + printf ("********* struct reliable %s\n", desc); + printf (" initial_timeout=%d\n", (int)rel->initial_timeout); + printf (" packet_id=" packet_id_format "\n", rel->packet_id); + printf (" now=" time_format "\n", now); + for (i = 0; i < rel->size; ++i) + { + const struct reliable_entry *e = &rel->array[i]; + if (e->active) + { + printf (" %d: packet_id=" packet_id_format " len=%d", i, e->packet_id, e->buf.len); + printf (" next_try=" time_format, e->next_try); + printf ("\n"); + } + } +} + +#endif + +#else +static void dummy(void) {} +#endif /* USE_CRYPTO && USE_SSL*/ diff --git a/reliable.h b/reliable.h new file mode 100644 index 0000000..d498f64 --- /dev/null +++ b/reliable.h @@ -0,0 +1,162 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * This routines implement a reliability layer on top of UDP, + * so that TLS can be run over UDP. + */ + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +#ifndef RELIABLE_H +#define RELIABLE_H + +#include "basic.h" +#include "buffer.h" +#include "packet_id.h" +#include "session_id.h" +#include "mtu.h" + +/* #define EXPONENTIAL_BACKOFF */ + +#define RELIABLE_ACK_SIZE 8 + +struct reliable_ack +{ + int len; + packet_id_type packet_id[RELIABLE_ACK_SIZE]; +}; + +/* no active buffers? */ +static inline bool +reliable_ack_empty (struct reliable_ack *ack) +{ + return !ack->len; +} + +/* get a packet_id from buf */ +bool reliable_ack_read_packet_id (struct buffer *buf, packet_id_type *pid); + +/* acknowledge a packet_id by adding it to a struct reliable_ack */ +bool reliable_ack_acknowledge_packet_id (struct reliable_ack *ack, packet_id_type pid); + +/* read a packet ID acknowledgement record from buf */ +bool reliable_ack_read (struct reliable_ack *ack, + struct buffer *buf, const struct session_id *sid); + +/* write a packet ID acknowledgement record to buf */ +bool reliable_ack_write (struct reliable_ack *ack, + struct buffer *buf, + const struct session_id *sid, int max, bool prepend); + +/* print a reliable ACK record coming off the wire */ +const char *reliable_ack_print (struct buffer *buf, bool verbose, struct gc_arena *gc); + +/* add to extra_frame the maximum number of bytes we will need for reliable_ack_write */ +void reliable_ack_adjust_frame_parameters (struct frame* frame, int max); + +void reliable_ack_debug_print (const struct reliable_ack *ack, char *desc); + +#define RELIABLE_CAPACITY 8 + +struct reliable_entry +{ + bool active; + interval_t timeout; + time_t next_try; + packet_id_type packet_id; + int opcode; + struct buffer buf; +}; + +struct reliable +{ + int size; + interval_t initial_timeout; + packet_id_type packet_id; + int offset; + struct reliable_entry array[RELIABLE_CAPACITY]; +}; + +void reliable_debug_print (const struct reliable *rel, char *desc); + +/* set sending timeout (after this time we send again until ACK) */ +static inline void +reliable_set_timeout (struct reliable *rel, interval_t timeout) +{ + rel->initial_timeout = timeout; +} + +void reliable_init (struct reliable *rel, int buf_size, int offset, int array_size); + +void reliable_free (struct reliable *rel); + +/* no active buffers? */ +bool reliable_empty (const struct reliable *rel); + +/* in how many seconds should we wake up to check for timeout */ +interval_t reliable_send_timeout (const struct reliable *rel); + +/* del acknowledged items from send buf */ +void reliable_send_purge (struct reliable *rel, struct reliable_ack *ack); + +/* true if at least one free buffer available */ +bool reliable_can_get (const struct reliable *rel); + +/* make sure that incoming packet ID isn't a replay */ +bool reliable_not_replay (const struct reliable *rel, packet_id_type id); + +/* make sure that incoming packet ID won't deadlock the receive buffer */ +bool reliable_wont_break_sequentiality (const struct reliable *rel, packet_id_type id); + +/* grab a free buffer */ +struct buffer *reliable_get_buf (struct reliable *rel); + +/* grab a free buffer, fail if buffer clogged by unacknowledged low packet IDs */ +struct buffer *reliable_get_buf_output_sequenced (struct reliable *rel); + +/* get active buffer for next sequentially increasing key ID */ +struct buffer *reliable_get_buf_sequenced (struct reliable *rel); + +/* return true if reliable_send would return a non-NULL result */ +bool reliable_can_send (const struct reliable *rel); + +/* return next buffer to send to remote */ +struct buffer *reliable_send (struct reliable *rel, int *opcode); + +/* schedule all pending packets for immediate retransmit */ +void reliable_schedule_now (struct reliable *rel); + +/* enable an incoming buffer previously returned by a get function as active */ +void reliable_mark_active_incoming (struct reliable *rel, struct buffer *buf, + packet_id_type pid, int opcode); + +/* enable an outgoing buffer previously returned by a get function as active. */ +void reliable_mark_active_outgoing (struct reliable *rel, struct buffer *buf, int opcode); + +/* delete a buffer previously activated by reliable_mark_active() */ +void reliable_mark_deleted (struct reliable *rel, struct buffer *buf, bool inc_pid); + +#endif /* RELIABLE_H */ +#endif /* USE_CRYPTO && USE_SSL */ @@ -0,0 +1,1776 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Support routines for adding/deleting network routes. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "common.h" +#include "error.h" +#include "route.h" +#include "misc.h" +#include "socket.h" +#include "manage.h" + +#include "memdbg.h" + +static void add_route (struct route *r, const struct tuntap *tt, unsigned int flags, const struct env_set *es); +static void delete_route (const struct route *r, const struct tuntap *tt, unsigned int flags, const struct env_set *es); +static bool get_default_gateway (in_addr_t *ret); + +struct route_option_list * +new_route_option_list (struct gc_arena *a) +{ + struct route_option_list *ret; + ALLOC_OBJ_CLEAR_GC (ret, struct route_option_list, a); + return ret; +} + +struct route_list * +new_route_list (struct gc_arena *a) +{ + struct route_list *ret; + ALLOC_OBJ_CLEAR_GC (ret, struct route_list, a); + return ret; +} + +static const char * +route_string (const struct route *r, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + buf_printf (&out, "ROUTE network %s netmask %s gateway %s", + print_in_addr_t (r->network, 0, gc), + print_in_addr_t (r->netmask, 0, gc), + print_in_addr_t (r->gateway, 0, gc) + ); + if (r->metric_defined) + buf_printf (&out, " metric %d", r->metric); + return BSTR (&out); +} + +static bool +is_route_parm_defined (const char *parm) +{ + if (!parm) + return false; + if (!strcmp (parm, "default")) + return false; + return true; +} + +static void +setenv_route_addr (struct env_set *es, const char *key, const in_addr_t addr, int i) +{ + struct gc_arena gc = gc_new (); + struct buffer name = alloc_buf_gc (256, &gc); + if (i >= 0) + buf_printf (&name, "route_%s_%d", key, i); + else + buf_printf (&name, "route_%s", key); + setenv_str (es, BSTR (&name), print_in_addr_t (addr, 0, &gc)); + gc_free (&gc); +} + +static bool +get_special_addr (const struct route_special_addr *spec, + const char *string, + in_addr_t *out, + bool *status) +{ + *status = true; + if (!strcmp (string, "vpn_gateway")) + { + if (spec->remote_endpoint_defined) + *out = spec->remote_endpoint; + else + { + msg (M_INFO, PACKAGE_NAME " ROUTE: vpn_gateway undefined"); + *status = false; + } + return true; + } + else if (!strcmp (string, "net_gateway")) + { + if (spec->net_gateway_defined) + *out = spec->net_gateway; + else + { + msg (M_INFO, PACKAGE_NAME " ROUTE: net_gateway undefined -- unable to get default gateway from system"); + *status = false; + } + return true; + } + else if (!strcmp (string, "remote_host")) + { + if (spec->remote_host_defined) + *out = spec->remote_host; + else + { + msg (M_INFO, PACKAGE_NAME " ROUTE: remote_host undefined"); + *status = false; + } + return true; + } + return false; +} + +static bool +init_route (struct route *r, + const struct route_option *ro, + const struct route_special_addr *spec) +{ + const in_addr_t default_netmask = ~0; + bool status; + + r->option = ro; + r->defined = false; + + /* network */ + + if (!is_route_parm_defined (ro->network)) + { + goto fail; + } + + if (!get_special_addr (spec, ro->network, &r->network, &status)) + { + r->network = getaddr ( + GETADDR_RESOLVE + | GETADDR_HOST_ORDER + | GETADDR_WARN_ON_SIGNAL, + ro->network, + 0, + &status, + NULL); + } + + if (!status) + goto fail; + + /* netmask */ + + if (is_route_parm_defined (ro->netmask)) + { + r->netmask = getaddr ( + GETADDR_HOST_ORDER + | GETADDR_WARN_ON_SIGNAL, + ro->netmask, + 0, + &status, + NULL); + if (!status) + goto fail; + } + else + r->netmask = default_netmask; + + /* gateway */ + + if (is_route_parm_defined (ro->gateway)) + { + if (!get_special_addr (spec, ro->gateway, &r->gateway, &status)) + { + r->gateway = getaddr ( + GETADDR_RESOLVE + | GETADDR_HOST_ORDER + | GETADDR_WARN_ON_SIGNAL, + ro->gateway, + 0, + &status, + NULL); + } + if (!status) + goto fail; + } + else + { + if (spec->remote_endpoint_defined) + r->gateway = spec->remote_endpoint; + else + { + msg (M_WARN, PACKAGE_NAME " ROUTE: " PACKAGE_NAME " needs a gateway parameter for a --route option and no default was specified by either --route-gateway or --ifconfig options"); + goto fail; + } + } + + /* metric */ + + r->metric_defined = false; + r->metric = 0; + if (is_route_parm_defined (ro->metric)) + { + r->metric = atoi (ro->metric); + if (r->metric < 0) + { + msg (M_WARN, PACKAGE_NAME " ROUTE: route metric for network %s (%s) must be >= 0", + ro->network, + ro->metric); + goto fail; + } + r->metric_defined = true; + } + else + { + r->metric = 0; + r->metric_defined = false; + } + + r->defined = true; + + return true; + + fail: + msg (M_WARN, PACKAGE_NAME " ROUTE: failed to parse/resolve route for host/network: %s", + ro->network); + r->defined = false; + return false; +} + +void +add_route_to_option_list (struct route_option_list *l, + const char *network, + const char *netmask, + const char *gateway, + const char *metric) +{ + struct route_option *ro; + if (l->n >= MAX_ROUTES) + msg (M_FATAL, PACKAGE_NAME " ROUTE: cannot add more than %d routes", + MAX_ROUTES); + ro = &l->routes[l->n]; + ro->network = network; + ro->netmask = netmask; + ro->gateway = gateway; + ro->metric = metric; + ++l->n; +} + +void +clear_route_list (struct route_list *rl) +{ + CLEAR (*rl); +} + +bool +init_route_list (struct route_list *rl, + const struct route_option_list *opt, + const char *remote_endpoint, + in_addr_t remote_host, + struct env_set *es) +{ + bool ret = true; + + clear_route_list (rl); + + if (remote_host) + { + rl->spec.remote_host = remote_host; + rl->spec.remote_host_defined = true; + } + + rl->spec.net_gateway_defined = get_default_gateway (&rl->spec.net_gateway); + if (rl->spec.net_gateway_defined) + { + setenv_route_addr (es, "net_gateway", rl->spec.net_gateway, -1); + } + rl->redirect_default_gateway = opt->redirect_default_gateway; + rl->redirect_local = opt->redirect_local; + rl->redirect_def1 = opt->redirect_def1; + + if (is_route_parm_defined (remote_endpoint)) + { + rl->spec.remote_endpoint = getaddr ( + GETADDR_RESOLVE + | GETADDR_HOST_ORDER + | GETADDR_WARN_ON_SIGNAL, + remote_endpoint, + 0, + &rl->spec.remote_endpoint_defined, + NULL); + + if (rl->spec.remote_endpoint_defined) + { + setenv_route_addr (es, "vpn_gateway", rl->spec.remote_endpoint, -1); + } + else + { + msg (M_WARN, PACKAGE_NAME " ROUTE: failed to parse/resolve default gateway: %s", + remote_endpoint); + ret = false; + } + } + else + rl->spec.remote_endpoint_defined = false; + + ASSERT (opt->n >= 0 && opt->n < MAX_ROUTES); + + /* parse the routes from opt to rl */ + { + int i, j = 0; + for (i = 0; i < opt->n; ++i) + { + if (!init_route (&rl->routes[j], + &opt->routes[i], + &rl->spec)) + ret = false; + else + ++j; + } + rl->n = j; + } + + return ret; +} + +static void +add_route3 (in_addr_t network, + in_addr_t netmask, + in_addr_t gateway, + const struct tuntap *tt, + unsigned int flags, + const struct env_set *es) +{ + struct route r; + CLEAR (r); + r.defined = true; + r.network = network; + r.netmask = netmask; + r.gateway = gateway; + add_route (&r, tt, flags, es); +} + +static void +del_route3 (in_addr_t network, + in_addr_t netmask, + in_addr_t gateway, + const struct tuntap *tt, + unsigned int flags, + const struct env_set *es) +{ + struct route r; + CLEAR (r); + r.defined = true; + r.network = network; + r.netmask = netmask; + r.gateway = gateway; + delete_route (&r, tt, flags, es); +} + +static void +redirect_default_route_to_vpn (struct route_list *rl, const struct tuntap *tt, unsigned int flags, const struct env_set *es) +{ + const char err[] = "NOTE: unable to redirect default gateway --"; + + if (rl->redirect_default_gateway) + { + if (!rl->spec.remote_endpoint_defined) + { + msg (M_WARN, "%s VPN gateway parameter (--route-gateway or --ifconfig) is missing", err); + } + else if (!rl->spec.net_gateway_defined) + { + msg (M_WARN, "%s Cannot read current default gateway from system", err); + } + else if (!rl->spec.remote_host_defined) + { + msg (M_WARN, "%s Cannot obtain current remote host address", err); + } + else + { + /* route remote host to original default gateway */ + if (!rl->redirect_local) + add_route3 (rl->spec.remote_host, + ~0, + rl->spec.net_gateway, + tt, + flags, + es); + + if (rl->redirect_def1) + { + /* add new default route (1st component) */ + add_route3 (0x00000000, + 0x80000000, + rl->spec.remote_endpoint, + tt, + flags, + es); + + /* add new default route (2nd component) */ + add_route3 (0x80000000, + 0x80000000, + rl->spec.remote_endpoint, + tt, + flags, + es); + } + else + { + /* delete default route */ + del_route3 (0, + 0, + rl->spec.net_gateway, + tt, + flags, + es); + + /* add new default route */ + add_route3 (0, + 0, + rl->spec.remote_endpoint, + tt, + flags, + es); + } + + /* set a flag so we can undo later */ + rl->did_redirect_default_gateway = true; + } + } +} + +static void +undo_redirect_default_route_to_vpn (struct route_list *rl, const struct tuntap *tt, unsigned int flags, const struct env_set *es) +{ + if (rl->did_redirect_default_gateway) + { + /* delete remote host route */ + if (!rl->redirect_local) + del_route3 (rl->spec.remote_host, + ~0, + rl->spec.net_gateway, + tt, + flags, + es); + + if (rl->redirect_def1) + { + /* delete default route (1st component) */ + del_route3 (0x00000000, + 0x80000000, + rl->spec.remote_endpoint, + tt, + flags, + es); + + /* delete default route (2nd component) */ + del_route3 (0x80000000, + 0x80000000, + rl->spec.remote_endpoint, + tt, + flags, + es); + } + else + { + /* delete default route */ + del_route3 (0, + 0, + rl->spec.remote_endpoint, + tt, + flags, + es); + + /* restore original default route */ + add_route3 (0, + 0, + rl->spec.net_gateway, + tt, + flags, + es); + } + + rl->did_redirect_default_gateway = false; + } +} + +void +add_routes (struct route_list *rl, const struct tuntap *tt, unsigned int flags, const struct env_set *es) +{ + redirect_default_route_to_vpn (rl, tt, flags, es); + if (!rl->routes_added) + { + int i; + +#ifdef ENABLE_MANAGEMENT + if (management && rl->n) + { + management_set_state (management, + OPENVPN_STATE_ADD_ROUTES, + NULL, + 0); + } +#endif + + for (i = 0; i < rl->n; ++i) + { + if (flags & ROUTE_DELETE_FIRST) + delete_route (&rl->routes[i], tt, flags, es); + add_route (&rl->routes[i], tt, flags, es); + } + rl->routes_added = true; + } +} + +void +delete_routes (struct route_list *rl, const struct tuntap *tt, unsigned int flags, const struct env_set *es) +{ + if (rl->routes_added) + { + int i; + for (i = rl->n - 1; i >= 0; --i) + { + const struct route *r = &rl->routes[i]; + delete_route (r, tt, flags, es); + } + rl->routes_added = false; + } + undo_redirect_default_route_to_vpn (rl, tt, flags, es); + + CLEAR (*rl); +} + +#ifdef ENABLE_DEBUG + +static const char * +show_opt (const char *option) +{ + if (!option) + return "nil"; + else + return option; +} + +static void +print_route_option (const struct route_option *ro, int level) +{ + msg (level, " route %s/%s/%s/%s", + show_opt (ro->network), + show_opt (ro->netmask), + show_opt (ro->gateway), + show_opt (ro->metric)); +} + +void +print_route_options (const struct route_option_list *rol, + int level) +{ + int i; + if (rol->redirect_default_gateway) + msg (level, " [redirect_default_gateway local=%d]", + rol->redirect_local); + for (i = 0; i < rol->n; ++i) + print_route_option (&rol->routes[i], level); +} + +#endif + +static void +print_route (const struct route *r, int level) +{ + struct gc_arena gc = gc_new (); + if (r->defined) + msg (level, "%s", route_string (r, &gc)); + gc_free (&gc); +} + +void +print_routes (const struct route_list *rl, int level) +{ + int i; + for (i = 0; i < rl->n; ++i) + print_route (&rl->routes[i], level); +} + +static void +setenv_route (struct env_set *es, const struct route *r, int i) +{ + struct gc_arena gc = gc_new (); + if (r->defined) + { + setenv_route_addr (es, "network", r->network, i); + setenv_route_addr (es, "netmask", r->netmask, i); + setenv_route_addr (es, "gateway", r->gateway, i); + + if (r->metric_defined) + { + struct buffer name = alloc_buf_gc (256, &gc); + buf_printf (&name, "route_metric_%d", i); + setenv_int (es, BSTR (&name), r->metric); + } + } + gc_free (&gc); +} + +void +setenv_routes (struct env_set *es, const struct route_list *rl) +{ + int i; + for (i = 0; i < rl->n; ++i) + setenv_route (es, &rl->routes[i], i + 1); +} + +static void +add_route (struct route *r, const struct tuntap *tt, unsigned int flags, const struct env_set *es) +{ + struct gc_arena gc; + struct buffer buf; + const char *network; + const char *netmask; + const char *gateway; + bool status = false; + + if (!r->defined) + return; + + gc_init (&gc); + buf = alloc_buf_gc (256, &gc); + + network = print_in_addr_t (r->network, 0, &gc); + netmask = print_in_addr_t (r->netmask, 0, &gc); + gateway = print_in_addr_t (r->gateway, 0, &gc); + + /* + * Filter out routes which are essentially no-ops + */ + if (r->network == r->gateway && r->netmask == 0xFFFFFFFF) + { + msg (M_INFO, PACKAGE_NAME " ROUTE: omitted no-op route: %s/%s -> %s", + network, netmask, gateway); + goto done; + } + +#if defined(TARGET_LINUX) +#ifdef CONFIG_FEATURE_IPROUTE + buf_printf (&buf, IPROUTE_PATH " route add %s/%d via %s", + network, + count_netmask_bits(netmask), + gateway); + if (r->metric_defined) + buf_printf (&buf, " metric %d", r->metric); + +#else + buf_printf (&buf, ROUTE_PATH " add -net %s netmask %s gw %s", + network, + netmask, + gateway); + if (r->metric_defined) + buf_printf (&buf, " metric %d", r->metric); +#endif /*CONFIG_FEATURE_IPROUTE*/ + msg (D_ROUTE, "%s", BSTR (&buf)); + status = system_check (BSTR (&buf), es, 0, "ERROR: Linux route add command failed"); + +#elif defined (WIN32) + + buf_printf (&buf, ROUTE_PATH " ADD %s MASK %s %s", + network, + netmask, + gateway); + if (r->metric_defined) + buf_printf (&buf, " METRIC %d", r->metric); + + msg (D_ROUTE, "%s", BSTR (&buf)); + + if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_IPAPI) + { + status = add_route_ipapi (r, tt); + msg (D_ROUTE, "Route addition via IPAPI %s", status ? "succeeded" : "failed"); + } + else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_EXE) + { + netcmd_semaphore_lock (); + status = system_check (BSTR (&buf), es, 0, "ERROR: Windows route add command failed"); + netcmd_semaphore_release (); + } + else + { + ASSERT (0); + } + +#elif defined (TARGET_SOLARIS) + + /* example: route add 192.0.2.32 -netmask 255.255.255.224 somegateway */ + + buf_printf (&buf, ROUTE_PATH " add"); + +#if 0 + if (r->metric_defined) + buf_printf (&buf, " -rtt %d", r->metric); +#endif + + buf_printf (&buf, " %s -netmask %s %s", + network, + netmask, + gateway); + + msg (D_ROUTE, "%s", BSTR (&buf)); + status = system_check (BSTR (&buf), es, 0, "ERROR: Solaris route add command failed"); + +#elif defined(TARGET_FREEBSD) + + buf_printf (&buf, ROUTE_PATH " add"); + +#if 0 + if (r->metric_defined) + buf_printf (&buf, " -rtt %d", r->metric); +#endif + + buf_printf (&buf, " -net %s %s %s", + network, + gateway, + netmask); + + msg (D_ROUTE, "%s", BSTR (&buf)); + status = system_check (BSTR (&buf), es, 0, "ERROR: FreeBSD route add command failed"); + +#elif defined(TARGET_DARWIN) + + buf_printf (&buf, ROUTE_PATH " add"); + +#if 0 + if (r->metric_defined) + buf_printf (&buf, " -rtt %d", r->metric); +#endif + + buf_printf (&buf, " -net %s %s %s", + network, + gateway, + netmask); + + msg (D_ROUTE, "%s", BSTR (&buf)); + status = system_check (BSTR (&buf), es, 0, "ERROR: OS X route add command failed"); + +#elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD) + + buf_printf (&buf, ROUTE_PATH " add"); + +#if 0 + if (r->metric_defined) + buf_printf (&buf, " -rtt %d", r->metric); +#endif + + buf_printf (&buf, " -net %s %s -netmask %s", + network, + gateway, + netmask); + + msg (D_ROUTE, "%s", BSTR (&buf)); + status = system_check (BSTR (&buf), es, 0, "ERROR: OpenBSD/NetBSD route add command failed"); + +#else + msg (M_FATAL, "Sorry, but I don't know how to do 'route' commands on this operating system. Try putting your routes in a --route-up script"); +#endif + + done: + r->defined = status; + gc_free (&gc); +} + +static void +delete_route (const struct route *r, const struct tuntap *tt, unsigned int flags, const struct env_set *es) +{ + struct gc_arena gc; + struct buffer buf; + const char *network; + const char *netmask; + const char *gateway; + + if (!r->defined) + return; + + gc_init (&gc); + + buf = alloc_buf_gc (256, &gc); + network = print_in_addr_t (r->network, 0, &gc); + netmask = print_in_addr_t (r->netmask, 0, &gc); + gateway = print_in_addr_t (r->gateway, 0, &gc); + +#if defined(TARGET_LINUX) +#ifdef CONFIG_FEATURE_IPROUTE + buf_printf (&buf, IPROUTE_PATH " route del %s/%d", + network, + count_netmask_bits(netmask)); +#else + + buf_printf (&buf, ROUTE_PATH " del -net %s netmask %s", + network, + netmask); +#endif /*CONFIG_FEATURE_IPROUTE*/ + msg (D_ROUTE, "%s", BSTR (&buf)); + system_check (BSTR (&buf), es, 0, "ERROR: Linux route delete command failed"); + +#elif defined (WIN32) + + buf_printf (&buf, ROUTE_PATH " DELETE %s MASK %s %s", + network, + netmask, + gateway); + + msg (D_ROUTE, "%s", BSTR (&buf)); + + if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_IPAPI) + { + const bool status = del_route_ipapi (r, tt); + msg (D_ROUTE, "Route deletion via IPAPI %s", status ? "succeeded" : "failed"); + } + else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_EXE) + { + netcmd_semaphore_lock (); + system_check (BSTR (&buf), es, 0, "ERROR: Windows route delete command failed"); + netcmd_semaphore_release (); + } + else + { + ASSERT (0); + } + +#elif defined (TARGET_SOLARIS) + + buf_printf (&buf, ROUTE_PATH " delete %s -netmask %s %s", + network, + netmask, + gateway); + + msg (D_ROUTE, "%s", BSTR (&buf)); + system_check (BSTR (&buf), es, 0, "ERROR: Solaris route delete command failed"); + +#elif defined(TARGET_FREEBSD) + + buf_printf (&buf, ROUTE_PATH " delete -net %s %s %s", + network, + gateway, + netmask); + + msg (D_ROUTE, "%s", BSTR (&buf)); + system_check (BSTR (&buf), es, 0, "ERROR: FreeBSD route delete command failed"); + +#elif defined(TARGET_DARWIN) + + buf_printf (&buf, ROUTE_PATH " delete -net %s %s %s", + network, + gateway, + netmask); + + msg (D_ROUTE, "%s", BSTR (&buf)); + system_check (BSTR (&buf), es, 0, "ERROR: OS X route delete command failed"); + +#elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD) + + buf_printf (&buf, ROUTE_PATH " delete -net %s %s -netmask %s", + network, + gateway, + netmask); + + msg (D_ROUTE, "%s", BSTR (&buf)); + system_check (BSTR (&buf), es, 0, "ERROR: OpenBSD/NetBSD route delete command failed"); + +#else + msg (M_FATAL, "Sorry, but I don't know how to do 'route' commands on this operating system. Try putting your routes in a --route-up script"); +#endif + + gc_free (&gc); +} + +/* + * The --redirect-gateway option requires OS-specific code below + * to get the current default gateway. + */ + +#if defined(WIN32) + +static const MIB_IPFORWARDTABLE * +get_windows_routing_table (struct gc_arena *gc) +{ + ULONG size = 0; + PMIB_IPFORWARDTABLE rt = NULL; + DWORD status; + + status = GetIpForwardTable (NULL, &size, TRUE); + if (status == ERROR_INSUFFICIENT_BUFFER) + { + rt = (PMIB_IPFORWARDTABLE) gc_malloc (size, false, gc); + status = GetIpForwardTable (rt, &size, TRUE); + if (status != NO_ERROR) + { + msg (D_ROUTE, "NOTE: GetIpForwardTable returned error: %s (code=%u)", + strerror_win32 (status, gc), + (unsigned int)status); + rt = NULL; + } + } + return rt; +} + +static int +test_route (const IP_ADAPTER_INFO *adapters, + const in_addr_t gateway, + DWORD *index) +{ + int count = 0; + DWORD i = adapter_index_of_ip (adapters, gateway, &count); + if (index) + *index = i; + return count; +} + +static void +test_route_helper (bool *ret, + int *count, + int *good, + int *ambig, + const IP_ADAPTER_INFO *adapters, + const in_addr_t gateway) +{ + int c; + + ++*count; + c = test_route (adapters, gateway, NULL); + if (c == 0) + *ret = false; + else + ++*good; + if (c > 1) + ++*ambig; +} + +/* + * If we tried to add routes now, would we succeed? + */ +bool +test_routes (const struct route_list *rl, const struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + const IP_ADAPTER_INFO *adapters = get_adapter_info_list (&gc); + bool ret = false; + int count = 0; + int good = 0; + int ambig = 0; + bool adapter_up = false; + + if (is_adapter_up (tt, adapters)) + { + ret = true; + adapter_up = true; + + if (rl) + { + int i; + for (i = 0; i < rl->n; ++i) + test_route_helper (&ret, &count, &good, &ambig, adapters, rl->routes[i].gateway); + + if (rl->redirect_default_gateway && rl->spec.remote_endpoint_defined) + test_route_helper (&ret, &count, &good, &ambig, adapters, rl->spec.remote_endpoint); + } + } + + msg (D_ROUTE, "TEST ROUTES: %d/%d succeeded len=%d ret=%d a=%d u/d=%s", + good, + count, + rl ? rl->n : -1, + (int)ret, + ambig, + adapter_up ? "up" : "down"); + + gc_free (&gc); + return ret; +} + +static bool +get_default_gateway (in_addr_t *ret) +{ + struct gc_arena gc = gc_new (); + bool ret_bool = false; + int i; + const MIB_IPFORWARDTABLE *routes = get_windows_routing_table (&gc); + + if (!routes) + goto done; + + for (i = 0; i < routes->dwNumEntries; ++i) + { + const MIB_IPFORWARDROW *row = &routes->table[i]; + const in_addr_t net = ntohl (row->dwForwardDest); + const in_addr_t mask = ntohl (row->dwForwardMask); + const in_addr_t gw = ntohl (row->dwForwardNextHop); + +#if 0 + msg (M_INFO, "route[%d] %s %s %s", + i, + print_in_addr_t ((in_addr_t) net, 0, &gc), + print_in_addr_t ((in_addr_t) mask, 0, &gc), + print_in_addr_t ((in_addr_t) gw, 0, &gc)); +#endif + if (!net && !mask) + { + *ret = gw; + ret_bool = true; + break; + } + } + + done: + gc_free (&gc); + return ret_bool; +} + +static DWORD +windows_route_find_if_index (const struct route *r, const struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + DWORD ret = ~0; + int count = 0; + const IP_ADAPTER_INFO *adapters = get_adapter_info_list (&gc); + const IP_ADAPTER_INFO *tun_adapter = get_tun_adapter (tt, adapters); + bool on_tun = false; + + /* first test on tun interface */ + if (is_ip_in_adapter_subnet (tun_adapter, r->gateway, NULL)) + { + ret = tun_adapter->Index; + count = 1; + on_tun = true; + } + else /* test on other interfaces */ + { + count = test_route (adapters, r->gateway, &ret); + } + + if (count == 0) + { + msg (M_WARN, "Warning: route gateway is not reachable on any active network adapters: %s", + print_in_addr_t (r->gateway, 0, &gc)); + ret = ~0; + } + else if (count > 1) + { + msg (M_WARN, "Warning: route gateway is ambiguous: %s (%d matches)", + print_in_addr_t (r->gateway, 0, &gc), + count); + ret = ~0; + } + + dmsg (D_ROUTE_DEBUG, "DEBUG: route find if: on_tun=%d count=%d index=%d", + on_tun, + count, + (int)ret); + + gc_free (&gc); + return ret; +} + +bool +add_route_ipapi (const struct route *r, const struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + DWORD status; + const DWORD if_index = windows_route_find_if_index (r, tt); + + if (if_index != ~0) + { + MIB_IPFORWARDROW fr; + CLEAR (fr); + fr.dwForwardDest = htonl (r->network); + fr.dwForwardMask = htonl (r->netmask); + fr.dwForwardPolicy = 0; + fr.dwForwardNextHop = htonl (r->gateway); + fr.dwForwardIfIndex = if_index; + fr.dwForwardType = 4; /* the next hop is not the final dest */ + fr.dwForwardProto = 3; /* PROTO_IP_NETMGMT */ + fr.dwForwardAge = 0; + fr.dwForwardNextHopAS = 0; + fr.dwForwardMetric1 = r->metric_defined ? r->metric : 1; + fr.dwForwardMetric2 = ~0; + fr.dwForwardMetric3 = ~0; + fr.dwForwardMetric4 = ~0; + fr.dwForwardMetric5 = ~0; + + if ((r->network & r->netmask) != r->network) + msg (M_WARN, "Warning: address %s is not a network address in relation to netmask %s", + print_in_addr_t (r->network, 0, &gc), + print_in_addr_t (r->netmask, 0, &gc)); + + status = CreateIpForwardEntry (&fr); + + if (status == NO_ERROR) + ret = true; + else + { + /* failed, try a different forward type (--redirect-gateway over RRAS seems to need this) */ + fr.dwForwardType = 3; /* the next hop is the final dest */ + + status = CreateIpForwardEntry (&fr); + + if (status == NO_ERROR) + ret = true; + else + msg (M_WARN, "ROUTE: route addition failed using CreateIpForwardEntry: %s [if_index=%u]", + strerror_win32 (status, &gc), + (unsigned int)if_index); + } + } + + gc_free (&gc); + return ret; +} + +bool +del_route_ipapi (const struct route *r, const struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + DWORD status; + const DWORD if_index = windows_route_find_if_index (r, tt); + + if (if_index != ~0) + { + MIB_IPFORWARDROW fr; + CLEAR (fr); + + fr.dwForwardDest = htonl (r->network); + fr.dwForwardMask = htonl (r->netmask); + fr.dwForwardPolicy = 0; + fr.dwForwardNextHop = htonl (r->gateway); + fr.dwForwardIfIndex = if_index; + + status = DeleteIpForwardEntry (&fr); + + if (status == NO_ERROR) + ret = true; + else + msg (M_WARN, "ROUTE: route deletion failed using DeleteIpForwardEntry: %s", + strerror_win32 (status, &gc)); + } + + gc_free (&gc); + return ret; +} + +static const char * +format_route_entry (const MIB_IPFORWARDROW *r, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + buf_printf (&out, "%s %s %s p=%d i=%d t=%d pr=%d a=%d h=%d m=%d/%d/%d/%d/%d", + print_in_addr_t (r->dwForwardDest, IA_NET_ORDER, gc), + print_in_addr_t (r->dwForwardMask, IA_NET_ORDER, gc), + print_in_addr_t (r->dwForwardNextHop, IA_NET_ORDER, gc), + (int)r->dwForwardPolicy, + (int)r->dwForwardIfIndex, + (int)r->dwForwardType, + (int)r->dwForwardProto, + (int)r->dwForwardAge, + (int)r->dwForwardNextHopAS, + (int)r->dwForwardMetric1, + (int)r->dwForwardMetric2, + (int)r->dwForwardMetric3, + (int)r->dwForwardMetric4, + (int)r->dwForwardMetric5); + return BSTR (&out); +} + +/* + * Show current routing table + */ +void +show_routes (int msglev) +{ + struct gc_arena gc = gc_new (); + int i; + + const MIB_IPFORWARDTABLE *rt = get_windows_routing_table (&gc); + + msg (msglev, "SYSTEM ROUTING TABLE"); + if (rt) + { + for (i = 0; i < rt->dwNumEntries; ++i) + { + msg (msglev, "%s", format_route_entry (&rt->table[i], &gc)); + } + } + gc_free (&gc); +} + +#elif defined(TARGET_LINUX) + +static bool +get_default_gateway (in_addr_t *ret) +{ + struct gc_arena gc = gc_new (); + FILE *fp = fopen ("/proc/net/route", "r"); + if (fp) + { + char line[256]; + int count = 0; + while (fgets (line, sizeof (line), fp) != NULL) + { + if (count) + { + unsigned int net_x = 0; + unsigned int mask_x = 0; + unsigned int gw_x = 0; + const int np = sscanf (line, "%*s\t%x\t%x\t%*s\t%*s\t%*s\t%*s\t%x", + &net_x, + &gw_x, + &mask_x); + if (np == 3) + { + const in_addr_t net = ntohl (net_x); + const in_addr_t mask = ntohl (mask_x); + const in_addr_t gw = ntohl (gw_x); +#if 0 + msg (M_INFO, "route %s %s %s", + print_in_addr_t ((in_addr_t) net, 0, &gc), + print_in_addr_t ((in_addr_t) mask, 0, &gc), + print_in_addr_t ((in_addr_t) gw, 0, &gc)); +#endif + if (!net && !mask) + { + fclose (fp); + *ret = gw; + gc_free (&gc); + return true; + } + } + } + ++count; + } + fclose (fp); + } + + gc_free (&gc); + return false; +} + +#elif defined(TARGET_FREEBSD) + +#include <sys/types.h> +#include <sys/socket.h> +#include <netinet/in.h> + +/* all of this is taken from <net/route.h> in FreeBSD */ +#define RTA_DST 0x1 +#define RTA_GATEWAY 0x2 +#define RTA_NETMASK 0x4 + +#define RTM_GET 0x4 +#define RTM_VERSION 5 + +#define RTF_UP 0x1 +#define RTF_GATEWAY 0x2 + +/* + * These numbers are used by reliable protocols for determining + * retransmission behavior and are included in the routing structure. + */ +struct rt_metrics { + u_long rmx_locks; /* Kernel must leave these values alone */ + u_long rmx_mtu; /* MTU for this path */ + u_long rmx_hopcount; /* max hops expected */ + u_long rmx_expire; /* lifetime for route, e.g. redirect */ + u_long rmx_recvpipe; /* inbound delay-bandwidth product */ + u_long rmx_sendpipe; /* outbound delay-bandwidth product */ + u_long rmx_ssthresh; /* outbound gateway buffer limit */ + u_long rmx_rtt; /* estimated round trip time */ + u_long rmx_rttvar; /* estimated rtt variance */ + u_long rmx_pksent; /* packets sent using this route */ + u_long rmx_filler[4]; /* will be used for T/TCP later */ +}; + +/* + * Structures for routing messages. + */ +struct rt_msghdr { + u_short rtm_msglen; /* to skip over non-understood messages */ + u_char rtm_version; /* future binary compatibility */ + u_char rtm_type; /* message type */ + u_short rtm_index; /* index for associated ifp */ + int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ + int rtm_addrs; /* bitmask identifying sockaddrs in msg */ + pid_t rtm_pid; /* identify sender */ + int rtm_seq; /* for sender to identify action */ + int rtm_errno; /* why failed */ + int rtm_use; /* from rtentry */ + u_long rtm_inits; /* which metrics we are initializing */ + struct rt_metrics rtm_rmx; /* metrics themselves */ +}; + +struct { + struct rt_msghdr m_rtm; + char m_space[512]; +} m_rtmsg; + +#define ROUNDUP(a) \ + ((a) > 0 ? (1 + (((a) - 1) | (sizeof(long) - 1))) : sizeof(long)) + +static bool +get_default_gateway (in_addr_t *ret) +{ + struct gc_arena gc = gc_new (); + int s, seq, l, pid, rtm_addrs, i; + struct sockaddr so_dst, so_mask; + char *cp = m_rtmsg.m_space; + struct sockaddr *gate = NULL, *sa; + struct rt_msghdr *rtm_aux; + +#define NEXTADDR(w, u) \ + if (rtm_addrs & (w)) {\ + l = ROUNDUP(u.sa_len); memmove(cp, &(u), l); cp += l;\ + } + +#define ADVANCE(x, n) (x += ROUNDUP((n)->sa_len)) + +#define rtm m_rtmsg.m_rtm + + pid = getpid(); + seq = 0; + rtm_addrs = RTA_DST | RTA_NETMASK; + + bzero(&so_dst, sizeof(so_dst)); + bzero(&so_mask, sizeof(so_mask)); + bzero(&rtm, sizeof(struct rt_msghdr)); + + rtm.rtm_type = RTM_GET; + rtm.rtm_flags = RTF_UP | RTF_GATEWAY; + rtm.rtm_version = RTM_VERSION; + rtm.rtm_seq = ++seq; + rtm.rtm_addrs = rtm_addrs; + + so_dst.sa_family = AF_INET; + so_dst.sa_len = sizeof(struct sockaddr_in); + so_mask.sa_family = AF_INET; + so_mask.sa_len = sizeof(struct sockaddr_in); + + NEXTADDR(RTA_DST, so_dst); + NEXTADDR(RTA_NETMASK, so_mask); + + rtm.rtm_msglen = l = cp - (char *)&m_rtmsg; + + s = socket(PF_ROUTE, SOCK_RAW, 0); + + if (write(s, (char *)&m_rtmsg, l) < 0) + { + warn("writing to routing socket"); + gc_free (&gc); + close(s); + return false; + } + + do { + l = read(s, (char *)&m_rtmsg, sizeof(m_rtmsg)); + } while (l > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid)); + + close(s); + + rtm_aux = &rtm; + + cp = ((char *)(rtm_aux + 1)); + if (rtm_aux->rtm_addrs) { + for (i = 1; i; i <<= 1) + if (i & rtm_aux->rtm_addrs) { + sa = (struct sockaddr *)cp; + if (i == RTA_GATEWAY ) + gate = sa; + ADVANCE(cp, sa); + } + } + else + { + gc_free (&gc); + return false; + } + + + if (gate != NULL ) + { + *ret = ntohl(((struct sockaddr_in *)gate)->sin_addr.s_addr); +#if 1 + msg (M_INFO, "gw %s", + print_in_addr_t ((in_addr_t) *ret, 0, &gc)); +#endif + + gc_free (&gc); + return true; + } + else + { + gc_free (&gc); + return false; + } +} + +#elif defined(TARGET_DARWIN) + +#include <sys/types.h> +#include <sys/socket.h> +#include <netinet/in.h> + +/* all of this is taken from <net/route.h> in Darwin */ +#define RTA_DST 0x1 +#define RTA_GATEWAY 0x2 +#define RTA_NETMASK 0x4 + +#define RTM_GET 0x4 +#define RTM_VERSION 5 + +#define RTF_UP 0x1 +#define RTF_GATEWAY 0x2 + +/* + * These numbers are used by reliable protocols for determining + * retransmission behavior and are included in the routing structure. + */ +struct rt_metrics { + u_long rmx_locks; /* Kernel must leave these values alone */ + u_long rmx_mtu; /* MTU for this path */ + u_long rmx_hopcount; /* max hops expected */ + u_long rmx_expire; /* lifetime for route, e.g. redirect */ + u_long rmx_recvpipe; /* inbound delay-bandwidth product */ + u_long rmx_sendpipe; /* outbound delay-bandwidth product */ + u_long rmx_ssthresh; /* outbound gateway buffer limit */ + u_long rmx_rtt; /* estimated round trip time */ + u_long rmx_rttvar; /* estimated rtt variance */ + u_long rmx_pksent; /* packets sent using this route */ + u_long rmx_filler[4]; /* will be used for T/TCP later */ +}; + +/* + * Structures for routing messages. + */ +struct rt_msghdr { + u_short rtm_msglen; /* to skip over non-understood messages */ + u_char rtm_version; /* future binary compatibility */ + u_char rtm_type; /* message type */ + u_short rtm_index; /* index for associated ifp */ + int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ + int rtm_addrs; /* bitmask identifying sockaddrs in msg */ + pid_t rtm_pid; /* identify sender */ + int rtm_seq; /* for sender to identify action */ + int rtm_errno; /* why failed */ + int rtm_use; /* from rtentry */ + u_long rtm_inits; /* which metrics we are initializing */ + struct rt_metrics rtm_rmx; /* metrics themselves */ +}; + +struct { + struct rt_msghdr m_rtm; + char m_space[512]; +} m_rtmsg; + +#define ROUNDUP(a) \ + ((a) > 0 ? (1 + (((a) - 1) | (sizeof(long) - 1))) : sizeof(long)) + +static bool +get_default_gateway (in_addr_t *ret) +{ + struct gc_arena gc = gc_new (); + int s, seq, l, pid, rtm_addrs, i; + struct sockaddr so_dst, so_mask; + char *cp = m_rtmsg.m_space; + struct sockaddr *gate = NULL, *sa; + struct rt_msghdr *rtm_aux; + +#define NEXTADDR(w, u) \ + if (rtm_addrs & (w)) {\ + l = ROUNDUP(u.sa_len); memmove(cp, &(u), l); cp += l;\ + } + +#define ADVANCE(x, n) (x += ROUNDUP((n)->sa_len)) + +#define rtm m_rtmsg.m_rtm + + pid = getpid(); + seq = 0; + rtm_addrs = RTA_DST | RTA_NETMASK; + + bzero(&so_dst, sizeof(so_dst)); + bzero(&so_mask, sizeof(so_mask)); + bzero(&rtm, sizeof(struct rt_msghdr)); + + rtm.rtm_type = RTM_GET; + rtm.rtm_flags = RTF_UP | RTF_GATEWAY; + rtm.rtm_version = RTM_VERSION; + rtm.rtm_seq = ++seq; + rtm.rtm_addrs = rtm_addrs; + + so_dst.sa_family = AF_INET; + so_dst.sa_len = sizeof(struct sockaddr_in); + so_mask.sa_family = AF_INET; + so_mask.sa_len = sizeof(struct sockaddr_in); + + NEXTADDR(RTA_DST, so_dst); + NEXTADDR(RTA_NETMASK, so_mask); + + rtm.rtm_msglen = l = cp - (char *)&m_rtmsg; + + s = socket(PF_ROUTE, SOCK_RAW, 0); + + if (write(s, (char *)&m_rtmsg, l) < 0) + { + msg (M_WARN, "ROUTE: problem writing to routing socket"); + gc_free (&gc); + close(s); + return false; + } + + do { + l = read(s, (char *)&m_rtmsg, sizeof(m_rtmsg)); + } while (l > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid)); + + close(s); + + rtm_aux = &rtm; + + cp = ((char *)(rtm_aux + 1)); + if (rtm_aux->rtm_addrs) { + for (i = 1; i; i <<= 1) + if (i & rtm_aux->rtm_addrs) { + sa = (struct sockaddr *)cp; + if (i == RTA_GATEWAY ) + gate = sa; + ADVANCE(cp, sa); + } + } + else + { + gc_free (&gc); + return false; + } + + + if (gate != NULL ) + { + *ret = ntohl(((struct sockaddr_in *)gate)->sin_addr.s_addr); +#if 1 + msg (M_INFO, "gw %s", + print_in_addr_t ((in_addr_t) *ret, 0, &gc)); +#endif + + gc_free (&gc); + return true; + } + else + { + gc_free (&gc); + return false; + } +} + +#elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD) + +#include <sys/types.h> +#include <sys/socket.h> +#include <netinet/in.h> + +/* all of this is taken from <net/route.h> in OpenBSD 3.6 */ +#define RTA_DST 0x1 /* destination sockaddr present */ +#define RTA_GATEWAY 0x2 /* gateway sockaddr present */ +#define RTA_NETMASK 0x4 /* netmask sockaddr present */ + +#define RTM_GET 0x4 /* Report Metrics */ + +#define RTM_VERSION 3 /* Up the ante and ignore older versions */ + +#define RTF_UP 0x1 /* route usable */ +#define RTF_GATEWAY 0x2 /* destination is a gateway */ + +/* + * Huge version for userland compatibility. + */ +struct rt_metrics { + u_long rmx_locks; /* Kernel must leave these values alone */ + u_long rmx_mtu; /* MTU for this path */ + u_long rmx_hopcount; /* max hops expected */ + u_long rmx_expire; /* lifetime for route, e.g. redirect */ + u_long rmx_recvpipe; /* inbound delay-bandwidth product */ + u_long rmx_sendpipe; /* outbound delay-bandwidth product */ + u_long rmx_ssthresh; /* outbound gateway buffer limit */ + u_long rmx_rtt; /* estimated round trip time */ + u_long rmx_rttvar; /* estimated rtt variance */ + u_long rmx_pksent; /* packets sent using this route */ +}; + +/* + * Structures for routing messages. + */ +struct rt_msghdr { + u_short rtm_msglen; /* to skip over non-understood messages */ + u_char rtm_version; /* future binary compatibility */ + u_char rtm_type; /* message type */ + u_short rtm_index; /* index for associated ifp */ + int rtm_flags; /* flags, incl. kern & message, e.g. DONE */ + int rtm_addrs; /* bitmask identifying sockaddrs in msg */ + pid_t rtm_pid; /* identify sender */ + int rtm_seq; /* for sender to identify action */ + int rtm_errno; /* why failed */ + int rtm_use; /* from rtentry */ + u_long rtm_inits; /* which metrics we are initializing */ + struct rt_metrics rtm_rmx; /* metrics themselves */ +}; + +struct { + struct rt_msghdr m_rtm; + char m_space[512]; +} m_rtmsg; + +#define ROUNDUP(a) \ + ((a) > 0 ? (1 + (((a) - 1) | (sizeof(long) - 1))) : sizeof(long)) + +static bool +get_default_gateway (in_addr_t *ret) +{ + struct gc_arena gc = gc_new (); + int s, seq, l, rtm_addrs, i; + pid_t pid; + struct sockaddr so_dst, so_mask; + char *cp = m_rtmsg.m_space; + struct sockaddr *gate = NULL, *sa; + struct rt_msghdr *rtm_aux; + +#define NEXTADDR(w, u) \ + if (rtm_addrs & (w)) {\ + l = ROUNDUP(u.sa_len); memmove(cp, &(u), l); cp += l;\ + } + +#define ADVANCE(x, n) (x += ROUNDUP((n)->sa_len)) + +#define rtm m_rtmsg.m_rtm + + pid = getpid(); + seq = 0; + rtm_addrs = RTA_DST | RTA_NETMASK; + + bzero(&so_dst, sizeof(so_dst)); + bzero(&so_mask, sizeof(so_mask)); + bzero(&rtm, sizeof(struct rt_msghdr)); + + rtm.rtm_type = RTM_GET; + rtm.rtm_flags = RTF_UP | RTF_GATEWAY; + rtm.rtm_version = RTM_VERSION; + rtm.rtm_seq = ++seq; + rtm.rtm_addrs = rtm_addrs; + + so_dst.sa_family = AF_INET; + so_dst.sa_len = sizeof(struct sockaddr_in); + so_mask.sa_family = AF_INET; + so_mask.sa_len = sizeof(struct sockaddr_in); + + NEXTADDR(RTA_DST, so_dst); + NEXTADDR(RTA_NETMASK, so_mask); + + rtm.rtm_msglen = l = cp - (char *)&m_rtmsg; + + s = socket(PF_ROUTE, SOCK_RAW, 0); + + if (write(s, (char *)&m_rtmsg, l) < 0) + { + warn("writing to routing socket"); + gc_free (&gc); + close(s); + return false; + } + + do { + l = read(s, (char *)&m_rtmsg, sizeof(m_rtmsg)); + } while (l > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid)); + + close(s); + + rtm_aux = &rtm; + + cp = ((char *)(rtm_aux + 1)); + if (rtm_aux->rtm_addrs) { + for (i = 1; i; i <<= 1) + if (i & rtm_aux->rtm_addrs) { + sa = (struct sockaddr *)cp; + if (i == RTA_GATEWAY ) + gate = sa; + ADVANCE(cp, sa); + } + } + else + { + gc_free (&gc); + return false; + } + + + if (gate != NULL ) + { + *ret = ntohl(((struct sockaddr_in *)gate)->sin_addr.s_addr); +#if 1 + msg (M_INFO, "gw %s", + print_in_addr_t ((in_addr_t) *ret, 0, &gc)); +#endif + + gc_free (&gc); + return true; + } + else + { + gc_free (&gc); + return false; + } +} + +#else + +static bool +get_default_gateway (in_addr_t *ret) +{ + return false; +} + +#endif + +bool +netmask_to_netbits (const in_addr_t network, const in_addr_t netmask, int *netbits) +{ + int i; + const int addrlen = sizeof (in_addr_t) * 8; + + if ((network & netmask) == network) + { + for (i = 0; i <= addrlen; ++i) + { + in_addr_t mask = netbits_to_netmask (i); + if (mask == netmask) + { + if (i == addrlen) + *netbits = -1; + else + *netbits = i; + return true; + } + } + } + return false; +} @@ -0,0 +1,167 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Support routines for adding/deleting network routes. + */ + +#ifndef ROUTE_H +#define ROUTE_H + +#include "tun.h" +#include "misc.h" + +#define MAX_ROUTES 100 + +#ifdef WIN32 +/* + * Windows route methods + */ +#define ROUTE_METHOD_IPAPI 0 /* use IP helper API */ +#define ROUTE_METHOD_EXE 1 /* use route.exe */ +#define ROUTE_METHOD_MASK 1 +#endif + +/* + * Route add flags (must stay clear of ROUTE_METHOD bits) + */ +#define ROUTE_DELETE_FIRST 2 + +struct route_special_addr +{ + in_addr_t remote_endpoint; + bool remote_endpoint_defined; + in_addr_t net_gateway; + bool net_gateway_defined; + in_addr_t remote_host; + bool remote_host_defined; +}; + +struct route_option { + const char *network; + const char *netmask; + const char *gateway; + const char *metric; +}; + +struct route_option_list { + int n; + bool redirect_default_gateway; + bool redirect_local; + bool redirect_def1; + struct route_option routes[MAX_ROUTES]; +}; + +struct route { + bool defined; + const struct route_option *option; + in_addr_t network; + in_addr_t netmask; + in_addr_t gateway; + bool metric_defined; + int metric; +}; + +struct route_list { + bool routes_added; + struct route_special_addr spec; + bool redirect_default_gateway; + bool redirect_local; + bool redirect_def1; + bool did_redirect_default_gateway; + + int n; + struct route routes[MAX_ROUTES]; +}; + +#if P2MP +/* internal OpenVPN route */ +struct iroute { + in_addr_t network; + int netbits; + struct iroute *next; +}; +#endif + +struct route_option_list *new_route_option_list (struct gc_arena *a); + +struct route_list *new_route_list (struct gc_arena *a); + +void add_route_to_option_list (struct route_option_list *l, + const char *network, + const char *netmask, + const char *gateway, + const char *metric); + +void clear_route_list (struct route_list *rl); + +bool init_route_list (struct route_list *rl, + const struct route_option_list *opt, + const char *remote_endpoint, + in_addr_t remote_host, + struct env_set *es); + +void add_routes (struct route_list *rl, + const struct tuntap *tt, + unsigned int flags, + const struct env_set *es); + +void delete_routes (struct route_list *rl, + const struct tuntap *tt, + unsigned int flags, + const struct env_set *es); + +void setenv_routes (struct env_set *es, const struct route_list *rl); + +#ifdef ENABLE_DEBUG +void print_route_options (const struct route_option_list *rol, + int level); +#endif + +void print_routes (const struct route_list *rl, int level); + +#ifdef WIN32 + +void show_routes (int msglev); +bool test_routes (const struct route_list *rl, const struct tuntap *tt); +bool add_route_ipapi (const struct route *r, const struct tuntap *tt); +bool del_route_ipapi (const struct route *r, const struct tuntap *tt); + +#else +static inline bool test_routes (const struct route_list *rl, const struct tuntap *tt) { return true; } +#endif + +bool netmask_to_netbits (const in_addr_t network, const in_addr_t netmask, int *netbits); + +static inline in_addr_t +netbits_to_netmask (const int netbits) +{ + const int addrlen = sizeof (in_addr_t) * 8; + in_addr_t mask = 0; + if (netbits > 0 && netbits <= addrlen) + mask = ~0 << (addrlen-netbits); + return mask; +} + +#endif diff --git a/sample-config-files/README b/sample-config-files/README new file mode 100644 index 0000000..d53ac79 --- /dev/null +++ b/sample-config-files/README @@ -0,0 +1,6 @@ +Sample OpenVPN Configuration Files. + +These files are part of the OpenVPN HOWTO +which is located at: + +http://openvpn.net/howto.html diff --git a/sample-config-files/client.conf b/sample-config-files/client.conf new file mode 100644 index 0000000..9dd3a65 --- /dev/null +++ b/sample-config-files/client.conf @@ -0,0 +1,123 @@ +############################################## +# Sample client-side OpenVPN 2.0 config file # +# for connecting to multi-client server. # +# # +# This configuration can be used by multiple # +# clients, however each client should have # +# its own cert and key files. # +# # +# On Windows, you might want to rename this # +# file so it has a .ovpn extension # +############################################## + +# Specify that we are a client and that we +# will be pulling certain config file directives +# from the server. +client + +# Use the same setting as you are using on +# the server. +# On most systems, the VPN will not function +# unless you partially or fully disable +# the firewall for the TUN/TAP interface. +;dev tap +dev tun + +# Windows needs the TAP-Win32 adapter name +# from the Network Connections panel +# if you have more than one. On XP SP2, +# you may need to disable the firewall +# for the TAP adapter. +;dev-node MyTap + +# Are we connecting to a TCP or +# UDP server? Use the same setting as +# on the server. +;proto tcp +proto udp + +# The hostname/IP and port of the server. +# You can have multiple remote entries +# to load balance between the servers. +remote my-server-1 1194 +;remote my-server-2 1194 + +# Choose a random host from the remote +# list for load-balancing. Otherwise +# try hosts in the order specified. +;remote-random + +# Keep trying indefinitely to resolve the +# host name of the OpenVPN server. Very useful +# on machines which are not permanently connected +# to the internet such as laptops. +resolv-retry infinite + +# Most clients don't need to bind to +# a specific local port number. +nobind + +# Downgrade privileges after initialization (non-Windows only) +;user nobody +;group nobody + +# Try to preserve some state across restarts. +persist-key +persist-tun + +# If you are connecting through an +# HTTP proxy to reach the actual OpenVPN +# server, put the proxy server/IP and +# port number here. See the man page +# if your proxy server requires +# authentication. +;http-proxy-retry # retry on connection failures +;http-proxy [proxy server] [proxy port #] + +# Wireless networks often produce a lot +# of duplicate packets. Set this flag +# to silence duplicate packet warnings. +;mute-replay-warnings + +# SSL/TLS parms. +# See the server config file for more +# description. It's best to use +# a separate .crt/.key file pair +# for each client. A single ca +# file can be used for all clients. +ca ca.crt +cert client.crt +key client.key + +# Verify server certificate by checking +# that the certicate has the nsCertType +# field set to "server". This is an +# important precaution to protect against +# a potential attack discussed here: +# http://openvpn.net/howto.html#mitm +# +# To use this feature, you will need to generate +# your server certificates with the nsCertType +# field set to "server". The build-key-server +# script in the easy-rsa folder will do this. +;ns-cert-type server + +# If a tls-auth key is used on the server +# then every client must also have the key. +;tls-auth ta.key 1 + +# Select a cryptographic cipher. +# If the cipher option is used on the server +# then you must also specify it here. +;cipher x + +# Enable compression on the VPN link. +# Don't enable this unless it is also +# enabled in the server config file. +comp-lzo + +# Set log file verbosity. +verb 3 + +# Silence repeating messages +;mute 20 diff --git a/sample-config-files/firewall.sh b/sample-config-files/firewall.sh new file mode 100755 index 0000000..f0db806 --- /dev/null +++ b/sample-config-files/firewall.sh @@ -0,0 +1,108 @@ +#!/bin/bash + +# A Sample OpenVPN-aware firewall. + +# eth0 is connected to the internet. +# eth1 is connected to a private subnet. + +# Change this subnet to correspond to your private +# ethernet subnet. Home will use HOME_NET/24 and +# Office will use OFFICE_NET/24. +PRIVATE=10.0.0.0/24 + +# Loopback address +LOOP=127.0.0.1 + +# Delete old iptables rules +# and temporarily block all traffic. +iptables -P OUTPUT DROP +iptables -P INPUT DROP +iptables -P FORWARD DROP +iptables -F + +# Set default policies +iptables -P OUTPUT ACCEPT +iptables -P INPUT DROP +iptables -P FORWARD DROP + +# Prevent external packets from using loopback addr +iptables -A INPUT -i eth0 -s $LOOP -j DROP +iptables -A FORWARD -i eth0 -s $LOOP -j DROP +iptables -A INPUT -i eth0 -d $LOOP -j DROP +iptables -A FORWARD -i eth0 -d $LOOP -j DROP + +# Anything coming from the Internet should have a real Internet address +iptables -A FORWARD -i eth0 -s 192.168.0.0/16 -j DROP +iptables -A FORWARD -i eth0 -s 172.16.0.0/12 -j DROP +iptables -A FORWARD -i eth0 -s 10.0.0.0/8 -j DROP +iptables -A INPUT -i eth0 -s 192.168.0.0/16 -j DROP +iptables -A INPUT -i eth0 -s 172.16.0.0/12 -j DROP +iptables -A INPUT -i eth0 -s 10.0.0.0/8 -j DROP + +# Block outgoing NetBios (if you have windows machines running +# on the private subnet). This will not affect any NetBios +# traffic that flows over the VPN tunnel, but it will stop +# local windows machines from broadcasting themselves to +# the internet. +iptables -A FORWARD -p tcp --sport 137:139 -o eth0 -j DROP +iptables -A FORWARD -p udp --sport 137:139 -o eth0 -j DROP +iptables -A OUTPUT -p tcp --sport 137:139 -o eth0 -j DROP +iptables -A OUTPUT -p udp --sport 137:139 -o eth0 -j DROP + +# Check source address validity on packets going out to internet +iptables -A FORWARD -s ! $PRIVATE -i eth1 -j DROP + +# Allow local loopback +iptables -A INPUT -s $LOOP -j ACCEPT +iptables -A INPUT -d $LOOP -j ACCEPT + +# Allow incoming pings (can be disabled) +iptables -A INPUT -p icmp --icmp-type echo-request -j ACCEPT + +# Allow services such as www and ssh (can be disabled) +iptables -A INPUT -p tcp --dport http -j ACCEPT +iptables -A INPUT -p tcp --dport ssh -j ACCEPT + +# Allow incoming OpenVPN packets +# Duplicate the line below for each +# OpenVPN tunnel, changing --dport n +# to match the OpenVPN UDP port. +# +# In OpenVPN, the port number is +# controlled by the --port n option. +# If you put this option in the config +# file, you can remove the leading '--' +# +# If you taking the stateful firewall +# approach (see the OpenVPN HOWTO), +# then comment out the line below. + +iptables -A INPUT -p udp --dport 1194 -j ACCEPT + +# Allow packets from TUN/TAP devices. +# When OpenVPN is run in a secure mode, +# it will authenticate packets prior +# to their arriving on a tun or tap +# interface. Therefore, it is not +# necessary to add any filters here, +# unless you want to restrict the +# type of packets which can flow over +# the tunnel. + +iptables -A INPUT -i tun+ -j ACCEPT +iptables -A FORWARD -i tun+ -j ACCEPT +iptables -A INPUT -i tap+ -j ACCEPT +iptables -A FORWARD -i tap+ -j ACCEPT + +# Allow packets from private subnets +iptables -A INPUT -i eth1 -j ACCEPT +iptables -A FORWARD -i eth1 -j ACCEPT + +# Keep state of connections from local machine and private subnets +iptables -A OUTPUT -m state --state NEW -o eth0 -j ACCEPT +iptables -A INPUT -m state --state ESTABLISHED,RELATED -j ACCEPT +iptables -A FORWARD -m state --state NEW -o eth0 -j ACCEPT +iptables -A FORWARD -m state --state ESTABLISHED,RELATED -j ACCEPT + +# Masquerade local subnet +iptables -t nat -A POSTROUTING -s $PRIVATE -o eth0 -j MASQUERADE diff --git a/sample-config-files/home.up b/sample-config-files/home.up new file mode 100755 index 0000000..9c347cc --- /dev/null +++ b/sample-config-files/home.up @@ -0,0 +1,2 @@ +#!/bin/sh +route add -net 10.0.0.0 netmask 255.255.255.0 gw $5 diff --git a/sample-config-files/loopback-client b/sample-config-files/loopback-client new file mode 100644 index 0000000..9db2877 --- /dev/null +++ b/sample-config-files/loopback-client @@ -0,0 +1,25 @@ +# Perform a TLS loopback test -- client side. +# +# This test performs a TLS negotiation once every 10 seconds, +# and will terminate after 2 minutes. +# +# From the root directory of the OpenVPN distribution, +# after openvpn has been built, run: +# +# ./openvpn --config sample-config-files/loopback-client (In one window) +# ./openvpn --config sample-config-files/loopback-server (Simultaneously in another window) + +rport 16000 +lport 16001 +remote localhost +local localhost +dev null +verb 3 +reneg-sec 10 +tls-client +ca sample-keys/tmp-ca.crt +key sample-keys/client.key +cert sample-keys/client.crt +cipher DES-EDE3-CBC +ping 1 +inactive 120 diff --git a/sample-config-files/loopback-server b/sample-config-files/loopback-server new file mode 100644 index 0000000..18bbbeb --- /dev/null +++ b/sample-config-files/loopback-server @@ -0,0 +1,26 @@ +# Perform a TLS loopback test -- server side. +# +# This test performs a TLS negotiation once every 10 seconds, +# and will terminate after 2 minutes. +# +# From the root directory of the OpenVPN distribution, +# after openvpn has been built, run: +# +# ./openvpn --config sample-config-files/loopback-client (In one window) +# ./openvpn --config sample-config-files/loopback-server (Simultaneously in another window) + +rport 16001 +lport 16000 +remote localhost +local localhost +dev null +verb 3 +reneg-sec 10 +tls-server +dh sample-keys/dh1024.pem +ca sample-keys/tmp-ca.crt +key sample-keys/server.key +cert sample-keys/server.crt +cipher DES-EDE3-CBC +ping 1 +inactive 120 diff --git a/sample-config-files/office.up b/sample-config-files/office.up new file mode 100755 index 0000000..74a71a3 --- /dev/null +++ b/sample-config-files/office.up @@ -0,0 +1,2 @@ +#!/bin/sh +route add -net 10.0.1.0 netmask 255.255.255.0 gw $5 diff --git a/sample-config-files/openvpn-shutdown.sh b/sample-config-files/openvpn-shutdown.sh new file mode 100755 index 0000000..8ed2d1d --- /dev/null +++ b/sample-config-files/openvpn-shutdown.sh @@ -0,0 +1,5 @@ +#!/bin/sh + +# stop all openvpn processes + +killall -TERM openvpn diff --git a/sample-config-files/openvpn-startup.sh b/sample-config-files/openvpn-startup.sh new file mode 100755 index 0000000..0ee006b --- /dev/null +++ b/sample-config-files/openvpn-startup.sh @@ -0,0 +1,34 @@ +#!/bin/sh + +# A sample OpenVPN startup script +# for Linux. + +# openvpn config file directory +dir=/etc/openvpn + +# load the firewall +$dir/firewall.sh + +# load TUN/TAP kernel module +modprobe tun + +# enable IP forwarding +echo 1 > /proc/sys/net/ipv4/ip_forward + +# Invoke openvpn for each VPN tunnel +# in daemon mode. Alternatively, +# you could remove "--daemon" from +# the command line and add "daemon" +# to the config file. +# +# Each tunnel should run on a separate +# UDP port. Use the "port" option +# to control this. Like all of +# OpenVPN's options, you can +# specify "--port 8000" on the command +# line or "port 8000" in the config +# file. + +openvpn --cd $dir --daemon --config vpn1.conf +openvpn --cd $dir --daemon --config vpn2.conf +openvpn --cd $dir --daemon --config vpn2.conf diff --git a/sample-config-files/server.conf b/sample-config-files/server.conf new file mode 100644 index 0000000..929e546 --- /dev/null +++ b/sample-config-files/server.conf @@ -0,0 +1,289 @@ +################################################# +# Sample OpenVPN 2.0 config file for # +# multi-client server. # +# # +# This file is for the server side # +# of a many-clients <-> one-server # +# OpenVPN configuration. # +# # +# OpenVPN also supports # +# single-machine <-> single-machine # +# configurations (See the Examples page # +# on the web site for more info). # +# # +# This config should work on Windows # +# or Linux/BSD systems. Remember on # +# Windows to quote pathnames and use # +# double backslashes, e.g.: # +# "C:\\Program Files\\OpenVPN\\config\\foo.key" # +# # +# Comments are preceded with '#' or ';' # +################################################# + +# Which local IP address should OpenVPN +# listen on? (optional) +;local a.b.c.d + +# Which TCP/UDP port should OpenVPN listen on? +# If you want to run multiple OpenVPN instances +# on the same machine, use a different port +# number for each one. You will need to +# open up this port on your firewall. +port 1194 + +# TCP or UDP server? +;proto tcp +proto udp + +# "dev tun" will create a routed IP tunnel, +# "dev tap" will create an ethernet tunnel. +# Use "dev tap" if you are ethernet bridging. +# If you want to control access policies +# over the VPN, you must create firewall +# rules for the the TUN/TAP interface. +# On non-Windows systems, you can give +# an explicit unit number, such as tun0. +# On Windows, use "dev-node" for this. +# On most systems, the VPN will not function +# unless you partially or fully disable +# the firewall for the TUN/TAP interface. +;dev tap +dev tun + +# Windows needs the TAP-Win32 adapter name +# from the Network Connections panel if you +# have more than one. On XP SP2 or higher, +# you may need to selectively disable the +# Windows firewall for the TAP adapter. +# Non-Windows systems usually don't need this. +;dev-node MyTap + +# SSL/TLS root certificate (ca), certificate +# (cert), and private key (key). Each client +# and the server must have their own cert and +# key file. The server and all clients will +# use the same ca file. +# +# See the "easy-rsa" directory for a series +# of scripts for generating RSA certificates +# and private keys. Remember to use +# a unique Common Name for the server +# and each of the client certificates. +# +# Any X509 key management system can be used. +# OpenVPN can also use a PKCS #12 formatted key file +# (see "pkcs12" directive in man page). +ca ca.crt +cert server.crt +key server.key # This file should be kept secret + +# Diffie hellman parameters. +# Generate your own with: +# openssl dhparam -out dh1024.pem 1024 +# Substitute 2048 for 1024 if you are using +# 2048 bit keys. +dh dh1024.pem + +# Configure server mode and supply a VPN subnet +# for OpenVPN to draw client addresses from. +# The server will take 10.8.0.1 for itself, +# the rest will be made available to clients. +# Each client will be able to reach the server +# on 10.8.0.1. Comment this line out if you are +# ethernet bridging. See the man page for more info. +server 10.8.0.0 255.255.255.0 + +# Maintain a record of client <-> virtual IP address +# associations in this file. If OpenVPN goes down or +# is restarted, reconnecting clients can be assigned +# the same virtual IP address from the pool that was +# previously assigned. +ifconfig-pool-persist ipp.txt + +# Configure server mode for ethernet bridging. +# You must first use your OS's bridging capability +# to bridge the TAP interface with the ethernet +# NIC interface. Then you must manually set the +# IP/netmask on the bridge interface, here we +# assume 10.8.0.4/255.255.255.0. Finally we +# must set aside an IP range in this subnet +# (start=10.8.0.50 end=10.8.0.100) to allocate +# to connecting clients. Leave this line commented +# out unless you are ethernet bridging. +;server-bridge 10.8.0.4 255.255.255.0 10.8.0.50 10.8.0.100 + +# Push routes to the client to allow it +# to reach other private subnets behind +# the server. Remember that these +# private subnets will also need +# to know to route the OpenVPN client +# address pool (10.8.0.0/255.255.255.0) +# back to the OpenVPN server. +;push "route 192.168.10.0 255.255.255.0" +;push "route 192.168.20.0 255.255.255.0" + +# To assign specific IP addresses to specific +# clients or if a connecting client has a private +# subnet behind it that should also have VPN access, +# use the subdirectory "ccd" for client-specific +# configuration files (see man page for more info). + +# EXAMPLE: Suppose the client +# having the certificate common name "Thelonious" +# also has a small subnet behind his connecting +# machine, such as 192.168.40.128/255.255.255.248. +# First, uncomment out these lines: +;client-config-dir ccd +;route 192.168.40.128 255.255.255.248 +# Then create a file ccd/Thelonious with this line: +# iroute 192.168.40.128 255.255.255.248 +# This will allow Thelonious' private subnet to +# access the VPN. This example will only work +# if you are routing, not bridging, i.e. you are +# using "dev tun" and "server" directives. + +# EXAMPLE: Suppose you want to give +# Thelonious a fixed VPN IP address of 10.9.0.1. +# First uncomment out these lines: +;client-config-dir ccd +;route 10.9.0.0 255.255.255.252 +# Then add this line to ccd/Thelonious: +# ifconfig-push 10.9.0.1 10.9.0.2 + +# Suppose that you want to enable different +# firewall access policies for different groups +# of clients. There are two methods: +# (1) Run multiple OpenVPN daemons, one for each +# group, and firewall the TUN/TAP interface +# for each group/daemon appropriately. +# (2) (Advanced) Create a script to dynamically +# modify the firewall in response to access +# from different clients. See man +# page for more info on learn-address script. +;learn-address ./script + +# If enabled, this directive will configure +# all clients to redirect their default +# network gateway through the VPN, causing +# all IP traffic such as web browsing and +# and DNS lookups to go through the VPN +# (The OpenVPN server machine may need to NAT +# the TUN/TAP interface to the internet in +# order for this to work properly). +# CAVEAT: May break client's network config if +# client's local DHCP server packets get routed +# through the tunnel. Solution: make sure +# client's local DHCP server is reachable via +# a more specific route than the default route +# of 0.0.0.0/0.0.0.0. +;push "redirect-gateway" + +# Certain Windows-specific network settings +# can be pushed to clients, such as DNS +# or WINS server addresses. CAVEAT: +# http://openvpn.net/faq.html#dhcpcaveats +;push "dhcp-option DNS 10.8.0.1" +;push "dhcp-option WINS 10.8.0.1" + +# Uncomment this directive to allow different +# clients to be able to "see" each other. +# By default, clients will only see the server. +# To force clients to only see the server, you +# will also need to appropriately firewall the +# server's TUN/TAP interface. +;client-to-client + +# Uncomment this directive if multiple clients +# might connect with the same certificate/key +# files or common names. This is recommended +# only for testing purposes. For production use, +# each client should have its own certificate/key +# pair. +# +# IF YOU HAVE NOT GENERATED INDIVIDUAL +# CERTIFICATE/KEY PAIRS FOR EACH CLIENT, +# EACH HAVING ITS OWN UNIQUE "COMMON NAME", +# UNCOMMENT THIS LINE OUT. +;duplicate-cn + +# The keepalive directive causes ping-like +# messages to be sent back and forth over +# the link so that each side knows when +# the other side has gone down. +# Ping every 10 seconds, assume that remote +# peer is down if no ping received during +# a 120 second time period. +keepalive 10 120 + +# For extra security beyond that provided +# by SSL/TLS, create an "HMAC firewall" +# to help block DoS attacks and UDP port flooding. +# +# Generate with: +# openvpn --genkey --secret ta.key +# +# The server and each client must have +# a copy of this key. +# The second parameter should be '0' +# on the server and '1' on the clients. +;tls-auth ta.key 0 # This file is secret + +# Select a cryptographic cipher. +# This config item must be copied to +# the client config file as well. +;cipher BF-CBC # Blowfish (default) +;cipher AES-128-CBC # AES +;cipher DES-EDE3-CBC # Triple-DES + +# Enable compression on the VPN link. +# If you enable it here, you must also +# enable it in the client config file. +comp-lzo + +# The maximum number of concurrently connected +# clients we want to allow. +;max-clients 100 + +# It's a good idea to reduce the OpenVPN +# daemon's privileges after initialization. +# +# You can uncomment this out on +# non-Windows systems. +;user nobody +;group nobody + +# The persist options will try to avoid +# accessing certain resources on restart +# that may no longer be accessible because +# of the privilege downgrade. +persist-key +persist-tun + +# Output a short status file showing +# current connections, truncated +# and rewritten every minute. +status openvpn-status.log + +# By default, log messages will go to the syslog (or +# on Windows, if running as a service, they will go to +# the "\Program Files\OpenVPN\log" directory). +# Use log or log-append to override this default. +# "log" will truncate the log file on OpenVPN startup, +# while "log-append" will append to it. Use one +# or the other (but not both). +;log openvpn.log +;log-append openvpn.log + +# Set the appropriate level of log +# file verbosity. +# +# 0 is silent, except for fatal errors +# 4 is reasonable for general usage +# 5 and 6 can help to debug connection problems +# 9 is extremely verbose +verb 3 + +# Silence repeating messages. At most 20 +# sequential messages of the same message +# category will be output to the log. +;mute 20 diff --git a/sample-config-files/static-home.conf b/sample-config-files/static-home.conf new file mode 100644 index 0000000..c966687 --- /dev/null +++ b/sample-config-files/static-home.conf @@ -0,0 +1,72 @@ +# +# Sample OpenVPN configuration file for +# home using a pre-shared static key. +# +# '#' or ';' may be used to delimit comments. + +# Use a dynamic tun device. +# For Linux 2.2 or non-Linux OSes, +# you may want to use an explicit +# unit number such as "tun1". +# OpenVPN also supports virtual +# ethernet "tap" devices. +dev tun + +# Our OpenVPN peer is the office gateway. +remote 1.2.3.4 + +# 10.1.0.2 is our local VPN endpoint (home). +# 10.1.0.1 is our remote VPN endpoint (office). +ifconfig 10.1.0.2 10.1.0.1 + +# Our up script will establish routes +# once the VPN is alive. +up ./home.up + +# Our pre-shared static key +secret static.key + +# OpenVPN 2.0 uses UDP port 1194 by default +# (official port assignment by iana.org 11/04). +# OpenVPN 1.x uses UDP port 5000 by default. +# Each OpenVPN tunnel must use +# a different port number. +# lport or rport can be used +# to denote different ports +# for local and remote. +; port 1194 + +# Downgrade UID and GID to +# "nobody" after initialization +# for extra security. +; user nobody +; group nobody + +# If you built OpenVPN with +# LZO compression, uncomment +# out the following line. +; comp-lzo + +# Send a UDP ping to remote once +# every 15 seconds to keep +# stateful firewall connection +# alive. Uncomment this +# out if you are using a stateful +# firewall. +; ping 15 + +# Uncomment this section for a more reliable detection when a system +# loses its connection. For example, dial-ups or laptops that +# travel to other locations. +; ping 15 +; ping-restart 45 +; ping-timer-rem +; persist-tun +; persist-key + +# Verbosity level. +# 0 -- quiet except for fatal errors. +# 1 -- mostly quiet, but display non-fatal network errors. +# 3 -- medium output, good for normal operation. +# 9 -- verbose, good for troubleshooting +verb 3 diff --git a/sample-config-files/static-office.conf b/sample-config-files/static-office.conf new file mode 100644 index 0000000..68030cc --- /dev/null +++ b/sample-config-files/static-office.conf @@ -0,0 +1,69 @@ +# +# Sample OpenVPN configuration file for +# office using a pre-shared static key. +# +# '#' or ';' may be used to delimit comments. + +# Use a dynamic tun device. +# For Linux 2.2 or non-Linux OSes, +# you may want to use an explicit +# unit number such as "tun1". +# OpenVPN also supports virtual +# ethernet "tap" devices. +dev tun + +# 10.1.0.1 is our local VPN endpoint (office). +# 10.1.0.2 is our remote VPN endpoint (home). +ifconfig 10.1.0.1 10.1.0.2 + +# Our up script will establish routes +# once the VPN is alive. +up ./office.up + +# Our pre-shared static key +secret static.key + +# OpenVPN 2.0 uses UDP port 1194 by default +# (official port assignment by iana.org 11/04). +# OpenVPN 1.x uses UDP port 5000 by default. +# Each OpenVPN tunnel must use +# a different port number. +# lport or rport can be used +# to denote different ports +# for local and remote. +; port 1194 + +# Downgrade UID and GID to +# "nobody" after initialization +# for extra security. +; user nobody +; group nobody + +# If you built OpenVPN with +# LZO compression, uncomment +# out the following line. +; comp-lzo + +# Send a UDP ping to remote once +# every 15 seconds to keep +# stateful firewall connection +# alive. Uncomment this +# out if you are using a stateful +# firewall. +; ping 15 + +# Uncomment this section for a more reliable detection when a system +# loses its connection. For example, dial-ups or laptops that +# travel to other locations. +; ping 15 +; ping-restart 45 +; ping-timer-rem +; persist-tun +; persist-key + +# Verbosity level. +# 0 -- quiet except for fatal errors. +# 1 -- mostly quiet, but display non-fatal network errors. +# 3 -- medium output, good for normal operation. +# 9 -- verbose, good for troubleshooting +verb 3 diff --git a/sample-config-files/tls-home.conf b/sample-config-files/tls-home.conf new file mode 100644 index 0000000..daa4ea1 --- /dev/null +++ b/sample-config-files/tls-home.conf @@ -0,0 +1,83 @@ +# +# Sample OpenVPN configuration file for +# home using SSL/TLS mode and RSA certificates/keys. +# +# '#' or ';' may be used to delimit comments. + +# Use a dynamic tun device. +# For Linux 2.2 or non-Linux OSes, +# you may want to use an explicit +# unit number such as "tun1". +# OpenVPN also supports virtual +# ethernet "tap" devices. +dev tun + +# Our OpenVPN peer is the office gateway. +remote 1.2.3.4 + +# 10.1.0.2 is our local VPN endpoint (home). +# 10.1.0.1 is our remote VPN endpoint (office). +ifconfig 10.1.0.2 10.1.0.1 + +# Our up script will establish routes +# once the VPN is alive. +up ./home.up + +# In SSL/TLS key exchange, Office will +# assume server role and Home +# will assume client role. +tls-client + +# Certificate Authority file +ca my-ca.crt + +# Our certificate/public key +cert home.crt + +# Our private key +key home.key + +# OpenVPN 2.0 uses UDP port 1194 by default +# (official port assignment by iana.org 11/04). +# OpenVPN 1.x uses UDP port 5000 by default. +# Each OpenVPN tunnel must use +# a different port number. +# lport or rport can be used +# to denote different ports +# for local and remote. +; port 1194 + +# Downgrade UID and GID to +# "nobody" after initialization +# for extra security. +; user nobody +; group nobody + +# If you built OpenVPN with +# LZO compression, uncomment +# out the following line. +; comp-lzo + +# Send a UDP ping to remote once +# every 15 seconds to keep +# stateful firewall connection +# alive. Uncomment this +# out if you are using a stateful +# firewall. +; ping 15 + +# Uncomment this section for a more reliable detection when a system +# loses its connection. For example, dial-ups or laptops that +# travel to other locations. +; ping 15 +; ping-restart 45 +; ping-timer-rem +; persist-tun +; persist-key + +# Verbosity level. +# 0 -- quiet except for fatal errors. +# 1 -- mostly quiet, but display non-fatal network errors. +# 3 -- medium output, good for normal operation. +# 9 -- verbose, good for troubleshooting +verb 3 diff --git a/sample-config-files/tls-office.conf b/sample-config-files/tls-office.conf new file mode 100644 index 0000000..f790f46 --- /dev/null +++ b/sample-config-files/tls-office.conf @@ -0,0 +1,83 @@ +# +# Sample OpenVPN configuration file for +# office using SSL/TLS mode and RSA certificates/keys. +# +# '#' or ';' may be used to delimit comments. + +# Use a dynamic tun device. +# For Linux 2.2 or non-Linux OSes, +# you may want to use an explicit +# unit number such as "tun1". +# OpenVPN also supports virtual +# ethernet "tap" devices. +dev tun + +# 10.1.0.1 is our local VPN endpoint (office). +# 10.1.0.2 is our remote VPN endpoint (home). +ifconfig 10.1.0.1 10.1.0.2 + +# Our up script will establish routes +# once the VPN is alive. +up ./office.up + +# In SSL/TLS key exchange, Office will +# assume server role and Home +# will assume client role. +tls-server + +# Diffie-Hellman Parameters (tls-server only) +dh dh1024.pem + +# Certificate Authority file +ca my-ca.crt + +# Our certificate/public key +cert office.crt + +# Our private key +key office.key + +# OpenVPN 2.0 uses UDP port 1194 by default +# (official port assignment by iana.org 11/04). +# OpenVPN 1.x uses UDP port 5000 by default. +# Each OpenVPN tunnel must use +# a different port number. +# lport or rport can be used +# to denote different ports +# for local and remote. +; port 1194 + +# Downgrade UID and GID to +# "nobody" after initialization +# for extra security. +; user nobody +; group nobody + +# If you built OpenVPN with +# LZO compression, uncomment +# out the following line. +; comp-lzo + +# Send a UDP ping to remote once +# every 15 seconds to keep +# stateful firewall connection +# alive. Uncomment this +# out if you are using a stateful +# firewall. +; ping 15 + +# Uncomment this section for a more reliable detection when a system +# loses its connection. For example, dial-ups or laptops that +# travel to other locations. +; ping 15 +; ping-restart 45 +; ping-timer-rem +; persist-tun +; persist-key + +# Verbosity level. +# 0 -- quiet except for fatal errors. +# 1 -- mostly quiet, but display non-fatal network errors. +# 3 -- medium output, good for normal operation. +# 9 -- verbose, good for troubleshooting +verb 3 diff --git a/sample-config-files/xinetd-client-config b/sample-config-files/xinetd-client-config new file mode 100644 index 0000000..03c5c1f --- /dev/null +++ b/sample-config-files/xinetd-client-config @@ -0,0 +1,11 @@ +# This OpenVPN config file +# is the client side counterpart +# of xinetd-server-config + +dev tun +ifconfig 10.4.0.1 10.4.0.2 +remote my-server +port 1194 +user nobody +secret /root/openvpn/key +inactive 600 diff --git a/sample-config-files/xinetd-server-config b/sample-config-files/xinetd-server-config new file mode 100644 index 0000000..803a6f8 --- /dev/null +++ b/sample-config-files/xinetd-server-config @@ -0,0 +1,25 @@ +# An xinetd configuration file for OpenVPN. +# +# This file should be renamed to openvpn or something suitably +# descriptive and copied to the /etc/xinetd.d directory. +# xinetd can then be made aware of this file by restarting +# it or sending it a SIGHUP signal. +# +# For each potential incoming client, create a separate version +# of this configuration file on a unique port number. Also note +# that the key file and ifconfig endpoints should be unique for +# each client. This configuration assumes that the OpenVPN +# executable and key live in /root/openvpn. Change this to fit +# your environment. + +service openvpn_1 +{ + type = UNLISTED + port = 1194 + socket_type = dgram + protocol = udp + wait = yes + user = root + server = /root/openvpn/openvpn + server_args = --inetd --dev tun --ifconfig 10.4.0.2 10.4.0.1 --secret /root/openvpn/key --inactive 600 --user nobody +} diff --git a/sample-keys/README b/sample-keys/README new file mode 100644 index 0000000..dd5c25c --- /dev/null +++ b/sample-keys/README @@ -0,0 +1,14 @@ +Sample RSA keys. + +See the examples section of the man page +for usage examples. + +NOTE: THESE KEYS ARE FOR TESTING PURPOSES ONLY. + DON'T USE THEM FOR ANY REAL WORK BECAUSE + THEY ARE TOTALLY INSECURE! + +tmp-ca.{crt,key} -- sample CA key/cert +client.{crt,key} -- sample client key/cert +server.{crt,key} -- sample server key/cert (nsCertType=server) +pass.{crt,key} -- sample client key/cert with password-encrypted key + password = "password" diff --git a/sample-keys/client.crt b/sample-keys/client.crt new file mode 100644 index 0000000..c047446 --- /dev/null +++ b/sample-keys/client.crt @@ -0,0 +1,65 @@ +Certificate: + Data: + Version: 3 (0x2) + Serial Number: 2 (0x2) + Signature Algorithm: md5WithRSAEncryption + Issuer: C=KG, ST=NA, L=BISHKEK, O=OpenVPN-TEST/emailAddress=me@myhost.mydomain + Validity + Not Before: Nov 25 14:46:49 2004 GMT + Not After : Nov 23 14:46:49 2014 GMT + Subject: C=KG, ST=NA, O=OpenVPN-TEST, CN=Test-Client/emailAddress=me@myhost.mydomain + Subject Public Key Info: + Public Key Algorithm: rsaEncryption + RSA Public Key: (1024 bit) + Modulus (1024 bit): + 00:d2:12:5c:c6:4d:13:34:ae:cf:fa:ab:fe:cb:de: + 8c:f1:4b:4a:95:28:60:87:82:2c:b8:c1:e5:8e:c6: + 5d:11:58:61:a4:a5:f1:42:d7:86:74:6c:9d:9c:7a: + f0:3a:5c:29:e6:53:3b:5e:6d:d8:f0:45:06:2c:23: + ee:09:bc:02:8f:0e:b8:d5:33:1f:c3:4a:11:02:48: + 0b:cc:4b:ad:6e:74:e0:a2:53:b1:d6:cc:89:b9:e2: + 6f:db:15:b3:19:1e:57:04:79:48:3a:da:76:31:fc: + bf:d3:34:21:e7:32:d8:9e:06:4e:be:f3:e3:79:b0: + 54:fd:d1:42:32:aa:3e:7a:c1 + Exponent: 65537 (0x10001) + X509v3 extensions: + X509v3 Basic Constraints: + CA:FALSE + Netscape Comment: + OpenSSL Generated Certificate + X509v3 Subject Key Identifier: + 17:B7:3F:C7:62:A0:A9:FD:A4:31:0E:58:D7:D9:94:7B:4B:3F:CB:56 + X509v3 Authority Key Identifier: + keyid:89:A6:60:E3:BA:EA:3E:AF:FC:64:7F:4C:BD:8C:D2:48:8D:E0:CC:46 + DirName:/C=KG/ST=NA/L=BISHKEK/O=OpenVPN-TEST/emailAddress=me@myhost.mydomain + serial:00 + + Signature Algorithm: md5WithRSAEncryption + 61:c6:d1:fa:24:0f:c7:be:09:3b:d8:04:17:63:31:17:07:f9: + 56:99:af:4c:67:fa:db:cb:94:cf:55:a5:7b:16:20:8b:42:64: + 13:23:62:45:28:93:5e:36:f7:db:02:95:a1:e9:fd:e3:0f:8d: + 73:a1:7b:0e:55:78:4d:a5:c4:b7:22:12:a0:ee:55:e0:b8:0e: + c9:9b:12:e3:b0:ef:9b:68:93:57:6e:6c:ad:16:68:8e:8d:30: + 33:fe:2a:1b:c3:03:8f:b6:0a:2d:0c:b1:3c:bb:f9:58:3f:8c: + 81:59:6b:14:dd:62:b5:c2:93:ed:5d:c6:19:0f:9b:4b:52:b3: + 7c:78 +-----BEGIN CERTIFICATE----- +MIIDNTCCAp6gAwIBAgIBAjANBgkqhkiG9w0BAQQFADBmMQswCQYDVQQGEwJLRzEL +MAkGA1UECBMCTkExEDAOBgNVBAcTB0JJU0hLRUsxFTATBgNVBAoTDE9wZW5WUE4t +VEVTVDEhMB8GCSqGSIb3DQEJARYSbWVAbXlob3N0Lm15ZG9tYWluMB4XDTA0MTEy +NTE0NDY0OVoXDTE0MTEyMzE0NDY0OVowajELMAkGA1UEBhMCS0cxCzAJBgNVBAgT +Ak5BMRUwEwYDVQQKEwxPcGVuVlBOLVRFU1QxFDASBgNVBAMTC1Rlc3QtQ2xpZW50 +MSEwHwYJKoZIhvcNAQkBFhJtZUBteWhvc3QubXlkb21haW4wgZ8wDQYJKoZIhvcN +AQEBBQADgY0AMIGJAoGBANISXMZNEzSuz/qr/svejPFLSpUoYIeCLLjB5Y7GXRFY +YaSl8ULXhnRsnZx68DpcKeZTO15t2PBFBiwj7gm8Ao8OuNUzH8NKEQJIC8xLrW50 +4KJTsdbMibnib9sVsxkeVwR5SDradjH8v9M0Iecy2J4GTr7z43mwVP3RQjKqPnrB +AgMBAAGjge4wgeswCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYdT3BlblNTTCBH +ZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFBe3P8dioKn9pDEOWNfZlHtL +P8tWMIGQBgNVHSMEgYgwgYWAFImmYOO66j6v/GR/TL2M0kiN4MxGoWqkaDBmMQsw +CQYDVQQGEwJLRzELMAkGA1UECBMCTkExEDAOBgNVBAcTB0JJU0hLRUsxFTATBgNV +BAoTDE9wZW5WUE4tVEVTVDEhMB8GCSqGSIb3DQEJARYSbWVAbXlob3N0Lm15ZG9t +YWluggEAMA0GCSqGSIb3DQEBBAUAA4GBAGHG0fokD8e+CTvYBBdjMRcH+VaZr0xn ++tvLlM9VpXsWIItCZBMjYkUok14299sClaHp/eMPjXOhew5VeE2lxLciEqDuVeC4 +DsmbEuOw75tok1dubK0WaI6NMDP+KhvDA4+2Ci0MsTy7+Vg/jIFZaxTdYrXCk+1d +xhkPm0tSs3x4 +-----END CERTIFICATE----- diff --git a/sample-keys/client.key b/sample-keys/client.key new file mode 100644 index 0000000..17b9509 --- /dev/null +++ b/sample-keys/client.key @@ -0,0 +1,15 @@ +-----BEGIN RSA PRIVATE KEY----- +MIICXAIBAAKBgQDSElzGTRM0rs/6q/7L3ozxS0qVKGCHgiy4weWOxl0RWGGkpfFC +14Z0bJ2cevA6XCnmUztebdjwRQYsI+4JvAKPDrjVMx/DShECSAvMS61udOCiU7HW +zIm54m/bFbMZHlcEeUg62nYx/L/TNCHnMtieBk6+8+N5sFT90UIyqj56wQIDAQAB +AoGBAK8RoIGekCfym99DYYfTg9A/t/tQeAnWYaDj7oSrKbqf1lgZ91OGPEZgkoVr +KzLnxf9uU+bhUs8CJx+4HdO8/L9rAJA+oD9QNuMp0elN4AKuEGE1Eq3a0e3cmgPI ++VIoXM6WVAGgK9I03Zu/UerYQ/DdXWGOIsKhFe8qyQoG9pKxAkEA9ld6O9MHQt3d +JAjJkgCNn4psozxjrfLWy2huXd3H3CRqGMjLITDGzdkVSgXjHokBYroi0+TZTu4M +ulJSJaWwBQJBANpO2DAexH2zRHw5Z6QyeEVxz7B3/FzU4GgJx9BH+FSBh+F0G5Ln +ir5Vst8vZ/LGcgpYjHQLNAvZVgUjiQ4Y6I0CQGvwMJL+CHR4GmmroAblTyjU0n1D +/Lk/anZ+L73Za7U+D28ErFzCrpmLwRRKOBYtGfpUbOZDpCQ9kj4hy/TLALECQCcL +9ysUNbzt9Y/qjJkX1d9F7gn4TBEmmkTBixW76bTjvjQbGlt6Qpyso2O8DPGlgPxM +vkJ7RoHgC7y7kGYPGnkCQBVxSNGIjLx4NQBgN4HD0y4+fars1PTUGnckBcS4npb9 +onLNyerBlWdBwbARyBS7WPIbyyf5VCrn3yIqWxaARO0= +-----END RSA PRIVATE KEY----- diff --git a/sample-keys/dh1024.pem b/sample-keys/dh1024.pem new file mode 100644 index 0000000..7ce05f0 --- /dev/null +++ b/sample-keys/dh1024.pem @@ -0,0 +1,5 @@ +-----BEGIN DH PARAMETERS----- +MIGHAoGBAJ419DBEOgmQTzo5qXl5fQcN9TN455wkOL7052HzxxRVMyhYmwQcgJvh +1sa18fyfR9OiVEMYglOpkqVoGLN7qd5aQNNi5W7/C+VBdHTBJcGZJyyP5B3qcz32 +9mLJKudlVudV0Qxk5qUJaPZ/xupz0NyoVpviuiBOI1gNi8ovSXWzAgEC +-----END DH PARAMETERS----- diff --git a/sample-keys/pass.crt b/sample-keys/pass.crt new file mode 100644 index 0000000..8bb7b17 --- /dev/null +++ b/sample-keys/pass.crt @@ -0,0 +1,65 @@ +Certificate: + Data: + Version: 3 (0x2) + Serial Number: 3 (0x3) + Signature Algorithm: md5WithRSAEncryption + Issuer: C=KG, ST=NA, L=BISHKEK, O=OpenVPN-TEST/emailAddress=me@myhost.mydomain + Validity + Not Before: Nov 25 14:48:55 2004 GMT + Not After : Nov 23 14:48:55 2014 GMT + Subject: C=KG, ST=NA, O=OpenVPN-TEST, CN=Test-Client-Password/emailAddress=me@myhost.mydomain + Subject Public Key Info: + Public Key Algorithm: rsaEncryption + RSA Public Key: (1024 bit) + Modulus (1024 bit): + 00:ca:b4:05:67:7b:51:c1:d2:fe:21:57:b1:a5:57: + 5c:c0:86:38:05:a8:91:cf:e7:a4:bd:7a:76:d8:3b: + cf:fe:f3:78:65:24:d6:72:7d:1b:6d:b6:da:04:f2: + a8:f6:b4:04:78:d2:24:a7:21:2f:ca:29:46:96:0f: + 0b:91:31:66:1e:4d:22:9a:5d:05:17:99:9c:a0:7e: + e0:2a:be:78:0c:a1:b9:d4:04:c4:ec:f8:61:79:62: + b5:52:2d:f5:41:af:db:9f:8c:ab:08:1b:b7:95:b8: + c1:f0:29:d3:da:fb:00:3f:8e:5c:27:e3:8d:fa:ee: + dc:b4:3b:0b:8b:e0:ab:c1:c1 + Exponent: 65537 (0x10001) + X509v3 extensions: + X509v3 Basic Constraints: + CA:FALSE + Netscape Comment: + OpenSSL Generated Certificate + X509v3 Subject Key Identifier: + 40:57:F1:8C:9C:86:B2:DA:E0:3F:A7:B8:D7:85:43:45:07:8A:40:73 + X509v3 Authority Key Identifier: + keyid:89:A6:60:E3:BA:EA:3E:AF:FC:64:7F:4C:BD:8C:D2:48:8D:E0:CC:46 + DirName:/C=KG/ST=NA/L=BISHKEK/O=OpenVPN-TEST/emailAddress=me@myhost.mydomain + serial:00 + + Signature Algorithm: md5WithRSAEncryption + a5:79:72:7f:a2:08:28:8e:66:da:e1:d0:be:bb:97:3d:65:9f: + ab:1e:19:ac:f1:66:44:14:8f:4e:7c:eb:ea:1e:2f:57:ea:44: + 46:4c:b9:56:5b:c0:0c:58:d2:45:87:26:6d:82:de:8c:64:b8: + 8b:22:61:61:c6:68:36:08:9d:5a:fd:2f:e5:21:e1:a2:0c:7f: + 3e:ca:e1:06:ea:9f:81:62:3d:a0:ce:f1:1e:0d:ab:86:89:ed: + 9a:89:34:32:c9:e9:6d:7d:f5:11:c3:5d:7e:a5:f7:f1:a6:83: + 77:1b:94:67:d9:0f:5c:ac:0e:08:4a:88:98:65:49:eb:66:9e: + 2d:28 +-----BEGIN CERTIFICATE----- +MIIDPjCCAqegAwIBAgIBAzANBgkqhkiG9w0BAQQFADBmMQswCQYDVQQGEwJLRzEL +MAkGA1UECBMCTkExEDAOBgNVBAcTB0JJU0hLRUsxFTATBgNVBAoTDE9wZW5WUE4t +VEVTVDEhMB8GCSqGSIb3DQEJARYSbWVAbXlob3N0Lm15ZG9tYWluMB4XDTA0MTEy +NTE0NDg1NVoXDTE0MTEyMzE0NDg1NVowczELMAkGA1UEBhMCS0cxCzAJBgNVBAgT +Ak5BMRUwEwYDVQQKEwxPcGVuVlBOLVRFU1QxHTAbBgNVBAMTFFRlc3QtQ2xpZW50 +LVBhc3N3b3JkMSEwHwYJKoZIhvcNAQkBFhJtZUBteWhvc3QubXlkb21haW4wgZ8w +DQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMq0BWd7UcHS/iFXsaVXXMCGOAWokc/n +pL16dtg7z/7zeGUk1nJ9G2222gTyqPa0BHjSJKchL8opRpYPC5ExZh5NIppdBReZ +nKB+4Cq+eAyhudQExOz4YXlitVIt9UGv25+Mqwgbt5W4wfAp09r7AD+OXCfjjfru +3LQ7C4vgq8HBAgMBAAGjge4wgeswCQYDVR0TBAIwADAsBglghkgBhvhCAQ0EHxYd +T3BlblNTTCBHZW5lcmF0ZWQgQ2VydGlmaWNhdGUwHQYDVR0OBBYEFEBX8YychrLa +4D+nuNeFQ0UHikBzMIGQBgNVHSMEgYgwgYWAFImmYOO66j6v/GR/TL2M0kiN4MxG +oWqkaDBmMQswCQYDVQQGEwJLRzELMAkGA1UECBMCTkExEDAOBgNVBAcTB0JJU0hL +RUsxFTATBgNVBAoTDE9wZW5WUE4tVEVTVDEhMB8GCSqGSIb3DQEJARYSbWVAbXlo +b3N0Lm15ZG9tYWluggEAMA0GCSqGSIb3DQEBBAUAA4GBAKV5cn+iCCiOZtrh0L67 +lz1ln6seGazxZkQUj0586+oeL1fqREZMuVZbwAxY0kWHJm2C3oxkuIsiYWHGaDYI +nVr9L+Uh4aIMfz7K4Qbqn4FiPaDO8R4Nq4aJ7ZqJNDLJ6W199RHDXX6l9/Gmg3cb +lGfZD1ysDghKiJhlSetmni0o +-----END CERTIFICATE----- diff --git a/sample-keys/pass.key b/sample-keys/pass.key new file mode 100644 index 0000000..4916364 --- /dev/null +++ b/sample-keys/pass.key @@ -0,0 +1,18 @@ +-----BEGIN RSA PRIVATE KEY----- +Proc-Type: 4,ENCRYPTED +DEK-Info: DES-EDE3-CBC,959F7365DBBFDB77 + +nGm57l+rR/8dAZOHL/1x/6dt11zUca7rphjsgw6XRnSf3M/CWmHvHVjApWcNLEs5 +SWNMp1xfUogtGzsKoMBbnlZLDA7RVHUYD6dVMyCpc64UjzT08LmdZhtQYLAKmlUC +PT1VXS4Ae+SrqCPUqJkw1xP3kr0F1EVCXNu0nhOBAuuTGOS7PPEyW2N+k4nRHtsR +IaPp8GCuIeoR6CdymTFTq6d/GeCiEcyrUM4BNrG4GtRRrURxxOrzQFEOS5sjBPSg +Km1lwa6zBQFRLg9dKjRBL4teKuPY5Z2Nmpcml/aN4CkdkVEso4lW6/UHLE/joOMQ +0MdpdYtu8wnt1WI/Z4immQfl3MF+QcPMkqXXzCEhGG/5SbAo89KC46UXvu1Z5OhS +8XFHhvYBivOYWgZ3XUQqyZ0ulF60mFX7aE1Ph/eEbhWBHmU39hGjxzop1UoPwqLx +ahvtfvCkR3ZeqlWO9SHzCA3MlrKwQ1p1UL6nG6AJhNN9jSevH6by+8wr07NBZOqX +fJx+J/8EdVsUCFG2UJxPwM83ZSwAsvKRqph6CuWEl9ndUb7rw6khmRIoY0Iz3LbU +1MlcDoJNcJas6lYDr1UeFSk86g0SiGCHXZIqsjyUgq6HIy4YrAYiQUthnlF8tp2Q +nNQBPLo1GsHf0dC2MqKfDFASu7ST+Bl+yajHcIiUXvUJPxWbjkWYG9Q2p2ZBLzZD +uqeRr66OKxTzUS4go/QbHDNsAulXl61gQIEOdZw5uy/Jl11kyAI6EQbzmehagKdH +EshTgKp8ks62y0bBHgy3FMKyidJ5Hm58ZDhBxrwN0w+vhRoTGOepTA== +-----END RSA PRIVATE KEY----- diff --git a/sample-keys/pkcs12.p12 b/sample-keys/pkcs12.p12 Binary files differnew file mode 100644 index 0000000..e529807 --- /dev/null +++ b/sample-keys/pkcs12.p12 diff --git a/sample-keys/server.crt b/sample-keys/server.crt new file mode 100644 index 0000000..28bb4d9 --- /dev/null +++ b/sample-keys/server.crt @@ -0,0 +1,67 @@ +Certificate: + Data: + Version: 3 (0x2) + Serial Number: 1 (0x1) + Signature Algorithm: md5WithRSAEncryption + Issuer: C=KG, ST=NA, L=BISHKEK, O=OpenVPN-TEST/emailAddress=me@myhost.mydomain + Validity + Not Before: Nov 25 14:42:22 2004 GMT + Not After : Nov 23 14:42:22 2014 GMT + Subject: C=KG, ST=NA, O=OpenVPN-TEST, CN=Test-Server/emailAddress=me@myhost.mydomain + Subject Public Key Info: + Public Key Algorithm: rsaEncryption + RSA Public Key: (1024 bit) + Modulus (1024 bit): + 00:cb:4e:ac:f9:83:57:f6:69:d2:32:29:b4:bc:ad: + e6:f7:26:21:89:33:30:43:40:a3:35:d9:de:26:01: + d6:b4:f0:bc:0a:19:55:99:3b:f1:4c:91:60:b6:fd: + 74:34:8d:5a:c7:62:ec:ce:f2:d6:02:ce:57:32:f4: + 35:8c:71:a0:6d:65:2a:e7:80:ae:29:59:cf:36:73: + f8:7c:4a:73:90:fc:30:28:d5:46:7d:35:a4:4e:c9: + 9f:90:7b:e2:09:21:36:c5:a8:ec:85:82:9a:32:b4: + 91:3b:c1:d6:4f:9f:d1:f8:6f:68:f4:1d:d2:06:91: + 32:cc:9a:48:fd:cd:98:7f:2f + Exponent: 65537 (0x10001) + X509v3 extensions: + X509v3 Basic Constraints: + CA:FALSE + Netscape Cert Type: + SSL Server + Netscape Comment: + OpenSSL Generated Server Certificate + X509v3 Subject Key Identifier: + 69:11:FE:E7:9F:89:7B:71:34:69:C0:DC:82:F8:D0:5D:4D:FB:78:DF + X509v3 Authority Key Identifier: + keyid:89:A6:60:E3:BA:EA:3E:AF:FC:64:7F:4C:BD:8C:D2:48:8D:E0:CC:46 + DirName:/C=KG/ST=NA/L=BISHKEK/O=OpenVPN-TEST/emailAddress=me@myhost.mydomain + serial:00 + + Signature Algorithm: md5WithRSAEncryption + 35:5c:75:da:57:ef:b5:79:f2:a2:db:36:e4:75:e8:c7:bc:73: + 26:cf:30:36:4b:2e:51:46:37:60:2f:4e:2b:f6:71:a2:23:db: + 8e:d8:5c:d5:af:2e:22:28:dd:30:a8:89:66:3a:cc:5b:3c:0f: + 96:12:20:de:5e:41:52:74:35:ed:4c:26:40:19:ca:73:df:54: + b1:30:96:9c:a5:14:d0:38:28:3f:ab:30:07:d7:de:98:d2:7f: + 7f:90:b2:52:1d:e5:95:88:ed:ba:8a:6a:14:85:66:76:ec:75: + 30:e8:ae:94:f4:e1:76:fa:4b:0e:f1:53:d7:95:be:fb:69:fa: + 3d:32 +-----BEGIN CERTIFICATE----- +MIIDUTCCArqgAwIBAgIBATANBgkqhkiG9w0BAQQFADBmMQswCQYDVQQGEwJLRzEL +MAkGA1UECBMCTkExEDAOBgNVBAcTB0JJU0hLRUsxFTATBgNVBAoTDE9wZW5WUE4t +VEVTVDEhMB8GCSqGSIb3DQEJARYSbWVAbXlob3N0Lm15ZG9tYWluMB4XDTA0MTEy +NTE0NDIyMloXDTE0MTEyMzE0NDIyMlowajELMAkGA1UEBhMCS0cxCzAJBgNVBAgT +Ak5BMRUwEwYDVQQKEwxPcGVuVlBOLVRFU1QxFDASBgNVBAMTC1Rlc3QtU2VydmVy +MSEwHwYJKoZIhvcNAQkBFhJtZUBteWhvc3QubXlkb21haW4wgZ8wDQYJKoZIhvcN +AQEBBQADgY0AMIGJAoGBAMtOrPmDV/Zp0jIptLyt5vcmIYkzMENAozXZ3iYB1rTw +vAoZVZk78UyRYLb9dDSNWsdi7M7y1gLOVzL0NYxxoG1lKueArilZzzZz+HxKc5D8 +MCjVRn01pE7Jn5B74gkhNsWo7IWCmjK0kTvB1k+f0fhvaPQd0gaRMsyaSP3NmH8v +AgMBAAGjggEJMIIBBTAJBgNVHRMEAjAAMBEGCWCGSAGG+EIBAQQEAwIGQDAzBglg +hkgBhvhCAQ0EJhYkT3BlblNTTCBHZW5lcmF0ZWQgU2VydmVyIENlcnRpZmljYXRl +MB0GA1UdDgQWBBRpEf7nn4l7cTRpwNyC+NBdTft43zCBkAYDVR0jBIGIMIGFgBSJ +pmDjuuo+r/xkf0y9jNJIjeDMRqFqpGgwZjELMAkGA1UEBhMCS0cxCzAJBgNVBAgT +Ak5BMRAwDgYDVQQHEwdCSVNIS0VLMRUwEwYDVQQKEwxPcGVuVlBOLVRFU1QxITAf +BgkqhkiG9w0BCQEWEm1lQG15aG9zdC5teWRvbWFpboIBADANBgkqhkiG9w0BAQQF +AAOBgQA1XHXaV++1efKi2zbkdejHvHMmzzA2Sy5RRjdgL04r9nGiI9uO2FzVry4i +KN0wqIlmOsxbPA+WEiDeXkFSdDXtTCZAGcpz31SxMJacpRTQOCg/qzAH196Y0n9/ +kLJSHeWViO26imoUhWZ27HUw6K6U9OF2+ksO8VPXlb77afo9Mg== +-----END CERTIFICATE----- diff --git a/sample-keys/server.key b/sample-keys/server.key new file mode 100644 index 0000000..976acab --- /dev/null +++ b/sample-keys/server.key @@ -0,0 +1,15 @@ +-----BEGIN RSA PRIVATE KEY----- +MIICXgIBAAKBgQDLTqz5g1f2adIyKbS8reb3JiGJMzBDQKM12d4mAda08LwKGVWZ +O/FMkWC2/XQ0jVrHYuzO8tYCzlcy9DWMcaBtZSrngK4pWc82c/h8SnOQ/DAo1UZ9 +NaROyZ+Qe+IJITbFqOyFgpoytJE7wdZPn9H4b2j0HdIGkTLMmkj9zZh/LwIDAQAB +AoGBAKP1ljA/iY/zNY447kZ/5NWKzd7tBk4mcbl7M9no/7O6tZtbZRoIKoi6cYoC +C1ZabUyBbkNTud5XdCFmq0zRUjOWvoFMZ9VZfd2kRPvl4TGczBtJAq65b+EYMGui +q6T9p61xPdtzu0vM+Ecj127pAMk5XcJyxu8XQK7lZWmG5UoJAkEA8CxXNZN+A3qD +bMBPI3VdwKCNSjNVEQEnygMbNgw7VLdxPpspzZziqJEGdzsM4dsnOBwKxIWFLN2h +lbGBOquAswJBANi0atGWM8VUxDjvqqHCTS9RUXWgnvYhee4/xraJBQPBSivjC9P0 +vKT7PjBHU6djtKSLKGaHn1vHqmyY7PCMjZUCQQCNVSqExqSzG1dXmdt4PErNXi2G +6qo2dX2arTVIGu6XLdQgSWLSMm5XT/CEHWW5SyPLKwVTHFeATXQXCPvJML9tAkEA +k0yXax0g1ZoXwufN4SQUmPw6Va03P/BjU/nP1ZVvbiz9gLVU/d7WN4J7tA9XomkY +idv5OzAmtxkSE70jGSNAvQJAWhCf9+iHkzOHRyKKOYlh1DHUwDfSEp+hlZYg9H03 +P2sraQzUxgWDY/DIY63KvW78ny863baFz7onz21MYGgJXg== +-----END RSA PRIVATE KEY----- diff --git a/sample-keys/tmp-ca.crt b/sample-keys/tmp-ca.crt new file mode 100644 index 0000000..e063ccc --- /dev/null +++ b/sample-keys/tmp-ca.crt @@ -0,0 +1,19 @@ +-----BEGIN CERTIFICATE----- +MIIDBjCCAm+gAwIBAgIBADANBgkqhkiG9w0BAQQFADBmMQswCQYDVQQGEwJLRzEL +MAkGA1UECBMCTkExEDAOBgNVBAcTB0JJU0hLRUsxFTATBgNVBAoTDE9wZW5WUE4t +VEVTVDEhMB8GCSqGSIb3DQEJARYSbWVAbXlob3N0Lm15ZG9tYWluMB4XDTA0MTEy +NTE0NDA1NVoXDTE0MTEyMzE0NDA1NVowZjELMAkGA1UEBhMCS0cxCzAJBgNVBAgT +Ak5BMRAwDgYDVQQHEwdCSVNIS0VLMRUwEwYDVQQKEwxPcGVuVlBOLVRFU1QxITAf +BgkqhkiG9w0BCQEWEm1lQG15aG9zdC5teWRvbWFpbjCBnzANBgkqhkiG9w0BAQEF +AAOBjQAwgYkCgYEAqPjWJnesPu6bR/iec4FMz3opVaPdBHxg+ORKNmrnVZPh0t8/ +ZT34KXkYoI9B82scurp8UlZVXG8JdUsz+yai8ti9+g7vcuyKUtcCIjn0HLgmdPu5 +gFX25lB0pXw+XIU031dOfPvtROdG5YZN5yCErgCy7TE7zntLnkEDuRmyU6cCAwEA +AaOBwzCBwDAdBgNVHQ4EFgQUiaZg47rqPq/8ZH9MvYzSSI3gzEYwgZAGA1UdIwSB +iDCBhYAUiaZg47rqPq/8ZH9MvYzSSI3gzEahaqRoMGYxCzAJBgNVBAYTAktHMQsw +CQYDVQQIEwJOQTEQMA4GA1UEBxMHQklTSEtFSzEVMBMGA1UEChMMT3BlblZQTi1U +RVNUMSEwHwYJKoZIhvcNAQkBFhJtZUBteWhvc3QubXlkb21haW6CAQAwDAYDVR0T +BAUwAwEB/zANBgkqhkiG9w0BAQQFAAOBgQBfJoiWYrYdjM0mKPEzUQk0nLYTovBP +I0es/2rfGrin1zbcFY+4dhVBd1E/StebnG+CP8r7QeEIwu7x8gYDdOLLsZn+2vBL +e4jNU1ClI6Q0L7jrzhhunQ5mAaZztVyYwFB15odYcdN2iO0tP7jtEsvrRqxICNy3 +8itzViPTf5W4sA== +-----END CERTIFICATE----- diff --git a/sample-keys/tmp-ca.key b/sample-keys/tmp-ca.key new file mode 100644 index 0000000..b4bf792 --- /dev/null +++ b/sample-keys/tmp-ca.key @@ -0,0 +1,15 @@ +-----BEGIN RSA PRIVATE KEY----- +MIICXQIBAAKBgQCo+NYmd6w+7ptH+J5zgUzPeilVo90EfGD45Eo2audVk+HS3z9l +PfgpeRigj0Hzaxy6unxSVlVcbwl1SzP7JqLy2L36Du9y7IpS1wIiOfQcuCZ0+7mA +VfbmUHSlfD5chTTfV058++1E50blhk3nIISuALLtMTvOe0ueQQO5GbJTpwIDAQAB +AoGAQuVREyWp4bhhbZr2UFBOco2ws6EOLWp4kdD/uI+WSoEjlHKiDJj+GJ1CrL5K +o+4yD5MpCQf4/4FOQ0ukprfjJpDwDinTG6vzuWSLTHNiTgvksW3vy7IsNMJx97hT +4D2QOOl9HhA50Qqg70teMPYXOgLRMVsdCIV7p7zDNy4nM+ECQQDX8m5ZcQmPtUDA +38dPTfpL4U7kMB94FItJYH/Lk5kMW1/J33xymNhL+BHaG064ol9n2ubGW4XEO5t2 +qE1IOsVpAkEAyE/x/OBVSI1s75aYGlEwMd87p3qaDdtXT7WzujjRY7r8Y1ynkMU6 +GtMeneBX/lk4BY/6I+5bhAzce+hqhaXejwJBAL5Wg+c4GApf41xdogqHm7doNyYw +OHyZ9w9NDDc+uGbI30xLPSCxEe0cEXgiG6foDpm2uzRZFTWaqHPU8pFYpAkCQGNX +cpWM0/7VVK9Fqk1y8knpgfY/UWOJ4jU/0dCLGR0ywLSuYNPlXDmtdkOp3TnhGW14 +x/9F2NEWZ8pzq1B4wHUCQQC5ztD4m/rpiIpinoewUJODoeBJXYBKqx1+mdrALCq6 +ESvK1WRiusMaY3xmsdv4J2TB5iUPryELbn3jU12WGcQc +-----END RSA PRIVATE KEY----- diff --git a/sample-scripts/auth-pam.pl b/sample-scripts/auth-pam.pl new file mode 100755 index 0000000..5333bad --- /dev/null +++ b/sample-scripts/auth-pam.pl @@ -0,0 +1,97 @@ +#!/usr/bin/perl -t + +# OpenVPN PAM AUTHENTICATON +# This script can be used to add PAM-based authentication +# to OpenVPN 2.0. The OpenVPN client must provide +# a username/password, using the --auth-user-pass directive. +# The OpenVPN server should specify --auth-user-pass-verify +# with this script as the argument and the 'via-file' method +# specified. The server can also optionally specify +# --client-cert-not-required and/or --username-as-common-name. + +# SCRIPT OPERATION +# Return success or failure status based on whether or not a +# given username/password authenticates using PAM. +# Caller should write username/password as two lines in a file +# which is passed to this script as a command line argument. + +# CAVEATS +# * Requires Authen::PAM module, which may also +# require the pam-devel package. +# * May need to be run as root in order to +# access username/password file. + +# NOTES +# * This script is provided mostly as a demonstration of the +# --auth-user-pass-verify script capability in OpenVPN. +# For real world usage, see the auth-pam module in the plugin +# folder. + +use Authen::PAM; +use POSIX; + +# This "conversation function" will pass +# $password to PAM when it asks for it. + +sub my_conv_func { + my @res; + while ( @_ ) { + my $code = shift; + my $msg = shift; + my $ans = ""; + + $ans = $password if $msg =~ /[Pp]assword/; + + push @res, (PAM_SUCCESS(),$ans); + } + push @res, PAM_SUCCESS(); + return @res; +} + +# Identify service type to PAM +$service = "login"; + +# Get username/password from file + +if ($ARG = shift @ARGV) { + if (!open (UPFILE, "<$ARG")) { + print "Could not open username/password file: $ARG\n"; + exit 1; + } +} else { + print "No username/password file specified on command line\n"; + exit 1; +} + +$username = <UPFILE>; +$password = <UPFILE>; + +if (!$username || !$password) { + print "Username/password not found in file: $ARG\n"; + exit 1; +} + +chomp $username; +chomp $password; + +close (UPFILE); + +# Initialize PAM object + +if (!ref($pamh = new Authen::PAM($service, $username, \&my_conv_func))) { + print "Authen::PAM init failed\n"; + exit 1; +} + +# Authenticate with PAM + +$res = $pamh->pam_authenticate; + +# Return success or failure + +if ($res == PAM_SUCCESS()) { + exit 0; +} else { + print "Auth '$username' failed, PAM said: ", $pamh->pam_strerror($res), "\n"; + exit 1; +} diff --git a/sample-scripts/bridge-start b/sample-scripts/bridge-start new file mode 100755 index 0000000..bfbbdc5 --- /dev/null +++ b/sample-scripts/bridge-start @@ -0,0 +1,39 @@ +#!/bin/bash + +################################# +# Set up Ethernet bridge on Linux +# Requires: bridge-utils +################################# + +# Define Bridge Interface +br="br0" + +# Define list of TAP interfaces to be bridged, +# for example tap="tap0 tap1 tap2". +tap="tap0" + +# Define physical ethernet interface to be bridged +# with TAP interface(s) above. +eth="eth0" +eth_ip="192.168.8.4" +eth_netmask="255.255.255.0" +eth_broadcast="192.168.8.255" + +for t in $tap; do + openvpn --mktun --dev $t +done + +brctl addbr $br +brctl addif $br $eth + +for t in $tap; do + brctl addif $br $t +done + +for t in $tap; do + ifconfig $t 0.0.0.0 promisc up +done + +ifconfig $eth 0.0.0.0 promisc up + +ifconfig $br $eth_ip netmask $eth_netmask broadcast $eth_broadcast diff --git a/sample-scripts/bridge-stop b/sample-scripts/bridge-stop new file mode 100755 index 0000000..d452893 --- /dev/null +++ b/sample-scripts/bridge-stop @@ -0,0 +1,18 @@ +#!/bin/bash + +#################################### +# Tear Down Ethernet bridge on Linux +#################################### + +# Define Bridge Interface +br="br0" + +# Define list of TAP interfaces to be bridged together +tap="tap0" + +ifconfig $br down +brctl delbr $br + +for t in $tap; do + openvpn --rmtun --dev $t +done diff --git a/sample-scripts/openvpn.init b/sample-scripts/openvpn.init new file mode 100755 index 0000000..6c699cc --- /dev/null +++ b/sample-scripts/openvpn.init @@ -0,0 +1,244 @@ +#!/bin/sh +# +# openvpn This shell script takes care of starting and stopping +# openvpn on RedHat or other chkconfig-based system. +# +# chkconfig: 345 24 76 +# +# description: OpenVPN is a robust and highly flexible tunneling application that +# uses all of the encryption, authentication, and certification features +# of the OpenSSL library to securely tunnel IP networks over a single +# UDP port. +# + +# Contributed to the OpenVPN project by +# Douglas Keller <doug@voidstar.dyndns.org> +# 2002.05.15 + +# To install: +# copy this file to /etc/rc.d/init.d/openvpn +# shell> chkconfig --add openvpn +# shell> mkdir /etc/openvpn +# make .conf or .sh files in /etc/openvpn (see below) + +# To uninstall: +# run: chkconfig --del openvpn + +# Author's Notes: +# +# I have created an /etc/init.d init script and enhanced openvpn.spec to +# automatically register the init script. Once the RPM is installed you +# can start and stop OpenVPN with "service openvpn start" and "service +# openvpn stop". +# +# The init script does the following: +# +# - Starts an openvpn process for each .conf file it finds in +# /etc/openvpn. +# +# - If /etc/openvpn/xxx.sh exists for a xxx.conf file then it executes +# it before starting openvpn (useful for doing openvpn --mktun...). +# +# - In addition to start/stop you can do: +# +# service openvpn reload - SIGHUP +# service openvpn reopen - SIGUSR1 +# service openvpn status - SIGUSR2 +# +# Modifications: +# +# 2003.05.02 +# * Changed == to = for sh compliance (Bishop Clark). +# * If condrestart|reload|reopen|status, check that we were +# actually started (James Yonan). +# * Added lock, piddir, and work variables (James Yonan). +# * If start is attempted twice, without an intervening stop, or +# if start is attempted when previous start was not properly +# shut down, then kill any previously started processes, before +# commencing new start operation (James Yonan). +# * Do a better job of flagging errors on start, and properly +# returning success or failure status to caller (James Yonan). +# +# 2005.04.04 +# * Added openvpn-startup and openvpn-shutdown script calls +# (James Yonan). +# + +# Location of openvpn binary +openvpn="" +openvpn_locations="/usr/sbin/openvpn /usr/local/sbin/openvpn" +for location in $openvpn_locations +do + if [ -f "$location" ] + then + openvpn=$location + fi +done + +# Lockfile +lock="/var/lock/subsys/openvpn" + +# PID directory +piddir="/var/run/openvpn" + +# Our working directory +work=/etc/openvpn + +# Source function library. +. /etc/rc.d/init.d/functions + +# Source networking configuration. +. /etc/sysconfig/network + +# Check that networking is up. +if [ ${NETWORKING} = "no" ] +then + echo "Networking is down" + exit 0 +fi + +# Check that binary exists +if ! [ -f $openvpn ] +then + echo "openvpn binary not found" + exit 0 +fi + +# See how we were called. +case "$1" in + start) + echo -n $"Starting openvpn: " + + /sbin/modprobe tun >/dev/null 2>&1 + + # From a security perspective, I think it makes + # sense to remove this, and have users who need + # it explictly enable in their --up scripts or + # firewall setups. + + #echo 1 > /proc/sys/net/ipv4/ip_forward + + # Run startup script, if defined + if [ -f $work/openvpn-startup ]; then + $work/openvpn-startup + fi + + if [ ! -d $piddir ]; then + mkdir $piddir + fi + + if [ -f $lock ]; then + # we were not shut down correctly + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi + rm -f $pidf + done + rm -f $lock + sleep 2 + fi + + rm -f $piddir/*.pid + cd $work + + # Start every .conf in $work and run .sh if exists + errors=0 + successes=0 + for c in `/bin/ls *.conf 2>/dev/null`; do + bn=${c%%.conf} + if [ -f "$bn.sh" ]; then + . $bn.sh + fi + rm -f $piddir/$bn.pid + $openvpn --daemon --writepid $piddir/$bn.pid --config $c --cd $work + if [ $? = 0 ]; then + successes=1 + else + errors=1 + fi + done + + if [ $errors = 1 ]; then + failure; echo + else + success; echo + fi + + if [ $successes = 1 ]; then + touch $lock + fi + ;; + stop) + echo -n $"Shutting down openvpn: " + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi + rm -f $pidf + done + + # Run shutdown script, if defined + if [ -f $work/openvpn-shutdown ]; then + $work/openvpn-shutdown + fi + + success; echo + rm -f $lock + ;; + restart) + $0 stop + sleep 2 + $0 start + ;; + reload) + if [ -f $lock ]; then + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill -HUP `cat $pidf` >/dev/null 2>&1 + fi + done + else + echo "openvpn: service not started" + exit 1 + fi + ;; + reopen) + if [ -f $lock ]; then + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill -USR1 `cat $pidf` >/dev/null 2>&1 + fi + done + else + echo "openvpn: service not started" + exit 1 + fi + ;; + condrestart) + if [ -f $lock ]; then + $0 stop + # avoid race + sleep 2 + $0 start + fi + ;; + status) + if [ -f $lock ]; then + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill -USR2 `cat $pidf` >/dev/null 2>&1 + fi + done + echo "Status written to /var/log/messages" + else + echo "openvpn: service not started" + exit 1 + fi + ;; + *) + echo "Usage: openvpn {start|stop|restart|condrestart|reload|reopen|status}" + exit 1 + ;; +esac +exit 0 diff --git a/sample-scripts/verify-cn b/sample-scripts/verify-cn new file mode 100755 index 0000000..5d56d95 --- /dev/null +++ b/sample-scripts/verify-cn @@ -0,0 +1,52 @@ +#!/usr/bin/perl + +# verify-cn -- a sample OpenVPN tls-verify script +# +# Return 0 if cn matches the common name component of +# X509_NAME_oneline, 1 otherwise. +# +# For example in OpenVPN, you could use the directive: +# +# tls-verify "./verify-cn Test-Client" +# +# This would cause the connection to be dropped unless +# the client common name is "Test-Client" + +die "usage: verify-cn cn certificate_depth X509_NAME_oneline" if (@ARGV != 3); + +# Parse out arguments: +# cn -- The common name which the client is required to have, +# taken from the argument to the tls-verify directive +# in the OpenVPN config file. +# depth -- The current certificate chain depth. In a typical +# bi-level chain, the root certificate will be at level +# 1 and the client certificate will be at level 0. +# This script will be called separately for each level. +# x509 -- the X509 subject string as extracted by OpenVPN from +# the client's provided certificate. +($cn, $depth, $x509) = @ARGV; + +if ($depth == 0) { + # If depth is zero, we know that this is the final + # certificate in the chain (i.e. the client certificate), + # and the one we are interested in examining. + # If so, parse out the common name substring in + # the X509 subject string. + + if ($x509 =~ /\/CN=([^\/]+)/) { + # Accept the connection if the X509 common name + # string matches the passed cn argument. + if ($cn eq $1) { + exit 0; + } + } + + # Authentication failed -- Either we could not parse + # the X509 subject string, or the common name in the + # subject string didn't match the passed cn argument. + exit 1; +} + +# If depth is nonzero, tell OpenVPN to continue processing +# the certificate chain. +exit 0; diff --git a/schedule.c b/schedule.c new file mode 100644 index 0000000..25aec20 --- /dev/null +++ b/schedule.c @@ -0,0 +1,663 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#if P2MP_SERVER + +#include "buffer.h" +#include "misc.h" +#include "crypto.h" +#include "schedule.h" + +#include "memdbg.h" + +#ifdef SCHEDULE_TEST + +struct status +{ + int sru; + int ins; + int coll; + int lsteps; +}; + +static struct status z; + +#endif + +#ifdef ENABLE_DEBUG +static void +schedule_entry_debug_info (const char *caller, const struct schedule_entry *e) +{ + struct gc_arena gc = gc_new (); + if (e) + { + dmsg (D_SCHEDULER, "SCHEDULE: %s wakeup=[%s] pri=%u", + caller, + tv_string_abs (&e->tv, &gc), + e->pri); + } + else + { + dmsg (D_SCHEDULER, "SCHEDULE: %s NULL", + caller); + } + gc_free (&gc); +} +#endif + +static inline void +schedule_set_pri (struct schedule_entry *e) +{ + e->pri = random (); + if (e->pri < 1) + e->pri = 1; +} + +/* This is the master key comparison routine. A key is + * simply a struct timeval containing the absolute time for + * an event. The unique treap priority (pri) is used to ensure + * that keys do not collide. + */ +static inline int +schedule_entry_compare (const struct schedule_entry *e1, + const struct schedule_entry *e2) +{ + if (e1->tv.tv_sec < e2->tv.tv_sec) + return -1; + else if (e1->tv.tv_sec > e2->tv.tv_sec) + return 1; + else + { + if (e1->tv.tv_usec < e2->tv.tv_usec) + return -1; + else if (e1->tv.tv_usec > e2->tv.tv_usec) + return 1; + else + { + if (e1->pri < e2->pri) + return -1; + else if (e1->pri > e2->pri) + return 1; + else + return 0; + } + } +} + +/* + * Detach a btree node from its parent + */ +static inline void +schedule_detach_parent (struct schedule *s, struct schedule_entry *e) +{ + if (e) + { + if (e->parent) + { + if (e->parent->lt == e) + e->parent->lt = NULL; + else if (e->parent->gt == e) + e->parent->gt = NULL; + else + { + /* parent <-> child linkage is corrupted */ + ASSERT (0); + } + e->parent = NULL; + } + else + { + if (s->root == e) /* last element deleted, tree is empty */ + s->root = NULL; + } + } +} + +/* + * + * Given a binary search tree, move a node toward the root + * while still maintaining the correct ordering relationships + * within the tree. This function is the workhorse + * of the tree balancer. + * + * This code will break on key collisions, which shouldn't + * happen because the treap priority is considered part of the key + * and is guaranteed to be unique. + */ +static void +schedule_rotate_up (struct schedule *s, struct schedule_entry *e) +{ + if (e && e->parent) + { + struct schedule_entry *lt = e->lt; + struct schedule_entry *gt = e->gt; + struct schedule_entry *p = e->parent; + struct schedule_entry *gp = p->parent; + + if (gp) /* if grandparent exists, modify its child link */ + { + if (gp->gt == p) + gp->gt = e; + else if (gp->lt == p) + gp->lt = e; + else + { + ASSERT (0); + } + } + else /* no grandparent, now we are the root */ + { + s->root = e; + } + + /* grandparent is now our parent */ + e->parent = gp; + + /* parent is now our child */ + p->parent = e; + + /* reorient former parent's links + to reflect new position in the tree */ + if (p->gt == e) + { + e->lt = p; + p->gt = lt; + if (lt) + lt->parent = p; + } + else if (p->lt == e) + { + e->gt = p; + p->lt = gt; + if (gt) + gt->parent = p; + } + else + { + /* parent <-> child linkage is corrupted */ + ASSERT (0); + } + +#ifdef SCHEDULE_TEST + ++z.sru; +#endif + } +} + +/* + * This is the treap deletion algorithm: + * + * Rotate lesser-priority children up in the tree + * until we are childless. Then delete. + */ +void +schedule_remove_node (struct schedule *s, struct schedule_entry *e) +{ + while (e->lt || e->gt) + { + if (e->lt) + { + if (e->gt) + { + if (e->lt->pri < e->gt->pri) + schedule_rotate_up (s, e->lt); + else + schedule_rotate_up (s, e->gt); + } + else + schedule_rotate_up (s, e->lt); + } + else if (e->gt) + schedule_rotate_up (s, e->gt); + } + + schedule_detach_parent (s, e); + e->pri = 0; +} + +/* + * Trivially add a node to a binary search tree without + * regard for balance. + */ +static void +schedule_insert (struct schedule *s, struct schedule_entry *e) +{ + struct schedule_entry *c = s->root; + while (true) + { + const int comp = schedule_entry_compare (e, c); + +#ifdef SCHEDULE_TEST + ++z.ins; +#endif + + if (comp == -1) + { + if (c->lt) + { + c = c->lt; + continue; + } + else + { + c->lt = e; + e->parent = c; + break; + } + } + else if (comp == 1) + { + if (c->gt) + { + c = c->gt; + continue; + } + else + { + c->gt = e; + e->parent = c; + break; + } + } + else + { + /* rare key/priority collision -- no big deal, + just choose another priority and retry */ +#ifdef SCHEDULE_TEST + ++z.coll; +#endif + schedule_set_pri (e); + /* msg (M_INFO, "PRI COLLISION pri=%u", e->pri); */ + c = s->root; + continue; + } + } +} + +/* + * Given an element, remove it from the btree if it's already + * there and re-insert it based on its current key. + */ +void +schedule_add_modify (struct schedule *s, struct schedule_entry *e) +{ +#ifdef ENABLE_DEBUG + if (check_debug_level (D_SCHEDULER)) + schedule_entry_debug_info ("schedule_add_modify", e); +#endif + + /* already in tree, remove */ + if (IN_TREE (e)) + schedule_remove_node (s, e); + + /* set random priority */ + schedule_set_pri (e); + + if (s->root) + schedule_insert (s, e); /* trivial insert into tree */ + else + s->root = e; /* tree was empty, we are the first element */ + + /* This is the magic of the randomized treap algorithm which + keeps the tree balanced. Move the node up the tree until + its own priority is greater than that of its parent */ + while (e->parent && e->parent->pri > e->pri) + schedule_rotate_up (s, e); +} + +/* + * Find the earliest event to be scheduled + */ +struct schedule_entry * +schedule_find_least (struct schedule_entry *e) +{ + if (e) + { + while (e->lt) + { +#ifdef SCHEDULE_TEST + ++z.lsteps; +#endif + e = e->lt; + } + } + +#ifdef ENABLE_DEBUG + if (check_debug_level (D_SCHEDULER)) + schedule_entry_debug_info ("schedule_find_least", e); +#endif + + return e; +} + +/* + * Public functions below this point + */ + +struct schedule * +schedule_init (void) +{ + struct schedule *s; + + ALLOC_OBJ_CLEAR (s, struct schedule); + mutex_init (&s->mutex); + return s; +} + +void +schedule_free (struct schedule *s) +{ + mutex_destroy (&s->mutex); + free (s); +} + +void +schedule_remove_entry (struct schedule *s, struct schedule_entry *e) +{ + mutex_lock (&s->mutex); + s->earliest_wakeup = NULL; /* invalidate cache */ + schedule_remove_node (s, e); + mutex_unlock (&s->mutex); +} + +/* + * Debug functions below this point + */ + +#ifdef SCHEDULE_TEST + +static inline struct schedule_entry * +schedule_find_earliest_wakeup (struct schedule *s) +{ + return schedule_find_least (s->root); +} + +/* + * Recursively check that the treap (btree) is + * internally consistent. + */ +int +schedule_debug_entry (const struct schedule_entry* e, + int depth, + int *count, + struct timeval *least, + const struct timeval *min, + const struct timeval *max) +{ + struct gc_arena gc = gc_new (); + int maxdepth = depth; + if (e) + { + int d; + + ASSERT (e != e->lt); + ASSERT (e != e->gt); + ASSERT (e != e->parent); + ASSERT (!e->parent || e->parent != e->lt); + ASSERT (!e->parent || e->parent != e->gt); + ASSERT (!e->lt || e->lt != e->gt); + + if (e->lt) + { + ASSERT (e->lt->parent == e); + ASSERT (schedule_entry_compare (e->lt, e) == -1); + ASSERT (e->lt->pri >= e->pri); + } + + if (e->gt) + { + ASSERT (e->gt->parent == e); + ASSERT (schedule_entry_compare (e->gt, e)); + ASSERT (e->gt->pri >= e->pri); + } + + ASSERT (tv_le (min, &e->tv)); + ASSERT (tv_le (&e->tv, max)); + + if (count) + ++(*count); + + if (least && tv_lt (&e->tv, least)) + *least = e->tv; + + d = schedule_debug_entry (e->lt, depth+1, count, least, min, &e->tv); + if (d > maxdepth) + maxdepth = d; + + d = schedule_debug_entry (e->gt, depth+1, count, least, &e->tv, max); + if (d > maxdepth) + maxdepth = d; + } + gc_free (&gc); + return maxdepth; +} + +int +schedule_debug (struct schedule *s, int *count, struct timeval *least) +{ + struct timeval min; + struct timeval max; + + min.tv_sec = 0; + min.tv_usec = 0; + max.tv_sec = 0x7FFFFFFF; + max.tv_usec = 0x7FFFFFFF; + + if (s->root) + { + ASSERT (s->root->parent == NULL); + } + return schedule_debug_entry (s->root, 0, count, least, &min, &max); +} + +#if 1 + +void +tv_randomize (struct timeval *tv) +{ + tv->tv_sec += random() % 100; + tv->tv_usec = random () % 100; +} + +#else + +void +tv_randomize (struct timeval *tv) +{ + struct gc_arena gc = gc_new (); + long int choice = get_random (); + if ((choice & 0xFF) == 0) + tv->tv_usec += ((choice >> 8) & 0xFF); + else + prng_bytes ((uint8_t *)tv, sizeof (struct timeval)); + gc_free (&gc); +} + +#endif + +void +schedule_verify (struct schedule *s) +{ + struct gc_arena gc = gc_new (); + struct timeval least; + int count; + int maxlev; + struct schedule_entry* e; + const struct status zz = z; + + least.tv_sec = least.tv_usec = 0x7FFFFFFF; + + count = 0; + + maxlev = schedule_debug (s, &count, &least); + + e = schedule_find_earliest_wakeup (s); + + if (e) + { + printf ("Verification Phase count=%d maxlev=%d sru=%d ins=%d coll=%d ls=%d l=%s", + count, + maxlev, + zz.sru, + zz.ins, + zz.coll, + zz.lsteps, + tv_string (&e->tv, &gc)); + + if (!tv_eq (&least, &e->tv)) + printf (" [COMPUTED DIFFERENT MIN VALUES!]"); + + printf ("\n"); + } + + CLEAR (z); + gc_free (&gc); +} + +void +schedule_randomize_array (struct schedule_entry **array, int size) +{ + int i; + for (i = 0; i < size; ++i) + { + const int src = get_random () % size; + struct schedule_entry *tmp = array [i]; + if (i != src) + { + array [i] = array [src]; + array [src] = tmp; + } + } +} + +void +schedule_print_work (struct schedule_entry *e, int indent) +{ + struct gc_arena gc = gc_new (); + int i; + for (i = 0; i < indent; ++i) + printf (" "); + if (e) + { + printf ("%s [%u] e=" ptr_format ", p=" ptr_format " lt=" ptr_format " gt=" ptr_format "\n", + tv_string (&e->tv, &gc), + e->pri, + (ptr_type)e, + (ptr_type)e->parent, + (ptr_type)e->lt, + (ptr_type)e->gt); + schedule_print_work (e->lt, indent+1); + schedule_print_work (e->gt, indent+1); + } + else + printf ("NULL\n"); + gc_free (&gc); +} + +void +schedule_print (struct schedule *s) +{ + printf ("*************************\n"); + schedule_print_work (s->root, 0); +} + +void +schedule_test (void) +{ + struct gc_arena gc = gc_new (); + int n = 1000; + int n_mod = 25; + + int i, j; + struct schedule_entry **array; + struct schedule *s = schedule_init (); + struct schedule_entry* e; + + CLEAR (z); + ALLOC_ARRAY (array, struct schedule_entry *, n); + + printf ("Creation/Insertion Phase\n"); + + for (i = 0; i < n; ++i) + { + ALLOC_OBJ_CLEAR (array[i], struct schedule_entry); + tv_randomize (&array[i]->tv); + /*schedule_print (s);*/ + /*schedule_verify (s);*/ + schedule_add_modify (s, array[i]); + } + + schedule_randomize_array (array, n); + + /*schedule_print (s);*/ + schedule_verify (s); + + for (j = 1; j <= n_mod; ++j) + { + printf ("Modification Phase Pass %d\n", j); + + for (i = 0; i < n; ++i) + { + e = schedule_find_earliest_wakeup (s); + /*printf ("BEFORE %s\n", tv_string (&e->tv, &gc));*/ + tv_randomize (&e->tv); + /*printf ("AFTER %s\n", tv_string (&e->tv, &gc));*/ + schedule_add_modify (s, e); + /*schedule_verify (s);*/ + /*schedule_print (s);*/ + } + schedule_verify (s); + /*schedule_print (s);*/ + } + + /*printf ("INS=%d\n", z.ins);*/ + + while ((e = schedule_find_earliest_wakeup (s))) + { + schedule_remove_node (s, e); + /*schedule_verify (s);*/ + } + schedule_verify (s); + + printf ("S->ROOT is %s\n", s->root ? "NOT NULL" : "NULL"); + + for (i = 0; i < n; ++i) + { + free (array[i]); + } + free (array); + free (s); + gc_free (&gc); +} + +#endif +#endif diff --git a/schedule.h b/schedule.h new file mode 100644 index 0000000..4e0ae74 --- /dev/null +++ b/schedule.h @@ -0,0 +1,140 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef SCHEDULE_H +#define SCHEDULE_H + +/* + * This code implements an efficient scheduler using + * a random treap binary tree. + * + * The scheduler is used by the server executive to + * keep track of which instances need service at a + * known time in the future. Instances need to + * schedule events for things such as sending + * a ping or scheduling a TLS renegotiation. + */ + +#if P2MP_SERVER + +/* define to enable a special test mode */ +/*#define SCHEDULE_TEST*/ + +#include "otime.h" +#include "thread.h" +#include "error.h" + +struct schedule_entry +{ + struct timeval tv; /* wakeup time */ + unsigned int pri; /* random treap priority */ + struct schedule_entry *parent; /* treap (btree) links */ + struct schedule_entry *lt; + struct schedule_entry *gt; +}; + +struct schedule +{ + MUTEX_DEFINE (mutex); + struct schedule_entry *earliest_wakeup; /* cached earliest wakeup */ + struct schedule_entry *root; /* the root of the treap (btree) */ +}; + +/* Public functions */ + +struct schedule *schedule_init (void); +void schedule_free (struct schedule *s); +void schedule_remove_entry (struct schedule *s, struct schedule_entry *e); + +#ifdef SCHEDULE_TEST +void schedule_test (void); +#endif + +/* Private Functions */ + +/* is node already in tree? */ +#define IN_TREE(e) ((e)->pri) + +struct schedule_entry *schedule_find_least (struct schedule_entry *e); +void schedule_add_modify (struct schedule *s, struct schedule_entry *e); +void schedule_remove_node (struct schedule *s, struct schedule_entry *e); + +/* Public inline functions */ + +/* + * Add a struct schedule_entry (whose storage is managed by + * caller) to the btree. tv signifies the wakeup time for + * a future event. sigma is a time interval measured + * in microseconds -- the event window being represented + * starts at (tv - sigma) and ends at (tv + sigma). + * Event signaling can occur anywere within this interval. + * Making the interval larger makes the scheduler more efficient, + * while making it smaller results in more precise scheduling. + * The caller should treat the passed struct schedule_entry as + * an opaque object. + */ +static inline void +schedule_add_entry (struct schedule *s, + struct schedule_entry *e, + const struct timeval *tv, + unsigned int sigma) +{ + mutex_lock (&s->mutex); + if (!IN_TREE (e) || !sigma || !tv_within_sigma (tv, &e->tv, sigma)) + { + e->tv = *tv; + schedule_add_modify (s, e); + s->earliest_wakeup = NULL; /* invalidate cache */ + } + mutex_unlock (&s->mutex); +} + +/* + * Return the node with the earliest wakeup time. If two + * nodes have the exact same wakeup time, select based on + * the random priority assigned to each node (the priority + * is randomized every time an entry is re-added). + */ +static inline struct schedule_entry * +schedule_get_earliest_wakeup (struct schedule *s, + struct timeval *wakeup) +{ + struct schedule_entry *ret; + + mutex_lock (&s->mutex); + + /* cache result */ + if (!s->earliest_wakeup) + s->earliest_wakeup = schedule_find_least (s->root); + ret = s->earliest_wakeup; + if (ret) + *wakeup = ret->tv; + + mutex_unlock (&s->mutex); + + return ret; +} + +#endif +#endif diff --git a/service-win32/Makefile b/service-win32/Makefile new file mode 100755 index 0000000..027b6dd --- /dev/null +++ b/service-win32/Makefile @@ -0,0 +1,25 @@ +# This makefile builds the OpenVPN win32 service +# wrapper using the mingw environment. +# +# service.c and service.h should be generated by +# applying service.patch to the Platform +# SDK service sample. + +EXE = openvpnserv.exe + +HEADERS = service.h + +OBJS = openvpnserv.o service.o + +INCLUDE_DIRS = + +CC = gcc -g -O2 -Wall -Wno-unused-function -Wno-unused-variable -mno-cygwin + +all : ${OBJS} + ${CC} -o ${EXE} ${OBJS} + +clean : + rm -f ${OBJS} ${EXE} + +%.o : %.c ${HEADERS} + ${CC} ${INCLUDE_DIRS} -c $< -o $@ diff --git a/service-win32/mkpatch b/service-win32/mkpatch new file mode 100755 index 0000000..d87af52 --- /dev/null +++ b/service-win32/mkpatch @@ -0,0 +1,4 @@ +# build service.[ch] patch against original +# SDK sample +diff -u service.c.orig service.c >service.patch +diff -u service.h.orig service.h >>service.patch diff --git a/service-win32/openvpnserv.c b/service-win32/openvpnserv.c new file mode 100755 index 0000000..0a64a67 --- /dev/null +++ b/service-win32/openvpnserv.c @@ -0,0 +1,513 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * This program allows one or more OpenVPN processes to be started + * as a service. To build, you must get the service sample from the + * Platform SDK and replace Simple.c with this file. + * + * You should also apply service.patch to + * service.c and service.h from the Platform SDK service sample. + * + * This code is designed to be built with the mingw compiler. + */ + +#include <windows.h> +#include <stdlib.h> +#include <stdio.h> +#include <process.h> +#include "service.h" + +/* bool definitions */ +#define bool int +#define true 1 +#define false 0 + +/* These are new for 2000/XP, so they aren't in the mingw headers yet */ +#ifndef BELOW_NORMAL_PRIORITY_CLASS +#define BELOW_NORMAL_PRIORITY_CLASS 0x00004000 +#endif +#ifndef ABOVE_NORMAL_PRIORITY_CLASS +#define ABOVE_NORMAL_PRIORITY_CLASS 0x00008000 +#endif + +struct security_attributes +{ + SECURITY_ATTRIBUTES sa; + SECURITY_DESCRIPTOR sd; +}; + +/* + * This event is initially created in the non-signaled + * state. It will transition to the signaled state when + * we have received a terminate signal from the Service + * Control Manager which will cause an asynchronous call + * of ServiceStop below. + */ +#define EXIT_EVENT_NAME "openvpn_exit_1" + +/* + * Which registry key in HKLM should + * we get config info from? + */ +#define REG_KEY "SOFTWARE\\OpenVPN" + +static HANDLE exit_event = NULL; + +/* clear an object */ +#define CLEAR(x) memset(&(x), 0, sizeof(x)) + +/* snprintf with guaranteed null termination */ +#define mysnprintf(out, args...) \ + { \ + snprintf (out, sizeof(out), args); \ + out [sizeof (out) - 1] = '\0'; \ + } + +/* + * Message handling + */ +#define M_INFO (0) // informational +#define M_SYSERR (MSG_FLAGS_ERROR|MSG_FLAGS_SYS_CODE) // error + system code +#define M_ERR (MSG_FLAGS_ERROR) // error + +/* write error to event log */ +#define MSG(flags, args...) \ + { \ + char x_msg[256]; \ + mysnprintf (x_msg, args); \ + AddToMessageLog ((flags), x_msg); \ + } + +/* get a registry string */ +#define QUERY_REG_STRING(name, data) \ + { \ + len = sizeof (data); \ + status = RegQueryValueEx(openvpn_key, name, NULL, &type, data, &len); \ + if (status != ERROR_SUCCESS || type != REG_SZ) \ + { \ + SetLastError (status); \ + MSG (M_SYSERR, error_format_str, name); \ + RegCloseKey (openvpn_key); \ + goto finish; \ + } \ + } + +/* get a registry string */ +#define QUERY_REG_DWORD(name, data) \ + { \ + len = sizeof (DWORD); \ + status = RegQueryValueEx(openvpn_key, name, NULL, &type, (LPBYTE)&data, &len); \ + if (status != ERROR_SUCCESS || type != REG_DWORD || len != sizeof (DWORD)) \ + { \ + SetLastError (status); \ + MSG (M_SYSERR, error_format_dword, name); \ + RegCloseKey (openvpn_key); \ + goto finish; \ + } \ + } + +bool +init_security_attributes_allow_all (struct security_attributes *obj) +{ + CLEAR (*obj); + + obj->sa.nLength = sizeof (SECURITY_ATTRIBUTES); + obj->sa.lpSecurityDescriptor = &obj->sd; + obj->sa.bInheritHandle = TRUE; + if (!InitializeSecurityDescriptor (&obj->sd, SECURITY_DESCRIPTOR_REVISION)) + return false; + if (!SetSecurityDescriptorDacl (&obj->sd, TRUE, NULL, FALSE)) + return false; + return true; +} + +HANDLE +create_event (const char *name, bool allow_all, bool initial_state, bool manual_reset) +{ + if (allow_all) + { + struct security_attributes sa; + if (!init_security_attributes_allow_all (&sa)) + return NULL; + return CreateEvent (&sa.sa, (BOOL)manual_reset, (BOOL)initial_state, name); + } + else + return CreateEvent (NULL, (BOOL)manual_reset, (BOOL)initial_state, name); +} + +void +close_if_open (HANDLE h) +{ + if (h != NULL) + CloseHandle (h); +} + +static bool +match (const WIN32_FIND_DATA *find, const char *ext) +{ + int i; + + if (find->dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) + return false; + + if (!strlen (ext)) + return true; + + i = strlen (find->cFileName) - strlen (ext) - 1; + if (i < 1) + return false; + + return find->cFileName[i] == '.' && !strcasecmp (find->cFileName + i + 1, ext); +} + +/* + * Modify the extension on a filename. + */ +static bool +modext (char *dest, int size, const char *src, const char *newext) +{ + int i; + + if (size > 0 && (strlen (src) + 1) <= size) + { + strcpy (dest, src); + dest [size - 1] = '\0'; + i = strlen (dest); + while (--i >= 0) + { + if (dest[i] == '\\') + break; + if (dest[i] == '.') + { + dest[i] = '\0'; + break; + } + } + if (strlen (dest) + strlen(newext) + 2 <= size) + { + strcat (dest, "."); + strcat (dest, newext); + return true; + } + dest [0] = '\0'; + } + return false; +} + +VOID ServiceStart (DWORD dwArgc, LPTSTR *lpszArgv) +{ + char exe_path[MAX_PATH]; + char config_dir[MAX_PATH]; + char ext_string[16]; + char log_dir[MAX_PATH]; + char priority_string[64]; + char append_string[2]; + + DWORD priority; + bool append; + + ResetError (); + + if (!ReportStatusToSCMgr(SERVICE_START_PENDING, NO_ERROR, 3000)) + { + MSG (M_ERR, "ReportStatusToSCMgr #1 failed"); + goto finish; + } + + /* + * Create our exit event + */ + exit_event = create_event (EXIT_EVENT_NAME, false, false, true); + if (!exit_event) + { + MSG (M_ERR, "CreateEvent failed"); + goto finish; + } + + /* + * If exit event is already signaled, it means we were not + * shut down properly. + */ + if (WaitForSingleObject (exit_event, 0) != WAIT_TIMEOUT) + { + MSG (M_ERR, "Exit event is already signaled -- we were not shut down properly"); + goto finish; + } + + if (!ReportStatusToSCMgr(SERVICE_START_PENDING, NO_ERROR, 3000)) + { + MSG (M_ERR, "ReportStatusToSCMgr #2 failed"); + goto finish; + } + + /* + * Read info from registry in key HKLM\SOFTWARE\OpenVPN + */ + { + HKEY openvpn_key; + LONG status; + DWORD len; + DWORD type; + char error_string[256]; + + static const char error_format_str[] = + "Error querying registry key of type REG_SZ: HKLM\\" REG_KEY "\\%s"; + + static const char error_format_dword[] = + "Error querying registry key of type REG_DWORD: HKLM\\" REG_KEY "\\%s"; + + status = RegOpenKeyEx( + HKEY_LOCAL_MACHINE, + REG_KEY, + 0, + KEY_READ, + &openvpn_key); + + if (status != ERROR_SUCCESS) + { + SetLastError (status); + MSG (M_SYSERR, "Registry key HKLM\\" REG_KEY " not found"); + goto finish; + } + + /* get path to openvpn.exe */ + QUERY_REG_STRING ("exe_path", exe_path); + + /* get path to configuration directory */ + QUERY_REG_STRING ("config_dir", config_dir); + + /* get extension on configuration files */ + QUERY_REG_STRING ("config_ext", ext_string); + + /* get path to log directory */ + QUERY_REG_STRING ("log_dir", log_dir); + + /* get priority for spawned OpenVPN subprocesses */ + QUERY_REG_STRING ("priority", priority_string); + + /* should we truncate or append to logfile? */ + QUERY_REG_STRING ("log_append", append_string); + + RegCloseKey (openvpn_key); + } + + /* set process priority */ + priority = NORMAL_PRIORITY_CLASS; + if (!strcasecmp (priority_string, "IDLE_PRIORITY_CLASS")) + priority = IDLE_PRIORITY_CLASS; + else if (!strcasecmp (priority_string, "BELOW_NORMAL_PRIORITY_CLASS")) + priority = BELOW_NORMAL_PRIORITY_CLASS; + else if (!strcasecmp (priority_string, "NORMAL_PRIORITY_CLASS")) + priority = NORMAL_PRIORITY_CLASS; + else if (!strcasecmp (priority_string, "ABOVE_NORMAL_PRIORITY_CLASS")) + priority = ABOVE_NORMAL_PRIORITY_CLASS; + else if (!strcasecmp (priority_string, "HIGH_PRIORITY_CLASS")) + priority = HIGH_PRIORITY_CLASS; + else + { + MSG (M_ERR, "Unknown priority name: %s", priority_string); + goto finish; + } + + /* set log file append/truncate flag */ + append = false; + if (append_string[0] == '0') + append = false; + else if (append_string[0] == '1') + append = true; + else + { + MSG (M_ERR, "Log file append flag (given as '%s') must be '0' or '1'", append_string); + goto finish; + } + + /* + * Instantiate an OpenVPN process for each configuration + * file found. + */ + { + WIN32_FIND_DATA find_obj; + HANDLE find_handle; + BOOL more_files; + char find_string[MAX_PATH]; + + mysnprintf (find_string, "%s\\*", config_dir); + + find_handle = FindFirstFile (find_string, &find_obj); + if (find_handle == INVALID_HANDLE_VALUE) + { + MSG (M_ERR, "Cannot get configuration file list using: %s", find_string); + goto finish; + } + + /* + * Loop over each config file + */ + do { + HANDLE log_handle = NULL; + STARTUPINFO start_info; + PROCESS_INFORMATION proc_info; + struct security_attributes sa; + char log_file[MAX_PATH]; + char log_path[MAX_PATH]; + char command_line[256]; + + CLEAR (start_info); + CLEAR (proc_info); + CLEAR (sa); + + if (!ReportStatusToSCMgr(SERVICE_START_PENDING, NO_ERROR, 3000)) + { + MSG (M_ERR, "ReportStatusToSCMgr #3 failed"); + FindClose (find_handle); + goto finish; + } + + /* does file have the correct type and extension? */ + if (match (&find_obj, ext_string)) + { + /* get log file pathname */ + if (!modext (log_file, sizeof (log_file), find_obj.cFileName, "log")) + { + MSG (M_ERR, "Cannot construct logfile name based on: %s", find_obj.cFileName); + FindClose (find_handle); + goto finish; + } + mysnprintf (log_path, "%s\\%s", log_dir, log_file); + + /* construct command line */ + mysnprintf (command_line, "openvpn --service %s 1 --config \"%s\"", + EXIT_EVENT_NAME, + find_obj.cFileName); + + /* Make security attributes struct for logfile handle so it can + be inherited. */ + if (!init_security_attributes_allow_all (&sa)) + { + MSG (M_SYSERR, "InitializeSecurityDescriptor start_openvpn failed"); + goto finish; + } + + /* open logfile as stdout/stderr for soon-to-be-spawned subprocess */ + log_handle = CreateFile (log_path, + GENERIC_WRITE, + FILE_SHARE_READ, + &sa.sa, + append ? OPEN_ALWAYS : CREATE_ALWAYS, + FILE_ATTRIBUTE_NORMAL, + NULL); + + if (log_handle == INVALID_HANDLE_VALUE) + { + MSG (M_SYSERR, "Cannot open logfile: %s", log_path); + FindClose (find_handle); + goto finish; + } + + /* append to logfile? */ + if (append) + { + if (SetFilePointer (log_handle, 0, NULL, FILE_END) == INVALID_SET_FILE_POINTER) + { + MSG (M_SYSERR, "Cannot seek to end of logfile: %s", log_path); + FindClose (find_handle); + goto finish; + } + } + + /* fill in STARTUPINFO struct */ + GetStartupInfo(&start_info); + start_info.cb = sizeof(start_info); + start_info.dwFlags = STARTF_USESTDHANDLES|STARTF_USESHOWWINDOW; + start_info.wShowWindow = SW_HIDE; + start_info.hStdInput = GetStdHandle(STD_INPUT_HANDLE); + start_info.hStdOutput = start_info.hStdError = log_handle; + + /* create an OpenVPN process for one config file */ + if (!CreateProcess(exe_path, + command_line, + NULL, + NULL, + TRUE, + priority | CREATE_NEW_CONSOLE, + NULL, + config_dir, + &start_info, + &proc_info)) + { + MSG (M_SYSERR, "CreateProcess failed, exe='%s' cmdline='%s' dir='%s'", + exe_path, + command_line, + config_dir); + + FindClose (find_handle); + CloseHandle (log_handle); + goto finish; + } + + /* close unneeded handles */ + Sleep (1000); /* try to prevent race if we close logfile + handle before child process DUPs it */ + if (!CloseHandle (proc_info.hProcess) + || !CloseHandle (proc_info.hThread) + || !CloseHandle (log_handle)) + { + MSG (M_SYSERR, "CloseHandle failed"); + goto finish; + } + } + + /* more files to process? */ + more_files = FindNextFile (find_handle, &find_obj); + + } while (more_files); + + FindClose (find_handle); + } + + /* we are now fully started */ + if (!ReportStatusToSCMgr(SERVICE_RUNNING, NO_ERROR, 0)) + { + MSG (M_ERR, "ReportStatusToSCMgr SERVICE_RUNNING failed"); + goto finish; + } + + /* wait for our shutdown signal */ + if (WaitForSingleObject (exit_event, INFINITE) != WAIT_OBJECT_0) + { + MSG (M_ERR, "wait for shutdown signal failed"); + } + + finish: + ServiceStop (); + if (exit_event) + CloseHandle (exit_event); +} + +VOID ServiceStop() +{ + if (exit_event) + SetEvent(exit_event); +} diff --git a/service-win32/service.patch b/service-win32/service.patch new file mode 100755 index 0000000..0b60472 --- /dev/null +++ b/service-win32/service.patch @@ -0,0 +1,383 @@ +--- service.c.orig Sat Jan 15 17:39:20 2005 ++++ service.c Sun Feb 20 11:28:30 2005 +@@ -16,6 +16,7 @@ + service_main(DWORD dwArgc, LPTSTR *lpszArgv); + CmdInstallService(); + CmdRemoveService(); ++ CmdStartService(); + CmdDebugService(int argc, char **argv); + ControlHandler ( DWORD dwCtrlType ); + GetLastErrorText( LPTSTR lpszBuf, DWORD dwSize ); +@@ -40,8 +41,9 @@ + // internal function prototypes + VOID WINAPI service_ctrl(DWORD dwCtrlCode); + VOID WINAPI service_main(DWORD dwArgc, LPTSTR *lpszArgv); +-VOID CmdInstallService(); +-VOID CmdRemoveService(); ++int CmdInstallService(); ++int CmdRemoveService(); ++int CmdStartService(); + VOID CmdDebugService(int argc, char **argv); + BOOL WINAPI ControlHandler ( DWORD dwCtrlType ); + LPTSTR GetLastErrorText( LPTSTR lpszBuf, DWORD dwSize ); +@@ -64,7 +66,7 @@ + // main service thread. When the this call returns, + // the service has stopped, so exit. + // +-void __cdecl main(int argc, char **argv) ++int __cdecl main(int argc, char **argv) + { + SERVICE_TABLE_ENTRY dispatchTable[] = + { +@@ -77,12 +79,16 @@ + { + if ( _stricmp( "install", argv[1]+1 ) == 0 ) + { +- CmdInstallService(); ++ return CmdInstallService(); + } + else if ( _stricmp( "remove", argv[1]+1 ) == 0 ) + { +- CmdRemoveService(); ++ return CmdRemoveService(); + } ++ else if ( _stricmp( "start", argv[1]+1 ) == 0) ++ { ++ return CmdStartService(); ++ } + else if ( _stricmp( "debug", argv[1]+1 ) == 0 ) + { + bDebug = TRUE; +@@ -92,7 +98,7 @@ + { + goto dispatch; + } +- exit(0); ++ return 0; + } + + // if it doesn't match any of the above parameters +@@ -101,13 +107,16 @@ + dispatch: + // this is just to be friendly + printf( "%s -install to install the service\n", SZAPPNAME ); ++ printf( "%s -start to start the service\n", SZAPPNAME ); + printf( "%s -remove to remove the service\n", SZAPPNAME ); + printf( "%s -debug <params> to run as a console app for debugging\n", SZAPPNAME ); + printf( "\nStartServiceCtrlDispatcher being called.\n" ); + printf( "This may take several seconds. Please wait.\n" ); + + if (!StartServiceCtrlDispatcher(dispatchTable)) +- AddToMessageLog(TEXT("StartServiceCtrlDispatcher failed.")); ++ AddToMessageLog(MSG_FLAGS_ERROR, TEXT("StartServiceCtrlDispatcher failed.")); ++ ++ return 0; + } + + +@@ -267,7 +276,7 @@ + // + if (!(fResult = SetServiceStatus( sshStatusHandle, &ssStatus))) + { +- AddToMessageLog(TEXT("SetServiceStatus")); ++ AddToMessageLog(MSG_FLAGS_ERROR, TEXT("SetServiceStatus")); + } + } + return fResult; +@@ -288,28 +297,33 @@ + // + // COMMENTS: + // +-VOID AddToMessageLog(LPTSTR lpszMsg) ++void AddToMessageLog(DWORD flags, LPTSTR lpszMsg) + { + TCHAR szMsg [(sizeof(SZSERVICENAME) / sizeof(TCHAR)) + 100 ]; + HANDLE hEventSource; +- LPTSTR lpszStrings[2]; ++ LPCSTR lpszStrings[2]; + + if ( !bDebug ) + { +- dwErr = GetLastError(); ++ if (flags & MSG_FLAGS_SYS_CODE) ++ dwErr = GetLastError(); ++ else ++ dwErr = 0; + + // Use event logging to log the error. + // + hEventSource = RegisterEventSource(NULL, TEXT(SZSERVICENAME)); + +- _stprintf(szMsg, TEXT("%s error: %d"), TEXT(SZSERVICENAME), dwErr); ++ _stprintf(szMsg, TEXT("%s error: %d"), TEXT(SZSERVICENAME), (int)dwErr); + lpszStrings[0] = szMsg; + lpszStrings[1] = lpszMsg; + + if (hEventSource != NULL) + { + ReportEvent(hEventSource, // handle of event source +- EVENTLOG_ERROR_TYPE, // event type ++ // event type ++ (flags & MSG_FLAGS_ERROR) ++ ? EVENTLOG_ERROR_TYPE : EVENTLOG_INFORMATION_TYPE, + 0, // event category + 0, // event ID + NULL, // current user's SID +@@ -323,8 +337,10 @@ + } + } + +- +- ++void ResetError (void) ++{ ++ dwErr = 0; ++} + + /////////////////////////////////////////////////////////////////// + // +@@ -341,21 +357,23 @@ + // none + // + // RETURN VALUE: +-// none ++// 0 if success + // + // COMMENTS: + // +-void CmdInstallService() ++int CmdInstallService() + { + SC_HANDLE schService; + SC_HANDLE schSCManager; + + TCHAR szPath[512]; + ++ int ret = 0; ++ + if ( GetModuleFileName( NULL, szPath, 512 ) == 0 ) + { + _tprintf(TEXT("Unable to install %s - %s\n"), TEXT(SZSERVICEDISPLAYNAME), GetLastErrorText(szErr, 256)); +- return; ++ return 1; + } + + schSCManager = OpenSCManager( +@@ -366,19 +384,19 @@ + if ( schSCManager ) + { + schService = CreateService( +- schSCManager, // SCManager database +- TEXT(SZSERVICENAME), // name of service +- TEXT(SZSERVICEDISPLAYNAME), // name to display +- SERVICE_QUERY_STATUS, // desired access +- SERVICE_WIN32_OWN_PROCESS, // service type +- SERVICE_DEMAND_START, // start type +- SERVICE_ERROR_NORMAL, // error control type +- szPath, // service's binary +- NULL, // no load ordering group +- NULL, // no tag identifier +- TEXT(SZDEPENDENCIES), // dependencies +- NULL, // LocalSystem account +- NULL); // no password ++ schSCManager, // SCManager database ++ TEXT(SZSERVICENAME), // name of service ++ TEXT(SZSERVICEDISPLAYNAME), // name to display ++ SERVICE_QUERY_STATUS, // desired access ++ SERVICE_WIN32_OWN_PROCESS, // service type ++ SERVICE_DEMAND_START, // start type -- alternative: SERVICE_AUTO_START ++ SERVICE_ERROR_NORMAL, // error control type ++ szPath, // service's binary ++ NULL, // no load ordering group ++ NULL, // no tag identifier ++ TEXT(SZDEPENDENCIES), // dependencies ++ NULL, // LocalSystem account ++ NULL); // no password + + if ( schService ) + { +@@ -388,15 +406,78 @@ + else + { + _tprintf(TEXT("CreateService failed - %s\n"), GetLastErrorText(szErr, 256)); ++ ret = 1; + } + + CloseServiceHandle(schSCManager); + } + else +- _tprintf(TEXT("OpenSCManager failed - %s\n"), GetLastErrorText(szErr,256)); ++ { ++ _tprintf(TEXT("OpenSCManager failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } ++ return ret; + } + ++// ++// FUNCTION: CmdStartService() ++// ++// PURPOSE: Start the service ++// ++// PARAMETERS: ++// none ++// ++// RETURN VALUE: ++// 0 if success ++// ++// COMMENTS: ++ ++int CmdStartService() ++{ ++ int ret = 0; ++ ++ SC_HANDLE schSCManager; ++ SC_HANDLE schService; ++ + ++ // Open a handle to the SC Manager database. ++ schSCManager = OpenSCManager( ++ NULL, // local machine ++ NULL, // ServicesActive database ++ SC_MANAGER_ALL_ACCESS); // full access rights ++ ++ if (NULL == schSCManager) { ++ _tprintf(TEXT("OpenSCManager failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } ++ ++ schService = OpenService( ++ schSCManager, // SCM database ++ "MeetrixService", // service name ++ SERVICE_ALL_ACCESS); ++ ++ if (schService == NULL) { ++ _tprintf(TEXT("OpenService failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } ++ ++ if (!StartService( ++ schService, // handle to service ++ 0, // number of arguments ++ NULL) ) // no arguments ++ { ++ _tprintf(TEXT("StartService failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } ++ else ++ { ++ _tprintf(TEXT("Service Started\n")); ++ ret = 0; ++ } ++ CloseServiceHandle(schService); ++ CloseServiceHandle(schSCManager); ++ return ret; ++} + + // + // FUNCTION: CmdRemoveService() +@@ -407,15 +488,17 @@ + // none + // + // RETURN VALUE: +-// none ++// 0 if success + // + // COMMENTS: + // +-void CmdRemoveService() ++int CmdRemoveService() + { + SC_HANDLE schService; + SC_HANDLE schSCManager; + ++ int ret = 0; ++ + schSCManager = OpenSCManager( + NULL, // machine (NULL == local) + NULL, // database (NULL == default) +@@ -447,7 +530,10 @@ + if ( ssStatus.dwCurrentState == SERVICE_STOPPED ) + _tprintf(TEXT("\n%s stopped.\n"), TEXT(SZSERVICEDISPLAYNAME) ); + else +- _tprintf(TEXT("\n%s failed to stop.\n"), TEXT(SZSERVICEDISPLAYNAME) ); ++ { ++ _tprintf(TEXT("\n%s failed to stop.\n"), TEXT(SZSERVICEDISPLAYNAME) ); ++ ret = 1; ++ } + + } + +@@ -455,18 +541,28 @@ + if ( DeleteService(schService) ) + _tprintf(TEXT("%s removed.\n"), TEXT(SZSERVICEDISPLAYNAME) ); + else +- _tprintf(TEXT("DeleteService failed - %s\n"), GetLastErrorText(szErr,256)); ++ { ++ _tprintf(TEXT("DeleteService failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } + + + CloseServiceHandle(schService); + } + else +- _tprintf(TEXT("OpenService failed - %s\n"), GetLastErrorText(szErr,256)); ++ { ++ _tprintf(TEXT("OpenService failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } + + CloseServiceHandle(schSCManager); + } + else +- _tprintf(TEXT("OpenSCManager failed - %s\n"), GetLastErrorText(szErr,256)); ++ { ++ _tprintf(TEXT("OpenSCManager failed - %s\n"), GetLastErrorText(szErr,256)); ++ ret = 1; ++ } ++ return ret; + } + + +@@ -587,7 +683,7 @@ + else + { + lpszTemp[lstrlen(lpszTemp)-2] = TEXT('\0'); //remove cr and newline character +- _stprintf( lpszBuf, TEXT("%s (0x%x)"), lpszTemp, GetLastError() ); ++ _stprintf( lpszBuf, TEXT("%s (0x%x)"), lpszTemp, (int)GetLastError() ); + } + + if ( lpszTemp ) +--- service.h.orig Sat Jan 15 17:39:20 2005 ++++ service.h Mon Feb 7 17:24:04 2005 +@@ -62,13 +62,13 @@ + //// todo: change to desired strings + //// + // name of the executable +-#define SZAPPNAME "Simple" ++#define SZAPPNAME "openvpnserv" + // internal name of the service +-#define SZSERVICENAME "SimpleService" ++#define SZSERVICENAME "OpenVPNService" + // displayed name of the service +-#define SZSERVICEDISPLAYNAME "Simple Service" ++#define SZSERVICEDISPLAYNAME "OpenVPN Service" + // list of service dependencies - "dep1\0dep2\0\0" +-#define SZDEPENDENCIES "" ++#define SZDEPENDENCIES "TAP0801\0\0" + ////////////////////////////////////////////////////////////////////////////// + + +@@ -126,7 +126,10 @@ + // RETURN VALUE: + // none + // +- void AddToMessageLog(LPTSTR lpszMsg); ++# define MSG_FLAGS_ERROR (1<<0) ++# define MSG_FLAGS_SYS_CODE (1<<1) ++ void AddToMessageLog(DWORD flags, LPTSTR lpszMsg); ++ void ResetError (void); + ////////////////////////////////////////////////////////////////////////////// + + diff --git a/session_id.c b/session_id.c new file mode 100644 index 0000000..66c2442 --- /dev/null +++ b/session_id.c @@ -0,0 +1,67 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Each session is identified by a random 8-byte session identifier. + * + * For efficiency, the session id is only transmitted over the control + * channel (which only sees traffic occasionally when keys are being + * negotiated). The data channel sees a smaller version of the session-id -- + * it is called the key_id and is currently 2 bits long. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +#include "syshead.h" + +#include "error.h" +#include "common.h" +#include "crypto.h" +#include "session_id.h" + +#include "memdbg.h" + +const struct session_id x_session_id_zero; + +void +session_id_random (struct session_id *sid) +{ + prng_bytes (sid->id, SID_SIZE); +} + +const char * +session_id_print (const struct session_id *sid, struct gc_arena *gc) +{ + return format_hex (sid->id, SID_SIZE, 0, gc); +} + +#else +static void dummy(void) {} +#endif /* USE_CRYPTO && USE_SSL*/ diff --git a/session_id.h b/session_id.h new file mode 100644 index 0000000..d569c09 --- /dev/null +++ b/session_id.h @@ -0,0 +1,86 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Each session is identified by a random 8-byte session identifier. + * + * For efficiency, the session id is only transmitted over the control + * channel (which only sees traffic occasionally when keys are being + * negotiated). + */ + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +#ifndef SESSION_ID_H +#define SESSION_ID_H + +#include "basic.h" +#include "buffer.h" + +struct session_id +{ + uint8_t id[8]; +}; + +extern const struct session_id x_session_id_zero; + +#define SID_SIZE (sizeof (x_session_id_zero.id)) + +static inline bool +session_id_equal (const struct session_id *sid1, + const struct session_id *sid2) +{ + return !memcmp (sid1->id, sid2->id, SID_SIZE); +} + +static inline bool +session_id_defined (const struct session_id *sid1) +{ + return memcmp (sid1->id, &x_session_id_zero.id, SID_SIZE) != 0; +} + +static inline bool +session_id_read (struct session_id *sid, struct buffer *buf) +{ + return buf_read (buf, sid->id, SID_SIZE); +} + +static inline bool +session_id_write_prepend (const struct session_id *sid, struct buffer *buf) +{ + return buf_write_prepend (buf, sid->id, SID_SIZE); +} + +static inline bool +session_id_write (const struct session_id *sid, struct buffer *buf) +{ + return buf_write (buf, sid->id, SID_SIZE); +} + +void session_id_random (struct session_id *sid); + +const char *session_id_print (const struct session_id *sid, struct gc_arena *gc); + +#endif /* SESSION_ID_H */ +#endif /* USE_CRYPTO && USE_SSL */ diff --git a/shaper.c b/shaper.c new file mode 100644 index 0000000..f3b06cb --- /dev/null +++ b/shaper.c @@ -0,0 +1,100 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif +#include "syshead.h" +#include "shaper.h" +#include "memdbg.h" + +#ifdef HAVE_GETTIMEOFDAY + +/* + * We want to wake up in delay microseconds. If timeval is larger + * than delay, set timeval to delay. + */ +bool +shaper_soonest_event (struct timeval *tv, int delay) +{ + bool ret = false; + if (delay < 1000000) + { + if (tv->tv_sec) + { + tv->tv_sec = 0; + tv->tv_usec = delay; + ret = true; + } + else if (delay < tv->tv_usec) + { + tv->tv_usec = delay; + ret = true; + } + } + else + { + const int sec = delay / 1000000; + const int usec = delay % 1000000; + + if (sec < tv->tv_sec) + { + tv->tv_sec = sec; + tv->tv_usec = usec; + ret = true; + } + else if (sec == tv->tv_sec) + { + if (usec < tv->tv_usec) + { + tv->tv_usec = usec; + ret = true; + } + } + } +#ifdef SHAPER_DEBUG + dmsg (D_SHAPER_DEBUG, "SHAPER shaper_soonest_event sec=%d usec=%d ret=%d", + (int)tv->tv_sec, (int)tv->tv_usec, (int)ret); +#endif + return ret; +} + +void +shaper_reset_wakeup (struct shaper *s) +{ + CLEAR (s->wakeup); +} + +void +shaper_msg (struct shaper *s) +{ + msg (M_INFO, "Output Traffic Shaping initialized at %d bytes per second", + s->bytes_per_second); +} + +#else +static void dummy(void) {} +#endif /* HAVE_GETTIMEOFDAY */ diff --git a/shaper.h b/shaper.h new file mode 100644 index 0000000..3aba241 --- /dev/null +++ b/shaper.h @@ -0,0 +1,178 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef SHAPER_H +#define SHAPER_H + +/*#define SHAPER_DEBUG*/ + +#ifdef HAVE_GETTIMEOFDAY + +#include "basic.h" +#include "integer.h" +#include "misc.h" +#include "error.h" +#include "interval.h" + +/* + * A simple traffic shaper for + * the output direction. + */ + +#define SHAPER_MIN 100 /* bytes per second */ +#define SHAPER_MAX 100000000 + +#define SHAPER_MAX_TIMEOUT 10 /* seconds */ + +#define SHAPER_USE_FP + +struct shaper +{ + int bytes_per_second; + struct timeval wakeup; + +#ifdef SHAPER_USE_FP + double factor; +#else + int factor; +#endif +}; + +void shaper_msg (struct shaper *s); +void shaper_reset_wakeup (struct shaper *s); + +/* + * We want to wake up in delay microseconds. If timeval is larger + * than delay, set timeval to delay. + */ +bool shaper_soonest_event (struct timeval *tv, int delay); + +/* + * inline functions + */ + +static inline void +shaper_reset (struct shaper *s, int bytes_per_second) +{ + s->bytes_per_second = bytes_per_second ? constrain_int (bytes_per_second, SHAPER_MIN, SHAPER_MAX) : 0; + +#ifdef SHAPER_USE_FP + s->factor = 1000000.0 / (double)s->bytes_per_second; +#else + s->factor = 1000000 / s->bytes_per_second; +#endif +} + +static inline void +shaper_init (struct shaper *s, int bytes_per_second) +{ + shaper_reset (s, bytes_per_second); + shaper_reset_wakeup (s); +} + +static inline int +shaper_current_bandwidth (struct shaper *s) +{ + return s->bytes_per_second; +} + +/* + * Returns traffic shaping delay in microseconds relative to current + * time, or 0 if no delay. + */ +static inline int +shaper_delay (struct shaper* s) +{ + struct timeval tv; + int delay = 0; + + if (tv_defined (&s->wakeup)) + { + ASSERT (!gettimeofday (&tv, NULL)); + delay = tv_subtract (&s->wakeup, &tv, SHAPER_MAX_TIMEOUT); +#ifdef SHAPER_DEBUG + dmsg (D_SHAPER_DEBUG, "SHAPER shaper_delay delay=%d", delay); +#endif + } + + return delay > 0 ? delay : 0; +} + + +/* + * We are about to send a datagram of nbytes bytes. + * + * Compute when we can send another datagram, + * based on target throughput (s->bytes_per_second). + */ +static inline void +shaper_wrote_bytes (struct shaper* s, int nbytes) +{ + struct timeval tv; + + /* compute delay in microseconds */ + tv.tv_sec = 0; +#ifdef SHAPER_USE_FP + tv.tv_usec = min_int ((int)((double)max_int (nbytes, 100) * s->factor), (SHAPER_MAX_TIMEOUT*1000000)); +#else + tv.tv_usec = s->bytes_per_second + ? min_int (max_int (nbytes, 100) * s->factor, (SHAPER_MAX_TIMEOUT*1000000)) + : 0; +#endif + + if (tv.tv_usec) + { + ASSERT (!gettimeofday (&s->wakeup, NULL)); + tv_add (&s->wakeup, &tv); + +#ifdef SHAPER_DEBUG + dmsg (D_SHAPER_DEBUG, "SHAPER shaper_wrote_bytes bytes=%d delay=%d sec=%d usec=%d", + nbytes, + (int)tv.tv_usec, + (int)s->wakeup.tv_sec, + (int)s->wakeup.tv_usec); +#endif + } +} + +#if 0 +/* + * Increase/Decrease bandwidth by a percentage. + * + * Return true if bandwidth changed. + */ +static inline bool +shaper_change_pct (struct shaper *s, int pct) +{ + const int orig_bandwidth = s->bytes_per_second; + const int new_bandwidth = orig_bandwidth + (orig_bandwidth * pct / 100); + ASSERT (s->bytes_per_second); + shaper_reset (s, new_bandwidth); + return s->bytes_per_second != orig_bandwidth; +} +#endif + +#endif /* HAVE_GETTIMEOFDAY */ + +#endif @@ -0,0 +1,345 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "buffer.h" +#include "error.h" +#include "win32.h" +#include "init.h" +#include "status.h" +#include "sig.h" +#include "occ.h" +#include "manage.h" +#include "openvpn.h" + +#include "memdbg.h" + +/* Handle signals */ + +struct signal_info siginfo_static; /* GLOBAL */ + +struct signame { + int value; + const char *upper; + const char *lower; +}; + +static const struct signame signames[] = { + { SIGINT, "SIGINT", "sigint"}, + { SIGTERM, "SIGTERM", "sigterm" }, + { SIGHUP, "SIGHUP", "sighup" }, + { SIGUSR1, "SIGUSR1", "sigusr1" }, + { SIGUSR2, "SIGUSR2", "sigusr2" } +}; + +int +parse_signal (const char *signame) +{ + int i; + for (i = 0; i < (int)SIZE (signames); ++i) + { + if (!strcmp (signame, signames[i].upper)) + return signames[i].value; + } + return -1; +} + +const char * +signal_name (const int sig, const bool upper) +{ + int i; + for (i = 0; i < (int)SIZE (signames); ++i) + { + if (sig == signames[i].value) + return upper ? signames[i].upper : signames[i].lower; + } + return "UNKNOWN"; +} + +const char * +signal_description (const int signum, const char *sigtext) +{ + if (sigtext) + return sigtext; + else + return signal_name (signum, false); +} + +void +throw_signal (const int signum) +{ + siginfo_static.signal_received = signum; + siginfo_static.hard = true; +} + +static void +signal_reset (struct signal_info *si) +{ + if (si) + { + si->signal_received = 0; + si->signal_text = NULL; + si->hard = false; + } +} + +void +print_signal (const struct signal_info *si, const char *title, int msglevel) +{ + if (si) + { + const char *hs = (si->hard ? "hard" : "soft"); + const char *type = (si->signal_text ? si->signal_text : ""); + const char *t = (title ? title : "process"); + + switch (si->signal_received) + { + case SIGINT: + case SIGTERM: + msg (msglevel, "%s[%s,%s] received, %s exiting", + signal_name (si->signal_received, true), hs, type, t); + break; + case SIGHUP: + case SIGUSR1: + msg (msglevel, "%s[%s,%s] received, %s restarting", + signal_name (si->signal_received, true), hs, type, t); + break; + default: + msg (msglevel, "Unknown signal %d [%s,%s] received by %s", si->signal_received, hs, type, t); + break; + } + } + else + msg (msglevel, "Unknown signal received"); +} + +/* + * Call management interface with restart info + */ +void +signal_restart_status (const struct signal_info *si) +{ +#ifdef ENABLE_MANAGEMENT + if (management) + { + int state = -1; + switch (si->signal_received) + { + case SIGINT: + case SIGTERM: + state = OPENVPN_STATE_EXITING; + break; + case SIGHUP: + case SIGUSR1: + state = OPENVPN_STATE_RECONNECTING; + break; + } + + if (state >= 0) + management_set_state (management, + state, + si->signal_text ? si->signal_text : signal_name (si->signal_received, true), + (in_addr_t)0); + } +#endif +} + +#ifdef HAVE_SIGNAL_H + +/* normal signal handler, when we are in event loop */ +static void +signal_handler (const int signum) +{ + throw_signal (signum); + signal (signum, signal_handler); +} + +/* temporary signal handler, before we are fully initialized */ +static void +signal_handler_exit (const int signum) +{ + msg (M_FATAL, + "Signal %d (%s) received during initialization, exiting", + signum, signal_description (signum, NULL)); +} + +#endif + +void +pre_init_signal_catch (void) +{ +#ifdef HAVE_SIGNAL_H + signal (SIGINT, signal_handler); + signal (SIGTERM, signal_handler); + signal (SIGHUP, signal_handler); + signal (SIGUSR1, SIG_IGN); + signal (SIGUSR2, SIG_IGN); + signal (SIGPIPE, SIG_IGN); +#endif /* HAVE_SIGNAL_H */ +} + +void +post_init_signal_catch (void) +{ +#ifdef HAVE_SIGNAL_H + signal (SIGINT, signal_handler); + signal (SIGTERM, signal_handler); + signal (SIGHUP, signal_handler); + signal (SIGUSR1, signal_handler); + signal (SIGUSR2, signal_handler); + signal (SIGPIPE, SIG_IGN); +#endif /* HAVE_SIGNAL_H */ +} + +/* + * Print statistics. + * + * Triggered by SIGUSR2 or F2 on Windows. + */ +void +print_status (const struct context *c, struct status_output *so) +{ + struct gc_arena gc = gc_new (); + + status_reset (so); + + status_printf (so, PACKAGE_NAME " STATISTICS"); + status_printf (so, "Updated,%s", time_string (0, 0, false, &gc)); + status_printf (so, "TUN/TAP read bytes," counter_format, c->c2.tun_read_bytes); + status_printf (so, "TUN/TAP write bytes," counter_format, c->c2.tun_write_bytes); + status_printf (so, "TCP/UDP read bytes," counter_format, c->c2.link_read_bytes); + status_printf (so, "TCP/UDP write bytes," counter_format, c->c2.link_write_bytes); + status_printf (so, "Auth read bytes," counter_format, c->c2.link_read_bytes_auth); +#ifdef USE_LZO + if (c->options.comp_lzo) + lzo_print_stats (&c->c2.lzo_compwork, so); +#endif +#ifdef WIN32 + if (tuntap_defined (c->c1.tuntap)) + status_printf (so, "TAP-WIN32 driver status,\"%s\"", + tap_win32_getinfo (c->c1.tuntap, &gc)); +#endif + + status_printf (so, "END"); + status_flush (so); + gc_free (&gc); +} + +#ifdef ENABLE_OCC +/* + * Handle the triggering and time-wait of explicit + * exit notification. + */ + +static void +process_explicit_exit_notification_init (struct context *c) +{ + msg (M_INFO, "SIGTERM received, sending exit notification to peer"); + event_timeout_init (&c->c2.explicit_exit_notification_interval, 1, 0); + reset_coarse_timers (c); + signal_reset (c->sig); + halt_non_edge_triggered_signals (); + c->c2.explicit_exit_notification_time_wait = now; +} + +void +process_explicit_exit_notification_timer_wakeup (struct context *c) +{ + if (event_timeout_trigger (&c->c2.explicit_exit_notification_interval, + &c->c2.timeval, + ETT_DEFAULT)) + { + ASSERT (c->c2.explicit_exit_notification_time_wait && c->options.explicit_exit_notification); + if (now >= c->c2.explicit_exit_notification_time_wait + c->options.explicit_exit_notification) + { + event_timeout_clear (&c->c2.explicit_exit_notification_interval); + c->sig->signal_received = SIGTERM; + c->sig->signal_text = "exit-with-notification"; + } + else + { + c->c2.occ_op = OCC_EXIT; + } + } +} +#endif + +/* + * Process signals + */ + +void +remap_signal (struct context *c) +{ + if (c->sig->signal_received == SIGUSR1 && c->options.remap_sigusr1) + c->sig->signal_received = c->options.remap_sigusr1; +} + +static void +process_sigusr2 (const struct context *c) +{ + struct status_output *so = status_open (NULL, 0, M_INFO, NULL, 0); + print_status (c, so); + status_close (so); + signal_reset (c->sig); +} + +static bool +process_sigterm (struct context *c) +{ + bool ret = true; +#ifdef ENABLE_OCC + if (c->options.explicit_exit_notification + && !c->c2.explicit_exit_notification_time_wait) + { + process_explicit_exit_notification_init (c); + ret = false; + } +#endif + return ret; +} + +bool +process_signal (struct context *c) +{ + bool ret = true; + + if (c->sig->signal_received == SIGTERM || c->sig->signal_received == SIGINT) + { + ret = process_sigterm (c); + } + else if (c->sig->signal_received == SIGUSR2) + { + process_sigusr2 (c); + ret = false; + } + return ret; +} @@ -0,0 +1,100 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef SIG_H +#define SIG_H + +#include "status.h" +#include "win32.h" + +/* + * Signal information, including signal code + * and descriptive text. + */ +struct signal_info +{ + volatile int signal_received; + volatile bool hard; + const char *signal_text; +}; + +#define IS_SIG(c) ((c)->sig->signal_received) + +struct context; + +extern struct signal_info siginfo_static; + +int parse_signal (const char *signame); +const char *signal_name (const int sig, const bool upper); +const char *signal_description (const int signum, const char *sigtext); +void throw_signal (const int signum); + +void pre_init_signal_catch (void); +void post_init_signal_catch (void); + +void print_signal (const struct signal_info *si, const char *title, int msglevel); +void print_status (const struct context *c, struct status_output *so); + +void remap_signal (struct context *c); + +void signal_restart_status (const struct signal_info *si); + +bool process_signal (struct context *c); + +#ifdef ENABLE_OCC +void process_explicit_exit_notification_timer_wakeup (struct context *c); +#endif + +#ifdef WIN32 + +static inline void +get_signal (volatile int *sig) +{ + *sig = win32_signal_get (&win32_signal); +} + +static inline void +halt_non_edge_triggered_signals (void) +{ + win32_signal_close (&win32_signal); +} + +#else + +static inline void +get_signal (volatile int *sig) +{ + const int i = siginfo_static.signal_received; + if (i) + *sig = i; +} + +static inline void +halt_non_edge_triggered_signals (void) +{ +} + +#endif + +#endif diff --git a/socket.c b/socket.c new file mode 100644 index 0000000..070e4ec --- /dev/null +++ b/socket.c @@ -0,0 +1,2154 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "socket.h" +#include "fdmisc.h" +#include "thread.h" +#include "misc.h" +#include "gremlin.h" +#include "plugin.h" + +#include "memdbg.h" + +/* + * Functions related to the translation of DNS names to IP addresses. + */ + +static const char* +h_errno_msg(int h_errno_err) +{ + switch (h_errno_err) + { + case HOST_NOT_FOUND: + return "[HOST_NOT_FOUND] The specified host is unknown."; + case NO_DATA: + return "[NO_DATA] The requested name is valid but does not have an IP address."; + case NO_RECOVERY: + return "[NO_RECOVERY] A non-recoverable name server error occurred."; + case TRY_AGAIN: + return "[TRY_AGAIN] A temporary error occurred on an authoritative name server."; + } + return "[unknown h_errno value]"; +} + +/* + * Translate IP addr or hostname to in_addr_t. + * If resolve error, try again for + * resolve_retry_seconds seconds. + */ +in_addr_t +getaddr (unsigned int flags, + const char *hostname, + int resolve_retry_seconds, + bool *succeeded, + volatile int *signal_received) +{ + struct in_addr ia; + int status; + int sigrec = 0; + int msglevel = (flags & GETADDR_FATAL) ? M_FATAL : D_RESOLVE_ERRORS; + + if (flags & GETADDR_MSG_VIRT_OUT) + msglevel |= M_MSG_VIRT_OUT; + + CLEAR (ia); + if (succeeded) + *succeeded = false; + + if ((flags & (GETADDR_FATAL_ON_SIGNAL|GETADDR_WARN_ON_SIGNAL)) + && !signal_received) + signal_received = &sigrec; + + status = openvpn_inet_aton (hostname, &ia); /* parse ascii IP address */ + + if (status != OIA_IP) /* parse as IP address failed? */ + { + const int fail_wait_interval = 5; /* seconds */ + int resolve_retries = (flags & GETADDR_TRY_ONCE) ? 1 : (resolve_retry_seconds / fail_wait_interval); + struct hostent *h; + const char *fmt; + int level = 0; + + CLEAR (ia); + + fmt = "RESOLVE: Cannot resolve host address: %s: %s"; + if ((flags & GETADDR_MENTION_RESOLVE_RETRY) + && !resolve_retry_seconds) + fmt = "RESOLVE: Cannot resolve host address: %s: %s (I would have retried this name query if you had specified the --resolv-retry option.)"; + + if (!(flags & GETADDR_RESOLVE) || status == OIA_ERROR) + { + msg (msglevel, "RESOLVE: Cannot parse IP address: %s", hostname); + goto done; + } + + /* + * Resolve hostname + */ + while (true) + { + /* try hostname lookup */ + h = gethostbyname (hostname); + + if (signal_received) + { + get_signal (signal_received); + if (*signal_received) /* were we interrupted by a signal? */ + { + h = NULL; + if (*signal_received == SIGUSR1) /* ignore SIGUSR1 */ + { + msg (level, "RESOLVE: Ignored SIGUSR1 signal received during DNS resolution attempt"); + *signal_received = 0; + } + else + goto done; + } + } + + /* success? */ + if (h) + break; + + /* resolve lookup failed, should we + continue or fail? */ + + level = msglevel; + if (resolve_retries > 0) + level = D_RESOLVE_ERRORS; + + msg (level, + fmt, + hostname, + h_errno_msg (h_errno)); + + if (--resolve_retries <= 0) + goto done; + + openvpn_sleep (fail_wait_interval); + } + + if (h->h_addrtype != AF_INET || h->h_length != 4) + { + msg (msglevel, "RESOLVE: Sorry, but we only accept IPv4 DNS names: %s", hostname); + goto done; + } + + ia.s_addr = *(in_addr_t *) (h->h_addr_list[0]); + + if (ia.s_addr) + { + if (h->h_addr_list[1]) /* more than one address returned */ + { + int n = 0; + + /* count address list */ + while (h->h_addr_list[n]) + ++n; + ASSERT (n >= 2); + + msg (D_RESOLVE_ERRORS, "RESOLVE: NOTE: %s resolves to %d addresses, choosing one by random", + hostname, + n); + + /* choose address randomly, for basic load-balancing capability */ + ia.s_addr = *(in_addr_t *) (h->h_addr_list[get_random () % n]); + } + } + + /* hostname resolve succeeded */ + if (succeeded) + *succeeded = true; + } + else + { + /* IP address parse succeeded */ + if (succeeded) + *succeeded = true; + } + + done: + if (signal_received && *signal_received) + { + int level = 0; + if (flags & GETADDR_FATAL_ON_SIGNAL) + level = M_FATAL; + else if (flags & GETADDR_WARN_ON_SIGNAL) + level = M_WARN; + msg (level, "RESOLVE: signal received during DNS resolution attempt"); + } + + return (flags & GETADDR_HOST_ORDER) ? ntohl (ia.s_addr) : ia.s_addr; +} + +/* + * We do our own inet_aton because the glibc function + * isn't very good about error checking. + */ +int +openvpn_inet_aton (const char *dotted_quad, struct in_addr *addr) +{ + unsigned int a, b, c, d; + + CLEAR (*addr); + if (sscanf (dotted_quad, "%u.%u.%u.%u", &a, &b, &c, &d) == 4) + { + if (a < 256 && b < 256 && c < 256 && d < 256) + { + addr->s_addr = htonl (a<<24 | b<<16 | c<<8 | d); + return OIA_IP; /* good dotted quad */ + } + } + if (string_class (dotted_quad, CC_DIGIT|CC_DOT, 0)) + return OIA_ERROR; /* probably a badly formatted dotted quad */ + else + return OIA_HOSTNAME; /* probably a hostname */ +} + +static void +update_remote (const char* host, + struct sockaddr_in *addr, + bool *changed) +{ + if (host && addr) + { + const in_addr_t new_addr = getaddr ( + GETADDR_RESOLVE, + host, + 1, + NULL, + NULL); + if (new_addr && addr->sin_addr.s_addr != new_addr) + { + addr->sin_addr.s_addr = new_addr; + *changed = true; + } + } +} + +static int +socket_get_sndbuf (int sd) +{ +#if defined(HAVE_GETSOCKOPT) && defined(SOL_SOCKET) && defined(SO_SNDBUF) + int val; + socklen_t len; + + len = sizeof (val); + if (getsockopt (sd, SOL_SOCKET, SO_SNDBUF, (void *) &val, &len) == 0 + && len == sizeof (val)) + return val; +#endif + return 0; +} + +static void +socket_set_sndbuf (int sd, int size) +{ +#if defined(HAVE_SETSOCKOPT) && defined(SOL_SOCKET) && defined(SO_SNDBUF) + if (setsockopt (sd, SOL_SOCKET, SO_SNDBUF, (void *) &size, sizeof (size)) != 0) + { + msg (M_WARN, "NOTE: setsockopt SO_SNDBUF=%d failed", size); + } +#endif +} + +static int +socket_get_rcvbuf (int sd) +{ +#if defined(HAVE_GETSOCKOPT) && defined(SOL_SOCKET) && defined(SO_RCVBUF) + int val; + socklen_t len; + + len = sizeof (val); + if (getsockopt (sd, SOL_SOCKET, SO_RCVBUF, (void *) &val, &len) == 0 + && len == sizeof (val)) + return val; +#endif + return 0; +} + +static bool +socket_set_rcvbuf (int sd, int size) +{ +#if defined(HAVE_SETSOCKOPT) && defined(SOL_SOCKET) && defined(SO_RCVBUF) + if (setsockopt (sd, SOL_SOCKET, SO_RCVBUF, (void *) &size, sizeof (size)) != 0) + { + msg (M_WARN, "NOTE: setsockopt SO_RCVBUF=%d failed", size); + return false; + } + return true; +#endif +} + +static void +socket_set_buffers (int fd, const struct socket_buffer_size *sbs) +{ + if (sbs) + { + const int sndbuf_old = socket_get_sndbuf (fd); + const int rcvbuf_old = socket_get_rcvbuf (fd); + + if (sbs->sndbuf) + socket_set_sndbuf (fd, sbs->sndbuf); + + if (sbs->rcvbuf) + socket_set_rcvbuf (fd, sbs->rcvbuf); + + msg (D_OSBUF, "Socket Buffers: R=[%d->%d] S=[%d->%d]", + rcvbuf_old, + socket_get_rcvbuf (fd), + sndbuf_old, + socket_get_sndbuf (fd)); + } +} + +/* + * Remote list code allows clients to specify a list of + * potential remote server addresses. + */ + +static void +remote_list_next (struct remote_list *l) +{ + if (l) + { + if (l->no_advance && l->current >= 0) + { + l->no_advance = false; + } + else + { + int i; + if (++l->current >= l->len) + l->current = 0; + + dmsg (D_REMOTE_LIST, "REMOTE_LIST len=%d current=%d", + l->len, l->current); + for (i = 0; i < l->len; ++i) + { + dmsg (D_REMOTE_LIST, "[%d] %s:%d", + i, + l->array[i].hostname, + l->array[i].port); + } + } + } +} + +void +remote_list_randomize (struct remote_list *l) +{ + int i; + if (l) + { + for (i = 0; i < l->len; ++i) + { + const int j = get_random () % l->len; + if (i != j) + { + struct remote_entry tmp; + tmp = l->array[i]; + l->array[i] = l->array[j]; + l->array[j] = tmp; + } + } + } +} + +static const char * +remote_list_host (const struct remote_list *rl) +{ + if (rl) + return rl->array[rl->current].hostname; + else + return NULL; +} + +static int +remote_list_port (const struct remote_list *rl) +{ + if (rl) + return rl->array[rl->current].port; + else + return 0; +} + +/* + * SOCKET INITALIZATION CODE. + * Create a TCP/UDP socket + */ + +socket_descriptor_t +create_socket_tcp (void) +{ + socket_descriptor_t sd; + + if ((sd = socket (PF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0) + msg (M_SOCKERR, "Cannot create TCP socket"); + + /* set SO_REUSEADDR on socket */ + { + int on = 1; + if (setsockopt (sd, SOL_SOCKET, SO_REUSEADDR, + (void *) &on, sizeof (on)) < 0) + msg (M_SOCKERR, "TCP: Cannot setsockopt SO_REUSEADDR on TCP socket"); + } + +#if 0 + /* set socket linger options */ + { + struct linger linger; + linger.l_onoff = 1; + linger.l_linger = 2; + if (setsockopt (sd, SOL_SOCKET, SO_LINGER, + (void *) &linger, sizeof (linger)) < 0) + msg (M_SOCKERR, "TCP: Cannot setsockopt SO_LINGER on TCP socket"); + } +#endif + + return sd; +} + +static socket_descriptor_t +create_socket_udp (void) +{ + socket_descriptor_t sd; + + if ((sd = socket (PF_INET, SOCK_DGRAM, IPPROTO_UDP)) < 0) + msg (M_SOCKERR, "UDP: Cannot create UDP socket"); + return sd; +} + +static void +create_socket (struct link_socket *sock) +{ + /* create socket */ + if (sock->info.proto == PROTO_UDPv4) + { + sock->sd = create_socket_udp (); + +#ifdef ENABLE_SOCKS + if (sock->socks_proxy) + sock->ctrl_sd = create_socket_tcp (); +#endif + } + else if (sock->info.proto == PROTO_TCPv4_SERVER + || sock->info.proto == PROTO_TCPv4_CLIENT) + { + sock->sd = create_socket_tcp (); + } + else + { + ASSERT (0); + } +} + +/* + * Functions used for establishing a TCP stream connection. + */ + +static void +socket_do_listen (socket_descriptor_t sd, + const struct sockaddr_in *local, + bool do_listen, + bool do_set_nonblock) +{ + struct gc_arena gc = gc_new (); + if (do_listen) + { + msg (M_INFO, "Listening for incoming TCP connection on %s", + print_sockaddr (local, &gc)); + if (listen (sd, 1)) + msg (M_SOCKERR, "TCP: listen() failed"); + } + + /* set socket to non-blocking mode */ + if (do_set_nonblock) + set_nonblock (sd); + + gc_free (&gc); +} + +socket_descriptor_t +socket_do_accept (socket_descriptor_t sd, + struct sockaddr_in *remote, + const bool nowait) +{ + socklen_t remote_len = sizeof (*remote); + socket_descriptor_t new_sd = SOCKET_UNDEFINED; + +#ifdef HAVE_GETPEERNAME + if (nowait) + { + new_sd = getpeername (sd, (struct sockaddr *) remote, &remote_len); + + if (!socket_defined (new_sd)) + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "TCP: getpeername() failed"); + else + new_sd = sd; + } +#else + if (nowait) + msg (M_WARN, "TCP: this OS does not provide the getpeername() function"); +#endif + else + { + new_sd = accept (sd, (struct sockaddr *) remote, &remote_len); + } + + if (!socket_defined (new_sd)) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "TCP: accept(%d) failed", sd); + } + else if (remote_len != sizeof (*remote)) + { + msg (D_LINK_ERRORS, "TCP: Received strange incoming connection with unknown address length=%d", remote_len); + openvpn_close_socket (new_sd); + new_sd = SOCKET_UNDEFINED; + } + return new_sd; +} + +static void +tcp_connection_established (const struct sockaddr_in *remote) +{ + struct gc_arena gc = gc_new (); + msg (M_INFO, "TCP connection established with %s", + print_sockaddr (remote, &gc)); + gc_free (&gc); +} + +static int +socket_listen_accept (socket_descriptor_t sd, + struct sockaddr_in *remote, + const char *remote_dynamic, + bool *remote_changed, + const struct sockaddr_in *local, + bool do_listen, + bool nowait, + volatile int *signal_received) +{ + struct gc_arena gc = gc_new (); + struct sockaddr_in remote_verify = *remote; + int new_sd = SOCKET_UNDEFINED; + + socket_do_listen (sd, local, do_listen, true); + + while (true) + { + int status; + fd_set reads; + struct timeval tv; + + FD_ZERO (&reads); + FD_SET (sd, &reads); + tv.tv_sec = 0; + tv.tv_usec = 0; + + status = select (sd + 1, &reads, NULL, NULL, &tv); + + get_signal (signal_received); + if (*signal_received) + { + gc_free (&gc); + return sd; + } + + if (status < 0) + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "TCP: select() failed"); + + if (status <= 0) + { + openvpn_sleep (1); + continue; + } + + new_sd = socket_do_accept (sd, remote, nowait); + + if (socket_defined (new_sd)) + { + update_remote (remote_dynamic, &remote_verify, remote_changed); + if (addr_defined (&remote_verify) + && !addr_match (&remote_verify, remote)) + { + msg (M_WARN, + "TCP NOTE: Rejected connection attempt from %s due to --remote setting", + print_sockaddr (remote, &gc)); + if (openvpn_close_socket (new_sd)) + msg (M_SOCKERR, "TCP: close socket failed (new_sd)"); + } + else + break; + } + openvpn_sleep (1); + } + + if (!nowait && openvpn_close_socket (sd)) + msg (M_SOCKERR, "TCP: close socket failed (sd)"); + + tcp_connection_established (remote); + + gc_free (&gc); + return new_sd; +} + +static void +socket_connect (socket_descriptor_t *sd, + struct sockaddr_in *remote, + struct remote_list *remote_list, + const char *remote_dynamic, + bool *remote_changed, + const int connect_retry_seconds, + volatile int *signal_received) +{ + struct gc_arena gc = gc_new (); + + msg (M_INFO, "Attempting to establish TCP connection with %s", + print_sockaddr (remote, &gc)); + while (true) + { + const int status = connect (*sd, (struct sockaddr *) remote, + sizeof (*remote)); + + get_signal (signal_received); + if (*signal_received) + goto done; + + if (!status) + break; + + msg (D_LINK_ERRORS | M_ERRNO_SOCK, + "TCP: connect to %s failed, will try again in %d seconds", + print_sockaddr (remote, &gc), + connect_retry_seconds); + + openvpn_close_socket (*sd); + openvpn_sleep (connect_retry_seconds); + + if (remote_list) + { + remote_list_next (remote_list); + remote_dynamic = remote_list_host (remote_list); + remote->sin_port = htons (remote_list_port (remote_list)); + *remote_changed = true; + } + + *sd = create_socket_tcp (); + update_remote (remote_dynamic, remote, remote_changed); + } + + msg (M_INFO, "TCP connection established with %s", + print_sockaddr (remote, &gc)); + + done: + gc_free (&gc); +} + +/* For stream protocols, allocate a buffer to build up packet. + Called after frame has been finalized. */ + +static void +socket_frame_init (const struct frame *frame, struct link_socket *sock) +{ +#ifdef WIN32 + overlapped_io_init (&sock->reads, frame, FALSE, false); + overlapped_io_init (&sock->writes, frame, TRUE, false); + sock->rw_handle.read = sock->reads.overlapped.hEvent; + sock->rw_handle.write = sock->writes.overlapped.hEvent; +#endif + + if (link_socket_connection_oriented (sock)) + { +#ifdef WIN32 + stream_buf_init (&sock->stream_buf, &sock->reads.buf_init); +#else + alloc_buf_sock_tun (&sock->stream_buf_data, + frame, + false, + FRAME_HEADROOM_MARKER_READ_STREAM); + stream_buf_init (&sock->stream_buf, &sock->stream_buf_data); +#endif + } +} + +/* + * Adjust frame structure based on a Path MTU value given + * to us by the OS. + */ +void +frame_adjust_path_mtu (struct frame *frame, int pmtu, int proto) +{ + frame_set_mtu_dynamic (frame, pmtu - datagram_overhead (proto), SET_MTU_UPPER_BOUND); +} + +static void +resolve_bind_local (struct link_socket *sock) +{ + struct gc_arena gc = gc_new (); + + /* resolve local address if undefined */ + if (!addr_defined (&sock->info.lsa->local)) + { + sock->info.lsa->local.sin_family = AF_INET; + sock->info.lsa->local.sin_addr.s_addr = + (sock->local_host ? getaddr (GETADDR_RESOLVE | GETADDR_WARN_ON_SIGNAL | GETADDR_FATAL, + sock->local_host, + 0, + NULL, + NULL) + : htonl (INADDR_ANY)); + sock->info.lsa->local.sin_port = htons (sock->local_port); + } + + /* bind to local address/port */ + if (sock->bind_local) + { + if (bind (sock->sd, (struct sockaddr *) &sock->info.lsa->local, + sizeof (sock->info.lsa->local))) + { + const int errnum = openvpn_errno_socket (); + msg (M_FATAL, "TCP/UDP: Socket bind failed on local address %s: %s", + print_sockaddr (&sock->info.lsa->local, &gc), + strerror_ts (errnum, &gc)); + } + } + gc_free (&gc); +} + +static void +resolve_remote (struct link_socket *sock, + int phase, + const char **remote_dynamic, + volatile int *signal_received) +{ + struct gc_arena gc = gc_new (); + + if (!sock->did_resolve_remote) + { + /* resolve remote address if undefined */ + if (!addr_defined (&sock->info.lsa->remote)) + { + sock->info.lsa->remote.sin_family = AF_INET; + sock->info.lsa->remote.sin_addr.s_addr = 0; + + if (sock->remote_host) + { + unsigned int flags = 0; + int retry = 0; + bool status = false; + + if (remote_list_len (sock->remote_list) > 1 && sock->resolve_retry_seconds == RESOLV_RETRY_INFINITE) + { + flags = GETADDR_RESOLVE; + if (phase == 2) + flags |= (GETADDR_TRY_ONCE | GETADDR_FATAL); + retry = 0; + } + else if (phase == 1) + { + if (sock->resolve_retry_seconds) + { + flags = GETADDR_RESOLVE; + retry = 0; + } + else + { + flags = GETADDR_RESOLVE | GETADDR_FATAL | GETADDR_MENTION_RESOLVE_RETRY; + retry = 0; + } + } + else if (phase == 2) + { + if (sock->resolve_retry_seconds) + { + flags = GETADDR_RESOLVE | GETADDR_FATAL; + retry = sock->resolve_retry_seconds; + } + else + { + ASSERT (0); + } + } + else + { + ASSERT (0); + } + + sock->info.lsa->remote.sin_addr.s_addr = getaddr ( + flags, + sock->remote_host, + retry, + &status, + signal_received); + + dmsg (D_SOCKET_DEBUG, "RESOLVE_REMOTE flags=0x%04x phase=%d rrs=%d sig=%d status=%d", + flags, + phase, + retry, + signal_received ? *signal_received : -1, + status); + + if (signal_received) + { + if (*signal_received) + goto done; + } + if (!status) + { + if (signal_received) + *signal_received = SIGUSR1; + goto done; + } + } + + sock->info.lsa->remote.sin_port = htons (sock->remote_port); + } + + /* should we re-use previous active remote address? */ + if (addr_defined (&sock->info.lsa->actual)) + { + msg (M_INFO, "TCP/UDP: Preserving recently used remote address: %s", + print_sockaddr (&sock->info.lsa->actual, &gc)); + if (remote_dynamic) + *remote_dynamic = NULL; + } + else + sock->info.lsa->actual = sock->info.lsa->remote; + + /* remember that we finished */ + sock->did_resolve_remote = true; + } + + done: + gc_free (&gc); +} + +struct link_socket * +link_socket_new (void) +{ + struct link_socket *sock; + + ALLOC_OBJ_CLEAR (sock, struct link_socket); + sock->sd = SOCKET_UNDEFINED; +#ifdef ENABLE_SOCKS + sock->ctrl_sd = SOCKET_UNDEFINED; +#endif + return sock; +} + +/* bind socket if necessary */ +void +link_socket_init_phase1 (struct link_socket *sock, + const char *local_host, + struct remote_list *remote_list, + int local_port, + int proto, + int mode, + const struct link_socket *accept_from, +#ifdef ENABLE_HTTP_PROXY + struct http_proxy_info *http_proxy, +#endif +#ifdef ENABLE_SOCKS + struct socks_proxy_info *socks_proxy, +#endif +#ifdef ENABLE_DEBUG + int gremlin, +#endif + bool bind_local, + bool remote_float, + int inetd, + struct link_socket_addr *lsa, + const char *ipchange_command, + const struct plugin_list *plugins, + int resolve_retry_seconds, + int connect_retry_seconds, + int mtu_discover_type, + int rcvbuf, + int sndbuf) +{ + const char *remote_host; + int remote_port; + + ASSERT (sock); + + sock->remote_list = remote_list; + remote_list_next (remote_list); + remote_host = remote_list_host (remote_list); + remote_port = remote_list_port (remote_list); + + sock->local_host = local_host; + sock->local_port = local_port; + +#ifdef ENABLE_HTTP_PROXY + sock->http_proxy = http_proxy; +#endif + +#ifdef ENABLE_SOCKS + sock->socks_proxy = socks_proxy; +#endif + + sock->bind_local = bind_local; + sock->inetd = inetd; + sock->resolve_retry_seconds = resolve_retry_seconds; + sock->connect_retry_seconds = connect_retry_seconds; + sock->mtu_discover_type = mtu_discover_type; + +#ifdef ENABLE_DEBUG + sock->gremlin = gremlin; +#endif + + sock->socket_buffer_sizes.rcvbuf = rcvbuf; + sock->socket_buffer_sizes.sndbuf = sndbuf; + + sock->info.proto = proto; + sock->info.remote_float = remote_float; + sock->info.lsa = lsa; + sock->info.ipchange_command = ipchange_command; + sock->info.plugins = plugins; + + sock->mode = mode; + if (mode == LS_MODE_TCP_ACCEPT_FROM) + { + ASSERT (accept_from); + ASSERT (sock->info.proto == PROTO_TCPv4_SERVER); + ASSERT (!sock->inetd); + sock->sd = accept_from->sd; + } + + if (false) + ; +#ifdef ENABLE_HTTP_PROXY + /* are we running in HTTP proxy mode? */ + else if (sock->http_proxy) + { + ASSERT (sock->info.proto == PROTO_TCPv4_CLIENT); + ASSERT (!sock->inetd); + + /* the proxy server */ + sock->remote_host = http_proxy->options.server; + sock->remote_port = http_proxy->options.port; + + /* the OpenVPN server we will use the proxy to connect to */ + sock->proxy_dest_host = remote_host; + sock->proxy_dest_port = remote_port; + + /* this is needed so that connection retries will go to the proxy server, + not the remote OpenVPN address */ + sock->remote_list = NULL; + } +#endif +#ifdef ENABLE_SOCKS + /* or in Socks proxy mode? */ + else if (sock->socks_proxy) + { + ASSERT (sock->info.proto == PROTO_TCPv4_CLIENT || sock->info.proto == PROTO_UDPv4); + ASSERT (!sock->inetd); + + /* the proxy server */ + sock->remote_host = socks_proxy->server; + sock->remote_port = socks_proxy->port; + + /* the OpenVPN server we will use the proxy to connect to */ + sock->proxy_dest_host = remote_host; + sock->proxy_dest_port = remote_port; + + /* this is needed so that connection retries will go to the proxy server, + not the remote OpenVPN address */ + sock->remote_list = NULL; + } +#endif + else + { + sock->remote_host = remote_host; + sock->remote_port = remote_port; + } + + /* bind behavior for TCP server vs. client */ + if (sock->info.proto == PROTO_TCPv4_SERVER) + { + if (sock->mode == LS_MODE_TCP_ACCEPT_FROM) + sock->bind_local = false; + else + sock->bind_local = true; + } + else if (sock->info.proto == PROTO_TCPv4_CLIENT) + { + sock->bind_local = false; + } + + /* were we started by inetd or xinetd? */ + if (sock->inetd) + { + ASSERT (sock->info.proto != PROTO_TCPv4_CLIENT); + ASSERT (socket_defined (inetd_socket_descriptor)); + sock->sd = inetd_socket_descriptor; + } + else if (mode != LS_MODE_TCP_ACCEPT_FROM) + { + create_socket (sock); + resolve_bind_local (sock); + resolve_remote (sock, 1, NULL, NULL); + } +} + +/* finalize socket initialization */ +void +link_socket_init_phase2 (struct link_socket *sock, + const struct frame *frame, + volatile int *signal_received) +{ + struct gc_arena gc = gc_new (); + const char *remote_dynamic = NULL; + bool remote_changed = false; + + ASSERT (sock); + + /* initialize buffers */ + socket_frame_init (frame, sock); + + /* + * Pass a remote name to connect/accept so that + * they can test for dynamic IP address changes + * and throw a SIGUSR1 if appropriate. + */ + if (sock->resolve_retry_seconds) + remote_dynamic = sock->remote_host; + + /* were we started by inetd or xinetd? */ + if (sock->inetd) + { + if (sock->info.proto == PROTO_TCPv4_SERVER) + sock->sd = + socket_listen_accept (sock->sd, + &sock->info.lsa->actual, + remote_dynamic, + &remote_changed, + &sock->info.lsa->local, + false, + sock->inetd == INETD_NOWAIT, + signal_received); + ASSERT (!remote_changed); + if (*signal_received) + goto done; + } + else + { + resolve_remote (sock, 2, &remote_dynamic, signal_received); + + if (*signal_received) + goto done; + + /* TCP client/server */ + if (sock->info.proto == PROTO_TCPv4_SERVER) + { + switch (sock->mode) + { + case LS_MODE_DEFAULT: + sock->sd = socket_listen_accept (sock->sd, + &sock->info.lsa->actual, + remote_dynamic, + &remote_changed, + &sock->info.lsa->local, + true, + false, + signal_received); + break; + case LS_MODE_TCP_LISTEN: + socket_do_listen (sock->sd, + &sock->info.lsa->local, + true, + false); + break; + case LS_MODE_TCP_ACCEPT_FROM: + sock->sd = socket_do_accept (sock->sd, + &sock->info.lsa->actual, + false); + if (!socket_defined (sock->sd)) + { + *signal_received = SIGTERM; + goto done; + } + tcp_connection_established (&sock->info.lsa->actual); + break; + default: + ASSERT (0); + } + } + else if (sock->info.proto == PROTO_TCPv4_CLIENT) + { + socket_connect (&sock->sd, + &sock->info.lsa->actual, + sock->remote_list, + remote_dynamic, + &remote_changed, + sock->connect_retry_seconds, + signal_received); + + if (*signal_received) + goto done; + + if (false) + ; +#ifdef ENABLE_HTTP_PROXY + else if (sock->http_proxy) + { + establish_http_proxy_passthru (sock->http_proxy, + sock->sd, + sock->proxy_dest_host, + sock->proxy_dest_port, + &sock->stream_buf.residual, + signal_received); + } +#endif +#ifdef ENABLE_SOCKS + else if (sock->socks_proxy) + { + establish_socks_proxy_passthru (sock->socks_proxy, + sock->sd, + sock->proxy_dest_host, + sock->proxy_dest_port, + signal_received); + } +#endif + } +#ifdef ENABLE_SOCKS + else if (sock->info.proto == PROTO_UDPv4 && sock->socks_proxy) + { + socket_connect (&sock->ctrl_sd, + &sock->info.lsa->actual, + NULL, + remote_dynamic, + &remote_changed, + sock->connect_retry_seconds, + signal_received); + + if (*signal_received) + goto done; + + establish_socks_proxy_udpassoc (sock->socks_proxy, + sock->ctrl_sd, + sock->sd, &sock->socks_relay, + signal_received); + + if (*signal_received) + goto done; + + sock->remote_host = sock->proxy_dest_host; + sock->remote_port = sock->proxy_dest_port; + sock->did_resolve_remote = false; + sock->info.lsa->actual.sin_addr.s_addr = 0; + sock->info.lsa->remote.sin_addr.s_addr = 0; + + resolve_remote (sock, 1, NULL, signal_received); + + if (*signal_received) + goto done; + } +#endif + + if (*signal_received) + goto done; + + if (remote_changed) + { + msg (M_INFO, "TCP/UDP: Dynamic remote address changed during TCP connection establishment"); + sock->info.lsa->remote.sin_addr.s_addr = sock->info.lsa->actual.sin_addr.s_addr; + } + } + + /* set socket buffers based on --sndbuf and --rcvbuf options */ + socket_set_buffers (sock->sd, &sock->socket_buffer_sizes); + + /* set socket to non-blocking mode */ + set_nonblock (sock->sd); + + /* set socket file descriptor to not pass across execs, so that + scripts don't have access to it */ + set_cloexec (sock->sd); + +#ifdef ENABLE_SOCKS + if (socket_defined (sock->ctrl_sd)) + set_cloexec (sock->ctrl_sd); +#endif + + /* set Path MTU discovery options on the socket */ + set_mtu_discover_type (sock->sd, sock->mtu_discover_type); + +#if EXTENDED_SOCKET_ERROR_CAPABILITY + /* if the OS supports it, enable extended error passing on the socket */ + set_sock_extended_error_passing (sock->sd); +#endif + + /* print local address */ + if (sock->inetd) + msg (M_INFO, "%s link local: [inetd]", proto2ascii (sock->info.proto, true)); + else + msg (M_INFO, "%s link local%s: %s", + proto2ascii (sock->info.proto, true), + (sock->bind_local ? " (bound)" : ""), + print_sockaddr_ex (&sock->info.lsa->local, sock->bind_local, ":", &gc)); + + /* print active remote address */ + msg (M_INFO, "%s link remote: %s", + proto2ascii (sock->info.proto, true), + print_sockaddr_ex (&sock->info.lsa->actual, addr_defined (&sock->info.lsa->actual), ":", &gc)); + + done: + gc_free (&gc); +} + +void +link_socket_close (struct link_socket *sock) +{ + if (sock) + { +#ifdef ENABLE_DEBUG + const int gremlin = GREMLIN_CONNECTION_FLOOD_LEVEL (sock->gremlin); +#else + const int gremlin = 0; +#endif + + if (socket_defined (sock->sd)) + { +#ifdef WIN32 + close_net_event_win32 (&sock->listen_handle, sock->sd, 0); +#endif + if (!gremlin) + { + msg (D_CLOSE, "TCP/UDP: Closing socket"); + if (openvpn_close_socket (sock->sd)) + msg (M_WARN | M_ERRNO_SOCK, "TCP/UDP: Close Socket failed"); + } + sock->sd = SOCKET_UNDEFINED; +#ifdef WIN32 + if (!gremlin) + { + overlapped_io_close (&sock->reads); + overlapped_io_close (&sock->writes); + } +#endif + } + +#ifdef ENABLE_SOCKS + if (socket_defined (sock->ctrl_sd)) + { + if (openvpn_close_socket (sock->ctrl_sd)) + msg (M_WARN | M_ERRNO_SOCK, "TCP/UDP: Close Socket (ctrl_sd) failed"); + sock->ctrl_sd = SOCKET_UNDEFINED; + } +#endif + + stream_buf_close (&sock->stream_buf); + free_buf (&sock->stream_buf_data); + if (!gremlin) + free (sock); + } +} + +/* for stream protocols, allow for packet length prefix */ +void +socket_adjust_frame_parameters (struct frame *frame, int proto) +{ + if (link_socket_proto_connection_oriented (proto)) + frame_add_to_extra_frame (frame, sizeof (packet_size_type)); +} + +void +setenv_trusted (struct env_set *es, const struct link_socket_info *info) +{ + setenv_sockaddr (es, "trusted", &info->lsa->actual, SA_IP_PORT); +} + +void +link_socket_connection_initiated (const struct buffer *buf, + struct link_socket_info *info, + const struct sockaddr_in *addr, + const char *common_name, + struct env_set *es) +{ + struct gc_arena gc = gc_new (); + + info->lsa->actual = *addr; /* Note: skip this line for --force-dest */ + setenv_trusted (es, info); + info->connection_established = true; + + /* Print connection initiated message, with common name if available */ + { + struct buffer out = alloc_buf_gc (256, &gc); + if (common_name) + buf_printf (&out, "[%s] ", common_name); + buf_printf (&out, "Peer Connection Initiated with %s", print_sockaddr (&info->lsa->actual, &gc)); + msg (M_INFO, "%s", BSTR (&out)); + } + + /* set environmental vars */ + setenv_str (es, "common_name", common_name); + + /* Process --ipchange plugin */ + if (plugin_defined (info->plugins, OPENVPN_PLUGIN_IPCHANGE)) + { + const char *addr_ascii = print_sockaddr_ex (&info->lsa->actual, true, " ", &gc); + if (plugin_call (info->plugins, OPENVPN_PLUGIN_IPCHANGE, addr_ascii, es)) + msg (M_WARN, "WARNING: ipchange plugin call failed"); + } + + /* Process --ipchange option */ + if (info->ipchange_command) + { + struct buffer out = alloc_buf_gc (256, &gc); + setenv_str (es, "script_type", "ipchange"); + buf_printf (&out, "%s %s", + info->ipchange_command, + print_sockaddr_ex (&info->lsa->actual, true, " ", &gc)); + system_check (BSTR (&out), es, S_SCRIPT, "ip-change command failed"); + } + + gc_free (&gc); +} + +void +link_socket_bad_incoming_addr (struct buffer *buf, + const struct link_socket_info *info, + const struct sockaddr_in *from_addr) +{ + struct gc_arena gc = gc_new (); + + msg (D_LINK_ERRORS, + "TCP/UDP: Incoming packet rejected from %s[%d], expected peer address: %s (allow this incoming source address/port by removing --remote or adding --float)", + print_sockaddr (from_addr, &gc), + (int)from_addr->sin_family, + print_sockaddr (&info->lsa->remote, &gc)); + buf->len = 0; + + gc_free (&gc); +} + +void +link_socket_bad_outgoing_addr (void) +{ + dmsg (D_READ_WRITE, "TCP/UDP: No outgoing address to send packet"); +} + +in_addr_t +link_socket_current_remote (const struct link_socket_info *info) +{ + const struct link_socket_addr *lsa = info->lsa; + + if (addr_defined (&lsa->actual)) + return ntohl (lsa->actual.sin_addr.s_addr); + else if (addr_defined (&lsa->remote)) + return ntohl (lsa->remote.sin_addr.s_addr); + else + return 0; +} + +/* + * Return a status string describing socket state. + */ +const char * +socket_stat (const struct link_socket *s, unsigned int rwflags, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + if (s) + { + if (rwflags & EVENT_READ) + { + buf_printf (&out, "S%s", + (s->rwflags_debug & EVENT_READ) ? "R" : "r"); +#ifdef WIN32 + buf_printf (&out, "%s", + overlapped_io_state_ascii (&s->reads)); +#endif + } + if (rwflags & EVENT_WRITE) + { + buf_printf (&out, "S%s", + (s->rwflags_debug & EVENT_WRITE) ? "W" : "w"); +#ifdef WIN32 + buf_printf (&out, "%s", + overlapped_io_state_ascii (&s->writes)); +#endif + } + } + else + { + buf_printf (&out, "S?"); + } + return BSTR (&out); +} + +/* + * Stream buffer functions, used to packetize a TCP + * stream connection. + */ + +static inline void +stream_buf_reset (struct stream_buf *sb) +{ + dmsg (D_STREAM_DEBUG, "STREAM: RESET"); + sb->residual_fully_formed = false; + sb->buf = sb->buf_init; + buf_reset (&sb->next); + sb->len = -1; +} + +void +stream_buf_init (struct stream_buf *sb, + struct buffer *buf) +{ + sb->buf_init = *buf; + sb->maxlen = sb->buf_init.len; + sb->buf_init.len = 0; + sb->residual = alloc_buf (sb->maxlen); + sb->error = false; + stream_buf_reset (sb); + + dmsg (D_STREAM_DEBUG, "STREAM: INIT maxlen=%d", sb->maxlen); +} + +static inline void +stream_buf_set_next (struct stream_buf *sb) +{ + /* set up 'next' for next i/o read */ + sb->next = sb->buf; + sb->next.offset = sb->buf.offset + sb->buf.len; + sb->next.len = (sb->len >= 0 ? sb->len : sb->maxlen) - sb->buf.len; + dmsg (D_STREAM_DEBUG, "STREAM: SET NEXT, buf=[%d,%d] next=[%d,%d] len=%d maxlen=%d", + sb->buf.offset, sb->buf.len, + sb->next.offset, sb->next.len, + sb->len, sb->maxlen); + ASSERT (sb->next.len > 0); + ASSERT (buf_safe (&sb->buf, sb->next.len)); +} + +static inline void +stream_buf_get_final (struct stream_buf *sb, struct buffer *buf) +{ + dmsg (D_STREAM_DEBUG, "STREAM: GET FINAL len=%d", + buf_defined (&sb->buf) ? sb->buf.len : -1); + ASSERT (buf_defined (&sb->buf)); + *buf = sb->buf; +} + +static inline void +stream_buf_get_next (struct stream_buf *sb, struct buffer *buf) +{ + dmsg (D_STREAM_DEBUG, "STREAM: GET NEXT len=%d", + buf_defined (&sb->next) ? sb->next.len : -1); + ASSERT (buf_defined (&sb->next)); + *buf = sb->next; +} + +bool +stream_buf_read_setup_dowork (struct link_socket* sock) +{ + if (sock->stream_buf.residual.len && !sock->stream_buf.residual_fully_formed) + { + ASSERT (buf_copy (&sock->stream_buf.buf, &sock->stream_buf.residual)); + ASSERT (buf_init (&sock->stream_buf.residual, 0)); + sock->stream_buf.residual_fully_formed = stream_buf_added (&sock->stream_buf, 0); + dmsg (D_STREAM_DEBUG, "STREAM: RESIDUAL FULLY FORMED [%s], len=%d", + sock->stream_buf.residual_fully_formed ? "YES" : "NO", + sock->stream_buf.residual.len); + } + + if (!sock->stream_buf.residual_fully_formed) + stream_buf_set_next (&sock->stream_buf); + return !sock->stream_buf.residual_fully_formed; +} + +bool +stream_buf_added (struct stream_buf *sb, + int length_added) +{ + dmsg (D_STREAM_DEBUG, "STREAM: ADD length_added=%d", length_added); + if (length_added > 0) + sb->buf.len += length_added; + + /* if length unknown, see if we can get the length prefix from + the head of the buffer */ + if (sb->len < 0 && sb->buf.len >= (int) sizeof (packet_size_type)) + { + packet_size_type net_size; + ASSERT (buf_read (&sb->buf, &net_size, sizeof (net_size))); + sb->len = ntohps (net_size); + + if (sb->len < 1 || sb->len > sb->maxlen) + { + msg (M_WARN, "WARNING: Bad encapsulated packet length from peer (%d), which must be > 0 and <= %d -- please ensure that --tun-mtu or --link-mtu is equal on both peers -- this condition could also indicate a possible active attack on the TCP link -- [Attemping restart...]", sb->len, sb->maxlen); + stream_buf_reset (sb); + sb->error = true; + return false; + } + } + + /* is our incoming packet fully read? */ + if (sb->len > 0 && sb->buf.len >= sb->len) + { + /* save any residual data that's part of the next packet */ + ASSERT (buf_init (&sb->residual, 0)); + if (sb->buf.len > sb->len) + ASSERT (buf_copy_excess (&sb->residual, &sb->buf, sb->len)); + dmsg (D_STREAM_DEBUG, "STREAM: ADD returned TRUE, buf_len=%d, residual_len=%d", + BLEN (&sb->buf), + BLEN (&sb->residual)); + return true; + } + else + { + dmsg (D_STREAM_DEBUG, "STREAM: ADD returned FALSE (have=%d need=%d)", sb->buf.len, sb->len); + stream_buf_set_next (sb); + return false; + } +} + +void +stream_buf_close (struct stream_buf* sb) +{ + free_buf (&sb->residual); +} + +/* + * The listen event is a special event whose sole purpose is + * to tell us that there's a new incoming connection on a + * TCP socket, for use in server mode. + */ +event_t +socket_listen_event_handle (struct link_socket *s) +{ +#ifdef WIN32 + if (!defined_net_event_win32 (&s->listen_handle)) + init_net_event_win32 (&s->listen_handle, FD_ACCEPT, s->sd, 0); + return &s->listen_handle; +#else + return s->sd; +#endif +} + +/* + * Format IP addresses in ascii + */ + +const char * +print_sockaddr (const struct sockaddr_in *addr, struct gc_arena *gc) +{ + return print_sockaddr_ex(addr, true, ":", gc); +} + +const char * +print_sockaddr_ex (const struct sockaddr_in *addr, bool do_port, const char* separator, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + const int port = ntohs (addr->sin_port); + + mutex_lock_static (L_INET_NTOA); + buf_printf (&out, "%s", (addr_defined (addr) ? inet_ntoa (addr->sin_addr) : "[undef]")); + mutex_unlock_static (L_INET_NTOA); + + if (do_port && port) + { + if (separator) + buf_printf (&out, "%s", separator); + + buf_printf (&out, "%d", port); + } + return BSTR (&out); +} + +/* + * Convert an in_addr_t in host byte order + * to an ascii dotted quad. + */ +const char * +print_in_addr_t (in_addr_t addr, unsigned int flags, struct gc_arena *gc) +{ + struct in_addr ia; + struct buffer out = alloc_buf_gc (64, gc); + + if (addr || !(flags & IA_EMPTY_IF_UNDEF)) + { + CLEAR (ia); + ia.s_addr = (flags & IA_NET_ORDER) ? addr : htonl (addr); + + mutex_lock_static (L_INET_NTOA); + buf_printf (&out, "%s", inet_ntoa (ia)); + mutex_unlock_static (L_INET_NTOA); + } + return BSTR (&out); +} + +/* set environmental variables for ip/port in *addr */ +void +setenv_sockaddr (struct env_set *es, const char *name_prefix, const struct sockaddr_in *addr, const bool flags) +{ + char name_buf[256]; + + if (flags & SA_IP_PORT) + openvpn_snprintf (name_buf, sizeof (name_buf), "%s_ip", name_prefix); + else + openvpn_snprintf (name_buf, sizeof (name_buf), "%s", name_prefix); + + mutex_lock_static (L_INET_NTOA); + setenv_str (es, name_buf, inet_ntoa (addr->sin_addr)); + mutex_unlock_static (L_INET_NTOA); + + if ((flags & SA_IP_PORT) && addr->sin_port) + { + openvpn_snprintf (name_buf, sizeof (name_buf), "%s_port", name_prefix); + setenv_int (es, name_buf, ntohs (addr->sin_port)); + } +} + +void +setenv_in_addr_t (struct env_set *es, const char *name_prefix, in_addr_t addr, const bool flags) +{ + if (addr || !(flags & SA_SET_IF_NONZERO)) + { + struct sockaddr_in si; + CLEAR (si); + si.sin_addr.s_addr = htonl (addr); + setenv_sockaddr (es, name_prefix, &si, flags); + } +} + +/* + * Convert protocol names between index and ascii form. + */ + +struct proto_names { + const char *short_form; + const char *display_form; +}; + +/* Indexed by PROTO_x */ +static const struct proto_names proto_names[] = { + {"udp", "UDPv4"}, + {"tcp-server", "TCPv4_SERVER"}, + {"tcp-client", "TCPv4_CLIENT"}, + {"tcp", "TCPv4"} +}; + +int +ascii2proto (const char* proto_name) +{ + int i; + ASSERT (PROTO_N == SIZE (proto_names)); + for (i = 0; i < PROTO_N; ++i) + if (!strcmp (proto_name, proto_names[i].short_form)) + return i; + return -1; +} + +const char * +proto2ascii (int proto, bool display_form) +{ + ASSERT (PROTO_N == SIZE (proto_names)); + if (proto < 0 || proto >= PROTO_N) + return "[unknown protocol]"; + else if (display_form) + return proto_names[proto].display_form; + else + return proto_names[proto].short_form; +} + +const char * +proto2ascii_all (struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + int i; + + ASSERT (PROTO_N == SIZE (proto_names)); + for (i = 0; i < PROTO_N; ++i) + { + if (i) + buf_printf(&out, " "); + buf_printf(&out, "[%s]", proto2ascii(i, false)); + } + return BSTR (&out); +} + +/* + * Given a local proto, return local proto + * if !remote, or compatible remote proto + * if remote. + * + * This is used for options compatibility + * checking. + */ +int +proto_remote (int proto, bool remote) +{ + ASSERT (proto >= 0 && proto < PROTO_N); + if (remote) + { + if (proto == PROTO_TCPv4_SERVER) + return PROTO_TCPv4_CLIENT; + if (proto == PROTO_TCPv4_CLIENT) + return PROTO_TCPv4_SERVER; + } + return proto; +} + +/* + * Bad incoming address lengths that differ from what + * we expect are considered to be fatal errors. + */ +void +bad_address_length (int actual, int expected) +{ + msg (M_FATAL, "ERROR: received strange incoming packet with an address length of %d -- we only accept address lengths of %d.", + actual, + expected); +} + +/* + * Socket Read Routines + */ + +int +link_socket_read_tcp (struct link_socket *sock, + struct buffer *buf) +{ + int len = 0; + + if (!sock->stream_buf.residual_fully_formed) + { +#ifdef WIN32 + len = socket_finalize (sock->sd, &sock->reads, buf, NULL); +#else + struct buffer frag; + stream_buf_get_next (&sock->stream_buf, &frag); + len = recv (sock->sd, BPTR (&frag), BLEN (&frag), MSG_NOSIGNAL); +#endif + + if (!len) + sock->stream_reset = true; + if (len <= 0) + return buf->len = len; + } + + if (sock->stream_buf.residual_fully_formed + || stream_buf_added (&sock->stream_buf, len)) /* packet complete? */ + { + stream_buf_get_final (&sock->stream_buf, buf); + stream_buf_reset (&sock->stream_buf); + return buf->len; + } + else + return buf->len = 0; /* no error, but packet is still incomplete */ +} + +#ifndef WIN32 + +int +link_socket_read_udp_posix (struct link_socket *sock, + struct buffer *buf, + int maxsize, + struct sockaddr_in *from) +{ + socklen_t fromlen = sizeof (*from); + CLEAR (*from); + ASSERT (buf_safe (buf, maxsize)); + buf->len = recvfrom (sock->sd, BPTR (buf), maxsize, 0, + (struct sockaddr *) from, &fromlen); + if (fromlen != sizeof (*from)) + bad_address_length (fromlen, sizeof (*from)); + return buf->len; +} + +#endif + +/* + * Socket Write Routines + */ + +int +link_socket_write_tcp (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to) +{ + packet_size_type len = BLEN (buf); + dmsg (D_STREAM_DEBUG, "STREAM: WRITE %d offset=%d", (int)len, buf->offset); + ASSERT (len <= sock->stream_buf.maxlen); + len = htonps (len); + ASSERT (buf_write_prepend (buf, &len, sizeof (len))); +#ifdef WIN32 + return link_socket_write_win32 (sock, buf, to); +#else + return link_socket_write_tcp_posix (sock, buf, to); +#endif +} + +/* + * Win32 overlapped socket I/O functions. + */ + +#ifdef WIN32 + +int +socket_recv_queue (struct link_socket *sock, int maxsize) +{ + if (sock->reads.iostate == IOSTATE_INITIAL) + { + WSABUF wsabuf[1]; + int status; + + /* reset buf to its initial state */ + if (sock->info.proto == PROTO_UDPv4) + { + sock->reads.buf = sock->reads.buf_init; + } + else if (sock->info.proto == PROTO_TCPv4_CLIENT || sock->info.proto == PROTO_TCPv4_SERVER) + { + stream_buf_get_next (&sock->stream_buf, &sock->reads.buf); + } + else + { + ASSERT (0); + } + + /* Win32 docs say it's okay to allocate the wsabuf on the stack */ + wsabuf[0].buf = BPTR (&sock->reads.buf); + wsabuf[0].len = maxsize ? maxsize : BLEN (&sock->reads.buf); + + /* check for buffer overflow */ + ASSERT (wsabuf[0].len <= BLEN (&sock->reads.buf)); + + /* the overlapped read will signal this event on I/O completion */ + ASSERT (ResetEvent (sock->reads.overlapped.hEvent)); + sock->reads.flags = 0; + + if (sock->info.proto == PROTO_UDPv4) + { + sock->reads.addr_defined = true; + sock->reads.addrlen = sizeof (sock->reads.addr); + status = WSARecvFrom( + sock->sd, + wsabuf, + 1, + &sock->reads.size, + &sock->reads.flags, + (struct sockaddr *) &sock->reads.addr, + &sock->reads.addrlen, + &sock->reads.overlapped, + NULL); + } + else if (sock->info.proto == PROTO_TCPv4_CLIENT || sock->info.proto == PROTO_TCPv4_SERVER) + { + sock->reads.addr_defined = false; + status = WSARecv( + sock->sd, + wsabuf, + 1, + &sock->reads.size, + &sock->reads.flags, + &sock->reads.overlapped, + NULL); + } + else + { + status = 0; + ASSERT (0); + } + + if (!status) /* operation completed immediately? */ + { + if (sock->reads.addr_defined && sock->reads.addrlen != sizeof (sock->reads.addr)) + bad_address_length (sock->reads.addrlen, sizeof (sock->reads.addr)); + + sock->reads.iostate = IOSTATE_IMMEDIATE_RETURN; + + /* since we got an immediate return, we must signal the event object ourselves */ + ASSERT (SetEvent (sock->reads.overlapped.hEvent)); + sock->reads.status = 0; + + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Receive immediate return [%d,%d]", + (int) wsabuf[0].len, + (int) sock->reads.size); + } + else + { + status = WSAGetLastError (); + if (status == WSA_IO_PENDING) /* operation queued? */ + { + sock->reads.iostate = IOSTATE_QUEUED; + sock->reads.status = status; + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Receive queued [%d]", + (int) wsabuf[0].len); + } + else /* error occurred */ + { + struct gc_arena gc = gc_new (); + ASSERT (SetEvent (sock->reads.overlapped.hEvent)); + sock->reads.iostate = IOSTATE_IMMEDIATE_RETURN; + sock->reads.status = status; + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Receive error [%d]: %s", + (int) wsabuf[0].len, + strerror_win32 (status, &gc)); + gc_free (&gc); + } + } + } + return sock->reads.iostate; +} + +int +socket_send_queue (struct link_socket *sock, struct buffer *buf, const struct sockaddr_in *to) +{ + if (sock->writes.iostate == IOSTATE_INITIAL) + { + WSABUF wsabuf[1]; + int status; + + /* make a private copy of buf */ + sock->writes.buf = sock->writes.buf_init; + sock->writes.buf.len = 0; + ASSERT (buf_copy (&sock->writes.buf, buf)); + + /* Win32 docs say it's okay to allocate the wsabuf on the stack */ + wsabuf[0].buf = BPTR (&sock->writes.buf); + wsabuf[0].len = BLEN (&sock->writes.buf); + + /* the overlapped write will signal this event on I/O completion */ + ASSERT (ResetEvent (sock->writes.overlapped.hEvent)); + sock->writes.flags = 0; + + if (sock->info.proto == PROTO_UDPv4) + { + /* set destination address for UDP writes */ + sock->writes.addr_defined = true; + sock->writes.addr = *to; + sock->writes.addrlen = sizeof (sock->writes.addr); + + status = WSASendTo( + sock->sd, + wsabuf, + 1, + &sock->writes.size, + sock->writes.flags, + (struct sockaddr *) &sock->writes.addr, + sock->writes.addrlen, + &sock->writes.overlapped, + NULL); + } + else if (sock->info.proto == PROTO_TCPv4_CLIENT || sock->info.proto == PROTO_TCPv4_SERVER) + { + /* destination address for TCP writes was established on connection initiation */ + sock->writes.addr_defined = false; + + status = WSASend( + sock->sd, + wsabuf, + 1, + &sock->writes.size, + sock->writes.flags, + &sock->writes.overlapped, + NULL); + } + else + { + status = 0; + ASSERT (0); + } + + if (!status) /* operation completed immediately? */ + { + sock->writes.iostate = IOSTATE_IMMEDIATE_RETURN; + + /* since we got an immediate return, we must signal the event object ourselves */ + ASSERT (SetEvent (sock->writes.overlapped.hEvent)); + + sock->writes.status = 0; + + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Send immediate return [%d,%d]", + (int) wsabuf[0].len, + (int) sock->writes.size); + } + else + { + status = WSAGetLastError (); + if (status == WSA_IO_PENDING) /* operation queued? */ + { + sock->writes.iostate = IOSTATE_QUEUED; + sock->writes.status = status; + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Send queued [%d]", + (int) wsabuf[0].len); + } + else /* error occurred */ + { + struct gc_arena gc = gc_new (); + ASSERT (SetEvent (sock->writes.overlapped.hEvent)); + sock->writes.iostate = IOSTATE_IMMEDIATE_RETURN; + sock->writes.status = status; + + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Send error [%d]: %s", + (int) wsabuf[0].len, + strerror_win32 (status, &gc)); + + gc_free (&gc); + } + } + } + return sock->writes.iostate; +} + +int +socket_finalize ( + SOCKET s, + struct overlapped_io *io, + struct buffer *buf, + struct sockaddr_in *from) +{ + int ret = -1; + BOOL status; + + switch (io->iostate) + { + case IOSTATE_QUEUED: + status = WSAGetOverlappedResult( + s, + &io->overlapped, + &io->size, + FALSE, + &io->flags + ); + if (status) + { + /* successful return for a queued operation */ + if (buf) + *buf = io->buf; + ret = io->size; + io->iostate = IOSTATE_INITIAL; + ASSERT (ResetEvent (io->overlapped.hEvent)); + + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Completion success [%d]", ret); + } + else + { + /* error during a queued operation */ + ret = -1; + if (WSAGetLastError() != WSA_IO_INCOMPLETE) + { + /* if no error (i.e. just not finished yet), then DON'T execute this code */ + io->iostate = IOSTATE_INITIAL; + ASSERT (ResetEvent (io->overlapped.hEvent)); + msg (D_WIN32_IO | M_ERRNO_SOCK, "WIN32 I/O: Socket Completion error"); + } + } + break; + + case IOSTATE_IMMEDIATE_RETURN: + io->iostate = IOSTATE_INITIAL; + ASSERT (ResetEvent (io->overlapped.hEvent)); + if (io->status) + { + /* error return for a non-queued operation */ + WSASetLastError (io->status); + ret = -1; + msg (D_WIN32_IO | M_ERRNO_SOCK, "WIN32 I/O: Socket Completion non-queued error"); + } + else + { + /* successful return for a non-queued operation */ + if (buf) + *buf = io->buf; + ret = io->size; + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Completion non-queued success [%d]", ret); + } + break; + + case IOSTATE_INITIAL: /* were we called without proper queueing? */ + WSASetLastError (WSAEINVAL); + ret = -1; + dmsg (D_WIN32_IO, "WIN32 I/O: Socket Completion BAD STATE"); + break; + + default: + ASSERT (0); + } + + /* return from address if requested */ + if (from) + { + if (ret >= 0 && io->addr_defined) + { + if (io->addrlen != sizeof (io->addr)) + bad_address_length (io->addrlen, sizeof (io->addr)); + *from = io->addr; + } + else + CLEAR (*from); + } + + if (buf) + buf->len = ret; + return ret; +} + +#endif /* WIN32 */ + +/* + * Socket event notification + */ + +unsigned int +socket_set (struct link_socket *s, + struct event_set *es, + unsigned int rwflags, + void *arg, + unsigned int *persistent) +{ + if (s) + { + if ((rwflags & EVENT_READ) && !stream_buf_read_setup (s)) + { + ASSERT (!persistent); + rwflags &= ~EVENT_READ; + } + +#ifdef WIN32 + if (rwflags & EVENT_READ) + socket_recv_queue (s, 0); +#endif + + /* if persistent is defined, call event_ctl only if rwflags has changed since last call */ + if (!persistent || *persistent != rwflags) + { + event_ctl (es, socket_event_handle (s), rwflags, arg); + if (persistent) + *persistent = rwflags; + } + + s->rwflags_debug = rwflags; + } + return rwflags; +} diff --git a/socket.h b/socket.h new file mode 100644 index 0000000..b1510c3 --- /dev/null +++ b/socket.h @@ -0,0 +1,808 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef SOCKET_H +#define SOCKET_H + +#include "buffer.h" +#include "common.h" +#include "error.h" +#include "proto.h" +#include "mtu.h" +#include "win32.h" +#include "event.h" +#include "proxy.h" +#include "socks.h" +#include "misc.h" + +/* + * OpenVPN's default port number as assigned by IANA. + */ +#define OPENVPN_PORT 1194 + +/* + * Number of seconds that "resolv-retry infinite" + * represents. + */ +#define RESOLV_RETRY_INFINITE 1000000000 + +#define REMOTE_LIST_SIZE 64 + +struct remote_entry +{ + const char *hostname; + int port; +}; + +struct remote_list +{ + int len; + int current; + bool no_advance; + struct remote_entry array[REMOTE_LIST_SIZE]; +}; + +/* + * packet_size_type is used to communicate packet size + * over the wire when stream oriented protocols are + * being used + */ + +typedef uint16_t packet_size_type; + +/* convert a packet_size_type from host to network order */ +#define htonps(x) htons(x) + +/* convert a packet_size_type from network to host order */ +#define ntohps(x) ntohs(x) + +/* IP addresses which are persistant across SIGUSR1s */ +struct link_socket_addr +{ + struct sockaddr_in local; + struct sockaddr_in remote; /* initial remote */ + struct sockaddr_in actual; /* remote may change due to --float */ +}; + +struct link_socket_info +{ + struct link_socket_addr *lsa; + bool connection_established; + const char *ipchange_command; + const struct plugin_list *plugins; + bool remote_float; + int proto; /* Protocol (PROTO_x defined below) */ + int mtu_changed; /* Set to true when mtu value is changed */ +}; + +/* + * Used to extract packets encapsulated in streams into a buffer, + * in this case IP packets embedded in a TCP stream. + */ +struct stream_buf +{ + struct buffer buf_init; + struct buffer residual; + int maxlen; + bool residual_fully_formed; + + struct buffer buf; + struct buffer next; + int len; /* -1 if not yet known */ + + bool error; /* if true, fatal TCP error has occurred, + requiring that connection be restarted */ +}; + +/* + * Used to set socket buffer sizes + */ +struct socket_buffer_size +{ + int rcvbuf; + int sndbuf; +}; + +/* + * This is the main socket structure used by OpenVPN. The SOCKET_ + * defines try to abstract away our implementation differences between + * using sockets on Posix vs. Win32. + */ +struct link_socket +{ + struct link_socket_info info; + + socket_descriptor_t sd; + +#ifdef ENABLE_SOCKS + socket_descriptor_t ctrl_sd; /* only used for UDP over Socks */ +#endif + +#ifdef WIN32 + struct overlapped_io reads; + struct overlapped_io writes; + struct rw_handle rw_handle; + struct rw_handle listen_handle; /* For listening on TCP socket in server mode */ +#endif + + /* used for printing status info only */ + unsigned int rwflags_debug; + + /* used for long-term queueing of pre-accepted socket listen */ + bool listen_persistent_queued; + + /* set on initial call to init phase 1 */ + struct remote_list *remote_list; + const char *remote_host; + int remote_port; + const char *local_host; + int local_port; + bool bind_local; + +# define INETD_NONE 0 +# define INETD_WAIT 1 +# define INETD_NOWAIT 2 + int inetd; + +# define LS_MODE_DEFAULT 0 +# define LS_MODE_TCP_LISTEN 1 +# define LS_MODE_TCP_ACCEPT_FROM 2 + int mode; + + int resolve_retry_seconds; + int connect_retry_seconds; + int mtu_discover_type; + + struct socket_buffer_size socket_buffer_sizes; + + int mtu; /* OS discovered MTU, or 0 if unknown */ + + bool did_resolve_remote; + + /* for stream sockets */ + struct stream_buf stream_buf; + struct buffer stream_buf_data; + bool stream_reset; + +#ifdef ENABLE_HTTP_PROXY + /* HTTP proxy */ + struct http_proxy_info *http_proxy; +#endif + +#ifdef ENABLE_SOCKS + /* Socks proxy */ + struct socks_proxy_info *socks_proxy; + struct sockaddr_in socks_relay; /* Socks UDP relay address */ +#endif + +#if defined(ENABLE_HTTP_PROXY) || defined(ENABLE_SOCKS) + /* The OpenVPN server we will use the proxy to connect to */ + const char *proxy_dest_host; + int proxy_dest_port; +#endif + +#if PASSTOS_CAPABILITY + /* used to get/set TOS. */ + uint8_t ptos; + bool ptos_defined; +#endif + +#ifdef ENABLE_DEBUG + int gremlin; /* --gremlin bits */ +#endif +}; + +/* + * Some Posix/Win32 differences. + */ + +#ifndef MSG_NOSIGNAL +#define MSG_NOSIGNAL 0 +#endif + +#ifdef WIN32 + +#define openvpn_close_socket(s) closesocket(s) + +int socket_recv_queue (struct link_socket *sock, int maxsize); + +int socket_send_queue (struct link_socket *sock, + struct buffer *buf, + const struct sockaddr_in *to); + +int socket_finalize ( + SOCKET s, + struct overlapped_io *io, + struct buffer *buf, + struct sockaddr_in *from); + +#else + +#define openvpn_close_socket(s) close(s) + +#endif + +struct link_socket *link_socket_new (void); + +/* + * Initialize link_socket object. + */ + +void +link_socket_init_phase1 (struct link_socket *sock, + const char *local_host, + struct remote_list *remote_list, + int local_port, + int proto, + int mode, + const struct link_socket *accept_from, +#ifdef ENABLE_HTTP_PROXY + struct http_proxy_info *http_proxy, +#endif +#ifdef ENABLE_SOCKS + struct socks_proxy_info *socks_proxy, +#endif +#ifdef ENABLE_DEBUG + int gremlin, +#endif + bool bind_local, + bool remote_float, + int inetd, + struct link_socket_addr *lsa, + const char *ipchange_command, + const struct plugin_list *plugins, + int resolve_retry_seconds, + int connect_retry_seconds, + int mtu_discover_type, + int rcvbuf, + int sndbuf); + +void link_socket_init_phase2 (struct link_socket *sock, + const struct frame *frame, + volatile int *signal_received); + +void link_socket_post_fork (const struct link_socket *sock, + const struct sockaddr_in *remote); + +void socket_adjust_frame_parameters (struct frame *frame, int proto); + +void frame_adjust_path_mtu (struct frame *frame, int pmtu, int proto); + +void link_socket_close (struct link_socket *sock); + +const char *print_sockaddr_ex (const struct sockaddr_in *addr, + bool do_port, + const char* separator, + struct gc_arena *gc); + +const char *print_sockaddr (const struct sockaddr_in *addr, + struct gc_arena *gc); + +#define IA_EMPTY_IF_UNDEF (1<<0) +#define IA_NET_ORDER (1<<1) +const char *print_in_addr_t (in_addr_t addr, unsigned int flags, struct gc_arena *gc); + +#define SA_IP_PORT (1<<0) +#define SA_SET_IF_NONZERO (1<<1) +void setenv_sockaddr (struct env_set *es, + const char *name_prefix, + const struct sockaddr_in *addr, + const bool flags); + +void setenv_in_addr_t (struct env_set *es, + const char *name_prefix, + in_addr_t addr, + const bool flags); + +void bad_address_length (int actual, int expected); + +in_addr_t link_socket_current_remote (const struct link_socket_info *info); + +void link_socket_connection_initiated (const struct buffer *buf, + struct link_socket_info *info, + const struct sockaddr_in *addr, + const char *common_name, + struct env_set *es); + +void link_socket_bad_incoming_addr (struct buffer *buf, + const struct link_socket_info *info, + const struct sockaddr_in *from_addr); + +void link_socket_bad_outgoing_addr (void); + +void setenv_trusted (struct env_set *es, const struct link_socket_info *info); + +void remote_list_randomize (struct remote_list *l); + +/* + * Low-level functions + */ + +/* return values of openvpn_inet_aton */ +#define OIA_HOSTNAME 0 +#define OIA_IP 1 +#define OIA_ERROR -1 +int openvpn_inet_aton (const char *dotted_quad, struct in_addr *addr); + +socket_descriptor_t create_socket_tcp (void); + +socket_descriptor_t socket_do_accept (socket_descriptor_t sd, + struct sockaddr_in *remote, + const bool nowait); + +/* + * DNS resolution + */ + +#define GETADDR_RESOLVE (1<<0) +#define GETADDR_FATAL (1<<1) +#define GETADDR_HOST_ORDER (1<<2) +#define GETADDR_MENTION_RESOLVE_RETRY (1<<3) +#define GETADDR_FATAL_ON_SIGNAL (1<<4) +#define GETADDR_WARN_ON_SIGNAL (1<<5) +#define GETADDR_MSG_VIRT_OUT (1<<6) +#define GETADDR_TRY_ONCE (1<<7) + +in_addr_t getaddr (unsigned int flags, + const char *hostname, + int resolve_retry_seconds, + bool *succeeded, + volatile int *signal_received); + +/* + * Transport protocol naming and other details. + */ + +#define PROTO_UDPv4 0 +#define PROTO_TCPv4_SERVER 1 +#define PROTO_TCPv4_CLIENT 2 +#define PROTO_TCPv4 3 +#define PROTO_N 4 + +int ascii2proto (const char* proto_name); +const char *proto2ascii (int proto, bool display_form); +const char *proto2ascii_all (struct gc_arena *gc); +int proto_remote (int proto, bool remote); + +/* + * Overhead added to packets by various protocols. + */ +#define IPv4_UDP_HEADER_SIZE 28 +#define IPv4_TCP_HEADER_SIZE 40 +#define IPv6_UDP_HEADER_SIZE 40 + +static const int proto_overhead[] = { /* indexed by PROTO_x */ + IPv4_UDP_HEADER_SIZE, + IPv4_TCP_HEADER_SIZE, + IPv4_TCP_HEADER_SIZE +}; + +static inline int +datagram_overhead (int proto) +{ + ASSERT (proto >= 0 && proto < PROTO_N); + return proto_overhead [proto]; +} + +/* + * Misc inline functions + */ + +static inline int +remote_list_len (const struct remote_list *rl) +{ + if (rl) + return rl->len; + else + return 0; +} + +static inline bool +legal_ipv4_port (int port) +{ + return port > 0 && port < 65536; +} + +static inline bool +link_socket_proto_connection_oriented (int proto) +{ + return proto == PROTO_TCPv4_SERVER || proto == PROTO_TCPv4_CLIENT; +} + +static inline bool +link_socket_connection_oriented (const struct link_socket *sock) +{ + if (sock) + return link_socket_proto_connection_oriented (sock->info.proto); + else + return false; +} + +static inline bool +addr_defined (const struct sockaddr_in *addr) +{ + return addr->sin_addr.s_addr != 0; +} + +static inline bool +addr_match (const struct sockaddr_in *a1, const struct sockaddr_in *a2) +{ + return a1->sin_addr.s_addr == a2->sin_addr.s_addr; +} + +static inline in_addr_t +addr_host (const struct sockaddr_in *s) +{ + return ntohl (s->sin_addr.s_addr); +} + +static inline bool +addr_port_match (const struct sockaddr_in *a1, const struct sockaddr_in *a2) +{ + return a1->sin_addr.s_addr == a2->sin_addr.s_addr + && a1->sin_port == a2->sin_port; +} + +static inline bool +addr_match_proto (const struct sockaddr_in *a1, + const struct sockaddr_in *a2, + const int proto) +{ + return link_socket_proto_connection_oriented (proto) + ? addr_match (a1, a2) + : addr_port_match (a1, a2); +} + +static inline bool +socket_connection_reset (const struct link_socket *sock, int status) +{ + if (link_socket_connection_oriented (sock)) + { + if (sock->stream_reset || sock->stream_buf.error) + return true; + else if (status < 0) + { + const int err = openvpn_errno_socket (); +#ifdef WIN32 + return err == WSAECONNRESET || err == WSAECONNABORTED; +#else + return err == ECONNRESET; +#endif + } + } + return false; +} + +static inline bool +link_socket_verify_incoming_addr (struct buffer *buf, + const struct link_socket_info *info, + const struct sockaddr_in *from_addr) +{ + if (buf->len > 0) + { + if (from_addr->sin_family != AF_INET) + return false; + if (!addr_defined (from_addr)) + return false; + if (info->remote_float || !addr_defined (&info->lsa->remote)) + return true; + if (addr_match_proto (from_addr, &info->lsa->remote, info->proto)) + return true; + } + return false; +} + +static inline void +link_socket_get_outgoing_addr (struct buffer *buf, + const struct link_socket_info *info, + struct sockaddr_in *addr) +{ + if (buf->len > 0) + { + struct link_socket_addr *lsa = info->lsa; + if (addr_defined (&lsa->actual)) + { + addr->sin_family = lsa->actual.sin_family; + addr->sin_addr.s_addr = lsa->actual.sin_addr.s_addr; + addr->sin_port = lsa->actual.sin_port; + } + else + { + link_socket_bad_outgoing_addr (); + buf->len = 0; + } + } +} + +static inline void +link_socket_set_outgoing_addr (const struct buffer *buf, + struct link_socket_info *info, + const struct sockaddr_in *addr, + const char *common_name, + struct env_set *es) +{ + if (!buf || buf->len > 0) + { + struct link_socket_addr *lsa = info->lsa; + if ( + /* new or changed address? */ + (!info->connection_established + || !addr_match_proto (addr, &lsa->actual, info->proto)) + /* address undef or address == remote or --float */ + && (info->remote_float + || !addr_defined (&lsa->remote) + || addr_match_proto (addr, &lsa->remote, info->proto)) + ) + { + link_socket_connection_initiated (buf, info, addr, common_name, es); + } + } +} + +/* + * Stream buffer handling -- stream_buf is a helper class + * to assist in the packetization of stream transport protocols + * such as TCP. + */ + +void stream_buf_init (struct stream_buf *sb, struct buffer *buf); +void stream_buf_close (struct stream_buf* sb); +bool stream_buf_added (struct stream_buf *sb, int length_added); + +static inline bool +stream_buf_read_setup (struct link_socket* sock) +{ + bool stream_buf_read_setup_dowork (struct link_socket* sock); + if (link_socket_connection_oriented (sock)) + return stream_buf_read_setup_dowork (sock); + else + return true; +} + +/* + * Socket Read Routines + */ + +int link_socket_read_tcp (struct link_socket *sock, + struct buffer *buf); + +#ifdef WIN32 + +static inline int +link_socket_read_udp_win32 (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *from) +{ + return socket_finalize (sock->sd, &sock->reads, buf, from); +} + +#else + +int link_socket_read_udp_posix (struct link_socket *sock, + struct buffer *buf, + int maxsize, + struct sockaddr_in *from); + +#endif + +/* read a TCP or UDP packet from link */ +static inline int +link_socket_read (struct link_socket *sock, + struct buffer *buf, + int maxsize, + struct sockaddr_in *from) +{ + if (sock->info.proto == PROTO_UDPv4) + { + int res; + +#ifdef WIN32 + res = link_socket_read_udp_win32 (sock, buf, from); +#else + res = link_socket_read_udp_posix (sock, buf, maxsize, from); +#endif + return res; + } + else if (sock->info.proto == PROTO_TCPv4_SERVER || sock->info.proto == PROTO_TCPv4_CLIENT) + { + /* from address was returned by accept */ + *from = sock->info.lsa->actual; + return link_socket_read_tcp (sock, buf); + } + else + { + ASSERT (0); + return -1; /* NOTREACHED */ + } +} + +/* + * Socket Write routines + */ + +int link_socket_write_tcp (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to); + +#ifdef WIN32 + +static inline int +link_socket_write_win32 (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to) +{ + int err = 0; + int status = 0; + if (overlapped_io_active (&sock->writes)) + { + status = socket_finalize (sock->sd, &sock->writes, NULL, NULL); + if (status < 0) + err = WSAGetLastError (); + } + socket_send_queue (sock, buf, to); + if (status < 0) + { + WSASetLastError (err); + return status; + } + else + return BLEN (buf); +} + +#else + +static inline int +link_socket_write_udp_posix (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to) +{ + return sendto (sock->sd, BPTR (buf), BLEN (buf), 0, + (struct sockaddr *) to, + (socklen_t) sizeof (*to)); +} + +static inline int +link_socket_write_tcp_posix (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to) +{ + return send (sock->sd, BPTR (buf), BLEN (buf), MSG_NOSIGNAL); +} + +#endif + +static inline int +link_socket_write_udp (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to) +{ +#ifdef WIN32 + return link_socket_write_win32 (sock, buf, to); +#else + return link_socket_write_udp_posix (sock, buf, to); +#endif +} + +/* write a TCP or UDP packet to link */ +static inline int +link_socket_write (struct link_socket *sock, + struct buffer *buf, + struct sockaddr_in *to) +{ + if (sock->info.proto == PROTO_UDPv4) + { + return link_socket_write_udp (sock, buf, to); + } + else if (sock->info.proto == PROTO_TCPv4_SERVER || sock->info.proto == PROTO_TCPv4_CLIENT) + { + return link_socket_write_tcp (sock, buf, to); + } + else + { + ASSERT (0); + return -1; /* NOTREACHED */ + } +} + +#if PASSTOS_CAPABILITY + +/* + * Extract TOS bits. Assumes that ipbuf is a valid IPv4 packet. + */ +static inline void +link_socket_extract_tos (struct link_socket *ls, const struct buffer *ipbuf) +{ + if (ls && ipbuf) + { + struct openvpn_iphdr *iph = (struct openvpn_iphdr *) BPTR (ipbuf); + ls->ptos = iph->tos; + ls->ptos_defined = true; + } +} + +/* + * Set socket properties to reflect TOS bits which were extracted + * from tunnel packet. + */ +static inline void +link_socket_set_tos (struct link_socket *ls) +{ + if (ls && ls->ptos_defined) + setsockopt (ls->sd, IPPROTO_IP, IP_TOS, &ls->ptos, sizeof (ls->ptos)); +} + +#endif + +/* + * Socket I/O wait functions + */ + +static inline bool +socket_read_residual (const struct link_socket *s) +{ + return s && s->stream_buf.residual_fully_formed; +} + +static inline event_t +socket_event_handle (const struct link_socket *s) +{ +#ifdef WIN32 + return &s->rw_handle; +#else + return s->sd; +#endif +} + +event_t socket_listen_event_handle (struct link_socket *s); + +unsigned int +socket_set (struct link_socket *s, + struct event_set *es, + unsigned int rwflags, + void *arg, + unsigned int *persistent); + +static inline void +socket_set_listen_persistent (struct link_socket *s, + struct event_set *es, + void *arg) +{ + if (s && !s->listen_persistent_queued) + { + event_ctl (es, socket_listen_event_handle (s), EVENT_READ, arg); + s->listen_persistent_queued = true; + } +} + +static inline void +socket_reset_listen_persistent (struct link_socket *s) +{ +#ifdef WIN32 + reset_net_event_win32 (&s->listen_handle, s->sd); +#endif +} + +const char *socket_stat (const struct link_socket *s, unsigned int rwflags, struct gc_arena *gc); + +#endif /* SOCKET_H */ @@ -0,0 +1,411 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * 2004-01-30: Added Socks5 proxy support + * (Christof Meerwald, http://cmeerw.org) + * + * see RFC 1928, only supports "no authentication" + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#ifdef ENABLE_SOCKS + +#include "syshead.h" + +#include "common.h" +#include "misc.h" +#include "win32.h" +#include "socket.h" +#include "fdmisc.h" +#include "proxy.h" + +#include "memdbg.h" + + +void +socks_adjust_frame_parameters (struct frame *frame, int proto) +{ + if (proto == PROTO_UDPv4) + frame_add_to_extra_link (frame, 10); +} + +struct socks_proxy_info * +new_socks_proxy (const char *server, + int port, + bool retry, + struct gc_arena *gc) +{ + struct socks_proxy_info *p; + ALLOC_OBJ_CLEAR_GC (p, struct socks_proxy_info, gc); + ASSERT (server); + ASSERT (legal_ipv4_port (port)); + + strncpynt (p->server, server, sizeof (p->server)); + p->port = port; + p->retry = retry; + p->defined = true; + + return p; +} + +static bool +socks_handshake (socket_descriptor_t sd, volatile int *signal_received) +{ + char buf[2]; + int len = 0; + const int timeout_sec = 5; + + /* VER = 5, NMETHODS = 1, METHODS = [0] */ + const ssize_t size = send (sd, "\x05\x01\x00", 3, MSG_NOSIGNAL); + if (size != 3) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "socks_handshake: TCP port write failed on send()"); + return false; + } + + while (len < 2) + { + int status; + ssize_t size; + fd_set reads; + struct timeval tv; + char c; + + FD_ZERO (&reads); + FD_SET (sd, &reads); + tv.tv_sec = timeout_sec; + tv.tv_usec = 0; + + status = select (sd + 1, &reads, NULL, NULL, &tv); + + get_signal (signal_received); + if (*signal_received) + return false; + + /* timeout? */ + if (status == 0) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "socks_handshake: TCP port read timeout expired"); + return false; + } + + /* error */ + if (status < 0) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "socks_handshake: TCP port read failed on select()"); + return false; + } + + /* read single char */ + size = recv(sd, &c, 1, MSG_NOSIGNAL); + + /* error? */ + if (size != 1) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "socks_handshake: TCP port read failed on recv()"); + return false; + } + + /* store char in buffer */ + buf[len++] = c; + } + + /* VER == 5 && METHOD == 0 */ + if (buf[0] != '\x05' || buf[1] != '\x00') + { + msg (D_LINK_ERRORS, "socks_handshake: Socks proxy returned bad status"); + return false; + } + + return true; +} + +static bool +recv_socks_reply (socket_descriptor_t sd, struct sockaddr_in *addr, + volatile int *signal_received) +{ + char atyp = '\0'; + int alen = 0; + int len = 0; + char buf[22]; + const int timeout_sec = 5; + + if (addr != NULL) + { + addr->sin_family = AF_INET; + addr->sin_addr.s_addr = htonl (INADDR_ANY); + addr->sin_port = htons (0); + } + + while (len < 4 + alen + 2) + { + int status; + ssize_t size; + fd_set reads; + struct timeval tv; + char c; + + FD_ZERO (&reads); + FD_SET (sd, &reads); + tv.tv_sec = timeout_sec; + tv.tv_usec = 0; + + status = select (sd + 1, &reads, NULL, NULL, &tv); + + get_signal (signal_received); + if (*signal_received) + return false; + + /* timeout? */ + if (status == 0) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_socks_reply: TCP port read timeout expired"); + return false; + } + + /* error */ + if (status < 0) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_socks_reply: TCP port read failed on select()"); + return false; + } + + /* read single char */ + size = recv(sd, &c, 1, MSG_NOSIGNAL); + + /* error? */ + if (size != 1) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "recv_socks_reply: TCP port read failed on recv()"); + return false; + } + + if (len == 3) + atyp = c; + + if (len == 4) + { + switch (atyp) + { + case '\x01': /* IP V4 */ + alen = 4; + break; + + case '\x03': /* DOMAINNAME */ + alen = (unsigned char) c; + break; + + case '\x04': /* IP V6 */ + alen = 16; + break; + + default: + msg (D_LINK_ERRORS, "recv_socks_reply: Socks proxy returned bad address type"); + return false; + } + } + + /* store char in buffer */ + if (len < (int)sizeof(buf)) + buf[len] = c; + ++len; + } + + /* VER == 5 && REP == 0 (succeeded) */ + if (buf[0] != '\x05' || buf[1] != '\x00') + { + msg (D_LINK_ERRORS, "recv_socks_reply: Socks proxy returned bad reply"); + return false; + } + + /* ATYP == 1 (IP V4 address) */ + if (atyp == '\x01' && addr != NULL) + { + memcpy (&addr->sin_addr, buf + 4, sizeof (addr->sin_addr)); + memcpy (&addr->sin_port, buf + 8, sizeof (addr->sin_port)); + } + + + return true; +} + +void +establish_socks_proxy_passthru (struct socks_proxy_info *p, + socket_descriptor_t sd, /* already open to proxy */ + const char *host, /* openvpn server remote */ + const int port, /* openvpn server port */ + volatile int *signal_received) +{ + char buf[128]; + size_t len; + + if (!socks_handshake (sd, signal_received)) + goto error; + + /* format Socks CONNECT message */ + buf[0] = '\x05'; /* VER = 5 */ + buf[1] = '\x01'; /* CMD = 1 (CONNECT) */ + buf[2] = '\x00'; /* RSV */ + buf[3] = '\x03'; /* ATYP = 3 (DOMAINNAME) */ + + len = strlen(host); + len = (5 + len + 2 > sizeof(buf)) ? (sizeof(buf) - 5 - 2) : len; + + buf[4] = (char) len; + memcpy(buf + 5, host, len); + + buf[5 + len] = (char) (port >> 8); + buf[5 + len + 1] = (char) (port & 0xff); + + { + const ssize_t size = send (sd, buf, 5 + len + 2, MSG_NOSIGNAL); + if ((int)size != 5 + (int)len + 2) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "establish_socks_proxy_passthru: TCP port write failed on send()"); + goto error; + } + } + + /* receive reply from Socks proxy and discard */ + if (!recv_socks_reply (sd, NULL, signal_received)) + goto error; + + return; + + error: + /* on error, should we exit or restart? */ + if (!*signal_received) + *signal_received = (p->retry ? SIGUSR1 : SIGTERM); /* SOFT-SIGUSR1 -- socks error */ + return; +} + +void +establish_socks_proxy_udpassoc (struct socks_proxy_info *p, + socket_descriptor_t ctrl_sd, /* already open to proxy */ + socket_descriptor_t udp_sd, + struct sockaddr_in *relay_addr, + volatile int *signal_received) +{ + if (!socks_handshake (ctrl_sd, signal_received)) + goto error; + + { + /* send Socks UDP ASSOCIATE message */ + /* VER = 5, CMD = 3 (UDP ASSOCIATE), RSV = 0, ATYP = 1 (IP V4), + BND.ADDR = 0, BND.PORT = 0 */ + const ssize_t size = send (ctrl_sd, + "\x05\x03\x00\x01\x00\x00\x00\x00\x00\x00", + 10, MSG_NOSIGNAL); + if (size != 10) + { + msg (D_LINK_ERRORS | M_ERRNO_SOCK, "establish_socks_proxy_passthru: TCP port write failed on send()"); + goto error; + } + } + + /* receive reply from Socks proxy */ + CLEAR (*relay_addr); + if (!recv_socks_reply (ctrl_sd, relay_addr, signal_received)) + goto error; + + return; + + error: + /* on error, should we exit or restart? */ + if (!*signal_received) + *signal_received = (p->retry ? SIGUSR1 : SIGTERM); /* SOFT-SIGUSR1 -- socks error */ + return; +} + +/* + * Remove the 10 byte socks5 header from an incoming + * UDP packet, setting *from to the source address. + * + * Run after UDP read. + */ +void +socks_process_incoming_udp (struct buffer *buf, + struct sockaddr_in *from) +{ + int atyp; + + if (BLEN (buf) < 10) + goto error; + + buf_read_u16 (buf); + if (buf_read_u8 (buf) != 0) + goto error; + + atyp = buf_read_u8 (buf); + if (atyp != 1) /* ATYP == 1 (IP V4) */ + goto error; + + buf_read (buf, &from->sin_addr, sizeof (from->sin_addr)); + buf_read (buf, &from->sin_port, sizeof (from->sin_port)); + + return; + + error: + buf->len = 0; +} + +/* + * Add a 10 byte socks header prior to UDP write. + * *to is the destination address. + * + * Run before UDP write. + * Returns the size of the header. + */ +int +socks_process_outgoing_udp (struct buffer *buf, + struct sockaddr_in *to) +{ + /* + * Get a 10 byte subset buffer prepended to buf -- + * we expect these bytes will be here because + * we allocated frame space in socks_adjust_frame_parameters. + */ + struct buffer head = buf_sub (buf, 10, true); + + /* crash if not enough headroom in buf */ + ASSERT (buf_defined (&head)); + + buf_write_u16 (&head, 0); /* RSV = 0 */ + buf_write_u8 (&head, 0); /* FRAG = 0 */ + buf_write_u8 (&head, '\x01'); /* ATYP = 1 (IP V4) */ + buf_write (&head, &to->sin_addr, sizeof (to->sin_addr)); + buf_write (&head, &to->sin_port, sizeof (to->sin_port)); + + return 10; +} + +#else +static void dummy(void) {} +#endif /* ENABLE_SOCKS */ @@ -0,0 +1,71 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * 2004-01-30: Added Socks5 proxy support + * (Christof Meerwald, http://cmeerw.org) + */ + +#ifndef SOCKS_H +#define SOCKS_H + +#ifdef ENABLE_SOCKS + +#include "buffer.h" + +struct socks_proxy_info { + bool defined; + bool retry; + + char server[128]; + int port; +}; + +void socks_adjust_frame_parameters (struct frame *frame, int proto); + +struct socks_proxy_info *new_socks_proxy (const char *server, + int port, + bool retry, + struct gc_arena *gc); + +void establish_socks_proxy_passthru (struct socks_proxy_info *p, + socket_descriptor_t sd, /* already open to proxy */ + const char *host, /* openvpn server remote */ + const int port, /* openvpn server port */ + volatile int *signal_received); + +void establish_socks_proxy_udpassoc (struct socks_proxy_info *p, + socket_descriptor_t ctrl_sd, /* already open to proxy */ + socket_descriptor_t udp_sd, + struct sockaddr_in *relay_addr, + volatile int *signal_received); + +void socks_process_incoming_udp (struct buffer *buf, + struct sockaddr_in *from); + +int socks_process_outgoing_udp (struct buffer *buf, + struct sockaddr_in *to); + +#endif +#endif @@ -0,0 +1,4099 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * The routines in this file deal with dynamically negotiating + * the data channel HMAC and cipher keys through a TLS session. + * + * Both the TLS session and the data channel are multiplexed + * over the same TCP/UDP port. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +#include "syshead.h" + +#include "ssl.h" +#include "error.h" +#include "common.h" +#include "integer.h" +#include "socket.h" +#include "thread.h" +#include "misc.h" +#include "fdmisc.h" +#include "interval.h" +#include "perf.h" +#include "status.h" +#include "gremlin.h" + +#ifdef WIN32 +#include "cryptoapi.h" +#endif + +#include "memdbg.h" + +#ifndef ENABLE_OCC +static const char ssl_default_options_string[] = "V0 UNDEF"; +#endif + +static inline const char * +local_options_string (const struct tls_session *session) +{ +#ifdef ENABLE_OCC + return session->opt->local_options; +#else + return ssl_default_options_string; +#endif +} + +#ifdef MEASURE_TLS_HANDSHAKE_STATS + +static int tls_handshake_success; /* GLOBAL */ +static int tls_handshake_error; /* GLOBAL */ +static int tls_packets_generated; /* GLOBAL */ +static int tls_packets_sent; /* GLOBAL */ + +#define INCR_SENT ++tls_packets_sent +#define INCR_GENERATED ++tls_packets_generated +#define INCR_SUCCESS ++tls_handshake_success +#define INCR_ERROR ++tls_handshake_error + +void +show_tls_performance_stats(void) +{ + msg (D_TLS_DEBUG_LOW, "TLS Handshakes, success=%f%% (good=%d, bad=%d), retransmits=%f%%", + (double) tls_handshake_success / (tls_handshake_success + tls_handshake_error) * 100.0, + tls_handshake_success, tls_handshake_error, + (double) (tls_packets_sent - tls_packets_generated) / tls_packets_generated * 100.0); +} +#else + +#define INCR_SENT +#define INCR_GENERATED +#define INCR_SUCCESS +#define INCR_ERROR + +#endif + +#ifdef BIO_DEBUG + +#warning BIO_DEBUG defined + +static FILE *biofp; /* GLOBAL */ +static bool biofp_toggle; /* GLOBAL */ +static time_t biofp_last_open; /* GLOBAL */ +static const int biofp_reopen_interval = 600; /* GLOBAL */ + +static void +close_biofp() +{ + if (biofp) + { + ASSERT (!fclose (biofp)); + biofp = NULL; + } +} + +static void +open_biofp() +{ + const time_t current = time (NULL); + const pid_t pid = getpid (); + + if (biofp_last_open + biofp_reopen_interval < current) + close_biofp(); + if (!biofp) + { + char fn[256]; + openvpn_snprintf(fn, sizeof(fn), "bio/%d-%d.log", pid, biofp_toggle); + biofp = fopen (fn, "w"); + ASSERT (biofp); + biofp_last_open = time (NULL); + biofp_toggle ^= 1; + } +} + +static void +bio_debug_data (const char *mode, BIO *bio, const uint8_t *buf, int len, const char *desc) +{ + struct gc_arena gc = gc_new (); + if (len > 0) + { + open_biofp(); + fprintf(biofp, "BIO_%s %s time=" time_format " bio=" ptr_format " len=%d data=%s\n", + mode, desc, time (NULL), (ptr_type)bio, len, format_hex (buf, len, 0, &gc)); + fflush (biofp); + } + gc_free (&gc); +} + +static void +bio_debug_oc (const char *mode, BIO *bio) +{ + open_biofp(); + fprintf(biofp, "BIO %s time=" time_format " bio=" ptr_format "\n", + mode, time (NULL), (ptr_type)bio); + fflush (biofp); +} + +#endif + +/* + * Max number of bytes we will add + * for data structures common to both + * data and control channel packets. + * (opcode only). + */ +void +tls_adjust_frame_parameters(struct frame *frame) +{ + frame_add_to_extra_frame (frame, 1); /* space for opcode */ +} + +/* + * Max number of bytes we will add + * to control channel packet. + */ +static void +tls_init_control_channel_frame_parameters(const struct frame *data_channel_frame, + struct frame *frame) +{ + /* + * frame->extra_frame is already initialized with tls_auth buffer requirements, + * if --tls-auth is enabled. + */ + + /* inherit link MTU and extra_link from data channel */ + frame->link_mtu = data_channel_frame->link_mtu; + frame->extra_link = data_channel_frame->extra_link; + + /* set extra_frame */ + tls_adjust_frame_parameters (frame); + reliable_ack_adjust_frame_parameters (frame, CONTROL_SEND_ACK_MAX); + frame_add_to_extra_frame (frame, SID_SIZE + sizeof (packet_id_type)); + + /* set dynamic link MTU to minimum value */ + frame_set_mtu_dynamic (frame, 0, SET_MTU_TUN); +} + +/* + * Allocate space in SSL objects + * in which to store a struct tls_session + * pointer back to parent. + */ + +static int mydata_index; /* GLOBAL */ + +static void +ssl_set_mydata_index () +{ + mydata_index = SSL_get_ex_new_index (0, "struct session *", NULL, NULL, NULL); + ASSERT (mydata_index >= 0); +} + +void +init_ssl_lib () +{ + SSL_library_init (); + SSL_load_error_strings (); + OpenSSL_add_all_algorithms (); + + init_crypto_lib(); + + /* + * If you build the OpenSSL library and OpenVPN with + * CRYPTO_MDEBUG, you will get a listing of OpenSSL + * memory leaks on program termination. + */ +#ifdef CRYPTO_MDEBUG + CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON); +#endif + + ssl_set_mydata_index (); +} + +void +free_ssl_lib () +{ +#ifdef CRYPTO_MDEBUG + FILE* fp = fopen ("sdlog", "w"); + ASSERT (fp); + CRYPTO_mem_leaks_fp (fp); + fclose (fp); +#endif + + uninit_crypto_lib (); + EVP_cleanup (); + ERR_free_strings (); +} + +/* + * OpenSSL library calls pem_password_callback if the + * private key is protected by a password. + */ + +static struct user_pass passbuf; /* GLOBAL */ + +void +pem_password_setup (const char *auth_file) +{ + if (!strlen (passbuf.password)) + get_user_pass (&passbuf, auth_file, true, UP_TYPE_PRIVATE_KEY, GET_USER_PASS_MANAGEMENT|GET_USER_PASS_SENSITIVE); +} + +int +pem_password_callback (char *buf, int size, int rwflag, void *u) +{ + if (buf) + { + /* prompt for password even if --askpass wasn't specified */ + pem_password_setup (NULL); + strncpynt (buf, passbuf.password, size); + purge_user_pass (&passbuf, false); + + return strlen (buf); + } + return 0; +} + +/* + * Auth username/password handling + */ + +static bool auth_user_pass_enabled; /* GLOBAL */ +static struct user_pass auth_user_pass; /* GLOBAL */ + +void +auth_user_pass_setup (const char *auth_file) +{ + auth_user_pass_enabled = true; + if (!auth_user_pass.defined) + get_user_pass (&auth_user_pass, auth_file, false, UP_TYPE_AUTH, GET_USER_PASS_MANAGEMENT|GET_USER_PASS_SENSITIVE); +} + +/* + * Disable password caching + */ +void +ssl_set_auth_nocache (void) +{ + passbuf.nocache = true; + auth_user_pass.nocache = true; +} + +/* + * Forget private key password AND auth-user-pass username/password. + */ +void +ssl_purge_auth (void) +{ +#if 1 /* JYFIXME -- todo: bad private key should trigger a signal, then this code can be included */ + purge_user_pass (&passbuf, true); +#endif + purge_user_pass (&auth_user_pass, true); +} + +/* + * OpenSSL callback to get a temporary RSA key, mostly + * used for export ciphers. + */ +static RSA * +tmp_rsa_cb (SSL * s, int is_export, int keylength) +{ + static RSA *rsa_tmp = NULL; + if (rsa_tmp == NULL) + { + msg (D_HANDSHAKE, "Generating temp (%d bit) RSA key", keylength); + rsa_tmp = RSA_generate_key (keylength, RSA_F4, NULL, NULL); + } + return (rsa_tmp); +} + +/* + * Extract a field from an X509 subject name. + * + * Example: + * + * /C=US/ST=CO/L=Denver/O=ORG/CN=Test-CA/Email=jim@yonan.net + * + * The common name is 'Test-CA' + */ +static void +extract_x509_field (const char *x509, const char *field_name, char *out, int size) +{ + char field_buf[256]; + struct buffer x509_buf; + + ASSERT (size > 0); + *out = '\0'; + buf_set_read (&x509_buf, (uint8_t *)x509, strlen (x509)); + while (buf_parse (&x509_buf, '/', field_buf, sizeof (field_buf))) + { + struct buffer component_buf; + char field_name_buf[64]; + char field_value_buf[256]; + buf_set_read (&component_buf, (const uint8_t *) field_buf, strlen (field_buf)); + buf_parse (&component_buf, '=', field_name_buf, sizeof (field_name_buf)); + buf_parse (&component_buf, '=', field_value_buf, sizeof (field_value_buf)); + if (!strcmp (field_name_buf, field_name)) + { + strncpynt (out, field_value_buf, size); + break; + } + } +} + +static void +setenv_untrusted (struct tls_session *session) +{ + setenv_sockaddr (session->opt->es, "untrusted", &session->untrusted_sockaddr, SA_IP_PORT); +} + +static void +set_common_name (struct tls_session *session, const char *common_name) +{ + if (session->common_name) + { + free (session->common_name); + session->common_name = NULL; + } + if (common_name) + { + session->common_name = string_alloc (common_name, NULL); + } +} + +/* + * nsCertType checking + */ + +#define verify_nsCertType(x, usage) (((x)->ex_flags & EXFLAG_NSCERT) && ((x)->ex_nscert & (usage))) + +static const char * +print_nsCertType (int type) +{ + switch (type) + { + case NS_SSL_SERVER: + return "SERVER"; + case NS_SSL_CLIENT: + return "CLIENT"; + default: + return "?"; + } +} + +/* + * Our verify callback function -- check + * that an incoming peer certificate is good. + */ + +static int +verify_callback (int preverify_ok, X509_STORE_CTX * ctx) +{ + char subject[256]; + char envname[64]; + char common_name[TLS_CN_LEN]; + SSL *ssl; + struct tls_session *session; + const struct tls_options *opt; + const int max_depth = 8; + + /* get the tls_session pointer */ + ssl = X509_STORE_CTX_get_ex_data (ctx, SSL_get_ex_data_X509_STORE_CTX_idx()); + ASSERT (ssl); + session = (struct tls_session *) SSL_get_ex_data (ssl, mydata_index); + ASSERT (session); + opt = session->opt; + ASSERT (opt); + + session->verified = false; + + /* get the X509 name */ + X509_NAME_oneline (X509_get_subject_name (ctx->current_cert), subject, + sizeof (subject)); + subject[sizeof (subject) - 1] = '\0'; + + /* enforce character class restrictions in X509 name */ + string_mod (subject, X509_NAME_CHAR_CLASS, 0, '_'); + + /* extract the common name */ + extract_x509_field (subject, "CN", common_name, TLS_CN_LEN); + string_mod (common_name, COMMON_NAME_CHAR_CLASS, 0, '_'); + +#if 0 /* print some debugging info */ + msg (D_LOW, "LOCAL OPT: %s", opt->local_options); + msg (D_LOW, "X509: %s", subject); +#endif + + /* did peer present cert which was signed our root cert? */ + if (!preverify_ok) + { + /* Remote site specified a certificate, but it's not correct */ + msg (D_TLS_ERRORS, "VERIFY ERROR: depth=%d, error=%s: %s", + ctx->error_depth, X509_verify_cert_error_string (ctx->error), subject); + goto err; /* Reject connection */ + } + + /* warn if cert chain is too deep */ + if (ctx->error_depth >= max_depth) + msg (M_WARN, "TLS Warning: Convoluted certificate chain detected with depth [%d] greater than %d", ctx->error_depth, max_depth); + + /* save common name in session object */ + if (ctx->error_depth == 0) + set_common_name (session, common_name); + + /* export subject name string as environmental variable */ + session->verify_maxlevel = max_int (session->verify_maxlevel, ctx->error_depth); + openvpn_snprintf (envname, sizeof(envname), "tls_id_%d", ctx->error_depth); + setenv_str (opt->es, envname, subject); + +#if 0 + /* export common name string as environmental variable */ + openvpn_snprintf (envname, sizeof(envname), "tls_common_name_%d", ctx->error_depth); + setenv_str (opt->es, envname, common_name); +#endif + + /* export serial number as environmental variable */ + { + const int serial = (int) ASN1_INTEGER_get (X509_get_serialNumber (ctx->current_cert)); + openvpn_snprintf (envname, sizeof(envname), "tls_serial_%d", ctx->error_depth); + setenv_int (opt->es, envname, serial); + } + + /* export current untrusted IP */ + setenv_untrusted (session); + + /* verify certificate nsCertType */ + if (opt->ns_cert_type && ctx->error_depth == 0) + { + if (verify_nsCertType (ctx->current_cert, opt->ns_cert_type)) + { + msg (D_HANDSHAKE, "VERIFY OK: nsCertType=%s", + print_nsCertType (opt->ns_cert_type)); + } + else + { + msg (D_HANDSHAKE, "VERIFY nsCertType ERROR: %s, require nsCertType=%s", + subject, print_nsCertType (opt->ns_cert_type)); + goto err; /* Reject connection */ + } + } + + /* verify X509 name or common name against --tls-remote */ + if (opt->verify_x509name && strlen (opt->verify_x509name) > 0 && ctx->error_depth == 0) + { + if (strcmp (opt->verify_x509name, subject) == 0 + || strncmp (opt->verify_x509name, common_name, strlen (opt->verify_x509name)) == 0) + msg (D_HANDSHAKE, "VERIFY X509NAME OK: %s", subject); + else + { + msg (D_HANDSHAKE, "VERIFY X509NAME ERROR: %s, must be %s", + subject, opt->verify_x509name); + goto err; /* Reject connection */ + } + } + + /* call --tls-verify plug-in(s) */ + if (plugin_defined (opt->plugins, OPENVPN_PLUGIN_TLS_VERIFY)) + { + char command[256]; + struct buffer out; + int ret; + + buf_set_write (&out, (uint8_t*)command, sizeof (command)); + buf_printf (&out, "%d %s", + ctx->error_depth, + subject); + + ret = plugin_call (opt->plugins, OPENVPN_PLUGIN_TLS_VERIFY, command, opt->es); + + if (!ret) + { + msg (D_HANDSHAKE, "VERIFY PLUGIN OK: depth=%d, %s", + ctx->error_depth, subject); + } + else + { + msg (D_HANDSHAKE, "VERIFY PLUGIN ERROR: depth=%d, %s", + ctx->error_depth, subject); + goto err; /* Reject connection */ + } + } + + /* run --tls-verify script */ + if (opt->verify_command) + { + char command[256]; + struct buffer out; + int ret; + + setenv_str (opt->es, "script_type", "tls-verify"); + + buf_set_write (&out, (uint8_t*)command, sizeof (command)); + buf_printf (&out, "%s %d %s", + opt->verify_command, + ctx->error_depth, + subject); + dmsg (D_TLS_DEBUG, "TLS: executing verify command: %s", command); + ret = openvpn_system (command, opt->es, S_SCRIPT); + + if (system_ok (ret)) + { + msg (D_HANDSHAKE, "VERIFY SCRIPT OK: depth=%d, %s", + ctx->error_depth, subject); + } + else + { + if (!system_executed (ret)) + msg (M_ERR, "Verify command failed to execute: %s", command); + msg (D_HANDSHAKE, "VERIFY SCRIPT ERROR: depth=%d, %s", + ctx->error_depth, subject); + goto err; /* Reject connection */ + } + } + + /* check peer cert against CRL */ + if (opt->crl_file) + { + X509_CRL *crl=NULL; + X509_REVOKED *revoked; + BIO *in=NULL; + int n,i,retval = 0; + + in=BIO_new(BIO_s_file()); + + if (in == NULL) { + msg (M_ERR, "CRL: BIO err"); + goto end; + } + if (BIO_read_filename(in, opt->crl_file) <= 0) { + msg (M_ERR, "CRL: cannot read: %s", opt->crl_file); + goto end; + } + crl=PEM_read_bio_X509_CRL(in,NULL,NULL,NULL); + if (crl == NULL) { + msg (M_ERR, "CRL: cannot read CRL from file %s", opt->crl_file); + goto end; + } + + if (X509_NAME_cmp(X509_CRL_get_issuer(crl), X509_get_issuer_name(ctx->current_cert)) != 0) { + msg (M_WARN, "CRL: CRL %s is from a different issuer than the issuer of certificate %s", opt->crl_file, subject); + retval = 1; + goto end; + } + + n = sk_num(X509_CRL_get_REVOKED(crl)); + + for (i = 0; i < n; i++) { + revoked = (X509_REVOKED *)sk_value(X509_CRL_get_REVOKED(crl), i); + if (ASN1_INTEGER_cmp(revoked->serialNumber, X509_get_serialNumber(ctx->current_cert)) == 0) { + msg (D_HANDSHAKE, "CRL CHECK FAILED: %s is REVOKED",subject); + goto end; + } + } + + retval = 1; + msg (D_HANDSHAKE, "CRL CHECK OK: %s",subject); + + end: + + BIO_free(in); + if (crl) + X509_CRL_free (crl); + if (!retval) + goto err; + } + + msg (D_HANDSHAKE, "VERIFY OK: depth=%d, %s", ctx->error_depth, subject); + + session->verified = true; + return 1; /* Accept connection */ + + err: + ERR_clear_error (); + return 0; /* Reject connection */ +} + +void +tls_set_common_name (struct tls_multi *multi, const char *common_name) +{ + if (multi) + set_common_name (&multi->session[TM_ACTIVE], common_name); +} + +const char * +tls_common_name (struct tls_multi *multi, bool null) +{ + const char *ret = NULL; + if (multi) + ret = multi->session[TM_ACTIVE].common_name; + if (ret && strlen (ret)) + return ret; + else if (null) + return NULL; + else + return "UNDEF"; +} + +void +tls_lock_common_name (struct tls_multi *multi) +{ + const char *cn = multi->session[TM_ACTIVE].common_name; + if (cn && !multi->locked_cn) + multi->locked_cn = string_alloc (cn, NULL); +} + +/* + * Return true if at least one valid key state exists + * which has passed authentication. If we are using + * username/password authentication, and the authentication + * failed, we may have a live S_ACTIVE/S_NORMAL key state + * even though the 'authenticated' var might be false. + * + * This is so that we can return an AUTH_FAILED error + * message to the client over the TLS channel. + * + * If 'authenticated' is false, tunnel traffic forwarding + * is disabled but TLS channel data can still be sent + * or received. + */ +bool +tls_authenticated (struct tls_multi *multi) +{ + if (multi) + { + int i; + for (i = 0; i < KEY_SCAN_SIZE; ++i) + { + const struct key_state *ks = multi->key_scan[i]; + if (DECRYPT_KEY_ENABLED (multi, ks) && ks->authenticated) + return true; + } + } + return false; +} + +void +tls_deauthenticate (struct tls_multi *multi) +{ + if (multi) + { + int i, j; + for (i = 0; i < TM_SIZE; ++i) + for (j = 0; j < KS_SIZE; ++j) + multi->session[i].key[j].authenticated = false; + } +} + +/* + * Print debugging information on SSL/TLS session negotiation. + */ +static void +info_callback (INFO_CALLBACK_SSL_CONST SSL * s, int where, int ret) +{ + if (where & SSL_CB_LOOP) + { + dmsg (D_HANDSHAKE_VERBOSE, "SSL state (%s): %s", + where & SSL_ST_CONNECT ? "connect" : + where & SSL_ST_ACCEPT ? "accept" : + "undefined", SSL_state_string_long (s)); + } + else if (where & SSL_CB_ALERT) + { + dmsg (D_HANDSHAKE_VERBOSE, "SSL alert (%s): %s: %s", + where & SSL_CB_READ ? "read" : "write", + SSL_alert_type_string_long (ret), + SSL_alert_desc_string_long (ret)); + } +} + +/* + * Initialize SSL context. + * All files are in PEM format. + */ +SSL_CTX * +init_ssl (const struct options *options) +{ + SSL_CTX *ctx = NULL; + DH *dh; + BIO *bio; + bool using_cert_file = false; + + ERR_clear_error (); + + if (options->tls_server) + { + ctx = SSL_CTX_new (TLSv1_server_method ()); + if (ctx == NULL) + msg (M_SSLERR, "SSL_CTX_new TLSv1_server_method"); + + SSL_CTX_set_tmp_rsa_callback (ctx, tmp_rsa_cb); + + /* Get Diffie Hellman Parameters */ + if (!(bio = BIO_new_file (options->dh_file, "r"))) + msg (M_SSLERR, "Cannot open %s for DH parameters", options->dh_file); + dh = PEM_read_bio_DHparams (bio, NULL, NULL, NULL); + BIO_free (bio); + if (!dh) + msg (M_SSLERR, "Cannot load DH parameters from %s", options->dh_file); + if (!SSL_CTX_set_tmp_dh (ctx, dh)) + msg (M_SSLERR, "SSL_CTX_set_tmp_dh"); + msg (D_TLS_DEBUG_LOW, "Diffie-Hellman initialized with %d bit key", + 8 * DH_size (dh)); + DH_free (dh); + } + else /* if client */ + { + ctx = SSL_CTX_new (TLSv1_client_method ()); + if (ctx == NULL) + msg (M_SSLERR, "SSL_CTX_new TLSv1_client_method"); + } + + /* Set SSL options */ + SSL_CTX_set_session_cache_mode (ctx, SSL_SESS_CACHE_OFF); + SSL_CTX_set_options (ctx, SSL_OP_SINGLE_DH_USE); + + /* Set callback for getting password from user to decrypt private key */ + SSL_CTX_set_default_passwd_cb (ctx, pem_password_callback); + + if (options->pkcs12_file) + { + /* Use PKCS #12 file for key, cert and CA certs */ + + FILE *fp; + EVP_PKEY *pkey; + X509 *cert; + STACK_OF(X509) *ca = NULL; + PKCS12 *p12; + int i; + char password[256]; + + /* Load the PKCS #12 file */ + if (!(fp = fopen(options->pkcs12_file, "rb"))) + msg (M_SSLERR, "Error opening file %s", options->pkcs12_file); + p12 = d2i_PKCS12_fp(fp, NULL); + fclose (fp); + if (!p12) msg (M_SSLERR, "Error reading PKCS#12 file %s", options->pkcs12_file); + + /* Parse the PKCS #12 file */ + if (!PKCS12_parse(p12, "", &pkey, &cert, &ca)) + { + pem_password_callback (password, sizeof(password) - 1, 0, NULL); + /* Reparse the PKCS #12 file with password */ + ca = NULL; + if (!PKCS12_parse(p12, password, &pkey, &cert, &ca)) + { + PKCS12_free(p12); + msg (M_WARN|M_SSL, "Error parsing PKCS#12 file %s", options->pkcs12_file); + goto err; + } + } + PKCS12_free(p12); + + /* Load Certificate */ + if (!SSL_CTX_use_certificate (ctx, cert)) + msg (M_SSLERR, "Cannot use certificate"); + + /* Load Private Key */ + if (!SSL_CTX_use_PrivateKey (ctx, pkey)) + msg (M_SSLERR, "Cannot use private key"); + warn_if_group_others_accessible (options->pkcs12_file); + + /* Check Private Key */ + if (!SSL_CTX_check_private_key (ctx)) + msg (M_SSLERR, "Private key does not match the certificate"); + + /* Set Certificate Verification chain */ + if (ca && sk_num(ca)) + { + for (i = 0; i < sk_X509_num(ca); i++) + { + if (!X509_STORE_add_cert(ctx->cert_store,sk_X509_value(ca, i))) + msg (M_SSLERR, "Cannot add certificate to certificate chain (X509_STORE_add_cert)"); + if (!SSL_CTX_add_client_CA(ctx, sk_X509_value(ca, i))) + msg (M_SSLERR, "Cannot add certificate to client CA list (SSL_CTX_add_client_CA)"); + } + } + } + else + { + /* Use seperate PEM files for key, cert and CA certs */ + +#ifdef WIN32 + if (options->cryptoapi_cert) + { + /* Load Certificate and Private Key */ + if (!SSL_CTX_use_CryptoAPI_certificate (ctx, options->cryptoapi_cert)) + msg (M_SSLERR, "Cannot load certificate \"%s\" from Microsoft Certificate Store", + options->cryptoapi_cert); + } + else +#endif + { + /* Load Certificate */ + if (options->cert_file) + { + using_cert_file = true; + if (!SSL_CTX_use_certificate_file (ctx, options->cert_file, SSL_FILETYPE_PEM)) + msg (M_SSLERR, "Cannot load certificate file %s", options->cert_file); + } + + /* Load Private Key */ + if (options->priv_key_file) + { + if (!SSL_CTX_use_PrivateKey_file (ctx, options->priv_key_file, SSL_FILETYPE_PEM)) + { +#ifdef ENABLE_MANAGEMENT + if (management && (ERR_GET_REASON (ERR_peek_error()) == EVP_R_BAD_DECRYPT)) + management_auth_failure (management, UP_TYPE_PRIVATE_KEY); +#endif + msg (M_WARN|M_SSL, "Cannot load private key file %s", options->priv_key_file); + goto err; + } + warn_if_group_others_accessible (options->priv_key_file); + + /* Check Private Key */ + if (!SSL_CTX_check_private_key (ctx)) + msg (M_SSLERR, "Private key does not match the certificate"); + } + } + + /* Load CA file for verifying peer supplied certificate */ + ASSERT (options->ca_file); + if (!SSL_CTX_load_verify_locations (ctx, options->ca_file, NULL)) + msg (M_SSLERR, "Cannot load CA certificate file %s (SSL_CTX_load_verify_locations)", options->ca_file); + + /* Load names of CAs from file and use it as a client CA list */ + { + STACK_OF(X509_NAME) *cert_names; + cert_names = SSL_load_client_CA_file (options->ca_file); + if (!cert_names) + msg (M_SSLERR, "Cannot load CA certificate file %s (SSL_load_client_CA_file)", options->ca_file); + SSL_CTX_set_client_CA_list (ctx, cert_names); + } + + } + + /* Enable the use of certificate chains */ + if (using_cert_file) + { + if (!SSL_CTX_use_certificate_chain_file (ctx, options->cert_file)) + msg (M_SSLERR, "Cannot load certificate chain file %s (SSL_use_certificate_chain_file)", options->cert_file); + } + + /* Require peer certificate verification */ +#if P2MP_SERVER + if (options->client_cert_not_required) + { + msg (M_WARN, "WARNING: This configuration may accept clients which do not present a certificate"); + } + else +#endif + SSL_CTX_set_verify (ctx, SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT, + verify_callback); + + /* Connection information callback */ + SSL_CTX_set_info_callback (ctx, info_callback); + + /* Allowable ciphers */ + if (options->cipher_list) + { + if (!SSL_CTX_set_cipher_list (ctx, options->cipher_list)) + msg (M_SSLERR, "Problem with cipher list: %s", options->cipher_list); + } + + ERR_clear_error (); + + return ctx; + + err: + ERR_clear_error (); + if (ctx) + SSL_CTX_free (ctx); + return NULL; +} + +/* + * Print a one line summary of SSL/TLS session handshake. + */ +static void +print_details (SSL * c_ssl, const char *prefix) +{ + SSL_CIPHER *ciph; + X509 *cert; + char s1[256]; + char s2[256]; + + s1[0] = s2[0] = 0; + ciph = SSL_get_current_cipher (c_ssl); + openvpn_snprintf (s1, sizeof (s1), "%s %s, cipher %s %s", + prefix, + SSL_get_version (c_ssl), + SSL_CIPHER_get_version (ciph), + SSL_CIPHER_get_name (ciph)); + cert = SSL_get_peer_certificate (c_ssl); + if (cert != NULL) + { + EVP_PKEY *pkey = X509_get_pubkey (cert); + if (pkey != NULL) + { + if (pkey->type == EVP_PKEY_RSA && pkey->pkey.rsa != NULL + && pkey->pkey.rsa->n != NULL) + { + openvpn_snprintf (s2, sizeof (s2), ", %d bit RSA", + BN_num_bits (pkey->pkey.rsa->n)); + } + else if (pkey->type == EVP_PKEY_DSA && pkey->pkey.dsa != NULL + && pkey->pkey.dsa->p != NULL) + { + openvpn_snprintf (s2, sizeof (s2), ", %d bit DSA", + BN_num_bits (pkey->pkey.dsa->p)); + } + EVP_PKEY_free (pkey); + } + X509_free (cert); + } + /* The SSL API does not allow us to look at temporary RSA/DH keys, + * otherwise we should print their lengths too */ + msg (D_HANDSHAKE, "%s%s", s1, s2); +} + +/* + * Show the TLS ciphers that are available for us to use + * in the OpenSSL library. + */ +void +show_available_tls_ciphers () +{ + SSL_CTX *ctx; + SSL *ssl; + const char *cipher_name; + int priority = 0; + + ctx = SSL_CTX_new (TLSv1_method ()); + if (!ctx) + msg (M_SSLERR, "Cannot create SSL_CTX object"); + ssl = SSL_new (ctx); + if (!ssl) + msg (M_SSLERR, "Cannot create SSL object"); + + printf ("Available TLS Ciphers,\n"); + printf ("listed in order of preference:\n\n"); + while ((cipher_name = SSL_get_cipher_list (ssl, priority++))) + printf ("%s\n", cipher_name); + printf ("\n"); + + SSL_free (ssl); + SSL_CTX_free (ctx); +} + +/* + * The OpenSSL library has a notion of preference in TLS + * ciphers. Higher preference == more secure. + * Return the highest preference cipher. + */ +void +get_highest_preference_tls_cipher (char *buf, int size) +{ + SSL_CTX *ctx; + SSL *ssl; + const char *cipher_name; + + ctx = SSL_CTX_new (TLSv1_method ()); + if (!ctx) + msg (M_SSLERR, "Cannot create SSL_CTX object"); + ssl = SSL_new (ctx); + if (!ssl) + msg (M_SSLERR, "Cannot create SSL object"); + + cipher_name = SSL_get_cipher_list (ssl, 0); + strncpynt (buf, cipher_name, size); + + SSL_free (ssl); + SSL_CTX_free (ctx); +} + +/* + * Map internal constants to ascii names. + */ +static const char * +state_name (int state) +{ + switch (state) + { + case S_UNDEF: + return "S_UNDEF"; + case S_INITIAL: + return "S_INITIAL"; + case S_PRE_START: + return "S_PRE_START"; + case S_START: + return "S_START"; + case S_SENT_KEY: + return "S_SENT_KEY"; + case S_GOT_KEY: + return "S_GOT_KEY"; + case S_ACTIVE: + return "S_ACTIVE"; + case S_NORMAL: + return "S_NORMAL"; + case S_ERROR: + return "S_ERROR"; + default: + return "S_???"; + } +} + +static const char * +packet_opcode_name (int op) +{ + switch (op) + { + case P_CONTROL_HARD_RESET_CLIENT_V1: + return "P_CONTROL_HARD_RESET_CLIENT_V1"; + case P_CONTROL_HARD_RESET_SERVER_V1: + return "P_CONTROL_HARD_RESET_SERVER_V1"; + case P_CONTROL_HARD_RESET_CLIENT_V2: + return "P_CONTROL_HARD_RESET_CLIENT_V2"; + case P_CONTROL_HARD_RESET_SERVER_V2: + return "P_CONTROL_HARD_RESET_SERVER_V2"; + case P_CONTROL_SOFT_RESET_V1: + return "P_CONTROL_SOFT_RESET_V1"; + case P_CONTROL_V1: + return "P_CONTROL_V1"; + case P_ACK_V1: + return "P_ACK_V1"; + case P_DATA_V1: + return "P_DATA_V1"; + default: + return "P_???"; + } +} + +static const char * +session_index_name (int index) +{ + switch (index) + { + case TM_ACTIVE: + return "TM_ACTIVE"; + case TM_UNTRUSTED: + return "TM_UNTRUSTED"; + case TM_LAME_DUCK: + return "TM_LAME_DUCK"; + default: + return "TM_???"; + } +} + +/* + * For debugging. + */ +static const char * +print_key_id (struct tls_multi *multi, struct gc_arena *gc) +{ + int i; + struct buffer out = alloc_buf_gc (256, gc); + + for (i = 0; i < KEY_SCAN_SIZE; ++i) + { + struct key_state *ks = multi->key_scan[i]; + buf_printf (&out, " [key#%d state=%s id=%d sid=%s]", i, + state_name (ks->state), ks->key_id, + session_id_print (&ks->session_id_remote, gc)); + } + + return BSTR (&out); +} + +/* + * Given a key_method, return true if op + * represents the required form of hard_reset. + * + * If key_method = 0, return true if any + * form of hard reset is used. + */ +static bool +is_hard_reset (int op, int key_method) +{ + if (!key_method || key_method == 1) + if (op == P_CONTROL_HARD_RESET_CLIENT_V1 || op == P_CONTROL_HARD_RESET_SERVER_V1) + return true; + + if (!key_method || key_method >= 2) + if (op == P_CONTROL_HARD_RESET_CLIENT_V2 || op == P_CONTROL_HARD_RESET_SERVER_V2) + return true; + + return false; +} + +/* + * OpenVPN's interface to SSL/TLS authentication, + * encryption, and decryption is exclusively + * through "memory BIOs". + */ +static BIO * +getbio (BIO_METHOD * type, const char *desc) +{ + BIO *ret; + ret = BIO_new (type); + if (!ret) + msg (M_SSLERR, "Error creating %s BIO", desc); + return ret; +} + +/* + * Write to an OpenSSL BIO in non-blocking mode. + */ +static int +bio_write (struct tls_multi* multi, BIO *bio, const uint8_t *data, int size, const char *desc) +{ + int i; + int ret = 0; + ASSERT (size >= 0); + if (size) + { + /* + * Free the L_TLS lock prior to calling BIO routines + * so that foreground thread can still call + * tls_pre_decrypt or tls_pre_encrypt, + * allowing tunnel packet forwarding to continue. + */ +#ifdef BIO_DEBUG + bio_debug_data ("write", bio, data, size, desc); +#endif + i = BIO_write (bio, data, size); + + if (i < 0) + { + if (BIO_should_retry (bio)) + { + ; + } + else + { + msg (D_TLS_ERRORS | M_SSL, "TLS ERROR: BIO write %s error", + desc); + ret = -1; + ERR_clear_error (); + } + } + else if (i != size) + { + msg (D_TLS_ERRORS | M_SSL, + "TLS ERROR: BIO write %s incomplete %d/%d", desc, i, size); + ret = -1; + ERR_clear_error (); + } + else + { /* successful write */ + dmsg (D_HANDSHAKE_VERBOSE, "BIO write %s %d bytes", desc, i); + ret = 1; + } + } + return ret; +} + +/* + * Read from an OpenSSL BIO in non-blocking mode. + */ +static int +bio_read (struct tls_multi* multi, BIO *bio, struct buffer *buf, int maxlen, const char *desc) +{ + int i; + int ret = 0; + ASSERT (buf->len >= 0); + if (buf->len) + { + ; + } + else + { + int len = buf_forward_capacity (buf); + if (maxlen < len) + len = maxlen; + + /* + * BIO_read brackets most of the serious RSA + * key negotiation number crunching. + */ + i = BIO_read (bio, BPTR (buf), len); + + VALGRIND_MAKE_READABLE ((void *) &i, sizeof (i)); + +#ifdef BIO_DEBUG + bio_debug_data ("read", bio, BPTR (buf), i, desc); +#endif + if (i < 0) + { + if (BIO_should_retry (bio)) + { + ; + } + else + { + msg (D_TLS_ERRORS | M_SSL, "TLS_ERROR: BIO read %s error", + desc); + buf->len = 0; + ret = -1; + ERR_clear_error (); + } + } + else if (!i) + { + buf->len = 0; + } + else + { /* successful read */ + dmsg (D_HANDSHAKE_VERBOSE, "BIO read %s %d bytes", desc, i); + buf->len = i; + ret = 1; + VALGRIND_MAKE_READABLE ((void *) BPTR (buf), BLEN (buf)); + } + } + return ret; +} + +/* + * Inline functions for reading from and writing + * to BIOs. + */ + +static void +bio_write_post (const int status, struct buffer *buf) +{ + if (status == 1) /* success status return from bio_write? */ + { + memset (BPTR (buf), 0, BLEN (buf)); /* erase data just written */ + buf->len = 0; + } +} + +static int +key_state_write_plaintext (struct tls_multi *multi, struct key_state *ks, struct buffer *buf) +{ + int ret; + perf_push (PERF_BIO_WRITE_PLAINTEXT); + ret = bio_write (multi, ks->ssl_bio, BPTR(buf), BLEN(buf), "tls_write_plaintext"); + bio_write_post (ret, buf); + perf_pop (); + return ret; +} + +static int +key_state_write_plaintext_const (struct tls_multi *multi, struct key_state *ks, const uint8_t *data, int len) +{ + int ret; + perf_push (PERF_BIO_WRITE_PLAINTEXT); + ret = bio_write (multi, ks->ssl_bio, data, len, "tls_write_plaintext_const"); + perf_pop (); + return ret; +} + +static int +key_state_write_ciphertext (struct tls_multi *multi, struct key_state *ks, struct buffer *buf) +{ + int ret; + perf_push (PERF_BIO_WRITE_CIPHERTEXT); + ret = bio_write (multi, ks->ct_in, BPTR(buf), BLEN(buf), "tls_write_ciphertext"); + bio_write_post (ret, buf); + perf_pop (); + return ret; +} + +static int +key_state_read_plaintext (struct tls_multi *multi, struct key_state *ks, struct buffer *buf, + int maxlen) +{ + int ret; + perf_push (PERF_BIO_READ_PLAINTEXT); + ret = bio_read (multi, ks->ssl_bio, buf, maxlen, "tls_read_plaintext"); + perf_pop (); + return ret; +} + +static int +key_state_read_ciphertext (struct tls_multi *multi, struct key_state *ks, struct buffer *buf, + int maxlen) +{ + int ret; + perf_push (PERF_BIO_READ_CIPHERTEXT); + ret = bio_read (multi, ks->ct_out, buf, maxlen, "tls_read_ciphertext"); + perf_pop (); + return ret; +} + +/* + * Initialize a key_state. Each key_state corresponds to + * a specific SSL/TLS session. + */ +static void +key_state_init (struct tls_session *session, struct key_state *ks) +{ + update_time (); + + /* + * Build TLS object that reads/writes ciphertext + * to/from memory BIOs. + */ + CLEAR (*ks); + + ks->ssl = SSL_new (session->opt->ssl_ctx); + if (!ks->ssl) + msg (M_SSLERR, "SSL_new failed"); + + /* put session * in ssl object so we can access it + from verify callback*/ + SSL_set_ex_data (ks->ssl, mydata_index, session); + + ks->ssl_bio = getbio (BIO_f_ssl (), "ssl_bio"); + ks->ct_in = getbio (BIO_s_mem (), "ct_in"); + ks->ct_out = getbio (BIO_s_mem (), "ct_out"); + +#ifdef BIO_DEBUG + bio_debug_oc ("open ssl_bio", ks->ssl_bio); + bio_debug_oc ("open ct_in", ks->ct_in); + bio_debug_oc ("open ct_out", ks->ct_out); +#endif + + if (session->opt->server) + SSL_set_accept_state (ks->ssl); + else + SSL_set_connect_state (ks->ssl); + + SSL_set_bio (ks->ssl, ks->ct_in, ks->ct_out); + BIO_set_ssl (ks->ssl_bio, ks->ssl, BIO_NOCLOSE); + + /* Set control-channel initiation mode */ + ks->initial_opcode = session->initial_opcode; + session->initial_opcode = P_CONTROL_SOFT_RESET_V1; + ks->state = S_INITIAL; + ks->key_id = session->key_id; + + /* + * key_id increments to KEY_ID_MASK then recycles back to 1. + * This way you know that if key_id is 0, it is the first key. + */ + ++session->key_id; + session->key_id &= P_KEY_ID_MASK; + if (!session->key_id) + session->key_id = 1; + + /* allocate key source material object */ + ALLOC_OBJ_CLEAR (ks->key_src, struct key_source2); + + /* allocate reliability objects */ + ALLOC_OBJ_CLEAR (ks->send_reliable, struct reliable); + ALLOC_OBJ_CLEAR (ks->rec_reliable, struct reliable); + ALLOC_OBJ_CLEAR (ks->rec_ack, struct reliable_ack); + + /* allocate buffers */ + ks->plaintext_read_buf = alloc_buf (PLAINTEXT_BUFFER_SIZE); + ks->plaintext_write_buf = alloc_buf (PLAINTEXT_BUFFER_SIZE); + ks->ack_write_buf = alloc_buf (BUF_SIZE (&session->opt->frame)); + reliable_init (ks->send_reliable, BUF_SIZE (&session->opt->frame), + FRAME_HEADROOM (&session->opt->frame), TLS_RELIABLE_N_SEND_BUFFERS); + reliable_init (ks->rec_reliable, BUF_SIZE (&session->opt->frame), + FRAME_HEADROOM (&session->opt->frame), TLS_RELIABLE_N_REC_BUFFERS); + reliable_set_timeout (ks->send_reliable, session->opt->packet_timeout); + + /* init packet ID tracker */ + packet_id_init (&ks->packet_id, + session->opt->replay_window, + session->opt->replay_time); +} + +static void +key_state_free (struct key_state *ks, bool clear) +{ + ks->state = S_UNDEF; + + if (ks->ssl) { +#ifdef BIO_DEBUG + bio_debug_oc ("close ssl_bio", ks->ssl_bio); + bio_debug_oc ("close ct_in", ks->ct_in); + bio_debug_oc ("close ct_out", ks->ct_out); +#endif + BIO_free_all(ks->ssl_bio); + SSL_free (ks->ssl); + } + + free_key_ctx_bi (&ks->key); + free_buf (&ks->plaintext_read_buf); + free_buf (&ks->plaintext_write_buf); + free_buf (&ks->ack_write_buf); + + if (ks->send_reliable) + { + reliable_free (ks->send_reliable); + free (ks->send_reliable); + } + + if (ks->rec_reliable) + { + reliable_free (ks->rec_reliable); + free (ks->rec_reliable); + } + + if (ks->rec_ack) + free (ks->rec_ack); + + if (ks->key_src) + free (ks->key_src); + + packet_id_free (&ks->packet_id); + + if (clear) + CLEAR (*ks); +} + +/* + * Must be called if we move a tls_session in memory. + */ +static inline void tls_session_set_self_referential_pointers (struct tls_session* session) { + session->tls_auth.packet_id = &session->tls_auth_pid; +} + +/* + * Initialize a TLS session. A TLS session normally has 2 key_state objects, + * one for the current key, and one for the lame duck (i.e. retiring) key. + */ +static void +tls_session_init (struct tls_multi *multi, struct tls_session *session) +{ + struct gc_arena gc = gc_new (); + + dmsg (D_TLS_DEBUG, "TLS: tls_session_init: entry"); + + CLEAR (*session); + + /* Set options data to point to parent's option structure */ + session->opt = &multi->opt; + + /* Randomize session # if it is 0 */ + while (!session_id_defined(&session->session_id)) + session_id_random (&session->session_id); + + /* Are we a TLS server or client? */ + ASSERT (session->opt->key_method >= 1); + if (session->opt->key_method == 1) + { + session->initial_opcode = session->opt->server ? + P_CONTROL_HARD_RESET_SERVER_V1 : P_CONTROL_HARD_RESET_CLIENT_V1; + } + else /* session->opt->key_method >= 2 */ + { + session->initial_opcode = session->opt->server ? + P_CONTROL_HARD_RESET_SERVER_V2 : P_CONTROL_HARD_RESET_CLIENT_V2; + } + + /* Initialize control channel authentication parameters */ + session->tls_auth = session->opt->tls_auth; + + /* Set session internal pointers (also called if session object is moved in memory) */ + tls_session_set_self_referential_pointers (session); + + /* initialize packet ID replay window for --tls-auth */ + packet_id_init (session->tls_auth.packet_id, + session->opt->replay_window, + session->opt->replay_time); + + /* load most recent packet-id to replay protect on --tls-auth */ + packet_id_persist_load_obj (session->tls_auth.pid_persist, session->tls_auth.packet_id); + + key_state_init (session, &session->key[KS_PRIMARY]); + + dmsg (D_TLS_DEBUG, "TLS: tls_session_init: new session object, sid=%s", + session_id_print (&session->session_id, &gc)); + + gc_free (&gc); +} + +static void +tls_session_free (struct tls_session *session, bool clear) +{ + int i; + + if (session->tls_auth.packet_id) + packet_id_free (session->tls_auth.packet_id); + + for (i = 0; i < KS_SIZE; ++i) + key_state_free (&session->key[i], false); + + if (session->common_name) + free (session->common_name); + + if (clear) + CLEAR (*session); +} + +static void +move_session (struct tls_multi* multi, int dest, int src, bool reinit_src) +{ + msg (D_TLS_DEBUG_LOW, "TLS: move_session: dest=%s src=%s reinit_src=%d", + session_index_name(dest), + session_index_name(src), + reinit_src); + ASSERT (src != dest); + ASSERT (src >= 0 && src < TM_SIZE); + ASSERT (dest >= 0 && dest < TM_SIZE); + tls_session_free (&multi->session[dest], false); + multi->session[dest] = multi->session[src]; + tls_session_set_self_referential_pointers (&multi->session[dest]); + + if (reinit_src) + tls_session_init (multi, &multi->session[src]); + else + CLEAR (multi->session[src]); + + dmsg (D_TLS_DEBUG, "TLS: move_session: exit"); +} + +static void +reset_session (struct tls_multi *multi, struct tls_session *session) +{ + tls_session_free (session, false); + tls_session_init (multi, session); +} + +#if 0 +/* + * Transmit a TLS reset on our untrusted channel. + */ +static void +initiate_untrusted_session (struct tls_multi *multi, struct sockaddr_in *to) +{ + struct tls_session *session = &multi->session[TM_UNTRUSTED]; + struct key_state *ks = &session->key[KS_PRIMARY]; + + reset_session (multi, session); + ks->remote_addr = *to; + msg (D_TLS_DEBUG_LOW, "TLS: initiate_untrusted_session: addr=%s", print_sockaddr (to)); +} +#endif + +/* + * Used to determine in how many seconds we should be + * called again. + */ +static inline void +compute_earliest_wakeup (interval_t *earliest, interval_t seconds_from_now) { + if (seconds_from_now < *earliest) + *earliest = seconds_from_now; + if (*earliest < 0) + *earliest = 0; +} + +/* + * Return true if "lame duck" or retiring key has expired and can + * no longer be used. + */ +static inline bool +lame_duck_must_die (const struct tls_session* session, interval_t *wakeup) +{ + const struct key_state* lame = &session->key[KS_LAME_DUCK]; + if (lame->state >= S_INITIAL) + { + const time_t local_now = now; + ASSERT (lame->must_die); /* a lame duck key must always have an expiration */ + if (local_now < lame->must_die) + { + compute_earliest_wakeup (wakeup, lame->must_die - local_now); + return false; + } + else + return true; + } + else if (lame->state == S_ERROR) + return true; + else + return false; +} + +/* + * A tls_multi object fully encapsulates OpenVPN's TLS state. + * See ssl.h for more comments. + */ +struct tls_multi * +tls_multi_init (struct tls_options *tls_options) +{ + struct tls_multi *ret; + + ALLOC_OBJ_CLEAR (ret, struct tls_multi); + + /* get command line derived options */ + ret->opt = *tls_options; + + /* set up pointer to HMAC object for TLS packet authentication */ + ret->opt.tls_auth.key_ctx_bi = &ret->opt.tls_auth_key; + + /* set up list of keys to be scanned by data channel encrypt and decrypt routines */ + ASSERT (SIZE (ret->key_scan) == 3); + ret->key_scan[0] = &ret->session[TM_ACTIVE].key[KS_PRIMARY]; + ret->key_scan[1] = &ret->session[TM_ACTIVE].key[KS_LAME_DUCK]; + ret->key_scan[2] = &ret->session[TM_LAME_DUCK].key[KS_LAME_DUCK]; + + return ret; +} + +/* + * Finalize our computation of frame sizes. + */ +void +tls_multi_init_finalize (struct tls_multi* multi, const struct frame* frame) +{ + tls_init_control_channel_frame_parameters (frame, &multi->opt.frame); + + /* initialize the active and untrusted sessions */ + + tls_session_init (multi, &multi->session[TM_ACTIVE]); + + if (!multi->opt.single_session) + tls_session_init (multi, &multi->session[TM_UNTRUSTED]); +} + +/* + * Initialize and finalize a standalone tls-auth verification object. + */ + +struct tls_auth_standalone * +tls_auth_standalone_init (struct tls_options *tls_options, + struct gc_arena *gc) +{ + struct tls_auth_standalone *tas; + + ALLOC_OBJ_CLEAR_GC (tas, struct tls_auth_standalone, gc); + + /* set up pointer to HMAC object for TLS packet authentication */ + tas->tls_auth_key = tls_options->tls_auth_key; + tas->tls_auth_options.key_ctx_bi = &tas->tls_auth_key; + tas->tls_auth_options.flags |= CO_PACKET_ID_LONG_FORM; + + /* get initial frame parms, still need to finalize */ + tas->frame = tls_options->frame; + + return tas; +} + +void +tls_auth_standalone_finalize (struct tls_auth_standalone *tas, + const struct frame *frame) +{ + tls_init_control_channel_frame_parameters (frame, &tas->frame); +} + +/* + * Set local and remote option compatibility strings. + * Used to verify compatibility of local and remote option + * sets. + */ +void +tls_multi_init_set_options (struct tls_multi* multi, + const char *local, + const char *remote) +{ +#ifdef ENABLE_OCC + /* initialize options string */ + multi->opt.local_options = local; + multi->opt.remote_options = remote; +#endif +} + +void +tls_multi_free (struct tls_multi *multi, bool clear) +{ + int i; + + ASSERT (multi); + + if (multi->locked_cn) + free (multi->locked_cn); + + for (i = 0; i < TM_SIZE; ++i) + tls_session_free (&multi->session[i], false); + + if (clear) + CLEAR (*multi); + + free(multi); +} + +/* + * Move a packet authentication HMAC + related fields to or from the front + * of the buffer so it can be processed by encrypt/decrypt. + */ + +/* + * Dependent on hmac size, opcode size, and session_id size. + * Will assert if too small. + */ +#define SWAP_BUF_SIZE 256 + +static bool +swap_hmac (struct buffer *buf, const struct crypto_options *co, bool incoming) +{ + struct key_ctx *ctx; + + ASSERT (co); + + ctx = (incoming ? &co->key_ctx_bi->decrypt : &co->key_ctx_bi->encrypt); + ASSERT (ctx->hmac); + + { + /* hmac + packet_id (8 bytes) */ + const int hmac_size = HMAC_size (ctx->hmac) + packet_id_size (true); + + /* opcode + session_id */ + const int osid_size = 1 + SID_SIZE; + + int e1, e2; + uint8_t *b = BPTR (buf); + uint8_t buf1[SWAP_BUF_SIZE]; + uint8_t buf2[SWAP_BUF_SIZE]; + + if (incoming) + { + e1 = osid_size; + e2 = hmac_size; + } + else + { + e1 = hmac_size; + e2 = osid_size; + } + + ASSERT (e1 <= SWAP_BUF_SIZE && e2 <= SWAP_BUF_SIZE); + + if (buf->len >= e1 + e2) + { + memcpy (buf1, b, e1); + memcpy (buf2, b + e1, e2); + memcpy (b, buf2, e2); + memcpy (b + e2, buf1, e1); + return true; + } + else + return false; + } +} + +#undef SWAP_BUF_SIZE + +/* + * Write a control channel authentication record. + */ +static void +write_control_auth (struct tls_session *session, + struct key_state *ks, + struct buffer *buf, + struct sockaddr_in *to_link_addr, + int opcode, + int max_ack, + bool prepend_ack) +{ + uint8_t *header; + struct buffer null = clear_buf (); + + ASSERT (addr_defined (&ks->remote_addr)); + ASSERT (reliable_ack_write + (ks->rec_ack, buf, &ks->session_id_remote, max_ack, prepend_ack)); + ASSERT (session_id_write_prepend (&session->session_id, buf)); + ASSERT (header = buf_prepend (buf, 1)); + *header = ks->key_id | (opcode << P_OPCODE_SHIFT); + if (session->tls_auth.key_ctx_bi->encrypt.hmac) + { + /* no encryption, only write hmac */ + openvpn_encrypt (buf, null, &session->tls_auth, NULL); + ASSERT (swap_hmac (buf, &session->tls_auth, false)); + } + *to_link_addr = ks->remote_addr; +} + +/* + * Read a control channel authentication record. + */ +static bool +read_control_auth (struct buffer *buf, + const struct crypto_options *co, + const struct sockaddr_in *from) +{ + struct gc_arena gc = gc_new (); + + if (co->key_ctx_bi->decrypt.hmac) + { + struct buffer null = clear_buf (); + + /* move the hmac record to the front of the packet */ + if (!swap_hmac (buf, co, true)) + { + msg (D_TLS_ERRORS, + "TLS Error: cannot locate HMAC in incoming packet from %s", + print_sockaddr (from, &gc)); + gc_free (&gc); + return false; + } + + /* authenticate only (no decrypt) and remove the hmac record + from the head of the buffer */ + openvpn_decrypt (buf, null, co, NULL); + if (!buf->len) + { + msg (D_TLS_ERRORS, + "TLS Error: incoming packet authentication failed from %s", + print_sockaddr (from, &gc)); + gc_free (&gc); + return false; + } + + } + + /* advance buffer pointer past opcode & session_id since our caller + already read it */ + buf_advance (buf, SID_SIZE + 1); + + gc_free (&gc); + return true; +} + +/* + * For debugging, print contents of key_source2 structure. + */ + +static void +key_source_print (const struct key_source *k, + const char *prefix) +{ + struct gc_arena gc = gc_new (); + + VALGRIND_MAKE_READABLE ((void *)k->pre_master, sizeof (k->pre_master)); + VALGRIND_MAKE_READABLE ((void *)k->random1, sizeof (k->random1)); + VALGRIND_MAKE_READABLE ((void *)k->random2, sizeof (k->random2)); + + dmsg (D_SHOW_KEY_SOURCE, + "%s pre_master: %s", + prefix, + format_hex (k->pre_master, sizeof (k->pre_master), 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, + "%s random1: %s", + prefix, + format_hex (k->random1, sizeof (k->random1), 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, + "%s random2: %s", + prefix, + format_hex (k->random2, sizeof (k->random2), 0, &gc)); + + gc_free (&gc); +} + +static void +key_source2_print (const struct key_source2 *k) +{ + key_source_print (&k->client, "Client"); + key_source_print (&k->server, "Server"); +} + +/* + * Use the TLS PRF function for generating data channel keys. + * This code is taken from the OpenSSL library. + * + * TLS generates keys as such: + * + * master_secret[48] = PRF(pre_master_secret[48], "master secret", + * ClientHello.random[32] + ServerHello.random[32]) + * + * key_block[] = PRF(SecurityParameters.master_secret[48], + * "key expansion", + * SecurityParameters.server_random[32] + + * SecurityParameters.client_random[32]); + * + * Notes: + * + * (1) key_block contains a full set of 4 keys. + * (2) The pre-master secret is generated by the client. + */ + +static void +tls1_P_hash(const EVP_MD *md, + const uint8_t *sec, + int sec_len, + const uint8_t *seed, + int seed_len, + uint8_t *out, + int olen) +{ + struct gc_arena gc = gc_new (); + int chunk,n; + unsigned int j; + HMAC_CTX ctx; + HMAC_CTX ctx_tmp; + uint8_t A1[EVP_MAX_MD_SIZE]; + unsigned int A1_len; + +#ifdef ENABLE_DEBUG + const int olen_orig = olen; + const uint8_t *out_orig = out; +#endif + + dmsg (D_SHOW_KEY_SOURCE, "tls1_P_hash sec: %s", format_hex (sec, sec_len, 0, &gc)); + dmsg (D_SHOW_KEY_SOURCE, "tls1_P_hash seed: %s", format_hex (seed, seed_len, 0, &gc)); + + chunk=EVP_MD_size(md); + + HMAC_CTX_init(&ctx); + HMAC_CTX_init(&ctx_tmp); + HMAC_Init_ex(&ctx,sec,sec_len,md, NULL); + HMAC_Init_ex(&ctx_tmp,sec,sec_len,md, NULL); + HMAC_Update(&ctx,seed,seed_len); + HMAC_Final(&ctx,A1,&A1_len); + + n=0; + for (;;) + { + HMAC_Init_ex(&ctx,NULL,0,NULL,NULL); /* re-init */ + HMAC_Init_ex(&ctx_tmp,NULL,0,NULL,NULL); /* re-init */ + HMAC_Update(&ctx,A1,A1_len); + HMAC_Update(&ctx_tmp,A1,A1_len); + HMAC_Update(&ctx,seed,seed_len); + + if (olen > chunk) + { + HMAC_Final(&ctx,out,&j); + out+=j; + olen-=j; + HMAC_Final(&ctx_tmp,A1,&A1_len); /* calc the next A1 value */ + } + else /* last one */ + { + HMAC_Final(&ctx,A1,&A1_len); + memcpy(out,A1,olen); + break; + } + } + HMAC_CTX_cleanup(&ctx); + HMAC_CTX_cleanup(&ctx_tmp); + CLEAR (A1); + + dmsg (D_SHOW_KEY_SOURCE, "tls1_P_hash out: %s", format_hex (out_orig, olen_orig, 0, &gc)); + gc_free (&gc); +} + +static void +tls1_PRF(uint8_t *label, + int label_len, + const uint8_t *sec, + int slen, + uint8_t *out1, + int olen) +{ + struct gc_arena gc = gc_new (); + const EVP_MD *md5 = EVP_md5(); + const EVP_MD *sha1 = EVP_sha1(); + int len,i; + const uint8_t *S1,*S2; + uint8_t *out2; + + out2 = (uint8_t *) gc_malloc (olen, false, &gc); + + len=slen/2; + S1=sec; + S2= &(sec[len]); + len+=(slen&1); /* add for odd, make longer */ + + + tls1_P_hash(md5 ,S1,len,label,label_len,out1,olen); + tls1_P_hash(sha1,S2,len,label,label_len,out2,olen); + + for (i=0; i<olen; i++) + out1[i]^=out2[i]; + + memset (out2, 0, olen); + + dmsg (D_SHOW_KEY_SOURCE, "tls1_PRF out[%d]: %s", olen, format_hex (out1, olen, 0, &gc)); + + gc_free (&gc); +} + +static void +openvpn_PRF (const uint8_t *secret, + int secret_len, + const char *label, + const uint8_t *client_seed, + int client_seed_len, + const uint8_t *server_seed, + int server_seed_len, + const struct session_id *client_sid, + const struct session_id *server_sid, + uint8_t *output, + int output_len) +{ + /* concatenate seed components */ + + struct buffer seed = alloc_buf (strlen (label) + + client_seed_len + + server_seed_len + + SID_SIZE * 2); + + ASSERT (buf_write (&seed, label, strlen (label))); + ASSERT (buf_write (&seed, client_seed, client_seed_len)); + ASSERT (buf_write (&seed, server_seed, server_seed_len)); + + if (client_sid) + ASSERT (buf_write (&seed, client_sid->id, SID_SIZE)); + if (server_sid) + ASSERT (buf_write (&seed, server_sid->id, SID_SIZE)); + + /* compute PRF */ + tls1_PRF (BPTR(&seed), BLEN(&seed), secret, secret_len, output, output_len); + + buf_clear (&seed); + free_buf (&seed); + + VALGRIND_MAKE_READABLE ((void *)output, output_len); +} + +/* + * Using source entropy from local and remote hosts, mix into + * master key. + */ +static bool +generate_key_expansion (struct key_ctx_bi *key, + const struct key_type *key_type, + const struct key_source2 *key_src, + const struct session_id *client_sid, + const struct session_id *server_sid, + bool server) +{ + uint8_t master[48]; + struct key2 key2; + bool ret = false; + int i; + + CLEAR (master); + CLEAR (key2); + + /* debugging print of source key material */ + key_source2_print (key_src); + + /* compute master secret */ + openvpn_PRF (key_src->client.pre_master, + sizeof(key_src->client.pre_master), + KEY_EXPANSION_ID " master secret", + key_src->client.random1, + sizeof(key_src->client.random1), + key_src->server.random1, + sizeof(key_src->server.random1), + NULL, + NULL, + master, + sizeof(master)); + + /* compute key expansion */ + openvpn_PRF (master, + sizeof(master), + KEY_EXPANSION_ID " key expansion", + key_src->client.random2, + sizeof(key_src->client.random2), + key_src->server.random2, + sizeof(key_src->server.random2), + client_sid, + server_sid, + (uint8_t*)key2.keys, + sizeof(key2.keys)); + + key2.n = 2; + + key2_print (&key2, key_type, "Master Encrypt", "Master Decrypt"); + + /* check for weak keys */ + for (i = 0; i < 2; ++i) + { + fixup_key (&key2.keys[i], key_type); + if (!check_key (&key2.keys[i], key_type)) + { + msg (D_TLS_ERRORS, "TLS Error: Bad dynamic key generated"); + goto exit; + } + } + + /* Initialize OpenSSL key contexts */ + + ASSERT (server == true || server == false); + + init_key_ctx (&key->encrypt, + &key2.keys[(int)server], + key_type, + DO_ENCRYPT, + "Data Channel Encrypt"); + + init_key_ctx (&key->decrypt, + &key2.keys[1-(int)server], + key_type, + DO_DECRYPT, + "Data Channel Decrypt"); + + ret = true; + + exit: + CLEAR (master); + CLEAR (key2); + + return ret; +} + +static bool +random_bytes_to_buf (struct buffer *buf, + uint8_t *out, + int outlen) +{ + if (!RAND_bytes (out, outlen)) + msg (M_FATAL, "ERROR: Random number generator cannot obtain entropy for key generation [SSL]"); + if (!buf_write (buf, out, outlen)) + return false; + return true; +} + +static bool +key_source2_randomize_write (struct key_source2 *k2, + struct buffer *buf, + bool server) +{ + struct key_source *k = &k2->client; + if (server) + k = &k2->server; + + CLEAR (*k); + + if (!server) + { + if (!random_bytes_to_buf (buf, k->pre_master, sizeof (k->pre_master))) + return false; + } + + if (!random_bytes_to_buf (buf, k->random1, sizeof (k->random1))) + return false; + if (!random_bytes_to_buf (buf, k->random2, sizeof (k->random2))) + return false; + + return true; +} + +static int +key_source2_read (struct key_source2 *k2, + struct buffer *buf, + bool server) +{ + struct key_source *k = &k2->client; + + if (!server) + k = &k2->server; + + CLEAR (*k); + + if (server) + { + if (!buf_read (buf, k->pre_master, sizeof (k->pre_master))) + return 0; + } + + if (!buf_read (buf, k->random1, sizeof (k->random1))) + return 0; + if (!buf_read (buf, k->random2, sizeof (k->random2))) + return 0; + + return 1; +} + +/* + * Macros for key_state_soft_reset & tls_process + */ +#define ks (&session->key[KS_PRIMARY]) /* primary key */ +#define ks_lame (&session->key[KS_LAME_DUCK]) /* retiring key */ + +/* true if no in/out acknowledgements pending */ +#define FULL_SYNC \ + (reliable_empty(ks->send_reliable) && reliable_ack_empty (ks->rec_ack)) + +/* + * Move the active key to the lame duck key and reinitialize the + * active key. + */ +static void +key_state_soft_reset (struct tls_session *session) +{ + ks->must_die = now + session->opt->transition_window; /* remaining lifetime of old key */ + key_state_free (ks_lame, false); + *ks_lame = *ks; + + key_state_init (session, ks); + ks->session_id_remote = ks_lame->session_id_remote; + ks->remote_addr = ks_lame->remote_addr; +} + +/* + * Read/write strings from/to a struct buffer with a u16 length prefix. + */ + +static bool +write_string (struct buffer *buf, const char *str, const int maxlen) +{ + const int len = strlen (str) + 1; + if (len < 1 || (maxlen >= 0 && len > maxlen)) + return false; + if (!buf_write_u16 (buf, len)) + return false; + if (!buf_write (buf, str, len)) + return false; + return true; +} + +static bool +read_string (struct buffer *buf, char *str, const unsigned int capacity) +{ + const int len = buf_read_u16 (buf); + if (len < 1 || len > (int)capacity) + return false; + if (!buf_read (buf, str, len)) + return false; + str[len-1] = '\0'; + return true; +} + +/* + * Authenticate a client using username/password. + * Runs on server. + * + * If you want to add new authentication methods, + * this is the place to start. + */ + +static bool +verify_user_pass_script (struct tls_session *session, const struct user_pass *up) +{ + struct gc_arena gc = gc_new (); + struct buffer cmd = alloc_buf_gc (256, &gc); + const char *tmp_file = ""; + int retval; + bool ret = false; + + /* Is username defined? */ + if (strlen (up->username)) + { + /* Set environmental variables prior to calling script */ + setenv_str (session->opt->es, "script_type", "user-pass-verify"); + + if (session->opt->auth_user_pass_verify_script_via_file) + { + struct status_output *so; + + tmp_file = create_temp_filename (session->opt->tmp_dir, &gc); + so = status_open (tmp_file, 0, -1, NULL, STATUS_OUTPUT_WRITE); + status_printf (so, "%s", up->username); + status_printf (so, "%s", up->password); + if (!status_close (so)) + { + msg (D_TLS_ERRORS, "TLS Auth Error: could not write username/password to file: %s", + tmp_file); + goto done; + } + } + else + { + setenv_str (session->opt->es, "username", up->username); + setenv_str (session->opt->es, "password", up->password); + } + + /* setenv incoming cert common name for script */ + setenv_str (session->opt->es, "common_name", session->common_name); + + /* setenv client real IP address */ + setenv_untrusted (session); + + /* format command line */ + buf_printf (&cmd, "%s %s", session->opt->auth_user_pass_verify_script, tmp_file); + + /* call command */ + retval = openvpn_system (BSTR (&cmd), session->opt->es, S_SCRIPT); + + /* test return status of command */ + if (system_ok (retval)) + ret = true; + else if (!system_executed (retval)) + msg (D_TLS_ERRORS, "TLS Auth Error: user-pass-verify script failed to execute: %s", BSTR (&cmd)); + + if (!session->opt->auth_user_pass_verify_script_via_file) + setenv_del (session->opt->es, "password"); + } + else + { + msg (D_TLS_ERRORS, "TLS Auth Error: peer provided a blank username"); + } + + done: + if (strlen (tmp_file) > 0) + delete_file (tmp_file); + + gc_free (&gc); + return ret; +} + +static bool +verify_user_pass_plugin (struct tls_session *session, const struct user_pass *up, const char *raw_username) +{ + int retval; + bool ret = false; + + /* Is username defined? */ + if (strlen (up->username)) + { + /* set username/password in private env space */ + setenv_str (session->opt->es, "username", raw_username); + setenv_str (session->opt->es, "password", up->password); + + /* setenv incoming cert common name for script */ + setenv_str (session->opt->es, "common_name", session->common_name); + + /* setenv client real IP address */ + setenv_untrusted (session); + + /* call command */ + retval = plugin_call (session->opt->plugins, OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY, NULL, session->opt->es); + + if (!retval) + ret = true; + + setenv_del (session->opt->es, "password"); + setenv_str (session->opt->es, "username", up->username); + } + else + { + msg (D_TLS_ERRORS, "TLS Auth Error: peer provided a blank username"); + } + + return ret; +} + +/* + * Handle the reading and writing of key data to and from + * the TLS control channel (cleartext). + */ + +static bool +key_method_1_write (struct buffer *buf, struct tls_session *session) +{ + struct key key; + + ASSERT (session->opt->key_method == 1); + ASSERT (buf_init (buf, 0)); + + generate_key_random (&key, &session->opt->key_type); + if (!check_key (&key, &session->opt->key_type)) + { + msg (D_TLS_ERRORS, "TLS Error: Bad encrypting key generated"); + return false; + } + + if (!write_key (&key, &session->opt->key_type, buf)) + { + msg (D_TLS_ERRORS, "TLS Error: write_key failed"); + return false; + } + + init_key_ctx (&ks->key.encrypt, &key, &session->opt->key_type, + DO_ENCRYPT, "Data Channel Encrypt"); + CLEAR (key); + + /* send local options string */ + { + const char *local_options = local_options_string (session); + const int optlen = strlen (local_options) + 1; + if (!buf_write (buf, local_options, optlen)) + { + msg (D_TLS_ERRORS, "TLS Error: KM1 write options failed"); + return false; + } + } + + return true; +} + +static bool +key_method_2_write (struct buffer *buf, struct tls_session *session) +{ + ASSERT (session->opt->key_method == 2); + ASSERT (buf_init (buf, 0)); + + /* write a uint32 0 */ + if (!buf_write_u32 (buf, 0)) + goto error; + + /* write key_method + flags */ + if (!buf_write_u8 (buf, (session->opt->key_method & KEY_METHOD_MASK))) + goto error; + + /* write key source material */ + if (!key_source2_randomize_write (ks->key_src, buf, session->opt->server)) + goto error; + + /* write options string */ + { + if (!write_string (buf, local_options_string (session), TLS_OPTIONS_LEN)) + goto error; + } + + /* write username/password if specified */ + if (auth_user_pass_enabled) + { + auth_user_pass_setup (NULL); + if (!write_string (buf, auth_user_pass.username, -1)) + goto error; + if (!write_string (buf, auth_user_pass.password, -1)) + goto error; + purge_user_pass (&auth_user_pass, false); + } + + /* + * generate tunnel keys if server + */ + if (session->opt->server) + { + if (ks->authenticated) + { + if (!generate_key_expansion (&ks->key, + &session->opt->key_type, + ks->key_src, + &ks->session_id_remote, + &session->session_id, + true)) + { + msg (D_TLS_ERRORS, "TLS Error: server generate_key_expansion failed"); + goto error; + } + } + + CLEAR (*ks->key_src); + } + + return true; + + error: + msg (D_TLS_ERRORS, "TLS Error: Key Method #2 write failed"); + CLEAR (*ks->key_src); + return false; +} + +static bool +key_method_1_read (struct buffer *buf, struct tls_session *session) +{ + int status; + struct key key; + + ASSERT (session->opt->key_method == 1); + + if (!session->verified) + { + msg (D_TLS_ERRORS, + "TLS Error: Certificate verification failed (key-method 1)"); + goto error; + } + + status = read_key (&key, &session->opt->key_type, buf); + if (status != 1) + { + msg (D_TLS_ERRORS, + "TLS Error: Error reading data channel key from plaintext buffer"); + goto error; + } + + if (!check_key (&key, &session->opt->key_type)) + { + msg (D_TLS_ERRORS, "TLS Error: Bad decrypting key received from peer"); + goto error; + } + + if (buf->len < 1) + { + msg (D_TLS_ERRORS, "TLS Error: Missing options string"); + goto error; + } + +#ifdef ENABLE_OCC + /* compare received remote options string + with our locally computed options string */ + if (!session->opt->disable_occ && + !options_cmp_equal_safe ((char *) BPTR (buf), session->opt->remote_options, buf->len)) + { + options_warning_safe ((char *) BPTR (buf), session->opt->remote_options, buf->len); + } +#endif + + buf_clear (buf); + + init_key_ctx (&ks->key.decrypt, &key, &session->opt->key_type, + DO_DECRYPT, "Data Channel Decrypt"); + CLEAR (key); + ks->authenticated = true; + return true; + + error: + buf_clear (buf); + CLEAR (key); + return false; +} + +static bool +key_method_2_read (struct buffer *buf, struct tls_multi *multi, struct tls_session *session) +{ + struct gc_arena gc = gc_new (); + int key_method_flags; + char *options; + struct user_pass *up; + + ASSERT (session->opt->key_method == 2); + + /* allocate temporary objects */ + ALLOC_ARRAY_CLEAR_GC (options, char, TLS_OPTIONS_LEN, &gc); + + /* discard leading uint32 */ + ASSERT (buf_advance (buf, 4)); + + /* get key method */ + key_method_flags = buf_read_u8 (buf); + if ((key_method_flags & KEY_METHOD_MASK) != 2) + { + msg (D_TLS_ERRORS, + "TLS ERROR: Unknown key_method/flags=%d received from remote host", + key_method_flags); + goto error; + } + + /* get key source material (not actual keys yet) */ + if (!key_source2_read (ks->key_src, buf, session->opt->server)) + { + msg (D_TLS_ERRORS, "TLS Error: Error reading remote data channel key source entropy from plaintext buffer"); + goto error; + } + + /* get options */ + if (!read_string (buf, options, TLS_OPTIONS_LEN)) + { + msg (D_TLS_ERRORS, "TLS Error: Failed to read required OCC options string"); + goto error; + } + + /* should we check username/password? */ + ks->authenticated = false; + if (session->opt->auth_user_pass_verify_script + || plugin_defined (session->opt->plugins, OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY)) + { + bool s1 = true; + bool s2 = true; + char *raw_username; + + /* get username/password from plaintext buffer */ + ALLOC_OBJ_CLEAR_GC (up, struct user_pass, &gc); + if (!read_string (buf, up->username, USER_PASS_LEN) + || !read_string (buf, up->password, USER_PASS_LEN)) + { + msg (D_TLS_ERRORS, "TLS Error: Auth Username/Password was not provided by peer"); + CLEAR (*up); + goto error; + } + + /* preserve raw username before string_mod remapping, for plugins */ + ALLOC_ARRAY_CLEAR_GC (raw_username, char, USER_PASS_LEN, &gc); + strcpy (raw_username, up->username); + string_mod (raw_username, CC_PRINT, CC_CRLF, '_'); + + /* enforce character class restrictions in username/password */ + string_mod (up->username, COMMON_NAME_CHAR_CLASS, 0, '_'); + string_mod (up->password, CC_PRINT, CC_CRLF, '_'); + + /* call plugin(s) and/or script */ + if (plugin_defined (session->opt->plugins, OPENVPN_PLUGIN_AUTH_USER_PASS_VERIFY)) + s1 = verify_user_pass_plugin (session, up, raw_username); + if (session->opt->auth_user_pass_verify_script) + s2 = verify_user_pass_script (session, up); + + /* auth succeeded? */ + if (s1 && s2) + { + ks->authenticated = true; + if (session->opt->username_as_common_name) + set_common_name (session, up->username); + msg (D_HANDSHAKE, "TLS: Username/Password authentication succeeded for username '%s' %s", + up->username, + session->opt->username_as_common_name ? "[CN SET]" : ""); + } + else + { + msg (D_TLS_ERRORS, "TLS Auth Error: Auth Username/Password verification failed for peer"); + } + + CLEAR (*up); + } + else + { + if (!session->verified) + { + msg (D_TLS_ERRORS, + "TLS Error: Certificate verification failed (key-method 2)"); + goto error; + } + ks->authenticated = true; + } + + /* While it shouldn't really happen, don't allow the common name to be NULL */ + if (!session->common_name) + set_common_name (session, ""); + + /* Don't allow the CN to change once it's been locked */ + if (ks->authenticated && multi->locked_cn) + { + const char *cn = session->common_name; + if (cn && strcmp (cn, multi->locked_cn)) + { + msg (D_TLS_ERRORS, "TLS Auth Error: TLS object CN attempted to change from '%s' to '%s' -- tunnel disabled", + multi->locked_cn, + cn); + + /* change the common name back to its original value and disable the tunnel */ + set_common_name (session, multi->locked_cn); + tls_deauthenticate (multi); + } + } + + /* verify --client-config-dir based authentication */ + if (ks->authenticated && session->opt->client_config_dir_exclusive) + { + const char *cn = session->common_name; + const char *path = gen_path (session->opt->client_config_dir_exclusive, cn, &gc); + if (!cn || !strcmp (cn, CCD_DEFAULT) || !test_file (path)) + { + ks->authenticated = false; + msg (D_TLS_ERRORS, "TLS Auth Error: --client-config-dir authentication failed for common name '%s' file='%s'", + session->common_name, + path ? path : "UNDEF"); + } + } + +#ifdef ENABLE_OCC + /* check options consistency */ + if (!session->opt->disable_occ && + !options_cmp_equal (options, session->opt->remote_options)) + { + options_warning (options, session->opt->remote_options); + } +#endif + + buf_clear (buf); + + /* + * generate tunnel keys if client + */ + if (!session->opt->server) + { + if (!generate_key_expansion (&ks->key, + &session->opt->key_type, + ks->key_src, + &session->session_id, + &ks->session_id_remote, + false)) + { + msg (D_TLS_ERRORS, "TLS Error: client generate_key_expansion failed"); + goto error; + } + + CLEAR (*ks->key_src); + } + + gc_free (&gc); + return true; + + error: + CLEAR (*ks->key_src); + buf_clear (buf); + gc_free (&gc); + return false; +} + +/* + * This is the primary routine for processing TLS stuff inside the + * the main event loop. When this routine exits + * with non-error status, it will set *wakeup to the number of seconds + * when it wants to be called again. + * + * Return value is true if we have placed a packet in *to_link which we + * want to send to our peer. + */ +static bool +tls_process (struct tls_multi *multi, + struct tls_session *session, + struct buffer *to_link, + struct sockaddr_in *to_link_addr, + struct link_socket_info *to_link_socket_info, + interval_t *wakeup) +{ + struct gc_arena gc = gc_new (); + struct buffer *buf; + bool state_change = false; + bool active = false; + + /* Make sure we were initialized and that we're not in an error state */ + ASSERT (ks->state != S_UNDEF); + ASSERT (ks->state != S_ERROR); + ASSERT (session_id_defined (&session->session_id)); + + /* Should we trigger a soft reset? -- new key, keeps old key for a while */ + if (ks->state >= S_ACTIVE && + ((session->opt->renegotiate_seconds + && now >= ks->established + session->opt->renegotiate_seconds) + || (session->opt->renegotiate_bytes + && ks->n_bytes >= session->opt->renegotiate_bytes) + || (session->opt->renegotiate_packets + && ks->n_packets >= session->opt->renegotiate_packets) + || (packet_id_close_to_wrapping (&ks->packet_id.send)))) + { + msg (D_TLS_DEBUG_LOW, "TLS: soft reset sec=%d bytes=%d/%d pkts=%d/%d", + (int)(ks->established + session->opt->renegotiate_seconds - now), + ks->n_bytes, session->opt->renegotiate_bytes, + ks->n_packets, session->opt->renegotiate_packets); + key_state_soft_reset (session); + } + + /* Kill lame duck key transition_window seconds after primary key negotiation */ + if (lame_duck_must_die (session, wakeup)) { + key_state_free (ks_lame, true); + msg (D_TLS_DEBUG_LOW, "TLS: tls_process: killed expiring key"); + } + + /*mutex_cycle (multi->mutex);*/ + + do + { + update_time (); + + dmsg (D_TLS_DEBUG, "TLS: tls_process: chg=%d ks=%s lame=%s to_link->len=%d wakeup=%d", + state_change, + state_name (ks->state), + state_name (ks_lame->state), + to_link->len, + *wakeup); + + state_change = false; + + /* + * TLS activity is finished once we get to S_ACTIVE, + * though we will still process acknowledgements. + * + * CHANGED with 2.0 -> now we may send tunnel configuration + * info over the control channel. + */ + if (true) + { + /* Initial handshake */ + if (ks->state == S_INITIAL) + { + buf = reliable_get_buf_output_sequenced (ks->send_reliable); + if (buf) + { + ks->must_negotiate = now + session->opt->handshake_window; + + /* null buffer */ + reliable_mark_active_outgoing (ks->send_reliable, buf, ks->initial_opcode); + INCR_GENERATED; + + ks->state = S_PRE_START; + state_change = true; + dmsg (D_TLS_DEBUG, "TLS: Initial Handshake, sid=%s", + session_id_print (&session->session_id, &gc)); + +#ifdef ENABLE_MANAGEMENT + if (management && ks->initial_opcode != P_CONTROL_SOFT_RESET_V1) + { + management_set_state (management, + OPENVPN_STATE_WAIT, + NULL, + 0); + } +#endif + } + } + + /* Are we timed out on receive? */ + if (now >= ks->must_negotiate) + { + if (ks->state < S_ACTIVE) + { + msg (D_TLS_ERRORS, + "TLS Error: TLS key negotiation failed to occur within %d seconds (check your network connectivity)", + session->opt->handshake_window); + goto error; + } + else /* assume that ks->state == S_ACTIVE */ + { + dmsg (D_TLS_DEBUG_MED, "STATE S_NORMAL"); + ks->state = S_NORMAL; + ks->must_negotiate = 0; + } + } + + /* Wait for Initial Handshake ACK */ + if (ks->state == S_PRE_START && FULL_SYNC) + { + ks->state = S_START; + state_change = true; + dmsg (D_TLS_DEBUG_MED, "STATE S_START"); + } + + /* Wait for ACK */ + if (((ks->state == S_GOT_KEY && !session->opt->server) || + (ks->state == S_SENT_KEY && session->opt->server))) + { + if (FULL_SYNC) + { + ks->established = now; + dmsg (D_TLS_DEBUG_MED, "STATE S_ACTIVE"); + if (check_debug_level (D_HANDSHAKE)) + print_details (ks->ssl, "Control Channel:"); + state_change = true; + ks->state = S_ACTIVE; + INCR_SUCCESS; + + /* Set outgoing address for data channel packets */ + link_socket_set_outgoing_addr (NULL, to_link_socket_info, &ks->remote_addr, session->common_name, session->opt->es); + +#ifdef MEASURE_TLS_HANDSHAKE_STATS + show_tls_performance_stats(); +#endif + } + } + + /* Reliable buffer to outgoing TCP/UDP (send up to CONTROL_SEND_ACK_MAX ACKs + for previously received packets) */ + if (!to_link->len && reliable_can_send (ks->send_reliable)) + { + int opcode; + struct buffer b; + + buf = reliable_send (ks->send_reliable, &opcode); + ASSERT (buf); + b = *buf; + INCR_SENT; + + write_control_auth (session, ks, &b, to_link_addr, opcode, + CONTROL_SEND_ACK_MAX, true); + *to_link = b; + active = true; + state_change = true; + dmsg (D_TLS_DEBUG, "Reliable -> TCP/UDP"); + break; + } + +#ifndef TLS_AGGREGATE_ACK + /* Send 1 or more ACKs (each received control packet gets one ACK) */ + if (!to_link->len && !reliable_ack_empty (ks->rec_ack)) + { + buf = &ks->ack_write_buf; + ASSERT (buf_init (buf, FRAME_HEADROOM (&multi->opt.frame))); + write_control_auth (session, ks, buf, to_link_addr, P_ACK_V1, + RELIABLE_ACK_SIZE, false); + *to_link = *buf; + active = true; + state_change = true; + dmsg (D_TLS_DEBUG, "Dedicated ACK -> TCP/UDP"); + break; + } +#endif + + /* Write incoming ciphertext to TLS object */ + buf = reliable_get_buf_sequenced (ks->rec_reliable); + if (buf) + { + int status = 0; + if (buf->len) + { + status = key_state_write_ciphertext (multi, ks, buf); + if (status == -1) + { + msg (D_TLS_ERRORS, + "TLS Error: Incoming Ciphertext -> TLS object write error"); + goto error; + } + } + else + { + status = 1; + } + if (status == 1) + { + reliable_mark_deleted (ks->rec_reliable, buf, true); + state_change = true; + dmsg (D_TLS_DEBUG, "Incoming Ciphertext -> TLS"); + } + } + + /* Read incoming plaintext from TLS object */ + buf = &ks->plaintext_read_buf; + if (!buf->len) + { + int status; + + ASSERT (buf_init (buf, 0)); + status = key_state_read_plaintext (multi, ks, buf, PLAINTEXT_BUFFER_SIZE); + update_time (); + if (status == -1) + { + msg (D_TLS_ERRORS, "TLS Error: TLS object -> incoming plaintext read error"); + goto error; + } + if (status == 1) + { + state_change = true; + dmsg (D_TLS_DEBUG, "TLS -> Incoming Plaintext"); + } +#if 0 /* show null plaintext reads */ + if (!status) + msg (M_INFO, "TLS plaintext read -> NULL return"); +#endif + } + + /* Send Key */ + buf = &ks->plaintext_write_buf; + if (!buf->len && ((ks->state == S_START && !session->opt->server) || + (ks->state == S_GOT_KEY && session->opt->server))) + { + if (session->opt->key_method == 1) + { + if (!key_method_1_write (buf, session)) + goto error; + } + else if (session->opt->key_method == 2) + { + if (!key_method_2_write (buf, session)) + goto error; + } + else + { + ASSERT (0); + } + + state_change = true; + dmsg (D_TLS_DEBUG_MED, "STATE S_SENT_KEY"); + ks->state = S_SENT_KEY; + } + + /* Receive Key */ + buf = &ks->plaintext_read_buf; + if (buf->len + && ((ks->state == S_SENT_KEY && !session->opt->server) + || (ks->state == S_START && session->opt->server))) + { + if (session->opt->key_method == 1) + { + if (!key_method_1_read (buf, session)) + goto error; + } + else if (session->opt->key_method == 2) + { + if (!key_method_2_read (buf, multi, session)) + goto error; + } + else + { + ASSERT (0); + } + + state_change = true; + dmsg (D_TLS_DEBUG_MED, "STATE S_GOT_KEY"); + ks->state = S_GOT_KEY; + } + + /* Write outgoing plaintext to TLS object */ + buf = &ks->plaintext_write_buf; + if (buf->len) + { + int status = key_state_write_plaintext (multi, ks, buf); + if (status == -1) + { + msg (D_TLS_ERRORS, + "TLS ERROR: Outgoing Plaintext -> TLS object write error"); + goto error; + } + if (status == 1) + { + state_change = true; + dmsg (D_TLS_DEBUG, "Outgoing Plaintext -> TLS"); + } + } + + /* Outgoing Ciphertext to reliable buffer */ + if (ks->state >= S_START) + { + buf = reliable_get_buf_output_sequenced (ks->send_reliable); + if (buf) + { + int status = key_state_read_ciphertext (multi, ks, buf, PAYLOAD_SIZE_DYNAMIC (&multi->opt.frame)); + if (status == -1) + { + msg (D_TLS_ERRORS, + "TLS Error: Ciphertext -> reliable TCP/UDP transport read error"); + goto error; + } + if (status == 1) + { + reliable_mark_active_outgoing (ks->send_reliable, buf, P_CONTROL_V1); + INCR_GENERATED; + state_change = true; + dmsg (D_TLS_DEBUG, "Outgoing Ciphertext -> Reliable"); + } + } + } + } + /*mutex_cycle (multi->mutex);*/ + } + while (state_change); + + update_time (); + +#ifdef TLS_AGGREGATE_ACK + /* Send 1 or more ACKs (each received control packet gets one ACK) */ + if (!to_link->len && !reliable_ack_empty (ks->rec_ack)) + { + buf = &ks->ack_write_buf; + ASSERT (buf_init (buf, FRAME_HEADROOM (&multi->opt.frame))); + write_control_auth (session, ks, buf, to_link_addr, P_ACK_V1, + RELIABLE_ACK_SIZE, false); + *to_link = *buf; + active = true; + state_change = true; + dmsg (D_TLS_DEBUG, "Dedicated ACK -> TCP/UDP"); + } +#endif + + /* When should we wake up again? */ + { + if (ks->state >= S_INITIAL) + { + compute_earliest_wakeup (wakeup, + reliable_send_timeout (ks->send_reliable)); + + if (ks->must_negotiate) + compute_earliest_wakeup (wakeup, ks->must_negotiate - now); + } + + if (ks->established && session->opt->renegotiate_seconds) + compute_earliest_wakeup (wakeup, + ks->established + session->opt->renegotiate_seconds - now); + + /* prevent event-loop spinning by setting minimum wakeup of 1 second */ + if (*wakeup <= 0) + { + *wakeup = 1; + + /* if we had something to send to remote, but to_link was busy, + let caller know we need to be called again soon */ + active = true; + } + + dmsg (D_TLS_DEBUG, "TLS: tls_process: timeout set to %d", *wakeup); + + gc_free (&gc); + return active; + } + +error: + ERR_clear_error (); + ks->state = S_ERROR; + msg (D_TLS_ERRORS, "TLS Error: TLS handshake failed"); + INCR_ERROR; + gc_free (&gc); + return false; +} + +#undef ks +#undef ks_lame + +/* + * Called by the top-level event loop. + * + * Basically decides if we should call tls_process for + * the active or untrusted sessions. + */ + +bool +tls_multi_process (struct tls_multi *multi, + struct buffer *to_link, + struct sockaddr_in *to_link_addr, + struct link_socket_info *to_link_socket_info, + interval_t *wakeup) +{ + struct gc_arena gc = gc_new (); + int i; + bool active = false; + bool error = false; + + perf_push (PERF_TLS_MULTI_PROCESS); + + ERR_clear_error (); + + /* + * Process each session object having state of S_INITIAL or greater, + * and which has a defined remote IP addr. + */ + + for (i = 0; i < TM_SIZE; ++i) + { + struct tls_session *session = &multi->session[i]; + struct key_state *ks = &session->key[KS_PRIMARY]; + struct key_state *ks_lame = &session->key[KS_LAME_DUCK]; + + /* set initial remote address */ + if (i == TM_ACTIVE && ks->state == S_INITIAL && + addr_defined (&to_link_socket_info->lsa->actual)) + ks->remote_addr = to_link_socket_info->lsa->actual; + + dmsg (D_TLS_DEBUG, + "TLS: tls_multi_process: i=%d state=%s, mysid=%s, stored-sid=%s, stored-ip=%s", + i, + state_name (ks->state), + session_id_print (&session->session_id, &gc), + session_id_print (&ks->session_id_remote, &gc), + print_sockaddr (&ks->remote_addr, &gc)); + + if (ks->state >= S_INITIAL && addr_defined (&ks->remote_addr)) + { + update_time (); + + if (tls_process (multi, session, to_link, to_link_addr, + to_link_socket_info, wakeup)) + active = true; + + /* + * If tls_process hits an error: + * (1) If the session has an unexpired lame duck key, preserve it. + * (2) Reinitialize the session. + * (3) Increment soft error count + */ + if (ks->state == S_ERROR) + { + ++multi->n_soft_errors; + + if (i == TM_ACTIVE) + error = true; + + if (i == TM_ACTIVE + && ks_lame->state >= S_ACTIVE + && !multi->opt.single_session) + move_session (multi, TM_LAME_DUCK, TM_ACTIVE, true); + else + reset_session (multi, session); + } + } + /*mutex_cycle (multi->mutex);*/ + } + + update_time (); + + /* + * If lame duck session expires, kill it. + */ + if (lame_duck_must_die (&multi->session[TM_LAME_DUCK], wakeup)) { + tls_session_free (&multi->session[TM_LAME_DUCK], true); + msg (D_TLS_DEBUG_LOW, "TLS: tls_multi_process: killed expiring key"); + } + + /* + * If untrusted session achieves TLS authentication, + * move it to active session, usurping any prior session. + * + * A semi-trusted session is one in which the certificate authentication + * succeeded (if cert verification is enabled) but the username/password + * verification failed. A semi-trusted session can forward data on the + * TLS control channel but not on the tunnel channel. + */ + if (DECRYPT_KEY_ENABLED (multi, &multi->session[TM_UNTRUSTED].key[KS_PRIMARY])) { + move_session (multi, TM_ACTIVE, TM_UNTRUSTED, true); + msg (D_TLS_DEBUG_LOW, "TLS: tls_multi_process: untrusted session promoted to %strusted", + tls_authenticated (multi) ? "" : "semi-"); + } + + /* + * A hard error means that TM_ACTIVE hit an S_ERROR state and that no + * other key state objects are S_ACTIVE or higher. + */ + if (error) + { + for (i = 0; i < (int) SIZE (multi->key_scan); ++i) + { + if (multi->key_scan[i]->state >= S_ACTIVE) + goto nohard; + } + ++multi->n_hard_errors; + } + nohard: + +#ifdef ENABLE_DEBUG + /* DEBUGGING -- flood peer with repeating connection attempts */ + { + const int throw_level = GREMLIN_CONNECTION_FLOOD_LEVEL (multi->opt.gremlin); + if (throw_level) + { + for (i = 0; i < (int) SIZE (multi->key_scan); ++i) + { + if (multi->key_scan[i]->state >= throw_level) + { + ++multi->n_hard_errors; + ++multi->n_soft_errors; + } + } + } + } +#endif + + perf_pop (); + gc_free (&gc); + return active; +} + +/* + * Pre and post-process the encryption & decryption buffers in order + * to implement a multiplexed TLS channel over the TCP/UDP port. + */ + +/* + * + * When we are in TLS mode, this is the first routine which sees + * an incoming packet. + * + * If it's a data packet, we set opt so that our caller can + * decrypt it. We also give our caller the appropriate decryption key. + * + * If it's a control packet, we authenticate it and process it, + * possibly creating a new tls_session if it represents the + * first packet of a new session. For control packets, we will + * also zero the size of *buf so that our caller ignores the + * packet on our return. + * + * Note that openvpn only allows one active session at a time, + * so a new session (once authenticated) will always usurp + * an old session. + * + * Return true if input was an authenticated control channel + * packet. + * + * If we are running in TLS thread mode, all public routines + * below this point must be called with the L_TLS lock held. + */ + +bool +tls_pre_decrypt (struct tls_multi *multi, + struct sockaddr_in *from, + struct buffer *buf, + struct crypto_options *opt) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + + if (buf->len > 0) + { + int i; + int op; + int key_id; + + /* get opcode and key ID */ + { + uint8_t c = *BPTR (buf); + op = c >> P_OPCODE_SHIFT; + key_id = c & P_KEY_ID_MASK; + } + + if (op == P_DATA_V1) + { /* data channel packet */ + for (i = 0; i < KEY_SCAN_SIZE; ++i) + { + struct key_state *ks = multi->key_scan[i]; + + /* + * This is the basic test of TLS state compatibility between a local OpenVPN + * instance and its remote peer. + * + * If the test fails, it tells us that we are getting a packet from a source + * which claims reference to a prior negotiated TLS session, but the local + * OpenVPN instance has no memory of such a negotiation. + * + * It almost always occurs on UDP sessions when the passive side of the + * connection is restarted without the active side restarting as well (the + * passive side is the server which only listens for the connections, the + * active side is the client which initiates connections). + */ + if (DECRYPT_KEY_ENABLED (multi, ks) + && key_id == ks->key_id + && ks->authenticated + && addr_port_match(from, &ks->remote_addr)) + { + /* return appropriate data channel decrypt key in opt */ + opt->key_ctx_bi = &ks->key; + opt->packet_id = multi->opt.replay ? &ks->packet_id : NULL; + opt->pid_persist = NULL; + opt->flags &= multi->opt.crypto_flags_and; + opt->flags |= multi->opt.crypto_flags_or; + ASSERT (buf_advance (buf, 1)); + ++ks->n_packets; + ks->n_bytes += buf->len; + dmsg (D_TLS_DEBUG, + "TLS: data channel, key_id=%d, IP=%s", + key_id, print_sockaddr (from, &gc)); + gc_free (&gc); + return ret; + } +#if 0 /* keys out of sync? */ + else + { + dmsg (D_TLS_DEBUG, "TLS_PRE_DECRYPT: [%d] dken=%d rkid=%d lkid=%d auth=%d match=%d", + i, + DECRYPT_KEY_ENABLED (multi, ks), + key_id, + ks->key_id, + ks->authenticated, + addr_port_match (from, &ks->remote_addr)); + } +#endif + } + + msg (D_TLS_ERRORS, + "TLS Error: local/remote TLS keys are out of sync: %s [%d]", + print_sockaddr (from, &gc), key_id); + goto error; + } + else /* control channel packet */ + { + bool do_burst = false; + bool new_link = false; + struct session_id sid; /* remote session ID */ + + /* verify legal opcode */ + if (op < P_FIRST_OPCODE || op > P_LAST_OPCODE) + { + msg (D_TLS_ERRORS, + "TLS Error: unknown opcode received from %s op=%d", + print_sockaddr (from, &gc), op); + goto error; + } + + /* hard reset ? */ + if (is_hard_reset (op, 0)) + { + /* verify client -> server or server -> client connection */ + if (((op == P_CONTROL_HARD_RESET_CLIENT_V1 + || op == P_CONTROL_HARD_RESET_CLIENT_V2) && !multi->opt.server) + || ((op == P_CONTROL_HARD_RESET_SERVER_V1 + || op == P_CONTROL_HARD_RESET_SERVER_V2) && multi->opt.server)) + { + msg (D_TLS_ERRORS, + "TLS Error: client->client or server->server connection attempted from %s", + print_sockaddr (from, &gc)); + goto error; + } + } + + /* + * Authenticate Packet + */ + dmsg (D_TLS_DEBUG, "TLS: control channel, op=%s, IP=%s", + packet_opcode_name (op), print_sockaddr (from, &gc)); + + /* get remote session-id */ + { + struct buffer tmp = *buf; + buf_advance (&tmp, 1); + if (!session_id_read (&sid, &tmp) || !session_id_defined (&sid)) + { + msg (D_TLS_ERRORS, + "TLS Error: session-id not found in packet from %s", + print_sockaddr (from, &gc)); + goto error; + } + } + + /* use session ID to match up packet with appropriate tls_session object */ + for (i = 0; i < TM_SIZE; ++i) + { + struct tls_session *session = &multi->session[i]; + struct key_state *ks = &session->key[KS_PRIMARY]; + + dmsg (D_TLS_DEBUG, + "TLS: initial packet test, i=%d state=%s, mysid=%s, rec-sid=%s, rec-ip=%s, stored-sid=%s, stored-ip=%s", + i, + state_name (ks->state), + session_id_print (&session->session_id, &gc), + session_id_print (&sid, &gc), + print_sockaddr (from, &gc), + session_id_print (&ks->session_id_remote, &gc), + print_sockaddr (&ks->remote_addr, &gc)); + + if (session_id_equal (&ks->session_id_remote, &sid)) + /* found a match */ + { + if (i == TM_LAME_DUCK) { + msg (D_TLS_ERRORS, + "TLS ERROR: received control packet with stale session-id=%s", + session_id_print (&sid, &gc)); + goto error; + } + dmsg (D_TLS_DEBUG, + "TLS: found match, session[%d], sid=%s", + i, session_id_print (&sid, &gc)); + break; + } + } + + /* + * Initial packet received. + */ + + if (i == TM_SIZE && is_hard_reset (op, 0)) + { + struct tls_session *session = &multi->session[TM_ACTIVE]; + struct key_state *ks = &session->key[KS_PRIMARY]; + + if (!is_hard_reset (op, multi->opt.key_method)) + { + msg (D_TLS_ERRORS, "TLS ERROR: initial packet local/remote key_method mismatch, local key_method=%d, op=%s", + multi->opt.key_method, + packet_opcode_name (op)); + goto error; + } + + /* + * If we have no session currently in progress, the initial packet will + * open a new session in TM_ACTIVE rather than TM_UNTRUSTED. + */ + if (!session_id_defined (&ks->session_id_remote)) + { + if (multi->opt.single_session && multi->n_sessions) + { + msg (D_TLS_ERRORS, + "TLS Error: Cannot accept new session request from %s due to --single-session [1]", + print_sockaddr (from, &gc)); + goto error; + } + +#ifdef ENABLE_MANAGEMENT + if (management) + { + management_set_state (management, + OPENVPN_STATE_AUTH, + NULL, + 0); + } +#endif + + msg (D_TLS_DEBUG_LOW, + "TLS: Initial packet from %s, sid=%s", + print_sockaddr (from, &gc), + session_id_print (&sid, &gc)); + + do_burst = true; + new_link = true; + i = TM_ACTIVE; + session->untrusted_sockaddr = *from; + } + } + + if (i == TM_SIZE && is_hard_reset (op, 0)) + { + /* + * No match with existing sessions, + * probably a new session. + */ + struct tls_session *session = &multi->session[TM_UNTRUSTED]; + + /* + * If --single-session, don't allow any hard-reset connection request + * unless it the the first packet of the session. + */ + if (multi->opt.single_session) + { + msg (D_TLS_ERRORS, + "TLS Error: Cannot accept new session request from %s due to --single-session [2]", + print_sockaddr (from, &gc)); + goto error; + } + + if (!is_hard_reset (op, multi->opt.key_method)) + { + msg (D_TLS_ERRORS, "TLS ERROR: new session local/remote key_method mismatch, local key_method=%d, op=%s", + multi->opt.key_method, + packet_opcode_name (op)); + goto error; + } + + if (!read_control_auth (buf, &session->tls_auth, from)) + goto error; + + /* + * New session-initiating control packet is authenticated at this point, + * assuming that the --tls-auth command line option was used. + * + * Without --tls-auth, we leave authentication entirely up to TLS. + */ + msg (D_TLS_DEBUG_LOW, + "TLS: new session incoming connection from %s", + print_sockaddr (from, &gc)); + + new_link = true; + i = TM_UNTRUSTED; + session->untrusted_sockaddr = *from; + } + else + { + struct tls_session *session = &multi->session[i]; + struct key_state *ks = &session->key[KS_PRIMARY]; + + /* + * Packet must belong to an existing session. + */ + if (i != TM_ACTIVE && i != TM_UNTRUSTED) + { + msg (D_TLS_ERRORS, + "TLS Error: Unroutable control packet received from %s (si=%d op=%s)", + print_sockaddr (from, &gc), + i, + packet_opcode_name (op)); + goto error; + } + + /* + * Verify remote IP address + */ + if (!new_link && !addr_port_match (&ks->remote_addr, from)) + { + msg (D_TLS_ERRORS, "TLS Error: Received control packet from unexpected IP addr: %s", + print_sockaddr (from, &gc)); + goto error; + } + + /* + * Remote is requesting a key renegotiation + */ + if (op == P_CONTROL_SOFT_RESET_V1 + && DECRYPT_KEY_ENABLED (multi, ks)) + { + if (!read_control_auth (buf, &session->tls_auth, from)) + goto error; + + key_state_soft_reset (session); + + dmsg (D_TLS_DEBUG, + "TLS: received P_CONTROL_SOFT_RESET_V1 s=%d sid=%s", + i, session_id_print (&sid, &gc)); + } + else + { + /* + * Remote responding to our key renegotiation request? + */ + if (op == P_CONTROL_SOFT_RESET_V1) + do_burst = true; + + if (!read_control_auth (buf, &session->tls_auth, from)) + goto error; + + dmsg (D_TLS_DEBUG, + "TLS: received control channel packet s#=%d sid=%s", + i, session_id_print (&sid, &gc)); + } + } + + /* + * We have an authenticated packet (if --tls-auth was set). + * Now pass to our reliability level which deals with + * packet acknowledgements, retransmits, sequencing, etc. + */ + { + struct tls_session *session = &multi->session[i]; + struct key_state *ks = &session->key[KS_PRIMARY]; + + /* Make sure we were initialized and that we're not in an error state */ + ASSERT (ks->state != S_UNDEF); + ASSERT (ks->state != S_ERROR); + ASSERT (session_id_defined (&session->session_id)); + + /* Let our caller know we processed a control channel packet */ + ret = true; + + /* + * Set our remote address and remote session_id + */ + if (new_link) + { + ks->session_id_remote = sid; + ks->remote_addr = *from; + ++multi->n_sessions; + } + else if (!addr_port_match (&ks->remote_addr, from)) + { + msg (D_TLS_ERRORS, + "TLS Error: Existing session control channel packet from unknown IP address: %s", + print_sockaddr (from, &gc)); + goto error; + } + + /* + * Should we do a retransmit of all unacknowledged packets in + * the send buffer? This improves the start-up efficiency of the + * initial key negotiation after the 2nd peer comes online. + */ + if (do_burst && !session->burst) + { + reliable_schedule_now (ks->send_reliable); + session->burst = true; + } + + /* Check key_id */ + if (ks->key_id != key_id) + { + msg (D_TLS_ERRORS, + "TLS ERROR: local/remote key IDs out of sync (%d/%d) ID: %s", + ks->key_id, key_id, print_key_id (multi, &gc)); + goto error; + } + + /* + * Process incoming ACKs for packets we can now + * delete from reliable send buffer + */ + { + /* buffers all packet IDs to delete from send_reliable */ + struct reliable_ack send_ack; + + send_ack.len = 0; + if (!reliable_ack_read (&send_ack, buf, &session->session_id)) + { + msg (D_TLS_ERRORS, + "TLS Error: reading acknowledgement record from packet"); + goto error; + } + reliable_send_purge (ks->send_reliable, &send_ack); + } + + if (op != P_ACK_V1 && reliable_can_get (ks->rec_reliable)) + { + packet_id_type id; + + /* Extract the packet ID from the packet */ + if (reliable_ack_read_packet_id (buf, &id)) + { + /* Avoid deadlock by rejecting packet that would de-sequentialize receive buffer */ + if (reliable_wont_break_sequentiality (ks->rec_reliable, id)) + { + if (reliable_not_replay (ks->rec_reliable, id)) + { + /* Save incoming ciphertext packet to reliable buffer */ + struct buffer *in = reliable_get_buf (ks->rec_reliable); + ASSERT (in); + ASSERT (buf_copy (in, buf)); + reliable_mark_active_incoming (ks->rec_reliable, in, id, op); + } + + /* Process outgoing acknowledgment for packet just received, even if it's a replay */ + reliable_ack_acknowledge_packet_id (ks->rec_ack, id); + } + } + } + } + } + } + + done: + buf->len = 0; + opt->key_ctx_bi = NULL; + opt->packet_id = NULL; + opt->pid_persist = NULL; + opt->flags &= multi->opt.crypto_flags_and; + gc_free (&gc); + return ret; + + error: + ERR_clear_error (); + ++multi->n_soft_errors; + goto done; +} + +/* + * This function is similar to tls_pre_decrypt, except it is called + * when we are in server mode and receive an initial incoming + * packet. Note that we don't modify + * any state in our parameter objects. The purpose is solely to + * determine whether we should generate a client instance + * object, in which case true is returned. + * + * This function is essentially the first-line HMAC firewall + * on the UDP port listener in --mode server mode. + */ +bool +tls_pre_decrypt_lite (const struct tls_auth_standalone *tas, + const struct sockaddr_in *from, + const struct buffer *buf) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + + if (buf->len > 0) + { + int op; + int key_id; + + /* get opcode and key ID */ + { + uint8_t c = *BPTR (buf); + op = c >> P_OPCODE_SHIFT; + key_id = c & P_KEY_ID_MASK; + } + + /* this packet is from an as-yet untrusted source, so + scrutinize carefully */ + + if (op != P_CONTROL_HARD_RESET_CLIENT_V2) + { + /* + * This can occur due to bogus data or DoS packets. + */ + dmsg (D_TLS_STATE_ERRORS, + "TLS State Error: No TLS state for client %s, opcode=%d", + print_sockaddr (from, &gc), + op); + goto error; + } + + if (key_id != 0) + { + dmsg (D_TLS_STATE_ERRORS, + "TLS State Error: Unknown key ID (%d) received from %s -- 0 was expected", + key_id, + print_sockaddr (from, &gc)); + goto error; + } + + if (buf->len > EXPANDED_SIZE_DYNAMIC (&tas->frame)) + { + dmsg (D_TLS_STATE_ERRORS, + "TLS State Error: Large packet (size %d) received from %s -- a packet no larger than %d bytes was expected", + buf->len, + print_sockaddr (from, &gc), + EXPANDED_SIZE_DYNAMIC (&tas->frame)); + goto error; + } + + { + struct buffer newbuf = clone_buf (buf); + struct crypto_options co = tas->tls_auth_options; + bool status; + + /* + * We are in read-only mode at this point with respect to TLS + * control channel state. After we build a new client instance + * object, we will process this session-initiating packet for real. + */ + co.flags |= CO_IGNORE_PACKET_ID; + + /* HMAC test, if --tls-auth was specified */ + status = read_control_auth (&newbuf, &co, from); + free_buf (&newbuf); + if (!status) + goto error; + + /* + * At this point, if --tls-auth is being used, we know that + * the packet has passed the HMAC test, but we don't know if + * it is a replay yet. We will attempt to defeat replays + * by not advancing to the S_START state until we + * receive an ACK from our first reply to the client + * that includes an HMAC of our randomly generated 64 bit + * session ID. + * + * On the other hand if --tls-auth is not being used, we + * will proceed to begin the TLS authentication + * handshake with only cursory integrity checks having + * been performed, since we will be leaving the task + * of authentication solely up to TLS. + */ + + ret = true; + } + } + gc_free (&gc); + return ret; + + error: + ERR_clear_error (); + gc_free (&gc); + return ret; +} + +/* Choose the key with which to encrypt a data packet */ +void +tls_pre_encrypt (struct tls_multi *multi, + struct buffer *buf, struct crypto_options *opt) +{ + multi->save_ks = NULL; + if (buf->len > 0) + { + int i; + for (i = 0; i < KEY_SCAN_SIZE; ++i) + { + struct key_state *ks = multi->key_scan[i]; + if (ks->state >= S_ACTIVE && ks->authenticated) + { + opt->key_ctx_bi = &ks->key; + opt->packet_id = multi->opt.replay ? &ks->packet_id : NULL; + opt->pid_persist = NULL; + opt->flags &= multi->opt.crypto_flags_and; + opt->flags |= multi->opt.crypto_flags_or; + multi->save_ks = ks; + dmsg (D_TLS_DEBUG, "TLS: tls_pre_encrypt: key_id=%d", ks->key_id); + return; + } + } + + { + struct gc_arena gc = gc_new (); + dmsg (D_TLS_NO_SEND_KEY, "TLS Warning: no data channel send key available: %s", + print_key_id (multi, &gc)); + gc_free (&gc); + } + } + + buf->len = 0; + opt->key_ctx_bi = NULL; + opt->packet_id = NULL; + opt->pid_persist = NULL; + opt->flags &= multi->opt.crypto_flags_and; +} + +/* Prepend the appropriate opcode to encrypted buffer prior to TCP/UDP send */ +void +tls_post_encrypt (struct tls_multi *multi, struct buffer *buf) +{ + struct key_state *ks; + uint8_t *op; + + ks = multi->save_ks; + multi->save_ks = NULL; + if (buf->len > 0) + { + ASSERT (ks); + ASSERT (op = buf_prepend (buf, 1)); + *op = (P_DATA_V1 << P_OPCODE_SHIFT) | ks->key_id; + ++ks->n_packets; + ks->n_bytes += buf->len; + } +} + +/* + * Send a payload over the TLS control channel. + * Called externally. + */ + +bool +tls_send_payload (struct tls_multi *multi, + const uint8_t *data, + int size) +{ + struct tls_session *session; + struct key_state *ks; + bool ret = false; + + ERR_clear_error (); + + ASSERT (multi); + + session = &multi->session[TM_ACTIVE]; + ks = &session->key[KS_PRIMARY]; + + if (ks->state >= S_ACTIVE) + { + if (key_state_write_plaintext_const (multi, ks, data, size) == 1) + ret = true; + } + + ERR_clear_error (); + + return ret; +} + +bool +tls_rec_payload (struct tls_multi *multi, + struct buffer *buf) +{ + struct tls_session *session; + struct key_state *ks; + bool ret = false; + + ERR_clear_error (); + + ASSERT (multi); + + session = &multi->session[TM_ACTIVE]; + ks = &session->key[KS_PRIMARY]; + + if (ks->state >= S_ACTIVE && BLEN (&ks->plaintext_read_buf)) + { + if (buf_copy (buf, &ks->plaintext_read_buf)) + ret = true; + ks->plaintext_read_buf.len = 0; + } + + ERR_clear_error (); + + return ret; +} + +/* + * Dump a human-readable rendition of an openvpn packet + * into a garbage collectable string which is returned. + */ +const char * +protocol_dump (struct buffer *buffer, unsigned int flags, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + struct buffer buf = *buffer; + + uint8_t c; + int op; + int key_id; + + int tls_auth_hmac_size = (flags & PD_TLS_AUTH_HMAC_SIZE_MASK); + + if (buf.len <= 0) + { + buf_printf (&out, "DATA UNDEF len=%d", buf.len); + goto done; + } + + if (!(flags & PD_TLS)) + goto print_data; + + /* + * Initial byte (opcode) + */ + if (!buf_read (&buf, &c, sizeof (c))) + goto done; + op = (c >> P_OPCODE_SHIFT); + key_id = c & P_KEY_ID_MASK; + buf_printf (&out, "%s kid=%d", packet_opcode_name (op), key_id); + + if (op == P_DATA_V1) + goto print_data; + + /* + * Session ID + */ + { + struct session_id sid; + + if (!session_id_read (&sid, &buf)) + goto done; + if (flags & PD_VERBOSE) + buf_printf (&out, " sid=%s", session_id_print (&sid, gc)); + } + + /* + * tls-auth hmac + packet_id + */ + if (tls_auth_hmac_size) + { + struct packet_id_net pin; + uint8_t tls_auth_hmac[MAX_HMAC_KEY_LENGTH]; + + ASSERT (tls_auth_hmac_size <= MAX_HMAC_KEY_LENGTH); + + if (!buf_read (&buf, tls_auth_hmac, tls_auth_hmac_size)) + goto done; + if (flags & PD_VERBOSE) + buf_printf (&out, " tls_hmac=%s", format_hex (tls_auth_hmac, tls_auth_hmac_size, 0, gc)); + + if (!packet_id_read (&pin, &buf, true)) + goto done; + buf_printf(&out, " pid=%s", packet_id_net_print (&pin, (flags & PD_VERBOSE), gc)); + } + + /* + * ACK list + */ + buf_printf (&out, " %s", reliable_ack_print(&buf, (flags & PD_VERBOSE), gc)); + + if (op == P_ACK_V1) + goto done; + + /* + * Packet ID + */ + { + packet_id_type l; + if (!buf_read (&buf, &l, sizeof (l))) + goto done; + l = ntohpid (l); + buf_printf (&out, " pid=" packet_id_format, (packet_id_print_type)l); + } + +print_data: + if (flags & PD_SHOW_DATA) + buf_printf (&out, " DATA %s", format_hex (BPTR (&buf), BLEN (&buf), 80, gc)); + else + buf_printf (&out, " DATA len=%d", buf.len); + +done: + return BSTR (&out); +} + +#ifdef EXTRACT_X509_FIELD_TEST + +void +extract_x509_field_test (void) +{ + char line[8]; + char field[4]; + static const char field_name[] = "CN"; + + while (fgets (line, sizeof (line), stdin)) + { + chomp (line); + extract_x509_field (line, field_name, field, sizeof (field)); + printf ("CN: '%s'\n", field); + } +} + +#endif + +#else +static void dummy(void) {} +#endif /* USE_CRYPTO && USE_SSL*/ @@ -0,0 +1,683 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef OPENVPN_SSL_H +#define OPENVPN_SSL_H + +#if defined(USE_CRYPTO) && defined(USE_SSL) + +#include <openssl/ssl.h> +#include <openssl/bio.h> +#include <openssl/rand.h> +#include <openssl/err.h> +#include <openssl/pkcs12.h> +#include <openssl/x509v3.h> + +#include "basic.h" +#include "common.h" +#include "crypto.h" +#include "packet_id.h" +#include "session_id.h" +#include "reliable.h" +#include "socket.h" +#include "mtu.h" +#include "thread.h" +#include "options.h" +#include "plugin.h" + +/* + * OpenVPN Protocol, taken from ssl.h in OpenVPN source code. + * + * TCP/UDP Packet: This represents the top-level encapsulation. + * + * TCP/UDP packet format: + * + * Packet length (16 bits, unsigned) -- TCP only, always sent as + * plaintext. Since TCP is a stream protocol, the packet + * length words define the packetization of the stream. + * + * Packet opcode/key_id (8 bits) -- TLS only, not used in + * pre-shared secret mode. + * packet message type, a P_* constant (high 5 bits) + * key_id (low 3 bits, see key_id in struct tls_session + * below for comment). The key_id refers to an + * already negotiated TLS session. OpenVPN seamlessly + * renegotiates the TLS session by using a new key_id + * for the new session. Overlap (controlled by + * user definable parameters) between old and new TLS + * sessions is allowed, providing a seamless transition + * during tunnel operation. + * + * Payload (n bytes), which may be a P_CONTROL, P_ACK, or P_DATA + * message. + * + * Message types: + * + * P_CONTROL_HARD_RESET_CLIENT_V1 -- Key method 1, initial key from + * client, forget previous state. + * + * P_CONTROL_HARD_RESET_SERVER_V1 -- Key method 2, initial key + * from server, forget previous state. + * + * P_CONTROL_SOFT_RESET_V1 -- New key, with a graceful transition + * from old to new key in the sense that a transition window + * exists where both the old or new key_id can be used. OpenVPN + * uses two different forms of key_id. The first form is 64 bits + * and is used for all P_CONTROL messages. P_DATA messages on the + * other hand use a shortened key_id of 3 bits for efficiency + * reasons since the vast majority of OpenVPN packets in an + * active tunnel will be P_DATA messages. The 64 bit form + * is referred to as a session_id, while the 3 bit form is + * referred to as a key_id. + * + * P_CONTROL_V1 -- Control channel packet (usually TLS ciphertext). + * + * P_ACK_V1 -- Acknowledgement for P_CONTROL packets received. + * + * P_DATA_V1 -- Data channel packet containing actual tunnel data + * ciphertext. + * + * P_CONTROL_HARD_RESET_CLIENT_V2 -- Key method 2, initial key from + * client, forget previous state. + * + * P_CONTROL_HARD_RESET_SERVER_V2 -- Key method 2, initial key from + * server, forget previous state. + * + * P_CONTROL* and P_ACK Payload: The P_CONTROL message type + * indicates a TLS ciphertext packet which has been encapsulated + * inside of a reliability layer. The reliability layer is + * implemented as a straightforward ACK and retransmit model. + * + * P_CONTROL message format: + * + * local session_id (random 64 bit value to identify TLS session). + * HMAC signature of entire encapsulation header for integrity + * check if --tls-auth is specified (usually 16 or 20 bytes). + * packet-id for replay protection (4 or 8 bytes, includes + * sequence number and optional time_t timestamp). + * P_ACK packet_id array length (1 byte). + * P_ACK packet-id array (if length > 0). + * P_ACK remote session_id (if length > 0). + * message packet-id (4 bytes). + * TLS payload ciphertext (n bytes) (only for P_CONTROL). + * + * Once the TLS session has been initialized and authenticated, + * the TLS channel is used to exchange random key material for + * bidirectional cipher and HMAC keys which will be + * used to secure actual tunnel packets. OpenVPN currently + * implements two key methods. Key method 1 directly + * derives keys using random bits obtained from the RAND_bytes + * OpenSSL function. Key method 2 mixes random key material + * from both sides of the connection using the TLS PRF mixing + * function. Key method 2 is the preferred method and is the default + * for OpenVPN 2.0. + * + * TLS plaintext content: + * + * TLS plaintext packet (if key_method == 1): + * + * Cipher key length in bytes (1 byte). + * Cipher key (n bytes). + * HMAC key length in bytes (1 byte). + * HMAC key (n bytes). + * Options string (n bytes, null terminated, client/server options + * string should match). + * + * TLS plaintext packet (if key_method == 2): + * + * Literal 0 (4 bytes). + * key_method type (1 byte). + * key_source structure (pre_master only defined for client -> + * server). + * options_string_length, including null (2 bytes). + * Options string (n bytes, null terminated, client/server options + * string must match). + * [The username/password data below is optional, record can end + * at this point.] + * username_string_length, including null (2 bytes). + * Username string (n bytes, null terminated). + * password_string_length, including null (2 bytes). + * Password string (n bytes, null terminated). + * + * The P_DATA payload represents encrypted, encapsulated tunnel + * packets which tend to be either IP packets or Ethernet frames. + * This is essentially the "payload" of the VPN. + * + * P_DATA message content: + * HMAC of ciphertext IV + ciphertext (if not disabled by + * --auth none). + * Ciphertext IV (size is cipher-dependent, if not disabled by + * --no-iv). + * Tunnel packet ciphertext. + * + * P_DATA plaintext + * packet_id (4 or 8 bytes, if not disabled by --no-replay). + * In SSL/TLS mode, 4 bytes are used because the implementation + * can force a TLS renegotation before 2^32 packets are sent. + * In pre-shared key mode, 8 bytes are used (sequence number + * and time_t value) to allow long-term key usage without + * packet_id collisions. + * User plaintext (n bytes). + * + * Notes: + * (1) ACK messages can be encoded in either the dedicated + * P_ACK record or they can be prepended to a P_CONTROL message. + * (2) P_DATA and P_CONTROL/P_ACK use independent packet-id + * sequences because P_DATA is an unreliable channel while + * P_CONTROL/P_ACK is a reliable channel. Each use their + * own independent HMAC keys. + * (3) Note that when --tls-auth is used, all message types are + * protected with an HMAC signature, even the initial packets + * of the TLS handshake. This makes it easy for OpenVPN to + * throw away bogus packets quickly, without wasting resources + * on attempting a TLS handshake which will ultimately fail. + */ + +/* Used in the TLS PRF function */ +#define KEY_EXPANSION_ID "OpenVPN" + +/* passwords */ +#define UP_TYPE_AUTH "Auth" +#define UP_TYPE_PRIVATE_KEY "Private Key" + +/* packet opcode (high 5 bits) and key-id (low 3 bits) are combined in one byte */ +#define P_KEY_ID_MASK 0x07 +#define P_OPCODE_SHIFT 3 + +/* packet opcodes -- the V1 is intended to allow protocol changes in the future */ +#define P_CONTROL_HARD_RESET_CLIENT_V1 1 /* initial key from client, forget previous state */ +#define P_CONTROL_HARD_RESET_SERVER_V1 2 /* initial key from server, forget previous state */ +#define P_CONTROL_SOFT_RESET_V1 3 /* new key, graceful transition from old to new key */ +#define P_CONTROL_V1 4 /* control channel packet (usually TLS ciphertext) */ +#define P_ACK_V1 5 /* acknowledgement for packets received */ +#define P_DATA_V1 6 /* data channel packet */ + +/* indicates key_method >= 2 */ +#define P_CONTROL_HARD_RESET_CLIENT_V2 7 /* initial key from client, forget previous state */ +#define P_CONTROL_HARD_RESET_SERVER_V2 8 /* initial key from server, forget previous state */ + +/* define the range of legal opcodes */ +#define P_FIRST_OPCODE 1 +#define P_LAST_OPCODE 8 + +/* key negotiation states */ +#define S_ERROR -1 +#define S_UNDEF 0 +#define S_INITIAL 1 /* tls_init() was called */ +#define S_PRE_START 2 /* waiting for initial reset & acknowledgement */ +#define S_START 3 /* ready to exchange keys */ +#define S_SENT_KEY 4 /* client does S_SENT_KEY -> S_GOT_KEY */ +#define S_GOT_KEY 5 /* server does S_GOT_KEY -> S_SENT_KEY */ +#define S_ACTIVE 6 /* ready to exchange data channel packets */ +#define S_NORMAL 7 /* normal operations */ + +/* + * Are we ready to receive data channel packets? + * + * Also, if true, we can safely assume session has been + * authenticated by TLS. + * + * NOTE: Assumes S_SENT_KEY + 1 == S_GOT_KEY. + */ +#define DECRYPT_KEY_ENABLED(multi, ks) ((ks)->state >= (S_GOT_KEY - (multi)->opt.server)) + +/* Should we aggregate TLS acknowledgements, and tack them onto control packets? */ +#define TLS_AGGREGATE_ACK + +/* + * If TLS_AGGREGATE_ACK, set the + * max number of acknowledgments that + * can "hitch a ride" on an outgoing + * non-P_ACK_V1 control packet. + */ +#define CONTROL_SEND_ACK_MAX 4 + +/* + * Define number of buffers for send and receive in the reliability layer. + */ +#define TLS_RELIABLE_N_SEND_BUFFERS 4 /* also window size for reliablity layer */ +#define TLS_RELIABLE_N_REC_BUFFERS 8 + +/* + * Various timeouts + */ + +#define TLS_MULTI_REFRESH 15 /* call tls_multi_process once every n seconds */ +#define TLS_MULTI_HORIZON 2 /* call tls_multi_process frequently for n seconds after + every packet sent/received action */ + +/* The SSL/TLS worker thread will wait at most this many seconds for the interprocess + communication pipe to the main thread to be ready to accept writes. */ +#define TLS_MULTI_THREAD_SEND_TIMEOUT 5 + +/* + * Buffer sizes (also see mtu.h). + */ + +#define PLAINTEXT_BUFFER_SIZE TLS_CHANNEL_BUF_SIZE + +/* Maximum length of common name */ +#define TLS_CN_LEN 64 + +/* Legal characters in an X509 or common name */ +#define X509_NAME_CHAR_CLASS (CC_ALNUM|CC_UNDERBAR|CC_DASH|CC_DOT|CC_AT|CC_COLON|CC_SLASH|CC_EQUAL) +#define COMMON_NAME_CHAR_CLASS (CC_ALNUM|CC_UNDERBAR|CC_DASH|CC_DOT|CC_AT) + +/* Maximum length of OCC options string passed as part of auth handshake */ +#define TLS_OPTIONS_LEN 512 + +/* + * Range of key exchange methods + */ +#define KEY_METHOD_MIN 1 +#define KEY_METHOD_MAX 2 + +/* key method taken from lower 4 bits */ +#define KEY_METHOD_MASK 0x0F + +/* + * Measure success rate of TLS handshakes, for debugging only + */ +/* #define MEASURE_TLS_HANDSHAKE_STATS */ + +/* + * Key material, used as source for PRF-based + * key expansion. + */ + +struct key_source { + uint8_t pre_master[48]; /* client generated */ + uint8_t random1[32]; /* generated by both client and server */ + uint8_t random2[32]; /* generated by both client and server */ +}; + +struct key_source2 { + struct key_source client; + struct key_source server; +}; + +/* + * Represents a single instantiation of a TLS negotiation and + * data channel key exchange. 4 keys are kept: encrypt hmac, + * decrypt hmac, encrypt cipher, and decrypt cipher. The TLS + * control channel is used to exchange these keys. + * Each hard or soft reset will build + * a fresh key_state. Normally an openvpn session will contain two + * key_state objects, one for the current TLS connection, and other + * for the retiring or "lame duck" key. The lame duck key_state is + * used to maintain transmission continuity on the data-channel while + * a key renegotiation is taking place. + */ +struct key_state +{ + int state; + int key_id; /* inherited from struct tls_session below */ + + SSL *ssl; /* SSL object -- new obj created for each new key */ + BIO *ssl_bio; /* read/write plaintext from here */ + BIO *ct_in; /* write ciphertext to here */ + BIO *ct_out; /* read ciphertext from here */ + + time_t established; /* when our state went S_ACTIVE */ + time_t must_negotiate; /* key negotiation times out if not finished before this time */ + time_t must_die; /* this object is destroyed at this time */ + + int initial_opcode; /* our initial P_ opcode */ + struct session_id session_id_remote; /* peer's random session ID */ + struct sockaddr_in remote_addr; /* peer's IP addr */ + struct packet_id packet_id; /* for data channel, to prevent replay attacks */ + + struct key_ctx_bi key; /* data channel keys for encrypt/decrypt/hmac */ + + struct key_source2 *key_src; /* source entropy for key expansion */ + + struct buffer plaintext_read_buf; + struct buffer plaintext_write_buf; + struct buffer ack_write_buf; + + struct reliable *send_reliable; /* holds a copy of outgoing packets until ACK received */ + struct reliable *rec_reliable; /* order incoming ciphertext packets before we pass to TLS */ + struct reliable_ack *rec_ack; /* buffers all packet IDs we want to ACK back to sender */ + + int n_bytes; /* how many bytes sent/recvd since last key exchange */ + int n_packets; /* how many packets sent/recvd since last key exchange */ + + /* + * If bad username/password, TLS connection will come up but 'authenticated' will be false. + */ + bool authenticated; +}; + +/* + * Our const options, obtained directly or derived from + * command line options. + */ +struct tls_options +{ + /* our master SSL_CTX from which all SSL objects derived */ + SSL_CTX *ssl_ctx; + + /* data channel cipher, hmac, and key lengths */ + struct key_type key_type; + + /* true if we are a TLS server, client otherwise */ + bool server; + +#ifdef ENABLE_OCC + /* local and remote options strings + that must match between client and server */ + const char *local_options; + const char *remote_options; +#endif + + /* from command line */ + int key_method; + bool replay; + bool single_session; +#ifdef ENABLE_OCC + bool disable_occ; +#endif + int transition_window; + int handshake_window; + interval_t packet_timeout; + int renegotiate_bytes; + int renegotiate_packets; + interval_t renegotiate_seconds; + + /* cert verification parms */ + const char *verify_command; + const char *verify_x509name; + const char *crl_file; + int ns_cert_type; + + /* allow openvpn config info to be + passed over control channel */ + bool pass_config_info; + + /* struct crypto_option flags */ + unsigned int crypto_flags_and; + unsigned int crypto_flags_or; + + int replay_window; /* --replay-window parm */ + int replay_time; /* --replay-window parm */ + + /* packet authentication for TLS handshake */ + struct crypto_options tls_auth; + struct key_ctx_bi tls_auth_key; + + /* frame parameters for TLS control channel */ + struct frame frame; + + /* used for username/password authentication */ + const char *auth_user_pass_verify_script; + bool auth_user_pass_verify_script_via_file; + const char *tmp_dir; + bool username_as_common_name; + + /* use the client-config-dir as a positive authenticator */ + const char *client_config_dir_exclusive; + + /* instance-wide environment variable set */ + struct env_set *es; + const struct plugin_list *plugins; + + /* --gremlin bits */ + int gremlin; +}; + +/* index into tls_session.key */ +#define KS_PRIMARY 0 /* the primary key */ +#define KS_LAME_DUCK 1 /* the key that's going to retire soon */ +#define KS_SIZE 2 + +/* + * A tls_session lives through multiple key_state life-cycles. Soft resets + * will reuse a tls_session object, but hard resets or errors will require + * that a fresh object be built. Normally three tls_session objects are maintained + * by an active openvpn session. The first is the current, TLS authenticated + * session, the second is used to process connection requests from a new + * client that would usurp the current session if successfully authenticated, + * and the third is used as a repository for a "lame-duck" key in the event + * that the primary session resets due to error while the lame-duck key still + * has time left before its expiration. Lame duck keys are used to maintain + * the continuity of the data channel connection while a new key is being + * negotiated. + */ +struct tls_session +{ + /* const options and config info */ + const struct tls_options *opt; + + /* during hard reset used to control burst retransmit */ + bool burst; + + /* authenticate control packets */ + struct crypto_options tls_auth; + struct packet_id tls_auth_pid; + + int initial_opcode; /* our initial P_ opcode */ + struct session_id session_id; /* our random session ID */ + int key_id; /* increments with each soft reset (for key renegotiation) */ + + int limit_next; /* used for traffic shaping on the control channel */ + + int verify_maxlevel; + + char *common_name; + bool verified; /* true if peer certificate was verified against CA */ + + /* not-yet-authenticated incoming client */ + struct sockaddr_in untrusted_sockaddr; + + struct key_state key[KS_SIZE]; +}; + +/* index into tls_multi.session */ +#define TM_ACTIVE 0 +#define TM_UNTRUSTED 1 +#define TM_LAME_DUCK 2 +#define TM_SIZE 3 + +/* + * The number of keys we will scan on encrypt or decrypt. The first + * is the "active" key. The second is the lame_duck or retiring key + * associated with the active key's session ID. The third is a detached + * lame duck session that only occurs in situations where a key renegotiate + * failed on the active key, but a lame duck key was still valid. By + * preserving the lame duck session, we can be assured of having a data + * channel key available even when network conditions are so bad that + * we can't negotiate a new key within the time allotted. + */ +#define KEY_SCAN_SIZE 3 + +/* + * An openvpn session running with TLS enabled has one tls_multi object. + */ +struct tls_multi +{ + /* used to coordinate access between main thread and TLS thread */ + /*MUTEX_PTR_DEFINE (mutex);*/ + + /* const options and config info */ + struct tls_options opt; + + /* + * A list of key_state objects in the order they should be + * scanned by data channel encrypt and decrypt routines. + */ + struct key_state* key_scan[KEY_SCAN_SIZE]; + + /* + * used by tls_pre_encrypt to communicate the encrypt key + * to tls_post_encrypt() + */ + struct key_state *save_ks; /* temporary pointer used between pre/post routines */ + + /* + * Number of sessions negotiated thus far. + */ + int n_sessions; + + /* + * Number of errors. + */ + int n_hard_errors; /* errors due to TLS negotiation failure */ + int n_soft_errors; /* errors due to unrecognized or failed-to-authenticate incoming packets */ + + /* + * Our locked common name (cannot change during the life of this tls_multi object) + */ + char *locked_cn; + + /* + * Our session objects. + */ + struct tls_session session[TM_SIZE]; +}; + +/* + * Used in --mode server mode to check tls-auth signature on initial + * packets received from new clients. + */ +struct tls_auth_standalone +{ + struct key_ctx_bi tls_auth_key; + struct crypto_options tls_auth_options; + struct frame frame; +}; + +void init_ssl_lib (void); +void free_ssl_lib (void); + +/* Build master SSL_CTX object that serves for the whole of openvpn instantiation */ +SSL_CTX *init_ssl (const struct options *options); + +struct tls_multi *tls_multi_init (struct tls_options *tls_options); + +struct tls_auth_standalone *tls_auth_standalone_init (struct tls_options *tls_options, + struct gc_arena *gc); + +void tls_auth_standalone_finalize (struct tls_auth_standalone *tas, + const struct frame *frame); + +void tls_multi_init_finalize(struct tls_multi *multi, + const struct frame *frame); + +void tls_multi_init_set_options(struct tls_multi* multi, + const char *local, + const char *remote); + +bool tls_multi_process (struct tls_multi *multi, + struct buffer *to_link, + struct sockaddr_in *to_link_addr, + struct link_socket_info *to_link_socket_info, + interval_t *wakeup); + +void tls_multi_free (struct tls_multi *multi, bool clear); + +bool tls_pre_decrypt (struct tls_multi *multi, + struct sockaddr_in *from, + struct buffer *buf, + struct crypto_options *opt); + +bool tls_pre_decrypt_lite (const struct tls_auth_standalone *tas, + const struct sockaddr_in *from, + const struct buffer *buf); + +void tls_pre_encrypt (struct tls_multi *multi, + struct buffer *buf, struct crypto_options *opt); + +void tls_post_encrypt (struct tls_multi *multi, struct buffer *buf); + +void show_available_tls_ciphers (void); +void get_highest_preference_tls_cipher (char *buf, int size); + +void pem_password_setup (const char *auth_file); +int pem_password_callback (char *buf, int size, int rwflag, void *u); +void auth_user_pass_setup (const char *auth_file); +void ssl_set_auth_nocache (void); +void ssl_purge_auth (void); + +void tls_set_verify_command (const char *cmd); +void tls_set_crl_verify (const char *crl); +void tls_set_verify_x509name (const char *x509name); + +void tls_adjust_frame_parameters(struct frame *frame); + +bool tls_send_payload (struct tls_multi *multi, + const uint8_t *data, + int size); + +bool tls_rec_payload (struct tls_multi *multi, + struct buffer *buf); + +const char *tls_common_name (struct tls_multi* multi, bool null); +void tls_set_common_name (struct tls_multi *multi, const char *common_name); +void tls_lock_common_name (struct tls_multi *multi); + +bool tls_authenticated (struct tls_multi *multi); +void tls_deauthenticate (struct tls_multi *multi); + +/* + * inline functions + */ + +static inline int +tls_test_payload_len (const struct tls_multi *multi) +{ + if (multi) + { + const struct key_state *ks = &multi->session[TM_ACTIVE].key[KS_PRIMARY]; + if (ks->state >= S_ACTIVE) + return BLEN (&ks->plaintext_read_buf); + } + return 0; +} + +/* + * protocol_dump() flags + */ +#define PD_TLS_AUTH_HMAC_SIZE_MASK 0xFF +#define PD_SHOW_DATA (1<<8) +#define PD_TLS (1<<9) +#define PD_VERBOSE (1<<10) + +const char *protocol_dump (struct buffer *buffer, + unsigned int flags, + struct gc_arena *gc); + +/* + * debugging code + */ + +#ifdef MEASURE_TLS_HANDSHAKE_STATS +void show_tls_performance_stats(void); +#endif + +/*#define EXTRACT_X509_FIELD_TEST*/ +void extract_x509_field_test (void); + +#endif /* USE_CRYPTO && USE_SSL */ + +#endif diff --git a/status.c b/status.c new file mode 100644 index 0000000..da1be14 --- /dev/null +++ b/status.c @@ -0,0 +1,301 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "status.h" +#include "perf.h" + +#include "memdbg.h" + +/* + * printf-style interface for outputting status info + */ + +static const char * +print_status_mode (unsigned int flags) +{ + switch (flags) + { + case STATUS_OUTPUT_WRITE: + return "WRITE"; + case STATUS_OUTPUT_READ: + return "READ"; + case STATUS_OUTPUT_READ|STATUS_OUTPUT_WRITE: + return "READ/WRITE"; + default: + return "UNDEF"; + } +} + +struct status_output * +status_open (const char *filename, + const int refresh_freq, + const int msglevel, + const struct virtual_output *vout, + const unsigned int flags) +{ + struct status_output *so = NULL; + if (filename || msglevel >= 0 || vout) + { + ALLOC_OBJ_CLEAR (so, struct status_output); + so->flags = flags; + so->msglevel = msglevel; + so->vout = vout; + so->fd = -1; + buf_reset (&so->read_buf); + event_timeout_clear (&so->et); + if (filename) + { + switch (so->flags) + { +#ifdef _MSC_VER + case STATUS_OUTPUT_WRITE: + so->fd = open (filename, + O_CREAT | O_TRUNC | O_WRONLY, + _S_IREAD | _S_IWRITE); + break; + case STATUS_OUTPUT_READ: + so->fd = open (filename, + O_RDONLY, + _S_IREAD | _S_IWRITE); + break; + case STATUS_OUTPUT_READ|STATUS_OUTPUT_WRITE: + so->fd = open (filename, + O_CREAT | O_RDWR, + _S_IREAD | _S_IWRITE); + break; +#else + case STATUS_OUTPUT_WRITE: + so->fd = open (filename, + O_CREAT | O_TRUNC | O_WRONLY, + S_IRUSR | S_IWUSR); + break; + case STATUS_OUTPUT_READ: + so->fd = open (filename, + O_RDONLY, + S_IRUSR | S_IWUSR); + break; + case STATUS_OUTPUT_READ|STATUS_OUTPUT_WRITE: + so->fd = open (filename, + O_CREAT | O_RDWR, + S_IRUSR | S_IWUSR); + break; +#endif + default: + ASSERT (0); + } + if (so->fd >= 0) + { + so->filename = string_alloc (filename, NULL); + + /* allocate read buffer */ + if (so->flags & STATUS_OUTPUT_READ) + so->read_buf = alloc_buf (512); + } + else + { + msg (M_WARN, "Note: cannot open %s for %s", filename, print_status_mode (so->flags)); + so->errors = true; + } + } + else + so->flags = STATUS_OUTPUT_WRITE; + + if ((so->flags & STATUS_OUTPUT_WRITE) && refresh_freq > 0) + { + event_timeout_init (&so->et, refresh_freq, 0); + } + } + return so; +} + +bool +status_trigger (struct status_output *so) +{ + if (so) + { + struct timeval null; + CLEAR (null); + return event_timeout_trigger (&so->et, &null, ETT_DEFAULT); + } + else + return false; +} + +bool +status_trigger_tv (struct status_output *so, struct timeval *tv) +{ + if (so) + return event_timeout_trigger (&so->et, tv, ETT_DEFAULT); + else + return false; +} + +void +status_reset (struct status_output *so) +{ + if (so && so->fd >= 0) + lseek (so->fd, (off_t)0, SEEK_SET); +} + +void +status_flush (struct status_output *so) +{ + if (so && so->fd >= 0 && (so->flags & STATUS_OUTPUT_WRITE)) + { +#if defined(HAVE_FTRUNCATE) + { + const off_t off = lseek (so->fd, (off_t)0, SEEK_CUR); + ftruncate (so->fd, off); + } +#elif defined(HAVE_CHSIZE) + { + const long off = (long) lseek (so->fd, (off_t)0, SEEK_CUR); + chsize (so->fd, off); + } +#else +#warning both ftruncate and chsize functions appear to be missing from this OS +#endif + + /* clear read buffer */ + if (buf_defined (&so->read_buf)) + { + ASSERT (buf_init (&so->read_buf, 0)); + } + } +} + +/* return false if error occurred */ +bool +status_close (struct status_output *so) +{ + bool ret = true; + if (so) + { + if (so->errors) + ret = false; + if (so->fd >= 0) + { + if (close (so->fd) < 0) + ret = false; + } + if (so->filename) + free (so->filename); + if (buf_defined (&so->read_buf)) + free_buf (&so->read_buf); + free (so); + } + else + ret = false; + return ret; +} + +#define STATUS_PRINTF_MAXLEN 256 + +void +status_printf (struct status_output *so, const char *format, ...) +{ + if (so && (so->flags & STATUS_OUTPUT_WRITE)) + { + char buf[STATUS_PRINTF_MAXLEN+2]; /* leave extra bytes for CR, LF */ + va_list arglist; + + va_start (arglist, format); + vsnprintf (buf, STATUS_PRINTF_MAXLEN, format, arglist); + va_end (arglist); + buf[STATUS_PRINTF_MAXLEN - 1] = 0; + + if (so->msglevel >= 0) + msg (so->msglevel, "%s", buf); + + if (so->fd >= 0) + { + int len; + strcat (buf, "\n"); + len = strlen (buf); + if (len > 0) + { + if (write (so->fd, buf, len) < 0) + so->errors = true; + } + } + + if (so->vout) + { + chomp (buf); + (*so->vout->func) (so->vout->arg, so->vout->flags_default, buf); + } + } +} + +bool +status_read (struct status_output *so, struct buffer *buf) +{ + bool ret = false; + + if (so && so->fd >= 0 && (so->flags & STATUS_OUTPUT_READ)) + { + ASSERT (buf_defined (&so->read_buf)); + ASSERT (buf_defined (buf)); + while (true) + { + const int c = buf_read_u8 (&so->read_buf); + + /* read more of file into buffer */ + if (c == -1) + { + int len; + + ASSERT (buf_init (&so->read_buf, 0)); + len = read (so->fd, BPTR (&so->read_buf), BCAP (&so->read_buf)); + if (len <= 0) + break; + + ASSERT (buf_inc_len (&so->read_buf, len)); + continue; + } + + ret = true; + + if (c == '\r') + continue; + + if (c == '\n') + break; + + buf_write_u8 (buf, c); + } + + buf_null_terminate (buf); + } + + return ret; +} diff --git a/status.h b/status.h new file mode 100644 index 0000000..be3c3f3 --- /dev/null +++ b/status.h @@ -0,0 +1,95 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef STATUS_H +#define STATUS_H + +#include "interval.h" + +/* + * virtual function interface for status output + */ +struct virtual_output { + void *arg; + unsigned int flags_default; + void (*func) (void *arg, const unsigned int flags, const char *str); +}; + +static inline void +virtual_output_print (const struct virtual_output *vo, const unsigned int flags, const char *str) +{ + (*vo->func) (vo->arg, flags, str); +} + +/* + * printf-style interface for inputting/outputting status info + */ + +struct status_output +{ +# define STATUS_OUTPUT_READ (1<<0) +# define STATUS_OUTPUT_WRITE (1<<1) + unsigned int flags; + + char *filename; + int fd; + int msglevel; + const struct virtual_output *vout; + + struct buffer read_buf; + + struct event_timeout et; + + bool errors; +}; + +struct status_output *status_open (const char *filename, + const int refresh_freq, + const int msglevel, + const struct virtual_output *vout, + const unsigned int flags); + +bool status_trigger_tv (struct status_output *so, struct timeval *tv); +bool status_trigger (struct status_output *so); +void status_reset (struct status_output *so); +void status_flush (struct status_output *so); +bool status_close (struct status_output *so); +void status_printf (struct status_output *so, const char *format, ...) +#ifdef __GNUC__ + __attribute__ ((format (printf, 2, 3))) +#endif + ; + +bool status_read (struct status_output *so, struct buffer *buf); + +static inline unsigned int +status_rw_flags (const struct status_output *so) +{ + if (so) + return so->flags; + else + return 0; +} + +#endif diff --git a/suse/openvpn.init b/suse/openvpn.init new file mode 100644 index 0000000..8f1060a --- /dev/null +++ b/suse/openvpn.init @@ -0,0 +1,264 @@ +#!/bin/sh +### BEGIN INIT INFO +# Provides: openvpn +# Required-Start: $network +# Required-Stop: $network +# Default-Start: 3 5 +# Default-Stop: 0 1 2 6 +# Short-Description: This shell script takes care of starting and stopping OpenVPN. +# Description: OpenVPN is a robust and highly flexible tunneling application that uses all of the encryption, authentication, and certification features of the OpenSSL library to securely tunnel IP networks over a single UDP port. +### END INIT INFO + +# Contributed to the OpenVPN project by +# Douglas Keller <doug@voidstar.dyndns.org> +# 2002.05.15 + +# Modified for SuSE by +# Frank Plohmann <openvpn@franks-planet.de> +# 2003.08.24 +# Please feel free to contact me if you have problems or suggestions +# using this script. + +# To install: +# copy this file to /etc/rc.d/init.d/openvpn +# use the runlevel editor in Yast to add it to runlevel 3 and/or 5 +# shell> mkdir /etc/openvpn +# make .conf or .sh files in /etc/openvpn (see below) + +# To uninstall: +# use also Yast and the runlevel editor to uninstall + +# Author's Notes: +# +# I have created an /etc/init.d init script and enhanced openvpn.spec to +# automatically register the init script. Once the RPM is installed you +# can start and stop OpenVPN with "service openvpn start" and "service +# openvpn stop". +# +# The init script does the following: +# +# - Starts an openvpn process for each .conf file it finds in +# /etc/openvpn. +# +# - If /etc/openvpn/xxx.sh exists for a xxx.conf file then it executes +# it before starting openvpn (useful for doing openvpn --mktun...). +# +# - In addition to start/stop you can do: +# +# /etc/init.d/openvpn reload - SIGHUP +# /etc/init.d/openvpn reopen - SIGUSR1 +# /etc/init.d/openvpn status - SIGUSR2 + +# Modifications 2003.05.02 +# * Changed == to = for sh compliance (Bishop Clark). +# * If condrestart|reload|reopen|status, check that we were +# actually started (James Yonan). +# * Added lock, piddir, and work variables (James Yonan). +# * If start is attempted twice, without an intervening stop, or +# if start is attempted when previous start was not properly +# shut down, then kill any previously started processes, before +# commencing new start operation (James Yonan). +# * Do a better job of flagging errors on start, and properly +# returning success or failure status to caller (James Yonan). +# +# Modifications 2003.08.24 +# * Converted the script for SuSE Linux distribution. +# Tested with version 8.2 (Frank Plohmann). +# - removed "chkconfig" header +# - added Yast header +# - changed installation notes +# - corrected path to openvpn binary +# - removes sourcing "functions" +# - removed sourcing "network" +# - removed network checking. it seemed not to work with SuSE. +# - added sourcing "rc.status", comments and "rc_reset" command +# - removed "succes; echo" and "failure; echo" lines +# - added "rc_status" lines at the end of each section +# - changed "service" to "/etc/init.d/" in "In addition to start/stop" +# section above. +# +# Modifications 2005.04.04 +# * Added openvpn-startup and openvpn-shutdown script calls (James Yonan). +# + +# Location of openvpn binary +openvpn="/usr/local/sbin/openvpn" + +# Lockfile +lock="/var/lock/subsys/openvpn" + +# PID directory +piddir="/var/run/openvpn" + +# Our working directory +work=/etc/openvpn + +# Source rc functions +. /etc/rc.status + +# Shell functions sourced from /etc/rc.status: +# rc_check check and set local and overall rc status +# rc_status check and set local and overall rc status +# rc_status -v ditto but be verbose in local rc status +# rc_status -v -r ditto and clear the local rc status +# rc_failed set local and overall rc status to failed +# rc_reset clear local rc status (overall remains) +# rc_exit exit appropriate to overall rc status + +# rc_status check and set local and overall rc status +# rc_status -v ditto but be verbose in local rc status +# rc_status -v -r ditto and clear the local rc status +# rc_failed set local and overall rc status to failed +# rc_reset clear local rc status (overall remains) +# rc_exit exit appropriate to overall rc status + +# First reset status of this service +rc_reset + +[ -f $openvpn ] || exit 0 + +# See how we were called. +case "$1" in + start) + echo -n $"Starting openvpn: " + + /sbin/modprobe tun >/dev/null 2>&1 + + # From a security perspective, I think it makes + # sense to remove this, and have users who need + # it explictly enable in their --up scripts or + # firewall setups. + + #echo 1 > /proc/sys/net/ipv4/ip_forward + + # Run startup script, if defined + if [ -f $work/openvpn-startup ]; then + $work/openvpn-startup + fi + + if [ ! -d $piddir ]; then + mkdir $piddir + fi + + if [ -f $lock ]; then + # we were not shut down correctly + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi + rm -f $pidf + done + rm -f $lock + sleep 2 + fi + + rm -f $piddir/*.pid + cd $work + + # Start every .conf in $work and run .sh if exists + errors=0 + successes=0 + for c in `/bin/ls *.conf 2>/dev/null`; do + bn=${c%%.conf} + if [ -f "$bn.sh" ]; then + . $bn.sh + fi + rm -f $piddir/$bn.pid + $openvpn --daemon --writepid $piddir/$bn.pid --config $c --cd $work + if [ $? = 0 ]; then + successes=1 + else + errors=1 + fi + done + + if [ $successes = 1 ]; then + touch $lock + fi + + rc_status -v + ;; + stop) + echo -n $"Shutting down openvpn: " + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill `cat $pidf` >/dev/null 2>&1 + fi + rm -f $pidf + done + + # Run shutdown script, if defined + if [ -f $work/openvpn-shutdown ]; then + $work/openvpn-shutdown + fi + + rm -f $lock + + rc_status -v + ;; + restart) + $0 stop + sleep 2 + $0 start + + rc_status + ;; + reload) + if [ -f $lock ]; then + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill -HUP `cat $pidf` >/dev/null 2>&1 + fi + done + else + echo "openvpn: service not started" + exit 1 + fi + + rc_status -v + ;; + reopen) + if [ -f $lock ]; then + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill -USR1 `cat $pidf` >/dev/null 2>&1 + fi + done + else + echo "openvpn: service not started" + exit 1 + fi + + rc_status -v + ;; + condrestart) + if [ -f $lock ]; then + $0 stop + # avoid race + sleep 2 + $0 start + fi + + rc_status + ;; + status) + if [ -f $lock ]; then + for pidf in `/bin/ls $piddir/*.pid 2>/dev/null`; do + if [ -s $pidf ]; then + kill -USR2 `cat $pidf` >/dev/null 2>&1 + fi + done + echo "Status written to /var/log/messages" + else + echo "openvpn: service not started" + exit 1 + fi + + rc_status -v + ;; + *) + echo "Usage: openvpn {start|stop|restart|condrestart|reload|reopen|status}" + exit 1 +esac + +exit 0 diff --git a/syshead.h b/syshead.h new file mode 100644 index 0000000..0712a87 --- /dev/null +++ b/syshead.h @@ -0,0 +1,449 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef SYSHEAD_H +#define SYSHEAD_H + +#ifdef HAVE_SYS_TYPES_H +#include <sys/types.h> +#endif + +#ifdef HAVE_SYS_WAIT_H +# include <sys/wait.h> +#endif + +#ifndef WIN32 +#ifndef WEXITSTATUS +# define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8) +#endif +#ifndef WIFEXITED +# define WIFEXITED(stat_val) (((stat_val) & 255) == 0) +#endif +#endif + +#ifdef TIME_WITH_SYS_TIME +# include <sys/time.h> +# include <time.h> +#else +# ifdef HAVE_SYS_TIME_H +# include <sys/time.h> +# else +# include <time.h> +# endif +#endif + +#ifdef HAVE_SYS_SOCKET_H +#include <sys/socket.h> +#endif + +#ifdef HAVE_SYS_IOCTL_H +#include <sys/ioctl.h> +#endif + +#ifdef HAVE_SYS_STAT_H +#include <sys/stat.h> +#endif + +#ifdef HAVE_FCNTL_H +#include <fcntl.h> +#endif + +#ifdef HAVE_SYS_FILE_H +#include <sys/file.h> +#endif + +#ifdef HAVE_STDLIB_H +#include <stdlib.h> +#endif + +#ifdef HAVE_STDINT_H +#include <stdint.h> +#endif + +#ifdef HAVE_STDARG_H +#include <stdarg.h> +#endif + +#ifdef HAVE_UNISTD_H +#include <unistd.h> +#endif + +#ifdef HAVE_SIGNAL_H +#include <signal.h> +#endif + +#ifdef HAVE_STDIO_H +#include <stdio.h> +#endif + +#ifdef HAVE_CTYPE_H +#include <ctype.h> +#endif + +#ifdef HAVE_ERRNO_H +#include <errno.h> +#endif + +#ifdef HAVE_SYSLOG_H +#include <syslog.h> +#endif + +#ifdef HAVE_PWD_H +#include <pwd.h> +#endif + +#ifdef HAVE_GRP_H +#include <grp.h> +#endif + +#ifdef USE_LIBDL +#include <dlfcn.h> +#endif + +#ifdef HAVE_NETDB_H +#include <netdb.h> +#endif + +#ifdef HAVE_NETINET_IN_H +#include <netinet/in.h> +#endif + +#ifdef HAVE_SYS_POLL_H +#include <sys/poll.h> +#endif + +#ifdef HAVE_SYS_EPOLL_H +#include <sys/epoll.h> +#endif + +#ifdef TARGET_SOLARIS +#ifdef HAVE_STRINGS_H +#include <strings.h> +#endif +#else +#ifdef HAVE_STRING_H +#include <string.h> +#endif +#endif + +#ifdef HAVE_ARPA_INET_H +#include <arpa/inet.h> +#endif + +#ifdef HAVE_NET_IF_H +#include <net/if.h> +#endif + +#ifdef TARGET_LINUX + +#if defined(HAVE_NETINET_IF_ETHER_H) +#include <netinet/if_ether.h> +#endif + +#ifdef HAVE_LINUX_IF_TUN_H +#include <linux/if_tun.h> +#endif + +#ifdef HAVE_NETINET_IP_H +#include <netinet/ip.h> +#endif + +#ifdef HAVE_LINUX_SOCKIOS_H +#include <linux/sockios.h> +#endif + +#ifdef HAVE_LINUX_TYPES_H +#include <linux/types.h> +#endif + +#ifdef HAVE_LINUX_ERRQUEUE_H +#include <linux/errqueue.h> +#endif + +#endif /* TARGET_LINUX */ + +#ifdef TARGET_SOLARIS + +#ifdef HAVE_STROPTS_H +#include <stropts.h> +#undef S_ERROR +#endif + +#ifdef HAVE_NET_IF_TUN_H +#include <net/if_tun.h> +#endif + +#ifdef HAVE_SYS_SOCKIO_H +#include <sys/sockio.h> +#endif + +#ifdef HAVE_NETINET_IN_SYSTM_H +#include <netinet/in_systm.h> +#endif + +#ifdef HAVE_NETINET_IP_H +#include <netinet/ip.h> +#endif + +#ifdef HAVE_NETINET_TCP_H +#include <netinet/tcp.h> +#endif + +#endif /* TARGET_SOLARIS */ + +#ifdef TARGET_OPENBSD + +#ifdef HAVE_SYS_UIO_H +#include <sys/uio.h> +#endif + +#ifdef HAVE_NETINET_IN_SYSTM_H +#include <netinet/in_systm.h> +#endif + +#ifdef HAVE_NETINET_IP_H +#include <netinet/ip.h> +#endif + +#ifdef HAVE_NET_IF_TUN_H +#include <net/if_tun.h> +#endif + +#endif /* TARGET_OPENBSD */ + +#ifdef TARGET_FREEBSD + +#ifdef HAVE_SYS_UIO_H +#include <sys/uio.h> +#endif + +#ifdef HAVE_NETINET_IN_SYSTM_H +#include <netinet/in_systm.h> +#endif + +#ifdef HAVE_NETINET_IP_H +#include <netinet/ip.h> +#endif + +#ifdef HAVE_NET_IF_TUN_H +#include <net/if_tun.h> +#endif + +#endif /* TARGET_FREEBSD */ + +#ifdef TARGET_NETBSD + +#ifdef HAVE_NET_IF_TUN_H +#include <net/if_tun.h> +#endif + +#endif /* TARGET_NETBSD */ + +#ifdef WIN32 +#include <iphlpapi.h> +#endif + +#ifdef HAVE_SYS_MMAN_H +#ifdef TARGET_DARWIN +#define _P1003_1B_VISIBLE +#endif /* TARGET_DARWIN */ +#include <sys/mman.h> +#endif + +/* + * Pedantic mode is meant to accomplish lint-style program checking, + * not to build a working executable. + */ +#ifdef __STRICT_ANSI__ +# define PEDANTIC 1 +# undef HAVE_CPP_VARARG_MACRO_GCC +# undef HAVE_CPP_VARARG_MACRO_ISO +# undef EMPTY_ARRAY_SIZE +# define EMPTY_ARRAY_SIZE 1 +# undef inline +# define inline +#else +# define PEDANTIC 0 +#endif + +/* + * Do we have the capability to support the --passtos option? + */ +#if defined(IPPROTO_IP) && defined(IP_TOS) && defined(HAVE_SETSOCKOPT) +#define PASSTOS_CAPABILITY 1 +#else +#define PASSTOS_CAPABILITY 0 +#endif + +/* + * Do we have the capability to report extended socket errors? + */ +#if defined(HAVE_LINUX_TYPES_H) && defined(HAVE_LINUX_ERRQUEUE_H) && defined(HAVE_SOCK_EXTENDED_ERR) && defined(HAVE_MSGHDR) && defined(HAVE_CMSGHDR) && defined(CMSG_FIRSTHDR) && defined(CMSG_NXTHDR) && defined(IP_RECVERR) && defined(MSG_ERRQUEUE) && defined(SOL_IP) && defined(HAVE_IOVEC) +#define EXTENDED_SOCKET_ERROR_CAPABILITY 1 +#else +#define EXTENDED_SOCKET_ERROR_CAPABILITY 0 +#endif + +/* + * Disable ESEC + */ +#if 0 +#undef EXTENDED_SOCKET_ERROR_CAPABILITY +#define EXTENDED_SOCKET_ERROR_CAPABILITY 0 +#endif + +/* + * Do we have a syslog capability? + */ +#if defined(HAVE_OPENLOG) && defined(HAVE_SYSLOG) +#define SYSLOG_CAPABILITY 1 +#else +#define SYSLOG_CAPABILITY 0 +#endif + +/* + * Does this OS draw a distinction between binary and ascii files? + */ +#ifndef O_BINARY +#define O_BINARY 0 +#endif + +/* + * Directory separation char + */ +#ifdef WIN32 +#define OS_SPECIFIC_DIRSEP '\\' +#else +#define OS_SPECIFIC_DIRSEP '/' +#endif + +/* + * Define a boolean value based + * on Win32 status. + */ +#ifdef WIN32 +#define WIN32_0_1 1 +#else +#define WIN32_0_1 0 +#endif + +/* + * Our socket descriptor type. + */ +#ifdef WIN32 +#define SOCKET_UNDEFINED (INVALID_SOCKET) +typedef SOCKET socket_descriptor_t; +#else +#define SOCKET_UNDEFINED (-1) +typedef int socket_descriptor_t; +#endif + +static inline int +socket_defined (const socket_descriptor_t sd) +{ + return sd != SOCKET_UNDEFINED; +} + +/* + * Do we have point-to-multipoint capability? + */ + +#if defined(ENABLE_CLIENT_SERVER) && defined(USE_CRYPTO) && defined(USE_SSL) && defined(HAVE_GETTIMEOFDAY) +#define P2MP 1 +#else +#define P2MP 0 +#endif + +#if P2MP && !defined(ENABLE_CLIENT_ONLY) +#define P2MP_SERVER 1 +#else +#define P2MP_SERVER 0 +#endif + +/* + * Do we have a plug-in capability? + */ +#if defined(USE_LIBDL) || defined(USE_LOAD_LIBRARY) +#define ENABLE_PLUGIN +#endif + +/* + * Do we have pthread capability? + */ +#ifdef USE_PTHREAD +#if defined(USE_CRYPTO) && defined(USE_SSL) && P2MP +#include <pthread.h> +#else +#undef USE_PTHREAD +#endif +#endif + +/* + * Pthread support is currently experimental (and quite unfinished). + */ +#if 1 /* JYFIXME -- if defined, disable pthread */ +#undef USE_PTHREAD +#endif + +/* + * Should we include OCC (options consistency check) code? + */ +#ifndef ENABLE_SMALL +#define ENABLE_OCC +#endif + +/* + * Should we include NTLM proxy functionality + */ +#if defined(USE_CRYPTO) && defined (ENABLE_HTTP_PROXY) +#define NTLM 1 +#else +#define NTLM 0 +#endif + +/* + * Is poll available on this platform? + */ +#if defined(HAVE_POLL) && defined(HAVE_SYS_POLL_H) +#define POLL 1 +#else +#define POLL 0 +#endif + +/* + * Is epoll available on this platform? + */ +#if defined(HAVE_EPOLL_CREATE) && defined(HAVE_SYS_EPOLL_H) +#define EPOLL 1 +#else +#define EPOLL 0 +#endif + +/* Disable EPOLL */ +#if 0 +#undef EPOLL +#define EPOLL 0 +#endif + +#endif diff --git a/t_cltsrv.sh b/t_cltsrv.sh new file mode 100755 index 0000000..1e157e4 --- /dev/null +++ b/t_cltsrv.sh @@ -0,0 +1,38 @@ +#! /bin/sh +# +# t_cltsrv.sh - script to test OpenVPN's crypto loopback +# Copyright (C) 2005 Matthias Andree +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. + +set -e +echo "the following test will run about two minutes..." >&2 +trap "rm -f log.$$ ; false" 1 2 3 15 +set +e +( +./openvpn --cd "${srcdir}" --config sample-config-files/loopback-server & +./openvpn --cd "${srcdir}" --config sample-config-files/loopback-client +) >log.$$ 2>&1 +e1=$? +wait $! +e2=$? +set -e + +if [ $e1 != 0 ] || [ $e2 != 0 ] ; then + cat log.$$ + exit 1 +fi +rm log.$$ diff --git a/t_lpback.sh b/t_lpback.sh new file mode 100755 index 0000000..7cdffe4 --- /dev/null +++ b/t_lpback.sh @@ -0,0 +1,29 @@ +#! /bin/sh +# +# t_lpback.sh - script to test OpenVPN's crypto loopback +# Copyright (C) 2005 Matthias Andree +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License +# as published by the Free Software Foundation; either version 2 +# of the License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA +# 02110-1301, USA. + +set -e +trap "rm -f key.$$ log.$$ ; false" 1 2 3 15 +./openvpn --genkey --secret key.$$ +set +e +( ./openvpn --test-crypto --secret key.$$ ) >log.$$ 2>&1 +e=$? +if [ $e != 0 ] ; then cat log.$$ ; fi +rm key.$$ +exit $e diff --git a/tap-win32/MAKEFILE b/tap-win32/MAKEFILE new file mode 100755 index 0000000..6ee4f43 --- /dev/null +++ b/tap-win32/MAKEFILE @@ -0,0 +1,6 @@ +# +# DO NOT EDIT THIS FILE!!! Edit .\sources. if you want to add a new source +# file to this component. This file merely indirects to the real make file +# that is shared by all the components of NT OS/2 +# +!INCLUDE $(NTMAKEENV)\makefile.def diff --git a/tap-win32/SOURCES b/tap-win32/SOURCES new file mode 100755 index 0000000..5320ae3 --- /dev/null +++ b/tap-win32/SOURCES @@ -0,0 +1,72 @@ +# Build TAP-Win32 driver. +# Build Command: build -cef + +MAJORCOMP=ntos +MINORCOMP=ndis + +TARGETNAME=tap0801 +TARGETTYPE=DRIVER +TARGETPATH=. +TARGETLIBS=$(DDK_LIB_PATH)\ndis.lib $(DDK_LIB_PATH)\ntstrsafe.lib +INCLUDES=$(DDK_INCLUDE_PATH) + +# The TAP version numbers here must be >= +# TAP_WIN32_MIN_x values defined in +# config-win32.h +C_DEFINES= +C_DEFINES=$(C_DEFINES) -DTAP_DRIVER_MAJOR_VERSION=8 +C_DEFINES=$(C_DEFINES) -DTAP_DRIVER_MINOR_VERSION=1 + +# Use 00:FF:XX:XX:XX:XX format MAC addresses where +# the Xs are random (like Linux tap driver). +# +# Don't allow TAP device to be opened by more than one process +# at a time. +C_DEFINES=$(C_DEFINES) + +# Produce the same symbolic information for both free & checked builds. +# This will allow us to perform full source-level debugging on both +# builds without affecting the free build's performance. +!IF "$(DDKBUILDENV)" != "chk" +NTDEBUGTYPE=both +USE_PDB=1 +!ELSE +NTDEBUGTYPE=both +USE_PDB=1 +!ENDIF + +# Set compiler optimizations: +# /Ox - Full optimization enabled +# /Os - favor speed over size when optimizing +# /Od - Disable all optimizations +# /Oi - Enable optimization for intrinsic functions +# /Fc - Generate mixed assembler/source code files +# +# For both checked and free builds, make sure that any intrinsic +# functions are compiled correctly. To do this, ensure that /Oi +# is selected for both free and checked builds. There is a bug in +# VC++ 6.0 (at least through SP4) where, if you specify any +# intrinsic functions in your code with "#pragma intrinsic" but +# you don't have the /Oi optimization enabled, neither a call +# to the function, nor the intrinsic inline version of the function +# will end up in your object code. This bug only applies to free +# builds, but just to be safe we'll make sure that the flag is +# enabled for all builds. + +!IF "$(DDKBUILDENV)" != "chk" +MSC_OPTIMIZATION=/Ox /Oi /Fc +!ELSE +MSC_OPTIMIZATION=/Od /Oi /Fc +!ENDIF + +# Generate a linker map file just in case we need one for debugging +LINKER_FLAGS=$(LINKER_FLAGS) /MAP /MAPINFO:EXPORTS /MAPINFO:LINES /MAPINFO:FIXUPS + +# Generate a browser information file for use in IDE development +BROWSER_INFO=1 +BROWSERFILE=$(TARGETNAME).BSC -n + +# Abort compilation on warnings. +MSC_WARNING_LEVEL=/W3 /WX + +SOURCES=tapdrvr.c resource.rc diff --git a/tap-win32/common.h b/tap-win32/common.h new file mode 100755 index 0000000..ef121b1 --- /dev/null +++ b/tap-win32/common.h @@ -0,0 +1,75 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//=============================================== +// This file is included both by OpenVPN and +// the TAP-Win32 driver and contains definitions +// common to both. +//=============================================== + +//============= +// TAP IOCTLs +//============= + +#define TAP_CONTROL_CODE(request,method) \ + CTL_CODE (FILE_DEVICE_UNKNOWN, request, method, FILE_ANY_ACCESS) + +#define TAP_IOCTL_GET_MAC TAP_CONTROL_CODE (1, METHOD_BUFFERED) +#define TAP_IOCTL_GET_VERSION TAP_CONTROL_CODE (2, METHOD_BUFFERED) +#define TAP_IOCTL_GET_MTU TAP_CONTROL_CODE (3, METHOD_BUFFERED) +#define TAP_IOCTL_GET_INFO TAP_CONTROL_CODE (4, METHOD_BUFFERED) +#define TAP_IOCTL_CONFIG_POINT_TO_POINT TAP_CONTROL_CODE (5, METHOD_BUFFERED) +#define TAP_IOCTL_SET_MEDIA_STATUS TAP_CONTROL_CODE (6, METHOD_BUFFERED) +#define TAP_IOCTL_CONFIG_DHCP_MASQ TAP_CONTROL_CODE (7, METHOD_BUFFERED) +#define TAP_IOCTL_GET_LOG_LINE TAP_CONTROL_CODE (8, METHOD_BUFFERED) +#define TAP_IOCTL_CONFIG_DHCP_SET_OPT TAP_CONTROL_CODE (9, METHOD_BUFFERED) + +//================= +// Registry keys +//================= + +#define ADAPTER_KEY "SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E972-E325-11CE-BFC1-08002BE10318}" + +#define NETWORK_CONNECTIONS_KEY "SYSTEM\\CurrentControlSet\\Control\\Network\\{4D36E972-E325-11CE-BFC1-08002BE10318}" + +//====================== +// Filesystem prefixes +//====================== + +#define USERMODEDEVICEDIR "\\\\.\\Global\\" +#define SYSDEVICEDIR "\\Device\\" +#define USERDEVICEDIR "\\DosDevices\\Global\\" +#define TAPSUFFIX ".tap" + +//========================================================= +// TAP_COMPONENT_ID -- This string defines the TAP driver +// type -- different component IDs can reside in the system +// simultaneously. +//========================================================= + +#define TAP_COMPONENT_ID "tap0801" diff --git a/tap-win32/constants.h b/tap-win32/constants.h new file mode 100755 index 0000000..37c1335 --- /dev/null +++ b/tap-win32/constants.h @@ -0,0 +1,55 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//==================================================================== +// Product and Version public settings +//==================================================================== + +#define PRODUCT_STRING "TAP-Win32 Adapter V8" + +#define TAP_NDIS_MAJOR_VERSION 5 +#define TAP_NDIS_MINOR_VERSION 0 + +//=========================================================== +// Driver constants +//=========================================================== + +#define ETHERNET_HEADER_SIZE (sizeof (ETH_HEADER)) +#define ETHERNET_MTU 1500 +#define ETHERNET_PACKET_SIZE (ETHERNET_MTU + ETHERNET_HEADER_SIZE) +#define DEFAULT_PACKET_LOOKAHEAD (ETHERNET_PACKET_SIZE) + +#define NIC_MAX_MCAST_LIST 32 // Max length of multicast address list + +#define MINIMUM_MTU 576 // USE TCP Minimum MTU +#define MAXIMUM_MTU 65536 // IP maximum MTU + +#define PACKET_QUEUE_SIZE 64 // tap -> userspace queue size +#define IRP_QUEUE_SIZE 16 // max number of simultaneous i/o operations from userspace + +#define TAP_LITTLE_ENDIAN // affects ntohs, htonl, etc. functions diff --git a/tap-win32/dhcp.c b/tap-win32/dhcp.c new file mode 100755 index 0000000..1d8f303 --- /dev/null +++ b/tap-win32/dhcp.c @@ -0,0 +1,603 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//========================= +// Code to set DHCP options +//========================= + +VOID +SetDHCPOpt (DHCPMsg *m, void *data, unsigned int len) +{ + if (!m->overflow) + { + if (m->optlen + len <= DHCP_OPTIONS_BUFFER_SIZE) + { + if (len) + { + NdisMoveMemory (m->msg.options + m->optlen, data, len); + m->optlen += len; + } + } + else + { + m->overflow = TRUE; + } + } +} + +VOID +SetDHCPOpt0 (DHCPMsg *msg, int type) +{ + DHCPOPT0 opt; + opt.type = (UCHAR) type; + SetDHCPOpt (msg, &opt, sizeof (opt)); +} + +VOID +SetDHCPOpt8 (DHCPMsg *msg, int type, ULONG data) +{ + DHCPOPT8 opt; + opt.type = (UCHAR) type; + opt.len = sizeof (opt.data); + opt.data = (UCHAR) data; + SetDHCPOpt (msg, &opt, sizeof (opt)); +} + +VOID +SetDHCPOpt32 (DHCPMsg *msg, int type, ULONG data) +{ + DHCPOPT32 opt; + opt.type = (UCHAR) type; + opt.len = sizeof (opt.data); + opt.data = data; + SetDHCPOpt (msg, &opt, sizeof (opt)); +} + +//============== +// Checksum code +//============== + +USHORT +ip_checksum (const UCHAR *buf, const int len_ip_header) +{ + USHORT word16; + ULONG sum = 0; + int i; + + // make 16 bit words out of every two adjacent 8 bit words in the packet + // and add them up + for (i = 0; i < len_ip_header - 1; i += 2) { + word16 = ((buf[i] << 8) & 0xFF00) + (buf[i+1] & 0xFF); + sum += (ULONG) word16; + } + + // take only 16 bits out of the 32 bit sum and add up the carries + while (sum >> 16) + sum = (sum & 0xFFFF) + (sum >> 16); + + // one's complement the result + return ((USHORT) ~sum); +} + +USHORT +udp_checksum (const UCHAR *buf, + const int len_udp, + const UCHAR *src_addr, + const UCHAR *dest_addr) +{ + USHORT word16; + ULONG sum = 0; + int i; + + // make 16 bit words out of every two adjacent 8 bit words and + // calculate the sum of all 16 bit words + for (i = 0; i < len_udp; i += 2){ + word16 = ((buf[i] << 8) & 0xFF00) + ((i + 1 < len_udp) ? (buf[i+1] & 0xFF) : 0); + sum += word16; + } + + // add the UDP pseudo header which contains the IP source and destination addresses + for (i = 0; i < 4; i += 2){ + word16 =((src_addr[i] << 8) & 0xFF00) + (src_addr[i+1] & 0xFF); + sum += word16; + } + for (i = 0; i < 4; i += 2){ + word16 =((dest_addr[i] << 8) & 0xFF00) + (dest_addr[i+1] & 0xFF); + sum += word16; + } + + // the protocol number and the length of the UDP packet + sum += (USHORT) IPPROTO_UDP + (USHORT) len_udp; + + // keep only the last 16 bits of the 32 bit calculated sum and add the carries + while (sum >> 16) + sum = (sum & 0xFFFF) + (sum >> 16); + + // Take the one's complement of sum + return ((USHORT) ~sum); +} + +//================================ +// Set IP and UDP packet checksums +//================================ + +VOID +SetChecksumDHCPMsg (DHCPMsg *m) +{ + // Set IP checksum + m->msg.pre.ip.check = htons (ip_checksum ((UCHAR *) &m->msg.pre.ip, sizeof (IPHDR))); + + // Set UDP Checksum + m->msg.pre.udp.check = htons (udp_checksum ((UCHAR *) &m->msg.pre.udp, + sizeof (UDPHDR) + sizeof (DHCP) + m->optlen, + (UCHAR *)&m->msg.pre.ip.saddr, + (UCHAR *)&m->msg.pre.ip.daddr)); +} + +//=================== +// DHCP message tests +//=================== + +int +GetDHCPMessageType (const DHCP *dhcp, const int optlen) +{ + const UCHAR *p = (UCHAR *) (dhcp + 1); + int i; + + for (i = 0; i < optlen; ++i) + { + const UCHAR type = p[i]; + const int room = optlen - i - 1; + if (type == DHCP_END) // didn't find what we were looking for + return -1; + else if (type == DHCP_PAD) // no-operation + ; + else if (type == DHCP_MSG_TYPE) // what we are looking for + { + if (room >= 2) + { + if (p[i+1] == 1) // message length should be 1 + return p[i+2]; // return message type + } + return -1; + } + else // some other message + { + if (room >= 1) + { + const int len = p[i+1]; // get message length + i += (len + 1); // advance to next message + } + } + } + return -1; +} + +BOOLEAN +DHCPMessageOurs (const TapAdapterPointer p_Adapter, + const ETH_HEADER *eth, + const IPHDR *ip, + const UDPHDR *udp, + const DHCP *dhcp) +{ + // Must be UDPv4 protocol + if (!(eth->proto == htons (ETH_P_IP) && ip->protocol == IPPROTO_UDP)) + return FALSE; + + // Source MAC must be our adapter + if (!MAC_EQUAL (eth->src, p_Adapter->m_MAC)) + return FALSE; + + // Dest MAC must be either broadcast or our virtual DHCP server + if (!(MAC_EQUAL (eth->dest, p_Adapter->m_MAC_Broadcast) + || MAC_EQUAL (eth->dest, p_Adapter->m_dhcp_server_mac))) + return FALSE; + + // Port numbers must be correct + if (!(udp->dest == htons (BOOTPS_PORT) + && udp->source == htons (BOOTPC_PORT))) + return FALSE; + + // Hardware address must be MAC addr sized + if (!(dhcp->hlen == sizeof (MACADDR))) + return FALSE; + + // Hardware address must match our adapter + if (!MAC_EQUAL (eth->src, dhcp->chaddr)) + return FALSE; + + return TRUE; +} + + +//===================================================== +// Build all of DHCP packet except for DHCP options. +// Assume that *p has been zeroed before we are called. +//===================================================== + +VOID +BuildDHCPPre (const TapAdapterPointer a, + DHCPPre *p, + const ETH_HEADER *eth, + const IPHDR *ip, + const UDPHDR *udp, + const DHCP *dhcp, + const int optlen, + const int type) +{ + // Should we broadcast or direct to a specific MAC / IP address? + const BOOLEAN broadcast = (type == DHCPNAK + || MAC_EQUAL (eth->dest, a->m_MAC_Broadcast)); + // Build ethernet header + + COPY_MAC (p->eth.src, a->m_dhcp_server_mac); + + if (broadcast) + COPY_MAC (p->eth.dest, a->m_MAC_Broadcast); + else + COPY_MAC (p->eth.dest, eth->src); + + p->eth.proto = htons (ETH_P_IP); + + // Build IP header + + p->ip.version_len = (4 << 4) | (sizeof (IPHDR) >> 2); + p->ip.tos = 0; + p->ip.tot_len = htons (sizeof (IPHDR) + sizeof (UDPHDR) + sizeof (DHCP) + optlen); + p->ip.id = 0; + p->ip.frag_off = 0; + p->ip.ttl = 16; + p->ip.protocol = IPPROTO_UDP; + p->ip.check = 0; + p->ip.saddr = a->m_dhcp_server_ip; + + if (broadcast) + p->ip.daddr = ~0; + else + p->ip.daddr = a->m_dhcp_addr; + + // Build UDP header + + p->udp.source = htons (BOOTPS_PORT); + p->udp.dest = htons (BOOTPC_PORT); + p->udp.len = htons (sizeof (UDPHDR) + sizeof (DHCP) + optlen); + p->udp.check = 0; + + // Build DHCP response + + p->dhcp.op = BOOTREPLY; + p->dhcp.htype = 1; + p->dhcp.hlen = sizeof (MACADDR); + p->dhcp.hops = 0; + p->dhcp.xid = dhcp->xid; + p->dhcp.secs = 0; + p->dhcp.flags = 0; + p->dhcp.ciaddr = 0; + + if (type == DHCPNAK) + p->dhcp.yiaddr = 0; + else + p->dhcp.yiaddr = a->m_dhcp_addr; + + p->dhcp.siaddr = a->m_dhcp_server_ip; + p->dhcp.giaddr = 0; + COPY_MAC (p->dhcp.chaddr, eth->src); + p->dhcp.magic = htonl (0x63825363); +} +//============================= +// Build specific DHCP messages +//============================= + +VOID +SendDHCPMsg (const TapAdapterPointer a, + const int type, + const ETH_HEADER *eth, + const IPHDR *ip, + const UDPHDR *udp, + const DHCP *dhcp) +{ + DHCPMsg *pkt; + + if (!(type == DHCPOFFER || type == DHCPACK || type == DHCPNAK)) + { + DEBUGP (("[TAP] SendDHCPMsg: Bad DHCP type: %d\n", type)); + return; + } + + pkt = (DHCPMsg *) MemAlloc (sizeof (DHCPMsg), TRUE); + + if (pkt) + { + //----------------------- + // Build DHCP options + //----------------------- + + // Message Type + SetDHCPOpt8 (pkt, DHCP_MSG_TYPE, type); + + // Server ID + SetDHCPOpt32 (pkt, DHCP_SERVER_ID, a->m_dhcp_server_ip); + + if (type == DHCPOFFER || type == DHCPACK) + { + // Lease Time + SetDHCPOpt32 (pkt, DHCP_LEASE_TIME, htonl (a->m_dhcp_lease_time)); + + // Netmask + SetDHCPOpt32 (pkt, DHCP_NETMASK, a->m_dhcp_netmask); + + // Other user-defined options + SetDHCPOpt (pkt, + a->m_dhcp_user_supplied_options_buffer, + a->m_dhcp_user_supplied_options_buffer_len); + } + + // End + SetDHCPOpt0 (pkt, DHCP_END); + + if (!DHCPMSG_OVERFLOW (pkt)) + { + // The initial part of the DHCP message (not including options) gets built here + BuildDHCPPre (a, + &pkt->msg.pre, + eth, + ip, + udp, + dhcp, + DHCPMSG_LEN_OPT (pkt), + type); + + SetChecksumDHCPMsg (pkt); + + DUMP_PACKET ("DHCPMsg", + DHCPMSG_BUF (pkt), + DHCPMSG_LEN_FULL (pkt)); + + // Return DHCP response to kernel + InjectPacket (a, + DHCPMSG_BUF (pkt), + DHCPMSG_LEN_FULL (pkt)); + } + else + { + DEBUGP (("[TAP] SendDHCPMsg: DHCP buffer overflow\n")); + } + + MemFree (pkt, sizeof (DHCPMsg)); + } +} + +//=================================================================== +// Handle a BOOTPS packet produced by the local system to +// resolve the address/netmask of this adapter. +// If we are in TAP_IOCTL_CONFIG_DHCP_MASQ mode, reply +// to the message. Return TRUE if we processed the passed +// message, so that downstream stages can ignore it. +//=================================================================== + +BOOLEAN +ProcessDHCP (TapAdapterPointer p_Adapter, + const ETH_HEADER *eth, + const IPHDR *ip, + const UDPHDR *udp, + const DHCP *dhcp, + int optlen) +{ + int msg_type; + + // Sanity check IP header + if (!(ntohs (ip->tot_len) == sizeof (IPHDR) + sizeof (UDPHDR) + sizeof (DHCP) + optlen + && (ntohs (ip->frag_off) & IP_OFFMASK) == 0)) + return TRUE; + + // Does this message belong to us? + if (!DHCPMessageOurs (p_Adapter, eth, ip, udp, dhcp)) + return FALSE; + + msg_type = GetDHCPMessageType (dhcp, optlen); + + // Drop non-BOOTREQUEST messages + if (dhcp->op != BOOTREQUEST) + return TRUE; + + // Drop any messages except DHCPDISCOVER or DHCPREQUEST + if (!(msg_type == DHCPDISCOVER || msg_type == DHCPREQUEST)) + return TRUE; + + // Should we reply with DHCPOFFER, DHCPACK, or DHCPNAK? + if (msg_type == DHCPREQUEST + && ((dhcp->ciaddr && dhcp->ciaddr != p_Adapter->m_dhcp_addr) + || !p_Adapter->m_dhcp_received_discover + || p_Adapter->m_dhcp_bad_requests >= BAD_DHCPREQUEST_NAK_THRESHOLD)) + SendDHCPMsg (p_Adapter, + DHCPNAK, + eth, ip, udp, dhcp); + else + SendDHCPMsg (p_Adapter, + (msg_type == DHCPDISCOVER ? DHCPOFFER : DHCPACK), + eth, ip, udp, dhcp); + + // Remember if we received a DHCPDISCOVER + if (msg_type == DHCPDISCOVER) + p_Adapter->m_dhcp_received_discover = TRUE; + + // Is this a bad DHCPREQUEST? + if (msg_type == DHCPREQUEST && dhcp->ciaddr != p_Adapter->m_dhcp_addr) + ++p_Adapter->m_dhcp_bad_requests; + + return TRUE; +} + +#if DBG + +const char * +message_op_text (int op) +{ + switch (op) + { + case BOOTREQUEST: + return "BOOTREQUEST"; + case BOOTREPLY: + return "BOOTREPLY"; + default: + return "???"; + } +} + +const char * +message_type_text (int type) +{ + switch (type) + { + case DHCPDISCOVER: + return "DHCPDISCOVER"; + case DHCPOFFER: + return "DHCPOFFER"; + case DHCPREQUEST: + return "DHCPREQUEST"; + case DHCPDECLINE: + return "DHCPDECLINE"; + case DHCPACK: + return "DHCPACK"; + case DHCPNAK: + return "DHCPNAK"; + case DHCPRELEASE: + return "DHCPRELEASE"; + case DHCPINFORM: + return "DHCPINFORM"; + default: + return "???"; + } +} + +const char * +port_name (int port) +{ + switch (port) + { + case BOOTPS_PORT: + return "BOOTPS"; + case BOOTPC_PORT: + return "BOOTPC"; + default: + return "unknown"; + } +} + +VOID +DumpDHCP (const ETH_HEADER *eth, + const IPHDR *ip, + const UDPHDR *udp, + const DHCP *dhcp, + const int optlen) +{ + DEBUGP ((" %s", message_op_text (dhcp->op))); + DEBUGP ((" %s ", message_type_text (GetDHCPMessageType (dhcp, optlen)))); + PrIP (ip->saddr); + DEBUGP ((":%s[", port_name (ntohs (udp->source)))); + PrMac (eth->src); + DEBUGP (("] -> ")); + PrIP (ip->daddr); + DEBUGP ((":%s[", port_name (ntohs (udp->dest)))); + PrMac (eth->dest); + DEBUGP (("]")); + if (dhcp->ciaddr) + { + DEBUGP ((" ci=")); + PrIP (dhcp->ciaddr); + } + if (dhcp->yiaddr) + { + DEBUGP ((" yi=")); + PrIP (dhcp->yiaddr); + } + if (dhcp->siaddr) + { + DEBUGP ((" si=")); + PrIP (dhcp->siaddr); + } + if (dhcp->hlen == sizeof (MACADDR)) + { + DEBUGP ((" ch=")); + PrMac (dhcp->chaddr); + } + + DEBUGP ((" xid=0x%08x", ntohl (dhcp->xid))); + + if (ntohl (dhcp->magic) != 0x63825363) + DEBUGP ((" ma=0x%08x", ntohl (dhcp->magic))); + if (dhcp->htype != 1) + DEBUGP ((" htype=%d", dhcp->htype)); + if (dhcp->hops) + DEBUGP ((" hops=%d", dhcp->hops)); + if (ntohs (dhcp->secs)) + DEBUGP ((" secs=%d", ntohs (dhcp->secs))); + if (ntohs (dhcp->flags)) + DEBUGP ((" flags=0x%04x", ntohs (dhcp->flags))); + + // extra stuff + + if (ip->version_len != 0x45) + DEBUGP ((" vl=0x%02x", ip->version_len)); + if (ntohs (ip->tot_len) != sizeof (IPHDR) + sizeof (UDPHDR) + sizeof (DHCP) + optlen) + DEBUGP ((" tl=%d", ntohs (ip->tot_len))); + if (ntohs (udp->len) != sizeof (UDPHDR) + sizeof (DHCP) + optlen) + DEBUGP ((" ul=%d", ntohs (udp->len))); + + if (ip->tos) + DEBUGP ((" tos=0x%02x", ip->tos)); + if (ntohs (ip->id)) + DEBUGP ((" id=0x%04x", ntohs (ip->id))); + if (ntohs (ip->frag_off)) + DEBUGP ((" frag_off=0x%04x", ntohs (ip->frag_off))); + + DEBUGP ((" ttl=%d", ip->ttl)); + DEBUGP ((" ic=0x%04x [0x%04x]", ntohs (ip->check), + ip_checksum ((UCHAR*)ip, sizeof (IPHDR)))); + DEBUGP ((" uc=0x%04x [0x%04x/%d]", ntohs (udp->check), + udp_checksum ((UCHAR *) udp, + sizeof (UDPHDR) + sizeof (DHCP) + optlen, + (UCHAR *) &ip->saddr, + (UCHAR *) &ip->daddr), + optlen)); + + // Options + { + const UCHAR *opt = (UCHAR *) (dhcp + 1); + int i; + + DEBUGP ((" OPT")); + for (i = 0; i < optlen; ++i) + { + const UCHAR data = opt[i]; + DEBUGP ((".%d", data)); + } + } +} + +#endif /* DBG */ diff --git a/tap-win32/dhcp.h b/tap-win32/dhcp.h new file mode 100755 index 0000000..8a573f8 --- /dev/null +++ b/tap-win32/dhcp.h @@ -0,0 +1,168 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#pragma pack(1) + +//=================================================== +// How many bad DHCPREQUESTs do we receive before we +// return a NAK? +// +// A bad DHCPREQUEST is defined to be one where the +// requestor doesn't know its IP address. +//=================================================== + +#define BAD_DHCPREQUEST_NAK_THRESHOLD 3 + +//============================================== +// Maximum number of DHCP options bytes supplied +//============================================== + +#define DHCP_USER_SUPPLIED_OPTIONS_BUFFER_SIZE 256 +#define DHCP_OPTIONS_BUFFER_SIZE 256 + +//=================================== +// UDP port numbers of DHCP messages. +//=================================== + +#define BOOTPS_PORT 67 +#define BOOTPC_PORT 68 + +//=========================== +// The DHCP message structure +//=========================== + +typedef struct { +# define BOOTREQUEST 1 +# define BOOTREPLY 2 + UCHAR op; /* message op */ + + UCHAR htype; /* hardware address type (e.g. '1' = 10Mb Ethernet) */ + UCHAR hlen; /* hardware address length (e.g. '6' for 10Mb Ethernet) */ + UCHAR hops; /* client sets to 0, may be used by relay agents */ + ULONG xid; /* transaction ID, chosen by client */ + USHORT secs; /* seconds since request process began, set by client */ + USHORT flags; + ULONG ciaddr; /* client IP address, client sets if known */ + ULONG yiaddr; /* 'your' IP address -- server's response to client */ + ULONG siaddr; /* server IP address */ + ULONG giaddr; /* relay agent IP address */ + UCHAR chaddr[16]; /* client hardware address */ + UCHAR sname[64]; /* optional server host name */ + UCHAR file[128]; /* boot file name */ + ULONG magic; /* must be 0x63825363 (network order) */ +} DHCP; + +typedef struct { + ETH_HEADER eth; + IPHDR ip; + UDPHDR udp; + DHCP dhcp; +} DHCPPre; + +typedef struct { + DHCPPre pre; + UCHAR options[DHCP_OPTIONS_BUFFER_SIZE]; +} DHCPFull; + +typedef struct { + unsigned int optlen; + BOOLEAN overflow; + DHCPFull msg; +} DHCPMsg; + +//=================== +// Macros for DHCPMSG +//=================== + +#define DHCPMSG_LEN_BASE(p) (sizeof (DHCPPre)) +#define DHCPMSG_LEN_OPT(p) ((p)->optlen) +#define DHCPMSG_LEN_FULL(p) (DHCPMSG_LEN_BASE(p) + DHCPMSG_LEN_OPT(p)) +#define DHCPMSG_BUF(p) ((UCHAR*) &(p)->msg) +#define DHCPMSG_OVERFLOW(p) ((p)->overflow) + +//======================================== +// structs to hold individual DHCP options +//======================================== + +typedef struct { + UCHAR type; +} DHCPOPT0; + +typedef struct { + UCHAR type; + UCHAR len; + UCHAR data; +} DHCPOPT8; + +typedef struct { + UCHAR type; + UCHAR len; + ULONG data; +} DHCPOPT32; + +#pragma pack() + +//================== +// DHCP Option types +//================== + +#define DHCP_MSG_TYPE 53 /* message type (u8) */ +#define DHCP_PARM_REQ 55 /* parameter request list: c1 (u8), ... */ +#define DHCP_CLIENT_ID 61 /* client ID: type (u8), i1 (u8), ... */ +#define DHCP_IP 50 /* requested IP addr (u32) */ +#define DHCP_NETMASK 1 /* subnet mask (u32) */ +#define DHCP_LEASE_TIME 51 /* lease time sec (u32) */ +#define DHCP_RENEW_TIME 58 /* renewal time sec (u32) */ +#define DHCP_REBIND_TIME 59 /* rebind time sec (u32) */ +#define DHCP_SERVER_ID 54 /* server ID: IP addr (u32) */ +#define DHCP_PAD 0 +#define DHCP_END 255 + +//==================== +// DHCP Messages types +//==================== + +#define DHCPDISCOVER 1 +#define DHCPOFFER 2 +#define DHCPREQUEST 3 +#define DHCPDECLINE 4 +#define DHCPACK 5 +#define DHCPNAK 6 +#define DHCPRELEASE 7 +#define DHCPINFORM 8 + +#if DBG + +VOID +DumpDHCP (const ETH_HEADER *eth, + const IPHDR *ip, + const UDPHDR *udp, + const DHCP *dhcp, + const int optlen); + +#endif diff --git a/tap-win32/endian.h b/tap-win32/endian.h new file mode 100755 index 0000000..3032dea --- /dev/null +++ b/tap-win32/endian.h @@ -0,0 +1,39 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device + * functionality on Windows. Originally derived + * from the CIPE-Win32 project by Damion K. Wilson, + * with extensive modifications by James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef TAP_LITTLE_ENDIAN +#define ntohs(x) RtlUshortByteSwap(x) +#define htons(x) RtlUshortByteSwap(x) +#define ntohl(x) RtlUlongByteSwap(x) +#define htonl(x) RtlUlongByteSwap(x) +#else +#define ntohs(x) ((USHORT)(x)) +#define htons(x) ((USHORT)(x)) +#define ntohl(x) ((ULONG)(x)) +#define htonl(x) ((ULONG)(x)) +#endif diff --git a/tap-win32/error.c b/tap-win32/error.c new file mode 100755 index 0000000..3e52eb0 --- /dev/null +++ b/tap-win32/error.c @@ -0,0 +1,382 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//----------------- +// DEBUGGING OUTPUT +//----------------- + +const char *g_LastErrorFilename; +int g_LastErrorLineNumber; + +#if DBG + +DebugOutput g_Debug; + +BOOLEAN +NewlineExists (const char *str, int len) +{ + while (len-- > 0) + { + const char c = *str++; + if (c == '\n') + return TRUE; + else if (c == '\0') + break; + } + return FALSE; +} + +VOID +MyDebugInit (unsigned int bufsiz) +{ + NdisZeroMemory (&g_Debug, sizeof (g_Debug)); + g_Debug.text = (char *) MemAlloc (bufsiz, FALSE); + if (g_Debug.text) + g_Debug.capacity = bufsiz; +} + +VOID +MyDebugFree () +{ + if (g_Debug.text) + MemFree (g_Debug.text, g_Debug.capacity); + NdisZeroMemory (&g_Debug, sizeof (g_Debug)); +} + +VOID +MyDebugPrint (const unsigned char* format, ...) +{ + if (g_Debug.text && g_Debug.capacity > 0 && CAN_WE_PRINT) + { + BOOLEAN owned; + ACQUIRE_MUTEX_ADAPTIVE (&g_Debug.lock, owned); + if (owned) + { + const int remaining = (int)g_Debug.capacity - (int)g_Debug.out; + + if (remaining > 0) + { + va_list args; + NTSTATUS status; + char *end; + + va_start (args, format); + status = RtlStringCchVPrintfExA (g_Debug.text + g_Debug.out, + remaining, + &end, + NULL, + STRSAFE_NO_TRUNCATION | STRSAFE_IGNORE_NULLS, + format, + args); + va_end (args); + + if (status == STATUS_SUCCESS) + g_Debug.out = end - g_Debug.text; + else + g_Debug.error = TRUE; + } + else + g_Debug.error = TRUE; + + RELEASE_MUTEX (&g_Debug.lock); + } + else + g_Debug.error = TRUE; + } +} + +BOOLEAN +GetDebugLine (char *buf, const int len) +{ + static const char *truncated = "[OUTPUT TRUNCATED]\n"; + BOOLEAN ret = FALSE; + + NdisZeroMemory (buf, len); + + if (g_Debug.text && g_Debug.capacity > 0) + { + BOOLEAN owned; + ACQUIRE_MUTEX_ADAPTIVE (&g_Debug.lock, owned); + if (owned) + { + int i = 0; + + if (g_Debug.error || NewlineExists (g_Debug.text + g_Debug.in, (int)g_Debug.out - (int)g_Debug.in)) + { + while (i < (len - 1) && g_Debug.in < g_Debug.out) + { + const char c = g_Debug.text[g_Debug.in++]; + if (c == '\n') + break; + buf[i++] = c; + } + if (i < len) + buf[i] = '\0'; + } + + if (!i) + { + if (g_Debug.in == g_Debug.out) + { + g_Debug.in = g_Debug.out = 0; + if (g_Debug.error) + { + const unsigned int tlen = strlen (truncated); + if (tlen < g_Debug.capacity) + { + NdisMoveMemory (g_Debug.text, truncated, tlen+1); + g_Debug.out = tlen; + } + g_Debug.error = FALSE; + } + } + } + else + ret = TRUE; + + RELEASE_MUTEX (&g_Debug.lock); + } + } + return ret; +} + +VOID +MyAssert (const unsigned char *file, int line) +{ + DEBUGP (("MYASSERT failed %s/%d\n", file, line)); + KeBugCheckEx (0x0F00BABA, + (ULONG_PTR) line, + (ULONG_PTR) 0, + (ULONG_PTR) 0, + (ULONG_PTR) 0); +} + +VOID +PrMac (const MACADDR mac) +{ + DEBUGP (("%x:%x:%x:%x:%x:%x", + mac[0], mac[1], mac[2], + mac[3], mac[4], mac[5])); +} + +VOID +PrIP (IPADDR ip_addr) +{ + const unsigned char *ip = (const unsigned char *) &ip_addr; + + DEBUGP (("%d.%d.%d.%d", + ip[0], ip[1], ip[2], ip[3])); +} + +const char * +PrIPProto (int proto) +{ + switch (proto) + { + case IPPROTO_UDP: + return "UDP"; + case IPPROTO_TCP: + return "TCP"; + case IPPROTO_ICMP: + return "ICMP"; + case IPPROTO_IGMP: + return "IGMP"; + default: + return "???"; + } +} + +VOID +DumpARP (const char *prefix, const ARP_PACKET *arp) +{ + DEBUGP (("%s ARP src=", prefix)); + PrMac (arp->m_MAC_Source); + DEBUGP ((" dest=")); + PrMac (arp->m_MAC_Destination); + DEBUGP ((" OP=0x%04x", + (int)ntohs(arp->m_ARP_Operation))); + DEBUGP ((" M=0x%04x(%d)", + (int)ntohs(arp->m_MAC_AddressType), + (int)arp->m_MAC_AddressSize)); + DEBUGP ((" P=0x%04x(%d)", + (int)ntohs(arp->m_PROTO_AddressType), + (int)arp->m_PROTO_AddressSize)); + + DEBUGP ((" MacSrc=")); + PrMac (arp->m_ARP_MAC_Source); + DEBUGP ((" MacDest=")); + PrMac (arp->m_ARP_MAC_Destination); + + DEBUGP ((" IPSrc=")); + PrIP (arp->m_ARP_IP_Source); + DEBUGP ((" IPDest=")); + PrIP (arp->m_ARP_IP_Destination); + + DEBUGP (("\n")); +} + +struct ethpayload { + ETH_HEADER eth; + UCHAR payload[DEFAULT_PACKET_LOOKAHEAD]; +}; + +VOID +DumpPacket2 (const char *prefix, + const ETH_HEADER *eth, + const unsigned char *data, + unsigned int len) +{ + struct ethpayload *ep = (struct ethpayload *) MemAlloc (sizeof (struct ethpayload), TRUE); + if (ep) + { + if (len > DEFAULT_PACKET_LOOKAHEAD) + len = DEFAULT_PACKET_LOOKAHEAD; + ep->eth = *eth; + NdisMoveMemory (ep->payload, data, len); + DumpPacket (prefix, (unsigned char *) ep, sizeof (ETH_HEADER) + len); + MemFree (ep, sizeof (struct ethpayload)); + } +} + +VOID +DumpPacket (const char *prefix, + const unsigned char *data, + unsigned int len) +{ + const ETH_HEADER *eth = (const ETH_HEADER *) data; + const IPHDR *ip = (const IPHDR *) (data + sizeof (ETH_HEADER)); + + if (len < sizeof (ETH_HEADER)) + { + DEBUGP (("%s TRUNCATED PACKET LEN=%d\n", prefix, len)); + return; + } + + // ARP Packet? + if (len >= sizeof (ARP_PACKET) && eth->proto == htons (ETH_P_ARP)) + { + DumpARP (prefix, (const ARP_PACKET *) data); + return; + } + + // IPv4 packet? + if (len >= (sizeof (IPHDR) + sizeof (ETH_HEADER)) + && eth->proto == htons (ETH_P_IP) + && IPH_GET_VER (ip->version_len) == 4) + { + const int hlen = IPH_GET_LEN (ip->version_len); + const int blen = len - sizeof (ETH_HEADER); + BOOLEAN did = FALSE; + + DEBUGP (("%s IPv4 %s[%d]", prefix, PrIPProto (ip->protocol), len)); + + if (!(ntohs (ip->tot_len) == blen && hlen <= blen)) + { + DEBUGP ((" XXX")); + return; + } + + // TCP packet? + if (ip->protocol == IPPROTO_TCP + && blen - hlen >= (sizeof (TCPHDR))) + { + const TCPHDR *tcp = (TCPHDR *) (data + sizeof (ETH_HEADER) + hlen); + DEBUGP ((" ")); + PrIP (ip->saddr); + DEBUGP ((":%d", ntohs (tcp->source))); + DEBUGP ((" -> ")); + PrIP (ip->daddr); + DEBUGP ((":%d", ntohs (tcp->dest))); + did = TRUE; + } + + // UDP packet? + else if ((ntohs (ip->frag_off) & IP_OFFMASK) == 0 + && ip->protocol == IPPROTO_UDP + && blen - hlen >= (sizeof (UDPHDR))) + { + const UDPHDR *udp = (UDPHDR *) (data + sizeof (ETH_HEADER) + hlen); + + // DHCP packet? + if ((udp->dest == htons (BOOTPC_PORT) || udp->dest == htons (BOOTPS_PORT)) + && blen - hlen >= (sizeof (UDPHDR) + sizeof (DHCP))) + { + const DHCP *dhcp = (DHCP *) (data + + hlen + + sizeof (ETH_HEADER) + + sizeof (UDPHDR)); + + int optlen = len + - sizeof (ETH_HEADER) + - hlen + - sizeof (UDPHDR) + - sizeof (DHCP); + + if (optlen < 0) + optlen = 0; + + DumpDHCP (eth, ip, udp, dhcp, optlen); + did = TRUE; + } + + if (!did) + { + DEBUGP ((" ")); + PrIP (ip->saddr); + DEBUGP ((":%d", ntohs (udp->source))); + DEBUGP ((" -> ")); + PrIP (ip->daddr); + DEBUGP ((":%d", ntohs (udp->dest))); + did = TRUE; + } + } + + if (!did) + { + DEBUGP ((" ipproto=%d ", ip->protocol)); + PrIP (ip->saddr); + DEBUGP ((" -> ")); + PrIP (ip->daddr); + } + + DEBUGP (("\n")); + return; + } + + { + DEBUGP (("%s ??? src=", prefix)); + PrMac (eth->src); + DEBUGP ((" dest=")); + PrMac (eth->dest); + DEBUGP ((" proto=0x%04x len=%d\n", + (int) ntohs(eth->proto), + len)); + } +} + +#endif diff --git a/tap-win32/error.h b/tap-win32/error.h new file mode 100755 index 0000000..21137e5 --- /dev/null +++ b/tap-win32/error.h @@ -0,0 +1,92 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//----------------- +// DEBUGGING OUTPUT +//----------------- + +#define NOTE_ERROR() \ +{ \ + g_LastErrorFilename = __FILE__; \ + g_LastErrorLineNumber = __LINE__; \ +} + +#if DBG + +typedef struct { + unsigned int in; + unsigned int out; + unsigned int capacity; + char *text; + BOOLEAN error; + MUTEX lock; +} DebugOutput; + +VOID MyDebugPrint (const unsigned char* format, ...); + +VOID MyAssert (const unsigned char *file, int line); + +VOID DumpPacket (const char *prefix, + const unsigned char *data, + unsigned int len); + +VOID DumpPacket2 (const char *prefix, + const ETH_HEADER *eth, + const unsigned char *data, + unsigned int len); + +#define CAN_WE_PRINT (DEBUGP_AT_DISPATCH || KeGetCurrentIrql () < DISPATCH_LEVEL) + +#if ALSO_DBGPRINT +#define DEBUGP(fmt) { MyDebugPrint fmt; if (CAN_WE_PRINT) DbgPrint fmt; } +#else +#define DEBUGP(fmt) { MyDebugPrint fmt; } +#endif + +#define MYASSERT(exp) \ +{ \ + if (!(exp)) \ + { \ + MyAssert(__FILE__, __LINE__); \ + } \ +} + +#define DUMP_PACKET(prefix, data, len) \ + DumpPacket (prefix, data, len) + +#define DUMP_PACKET2(prefix, eth, data, len) \ + DumpPacket2 (prefix, eth, data, len) + +#else + +#define DEBUGP(fmt) +#define MYASSERT(exp) +#define DUMP_PACKET(prefix, data, len) +#define DUMP_PACKET2(prefix, eth, data, len) + +#endif diff --git a/tap-win32/hexdump.c b/tap-win32/hexdump.c new file mode 100755 index 0000000..69ca418 --- /dev/null +++ b/tap-win32/hexdump.c @@ -0,0 +1,73 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include "hexdump.h" + +#ifndef NDIS_MINIPORT_DRIVER + +VOID (*DbgMessage)(char *p_Format, ...) = DisplayDebugString; + +VOID DisplayDebugString (char *p_Format, ...) + { + static char l_Buffer [4096]; + + va_list l_ArgumentList; + va_start (l_ArgumentList, p_Format); + vsprintf (l_Buffer, p_Format, l_ArgumentList); + va_end (l_ArgumentList); + + OutputDebugStringA (l_Buffer); + } + +#endif + +VOID HexDump (unsigned char *p_Buffer, unsigned long p_Size) + { + unsigned long l_Index, l_Idx; + unsigned char l_Row [17]; + + for (l_Index = l_Row [16] = 0; l_Index < p_Size || l_Index % 16; ++l_Index) + { + if (l_Index % 16 == 0) + DEBUGP (("%05x ", l_Index)); + DEBUGP (("%02x ", l_Row [l_Index % 16] = (l_Index < p_Size ? p_Buffer [l_Index] : 0))); + l_Row [l_Index % 16] = IfPrint (l_Row [l_Index % 16]); + if ((l_Index + 1) % 16 == 0) + DEBUGP ((" %s\n", l_Row)); + } + + DEBUGP (("\n")); + } + +#ifdef __cplusplus +} +#endif diff --git a/tap-win32/hexdump.h b/tap-win32/hexdump.h new file mode 100755 index 0000000..4963dbf --- /dev/null +++ b/tap-win32/hexdump.h @@ -0,0 +1,67 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef HEXDUMP_DEFINED +#define HEXDUMP_DEFINED + +#ifdef __cplusplus +extern "C" { +#endif + +//===================================================================================== +// Debug Routines +//===================================================================================== + +#ifndef NDIS_MINIPORT_DRIVER +# include <stdio.h> +# include <ctype.h> +# include <windows.h> +# include <winnt.h> +# include <memory.h> + +# ifndef DEBUGP +# define DEBUGP(fmt) { DbgMessage fmt; } +# endif + + extern VOID (*DbgMessage)(char *p_Format, ...); + + VOID DisplayDebugString (char *p_Format, ...); +#endif + +//=================================================================================== +// Reporting / Debugging +//=================================================================================== +#define IfPrint(c) (c >= 32 && c < 127 ? c : '.') + +VOID HexDump (unsigned char *p_Buffer, unsigned long p_Size); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/tap-win32/i386/OemWin2k.inf b/tap-win32/i386/OemWin2k.inf new file mode 100755 index 0000000..eb1e071 --- /dev/null +++ b/tap-win32/i386/OemWin2k.inf @@ -0,0 +1,172 @@ +; **************************************************************************** +; * Copyright (C) 2002-2005 OpenVPN Solutions LLC * +; * This program is free software; you can redistribute it and/or modify * +; * it under the terms of the GNU General Public License version 2 * +; * as published by the Free Software Foundation. * +; **************************************************************************** + +; SYNTAX CHECKER +; cd \WINDDK\3790\tools\chkinf +; chkinf c:\src\openvpn\tap-win32\i386\oemwin2k.inf +; OUTPUT -> file:///c:/WINDDK/3790/tools/chkinf/htm/c%23+src+openvpn+tap-win32+i386+__OemWin2k.htm + +;********************************************************* +; Note to Developers: +; +; If you are bundling the TAP-Win32 driver with your app, +; you should try to rename it in such a way that it will +; not collide with other instances of TAP-Win32 defined +; by other apps. Multiple versions of the TAP-Win32 +; driver, each installed by different apps, can coexist +; on the same machine if you follow these guidelines: +; +; (1) Rename all tapXXXX instances in this file to +; something different (use at least 5 characters +; for this name!) +; (2) Change the "!define TAP" definition in openvpn.nsi +; to match what you changed tapXXXX to. +; (3) Change TARGETNAME in SOURCES to match what you +; changed tapXXXX to. +; (4) Change TAP_COMPONENT_ID in common.h to match what +; you changed tapXXXX to. +; (5) Change SZDEPENDENCIES in service.h to match what +; you changed tapXXXX to. +; (6) Change DeviceDescription and Provider strings. +; (7) Change PRODUCT_STRING in constants.h to what you +; set DeviceDescription to. +; +;********************************************************* + +[Version] + Signature = "$Windows NT$" + CatalogFile = tap.cat + ClassGUID = {4d36e972-e325-11ce-bfc1-08002be10318} + Provider = %Provider% + Class = Net + +; This version number should match the version +; number given in SOURCES. + DriverVer=05/15/2004,8.00.00.0001 + +[Strings] + DeviceDescription = "TAP-Win32 Adapter V8" + Provider = "TAP-Win32 Provider" + +;---------------------------------------------------------------- +; Manufacturer + Product Section (Done) +;---------------------------------------------------------------- +[Manufacturer] + %Provider% = tap0801 + +[tap0801] + %DeviceDescription% = tap0801.ndi, tap0801 + +;--------------------------------------------------------------- +; Driver Section (Done) +;--------------------------------------------------------------- + +;----------------- Characteristics ------------ +; NCF_PHYSICAL = 0x04 +; NCF_VIRTUAL = 0x01 +; NCF_SOFTWARE_ENUMERATED = 0x02 +; NCF_HIDDEN = 0x08 +; NCF_NO_SERVICE = 0x10 +; NCF_HAS_UI = 0x80 +;----------------- Characteristics ------------ + +[tap0801.ndi] + CopyFiles = tap0801.driver, tap0801.files + AddReg = tap0801.reg + AddReg = tap0801.params.reg + Characteristics = 0x81 + +[tap0801.ndi.Services] + AddService = tap0801, 2, tap0801.service + +[tap0801.reg] + HKR, Ndi, Service, 0, "tap0801" + HKR, Ndi\Interfaces, UpperRange, 0, "ndis5" + HKR, Ndi\Interfaces, LowerRange, 0, "ethernet" + HKR, , Manufacturer, 0, "%Provider%" + HKR, , ProductName, 0, "%DeviceDescription%" + +[tap0801.params.reg] + HKR, Ndi\params\MTU, ParamDesc, 0, "MTU" + HKR, Ndi\params\MTU, Type, 0, "int" + HKR, Ndi\params\MTU, Default, 0, "1500" + HKR, Ndi\params\MTU, Optional, 0, "0" + HKR, Ndi\params\MTU, Min, 0, "100" + HKR, Ndi\params\MTU, Max, 0, "1500" + HKR, Ndi\params\MTU, Step, 0, "1" + HKR, Ndi\params\MediaStatus, ParamDesc, 0, "Media Status" + HKR, Ndi\params\MediaStatus, Type, 0, "enum" + HKR, Ndi\params\MediaStatus, Default, 0, "0" + HKR, Ndi\params\MediaStatus, Optional, 0, "0" + HKR, Ndi\params\MediaStatus\enum, "0", 0, "Application Controlled" + HKR, Ndi\params\MediaStatus\enum, "1", 0, "Always Connected" + HKR, Ndi\params\MAC, ParamDesc, 0, "MAC Address" + HKR, Ndi\params\MAC, Type, 0, "edit" + HKR, Ndi\params\MAC, Optional, 0, "1" + +;---------------------------------------------------------------- +; Service Section +;---------------------------------------------------------------- + +;---------- Service Type ------------- +; SERVICE_KERNEL_DRIVER = 0x01 +; SERVICE_WIN32_OWN_PROCESS = 0x10 +;---------- Service Type ------------- + +;---------- Start Mode --------------- +; SERVICE_BOOT_START = 0x0 +; SERVICE_SYSTEM_START = 0x1 +; SERVICE_AUTO_START = 0x2 +; SERVICE_DEMAND_START = 0x3 +; SERVICE_DISABLED = 0x4 +;---------- Start Mode --------------- + +[tap0801.service] + DisplayName = %DeviceDescription% + ServiceType = 1 + StartType = 3 + ErrorControl = 1 + LoadOrderGroup = NDIS + ServiceBinary = %12%\tap0801.sys + +;----------------------------------------------------------------- +; File Installation +;----------------------------------------------------------------- + +;----------------- Copy Flags ------------ +; COPYFLG_NOSKIP = 0x02 +; COPYFLG_NOVERSIONCHECK = 0x04 +;----------------- Copy Flags ------------ + +; SourceDisksNames +; diskid = description[, [tagfile] [, <unused>, subdir]] +; 1 = "Intel Driver Disk 1",e100bex.sys,, + +[SourceDisksNames] + 1 = %DeviceDescription%, tap0801.sys + +; SourceDisksFiles +; filename_on_source = diskID[, [subdir][, size]] +; e100bex.sys = 1,, ; on distribution disk 1 + +[SourceDisksFiles] +tap0801.sys = 1 + +[DestinationDirs] + tap0801.files = 11 + tap0801.driver = 12 + +[tap0801.files] +; TapPanel.cpl,,,6 ; COPYFLG_NOSKIP | COPYFLG_NOVERSIONCHECK +; cipsrvr.exe,,,6 ; COPYFLG_NOSKIP | COPYFLG_NOVERSIONCHECK + +[tap0801.driver] + tap0801.sys,,,6 ; COPYFLG_NOSKIP | COPYFLG_NOVERSIONCHECK + +;--------------------------------------------------------------- +; End +;--------------------------------------------------------------- diff --git a/tap-win32/i386/tap.cat b/tap-win32/i386/tap.cat new file mode 100755 index 0000000..4492fa2 --- /dev/null +++ b/tap-win32/i386/tap.cat @@ -0,0 +1,6 @@ +; **************************************************************************** +; * Copyright (C) 2002-2005 OpenVPN Solutions LLC * +; * This program is free software; you can redistribute it and/or modify * +; * it under the terms of the GNU General Public License version 2 * +; * as published by the Free Software Foundation. * +; **************************************************************************** diff --git a/tap-win32/instance.c b/tap-win32/instance.c new file mode 100755 index 0000000..53c800c --- /dev/null +++ b/tap-win32/instance.c @@ -0,0 +1,245 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device + * functionality on Windows. Originally derived + * from the CIPE-Win32 project by Damion K. Wilson, + * with extensive modifications by James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#define INSTANCE_KEY(a) ((PVOID)((a)->m_Extension.m_TapDevice)) + +#define N_INSTANCE_BUCKETS 256 + +typedef struct _INSTANCE { + struct _INSTANCE *next; + TapAdapterPointer m_Adapter; +} INSTANCE; + +typedef struct { + INSTANCE *list; + MUTEX lock; +} INSTANCE_BUCKET; + +typedef struct { + INSTANCE_BUCKET buckets[N_INSTANCE_BUCKETS]; +} INSTANCE_HASH; + +INSTANCE_HASH *g_InstanceHash = NULL; + +// must return a hash >= 0 and < N_INSTANCE_BUCKETS +int +InstanceHashValue (PVOID addr) +{ + UCHAR *p = (UCHAR *) &addr; + + if (sizeof (addr) == 4) + return p[0] ^ p[1] ^ p[2] ^ p[3]; + else if (sizeof (addr) == 8) + return p[0] ^ p[1] ^ p[2] ^ p[3] ^ p[4] ^ p[5] ^ p[6] ^ p[7]; + else + { + MYASSERT (0); + } +} + +BOOLEAN +InitInstanceList (VOID) +{ + MYASSERT (g_InstanceHash == NULL); + g_InstanceHash = MemAlloc (sizeof (INSTANCE_HASH), TRUE); + if (g_InstanceHash) + { + int i; + for (i = 0; i < N_INSTANCE_BUCKETS; ++i) + INIT_MUTEX (&g_InstanceHash->buckets[i].lock); + return TRUE; + } + else + return FALSE; +} + +int +NInstances (VOID) +{ + int i, n = 0; + + if (g_InstanceHash) + { + for (i = 0; i < N_INSTANCE_BUCKETS; ++i) + { + BOOLEAN got_lock; + INSTANCE_BUCKET *ib = &g_InstanceHash->buckets[i]; + ACQUIRE_MUTEX_ADAPTIVE (&ib->lock, got_lock); + + if (got_lock) + { + INSTANCE *current; + for (current = ib->list; current != NULL; current = current->next) + ++n; + RELEASE_MUTEX (&ib->lock); + } + else + return -1; + } + } + + return n; +} + +int +InstanceMaxBucketSize (VOID) +{ + int i, n = 0; + + if (g_InstanceHash) + { + for (i = 0; i < N_INSTANCE_BUCKETS; ++i) + { + BOOLEAN got_lock; + int bucket_size = 0; + INSTANCE_BUCKET *ib = &g_InstanceHash->buckets[i]; + ACQUIRE_MUTEX_ADAPTIVE (&ib->lock, got_lock); + + if (got_lock) + { + INSTANCE *current; + for (current = ib->list; current != NULL; current = current->next) + ++bucket_size; + if (bucket_size > n) + n = bucket_size; + RELEASE_MUTEX (&ib->lock); + } + else + return -1; + } + } + + return n; +} + +VOID +FreeInstanceList (VOID) +{ + if (g_InstanceHash) + { + MYASSERT (NInstances() == 0); + MemFree (g_InstanceHash, sizeof (INSTANCE_HASH)); + g_InstanceHash = NULL; + } +} + +BOOLEAN +AddAdapterToInstanceList (TapAdapterPointer p_Adapter) +{ + BOOLEAN got_lock; + BOOLEAN ret = FALSE; + const int hash = InstanceHashValue(INSTANCE_KEY(p_Adapter)); + INSTANCE_BUCKET *ib = &g_InstanceHash->buckets[hash]; + + DEBUGP (("[TAP] AddAdapterToInstanceList hash=%d\n", hash)); + + ACQUIRE_MUTEX_ADAPTIVE (&ib->lock, got_lock); + + if (got_lock) + { + INSTANCE *i = MemAlloc (sizeof (INSTANCE), FALSE); + if (i) + { + MYASSERT (p_Adapter); + i->m_Adapter = p_Adapter; + i->next = ib->list; + ib->list = i; + ret = TRUE; + } + RELEASE_MUTEX (&ib->lock); + } + + return ret; +} + +BOOLEAN +RemoveAdapterFromInstanceList (TapAdapterPointer p_Adapter) +{ + BOOLEAN got_lock; + BOOLEAN ret = FALSE; + INSTANCE_BUCKET *ib = &g_InstanceHash->buckets[InstanceHashValue(INSTANCE_KEY(p_Adapter))]; + + ACQUIRE_MUTEX_ADAPTIVE (&ib->lock, got_lock); + + if (got_lock) + { + INSTANCE *current, *prev=NULL; + for (current = ib->list; current != NULL; current = current->next) + { + if (current->m_Adapter == p_Adapter) // found match + { + if (prev) + prev->next = current->next; + else + ib->list = current->next; + MemFree (current->m_Adapter, sizeof (TapAdapter)); + MemFree (current, sizeof (INSTANCE)); + ret = TRUE; + break; + } + prev = current; + } + RELEASE_MUTEX (&ib->lock); + } + + return ret; +} + +TapAdapterPointer +LookupAdapterInInstanceList (PDEVICE_OBJECT p_DeviceObject) +{ + BOOLEAN got_lock; + TapAdapterPointer ret = NULL; + INSTANCE_BUCKET *ib = &g_InstanceHash->buckets[InstanceHashValue((PVOID)p_DeviceObject)]; + + ACQUIRE_MUTEX_ADAPTIVE (&ib->lock, got_lock); + + if (got_lock) + { + INSTANCE *current, *prev=NULL; + for (current = ib->list; current != NULL; current = current->next) + { + if (p_DeviceObject == INSTANCE_KEY (current->m_Adapter)) // found match + { + // move it to head of list + if (prev) + { + prev->next = current->next; + current->next = ib->list; + ib->list = current; + } + ret = ib->list->m_Adapter; + break; + } + prev = current; + } + RELEASE_MUTEX (&ib->lock); + } + + return ret; +} diff --git a/tap-win32/lock.h b/tap-win32/lock.h new file mode 100755 index 0000000..8598f31 --- /dev/null +++ b/tap-win32/lock.h @@ -0,0 +1,79 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device + * functionality on Windows. Originally derived + * from the CIPE-Win32 project by Damion K. Wilson, + * with extensive modifications by James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +typedef struct +{ + volatile long count; +} MUTEX; + +#define MUTEX_SLEEP_TIME 10000 // microseconds + +#define INIT_MUTEX(m) { (m)->count = 0; } + +#define ACQUIRE_MUTEX_BLOCKING(m) \ +{ \ + while (NdisInterlockedIncrement (&((m)->count)) != 1) \ + { \ + NdisInterlockedDecrement(&((m)->count)); \ + NdisMSleep(MUTEX_SLEEP_TIME); \ + } \ +} + +#define RELEASE_MUTEX(m) \ +{ \ + NdisInterlockedDecrement(&((m)->count)); \ +} + +#define ACQUIRE_MUTEX_NONBLOCKING(m, result) \ +{ \ + if (NdisInterlockedIncrement (&((m)->count)) != 1) \ + { \ + NdisInterlockedDecrement(&((m)->count)); \ + result = FALSE; \ + } \ + else \ + { \ + result = TRUE; \ + } \ +} + +#define ACQUIRE_MUTEX_ADAPTIVE(m, result) \ +{ \ + result = TRUE; \ + while (NdisInterlockedIncrement (&((m)->count)) != 1) \ + { \ + NdisInterlockedDecrement(&((m)->count)); \ + if (KeGetCurrentIrql () < DISPATCH_LEVEL) \ + NdisMSleep(MUTEX_SLEEP_TIME); \ + else \ + { \ + result = FALSE; \ + break; \ + } \ + } \ +} diff --git a/tap-win32/macinfo.c b/tap-win32/macinfo.c new file mode 100755 index 0000000..bc75f3d --- /dev/null +++ b/tap-win32/macinfo.c @@ -0,0 +1,158 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#include "macinfo.h" + +int +HexStringToDecimalInt (const int p_Character) +{ + int l_Value = 0; + + if (p_Character >= 'A' && p_Character <= 'F') + l_Value = (p_Character - 'A') + 10; + else if (p_Character >= 'a' && p_Character <= 'f') + l_Value = (p_Character - 'a') + 10; + else if (p_Character >= '0' && p_Character <= '9') + l_Value = p_Character - '0'; + + return l_Value; +} + +BOOLEAN +ParseMAC (MACADDR dest, const char *src) +{ + int c; + int mac_index = 0; + BOOLEAN high_digit = FALSE; + int delim_action = 1; + + MYASSERT (src); + MYASSERT (dest); + + CLEAR_MAC (dest); + + while (c = *src++) + { + if (IsMacDelimiter (c)) + { + mac_index += delim_action; + high_digit = FALSE; + delim_action = 1; + } + else if (IsHexDigit (c)) + { + const int digit = HexStringToDecimalInt (c); + if (mac_index < sizeof (MACADDR)) + { + if (!high_digit) + { + dest[mac_index] = (char)(digit); + high_digit = TRUE; + delim_action = 1; + } + else + { + dest[mac_index] = (char)(dest[mac_index] * 16 + digit); + ++mac_index; + high_digit = FALSE; + delim_action = 0; + } + } + else + return FALSE; + } + else + return FALSE; + } + + return (mac_index + delim_action) >= sizeof (MACADDR); +} + +/* + * Generate a MAC using the GUID in the adapter name. + * + * The mac is constructed as 00:FF:xx:xx:xx:xx where + * the Xs are taken from the first 32 bits of the GUID in the + * adapter name. This is similar to the Linux 2.4 tap MAC + * generator, except linux uses 32 random bits for the Xs. + * + * In general, this solution is reasonable for most + * applications except for very large bridged TAP networks, + * where the probability of address collisions becomes more + * than infintesimal. + * + * Using the well-known "birthday paradox", on a 1000 node + * network the probability of collision would be + * 0.000116292153. On a 10,000 node network, the probability + * of collision would be 0.01157288998621678766. + */ + +VOID GenerateRandomMac (MACADDR mac, const unsigned char *adapter_name) +{ + unsigned const char *cp = adapter_name; + unsigned char c; + unsigned int i = 2; + unsigned int byte = 0; + int brace = 0; + int state = 0; + + CLEAR_MAC (mac); + + mac[0] = 0x00; + mac[1] = 0xFF; + + while (c = *cp++) + { + if (i >= sizeof (MACADDR)) + break; + if (c == '{') + brace = 1; + if (IsHexDigit (c) && brace) + { + const unsigned int digit = HexStringToDecimalInt (c); + if (state) + { + byte <<= 4; + byte |= digit; + mac[i++] = (unsigned char) byte; + state = 0; + } + else + { + byte = digit; + state = 1; + } + } + } +} + +VOID GenerateRelatedMAC (MACADDR dest, const MACADDR src, const int delta) +{ + COPY_MAC (dest, src); + dest[2] += (UCHAR) delta; +} diff --git a/tap-win32/macinfo.h b/tap-win32/macinfo.h new file mode 100755 index 0000000..71a17c3 --- /dev/null +++ b/tap-win32/macinfo.h @@ -0,0 +1,42 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef MacInfoDefined +#define MacInfoDefined + +//=================================================================================== +// Macros +//=================================================================================== +#define IsMacDelimiter(a) (a == ':' || a == '-' || a == '.') +#define IsHexDigit(c) ((c >= '0' && c <= '9') || (c >= 'A' && c <= 'F') || (c >= 'a' && c <= 'f')) + +#define COPY_MAC(dest, src) NdisMoveMemory ((dest), (src), sizeof (MACADDR)) +#define CLEAR_MAC(dest) NdisZeroMemory ((dest), sizeof (MACADDR)) +#define MAC_EQUAL(a,b) (memcmp ((a), (b), sizeof (MACADDR)) == 0) + +#endif diff --git a/tap-win32/mem.c b/tap-win32/mem.c new file mode 100755 index 0000000..5df7206 --- /dev/null +++ b/tap-win32/mem.c @@ -0,0 +1,190 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//------------------ +// Memory Management +//------------------ + +PVOID +MemAlloc (ULONG p_Size, BOOLEAN zero) +{ + PVOID l_Return = NULL; + + if (p_Size) + { + __try + { + if (NdisAllocateMemoryWithTag (&l_Return, p_Size, 'APAT') + == NDIS_STATUS_SUCCESS) + { + if (zero) + NdisZeroMemory (l_Return, p_Size); + } + else + l_Return = NULL; + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + l_Return = NULL; + } + } + + return l_Return; +} + +VOID +MemFree (PVOID p_Addr, ULONG p_Size) +{ + if (p_Addr && p_Size) + { + __try + { +#if DBG + NdisZeroMemory (p_Addr, p_Size); +#endif + NdisFreeMemory (p_Addr, p_Size, 0); + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + } + } +} + +/* + * Circular queue management routines. + */ + +#define QUEUE_BYTE_ALLOCATION(size) \ + (sizeof (Queue) + (size * sizeof (PVOID))) + +#define QUEUE_ADD_INDEX(var, inc) \ +{ \ + var += inc; \ + if (var >= q->capacity) \ + var -= q->capacity; \ + MYASSERT (var < q->capacity); \ +} + +#define QUEUE_SANITY_CHECK() \ + MYASSERT (q != NULL && q->base < q->capacity && q->size <= q->capacity) + +#define QueueCount(q) (q->size) + +#define UPDATE_MAX_SIZE() \ +{ \ + if (q->size > q->max_size) \ + q->max_size = q->size; \ +} + +Queue * +QueueInit (ULONG capacity) +{ + Queue *q; + + MYASSERT (capacity > 0); + q = (Queue *) MemAlloc (QUEUE_BYTE_ALLOCATION (capacity), TRUE); + if (!q) + return NULL; + + q->base = q->size = 0; + q->capacity = capacity; + q->max_size = 0; + return q; +} + +VOID +QueueFree (Queue *q) +{ + if (q) + { + QUEUE_SANITY_CHECK (); + MemFree (q, QUEUE_BYTE_ALLOCATION (q->capacity)); + } +} + +PVOID +QueuePush (Queue *q, PVOID item) +{ + ULONG dest; + QUEUE_SANITY_CHECK (); + if (q->size == q->capacity) + return NULL; + dest = q->base; + QUEUE_ADD_INDEX (dest, q->size); + q->data[dest] = item; + ++q->size; + UPDATE_MAX_SIZE(); + return item; +} + +PVOID +QueuePop (Queue *q) +{ + ULONG oldbase; + QUEUE_SANITY_CHECK (); + if (!q->size) + return NULL; + oldbase = q->base; + QUEUE_ADD_INDEX (q->base, 1); + --q->size; + UPDATE_MAX_SIZE(); + return q->data[oldbase]; +} + +PVOID +QueueExtract (Queue *q, PVOID item) +{ + ULONG src, dest, count, n; + QUEUE_SANITY_CHECK (); + n = 0; + src = dest = q->base; + count = q->size; + while (count--) + { + if (item == q->data[src]) + { + ++n; + --q->size; + } + else + { + q->data[dest] = q->data[src]; + QUEUE_ADD_INDEX (dest, 1); + } + QUEUE_ADD_INDEX (src, 1); + } + if (n) + return item; + else + return NULL; +} + +#undef QUEUE_BYTE_ALLOCATION +#undef QUEUE_ADD_INDEX +#undef QUEUE_SANITY_CHECK +#undef UPDATE_MAX_SIZE diff --git a/tap-win32/proto.h b/tap-win32/proto.h new file mode 100755 index 0000000..6a70beb --- /dev/null +++ b/tap-win32/proto.h @@ -0,0 +1,168 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//============================================================ +// MAC address, Ethernet header, and ARP +//============================================================ + +#pragma pack(1) + +#define IP_HEADER_SIZE 20 + +typedef unsigned char MACADDR [6]; +typedef unsigned long IPADDR; + +//----------------- +// Ethernet address +//----------------- + +typedef struct { + MACADDR addr; +} ETH_ADDR; + +typedef struct { + ETH_ADDR list[NIC_MAX_MCAST_LIST]; +} MC_LIST; + +//---------------- +// Ethernet header +//---------------- + +typedef struct +{ + MACADDR dest; /* destination eth addr */ + MACADDR src; /* source ether addr */ + +# define ETH_P_IP 0x0800 /* IPv4 protocol */ +# define ETH_P_ARP 0x0806 /* ARP protocol */ + USHORT proto; /* packet type ID field */ +} ETH_HEADER, *PETH_HEADER; + +//---------------- +// ARP packet +//---------------- + +typedef struct + { + MACADDR m_MAC_Destination; // Reverse these two + MACADDR m_MAC_Source; // to answer ARP requests + USHORT m_Proto; // 0x0806 + +# define MAC_ADDR_TYPE 0x0001 + USHORT m_MAC_AddressType; // 0x0001 + + USHORT m_PROTO_AddressType; // 0x0800 + UCHAR m_MAC_AddressSize; // 0x06 + UCHAR m_PROTO_AddressSize; // 0x04 + +# define ARP_REQUEST 0x0001 +# define ARP_REPLY 0x0002 + USHORT m_ARP_Operation; // 0x0001 for ARP request, 0x0002 for ARP reply + + MACADDR m_ARP_MAC_Source; + IPADDR m_ARP_IP_Source; + MACADDR m_ARP_MAC_Destination; + IPADDR m_ARP_IP_Destination; + } +ARP_PACKET, *PARP_PACKET; + +//---------- +// IP Header +//---------- + +typedef struct { +# define IPH_GET_VER(v) (((v) >> 4) & 0x0F) +# define IPH_GET_LEN(v) (((v) & 0x0F) << 2) + UCHAR version_len; + + UCHAR tos; + USHORT tot_len; + USHORT id; + +# define IP_OFFMASK 0x1fff + USHORT frag_off; + + UCHAR ttl; + +# define IPPROTO_UDP 17 /* UDP protocol */ +# define IPPROTO_TCP 6 /* TCP protocol */ +# define IPPROTO_ICMP 1 /* ICMP protocol */ +# define IPPROTO_IGMP 2 /* IGMP protocol */ + UCHAR protocol; + + USHORT check; + ULONG saddr; + ULONG daddr; + /* The options start here. */ +} IPHDR; + +//----------- +// UDP header +//----------- + +typedef struct { + USHORT source; + USHORT dest; + USHORT len; + USHORT check; +} UDPHDR; + +//-------------------------- +// TCP header, per RFC 793. +//-------------------------- + +typedef struct { + USHORT source; /* source port */ + USHORT dest; /* destination port */ + ULONG seq; /* sequence number */ + ULONG ack_seq; /* acknowledgement number */ + +# define TCPH_GET_DOFF(d) (((d) & 0xF0) >> 2) + UCHAR doff_res; + +# define TCPH_FIN_MASK (1<<0) +# define TCPH_SYN_MASK (1<<1) +# define TCPH_RST_MASK (1<<2) +# define TCPH_PSH_MASK (1<<3) +# define TCPH_ACK_MASK (1<<4) +# define TCPH_URG_MASK (1<<5) +# define TCPH_ECE_MASK (1<<6) +# define TCPH_CWR_MASK (1<<7) + UCHAR flags; + + USHORT window; + USHORT check; + USHORT urg_ptr; +} TCPHDR; + +#define TCPOPT_EOL 0 +#define TCPOPT_NOP 1 +#define TCPOPT_MAXSEG 2 +#define TCPOLEN_MAXSEG 4 + +#pragma pack() diff --git a/tap-win32/prototypes.h b/tap-win32/prototypes.h new file mode 100755 index 0000000..81f58f4 --- /dev/null +++ b/tap-win32/prototypes.h @@ -0,0 +1,187 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef TAP_PROTOTYPES_DEFINED +#define TAP_PROTOTYPES_DEFINED + +NTSTATUS DriverEntry + ( + IN PDRIVER_OBJECT p_DriverObject, + IN PUNICODE_STRING p_RegistryPath + ); + +VOID TapDriverUnload + ( + IN PDRIVER_OBJECT p_DriverObject + ); + +NDIS_STATUS AdapterCreate + ( + OUT PNDIS_STATUS p_ErrorStatus, + OUT PUINT p_MediaIndex, + IN PNDIS_MEDIUM p_Media, + IN UINT p_MediaCount, + IN NDIS_HANDLE p_AdapterHandle, + IN NDIS_HANDLE p_ConfigurationHandle + ); + +VOID AdapterHalt + ( + IN NDIS_HANDLE p_AdapterContext + ); + +VOID AdapterFreeResources + ( + TapAdapterPointer p_Adapter + ); + +NDIS_STATUS AdapterReset + ( + OUT PBOOLEAN p_AddressingReset, + IN NDIS_HANDLE p_AdapterContext + ); + +NDIS_STATUS AdapterQuery + ( + IN NDIS_HANDLE p_AdapterContext, + IN NDIS_OID p_OID, + IN PVOID p_Buffer, + IN ULONG p_BufferLength, + OUT PULONG p_BytesWritten, + OUT PULONG p_BytesNeeded + ); + +NDIS_STATUS AdapterModify + ( + IN NDIS_HANDLE p_AdapterContext, + IN NDIS_OID p_OID, + IN PVOID p_Buffer, + IN ULONG p_BufferLength, + OUT PULONG p_BytesRead, + OUT PULONG p_BytesNeeded + ); + +NDIS_STATUS AdapterTransmit + ( + IN NDIS_HANDLE p_AdapterContext, + IN PNDIS_PACKET p_Packet, + IN UINT p_Flags + ); + +NDIS_STATUS AdapterReceive + ( + OUT PNDIS_PACKET p_Packet, + OUT PUINT p_Transferred, + IN NDIS_HANDLE p_AdapterContext, + IN NDIS_HANDLE p_ReceiveContext, + IN UINT p_Offset, + IN UINT p_ToTransfer + ); + +NTSTATUS TapDeviceHook + ( + IN PDEVICE_OBJECT p_DeviceObject, + IN PIRP p_IRP + ); + +NDIS_STATUS CreateTapDevice + ( + TapExtensionPointer p_Extension, + const char *p_Name + ); + +VOID DestroyTapDevice + ( + TapExtensionPointer p_Extension + ); + +VOID TapDeviceFreeResources + ( + TapExtensionPointer p_Extension + ); + +NTSTATUS CompleteIRP + ( + IN PIRP p_IRP, + IN TapPacketPointer p_PacketBuffer, + IN CCHAR PriorityBoost + ); + +VOID CancelIRPCallback + ( + IN PDEVICE_OBJECT p_DeviceObject, + IN PIRP p_IRP + ); + +VOID CancelIRP + ( + TapExtensionPointer p_Extension, + IN PIRP p_IRP, + BOOLEAN callback + ); + +VOID FlushQueues + ( + TapExtensionPointer p_Extension + ); + +VOID ResetTapAdapterState + ( + TapAdapterPointer p_Adapter + ); + +BOOLEAN ProcessARP + ( + TapAdapterPointer p_Adapter, + const PARP_PACKET src, + const IPADDR adapter_ip, + const IPADDR ip, + const MACADDR mac + ); + +VOID SetMediaStatus + ( + TapAdapterPointer p_Adapter, + BOOLEAN state + ); + +VOID InjectPacket + ( + TapAdapterPointer p_Adapter, + UCHAR *packet, + const unsigned int len + ); + +VOID CheckIfDhcpAndPointToPointMode + ( + TapAdapterPointer p_Adapter + ); + +VOID HookDispatchFunctions(); + +#endif diff --git a/tap-win32/resource.rc b/tap-win32/resource.rc new file mode 100755 index 0000000..726e287 --- /dev/null +++ b/tap-win32/resource.rc @@ -0,0 +1,59 @@ +#include <windows.h> +#include <ntverp.h> + +/* get VERSION */ +#include "../config-win32.h" +#include "common.h" + +/* VER_FILETYPE, VER_FILESUBTYPE, VER_FILEDESCRIPTION_STR + * and VER_INTERNALNAME_STR must be defined before including COMMON.VER + * The strings don't need a '\0', since common.ver has them. + */ + +#define VER_FILETYPE VFT_DRV +/* possible values: VFT_UNKNOWN + VFT_APP + VFT_DLL + VFT_DRV + VFT_FONT + VFT_VXD + VFT_STATIC_LIB +*/ +#define VER_FILESUBTYPE VFT2_DRV_NETWORK +/* possible values VFT2_UNKNOWN + VFT2_DRV_PRINTER + VFT2_DRV_KEYBOARD + VFT2_DRV_LANGUAGE + VFT2_DRV_DISPLAY + VFT2_DRV_MOUSE + VFT2_DRV_NETWORK + VFT2_DRV_SYSTEM + VFT2_DRV_INSTALLABLE + VFT2_DRV_SOUND + VFT2_DRV_COMM +*/ + +#define VER_COMPANYNAME_STR "The OpenVPN Project" +#define VER_FILEDESCRIPTION_STR "TAP-Win32 Virtual Network Driver" +#define VER_ORIGINALFILENAME_STR TAP_COMPONENT_ID ".sys" +#define VER_LEGALCOPYRIGHT_YEARS "2003-2004" +#define VER_LEGALCOPYRIGHT_STR "OpenVPN Solutions LLC and Damion K. Wilson" + + +#define VER_PRODUCTNAME_STR VER_FILEDESCRIPTION_STR +#define VER_PRODUCTVERSION TAP_DRIVER_MAJOR_VERSION,00,00,TAP_DRIVER_MINOR_VERSION + +#define XSTR(s) STR(s) +#define STR(s) #s + +#define VSTRING VERSION " " XSTR(TAP_DRIVER_MAJOR_VERSION) "/" XSTR(TAP_DRIVER_MINOR_VERSION) + +#ifdef DBG +#define VER_PRODUCTVERSION_STR VSTRING " (DEBUG)" +#else +#define VER_PRODUCTVERSION_STR VSTRING +#endif + +#define VER_INTERNALNAME_STR VER_ORIGINALFILENAME_STR + +#include "common.ver" diff --git a/tap-win32/tapdrvr.c b/tap-win32/tapdrvr.c new file mode 100755 index 0000000..7eecca7 --- /dev/null +++ b/tap-win32/tapdrvr.c @@ -0,0 +1,2531 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device + * functionality on Windows. Originally derived + * from the CIPE-Win32 project by Damion K. Wilson, + * with extensive modifications by James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +//====================================================== +// This driver is designed to work on Win 2000 or higher +// versions of Windows. +// +// It is SMP-safe and handles NDIS 5 power management. +// +// By default we operate as a "tap" virtual ethernet +// 802.3 interface, but we can emulate a "tun" +// interface (point-to-point IPv4) through the +// TAP_IOCTL_CONFIG_POINT_TO_POINT ioctl. +//====================================================== + +#define NDIS_MINIPORT_DRIVER +#define BINARY_COMPATIBLE 0 +#define NDIS50_MINIPORT 1 +#define NDIS_WDM 0 +#define NDIS50 1 +#define NTSTRSAFE_LIB + +// Debug info output +#define ALSO_DBGPRINT 1 +#define DEBUGP_AT_DISPATCH 0 + +#include <ndis.h> +#include <ntstrsafe.h> + +#include "lock.h" +#include "constants.h" +#include "common.h" +#include "proto.h" +#include "error.h" +#include "endian.h" +#include "dhcp.h" +#include "types.h" +#include "prototypes.h" + +#include "mem.c" +#include "macinfo.c" +#include "error.c" +#include "dhcp.c" +#include "instance.c" + +#define IS_UP(ta) \ + ((ta)->m_InterfaceIsRunning && (ta)->m_Extension.m_TapIsRunning) + +#define INCREMENT_STAT(s) ++(s) + +#define NAME_BUFFER_SIZE 80 + +//======================================================== +// Globals +//======================================================== + +NDIS_HANDLE g_NdisWrapperHandle; + +const UINT g_SupportedOIDList[] = { + OID_GEN_HARDWARE_STATUS, + OID_GEN_MEDIA_SUPPORTED, + OID_GEN_MEDIA_IN_USE, + OID_GEN_MAXIMUM_LOOKAHEAD, + OID_GEN_MAC_OPTIONS, + OID_GEN_LINK_SPEED, + OID_GEN_TRANSMIT_BLOCK_SIZE, + OID_GEN_RECEIVE_BLOCK_SIZE, + OID_GEN_VENDOR_DESCRIPTION, + OID_GEN_DRIVER_VERSION, + OID_GEN_XMIT_OK, + OID_GEN_RCV_OK, + OID_GEN_XMIT_ERROR, + OID_GEN_RCV_ERROR, + OID_802_3_PERMANENT_ADDRESS, + OID_802_3_CURRENT_ADDRESS, + OID_GEN_RCV_NO_BUFFER, + OID_802_3_RCV_ERROR_ALIGNMENT, + OID_802_3_XMIT_ONE_COLLISION, + OID_802_3_XMIT_MORE_COLLISIONS, + OID_802_3_MULTICAST_LIST, + OID_802_3_MAXIMUM_LIST_SIZE, + OID_GEN_VENDOR_ID, + OID_GEN_CURRENT_LOOKAHEAD, + OID_GEN_CURRENT_PACKET_FILTER, + OID_GEN_PROTOCOL_OPTIONS, + OID_GEN_MAXIMUM_TOTAL_SIZE, + OID_GEN_TRANSMIT_BUFFER_SPACE, + OID_GEN_RECEIVE_BUFFER_SPACE, + OID_GEN_MAXIMUM_FRAME_SIZE, + OID_GEN_VENDOR_DRIVER_VERSION, + OID_GEN_MAXIMUM_SEND_PACKETS, + OID_GEN_MEDIA_CONNECT_STATUS, + OID_GEN_SUPPORTED_LIST +}; + +//============================================================ +// Driver Entry +//============================================================ +#pragma NDIS_INIT_FUNCTION (DriverEntry) + +NTSTATUS +DriverEntry (IN PDRIVER_OBJECT p_DriverObject, + IN PUNICODE_STRING p_RegistryPath) +{ + NDIS_STATUS l_Status = NDIS_STATUS_FAILURE; + NDIS_MINIPORT_CHARACTERISTICS *l_Properties = NULL; + + //======================================================== + // Notify NDIS that a new miniport driver is initializing. + //======================================================== + + NdisMInitializeWrapper (&g_NdisWrapperHandle, + p_DriverObject, + p_RegistryPath, NULL); + + //====================== + // Global initialization + //====================== + +#if DBG + MyDebugInit (10000); // Allocate debugging text space +#endif + + if (!InitInstanceList ()) + { + DEBUGP (("[TAP] Allocation failed for adapter instance list\n")); + goto cleanup; + } + + //======================================= + // Set and register miniport entry points + //======================================= + + l_Properties = MemAlloc (sizeof (NDIS_MINIPORT_CHARACTERISTICS), TRUE); + + if (l_Properties == NULL) + { + DEBUGP (("[TAP] Allocation failed for miniport entry points\n")); + goto cleanup; + } + + l_Properties->MajorNdisVersion = TAP_NDIS_MAJOR_VERSION; + l_Properties->MinorNdisVersion = TAP_NDIS_MINOR_VERSION; + l_Properties->InitializeHandler = AdapterCreate; + l_Properties->HaltHandler = AdapterHalt; + l_Properties->ResetHandler = AdapterReset; /* DISPATCH_LEVEL */ + l_Properties->TransferDataHandler = AdapterReceive; /* DISPATCH_LEVEL */ + l_Properties->SendHandler = AdapterTransmit; /* DISPATCH_LEVEL */ + l_Properties->QueryInformationHandler = AdapterQuery; /* DISPATCH_LEVEL */ + l_Properties->SetInformationHandler = AdapterModify; /* DISPATCH_LEVEL */ + + switch (l_Status = + NdisMRegisterMiniport (g_NdisWrapperHandle, l_Properties, + sizeof (NDIS_MINIPORT_CHARACTERISTICS))) + { + case NDIS_STATUS_SUCCESS: + { + DEBUGP (("[TAP] version [%d.%d] %s %s registered miniport successfully\n", + TAP_DRIVER_MAJOR_VERSION, + TAP_DRIVER_MINOR_VERSION, + __DATE__, + __TIME__)); + DEBUGP (("Registry Path: '%S'\n", p_RegistryPath->Buffer)); + break; + } + + case NDIS_STATUS_BAD_CHARACTERISTICS: + { + DEBUGP (("[TAP] Miniport characteristics were badly defined\n")); + NdisTerminateWrapper (g_NdisWrapperHandle, NULL); + break; + } + + case NDIS_STATUS_BAD_VERSION: + { + DEBUGP + (("[TAP] NDIS Version is wrong for the given characteristics\n")); + NdisTerminateWrapper (g_NdisWrapperHandle, NULL); + break; + } + + case NDIS_STATUS_RESOURCES: + { + DEBUGP (("[TAP] Insufficient resources\n")); + NdisTerminateWrapper (g_NdisWrapperHandle, NULL); + break; + } + + default: + case NDIS_STATUS_FAILURE: + { + DEBUGP (("[TAP] Unknown fatal registration error\n")); + NdisTerminateWrapper (g_NdisWrapperHandle, NULL); + break; + } + } + + cleanup: + if (l_Properties) + MemFree (l_Properties, sizeof (NDIS_MINIPORT_CHARACTERISTICS)); + + if (l_Status == NDIS_STATUS_SUCCESS) + NdisMRegisterUnloadHandler (g_NdisWrapperHandle, TapDriverUnload); + else + TapDriverUnload (p_DriverObject); + + return l_Status; +} + +//============================================================ +// Driver Unload +//============================================================ +VOID +TapDriverUnload (IN PDRIVER_OBJECT p_DriverObject) +{ + DEBUGP (("[TAP] version [%d.%d] %s %s unloaded, instances=%d, imbs=%d\n", + TAP_DRIVER_MAJOR_VERSION, + TAP_DRIVER_MINOR_VERSION, + __DATE__, + __TIME__, + NInstances(), + InstanceMaxBucketSize())); + + FreeInstanceList (); + + //============================== + // Free debugging text space + //============================== +#if DBG + MyDebugFree (); +#endif +} + +//========================================================== +// Adapter Initialization +//========================================================== +NDIS_STATUS AdapterCreate + (OUT PNDIS_STATUS p_ErrorStatus, + OUT PUINT p_MediaIndex, + IN PNDIS_MEDIUM p_Media, + IN UINT p_MediaCount, + IN NDIS_HANDLE p_AdapterHandle, + IN NDIS_HANDLE p_ConfigurationHandle) +{ + TapAdapterPointer l_Adapter = NULL; + + NDIS_MEDIUM l_PreferredMedium = NdisMedium802_3; // Ethernet + BOOLEAN l_MacFromRegistry = FALSE; + UINT l_Index; + NDIS_STATUS status; + + //==================================== + // Make sure adapter type is supported + //==================================== + + for (l_Index = 0; + l_Index < p_MediaCount && p_Media[l_Index] != l_PreferredMedium; + ++l_Index); + + if (l_Index == p_MediaCount) + { + DEBUGP (("[TAP] Unsupported adapter type [wanted: %d]\n", + l_PreferredMedium)); + return NDIS_STATUS_UNSUPPORTED_MEDIA; + } + + *p_MediaIndex = l_Index; + + //========================================= + // Allocate memory for TapAdapter structure + //========================================= + + l_Adapter = MemAlloc (sizeof (TapAdapter), TRUE); + + if (l_Adapter == NULL) + { + DEBUGP (("[TAP] Couldn't allocate adapter memory\n")); + return NDIS_STATUS_RESOURCES; + } + + //========================================== + // Inform the NDIS library about significant + // features of our virtual NIC. + //========================================== + + NdisMSetAttributesEx + (p_AdapterHandle, + (NDIS_HANDLE) l_Adapter, + 16, + NDIS_ATTRIBUTE_DESERIALIZE + | NDIS_ATTRIBUTE_IGNORE_PACKET_TIMEOUT + | NDIS_ATTRIBUTE_IGNORE_REQUEST_TIMEOUT + | NDIS_ATTRIBUTE_NO_HALT_ON_SUSPEND, + NdisInterfaceInternal); + + //===================================== + // Initialize simple Adapter parameters + //===================================== + + l_Adapter->m_Lookahead = DEFAULT_PACKET_LOOKAHEAD; + l_Adapter->m_Medium = l_PreferredMedium; + l_Adapter->m_DeviceState = '?'; + l_Adapter->m_MiniportAdapterHandle = p_AdapterHandle; + + //================================== + // Allocate spinlock for controlling + // access to multicast address list. + //================================== + NdisAllocateSpinLock (&l_Adapter->m_MCLock); + l_Adapter->m_MCLockAllocated = TRUE; + + //==================================================== + // Register a shutdown handler which will be called + // on system restart/shutdown to halt our virtual NIC. + //==================================================== + + NdisMRegisterAdapterShutdownHandler (p_AdapterHandle, l_Adapter, + AdapterHalt); + l_Adapter->m_RegisteredAdapterShutdownHandler = TRUE; + + //==================================== + // Allocate and construct adapter name + //==================================== + + if (RtlUnicodeStringToAnsiString ( + &l_Adapter->m_NameAnsi, + &((PNDIS_MINIPORT_BLOCK) p_AdapterHandle)->MiniportName, + TRUE) != STATUS_SUCCESS) + { + AdapterFreeResources (l_Adapter); + return NDIS_STATUS_RESOURCES; + } + + //============================================ + // Get parameters from registry which were set + // in the adapter advanced properties dialog. + //============================================ + { + NDIS_STATUS status; + NDIS_HANDLE configHandle; + NDIS_CONFIGURATION_PARAMETER *parm; + + // set defaults in case our registry query fails + l_Adapter->m_MTU = ETHERNET_MTU; + l_Adapter->m_MediaStateAlwaysConnected = FALSE; + l_Adapter->m_MediaState = FALSE; + + NdisOpenConfiguration (&status, &configHandle, p_ConfigurationHandle); + if (status == NDIS_STATUS_SUCCESS) + { + /* Read MTU setting from registry */ + { + NDIS_STRING key = NDIS_STRING_CONST("MTU"); + NdisReadConfiguration (&status, &parm, configHandle, + &key, NdisParameterInteger); + if (status == NDIS_STATUS_SUCCESS) + { + if (parm->ParameterType == NdisParameterInteger) + { + int mtu = parm->ParameterData.IntegerData; + if (mtu < MINIMUM_MTU) + mtu = MINIMUM_MTU; + if (mtu > MAXIMUM_MTU) + mtu = MAXIMUM_MTU; + l_Adapter->m_MTU = mtu; + } + } + } + + /* Read Media Status setting from registry */ + { + NDIS_STRING key = NDIS_STRING_CONST("MediaStatus"); + NdisReadConfiguration (&status, &parm, configHandle, + &key, NdisParameterInteger); + if (status == NDIS_STATUS_SUCCESS) + { + if (parm->ParameterType == NdisParameterInteger) + { + if (parm->ParameterData.IntegerData) + { + l_Adapter->m_MediaStateAlwaysConnected = TRUE; + l_Adapter->m_MediaState = TRUE; + } + } + } + } + + /* Read optional MAC setting from registry */ + { + NDIS_STRING key = NDIS_STRING_CONST("MAC"); + ANSI_STRING mac_string; + NdisReadConfiguration (&status, &parm, configHandle, + &key, NdisParameterString); + if (status == NDIS_STATUS_SUCCESS) + { + if (parm->ParameterType == NdisParameterString) + { + if (RtlUnicodeStringToAnsiString (&mac_string, &parm->ParameterData.StringData, TRUE) == STATUS_SUCCESS) + { + l_MacFromRegistry = ParseMAC (l_Adapter->m_MAC, mac_string.Buffer); + RtlFreeAnsiString (&mac_string); + } + } + } + } + + NdisCloseConfiguration (configHandle); + } + + DEBUGP (("[%s] MTU=%d\n", NAME (l_Adapter), l_Adapter->m_MTU)); + } + + //================================== + // Store and update MAC address info + //================================== + + if (!l_MacFromRegistry) + GenerateRandomMac (l_Adapter->m_MAC, NAME (l_Adapter)); + + DEBUGP (("[%s] Using MAC %x:%x:%x:%x:%x:%x\n", + NAME (l_Adapter), + l_Adapter->m_MAC[0], l_Adapter->m_MAC[1], l_Adapter->m_MAC[2], + l_Adapter->m_MAC[3], l_Adapter->m_MAC[4], l_Adapter->m_MAC[5])); + + //================== + // Set broadcast MAC + //================== + { + int i; + for (i = 0; i < sizeof (MACADDR); ++i) + l_Adapter->m_MAC_Broadcast[i] = 0xFF; + } + + //==================================== + // Initialize TAP device + //==================================== + { + NDIS_STATUS tap_status; + tap_status = CreateTapDevice (&l_Adapter->m_Extension, NAME (l_Adapter)); + if (tap_status != NDIS_STATUS_SUCCESS) + { + AdapterFreeResources (l_Adapter); + return tap_status; + } + } + + if (!AddAdapterToInstanceList (l_Adapter)) + { + NOTE_ERROR (); + TapDeviceFreeResources (&l_Adapter->m_Extension); + AdapterFreeResources (l_Adapter); + return NDIS_STATUS_RESOURCES; + } + + l_Adapter->m_InterfaceIsRunning = TRUE; + + return NDIS_STATUS_SUCCESS; +} + +VOID +AdapterHalt (IN NDIS_HANDLE p_AdapterContext) +{ + BOOLEAN status; + + TapAdapterPointer l_Adapter = (TapAdapterPointer) p_AdapterContext; + + NOTE_ERROR (); + + l_Adapter->m_InterfaceIsRunning = FALSE; + + DEBUGP (("[%s] is being halted\n", NAME (l_Adapter))); + + DestroyTapDevice (&l_Adapter->m_Extension); + + // Free resources + DEBUGP (("[%s] Freeing Resources\n", NAME (l_Adapter))); + AdapterFreeResources (l_Adapter); + + status = RemoveAdapterFromInstanceList (l_Adapter); + DEBUGP (("[TAP] RemoveAdapterFromInstanceList returned %d\n", (int) status)); + + DEBUGP (("[TAP] version [%d.%d] %s %s AdapterHalt returning\n", + TAP_DRIVER_MAJOR_VERSION, + TAP_DRIVER_MINOR_VERSION, + __DATE__, + __TIME__)); +} + +VOID +AdapterFreeResources (TapAdapterPointer p_Adapter) +{ + MYASSERT (!p_Adapter->m_CalledAdapterFreeResources); + p_Adapter->m_CalledAdapterFreeResources = TRUE; + + if (p_Adapter->m_NameAnsi.Buffer) + RtlFreeAnsiString (&p_Adapter->m_NameAnsi); + + if (p_Adapter->m_RegisteredAdapterShutdownHandler) + NdisMDeregisterAdapterShutdownHandler (p_Adapter->m_MiniportAdapterHandle); + + if (p_Adapter->m_MCLockAllocated) + NdisFreeSpinLock (&l_Adapter->m_MCLock); +} + +VOID +DestroyTapDevice (TapExtensionPointer p_Extension) +{ + DEBUGP (("[%s] Destroying tap device\n", p_Extension->m_TapName)); + + //====================================== + // Let clients know we are shutting down + //====================================== + p_Extension->m_TapIsRunning = FALSE; + p_Extension->m_TapOpens = 0; + p_Extension->m_Halt = TRUE; + + //===================================== + // If we are concurrently executing in + // TapDeviceHook or AdapterTransmit, + // give those calls time to finish. + // Note that we must be running at IRQL + // < DISPATCH_LEVEL in order to call + // NdisMSleep. + //===================================== + NdisMSleep (500000); + + //=========================================================== + // Exhaust IRP and packet queues. Any pending IRPs will + // be cancelled, causing user-space to get this error + // on overlapped reads: + // The I/O operation has been aborted because of either a + // thread exit or an application request. (code=995) + // It's important that user-space close the device handle + // when this code is returned, so that when we finally + // do a NdisMDeregisterDevice, the device reference count + // is 0. Otherwise the driver will not unload even if the + // the last adapter has been halted. + //=========================================================== + FlushQueues (p_Extension); + NdisMSleep (500000); // give user space time to respond to IRP cancel + + TapDeviceFreeResources (p_Extension); +} + +VOID +TapDeviceFreeResources (TapExtensionPointer p_Extension) +{ + MYASSERT (p_Extension); + MYASSERT (!p_Extension->m_CalledTapDeviceFreeResources); + p_Extension->m_CalledTapDeviceFreeResources = TRUE; + + if (p_Extension->m_PacketQueue) + QueueFree (p_Extension->m_PacketQueue); + if (p_Extension->m_IrpQueue) + QueueFree (p_Extension->m_IrpQueue); + + if (p_Extension->m_CreatedUnicodeLinkName) + RtlFreeUnicodeString (&p_Extension->m_UnicodeLinkName); + + //========================================================== + // According to DDK docs, the device is not actually deleted + // until its reference count falls to zero. That means we + // still need to gracefully fail TapDeviceHook requests + // after this point, otherwise ugly things would happen if + // the device was disabled (e.g. in the network connections + // control panel) while a userspace app still held an open + // file handle to it. + //========================================================== + + if (p_Extension->m_TapDevice) + { + BOOLEAN status; + status = (NdisMDeregisterDevice (p_Extension->m_TapDeviceHandle) + == NDIS_STATUS_SUCCESS); + DEBUGP (("[TAP] Deregistering TAP device, status=%d\n", (int)status)); + } + + if (p_Extension->m_TapName) + MemFree (p_Extension->m_TapName, NAME_BUFFER_SIZE); + + if (p_Extension->m_AllocatedSpinlocks) + NdisFreeSpinLock (&p_Extension->m_QueueLock); +} + +//======================================================================== +// Tap Device Initialization +//======================================================================== + +NDIS_STATUS +CreateTapDevice (TapExtensionPointer p_Extension, const char *p_Name) +{ +# define SIZEOF_DISPATCH (sizeof(PDRIVER_DISPATCH) * (IRP_MJ_MAXIMUM_FUNCTION + 1)) + PDRIVER_DISPATCH *l_Dispatch = NULL; + ANSI_STRING l_TapString, l_LinkString; + UNICODE_STRING l_TapUnicode; + BOOLEAN l_FreeTapUnicode = FALSE; + NTSTATUS l_Status, l_Return = NDIS_STATUS_SUCCESS; + const char *l_UsableName; + + DEBUGP (("[TAP] version [%d.%d] creating tap device: %s\n", + TAP_DRIVER_MAJOR_VERSION, + TAP_DRIVER_MINOR_VERSION, + p_Name)); + + NdisZeroMemory (p_Extension, sizeof (TapExtension)); + + INIT_MUTEX (&p_Extension->m_OpenCloseMutex); + + l_LinkString.Buffer = NULL; + l_TapString.Buffer = NULL; + + l_TapString.MaximumLength = l_LinkString.MaximumLength = NAME_BUFFER_SIZE; + + //======================================= + // Set TAP device entry points + //======================================= + + if ((l_Dispatch = MemAlloc (SIZEOF_DISPATCH, TRUE)) == NULL) + { + DEBUGP (("[%s] couldn't alloc TAP dispatch table\n", p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + + l_Dispatch[IRP_MJ_DEVICE_CONTROL] = TapDeviceHook; + l_Dispatch[IRP_MJ_READ] = TapDeviceHook; + l_Dispatch[IRP_MJ_WRITE] = TapDeviceHook; + l_Dispatch[IRP_MJ_CREATE] = TapDeviceHook; + l_Dispatch[IRP_MJ_CLOSE] = TapDeviceHook; + + //================================== + // Find the beginning of the GUID + //================================== + l_UsableName = p_Name; + while (*l_UsableName != '{') + { + if (*l_UsableName == '\0') + { + DEBUGP (("[%s] couldn't find leading '{' in name\n", p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + ++l_UsableName; + } + + //================================== + // Allocate pool for TAP device name + //================================== + + if ((p_Extension->m_TapName = l_TapString.Buffer = + MemAlloc (NAME_BUFFER_SIZE, TRUE)) == NULL) + { + DEBUGP (("[%s] couldn't alloc TAP name buffer\n", p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + + //================================================ + // Allocate pool for TAP symbolic link name buffer + //================================================ + + if ((l_LinkString.Buffer = + MemAlloc (NAME_BUFFER_SIZE, TRUE)) == NULL) + { + DEBUGP (("[%s] couldn't alloc TAP symbolic link name buffer\n", + p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + + //======================================================= + // Set TAP device name + //======================================================= + + l_Status = RtlStringCchPrintfExA + (l_TapString.Buffer, + l_TapString.MaximumLength, + NULL, + NULL, + STRSAFE_FILL_BEHIND_NULL | STRSAFE_IGNORE_NULLS, + "%s%s%s", + SYSDEVICEDIR, + l_UsableName, + TAPSUFFIX); + + if (l_Status != STATUS_SUCCESS) + { + DEBUGP (("[%s] couldn't format TAP device name\n", + p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + l_TapString.Length = (USHORT) strlen (l_TapString.Buffer); + + DEBUGP (("TAP DEV NAME: '%s'\n", l_TapString.Buffer)); + + //======================================================= + // Set TAP link name + //======================================================= + + l_Status = RtlStringCchPrintfExA + (l_LinkString.Buffer, + l_LinkString.MaximumLength, + NULL, + NULL, + STRSAFE_FILL_BEHIND_NULL | STRSAFE_IGNORE_NULLS, + "%s%s%s", + USERDEVICEDIR, + l_UsableName, + TAPSUFFIX); + + if (l_Status != STATUS_SUCCESS) + { + DEBUGP (("[%s] couldn't format TAP device symbolic link\n", + p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + l_LinkString.Length = (USHORT) strlen (l_LinkString.Buffer); + + DEBUGP (("TAP LINK NAME: '%s'\n", l_LinkString.Buffer)); + + //================================================== + // Convert strings to unicode + //================================================== + if (RtlAnsiStringToUnicodeString (&l_TapUnicode, &l_TapString, TRUE) != + STATUS_SUCCESS) + { + DEBUGP (("[%s] couldn't alloc TAP unicode name buffer\n", + p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + l_FreeTapUnicode = TRUE; + + if (RtlAnsiStringToUnicodeString + (&p_Extension->m_UnicodeLinkName, &l_LinkString, TRUE) + != STATUS_SUCCESS) + { + DEBUGP + (("[%s] Couldn't allocate unicode string for symbolic link name\n", + p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + p_Extension->m_CreatedUnicodeLinkName = TRUE; + + //================================================== + // Create new TAP device with symbolic + // link and associate with adapter. + //================================================== + + l_Status = NdisMRegisterDevice + (g_NdisWrapperHandle, + &l_TapUnicode, + &p_Extension->m_UnicodeLinkName, + l_Dispatch, + &p_Extension->m_TapDevice, + &p_Extension->m_TapDeviceHandle + ); + + if (l_Status != STATUS_SUCCESS) + { + DEBUGP (("[%s] couldn't be created\n", p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + + /* Set TAP device flags */ + p_Extension->m_TapDevice->Flags |= DO_DIRECT_IO; + + //======================================================== + // Initialize Packet and IRP queues. + // + // The packet queue is used to buffer data which has been + // "transmitted" by the virtual NIC, before user space + // has had a chance to read it. + // + // The IRP queue is used to buffer pending I/O requests + // from userspace, i.e. read requests on the TAP device + // waiting for the system to "transmit" something through + // the virtual NIC. + // + // Basically, packets in the packet queue are used + // to satisfy IRP requests in the IRP queue. + // + // QueueLock is used to lock the packet queue used + // for the TAP-Win32 NIC -> User Space packet flow direction. + // + // All accesses to packet or IRP queues should be + // bracketed by the QueueLock spinlock, + // in order to be SMP-safe. + //======================================================== + + NdisAllocateSpinLock (&p_Extension->m_QueueLock); + p_Extension->m_AllocatedSpinlocks = TRUE; + + p_Extension->m_PacketQueue = QueueInit (PACKET_QUEUE_SIZE); + p_Extension->m_IrpQueue = QueueInit (IRP_QUEUE_SIZE); + + if (!p_Extension->m_PacketQueue + || !p_Extension->m_IrpQueue) + { + DEBUGP (("[%s] couldn't alloc TAP queues\n", p_Name)); + l_Return = NDIS_STATUS_RESOURCES; + goto cleanup; + } + + //======================== + // Finalize initialization + //======================== + + p_Extension->m_TapIsRunning = TRUE; + + DEBUGP (("[%s] successfully created TAP device [%s]\n", p_Name, + p_Extension->m_TapName)); + + cleanup: + if (l_FreeTapUnicode) + RtlFreeUnicodeString (&l_TapUnicode); + if (l_LinkString.Buffer) + MemFree (l_LinkString.Buffer, NAME_BUFFER_SIZE); + if (l_Dispatch) + MemFree (l_Dispatch, SIZEOF_DISPATCH); + + if (l_Return != NDIS_STATUS_SUCCESS) + TapDeviceFreeResources (p_Extension); + + return l_Return; +} +#undef SIZEOF_DISPATCH + +//======================================================== +// Adapter Control +//======================================================== +NDIS_STATUS +AdapterReset (OUT PBOOLEAN p_AddressingReset, IN NDIS_HANDLE p_AdapterContext) +{ + TapAdapterPointer l_Adapter = (TapAdapterPointer) p_AdapterContext; + DEBUGP (("[%s] is resetting\n", NAME (l_Adapter))); + return NDIS_STATUS_SUCCESS; +} + +NDIS_STATUS AdapterReceive + (OUT PNDIS_PACKET p_Packet, + OUT PUINT p_Transferred, + IN NDIS_HANDLE p_AdapterContext, + IN NDIS_HANDLE p_ReceiveContext, + IN UINT p_Offset, + IN UINT p_ToTransfer) +{ + return NDIS_STATUS_SUCCESS; +} + +//============================================================== +// Adapter Option Query/Modification +//============================================================== +NDIS_STATUS AdapterQuery +(IN NDIS_HANDLE p_AdapterContext, + IN NDIS_OID p_OID, + IN PVOID p_Buffer, + IN ULONG p_BufferLength, + OUT PULONG p_BytesWritten, OUT PULONG p_BytesNeeded) +{ + TapAdapterPointer l_Adapter = (TapAdapterPointer) p_AdapterContext; + TapAdapterQuery l_Query, *l_QueryPtr = &l_Query; + NDIS_STATUS l_Status = NDIS_STATUS_SUCCESS; + UINT l_QueryLength = 4; + BOOLEAN lock_succeeded; + + NdisZeroMemory (&l_Query, sizeof (l_Query)); + + switch (p_OID) + { + //=================================================================== + // Vendor & Driver version Info + //=================================================================== + case OID_GEN_VENDOR_DESCRIPTION: + l_QueryPtr = (TapAdapterQueryPointer) PRODUCT_STRING; + l_QueryLength = strlen (PRODUCT_STRING) + 1; + break; + + case OID_GEN_VENDOR_ID: + l_Query.m_Long = 0xffffff; + break; + + case OID_GEN_DRIVER_VERSION: + l_Query.m_Short = + (((USHORT) TAP_NDIS_MAJOR_VERSION) << 8 | (USHORT) + TAP_NDIS_MINOR_VERSION); + l_QueryLength = sizeof (unsigned short); + break; + + case OID_GEN_VENDOR_DRIVER_VERSION: + l_Query.m_Long = + (((USHORT) TAP_DRIVER_MAJOR_VERSION) << 8 | (USHORT) + TAP_DRIVER_MINOR_VERSION); + break; + + //================================================================= + // Statistics + //================================================================= + case OID_GEN_RCV_NO_BUFFER: + l_Query.m_Long = 0; + break; + + case OID_802_3_RCV_ERROR_ALIGNMENT: + l_Query.m_Long = 0; + break; + + case OID_802_3_XMIT_ONE_COLLISION: + l_Query.m_Long = 0; + break; + + case OID_802_3_XMIT_MORE_COLLISIONS: + l_Query.m_Long = 0; + break; + + case OID_GEN_XMIT_OK: + l_Query.m_Long = l_Adapter->m_Tx; + break; + + case OID_GEN_RCV_OK: + l_Query.m_Long = l_Adapter->m_Rx; + break; + + case OID_GEN_XMIT_ERROR: + l_Query.m_Long = l_Adapter->m_TxErr; + break; + + case OID_GEN_RCV_ERROR: + l_Query.m_Long = l_Adapter->m_RxErr; + break; + + //=================================================================== + // Device & Protocol Options + //=================================================================== + case OID_GEN_SUPPORTED_LIST: + l_QueryPtr = (TapAdapterQueryPointer) g_SupportedOIDList; + l_QueryLength = sizeof (g_SupportedOIDList); + break; + + case OID_GEN_MAC_OPTIONS: + // This MUST be here !!! + l_Query.m_Long = (NDIS_MAC_OPTION_RECEIVE_SERIALIZED + | NDIS_MAC_OPTION_COPY_LOOKAHEAD_DATA + | NDIS_MAC_OPTION_NO_LOOPBACK + | NDIS_MAC_OPTION_TRANSFERS_NOT_PEND); + + break; + + case OID_GEN_CURRENT_PACKET_FILTER: + l_Query.m_Long = + (NDIS_PACKET_TYPE_ALL_LOCAL | + NDIS_PACKET_TYPE_BROADCAST | + NDIS_PACKET_TYPE_DIRECTED | NDIS_PACKET_TYPE_ALL_FUNCTIONAL); + + break; + + case OID_GEN_PROTOCOL_OPTIONS: + l_Query.m_Long = 0; + break; + + //================================================================== + // Device Info + //================================================================== + case OID_GEN_MEDIA_CONNECT_STATUS: + l_Query.m_Long = l_Adapter->m_MediaState + ? NdisMediaStateConnected : NdisMediaStateDisconnected; + break; + + case OID_GEN_HARDWARE_STATUS: + l_Query.m_HardwareStatus = NdisHardwareStatusReady; + l_QueryLength = sizeof (NDIS_HARDWARE_STATUS); + break; + + case OID_GEN_MEDIA_SUPPORTED: + case OID_GEN_MEDIA_IN_USE: + l_Query.m_Medium = l_Adapter->m_Medium; + l_QueryLength = sizeof (NDIS_MEDIUM); + break; + + case OID_GEN_PHYSICAL_MEDIUM: + l_Query.m_PhysicalMedium = NdisPhysicalMediumUnspecified; + l_QueryLength = sizeof (NDIS_PHYSICAL_MEDIUM); + break; + + case OID_GEN_LINK_SPEED: + l_Query.m_Long = 100000; + break; + + case OID_802_3_PERMANENT_ADDRESS: + case OID_802_3_CURRENT_ADDRESS: + COPY_MAC (l_Query.m_MacAddress, l_Adapter->m_MAC); + l_QueryLength = sizeof (MACADDR); + break; + + //================================================================== + // Limits + //================================================================== + + case OID_GEN_MAXIMUM_SEND_PACKETS: + l_Query.m_Long = 1; + break; + + case OID_802_3_MAXIMUM_LIST_SIZE: + l_Query.m_Long = NIC_MAX_MCAST_LIST; + break; + + case OID_GEN_CURRENT_LOOKAHEAD: + l_Query.m_Long = l_Adapter->m_Lookahead; + break; + + case OID_GEN_MAXIMUM_LOOKAHEAD: + case OID_GEN_MAXIMUM_TOTAL_SIZE: + case OID_GEN_RECEIVE_BUFFER_SPACE: + case OID_GEN_RECEIVE_BLOCK_SIZE: + l_Query.m_Long = DEFAULT_PACKET_LOOKAHEAD; + break; + + case OID_GEN_MAXIMUM_FRAME_SIZE: + case OID_GEN_TRANSMIT_BLOCK_SIZE: + case OID_GEN_TRANSMIT_BUFFER_SPACE: + l_Query.m_Long = l_Adapter->m_MTU; + break; + + case OID_PNP_CAPABILITIES: + do + { + PNDIS_PNP_CAPABILITIES pPNPCapabilities; + PNDIS_PM_WAKE_UP_CAPABILITIES pPMstruct; + + if (p_BufferLength >= sizeof (NDIS_PNP_CAPABILITIES)) + { + pPNPCapabilities = (PNDIS_PNP_CAPABILITIES) (p_Buffer); + + // + // Setting up the buffer to be returned + // to the Protocol above the Passthru miniport + // + pPMstruct = &pPNPCapabilities->WakeUpCapabilities; + pPMstruct->MinMagicPacketWakeUp = NdisDeviceStateUnspecified; + pPMstruct->MinPatternWakeUp = NdisDeviceStateUnspecified; + pPMstruct->MinLinkChangeWakeUp = NdisDeviceStateUnspecified; + } + l_QueryLength = sizeof (NDIS_PNP_CAPABILITIES); + } + while (FALSE); + break; + case OID_PNP_QUERY_POWER: + break; + + // Required OIDs that we don't support + + case OID_GEN_SUPPORTED_GUIDS: + case OID_GEN_MEDIA_CAPABILITIES: + case OID_TCP_TASK_OFFLOAD: + case OID_FFP_SUPPORT: + l_Status = NDIS_STATUS_INVALID_OID; + break; + + // Optional stats OIDs + + case OID_GEN_DIRECTED_BYTES_XMIT: + case OID_GEN_DIRECTED_FRAMES_XMIT: + case OID_GEN_MULTICAST_BYTES_XMIT: + case OID_GEN_MULTICAST_FRAMES_XMIT: + case OID_GEN_BROADCAST_BYTES_XMIT: + case OID_GEN_BROADCAST_FRAMES_XMIT: + case OID_GEN_DIRECTED_BYTES_RCV: + case OID_GEN_DIRECTED_FRAMES_RCV: + case OID_GEN_MULTICAST_BYTES_RCV: + case OID_GEN_MULTICAST_FRAMES_RCV: + case OID_GEN_BROADCAST_BYTES_RCV: + case OID_GEN_BROADCAST_FRAMES_RCV: + l_Status = NDIS_STATUS_INVALID_OID; + break; + + //=================================================================== + // Not Handled + //=================================================================== + default: + DEBUGP (("[%s] Unhandled OID %lx\n", NAME (l_Adapter), p_OID)); + l_Status = NDIS_STATUS_INVALID_OID; + break; + } + + if (l_Status != NDIS_STATUS_SUCCESS) + ; + else if (l_QueryLength > p_BufferLength) + { + l_Status = NDIS_STATUS_INVALID_LENGTH; + *p_BytesNeeded = l_QueryLength; + } + else + NdisMoveMemory (p_Buffer, (PVOID) l_QueryPtr, + (*p_BytesWritten = l_QueryLength)); + + return l_Status; +} + +NDIS_STATUS AdapterModify +(IN NDIS_HANDLE p_AdapterContext, + IN NDIS_OID p_OID, + IN PVOID p_Buffer, + IN ULONG p_BufferLength, + OUT PULONG p_BytesRead, + OUT PULONG p_BytesNeeded) +{ + TapAdapterQueryPointer l_Query = (TapAdapterQueryPointer) p_Buffer; + TapAdapterPointer l_Adapter = (TapAdapterPointer) p_AdapterContext; + NDIS_STATUS l_Status = NDIS_STATUS_INVALID_OID; + ULONG l_Long; + + switch (p_OID) + { + //================================================================== + // Device Info + //================================================================== + case OID_802_3_MULTICAST_LIST: + DEBUGP (("[%s] Setting [OID_802_3_MULTICAST_LIST]\n", + NAME (l_Adapter))); + + *p_BytesNeeded = sizeof (ETH_ADDR); + *p_BytesRead = p_BufferLength; + + if (p_BufferLength % sizeof (ETH_ADDR)) + l_Status = NDIS_STATUS_INVALID_LENGTH; + else if (p_BufferLength > sizeof (MC_LIST)) + { + l_Status = NDIS_STATUS_MULTICAST_FULL; + *p_BytesNeeded = sizeof (MC_LIST); + } + else + { + NdisAcquireSpinLock (&l_Adapter->m_MCLock); + + NdisZeroMemory(&l_Adapter->m_MCList, sizeof (MC_LIST)); + + NdisMoveMemory(&l_Adapter->m_MCList, + p_Buffer, + p_BufferLength); + + l_Adapter->m_MCListSize = p_BufferLength / sizeof (ETH_ADDR); + + NdisReleaseSpinLock (&l_Adapter->m_MCLock); + + l_Status = NDIS_STATUS_SUCCESS; + } + break; + + case OID_GEN_CURRENT_PACKET_FILTER: + l_Status = NDIS_STATUS_INVALID_LENGTH; + *p_BytesNeeded = 4; + + if (p_BufferLength >= sizeof (ULONG)) + { + DEBUGP + (("[%s] Setting [OID_GEN_CURRENT_PACKET_FILTER] to [0x%02lx]\n", + NAME (l_Adapter), l_Query->m_Long)); + l_Status = NDIS_STATUS_SUCCESS; + *p_BytesRead = sizeof (ULONG); + } + break; + + case OID_GEN_CURRENT_LOOKAHEAD: + if (p_BufferLength < sizeof (ULONG)) + { + l_Status = NDIS_STATUS_INVALID_LENGTH; + *p_BytesNeeded = 4; + } + else if (l_Query->m_Long > DEFAULT_PACKET_LOOKAHEAD + || l_Query->m_Long <= 0) + { + l_Status = NDIS_STATUS_INVALID_DATA; + } + else + { + DEBUGP (("[%s] Setting [OID_GEN_CURRENT_LOOKAHEAD] to [%d]\n", + NAME (l_Adapter), l_Query->m_Long)); + l_Adapter->m_Lookahead = l_Query->m_Long; + l_Status = NDIS_STATUS_SUCCESS; + *p_BytesRead = sizeof (ULONG); + } + break; + + case OID_GEN_NETWORK_LAYER_ADDRESSES: + l_Status = NDIS_STATUS_SUCCESS; + *p_BytesRead = *p_BytesNeeded = 0; + break; + + case OID_GEN_TRANSPORT_HEADER_OFFSET: + l_Status = NDIS_STATUS_SUCCESS; + *p_BytesRead = *p_BytesNeeded = 0; + break; + + case OID_PNP_SET_POWER: + do + { + NDIS_DEVICE_POWER_STATE NewDeviceState; + + NewDeviceState = (*(PNDIS_DEVICE_POWER_STATE) p_Buffer); + + switch (NewDeviceState) + { + case NdisDeviceStateD0: + l_Adapter->m_DeviceState = '0'; + break; + case NdisDeviceStateD1: + l_Adapter->m_DeviceState = '1'; + break; + case NdisDeviceStateD2: + l_Adapter->m_DeviceState = '2'; + break; + case NdisDeviceStateD3: + l_Adapter->m_DeviceState = '3'; + break; + default: + l_Adapter->m_DeviceState = '?'; + break; + } + + l_Status = NDIS_STATUS_FAILURE; + + // + // Check for invalid length + // + if (p_BufferLength < sizeof (NDIS_DEVICE_POWER_STATE)) + { + l_Status = NDIS_STATUS_INVALID_LENGTH; + break; + } + + if (NewDeviceState > NdisDeviceStateD0) + { + l_Adapter->m_InterfaceIsRunning = FALSE; + DEBUGP (("[%s] Power management device state OFF\n", + NAME (l_Adapter))); + } + else + { + l_Adapter->m_InterfaceIsRunning = TRUE; + DEBUGP (("[%s] Power management device state ON\n", + NAME (l_Adapter))); + } + + l_Status = NDIS_STATUS_SUCCESS; + } + while (FALSE); + + if (l_Status == NDIS_STATUS_SUCCESS) + { + *p_BytesRead = sizeof (NDIS_DEVICE_POWER_STATE); + *p_BytesNeeded = 0; + } + else + { + *p_BytesRead = 0; + *p_BytesNeeded = sizeof (NDIS_DEVICE_POWER_STATE); + } + break; + + case OID_PNP_REMOVE_WAKE_UP_PATTERN: + case OID_PNP_ADD_WAKE_UP_PATTERN: + l_Status = NDIS_STATUS_SUCCESS; + *p_BytesRead = *p_BytesNeeded = 0; + break; + + default: + DEBUGP (("[%s] Can't set value for OID %lx\n", NAME (l_Adapter), + p_OID)); + l_Status = NDIS_STATUS_INVALID_OID; + *p_BytesRead = *p_BytesNeeded = 0; + break; + } + + return l_Status; +} + +//==================================================================== +// Adapter Transmission +//==================================================================== +NDIS_STATUS +AdapterTransmit (IN NDIS_HANDLE p_AdapterContext, + IN PNDIS_PACKET p_Packet, + IN UINT p_Flags) +{ + TapAdapterPointer l_Adapter = (TapAdapterPointer) p_AdapterContext; + ULONG l_Index = 0, l_BufferLength = 0, l_PacketLength = 0; + PIRP l_IRP; + TapPacketPointer l_PacketBuffer; + PNDIS_BUFFER l_NDIS_Buffer; + PUCHAR l_Buffer; + PVOID result; + + NdisQueryPacket (p_Packet, NULL, NULL, &l_NDIS_Buffer, &l_PacketLength); + + //==================================================== + // Here we abandon the transmission attempt if any of + // the parameters is wrong or memory allocation fails + // but we do not indicate failure. The packet is + // silently dropped. + //==================================================== + + if (l_PacketLength < ETHERNET_HEADER_SIZE || l_PacketLength > 65535) + goto exit_fail; + else if (!l_Adapter->m_Extension.m_TapOpens || !l_Adapter->m_MediaState) + goto exit_success; // Nothing is bound to the TAP device + + if (NdisAllocateMemoryWithTag (&l_PacketBuffer, + TAP_PACKET_SIZE (l_PacketLength), + '5PAT') != NDIS_STATUS_SUCCESS) + goto exit_no_resources; + + if (l_PacketBuffer == NULL) + goto exit_no_resources; + + l_PacketBuffer->m_SizeFlags = (l_PacketLength & TP_SIZE_MASK); + + //=========================== + // Reassemble packet contents + //=========================== + + __try + { + for (l_Index = 0; l_NDIS_Buffer && l_Index < l_PacketLength; + l_Index += l_BufferLength) + { + NdisQueryBuffer (l_NDIS_Buffer, (PVOID *) & l_Buffer, + &l_BufferLength); + NdisMoveMemory (l_PacketBuffer->m_Data + l_Index, l_Buffer, + l_BufferLength); + NdisGetNextBuffer (l_NDIS_Buffer, &l_NDIS_Buffer); + } + + DUMP_PACKET ("AdapterTransmit", l_PacketBuffer->m_Data, l_PacketLength); + + //===================================================== + // Are we running in DHCP server masquerade mode? + // + // If so, catch both DHCP requests and ARP queries + // to resolve the address of our virtual DHCP server. + //===================================================== + if (l_Adapter->m_dhcp_enabled) + { + const ETH_HEADER *eth = (ETH_HEADER *) l_PacketBuffer->m_Data; + const IPHDR *ip = (IPHDR *) (l_PacketBuffer->m_Data + sizeof (ETH_HEADER)); + const UDPHDR *udp = (UDPHDR *) (l_PacketBuffer->m_Data + sizeof (ETH_HEADER) + sizeof (IPHDR)); + + // ARP packet? + if (l_PacketLength == sizeof (ARP_PACKET) + && eth->proto == htons (ETH_P_ARP) + && l_Adapter->m_dhcp_server_arp) + { + if (ProcessARP (l_Adapter, + (PARP_PACKET) l_PacketBuffer->m_Data, + l_Adapter->m_dhcp_addr, + l_Adapter->m_dhcp_server_ip, + l_Adapter->m_dhcp_server_mac)) + goto no_queue; + } + + // DHCP packet? + else if (l_PacketLength >= sizeof (ETH_HEADER) + sizeof (IPHDR) + sizeof (UDPHDR) + sizeof (DHCP) + && eth->proto == htons (ETH_P_IP) + && ip->version_len == 0x45 // IPv4, 20 byte header + && ip->protocol == IPPROTO_UDP + && udp->dest == htons (BOOTPS_PORT)) + { + const DHCP *dhcp = (DHCP *) (l_PacketBuffer->m_Data + + sizeof (ETH_HEADER) + + sizeof (IPHDR) + + sizeof (UDPHDR)); + + const int optlen = l_PacketLength + - sizeof (ETH_HEADER) + - sizeof (IPHDR) + - sizeof (UDPHDR) + - sizeof (DHCP); + + if (optlen > 0) // we must have at least one DHCP option + { + if (ProcessDHCP (l_Adapter, eth, ip, udp, dhcp, optlen)) + goto no_queue; + } + else + goto no_queue; + } + } + + //=============================================== + // In Point-To-Point mode, check to see whether + // packet is ARP or IPv4 (if neither, then drop). + //=============================================== + if (l_Adapter->m_PointToPoint) + { + ETH_HEADER *e; + + if (l_PacketLength < ETHERNET_HEADER_SIZE) + goto no_queue; + + e = (ETH_HEADER *) l_PacketBuffer->m_Data; + + switch (ntohs (e->proto)) + { + case ETH_P_ARP: + + // Make sure that packet is the + // right size for ARP. + if (l_PacketLength != sizeof (ARP_PACKET)) + goto no_queue; + + ProcessARP (l_Adapter, + (PARP_PACKET) l_PacketBuffer->m_Data, + l_Adapter->m_localIP, + l_Adapter->m_remoteIP, + l_Adapter->m_TapToUser.dest); + + default: + goto no_queue; + + case ETH_P_IP: + + // Make sure that packet is large + // enough to be IPv4. + if (l_PacketLength + < ETHERNET_HEADER_SIZE + IP_HEADER_SIZE) + goto no_queue; + + // Only accept directed packets, + // not broadcasts. + if (memcmp (e, &l_Adapter->m_TapToUser, ETHERNET_HEADER_SIZE)) + goto no_queue; + + // Packet looks like IPv4, queue it. + l_PacketBuffer->m_SizeFlags |= TP_POINT_TO_POINT; + } + } + + //=============================================== + // Push packet onto queue to wait for read from + // userspace. + //=============================================== + + NdisAcquireSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + result = NULL; + if (IS_UP (l_Adapter)) + result = QueuePush (l_Adapter->m_Extension.m_PacketQueue, l_PacketBuffer); + + NdisReleaseSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + if ((TapPacketPointer) result != l_PacketBuffer) + { + // adapter receive overrun + INCREMENT_STAT (l_Adapter->m_TxErr); + goto no_queue; + } + else + { + INCREMENT_STAT (l_Adapter->m_Tx); + } + + //============================================================ + // Cycle through IRPs and packets, try to satisfy each pending + // IRP with a queued packet. + //============================================================ + while (TRUE) + { + l_IRP = NULL; + l_PacketBuffer = NULL; + + NdisAcquireSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + if (IS_UP (l_Adapter) + && QueueCount (l_Adapter->m_Extension.m_PacketQueue) + && QueueCount (l_Adapter->m_Extension.m_IrpQueue)) + { + l_IRP = (PIRP) QueuePop (l_Adapter->m_Extension.m_IrpQueue); + l_PacketBuffer = (TapPacketPointer) + QueuePop (l_Adapter->m_Extension.m_PacketQueue); + } + + NdisReleaseSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + MYASSERT ((l_IRP != NULL) + (l_PacketBuffer != NULL) != 1); + + if (l_IRP && l_PacketBuffer) + { + CompleteIRP (l_IRP, + l_PacketBuffer, + IO_NETWORK_INCREMENT); + } + else + break; + } + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + } + + return NDIS_STATUS_SUCCESS; + + no_queue: + NdisFreeMemory (l_PacketBuffer, + TAP_PACKET_SIZE (l_PacketLength), + 0); + + exit_success: + return NDIS_STATUS_SUCCESS; + + exit_fail: + return NDIS_STATUS_FAILURE; + + exit_no_resources: + return NDIS_STATUS_RESOURCES; +} + +//====================================================================== +// Hooks for catching TAP device IRP's. +//====================================================================== + +NTSTATUS +TapDeviceHook (IN PDEVICE_OBJECT p_DeviceObject, IN PIRP p_IRP) +{ + TapAdapterPointer l_Adapter = LookupAdapterInInstanceList (p_DeviceObject); + PIO_STACK_LOCATION l_IrpSp; + NTSTATUS l_Status = STATUS_SUCCESS; + BOOLEAN accessible; + + l_IrpSp = IoGetCurrentIrpStackLocation (p_IRP); + + p_IRP->IoStatus.Status = STATUS_SUCCESS; + p_IRP->IoStatus.Information = 0; + + if (!l_Adapter || l_Adapter->m_Extension.m_Halt) + { + DEBUGP (("TapDeviceHook called when TAP device is halted, MajorFunction=%d\n", + (int)l_IrpSp->MajorFunction)); + + if (l_IrpSp->MajorFunction == IRP_MJ_CLOSE) + { + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + return STATUS_SUCCESS; + } + else + { + p_IRP->IoStatus.Status = STATUS_NO_SUCH_DEVICE; + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + return STATUS_NO_SUCH_DEVICE; + } + } + + switch (l_IrpSp->MajorFunction) + { + //=========================================================== + // Ioctl call handlers + //=========================================================== + case IRP_MJ_DEVICE_CONTROL: + { + switch (l_IrpSp->Parameters.DeviceIoControl.IoControlCode) + { + case TAP_IOCTL_GET_MAC: + { + if (l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength + >= sizeof (MACADDR)) + { + COPY_MAC (p_IRP->AssociatedIrp.SystemBuffer, + l_Adapter->m_MAC); + p_IRP->IoStatus.Information = sizeof (MACADDR); + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_BUFFER_TOO_SMALL; + } + break; + } + case TAP_IOCTL_GET_VERSION: + { + const ULONG size = sizeof (ULONG) * 3; + if (l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength + >= size) + { + ((PULONG) (p_IRP->AssociatedIrp.SystemBuffer))[0] + = TAP_DRIVER_MAJOR_VERSION; + ((PULONG) (p_IRP->AssociatedIrp.SystemBuffer))[1] + = TAP_DRIVER_MINOR_VERSION; + ((PULONG) (p_IRP->AssociatedIrp.SystemBuffer))[2] +#if DBG + = 1; +#else + = 0; +#endif + p_IRP->IoStatus.Information = size; + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_BUFFER_TOO_SMALL; + } + + break; + } + case TAP_IOCTL_GET_MTU: + { + const ULONG size = sizeof (ULONG) * 1; + if (l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength + >= size) + { + ((PULONG) (p_IRP->AssociatedIrp.SystemBuffer))[0] + = l_Adapter->m_MTU; + p_IRP->IoStatus.Information = size; + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_BUFFER_TOO_SMALL; + } + + break; + } + case TAP_IOCTL_GET_INFO: + { + char state[16]; + if (l_Adapter->m_InterfaceIsRunning) + state[0] = 'A'; + else + state[0] = 'a'; + if (l_Adapter->m_Extension.m_TapIsRunning) + state[1] = 'T'; + else + state[1] = 't'; + state[2] = l_Adapter->m_DeviceState; + if (l_Adapter->m_MediaStateAlwaysConnected) + state[3] = 'C'; + else + state[3] = 'c'; + state[4] = '\0'; + + p_IRP->IoStatus.Status = l_Status = RtlStringCchPrintfExA ( + ((LPTSTR) (p_IRP->AssociatedIrp.SystemBuffer)), + l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength, + NULL, + NULL, + STRSAFE_FILL_BEHIND_NULL | STRSAFE_IGNORE_NULLS, + "State=%s Err=[%s/%d] #O=%d Tx=[%d,%d] Rx=[%d,%d] IrpQ=[%d,%d,%d] PktQ=[%d,%d,%d]", + state, + g_LastErrorFilename, + g_LastErrorLineNumber, + (int)l_Adapter->m_Extension.m_NumTapOpens, + (int)l_Adapter->m_Tx, + (int)l_Adapter->m_TxErr, + (int)l_Adapter->m_Rx, + (int)l_Adapter->m_RxErr, + (int)l_Adapter->m_Extension.m_IrpQueue->size, + (int)l_Adapter->m_Extension.m_IrpQueue->max_size, + (int)IRP_QUEUE_SIZE, + (int)l_Adapter->m_Extension.m_PacketQueue->size, + (int)l_Adapter->m_Extension.m_PacketQueue->max_size, + (int)PACKET_QUEUE_SIZE + ); + + p_IRP->IoStatus.Information + = l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength; + + break; + } + +#if DBG + case TAP_IOCTL_GET_LOG_LINE: + { + if (GetDebugLine ((LPTSTR)p_IRP->AssociatedIrp.SystemBuffer, + l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength)) + p_IRP->IoStatus.Status = l_Status = STATUS_SUCCESS; + else + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + + p_IRP->IoStatus.Information + = l_IrpSp->Parameters.DeviceIoControl.OutputBufferLength; + + break; + } +#endif + + case TAP_IOCTL_CONFIG_POINT_TO_POINT: + { + if (l_IrpSp->Parameters.DeviceIoControl.InputBufferLength >= + (sizeof (IPADDR) * 2)) + { + MACADDR dest; + + l_Adapter->m_PointToPoint = FALSE; + + GenerateRelatedMAC (dest, l_Adapter->m_MAC, 1); + + l_Adapter->m_localIP = + ((IPADDR*) (p_IRP->AssociatedIrp.SystemBuffer))[0]; + l_Adapter->m_remoteIP = + ((IPADDR*) (p_IRP->AssociatedIrp.SystemBuffer))[1]; + + COPY_MAC (l_Adapter->m_TapToUser.src, l_Adapter->m_MAC); + COPY_MAC (l_Adapter->m_TapToUser.dest, dest); + COPY_MAC (l_Adapter->m_UserToTap.src, dest); + COPY_MAC (l_Adapter->m_UserToTap.dest, l_Adapter->m_MAC); + + l_Adapter->m_TapToUser.proto = l_Adapter->m_UserToTap.proto = htons (ETH_P_IP); + + l_Adapter->m_PointToPoint = TRUE; + + CheckIfDhcpAndPointToPointMode (l_Adapter); + + p_IRP->IoStatus.Information = 1; // Simple boolean value + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + } + + break; + } + + case TAP_IOCTL_SET_MEDIA_STATUS: + { + if (l_IrpSp->Parameters.DeviceIoControl.InputBufferLength >= + (sizeof (ULONG) * 1)) + { + ULONG parm = ((PULONG) (p_IRP->AssociatedIrp.SystemBuffer))[0]; + SetMediaStatus (l_Adapter, (BOOLEAN) parm); + p_IRP->IoStatus.Information = 1; + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + } + break; + } + + case TAP_IOCTL_CONFIG_DHCP_MASQ: + { + if (l_IrpSp->Parameters.DeviceIoControl.InputBufferLength >= + (sizeof (IPADDR) * 4)) + { + l_Adapter->m_dhcp_enabled = FALSE; + l_Adapter->m_dhcp_server_arp = FALSE; + l_Adapter->m_dhcp_user_supplied_options_buffer_len = 0; + + // Adapter IP addr / netmask + l_Adapter->m_dhcp_addr = + ((IPADDR*) (p_IRP->AssociatedIrp.SystemBuffer))[0]; + l_Adapter->m_dhcp_netmask = + ((IPADDR*) (p_IRP->AssociatedIrp.SystemBuffer))[1]; + + // IP addr of DHCP masq server + l_Adapter->m_dhcp_server_ip = + ((IPADDR*) (p_IRP->AssociatedIrp.SystemBuffer))[2]; + + // Lease time in seconds + l_Adapter->m_dhcp_lease_time = + ((IPADDR*) (p_IRP->AssociatedIrp.SystemBuffer))[3]; + + GenerateRelatedMAC (l_Adapter->m_dhcp_server_mac, l_Adapter->m_MAC, 2); + + l_Adapter->m_dhcp_enabled = TRUE; + l_Adapter->m_dhcp_server_arp = TRUE; + + CheckIfDhcpAndPointToPointMode (l_Adapter); + + p_IRP->IoStatus.Information = 1; // Simple boolean value + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + } + + break; + } + + case TAP_IOCTL_CONFIG_DHCP_SET_OPT: + { + if (l_IrpSp->Parameters.DeviceIoControl.InputBufferLength <= + DHCP_USER_SUPPLIED_OPTIONS_BUFFER_SIZE + && l_Adapter->m_dhcp_enabled) + { + l_Adapter->m_dhcp_user_supplied_options_buffer_len = 0; + + NdisMoveMemory (l_Adapter->m_dhcp_user_supplied_options_buffer, + p_IRP->AssociatedIrp.SystemBuffer, + l_IrpSp->Parameters.DeviceIoControl.InputBufferLength); + + l_Adapter->m_dhcp_user_supplied_options_buffer_len = + l_IrpSp->Parameters.DeviceIoControl.InputBufferLength; + + p_IRP->IoStatus.Information = 1; // Simple boolean value + } + else + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + } + + break; + } + + default: + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + break; + } + } + + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + + //=========================================================== + // User mode thread issued a read request on the tap device + // If there are packets waiting to be read, then the request + // will be satisfied here. If not, then the request will be + // queued and satisfied by any packet that is not used to + // satisfy requests ahead of it. + //=========================================================== + case IRP_MJ_READ: + { + TapPacketPointer l_PacketBuffer; + BOOLEAN pending = FALSE; + + // Save IRP-accessible copy of buffer length + p_IRP->IoStatus.Information = l_IrpSp->Parameters.Read.Length; + + if (p_IRP->MdlAddress == NULL) + { + DEBUGP (("[%s] MdlAddress is NULL for IRP_MJ_READ\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + p_IRP->IoStatus.Information = 0; + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + else if ((p_IRP->AssociatedIrp.SystemBuffer = + MmGetSystemAddressForMdlSafe + (p_IRP->MdlAddress, NormalPagePriority)) == NULL) + { + DEBUGP (("[%s] Could not map address in IRP_MJ_READ\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INSUFFICIENT_RESOURCES; + p_IRP->IoStatus.Information = 0; + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + else if (!l_Adapter->m_InterfaceIsRunning) + { + DEBUGP (("[%s] Interface is down in IRP_MJ_READ\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + + //================================== + // Can we provide immediate service? + //================================== + + l_PacketBuffer = NULL; + + NdisAcquireSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + if (IS_UP (l_Adapter) + && QueueCount (l_Adapter->m_Extension.m_PacketQueue) + && QueueCount (l_Adapter->m_Extension.m_IrpQueue) == 0) + { + l_PacketBuffer = (TapPacketPointer) + QueuePop (l_Adapter->m_Extension.m_PacketQueue); + } + + NdisReleaseSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + if (l_PacketBuffer) + { + l_Status = CompleteIRP (p_IRP, + l_PacketBuffer, + IO_NO_INCREMENT); + break; + } + + //============================= + // Attempt to pend read request + //============================= + + NdisAcquireSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + if (IS_UP (l_Adapter) + && QueuePush (l_Adapter->m_Extension.m_IrpQueue, p_IRP) == (PIRP) p_IRP) + { + IoSetCancelRoutine (p_IRP, CancelIRPCallback); + l_Status = STATUS_PENDING; + IoMarkIrpPending (p_IRP); + pending = TRUE; + } + + NdisReleaseSpinLock (&l_Adapter->m_Extension.m_QueueLock); + + if (pending) + break; + + // Can't queue anymore IRP's + DEBUGP (("[%s] TAP [%s] read IRP overrun\n", + NAME (l_Adapter), l_Adapter->m_Extension.m_TapName)); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + + //============================================================== + // User mode issued a WriteFile request on the TAP file handle. + // The request will always get satisfied here. The call may + // fail if there are too many pending packets (queue full). + //============================================================== + case IRP_MJ_WRITE: + { + if (p_IRP->MdlAddress == NULL) + { + DEBUGP (("[%s] MdlAddress is NULL for IRP_MJ_WRITE\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INVALID_PARAMETER; + p_IRP->IoStatus.Information = 0; + } + else if ((p_IRP->AssociatedIrp.SystemBuffer = + MmGetSystemAddressForMdlSafe + (p_IRP->MdlAddress, NormalPagePriority)) == NULL) + { + DEBUGP (("[%s] Could not map address in IRP_MJ_WRITE\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_INSUFFICIENT_RESOURCES; + p_IRP->IoStatus.Information = 0; + } + else if (!l_Adapter->m_InterfaceIsRunning) + { + DEBUGP (("[%s] Interface is down in IRP_MJ_WRITE\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + else if (!l_Adapter->m_PointToPoint && ((l_IrpSp->Parameters.Write.Length) >= ETHERNET_HEADER_SIZE)) + { + __try + { + p_IRP->IoStatus.Information = l_IrpSp->Parameters.Write.Length; + + DUMP_PACKET ("IRP_MJ_WRITE ETH", + (unsigned char *) p_IRP->AssociatedIrp.SystemBuffer, + l_IrpSp->Parameters.Write.Length); + + NdisMEthIndicateReceive + (l_Adapter->m_MiniportAdapterHandle, + (NDIS_HANDLE) l_Adapter, + (unsigned char *) p_IRP->AssociatedIrp.SystemBuffer, + ETHERNET_HEADER_SIZE, + (unsigned char *) p_IRP->AssociatedIrp.SystemBuffer + ETHERNET_HEADER_SIZE, + l_IrpSp->Parameters.Write.Length - ETHERNET_HEADER_SIZE, + l_IrpSp->Parameters.Write.Length - ETHERNET_HEADER_SIZE); + + NdisMEthIndicateReceiveComplete (l_Adapter->m_MiniportAdapterHandle); + + p_IRP->IoStatus.Status = l_Status = STATUS_SUCCESS; + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + DEBUGP (("[%s] NdisMEthIndicateReceive failed in IRP_MJ_WRITE\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + } + else if (l_Adapter->m_PointToPoint && ((l_IrpSp->Parameters.Write.Length) >= IP_HEADER_SIZE)) + { + __try + { + p_IRP->IoStatus.Information = l_IrpSp->Parameters.Write.Length; + + DUMP_PACKET2 ("IRP_MJ_WRITE P2P", + &l_Adapter->m_UserToTap, + (unsigned char *) p_IRP->AssociatedIrp.SystemBuffer, + l_IrpSp->Parameters.Write.Length); + + NdisMEthIndicateReceive + (l_Adapter->m_MiniportAdapterHandle, + (NDIS_HANDLE) l_Adapter, + (unsigned char *) &l_Adapter->m_UserToTap, + sizeof (l_Adapter->m_UserToTap), + (unsigned char *) p_IRP->AssociatedIrp.SystemBuffer, + l_IrpSp->Parameters.Write.Length, + l_IrpSp->Parameters.Write.Length); + + NdisMEthIndicateReceiveComplete (l_Adapter->m_MiniportAdapterHandle); + + p_IRP->IoStatus.Status = l_Status = STATUS_SUCCESS; + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + DEBUGP (("[%s] NdisMEthIndicateReceive failed in IRP_MJ_WRITE (P2P)\n", + NAME (l_Adapter))); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + } + else + { + DEBUGP (("[%s] Bad buffer size in IRP_MJ_WRITE, len=%d\n", + NAME (l_Adapter), + l_IrpSp->Parameters.Write.Length)); + NOTE_ERROR (); + p_IRP->IoStatus.Information = 0; // ETHERNET_HEADER_SIZE; + p_IRP->IoStatus.Status = l_Status = STATUS_BUFFER_TOO_SMALL; + } + + if (l_Status == STATUS_SUCCESS) + INCREMENT_STAT (l_Adapter->m_Rx); + else + INCREMENT_STAT (l_Adapter->m_RxErr); + + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + + //-------------------------------------------------------------- + // User mode thread has called CreateFile() on the tap device + //-------------------------------------------------------------- + case IRP_MJ_CREATE: + { + BOOLEAN succeeded = FALSE; + BOOLEAN mutex_succeeded; + + DEBUGP + (("[%s] [TAP] release [%d.%d] open request (m_TapOpens=%d)\n", + NAME (l_Adapter), TAP_DRIVER_MAJOR_VERSION, + TAP_DRIVER_MINOR_VERSION, l_Adapter->m_Extension.m_TapOpens)); + + ACQUIRE_MUTEX_ADAPTIVE (&l_Adapter->m_Extension.m_OpenCloseMutex, mutex_succeeded); + if (mutex_succeeded) + { + if (l_Adapter->m_Extension.m_TapIsRunning && !l_Adapter->m_Extension.m_TapOpens) + { + ResetTapAdapterState (l_Adapter); + l_Adapter->m_Extension.m_TapOpens = 1; + succeeded = TRUE; + } + + if (succeeded) + { + INCREMENT_STAT (l_Adapter->m_Extension.m_NumTapOpens); + p_IRP->IoStatus.Status = l_Status = STATUS_SUCCESS; + p_IRP->IoStatus.Information = 0; + } + else + { + DEBUGP (("[%s] TAP is presently unavailable (m_TapOpens=%d)\n", + NAME (l_Adapter), l_Adapter->m_Extension.m_TapOpens)); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + + RELEASE_MUTEX (&l_Adapter->m_Extension.m_OpenCloseMutex); + } + else + { + DEBUGP (("[%s] TAP is presently locked (m_TapOpens=%d)\n", + NAME (l_Adapter), l_Adapter->m_Extension.m_TapOpens)); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + + //----------------------------------------------------------- + // User mode thread called CloseHandle() on the tap device + //----------------------------------------------------------- + case IRP_MJ_CLOSE: + { + BOOLEAN mutex_succeeded; + + DEBUGP (("[%s] [TAP] release [%d.%d] close/cleanup request\n", + NAME (l_Adapter), TAP_DRIVER_MAJOR_VERSION, + TAP_DRIVER_MINOR_VERSION)); + + ACQUIRE_MUTEX_ADAPTIVE (&l_Adapter->m_Extension.m_OpenCloseMutex, mutex_succeeded); + if (mutex_succeeded) + { + l_Adapter->m_Extension.m_TapOpens = 0; + ResetTapAdapterState (l_Adapter); + FlushQueues (&l_Adapter->m_Extension); + SetMediaStatus (l_Adapter, FALSE); + RELEASE_MUTEX (&l_Adapter->m_Extension.m_OpenCloseMutex); + } + else + { + DEBUGP (("[%s] TAP is presently locked (m_TapOpens=%d)\n", + NAME (l_Adapter), l_Adapter->m_Extension.m_TapOpens)); + NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + + //------------------ + // Strange Request + //------------------ + default: + { + //NOTE_ERROR (); + p_IRP->IoStatus.Status = l_Status = STATUS_UNSUCCESSFUL; + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + break; + } + } + + return l_Status; +} + +//============================================================= +// CompleteIRP is normally called with an adapter -> userspace +// network packet and an IRP (Pending I/O request) from userspace. +// +// The IRP will normally represent a queued overlapped read +// operation from userspace that is in a wait state. +// +// Use the ethernet packet to satisfy the IRP. +//============================================================= + +NTSTATUS +CompleteIRP (IN PIRP p_IRP, + IN TapPacketPointer p_PacketBuffer, + IN CCHAR PriorityBoost) +{ + NTSTATUS l_Status = STATUS_UNSUCCESSFUL; + + int offset; + int len; + + MYASSERT (p_IRP); + MYASSERT (p_PacketBuffer); + + IoSetCancelRoutine (p_IRP, NULL); // Disable cancel routine + + //------------------------------------------- + // While p_PacketBuffer always contains a + // full ethernet packet, including the + // ethernet header, in point-to-point mode, + // we only want to return the IPv4 + // component. + //------------------------------------------- + + if (p_PacketBuffer->m_SizeFlags & TP_POINT_TO_POINT) + { + offset = ETHERNET_HEADER_SIZE; + len = (int) (p_PacketBuffer->m_SizeFlags & TP_SIZE_MASK) - ETHERNET_HEADER_SIZE; + } + else + { + offset = 0; + len = (p_PacketBuffer->m_SizeFlags & TP_SIZE_MASK); + } + + if (len < 0 || (int) p_IRP->IoStatus.Information < len) + { + p_IRP->IoStatus.Information = 0; + p_IRP->IoStatus.Status = STATUS_BUFFER_OVERFLOW; + NOTE_ERROR (); + } + else + { + p_IRP->IoStatus.Information = len; + p_IRP->IoStatus.Status = l_Status = STATUS_SUCCESS; + + __try + { + NdisMoveMemory (p_IRP->AssociatedIrp.SystemBuffer, + p_PacketBuffer->m_Data + offset, + len); + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + NOTE_ERROR (); + p_IRP->IoStatus.Status = STATUS_UNSUCCESSFUL; + p_IRP->IoStatus.Information = 0; + } + } + + __try + { + NdisFreeMemory (p_PacketBuffer, + TAP_PACKET_SIZE (p_PacketBuffer->m_SizeFlags & TP_SIZE_MASK), + 0); + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + } + + if (l_Status == STATUS_SUCCESS) + { + IoCompleteRequest (p_IRP, PriorityBoost); + } + else + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); + + return l_Status; +} + +//============================================== +// IRPs get cancelled for a number of reasons. +// +// The TAP device could be closed by userspace +// when there are still pending read operations. +// +// The user could disable the TAP adapter in the +// network connections control panel, while the +// device is still open by a process. +//============================================== +VOID +CancelIRPCallback (IN PDEVICE_OBJECT p_DeviceObject, + IN PIRP p_IRP) +{ + TapAdapterPointer l_Adapter = LookupAdapterInInstanceList (p_DeviceObject); + CancelIRP (l_Adapter ? &l_Adapter->m_Extension : NULL, p_IRP, TRUE); +} + +VOID +CancelIRP (TapExtensionPointer p_Extension, + IN PIRP p_IRP, + BOOLEAN callback) +{ + BOOLEAN exists = FALSE; + + MYASSERT (p_IRP); + + if (p_Extension) + { + NdisAcquireSpinLock (&p_Extension->m_QueueLock); + exists = (QueueExtract (p_Extension->m_IrpQueue, p_IRP) == p_IRP); + NdisReleaseSpinLock (&p_Extension->m_QueueLock); + } + else + exists = TRUE; + + if (exists) + { + IoSetCancelRoutine (p_IRP, NULL); + p_IRP->IoStatus.Status = STATUS_CANCELLED; + p_IRP->IoStatus.Information = 0; + } + + if (callback) + IoReleaseCancelSpinLock (p_IRP->CancelIrql); + + if (exists) + IoCompleteRequest (p_IRP, IO_NO_INCREMENT); +} + +//==================================== +// Exhaust packet and IRP queues. +//==================================== +VOID +FlushQueues (TapExtensionPointer p_Extension) +{ + PIRP l_IRP; + TapPacketPointer l_PacketBuffer; + int n_IRP=0, n_Packet=0; + + MYASSERT (p_Extension); + MYASSERT (p_Extension->m_TapDevice); + + while (TRUE) + { + NdisAcquireSpinLock (&p_Extension->m_QueueLock); + l_IRP = QueuePop (p_Extension->m_IrpQueue); + NdisReleaseSpinLock (&p_Extension->m_QueueLock); + if (l_IRP) + { + ++n_IRP; + CancelIRP (NULL, l_IRP, FALSE); + } + else + break; + } + + while (TRUE) + { + NdisAcquireSpinLock (&p_Extension->m_QueueLock); + l_PacketBuffer = QueuePop (p_Extension->m_PacketQueue); + NdisReleaseSpinLock (&p_Extension->m_QueueLock); + if (l_PacketBuffer) + { + ++n_Packet; + MemFree (l_PacketBuffer, TAP_PACKET_SIZE (l_PacketBuffer->m_SizeFlags & TP_SIZE_MASK)); + } + else + break; + } + + DEBUGP (( + "[%s] [TAP] FlushQueues n_IRP=[%d,%d,%d] n_Packet=[%d,%d,%d]\n", + p_Extension->m_TapName, + n_IRP, + p_Extension->m_IrpQueue->max_size, + IRP_QUEUE_SIZE, + n_Packet, + p_Extension->m_PacketQueue->max_size, + PACKET_QUEUE_SIZE + )); +} + +//=================================================== +// Tell Windows whether the TAP device should be +// considered "connected" or "disconnected". +//=================================================== +VOID +SetMediaStatus (TapAdapterPointer p_Adapter, BOOLEAN state) +{ + if (p_Adapter->m_MediaState != state && !p_Adapter->m_MediaStateAlwaysConnected) + { + if (state) + NdisMIndicateStatus (p_Adapter->m_MiniportAdapterHandle, + NDIS_STATUS_MEDIA_CONNECT, NULL, 0); + else + NdisMIndicateStatus (p_Adapter->m_MiniportAdapterHandle, + NDIS_STATUS_MEDIA_DISCONNECT, NULL, 0); + + NdisMIndicateStatusComplete (p_Adapter->m_MiniportAdapterHandle); + p_Adapter->m_MediaState = state; + } +} + + +//====================================================== +// If DHCP mode is used together with Point-to-point +// mode, consider the fact that the P2P remote endpoint +// might be equal to the DHCP masq server address. +//====================================================== +VOID +CheckIfDhcpAndPointToPointMode (TapAdapterPointer p_Adapter) +{ + if (p_Adapter->m_PointToPoint && p_Adapter->m_dhcp_enabled) + { + if (p_Adapter->m_dhcp_server_ip == p_Adapter->m_remoteIP) + { + COPY_MAC (p_Adapter->m_dhcp_server_mac, p_Adapter->m_TapToUser.dest); + p_Adapter->m_dhcp_server_arp = FALSE; + } + } +} + +//=================================================== +// Generate an ARP reply message for specific kinds +// ARP queries. +//=================================================== +BOOLEAN +ProcessARP (TapAdapterPointer p_Adapter, + const PARP_PACKET src, + const IPADDR adapter_ip, + const IPADDR ip, + const MACADDR mac) +{ + //----------------------------------------------- + // Is this the kind of packet we are looking for? + //----------------------------------------------- + if (src->m_Proto == htons (ETH_P_ARP) + && MAC_EQUAL (src->m_MAC_Source, p_Adapter->m_MAC) + && MAC_EQUAL (src->m_ARP_MAC_Source, p_Adapter->m_MAC) + && MAC_EQUAL (src->m_MAC_Destination, p_Adapter->m_MAC_Broadcast) + && src->m_ARP_Operation == htons (ARP_REQUEST) + && src->m_MAC_AddressType == htons (MAC_ADDR_TYPE) + && src->m_MAC_AddressSize == sizeof (MACADDR) + && src->m_PROTO_AddressType == htons (ETH_P_IP) + && src->m_PROTO_AddressSize == sizeof (IPADDR) + && src->m_ARP_IP_Source == adapter_ip + && src->m_ARP_IP_Destination == ip) + { + ARP_PACKET *arp = (ARP_PACKET *) MemAlloc (sizeof (ARP_PACKET), TRUE); + if (arp) + { + //---------------------------------------------- + // Initialize ARP reply fields + //---------------------------------------------- + arp->m_Proto = htons (ETH_P_ARP); + arp->m_MAC_AddressType = htons (MAC_ADDR_TYPE); + arp->m_PROTO_AddressType = htons (ETH_P_IP); + arp->m_MAC_AddressSize = sizeof (MACADDR); + arp->m_PROTO_AddressSize = sizeof (IPADDR); + arp->m_ARP_Operation = htons (ARP_REPLY); + + //---------------------------------------------- + // ARP addresses + //---------------------------------------------- + COPY_MAC (arp->m_MAC_Source, mac); + COPY_MAC (arp->m_MAC_Destination, p_Adapter->m_MAC); + COPY_MAC (arp->m_ARP_MAC_Source, mac); + COPY_MAC (arp->m_ARP_MAC_Destination, p_Adapter->m_MAC); + arp->m_ARP_IP_Source = ip; + arp->m_ARP_IP_Destination = adapter_ip; + + DUMP_PACKET ("ProcessARP", + (unsigned char *) arp, + sizeof (ARP_PACKET)); + + InjectPacket (p_Adapter, (UCHAR *) arp, sizeof (ARP_PACKET)); + + MemFree (arp, sizeof (ARP_PACKET)); + } + + return TRUE; + } + else + return FALSE; +} + +//=============================================================== +// Used in cases where internally generated packets such as +// ARP or DHCP replies must be returned to the kernel, to be +// seen as an incoming packet "arriving" on the interface. +//=============================================================== + +VOID +InjectPacket (TapAdapterPointer p_Adapter, + UCHAR *packet, + const unsigned int len) +{ + MYASSERT (len >= ETHERNET_HEADER_SIZE); + + __try + { + //------------------------------------------------------------ + // NdisMEthIndicateReceive and NdisMEthIndicateReceiveComplete + // could potentially be called reentrantly both here and in + // TapDeviceHook/IRP_MJ_WRITE. + // + // The DDK docs imply that this is okay. + //------------------------------------------------------------ + NdisMEthIndicateReceive + (p_Adapter->m_MiniportAdapterHandle, + (NDIS_HANDLE) p_Adapter, + packet, + ETHERNET_HEADER_SIZE, + packet + ETHERNET_HEADER_SIZE, + len - ETHERNET_HEADER_SIZE, + len - ETHERNET_HEADER_SIZE); + + NdisMEthIndicateReceiveComplete (p_Adapter->m_MiniportAdapterHandle); + } + __except (EXCEPTION_EXECUTE_HANDLER) + { + DEBUGP (("[%s] NdisMEthIndicateReceive failed in InjectPacket\n", + NAME (p_Adapter))); + NOTE_ERROR (); + } +} + +//=================================================================== +// Go back to default TAP mode from Point-To-Point mode. +// Also reset (i.e. disable) DHCP Masq mode. +//=================================================================== +VOID ResetTapAdapterState (TapAdapterPointer p_Adapter) +{ + // Point-To-Point + p_Adapter->m_PointToPoint = FALSE; + p_Adapter->m_localIP = 0; + p_Adapter->m_remoteIP = 0; + NdisZeroMemory (&p_Adapter->m_TapToUser, sizeof (p_Adapter->m_TapToUser)); + NdisZeroMemory (&p_Adapter->m_UserToTap, sizeof (p_Adapter->m_UserToTap)); + + // DHCP Masq + p_Adapter->m_dhcp_enabled = FALSE; + p_Adapter->m_dhcp_server_arp = FALSE; + p_Adapter->m_dhcp_user_supplied_options_buffer_len = 0; + p_Adapter->m_dhcp_addr = 0; + p_Adapter->m_dhcp_netmask = 0; + p_Adapter->m_dhcp_server_ip = 0; + p_Adapter->m_dhcp_lease_time = 0; + p_Adapter->m_dhcp_received_discover = FALSE; + p_Adapter->m_dhcp_bad_requests = 0; + NdisZeroMemory (p_Adapter->m_dhcp_server_mac, sizeof (MACADDR)); +} +//====================================================================== +// End of Source +//====================================================================== diff --git a/tap-win32/types.h b/tap-win32/types.h new file mode 100755 index 0000000..f5a4291 --- /dev/null +++ b/tap-win32/types.h @@ -0,0 +1,162 @@ +/* + * TAP-Win32 -- A kernel driver to provide virtual tap device functionality + * on Windows. Originally derived from the CIPE-Win32 + * project by Damion K. Wilson, with extensive modifications by + * James Yonan. + * + * All source code which derives from the CIPE-Win32 project is + * Copyright (C) Damion K. Wilson, 2003, and is released under the + * GPL version 2 (see below). + * + * All other source code is Copyright (C) 2002-2005 OpenVPN Solutions LLC, + * and is released under the GPL version 2 (see below). + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef TAP_TYPES_DEFINED +#define TAP_TYPES_DEFINED + +typedef struct _Queue +{ + ULONG base; + ULONG size; + ULONG capacity; + ULONG max_size; + PVOID data[]; +} Queue; + +typedef struct _TapAdapter; +typedef struct _TapPacket; + +typedef union _TapAdapterQuery +{ + NDIS_HARDWARE_STATUS m_HardwareStatus; + NDIS_MEDIUM m_Medium; + NDIS_PHYSICAL_MEDIUM m_PhysicalMedium; + UCHAR m_MacAddress [6]; + UCHAR m_Buffer [256]; + ULONG m_Long; + USHORT m_Short; + UCHAR m_Byte; +} +TapAdapterQuery, *TapAdapterQueryPointer; + +typedef struct _TapExtension +{ + // TAP device object and packet queues + Queue *m_PacketQueue, *m_IrpQueue; + PDEVICE_OBJECT m_TapDevice; + NDIS_HANDLE m_TapDeviceHandle; + ULONG m_TapOpens; + + // Used to lock packet queues + NDIS_SPIN_LOCK m_QueueLock; + BOOLEAN m_AllocatedSpinlocks; + + // Used to bracket open/close + // state changes. + MUTEX m_OpenCloseMutex; + + // True if device has been permanently halted + BOOLEAN m_Halt; + + // TAP device name + unsigned char *m_TapName; + UNICODE_STRING m_UnicodeLinkName; + BOOLEAN m_CreatedUnicodeLinkName; + + // Used for device status ioctl only + const char *m_LastErrorFilename; + int m_LastErrorLineNumber; + LONG m_NumTapOpens; + + // Flags + BOOLEAN m_TapIsRunning; + BOOLEAN m_CalledTapDeviceFreeResources; +} +TapExtension, *TapExtensionPointer; + +typedef struct _TapPacket + { +# define TAP_PACKET_SIZE(data_size) (sizeof (TapPacket) + (data_size)) +# define TP_POINT_TO_POINT 0x80000000 +# define TP_SIZE_MASK (~TP_POINT_TO_POINT) + ULONG m_SizeFlags; + UCHAR m_Data []; // m_Data must be the last struct member + } +TapPacket, *TapPacketPointer; + +typedef struct _TapAdapter +{ +# define NAME(a) ((a)->m_NameAnsi.Buffer) + ANSI_STRING m_NameAnsi; + MACADDR m_MAC; + BOOLEAN m_InterfaceIsRunning; + NDIS_HANDLE m_MiniportAdapterHandle; + LONG m_Rx, m_Tx, m_RxErr, m_TxErr; + NDIS_MEDIUM m_Medium; + ULONG m_Lookahead; + ULONG m_MTU; + + // TRUE if adapter should always be + // "connected" even when device node + // is not open by a userspace process. + BOOLEAN m_MediaStateAlwaysConnected; + + // TRUE if device is "connected" + BOOLEAN m_MediaState; + + // Adapter power state + char m_DeviceState; + + // Info for point-to-point mode + BOOLEAN m_PointToPoint; + IPADDR m_localIP; + IPADDR m_remoteIP; + ETH_HEADER m_TapToUser; + ETH_HEADER m_UserToTap; + MACADDR m_MAC_Broadcast; + + // Used for DHCP server masquerade + BOOLEAN m_dhcp_enabled; + IPADDR m_dhcp_addr; + ULONG m_dhcp_netmask; + IPADDR m_dhcp_server_ip; + BOOLEAN m_dhcp_server_arp; + MACADDR m_dhcp_server_mac; + ULONG m_dhcp_lease_time; + UCHAR m_dhcp_user_supplied_options_buffer[DHCP_USER_SUPPLIED_OPTIONS_BUFFER_SIZE]; + ULONG m_dhcp_user_supplied_options_buffer_len; + BOOLEAN m_dhcp_received_discover; + ULONG m_dhcp_bad_requests; + + // Help to tear down the adapter by keeping + // some state information on allocated + // resources. + BOOLEAN m_CalledAdapterFreeResources; + BOOLEAN m_RegisteredAdapterShutdownHandler; + + // Multicast list info + NDIS_SPIN_LOCK m_MCLock; + BOOLEAN m_MCLockAllocated; + ULONG m_MCListSize; + MC_LIST m_MCList; + + // Information on the TAP device + TapExtension m_Extension; +} TapAdapter, *TapAdapterPointer; + +#endif diff --git a/thread.c b/thread.c new file mode 100644 index 0000000..dc246c1 --- /dev/null +++ b/thread.c @@ -0,0 +1,162 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#ifdef USE_PTHREAD + +#include "thread.h" +#include "buffer.h" +#include "common.h" +#include "error.h" +#include "crypto.h" + +#include "memdbg.h" + +static struct sparse_mutex *ssl_mutex; /* GLOBAL */ + +static void +ssl_pthreads_locking_callback (int mode, int type, char *file, int line) +{ + dmsg (D_OPENSSL_LOCK, "SSL LOCK thread=%4lu mode=%s lock=%s %s:%d", + CRYPTO_thread_id (), + (mode & CRYPTO_LOCK) ? "l" : "u", + (type & CRYPTO_READ) ? "r" : "w", file, line); + + if (mode & CRYPTO_LOCK) + pthread_mutex_lock (&ssl_mutex[type].mutex); + else + pthread_mutex_unlock (&ssl_mutex[type].mutex); +} + +static unsigned long +ssl_pthreads_thread_id (void) +{ + unsigned long ret; + + ret = (unsigned long) pthread_self (); + return ret; +} + +static void +ssl_thread_setup (void) +{ + int i; + +#error L_MSG needs to be initialized as a recursive mutex + + ssl_mutex = OPENSSL_malloc (CRYPTO_num_locks () * sizeof (struct sparse_mutex)); + for (i = 0; i < CRYPTO_num_locks (); i++) + pthread_mutex_init (&ssl_mutex[i].mutex, NULL); + + CRYPTO_set_id_callback ((unsigned long (*)(void)) ssl_pthreads_thread_id); + CRYPTO_set_locking_callback ((void (*)(int, int, const char*, int)) ssl_pthreads_locking_callback); +} + +static void +ssl_thread_cleanup (void) +{ + int i; + + dmsg (D_OPENSSL_LOCK, "SSL LOCK cleanup"); + CRYPTO_set_locking_callback (NULL); + for (i = 0; i < CRYPTO_num_locks (); i++) + pthread_mutex_destroy (&ssl_mutex[i].mutex); + OPENSSL_free (ssl_mutex); +} + +struct sparse_mutex mutex_array[N_MUTEXES]; /* GLOBAL */ +bool pthread_initialized; /* GLOBAL */ + +openvpn_thread_t +openvpn_thread_create (void *(*start_routine) (void *), void* arg) +{ + openvpn_thread_t ret; + ASSERT (pthread_initialized); + ASSERT (!pthread_create (&ret, NULL, start_routine, arg)); + dmsg (D_THREAD_DEBUG, "CREATE THREAD ID=%lu", (unsigned long)ret); + return ret; +} + +void +openvpn_thread_join (openvpn_thread_t id) +{ + ASSERT (pthread_initialized); + pthread_join (id, NULL); +} + +void +openvpn_thread_init () +{ + int i; + + ASSERT (!pthread_initialized); + + msg (M_INFO, "PTHREAD support initialized"); + + /* initialize OpenSSL library locking */ +#if defined(USE_CRYPTO) && defined(USE_SSL) + ssl_thread_setup(); +#endif + + /* initialize static mutexes */ + for (i = 0; i < N_MUTEXES; i++) + ASSERT (!pthread_mutex_init (&mutex_array[i].mutex, NULL)); + + msg_thread_init (); + + pthread_initialized = true; +} + +void +openvpn_thread_cleanup () +{ + if (pthread_initialized) + { + int i; + + pthread_initialized = false; + + /* cleanup OpenSSL library locking */ +#if defined(USE_CRYPTO) && defined(USE_SSL) + ssl_thread_cleanup(); +#endif + + /* destroy static mutexes */ + for (i = 0; i < N_MUTEXES; i++) + ASSERT (!pthread_mutex_destroy (&mutex_array[i].mutex)); + + msg_thread_uninit (); + } +} + +#else +static void dummy(void) {} +#endif diff --git a/thread.h b/thread.h new file mode 100644 index 0000000..ecc3616 --- /dev/null +++ b/thread.h @@ -0,0 +1,235 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef THREAD_H +#define THREAD_H + +#include "basic.h" +#include "common.h" + +/* + * OpenVPN static mutex locks, by mutex type + */ +#define L_UNUSED 0 +#define L_CTIME 1 +#define L_INET_NTOA 2 +#define L_MSG 3 +#define L_STRERR 4 +#define L_PUTENV 5 +#define L_PRNG 6 +#define L_GETTIMEOFDAY 7 +#define L_ENV_SET 8 +#define L_SYSTEM 9 +#define L_CREATE_TEMP 10 +#define L_PLUGIN 11 +#define N_MUTEXES 12 + +#ifdef USE_PTHREAD + +#define MAX_THREADS 50 + +#define CACHE_LINE_SIZE 128 + +/* + * Improve SMP performance by making sure that each + * mutex resides in its own cache line. + */ +struct sparse_mutex +{ + pthread_mutex_t mutex; + uint8_t dummy [CACHE_LINE_SIZE - sizeof (pthread_mutex_t)]; +}; + +typedef pthread_t openvpn_thread_t; + +extern bool pthread_initialized; + +extern struct sparse_mutex mutex_array[N_MUTEXES]; + +#define MUTEX_DEFINE(lock) pthread_mutex_t lock +#define MUTEX_PTR_DEFINE(lock) pthread_mutex_t *lock + +static inline bool +openvpn_thread_enabled (void) +{ + return pthread_initialized; +} + +static inline openvpn_thread_t +openvpn_thread_self (void) +{ + return pthread_initialized ? pthread_self() : 0; +} + +static inline void +mutex_init (pthread_mutex_t *mutex) +{ + if (mutex) + pthread_mutex_init (mutex, NULL); +} + +static inline void +mutex_destroy (pthread_mutex_t *mutex) +{ + if (mutex) + pthread_mutex_destroy (mutex); +} + +static inline void +mutex_lock (pthread_mutex_t *mutex) +{ + if (pthread_initialized && mutex) + pthread_mutex_lock (mutex); +} + +static inline bool +mutex_trylock (pthread_mutex_t *mutex) +{ + if (pthread_initialized && mutex) + return pthread_mutex_trylock (mutex) == 0; + else + return true; +} + +static inline void +mutex_unlock (pthread_mutex_t *mutex) +{ + if (pthread_initialized && mutex) + { + pthread_mutex_unlock (mutex); +#if 1 /* JYFIXME: if race conditions exist, make them more likely to occur */ + sleep (0); +#endif + } +} + +static inline void +mutex_cycle (pthread_mutex_t *mutex) +{ + if (pthread_initialized && mutex) + { + pthread_mutex_unlock (mutex); + sleep (0); + pthread_mutex_lock (mutex); + } +} + +static inline void +mutex_lock_static (int type) +{ + mutex_lock (&mutex_array[type].mutex); +} + +static inline void +mutex_unlock_static (int type) +{ + mutex_unlock (&mutex_array[type].mutex); +} + +static inline void +mutex_cycle_static (int type) +{ + mutex_cycle (&mutex_array[type].mutex); +} + +void openvpn_thread_init (void); +void openvpn_thread_cleanup (void); + +openvpn_thread_t openvpn_thread_create (void *(*start_routine) (void *), void* arg); +void openvpn_thread_join (openvpn_thread_t id); + +#else /* USE_PTHREAD */ + +typedef int openvpn_thread_t; + +#if defined(_MSC_VER) || PEDANTIC + +#define MUTEX_DEFINE(lock) int eat_semicolon +#define MUTEX_PTR_DEFINE(lock) int eat_semicolon + +#else + +#define MUTEX_DEFINE(lock) +#define MUTEX_PTR_DEFINE(lock) + +#endif + +#define mutex_init(m) +#define mutex_destroy(m) +#define mutex_lock(m) +#define mutex_trylock(m) (true) +#define mutex_unlock(m) +#define mutex_cycle(m) + +static inline bool +openvpn_thread_enabled (void) +{ + return false; +} + +static inline openvpn_thread_t +openvpn_thread_self (void) +{ + return 0; +} + +static inline void +openvpn_thread_init (void) +{ +} + +static inline void +openvpn_thread_cleanup (void) +{ +} + +static inline openvpn_thread_t +openvpn_thread_create (void *(*start_routine) (void *), void* arg) +{ + return 0; +} + +static inline void +work_thread_join (openvpn_thread_t id) +{ +} + +static inline void +mutex_lock_static (int type) +{ +} + +static inline void +mutex_unlock_static (int type) +{ +} + +static inline void +mutex_cycle_static (int type) +{ +} + +#endif /* USE_PTHREAD */ + +#endif /* THREAD_H */ @@ -0,0 +1,3434 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Support routines for configuring and accessing TUN/TAP + * virtual network adapters. + * + * This file is based on the TUN/TAP driver interface routines + * from VTun by Maxim Krasnyansky <max_mk@yahoo.com>. + */ + +#ifdef WIN32 +#include "config-win32.h" +#else +#include "config.h" +#endif + +#include "syshead.h" + +#include "tun.h" +#include "fdmisc.h" +#include "common.h" +#include "misc.h" +#include "socket.h" +#include "manage.h" + +#include "memdbg.h" + +#ifdef TARGET_SOLARIS +static void solaris_error_close (struct tuntap *tt, const struct env_set *es, const char *actual); +#endif + +bool +is_dev_type (const char *dev, const char *dev_type, const char *match_type) +{ + ASSERT (match_type); + if (!dev) + return false; + if (dev_type) + return !strcmp (dev_type, match_type); + else + return !strncmp (dev, match_type, strlen (match_type)); +} + +int +dev_type_enum (const char *dev, const char *dev_type) +{ + if (is_dev_type (dev, dev_type, "tun")) + return DEV_TYPE_TUN; + else if (is_dev_type (dev, dev_type, "tap")) + return DEV_TYPE_TAP; + else if (is_dev_type (dev, dev_type, "null")) + return DEV_TYPE_NULL; + else + return DEV_TYPE_UNDEF; +} + +const char * +dev_type_string (const char *dev, const char *dev_type) +{ + switch (dev_type_enum (dev, dev_type)) + { + case DEV_TYPE_TUN: + return "tun"; + case DEV_TYPE_TAP: + return "tap"; + case DEV_TYPE_NULL: + return "null"; + default: + return "[unknown-dev-type]"; + } +} + +const char * +dev_component_in_dev_node (const char *dev_node) +{ + const char *ret; + const int dirsep = OS_SPECIFIC_DIRSEP; + + if (dev_node) + { + ret = strrchr (dev_node, dirsep); + if (ret && *ret) + ++ret; + else + ret = dev_node; + if (*ret) + return ret; + } + return NULL; +} + +/* + * Try to predict the actual TUN/TAP device instance name, + * before the device is actually opened. + */ +const char * +guess_tuntap_dev (const char *dev, + const char *dev_type, + const char *dev_node, + struct gc_arena *gc) +{ +#ifdef WIN32 + const int dt = dev_type_enum (dev, dev_type); + if (dt == DEV_TYPE_TUN || dt == DEV_TYPE_TAP) + { + return get_netsh_id (dev_node, gc); + } +#endif + + /* default case */ + return dev; +} + +/* + * Called by the open_tun function of OSes to check if we + * explicitly support IPv6. + * + * In this context, explicit means that the OS expects us to + * do something special to the tun socket in order to support + * IPv6, i.e. it is not transparent. + * + * ipv6_explicitly_supported should be set to false if we don't + * have any explicit IPv6 code in the tun device handler. + * + * If ipv6_explicitly_supported is true, then we have explicit + * OS-specific tun dev code for handling IPv6. If so, tt->ipv6 + * is set according to the --tun-ipv6 command line option. + */ +static void +ipv6_support (bool ipv6, bool ipv6_explicitly_supported, struct tuntap* tt) +{ + tt->ipv6 = false; + if (ipv6_explicitly_supported) + tt->ipv6 = ipv6; + else if (ipv6) + msg (M_WARN, "NOTE: explicit support for IPv6 tun devices is not provided for this OS"); +} + +/* --ifconfig-nowarn disables some options sanity checking */ +static const char ifconfig_warn_how_to_silence[] = "(silence this warning with --ifconfig-nowarn)"; + +/* + * If !tun, make sure ifconfig_remote_netmask looks + * like a netmask. + * + * If tun, make sure ifconfig_remote_netmask looks + * like an IPv4 address. + */ +static void +ifconfig_sanity_check (bool tun, in_addr_t addr) +{ + struct gc_arena gc = gc_new (); + const bool looks_like_netmask = ((addr & 0xFF000000) == 0xFF000000); + if (tun) + { + if (looks_like_netmask) + msg (M_WARN, "WARNING: Since you are using --dev tun, the second argument to --ifconfig must be an IP address. You are using something (%s) that looks more like a netmask. %s", + print_in_addr_t (addr, 0, &gc), + ifconfig_warn_how_to_silence); + } + else /* tap */ + { + if (!looks_like_netmask) + msg (M_WARN, "WARNING: Since you are using --dev tap, the second argument to --ifconfig must be a netmask, for example something like 255.255.255.0. %s", + ifconfig_warn_how_to_silence); + } + gc_free (&gc); +} + +/* + * For TAP-style devices, generate a broadcast address. + */ +static in_addr_t +generate_ifconfig_broadcast_addr (in_addr_t local, + in_addr_t netmask) +{ + return local | ~netmask; +} + +/* + * Check that --local and --remote addresses do not + * clash with ifconfig addresses or subnet. + */ +static void +check_addr_clash (const char *name, + int type, + in_addr_t public, + in_addr_t local, + in_addr_t remote_netmask) +{ + struct gc_arena gc = gc_new (); +#if 0 + msg (M_INFO, "CHECK_ADDR_CLASH type=%d public=%s local=%s, remote_netmask=%s", + type, + print_in_addr_t (public, 0, &gc), + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote_netmask, 0, &gc)); +#endif + + if (public) + { + if (type == DEV_TYPE_TUN) + { + const in_addr_t test_netmask = 0xFFFFFF00; + const in_addr_t public_net = public & test_netmask; + const in_addr_t local_net = local & test_netmask; + const in_addr_t remote_net = remote_netmask & test_netmask; + + if (public == local || public == remote_netmask) + msg (M_WARN, + "WARNING: --%s address [%s] conflicts with --ifconfig address pair [%s, %s]. %s", + name, + print_in_addr_t (public, 0, &gc), + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote_netmask, 0, &gc), + ifconfig_warn_how_to_silence); + + if (public_net == local_net || public_net == remote_net) + msg (M_WARN, + "WARNING: potential conflict between --%s address [%s] and --ifconfig address pair [%s, %s] -- this is a warning only that is triggered when local/remote addresses exist within the same /24 subnet as --ifconfig endpoints. %s", + name, + print_in_addr_t (public, 0, &gc), + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote_netmask, 0, &gc), + ifconfig_warn_how_to_silence); + } + else if (type == DEV_TYPE_TAP) + { + const in_addr_t public_network = public & remote_netmask; + const in_addr_t virtual_network = local & remote_netmask; + if (public_network == virtual_network) + msg (M_WARN, + "WARNING: --%s address [%s] conflicts with --ifconfig subnet [%s, %s] -- local and remote addresses cannot be inside of the --ifconfig subnet. %s", + name, + print_in_addr_t (public, 0, &gc), + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote_netmask, 0, &gc), + ifconfig_warn_how_to_silence); + } + } + gc_free (&gc); +} + +/* + * Complain if --dev tap and --ifconfig is used on an OS for which + * we don't have a custom tap ifconfig template below. + */ +static void +no_tap_ifconfig () +{ + msg (M_FATAL, "Sorry but you cannot use --dev tap and --ifconfig together on this OS because I have not yet been programmed to understand the appropriate ifconfig syntax to use for TAP-style devices on this OS. Your best alternative is to use an --up script and do the ifconfig command manually."); +} + +/* + * Return a string to be used for options compatibility check + * between peers. + */ +const char * +ifconfig_options_string (const struct tuntap* tt, bool remote, bool disable, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + if (tt->did_ifconfig_setup && !disable) + { + if (tt->type == DEV_TYPE_TUN) + { + const char *l, *r; + if (remote) + { + r = print_in_addr_t (tt->local, 0, gc); + l = print_in_addr_t (tt->remote_netmask, 0, gc); + } + else + { + l = print_in_addr_t (tt->local, 0, gc); + r = print_in_addr_t (tt->remote_netmask, 0, gc); + } + buf_printf (&out, "%s %s", r, l); + } + else if (tt->type == DEV_TYPE_TAP) + { + buf_printf (&out, "%s %s", + print_in_addr_t (tt->local & tt->remote_netmask, 0, gc), + print_in_addr_t (tt->remote_netmask, 0, gc)); + } + else + buf_printf (&out, "[undef]"); + } + return BSTR (&out); +} + +/* + * Return a status string describing wait state. + */ +const char * +tun_stat (const struct tuntap *tt, unsigned int rwflags, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (64, gc); + if (tt) + { + if (rwflags & EVENT_READ) + { + buf_printf (&out, "T%s", + (tt->rwflags_debug & EVENT_READ) ? "R" : "r"); +#ifdef WIN32 + buf_printf (&out, "%s", + overlapped_io_state_ascii (&tt->reads)); +#endif + } + if (rwflags & EVENT_WRITE) + { + buf_printf (&out, "T%s", + (tt->rwflags_debug & EVENT_WRITE) ? "W" : "w"); +#ifdef WIN32 + buf_printf (&out, "%s", + overlapped_io_state_ascii (&tt->writes)); +#endif + } + } + else + { + buf_printf (&out, "T?"); + } + return BSTR (&out); +} + +/* + * Init tun/tap object. + * + * Set up tuntap structure for ifconfig, + * but don't execute yet. + */ +struct tuntap * +init_tun (const char *dev, /* --dev option */ + const char *dev_type, /* --dev-type option */ + const char *ifconfig_local_parm, /* --ifconfig parm 1 */ + const char *ifconfig_remote_netmask_parm, /* --ifconfig parm 2 */ + in_addr_t local_public, + in_addr_t remote_public, + const bool strict_warn, + struct env_set *es) +{ + struct gc_arena gc = gc_new (); + struct tuntap *tt; + + ALLOC_OBJ (tt, struct tuntap); + clear_tuntap (tt); + + tt->type = dev_type_enum (dev, dev_type); + + if (ifconfig_local_parm && ifconfig_remote_netmask_parm) + { + bool tun = false; + const char *ifconfig_local = NULL; + const char *ifconfig_remote_netmask = NULL; + const char *ifconfig_broadcast = NULL; + + /* + * We only handle TUN/TAP devices here, not --dev null devices. + */ + if (tt->type == DEV_TYPE_TUN) + tun = true; + else if (tt->type == DEV_TYPE_TAP) + tun = false; + else + msg (M_FATAL, "'%s' is not a TUN/TAP device. The --ifconfig option works only for TUN/TAP devices.", dev); + + /* + * Convert arguments to binary IPv4 addresses. + */ + + tt->local = getaddr ( + GETADDR_RESOLVE + | GETADDR_HOST_ORDER + | GETADDR_FATAL_ON_SIGNAL + | GETADDR_FATAL, + ifconfig_local_parm, + 0, + NULL, + NULL); + + tt->remote_netmask = getaddr ( + (tun ? GETADDR_RESOLVE : 0) + | GETADDR_HOST_ORDER + | GETADDR_FATAL_ON_SIGNAL + | GETADDR_FATAL, + ifconfig_remote_netmask_parm, + 0, + NULL, + NULL); + + /* + * Look for common errors in --ifconfig parms + */ + if (strict_warn) + { + ifconfig_sanity_check (tun, tt->remote_netmask); + + /* + * If local_public or remote_public addresses are defined, + * make sure they do not clash with our virtual subnet. + */ + + check_addr_clash ("local", + tt->type, + local_public, + tt->local, + tt->remote_netmask); + + check_addr_clash ("remote", + tt->type, + remote_public, + tt->local, + tt->remote_netmask); + } + + /* + * Set ifconfig parameters + */ + ifconfig_local = print_in_addr_t (tt->local, 0, &gc); + ifconfig_remote_netmask = print_in_addr_t (tt->remote_netmask, 0, &gc); + + /* + * If TAP-style interface, generate broadcast address. + */ + if (!tun) + { + tt->broadcast = generate_ifconfig_broadcast_addr (tt->local, tt->remote_netmask); + ifconfig_broadcast = print_in_addr_t (tt->broadcast, 0, &gc); + } + + /* + * Set environmental variables with ifconfig parameters. + */ + if (es) + { + setenv_str (es, "ifconfig_local", ifconfig_local); + if (tun) + { + setenv_str (es, "ifconfig_remote", ifconfig_remote_netmask); + } + else + { + setenv_str (es, "ifconfig_netmask", ifconfig_remote_netmask); + setenv_str (es, "ifconfig_broadcast", ifconfig_broadcast); + } + } + + tt->did_ifconfig_setup = true; + } + gc_free (&gc); + return tt; +} + +/* + * Platform specific tun initializations + */ +void +init_tun_post (struct tuntap *tt, + const struct frame *frame, + const struct tuntap_options *options) +{ + tt->options = *options; +#ifdef WIN32 + overlapped_io_init (&tt->reads, frame, FALSE, true); + overlapped_io_init (&tt->writes, frame, TRUE, true); + tt->rw_handle.read = tt->reads.overlapped.hEvent; + tt->rw_handle.write = tt->writes.overlapped.hEvent; + tt->adapter_index = ~0; +#endif +} + +/* execute the ifconfig command through the shell */ +void +do_ifconfig (struct tuntap *tt, + const char *actual, /* actual device name */ + int tun_mtu, + const struct env_set *es) +{ + struct gc_arena gc = gc_new (); + + if (tt->did_ifconfig_setup) + { + bool tun = false; + const char *ifconfig_local = NULL; + const char *ifconfig_remote_netmask = NULL; + const char *ifconfig_broadcast = NULL; + char command_line[256]; + + /* + * We only handle TUN/TAP devices here, not --dev null devices. + */ + if (tt->type == DEV_TYPE_TUN) + tun = true; + else if (tt->type == DEV_TYPE_TAP) + tun = false; + else + ASSERT (0); /* should have been caught in init_tun */ + + /* + * Set ifconfig parameters + */ + ifconfig_local = print_in_addr_t (tt->local, 0, &gc); + ifconfig_remote_netmask = print_in_addr_t (tt->remote_netmask, 0, &gc); + + /* + * If TAP-style device, generate broadcast address. + */ + if (!tun) + ifconfig_broadcast = print_in_addr_t (tt->broadcast, 0, &gc); + +#ifdef ENABLE_MANAGEMENT + if (management) + { + management_set_state (management, + OPENVPN_STATE_ASSIGN_IP, + NULL, + tt->local); + } +#endif + + +#if defined(TARGET_LINUX) +#ifdef CONFIG_FEATURE_IPROUTE + /* + * Set the MTU for the device + */ + openvpn_snprintf (command_line, sizeof (command_line), + IPROUTE_PATH " link set dev %s up mtu %d", + actual, + tun_mtu + ); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "Linux ip link set failed"); + + if (tun) { + + /* + * Set the address for the device + */ + openvpn_snprintf (command_line, sizeof (command_line), + IPROUTE_PATH " addr add dev %s local %s peer %s", + actual, + ifconfig_local, + ifconfig_remote_netmask + ); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "Linux ip addr add failed"); + } else { + openvpn_snprintf (command_line, sizeof (command_line), + IPROUTE_PATH " addr add dev %s %s/%d broadcast %s", + actual, + ifconfig_local, + count_netmask_bits(ifconfig_remote_netmask), + ifconfig_broadcast + ); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "Linux ip addr add failed"); + } + tt->did_ifconfig = true; +#else + if (tun) + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s pointopoint %s mtu %d", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + else + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s netmask %s mtu %d broadcast %s", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu, + ifconfig_broadcast + ); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "Linux ifconfig failed"); + tt->did_ifconfig = true; + +#endif /*CONFIG_FEATURE_IPROUTE*/ +#elif defined(TARGET_SOLARIS) + + /* Solaris 2.6 (and 7?) cannot set all parameters in one go... + * example: + * ifconfig tun2 10.2.0.2 10.2.0.1 mtu 1450 up + * ifconfig tun2 netmask 255.255.255.255 + */ + if (tun) + { + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s %s mtu %d up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + + msg (M_INFO, "%s", command_line); + if (!system_check (command_line, es, 0, "Solaris ifconfig phase-1 failed")) + solaris_error_close (tt, es, actual); + + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s netmask 255.255.255.255", + actual + ); + } + else + no_tap_ifconfig (); + + msg (M_INFO, "%s", command_line); + if (!system_check (command_line, es, 0, "Solaris ifconfig phase-2 failed")) + solaris_error_close (tt, es, actual); + + tt->did_ifconfig = true; + +#elif defined(TARGET_OPENBSD) + + /* + * OpenBSD tun devices appear to be persistent by default. It seems in order + * to make this work correctly, we need to delete the previous instance + * (if it exists), and re-ifconfig. Let me know if you know a better way. + */ + + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s destroy", + actual); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, 0, NULL); + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s create", + actual); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, 0, NULL); + msg (M_INFO, "NOTE: Tried to delete pre-existing tun/tap instance -- No Problem if failure"); + + /* example: ifconfig tun2 10.2.0.2 10.2.0.1 mtu 1450 netmask 255.255.255.255 up */ + if (tun) + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s %s mtu %d netmask 255.255.255.255 up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + else + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s netmask %s mtu %d broadcast %s link0", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu, + ifconfig_broadcast + ); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "OpenBSD ifconfig failed"); + tt->did_ifconfig = true; + +#elif defined(TARGET_NETBSD) + + if (tun) + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s %s mtu %d netmask 255.255.255.255 up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + else + no_tap_ifconfig (); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "NetBSD ifconfig failed"); + tt->did_ifconfig = true; + +#elif defined(TARGET_DARWIN) + + /* + * Darwin (i.e. Mac OS X) seems to exhibit similar behaviour to OpenBSD... + */ + + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s delete", + actual); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, 0, NULL); + msg (M_INFO, "NOTE: Tried to delete pre-existing tun/tap instance -- No Problem if failure"); + + + /* example: ifconfig tun2 10.2.0.2 10.2.0.1 mtu 1450 netmask 255.255.255.255 up */ + if (tun) + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s %s mtu %d netmask 255.255.255.255 up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + else + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s netmask %s mtu %d up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "Mac OS X ifconfig failed"); + tt->did_ifconfig = true; + +#elif defined(TARGET_FREEBSD) + + /* example: ifconfig tun2 10.2.0.2 10.2.0.1 mtu 1450 netmask 255.255.255.255 up */ + if (tun) + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s %s mtu %d netmask 255.255.255.255 up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + else + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s %s netmask %s mtu %d up", + actual, + ifconfig_local, + ifconfig_remote_netmask, + tun_mtu + ); + + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "FreeBSD ifconfig failed"); + tt->did_ifconfig = true; + +#elif defined (WIN32) + { + const char *netmask; + + /* + * Make sure that both ifconfig addresses are part of the + * same .252 subnet. + */ + if (tun) + { + verify_255_255_255_252 (tt->local, tt->remote_netmask); + tt->adapter_netmask = ~3; + netmask = print_in_addr_t (tt->adapter_netmask, 0, &gc); + } + else + { + netmask = ifconfig_remote_netmask; + tt->adapter_netmask = tt->remote_netmask; + } + + /* example: netsh interface ip set address my-tap static 10.3.0.1 255.255.255.0 */ + openvpn_snprintf (command_line, sizeof (command_line), + "netsh interface ip set address \"%s\" static %s %s", + actual, + ifconfig_local, + netmask); + + switch (tt->options.ip_win32_type) + { + case IPW32_SET_MANUAL: + msg (M_INFO, "******** NOTE: Please manually set the IP/netmask of '%s' to %s/%s (if it is not already set)", + actual, + ifconfig_local, + netmask); + break; + case IPW32_SET_NETSH: + if (!strcmp (actual, "NULL")) + msg (M_FATAL, "Error: When using --ip-win32 netsh, if you have more than one TAP-Win32 adapter, you must also specify --dev-node"); + netcmd_semaphore_lock (); + msg (M_INFO, "%s", command_line); + system_check (command_line, es, S_FATAL, "ERROR: netsh command failed"); + netcmd_semaphore_release (); + break; + } + tt->did_ifconfig = true; + } + +#else + msg (M_FATAL, "Sorry, but I don't know how to do 'ifconfig' commands on this operating system. You should ifconfig your TUN/TAP device manually or use an --up script."); +#endif + } + gc_free (&gc); +} + +void +clear_tuntap (struct tuntap *tuntap) +{ + CLEAR (*tuntap); +#ifdef WIN32 + tuntap->hand = NULL; +#else + tuntap->fd = -1; +#endif +#ifdef TARGET_SOLARIS + tuntap->ip_fd = -1; +#endif + tuntap->ipv6 = false; +} + +static void +open_null (struct tuntap *tt) +{ + tt->actual_name = string_alloc ("null", NULL); +} + +#ifndef WIN32 +static void +open_tun_generic (const char *dev, const char *dev_type, const char *dev_node, + bool ipv6, bool ipv6_explicitly_supported, bool dynamic, + struct tuntap *tt) +{ + char tunname[256]; + char dynamic_name[256]; + bool dynamic_opened = false; + + ipv6_support (ipv6, ipv6_explicitly_supported, tt); + + if (tt->type == DEV_TYPE_NULL) + { + open_null (tt); + } + else + { + /* + * --dev-node specified, so open an explicit device node + */ + if (dev_node) + { + openvpn_snprintf (tunname, sizeof (tunname), "%s", dev_node); + } + else + { + /* + * dynamic open is indicated by --dev specified without + * explicit unit number. Try opening /dev/[dev]n + * where n = [0, 255]. + */ + if (dynamic && !has_digit(dev)) + { + int i; + for (i = 0; i < 256; ++i) + { + openvpn_snprintf (tunname, sizeof (tunname), + "/dev/%s%d", dev, i); + openvpn_snprintf (dynamic_name, sizeof (dynamic_name), + "%s%d", dev, i); + if ((tt->fd = open (tunname, O_RDWR)) > 0) + { + dynamic_opened = true; + break; + } + msg (D_READ_WRITE | M_ERRNO, "Tried opening %s (failed)", tunname); + } + if (!dynamic_opened) + msg (M_FATAL, "Cannot allocate TUN/TAP dev dynamically"); + } + /* + * explicit unit number specified + */ + else + { + openvpn_snprintf (tunname, sizeof (tunname), "/dev/%s", dev); + } + } + + if (!dynamic_opened) + { + if ((tt->fd = open (tunname, O_RDWR)) < 0) + msg (M_ERR, "Cannot open TUN/TAP dev %s", tunname); + } + + set_nonblock (tt->fd); + set_cloexec (tt->fd); /* don't pass fd to scripts */ + msg (M_INFO, "TUN/TAP device %s opened", tunname); + + /* tt->actual_name is passed to up and down scripts and used as the ifconfig dev name */ + tt->actual_name = string_alloc (dynamic_opened ? dynamic_name : dev, NULL); + } +} + +static void +close_tun_generic (struct tuntap *tt) +{ + if (tt->fd >= 0) + close (tt->fd); + if (tt->actual_name) + free (tt->actual_name); + clear_tuntap (tt); +} + +#endif + +#if defined(TARGET_LINUX) + +#ifdef HAVE_LINUX_IF_TUN_H /* New driver support */ + +#ifndef HAVE_LINUX_SOCKIOS_H +#error header file linux/sockios.h required +#endif + +#if defined(HAVE_TUN_PI) && defined(HAVE_IPHDR) && defined(HAVE_IOVEC) && defined(ETH_P_IPV6) && defined(ETH_P_IP) && defined(HAVE_READV) && defined(HAVE_WRITEV) +#define LINUX_IPV6 1 +/* #warning IPv6 ON */ +#else +#define LINUX_IPV6 0 +/* #warning IPv6 OFF */ +#endif + +#if !PEDANTIC + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + struct ifreq ifr; + + /* + * Set tt->ipv6 to true if + * (a) we have the capability of supporting --tun-ipv6, and + * (b) --tun-ipv6 was specified. + */ + ipv6_support (ipv6, LINUX_IPV6, tt); + + /* + * We handle --dev null specially, we do not open /dev/null for this. + */ + if (tt->type == DEV_TYPE_NULL) + { + open_null (tt); + } + else + { + /* + * Process --dev-node + */ + const char *node = dev_node; + if (!node) + node = "/dev/net/tun"; + + /* + * Open the interface + */ + if ((tt->fd = open (node, O_RDWR)) < 0) + { + msg (M_WARN | M_ERRNO, "Note: Cannot open TUN/TAP dev %s", node); + goto linux_2_2_fallback; + } + + /* + * Process --tun-ipv6 + */ + CLEAR (ifr); + if (!tt->ipv6) + ifr.ifr_flags = IFF_NO_PI; + +#if defined(IFF_ONE_QUEUE) && defined(SIOCSIFTXQLEN) + ifr.ifr_flags |= IFF_ONE_QUEUE; +#endif + + /* + * Figure out if tun or tap device + */ + if (tt->type == DEV_TYPE_TUN) + { + ifr.ifr_flags |= IFF_TUN; + } + else if (tt->type == DEV_TYPE_TAP) + { + ifr.ifr_flags |= IFF_TAP; + } + else + { + msg (M_FATAL, "I don't recognize device %s as a tun or tap device", + dev); + } + + /* + * Set an explicit name, if --dev is not tun or tap + */ + if (strcmp(dev, "tun") && strcmp(dev, "tap")) + strncpynt (ifr.ifr_name, dev, IFNAMSIZ); + + /* + * Use special ioctl that configures tun/tap device with the parms + * we set in ifr + */ + if (ioctl (tt->fd, TUNSETIFF, (void *) &ifr) < 0) + { + msg (M_WARN | M_ERRNO, "Note: Cannot ioctl TUNSETIFF %s", dev); + goto linux_2_2_fallback; + } + + msg (M_INFO, "TUN/TAP device %s opened", ifr.ifr_name); + + /* + * Try making the TX send queue bigger + */ +#if defined(IFF_ONE_QUEUE) && defined(SIOCSIFTXQLEN) + { + struct ifreq netifr; + int ctl_fd; + + if ((ctl_fd = socket (AF_INET, SOCK_DGRAM, 0)) >= 0) + { + CLEAR (netifr); + strncpynt (netifr.ifr_name, ifr.ifr_name, IFNAMSIZ); + netifr.ifr_qlen = tt->options.txqueuelen; + if (ioctl (ctl_fd, SIOCSIFTXQLEN, (void *) &netifr) >= 0) + msg (D_OSBUF, "TUN/TAP TX queue length set to %d", tt->options.txqueuelen); + else + msg (M_WARN | M_ERRNO, "Note: Cannot set tx queue length on %s", ifr.ifr_name); + close (ctl_fd); + } + else + { + msg (M_WARN | M_ERRNO, "Note: Cannot open control socket on %s", ifr.ifr_name); + } + } +#endif + + set_nonblock (tt->fd); + set_cloexec (tt->fd); + tt->actual_name = string_alloc (ifr.ifr_name, NULL); + } + return; + + linux_2_2_fallback: + msg (M_INFO, "Note: Attempting fallback to kernel 2.2 TUN/TAP interface"); + if (tt->fd >= 0) + { + close (tt->fd); + tt->fd = -1; + } + open_tun_generic (dev, dev_type, dev_node, ipv6, false, true, tt); +} + +#else + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + ASSERT (0); +} + +#endif + +#else + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + open_tun_generic (dev, dev_type, dev_node, ipv6, false, true, tt); +} + +#endif /* HAVE_LINUX_IF_TUN_H */ + +#ifdef TUNSETPERSIST + +void +tuncfg (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, int persist_mode) +{ + struct tuntap *tt; + + ALLOC_OBJ (tt, struct tuntap); + clear_tuntap (tt); + tt->type = dev_type_enum (dev, dev_type); + open_tun (dev, dev_type, dev_node, ipv6, tt); + if (ioctl (tt->fd, TUNSETPERSIST, persist_mode) < 0) + msg (M_ERR, "Cannot ioctl TUNSETPERSIST(%d) %s", persist_mode, dev); + close_tun (tt); + msg (M_INFO, "Persist state set to: %s", (persist_mode ? "ON" : "OFF")); +} + +#endif /* TUNSETPERSIST */ + +void +close_tun (struct tuntap *tt) +{ + if (tt) + { + close_tun_generic (tt); + free (tt); + } +} + +int +write_tun (struct tuntap* tt, uint8_t *buf, int len) +{ +#if LINUX_IPV6 + if (tt->ipv6) + { + struct tun_pi pi; + struct iphdr *iph; + struct iovec vect[2]; + int ret; + + iph = (struct iphdr *)buf; + + pi.flags = 0; + + if(iph->version == 6) + pi.proto = htons(ETH_P_IPV6); + else + pi.proto = htons(ETH_P_IP); + + vect[0].iov_len = sizeof(pi); + vect[0].iov_base = π + vect[1].iov_len = len; + vect[1].iov_base = buf; + + ret = writev(tt->fd, vect, 2); + return(ret - sizeof(pi)); + } + else +#endif + return write (tt->fd, buf, len); +} + +int +read_tun (struct tuntap* tt, uint8_t *buf, int len) +{ +#if LINUX_IPV6 + if (tt->ipv6) + { + struct iovec vect[2]; + struct tun_pi pi; + int ret; + + vect[0].iov_len = sizeof(pi); + vect[0].iov_base = π + vect[1].iov_len = len; + vect[1].iov_base = buf; + + ret = readv(tt->fd, vect, 2); + return(ret - sizeof(pi)); + } + else +#endif + return read (tt->fd, buf, len); +} + +#elif defined(TARGET_SOLARIS) + +#ifndef TUNNEWPPA +#error I need the symbol TUNNEWPPA from net/if_tun.h +#endif + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + int if_fd, muxid, ppa = -1; + struct ifreq ifr; + const char *ptr; + const char *ip_node; + const char *dev_tuntap_type; + int link_type; + bool is_tun; + + ipv6_support (ipv6, false, tt); + + if (tt->type == DEV_TYPE_NULL) + { + open_null (tt); + return; + } + + if (tt->type == DEV_TYPE_TUN) + { + ip_node = "/dev/udp"; + if (!dev_node) + dev_node = "/dev/tun"; + dev_tuntap_type = "tun"; + link_type = I_PLINK; + is_tun = true; + } + else if (tt->type == DEV_TYPE_TAP) + { + ip_node = "/dev/ip"; + if (!dev_node) + dev_node = "/dev/tap"; + dev_tuntap_type = "tap"; + link_type = I_PLINK; /* was: I_LINK */ + is_tun = false; + } + else + { + msg (M_FATAL, "I don't recognize device %s as a tun or tap device", + dev); + } + + /* get unit number */ + if (*dev) + { + ptr = dev; + while (*ptr && !isdigit ((int) *ptr)) + ptr++; + ppa = atoi (ptr); + } + + if ((tt->ip_fd = open (ip_node, O_RDWR, 0)) < 0) + msg (M_ERR, "Can't open %s", ip_node); + + if ((tt->fd = open (dev_node, O_RDWR, 0)) < 0) + msg (M_ERR, "Can't open %s", dev_node); + + /* Assign a new PPA and get its unit number. */ + if ((ppa = ioctl (tt->fd, TUNNEWPPA, ppa)) < 0) + msg (M_ERR, "Can't assign new interface"); + + if ((if_fd = open (dev_node, O_RDWR, 0)) < 0) + msg (M_ERR, "Can't open %s (2)", dev_node); + + if (ioctl (if_fd, I_PUSH, "ip") < 0) + msg (M_ERR, "Can't push IP module"); + + /* Assign ppa according to the unit number returned by tun device */ + if (ioctl (if_fd, IF_UNITSEL, (char *) &ppa) < 0) + msg (M_ERR, "Can't set PPA %d", ppa); + + if ((muxid = ioctl (tt->ip_fd, link_type, if_fd)) < 0) + msg (M_ERR, "Can't link %s device to IP", dev_tuntap_type); + + close (if_fd); + + tt->actual_name = (char *) malloc (32); + check_malloc_return (tt->actual_name); + + openvpn_snprintf (tt->actual_name, 32, "%s%d", dev_tuntap_type, ppa); + + CLEAR (ifr); + strncpynt (ifr.ifr_name, tt->actual_name, sizeof (ifr.ifr_name)); + ifr.ifr_ip_muxid = muxid; + + if (ioctl (tt->ip_fd, SIOCSIFMUXID, &ifr) < 0) + { + ioctl (tt->ip_fd, I_PUNLINK, muxid); + msg (M_ERR, "Can't set multiplexor id"); + } + + set_nonblock (tt->fd); + set_cloexec (tt->fd); + set_cloexec (tt->ip_fd); + + msg (M_INFO, "TUN/TAP device %s opened", tt->actual_name); +} + +static void +solaris_close_tun (struct tuntap *tt) +{ + if (tt) + { + if (tt->ip_fd >= 0) + { + struct ifreq ifr; + CLEAR (ifr); + strncpynt (ifr.ifr_name, tt->actual_name, sizeof (ifr.ifr_name)); + + if (ioctl (tt->ip_fd, SIOCGIFFLAGS, &ifr) < 0) + msg (M_WARN | M_ERRNO, "Can't get iface flags"); + + if (ioctl (tt->ip_fd, SIOCGIFMUXID, &ifr) < 0) + msg (M_WARN | M_ERRNO, "Can't get multiplexor id"); + + if (ioctl (tt->ip_fd, I_PUNLINK, ifr.ifr_ip_muxid) < 0) + msg (M_WARN | M_ERRNO, "Can't unlink interface"); + + close (tt->ip_fd); + tt->ip_fd = -1; + } + + if (tt->fd >= 0) + { + close (tt->fd); + tt->fd = -1; + } + } +} + +/* + * Close TUN device. + */ +void +close_tun (struct tuntap *tt) +{ + if (tt) + { + solaris_close_tun (tt); + + if (tt->actual_name) + free (tt->actual_name); + + clear_tuntap (tt); + free (tt); + } +} + +static void +solaris_error_close (struct tuntap *tt, const struct env_set *es, const char *actual) +{ + char command_line[256]; + + openvpn_snprintf (command_line, sizeof (command_line), + IFCONFIG_PATH " %s unplumb", + actual); + + msg (M_INFO, "%s", command_line); + system_check (command_line, es, 0, "Solaris ifconfig unplumb failed"); + close_tun (tt); + msg (M_FATAL, "Solaris ifconfig failed"); +} + +int +write_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + struct strbuf sbuf; + sbuf.len = len; + sbuf.buf = (char *)buf; + return putmsg (tt->fd, NULL, &sbuf, 0) >= 0 ? sbuf.len : -1; +} + +int +read_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + struct strbuf sbuf; + int f = 0; + + sbuf.maxlen = len; + sbuf.buf = (char *)buf; + return getmsg (tt->fd, NULL, &sbuf, &f) >= 0 ? sbuf.len : -1; +} + +#elif defined(TARGET_OPENBSD) + +#if !defined(HAVE_READV) || !defined(HAVE_WRITEV) +#error openbsd build requires readv & writev library functions +#endif + +/* + * OpenBSD has a slightly incompatible TUN device from + * the rest of the world, in that it prepends a + * uint32 to the beginning of the IP header + * to designate the protocol (why not just + * look at the version field in the IP header to + * determine v4 or v6?). + * + * We strip off this field on reads and + * put it back on writes. + * + * I have not tested TAP devices on OpenBSD, + * but I have conditionalized the special + * TUN handling code described above to + * go away for TAP devices. + */ + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + open_tun_generic (dev, dev_type, dev_node, ipv6, true, true, tt); + + /* Enable multicast on the interface */ + if (tt->fd >= 0) + { + struct tuninfo info; + + if (ioctl (tt->fd, TUNGIFINFO, &info) < 0) { + msg (M_WARN | M_ERRNO, "Can't get interface info: %s", + strerror(errno)); + } + + info.flags |= IFF_MULTICAST; + + if (ioctl (tt->fd, TUNSIFINFO, &info) < 0) { + msg (M_WARN | M_ERRNO, "Can't set interface info: %s", + strerror(errno)); + } + } +} + +void +close_tun (struct tuntap* tt) +{ + if (tt) + { + close_tun_generic (tt); + free (tt); + } +} + +static inline int +openbsd_modify_read_write_return (int len) +{ + if (len > 0) + return len > sizeof (u_int32_t) ? len - sizeof (u_int32_t) : 0; + else + return len; +} + +int +write_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + if (tt->type == DEV_TYPE_TUN) + { + u_int32_t type; + struct iovec iv[2]; + struct ip *iph; + + iph = (struct ip *) buf; + + if (tt->ipv6 && iph->ip_v == 6) + type = htonl (AF_INET6); + else + type = htonl (AF_INET); + + iv[0].iov_base = &type; + iv[0].iov_len = sizeof (type); + iv[1].iov_base = buf; + iv[1].iov_len = len; + + return openbsd_modify_read_write_return (writev (tt->fd, iv, 2)); + } + else + return write (tt->fd, buf, len); +} + +int +read_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + if (tt->type == DEV_TYPE_TUN) + { + u_int32_t type; + struct iovec iv[2]; + + iv[0].iov_base = &type; + iv[0].iov_len = sizeof (type); + iv[1].iov_base = buf; + iv[1].iov_len = len; + + return openbsd_modify_read_write_return (readv (tt->fd, iv, 2)); + } + else + return read (tt->fd, buf, len); +} + +#elif defined(TARGET_NETBSD) + +/* + * NetBSD does not support IPv6 on tun out of the box, + * but there exists a patch. When this patch is applied, + * only two things are left to openvpn: + * 1. Activate multicasting (this has already been done + * before by the kernel, but we make sure that nobody + * has deactivated multicasting inbetween. + * 2. Deactivate "link layer mode" (otherwise NetBSD + * prepends the address family to the packet, and we + * would run into the same trouble as with OpenBSD. + */ + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + open_tun_generic (dev, dev_type, dev_node, ipv6, true, true, tt); + if (tt->fd >= 0) + { + int i = IFF_POINTOPOINT|IFF_MULTICAST; + ioctl (tt->fd, TUNSIFMODE, &i); /* multicast on */ + i = 0; + ioctl (tt->fd, TUNSLMODE, &i); /* link layer mode off */ + } +} + +void +close_tun (struct tuntap *tt) +{ + if (tt) + { + close_tun_generic (tt); + free (tt); + } +} + +int +write_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + return write (tt->fd, buf, len); +} + +int +read_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + return read (tt->fd, buf, len); +} + +#elif defined(TARGET_FREEBSD) + +static inline int +freebsd_modify_read_write_return (int len) +{ + if (len > 0) + return len > sizeof (u_int32_t) ? len - sizeof (u_int32_t) : 0; + else + return len; +} + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + open_tun_generic (dev, dev_type, dev_node, ipv6, true, true, tt); + + if (tt->fd >= 0) + { + int i = 0; + + /* Disable extended modes */ + ioctl (tt->fd, TUNSLMODE, &i); + i = 1; + ioctl (tt->fd, TUNSIFHEAD, &i); + } +} + +void +close_tun (struct tuntap *tt) +{ + if (tt) + { + close_tun_generic (tt); + free (tt); + } +} + +int +write_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + if (tt->type == DEV_TYPE_TUN) + { + u_int32_t type; + struct iovec iv[2]; + struct ip *iph; + + iph = (struct ip *) buf; + + if (tt->ipv6 && iph->ip_v == 6) + type = htonl (AF_INET6); + else + type = htonl (AF_INET); + + iv[0].iov_base = (char *)&type; + iv[0].iov_len = sizeof (type); + iv[1].iov_base = buf; + iv[1].iov_len = len; + + return freebsd_modify_read_write_return (writev (tt->fd, iv, 2)); + } + else + return write (tt->fd, buf, len); +} + +int +read_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + if (tt->type == DEV_TYPE_TUN) + { + u_int32_t type; + struct iovec iv[2]; + + iv[0].iov_base = (char *)&type; + iv[0].iov_len = sizeof (type); + iv[1].iov_base = buf; + iv[1].iov_len = len; + + return freebsd_modify_read_write_return (readv (tt->fd, iv, 2)); + } + else + return read (tt->fd, buf, len); +} + +#elif defined(WIN32) + +int +tun_read_queue (struct tuntap *tt, int maxsize) +{ + if (tt->reads.iostate == IOSTATE_INITIAL) + { + DWORD len; + BOOL status; + int err; + + /* reset buf to its initial state */ + tt->reads.buf = tt->reads.buf_init; + + len = maxsize ? maxsize : BLEN (&tt->reads.buf); + ASSERT (len <= BLEN (&tt->reads.buf)); + + /* the overlapped read will signal this event on I/O completion */ + ASSERT (ResetEvent (tt->reads.overlapped.hEvent)); + + status = ReadFile( + tt->hand, + BPTR (&tt->reads.buf), + len, + &tt->reads.size, + &tt->reads.overlapped + ); + + if (status) /* operation completed immediately? */ + { + /* since we got an immediate return, we must signal the event object ourselves */ + ASSERT (SetEvent (tt->reads.overlapped.hEvent)); + + tt->reads.iostate = IOSTATE_IMMEDIATE_RETURN; + tt->reads.status = 0; + + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Read immediate return [%d,%d]", + (int) len, + (int) tt->reads.size); + } + else + { + err = GetLastError (); + if (err == ERROR_IO_PENDING) /* operation queued? */ + { + tt->reads.iostate = IOSTATE_QUEUED; + tt->reads.status = err; + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Read queued [%d]", + (int) len); + } + else /* error occurred */ + { + struct gc_arena gc = gc_new (); + ASSERT (SetEvent (tt->reads.overlapped.hEvent)); + tt->reads.iostate = IOSTATE_IMMEDIATE_RETURN; + tt->reads.status = err; + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Read error [%d] : %s", + (int) len, + strerror_win32 (status, &gc)); + gc_free (&gc); + } + } + } + return tt->reads.iostate; +} + +int +tun_write_queue (struct tuntap *tt, struct buffer *buf) +{ + if (tt->writes.iostate == IOSTATE_INITIAL) + { + BOOL status; + int err; + + /* make a private copy of buf */ + tt->writes.buf = tt->writes.buf_init; + tt->writes.buf.len = 0; + ASSERT (buf_copy (&tt->writes.buf, buf)); + + /* the overlapped write will signal this event on I/O completion */ + ASSERT (ResetEvent (tt->writes.overlapped.hEvent)); + + status = WriteFile( + tt->hand, + BPTR (&tt->writes.buf), + BLEN (&tt->writes.buf), + &tt->writes.size, + &tt->writes.overlapped + ); + + if (status) /* operation completed immediately? */ + { + tt->writes.iostate = IOSTATE_IMMEDIATE_RETURN; + + /* since we got an immediate return, we must signal the event object ourselves */ + ASSERT (SetEvent (tt->writes.overlapped.hEvent)); + + tt->writes.status = 0; + + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Write immediate return [%d,%d]", + BLEN (&tt->writes.buf), + (int) tt->writes.size); + } + else + { + err = GetLastError (); + if (err == ERROR_IO_PENDING) /* operation queued? */ + { + tt->writes.iostate = IOSTATE_QUEUED; + tt->writes.status = err; + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Write queued [%d]", + BLEN (&tt->writes.buf)); + } + else /* error occurred */ + { + struct gc_arena gc = gc_new (); + ASSERT (SetEvent (tt->writes.overlapped.hEvent)); + tt->writes.iostate = IOSTATE_IMMEDIATE_RETURN; + tt->writes.status = err; + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Write error [%d] : %s", + BLEN (&tt->writes.buf), + strerror_win32 (err, &gc)); + gc_free (&gc); + } + } + } + return tt->writes.iostate; +} + +int +tun_finalize ( + HANDLE h, + struct overlapped_io *io, + struct buffer *buf) +{ + int ret = -1; + BOOL status; + + switch (io->iostate) + { + case IOSTATE_QUEUED: + status = GetOverlappedResult( + h, + &io->overlapped, + &io->size, + FALSE + ); + if (status) + { + /* successful return for a queued operation */ + if (buf) + *buf = io->buf; + ret = io->size; + io->iostate = IOSTATE_INITIAL; + ASSERT (ResetEvent (io->overlapped.hEvent)); + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Completion success [%d]", ret); + } + else + { + /* error during a queued operation */ + ret = -1; + if (GetLastError() != ERROR_IO_INCOMPLETE) + { + /* if no error (i.e. just not finished yet), + then DON'T execute this code */ + io->iostate = IOSTATE_INITIAL; + ASSERT (ResetEvent (io->overlapped.hEvent)); + msg (D_WIN32_IO | M_ERRNO, "WIN32 I/O: TAP Completion error"); + } + } + break; + + case IOSTATE_IMMEDIATE_RETURN: + io->iostate = IOSTATE_INITIAL; + ASSERT (ResetEvent (io->overlapped.hEvent)); + if (io->status) + { + /* error return for a non-queued operation */ + SetLastError (io->status); + ret = -1; + msg (D_WIN32_IO | M_ERRNO, "WIN32 I/O: TAP Completion non-queued error"); + } + else + { + /* successful return for a non-queued operation */ + if (buf) + *buf = io->buf; + ret = io->size; + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Completion non-queued success [%d]", ret); + } + break; + + case IOSTATE_INITIAL: /* were we called without proper queueing? */ + SetLastError (ERROR_INVALID_FUNCTION); + ret = -1; + dmsg (D_WIN32_IO, "WIN32 I/O: TAP Completion BAD STATE"); + break; + + default: + ASSERT (0); + } + + if (buf) + buf->len = ret; + return ret; +} + +const struct tap_reg * +get_tap_reg (struct gc_arena *gc) +{ + HKEY adapter_key; + LONG status; + DWORD len; + struct tap_reg *first = NULL; + struct tap_reg *last = NULL; + int i = 0; + + status = RegOpenKeyEx( + HKEY_LOCAL_MACHINE, + ADAPTER_KEY, + 0, + KEY_READ, + &adapter_key); + + if (status != ERROR_SUCCESS) + msg (M_FATAL, "Error opening registry key: %s", ADAPTER_KEY); + + while (true) + { + char enum_name[256]; + char unit_string[256]; + HKEY unit_key; + char component_id_string[] = "ComponentId"; + char component_id[256]; + char net_cfg_instance_id_string[] = "NetCfgInstanceId"; + char net_cfg_instance_id[256]; + DWORD data_type; + + len = sizeof (enum_name); + status = RegEnumKeyEx( + adapter_key, + i, + enum_name, + &len, + NULL, + NULL, + NULL, + NULL); + if (status == ERROR_NO_MORE_ITEMS) + break; + else if (status != ERROR_SUCCESS) + msg (M_FATAL, "Error enumerating registry subkeys of key: %s", + ADAPTER_KEY); + + openvpn_snprintf (unit_string, sizeof(unit_string), "%s\\%s", + ADAPTER_KEY, enum_name); + + status = RegOpenKeyEx( + HKEY_LOCAL_MACHINE, + unit_string, + 0, + KEY_READ, + &unit_key); + + if (status != ERROR_SUCCESS) + dmsg (D_REGISTRY, "Error opening registry key: %s", unit_string); + else + { + len = sizeof (component_id); + status = RegQueryValueEx( + unit_key, + component_id_string, + NULL, + &data_type, + component_id, + &len); + + if (status != ERROR_SUCCESS || data_type != REG_SZ) + dmsg (D_REGISTRY, "Error opening registry key: %s\\%s", + unit_string, component_id_string); + else + { + len = sizeof (net_cfg_instance_id); + status = RegQueryValueEx( + unit_key, + net_cfg_instance_id_string, + NULL, + &data_type, + net_cfg_instance_id, + &len); + + if (status == ERROR_SUCCESS && data_type == REG_SZ) + { + if (!strcmp (component_id, TAP_COMPONENT_ID)) + { + struct tap_reg *reg; + ALLOC_OBJ_CLEAR_GC (reg, struct tap_reg, gc); + reg->guid = string_alloc (net_cfg_instance_id, gc); + + /* link into return list */ + if (!first) + first = reg; + if (last) + last->next = reg; + last = reg; + } + } + } + RegCloseKey (unit_key); + } + ++i; + } + + RegCloseKey (adapter_key); + return first; +} + +const struct panel_reg * +get_panel_reg (struct gc_arena *gc) +{ + LONG status; + HKEY network_connections_key; + DWORD len; + struct panel_reg *first = NULL; + struct panel_reg *last = NULL; + int i = 0; + + status = RegOpenKeyEx( + HKEY_LOCAL_MACHINE, + NETWORK_CONNECTIONS_KEY, + 0, + KEY_READ, + &network_connections_key); + + if (status != ERROR_SUCCESS) + msg (M_FATAL, "Error opening registry key: %s", NETWORK_CONNECTIONS_KEY); + + while (true) + { + char enum_name[256]; + char connection_string[256]; + HKEY connection_key; + char name_data[256]; + DWORD name_type; + const char name_string[] = "Name"; + + len = sizeof (enum_name); + status = RegEnumKeyEx( + network_connections_key, + i, + enum_name, + &len, + NULL, + NULL, + NULL, + NULL); + if (status == ERROR_NO_MORE_ITEMS) + break; + else if (status != ERROR_SUCCESS) + msg (M_FATAL, "Error enumerating registry subkeys of key: %s", + NETWORK_CONNECTIONS_KEY); + + openvpn_snprintf (connection_string, sizeof(connection_string), + "%s\\%s\\Connection", + NETWORK_CONNECTIONS_KEY, enum_name); + + status = RegOpenKeyEx( + HKEY_LOCAL_MACHINE, + connection_string, + 0, + KEY_READ, + &connection_key); + + if (status != ERROR_SUCCESS) + dmsg (D_REGISTRY, "Error opening registry key: %s", connection_string); + else + { + len = sizeof (name_data); + status = RegQueryValueEx( + connection_key, + name_string, + NULL, + &name_type, + name_data, + &len); + + if (status != ERROR_SUCCESS || name_type != REG_SZ) + dmsg (D_REGISTRY, "Error opening registry key: %s\\%s\\%s", + NETWORK_CONNECTIONS_KEY, connection_string, name_string); + else + { + struct panel_reg *reg; + + ALLOC_OBJ_CLEAR_GC (reg, struct panel_reg, gc); + reg->name = string_alloc (name_data, gc); + reg->guid = string_alloc (enum_name, gc); + + /* link into return list */ + if (!first) + first = reg; + if (last) + last->next = reg; + last = reg; + } + RegCloseKey (connection_key); + } + ++i; + } + + RegCloseKey (network_connections_key); + + return first; +} + +/* + * Check that two addresses are part of the same 255.255.255.252 subnet. + */ +void +verify_255_255_255_252 (in_addr_t local, in_addr_t remote) +{ + struct gc_arena gc = gc_new (); + const unsigned int mask = 3; + const char *err = NULL; + + if (local == remote) + { + err = "must be different"; + goto error; + } + if ((local & (~mask)) != (remote & (~mask))) + { + err = "must exist within the same 255.255.255.252 subnet. This is a limitation of --dev tun when used with the TAP-WIN32 driver"; + goto error; + } + if ((local & mask) == 0 + || (local & mask) == 3 + || (remote & mask) == 0 + || (remote & mask) == 3) + { + err = "cannot use the first or last address within a given 255.255.255.252 subnet. This is a limitation of --dev tun when used with the TAP-WIN32 driver"; + goto error; + } + + gc_free (&gc); + return; + + error: + msg (M_FATAL, "There is a problem in your selection of --ifconfig endpoints [local=%s, remote=%s]. The local and remote VPN endpoints %s. Try '" PACKAGE " --show-valid-subnets' option for more info.", + print_in_addr_t (local, 0, &gc), + print_in_addr_t (remote, 0, &gc), + err); + gc_free (&gc); +} + +void show_valid_win32_tun_subnets (void) +{ + int i; + int col = 0; + + printf ("On Windows, point-to-point IP support (i.e. --dev tun)\n"); + printf ("is emulated by the TAP-Win32 driver. The major limitation\n"); + printf ("imposed by this approach is that the --ifconfig local and\n"); + printf ("remote endpoints must be part of the same 255.255.255.252\n"); + printf ("subnet. The following list shows examples of endpoint\n"); + printf ("pairs which satisfy this requirement. Only the final\n"); + printf ("component of the IP address pairs is at issue.\n\n"); + printf ("As an example, the following option would be correct:\n"); + printf (" --ifconfig 10.7.0.5 10.7.0.6 (on host A)\n"); + printf (" --ifconfig 10.7.0.6 10.7.0.5 (on host B)\n"); + printf ("because [5,6] is part of the below list.\n\n"); + + for (i = 0; i < 256; i += 4) + { + printf("[%3d,%3d] ", i+1, i+2); + if (++col > 4) + { + col = 0; + printf ("\n"); + } + } + if (col) + printf ("\n"); +} + +void +show_tap_win32_adapters (int msglev, int warnlev) +{ + struct gc_arena gc = gc_new (); + + bool warn_panel_null = false; + bool warn_panel_dup = false; + bool warn_tap_dup = false; + + int links; + + const struct tap_reg *tr; + const struct tap_reg *tr1; + const struct panel_reg *pr; + + const struct tap_reg *tap_reg = get_tap_reg (&gc); + const struct panel_reg *panel_reg = get_panel_reg (&gc); + + msg (msglev, "Available TAP-WIN32 adapters [name, GUID]:"); + + /* loop through each TAP-Win32 adapter registry entry */ + for (tr = tap_reg; tr != NULL; tr = tr->next) + { + links = 0; + + /* loop through each network connections entry in the control panel */ + for (pr = panel_reg; pr != NULL; pr = pr->next) + { + if (!strcmp (tr->guid, pr->guid)) + { + msg (msglev, "'%s' %s", pr->name, tr->guid); + ++links; + } + } + + if (links > 1) + { + warn_panel_dup = true; + } + else if (links == 0) + { + /* a TAP adapter exists without a link from the network + connections control panel */ + warn_panel_null = true; + msg (msglev, "[NULL] %s", tr->guid); + } + } + + /* check for TAP-Win32 adapter duplicated GUIDs */ + for (tr = tap_reg; tr != NULL; tr = tr->next) + { + for (tr1 = tap_reg; tr1 != NULL; tr1 = tr1->next) + { + if (tr != tr1 && !strcmp (tr->guid, tr1->guid)) + warn_tap_dup = true; + } + } + + /* warn on registry inconsistencies */ + if (warn_tap_dup) + msg (warnlev, "WARNING: Some TAP-Win32 adapters have duplicate GUIDs"); + + if (warn_panel_dup) + msg (warnlev, "WARNING: Some TAP-Win32 adapters have duplicate links from the Network Connections control panel"); + + if (warn_panel_null) + msg (warnlev, "WARNING: Some TAP-Win32 adapters have no link from the Network Connections control panel"); + + gc_free (&gc); +} + +/* + * Confirm that GUID is a TAP-Win32 adapter. + */ +static bool +is_tap_win32 (const char *guid, const struct tap_reg *tap_reg) +{ + const struct tap_reg *tr; + + for (tr = tap_reg; tr != NULL; tr = tr->next) + { + if (guid && !strcmp (tr->guid, guid)) + return true; + } + + return false; +} + +static const char * +guid_to_name (const char *guid, const struct panel_reg *panel_reg) +{ + const struct panel_reg *pr; + + for (pr = panel_reg; pr != NULL; pr = pr->next) + { + if (guid && !strcmp (pr->guid, guid)) + return pr->name; + } + + return NULL; +} + +static const char * +name_to_guid (const char *name, const struct tap_reg *tap_reg, const struct panel_reg *panel_reg) +{ + const struct panel_reg *pr; + + for (pr = panel_reg; pr != NULL; pr = pr->next) + { + if (name && !strcmp (pr->name, name) && is_tap_win32 (pr->guid, tap_reg)) + return pr->guid; + } + + return NULL; +} + +static void +at_least_one_tap_win32 (const struct tap_reg *tap_reg) +{ + if (!tap_reg) + msg (M_FATAL, "There are no TAP-Win32 adapters on this system. You should be able to create a TAP-Win32 adapter by going to Start -> All Programs -> " PACKAGE_NAME " -> Add a new TAP-Win32 virtual ethernet adapter."); +} + +/* + * Get an adapter GUID and optional actual_name from the + * registry for the TAP device # = device_number. + */ +static const char * +get_unspecified_device_guid (const int device_number, + char *actual_name, + int actual_name_size, + const struct tap_reg *tap_reg_src, + const struct panel_reg *panel_reg_src, + struct gc_arena *gc) +{ + const struct tap_reg *tap_reg = tap_reg_src; + struct buffer ret = clear_buf (); + struct buffer actual = clear_buf (); + int i; + + ASSERT (device_number >= 0); + + /* Make sure we have at least one TAP adapter */ + if (!tap_reg) + return NULL; + + /* The actual_name output buffer may be NULL */ + if (actual_name) + { + ASSERT (actual_name_size > 0); + buf_set_write (&actual, actual_name, actual_name_size); + } + + /* Move on to specified device number */ + for (i = 0; i < device_number; i++) + { + tap_reg = tap_reg->next; + if (!tap_reg) + return NULL; + } + + /* Save Network Panel name (if exists) in actual_name */ + if (actual_name) + { + const char *act = guid_to_name (tap_reg->guid, panel_reg_src); + if (act) + buf_printf (&actual, "%s", act); + else + buf_printf (&actual, "NULL"); + } + + /* Save GUID for return value */ + ret = alloc_buf_gc (256, gc); + buf_printf (&ret, "%s", tap_reg->guid); + return BSTR (&ret); +} + +/* + * Lookup a --dev-node adapter name in the registry + * returning the GUID and optional actual_name. + */ +static const char * +get_device_guid (const char *name, + char *actual_name, + int actual_name_size, + const struct tap_reg *tap_reg, + const struct panel_reg *panel_reg, + struct gc_arena *gc) +{ + struct buffer ret = alloc_buf_gc (256, gc); + struct buffer actual = clear_buf (); + + /* Make sure we have at least one TAP adapter */ + if (!tap_reg) + return NULL; + + /* The actual_name output buffer may be NULL */ + if (actual_name) + { + ASSERT (actual_name_size > 0); + buf_set_write (&actual, actual_name, actual_name_size); + } + + /* Check if GUID was explicitly specified as --dev-node parameter */ + if (is_tap_win32 (name, tap_reg)) + { + const char *act = guid_to_name (name, panel_reg); + buf_printf (&ret, "%s", name); + if (act) + buf_printf (&actual, "%s", act); + else + buf_printf (&actual, "NULL"); + return BSTR (&ret); + } + + /* Lookup TAP adapter in network connections list */ + { + const char *guid = name_to_guid (name, tap_reg, panel_reg); + if (guid) + { + buf_printf (&actual, "%s", name); + buf_printf (&ret, "%s", guid); + return BSTR (&ret); + } + } + + return NULL; +} + +/* + * Return a TAP name for netsh commands. + */ +const char * +get_netsh_id (const char *dev_node, struct gc_arena *gc) +{ + const struct tap_reg *tap_reg = get_tap_reg (gc); + const struct panel_reg *panel_reg = get_panel_reg (gc); + struct buffer actual = alloc_buf_gc (256, gc); + const char *guid; + + at_least_one_tap_win32 (tap_reg); + + if (dev_node) + { + guid = get_device_guid (dev_node, BPTR (&actual), BCAP (&actual), tap_reg, panel_reg, gc); + } + else + { + guid = get_unspecified_device_guid (0, BPTR (&actual), BCAP (&actual), tap_reg, panel_reg, gc); + + if (get_unspecified_device_guid (1, NULL, 0, tap_reg, panel_reg, gc)) /* ambiguous if more than one TAP-Win32 adapter */ + guid = NULL; + } + + if (!guid) + return "NULL"; /* not found */ + else if (strcmp (BPTR (&actual), "NULL")) + return BPTR (&actual); /* control panel name */ + else + return guid; /* no control panel name, return GUID instead */ +} + +/* + * Get adapter info list + */ +const IP_ADAPTER_INFO * +get_adapter_info_list (struct gc_arena *gc) +{ + ULONG size = 0; + IP_ADAPTER_INFO *pi = NULL; + DWORD status; + + if ((status = GetAdaptersInfo (NULL, &size)) != ERROR_BUFFER_OVERFLOW) + { + msg (M_INFO, "GetAdaptersInfo #1 failed (status=%u) : %s", + (unsigned int)status, + strerror_win32 (status, gc)); + } + else + { + pi = (PIP_ADAPTER_INFO) gc_malloc (size, false, gc); + if ((status = GetAdaptersInfo (pi, &size)) == NO_ERROR) + return pi; + else + { + msg (M_INFO, "GetAdaptersInfo #2 failed (status=%u) : %s", + (unsigned int)status, + strerror_win32 (status, gc)); + } + } + return pi; +} + +static const IP_INTERFACE_INFO * +get_interface_info_list (struct gc_arena *gc) +{ + ULONG size = 0; + IP_INTERFACE_INFO *ii = NULL; + DWORD status; + + if ((status = GetInterfaceInfo (NULL, &size)) != ERROR_INSUFFICIENT_BUFFER) + { + msg (M_INFO, "GetInterfaceInfo #1 failed (status=%u) : %s", + (unsigned int)status, + strerror_win32 (status, gc)); + } + else + { + ii = (PIP_INTERFACE_INFO) gc_malloc (size, false, gc); + if ((status = GetInterfaceInfo (ii, &size)) == NO_ERROR) + return ii; + else + { + msg (M_INFO, "GetInterfaceInfo #2 failed (status=%u) : %s", + (unsigned int)status, + strerror_win32 (status, gc)); + } + } + return ii; +} + +static const IP_ADAPTER_INDEX_MAP * +get_interface_info (DWORD index, struct gc_arena *gc) +{ + const IP_INTERFACE_INFO *list = get_interface_info_list (gc); + if (list) + { + int i; + for (i = 0; i < list->NumAdapters; ++i) + { + const IP_ADAPTER_INDEX_MAP *inter = &list->Adapter[i]; + if (index == inter->Index) + return inter; + } + } + return NULL; +} + +/* + * Given an adapter index, return a pointer to the + * IP_ADAPTER_INFO structure for that adapter. + */ + +static const IP_ADAPTER_INFO * +get_adapter (const IP_ADAPTER_INFO *ai, DWORD index) +{ + if (ai && index != (DWORD)~0) + { + const IP_ADAPTER_INFO *a; + + /* find index in the linked list */ + for (a = ai; a != NULL; a = a->Next) + { + if (a->Index == index) + return a; + } + } + return NULL; +} + +static const IP_ADAPTER_INFO * +get_adapter_info (DWORD index, struct gc_arena *gc) +{ + return get_adapter (get_adapter_info_list (gc), index); +} + +static int +get_adapter_n_ip_netmask (const IP_ADAPTER_INFO *ai) +{ + if (ai) + { + int n = 0; + const IP_ADDR_STRING *ip = &ai->IpAddressList; + + while (ip) + { + ++n; + ip = ip->Next; + } + return n; + } + else + return 0; +} + +static bool +get_adapter_ip_netmask (const IP_ADAPTER_INFO *ai, const int n, in_addr_t *ip, in_addr_t *netmask) +{ + bool ret = false; + *ip = 0; + *netmask = 0; + + if (ai) + { + const IP_ADDR_STRING *iplist = &ai->IpAddressList; + int i = 0; + + while (iplist) + { + if (i == n) + break; + ++i; + iplist = iplist->Next; + } + + if (iplist) + { + const unsigned int getaddr_flags = GETADDR_HOST_ORDER; + const char *ip_str = iplist->IpAddress.String; + const char *netmask_str = iplist->IpMask.String; + bool succeed1 = false; + bool succeed2 = false; + + if (ip_str && netmask_str && strlen (ip_str) && strlen (netmask_str)) + { + *ip = getaddr (getaddr_flags, ip_str, 0, &succeed1, NULL); + *netmask = getaddr (getaddr_flags, netmask_str, 0, &succeed2, NULL); + ret = (succeed1 == true && succeed2 == true); + } + } + } + + return ret; +} + +const IP_ADAPTER_INFO * +get_tun_adapter (const struct tuntap *tt, const IP_ADAPTER_INFO *list) +{ + if (list && tt) + return get_adapter (list, tt->adapter_index); + else + return NULL; +} + +bool +is_adapter_up (const struct tuntap *tt, const IP_ADAPTER_INFO *list) +{ + int i; + bool ret = false; + + const IP_ADAPTER_INFO *ai = get_tun_adapter (tt, list); + + if (ai) + { + const int n = get_adapter_n_ip_netmask (ai); + + /* loop once for every IP/netmask assigned to adapter */ + for (i = 0; i < n; ++i) + { + in_addr_t ip, netmask; + if (get_adapter_ip_netmask (ai, i, &ip, &netmask)) + { + if (tt->local && tt->adapter_netmask) + { + /* wait for our --ifconfig parms to match the actual adapter parms */ + if (tt->local == ip && tt->adapter_netmask == netmask) + ret = true; + } + else + { + /* --ifconfig was not defined, maybe using a real DHCP server */ + if (ip && netmask) + ret = true; + } + } + } + } + else + ret = true; /* this can occur when TAP adapter is bridged */ + + return ret; +} + +bool +is_ip_in_adapter_subnet (const IP_ADAPTER_INFO *ai, const in_addr_t ip, in_addr_t *highest_netmask) +{ + int i; + bool ret = false; + + if (highest_netmask) + *highest_netmask = 0; + + if (ai) + { + const int n = get_adapter_n_ip_netmask (ai); + for (i = 0; i < n; ++i) + { + in_addr_t adapter_ip, adapter_netmask; + if (get_adapter_ip_netmask (ai, i, &adapter_ip, &adapter_netmask)) + { + if (adapter_ip && adapter_netmask && (ip & adapter_netmask) == (adapter_ip & adapter_netmask)) + { + if (highest_netmask && adapter_netmask > *highest_netmask) + *highest_netmask = adapter_netmask; + ret = true; + } + } + } + } + return ret; +} + +DWORD +adapter_index_of_ip (const IP_ADAPTER_INFO *list, const in_addr_t ip, int *count) +{ + struct gc_arena gc = gc_new (); + DWORD ret = ~0; + in_addr_t highest_netmask = 0; + bool first = true; + + if (count) + *count = 0; + + while (list) + { + in_addr_t hn; + + if (is_ip_in_adapter_subnet (list, ip, &hn)) + { + if (first || hn > highest_netmask) + { + highest_netmask = hn; + if (count) + *count = 1; + ret = list->Index; + first = false; + } + else if (hn == highest_netmask) + { + if (count) + ++*count; + } + } + list = list->Next; + } + + dmsg (D_ROUTE_DEBUG, "DEBUG: IP Locate: ip=%s nm=%s index=%d count=%d", + print_in_addr_t (ip, 0, &gc), + print_in_addr_t (highest_netmask, 0, &gc), + (int)ret, + count ? *count : -1); + + if (ret == ~0 && count) + *count = 0; + + gc_free (&gc); + return ret; +} + +/* + * Given an adapter index, return true if the adapter + * is DHCP disabled. + */ +static bool +dhcp_disabled (DWORD index) +{ + struct gc_arena gc = gc_new (); + const IP_ADAPTER_INFO *ai = get_adapter_info (index, &gc); + bool ret = false; + + if (ai && !ai->DhcpEnabled) + ret = true; + + gc_free (&gc); + return ret; +} + +/* + * Delete all temporary address/netmask pairs which were added + * to adapter (given by index) by previous calls to AddIPAddress. + */ +static void +delete_temp_addresses (DWORD index) +{ + struct gc_arena gc = gc_new (); + const IP_ADAPTER_INFO *a = get_adapter_info (index, &gc); + + if (a) + { + const IP_ADDR_STRING *ip = &a->IpAddressList; + while (ip) + { + DWORD status; + const DWORD context = ip->Context; + + if ((status = DeleteIPAddress ((ULONG) context)) == NO_ERROR) + { + msg (M_INFO, "Successfully deleted previously set dynamic IP/netmask: %s/%s", + ip->IpAddress.String, + ip->IpMask.String); + } + else + { + const char *empty = "0.0.0.0"; + if (strcmp (ip->IpAddress.String, empty) + || strcmp (ip->IpMask.String, empty)) + msg (M_INFO, "NOTE: could not delete previously set dynamic IP/netmask: %s/%s (status=%u)", + ip->IpAddress.String, + ip->IpMask.String, + (unsigned int)status); + } + ip = ip->Next; + } + } + gc_free (&gc); +} + +/* + * Get interface index for use with IP Helper API functions. + */ +static DWORD +get_interface_index (const char *guid) +{ + struct gc_arena gc = gc_new (); + ULONG index; + DWORD status; + wchar_t wbuf[256]; + snwprintf (wbuf, SIZE (wbuf), L"\\DEVICE\\TCPIP_%S", guid); + wbuf [SIZE(wbuf) - 1] = 0; + if ((status = GetAdapterIndex (wbuf, &index)) != NO_ERROR) + { + msg (M_INFO, "NOTE: could not get adapter index for %S, status=%u : %s", + wbuf, + (unsigned int)status, + strerror_win32 (status, &gc)); + gc_free (&gc); + return (DWORD)~0; + } + else + { + gc_free (&gc); + return index; + } +} + +/* + * Return a string representing a PIP_ADDR_STRING + */ +static const char * +format_ip_addr_string (const IP_ADDR_STRING *ip, struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + while (ip) + { + buf_printf (&out, "%s", ip->IpAddress.String); + if (strlen (ip->IpMask.String)) + { + buf_printf (&out, "/"); + buf_printf (&out, "%s", ip->IpMask.String); + } + buf_printf (&out, " "); + ip = ip->Next; + } + return BSTR (&out); +} + +/* + * Show info for a single adapter + */ +static void +show_adapter (int msglev, const IP_ADAPTER_INFO *a, struct gc_arena *gc) +{ + msg (msglev, "%s", a->Description); + msg (msglev, " Index = %d", (int)a->Index); + msg (msglev, " GUID = %s", a->AdapterName); + msg (msglev, " IP = %s", format_ip_addr_string (&a->IpAddressList, gc)); + msg (msglev, " MAC = %s", format_hex_ex (a->Address, a->AddressLength, 0, 1, ":", gc)); + msg (msglev, " GATEWAY = %s", format_ip_addr_string (&a->GatewayList, gc)); + if (a->DhcpEnabled) + { + msg (msglev, " DHCP SERV = %s", format_ip_addr_string (&a->DhcpServer, gc)); + msg (msglev, " DHCP LEASE OBTAINED = %s", time_string (a->LeaseObtained, 0, false, gc)); + msg (msglev, " DHCP LEASE EXPIRES = %s", time_string (a->LeaseExpires, 0, false, gc)); + } + if (a->HaveWins) + { + msg (msglev, " PRI WINS = %s", format_ip_addr_string (&a->PrimaryWinsServer, gc)); + msg (msglev, " SEC WINS = %s", format_ip_addr_string (&a->SecondaryWinsServer, gc)); + } +} + +/* + * Show current adapter list + */ +void +show_adapters (int msglev) +{ + struct gc_arena gc = gc_new (); + const IP_ADAPTER_INFO *ai = get_adapter_info_list (&gc); + + msg (msglev, "SYSTEM ADAPTER LIST"); + if (ai) + { + const IP_ADAPTER_INFO *a; + + /* find index in the linked list */ + for (a = ai; a != NULL; a = a->Next) + { + show_adapter (msglev, a, &gc); + } + } + gc_free (&gc); +} + +/* + * DHCP release/renewal + */ + +bool +dhcp_release (const struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + if (tt && tt->options.ip_win32_type == IPW32_SET_DHCP_MASQ && tt->adapter_index != ~0) + { + const IP_ADAPTER_INDEX_MAP *inter = get_interface_info (tt->adapter_index, &gc); + if (inter) + { + DWORD status = IpReleaseAddress ((IP_ADAPTER_INDEX_MAP *)inter); + if (status == NO_ERROR) + { + msg (D_TUNTAP_INFO, "TAP: DHCP address released"); + ret = true; + } + else + msg (M_WARN, "NOTE: Release of DHCP-assigned IP address lease on TAP-Win32 adapter failed: %s (code=%u)", + strerror_win32 (status, &gc), + (unsigned int)status); + } + } + gc_free (&gc); + return ret; +} + +bool +dhcp_renew (const struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + bool ret = false; + if (tt && tt->options.ip_win32_type == IPW32_SET_DHCP_MASQ && tt->adapter_index != ~0) + { + const IP_ADAPTER_INDEX_MAP *inter = get_interface_info (tt->adapter_index, &gc); + if (inter) + { + DWORD status = IpRenewAddress ((IP_ADAPTER_INDEX_MAP *)inter); + if (status == NO_ERROR) + { + msg (D_TUNTAP_INFO, "TAP: DHCP address renewal succeeded"); + ret = true; + } + else + msg (M_WARN, "WARNING: Failed to renew DHCP IP address lease on TAP-Win32 adapter: %s (code=%u)", + strerror_win32 (status, &gc), + (unsigned int)status); + } + } + gc_free (&gc); + return ret; +} + +/* + * Convert DHCP options from the command line / config file + * into a raw DHCP-format options string. + */ + +static void +write_dhcp_u8 (struct buffer *buf, const int type, const int data) +{ + if (!buf_safe (buf, 3)) + msg (M_FATAL, "write_dhcp_u8: buffer overflow building DHCP options"); + buf_write_u8 (buf, type); + buf_write_u8 (buf, 1); + buf_write_u8 (buf, data); +} + +static void +write_dhcp_u32_array (struct buffer *buf, const int type, const uint32_t *data, const unsigned int len) +{ + if (len > 0) + { + int i; + const int size = len * sizeof (uint32_t); + + if (!buf_safe (buf, 2 + size)) + msg (M_FATAL, "write_dhcp_u32_array: buffer overflow building DHCP options"); + if (size < 1 || size > 255) + msg (M_FATAL, "write_dhcp_u32_array: size (%d) must be > 0 and <= 255", size); + buf_write_u8 (buf, type); + buf_write_u8 (buf, size); + for (i = 0; i < len; ++i) + buf_write_u32 (buf, data[i]); + } +} + +static void +write_dhcp_str (struct buffer *buf, const int type, const char *str) +{ + const int len = strlen (str); + if (!buf_safe (buf, 2 + len)) + msg (M_FATAL, "write_dhcp_str: buffer overflow building DHCP options"); + if (len < 1 || len > 255) + msg (M_FATAL, "write_dhcp_str: string '%s' must be > 0 bytes and <= 255 bytes", str); + buf_write_u8 (buf, type); + buf_write_u8 (buf, len); + buf_write (buf, str, len); +} + +static void +build_dhcp_options_string (struct buffer *buf, const struct tuntap_options *o) +{ + if (o->domain) + write_dhcp_str (buf, 15, o->domain); + + if (o->netbios_scope) + write_dhcp_str (buf, 47, o->netbios_scope); + + if (o->netbios_node_type) + write_dhcp_u8 (buf, 46, o->netbios_node_type); + + write_dhcp_u32_array (buf, 6, (uint32_t*)o->dns, o->dns_len); + write_dhcp_u32_array (buf, 44, (uint32_t*)o->wins, o->wins_len); + write_dhcp_u32_array (buf, 42, (uint32_t*)o->ntp, o->ntp_len); + write_dhcp_u32_array (buf, 45, (uint32_t*)o->nbdd, o->nbdd_len); + + /* the MS DHCP server option 'Disable Netbios-over-TCP/IP + is implemented as vendor option 001, value 002. + A value of 001 means 'leave NBT alone' which is the default */ + if (o->disable_nbt) + { + buf_write_u8 (buf, 43); + buf_write_u8 (buf, 6); /* total length field */ + buf_write_u8 (buf, 0x001); + buf_write_u8 (buf, 4); /* length of the vendor specified field */ + buf_write_u32 (buf, 0x002); + } +} + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + char device_path[256]; + const char *device_guid = NULL; + DWORD len; + + /*netcmd_semaphore_lock ();*/ + + ipv6_support (ipv6, false, tt); + + if (tt->type == DEV_TYPE_NULL) + { + open_null (tt); + gc_free (&gc); + return; + } + else if (tt->type == DEV_TYPE_TAP || tt->type == DEV_TYPE_TUN) + { + ; + } + else + { + msg (M_FATAL|M_NOPREFIX, "Unknown virtual device type: '%s'", dev); + } + + /* + * Lookup the device name in the registry, using the --dev-node high level name. + */ + { + const struct tap_reg *tap_reg = get_tap_reg (&gc); + const struct panel_reg *panel_reg = get_panel_reg (&gc); + char guid_buffer[256]; + + at_least_one_tap_win32 (tap_reg); + + if (dev_node) + { + /* Get the device GUID for the device specified with --dev-node. */ + device_guid = get_device_guid (dev_node, guid_buffer, sizeof (guid_buffer), tap_reg, panel_reg, &gc); + + if (!device_guid) + msg (M_FATAL, "TAP-Win32 adapter '%s' not found", dev_node); + + /* Open Windows TAP-Win32 adapter */ + openvpn_snprintf (device_path, sizeof(device_path), "%s%s%s", + USERMODEDEVICEDIR, + device_guid, + TAPSUFFIX); + + tt->hand = CreateFile ( + device_path, + GENERIC_READ | GENERIC_WRITE, + 0, /* was: FILE_SHARE_READ */ + 0, + OPEN_EXISTING, + FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, + 0 + ); + + if (tt->hand == INVALID_HANDLE_VALUE) + msg (M_ERR, "CreateFile failed on TAP device: %s", device_path); + } + else + { + int device_number = 0; + + /* Try opening all TAP devices until we find one available */ + while (true) + { + device_guid = get_unspecified_device_guid (device_number, + guid_buffer, + sizeof (guid_buffer), + tap_reg, + panel_reg, + &gc); + + if (!device_guid) + msg (M_FATAL, "All TAP-Win32 adapters on this system are currently in use."); + + /* Open Windows TAP-Win32 adapter */ + openvpn_snprintf (device_path, sizeof(device_path), "%s%s%s", + USERMODEDEVICEDIR, + device_guid, + TAPSUFFIX); + + tt->hand = CreateFile ( + device_path, + GENERIC_READ | GENERIC_WRITE, + 0, /* was: FILE_SHARE_READ */ + 0, + OPEN_EXISTING, + FILE_ATTRIBUTE_SYSTEM | FILE_FLAG_OVERLAPPED, + 0 + ); + + if (tt->hand == INVALID_HANDLE_VALUE) + msg (D_TUNTAP_INFO, "CreateFile failed on TAP device: %s", device_path); + else + break; + + device_number++; + } + } + + /* translate high-level device name into a device instance + GUID using the registry */ + tt->actual_name = string_alloc (guid_buffer, NULL); + } + + msg (M_INFO, "TAP-WIN32 device [%s] opened: %s", tt->actual_name, device_path); + + /* get driver version info */ + { + ULONG info[3]; + CLEAR (info); + if (DeviceIoControl (tt->hand, TAP_IOCTL_GET_VERSION, + &info, sizeof (info), + &info, sizeof (info), &len, NULL)) + { + msg (D_TUNTAP_INFO, "TAP-Win32 Driver Version %d.%d %s", + (int) info[0], + (int) info[1], + (info[2] ? "(DEBUG)" : "")); + + } + if ( !(info[0] > TAP_WIN32_MIN_MAJOR + || (info[0] == TAP_WIN32_MIN_MAJOR && info[1] >= TAP_WIN32_MIN_MINOR)) ) + msg (M_FATAL, "ERROR: This version of " PACKAGE_NAME " requires a TAP-Win32 driver that is at least version %d.%d -- If you recently upgraded your " PACKAGE_NAME " distribution, a reboot is probably required at this point to get Windows to see the new driver.", + TAP_WIN32_MIN_MAJOR, + TAP_WIN32_MIN_MINOR); + } + + /* get driver MTU */ + { + ULONG mtu; + if (DeviceIoControl (tt->hand, TAP_IOCTL_GET_MTU, + &mtu, sizeof (mtu), + &mtu, sizeof (mtu), &len, NULL)) + { + tt->post_open_mtu = (int) mtu; + msg (D_MTU_INFO, "TAP-Win32 MTU=%d", (int) mtu); + } + } + + /* set point-to-point mode if TUN device */ + + if (tt->type == DEV_TYPE_TUN) + { + in_addr_t ep[2]; + ep[0] = htonl (tt->local); + ep[1] = htonl (tt->remote_netmask); + if (!tt->did_ifconfig_setup) + { + msg (M_FATAL, "ERROR: --dev tun also requires --ifconfig"); + } + if (!DeviceIoControl (tt->hand, TAP_IOCTL_CONFIG_POINT_TO_POINT, + ep, sizeof (ep), + ep, sizeof (ep), &len, NULL)) + msg (M_FATAL, "ERROR: The TAP-Win32 driver rejected a DeviceIoControl call to set Point-to-Point mode, which is required for --dev tun"); + } + + /* should we tell the TAP-Win32 driver to masquerade as a DHCP server as a means + of setting the adapter address? */ + if (tt->did_ifconfig_setup && tt->options.ip_win32_type == IPW32_SET_DHCP_MASQ) + { + uint32_t ep[4]; + + /* We will answer DHCP requests with a reply to set IP/subnet to these values */ + ep[0] = htonl (tt->local); + ep[1] = htonl (tt->adapter_netmask); + + /* At what IP address should the DHCP server masquerade at? */ + if (tt->type == DEV_TYPE_TUN) + { + ep[2] = htonl (tt->remote_netmask); + if (tt->options.dhcp_masq_custom_offset) + msg (M_WARN, "WARNING: because you are using '--dev tun' mode, the '--ip-win32 dynamic [offset]' option is ignoring the offset parameter"); + } + else + { + in_addr_t dsa; /* DHCP server addr */ + + ASSERT (tt->type == DEV_TYPE_TAP); + + if (tt->options.dhcp_masq_offset < 0) + dsa = (tt->local | (~tt->adapter_netmask)) + tt->options.dhcp_masq_offset; + else + dsa = (tt->local & tt->adapter_netmask) + tt->options.dhcp_masq_offset; + + if (dsa == tt->local) + msg (M_FATAL, "ERROR: There is a clash between the --ifconfig local address and the internal DHCP server address -- both are set to %s -- please use the --ip-win32 dynamic option to choose a different free address from the --ifconfig subnet for the internal DHCP server", print_in_addr_t (dsa, 0, &gc)); + + if ((tt->local & tt->adapter_netmask) != (dsa & tt->adapter_netmask)) + msg (M_FATAL, "ERROR: --tap-win32 dynamic [offset] : offset is outside of --ifconfig subnet"); + + ep[2] = htonl (dsa); + } + + /* lease time in seconds */ + ep[3] = (uint32_t) tt->options.dhcp_lease_time; + + ASSERT (ep[3] > 0); + + if (!DeviceIoControl (tt->hand, TAP_IOCTL_CONFIG_DHCP_MASQ, + ep, sizeof (ep), + ep, sizeof (ep), &len, NULL)) + msg (M_FATAL, "ERROR: The TAP-Win32 driver rejected a DeviceIoControl call to set TAP_IOCTL_CONFIG_DHCP_MASQ mode"); + + msg (M_INFO, "Notified TAP-Win32 driver to set a DHCP IP/netmask of %s/%s on interface %s [DHCP-serv: %s, lease-time: %d]", + print_in_addr_t (tt->local, 0, &gc), + print_in_addr_t (tt->adapter_netmask, 0, &gc), + device_guid, + print_in_addr_t (ep[2], IA_NET_ORDER, &gc), + ep[3] + ); + + /* user-supplied DHCP options capability */ + if (tt->options.dhcp_options) + { + struct buffer buf = alloc_buf (256); + build_dhcp_options_string (&buf, &tt->options); + msg (D_DHCP_OPT, "DHCP option string: %s", format_hex (BPTR (&buf), BLEN (&buf), 0, &gc)); + if (!DeviceIoControl (tt->hand, TAP_IOCTL_CONFIG_DHCP_SET_OPT, + BPTR (&buf), BLEN (&buf), + BPTR (&buf), BLEN (&buf), &len, NULL)) + msg (M_FATAL, "ERROR: The TAP-Win32 driver rejected a TAP_IOCTL_CONFIG_DHCP_SET_OPT DeviceIoControl call"); + free_buf (&buf); + } + } + + /* set driver media status to 'connected' */ + { + ULONG status = TRUE; + if (!DeviceIoControl (tt->hand, TAP_IOCTL_SET_MEDIA_STATUS, + &status, sizeof (status), + &status, sizeof (status), &len, NULL)) + msg (M_WARN, "WARNING: The TAP-Win32 driver rejected a TAP_IOCTL_SET_MEDIA_STATUS DeviceIoControl call."); + } + + /* possible wait for adapter to come up */ + { + int s = tt->options.tap_sleep; + if (s > 0) + { + msg (M_INFO, "Sleeping for %d seconds...", s); + openvpn_sleep (s); + } + } + + /* possibly use IP Helper API to set IP address on adapter */ + { + DWORD index = get_interface_index (device_guid); + tt->adapter_index = index; + + /* flush arp cache */ + if (index != (DWORD)~0) + { + DWORD status; + + if ((status = FlushIpNetTable (index)) == NO_ERROR) + msg (M_INFO, "Successful ARP Flush on interface [%u] %s", + (unsigned int)index, + device_guid); + else + msg (M_WARN, "NOTE: FlushIpNetTable failed on interface [%u] %s (status=%u) : %s", + (unsigned int)index, + device_guid, + (unsigned int)status, + strerror_win32 (status, &gc)); + } + + /* + * If the TAP-Win32 driver is masquerading as a DHCP server + * make sure the TCP/IP properties for the adapter are + * set correctly. + */ + if (tt->did_ifconfig_setup && tt->options.ip_win32_type == IPW32_SET_DHCP_MASQ) + { + /* check dhcp enable status */ + if (dhcp_disabled (index)) + msg (M_WARN, "WARNING: You have selected '--ip-win32 dynamic', which will not work unless the TAP-Win32 TCP/IP properties are set to 'Obtain an IP address automatically'"); + + /* force an explicit DHCP lease renewal on TAP adapter? */ + if (tt->options.dhcp_pre_release) + dhcp_release (tt); + if (tt->options.dhcp_renew) + dhcp_renew (tt); + } + + if (tt->did_ifconfig_setup && tt->options.ip_win32_type == IPW32_SET_IPAPI) + { + DWORD status; + const char *error_suffix = "I am having trouble using the Windows 'IP helper API' to automatically set the IP address -- consider using other --ip-win32 methods (not 'ipapi')"; + + /* couldn't get adapter index */ + if (index == (DWORD)~0) + { + msg (M_FATAL, "ERROR: unable to get adapter index for interface %s -- %s", + device_guid, + error_suffix); + } + + /* check dhcp enable status */ + if (dhcp_disabled (index)) + msg (M_WARN, "NOTE: You have selected (explicitly or by default) '--ip-win32 ipapi', which has a better chance of working correctly if the TAP-Win32 TCP/IP properties are set to 'Obtain an IP address automatically'"); + + /* delete previously added IP addresses which were not + correctly deleted */ + delete_temp_addresses (index); + + /* add a new IP address */ + if ((status = AddIPAddress (htonl(tt->local), + htonl(tt->adapter_netmask), + index, + &tt->ipapi_context, + &tt->ipapi_instance)) == NO_ERROR) + msg (M_INFO, "Succeeded in adding a temporary IP/netmask of %s/%s to interface %s using the Win32 IP Helper API", + print_in_addr_t (tt->local, 0, &gc), + print_in_addr_t (tt->adapter_netmask, 0, &gc), + device_guid + ); + else + msg (M_FATAL, "ERROR: AddIPAddress %s/%s failed on interface %s, index=%d, status=%u (windows error: '%s') -- %s", + print_in_addr_t (tt->local, 0, &gc), + print_in_addr_t (tt->adapter_netmask, 0, &gc), + device_guid, + (int)index, + (unsigned int)status, + strerror_win32 (status, &gc), + error_suffix); + tt->ipapi_context_defined = true; + } + } + /*netcmd_semaphore_release ();*/ + gc_free (&gc); +} + +const char * +tap_win32_getinfo (const struct tuntap *tt, struct gc_arena *gc) +{ + if (tt && tt->hand != NULL) + { + struct buffer out = alloc_buf_gc (256, gc); + DWORD len; + if (DeviceIoControl (tt->hand, TAP_IOCTL_GET_INFO, + BSTR (&out), BCAP (&out), + BSTR (&out), BCAP (&out), + &len, NULL)) + { + return BSTR (&out); + } + } + return NULL; +} + +void +tun_show_debug (struct tuntap *tt) +{ + if (tt && tt->hand != NULL) + { + struct buffer out = alloc_buf (1024); + DWORD len; + while (DeviceIoControl (tt->hand, TAP_IOCTL_GET_LOG_LINE, + BSTR (&out), BCAP (&out), + BSTR (&out), BCAP (&out), + &len, NULL)) + { + msg (D_TAP_WIN32_DEBUG, "TAP-Win32: %s", BSTR (&out)); + } + free_buf (&out); + } +} + +void +close_tun (struct tuntap *tt) +{ + struct gc_arena gc = gc_new (); + + if (tt) + { +#if 1 + if (tt->ipapi_context_defined) + { + DWORD status; + if ((status = DeleteIPAddress (tt->ipapi_context)) != NO_ERROR) + { + msg (M_WARN, "Warning: DeleteIPAddress[%u] failed on TAP-Win32 adapter, status=%u : %s", + (unsigned int)tt->ipapi_context, + (unsigned int)status, + strerror_win32 (status, &gc)); + } + } +#endif + + if (tt->options.dhcp_release) + dhcp_release (tt); + + if (tt->hand != NULL) + { + dmsg (D_WIN32_IO_LOW, "Attempting CancelIO on TAP-Win32 adapter"); + if (!CancelIo (tt->hand)) + msg (M_WARN | M_ERRNO, "Warning: CancelIO failed on TAP-Win32 adapter"); + } + + dmsg (D_WIN32_IO_LOW, "Attempting close of overlapped read event on TAP-Win32 adapter"); + overlapped_io_close (&tt->reads); + + dmsg (D_WIN32_IO_LOW, "Attempting close of overlapped write event on TAP-Win32 adapter"); + overlapped_io_close (&tt->writes); + + if (tt->hand != NULL) + { + dmsg (D_WIN32_IO_LOW, "Attempting CloseHandle on TAP-Win32 adapter"); + if (!CloseHandle (tt->hand)) + msg (M_WARN | M_ERRNO, "Warning: CloseHandle failed on TAP-Win32 adapter"); + } + + if (tt->actual_name) + free (tt->actual_name); + + clear_tuntap (tt); + free (tt); + } + gc_free (&gc); +} + +/* + * Convert --ip-win32 constants between index and ascii form. + */ + +struct ipset_names { + const char *short_form; +}; + +/* Indexed by IPW32_SET_x */ +static const struct ipset_names ipset_names[] = { + {"manual"}, + {"netsh"}, + {"ipapi"}, + {"dynamic"} +}; + +int +ascii2ipset (const char* name) +{ + int i; + ASSERT (IPW32_SET_N == SIZE (ipset_names)); + for (i = 0; i < IPW32_SET_N; ++i) + if (!strcmp (name, ipset_names[i].short_form)) + return i; + return -1; +} + +const char * +ipset2ascii (int index) +{ + ASSERT (IPW32_SET_N == SIZE (ipset_names)); + if (index < 0 || index >= IPW32_SET_N) + return "[unknown --ip-win32 type]"; + else + return ipset_names[index].short_form; +} + +const char * +ipset2ascii_all (struct gc_arena *gc) +{ + struct buffer out = alloc_buf_gc (256, gc); + int i; + + ASSERT (IPW32_SET_N == SIZE (ipset_names)); + for (i = 0; i < IPW32_SET_N; ++i) + { + if (i) + buf_printf(&out, " "); + buf_printf(&out, "[%s]", ipset2ascii(i)); + } + return BSTR (&out); +} + +#else /* generic */ + +void +open_tun (const char *dev, const char *dev_type, const char *dev_node, bool ipv6, struct tuntap *tt) +{ + open_tun_generic (dev, dev_type, dev_node, ipv6, false, true, tt); +} + +void +close_tun (struct tuntap* tt) +{ + if (tt) + { + close_tun_generic (tt); + free (tt); + } +} + +int +write_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + return write (tt->fd, buf, len); +} + +int +read_tun (struct tuntap* tt, uint8_t *buf, int len) +{ + return read (tt->fd, buf, len); +} + +#endif @@ -0,0 +1,413 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single TCP/UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifndef TUN_H +#define TUN_H + +#ifdef WIN32 +#include <winioctl.h> +#include "tap-win32/common.h" +#endif + +#include "buffer.h" +#include "error.h" +#include "mtu.h" +#include "win32.h" +#include "event.h" +#include "proto.h" +#include "misc.h" + +#ifdef WIN32 + +struct tuntap_options { + /* --ip-win32 options */ + bool ip_win32_defined; + +# define IPW32_SET_MANUAL 0 /* "--ip-win32 manual" */ +# define IPW32_SET_NETSH 1 /* "--ip-win32 netsh" */ +# define IPW32_SET_IPAPI 2 /* "--ip-win32 ipapi" */ +# define IPW32_SET_DHCP_MASQ 3 /* "--ip-win32 dynamic" */ +# define IPW32_SET_N 4 + int ip_win32_type; + + /* --ip-win32 dynamic options */ + bool dhcp_masq_custom_offset; + int dhcp_masq_offset; + int dhcp_lease_time; + + /* --tap-sleep option */ + int tap_sleep; + + /* --dhcp-option options */ + + bool dhcp_options; + + const char *domain; /* DOMAIN (15) */ + + const char *netbios_scope; /* NBS (47) */ + + int netbios_node_type; /* NBT 1,2,4,8 (46) */ + +#define N_DHCP_ADDR 4 /* Max # of addresses allowed for + DNS, WINS, etc. */ + + /* DNS (6) */ + in_addr_t dns[N_DHCP_ADDR]; + int dns_len; + + /* WINS (44) */ + in_addr_t wins[N_DHCP_ADDR]; + int wins_len; + + /* NTP (42) */ + in_addr_t ntp[N_DHCP_ADDR]; + int ntp_len; + + /* NBDD (45) */ + in_addr_t nbdd[N_DHCP_ADDR]; + int nbdd_len; + + /* DISABLE_NBT (43, Vendor option 001) */ + bool disable_nbt; + + bool dhcp_renew; + bool dhcp_pre_release; + bool dhcp_release; +}; + +#elif TARGET_LINUX + +struct tuntap_options { + int txqueuelen; +}; + +#else + +struct tuntap_options { + int dummy; /* not used */ +}; + +#endif + +/* + * Define a TUN/TAP dev. + */ + +struct tuntap +{ +# define TUNNEL_TYPE(tt) ((tt) ? ((tt)->type) : DEV_TYPE_UNDEF) + int type; /* DEV_TYPE_x as defined in proto.h */ + + bool did_ifconfig_setup; + bool did_ifconfig; + + bool ipv6; + + struct tuntap_options options; /* options set on command line */ + + char *actual_name; /* actual name of TUN/TAP dev, usually including unit number */ + + /* number of TX buffers */ + int txqueuelen; + + /* ifconfig parameters */ + in_addr_t local; + in_addr_t remote_netmask; + in_addr_t broadcast; + +#ifdef WIN32 + HANDLE hand; + struct overlapped_io reads; + struct overlapped_io writes; + struct rw_handle rw_handle; + + /* used for setting interface address via IP Helper API + or DHCP masquerade */ + bool ipapi_context_defined; + ULONG ipapi_context; + ULONG ipapi_instance; + in_addr_t adapter_netmask; + + /* Windows adapter index for TAP-Win32 adapter, + ~0 if undefined */ + DWORD adapter_index; +#else + int fd; /* file descriptor for TUN/TAP dev */ +#endif + +#ifdef TARGET_SOLARIS + int ip_fd; +#endif + + /* used for printing status info only */ + unsigned int rwflags_debug; + + /* Some TUN/TAP drivers like to be ioctled for mtu + after open */ + int post_open_mtu; +}; + +static inline bool +tuntap_defined (const struct tuntap *tt) +{ +#ifdef WIN32 + return tt && tt->hand != NULL; +#else + return tt && tt->fd >= 0; +#endif +} + +/* + * Function prototypes + */ + +void clear_tuntap (struct tuntap *tuntap); + +void open_tun (const char *dev, const char *dev_type, const char *dev_node, + bool ipv6, struct tuntap *tt); + +void close_tun (struct tuntap *tt); + +int write_tun (struct tuntap* tt, uint8_t *buf, int len); + +int read_tun (struct tuntap* tt, uint8_t *buf, int len); + +void tuncfg (const char *dev, const char *dev_type, const char *dev_node, + bool ipv6, int persist_mode); + +const char *guess_tuntap_dev (const char *dev, + const char *dev_type, + const char *dev_node, + struct gc_arena *gc); + +struct tuntap *init_tun (const char *dev, /* --dev option */ + const char *dev_type, /* --dev-type option */ + const char *ifconfig_local_parm, /* --ifconfig parm 1 */ + const char *ifconfig_remote_netmask_parm, /* --ifconfig parm 2 */ + in_addr_t local_public, + in_addr_t remote_public, + const bool strict_warn, + struct env_set *es); + +void init_tun_post (struct tuntap *tt, + const struct frame *frame, + const struct tuntap_options *options); + +void do_ifconfig (struct tuntap *tt, + const char *actual, /* actual device name */ + int tun_mtu, + const struct env_set *es); + +const char *dev_component_in_dev_node (const char *dev_node); + +bool is_dev_type (const char *dev, const char *dev_type, const char *match_type); +int dev_type_enum (const char *dev, const char *dev_type); +const char *dev_type_string (const char *dev, const char *dev_type); + +const char *ifconfig_options_string (const struct tuntap* tt, bool remote, bool disable, struct gc_arena *gc); + +/* + * Inline functions + */ + +static inline void +tun_adjust_frame_parameters (struct frame* frame, int size) +{ + frame_add_to_extra_tun (frame, size); +} + +/* + * Should ifconfig be called before or after + * tun dev open? + */ + +#define IFCONFIG_BEFORE_TUN_OPEN 0 +#define IFCONFIG_AFTER_TUN_OPEN 1 + +#define IFCONFIG_DEFAULT IFCONFIG_AFTER_TUN_OPEN + +static inline int +ifconfig_order(void) +{ +#if defined(TARGET_LINUX) + return IFCONFIG_AFTER_TUN_OPEN; +#elif defined(TARGET_SOLARIS) + return IFCONFIG_AFTER_TUN_OPEN; +#elif defined(TARGET_OPENBSD) + return IFCONFIG_BEFORE_TUN_OPEN; +#elif defined(TARGET_DARWIN) + return IFCONFIG_AFTER_TUN_OPEN; +#elif defined(TARGET_NETBSD) + return IFCONFIG_AFTER_TUN_OPEN; +#elif defined(WIN32) + return IFCONFIG_BEFORE_TUN_OPEN; +#else + return IFCONFIG_DEFAULT; +#endif +} + +#ifdef WIN32 + +#define TUN_PASS_BUFFER + +struct tap_reg +{ + const char *guid; + struct tap_reg *next; +}; + +struct panel_reg +{ + const char *name; + const char *guid; + struct panel_reg *next; +}; + +int ascii2ipset (const char* name); +const char *ipset2ascii (int index); +const char *ipset2ascii_all (struct gc_arena *gc); + +void verify_255_255_255_252 (in_addr_t local, in_addr_t remote); + +const IP_ADAPTER_INFO *get_adapter_info_list (struct gc_arena *gc); +const IP_ADAPTER_INFO *get_tun_adapter (const struct tuntap *tt, const IP_ADAPTER_INFO *list); +bool is_adapter_up (const struct tuntap *tt, const IP_ADAPTER_INFO *list); +bool is_ip_in_adapter_subnet (const IP_ADAPTER_INFO *ai, const in_addr_t ip, in_addr_t *highest_netmask); +DWORD adapter_index_of_ip (const IP_ADAPTER_INFO *list, const in_addr_t ip, int *count); + +void show_tap_win32_adapters (int msglev, int warnlev); +void show_adapters (int msglev); + +void show_valid_win32_tun_subnets (void); +const char *tap_win32_getinfo (const struct tuntap *tt, struct gc_arena *gc); +void tun_show_debug (struct tuntap *tt); + +bool dhcp_release (const struct tuntap *tt); +bool dhcp_renew (const struct tuntap *tt); + +int tun_read_queue (struct tuntap *tt, int maxsize); +int tun_write_queue (struct tuntap *tt, struct buffer *buf); +int tun_finalize (HANDLE h, struct overlapped_io *io, struct buffer *buf); + +const char *get_netsh_id (const char *dev_node, struct gc_arena *gc); + +static inline bool +tuntap_stop (int status) +{ + /* + * This corresponds to the STATUS_NO_SUCH_DEVICE + * error in tapdrvr.c. + */ + if (status < 0) + { + return openvpn_errno () == ERROR_FILE_NOT_FOUND; + } + return false; +} + +static inline int +tun_write_win32 (struct tuntap *tt, struct buffer *buf) +{ + int err = 0; + int status = 0; + if (overlapped_io_active (&tt->writes)) + { + status = tun_finalize (tt->hand, &tt->writes, NULL); + if (status < 0) + err = GetLastError (); + } + tun_write_queue (tt, buf); + if (status < 0) + { + SetLastError (err); + return status; + } + else + return BLEN (buf); +} + +static inline int +read_tun_buffered (struct tuntap *tt, struct buffer *buf, int maxsize) +{ + return tun_finalize (tt->hand, &tt->reads, buf); +} + +static inline int +write_tun_buffered (struct tuntap *tt, struct buffer *buf) +{ + return tun_write_win32 (tt, buf); +} + +#else + +static inline bool +tuntap_stop (int status) +{ + return false; +} + +#endif + +/* + * TUN/TAP I/O wait functions + */ + +static inline event_t +tun_event_handle (const struct tuntap *tt) +{ +#ifdef WIN32 + return &tt->rw_handle; +#else + return tt->fd; +#endif +} + +static inline unsigned int +tun_set (struct tuntap *tt, + struct event_set *es, + unsigned int rwflags, + void *arg, + unsigned int *persistent) +{ + if (tuntap_defined (tt)) + { + /* if persistent is defined, call event_ctl only if rwflags has changed since last call */ + if (!persistent || *persistent != rwflags) + { + event_ctl (es, tun_event_handle (tt), rwflags, arg); + if (persistent) + *persistent = rwflags; + } +#ifdef WIN32 + if (rwflags & EVENT_READ) + tun_read_queue (tt, 0); +#endif + tt->rwflags_debug = rwflags; + } + return rwflags; +} + +const char *tun_stat (const struct tuntap *tt, unsigned int rwflags, struct gc_arena *gc); + +#endif /* TUN_H */ @@ -0,0 +1,758 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +/* + * Win32-specific OpenVPN code, targetted at the mingw + * development environment. + */ + +#ifdef WIN32 + +#include "config-win32.h" + +#include "syshead.h" +#include "buffer.h" +#include "error.h" +#include "mtu.h" +#include "sig.h" +#include "win32.h" + +#include "memdbg.h" + +/* + * Windows internal socket API state (opaque). + */ +static struct WSAData wsa_state; /* GLOBAL */ + +/* + * Should we call win32_pause() on program exit? + */ +static bool pause_exit_enabled = false; /* GLOBAL */ + +/* + * win32_signal is used to get input from the keyboard + * if we are running in a console, or get input from an + * event object if we are running as a service. + */ + +struct win32_signal win32_signal; /* GLOBAL */ + +/* + * Save our old window title so we can restore + * it on exit. + */ +struct window_title window_title; /* GLOBAL*/ + +/* + * Special global semaphore used to protect network + * shell commands from simultaneous instantiation. + */ + +struct semaphore netcmd_semaphore; /* GLOBAL */ + +void +init_win32 (void) +{ + if (WSAStartup(0x0101, &wsa_state)) + { + msg (M_ERR, "WSAStartup failed"); + } + window_title_clear (&window_title); + win32_signal_clear (&win32_signal); + netcmd_semaphore_init (); +} + +void +uninit_win32 (void) +{ + netcmd_semaphore_close (); + if (pause_exit_enabled) + { + if (win32_signal.mode == WSO_MODE_UNDEF) + { + struct win32_signal w; + win32_signal_open (&w, WSO_FORCE_CONSOLE, NULL, false); + win32_pause (&w); + win32_signal_close (&w); + } + else + win32_pause (&win32_signal); + } + window_title_restore (&window_title); + win32_signal_close (&win32_signal); + WSACleanup (); +} + +void +set_pause_exit_win32 (void) +{ + pause_exit_enabled = true; +} + +bool +init_security_attributes_allow_all (struct security_attributes *obj) +{ + CLEAR (*obj); + + obj->sa.nLength = sizeof (SECURITY_ATTRIBUTES); + obj->sa.lpSecurityDescriptor = &obj->sd; + obj->sa.bInheritHandle = FALSE; + if (!InitializeSecurityDescriptor (&obj->sd, SECURITY_DESCRIPTOR_REVISION)) + return false; + if (!SetSecurityDescriptorDacl (&obj->sd, TRUE, NULL, FALSE)) + return false; + return true; +} + +void +overlapped_io_init (struct overlapped_io *o, + const struct frame *frame, + BOOL event_state, + bool tuntap_buffer) /* if true: tuntap buffer, if false: socket buffer */ +{ + CLEAR (*o); + + /* manual reset event, initially set according to event_state */ + o->overlapped.hEvent = CreateEvent (NULL, TRUE, event_state, NULL); + if (o->overlapped.hEvent == NULL) + msg (M_ERR, "Error: overlapped_io_init: CreateEvent failed"); + + /* allocate buffer for overlapped I/O */ + alloc_buf_sock_tun (&o->buf_init, frame, tuntap_buffer, 0); +} + +void +overlapped_io_close (struct overlapped_io *o) +{ + if (o->overlapped.hEvent) + { + if (!CloseHandle (o->overlapped.hEvent)) + msg (M_WARN | M_ERRNO, "Warning: CloseHandle failed on overlapped I/O event object"); + } + free_buf (&o->buf_init); +} + +char * +overlapped_io_state_ascii (const struct overlapped_io *o) +{ + switch (o->iostate) + { + case IOSTATE_INITIAL: + return "0"; + case IOSTATE_QUEUED: + return "Q"; + case IOSTATE_IMMEDIATE_RETURN: + return "1"; + } + return "?"; +} + +/* + * Event-based notification of network events + */ + +void +init_net_event_win32 (struct rw_handle *event, long network_events, socket_descriptor_t sd, unsigned int flags) +{ + /* manual reset events, initially set to unsignaled */ + + /* initialize write event */ + if (!(flags & NE32_PERSIST_EVENT) || !event->write) + { + if (flags & NE32_WRITE_EVENT) + { + event->write = CreateEvent (NULL, TRUE, FALSE, NULL); + if (event->write == NULL) + msg (M_ERR, "Error: init_net_event_win32: CreateEvent (write) failed"); + } + else + event->write = NULL; + } + + /* initialize read event */ + if (!(flags & NE32_PERSIST_EVENT) || !event->read) + { + event->read = CreateEvent (NULL, TRUE, FALSE, NULL); + if (event->read == NULL) + msg (M_ERR, "Error: init_net_event_win32: CreateEvent (read) failed"); + } + + /* setup network events to change read event state */ + if (WSAEventSelect (sd, event->read, network_events) != 0) + msg (M_FATAL | M_ERRNO_SOCK, "Error: init_net_event_win32: WSAEventSelect call failed"); +} + +long +reset_net_event_win32 (struct rw_handle *event, socket_descriptor_t sd) +{ + WSANETWORKEVENTS wne; + if (WSAEnumNetworkEvents (sd, event->read, &wne) != 0) + { + msg (M_FATAL | M_ERRNO_SOCK, "Error: reset_net_event_win32: WSAEnumNetworkEvents call failed"); + return 0; /* NOTREACHED */ + } + else + return wne.lNetworkEvents; +} + +void +close_net_event_win32 (struct rw_handle *event, socket_descriptor_t sd, unsigned int flags) +{ + if (event->read) + { + if (socket_defined (sd)) + { + if (WSAEventSelect (sd, event->read, 0) != 0) + msg (M_WARN | M_ERRNO_SOCK, "Warning: close_net_event_win32: WSAEventSelect call failed"); + } + if (!ResetEvent (event->read)) + msg (M_WARN | M_ERRNO, "Warning: ResetEvent (read) failed in close_net_event_win32"); + if (!(flags & NE32_PERSIST_EVENT)) + { + if (!CloseHandle (event->read)) + msg (M_WARN | M_ERRNO, "Warning: CloseHandle (read) failed in close_net_event_win32"); + event->read = NULL; + } + } + + if (event->write) + { + if (!ResetEvent (event->write)) + msg (M_WARN | M_ERRNO, "Warning: ResetEvent (write) failed in close_net_event_win32"); + if (!(flags & NE32_PERSIST_EVENT)) + { + if (!CloseHandle (event->write)) + msg (M_WARN | M_ERRNO, "Warning: CloseHandle (write) failed in close_net_event_win32"); + event->write = NULL; + } + } +} + +/* + * struct net_event_win32 + */ + +void +net_event_win32_init (struct net_event_win32 *ne) +{ + CLEAR (*ne); + ne->sd = SOCKET_UNDEFINED; +} + +void +net_event_win32_start (struct net_event_win32 *ne, long network_events, socket_descriptor_t sd) +{ + ASSERT (!socket_defined (ne->sd)); + ne->sd = sd; + ne->event_mask = 0; + init_net_event_win32 (&ne->handle, network_events, sd, NE32_PERSIST_EVENT|NE32_WRITE_EVENT); +} + +void +net_event_win32_reset_write (struct net_event_win32 *ne) +{ + BOOL status; + if (ne->event_mask & FD_WRITE) + status = SetEvent (ne->handle.write); + else + status = ResetEvent (ne->handle.write); + if (!status) + msg (M_WARN | M_ERRNO, "Warning: SetEvent/ResetEvent failed in net_event_win32_reset_write"); +} + +void +net_event_win32_reset (struct net_event_win32 *ne) +{ + ne->event_mask |= reset_net_event_win32 (&ne->handle, ne->sd); +} + +void +net_event_win32_stop (struct net_event_win32 *ne) +{ + if (net_event_win32_defined (ne)) + close_net_event_win32 (&ne->handle, ne->sd, NE32_PERSIST_EVENT); + ne->sd = SOCKET_UNDEFINED; + ne->event_mask = 0; +} + +void +net_event_win32_close (struct net_event_win32 *ne) +{ + if (net_event_win32_defined (ne)) + close_net_event_win32 (&ne->handle, ne->sd, 0); + net_event_win32_init (ne); +} + +/* + * Simulate *nix signals on Windows. + * + * Two modes: + * (1) Console mode -- map keyboard function keys to signals + * (2) Service mode -- map Windows event object to SIGTERM + */ + +void +win32_signal_clear (struct win32_signal *ws) +{ + CLEAR (*ws); +} + +void +win32_signal_open (struct win32_signal *ws, + int force, + const char *exit_event_name, + bool exit_event_initial_state) +{ + CLEAR (*ws); + + ws->mode = WSO_MODE_UNDEF; + ws->in.read = INVALID_HANDLE_VALUE; + ws->in.write = INVALID_HANDLE_VALUE; + ws->console_mode_save = 0; + ws->console_mode_save_defined = false; + + if (force == WSO_NOFORCE || force == WSO_FORCE_CONSOLE) + { + /* + * Try to open console. + */ + ws->in.read = GetStdHandle (STD_INPUT_HANDLE); + if (ws->in.read != INVALID_HANDLE_VALUE) + { + if (GetConsoleMode (ws->in.read, &ws->console_mode_save)) + { + /* running on a console */ + const DWORD new_console_mode = ws->console_mode_save + & ~(ENABLE_WINDOW_INPUT + | ENABLE_PROCESSED_INPUT + | ENABLE_LINE_INPUT + | ENABLE_ECHO_INPUT + | ENABLE_MOUSE_INPUT); + + if (new_console_mode != ws->console_mode_save) + { + if (!SetConsoleMode (ws->in.read, new_console_mode)) + msg (M_ERR, "Error: win32_signal_open: SetConsoleMode failed"); + ws->console_mode_save_defined = true; + } + ws->mode = WSO_MODE_CONSOLE; + } + else + ws->in.read = INVALID_HANDLE_VALUE; /* probably running as a service */ + } + } + + /* + * If console open failed, assume we are running + * as a service. + */ + if ((force == WSO_NOFORCE || force == WSO_FORCE_SERVICE) + && !HANDLE_DEFINED (ws->in.read) && exit_event_name) + { + struct security_attributes sa; + + if (!init_security_attributes_allow_all (&sa)) + msg (M_ERR, "Error: win32_signal_open: init SA failed"); + + ws->in.read = CreateEvent (&sa.sa, + TRUE, + exit_event_initial_state ? TRUE : FALSE, + exit_event_name); + if (ws->in.read == NULL) + { + msg (M_WARN|M_ERRNO, "NOTE: CreateEvent '%s' failed", exit_event_name); + } + else + { + if (WaitForSingleObject (ws->in.read, 0) != WAIT_TIMEOUT) + msg (M_FATAL, "ERROR: Exit Event ('%s') is signaled", exit_event_name); + else + ws->mode = WSO_MODE_SERVICE; + } + } +} + +static bool +keyboard_input_available (struct win32_signal *ws) +{ + ASSERT (ws->mode == WSO_MODE_CONSOLE); + if (HANDLE_DEFINED (ws->in.read)) + { + DWORD n; + if (GetNumberOfConsoleInputEvents (ws->in.read, &n)) + return n > 0; + } + return false; +} + +static unsigned int +keyboard_ir_to_key (INPUT_RECORD *ir) +{ + if (ir->Event.KeyEvent.uChar.AsciiChar == 0) + return ir->Event.KeyEvent.wVirtualScanCode; + + if ((ir->Event.KeyEvent.dwControlKeyState + & (LEFT_ALT_PRESSED | RIGHT_ALT_PRESSED)) + && (ir->Event.KeyEvent.wVirtualKeyCode != 18)) + return ir->Event.KeyEvent.wVirtualScanCode * 256; + + return ir->Event.KeyEvent.uChar.AsciiChar; +} + +static unsigned int +win32_keyboard_get (struct win32_signal *ws) +{ + ASSERT (ws->mode == WSO_MODE_CONSOLE); + if (HANDLE_DEFINED (ws->in.read)) + { + INPUT_RECORD ir; + do { + DWORD n; + if (!keyboard_input_available (ws)) + return 0; + if (!ReadConsoleInput (ws->in.read, &ir, 1, &n)) + return 0; + } while (ir.EventType != KEY_EVENT || ir.Event.KeyEvent.bKeyDown != TRUE); + + return keyboard_ir_to_key (&ir); + } + else + return 0; +} + +void +win32_signal_close (struct win32_signal *ws) +{ + if (ws->mode == WSO_MODE_SERVICE && HANDLE_DEFINED (ws->in.read)) + CloseHandle (ws->in.read); + if (ws->console_mode_save_defined) + { + if (!SetConsoleMode (ws->in.read, ws->console_mode_save)) + msg (M_ERR, "Error: win32_signal_close: SetConsoleMode failed"); + } + CLEAR (*ws); +} + +/* + * Return true if interrupt occurs in service mode. + */ +static bool +win32_service_interrupt (struct win32_signal *ws) +{ + if (ws->mode == WSO_MODE_SERVICE) + { + if (HANDLE_DEFINED (ws->in.read) + && WaitForSingleObject (ws->in.read, 0) == WAIT_OBJECT_0) + return true; + } + return false; +} + +int +win32_signal_get (struct win32_signal *ws) +{ + int ret = 0; + if (siginfo_static.signal_received) + { + ret = siginfo_static.signal_received; + } + else + { + if (ws->mode == WSO_MODE_SERVICE) + { + if (win32_service_interrupt (ws)) + ret = SIGTERM; + } + else if (ws->mode == WSO_MODE_CONSOLE) + { + switch (win32_keyboard_get (ws)) + { + case 0x3B: /* F1 -> USR1 */ + ret = SIGUSR1; + break; + case 0x3C: /* F2 -> USR2 */ + ret = SIGUSR2; + break; + case 0x3D: /* F3 -> HUP */ + ret = SIGHUP; + break; + case 0x3E: /* F4 -> TERM */ + ret = SIGTERM; + break; + } + } + if (ret) + { + siginfo_static.signal_received = ret; + siginfo_static.hard = true; + } + } + return ret; +} + +void +win32_pause (struct win32_signal *ws) +{ + if (ws->mode == WSO_MODE_CONSOLE && HANDLE_DEFINED (ws->in.read)) + { + int status; + msg (M_INFO|M_NOPREFIX, "Press any key to continue..."); + do { + status = WaitForSingleObject (ws->in.read, INFINITE); + } while (!win32_keyboard_get (ws)); + } +} + +/* window functions */ + +void +window_title_clear (struct window_title *wt) +{ + CLEAR (*wt); +} + +void +window_title_save (struct window_title *wt) +{ + if (!wt->saved) + { + if (!GetConsoleTitle (wt->old_window_title, sizeof (wt->old_window_title))) + { + wt->old_window_title[0] = 0; + wt->saved = false; + } + else + wt->saved = true; + } +} + +void +window_title_restore (const struct window_title *wt) +{ + if (wt->saved) + SetConsoleTitle (wt->old_window_title); +} + +void +window_title_generate (const char *title) +{ + struct gc_arena gc = gc_new (); + struct buffer out = alloc_buf_gc (256, &gc); + if (!title) + title = ""; + buf_printf (&out, "[%s] " PACKAGE_NAME " " VERSION " F4:EXIT F1:USR1 F2:USR2 F3:HUP", title); + SetConsoleTitle (BSTR (&out)); + gc_free (&gc); +} + +/* semaphore functions */ + +void +semaphore_clear (struct semaphore *s) +{ + CLEAR (*s); +} + +void +semaphore_open (struct semaphore *s, const char *name) +{ + struct security_attributes sa; + + s->locked = false; + s->name = name; + s->hand = NULL; + + if (init_security_attributes_allow_all (&sa)) + s->hand = CreateSemaphore(&sa.sa, 1, 1, name); + + if (s->hand == NULL) + msg (M_WARN|M_ERRNO, "WARNING: Cannot create Win32 semaphore '%s'", name); + else + dmsg (D_SEMAPHORE, "Created Win32 semaphore '%s'", s->name); +} + +bool +semaphore_lock (struct semaphore *s, int timeout_milliseconds) +{ + bool ret = true; + + if (s->hand) + { + DWORD status; + ASSERT (!s->locked); + + dmsg (D_SEMAPHORE_LOW, "Attempting to lock Win32 semaphore '%s' prior to net shell command (timeout = %d sec)", + s->name, + timeout_milliseconds / 1000); + status = WaitForSingleObject (s->hand, timeout_milliseconds); + if (status == WAIT_FAILED) + msg (M_ERR, "Wait failed on Win32 semaphore '%s'", s->name); + ret = (status == WAIT_TIMEOUT) ? false : true; + if (ret) + { + dmsg (D_SEMAPHORE, "Locked Win32 semaphore '%s'", s->name); + s->locked = true; + } + else + { + dmsg (D_SEMAPHORE, "Wait on Win32 semaphore '%s' timed out after %d milliseconds", + s->name, + timeout_milliseconds); + } + } + return ret; +} + +void +semaphore_release (struct semaphore *s) +{ + if (s->hand) + { + ASSERT (s->locked); + dmsg (D_SEMAPHORE, "Releasing Win32 semaphore '%s'", s->name); + if (!ReleaseSemaphore(s->hand, 1, NULL)) + msg (M_WARN | M_ERRNO, "ReleaseSemaphore failed on Win32 semaphore '%s'", + s->name); + s->locked = false; + } +} + +void +semaphore_close (struct semaphore *s) +{ + if (s->hand) + { + if (s->locked) + semaphore_release (s); + dmsg (D_SEMAPHORE, "Closing Win32 semaphore '%s'", s->name); + CloseHandle (s->hand); + s->hand = NULL; + } +} + +/* + * Special global semaphore used to protect network + * shell commands from simultaneous instantiation. + */ + +void +netcmd_semaphore_init (void) +{ + semaphore_open (&netcmd_semaphore, PACKAGE "_netcmd"); +} + +void +netcmd_semaphore_close (void) +{ + semaphore_close (&netcmd_semaphore); +} + +void +netcmd_semaphore_lock (void) +{ + const int timeout_seconds = 600; + if (!semaphore_lock (&netcmd_semaphore, timeout_seconds * 1000)) + msg (M_FATAL, "Cannot lock net command semaphore"); +} + +void +netcmd_semaphore_release (void) +{ + semaphore_release (&netcmd_semaphore); +} + +/* + * Get input from console. + * + * Return false on input error, or if service + * exit event is signaled. + */ + +bool +get_console_input_win32 (const char *prompt, const bool echo, char *input, const int capacity) +{ + HANDLE in = INVALID_HANDLE_VALUE; + HANDLE err = INVALID_HANDLE_VALUE; + DWORD len = 0; + + ASSERT (prompt); + ASSERT (input); + ASSERT (capacity > 0); + + input[0] = '\0'; + + in = GetStdHandle (STD_INPUT_HANDLE); + err = get_orig_stderr (); + + if (in != INVALID_HANDLE_VALUE + && err != INVALID_HANDLE_VALUE + && !win32_service_interrupt (&win32_signal) + && WriteFile (err, prompt, strlen (prompt), &len, NULL)) + { + bool is_console = (GetFileType (in) == FILE_TYPE_CHAR); + DWORD flags_save = 0; + int status = 0; + + if (is_console) + { + if (GetConsoleMode (in, &flags_save)) + { + DWORD flags = ENABLE_LINE_INPUT | ENABLE_PROCESSED_INPUT; + if (echo) + flags |= ENABLE_ECHO_INPUT; + SetConsoleMode (in, flags); + } + else + is_console = 0; + } + + status = ReadFile (in, input, capacity, &len, NULL); + + string_null_terminate (input, (int)len, capacity); + chomp (input); + + if (!echo) + WriteFile (err, "\r\n", 2, &len, NULL); + if (is_console) + SetConsoleMode (in, flags_save); + if (status && !win32_service_interrupt (&win32_signal)) + return true; + } + + return false; +} + +/* get password from console */ + +char * +getpass (const char *prompt) +{ + static char line[256]; + if (get_console_input_win32 (prompt, false, line, sizeof (line))) + return line; + else + return NULL; +} + +#endif @@ -0,0 +1,251 @@ +/* + * OpenVPN -- An application to securely tunnel IP networks + * over a single UDP port, with support for SSL/TLS-based + * session authentication and key exchange, + * packet encryption, packet authentication, and + * packet compression. + * + * Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net> + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 + * 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 (see the file COPYING included with this + * distribution); if not, write to the Free Software Foundation, Inc., + * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +#ifdef WIN32 +#ifndef OPENVPN_WIN32_H +#define OPENVPN_WIN32_H + +#include "mtu.h" + +/* + * Win32-specific OpenVPN code, targetted at the mingw + * development environment. + */ + +void init_win32 (void); +void uninit_win32 (void); + +void set_pause_exit_win32 (void); + +/* + * Use keyboard input or events + * to simulate incoming signals + */ + +#define SIGUSR1 1 +#define SIGUSR2 2 +#define SIGHUP 3 +#define SIGTERM 4 +#define SIGINT 5 + +struct security_attributes +{ + SECURITY_ATTRIBUTES sa; + SECURITY_DESCRIPTOR sd; +}; + +#define HANDLE_DEFINED(h) ((h) != NULL && (h) != INVALID_HANDLE_VALUE) + +/* + * Save old window title. + */ +struct window_title +{ + bool saved; + char old_window_title [256]; +}; + +struct rw_handle { + HANDLE read; + HANDLE write; +}; + +/* + * Event-based notification of incoming TCP connections + */ + +#define NE32_PERSIST_EVENT (1<<0) +#define NE32_WRITE_EVENT (1<<1) + +static inline bool +defined_net_event_win32 (const struct rw_handle *event) +{ + return event->read != NULL; +} + +void init_net_event_win32 (struct rw_handle *event, long network_events, socket_descriptor_t sd, unsigned int flags); +long reset_net_event_win32 (struct rw_handle *event, socket_descriptor_t sd); +void close_net_event_win32 (struct rw_handle *event, socket_descriptor_t sd, unsigned int flags); + +/* + * A stateful variant of the net_event_win32 functions above + */ + +struct net_event_win32 +{ + struct rw_handle handle; + socket_descriptor_t sd; + long event_mask; +}; + +void net_event_win32_init (struct net_event_win32 *ne); +void net_event_win32_start (struct net_event_win32 *ne, long network_events, socket_descriptor_t sd); +void net_event_win32_reset (struct net_event_win32 *ne); +void net_event_win32_reset_write (struct net_event_win32 *ne); +void net_event_win32_stop (struct net_event_win32 *ne); +void net_event_win32_close (struct net_event_win32 *ne); + +static bool +net_event_win32_defined (const struct net_event_win32 *ne) +{ + return defined_net_event_win32 (&ne->handle); +} + +static inline struct rw_handle * +net_event_win32_get_event (struct net_event_win32 *ne) +{ + return &ne->handle; +} + +static inline long +net_event_win32_get_event_mask (const struct net_event_win32 *ne) +{ + return ne->event_mask; +} + +static inline void +net_event_win32_clear_selected_events (struct net_event_win32 *ne, long selected_events) +{ + ne->event_mask &= ~selected_events; +} + +/* + * Signal handling + */ +struct win32_signal { +# define WSO_MODE_UNDEF 0 +# define WSO_MODE_SERVICE 1 +# define WSO_MODE_CONSOLE 2 + int mode; + struct rw_handle in; + DWORD console_mode_save; + bool console_mode_save_defined; +}; + +extern struct win32_signal win32_signal; /* static/global */ +extern struct window_title window_title; /* static/global */ + +void win32_signal_clear (struct win32_signal *ws); + +/* win32_signal_open startup type */ +#define WSO_NOFORCE 0 +#define WSO_FORCE_SERVICE 1 +#define WSO_FORCE_CONSOLE 2 + +void win32_signal_open (struct win32_signal *ws, + int force, /* set to WSO force parm */ + const char *exit_event_name, + bool exit_event_initial_state); + +void win32_signal_close (struct win32_signal *ws); + +int win32_signal_get (struct win32_signal *ws); + +void win32_pause (struct win32_signal *ws); + +/* + * Set the text on the window title bar + */ + +void window_title_clear (struct window_title *wt); +void window_title_save (struct window_title *wt); +void window_title_restore (const struct window_title *wt); +void window_title_generate (const char *title); + +/* + * We try to do all Win32 I/O using overlapped + * (i.e. asynchronous) I/O for a performance win. + */ +struct overlapped_io { +# define IOSTATE_INITIAL 0 +# define IOSTATE_QUEUED 1 /* overlapped I/O has been queued */ +# define IOSTATE_IMMEDIATE_RETURN 2 /* I/O function returned immediately without queueing */ + int iostate; + OVERLAPPED overlapped; + DWORD size; + DWORD flags; + int status; + bool addr_defined; + struct sockaddr_in addr; + int addrlen; + struct buffer buf_init; + struct buffer buf; +}; + +void overlapped_io_init (struct overlapped_io *o, + const struct frame *frame, + BOOL event_state, + bool tuntap_buffer); + +void overlapped_io_close (struct overlapped_io *o); + +static inline bool +overlapped_io_active (struct overlapped_io *o) +{ + return o->iostate == IOSTATE_QUEUED || o->iostate == IOSTATE_IMMEDIATE_RETURN; +} + +char *overlapped_io_state_ascii (const struct overlapped_io *o); + +/* + * Use to control access to resources that only one + * OpenVPN process on a given machine can access at + * a given time. + */ + +struct semaphore +{ + const char *name; + bool locked; + HANDLE hand; +}; + +void semaphore_clear (struct semaphore *s); +void semaphore_open (struct semaphore *s, const char *name); +bool semaphore_lock (struct semaphore *s, int timeout_milliseconds); +void semaphore_release (struct semaphore *s); +void semaphore_close (struct semaphore *s); + +/* + * Special global semaphore used to protect network + * shell commands from simultaneous instantiation. + * + * It seems you can't run more than one instance + * of netsh on the same machine at the same time. + */ + +extern struct semaphore netcmd_semaphore; +void netcmd_semaphore_init (void); +void netcmd_semaphore_close (void); +void netcmd_semaphore_lock (void); +void netcmd_semaphore_release (void); + +bool get_console_input_win32 (const char *prompt, const bool echo, char *input, const int capacity); +char *getpass (const char *prompt); + +/* Set Win32 security attributes structure to allow all access */ +bool init_security_attributes_allow_all (struct security_attributes *obj); + +#endif +#endif |
