diff options
| -rw-r--r-- | ChangeLog | 6 | ||||
| -rw-r--r-- | ext/socket/ancdata.c | 80 | ||||
| -rw-r--r-- | test/socket/test_unix.rb | 6 |
3 files changed, 72 insertions, 20 deletions
@@ -1,3 +1,9 @@ +Fri Feb 27 22:30:18 2009 Tanaka Akira <akr@fsij.org> + + * ext/socket/ancdata.c (bsock_recvmsg_internal): close FDs passed by + SCM_RIGHTS unless :scm_rights=>true is given. + (discard_cmsg): extracted from rsock_discard_cmsg_resource. + Fri Feb 27 22:14:22 2009 Tanaka Akira <akr@fsij.org> * ext/openssl/lib/openssl/buffering.rb: define Buffering module under diff --git a/ext/socket/ancdata.c b/ext/socket/ancdata.c index e943619a39..204f745314 100644 --- a/ext/socket/ancdata.c +++ b/ext/socket/ancdata.c @@ -223,20 +223,32 @@ ancillary_s_unix_rights(int argc, VALUE *argv, VALUE klass) /* * call-seq: - * ancillarydata.unix_rights => array-of-IOs + * ancillarydata.unix_rights => array-of-IOs or nil * - * returns the array of IOs which is sent by SCM_RIGHTS control message in UNIX domain socket. + * returns the array of IO objects for SCM_RIGHTS control message in UNIX domain socket. * - * The class of an IO in the array is IO or Socket. + * The class of the IO objects in the array is IO or Socket. * + * The array is attached to _ancillarydata_ when it is instantiated. + * For example, BasicSocket#recvmsg attach the array when + * receives a SCM_RIGHTS control message and :scm_rights=>true option is given. + * + * # recvmsg needs :scm_rights=>true for unix_rights * s1, s2 = UNIXSocket.pair * p s1 #=> #<UNIXSocket:fd 3> * s1.sendmsg "stdin and a socket", 0, nil, [:SOCKET, :RIGHTS, [0,s1.fileno].pack("ii")] - * _, _, _, ctl = s2.recvmsg + * _, _, _, ctl = s2.recvmsg(:scm_rights=>true) * p ctl.unix_rights #=> [#<IO:fd 6>, #<Socket:fd 7>] * p File.identical?(STDIN, ctl.unix_rights[0]) #=> true * p File.identical?(s1, ctl.unix_rights[1]) #=> true * + * # If :scm_rights=>true is not given, unix_rights returns nil + * s1, s2 = UNIXSocket.pair + * s1.sendmsg "stdin and a socket", 0, nil, [:SOCKET, :RIGHTS, [0,s1.fileno].pack("ii")] + * _, _, _, ctl = s2.recvmsg + * p ctl #=> #<Socket::AncillaryData: UNIX SOCKET RIGHTS 6 7> + * p ctl.unix_rights #=> nil + * */ static VALUE ancillary_unix_rights(VALUE self) @@ -1354,23 +1366,33 @@ rb_recvmsg(int fd, struct msghdr *msg, int flags) } #if defined(HAVE_ST_MSG_CONTROL) +static void +discard_cmsg(struct cmsghdr *cmh, char *msg_end) +{ + if (cmh->cmsg_level == SOL_SOCKET && cmh->cmsg_type == SCM_RIGHTS) { + int *fdp = (int *)CMSG_DATA(cmh); + int *end = (int *)((char *)cmh + cmh->cmsg_len); + while ((char *)fdp + sizeof(int) <= (char *)end && + (char *)fdp + sizeof(int) <= msg_end) { + close(*fdp); + fdp++; + } + } +} + void rsock_discard_cmsg_resource(struct msghdr *mh) { struct cmsghdr *cmh; + char *msg_end; if (mh->msg_controllen == 0) return; + msg_end = (char *)mh->msg_control + mh->msg_controllen; + for (cmh = CMSG_FIRSTHDR(mh); cmh != NULL; cmh = CMSG_NXTHDR(mh, cmh)) { - if (cmh->cmsg_level == SOL_SOCKET && cmh->cmsg_type == SCM_RIGHTS) { - int *fdp = (int *)CMSG_DATA(cmh); - int *end = (int *)((char *)cmh + cmh->cmsg_len); - while (fdp < end) { - close(*fdp); - fdp++; - } - } + discard_cmsg(cmh, msg_end); } } #endif @@ -1409,10 +1431,11 @@ static VALUE bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) { rb_io_t *fptr; - VALUE vmaxdatlen, vmaxctllen, vflags; + VALUE vmaxdatlen, vmaxctllen, vflags, vopts; int grow_buffer; size_t maxdatlen; int flags, orig_flags; + int request_scm_rights; struct msghdr mh; struct iovec iov; struct sockaddr_storage namebuf; @@ -1435,6 +1458,10 @@ bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) rb_secure(4); + vopts = Qnil; + if (0 < argc && TYPE(argv[argc-1]) == T_HASH) + vopts = argv[--argc]; + rb_scan_args(argc, argv, "03", &vmaxdatlen, &vflags, &vmaxctllen); maxdatlen = NIL_P(vmaxdatlen) ? sizeof(datbuf0) : NUM2SIZET(vmaxdatlen); @@ -1453,6 +1480,10 @@ bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) grow_buffer = NIL_P(vmaxdatlen) || NIL_P(vmaxctllen); + request_scm_rights = 0; + if (!NIL_P(vopts) && RTEST(rb_hash_aref(vopts, ID2SYM(rb_intern("scm_rights"))))) + request_scm_rights = 1; + GetOpenFile(sock, fptr); if (rb_io_read_pending(fptr)) { rb_raise(rb_eIOError, "recvmsg for buffered IO"); @@ -1623,7 +1654,10 @@ bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) ctl_end = (char*)cmh + cmh->cmsg_len; clen = (ctl_end <= msg_end ? ctl_end : msg_end) - (char*)CMSG_DATA(cmh); ctl = ancdata_new(family, cmh->cmsg_level, cmh->cmsg_type, rb_tainted_str_new((char*)CMSG_DATA(cmh), clen)); - make_io_for_unix_rights(ctl, cmh, msg_end); + if (request_scm_rights) + make_io_for_unix_rights(ctl, cmh, msg_end); + else + discard_cmsg(cmh, msg_end); rb_ary_push(ret, ctl); } } @@ -1641,7 +1675,7 @@ bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) /* * call-seq: - * basicsocket.recvmsg(maxmesglen=nil, flags=0, maxcontrollen=nil) => [mesg, sender_addrinfo, rflags, *controls] + * basicsocket.recvmsg(maxmesglen=nil, flags=0, maxcontrollen=nil, opts={}) => [mesg, sender_addrinfo, rflags, *controls] * * recvmsg receives a message using recvmsg(2) system call in blocking manner. * @@ -1651,6 +1685,18 @@ bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) * * _maxcontrolslen_ is the maximum length of controls (ancillary data) to receive. * + * _opts_ is option hash. + * Currently :scm_rights=>bool is the only option. + * + * :scm_rights option specifies that application expects SCM_RIGHTS control message. + * If the value is nil or false, application don't expects SCM_RIGHTS control message. + * In this case, recvmsg closes the passed file descriptors immediately. + * This is the default behavior. + * + * If :scm_rights value is neigher nil nor false, application expects SCM_RIGHTS control message. + * In this case, recvmsg creates IO objects for each file descriptors for + * Socket::AncillaryData#unix_rights method. + * * The return value is 4-elements array. * * _mesg_ is a string of the received message. @@ -1672,7 +1718,7 @@ bsock_recvmsg_internal(int argc, VALUE *argv, VALUE sock, int nonblock) * * recvmsg can be used to implement recv_io as follows: * - * mesg, sender_sockaddr, rflags, *controls = sock.recvmsg + * mesg, sender_sockaddr, rflags, *controls = sock.recvmsg(:scm_rights=>true) * controls.each {|ancdata| * if ancdata.cmsg_is?(:SOCKET, :RIGHTS) * return ancdata.unix_rights[0] @@ -1688,7 +1734,7 @@ bsock_recvmsg(int argc, VALUE *argv, VALUE sock) /* * call-seq: - * basicsocket.recvmsg_nonblock(maxdatalen=nil, flags=0, maxcontrollen=nil) => [data, sender_addrinfo, rflags, *controls] + * basicsocket.recvmsg_nonblock(maxdatalen=nil, flags=0, maxcontrollen=nil, opts={}) => [data, sender_addrinfo, rflags, *controls] * * recvmsg receives a message using recvmsg(2) system call in non-blocking manner. * diff --git a/test/socket/test_unix.rb b/test/socket/test_unix.rb index 1e9073dd0a..e75d7b6f9a 100644 --- a/test/socket/test_unix.rb +++ b/test/socket/test_unix.rb @@ -48,7 +48,7 @@ class TestSocket_UNIXSocket < Test::Unit::TestCase return end assert_equal(1, ret) - ret = s2.recvmsg + ret = s2.recvmsg(:scm_rights=>true) data, srcaddr, flags, *ctls = ret recv_io_ary = [] ctls.each {|ctl| @@ -83,7 +83,7 @@ class TestSocket_UNIXSocket < Test::Unit::TestCase return end assert_equal(1, ret) - ret = s2.recvmsg + ret = s2.recvmsg(:scm_rights=>true) data, srcaddr, flags, *ctls = ret recv_io_ary = [] ctls.each {|ctl| @@ -170,7 +170,7 @@ class TestSocket_UNIXSocket < Test::Unit::TestCase IO.pipe {|r1, w| UNIXSocket.pair {|s1, s2| s1.send_io(r1) - ret = s2.recvmsg + ret = s2.recvmsg(:scm_rights=>true) data, srcaddr, flags, *ctls = ret assert_equal("\0", data) if flags == nil |