s3: Fix a typo
[Samba.git] / source4 / torture / unix / whoami.c
blob45b2775646db65724a40ecb0056797fc31df485e
1 /*
2 Test the SMB_WHOAMI Unix extension.
4 Copyright (C) 2007 James Peach
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.
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.
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/>.
20 #include "includes.h"
21 #include "libcli/libcli.h"
22 #include "libcli/raw/raw_proto.h"
23 #include "torture/torture.h"
24 #include "lib/cmdline/popt_common.h"
25 #include "auth/credentials/credentials.h"
26 #include "param/param.h"
27 #include "libcli/resolve/resolve.h"
29 /* Size (in bytes) of the required fields in the SMBwhoami response. */
30 #define WHOAMI_REQUIRED_SIZE 40
32 enum smb_whoami_flags {
33 SMB_WHOAMI_GUEST = 0x1 /* Logged in as (or squashed to) guest */
37 SMBWhoami - Query the user mapping performed by the server for the
38 connected tree. This is a subcommand of the TRANS2_QFSINFO.
40 Returns:
41 4 bytes unsigned - mapping flags (smb_whoami_flags)
42 4 bytes unsigned - flags mask
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)
51 8 bytes unsigned[] - list of GIDs (may be empty)
52 struct dom_sid[] - list of SIDs (may be empty)
55 struct smb_whoami
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;
69 static struct smbcli_state *connect_to_server(struct torture_context *tctx,
70 struct cli_credentials *creds)
72 NTSTATUS status;
73 struct smbcli_state *cli;
75 const char *host = torture_setting_string(tctx, "host", NULL);
76 const char *share = torture_setting_string(tctx, "share", NULL);
77 struct smbcli_options options;
78 struct smbcli_session_options session_options;
80 lpcfg_smbcli_options(tctx->lp_ctx, &options);
81 lpcfg_smbcli_session_options(tctx->lp_ctx, &session_options);
83 status = smbcli_full_connection(tctx, &cli, host,
84 lpcfg_smb_ports(tctx->lp_ctx),
85 share, NULL, lpcfg_socket_options(tctx->lp_ctx),
86 creds, lpcfg_resolve_context(tctx->lp_ctx),
87 tctx->ev, &options, &session_options,
88 lpcfg_gensec_settings(tctx, tctx->lp_ctx));
90 if (!NT_STATUS_IS_OK(status)) {
91 printf("failed to connect to //%s/%s: %s\n",
92 host, share, nt_errstr(status));
93 return NULL;
96 return cli;
99 static bool sid_parse(void *mem_ctx,
100 struct torture_context *torture,
101 DATA_BLOB *data, size_t *offset,
102 struct dom_sid **psid)
104 size_t remain = data->length - *offset;
105 int i;
107 *psid = talloc_zero(mem_ctx, struct dom_sid);
108 torture_assert(torture, *psid != NULL, "out of memory");
110 torture_assert(torture, remain >= 8,
111 "invalid SID format");
113 (*psid)->sid_rev_num = CVAL(data->data, *offset);
114 (*psid)->num_auths = CVAL(data->data, *offset + 1);
115 memcpy((*psid)->id_auth, data->data + *offset + 2, 6);
117 (*offset) += 8;
118 remain = data->length - *offset;
120 torture_assert(torture, remain >= ((*psid)->num_auths * 4),
121 "invalid sub_auth byte count");
122 torture_assert(torture, (*psid)->num_auths >= 0,
123 "invalid sub_auth value");
124 torture_assert(torture, (*psid)->num_auths <= 15,
125 "invalid sub_auth value");
127 for (i = 0; i < (*psid)->num_auths; i++) {
128 (*psid)->sub_auths[i] = IVAL(data->data, *offset);
129 (*offset) += 4;
132 return true;
135 static bool smb_raw_query_posix_whoami(void *mem_ctx,
136 struct torture_context *torture,
137 struct smbcli_state *cli,
138 struct smb_whoami *whoami,
139 unsigned max_data)
141 struct smb_trans2 tp;
142 NTSTATUS status;
143 size_t offset;
144 int i;
146 uint16_t setup = TRANSACT2_QFSINFO;
147 uint16_t info_level;
149 ZERO_STRUCTP(whoami);
151 tp.in.max_setup = 0;
152 tp.in.flags = 0;
153 tp.in.timeout = 0;
154 tp.in.setup_count = 1;
155 tp.in.max_param = 10;
156 tp.in.max_data = (uint16_t)max_data;
157 tp.in.setup = &setup;
158 tp.in.trans_name = NULL;
159 SSVAL(&info_level, 0, SMB_QFS_POSIX_WHOAMI);
160 tp.in.params = data_blob_talloc(mem_ctx, &info_level, 2);
161 tp.in.data = data_blob_talloc(mem_ctx, NULL, 0);
163 status = smb_raw_trans2(cli->tree, mem_ctx, &tp);
164 torture_assert_ntstatus_equal(torture, status, NT_STATUS_OK,
165 "doing SMB_QFS_POSIX_WHOAMI");
167 /* Make sure we got back all the required fields. */
168 torture_assert(torture, tp.out.params.length == 0,
169 "trans2 params should be empty");
170 torture_assert(torture, tp.out.data.length >= WHOAMI_REQUIRED_SIZE,
171 "checking for required response fields");
173 whoami->mapping_flags = IVAL(tp.out.data.data, 0);
174 whoami->mapping_mask = IVAL(tp.out.data.data, 4);
175 whoami->server_uid = BVAL(tp.out.data.data, 8);
176 whoami->server_gid = BVAL(tp.out.data.data, 16);
177 whoami->num_gids = IVAL(tp.out.data.data, 24);
178 whoami->num_sids = IVAL(tp.out.data.data, 28);
179 whoami->num_sid_bytes = IVAL(tp.out.data.data, 32);
180 whoami->reserved = IVAL(tp.out.data.data, 36);
182 /* The GID list and SID list are optional, depending on the count
183 * and length fields.
185 if (whoami->num_sids != 0) {
186 torture_assert(torture, whoami->num_sid_bytes != 0,
187 "SID count does not match byte count");
190 printf("\tmapping_flags=0x%08x mapping_mask=0x%08x\n",
191 whoami->mapping_flags, whoami->mapping_mask);
192 printf("\tserver UID=%llu GID=%llu\n",
193 (unsigned long long)whoami->server_uid, (unsigned long long)whoami->server_gid);
194 printf("\t%u GIDs, %u SIDs, %u SID bytes\n",
195 whoami->num_gids, whoami->num_sids,
196 whoami->num_sid_bytes);
198 offset = WHOAMI_REQUIRED_SIZE;
200 torture_assert_int_equal(torture, whoami->reserved, 0,
201 "invalid reserved field");
203 if (tp.out.data.length == offset) {
204 /* No SIDs or GIDs returned */
205 torture_assert_int_equal(torture, whoami->num_gids, 0,
206 "invalid GID count");
207 torture_assert_int_equal(torture, whoami->num_sids, 0,
208 "invalid SID count");
209 torture_assert_int_equal(torture, whoami->num_sid_bytes, 0,
210 "invalid SID byte count");
211 return true;
214 if (whoami->num_gids != 0) {
215 int remain = tp.out.data.length - offset;
216 int gid_bytes = whoami->num_gids * 8;
218 if (whoami->num_sids == 0) {
219 torture_assert_int_equal(torture, remain, gid_bytes,
220 "GID count does not match data length");
221 } else {
222 torture_assert(torture, remain > gid_bytes,
223 "invalid GID count");
226 whoami->gid_list = talloc_array(mem_ctx, uint64_t, whoami->num_gids);
227 torture_assert(torture, whoami->gid_list != NULL, "out of memory");
229 for (i = 0; i < whoami->num_gids; ++i) {
230 whoami->gid_list[i] = BVAL(tp.out.data.data, offset);
231 offset += 8;
235 /* Check if there should be data left for the SID list. */
236 if (tp.out.data.length == offset) {
237 torture_assert_int_equal(torture, whoami->num_sids, 0,
238 "invalid SID count");
239 return true;
242 /* All the remaining bytes must be the SID list. */
243 torture_assert_int_equal(torture,
244 whoami->num_sid_bytes, (tp.out.data.length - offset),
245 "invalid SID byte count");
247 if (whoami->num_sids != 0) {
249 whoami->sid_list = talloc_array(mem_ctx, struct dom_sid *,
250 whoami->num_sids);
251 torture_assert(torture, whoami->sid_list != NULL,
252 "out of memory");
254 for (i = 0; i < whoami->num_sids; ++i) {
255 if (!sid_parse(mem_ctx, torture,
256 &tp.out.data, &offset,
257 &whoami->sid_list[i])) {
258 return false;
264 /* We should be at the end of the response now. */
265 torture_assert_int_equal(torture, tp.out.data.length, offset,
266 "trailing garbage bytes");
268 return true;
271 bool torture_unix_whoami(struct torture_context *torture)
273 struct smbcli_state *cli;
274 struct cli_credentials *anon_credentials;
275 struct smb_whoami whoami;
277 if (!(cli = connect_to_server(torture, cmdline_credentials))) {
278 return false;
281 /* Test basic authenticated mapping. */
282 printf("calling SMB_QFS_POSIX_WHOAMI on an authenticated connection\n");
283 if (!smb_raw_query_posix_whoami(torture, torture,
284 cli, &whoami, 0xFFFF)) {
285 smbcli_tdis(cli);
286 return false;
289 /* Test that the server drops the UID and GID list. */
290 printf("calling SMB_QFS_POSIX_WHOAMI with a small buffer\n");
291 if (!smb_raw_query_posix_whoami(torture, torture,
292 cli, &whoami, 0x40)) {
293 smbcli_tdis(cli);
294 return false;
297 torture_assert_int_equal(torture, whoami.num_gids, 0,
298 "invalid GID count");
299 torture_assert_int_equal(torture, whoami.num_sids, 0,
300 "invalid SID count");
301 torture_assert_int_equal(torture, whoami.num_sid_bytes, 0,
302 "invalid SID bytes count");
304 smbcli_tdis(cli);
306 printf("calling SMB_QFS_POSIX_WHOAMI on an anonymous connection\n");
307 anon_credentials = cli_credentials_init_anon(torture);
309 if (!(cli = connect_to_server(torture, anon_credentials))) {
310 return false;
313 if (!smb_raw_query_posix_whoami(torture, torture,
314 cli, &whoami, 0xFFFF)) {
315 smbcli_tdis(cli);
316 return false;
319 smbcli_tdis(cli);
321 /* Check that our anonymous login mapped us to guest on the server, but
322 * only if the server supports this.
324 if (whoami.mapping_mask & SMB_WHOAMI_GUEST) {
325 printf("checking whether we were logged in as guest... %s\n",
326 whoami.mapping_flags & SMB_WHOAMI_GUEST ? "YES" : "NO");
327 torture_assert(torture, whoami.mapping_flags & SMB_WHOAMI_GUEST,
328 "anonymous login did not map to guest");
329 } else {
330 printf("server does not support SMB_WHOAMI_GUEST flag\n");
333 return true;
336 /* vim: set sts=8 sw=8 : */