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