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 /* We let the build environment set the public winbindd socket
  29  * location. Therefore we no longer set
  30  *
  31  * #define WINBINDD_SOCKET_DIR "/tmp/.winbindd"
  32  *
  33  * A number of different distributions set different paths, and so it
  34  * needs to come from configure in Samba.  External users of this header will
  35  * need to know where the path is on their system by some other
  36  * mechanism.
  37  */
  38
  39 #define WINBINDD_PRIV_SOCKET_SUBDIR "winbindd_privileged" /* name of subdirectory of lp_lock_directory() to hold the 'privileged' pipe */
  40 #define WINBINDD_DOMAIN_ENV  "WINBINDD_DOMAIN" /* Environment variables */
  41 #define WINBINDD_DONT_ENV    "_NO_WINBINDD"
  42 #define WINBINDD_LOCATOR_KDC_ADDRESS "WINBINDD_LOCATOR_KDC_ADDRESS"
  43
  44 /* Update this when you change the interface.
  45  * 21: added WINBINDD_GETPWSID
  46  *     added WINBINDD_GETSIDALIASES
  47  * 22: added WINBINDD_PING_DC
  48  * 23: added session_key to ccache_ntlm_auth response
  49  *     added WINBINDD_CCACHE_SAVE
  50  * 24: Fill in num_entries WINBINDD_LIST_USERS and WINBINDD_LIST_GROUPS
  51  * 25: removed WINBINDD_SET_HWM
  52  *     removed WINBINDD_SET_MAPPING
  53  *     removed WINBINDD_REMOVE_MAPPING
  54  * 26: added WINBINDD_DC_INFO
  55  * 27: added WINBINDD_LOOKUPSIDS
  56  * 28: added WINBINDD_XIDS_TO_SIDS
  57  *     removed WINBINDD_SID_TO_UID
  58  *     removed WINBINDD_SID_TO_GID
  59  *     removed WINBINDD_GID_TO_SID
  60  *     removed WINBINDD_UID_TO_SID
  61  * 29: added "authoritative" to response.data.auth
  62  * 30: added "validation_level" and "info6" to response.data.auth
  63  * 31: added "client_name" to the request
  64  * 32: added "traceid" to the request
  65  *     removed WINBINDD_INIT_CONNECTION
  66  * 33: removed WINBINDD_SHOW_SEQUENCE
  67  */
  68 #define WINBIND_INTERFACE_VERSION 33
  69
  70 /* Have to deal with time_t being 4 or 8 bytes due to structure alignment.
  71    On a 64bit Linux box, we have to support a constant structure size
  72    between /lib/libnss_winbind.so.2 and /lib64/libnss_winbind.so.2.
  73    The easiest way to do this is to always use 8byte values for time_t. */
  74
  75 #define SMB_TIME_T int64_t
  76
  77 /* Socket commands */
  78
  79 enum winbindd_cmd {
  80
  81         WINBINDD_INTERFACE_VERSION,    /* Always a well known value */
  82
  83         /* Get users and groups */
  84
  85         WINBINDD_GETPWNAM,
  86         WINBINDD_GETPWUID,
  87         WINBINDD_GETPWSID,
  88         WINBINDD_GETGRNAM,
  89         WINBINDD_GETGRGID,
  90         WINBINDD_GETGROUPS,
  91
  92         /* Enumerate users and groups */
  93
  94         WINBINDD_SETPWENT,
  95         WINBINDD_ENDPWENT,
  96         WINBINDD_GETPWENT,
  97         WINBINDD_SETGRENT,
  98         WINBINDD_ENDGRENT,
  99         WINBINDD_GETGRENT,
 100
 101         /* PAM authenticate and password change */
 102
 103         WINBINDD_PAM_AUTH,
 104         WINBINDD_PAM_AUTH_CRAP,
 105         WINBINDD_PAM_CHAUTHTOK,
 106         WINBINDD_PAM_LOGOFF,
 107         WINBINDD_PAM_CHNG_PSWD_AUTH_CRAP,
 108
 109         /* List various things */
 110
 111         WINBINDD_LIST_USERS,         /* List w/o rid->id mapping */
 112         WINBINDD_LIST_GROUPS,        /* Ditto */
 113         WINBINDD_LIST_TRUSTDOM,
 114
 115         /* SID conversion */
 116
 117         WINBINDD_LOOKUPSID,
 118         WINBINDD_LOOKUPNAME,
 119         WINBINDD_LOOKUPRIDS,
 120         WINBINDD_LOOKUPSIDS,
 121
 122         /* Lookup functions */
 123
 124         WINBINDD_SIDS_TO_XIDS,
 125         WINBINDD_XIDS_TO_SIDS,
 126
 127         WINBINDD_ALLOCATE_UID,
 128         WINBINDD_ALLOCATE_GID,
 129
 130         /* Miscellaneous other stuff */
 131
 132         WINBINDD_CHECK_MACHACC,     /* Check machine account pw works */
 133         WINBINDD_CHANGE_MACHACC,    /* Change machine account pw */
 134         WINBINDD_PING_DC,           /* Ping the DC through NETLOGON */
 135         WINBINDD_PING,              /* Just tell me winbind is running */
 136         WINBINDD_INFO,              /* Various bit of info.  Currently just tidbits */
 137         WINBINDD_DOMAIN_NAME,       /* The domain this winbind server is a member of (lp_workgroup()) */
 138
 139         WINBINDD_DOMAIN_INFO,   /* Most of what we know from
 140                                    struct winbindd_domain */
 141         WINBINDD_GETDCNAME,     /* Issue a GetDCName Request */
 142         WINBINDD_DSGETDCNAME,   /* Issue a DsGetDCName Request */
 143         WINBINDD_DC_INFO,       /* Which DC are we connected to? */
 144
 145         /* WINS commands */
 146
 147         WINBINDD_WINS_BYIP,
 148         WINBINDD_WINS_BYNAME,
 149
 150         /* this is like GETGRENT but gives an empty group list */
 151         WINBINDD_GETGRLST,
 152
 153         WINBINDD_NETBIOS_NAME,       /* The netbios name of the server */
 154
 155         /* find the location of our privileged pipe */
 156         WINBINDD_PRIV_PIPE_DIR,
 157
 158         /* return a list of group sids for a user sid */
 159         WINBINDD_GETUSERSIDS,
 160
 161         /* Various group queries */
 162         WINBINDD_GETUSERDOMGROUPS,
 163
 164         /* lookup local groups */
 165         WINBINDD_GETSIDALIASES,
 166
 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,
 174
 175         /* Wrapper around possibly blocking unix nss calls */
 176         WINBINDD_DUAL_USERINFO,
 177         WINBINDD_DUAL_GETSIDALIASES,
 178
 179         WINBINDD_DUAL_NDRCMD,
 180
 181         /* Complete the challenge phase of the NTLM authentication
 182            protocol using cached password. */
 183         WINBINDD_CCACHE_NTLMAUTH,
 184         WINBINDD_CCACHE_SAVE,
 185
 186         WINBINDD_NUM_CMDS
 187 };
 188
 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;
 198
 199
 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;
 207
 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
 230 #define WBFLAG_FROM_NSS                 0x00020000
 231
 232 #define WINBINDD_MAX_EXTRA_DATA (128*1024)
 233
 234 /* Winbind request structure */
 235
 236 /*******************************************************************************
 237  * This structure MUST be the same size in the 32bit and 64bit builds
 238  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
 239  *
 240  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
 241  * A 64BIT WINBINDD    --jerry
 242  ******************************************************************************/
 243
 244 struct winbindd_request {
 245         uint32_t length;
 246         enum winbindd_cmd cmd;   /* Winbindd command to execute */
 247         enum winbindd_cmd original_cmd;   /* Original Winbindd command
 248                                              issued to parent process */
 249         pid_t pid;               /* pid of calling process */
 250         uint32_t wb_flags;       /* generic flags */
 251         uint32_t flags;          /* flags relevant *only* to a given request */
 252         fstring domain_name;    /* name of domain for which the request applies */
 253         char client_name[32];   /* The client process sending the request */
 254         uint64_t traceid;       /* debug traceid is sent from parent to child */
 255
 256         union {
 257                 fstring winsreq;     /* WINS request */
 258                 fstring username;    /* getpwnam */
 259                 fstring groupname;   /* getgrnam */
 260                 uid_t uid;           /* getpwuid, uid_to_sid */
 261                 gid_t gid;           /* getgrgid, gid_to_sid */
 262                 uint32_t ndrcmd;
 263                 struct {
 264                         /* We deliberately don't split into domain/user to
 265                            avoid having the client know what the separator
 266                            character is. */
 267                         fstring user;
 268                         fstring pass;
 269                         char require_membership_of_sid[1024];
 270                         fstring krb5_cc_type;
 271                         uid_t uid;
 272                 } auth;              /* pam_winbind auth module */
 273                 struct {
 274                         uint8_t chal[8];
 275                         uint32_t logon_parameters;
 276                         fstring user;
 277                         fstring domain;
 278                         fstring lm_resp;
 279                         uint32_t lm_resp_len;
 280                         fstring nt_resp;
 281                         uint32_t nt_resp_len;
 282                         fstring workstation;
 283                         fstring require_membership_of_sid;
 284                 } auth_crap;
 285                 struct {
 286                     fstring user;
 287                     fstring oldpass;
 288                     fstring newpass;
 289                 } chauthtok;         /* pam_winbind passwd module */
 290                 struct {
 291                         fstring user;
 292                         fstring domain;
 293                         uint8_t new_nt_pswd[516];
 294                         uint16_t new_nt_pswd_len;
 295                         uint8_t old_nt_hash_enc[16];
 296                         uint16_t old_nt_hash_enc_len;
 297                         uint8_t new_lm_pswd[516];
 298                         uint16_t new_lm_pswd_len;
 299                         uint8_t old_lm_hash_enc[16];
 300                         uint16_t old_lm_hash_enc_len;
 301                 } chng_pswd_auth_crap;/* pam_winbind passwd module */
 302                 struct {
 303                         fstring user;
 304                         fstring krb5ccname;
 305                         uid_t uid;
 306                 } logoff;              /* pam_winbind session module */
 307                 fstring sid;         /* lookupsid, sid_to_[ug]id */
 308                 struct {
 309                         fstring dom_name;       /* lookupname */
 310                         fstring name;
 311                 } name;
 312                 uint32_t num_entries;  /* getpwent, getgrent */
 313                 struct {
 314                         fstring username;
 315                         fstring groupname;
 316                 } acct_mgt;
 317                 struct {
 318                         bool is_primary;
 319                         fstring dcname;
 320                 } init_conn;
 321                 struct {
 322                         fstring sid;
 323                         fstring name;
 324                 } dual_sid2id;
 325                 struct {
 326                         fstring sid;
 327                         uint32_t type;
 328                         uint32_t id;
 329                 } dual_idmapset;
 330                 bool list_all_domains;
 331
 332                 struct {
 333                         uid_t uid;
 334                         fstring user;
 335                         /* the effective uid of the client, must be the uid for 'user'.
 336                            This is checked by the main daemon, trusted by children. */
 337                         /* if the blobs are length zero, then this doesn't
 338                            produce an actual challenge response. It merely
 339                            succeeds if there are cached credentials available
 340                            that could be used. */
 341                         uint32_t initial_blob_len; /* blobs in extra_data */
 342                         uint32_t challenge_blob_len;
 343                 } ccache_ntlm_auth;
 344                 struct {
 345                         uid_t uid;
 346                         fstring user;
 347                         fstring pass;
 348                 } ccache_save;
 349                 struct {
 350                         fstring domain_name;
 351                         fstring domain_guid;
 352                         fstring site_name;
 353                         uint32_t flags;
 354                 } dsgetdcname;
 355
 356                 /* padding -- needed to fix alignment between 32bit and 64bit libs.
 357                    The size is the sizeof the union without the padding aligned on
 358                    an 8 byte boundary.   --jerry */
 359
 360                 char padding[1800];
 361         } data;
 362         union {
 363                 SMB_TIME_T padding;
 364                 char *data;
 365         } extra_data;
 366         uint32_t extra_len;
 367         char null_term;
 368 };
 369
 370 /* Response values */
 371
 372 enum winbindd_result {
 373         WINBINDD_ERROR,
 374         WINBINDD_PENDING,
 375         WINBINDD_OK
 376 };
 377
 378 /* Winbind response structure */
 379
 380 /*******************************************************************************
 381  * This structure MUST be the same size in the 32bit and 64bit builds
 382  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
 383  *
 384  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
 385  * A 64BIT WINBINDD    --jerry
 386  ******************************************************************************/
 387
 388 struct winbindd_response {
 389
 390         /* Header information */
 391
 392         uint32_t length;                      /* Length of response */
 393         enum winbindd_result result;          /* Result code */
 394
 395         /* Fixed length return data */
 396
 397         union {
 398                 int interface_version;  /* Try to ensure this is always in the same spot... */
 399
 400                 fstring winsresp;               /* WINS response */
 401
 402                 /* getpwnam, getpwuid */
 403
 404                 struct winbindd_pw pw;
 405
 406                 /* getgrnam, getgrgid */
 407
 408                 struct winbindd_gr gr;
 409
 410                 uint32_t num_entries; /* getpwent, getgrent */
 411                 struct winbindd_sid {
 412                         fstring sid;        /* lookupname, [ug]id_to_sid */
 413                         int type;
 414                 } sid;
 415                 struct winbindd_name {
 416                         fstring dom_name;       /* lookupsid */
 417                         fstring name;
 418                         int type;
 419                 } name;
 420                 uid_t uid;          /* sid_to_uid */
 421                 gid_t gid;          /* sid_to_gid */
 422                 struct winbindd_info {
 423                         char winbind_separator;
 424                         fstring samba_version;
 425                 } info;
 426                 fstring domain_name;
 427                 fstring netbios_name;
 428                 fstring dc_name;
 429
 430                 struct auth_reply {
 431                         uint32_t nt_status;
 432                         fstring nt_status_string;
 433                         fstring error_string;
 434                         int pam_error;
 435                         char user_session_key[16];
 436                         char first_8_lm_hash[8];
 437                         fstring krb5ccname;
 438                         uint32_t reject_reason;
 439                         uint8_t authoritative;
 440                         uint8_t padding[1];
 441                         uint16_t validation_level;
 442                         struct policy_settings {
 443                                 uint32_t min_length_password;
 444                                 uint32_t password_history;
 445                                 uint32_t password_properties;
 446                                 uint32_t padding;
 447                                 SMB_TIME_T expire;
 448                                 SMB_TIME_T min_passwordage;
 449                         } policy;
 450                         struct info3_text {
 451                                 SMB_TIME_T logon_time;
 452                                 SMB_TIME_T logoff_time;
 453                                 SMB_TIME_T kickoff_time;
 454                                 SMB_TIME_T pass_last_set_time;
 455                                 SMB_TIME_T pass_can_change_time;
 456                                 SMB_TIME_T pass_must_change_time;
 457                                 uint32_t logon_count;
 458                                 uint32_t bad_pw_count;
 459                                 uint32_t user_rid;
 460                                 uint32_t group_rid;
 461                                 uint32_t num_groups;
 462                                 uint32_t user_flgs;
 463                                 uint32_t acct_flags;
 464                                 uint32_t num_other_sids;
 465                                 fstring dom_sid;
 466                                 fstring user_name;
 467                                 fstring full_name;
 468                                 fstring logon_script;
 469                                 fstring profile_path;
 470                                 fstring home_dir;
 471                                 fstring dir_drive;
 472                                 fstring logon_srv;
 473                                 fstring logon_dom;
 474                         } info3;
 475                         struct info6_text {
 476                                 fstring dns_domainname;
 477                                 fstring principal_name;
 478                         } info6;
 479                         fstring unix_username;
 480                 } auth;
 481                 struct {
 482                         fstring name;
 483                         fstring alt_name;
 484                         fstring sid;
 485                         bool native_mode;
 486                         bool active_directory;
 487                         bool primary;
 488                 } domain_info;
 489                 uint32_t sequence_number;
 490                 struct {
 491                         fstring acct_name;
 492                         fstring full_name;
 493                         fstring homedir;
 494                         fstring shell;
 495                         uint32_t primary_gid;
 496                         uint32_t group_rid;
 497                 } user_info;
 498                 struct {
 499                         uint8_t session_key[16];
 500                         uint32_t auth_blob_len; /* blob in extra_data */
 501                         uint8_t new_spnego;
 502                 } ccache_ntlm_auth;
 503                 struct {
 504                         fstring dc_unc;
 505                         fstring dc_address;
 506                         uint32_t dc_address_type;
 507                         fstring domain_guid;
 508                         fstring domain_name;
 509                         fstring forest_name;
 510                         uint32_t dc_flags;
 511                         fstring dc_site_name;
 512                         fstring client_site_name;
 513                 } dsgetdcname;
 514         } data;
 515
 516         /* Variable length return data */
 517
 518         union {
 519                 SMB_TIME_T padding;
 520                 void *data;
 521         } extra_data;
 522 };
 523
 524 /* Free a response structure */
 525
 526 static inline void winbindd_free_response(struct winbindd_response *response)
 527 {
 528         /* Free any allocated extra_data */
 529
 530         if (response)
 531                 SAFE_FREE(response->extra_data.data);
 532 }
 533
 534 #endif