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