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