selftests-drs: make our generated class subclass of classschema
[Samba/gebeck_regimport.git] / nsswitch / winbind_struct_protocol.h
blob4a41ba384387adf9470acd50e584f3ee3b3994a7
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 /* 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_QUERY_ONLY 0x00000020 /* not used */
215 #define WBFLAG_PAM_AUTH_PAC 0x00000040
216 #define WBFLAG_PAM_UNIX_NAME 0x00000080
217 #define WBFLAG_PAM_AFS_TOKEN 0x00000100
218 #define WBFLAG_PAM_NT_STATUS_SQUASH 0x00000200
219 /* This is a flag that can only be sent from parent to child */
220 #define WBFLAG_IS_PRIVILEGED 0x00000400 /* not used */
221 /* Flag to say this is a winbindd internal send - don't recurse. */
222 #define WBFLAG_RECURSE 0x00000800
223 #define WBFLAG_PAM_KRB5 0x00001000
224 #define WBFLAG_PAM_FALLBACK_AFTER_KRB5 0x00002000
225 #define WBFLAG_PAM_CACHED_LOGIN 0x00004000
226 #define WBFLAG_PAM_GET_PWD_POLICY 0x00008000
227 /* Flag to tell winbind the NTLMv2 blob is too big for the struct and is in the
228 * extra_data field */
229 #define WBFLAG_BIG_NTLMV2_BLOB 0x00010000
231 #define WINBINDD_MAX_EXTRA_DATA (128*1024)
233 /* Winbind request structure */
235 /*******************************************************************************
236 * This structure MUST be the same size in the 32bit and 64bit builds
237 * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
239 * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
240 * A 64BIT WINBINDD --jerry
241 ******************************************************************************/
243 struct winbindd_request {
244 uint32_t length;
245 enum winbindd_cmd cmd; /* Winbindd command to execute */
246 enum winbindd_cmd original_cmd; /* Original Winbindd command
247 issued to parent process */
248 pid_t pid; /* pid of calling process */
249 uint32_t wb_flags; /* generic flags */
250 uint32_t flags; /* flags relevant *only* to a given request */
251 fstring domain_name; /* name of domain for which the request applies */
253 union {
254 fstring winsreq; /* WINS request */
255 fstring username; /* getpwnam */
256 fstring groupname; /* getgrnam */
257 uid_t uid; /* getpwuid, uid_to_sid */
258 gid_t gid; /* getgrgid, gid_to_sid */
259 uint32_t ndrcmd;
260 struct {
261 /* We deliberatedly don't split into domain/user to
262 avoid having the client know what the separator
263 character is. */
264 fstring user;
265 fstring pass;
266 char require_membership_of_sid[1024];
267 fstring krb5_cc_type;
268 uid_t uid;
269 } auth; /* pam_winbind auth module */
270 struct {
271 uint8_t chal[8];
272 uint32_t logon_parameters;
273 fstring user;
274 fstring domain;
275 fstring lm_resp;
276 uint32_t lm_resp_len;
277 fstring nt_resp;
278 uint32_t nt_resp_len;
279 fstring workstation;
280 fstring require_membership_of_sid;
281 } auth_crap;
282 struct {
283 fstring user;
284 fstring oldpass;
285 fstring newpass;
286 } chauthtok; /* pam_winbind passwd module */
287 struct {
288 fstring user;
289 fstring domain;
290 uint8_t new_nt_pswd[516];
291 uint16_t new_nt_pswd_len;
292 uint8_t old_nt_hash_enc[16];
293 uint16_t old_nt_hash_enc_len;
294 uint8_t new_lm_pswd[516];
295 uint16_t new_lm_pswd_len;
296 uint8_t old_lm_hash_enc[16];
297 uint16_t old_lm_hash_enc_len;
298 } chng_pswd_auth_crap;/* pam_winbind passwd module */
299 struct {
300 fstring user;
301 fstring krb5ccname;
302 uid_t uid;
303 } logoff; /* pam_winbind session module */
304 fstring sid; /* lookupsid, sid_to_[ug]id */
305 struct {
306 fstring dom_name; /* lookupname */
307 fstring name;
308 } name;
309 uint32_t num_entries; /* getpwent, getgrent */
310 struct {
311 fstring username;
312 fstring groupname;
313 } acct_mgt;
314 struct {
315 bool is_primary;
316 fstring dcname;
317 } init_conn;
318 struct {
319 fstring sid;
320 fstring name;
321 } dual_sid2id;
322 struct {
323 fstring sid;
324 uint32_t type;
325 uint32_t id;
326 } dual_idmapset;
327 bool list_all_domains;
329 struct {
330 uid_t uid;
331 fstring user;
332 /* the effective uid of the client, must be the uid for 'user'.
333 This is checked by the main daemon, trusted by children. */
334 /* if the blobs are length zero, then this doesn't
335 produce an actual challenge response. It merely
336 succeeds if there are cached credentials available
337 that could be used. */
338 uint32_t initial_blob_len; /* blobs in extra_data */
339 uint32_t challenge_blob_len;
340 } ccache_ntlm_auth;
341 struct {
342 uid_t uid;
343 fstring user;
344 fstring pass;
345 } ccache_save;
346 struct {
347 fstring domain_name;
348 fstring domain_guid;
349 fstring site_name;
350 uint32_t flags;
351 } dsgetdcname;
353 /* padding -- needed to fix alignment between 32bit and 64bit libs.
354 The size is the sizeof the union without the padding aligned on
355 an 8 byte boundary. --jerry */
357 char padding[1800];
358 } data;
359 union {
360 SMB_TIME_T padding;
361 char *data;
362 } extra_data;
363 uint32_t extra_len;
364 char null_term;
367 /* Response values */
369 enum winbindd_result {
370 WINBINDD_ERROR,
371 WINBINDD_PENDING,
372 WINBINDD_OK
375 /* Winbind response structure */
377 /*******************************************************************************
378 * This structure MUST be the same size in the 32bit and 64bit builds
379 * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
381 * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
382 * A 64BIT WINBINDD --jerry
383 ******************************************************************************/
385 struct winbindd_response {
387 /* Header information */
389 uint32_t length; /* Length of response */
390 enum winbindd_result result; /* Result code */
392 /* Fixed length return data */
394 union {
395 int interface_version; /* Try to ensure this is always in the same spot... */
397 fstring winsresp; /* WINS response */
399 /* getpwnam, getpwuid */
401 struct winbindd_pw pw;
403 /* getgrnam, getgrgid */
405 struct winbindd_gr gr;
407 uint32_t num_entries; /* getpwent, getgrent */
408 struct winbindd_sid {
409 fstring sid; /* lookupname, [ug]id_to_sid */
410 int type;
411 } sid;
412 struct winbindd_name {
413 fstring dom_name; /* lookupsid */
414 fstring name;
415 int type;
416 } name;
417 uid_t uid; /* sid_to_uid */
418 gid_t gid; /* sid_to_gid */
419 struct winbindd_info {
420 char winbind_separator;
421 fstring samba_version;
422 } info;
423 fstring domain_name;
424 fstring netbios_name;
425 fstring dc_name;
427 struct auth_reply {
428 uint32_t nt_status;
429 fstring nt_status_string;
430 fstring error_string;
431 int pam_error;
432 char user_session_key[16];
433 char first_8_lm_hash[8];
434 fstring krb5ccname;
435 uint32_t reject_reason;
436 uint32_t padding;
437 struct policy_settings {
438 uint32_t min_length_password;
439 uint32_t password_history;
440 uint32_t password_properties;
441 uint32_t padding;
442 SMB_TIME_T expire;
443 SMB_TIME_T min_passwordage;
444 } policy;
445 struct info3_text {
446 SMB_TIME_T logon_time;
447 SMB_TIME_T logoff_time;
448 SMB_TIME_T kickoff_time;
449 SMB_TIME_T pass_last_set_time;
450 SMB_TIME_T pass_can_change_time;
451 SMB_TIME_T pass_must_change_time;
452 uint32_t logon_count;
453 uint32_t bad_pw_count;
454 uint32_t user_rid;
455 uint32_t group_rid;
456 uint32_t num_groups;
457 uint32_t user_flgs;
458 uint32_t acct_flags;
459 uint32_t num_other_sids;
460 fstring dom_sid;
461 fstring user_name;
462 fstring full_name;
463 fstring logon_script;
464 fstring profile_path;
465 fstring home_dir;
466 fstring dir_drive;
467 fstring logon_srv;
468 fstring logon_dom;
469 } info3;
470 fstring unix_username;
471 } auth;
472 struct {
473 fstring name;
474 fstring alt_name;
475 fstring sid;
476 bool native_mode;
477 bool active_directory;
478 bool primary;
479 } domain_info;
480 uint32_t sequence_number;
481 struct {
482 fstring acct_name;
483 fstring full_name;
484 fstring homedir;
485 fstring shell;
486 uint32_t primary_gid;
487 uint32_t group_rid;
488 } user_info;
489 struct {
490 uint8_t session_key[16];
491 uint32_t auth_blob_len; /* blob in extra_data */
492 } ccache_ntlm_auth;
493 struct {
494 fstring dc_unc;
495 fstring dc_address;
496 uint32_t dc_address_type;
497 fstring domain_guid;
498 fstring domain_name;
499 fstring forest_name;
500 uint32_t dc_flags;
501 fstring dc_site_name;
502 fstring client_site_name;
503 } dsgetdcname;
504 } data;
506 /* Variable length return data */
508 union {
509 SMB_TIME_T padding;
510 void *data;
511 } extra_data;
514 #endif