r23625: Reformating WBFLAGs, just a cosmetic change.
[sfrench/samba-autobuild/.git] / source / nsswitch / winbindd_nss.h
1 /* 
2    Unix SMB/CIFS implementation.
3
4    Winbind daemon for ntdom nss module
5
6    Copyright (C) Tim Potter 2000
7    Copyright (C) Gerald Carter 2006
8    
9    You are free to use this interface definition in any way you see
10    fit, including without restriction, using this header in your own
11    products. You do not need to give any attribution.  
12 */
13
14
15 #ifndef CONST_DISCARD
16 #define CONST_DISCARD(type, ptr)      ((type) ((void *) (ptr)))
17 #endif
18
19 #ifndef CONST_ADD
20 #define CONST_ADD(type, ptr)          ((type) ((const void *) (ptr)))
21 #endif
22
23 #ifndef SAFE_FREE
24 #define SAFE_FREE(x) do { if(x) {free(x); x=NULL;} } while(0)
25 #endif
26
27 #ifndef _WINBINDD_NTDOM_H
28 #define _WINBINDD_NTDOM_H
29
30 #define WINBINDD_SOCKET_NAME "pipe"            /* Name of PF_UNIX socket */
31
32 /* Let the build environment override the public winbindd socket location. This
33  * is needed for launchd support -- jpeach.
34  */
35 #ifndef WINBINDD_SOCKET_DIR
36 #define WINBINDD_SOCKET_DIR  "/tmp/.winbindd"  /* Name of PF_UNIX dir */
37 #endif
38
39 #define WINBINDD_PRIV_SOCKET_SUBDIR "winbindd_privileged" /* name of subdirectory of lp_lockdir() to hold the 'privileged' pipe */
40 #define WINBINDD_DOMAIN_ENV  "WINBINDD_DOMAIN" /* Environment variables */
41 #define WINBINDD_DONT_ENV    "_NO_WINBINDD"
42
43 /* Update this when you change the interface.  */
44
45 #define WINBIND_INTERFACE_VERSION 18
46
47 /* Have to deal with time_t being 4 or 8 bytes due to structure alignment.
48    On a 64bit Linux box, we have to support a constant structure size
49    between /lib/libnss_winbind.so.2 and /li64/libnss_winbind.so.2.
50    The easiest way to do this is to always use 8byte values for time_t. */
51
52 #if defined(int64)
53 #  define SMB_TIME_T int64
54 #else
55 #  define SMB_TIME_T time_t
56 #endif
57
58 /* Socket commands */
59
60 enum winbindd_cmd {
61
62         WINBINDD_INTERFACE_VERSION,    /* Always a well known value */
63
64         /* Get users and groups */
65
66         WINBINDD_GETPWNAM,
67         WINBINDD_GETPWUID,
68         WINBINDD_GETGRNAM,
69         WINBINDD_GETGRGID,
70         WINBINDD_GETGROUPS,
71
72         /* Enumerate users and groups */
73
74         WINBINDD_SETPWENT,
75         WINBINDD_ENDPWENT,
76         WINBINDD_GETPWENT,
77         WINBINDD_SETGRENT,
78         WINBINDD_ENDGRENT,
79         WINBINDD_GETGRENT,
80
81         /* PAM authenticate and password change */
82
83         WINBINDD_PAM_AUTH,
84         WINBINDD_PAM_AUTH_CRAP,
85         WINBINDD_PAM_CHAUTHTOK,
86         WINBINDD_PAM_LOGOFF,
87         WINBINDD_PAM_CHNG_PSWD_AUTH_CRAP,
88
89         /* List various things */
90
91         WINBINDD_LIST_USERS,         /* List w/o rid->id mapping */
92         WINBINDD_LIST_GROUPS,        /* Ditto */
93         WINBINDD_LIST_TRUSTDOM,
94
95         /* SID conversion */
96
97         WINBINDD_LOOKUPSID,
98         WINBINDD_LOOKUPNAME,
99         WINBINDD_LOOKUPRIDS,
100
101         /* Lookup functions */
102
103         WINBINDD_SID_TO_UID,       
104         WINBINDD_SID_TO_GID,
105         WINBINDD_SIDS_TO_XIDS,
106         WINBINDD_UID_TO_SID,
107         WINBINDD_GID_TO_SID,
108
109         WINBINDD_ALLOCATE_UID,
110         WINBINDD_ALLOCATE_GID,
111         WINBINDD_SET_MAPPING,
112         WINBINDD_SET_HWM,
113
114         /* Miscellaneous other stuff */
115
116         WINBINDD_DUMP_MAPS,
117
118         WINBINDD_CHECK_MACHACC,     /* Check machine account pw works */
119         WINBINDD_PING,              /* Just tell me winbind is running */
120         WINBINDD_INFO,              /* Various bit of info.  Currently just tidbits */
121         WINBINDD_DOMAIN_NAME,       /* The domain this winbind server is a member of (lp_workgroup()) */
122
123         WINBINDD_DOMAIN_INFO,   /* Most of what we know from
124                                    struct winbindd_domain */
125         WINBINDD_GETDCNAME,     /* Issue a GetDCName Request */
126
127         WINBINDD_SHOW_SEQUENCE, /* display sequence numbers of domains */
128
129         /* WINS commands */
130
131         WINBINDD_WINS_BYIP,
132         WINBINDD_WINS_BYNAME,
133
134         /* this is like GETGRENT but gives an empty group list */
135         WINBINDD_GETGRLST,
136
137         WINBINDD_NETBIOS_NAME,       /* The netbios name of the server */
138
139         /* find the location of our privileged pipe */
140         WINBINDD_PRIV_PIPE_DIR,
141
142         /* return a list of group sids for a user sid */
143         WINBINDD_GETUSERSIDS,
144
145         /* Various group queries */
146         WINBINDD_GETUSERDOMGROUPS,
147
148         /* Initialize connection in a child */
149         WINBINDD_INIT_CONNECTION,
150
151         /* Blocking calls that are not allowed on the main winbind pipe, only
152          * between parent and children */
153         WINBINDD_DUAL_SID2UID,
154         WINBINDD_DUAL_SID2GID,
155         WINBINDD_DUAL_SIDS2XIDS,
156         WINBINDD_DUAL_UID2SID,
157         WINBINDD_DUAL_GID2SID,
158         WINBINDD_DUAL_SET_MAPPING,
159         WINBINDD_DUAL_SET_HWM,
160         WINBINDD_DUAL_DUMP_MAPS,
161
162         /* Wrapper around possibly blocking unix nss calls */
163         WINBINDD_DUAL_UID2NAME,
164         WINBINDD_DUAL_NAME2UID,
165         WINBINDD_DUAL_GID2NAME,
166         WINBINDD_DUAL_NAME2GID,
167
168         WINBINDD_DUAL_USERINFO,
169         WINBINDD_DUAL_GETSIDALIASES,
170
171         /* Complete the challenge phase of the NTLM authentication
172            protocol using cached password. */
173         WINBINDD_CCACHE_NTLMAUTH,
174
175         WINBINDD_NUM_CMDS
176 };
177
178 typedef struct winbindd_pw {
179         fstring pw_name;
180         fstring pw_passwd;
181         uid_t pw_uid;
182         gid_t pw_gid;
183         fstring pw_gecos;
184         fstring pw_dir;
185         fstring pw_shell;
186 } WINBINDD_PW;
187
188
189 typedef struct winbindd_gr {
190         fstring gr_name;
191         fstring gr_passwd;
192         gid_t gr_gid;
193         uint32 num_gr_mem;
194         uint32 gr_mem_ofs;   /* offset to group membership */
195 } WINBINDD_GR;
196
197
198 #define WBFLAG_PAM_INFO3_NDR            0x00000001
199 #define WBFLAG_PAM_INFO3_TEXT           0x00000002
200 #define WBFLAG_PAM_USER_SESSION_KEY     0x00000004
201 #define WBFLAG_PAM_LMKEY                0x00000008
202 #define WBFLAG_PAM_CONTACT_TRUSTDOM     0x00000010
203 #define WBFLAG_QUERY_ONLY               0x00000020
204 #define WBFLAG_PAM_UNIX_NAME            0x00000080
205 #define WBFLAG_PAM_AFS_TOKEN            0x00000100
206 #define WBFLAG_PAM_NT_STATUS_SQUASH     0x00000200
207
208 /* This is a flag that can only be sent from parent to child */
209 #define WBFLAG_IS_PRIVILEGED            0x00000400
210 /* Flag to say this is a winbindd internal send - don't recurse. */
211 #define WBFLAG_RECURSE                  0x00000800
212
213 #define WBFLAG_PAM_KRB5                 0x00001000
214 #define WBFLAG_PAM_FALLBACK_AFTER_KRB5  0x00002000
215 #define WBFLAG_PAM_CACHED_LOGIN         0x00004000
216 #define WBFLAG_PAM_GET_PWD_POLICY       0x00008000      /* not used */
217
218 #define WINBINDD_MAX_EXTRA_DATA (128*1024)
219
220 /* Winbind request structure */
221
222 /*******************************************************************************
223  * This structure MUST be the same size in the 32bit and 64bit builds
224  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
225  * 
226  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
227  * A 64BIT WINBINDD    --jerry
228  ******************************************************************************/
229
230 struct winbindd_request {
231         uint32 length;
232         enum winbindd_cmd cmd;   /* Winbindd command to execute */
233         enum winbindd_cmd original_cmd;   /* Original Winbindd command
234                                              issued to parent process */
235         pid_t pid;               /* pid of calling process */
236         uint32 flags;            /* flags relavant to a given request */
237         fstring domain_name;    /* name of domain for which the request applies */
238
239         union {
240                 fstring winsreq;     /* WINS request */
241                 fstring username;    /* getpwnam */
242                 fstring groupname;   /* getgrnam */
243                 uid_t uid;           /* getpwuid, uid_to_sid */
244                 gid_t gid;           /* getgrgid, gid_to_sid */
245                 struct {
246                         /* We deliberatedly don't split into domain/user to
247                            avoid having the client know what the separator
248                            character is. */     
249                         fstring user;
250                         fstring pass;
251                         pstring require_membership_of_sid;
252                         fstring krb5_cc_type;
253                         uid_t uid;
254                 } auth;              /* pam_winbind auth module */
255                 struct {
256                         unsigned char chal[8];
257                         uint32 logon_parameters;
258                         fstring user;
259                         fstring domain;
260                         fstring lm_resp;
261                         uint32 lm_resp_len;
262                         fstring nt_resp;
263                         uint32 nt_resp_len;
264                         fstring workstation;
265                         fstring require_membership_of_sid;
266                 } auth_crap;
267                 struct {
268                     fstring user;
269                     fstring oldpass;
270                     fstring newpass;
271                 } chauthtok;         /* pam_winbind passwd module */
272                 struct {
273                         fstring user;
274                         fstring domain;
275                         unsigned char new_nt_pswd[516];
276                         uint16  new_nt_pswd_len;
277                         unsigned char old_nt_hash_enc[16];
278                         uint16  old_nt_hash_enc_len;
279                         unsigned char new_lm_pswd[516];
280                         uint16  new_lm_pswd_len;
281                         unsigned char old_lm_hash_enc[16];
282                         uint16  old_lm_hash_enc_len;
283                 } chng_pswd_auth_crap;/* pam_winbind passwd module */
284                 struct {
285                         fstring user;
286                         fstring krb5ccname;
287                         uid_t uid;
288                 } logoff;              /* pam_winbind session module */
289                 fstring sid;         /* lookupsid, sid_to_[ug]id */
290                 struct {
291                         fstring dom_name;       /* lookupname */
292                         fstring name;       
293                 } name;
294                 uint32 num_entries;  /* getpwent, getgrent */
295                 struct {
296                         fstring username;
297                         fstring groupname;
298                 } acct_mgt;
299                 struct {
300                         BOOL is_primary;
301                         fstring dcname;
302                 } init_conn;
303                 struct {
304                         fstring sid;
305                         fstring name;
306                 } dual_sid2id;
307                 struct {
308                         fstring sid;
309                         uint32 type;
310                         uint32 id;
311                 } dual_idmapset;
312                 BOOL list_all_domains;
313
314                 struct {
315                         uid_t uid;
316                         fstring user;
317                         /* the effective uid of the client, must be the uid for 'user'.
318                            This is checked by the main daemon, trusted by children. */
319                         /* if the blobs are length zero, then this doesn't
320                            produce an actual challenge response. It merely
321                            succeeds if there are cached credentials available
322                            that could be used. */
323                         uint32 initial_blob_len; /* blobs in extra_data */
324                         uint32 challenge_blob_len;
325                 } ccache_ntlm_auth;
326
327                 /* padding -- needed to fix alignment between 32bit and 64bit libs.
328                    The size is the sizeof the union without the padding aligned on 
329                    an 8 byte boundary.   --jerry */
330
331                 char padding[1560];
332         } data;
333         union {
334                 SMB_TIME_T padding;
335                 char *data;
336         } extra_data;
337         uint32 extra_len;
338         char null_term;
339 };
340
341 /* Response values */
342
343 enum winbindd_result {
344         WINBINDD_ERROR,
345         WINBINDD_PENDING,
346         WINBINDD_OK
347 };
348
349 /* Winbind response structure */
350
351 /*******************************************************************************
352  * This structure MUST be the same size in the 32bit and 64bit builds
353  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
354  * 
355  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
356  * A 64BIT WINBINDD    --jerry
357  ******************************************************************************/
358
359 struct winbindd_response {
360     
361         /* Header information */
362
363         uint32 length;                        /* Length of response */
364         enum winbindd_result result;          /* Result code */
365
366         /* Fixed length return data */
367         
368         union {
369                 int interface_version;  /* Try to ensure this is always in the same spot... */
370                 
371                 fstring winsresp;               /* WINS response */
372
373                 /* getpwnam, getpwuid */
374                 
375                 struct winbindd_pw pw;
376
377                 /* getgrnam, getgrgid */
378
379                 struct winbindd_gr gr;
380
381                 uint32 num_entries; /* getpwent, getgrent */
382                 struct winbindd_sid {
383                         fstring sid;        /* lookupname, [ug]id_to_sid */
384                         int type;
385                 } sid;
386                 struct winbindd_name {
387                         fstring dom_name;       /* lookupsid */
388                         fstring name;       
389                         int type;
390                 } name;
391                 uid_t uid;          /* sid_to_uid */
392                 gid_t gid;          /* sid_to_gid */
393                 struct winbindd_info {
394                         char winbind_separator;
395                         fstring samba_version;
396                 } info;
397                 fstring domain_name;
398                 fstring netbios_name;
399                 fstring dc_name;
400
401                 struct auth_reply {
402                         uint32 nt_status;
403                         fstring nt_status_string;
404                         fstring error_string;
405                         int pam_error;
406                         char user_session_key[16];
407                         char first_8_lm_hash[8];
408                         fstring krb5ccname;
409                         uint32 reject_reason;
410                         uint32 padding;
411                         struct policy_settings {
412                                 uint32 min_length_password;
413                                 uint32 password_history;
414                                 uint32 password_properties;
415                                 uint32 padding;
416                                 SMB_TIME_T expire;
417                                 SMB_TIME_T min_passwordage;
418                         } policy;
419                         struct info3_text {
420                                 SMB_TIME_T logon_time;
421                                 SMB_TIME_T logoff_time;
422                                 SMB_TIME_T kickoff_time;
423                                 SMB_TIME_T pass_last_set_time;
424                                 SMB_TIME_T pass_can_change_time;
425                                 SMB_TIME_T pass_must_change_time;
426                                 uint32 logon_count;
427                                 uint32 bad_pw_count;
428                                 uint32 user_rid;
429                                 uint32 group_rid;
430                                 uint32 num_groups;
431                                 uint32 user_flgs;
432                                 uint32 acct_flags;
433                                 uint32 num_other_sids;
434                                 fstring dom_sid;
435                                 fstring user_name;
436                                 fstring full_name;
437                                 fstring logon_script;
438                                 fstring profile_path;
439                                 fstring home_dir;
440                                 fstring dir_drive;
441                                 fstring logon_srv;
442                                 fstring logon_dom;
443                         } info3;
444                 } auth;
445                 struct {
446                         fstring name;
447                         fstring alt_name;
448                         fstring sid;
449                         BOOL native_mode;
450                         BOOL active_directory;
451                         BOOL primary;
452                         uint32 sequence_number;
453                 } domain_info;
454                 struct {
455                         fstring acct_name;
456                         fstring full_name;
457                         fstring homedir;
458                         fstring shell;
459                         uint32 primary_gid;                     
460                         uint32 group_rid;
461                 } user_info;
462                 struct {
463                         uint32 auth_blob_len; /* blob in extra_data */
464                 } ccache_ntlm_auth;
465         } data;
466
467         /* Variable length return data */
468
469         union {
470                 SMB_TIME_T padding;
471                 void *data;
472         } extra_data;
473 };
474
475 struct WINBINDD_MEMORY_CREDS {
476         struct WINBINDD_MEMORY_CREDS *next, *prev;
477         const char *username; /* lookup key. */
478         uid_t uid;
479         int ref_count;
480         size_t len;
481         unsigned char *nt_hash; /* Base pointer for the following 2 */
482         unsigned char *lm_hash;
483         char *pass;
484 };
485
486 struct WINBINDD_CCACHE_ENTRY {
487         struct WINBINDD_CCACHE_ENTRY *next, *prev;
488         const char *principal_name;
489         const char *ccname;
490         const char *service;
491         const char *username;
492         const char *realm;
493         struct WINBINDD_MEMORY_CREDS *cred_ptr;
494         int ref_count;
495         uid_t uid;
496         time_t create_time;
497         time_t renew_until;
498         time_t refresh_time;
499         struct timed_event *event;
500 };
501
502 #endif