diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/COPYING @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + 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 Lesser 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. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 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. + +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. + + , 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 Lesser General +Public License instead of this License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..30b1143 --- /dev/null +++ b/Makefile @@ -0,0 +1,45 @@ +SRC = src +TEST = t +BUILDDIR = build +DISTDIR = dist + +# Gah +SUBBUILDDIR = $(shell python -c 'import distutils.util, sys; print "lib.%s-%s" % (distutils.util.get_platform(), sys.version[0:3])') +BUILDDIR := $(BUILDDIR)/$(SUBBUILDDIR) + +COVERAGE = $(or $(shell which coverage), $(shell which python-coverage), \ + coverage) + +all: + ./setup.py build + +install: all + ./setup.py install + +test: all + retval=0; \ + for i in `find "$(TEST)" -perm -u+x -type f`; do \ + echo $$i; \ + PYTHONPATH="$(BUILDDIR):$$PYTHONPATH" $$i || retval=$$?; \ + done; exit $$retval + +coverage: all + rm -f .coverage + for i in `find "$(TEST)" -perm -u+x -type f`; do \ + set -e; \ + PYTHONPATH="$(BUILDDIR):$$PYTHONPATH" $(COVERAGE) -x $$i; \ + done + $(COVERAGE) -r -m `find "$(BUILDDIR)" -name \\*.py -type f` + rm -f .coverage + +clean: + ./setup.py clean + rm -f `find -name \*.pyc` .coverage + +distclean: clean + rm -rf "$(DISTDIR)" + +dist: + ./setup.py sdist + +.PHONY: clean distclean dist test coverage install diff --git a/PKG-INFO b/PKG-INFO new file mode 100644 index 0000000..c023f34 --- /dev/null +++ b/PKG-INFO @@ -0,0 +1,26 @@ +Metadata-Version: 1.0 +Name: python-passfd +Version: 0.2 +Summary: Python functions to pass file descriptors across UNIX domain sockets +Home-page: http://code.google.com/p/python-passfd/ +Author: Martin Ferrari +Author-email: martin.ferrari@gmail.com +License: GPLv2 +Description: This simple extension provides two functions to pass and receive file + descriptors across UNIX domain sockets, using the BSD-4.3+ sendmsg() and + recvmsg() interfaces. + + Direct bindings to sendmsg and recvmsg are not provided, as the API does + not map nicely into Python. + + Please note that this only supports BSD-4.3+ style file descriptor + passing, and was only tested on Linux. Patches are welcomed! + + For more information, see one of the R. Stevens' books: + - Richard Stevens: Unix Network Programming, Prentice Hall, 1990; + chapter 6.10 + + - Richard Stevens: Advanced Programming in the UNIX Environment, + Addison-Wesley, 1993; chapter 15.3 + +Platform: Linux diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..e1b8322 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[clean] +all = 1 diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..c86a110 --- /dev/null +++ b/setup.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 +# vim: ts=4:sw=4:et:ai:sts=4 +from distutils.core import setup, Extension +import sys +sys.path.append("src") +import passfd + +module1 = Extension('_passfd', sources = ['src/passfd.c']) + +setup( + name = 'python-passfd', + version = '0.2', + description = 'Python functions to pass file descriptors across ' + + 'UNIX domain sockets', + long_description = passfd.__doc__, + author = 'Martin Ferrari', + author_email = 'martin.ferrari@gmail.com', + url = 'http://code.google.com/p/python-passfd/', + license = 'GPLv2', + platforms = 'Linux', + package_dir = {'': 'src'}, + ext_modules = [module1], + py_modules = ['passfd']) diff --git a/src/passfd.c b/src/passfd.c new file mode 100644 index 0000000..de62781 --- /dev/null +++ b/src/passfd.c @@ -0,0 +1,241 @@ +/* vim:ts=4:sw=4:et:ai:sts=4 + * + * passfd.c: Functions to pass file descriptors across UNIX domain sockets. + * + * Please note that this only supports BSD-4.3+ style file descriptor passing, + * and was only tested on Linux. Patches are welcomed! + * + * Copyright © 2010 Martín Ferrari + * + * Inspired by Socket::PassAccessRights, which is: + * Copyright (c) 2000 Sampo Kellomaki + * + * For more information, see one of the R. Stevens' books: + * - Richard Stevens: Unix Network Programming, Prentice Hall, 1990; + * chapter 6.10 + * + * - Richard Stevens: Advanced Programming in the UNIX Environment, + * Addison-Wesley, 1993; chapter 15.3 + * + * 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. + */ + +#include +#ifndef _GNU_SOURCE +# define _GNU_SOURCE +#endif +#include +#include +#include + +int _sendfd(int sock, int fd, size_t len, const void *msg); +int _recvfd(int sock, size_t *len, void *buf); + +/* Python wrapper for _sendfd */ +static PyObject * +sendfd(PyObject *self, PyObject *args) { + const char *message; + char *buf; + int ret, sock, fd, message_len; + + if(!PyArg_ParseTuple(args, "iis#", &sock, &fd, &message, &message_len)) + return NULL; + + /* I don't know if I need to make a copy of the message buffer for thread + * safety, but let's do it just in case... */ + buf = strndup(message, (size_t)message_len); + if(buf == NULL) + return PyErr_SetFromErrno(PyExc_OSError); + + Py_BEGIN_ALLOW_THREADS; + ret = _sendfd(sock, fd, message_len, message); + Py_END_ALLOW_THREADS; + + free(buf); + if(ret == -1) + return PyErr_SetFromErrno(PyExc_OSError); + return Py_BuildValue("i", ret); +} + +/* Python wrapper for _recvfd */ +static PyObject * +recvfd(PyObject *self, PyObject *args) { + char *buffer; + int ret, sock, buffersize = 4096; + size_t _buffersize; + PyObject *retval; + + if(!PyArg_ParseTuple(args, "i|i", &sock, &buffersize)) + return NULL; + + if((buffer = malloc(buffersize)) == NULL) + return PyErr_SetFromErrno(PyExc_OSError); + + _buffersize = buffersize; + + Py_BEGIN_ALLOW_THREADS; + ret = _recvfd(sock, &_buffersize, buffer); + Py_END_ALLOW_THREADS; + + buffersize = (int)_buffersize; + if(ret == -1) { + free(buffer); + return PyErr_SetFromErrno(PyExc_OSError); + } + retval = Py_BuildValue("is#", ret, buffer, buffersize); + free(buffer); + return retval; +} + +static PyMethodDef methods[] = { + {"sendfd", sendfd, METH_VARARGS, "rv = sendfd(sock, fd, message)"}, + {"recvfd", recvfd, METH_VARARGS, "(fd, message) = recvfd(sock, " + "buffersize = 4096)"}, + {NULL, NULL, 0, NULL} +}; + +PyMODINIT_FUNC init_passfd(void) { + PyObject *m; + m = Py_InitModule("_passfd", methods); + if (m == NULL) + return; +} + +/* Size of the cmsg including one file descriptor */ +#define CMSG_SIZE CMSG_SPACE(sizeof(int)) + +/* + * _sendfd(): send a message and piggyback a file descriptor. + * + * Note that the file descriptor cannot be sent by itself, at least one byte of + * payload needs to be sent. + * + * Parameters: + * sock: AF_UNIX socket + * fd: file descriptor to pass + * len: length of the message + * msg: the message itself + * + * Return value: + * On success, sendfd returns the number of characters from the message sent, + * the file descriptor information is not taken into account. If there was no + * message to send, 0 is returned. On error, -1 is returned, and errno is set + * appropriately. + * + */ +int _sendfd(int sock, int fd, size_t len, const void *msg) { + struct iovec iov[1]; + struct msghdr msgh; + char buf[CMSG_SIZE]; + struct cmsghdr *h; + int ret; + + /* At least one byte needs to be sent, for some reason (?) */ + if(len < 1) + return 0; + + memset(&iov[0], 0, sizeof(struct iovec)); + memset(&msgh, 0, sizeof(struct msghdr)); + memset(buf, 0, CMSG_SIZE); + + msgh.msg_name = NULL; + msgh.msg_namelen = 0; + + msgh.msg_iov = iov; + msgh.msg_iovlen = 1; + + msgh.msg_control = buf; + msgh.msg_controllen = CMSG_SIZE; + msgh.msg_flags = 0; + + /* Message to be sent */ + iov[0].iov_base = (void *)msg; + iov[0].iov_len = len; + + /* Control data */ + h = CMSG_FIRSTHDR(&msgh); + h->cmsg_len = CMSG_LEN(sizeof(int)); + h->cmsg_level = SOL_SOCKET; + h->cmsg_type = SCM_RIGHTS; + ((int *)CMSG_DATA(h))[0] = fd; + + ret = sendmsg(sock, &msgh, 0); + return ret; +} +/* + * _recvfd(): receive a message and a file descriptor. + * + * Parameters: + * sock: AF_UNIX socket + * len: pointer to the length of the message buffer, modified on return + * buf: buffer to contain the received buffer + * + * If len is 0 or buf is NULL, the received message is stored in a temporary + * buffer and discarded later. + * + * Return value: + * On success, recvfd returns the received file descriptor, and len points to + * the size of the received message. + * If recvmsg fails, -1 is returned, and errno is set appropriately. + * If the received data does not carry exactly one file descriptor, -2 is + * returned. If the received file descriptor is not valid, -3 is returned. + * + */ +int _recvfd(int sock, size_t *len, void *buf) { + struct iovec iov[1]; + struct msghdr msgh; + char cmsgbuf[CMSG_SIZE]; + char extrabuf[4096]; + struct cmsghdr *h; + int st, fd; + + if(*len < 1 || buf == NULL) { + /* For some reason, again, one byte needs to be received. (it would not + * block?) */ + iov[0].iov_base = extrabuf; + iov[0].iov_len = sizeof(extrabuf); + } else { + iov[0].iov_base = buf; + iov[0].iov_len = *len; + } + + msgh.msg_name = NULL; + msgh.msg_namelen = 0; + + msgh.msg_iov = iov; + msgh.msg_iovlen = 1; + + msgh.msg_control = cmsgbuf; + msgh.msg_controllen = CMSG_SIZE; + msgh.msg_flags = 0; + + st = recvmsg(sock, &msgh, 0); + if(st < 0) + return -1; + + *len = st; + h = CMSG_FIRSTHDR(&msgh); + /* Check if we received what we expected */ + if(h == NULL + || h->cmsg_len != CMSG_LEN(sizeof(int)) + || h->cmsg_level != SOL_SOCKET + || h->cmsg_type != SCM_RIGHTS) { + return -2; + } + fd = ((int *)CMSG_DATA(h))[0]; + if(fd < 0) + return -3; + return fd; +} diff --git a/src/passfd.py b/src/passfd.py new file mode 100644 index 0000000..391e0fc --- /dev/null +++ b/src/passfd.py @@ -0,0 +1,125 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 +# vim: ts=4:sw=4:et:ai:sts=4 + +# passfd.py: Python library to pass file descriptors across UNIX domain sockets. +'''This simple extension provides two functions to pass and receive file +descriptors across UNIX domain sockets, using the BSD-4.3+ sendmsg() and +recvmsg() interfaces. + +Direct bindings to sendmsg and recvmsg are not provided, as the API does +not map nicely into Python. + +Please note that this only supports BSD-4.3+ style file descriptor +passing, and was only tested on Linux. Patches are welcomed! + +For more information, see one of the R. Stevens' books: + - Richard Stevens: Unix Network Programming, Prentice Hall, 1990; + chapter 6.10 + + - Richard Stevens: Advanced Programming in the UNIX Environment, + Addison-Wesley, 1993; chapter 15.3 +''' + +# +# Please note that this only supports BSD-4.3+ style file descriptor passing, +# and was only tested on Linux. Patches are welcomed! +# +# Copyright © 2010 Martín Ferrari +# +# Inspired by Socket::PassAccessRights, which is: +# Copyright (c) 2000 Sampo Kellomaki +# +# For more information, see one of the R. Stevens' books: +# - Richard Stevens: Unix Network Programming, Prentice Hall, 1990; +# chapter 6.10 +# +# - Richard Stevens: Advanced Programming in the UNIX Environment, +# Addison-Wesley, 1993; chapter 15.3 +# +# +# 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. +# + +import os, socket + +def __check_socket(sock): + if hasattr(sock, 'family') and sock.family != socket.AF_UNIX: + raise ValueError("Only AF_UNIX sockets are allowed") + + if hasattr(sock, 'fileno'): + sock = sock.fileno() + + if not isinstance(sock, int): + raise TypeError("An socket object or file descriptor was expected") + + return sock + +def __check_fd(fd): + try: + fd = fd.fileno() + except AttributeError: + pass + if not isinstance(fd, int): + raise TypeError("An file object or file descriptor was expected") + + return fd + +def sendfd(sock, fd, message = "NONE"): + """Sends a message and piggybacks a file descriptor through a Unix + domain socket. + + Note that the file descriptor cannot be sent by itself, at least + one byte of payload needs to be sent also. + + Parameters: + sock: socket object or file descriptor for an AF_UNIX socket + fd: file object or file descriptor to pass + message: message to send + + Return value: + On success, sendfd returns the number of bytes sent, not including + the file descriptor nor the control data. If there was no message + to send, 0 is returned.""" + + import _passfd + return _passfd.sendfd(__check_socket(sock), __check_fd(fd), message) + +def recvfd(sock, msg_buf = 4096): + """Receive a message and a file descriptor from a Unix domain socket. + + Parameters: + sock: file descriptor or socket object for an AF_UNIX socket + buffersize: maximum message size to receive + + Return value: + On success, recvfd returns a tuple containing the received + file descriptor and message. If recvmsg fails, an OSError exception + is raised. If the received data does not carry exactly one file + descriptor, or if the received file descriptor is not valid, + RuntimeError is raised.""" + + import _passfd + (ret, msg) = _passfd.recvfd(__check_socket(sock), msg_buf) + + # -1 should raise OSError + if ret == -2: + raise RuntimeError("The message received did not contain exactly one" + + " file descriptor") + if ret == -3: + raise RuntimeError("The received file descriptor is not valid") + assert ret >= 0 + + return (ret, msg) diff --git a/t/test_passfd.py b/t/test_passfd.py new file mode 100755 index 0000000..cdc2da9 --- /dev/null +++ b/t/test_passfd.py @@ -0,0 +1,150 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 +# vim: ts=4:sw=4:et:ai:sts=4 + +# Copyright © 2010 Martín Ferrari +# +# 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. +# + +import os, unittest, socket, sys, threading +from passfd import sendfd, recvfd +import _passfd + +class TestPassfd(unittest.TestCase): + def readfd_test(self, fd): + s = os.read(fd, 512) + self.assertEquals(s, "\0" * 512) + + def vrfy_recv(self, tuple, msg): + self.readfd_test(tuple[0]) + self.assertEquals(tuple[1], msg) + + def parent_tests(self, s, dgram = False): + # First message is not even sent + s.send("1") + self.vrfy_recv(recvfd(s), "a") + s.send("2") + self.vrfy_recv(recvfd(s), "\0") + s.send("3") + self.vrfy_recv(recvfd(s), "foobar") + s.send("4") + self.vrfy_recv(recvfd(s, msg_buf = 11), "long string") # is long + if not dgram: + self.assertEquals(s.recv(8), " is long") # re-sync + s.send("5") + self.assertEquals(s.recv(100), "foobar") + s.send("6") + self.assertRaises(RuntimeError, recvfd, s) # No fd received + # + s.send("7") + f, m = recvfd(s) + self.assertRaises(OSError, os.fdopen, f, "w") + s.send("8") + (f, msg) = recvfd(s) + self.assertEquals(msg, "writing") + os.write(f, "foo") + s.send("9") + + def child_tests(self, s, dgram = False): + f = file("/dev/zero") + assert sendfd(s, f, "") == 0 + s.recv(1) + assert sendfd(s, f, "a") == 1 + s.recv(1) + assert sendfd(s, f, "\0") == 1 + s.recv(1) + assert sendfd(s, f, "foobar") == 6 + s.recv(1) + assert sendfd(s, f, "long string is long") == 19 + # The other side will recv() instead of recvmsg(), this fd would be + # lost. I couldn't find any specification on this semantic + s.recv(1) + assert sendfd(s, f, "foobar") == 6 + s.recv(1) + assert s.send("barbaz") == 6 + # Try to write! + s.recv(1) + assert sendfd(s, f, "writing") == 7 + s.recv(1) + f = file("/dev/null", "w") + assert sendfd(s, f, "writing") == 7 + s.recv(1) + + def test_sanity_checks(self): + self.assertRaises(TypeError, recvfd, "foo") + s = socket.socket(socket.AF_INET) + self.assertRaises(ValueError, recvfd, s) + + (s0, s1) = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM, 0) + f = file("/dev/zero") + sendfd(s0, f) + recvfd(s1) + + # Using integers + sendfd(s0.fileno(), f.fileno()) + recvfd(s1.fileno()) + + self.assertRaises(TypeError, sendfd, s0, "foo") + # Assuming fd 255 is not valid + self.assertRaises(OSError, sendfd, s0, 255) + + def test_passfd_stream(self): + (s0, s1) = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM, 0) + pid = os.fork() + if pid == 0: + s0.close() + self.child_tests(s1) + s1.close() + os._exit(0) + + s1.close() + self.parent_tests(s0) + s0.close() + + self.assertEquals(os.waitpid(pid, 0)[1], 0) + + def test_passfd_dgram(self): + (s0, s1) = socket.socketpair(socket.AF_UNIX, socket.SOCK_DGRAM, 0) + pid = os.fork() + if pid == 0: + s0.close() + self.child_tests(s1, dgram = True) + s1.close() + os._exit(0) + + s1.close() + self.parent_tests(s0, dgram = True) + s0.close() + + self.assertEquals(os.waitpid(pid, 0)[1], 0) + + def test_threading(self): + # Check that the GIL is correctly released before blocking + (s0, s1) = socket.socketpair(socket.AF_UNIX, socket.SOCK_STREAM, 0) + + def run_server(s): + self.child_tests(s) + s.close() + + t = threading.Thread(target = run_server, args = (s1,)) + t.start() + self.parent_tests(s0) + s0.close() + t.join() + +if __name__ == '__main__': + unittest.main() +