s3:libsmb: add cli_{query,set}_security_descriptor() which take sec_info flags
[Samba/gebeck_regimport.git] / nsswitch / winbind_struct_protocol.h
blobc1704c8e0b3125de1152137479d6631cce52a8fd
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
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
60 #define WINBIND_INTERFACE_VERSION 27
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. */
67 #define SMB_TIME_T int64_t
69 /* Socket commands */
71 enum winbindd_cmd {
73 WINBINDD_INTERFACE_VERSION, /* Always a well known value */
75 /* Get users and groups */
77 WINBINDD_GETPWNAM,
78 WINBINDD_GETPWUID,
79 WINBINDD_GETPWSID,
80 WINBINDD_GETGRNAM,
81 WINBINDD_GETGRGID,
82 WINBINDD_GETGROUPS,
84 /* Enumerate users and groups */
86 WINBINDD_SETPWENT,
87 WINBINDD_ENDPWENT,
88 WINBINDD_GETPWENT,
89 WINBINDD_SETGRENT,
90 WINBINDD_ENDGRENT,
91 WINBINDD_GETGRENT,
93 /* PAM authenticate and password change */
95 WINBINDD_PAM_AUTH,
96 WINBINDD_PAM_AUTH_CRAP,
97 WINBINDD_PAM_CHAUTHTOK,
98 WINBINDD_PAM_LOGOFF,
99 WINBINDD_PAM_CHNG_PSWD_AUTH_CRAP,
101 /* List various things */
103 WINBINDD_LIST_USERS, /* List w/o rid->id mapping */
104 WINBINDD_LIST_GROUPS, /* Ditto */
105 WINBINDD_LIST_TRUSTDOM,
107 /* SID conversion */
109 WINBINDD_LOOKUPSID,
110 WINBINDD_LOOKUPNAME,
111 WINBINDD_LOOKUPRIDS,
112 WINBINDD_LOOKUPSIDS,
114 /* Lookup functions */
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,
122 WINBINDD_ALLOCATE_UID,
123 WINBINDD_ALLOCATE_GID,
125 /* Miscellaneous other stuff */
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()) */
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? */
140 WINBINDD_SHOW_SEQUENCE, /* display sequence numbers of domains */
142 /* WINS commands */
144 WINBINDD_WINS_BYIP,
145 WINBINDD_WINS_BYNAME,
147 /* this is like GETGRENT but gives an empty group list */
148 WINBINDD_GETGRLST,
150 WINBINDD_NETBIOS_NAME, /* The netbios name of the server */
152 /* find the location of our privileged pipe */
153 WINBINDD_PRIV_PIPE_DIR,
155 /* return a list of group sids for a user sid */
156 WINBINDD_GETUSERSIDS,
158 /* Various group queries */
159 WINBINDD_GETUSERDOMGROUPS,
161 /* lookup local groups */
162 WINBINDD_GETSIDALIASES,
164 /* Initialize connection in a child */
165 WINBINDD_INIT_CONNECTION,
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,
175 /* Wrapper around possibly blocking unix nss calls */
176 WINBINDD_DUAL_USERINFO,
177 WINBINDD_DUAL_GETSIDALIASES,
179 WINBINDD_DUAL_NDRCMD,
181 /* Complete the challenge phase of the NTLM authentication
182 protocol using cached password. */
183 WINBINDD_CCACHE_NTLMAUTH,
184 WINBINDD_CCACHE_SAVE,
186 WINBINDD_NUM_CMDS
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;
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;
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 #define WBFLAG_PAM_AUTH_PAC 0x00010000
223 /* generic request flags */
224 #define WBFLAG_QUERY_ONLY 0x00000020 /* not used */
225 /* This is a flag that can only be sent from parent to child */
226 #define WBFLAG_IS_PRIVILEGED 0x00000400 /* not used */
227 /* Flag to say this is a winbindd internal send - don't recurse. */
228 #define WBFLAG_RECURSE 0x00000800
229 /* Flag to tell winbind the NTLMv2 blob is too big for the struct and is in the
230 * extra_data field */
231 #define WBFLAG_BIG_NTLMV2_BLOB 0x00010000
233 #define WINBINDD_MAX_EXTRA_DATA (128*1024)
235 /* Winbind request structure */
237 /*******************************************************************************
238 * This structure MUST be the same size in the 32bit and 64bit builds
239 * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
241 * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
242 * A 64BIT WINBINDD --jerry
243 ******************************************************************************/
245 struct winbindd_request {
246 uint32_t length;
247 enum winbindd_cmd cmd; /* Winbindd command to execute */
248 enum winbindd_cmd original_cmd; /* Original Winbindd command
249 issued to parent process */
250 pid_t pid; /* pid of calling process */
251 uint32_t wb_flags; /* generic flags */
252 uint32_t flags; /* flags relevant *only* to a given request */
253 fstring domain_name; /* name of domain for which the request applies */
255 union {
256 fstring winsreq; /* WINS request */
257 fstring username; /* getpwnam */
258 fstring groupname; /* getgrnam */
259 uid_t uid; /* getpwuid, uid_to_sid */
260 gid_t gid; /* getgrgid, gid_to_sid */
261 uint32_t ndrcmd;
262 struct {
263 /* We deliberatedly don't split into domain/user to
264 avoid having the client know what the separator
265 character is. */
266 fstring user;
267 fstring pass;
268 char require_membership_of_sid[1024];
269 fstring krb5_cc_type;
270 uid_t uid;
271 } auth; /* pam_winbind auth module */
272 struct {
273 uint8_t chal[8];
274 uint32_t logon_parameters;
275 fstring user;
276 fstring domain;
277 fstring lm_resp;
278 uint32_t lm_resp_len;
279 fstring nt_resp;
280 uint32_t nt_resp_len;
281 fstring workstation;
282 fstring require_membership_of_sid;
283 } auth_crap;
284 struct {
285 fstring user;
286 fstring oldpass;
287 fstring newpass;
288 } chauthtok; /* pam_winbind passwd module */
289 struct {
290 fstring user;
291 fstring domain;
292 uint8_t new_nt_pswd[516];
293 uint16_t new_nt_pswd_len;
294 uint8_t old_nt_hash_enc[16];
295 uint16_t old_nt_hash_enc_len;
296 uint8_t new_lm_pswd[516];
297 uint16_t new_lm_pswd_len;
298 uint8_t old_lm_hash_enc[16];
299 uint16_t old_lm_hash_enc_len;
300 } chng_pswd_auth_crap;/* pam_winbind passwd module */
301 struct {
302 fstring user;
303 fstring krb5ccname;
304 uid_t uid;
305 } logoff; /* pam_winbind session module */
306 fstring sid; /* lookupsid, sid_to_[ug]id */
307 struct {
308 fstring dom_name; /* lookupname */
309 fstring name;
310 } name;
311 uint32_t num_entries; /* getpwent, getgrent */
312 struct {
313 fstring username;
314 fstring groupname;
315 } acct_mgt;
316 struct {
317 bool is_primary;
318 fstring dcname;
319 } init_conn;
320 struct {
321 fstring sid;
322 fstring name;
323 } dual_sid2id;
324 struct {
325 fstring sid;
326 uint32_t type;
327 uint32_t id;
328 } dual_idmapset;
329 bool list_all_domains;
331 struct {
332 uid_t uid;
333 fstring user;
334 /* the effective uid of the client, must be the uid for 'user'.
335 This is checked by the main daemon, trusted by children. */
336 /* if the blobs are length zero, then this doesn't
337 produce an actual challenge response. It merely
338 succeeds if there are cached credentials available
339 that could be used. */
340 uint32_t initial_blob_len; /* blobs in extra_data */
341 uint32_t challenge_blob_len;
342 } ccache_ntlm_auth;
343 struct {
344 uid_t uid;
345 fstring user;
346 fstring pass;
347 } ccache_save;
348 struct {
349 fstring domain_name;
350 fstring domain_guid;
351 fstring site_name;
352 uint32_t flags;
353 } dsgetdcname;
355 /* padding -- needed to fix alignment between 32bit and 64bit libs.
356 The size is the sizeof the union without the padding aligned on
357 an 8 byte boundary. --jerry */
359 char padding[1800];
360 } data;
361 union {
362 SMB_TIME_T padding;
363 char *data;
364 } extra_data;
365 uint32_t extra_len;
366 char null_term;
369 /* Response values */
371 enum winbindd_result {
372 WINBINDD_ERROR,
373 WINBINDD_PENDING,
374 WINBINDD_OK
377 /* Winbind response structure */
379 /*******************************************************************************
380 * This structure MUST be the same size in the 32bit and 64bit builds
381 * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
383 * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
384 * A 64BIT WINBINDD --jerry
385 ******************************************************************************/
387 struct winbindd_response {
389 /* Header information */
391 uint32_t length; /* Length of response */
392 enum winbindd_result result; /* Result code */
394 /* Fixed length return data */
396 union {
397 int interface_version; /* Try to ensure this is always in the same spot... */
399 fstring winsresp; /* WINS response */
401 /* getpwnam, getpwuid */
403 struct winbindd_pw pw;
405 /* getgrnam, getgrgid */
407 struct winbindd_gr gr;
409 uint32_t num_entries; /* getpwent, getgrent */
410 struct winbindd_sid {
411 fstring sid; /* lookupname, [ug]id_to_sid */
412 int type;
413 } sid;
414 struct winbindd_name {
415 fstring dom_name; /* lookupsid */
416 fstring name;
417 int type;
418 } name;
419 uid_t uid; /* sid_to_uid */
420 gid_t gid; /* sid_to_gid */
421 struct winbindd_info {
422 char winbind_separator;
423 fstring samba_version;
424 } info;
425 fstring domain_name;
426 fstring netbios_name;
427 fstring dc_name;
429 struct auth_reply {
430 uint32_t nt_status;
431 fstring nt_status_string;
432 fstring error_string;
433 int pam_error;
434 char user_session_key[16];
435 char first_8_lm_hash[8];
436 fstring krb5ccname;
437 uint32_t reject_reason;
438 uint32_t padding;
439 struct policy_settings {
440 uint32_t min_length_password;
441 uint32_t password_history;
442 uint32_t password_properties;
443 uint32_t padding;
444 SMB_TIME_T expire;
445 SMB_TIME_T min_passwordage;
446 } policy;
447 struct info3_text {
448 SMB_TIME_T logon_time;
449 SMB_TIME_T logoff_time;
450 SMB_TIME_T kickoff_time;
451 SMB_TIME_T pass_last_set_time;
452 SMB_TIME_T pass_can_change_time;
453 SMB_TIME_T pass_must_change_time;
454 uint32_t logon_count;
455 uint32_t bad_pw_count;
456 uint32_t user_rid;
457 uint32_t group_rid;
458 uint32_t num_groups;
459 uint32_t user_flgs;
460 uint32_t acct_flags;
461 uint32_t num_other_sids;
462 fstring dom_sid;
463 fstring user_name;
464 fstring full_name;
465 fstring logon_script;
466 fstring profile_path;
467 fstring home_dir;
468 fstring dir_drive;
469 fstring logon_srv;
470 fstring logon_dom;
471 } info3;
472 fstring unix_username;
473 } auth;
474 struct {
475 fstring name;
476 fstring alt_name;
477 fstring sid;
478 bool native_mode;
479 bool active_directory;
480 bool primary;
481 } domain_info;
482 uint32_t sequence_number;
483 struct {
484 fstring acct_name;
485 fstring full_name;
486 fstring homedir;
487 fstring shell;
488 uint32_t primary_gid;
489 uint32_t group_rid;
490 } user_info;
491 struct {
492 uint8_t session_key[16];
493 uint32_t auth_blob_len; /* blob in extra_data */
494 } ccache_ntlm_auth;
495 struct {
496 fstring dc_unc;
497 fstring dc_address;
498 uint32_t dc_address_type;
499 fstring domain_guid;
500 fstring domain_name;
501 fstring forest_name;
502 uint32_t dc_flags;
503 fstring dc_site_name;
504 fstring client_site_name;
505 } dsgetdcname;
506 } data;
508 /* Variable length return data */
510 union {
511 SMB_TIME_T padding;
512 void *data;
513 } extra_data;
516 #endif