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