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