source4/torture/unix/whoami.c

   1 /*
   2    Test the SMB_WHOAMI Unix extension.
   3
   4    Copyright (C) 2007 James Peach
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "includes.h"
  21 #include "libcli/libcli.h"
  22 #include "libcli/raw/raw_proto.h"
  23 #include "torture/torture.h"
  24 #include "torture/unix/proto.h"
  25 #include "lib/cmdline/popt_common.h"
  26 #include "auth/credentials/credentials.h"
  27 #include "param/param.h"
  28 #include "libcli/resolve/resolve.h"
  29 #include <ldb.h>
  30 #include "lib/util/util_ldb.h"
  31 #include "ldb_wrap.h"
  32 #include "dsdb/samdb/samdb.h"
  33 #include "../libcli/security/security.h"
  34
  35
  36 /* Size (in bytes) of the required fields in the SMBwhoami response. */
  37 #define WHOAMI_REQUIRED_SIZE    40
  38
  39 /*
  40    SMBWhoami - Query the user mapping performed by the server for the
  41    connected tree. This is a subcommand of the TRANS2_QFSINFO.
  42
  43    Returns:
  44        4 bytes unsigned -      mapping flags (smb_whoami_flags)
  45        4 bytes unsigned -      flags mask
  46
  47        8 bytes unsigned -      primary UID
  48        8 bytes unsigned -      primary GID
  49        4 bytes unsigned -      number of supplementary GIDs
  50        4 bytes unsigned -      number of SIDs
  51        4 bytes unsigned -      SID list byte count
  52        4 bytes -               pad / reserved (must be zero)
  53
  54        8 bytes unsigned[] -    list of GIDs (may be empty)
  55        struct dom_sid[] -             list of SIDs (may be empty)
  56 */
  57
  58 struct smb_whoami
  59 {
  60         uint32_t        mapping_flags;
  61         uint32_t        mapping_mask;
  62         uint64_t        server_uid;
  63         uint64_t        server_gid;
  64         uint32_t        num_gids;
  65         uint32_t        num_sids;
  66         uint32_t        num_sid_bytes;
  67         uint32_t        reserved; /* Must be zero */
  68         uint64_t *      gid_list;
  69         struct dom_sid ** sid_list;
  70 };
  71
  72 static struct smbcli_state *connect_to_server(struct torture_context *tctx,
  73                 struct cli_credentials *creds)
  74 {
  75         NTSTATUS status;
  76         struct smbcli_state *cli;
  77
  78         const char *host = torture_setting_string(tctx, "host", NULL);
  79         const char *share = torture_setting_string(tctx, "share", NULL);
  80         struct smbcli_options options;
  81         struct smbcli_session_options session_options;
  82
  83         lpcfg_smbcli_options(tctx->lp_ctx, &options);
  84         lpcfg_smbcli_session_options(tctx->lp_ctx, &session_options);
  85
  86         status = smbcli_full_connection(tctx, &cli, host,
  87                                         lpcfg_smb_ports(tctx->lp_ctx),
  88                                         share, NULL, lpcfg_socket_options(tctx->lp_ctx),
  89                                         creds, lpcfg_resolve_context(tctx->lp_ctx),
  90                                         tctx->ev, &options, &session_options,
  91                                         lpcfg_gensec_settings(tctx, tctx->lp_ctx));
  92
  93         if (!NT_STATUS_IS_OK(status)) {
  94                 torture_comment(tctx,
  95                                 "FATAL: Failed to connect to //%s/%s "
  96                                 "with %s - %s\n",
  97                                 host,
  98                                 share,
  99                                 cli_credentials_get_username(creds),
 100                                 nt_errstr(status));
 101                 return NULL;
 102         }
 103
 104         return cli;
 105 }
 106
 107 static bool whoami_sid_parse(void *mem_ctx,
 108                 struct torture_context *torture,
 109                 DATA_BLOB *data, size_t *offset,
 110                 struct dom_sid **psid)
 111 {
 112         size_t remain = data->length - *offset;
 113         int i;
 114
 115         *psid = talloc_zero(mem_ctx, struct dom_sid);
 116         torture_assert(torture, *psid != NULL, "out of memory");
 117
 118         torture_assert(torture, remain >= 8,
 119                         "invalid SID format");
 120
 121         (*psid)->sid_rev_num = CVAL(data->data, *offset);
 122         (*psid)->num_auths = CVAL(data->data, *offset + 1);
 123         memcpy((*psid)->id_auth, data->data + *offset + 2, 6);
 124
 125         (*offset) += 8;
 126         remain = data->length - *offset;
 127
 128         torture_assert(torture, remain >= ((*psid)->num_auths * 4),
 129                         "invalid sub_auth byte count");
 130         torture_assert(torture, (*psid)->num_auths >= 0,
 131                         "invalid sub_auth value");
 132         torture_assert(torture, (*psid)->num_auths <= 15,
 133                         "invalid sub_auth value");
 134
 135         for (i = 0; i < (*psid)->num_auths; i++) {
 136                 (*psid)->sub_auths[i] = IVAL(data->data, *offset);
 137                 (*offset) += 4;
 138         }
 139
 140         return true;
 141 }
 142
 143 static bool smb_raw_query_posix_whoami(void *mem_ctx,
 144                                 struct torture_context *torture,
 145                                 struct smbcli_state *cli,
 146                                 struct smb_whoami *whoami,
 147                                 unsigned max_data)
 148 {
 149         struct smb_trans2 tp;
 150         NTSTATUS status;
 151         size_t offset;
 152         int i;
 153
 154         uint16_t setup = TRANSACT2_QFSINFO;
 155         uint16_t info_level;
 156
 157         ZERO_STRUCTP(whoami);
 158
 159         tp.in.max_setup = 0;
 160         tp.in.flags = 0;
 161         tp.in.timeout = 0;
 162         tp.in.setup_count = 1;
 163         tp.in.max_param = 10;
 164         tp.in.max_data = (uint16_t)max_data;
 165         tp.in.setup = &setup;
 166         tp.in.trans_name = NULL;
 167         SSVAL(&info_level, 0, SMB_QFS_POSIX_WHOAMI);
 168         tp.in.params = data_blob_talloc(mem_ctx, &info_level, 2);
 169         tp.in.data = data_blob_talloc(mem_ctx, NULL, 0);
 170
 171         status = smb_raw_trans2(cli->tree, mem_ctx, &tp);
 172         torture_assert_ntstatus_equal(torture, status, NT_STATUS_OK,
 173                         "doing SMB_QFS_POSIX_WHOAMI");
 174
 175         /* Make sure we got back all the required fields. */
 176         torture_assert(torture, tp.out.params.length == 0,
 177                         "trans2 params should be empty");
 178         torture_assert(torture, tp.out.data.length >= WHOAMI_REQUIRED_SIZE,
 179                         "checking for required response fields");
 180
 181         whoami->mapping_flags = IVAL(tp.out.data.data, 0);
 182         whoami->mapping_mask = IVAL(tp.out.data.data, 4);
 183         whoami->server_uid = BVAL(tp.out.data.data, 8);
 184         whoami->server_gid = BVAL(tp.out.data.data, 16);
 185         whoami->num_gids = IVAL(tp.out.data.data, 24);
 186         whoami->num_sids = IVAL(tp.out.data.data, 28);
 187         whoami->num_sid_bytes = IVAL(tp.out.data.data, 32);
 188         whoami->reserved = IVAL(tp.out.data.data, 36);
 189
 190         /* The GID list and SID list are optional, depending on the count
 191          * and length fields.
 192          */
 193         if (whoami->num_sids != 0) {
 194                 torture_assert(torture, whoami->num_sid_bytes != 0,
 195                                 "SID count does not match byte count");
 196         }
 197
 198         printf("\tmapping_flags=0x%08x mapping_mask=0x%08x\n",
 199                         whoami->mapping_flags, whoami->mapping_mask);
 200         printf("\tserver UID=%llu GID=%llu\n",
 201                (unsigned long long)whoami->server_uid, (unsigned long long)whoami->server_gid);
 202         printf("\t%u GIDs, %u SIDs, %u SID bytes\n",
 203                         whoami->num_gids, whoami->num_sids,
 204                         whoami->num_sid_bytes);
 205
 206         offset = WHOAMI_REQUIRED_SIZE;
 207
 208         torture_assert_int_equal(torture, whoami->reserved, 0,
 209                         "invalid reserved field");
 210
 211         if (tp.out.data.length == offset) {
 212                 /* No SIDs or GIDs returned */
 213                 torture_assert_int_equal(torture, whoami->num_gids, 0,
 214                                 "invalid GID count");
 215                 torture_assert_int_equal(torture, whoami->num_sids, 0,
 216                                 "invalid SID count");
 217                 torture_assert_int_equal(torture, whoami->num_sid_bytes, 0,
 218                                 "invalid SID byte count");
 219                 return true;
 220         }
 221
 222         if (whoami->num_gids != 0) {
 223                 int remain = tp.out.data.length - offset;
 224                 int gid_bytes = whoami->num_gids * 8;
 225
 226                 if (whoami->num_sids == 0) {
 227                         torture_assert_int_equal(torture, remain, gid_bytes,
 228                                         "GID count does not match data length");
 229                 } else {
 230                         torture_assert(torture, remain > gid_bytes,
 231                                                 "invalid GID count");
 232                 }
 233
 234                 whoami->gid_list = talloc_array(mem_ctx, uint64_t, whoami->num_gids);
 235                 torture_assert(torture, whoami->gid_list != NULL, "out of memory");
 236
 237                 torture_comment(torture, "\tGIDs:\n");
 238
 239                 for (i = 0; i < whoami->num_gids; ++i) {
 240                         whoami->gid_list[i] = BVAL(tp.out.data.data, offset);
 241                         offset += 8;
 242                         torture_comment(torture, "\t\t%u\n", (unsigned int)whoami->gid_list[i]);
 243                 }
 244         }
 245
 246         /* Check if there should be data left for the SID list. */
 247         if (tp.out.data.length == offset) {
 248                 torture_assert_int_equal(torture, whoami->num_sids, 0,
 249                                 "invalid SID count");
 250                 return true;
 251         }
 252
 253         /* All the remaining bytes must be the SID list. */
 254         torture_assert_int_equal(torture,
 255                 whoami->num_sid_bytes, (tp.out.data.length - offset),
 256                 "invalid SID byte count");
 257
 258         if (whoami->num_sids != 0) {
 259
 260                 whoami->sid_list = talloc_array(mem_ctx, struct dom_sid *,
 261                                 whoami->num_sids);
 262                 torture_assert(torture, whoami->sid_list != NULL,
 263                                 "out of memory");
 264
 265                 torture_comment(torture, "\tSIDs:\n");
 266
 267                 for (i = 0; i < whoami->num_sids; ++i) {
 268                         if (!whoami_sid_parse(mem_ctx, torture,
 269                                         &tp.out.data, &offset,
 270                                         &whoami->sid_list[i])) {
 271                                 return false;
 272                         }
 273
 274                         torture_comment(torture, "\t\t%s\n",
 275                                         dom_sid_string(torture, whoami->sid_list[i]));
 276                 }
 277         }
 278
 279         /* We should be at the end of the response now. */
 280         torture_assert_int_equal(torture, tp.out.data.length, offset,
 281                         "trailing garbage bytes");
 282
 283         return true;
 284 }
 285
 286 static bool test_against_ldap(struct torture_context *torture, struct ldb_context *ldb, bool is_dc,
 287                               struct smb_whoami *whoami)
 288 {
 289         struct ldb_message *msg;
 290         struct ldb_message_element *el;
 291
 292         const char *attrs[] = { "tokenGroups", NULL };
 293         int i;
 294
 295         torture_assert_int_equal(torture, dsdb_search_one(ldb, torture, &msg, NULL, LDB_SCOPE_BASE, attrs, 0, NULL), LDB_SUCCESS, "searching for tokenGroups");
 296         el = ldb_msg_find_element(msg, "tokenGroups");
 297         torture_assert(torture, el, "obtaining tokenGroups");
 298         torture_assert(torture, el->num_values > 0, "Number of SIDs from LDAP needs to be more than 0");
 299         torture_assert(torture, whoami->num_sids > 0, "Number of SIDs from LDAP needs to be more than 0");
 300
 301         if (is_dc) {
 302                 torture_assert_int_equal(torture, el->num_values, whoami->num_sids, "Number of SIDs from LDAP and number of SIDs from CIFS does not match!");
 303
 304                 for (i = 0; i < el->num_values; i++) {
 305                         struct dom_sid *sid = talloc(torture, struct dom_sid);
 306                         torture_assert(torture, sid != NULL, "talloc failed");
 307
 308                         torture_assert(torture,
 309                                        sid_parse(el->values[i].data,
 310                                                  el->values[i].length, sid),
 311                                        "sid parse failed");
 312                         torture_assert_str_equal(torture, dom_sid_string(sid, sid), dom_sid_string(sid, whoami->sid_list[i]), "SID from LDAP and SID from CIFS does not match!");
 313                         talloc_free(sid);
 314                 }
 315         } else {
 316                 unsigned int num_domain_sids_dc = 0, num_domain_sids_member = 0;
 317                 struct dom_sid *user_sid = talloc(torture, struct dom_sid);
 318                 struct dom_sid *dom_sid = talloc(torture, struct dom_sid);
 319                 struct dom_sid *dc_sids = talloc_array(torture, struct dom_sid, el->num_values);
 320                 struct dom_sid *member_sids = talloc_array(torture, struct dom_sid, whoami->num_sids);
 321                 torture_assert(torture, user_sid != NULL, "talloc failed");
 322                 torture_assert(torture, sid_parse(el->values[0].data,
 323                                                   el->values[0].length,
 324                                                   user_sid),
 325                                "sid parse failed");
 326                 torture_assert_ntstatus_equal(torture, dom_sid_split_rid(torture, user_sid, &dom_sid, NULL), NT_STATUS_OK, "failed to split domain SID from user SID");
 327                 for (i = 0; i < el->num_values; i++) {
 328                         struct dom_sid *sid = talloc(dc_sids, struct dom_sid);
 329                         torture_assert(torture, sid != NULL, "talloc failed");
 330
 331                         torture_assert(torture,
 332                                        sid_parse(el->values[i].data,
 333                                                  el->values[i].length,
 334                                                  sid),
 335                                        "sid parse failed");
 336                         if (dom_sid_in_domain(dom_sid, sid)) {
 337                                 dc_sids[num_domain_sids_dc] = *sid;
 338                                 num_domain_sids_dc++;
 339                         }
 340                         talloc_free(sid);
 341                 }
 342
 343                 for (i = 0; i < whoami->num_sids; i++) {
 344                         if (dom_sid_in_domain(dom_sid, whoami->sid_list[i])) {
 345                                 member_sids[num_domain_sids_member] = *whoami->sid_list[i];
 346                                 num_domain_sids_member++;
 347                         }
 348                 }
 349
 350                 torture_assert_int_equal(torture, num_domain_sids_dc, num_domain_sids_member, "Number of Domain SIDs from LDAP DC and number of SIDs from CIFS member does not match!");
 351                 for (i = 0; i < num_domain_sids_dc; i++) {
 352                         torture_assert_str_equal(torture, dom_sid_string(dc_sids, &dc_sids[i]), dom_sid_string(member_sids, &member_sids[i]), "Domain SID from LDAP DC and SID from CIFS member server does not match!");
 353                 }
 354                 talloc_free(dc_sids);
 355                 talloc_free(member_sids);
 356         }
 357         return true;
 358 }
 359
 360 bool torture_unix_whoami(struct torture_context *torture)
 361 {
 362         struct smbcli_state *cli;
 363         struct smb_whoami whoami;
 364         bool ret = false;
 365         struct ldb_context *ldb;
 366         const char *addc, *host;
 367
 368         cli = connect_to_server(torture, popt_get_cmdline_credentials());
 369         torture_assert(torture, cli, "connecting to server with authenticated credentials");
 370
 371         /* Test basic authenticated mapping. */
 372         torture_assert_goto(torture, smb_raw_query_posix_whoami(torture, torture,
 373                                                        cli, &whoami, 0xFFFF), ret, fail,
 374                             "calling SMB_QFS_POSIX_WHOAMI on an authenticated connection");
 375
 376         /* Check that our anonymous login mapped us to guest on the server, but
 377          * only if the server supports this.
 378          */
 379         if (whoami.mapping_mask & SMB_WHOAMI_GUEST) {
 380                 bool guest = whoami.mapping_flags & SMB_WHOAMI_GUEST;
 381                 torture_comment(torture, "checking whether we were logged in as guest... %s\n",
 382                         guest ? "YES" : "NO");
 383                 torture_assert(torture,
 384                         cli_credentials_is_anonymous(
 385                                 popt_get_cmdline_credentials()) == guest,
 386                                "login did not credentials map to guest");
 387         } else {
 388                 torture_comment(torture, "server does not support SMB_WHOAMI_GUEST flag\n");
 389         }
 390
 391         addc = torture_setting_string(torture, "addc", NULL);
 392         host = torture_setting_string(torture, "host", NULL);
 393
 394         if (addc) {
 395                 ldb = ldb_wrap_connect(torture, torture->ev, torture->lp_ctx, talloc_asprintf(torture, "ldap://%s", addc),
 396                                        NULL, popt_get_cmdline_credentials(), 0);
 397                 torture_assert(torture, ldb, "ldb connect failed");
 398
 399                 /* We skip this testing if we could not contact the LDAP server */
 400                 if (!test_against_ldap(torture, ldb, strcasecmp(addc, host) == 0, &whoami)) {
 401                         goto fail;
 402                 }
 403         }
 404
 405         /* Test that the server drops the UID and GID list. */
 406         torture_assert_goto(torture, smb_raw_query_posix_whoami(torture, torture,
 407                                                   cli, &whoami, 0x40), ret, fail,
 408                        "calling SMB_QFS_POSIX_WHOAMI with a small buffer\n");
 409
 410         torture_assert_int_equal(torture, whoami.num_gids, 0,
 411                         "invalid GID count");
 412         torture_assert_int_equal(torture, whoami.num_sids, 0,
 413                         "invalid SID count");
 414         torture_assert_int_equal(torture, whoami.num_sid_bytes, 0,
 415                         "invalid SID bytes count");
 416
 417         smbcli_tdis(cli);
 418
 419         return true;
 420 fail:
 421
 422         smbcli_tdis(cli);
 423         return ret;
 424 }
 425
 426 /* vim: set sts=8 sw=8 : */