diff options
Diffstat (limited to 'man/pwcache.3bsd')
-rw-r--r-- | man/pwcache.3bsd | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/man/pwcache.3bsd b/man/pwcache.3bsd new file mode 100644 index 0000000..dac9bcd --- /dev/null +++ b/man/pwcache.3bsd @@ -0,0 +1,143 @@ +.\" $OpenBSD: pwcache.3,v 1.15 2018/09/13 16:50:54 jmc Exp $ +.\" +.\" Copyright (c) 1989, 1991, 1993 +.\" The Regents of the University of California. 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. +.\" 3. 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. +.\" +.Dd $Mdocdate: September 13 2018 $ +.Dt USER_FROM_UID 3 +.Os +.Sh NAME +.Nm user_from_uid , +.Nm uid_from_user , +.Nm group_from_gid , +.Nm gid_from_group +.Nd cache password and group entries +.Sh LIBRARY +.ds str-Lb-libbsd Utility functions from BSD systems (libbsd, \-lbsd) +.ds doc-str-Lb-libbsd \*[str-Lb-libbsd] +.Lb libbsd +.Sh SYNOPSIS +.In pwd.h +(See +.Xr libbsd 7 +for include usage.) +.Ft int +.Fn uid_from_user "const char *name" "uid_t *uid" +.Ft const char * +.Fn user_from_uid "uid_t uid" "int nouser" +.In grp.h +.Ft int +.Fn gid_from_group "const char *name" "gid_t *gid" +.Ft const char * +.Fn group_from_gid "gid_t gid" "int nogroup" +.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 +.Fa uid , +unless the argument +.Fa nouser +is non-zero, in which case a null pointer is returned. +.Pp +The +.Fn uid_from_user +function returns the user ID associated with the argument +.Fa name . +The user ID is cached so that multiple calls with the same +.Fa name +do not require additional calls to +.Xr getpwnam 3 . +If there is no user ID associated with the +.Fa name , +the +.Fn uid_from_user +function returns -1; +otherwise it stores the user ID at the location pointed to by +.Fa uid +and returns 0. +.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 +.Fa gid , +unless the argument +.Fa nogroup +is non-zero, in which case a null pointer is returned. +.Pp +The +.Fn gid_from_group +function returns the group ID associated with the argument +.Fa name . +The group ID is cached so that multiple calls with the same +.Fa name +do not require additional calls to +.Xr getgrnam 3 . +If there is no group ID associated with the +.Fa name , +the +.Fn gid_from_group +function returns -1; +otherwise it stores the group ID at the location pointed to by +.Fa gid +and returns 0. +.Sh SEE ALSO +.Xr getgrgid 3 , +.Xr getpwuid 3 +.Sh HISTORY +The +.Fn user_from_uid +and +.Fn group_from_gid +functions first appeared in +.Bx 4.4 . +.Pp +The +.Fn uid_from_user +and +.Fn gid_from_group +functions were ported from +.Nx +and first appeared in +.Ox 6.4 . |