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