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