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/interfaces.h"
  23 #include "libcli/raw/raw_proto.h"
  24 #include "torture/torture.h"
  25 #include "torture/basic/proto.h"
  26 #include "lib/cmdline/popt_common.h"
  27 #include "auth/credentials/credentials.h"
  28 #include "param/param.h"
  29 #include "libcli/resolve/resolve.h"
  30
  31 /* Size (in bytes) of the required fields in the SMBwhoami response. */
  32 #define WHOAMI_REQUIRED_SIZE    40
  33
  34 enum smb_whoami_flags {
  35     SMB_WHOAMI_GUEST = 0x1 /* Logged in as (or squashed to) guest */
  36 };
  37
  38 /*
  39    SMBWhoami - Query the user mapping performed by the server for the
  40    connected tree. This is a subcommand of the TRANS2_QFSINFO.
  41
  42    Returns:
  43        4 bytes unsigned -      mapping flags (smb_whoami_flags)
  44        4 bytes unsigned -      flags mask
  45
  46        8 bytes unsigned -      primary UID
  47        8 bytes unsigned -      primary GID
  48        4 bytes unsigned -      number of supplementary GIDs
  49        4 bytes unsigned -      number of SIDs
  50        4 bytes unsigned -      SID list byte count
  51        4 bytes -               pad / reserved (must be zero)
  52
  53        8 bytes unsigned[] -    list of GIDs (may be empty)
  54        DOM_SID[] -             list of SIDs (may be empty)
  55 */
  56
  57 struct smb_whoami
  58 {
  59         uint32_t        mapping_flags;
  60         uint32_t        mapping_mask;
  61         uint64_t        server_uid;
  62         uint64_t        server_gid;
  63         uint32_t        num_gids;
  64         uint32_t        num_sids;
  65         uint32_t        num_sid_bytes;
  66         uint32_t        reserved; /* Must be zero */
  67         uint64_t *      gid_list;
  68         struct dom_sid ** sid_list;
  69 };
  70
  71 static struct smbcli_state *connect_to_server(struct torture_context *tctx,
  72                 struct cli_credentials *creds)
  73 {
  74         NTSTATUS status;
  75         struct smbcli_state *cli;
  76
  77         const char *host = torture_setting_string(tctx, "host", NULL);
  78         const char *share = torture_setting_string(tctx, "share", NULL);
  79         struct smbcli_options options;
  80         struct smbcli_session_options session_options;
  81
  82         lp_smbcli_options(tctx->lp_ctx, &options);
  83         lp_smbcli_session_options(tctx->lp_ctx, &session_options);
  84
  85         status = smbcli_full_connection(tctx, &cli, host,
  86                                         lp_smb_ports(tctx->lp_ctx),
  87                                         share, NULL,
  88                                         creds, lp_resolve_context(tctx->lp_ctx),
  89                                         tctx->ev, &options, &session_options,
  90                                         lp_iconv_convenience(tctx->lp_ctx));
  91
  92         if (!NT_STATUS_IS_OK(status)) {
  93                 printf("failed to connect to //%s/%s: %s\n",
  94                         host, share, nt_errstr(status));
  95                 return NULL;
  96         }
  97
  98         return cli;
  99 }
 100
 101 static bool sid_parse(void *mem_ctx,
 102                 struct torture_context *torture,
 103                 DATA_BLOB *data, size_t *offset,
 104                 struct dom_sid **psid)
 105 {
 106         size_t remain = data->length - *offset;
 107         int i;
 108
 109         *psid = talloc_zero(mem_ctx, struct dom_sid);
 110         torture_assert(torture, *psid != NULL, "out of memory");
 111
 112         torture_assert(torture, remain >= 8,
 113                         "invalid SID format");
 114
 115         (*psid)->sid_rev_num = CVAL(data->data, *offset);
 116         (*psid)->num_auths = CVAL(data->data, *offset + 1);
 117         memcpy((*psid)->id_auth, data->data + *offset + 2, 6);
 118
 119         (*offset) += 8;
 120         remain = data->length - *offset;
 121
 122         torture_assert(torture, remain >= ((*psid)->num_auths * 4),
 123                         "invalid sub_auth byte count");
 124         torture_assert(torture, (*psid)->num_auths >= 0,
 125                         "invalid sub_auth value");
 126         torture_assert(torture, (*psid)->num_auths <= 15,
 127                         "invalid sub_auth value");
 128
 129         (*psid)->sub_auths = talloc_array(mem_ctx, uint32_t,
 130                         (*psid)->num_auths);
 131         torture_assert(torture, (*psid)->sub_auths != NULL,
 132                         "out of memory");
 133
 134         for (i = 0; i < (*psid)->num_auths; i++) {
 135                 (*psid)->sub_auths[i] = IVAL(data->data, *offset);
 136                 (*offset) += 4;
 137         }
 138
 139         return true;
 140 }
 141
 142 static bool smb_raw_query_posix_whoami(void *mem_ctx,
 143                                 struct torture_context *torture,
 144                                 struct smbcli_state *cli,
 145                                 struct smb_whoami *whoami,
 146                                 unsigned max_data)
 147 {
 148         struct smb_trans2 tp;
 149         NTSTATUS status;
 150         size_t offset;
 151         int i;
 152
 153         uint16_t setup = TRANSACT2_QFSINFO;
 154         uint16_t info_level;
 155
 156         ZERO_STRUCTP(whoami);
 157
 158         tp.in.max_setup = 0;
 159         tp.in.flags = 0;
 160         tp.in.timeout = 0;
 161         tp.in.setup_count = 1;
 162         tp.in.max_param = 10;
 163         tp.in.max_data = (uint16_t)max_data;
 164         tp.in.setup = &setup;
 165         tp.in.trans_name = NULL;
 166         SSVAL(&info_level, 0, SMB_QFS_POSIX_WHOAMI);
 167         tp.in.params = data_blob_talloc(mem_ctx, &info_level, 2);
 168         tp.in.data = data_blob_talloc(mem_ctx, NULL, 0);
 169
 170         status = smb_raw_trans2(cli->tree, mem_ctx, &tp);
 171         torture_assert_ntstatus_equal(torture, status, NT_STATUS_OK,
 172                         "doing SMB_QFS_POSIX_WHOAMI");
 173
 174         /* Make sure we got back all the required fields. */
 175         torture_assert(torture, tp.out.params.length == 0,
 176                         "trans2 params should be empty");
 177         torture_assert(torture, tp.out.data.length >= WHOAMI_REQUIRED_SIZE,
 178                         "checking for required response fields");
 179
 180         whoami->mapping_flags = IVAL(tp.out.data.data, 0);
 181         whoami->mapping_mask = IVAL(tp.out.data.data, 4);
 182         whoami->server_uid = BVAL(tp.out.data.data, 8);
 183         whoami->server_gid = BVAL(tp.out.data.data, 16);
 184         whoami->num_gids = IVAL(tp.out.data.data, 24);
 185         whoami->num_sids = IVAL(tp.out.data.data, 28);
 186         whoami->num_sid_bytes = IVAL(tp.out.data.data, 32);
 187         whoami->reserved = IVAL(tp.out.data.data, 36);
 188
 189         /* The GID list and SID list are optional, depending on the count
 190          * and length fields.
 191          */
 192         if (whoami->num_sids != 0) {
 193                 torture_assert(torture, whoami->num_sid_bytes != 0,
 194                                 "SID count does not match byte count");
 195         }
 196
 197         printf("\tmapping_flags=0x%08x mapping_mask=0x%08x\n",
 198                         whoami->mapping_flags, whoami->mapping_mask);
 199         printf("\tserver UID=%llu GID=%llu\n",
 200                (unsigned long long)whoami->server_uid, (unsigned long long)whoami->server_gid);
 201         printf("\t%u GIDs, %u SIDs, %u SID bytes\n",
 202                         whoami->num_gids, whoami->num_sids,
 203                         whoami->num_sid_bytes);
 204
 205         offset = WHOAMI_REQUIRED_SIZE;
 206
 207         torture_assert_int_equal(torture, whoami->reserved, 0,
 208                         "invalid reserved field");
 209
 210         if (tp.out.data.length == offset) {
 211                 /* No SIDs or GIDs returned */
 212                 torture_assert_int_equal(torture, whoami->num_gids, 0,
 213                                 "invalid GID count");
 214                 torture_assert_int_equal(torture, whoami->num_sids, 0,
 215                                 "invalid SID count");
 216                 torture_assert_int_equal(torture, whoami->num_sid_bytes, 0,
 217                                 "invalid SID byte count");
 218                 return true;
 219         }
 220
 221         if (whoami->num_gids != 0) {
 222                 int remain = tp.out.data.length - offset;
 223                 int gid_bytes = whoami->num_gids * 8;
 224
 225                 if (whoami->num_sids == 0) {
 226                         torture_assert_int_equal(torture, remain, gid_bytes,
 227                                         "GID count does not match data length");
 228                 } else {
 229                         torture_assert(torture, remain > gid_bytes,
 230                                                 "invalid GID count");
 231                 }
 232
 233                 whoami->gid_list = talloc_array(mem_ctx, uint64_t, whoami->num_gids);
 234                 torture_assert(torture, whoami->gid_list != NULL, "out of memory");
 235
 236                 for (i = 0; i < whoami->num_gids; ++i) {
 237                         whoami->gid_list[i] = BVAL(tp.out.data.data, offset);
 238                         offset += 8;
 239                 }
 240         }
 241
 242         /* Check if there should be data left for the SID list. */
 243         if (tp.out.data.length == offset) {
 244                 torture_assert_int_equal(torture, whoami->num_sids, 0,
 245                                 "invalid SID count");
 246                 return true;
 247         }
 248
 249         /* All the remaining bytes must be the SID list. */
 250         torture_assert_int_equal(torture,
 251                 whoami->num_sid_bytes, (tp.out.data.length - offset),
 252                 "invalid SID byte count");
 253
 254         if (whoami->num_sids != 0) {
 255
 256                 whoami->sid_list = talloc_array(mem_ctx, struct dom_sid *,
 257                                 whoami->num_sids);
 258                 torture_assert(torture, whoami->sid_list != NULL,
 259                                 "out of memory");
 260
 261                 for (i = 0; i < whoami->num_sids; ++i) {
 262                         if (!sid_parse(mem_ctx, torture,
 263                                         &tp.out.data, &offset,
 264                                         &whoami->sid_list[i])) {
 265                                 return false;
 266                         }
 267
 268                 }
 269         }
 270
 271         /* We should be at the end of the response now. */
 272         torture_assert_int_equal(torture, tp.out.data.length, offset,
 273                         "trailing garbage bytes");
 274
 275         return true;
 276 }
 277
 278 bool torture_unix_whoami(struct torture_context *torture)
 279 {
 280         struct smbcli_state *cli;
 281         struct cli_credentials *anon_credentials;
 282         struct smb_whoami whoami;
 283
 284         if (!(cli = connect_to_server(torture, cmdline_credentials))) {
 285                 return false;
 286         }
 287
 288         /* Test basic authenticated mapping. */
 289         printf("calling SMB_QFS_POSIX_WHOAMI on an authenticated connection\n");
 290         if (!smb_raw_query_posix_whoami(torture, torture,
 291                                 cli, &whoami, 0xFFFF)) {
 292                 smbcli_tdis(cli);
 293                 return false;
 294         }
 295
 296         /* Test that the server drops the UID and GID list. */
 297         printf("calling SMB_QFS_POSIX_WHOAMI with a small buffer\n");
 298         if (!smb_raw_query_posix_whoami(torture, torture,
 299                                 cli, &whoami, 0x40)) {
 300                 smbcli_tdis(cli);
 301                 return false;
 302         }
 303
 304         torture_assert_int_equal(torture, whoami.num_gids, 0,
 305                         "invalid GID count");
 306         torture_assert_int_equal(torture, whoami.num_sids, 0,
 307                         "invalid SID count");
 308         torture_assert_int_equal(torture, whoami.num_sid_bytes, 0,
 309                         "invalid SID bytes count");
 310
 311         smbcli_tdis(cli);
 312
 313         printf("calling SMB_QFS_POSIX_WHOAMI on an anonymous connection\n");
 314         anon_credentials = cli_credentials_init_anon(torture);
 315
 316         if (!(cli = connect_to_server(torture, anon_credentials))) {
 317                 return false;
 318         }
 319
 320         if (!smb_raw_query_posix_whoami(torture, torture,
 321                                 cli, &whoami, 0xFFFF)) {
 322                 smbcli_tdis(cli);
 323                 return false;
 324         }
 325
 326         smbcli_tdis(cli);
 327
 328         /* Check that our anonymous login mapped us to guest on the server, but
 329          * only if the server supports this.
 330          */
 331         if (whoami.mapping_mask & SMB_WHOAMI_GUEST) {
 332                 printf("checking whether we were logged in as guest... %s\n",
 333                         whoami.mapping_flags & SMB_WHOAMI_GUEST ? "YES" : "NO");
 334                 torture_assert(torture, whoami.mapping_flags & SMB_WHOAMI_GUEST,
 335                                 "anonymous login did not map to guest");
 336         } else {
 337                 printf("server does not support SMB_WHOAMI_GUEST flag\n");
 338         }
 339
 340         return true;
 341 }
 342
 343 /* vim: set sts=8 sw=8 : */