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