2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2000-2001 Boris Popov
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/endian.h>
33 #include <sys/kernel.h>
34 #include <sys/malloc.h>
35 #include <sys/module.h>
38 #include <sys/sysctl.h>
39 #include <sys/socket.h>
40 #include <sys/socketvar.h>
43 #include <netsmb/smb.h>
44 #include <netsmb/smb_conn.h>
45 #include <netsmb/smb_rq.h>
46 #include <netsmb/smb_subr.h>
47 #include <netsmb/smb_tran.h>
49 static MALLOC_DEFINE(M_SMBRQ, "SMBRQ", "SMB request");
51 MODULE_DEPEND(netsmb, libmchain, 1, 1, 1);
53 static int smb_rq_reply(struct smb_rq *rqp);
54 static int smb_rq_enqueue(struct smb_rq *rqp);
55 static int smb_rq_getenv(struct smb_connobj *layer,
56 struct smb_vc **vcpp, struct smb_share **sspp);
57 static int smb_rq_new(struct smb_rq *rqp, u_char cmd);
58 static int smb_t2_reply(struct smb_t2rq *t2p);
61 smb_rq_alloc(struct smb_connobj *layer, u_char cmd, struct smb_cred *scred,
67 rqp = malloc(sizeof(*rqp), M_SMBRQ, M_WAITOK);
70 error = smb_rq_init(rqp, layer, cmd, scred);
71 rqp->sr_flags |= SMBR_ALLOCED;
80 static char tzero[12];
83 smb_rq_init(struct smb_rq *rqp, struct smb_connobj *layer, u_char cmd,
84 struct smb_cred *scred)
88 bzero(rqp, sizeof(*rqp));
89 smb_sl_init(&rqp->sr_slock, "srslock");
90 error = smb_rq_getenv(layer, &rqp->sr_vc, &rqp->sr_share);
93 error = smb_vc_access(rqp->sr_vc, scred, SMBM_EXEC);
97 error = smb_share_access(rqp->sr_share, scred, SMBM_EXEC);
101 rqp->sr_cred = scred;
102 rqp->sr_mid = smb_vc_nextmid(rqp->sr_vc);
103 return smb_rq_new(rqp, cmd);
107 smb_rq_new(struct smb_rq *rqp, u_char cmd)
109 struct smb_vc *vcp = rqp->sr_vc;
110 struct mbchain *mbp = &rqp->sr_rq;
116 md_done(&rqp->sr_rp);
117 error = mb_init(mbp);
120 mb_put_mem(mbp, SMB_SIGNATURE, SMB_SIGLEN, MB_MSYSTEM);
121 mb_put_uint8(mbp, cmd);
122 mb_put_uint32le(mbp, 0); /* DosError */
123 mb_put_uint8(mbp, vcp->vc_hflags);
124 flags2 = vcp->vc_hflags2;
125 if (cmd == SMB_COM_TRANSACTION || cmd == SMB_COM_TRANSACTION_SECONDARY)
126 flags2 &= ~SMB_FLAGS2_UNICODE;
127 if (cmd == SMB_COM_NEGOTIATE)
128 flags2 &= ~SMB_FLAGS2_SECURITY_SIGNATURE;
129 mb_put_uint16le(mbp, flags2);
130 if ((flags2 & SMB_FLAGS2_SECURITY_SIGNATURE) == 0) {
131 mb_put_mem(mbp, tzero, 12, MB_MSYSTEM);
132 rqp->sr_rqsig = NULL;
134 mb_put_uint16le(mbp, 0 /*scred->sc_p->p_pid >> 16*/);
135 rqp->sr_rqsig = (u_int8_t *)mb_reserve(mbp, 8);
136 mb_put_uint16le(mbp, 0);
138 rqp->sr_rqtid = mb_reserve(mbp, sizeof(u_int16_t));
139 mb_put_uint16le(mbp, 1 /*scred->sc_p->p_pid & 0xffff*/);
140 rqp->sr_rquid = mb_reserve(mbp, sizeof(u_int16_t));
141 mb_put_uint16le(mbp, rqp->sr_mid);
146 smb_rq_done(struct smb_rq *rqp)
148 mb_done(&rqp->sr_rq);
149 md_done(&rqp->sr_rp);
150 smb_sl_destroy(&rqp->sr_slock);
151 if (rqp->sr_flags & SMBR_ALLOCED)
156 * Simple request-reply exchange
159 smb_rq_simple(struct smb_rq *rqp)
161 struct smb_vc *vcp = rqp->sr_vc;
162 int error = EINVAL, i;
164 for (i = 0; i < SMB_MAXRCN; i++) {
165 rqp->sr_flags &= ~SMBR_RESTART;
166 rqp->sr_timo = vcp->vc_timo;
167 rqp->sr_state = SMBRQ_NOTSENT;
168 error = smb_rq_enqueue(rqp);
171 error = smb_rq_reply(rqp);
174 if ((rqp->sr_flags & (SMBR_RESTART | SMBR_NORESTART)) != SMBR_RESTART)
181 smb_rq_enqueue(struct smb_rq *rqp)
183 struct smb_share *ssp = rqp->sr_share;
186 if (ssp == NULL || rqp->sr_cred == &rqp->sr_vc->vc_iod->iod_scred) {
187 return smb_iod_addrq(rqp);
191 if (ssp->ss_flags & SMBS_RECONNECTING) {
192 msleep(&ssp->ss_vcgenid, SMBS_ST_LOCKPTR(ssp),
193 PWAIT | PDROP, "90trcn", hz);
194 if (smb_td_intr(rqp->sr_cred->scr_td))
198 if (smb_share_valid(ssp) || (ssp->ss_flags & SMBS_CONNECTED) == 0) {
202 error = smb_iod_request(rqp->sr_vc->vc_iod,
203 SMBIOD_EV_TREECONNECT | SMBIOD_EV_SYNC, ssp);
207 error = smb_iod_addrq(rqp);
215 smb_rq_wstart(struct smb_rq *rqp)
217 rqp->sr_wcount = mb_reserve(&rqp->sr_rq, sizeof(u_int8_t));
218 rqp->sr_rq.mb_count = 0;
222 smb_rq_wend(struct smb_rq *rqp)
224 if (rqp->sr_wcount == NULL) {
225 SMBERROR("no wcount\n"); /* actually panic */
228 if (rqp->sr_rq.mb_count & 1)
229 SMBERROR("odd word count\n");
230 *rqp->sr_wcount = rqp->sr_rq.mb_count / 2;
234 smb_rq_bstart(struct smb_rq *rqp)
236 rqp->sr_bcount = mb_reserve(&rqp->sr_rq, sizeof(u_short));
237 rqp->sr_rq.mb_count = 0;
241 smb_rq_bend(struct smb_rq *rqp)
245 if (rqp->sr_bcount == NULL) {
246 SMBERROR("no bcount\n"); /* actually panic */
249 bcnt = rqp->sr_rq.mb_count;
251 SMBERROR("byte count too large (%d)\n", bcnt);
252 le16enc(rqp->sr_bcount, bcnt);
256 smb_rq_intr(struct smb_rq *rqp)
258 if (rqp->sr_flags & SMBR_INTR)
260 return smb_td_intr(rqp->sr_cred->scr_td);
264 smb_rq_getrequest(struct smb_rq *rqp, struct mbchain **mbpp)
271 smb_rq_getreply(struct smb_rq *rqp, struct mdchain **mbpp)
278 smb_rq_getenv(struct smb_connobj *layer,
279 struct smb_vc **vcpp, struct smb_share **sspp)
281 struct smb_vc *vcp = NULL;
282 struct smb_share *ssp = NULL;
283 struct smb_connobj *cp;
286 switch (layer->co_level) {
289 if (layer->co_parent == NULL) {
290 SMBERROR("zombie VC %s\n", vcp->vc_srvname);
297 cp = layer->co_parent;
299 SMBERROR("zombie share %s\n", ssp->ss_name);
303 error = smb_rq_getenv(cp, &vcp, NULL);
308 SMBERROR("invalid layer %d passed\n", layer->co_level);
319 * Wait for reply on the request
322 smb_rq_reply(struct smb_rq *rqp)
324 struct mdchain *mdp = &rqp->sr_rp;
327 int error, rperror = 0;
329 error = smb_iod_waitrq(rqp);
332 error = md_get_uint32(mdp, &tdw);
335 error = md_get_uint8(mdp, &tb);
336 if (rqp->sr_vc->vc_hflags2 & SMB_FLAGS2_ERR_STATUS) {
337 error = md_get_uint32le(mdp, &rqp->sr_error);
339 error = md_get_uint8(mdp, &rqp->sr_errclass);
340 error = md_get_uint8(mdp, &tb);
341 error = md_get_uint16le(mdp, &rqp->sr_serror);
343 rperror = smb_maperror(rqp->sr_errclass, rqp->sr_serror);
345 error = md_get_uint8(mdp, &rqp->sr_rpflags);
346 error = md_get_uint16le(mdp, &rqp->sr_rpflags2);
348 error = md_get_uint32(mdp, &tdw);
349 error = md_get_uint32(mdp, &tdw);
350 error = md_get_uint32(mdp, &tdw);
352 error = md_get_uint16le(mdp, &rqp->sr_rptid);
353 error = md_get_uint16le(mdp, &rqp->sr_rppid);
354 error = md_get_uint16le(mdp, &rqp->sr_rpuid);
355 error = md_get_uint16le(mdp, &rqp->sr_rpmid);
358 (rqp->sr_vc->vc_hflags2 & SMB_FLAGS2_SECURITY_SIGNATURE))
359 error = smb_rq_verify(rqp);
361 SMBSDEBUG("M:%04x, P:%04x, U:%04x, T:%04x, E: %d:%d\n",
362 rqp->sr_rpmid, rqp->sr_rppid, rqp->sr_rpuid, rqp->sr_rptid,
363 rqp->sr_errclass, rqp->sr_serror);
364 return error ? error : rperror;
367 #define ALIGN4(a) (((a) + 3) & ~3)
370 * TRANS2 request implementation
373 smb_t2_alloc(struct smb_connobj *layer, u_short setup, struct smb_cred *scred,
374 struct smb_t2rq **t2pp)
376 struct smb_t2rq *t2p;
379 t2p = malloc(sizeof(*t2p), M_SMBRQ, M_WAITOK);
382 error = smb_t2_init(t2p, layer, setup, scred);
383 t2p->t2_flags |= SMBT2_ALLOCED;
393 smb_t2_init(struct smb_t2rq *t2p, struct smb_connobj *source, u_short setup,
394 struct smb_cred *scred)
398 bzero(t2p, sizeof(*t2p));
399 t2p->t2_source = source;
400 t2p->t2_setupcount = 1;
401 t2p->t2_setupdata = t2p->t2_setup;
402 t2p->t2_setup[0] = setup;
403 t2p->t2_fid = 0xffff;
404 t2p->t2_cred = scred;
405 error = smb_rq_getenv(source, &t2p->t2_vc, NULL);
412 smb_t2_done(struct smb_t2rq *t2p)
414 mb_done(&t2p->t2_tparam);
415 mb_done(&t2p->t2_tdata);
416 md_done(&t2p->t2_rparam);
417 md_done(&t2p->t2_rdata);
418 if (t2p->t2_flags & SMBT2_ALLOCED)
423 smb_t2_placedata(struct mbuf *mtop, u_int16_t offset, u_int16_t count,
429 len = m_length(mtop, NULL);
430 if (offset + count > len)
433 m0 = m_split(mtop, offset, M_WAITOK);
434 if (len != offset + count) {
435 len -= offset + count;
438 if (mdp->md_top == NULL) {
441 m_cat(mdp->md_top, m0);
446 smb_t2_reply(struct smb_t2rq *t2p)
449 struct smb_rq *rqp = t2p->t2_rq;
450 int error, totpgot, totdgot;
451 u_int16_t totpcount, totdcount, pcount, poff, doff, pdisp, ddisp;
452 u_int16_t tmp, bc, dcount;
455 error = smb_rq_reply(rqp);
458 if ((t2p->t2_flags & SMBT2_ALLSENT) == 0) {
460 * this is an interim response, ignore it.
463 md_next_record(&rqp->sr_rp);
468 * Now we have to get all subsequent responses. The CIFS specification
469 * says that they can be disordered which is weird.
472 totpgot = totdgot = 0;
473 totpcount = totdcount = 0xffff;
476 m_dumpm(mdp->md_top);
477 if ((error = md_get_uint8(mdp, &wc)) != 0)
483 if ((error = md_get_uint16le(mdp, &tmp)) != 0)
487 md_get_uint16le(mdp, &tmp);
490 if ((error = md_get_uint16le(mdp, &tmp)) != 0 || /* reserved */
491 (error = md_get_uint16le(mdp, &pcount)) != 0 ||
492 (error = md_get_uint16le(mdp, &poff)) != 0 ||
493 (error = md_get_uint16le(mdp, &pdisp)) != 0)
495 if (pcount != 0 && pdisp != totpgot) {
496 SMBERROR("Can't handle disordered parameters %d:%d\n",
501 if ((error = md_get_uint16le(mdp, &dcount)) != 0 ||
502 (error = md_get_uint16le(mdp, &doff)) != 0 ||
503 (error = md_get_uint16le(mdp, &ddisp)) != 0)
505 if (dcount != 0 && ddisp != totdgot) {
506 SMBERROR("Can't handle disordered data\n");
510 md_get_uint8(mdp, &wc);
511 md_get_uint8(mdp, NULL);
514 md_get_uint16(mdp, NULL);
515 if ((error = md_get_uint16le(mdp, &bc)) != 0)
517 /* tmp = SMB_HDRLEN + 1 + 10 * 2 + 2 * wc + 2;*/
519 error = smb_t2_placedata(mdp->md_top, doff, dcount,
525 error = smb_t2_placedata(mdp->md_top, poff, pcount,
532 if (totpgot >= totpcount && totdgot >= totdcount) {
534 t2p->t2_flags |= SMBT2_ALLRECV;
538 * We're done with this reply, look for the next one.
541 md_next_record(&rqp->sr_rp);
543 error = smb_rq_reply(rqp);
551 * Perform a full round of TRANS2 request
554 smb_t2_request_int(struct smb_t2rq *t2p)
556 struct smb_vc *vcp = t2p->t2_vc;
557 struct smb_cred *scred = t2p->t2_cred;
559 struct mdchain *mdp, mbparam, mbdata;
562 int totpcount, leftpcount, totdcount, leftdcount, len, txmax, i;
563 int error, doff, poff, txdcount, txpcount, nmlen;
565 m = t2p->t2_tparam.mb_top;
567 md_initm(&mbparam, m); /* do not free it! */
568 totpcount = m_fixhdr(m);
569 if (totpcount > 0xffff) /* maxvalue for u_short */
573 m = t2p->t2_tdata.mb_top;
575 md_initm(&mbdata, m); /* do not free it! */
576 totdcount = m_fixhdr(m);
577 if (totdcount > 0xffff)
581 leftdcount = totdcount;
582 leftpcount = totpcount;
583 txmax = vcp->vc_txmax;
584 error = smb_rq_alloc(t2p->t2_source, t2p->t_name ?
585 SMB_COM_TRANSACTION : SMB_COM_TRANSACTION2, scred, &rqp);
588 rqp->sr_flags |= SMBR_MULTIPACKET;
593 mb_put_uint16le(mbp, totpcount);
594 mb_put_uint16le(mbp, totdcount);
595 mb_put_uint16le(mbp, t2p->t2_maxpcount);
596 mb_put_uint16le(mbp, t2p->t2_maxdcount);
597 mb_put_uint8(mbp, t2p->t2_maxscount);
598 mb_put_uint8(mbp, 0); /* reserved */
599 mb_put_uint16le(mbp, 0); /* flags */
600 mb_put_uint32le(mbp, 0); /* Timeout */
601 mb_put_uint16le(mbp, 0); /* reserved 2 */
602 len = mb_fixhdr(mbp);
604 * now we have known packet size as
605 * ALIGN4(len + 5 * 2 + setupcount * 2 + 2 + strlen(name) + 1),
606 * and need to decide which parts should go into the first request
608 nmlen = t2p->t_name ? strlen(t2p->t_name) : 0;
609 len = ALIGN4(len + 5 * 2 + t2p->t2_setupcount * 2 + 2 + nmlen + 1);
610 if (len + leftpcount > txmax) {
611 txpcount = min(leftpcount, txmax - len);
616 txpcount = leftpcount;
617 poff = txpcount ? len : 0;
618 len = ALIGN4(len + txpcount);
619 txdcount = min(leftdcount, txmax - len);
620 doff = txdcount ? len : 0;
622 leftpcount -= txpcount;
623 leftdcount -= txdcount;
624 mb_put_uint16le(mbp, txpcount);
625 mb_put_uint16le(mbp, poff);
626 mb_put_uint16le(mbp, txdcount);
627 mb_put_uint16le(mbp, doff);
628 mb_put_uint8(mbp, t2p->t2_setupcount);
629 mb_put_uint8(mbp, 0);
630 for (i = 0; i < t2p->t2_setupcount; i++)
631 mb_put_uint16le(mbp, t2p->t2_setupdata[i]);
636 mb_put_mem(mbp, t2p->t_name, nmlen, MB_MSYSTEM);
637 mb_put_uint8(mbp, 0); /* terminating zero */
638 len = mb_fixhdr(mbp);
640 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
641 error = md_get_mbuf(&mbparam, txpcount, &m);
642 SMBSDEBUG("%d:%d:%d\n", error, txpcount, txmax);
647 len = mb_fixhdr(mbp);
649 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
650 error = md_get_mbuf(&mbdata, txdcount, &m);
655 smb_rq_bend(rqp); /* incredible, but thats it... */
656 error = smb_rq_enqueue(rqp);
659 if (leftpcount == 0 && leftdcount == 0)
660 t2p->t2_flags |= SMBT2_ALLSENT;
661 error = smb_t2_reply(t2p);
664 while (leftpcount || leftdcount) {
665 t2p->t2_flags |= SMBT2_SECONDARY;
666 error = smb_rq_new(rqp, t2p->t_name ?
667 SMB_COM_TRANSACTION_SECONDARY : SMB_COM_TRANSACTION2_SECONDARY);
672 mb_put_uint16le(mbp, totpcount);
673 mb_put_uint16le(mbp, totdcount);
674 len = mb_fixhdr(mbp);
676 * now we have known packet size as
677 * ALIGN4(len + 7 * 2 + 2) for T2 request, and -2 for T one,
678 * and need to decide which parts should go into request
680 len = ALIGN4(len + 6 * 2 + 2);
681 if (t2p->t_name == NULL)
683 if (len + leftpcount > txmax) {
684 txpcount = min(leftpcount, txmax - len);
689 txpcount = leftpcount;
690 poff = txpcount ? len : 0;
691 len = ALIGN4(len + txpcount);
692 txdcount = min(leftdcount, txmax - len);
693 doff = txdcount ? len : 0;
695 mb_put_uint16le(mbp, txpcount);
696 mb_put_uint16le(mbp, poff);
697 mb_put_uint16le(mbp, totpcount - leftpcount);
698 mb_put_uint16le(mbp, txdcount);
699 mb_put_uint16le(mbp, doff);
700 mb_put_uint16le(mbp, totdcount - leftdcount);
701 leftpcount -= txpcount;
702 leftdcount -= txdcount;
703 if (t2p->t_name == NULL)
704 mb_put_uint16le(mbp, t2p->t2_fid);
707 mb_put_uint8(mbp, 0); /* name */
708 len = mb_fixhdr(mbp);
710 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
711 error = md_get_mbuf(&mbparam, txpcount, &m);
716 len = mb_fixhdr(mbp);
718 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
719 error = md_get_mbuf(&mbdata, txdcount, &m);
725 rqp->sr_state = SMBRQ_NOTSENT;
726 error = smb_iod_request(vcp->vc_iod, SMBIOD_EV_NEWRQ, NULL);
729 } /* while left params or data */
730 t2p->t2_flags |= SMBT2_ALLSENT;
731 mdp = &t2p->t2_rdata;
733 m_fixhdr(mdp->md_top);
734 md_initm(mdp, mdp->md_top);
736 mdp = &t2p->t2_rparam;
738 m_fixhdr(mdp->md_top);
739 md_initm(mdp, mdp->md_top);
742 smb_iod_removerq(rqp);
745 if (rqp->sr_flags & SMBR_RESTART)
746 t2p->t2_flags |= SMBT2_RESTART;
747 md_done(&t2p->t2_rparam);
748 md_done(&t2p->t2_rdata);
755 smb_t2_request(struct smb_t2rq *t2p)
757 int error = EINVAL, i;
759 for (i = 0; i < SMB_MAXRCN; i++) {
760 t2p->t2_flags &= ~SMBR_RESTART;
761 error = smb_t2_request_int(t2p);
764 if ((t2p->t2_flags & (SMBT2_RESTART | SMBT2_NORESTART)) != SMBT2_RESTART)