1.\" $OpenBSD: getgrouplist.3,v 1.17 2013/06/05 03:39:22 tedu 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: June 5 2013 $ 31.Dt GETGROUPLIST 3 32.Os 33.Sh NAME 34.Nm getgrouplist 35.Nd calculate group access list 36.Sh SYNOPSIS 37.In 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 44.Xr group 5 45file and calculates the group access list for the user specified in 46.Fa name . 47The 48.Fa basegid 49is automatically included in the groups list. 50Typically this value is given as 51the group number from the password file. 52.Pp 53If YP is active and the group file contains no exclusions, the 54.Xr netid 5 55file and the 56.Pa netid.byname 57YP map will be used in addition to the group file. 58If the group file contains at least one exclusion, the 59.Pa group.byname 60YP map will be used in addition to the group file. 61.Pp 62The resulting group list is returned in the integer array pointed to by 63.Fa groups . 64The caller specifies the size of the 65.Fa groups 66array in the integer pointed to by 67.Fa ngroups ; 68the actual number of groups found is returned in 69.Fa ngroups . 70.Sh RETURN VALUES 71The 72.Fn getgrouplist 73function returns 0 if successful and \-1 if the size of the group list is 74too small to hold all the user's groups. 75Here, the group array will be filled with as many groups as will fit. 76.Sh FILES 77.Bl -tag -width /etc/group -compact 78.It Pa /etc/group 79group database file 80.It Pa /etc/netid 81static group lists to override YP data 82.El 83.Sh SEE ALSO 84.Xr setgroups 2 , 85.Xr initgroups 3 , 86.Xr yp_match 3 , 87.Xr group 5 , 88.Xr netid 5 , 89.Xr yp 8 90.Sh HISTORY 91The 92.Fn getgrouplist 93function first appeared in 94.Bx 4.4 . 95.Sh BUGS 96The 97.Fn getgrouplist 98function uses the routines based on 99.Xr getgrent 3 . 100If the invoking program uses any of these routines, 101the group structure will be overwritten in the call to 102.Fn getgrouplist . 103