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