1.\" $OpenBSD: getgrouplist.3,v 1.14 2009/03/27 21:42:57 schwarze Exp $ 2.\" 3.\" Copyright (c) 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd $Mdocdate: March 27 2009 $ 31.Dt GETGROUPLIST 3 32.Os 33.Sh NAME 34.Nm getgrouplist 35.Nd calculate group access list 36.Sh SYNOPSIS 37.Fd #include <unistd.h> 38.Ft int 39.Fn getgrouplist "const char *name" "gid_t basegid" "gid_t *groups" "int *ngroups" 40.Sh DESCRIPTION 41The 42.Fn getgrouplist 43function reads through the group file and calculates 44the group access list for the user specified in 45.Fa name . 46The 47.Fa basegid 48is automatically included in the groups list. 49Typically this value is given as 50the group number from the password file. 51If YP is active, the 52.Xr netid 5 53file and the 54.Pa netid.byname 55YP map will be used in addition to the group file. 56.Pp 57The resulting group list is returned in the integer array pointed to by 58.Fa groups . 59The caller specifies the size of the 60.Fa groups 61array in the integer pointed to by 62.Fa ngroups ; 63the actual number of groups found is returned in 64.Fa ngroups . 65.Sh RETURN VALUES 66The 67.Fn getgrouplist 68function returns \-1 if the size of the group list is too small to 69hold all the user's groups. 70Here, the group array will be filled with as many groups as will fit. 71.Sh FILES 72.Bl -tag -width /etc/group -compact 73.It Pa /etc/group 74group database file 75.It Pa /etc/netid 76static group lists to override YP data 77.El 78.Sh SEE ALSO 79.Xr setgroups 2 , 80.Xr initgroups 3 , 81.Xr yp_match 3 , 82.Xr group 5 , 83.Xr netid 5 , 84.Xr yp 8 85.Sh HISTORY 86The 87.Fn getgrouplist 88function first appeared in 89.Bx 4.4 . 90.Sh BUGS 91The 92.Fn getgrouplist 93function uses the routines based on 94.Xr getgrent 3 . 95If the invoking program uses any of these routines, 96the group structure will be overwritten in the call to 97.Fn getgrouplist . 98