d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a892767bc4
freebsd-nq/lib/libc/gen/getpeereid.3

136 lines
3.3 KiB
Groff
Raw Normal View History

Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
.\"
.\" Copyright (c) 2001 Dima Dorfman.
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 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.
.\"
.\" $FreeBSD$
.\"
.Dd July 15, 2001
.Dt GETPEEREID 3
.Os
.Sh NAME
.Nm getpeereid
.Nd get the effective credentials of a UNIX-domain peer
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
Use .In, .Ux, and .Rv where appropriate. Also consistently call this a "function" instead of a "routine". Submitted by: ru
2001-08-21 19:32:47 +00:00
.In sys/types.h
.In unistd.h
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
.Ft int
.Fn getpeereid "int s" "uid_t *euid" "gid_t *egid"
.Sh DESCRIPTION
The
.Fn getpeereid
Use .In, .Ux, and .Rv where appropriate. Also consistently call this a "function" instead of a "routine". Submitted by: ru
2001-08-21 19:32:47 +00:00
function returns the effective user and group IDs of the
peer connected to a
.Ux Ns -domain
socket.
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
The argument
.Fa s
Use .In, .Ux, and .Rv where appropriate. Also consistently call this a "function" instead of a "routine". Submitted by: ru
2001-08-21 19:32:47 +00:00
must be a
.Ux Ns -domain
socket
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
.Pq Xr unix 4
of type
.Dv SOCK_STREAM
on which either
.Xr connect 2
or
.Xr listen 2
have been called.
The effective used ID is placed in
.Fa euid ,
and the effective group ID in
.Fa egid .
.Pp
The credentials returned to the
.Xr listen 2
caller are those of its peer at the time it called
.Xr connect 2 ;
the credentials returned to the
.Xr connect 2
caller are those of its peer at the time it called
.Xr listen 2 .
This mechanism is reliable; there is no way for either side to influence
the credentials returned to its peer except by calling the appropriate
system call (i.e., either
.Xr connect 2
or
.Xr listen 2 )
under different effective credentials.
.Pp
Use .In, .Ux, and .Rv where appropriate. Also consistently call this a "function" instead of a "routine". Submitted by: ru
2001-08-21 19:32:47 +00:00
One common use of this routine is for a
.Ux Ns -domain
server
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
to verify the credentials of its client.
Likewise, the client can verify the credentials of the server.
.Sh IMPLEMENTATION NOTES
On
.Fx ,
.Fn getpeereid
is implemented in terms of the
.Dv LOCAL_PEERCRED
.Xr unix 4
socket option.
.Sh RETURN VALUES
Fix typos getpeerid -> getpeereid. PR: docs/32442 Reviewed by: dd
2001-12-02 23:50:40 +00:00
.Rv -std getpeereid
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
.Sh ERRORS
Fix typos getpeerid -> getpeereid. PR: docs/32442 Reviewed by: dd
2001-12-02 23:50:40 +00:00
.Fn getpeereid
Use .In, .Ux, and .Rv where appropriate. Also consistently call this a "function" instead of a "routine". Submitted by: ru
2001-08-21 19:32:47 +00:00
fails if:
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
.Bl -tag -width Er
.It Bq Er EBADF
The argument
.Fa s
is not a valid descriptor.
.It Bq Er ENOTSOCK
The argument
.Fa s
is a file, not a socket.
.It Bq Er ENOTCONN
The argument
.Fa s
does not refer to a socket on which
.Xr connect 2
or
.Xr listen 2
have been called.
.It Bq Er EINVAL
The argument
.Fa s
does not refer to a socket of type
Introduce a version field to `struct xucred' in place of one of the spares (the size of the field was changed from u_short to u_int to reflect what it really ends up being). Accordingly, change users of xucred to set and check this field as appropriate. In the kernel, this is being done inside the new cru2x() routine which takes a `struct ucred' and fills out a `struct xucred' according to the former. This also has the pleasant sideaffect of removing some duplicate code. Reviewed by: rwatson
2002-02-27 04:45:37 +00:00
.Dv SOCK_STREAM ,
or the kernel returned invalid data.
Implement getpeereid(3), a front-end to the LOCAL_PEERCRED socket option for the Unix domain. It's weaker than the socket option (this only returns the uid and gid, while the socket opt. can return the entire group list), and is implemented mostly for compatibility with OpenBSD.
2001-08-17 22:09:15 +00:00
.El
.Sh SEE ALSO
.Xr connect 2 ,
.Xr getpeername 2 ,
.Xr getsockname 2 ,
.Xr getsockopt 2 ,
.Xr listen 2 ,
.Xr unix 4
.Sh HISTORY
The
.Fn getpeereid
Use .In, .Ux, and .Rv where appropriate. Also consistently call this a "function" instead of a "routine". Submitted by: ru
2001-08-21 19:32:47 +00:00
function appeared in
This API will appear in FreeBSD 4.6.
2002-03-09 05:19:21 +00:00
.Fx 4.6 .
Reference in New Issue Copy Permalink