cc7cdc5297368231d1f020902843b04c63e188c2
[tprouty/samba.git] / source / nsswitch / winbindd.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Winbind daemon for ntdom nss module
5
6    Copyright (C) Tim Potter 2000
7    
8    This library is free software; you can redistribute it and/or
9    modify it under the terms of the GNU Library General Public
10    License as published by the Free Software Foundation; either
11    version 2 of the License, or (at your option) any later version.
12    
13    This library is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    Library General Public License for more details.
17    
18    You should have received a copy of the GNU Library General Public
19    License along with this library; if not, write to the
20    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21    Boston, MA  02111-1307, USA.   
22 */
23
24 #ifndef _WINBINDD_H
25 #define _WINBINDD_H
26
27 #include "includes.h"
28 #include "nterr.h"
29
30 #include "winbindd_nss.h"
31
32 #undef DBGC_CLASS
33 #define DBGC_CLASS DBGC_WINBIND
34
35 /* Client state structure */
36
37 struct winbindd_cli_state {
38         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
39         int sock;                                 /* Open socket from client */
40         pid_t pid;                                /* pid of client */
41         int read_buf_len, write_buf_len;          /* Indexes in request/response */
42         BOOL finished;                            /* Can delete from list */
43         BOOL write_extra_data;                    /* Write extra_data field */
44         time_t last_access;                       /* Time of last access (read or write) */
45         struct winbindd_request request;          /* Request from client */
46         struct winbindd_response response;        /* Respose to client */
47         struct getent_state *getpwent_state;      /* State for getpwent() */
48         struct getent_state *getgrent_state;      /* State for getgrent() */
49 };
50
51 /* State between get{pw,gr}ent() calls */
52
53 struct getent_state {
54         struct getent_state *prev, *next;
55         void *sam_entries;
56         uint32 sam_entry_index, num_sam_entries;
57         BOOL got_sam_entries;
58         fstring domain_name;
59 };
60
61 /* Storage for cached getpwent() user entries */
62
63 struct getpwent_user {
64         fstring name;                        /* Account name */
65         fstring gecos;                       /* User information */
66         uint32 user_rid, group_rid;          /* NT user and group rids */
67 };
68
69 /* Server state structure */
70
71 struct winbindd_state {
72
73         /* User and group id pool */
74
75         uid_t uid_low, uid_high;               /* Range of uids to allocate */
76         gid_t gid_low, gid_high;               /* Range of gids to allocate */
77 };
78
79 extern struct winbindd_state server_state;  /* Server information */
80
81 typedef struct {
82         char *acct_name;
83         char *full_name;
84         uint32 user_rid;
85         uint32 group_rid; /* primary group */
86 } WINBIND_USERINFO;
87
88 /* Structures to hold per domain information */
89
90 struct winbindd_domain {
91         fstring name;                          /* Domain name */        
92         fstring alt_name;                      /* alt Domain name (if any) */
93         DOM_SID sid;                           /* SID for this domain */
94         BOOL native_mode;                      /* is this a win2k domain in native mode ? */
95
96         /* Lookup methods for this domain (LDAP or RPC) */
97
98         struct winbindd_methods *methods;
99
100         /* Private data for the backends (used for connection cache) */
101
102         void *private; 
103
104         /* Sequence number stuff */
105
106         time_t last_seq_check;
107         uint32 sequence_number;
108
109         /* Linked list info */
110
111         struct winbindd_domain *prev, *next;
112 };
113
114 /* per-domain methods. This is how LDAP vs RPC is selected
115  */
116 struct winbindd_methods {
117         /* does this backend provide a consistent view of the data? (ie. is the primary group
118            always correct) */
119         BOOL consistent;
120
121         /* get a list of users, returning a WINBIND_USERINFO for each one */
122         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
123                                    TALLOC_CTX *mem_ctx,
124                                    uint32 *num_entries, 
125                                    WINBIND_USERINFO **info);
126
127         /* get a list of domain groups */
128         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
129                                     TALLOC_CTX *mem_ctx,
130                                     uint32 *num_entries, 
131                                     struct acct_info **info);
132
133         /* get a list of domain local groups */
134         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
135                                     TALLOC_CTX *mem_ctx,
136                                     uint32 *num_entries, 
137                                     struct acct_info **info);
138                                     
139         /* convert one user or group name to a sid */
140         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
141                                 const char *name,
142                                 DOM_SID *sid,
143                                 enum SID_NAME_USE *type);
144
145         /* convert a sid to a user or group name */
146         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
147                                 TALLOC_CTX *mem_ctx,
148                                 DOM_SID *sid,
149                                 char **name,
150                                 enum SID_NAME_USE *type);
151
152         /* lookup user info for a given rid */
153         NTSTATUS (*query_user)(struct winbindd_domain *domain, 
154                                TALLOC_CTX *mem_ctx, 
155                                uint32 user_rid, 
156                                WINBIND_USERINFO *user_info);
157
158         /* lookup all groups that a user is a member of. The backend
159            can also choose to lookup by username or rid for this
160            function */
161         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
162                                       TALLOC_CTX *mem_ctx,
163                                       uint32 user_rid, 
164                                       uint32 *num_groups, uint32 **user_gids);
165
166         /* find all members of the group with the specified group_rid */
167         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
168                                     TALLOC_CTX *mem_ctx,
169                                     uint32 group_rid, uint32 *num_names, 
170                                     uint32 **rid_mem, char ***names, 
171                                     uint32 **name_types);
172
173         /* return the current global sequence number */
174         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
175
176         /* enumerate trusted domains */
177         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
178                                     TALLOC_CTX *mem_ctx,
179                                     uint32 *num_domains,
180                                     char ***names,
181                                     char ***alt_names,
182                                     DOM_SID **dom_sids);
183
184         /* find the domain sid */
185         NTSTATUS (*domain_sid)(struct winbindd_domain *domain,
186                                DOM_SID *sid);
187
188         /* setup the list of alternate names for the domain, if any */
189         NTSTATUS (*alternate_name)(struct winbindd_domain *domain);
190 };
191
192 /* Used to glue a policy handle and cli_state together */
193
194 typedef struct {
195         struct cli_state *cli;
196         POLICY_HND pol;
197 } CLI_POLICY_HND;
198
199 #include "winbindd_proto.h"
200
201 #include "rpc_parse.h"
202 #include "rpc_client.h"
203
204 #define WINBINDD_ESTABLISH_LOOP 30
205 #define WINBINDD_RESCAN_FREQ 300
206
207 #define DOM_SEQUENCE_NONE ((uint32)-1)
208
209 #endif /* _WINBINDD_H */