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