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