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