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