After technical consultation, add Steven Danneman's <steven.danneman@isilon.com>...
[Samba.git] / source / libsmb / clifsinfo.c
blob0005c3908ac1aedeecabfdfcf56be28f7d2494be
1 /*
2 Unix SMB/CIFS implementation.
3 FS info functions
4 Copyright (C) Stefan (metze) Metzmacher 2003
5 Copyright (C) Jeremy Allison 2007
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "includes.h"
23 /****************************************************************************
24 Get UNIX extensions version info.
25 ****************************************************************************/
27 bool cli_unix_extensions_version(struct cli_state *cli, uint16 *pmajor, uint16 *pminor,
28 uint32 *pcaplow, uint32 *pcaphigh)
30 bool ret = False;
31 uint16 setup;
32 char param[2];
33 char *rparam=NULL, *rdata=NULL;
34 unsigned int rparam_count=0, rdata_count=0;
36 setup = TRANSACT2_QFSINFO;
38 SSVAL(param,0,SMB_QUERY_CIFS_UNIX_INFO);
40 if (!cli_send_trans(cli, SMBtrans2,
41 NULL,
42 0, 0,
43 &setup, 1, 0,
44 param, 2, 0,
45 NULL, 0, 560)) {
46 goto cleanup;
49 if (!cli_receive_trans(cli, SMBtrans2,
50 &rparam, &rparam_count,
51 &rdata, &rdata_count)) {
52 goto cleanup;
55 if (cli_is_error(cli)) {
56 ret = False;
57 goto cleanup;
58 } else {
59 ret = True;
62 if (rdata_count < 12) {
63 goto cleanup;
66 *pmajor = SVAL(rdata,0);
67 *pminor = SVAL(rdata,2);
68 cli->posix_capabilities = *pcaplow = IVAL(rdata,4);
69 *pcaphigh = IVAL(rdata,8);
71 /* todo: but not yet needed
72 * return the other stuff
75 cleanup:
76 SAFE_FREE(rparam);
77 SAFE_FREE(rdata);
79 return ret;
82 /****************************************************************************
83 Set UNIX extensions capabilities.
84 ****************************************************************************/
86 bool cli_set_unix_extensions_capabilities(struct cli_state *cli, uint16 major, uint16 minor,
87 uint32 caplow, uint32 caphigh)
89 bool ret = False;
90 uint16 setup;
91 char param[4];
92 char data[12];
93 char *rparam=NULL, *rdata=NULL;
94 unsigned int rparam_count=0, rdata_count=0;
96 setup = TRANSACT2_SETFSINFO;
98 SSVAL(param,0,0);
99 SSVAL(param,2,SMB_SET_CIFS_UNIX_INFO);
101 SSVAL(data,0,major);
102 SSVAL(data,2,minor);
103 SIVAL(data,4,caplow);
104 SIVAL(data,8,caphigh);
106 if (!cli_send_trans(cli, SMBtrans2,
107 NULL,
108 0, 0,
109 &setup, 1, 0,
110 param, 4, 0,
111 data, 12, 560)) {
112 goto cleanup;
115 if (!cli_receive_trans(cli, SMBtrans2,
116 &rparam, &rparam_count,
117 &rdata, &rdata_count)) {
118 goto cleanup;
121 if (cli_is_error(cli)) {
122 ret = False;
123 goto cleanup;
124 } else {
125 ret = True;
128 cleanup:
129 SAFE_FREE(rparam);
130 SAFE_FREE(rdata);
132 return ret;
135 bool cli_get_fs_attr_info(struct cli_state *cli, uint32 *fs_attr)
137 bool ret = False;
138 uint16 setup;
139 char param[2];
140 char *rparam=NULL, *rdata=NULL;
141 unsigned int rparam_count=0, rdata_count=0;
143 if (!cli||!fs_attr)
144 smb_panic("cli_get_fs_attr_info() called with NULL Pionter!");
146 setup = TRANSACT2_QFSINFO;
148 SSVAL(param,0,SMB_QUERY_FS_ATTRIBUTE_INFO);
150 if (!cli_send_trans(cli, SMBtrans2,
151 NULL,
152 0, 0,
153 &setup, 1, 0,
154 param, 2, 0,
155 NULL, 0, 560)) {
156 goto cleanup;
159 if (!cli_receive_trans(cli, SMBtrans2,
160 &rparam, &rparam_count,
161 &rdata, &rdata_count)) {
162 goto cleanup;
165 if (cli_is_error(cli)) {
166 ret = False;
167 goto cleanup;
168 } else {
169 ret = True;
172 if (rdata_count < 12) {
173 goto cleanup;
176 *fs_attr = IVAL(rdata,0);
178 /* todo: but not yet needed
179 * return the other stuff
182 cleanup:
183 SAFE_FREE(rparam);
184 SAFE_FREE(rdata);
186 return ret;
189 bool cli_get_fs_volume_info_old(struct cli_state *cli, fstring volume_name, uint32 *pserial_number)
191 bool ret = False;
192 uint16 setup;
193 char param[2];
194 char *rparam=NULL, *rdata=NULL;
195 unsigned int rparam_count=0, rdata_count=0;
196 unsigned char nlen;
198 setup = TRANSACT2_QFSINFO;
200 SSVAL(param,0,SMB_INFO_VOLUME);
202 if (!cli_send_trans(cli, SMBtrans2,
203 NULL,
204 0, 0,
205 &setup, 1, 0,
206 param, 2, 0,
207 NULL, 0, 560)) {
208 goto cleanup;
211 if (!cli_receive_trans(cli, SMBtrans2,
212 &rparam, &rparam_count,
213 &rdata, &rdata_count)) {
214 goto cleanup;
217 if (cli_is_error(cli)) {
218 ret = False;
219 goto cleanup;
220 } else {
221 ret = True;
224 if (rdata_count < 5) {
225 goto cleanup;
228 if (pserial_number) {
229 *pserial_number = IVAL(rdata,0);
231 nlen = CVAL(rdata,l2_vol_cch);
232 clistr_pull(cli, volume_name, rdata + l2_vol_szVolLabel, sizeof(fstring), nlen, STR_NOALIGN);
234 /* todo: but not yet needed
235 * return the other stuff
238 cleanup:
239 SAFE_FREE(rparam);
240 SAFE_FREE(rdata);
242 return ret;
245 bool cli_get_fs_volume_info(struct cli_state *cli, fstring volume_name, uint32 *pserial_number, time_t *pdate)
247 bool ret = False;
248 uint16 setup;
249 char param[2];
250 char *rparam=NULL, *rdata=NULL;
251 unsigned int rparam_count=0, rdata_count=0;
252 unsigned int nlen;
254 setup = TRANSACT2_QFSINFO;
256 SSVAL(param,0,SMB_QUERY_FS_VOLUME_INFO);
258 if (!cli_send_trans(cli, SMBtrans2,
259 NULL,
260 0, 0,
261 &setup, 1, 0,
262 param, 2, 0,
263 NULL, 0, 560)) {
264 goto cleanup;
267 if (!cli_receive_trans(cli, SMBtrans2,
268 &rparam, &rparam_count,
269 &rdata, &rdata_count)) {
270 goto cleanup;
273 if (cli_is_error(cli)) {
274 ret = False;
275 goto cleanup;
276 } else {
277 ret = True;
280 if (rdata_count < 19) {
281 goto cleanup;
284 if (pdate) {
285 struct timespec ts;
286 ts = interpret_long_date(rdata);
287 *pdate = ts.tv_sec;
289 if (pserial_number) {
290 *pserial_number = IVAL(rdata,8);
292 nlen = IVAL(rdata,12);
293 clistr_pull(cli, volume_name, rdata + 18, sizeof(fstring), nlen, STR_UNICODE);
295 /* todo: but not yet needed
296 * return the other stuff
299 cleanup:
300 SAFE_FREE(rparam);
301 SAFE_FREE(rdata);
303 return ret;
306 /******************************************************************************
307 Send/receive the request encryption blob.
308 ******************************************************************************/
310 static NTSTATUS enc_blob_send_receive(struct cli_state *cli, DATA_BLOB *in, DATA_BLOB *out, DATA_BLOB *param_out)
312 uint16 setup;
313 char param[4];
314 char *rparam=NULL, *rdata=NULL;
315 unsigned int rparam_count=0, rdata_count=0;
316 NTSTATUS status = NT_STATUS_OK;
318 setup = TRANSACT2_SETFSINFO;
320 SSVAL(param,0,0);
321 SSVAL(param,2,SMB_REQUEST_TRANSPORT_ENCRYPTION);
323 if (!cli_send_trans(cli, SMBtrans2,
324 NULL,
325 0, 0,
326 &setup, 1, 0,
327 param, 4, 0,
328 (char *)in->data, in->length, CLI_BUFFER_SIZE)) {
329 status = cli_nt_error(cli);
330 goto out;
333 if (!cli_receive_trans(cli, SMBtrans2,
334 &rparam, &rparam_count,
335 &rdata, &rdata_count)) {
336 status = cli_nt_error(cli);
337 goto out;
340 if (cli_is_error(cli)) {
341 status = cli_nt_error(cli);
342 if (!NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
343 goto out;
347 *out = data_blob(rdata, rdata_count);
348 *param_out = data_blob(rparam, rparam_count);
350 out:
352 SAFE_FREE(rparam);
353 SAFE_FREE(rdata);
354 return status;
357 /******************************************************************************
358 Make a client state struct.
359 ******************************************************************************/
361 static struct smb_trans_enc_state *make_cli_enc_state(enum smb_trans_enc_type smb_enc_type)
363 struct smb_trans_enc_state *es = NULL;
364 es = SMB_MALLOC_P(struct smb_trans_enc_state);
365 if (!es) {
366 return NULL;
368 ZERO_STRUCTP(es);
369 es->smb_enc_type = smb_enc_type;
371 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
372 if (smb_enc_type == SMB_TRANS_ENC_GSS) {
373 es->s.gss_state = SMB_MALLOC_P(struct smb_tran_enc_state_gss);
374 if (!es->s.gss_state) {
375 SAFE_FREE(es);
376 return NULL;
378 ZERO_STRUCTP(es->s.gss_state);
380 #endif
381 return es;
384 /******************************************************************************
385 Start a raw ntlmssp encryption.
386 ******************************************************************************/
388 NTSTATUS cli_raw_ntlm_smb_encryption_start(struct cli_state *cli,
389 const char *user,
390 const char *pass,
391 const char *domain)
393 DATA_BLOB blob_in = data_blob_null;
394 DATA_BLOB blob_out = data_blob_null;
395 DATA_BLOB param_out = data_blob_null;
396 NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
397 struct smb_trans_enc_state *es = make_cli_enc_state(SMB_TRANS_ENC_NTLM);
399 if (!es) {
400 return NT_STATUS_NO_MEMORY;
402 status = ntlmssp_client_start(&es->s.ntlmssp_state);
403 if (!NT_STATUS_IS_OK(status)) {
404 goto fail;
407 ntlmssp_want_feature(es->s.ntlmssp_state, NTLMSSP_FEATURE_SESSION_KEY);
408 es->s.ntlmssp_state->neg_flags |= (NTLMSSP_NEGOTIATE_SIGN|NTLMSSP_NEGOTIATE_SEAL);
410 if (!NT_STATUS_IS_OK(status = ntlmssp_set_username(es->s.ntlmssp_state, user))) {
411 goto fail;
413 if (!NT_STATUS_IS_OK(status = ntlmssp_set_domain(es->s.ntlmssp_state, domain))) {
414 goto fail;
416 if (!NT_STATUS_IS_OK(status = ntlmssp_set_password(es->s.ntlmssp_state, pass))) {
417 goto fail;
420 do {
421 status = ntlmssp_update(es->s.ntlmssp_state, blob_in, &blob_out);
422 data_blob_free(&blob_in);
423 data_blob_free(&param_out);
424 if (NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED) || NT_STATUS_IS_OK(status)) {
425 NTSTATUS trans_status = enc_blob_send_receive(cli,
426 &blob_out,
427 &blob_in,
428 &param_out);
429 if (!NT_STATUS_EQUAL(trans_status,
430 NT_STATUS_MORE_PROCESSING_REQUIRED) &&
431 !NT_STATUS_IS_OK(trans_status)) {
432 status = trans_status;
433 } else {
434 if (param_out.length == 2) {
435 es->enc_ctx_num = SVAL(param_out.data, 0);
439 data_blob_free(&blob_out);
440 } while (NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED));
442 data_blob_free(&blob_in);
444 if (NT_STATUS_IS_OK(status)) {
445 /* Replace the old state, if any. */
446 if (cli->trans_enc_state) {
447 common_free_encryption_state(&cli->trans_enc_state);
449 cli->trans_enc_state = es;
450 cli->trans_enc_state->enc_on = True;
451 es = NULL;
454 fail:
456 common_free_encryption_state(&es);
457 return status;
460 #if defined(HAVE_GSSAPI) && defined(HAVE_KRB5)
462 #ifndef SMB_GSS_REQUIRED_FLAGS
463 #define SMB_GSS_REQUIRED_FLAGS (GSS_C_CONF_FLAG|GSS_C_INTEG_FLAG|GSS_C_MUTUAL_FLAG|GSS_C_REPLAY_FLAG|GSS_C_SEQUENCE_FLAG)
464 #endif
466 /******************************************************************************
467 Get client gss blob to send to a server.
468 ******************************************************************************/
470 static NTSTATUS make_cli_gss_blob(struct smb_trans_enc_state *es,
471 const char *service,
472 const char *host,
473 NTSTATUS status_in,
474 DATA_BLOB spnego_blob_in,
475 DATA_BLOB *p_blob_out)
477 const char *krb_mechs[] = {OID_KERBEROS5, NULL};
478 OM_uint32 ret;
479 OM_uint32 min;
480 gss_name_t srv_name;
481 gss_buffer_desc input_name;
482 gss_buffer_desc *p_tok_in;
483 gss_buffer_desc tok_out, tok_in;
484 DATA_BLOB blob_out = data_blob_null;
485 DATA_BLOB blob_in = data_blob_null;
486 char *host_princ_s = NULL;
487 OM_uint32 ret_flags = 0;
488 NTSTATUS status = NT_STATUS_OK;
490 gss_OID_desc nt_hostbased_service =
491 {10, CONST_DISCARD(char *,"\x2a\x86\x48\x86\xf7\x12\x01\x02\x01\x04")};
493 memset(&tok_out, '\0', sizeof(tok_out));
495 /* Get a ticket for the service@host */
496 if (asprintf(&host_princ_s, "%s@%s", service, host) == -1) {
497 return NT_STATUS_NO_MEMORY;
500 input_name.value = host_princ_s;
501 input_name.length = strlen(host_princ_s) + 1;
503 ret = gss_import_name(&min,
504 &input_name,
505 &nt_hostbased_service,
506 &srv_name);
508 if (ret != GSS_S_COMPLETE) {
509 SAFE_FREE(host_princ_s);
510 return map_nt_error_from_gss(ret, min);
513 if (spnego_blob_in.length == 0) {
514 p_tok_in = GSS_C_NO_BUFFER;
515 } else {
516 /* Remove the SPNEGO wrapper */
517 if (!spnego_parse_auth_response(spnego_blob_in, status_in, OID_KERBEROS5, &blob_in)) {
518 status = NT_STATUS_UNSUCCESSFUL;
519 goto fail;
521 tok_in.value = blob_in.data;
522 tok_in.length = blob_in.length;
523 p_tok_in = &tok_in;
526 ret = gss_init_sec_context(&min,
527 GSS_C_NO_CREDENTIAL, /* Use our default cred. */
528 &es->s.gss_state->gss_ctx,
529 srv_name,
530 GSS_C_NO_OID, /* default OID. */
531 GSS_C_MUTUAL_FLAG | GSS_C_REPLAY_FLAG | GSS_C_SEQUENCE_FLAG,
532 GSS_C_INDEFINITE, /* requested ticket lifetime. */
533 NULL, /* no channel bindings */
534 p_tok_in,
535 NULL, /* ignore mech type */
536 &tok_out,
537 &ret_flags,
538 NULL); /* ignore time_rec */
540 status = map_nt_error_from_gss(ret, min);
541 if (!NT_STATUS_IS_OK(status) && !NT_STATUS_EQUAL(status,NT_STATUS_MORE_PROCESSING_REQUIRED)) {
542 ADS_STATUS adss = ADS_ERROR_GSS(ret, min);
543 DEBUG(10,("make_cli_gss_blob: gss_init_sec_context failed with %s\n",
544 ads_errstr(adss)));
545 goto fail;
548 if ((ret_flags & SMB_GSS_REQUIRED_FLAGS) != SMB_GSS_REQUIRED_FLAGS) {
549 status = NT_STATUS_ACCESS_DENIED;
552 blob_out = data_blob(tok_out.value, tok_out.length);
554 /* Wrap in an SPNEGO wrapper */
555 *p_blob_out = gen_negTokenTarg(krb_mechs, blob_out);
557 fail:
559 data_blob_free(&blob_out);
560 data_blob_free(&blob_in);
561 SAFE_FREE(host_princ_s);
562 gss_release_name(&min, &srv_name);
563 if (tok_out.value) {
564 gss_release_buffer(&min, &tok_out);
566 return status;
569 /******************************************************************************
570 Start a SPNEGO gssapi encryption context.
571 ******************************************************************************/
573 NTSTATUS cli_gss_smb_encryption_start(struct cli_state *cli)
575 DATA_BLOB blob_recv = data_blob_null;
576 DATA_BLOB blob_send = data_blob_null;
577 DATA_BLOB param_out = data_blob_null;
578 NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
579 fstring fqdn;
580 const char *servicename;
581 struct smb_trans_enc_state *es = make_cli_enc_state(SMB_TRANS_ENC_GSS);
583 if (!es) {
584 return NT_STATUS_NO_MEMORY;
587 name_to_fqdn(fqdn, cli->desthost);
588 strlower_m(fqdn);
590 servicename = "cifs";
591 status = make_cli_gss_blob(es, servicename, fqdn, NT_STATUS_OK, blob_recv, &blob_send);
592 if (!NT_STATUS_EQUAL(status,NT_STATUS_MORE_PROCESSING_REQUIRED)) {
593 servicename = "host";
594 status = make_cli_gss_blob(es, servicename, fqdn, NT_STATUS_OK, blob_recv, &blob_send);
595 if (!NT_STATUS_EQUAL(status,NT_STATUS_MORE_PROCESSING_REQUIRED)) {
596 goto fail;
600 do {
601 data_blob_free(&blob_recv);
602 status = enc_blob_send_receive(cli, &blob_send, &blob_recv, &param_out);
603 if (param_out.length == 2) {
604 es->enc_ctx_num = SVAL(param_out.data, 0);
606 data_blob_free(&blob_send);
607 status = make_cli_gss_blob(es, servicename, fqdn, status, blob_recv, &blob_send);
608 } while (NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED));
609 data_blob_free(&blob_recv);
611 if (NT_STATUS_IS_OK(status)) {
612 /* Replace the old state, if any. */
613 if (cli->trans_enc_state) {
614 common_free_encryption_state(&cli->trans_enc_state);
616 cli->trans_enc_state = es;
617 cli->trans_enc_state->enc_on = True;
618 es = NULL;
621 fail:
623 common_free_encryption_state(&es);
624 return status;
626 #else
627 NTSTATUS cli_gss_smb_encryption_start(struct cli_state *cli)
629 return NT_STATUS_NOT_SUPPORTED;
631 #endif
633 /********************************************************************
634 Ensure a connection is encrypted.
635 ********************************************************************/
637 NTSTATUS cli_force_encryption(struct cli_state *c,
638 const char *username,
639 const char *password,
640 const char *domain)
642 uint16 major, minor;
643 uint32 caplow, caphigh;
645 if (!SERVER_HAS_UNIX_CIFS(c)) {
646 return NT_STATUS_NOT_SUPPORTED;
649 if (!cli_unix_extensions_version(c, &major, &minor, &caplow, &caphigh)) {
650 return NT_STATUS_UNKNOWN_REVISION;
653 if (!(caplow & CIFS_UNIX_TRANSPORT_ENCRYPTION_CAP)) {
654 return NT_STATUS_UNSUPPORTED_COMPRESSION;
657 if (c->use_kerberos) {
658 return cli_gss_smb_encryption_start(c);
660 return cli_raw_ntlm_smb_encryption_start(c,
661 username,
662 password,
663 domain);