2 * svc_unix.c, Server side for TCP/IP based RPC.
4 * Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 * This file is part of the GNU C Library.
7 * The GNU C Library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * The GNU C Library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with the GNU C Library; if not, see
19 * <http://www.gnu.org/licenses/>.
21 * Copyright (c) 2010, Oracle America, Inc.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions are
27 * * Redistributions of source code must retain the above copyright
28 * notice, this list of conditions and the following disclaimer.
29 * * Redistributions in binary form must reproduce the above
30 * copyright notice, this list of conditions and the following
31 * disclaimer in the documentation and/or other materials
32 * provided with the distribution.
33 * * Neither the name of the "Oracle America, Inc." nor the names of its
34 * contributors may be used to endorse or promote products derived
35 * from this software without specific prior written permission.
37 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
38 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
39 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
40 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
41 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
42 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
43 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
44 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
45 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
46 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
47 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
48 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
50 * Actually implements two flavors of transporter -
51 * a unix rendezvouser (a listener and connection establisher)
52 * and a record/unix stream.
60 #include <sys/socket.h>
69 * Ops vector for AF_UNIX based rpc service handle
71 static bool_t
svcunix_recv (SVCXPRT
*, struct rpc_msg
*);
72 static enum xprt_stat
svcunix_stat (SVCXPRT
*);
73 static bool_t
svcunix_getargs (SVCXPRT
*, xdrproc_t
, caddr_t
);
74 static bool_t
svcunix_reply (SVCXPRT
*, struct rpc_msg
*);
75 static bool_t
svcunix_freeargs (SVCXPRT
*, xdrproc_t
, caddr_t
);
76 static void svcunix_destroy (SVCXPRT
*);
78 static const struct xp_ops svcunix_op
=
89 * Ops vector for AF_UNIX rendezvous handler
91 static bool_t
rendezvous_request (SVCXPRT
*, struct rpc_msg
*);
92 static enum xprt_stat
rendezvous_stat (SVCXPRT
*);
93 static void svcunix_rendezvous_abort (void) __attribute__ ((__noreturn__
));
95 /* This function makes sure abort() relocation goes through PLT
96 and thus can be lazy bound. */
98 svcunix_rendezvous_abort (void)
103 static const struct xp_ops svcunix_rendezvous_op
=
107 (bool_t (*) (SVCXPRT
*, xdrproc_t
, caddr_t
)) svcunix_rendezvous_abort
,
108 (bool_t (*) (SVCXPRT
*, struct rpc_msg
*)) svcunix_rendezvous_abort
,
109 (bool_t (*) (SVCXPRT
*, xdrproc_t
, caddr_t
)) svcunix_rendezvous_abort
,
113 static int readunix (char*, char *, int);
114 static int writeunix (char *, char *, int);
115 static SVCXPRT
*makefd_xprt (int, u_int
, u_int
) internal_function
;
117 struct unix_rendezvous
{ /* kept in xprt->xp_p1 */
122 struct unix_conn
{ /* kept in xprt->xp_p1 */
123 enum xprt_stat strm_stat
;
126 char verf_body
[MAX_AUTH_BYTES
];
131 * xprt = svcunix_create(sock, send_buf_size, recv_buf_size);
133 * Creates, registers, and returns a (rpc) unix based transporter.
134 * Once *xprt is initialized, it is registered as a transporter
135 * see (svc.h, xprt_register). This routine returns
136 * a NULL if a problem occurred.
138 * If sock<0 then a socket is created, else sock is used.
139 * If the socket, sock is not bound to a port then svcunix_create
140 * binds it to an arbitrary port. The routine then starts a unix
141 * listener on the socket's associated port. In any (successful) case,
142 * xprt->xp_sock is the registered socket number and xprt->xp_port is the
143 * associated port number.
145 * Since unix streams do buffered io similar to stdio, the caller can specify
146 * how big the send and receive buffers are via the second and third parms;
147 * 0 => use the system default.
150 svcunix_create (int sock
, u_int sendsize
, u_int recvsize
, char *path
)
152 bool_t madesock
= FALSE
;
154 struct unix_rendezvous
*r
;
155 struct sockaddr_un addr
;
156 socklen_t len
= sizeof (struct sockaddr_in
);
158 if (sock
== RPC_ANYSOCK
)
160 if ((sock
= __socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
162 perror (_("svc_unix.c - AF_UNIX socket creation problem"));
163 return (SVCXPRT
*) NULL
;
167 memset (&addr
, '\0', sizeof (addr
));
168 addr
.sun_family
= AF_UNIX
;
169 len
= strlen (path
) + 1;
170 memcpy (addr
.sun_path
, path
, len
);
171 len
+= sizeof (addr
.sun_family
);
173 __bind (sock
, (struct sockaddr
*) &addr
, len
);
175 if (__getsockname (sock
, (struct sockaddr
*) &addr
, &len
) != 0
176 || __listen (sock
, SOMAXCONN
) != 0)
178 perror (_("svc_unix.c - cannot getsockname or listen"));
181 return (SVCXPRT
*) NULL
;
184 r
= (struct unix_rendezvous
*) mem_alloc (sizeof (*r
));
185 xprt
= (SVCXPRT
*) mem_alloc (sizeof (SVCXPRT
));
186 if (r
== NULL
|| xprt
== NULL
)
188 __fxprintf (NULL
, "%s: %s", __func__
, _("out of memory\n"));
189 mem_free (r
, sizeof (*r
));
190 mem_free (xprt
, sizeof (SVCXPRT
));
193 r
->sendsize
= sendsize
;
194 r
->recvsize
= recvsize
;
196 xprt
->xp_p1
= (caddr_t
) r
;
197 xprt
->xp_verf
= _null_auth
;
198 xprt
->xp_ops
= &svcunix_rendezvous_op
;
200 xprt
->xp_sock
= sock
;
201 xprt_register (xprt
);
204 libc_hidden_nolink_sunrpc (svcunix_create
, GLIBC_2_1
)
207 * Like svunix_create(), except the routine takes any *open* UNIX file
208 * descriptor as its first input.
211 svcunixfd_create (int fd
, u_int sendsize
, u_int recvsize
)
213 return makefd_xprt (fd
, sendsize
, recvsize
);
215 libc_hidden_nolink_sunrpc (svcunixfd_create
, GLIBC_2_1
)
219 makefd_xprt (int fd
, u_int sendsize
, u_int recvsize
)
222 struct unix_conn
*cd
;
224 xprt
= (SVCXPRT
*) mem_alloc (sizeof (SVCXPRT
));
225 cd
= (struct unix_conn
*) mem_alloc (sizeof (struct unix_conn
));
226 if (xprt
== (SVCXPRT
*) NULL
|| cd
== (struct unix_conn
*) NULL
)
228 (void) __fxprintf (NULL
, "%s: %s", "svc_unix: makefd_xprt",
229 _("out of memory\n"));
230 mem_free (xprt
, sizeof (SVCXPRT
));
231 mem_free (cd
, sizeof (struct unix_conn
));
234 cd
->strm_stat
= XPRT_IDLE
;
235 xdrrec_create (&(cd
->xdrs
), sendsize
, recvsize
,
236 (caddr_t
) xprt
, readunix
, writeunix
);
238 xprt
->xp_p1
= (caddr_t
) cd
;
239 xprt
->xp_verf
.oa_base
= cd
->verf_body
;
240 xprt
->xp_addrlen
= 0;
241 xprt
->xp_ops
= &svcunix_op
; /* truly deals with calls */
242 xprt
->xp_port
= 0; /* this is a connection, not a rendezvouser */
244 xprt_register (xprt
);
249 rendezvous_request (SVCXPRT
*xprt
, struct rpc_msg
*errmsg
)
252 struct unix_rendezvous
*r
;
253 struct sockaddr_un addr
;
254 struct sockaddr_in in_addr
;
257 r
= (struct unix_rendezvous
*) xprt
->xp_p1
;
259 len
= sizeof (struct sockaddr_un
);
260 if ((sock
= accept (xprt
->xp_sock
, (struct sockaddr
*) &addr
, &len
)) < 0)
264 __svc_accept_failed ();
268 * make a new transporter (re-uses xprt)
270 memset (&in_addr
, '\0', sizeof (in_addr
));
271 in_addr
.sin_family
= AF_UNIX
;
272 xprt
= makefd_xprt (sock
, r
->sendsize
, r
->recvsize
);
273 memcpy (&xprt
->xp_raddr
, &in_addr
, sizeof (in_addr
));
274 xprt
->xp_addrlen
= len
;
275 return FALSE
; /* there is never an rpc msg to be processed */
278 static enum xprt_stat
279 rendezvous_stat (SVCXPRT
*xprt
)
285 svcunix_destroy (SVCXPRT
*xprt
)
287 struct unix_conn
*cd
= (struct unix_conn
*) xprt
->xp_p1
;
289 xprt_unregister (xprt
);
290 __close (xprt
->xp_sock
);
291 if (xprt
->xp_port
!= 0)
293 /* a rendezvouser socket */
298 /* an actual connection socket */
299 XDR_DESTROY (&(cd
->xdrs
));
301 mem_free ((caddr_t
) cd
, sizeof (struct unix_conn
));
302 mem_free ((caddr_t
) xprt
, sizeof (SVCXPRT
));
305 #ifdef SCM_CREDENTIALS
309 /* hack to make sure we have enough memory */
310 char dummy
[(CMSG_ALIGN (sizeof (struct ucred
)) - sizeof (struct ucred
) + sizeof (long))];
313 /* XXX This is not thread safe, but since the main functions in svc.c
314 and the rpcgen generated *_svc functions for the daemon are also not
315 thread safe and uses static global variables, it doesn't matter. */
316 static struct cmessage cm
;
320 __msgread (int sock
, void *data
, size_t cnt
)
333 #ifdef SCM_CREDENTIALS
334 msg
.msg_control
= (caddr_t
) &cm
;
335 msg
.msg_controllen
= sizeof (struct cmessage
);
342 if (__setsockopt (sock
, SOL_SOCKET
, SO_PASSCRED
, &on
, sizeof (on
)))
348 len
= __recvmsg (sock
, &msg
, 0);
351 if (msg
.msg_flags
& MSG_CTRUNC
|| len
== 0)
362 __msgwrite (int sock
, void *data
, size_t cnt
)
364 #ifndef SCM_CREDENTIALS
365 /* We cannot implement this reliably. */
366 __set_errno (ENOSYS
);
371 struct cmsghdr
*cmsg
= &cm
.cmsg
;
375 /* XXX I'm not sure, if gete?id() is always correct, or if we should use
376 get?id(). But since keyserv needs geteuid(), we have no other chance.
377 It would be much better, if the kernel could pass both to the server. */
378 cred
.pid
= __getpid ();
379 cred
.uid
= __geteuid ();
380 cred
.gid
= __getegid ();
382 memcpy (CMSG_DATA(cmsg
), &cred
, sizeof (struct ucred
));
383 cmsg
->cmsg_level
= SOL_SOCKET
;
384 cmsg
->cmsg_type
= SCM_CREDENTIALS
;
385 cmsg
->cmsg_len
= sizeof(*cmsg
) + sizeof(struct ucred
);
394 msg
.msg_control
= cmsg
;
395 msg
.msg_controllen
= CMSG_ALIGN(cmsg
->cmsg_len
);
399 len
= __sendmsg (sock
, &msg
, 0);
410 * reads data from the unix connection.
411 * any error is fatal and the connection is closed.
412 * (And a read of zero bytes is a half closed stream => error.)
415 readunix (char *xprtptr
, char *buf
, int len
)
417 SVCXPRT
*xprt
= (SVCXPRT
*) xprtptr
;
418 int sock
= xprt
->xp_sock
;
419 int milliseconds
= 35 * 1000;
420 struct pollfd pollfd
;
425 pollfd
.events
= POLLIN
;
426 switch (__poll (&pollfd
, 1, milliseconds
))
435 if ((pollfd
.revents
& POLLERR
) || (pollfd
.revents
& POLLHUP
)
436 || (pollfd
.revents
& POLLNVAL
))
441 while ((pollfd
.revents
& POLLIN
) == 0);
443 if ((len
= __msgread (sock
, buf
, len
)) > 0)
447 ((struct unix_conn
*) (xprt
->xp_p1
))->strm_stat
= XPRT_DIED
;
452 * writes data to the unix connection.
453 * Any error is fatal and the connection is closed.
456 writeunix (char *xprtptr
, char * buf
, int len
)
458 SVCXPRT
*xprt
= (SVCXPRT
*) xprtptr
;
461 for (cnt
= len
; cnt
> 0; cnt
-= i
, buf
+= i
)
463 if ((i
= __msgwrite (xprt
->xp_sock
, buf
, cnt
)) < 0)
465 ((struct unix_conn
*) (xprt
->xp_p1
))->strm_stat
= XPRT_DIED
;
472 static enum xprt_stat
473 svcunix_stat (SVCXPRT
*xprt
)
475 struct unix_conn
*cd
=
476 (struct unix_conn
*) (xprt
->xp_p1
);
478 if (cd
->strm_stat
== XPRT_DIED
)
480 if (!xdrrec_eof (&(cd
->xdrs
)))
481 return XPRT_MOREREQS
;
486 svcunix_recv (SVCXPRT
*xprt
, struct rpc_msg
*msg
)
488 struct unix_conn
*cd
= (struct unix_conn
*) (xprt
->xp_p1
);
489 XDR
*xdrs
= &(cd
->xdrs
);
491 xdrs
->x_op
= XDR_DECODE
;
492 xdrrec_skiprecord (xdrs
);
493 if (xdr_callmsg (xdrs
, msg
))
495 cd
->x_id
= msg
->rm_xid
;
496 /* set up verifiers */
497 #ifdef SCM_CREDENTIALS
498 msg
->rm_call
.cb_verf
.oa_flavor
= AUTH_UNIX
;
499 msg
->rm_call
.cb_verf
.oa_base
= (caddr_t
) &cm
;
500 msg
->rm_call
.cb_verf
.oa_length
= sizeof (cm
);
504 cd
->strm_stat
= XPRT_DIED
; /* XXXX */
509 svcunix_getargs (SVCXPRT
*xprt
, xdrproc_t xdr_args
, caddr_t args_ptr
)
511 return (*xdr_args
) (&(((struct unix_conn
*) (xprt
->xp_p1
))->xdrs
),
516 svcunix_freeargs (SVCXPRT
*xprt
, xdrproc_t xdr_args
, caddr_t args_ptr
)
518 XDR
*xdrs
= &(((struct unix_conn
*) (xprt
->xp_p1
))->xdrs
);
520 xdrs
->x_op
= XDR_FREE
;
521 return (*xdr_args
) (xdrs
, args_ptr
);
525 svcunix_reply (SVCXPRT
*xprt
, struct rpc_msg
*msg
)
527 struct unix_conn
*cd
= (struct unix_conn
*) (xprt
->xp_p1
);
528 XDR
*xdrs
= &(cd
->xdrs
);
531 xdrs
->x_op
= XDR_ENCODE
;
532 msg
->rm_xid
= cd
->x_id
;
533 stat
= xdr_replymsg (xdrs
, msg
);
534 (void) xdrrec_endofrecord (xdrs
, TRUE
);