NetBSD/lib/libc/gen/pwcache.3

146 lines
4.2 KiB
Groff
Raw Normal View History

.\" $NetBSD: pwcache.3,v 1.9 1998/07/28 17:09:10 mycroft Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
.\"
.\" 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 acknowledgement:
.\" This product includes software developed by the University of
.\" California, Berkeley and its contributors.
.\" 4. Neither the name of the University 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 REGENTS 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 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.
.\"
.\" @(#)pwcache.3 8.1 (Berkeley) 6/9/93
1993-03-21 12:45:37 +03:00
.\"
.Dd July 28, 1998
1993-03-21 12:45:37 +03:00
.Dt PWCACHE 3
.Os
.Sh NAME
.Nm pwcache ,
.Nm user_from_uid ,
.Nm group_from_gid
1993-03-21 12:45:37 +03:00
.Nd cache password and group entries
1998-02-05 21:45:17 +03:00
.Sh LIBRARY
.Lb libc
1993-03-21 12:45:37 +03:00
.Sh SYNOPSIS
.Fd #include <pwd.h>
.Ft const char *
1993-03-21 12:45:37 +03:00
.Fn user_from_uid "uid_t uid" "int nouser"
.Ft int
.Fn uid_from_user "const char *name" "uid_t *uid"
.Fd #include <grp.h>
.Ft const char *
1993-03-21 12:45:37 +03:00
.Fn group_from_gid "gid_t gid" "int nogroup"
.Ft int
.Fn gid_from_group "const char *name" "gid_t *gid"
1993-03-21 12:45:37 +03:00
.Sh DESCRIPTION
The
.Fn user_from_uid
function returns the user name associated with the argument
.Fa uid .
The user name is cached so that multiple calls with the same
.Fa uid
do not require additional calls to
.Xr getpwuid 3 .
If there is no user associated with the
.Fa uid ,
a pointer is returned
to a string representation of the
1993-03-21 12:45:37 +03:00
.Fa uid ,
unless the argument
.Fa nouser
is non-zero, in which case a
.Dv NULL
pointer is returned.
.Pp
The
.Fn group_from_gid
function returns the group name associated with the argument
.Fa gid .
The group name is cached so that multiple calls with the same
.Fa gid
do not require additional calls to
.Xr getgrgid 3 .
If there is no group associated with the
.Fa gid ,
a pointer is returned
to a string representation of the
1993-03-21 12:45:37 +03:00
.Fa gid ,
unless the argument
.Fa nogroup
is non-zero, in which case a
.Dv NULL
pointer is returned.
.Pp
The
.Fn uid_from_user
function returns the uid associated with the argument
.Fa name .
The uid is cached so that multiple calls with the same
.Fa name
do not require additional calls to
.Xr getpwnam 3 .
If there is no uid associated with the
.Fa name ,
the
.Fn uid_from_user
function returns -1; otherwise it stores the uid at the location pointed to by
.Fa uid
and returns 0.
.Pp
The
.Fn gid_from_group
function returns the gid associated with the argument
.Fa name .
The gid is cached so that multiple calls with the same
.Fa name
do not require additional calls to
.Xr getgrnam 3 .
If there is no gid associated with the
.Fa name ,
the
.Fn gid_from_group
function returns -1; otherwise it stores the gid at the location pointed to by
.Fa gid
and returns 0.
1993-03-21 12:45:37 +03:00
.Sh SEE ALSO
.Xr getgrgid 3 ,
.Xr getgrnam 3 ,
.Xr getpwnam 3 ,
1993-03-21 12:45:37 +03:00
.Xr getpwuid 3
.Sh HISTORY
The
1996-05-06 17:45:44 +04:00
.Fn user_from_uid
1993-03-21 12:45:37 +03:00
and
1996-05-06 17:45:44 +04:00
.Fn group_from_gid
1998-02-04 00:42:54 +03:00
functions first appeared in
.Bx 4.4 .
.Pp
The
.Fn uid_from_user
and
.Fn gid_from_group
functions first appeared in
.Nx 1.4 .