summaryrefslogtreecommitdiffstats
path: root/man3/getgrouplist.3
blob: 604fd84e1c8b056a6833c2253e944e4848fb3ebf (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.\" Distributed under GPL
.\" Thanks to glibc info pages
.\"
.\" Modified 2003-11-18, aeb: glibc is broken
.TH GETGROUPLIST 2 2003-11-18 "GNU" "Linux Programmer's Manual"
.SH NAME
getgrouplist \-  list of groups a user belongs to
.SH SYNOPSIS
.sp 
.B #include <grp.h>
.sp
.BI "int getgrouplist (const char *" user ", gid_t " group ,
.in 25
.BI "gid_t *" groups ", int *" ngroups );
.SH DESCRIPTION
The 
.B getgrouplist()
function scans the group database for all the groups
.I user
belongs to.  Up to
.RI * ngroups
group IDs corresponding to these groups are stored in the array
.IR groups ;
the return value from the function is the number of group IDs
actually stored. The group
.I group
is automatically included in the list of groups returned by 
.BR getgroup\%list() .
.SH "RETURN VALUE"
If
.RI * ngroups 
is smaller than the total number of groups found, then
.B getgrouplist()
returns a value of `-1'.
In all cases the actual number of groups is stored in
.RI * ngroups .
.SH BUGS
The glibc 2.3.2 implementation of this function is broken:
it overwrites memory when the actual number of groups is larger than
.RI * ngroups .
.SH "CONFORMING TO"
This function is present since glibc 2.2.4.
.SH EXAMPLE
.nf
/* This crashes with glibc 2.3.2 */
#include <stdio.h>
#include <stdlib.h>
#include <grp.h>
#include <pwd.h>

int main() {
        int i, ng = 0;
        char *user = "who";	/* username here */
        gid_t *groups = NULL;
        struct passwd *pw = getpwnam(user);
        if (pw == NULL)
                return 0;

        if (getgrouplist(user, pw->pw_gid, NULL, &ng) < 0) {
                groups = (gid_t *) malloc(ng * sizeof (gid_t));
                getgrouplist(user, pw->pw_gid, groups, &ng);
        }

        for(i = 0; i < ng; i++)
                printf("%d\en", groups[i]);

        return 0;
}
.fi
.SH "SEE ALSO"
.BR getgroups (3),
.BR setgroups (3)