s3:idmap: remove unused method set_id_hwm from idmap API
[amitay/samba.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 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  */
55 #define WINBIND_INTERFACE_VERSION 24
56
57 /* Have to deal with time_t being 4 or 8 bytes due to structure alignment.
58    On a 64bit Linux box, we have to support a constant structure size
59    between /lib/libnss_winbind.so.2 and /lib64/libnss_winbind.so.2.
60    The easiest way to do this is to always use 8byte values for time_t. */
61
62 #define SMB_TIME_T int64_t
63
64 /* Socket commands */
65
66 enum winbindd_cmd {
67
68         WINBINDD_INTERFACE_VERSION,    /* Always a well known value */
69
70         /* Get users and groups */
71
72         WINBINDD_GETPWNAM,
73         WINBINDD_GETPWUID,
74         WINBINDD_GETPWSID,
75         WINBINDD_GETGRNAM,
76         WINBINDD_GETGRGID,
77         WINBINDD_GETGROUPS,
78
79         /* Enumerate users and groups */
80
81         WINBINDD_SETPWENT,
82         WINBINDD_ENDPWENT,
83         WINBINDD_GETPWENT,
84         WINBINDD_SETGRENT,
85         WINBINDD_ENDGRENT,
86         WINBINDD_GETGRENT,
87
88         /* PAM authenticate and password change */
89
90         WINBINDD_PAM_AUTH,
91         WINBINDD_PAM_AUTH_CRAP,
92         WINBINDD_PAM_CHAUTHTOK,
93         WINBINDD_PAM_LOGOFF,
94         WINBINDD_PAM_CHNG_PSWD_AUTH_CRAP,
95
96         /* List various things */
97
98         WINBINDD_LIST_USERS,         /* List w/o rid->id mapping */
99         WINBINDD_LIST_GROUPS,        /* Ditto */
100         WINBINDD_LIST_TRUSTDOM,
101
102         /* SID conversion */
103
104         WINBINDD_LOOKUPSID,
105         WINBINDD_LOOKUPNAME,
106         WINBINDD_LOOKUPRIDS,
107
108         /* Lookup functions */
109
110         WINBINDD_SID_TO_UID,
111         WINBINDD_SID_TO_GID,
112         WINBINDD_SIDS_TO_XIDS,
113         WINBINDD_UID_TO_SID,
114         WINBINDD_GID_TO_SID,
115
116         WINBINDD_ALLOCATE_UID,
117         WINBINDD_ALLOCATE_GID,
118
119         /* Miscellaneous other stuff */
120
121         WINBINDD_CHECK_MACHACC,     /* Check machine account pw works */
122         WINBINDD_CHANGE_MACHACC,    /* Change machine account pw */
123         WINBINDD_PING_DC,           /* Ping the DC through NETLOGON */
124         WINBINDD_PING,              /* Just tell me winbind is running */
125         WINBINDD_INFO,              /* Various bit of info.  Currently just tidbits */
126         WINBINDD_DOMAIN_NAME,       /* The domain this winbind server is a member of (lp_workgroup()) */
127
128         WINBINDD_DOMAIN_INFO,   /* Most of what we know from
129                                    struct winbindd_domain */
130         WINBINDD_GETDCNAME,     /* Issue a GetDCName Request */
131         WINBINDD_DSGETDCNAME,   /* Issue a DsGetDCName Request */
132
133         WINBINDD_SHOW_SEQUENCE, /* display sequence numbers of domains */
134
135         /* WINS commands */
136
137         WINBINDD_WINS_BYIP,
138         WINBINDD_WINS_BYNAME,
139
140         /* this is like GETGRENT but gives an empty group list */
141         WINBINDD_GETGRLST,
142
143         WINBINDD_NETBIOS_NAME,       /* The netbios name of the server */
144
145         /* find the location of our privileged pipe */
146         WINBINDD_PRIV_PIPE_DIR,
147
148         /* return a list of group sids for a user sid */
149         WINBINDD_GETUSERSIDS,
150
151         /* Various group queries */
152         WINBINDD_GETUSERDOMGROUPS,
153
154         /* lookup local groups */
155         WINBINDD_GETSIDALIASES,
156
157         /* Initialize connection in a child */
158         WINBINDD_INIT_CONNECTION,
159
160         /* Blocking calls that are not allowed on the main winbind pipe, only
161          * between parent and children */
162         WINBINDD_DUAL_SID2UID,
163         WINBINDD_DUAL_SID2GID,
164         WINBINDD_DUAL_SIDS2XIDS,
165         WINBINDD_DUAL_UID2SID,
166         WINBINDD_DUAL_GID2SID,
167
168         /* Wrapper around possibly blocking unix nss calls */
169         WINBINDD_DUAL_USERINFO,
170         WINBINDD_DUAL_GETSIDALIASES,
171
172         WINBINDD_DUAL_NDRCMD,
173
174         /* Complete the challenge phase of the NTLM authentication
175            protocol using cached password. */
176         WINBINDD_CCACHE_NTLMAUTH,
177         WINBINDD_CCACHE_SAVE,
178
179         WINBINDD_NUM_CMDS
180 };
181
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;
191
192
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;
200
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
214
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
224
225 #define WINBINDD_MAX_EXTRA_DATA (128*1024)
226
227 /* Winbind request structure */
228
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
232  *
233  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
234  * A 64BIT WINBINDD    --jerry
235  ******************************************************************************/
236
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 */
246
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;
322
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                         uid_t uid;
337                         fstring user;
338                         fstring pass;
339                 } ccache_save;
340                 struct {
341                         fstring domain_name;
342                         fstring domain_guid;
343                         fstring site_name;
344                         uint32_t flags;
345                 } dsgetdcname;
346
347                 /* padding -- needed to fix alignment between 32bit and 64bit libs.
348                    The size is the sizeof the union without the padding aligned on
349                    an 8 byte boundary.   --jerry */
350
351                 char padding[1800];
352         } data;
353         union {
354                 SMB_TIME_T padding;
355                 char *data;
356         } extra_data;
357         uint32_t extra_len;
358         char null_term;
359 };
360
361 /* Response values */
362
363 enum winbindd_result {
364         WINBINDD_ERROR,
365         WINBINDD_PENDING,
366         WINBINDD_OK
367 };
368
369 /* Winbind response structure */
370
371 /*******************************************************************************
372  * This structure MUST be the same size in the 32bit and 64bit builds
373  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
374  *
375  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
376  * A 64BIT WINBINDD    --jerry
377  ******************************************************************************/
378
379 struct winbindd_response {
380
381         /* Header information */
382
383         uint32_t length;                      /* Length of response */
384         enum winbindd_result result;          /* Result code */
385
386         /* Fixed length return data */
387
388         union {
389                 int interface_version;  /* Try to ensure this is always in the same spot... */
390
391                 fstring winsresp;               /* WINS response */
392
393                 /* getpwnam, getpwuid */
394
395                 struct winbindd_pw pw;
396
397                 /* getgrnam, getgrgid */
398
399                 struct winbindd_gr gr;
400
401                 uint32_t num_entries; /* getpwent, getgrent */
402                 struct winbindd_sid {
403                         fstring sid;        /* lookupname, [ug]id_to_sid */
404                         int type;
405                 } sid;
406                 struct winbindd_name {
407                         fstring dom_name;       /* lookupsid */
408                         fstring name;
409                         int type;
410                 } name;
411                 uid_t uid;          /* sid_to_uid */
412                 gid_t gid;          /* sid_to_gid */
413                 struct winbindd_info {
414                         char winbind_separator;
415                         fstring samba_version;
416                 } info;
417                 fstring domain_name;
418                 fstring netbios_name;
419                 fstring dc_name;
420
421                 struct auth_reply {
422                         uint32_t nt_status;
423                         fstring nt_status_string;
424                         fstring error_string;
425                         int pam_error;
426                         char user_session_key[16];
427                         char first_8_lm_hash[8];
428                         fstring krb5ccname;
429                         uint32_t reject_reason;
430                         uint32_t padding;
431                         struct policy_settings {
432                                 uint32_t min_length_password;
433                                 uint32_t password_history;
434                                 uint32_t password_properties;
435                                 uint32_t padding;
436                                 SMB_TIME_T expire;
437                                 SMB_TIME_T min_passwordage;
438                         } policy;
439                         struct info3_text {
440                                 SMB_TIME_T logon_time;
441                                 SMB_TIME_T logoff_time;
442                                 SMB_TIME_T kickoff_time;
443                                 SMB_TIME_T pass_last_set_time;
444                                 SMB_TIME_T pass_can_change_time;
445                                 SMB_TIME_T pass_must_change_time;
446                                 uint32_t logon_count;
447                                 uint32_t bad_pw_count;
448                                 uint32_t user_rid;
449                                 uint32_t group_rid;
450                                 uint32_t num_groups;
451                                 uint32_t user_flgs;
452                                 uint32_t acct_flags;
453                                 uint32_t num_other_sids;
454                                 fstring dom_sid;
455                                 fstring user_name;
456                                 fstring full_name;
457                                 fstring logon_script;
458                                 fstring profile_path;
459                                 fstring home_dir;
460                                 fstring dir_drive;
461                                 fstring logon_srv;
462                                 fstring logon_dom;
463                         } info3;
464                         fstring unix_username;
465                 } auth;
466                 struct {
467                         fstring name;
468                         fstring alt_name;
469                         fstring sid;
470                         bool native_mode;
471                         bool active_directory;
472                         bool primary;
473                 } domain_info;
474                 uint32_t sequence_number;
475                 struct {
476                         fstring acct_name;
477                         fstring full_name;
478                         fstring homedir;
479                         fstring shell;
480                         uint32_t primary_gid;
481                         uint32_t group_rid;
482                 } user_info;
483                 struct {
484                         uint8_t session_key[16];
485                         uint32_t auth_blob_len; /* blob in extra_data */
486                 } ccache_ntlm_auth;
487                 struct {
488                         fstring dc_unc;
489                         fstring dc_address;
490                         uint32_t dc_address_type;
491                         fstring domain_guid;
492                         fstring domain_name;
493                         fstring forest_name;
494                         uint32_t dc_flags;
495                         fstring dc_site_name;
496                         fstring client_site_name;
497                 } dsgetdcname;
498         } data;
499
500         /* Variable length return data */
501
502         union {
503                 SMB_TIME_T padding;
504                 void *data;
505         } extra_data;
506 };
507
508 #endif