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_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_DUMP_MAPS,
 112
 113         WINBINDD_CHECK_MACHACC,     /* Check machine account pw works */
 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         /* Initialize connection in a child */
 145         WINBINDD_INIT_CONNECTION,
 146
 147         /* Blocking calls that are not allowed on the main winbind pipe, only
 148          * between parent and children */
 149         WINBINDD_DUAL_SID2UID,
 150         WINBINDD_DUAL_SID2GID,
 151         WINBINDD_DUAL_SIDS2XIDS,
 152         WINBINDD_DUAL_UID2SID,
 153         WINBINDD_DUAL_GID2SID,
 154         WINBINDD_DUAL_SET_MAPPING,
 155         WINBINDD_DUAL_SET_HWM,
 156         WINBINDD_DUAL_DUMP_MAPS,
 157
 158         /* Wrapper around possibly blocking unix nss calls */
 159         WINBINDD_DUAL_UID2NAME,
 160         WINBINDD_DUAL_NAME2UID,
 161         WINBINDD_DUAL_GID2NAME,
 162         WINBINDD_DUAL_NAME2GID,
 163
 164         WINBINDD_DUAL_USERINFO,
 165         WINBINDD_DUAL_GETSIDALIASES,
 166
 167         /* Complete the challenge phase of the NTLM authentication
 168            protocol using cached password. */
 169         WINBINDD_CCACHE_NTLMAUTH,
 170
 171         WINBINDD_NUM_CMDS
 172 };
 173
 174 typedef struct winbindd_pw {
 175         fstring pw_name;
 176         fstring pw_passwd;
 177         uid_t pw_uid;
 178         gid_t pw_gid;
 179         fstring pw_gecos;
 180         fstring pw_dir;
 181         fstring pw_shell;
 182 } WINBINDD_PW;
 183
 184
 185 typedef struct winbindd_gr {
 186         fstring gr_name;
 187         fstring gr_passwd;
 188         gid_t gr_gid;
 189         uint32_t num_gr_mem;
 190         uint32_t gr_mem_ofs;   /* offset to group membership */
 191 } WINBINDD_GR;
 192
 193 /* PAM specific request flags */
 194 #define WBFLAG_PAM_INFO3_NDR            0x00000001
 195 #define WBFLAG_PAM_INFO3_TEXT           0x00000002
 196 #define WBFLAG_PAM_USER_SESSION_KEY     0x00000004
 197 #define WBFLAG_PAM_LMKEY                0x00000008
 198 #define WBFLAG_PAM_CONTACT_TRUSTDOM     0x00000010
 199 #define WBFLAG_PAM_UNIX_NAME            0x00000080
 200 #define WBFLAG_PAM_AFS_TOKEN            0x00000100
 201 #define WBFLAG_PAM_NT_STATUS_SQUASH     0x00000200
 202 #define WBFLAG_PAM_KRB5                 0x00001000
 203 #define WBFLAG_PAM_FALLBACK_AFTER_KRB5  0x00002000
 204 #define WBFLAG_PAM_CACHED_LOGIN         0x00004000
 205 #define WBFLAG_PAM_GET_PWD_POLICY       0x00008000      /* not used */
 206
 207 /* generic request flags */
 208 #define WBFLAG_QUERY_ONLY               0x00000020      /* not used */
 209 /* This is a flag that can only be sent from parent to child */
 210 #define WBFLAG_IS_PRIVILEGED            0x00000400      /* not used */
 211 /* Flag to say this is a winbindd internal send - don't recurse. */
 212 #define WBFLAG_RECURSE                  0x00000800
 213
 214
 215 #define WINBINDD_MAX_EXTRA_DATA (128*1024)
 216
 217 /* Winbind request structure */
 218
 219 /*******************************************************************************
 220  * This structure MUST be the same size in the 32bit and 64bit builds
 221  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
 222  *
 223  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
 224  * A 64BIT WINBINDD    --jerry
 225  ******************************************************************************/
 226
 227 struct winbindd_request {
 228         uint32_t length;
 229         enum winbindd_cmd cmd;   /* Winbindd command to execute */
 230         enum winbindd_cmd original_cmd;   /* Original Winbindd command
 231                                              issued to parent process */
 232         pid_t pid;               /* pid of calling process */
 233         uint32_t wb_flags;       /* generic flags */
 234         uint32_t flags;          /* flags relevant *only* to a given request */
 235         fstring domain_name;    /* name of domain for which the request applies */
 236
 237         union {
 238                 fstring winsreq;     /* WINS request */
 239                 fstring username;    /* getpwnam */
 240                 fstring groupname;   /* getgrnam */
 241                 uid_t uid;           /* getpwuid, uid_to_sid */
 242                 gid_t gid;           /* getgrgid, gid_to_sid */
 243                 struct {
 244                         /* We deliberatedly don't split into domain/user to
 245                            avoid having the client know what the separator
 246                            character is. */
 247                         fstring user;
 248                         fstring pass;
 249                         pstring require_membership_of_sid;
 250                         fstring krb5_cc_type;
 251                         uid_t uid;
 252                 } auth;              /* pam_winbind auth module */
 253                 struct {
 254                         uint8_t chal[8];
 255                         uint32_t logon_parameters;
 256                         fstring user;
 257                         fstring domain;
 258                         fstring lm_resp;
 259                         uint32_t lm_resp_len;
 260                         fstring nt_resp;
 261                         uint32_t nt_resp_len;
 262                         fstring workstation;
 263                         fstring require_membership_of_sid;
 264                 } auth_crap;
 265                 struct {
 266                     fstring user;
 267                     fstring oldpass;
 268                     fstring newpass;
 269                 } chauthtok;         /* pam_winbind passwd module */
 270                 struct {
 271                         fstring user;
 272                         fstring domain;
 273                         uint8_t new_nt_pswd[516];
 274                         uint16_t new_nt_pswd_len;
 275                         uint8_t old_nt_hash_enc[16];
 276                         uint16_t old_nt_hash_enc_len;
 277                         uint8_t new_lm_pswd[516];
 278                         uint16_t new_lm_pswd_len;
 279                         uint8_t old_lm_hash_enc[16];
 280                         uint16_t old_lm_hash_enc_len;
 281                 } chng_pswd_auth_crap;/* pam_winbind passwd module */
 282                 struct {
 283                         fstring user;
 284                         fstring krb5ccname;
 285                         uid_t uid;
 286                 } logoff;              /* pam_winbind session module */
 287                 fstring sid;         /* lookupsid, sid_to_[ug]id */
 288                 struct {
 289                         fstring dom_name;       /* lookupname */
 290                         fstring name;
 291                 } name;
 292                 uint32_t num_entries;  /* getpwent, getgrent */
 293                 struct {
 294                         fstring username;
 295                         fstring groupname;
 296                 } acct_mgt;
 297                 struct {
 298                         bool is_primary;
 299                         fstring dcname;
 300                 } init_conn;
 301                 struct {
 302                         fstring sid;
 303                         fstring name;
 304                 } dual_sid2id;
 305                 struct {
 306                         fstring sid;
 307                         uint32_t type;
 308                         uint32_t id;
 309                 } dual_idmapset;
 310                 bool list_all_domains;
 311
 312                 struct {
 313                         uid_t uid;
 314                         fstring user;
 315                         /* the effective uid of the client, must be the uid for 'user'.
 316                            This is checked by the main daemon, trusted by children. */
 317                         /* if the blobs are length zero, then this doesn't
 318                            produce an actual challenge response. It merely
 319                            succeeds if there are cached credentials available
 320                            that could be used. */
 321                         uint32_t initial_blob_len; /* blobs in extra_data */
 322                         uint32_t challenge_blob_len;
 323                 } ccache_ntlm_auth;
 324
 325                 /* padding -- needed to fix alignment between 32bit and 64bit libs.
 326                    The size is the sizeof the union without the padding aligned on
 327                    an 8 byte boundary.   --jerry */
 328
 329                 char padding[1560];
 330         } data;
 331         union {
 332                 SMB_TIME_T padding;
 333                 char *data;
 334         } extra_data;
 335         uint32_t extra_len;
 336         char null_term;
 337 };
 338
 339 /* Response values */
 340
 341 enum winbindd_result {
 342         WINBINDD_ERROR,
 343         WINBINDD_PENDING,
 344         WINBINDD_OK
 345 };
 346
 347 /* Winbind response structure */
 348
 349 /*******************************************************************************
 350  * This structure MUST be the same size in the 32bit and 64bit builds
 351  * for compatibility between /lib64/libnss_winbind.so and /lib/libnss_winbind.so
 352  *
 353  * DO NOT CHANGE THIS STRUCTURE WITHOUT TESTING THE 32BIT NSS LIB AGAINST
 354  * A 64BIT WINBINDD    --jerry
 355  ******************************************************************************/
 356
 357 struct winbindd_response {
 358
 359         /* Header information */
 360
 361         uint32_t length;                      /* Length of response */
 362         enum winbindd_result result;          /* Result code */
 363
 364         /* Fixed length return data */
 365
 366         union {
 367                 int interface_version;  /* Try to ensure this is always in the same spot... */
 368
 369                 fstring winsresp;               /* WINS response */
 370
 371                 /* getpwnam, getpwuid */
 372
 373                 struct winbindd_pw pw;
 374
 375                 /* getgrnam, getgrgid */
 376
 377                 struct winbindd_gr gr;
 378
 379                 uint32_t num_entries; /* getpwent, getgrent */
 380                 struct winbindd_sid {
 381                         fstring sid;        /* lookupname, [ug]id_to_sid */
 382                         int type;
 383                 } sid;
 384                 struct winbindd_name {
 385                         fstring dom_name;       /* lookupsid */
 386                         fstring name;
 387                         int type;
 388                 } name;
 389                 uid_t uid;          /* sid_to_uid */
 390                 gid_t gid;          /* sid_to_gid */
 391                 struct winbindd_info {
 392                         char winbind_separator;
 393                         fstring samba_version;
 394                 } info;
 395                 fstring domain_name;
 396                 fstring netbios_name;
 397                 fstring dc_name;
 398
 399                 struct auth_reply {
 400                         uint32_t nt_status;
 401                         fstring nt_status_string;
 402                         fstring error_string;
 403                         int pam_error;
 404                         char user_session_key[16];
 405                         char first_8_lm_hash[8];
 406                         fstring krb5ccname;
 407                         uint32_t reject_reason;
 408                         uint32_t padding;
 409                         struct policy_settings {
 410                                 uint32_t min_length_password;
 411                                 uint32_t password_history;
 412                                 uint32_t password_properties;
 413                                 uint32_t padding;
 414                                 SMB_TIME_T expire;
 415                                 SMB_TIME_T min_passwordage;
 416                         } policy;
 417                         struct info3_text {
 418                                 SMB_TIME_T logon_time;
 419                                 SMB_TIME_T logoff_time;
 420                                 SMB_TIME_T kickoff_time;
 421                                 SMB_TIME_T pass_last_set_time;
 422                                 SMB_TIME_T pass_can_change_time;
 423                                 SMB_TIME_T pass_must_change_time;
 424                                 uint32_t logon_count;
 425                                 uint32_t bad_pw_count;
 426                                 uint32_t user_rid;
 427                                 uint32_t group_rid;
 428                                 uint32_t num_groups;
 429                                 uint32_t user_flgs;
 430                                 uint32_t acct_flags;
 431                                 uint32_t num_other_sids;
 432                                 fstring dom_sid;
 433                                 fstring user_name;
 434                                 fstring full_name;
 435                                 fstring logon_script;
 436                                 fstring profile_path;
 437                                 fstring home_dir;
 438                                 fstring dir_drive;
 439                                 fstring logon_srv;
 440                                 fstring logon_dom;
 441                         } info3;
 442                 } auth;
 443                 struct {
 444                         fstring name;
 445                         fstring alt_name;
 446                         fstring sid;
 447                         bool native_mode;
 448                         bool active_directory;
 449                         bool primary;
 450                         uint32_t sequence_number;
 451                 } domain_info;
 452                 struct {
 453                         fstring acct_name;
 454                         fstring full_name;
 455                         fstring homedir;
 456                         fstring shell;
 457                         uint32_t primary_gid;
 458                         uint32_t group_rid;
 459                 } user_info;
 460                 struct {
 461                         uint32_t auth_blob_len; /* blob in extra_data */
 462                 } ccache_ntlm_auth;
 463         } data;
 464
 465         /* Variable length return data */
 466
 467         union {
 468                 SMB_TIME_T padding;
 469                 void *data;
 470         } extra_data;
 471 };
 472
 473 struct WINBINDD_MEMORY_CREDS {
 474         struct WINBINDD_MEMORY_CREDS *next, *prev;
 475         const char *username; /* lookup key. */
 476         uid_t uid;
 477         int ref_count;
 478         size_t len;
 479         uint8_t *nt_hash; /* Base pointer for the following 2 */
 480         uint8_t *lm_hash;
 481         char *pass;
 482 };
 483
 484 struct WINBINDD_CCACHE_ENTRY {
 485         struct WINBINDD_CCACHE_ENTRY *next, *prev;
 486         const char *principal_name;
 487         const char *ccname;
 488         const char *service;
 489         const char *username;
 490         const char *realm;
 491         struct WINBINDD_MEMORY_CREDS *cred_ptr;
 492         int ref_count;
 493         uid_t uid;
 494         time_t create_time;
 495         time_t renew_until;
 496         time_t refresh_time;
 497         struct timed_event *event;
 498 };
 499
 500 #endif