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
  91         if (!NT_STATUS_IS_OK(status)) {
  92                 printf("failed to connect to //%s/%s: %s\n",
  93                         host, share, nt_errstr(status));
  94                 return NULL;
  95         }
  96
  97         return cli;
  98 }
  99
 100 static bool sid_parse(void *mem_ctx,
 101                 struct torture_context *torture,
 102                 DATA_BLOB *data, size_t *offset,
 103                 struct dom_sid **psid)
 104 {
 105         size_t remain = data->length - *offset;
 106         int i;
 107
 108         *psid = talloc_zero(mem_ctx, struct dom_sid);
 109         torture_assert(torture, *psid != NULL, "out of memory");
 110
 111         torture_assert(torture, remain >= 8,
 112                         "invalid SID format");
 113
 114         (*psid)->sid_rev_num = CVAL(data->data, *offset);
 115         (*psid)->num_auths = CVAL(data->data, *offset + 1);
 116         memcpy((*psid)->id_auth, data->data + *offset + 2, 6);
 117
 118         (*offset) += 8;
 119         remain = data->length - *offset;
 120
 121         torture_assert(torture, remain >= ((*psid)->num_auths * 4),
 122                         "invalid sub_auth byte count");
 123         torture_assert(torture, (*psid)->num_auths >= 0,
 124                         "invalid sub_auth value");
 125         torture_assert(torture, (*psid)->num_auths <= 15,
 126                         "invalid sub_auth value");
 127
 128         (*psid)->sub_auths = talloc_array(mem_ctx, uint32_t,
 129                         (*psid)->num_auths);
 130         torture_assert(torture, (*psid)->sub_auths != NULL,
 131                         "out of memory");
 132
 133         for (i = 0; i < (*psid)->num_auths; i++) {
 134                 (*psid)->sub_auths[i] = IVAL(data->data, *offset);
 135                 (*offset) += 4;
 136         }
 137
 138         return true;
 139 }
 140
 141 static bool smb_raw_query_posix_whoami(void *mem_ctx,
 142                                 struct torture_context *torture,
 143                                 struct smbcli_state *cli,
 144                                 struct smb_whoami *whoami,
 145                                 unsigned max_data)
 146 {
 147         struct smb_trans2 tp;
 148         NTSTATUS status;
 149         size_t offset;
 150         int i;
 151
 152         uint16_t setup = TRANSACT2_QFSINFO;
 153         uint16_t info_level;
 154
 155         ZERO_STRUCTP(whoami);
 156
 157         tp.in.max_setup = 0;
 158         tp.in.flags = 0;
 159         tp.in.timeout = 0;
 160         tp.in.setup_count = 1;
 161         tp.in.max_param = 10;
 162         tp.in.max_data = (uint16_t)max_data;
 163         tp.in.setup = &setup;
 164         tp.in.trans_name = NULL;
 165         SSVAL(&info_level, 0, SMB_QFS_POSIX_WHOAMI);
 166         tp.in.params = data_blob_talloc(mem_ctx, &info_level, 2);
 167         tp.in.data = data_blob_talloc(mem_ctx, NULL, 0);
 168
 169         status = smb_raw_trans2(cli->tree, mem_ctx, &tp);
 170         torture_assert_ntstatus_equal(torture, status, NT_STATUS_OK,
 171                         "doing SMB_QFS_POSIX_WHOAMI");
 172
 173         /* Make sure we got back all the required fields. */
 174         torture_assert(torture, tp.out.params.length == 0,
 175                         "trans2 params should be empty");
 176         torture_assert(torture, tp.out.data.length >= WHOAMI_REQUIRED_SIZE,
 177                         "checking for required response fields");
 178
 179         whoami->mapping_flags = IVAL(tp.out.data.data, 0);
 180         whoami->mapping_mask = IVAL(tp.out.data.data, 4);
 181         whoami->server_uid = BVAL(tp.out.data.data, 8);
 182         whoami->server_gid = BVAL(tp.out.data.data, 16);
 183         whoami->num_gids = IVAL(tp.out.data.data, 24);
 184         whoami->num_sids = IVAL(tp.out.data.data, 28);
 185         whoami->num_sid_bytes = IVAL(tp.out.data.data, 32);
 186         whoami->reserved = IVAL(tp.out.data.data, 36);
 187
 188         /* The GID list and SID list are optional, depending on the count
 189          * and length fields.
 190          */
 191         if (whoami->num_sids != 0) {
 192                 torture_assert(torture, whoami->num_sid_bytes != 0,
 193                                 "SID count does not match byte count");
 194         }
 195
 196         printf("\tmapping_flags=0x%08x mapping_mask=0x%08x\n",
 197                         whoami->mapping_flags, whoami->mapping_mask);
 198         printf("\tserver UID=%llu GID=%llu\n",
 199                (unsigned long long)whoami->server_uid, (unsigned long long)whoami->server_gid);
 200         printf("\t%u GIDs, %u SIDs, %u SID bytes\n",
 201                         whoami->num_gids, whoami->num_sids,
 202                         whoami->num_sid_bytes);
 203
 204         offset = WHOAMI_REQUIRED_SIZE;
 205
 206         torture_assert_int_equal(torture, whoami->reserved, 0,
 207                         "invalid reserved field");
 208
 209         if (tp.out.data.length == offset) {
 210                 /* No SIDs or GIDs returned */
 211                 torture_assert_int_equal(torture, whoami->num_gids, 0,
 212                                 "invalid GID count");
 213                 torture_assert_int_equal(torture, whoami->num_sids, 0,
 214                                 "invalid SID count");
 215                 torture_assert_int_equal(torture, whoami->num_sid_bytes, 0,
 216                                 "invalid SID byte count");
 217                 return true;
 218         }
 219
 220         if (whoami->num_gids != 0) {
 221                 int remain = tp.out.data.length - offset;
 222                 int gid_bytes = whoami->num_gids * 8;
 223
 224                 if (whoami->num_sids == 0) {
 225                         torture_assert_int_equal(torture, remain, gid_bytes,
 226                                         "GID count does not match data length");
 227                 } else {
 228                         torture_assert(torture, remain > gid_bytes,
 229                                                 "invalid GID count");
 230                 }
 231
 232                 whoami->gid_list = talloc_array(mem_ctx, uint64_t, whoami->num_gids);
 233                 torture_assert(torture, whoami->gid_list != NULL, "out of memory");
 234
 235                 for (i = 0; i < whoami->num_gids; ++i) {
 236                         whoami->gid_list[i] = BVAL(tp.out.data.data, offset);
 237                         offset += 8;
 238                 }
 239         }
 240
 241         /* Check if there should be data left for the SID list. */
 242         if (tp.out.data.length == offset) {
 243                 torture_assert_int_equal(torture, whoami->num_sids, 0,
 244                                 "invalid SID count");
 245                 return true;
 246         }
 247
 248         /* All the remaining bytes must be the SID list. */
 249         torture_assert_int_equal(torture,
 250                 whoami->num_sid_bytes, (tp.out.data.length - offset),
 251                 "invalid SID byte count");
 252
 253         if (whoami->num_sids != 0) {
 254
 255                 whoami->sid_list = talloc_array(mem_ctx, struct dom_sid *,
 256                                 whoami->num_sids);
 257                 torture_assert(torture, whoami->sid_list != NULL,
 258                                 "out of memory");
 259
 260                 for (i = 0; i < whoami->num_sids; ++i) {
 261                         if (!sid_parse(mem_ctx, torture,
 262                                         &tp.out.data, &offset,
 263                                         &whoami->sid_list[i])) {
 264                                 return false;
 265                         }
 266
 267                 }
 268         }
 269
 270         /* We should be at the end of the response now. */
 271         torture_assert_int_equal(torture, tp.out.data.length, offset,
 272                         "trailing garbage bytes");
 273
 274         return true;
 275 }
 276
 277 bool torture_unix_whoami(struct torture_context *torture)
 278 {
 279         struct smbcli_state *cli;
 280         struct cli_credentials *anon_credentials;
 281         struct smb_whoami whoami;
 282
 283         if (!(cli = connect_to_server(torture, cmdline_credentials))) {
 284                 return false;
 285         }
 286
 287         /* Test basic authenticated mapping. */
 288         printf("calling SMB_QFS_POSIX_WHOAMI on an authenticated connection\n");
 289         if (!smb_raw_query_posix_whoami(torture, torture,
 290                                 cli, &whoami, 0xFFFF)) {
 291                 smbcli_tdis(cli);
 292                 return false;
 293         }
 294
 295         /* Test that the server drops the UID and GID list. */
 296         printf("calling SMB_QFS_POSIX_WHOAMI with a small buffer\n");
 297         if (!smb_raw_query_posix_whoami(torture, torture,
 298                                 cli, &whoami, 0x40)) {
 299                 smbcli_tdis(cli);
 300                 return false;
 301         }
 302
 303         torture_assert_int_equal(torture, whoami.num_gids, 0,
 304                         "invalid GID count");
 305         torture_assert_int_equal(torture, whoami.num_sids, 0,
 306                         "invalid SID count");
 307         torture_assert_int_equal(torture, whoami.num_sid_bytes, 0,
 308                         "invalid SID bytes count");
 309
 310         smbcli_tdis(cli);
 311
 312         printf("calling SMB_QFS_POSIX_WHOAMI on an anonymous connection\n");
 313         anon_credentials = cli_credentials_init_anon(torture);
 314
 315         if (!(cli = connect_to_server(torture, anon_credentials))) {
 316                 return false;
 317         }
 318
 319         if (!smb_raw_query_posix_whoami(torture, torture,
 320                                 cli, &whoami, 0xFFFF)) {
 321                 smbcli_tdis(cli);
 322                 return false;
 323         }
 324
 325         smbcli_tdis(cli);
 326
 327         /* Check that our anonymous login mapped us to guest on the server, but
 328          * only if the server supports this.
 329          */
 330         if (whoami.mapping_mask & SMB_WHOAMI_GUEST) {
 331                 printf("checking whether we were logged in as guest... %s\n",
 332                         whoami.mapping_flags & SMB_WHOAMI_GUEST ? "YES" : "NO");
 333                 torture_assert(torture, whoami.mapping_flags & SMB_WHOAMI_GUEST,
 334                                 "anonymous login did not map to guest");
 335         } else {
 336                 printf("server does not support SMB_WHOAMI_GUEST flag\n");
 337         }
 338
 339         return true;
 340 }
 341
 342 /* vim: set sts=8 sw=8 : */