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