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