2 * Copyright (c) 2000-2001, Boris Popov
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by Boris Popov.
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/endian.h>
39 #include <sys/kernel.h>
40 #include <sys/malloc.h>
41 #include <sys/module.h>
44 #include <sys/sysctl.h>
45 #include <sys/socket.h>
46 #include <sys/socketvar.h>
49 #include <netsmb/smb.h>
50 #include <netsmb/smb_conn.h>
51 #include <netsmb/smb_rq.h>
52 #include <netsmb/smb_subr.h>
53 #include <netsmb/smb_tran.h>
55 MALLOC_DEFINE(M_SMBRQ, "SMBRQ", "SMB request");
57 MODULE_DEPEND(netsmb, libmchain, 1, 1, 1);
59 static int smb_rq_reply(struct smb_rq *rqp);
60 static int smb_rq_enqueue(struct smb_rq *rqp);
61 static int smb_rq_getenv(struct smb_connobj *layer,
62 struct smb_vc **vcpp, struct smb_share **sspp);
63 static int smb_rq_new(struct smb_rq *rqp, u_char cmd);
64 static int smb_t2_reply(struct smb_t2rq *t2p);
67 smb_rq_alloc(struct smb_connobj *layer, u_char cmd, struct smb_cred *scred,
73 MALLOC(rqp, struct smb_rq *, sizeof(*rqp), M_SMBRQ, M_WAITOK);
76 error = smb_rq_init(rqp, layer, cmd, scred);
77 rqp->sr_flags |= SMBR_ALLOCED;
86 static char tzero[12];
89 smb_rq_init(struct smb_rq *rqp, struct smb_connobj *layer, u_char cmd,
90 struct smb_cred *scred)
94 bzero(rqp, sizeof(*rqp));
95 smb_sl_init(&rqp->sr_slock, "srslock");
96 error = smb_rq_getenv(layer, &rqp->sr_vc, &rqp->sr_share);
99 error = smb_vc_access(rqp->sr_vc, scred, SMBM_EXEC);
103 error = smb_share_access(rqp->sr_share, scred, SMBM_EXEC);
107 rqp->sr_cred = scred;
108 rqp->sr_mid = smb_vc_nextmid(rqp->sr_vc);
109 return smb_rq_new(rqp, cmd);
113 smb_rq_new(struct smb_rq *rqp, u_char cmd)
115 struct smb_vc *vcp = rqp->sr_vc;
116 struct mbchain *mbp = &rqp->sr_rq;
122 md_done(&rqp->sr_rp);
123 error = mb_init(mbp);
126 mb_put_mem(mbp, SMB_SIGNATURE, SMB_SIGLEN, MB_MSYSTEM);
127 mb_put_uint8(mbp, cmd);
128 mb_put_uint32le(mbp, 0); /* DosError */
129 mb_put_uint8(mbp, vcp->vc_hflags);
130 flags2 = vcp->vc_hflags2;
131 if (cmd == SMB_COM_TRANSACTION || cmd == SMB_COM_TRANSACTION_SECONDARY)
132 flags2 &= ~SMB_FLAGS2_UNICODE;
133 if (cmd == SMB_COM_NEGOTIATE)
134 flags2 &= ~SMB_FLAGS2_SECURITY_SIGNATURE;
135 mb_put_uint16le(mbp, flags2);
136 if ((flags2 & SMB_FLAGS2_SECURITY_SIGNATURE) == 0) {
137 mb_put_mem(mbp, tzero, 12, MB_MSYSTEM);
138 rqp->sr_rqsig = NULL;
140 mb_put_uint16le(mbp, 0 /*scred->sc_p->p_pid >> 16*/);
141 rqp->sr_rqsig = (u_int8_t *)mb_reserve(mbp, 8);
142 mb_put_uint16le(mbp, 0);
144 rqp->sr_rqtid = mb_reserve(mbp, sizeof(u_int16_t));
145 mb_put_uint16le(mbp, 1 /*scred->sc_p->p_pid & 0xffff*/);
146 rqp->sr_rquid = mb_reserve(mbp, sizeof(u_int16_t));
147 mb_put_uint16le(mbp, rqp->sr_mid);
152 smb_rq_done(struct smb_rq *rqp)
154 mb_done(&rqp->sr_rq);
155 md_done(&rqp->sr_rp);
156 smb_sl_destroy(&rqp->sr_slock);
157 if (rqp->sr_flags & SMBR_ALLOCED)
162 * Simple request-reply exchange
165 smb_rq_simple(struct smb_rq *rqp)
167 struct smb_vc *vcp = rqp->sr_vc;
168 int error = EINVAL, i;
170 for (i = 0; i < SMB_MAXRCN; i++) {
171 rqp->sr_flags &= ~SMBR_RESTART;
172 rqp->sr_timo = vcp->vc_timo;
173 rqp->sr_state = SMBRQ_NOTSENT;
174 error = smb_rq_enqueue(rqp);
177 error = smb_rq_reply(rqp);
180 if ((rqp->sr_flags & (SMBR_RESTART | SMBR_NORESTART)) != SMBR_RESTART)
187 smb_rq_enqueue(struct smb_rq *rqp)
189 struct smb_share *ssp = rqp->sr_share;
192 if (ssp == NULL || rqp->sr_cred == &rqp->sr_vc->vc_iod->iod_scred) {
193 return smb_iod_addrq(rqp);
197 if (ssp->ss_flags & SMBS_RECONNECTING) {
198 msleep(&ssp->ss_vcgenid, SMBS_ST_LOCKPTR(ssp),
199 PWAIT | PDROP, "90trcn", hz);
200 if (smb_td_intr(rqp->sr_cred->scr_td))
204 if (smb_share_valid(ssp) || (ssp->ss_flags & SMBS_CONNECTED) == 0) {
208 error = smb_iod_request(rqp->sr_vc->vc_iod,
209 SMBIOD_EV_TREECONNECT | SMBIOD_EV_SYNC, ssp);
213 error = smb_iod_addrq(rqp);
221 smb_rq_wstart(struct smb_rq *rqp)
223 rqp->sr_wcount = mb_reserve(&rqp->sr_rq, sizeof(u_int8_t));
224 rqp->sr_rq.mb_count = 0;
228 smb_rq_wend(struct smb_rq *rqp)
230 if (rqp->sr_wcount == NULL) {
231 SMBERROR("no wcount\n"); /* actually panic */
234 if (rqp->sr_rq.mb_count & 1)
235 SMBERROR("odd word count\n");
236 *rqp->sr_wcount = rqp->sr_rq.mb_count / 2;
240 smb_rq_bstart(struct smb_rq *rqp)
242 rqp->sr_bcount = mb_reserve(&rqp->sr_rq, sizeof(u_short));
243 rqp->sr_rq.mb_count = 0;
247 smb_rq_bend(struct smb_rq *rqp)
251 if (rqp->sr_bcount == NULL) {
252 SMBERROR("no bcount\n"); /* actually panic */
255 bcnt = rqp->sr_rq.mb_count;
257 SMBERROR("byte count too large (%d)\n", bcnt);
258 le16enc(rqp->sr_bcount, bcnt);
262 smb_rq_intr(struct smb_rq *rqp)
264 if (rqp->sr_flags & SMBR_INTR)
266 return smb_td_intr(rqp->sr_cred->scr_td);
270 smb_rq_getrequest(struct smb_rq *rqp, struct mbchain **mbpp)
277 smb_rq_getreply(struct smb_rq *rqp, struct mdchain **mbpp)
284 smb_rq_getenv(struct smb_connobj *layer,
285 struct smb_vc **vcpp, struct smb_share **sspp)
287 struct smb_vc *vcp = NULL;
288 struct smb_share *ssp = NULL;
289 struct smb_connobj *cp;
292 switch (layer->co_level) {
295 if (layer->co_parent == NULL) {
296 SMBERROR("zombie VC %s\n", vcp->vc_srvname);
303 cp = layer->co_parent;
305 SMBERROR("zombie share %s\n", ssp->ss_name);
309 error = smb_rq_getenv(cp, &vcp, NULL);
314 SMBERROR("invalid layer %d passed\n", layer->co_level);
325 * Wait for reply on the request
328 smb_rq_reply(struct smb_rq *rqp)
330 struct mdchain *mdp = &rqp->sr_rp;
333 int error, rperror = 0;
335 error = smb_iod_waitrq(rqp);
338 error = md_get_uint32(mdp, &tdw);
341 error = md_get_uint8(mdp, &tb);
342 if (rqp->sr_vc->vc_hflags2 & SMB_FLAGS2_ERR_STATUS) {
343 error = md_get_uint32le(mdp, &rqp->sr_error);
345 error = md_get_uint8(mdp, &rqp->sr_errclass);
346 error = md_get_uint8(mdp, &tb);
347 error = md_get_uint16le(mdp, &rqp->sr_serror);
349 rperror = smb_maperror(rqp->sr_errclass, rqp->sr_serror);
351 error = md_get_uint8(mdp, &rqp->sr_rpflags);
352 error = md_get_uint16le(mdp, &rqp->sr_rpflags2);
354 error = md_get_uint32(mdp, &tdw);
355 error = md_get_uint32(mdp, &tdw);
356 error = md_get_uint32(mdp, &tdw);
358 error = md_get_uint16le(mdp, &rqp->sr_rptid);
359 error = md_get_uint16le(mdp, &rqp->sr_rppid);
360 error = md_get_uint16le(mdp, &rqp->sr_rpuid);
361 error = md_get_uint16le(mdp, &rqp->sr_rpmid);
364 (rqp->sr_vc->vc_hflags2 & SMB_FLAGS2_SECURITY_SIGNATURE))
365 error = smb_rq_verify(rqp);
367 SMBSDEBUG("M:%04x, P:%04x, U:%04x, T:%04x, E: %d:%d\n",
368 rqp->sr_rpmid, rqp->sr_rppid, rqp->sr_rpuid, rqp->sr_rptid,
369 rqp->sr_errclass, rqp->sr_serror);
370 return error ? error : rperror;
374 #define ALIGN4(a) (((a) + 3) & ~3)
377 * TRANS2 request implementation
380 smb_t2_alloc(struct smb_connobj *layer, u_short setup, struct smb_cred *scred,
381 struct smb_t2rq **t2pp)
383 struct smb_t2rq *t2p;
386 MALLOC(t2p, struct smb_t2rq *, sizeof(*t2p), M_SMBRQ, M_WAITOK);
389 error = smb_t2_init(t2p, layer, setup, scred);
390 t2p->t2_flags |= SMBT2_ALLOCED;
400 smb_t2_init(struct smb_t2rq *t2p, struct smb_connobj *source, u_short setup,
401 struct smb_cred *scred)
405 bzero(t2p, sizeof(*t2p));
406 t2p->t2_source = source;
407 t2p->t2_setupcount = 1;
408 t2p->t2_setupdata = t2p->t2_setup;
409 t2p->t2_setup[0] = setup;
410 t2p->t2_fid = 0xffff;
411 t2p->t2_cred = scred;
412 error = smb_rq_getenv(source, &t2p->t2_vc, NULL);
419 smb_t2_done(struct smb_t2rq *t2p)
421 mb_done(&t2p->t2_tparam);
422 mb_done(&t2p->t2_tdata);
423 md_done(&t2p->t2_rparam);
424 md_done(&t2p->t2_rdata);
425 if (t2p->t2_flags & SMBT2_ALLOCED)
430 smb_t2_placedata(struct mbuf *mtop, u_int16_t offset, u_int16_t count,
436 m0 = m_split(mtop, offset, M_WAIT);
437 len = m_length(m0, &m);
438 m->m_len -= len - count;
439 if (mdp->md_top == NULL) {
442 m_cat(mdp->md_top, m0);
447 smb_t2_reply(struct smb_t2rq *t2p)
450 struct smb_rq *rqp = t2p->t2_rq;
451 int error, totpgot, totdgot;
452 u_int16_t totpcount, totdcount, pcount, poff, doff, pdisp, ddisp;
453 u_int16_t tmp, bc, dcount;
456 error = smb_rq_reply(rqp);
459 if ((t2p->t2_flags & SMBT2_ALLSENT) == 0) {
461 * this is an interim response, ignore it.
464 md_next_record(&rqp->sr_rp);
469 * Now we have to get all subsequent responses. The CIFS specification
470 * says that they can be disordered which is weird.
473 totpgot = totdgot = 0;
474 totpcount = totdcount = 0xffff;
477 m_dumpm(mdp->md_top);
478 if ((error = md_get_uint8(mdp, &wc)) != 0)
484 if ((error = md_get_uint16le(mdp, &tmp)) != 0)
488 md_get_uint16le(mdp, &tmp);
491 if ((error = md_get_uint16le(mdp, &tmp)) != 0 || /* reserved */
492 (error = md_get_uint16le(mdp, &pcount)) != 0 ||
493 (error = md_get_uint16le(mdp, &poff)) != 0 ||
494 (error = md_get_uint16le(mdp, &pdisp)) != 0)
496 if (pcount != 0 && pdisp != totpgot) {
497 SMBERROR("Can't handle disordered parameters %d:%d\n",
502 if ((error = md_get_uint16le(mdp, &dcount)) != 0 ||
503 (error = md_get_uint16le(mdp, &doff)) != 0 ||
504 (error = md_get_uint16le(mdp, &ddisp)) != 0)
506 if (dcount != 0 && ddisp != totdgot) {
507 SMBERROR("Can't handle disordered data\n");
511 md_get_uint8(mdp, &wc);
512 md_get_uint8(mdp, NULL);
515 md_get_uint16(mdp, NULL);
516 if ((error = md_get_uint16le(mdp, &bc)) != 0)
518 /* tmp = SMB_HDRLEN + 1 + 10 * 2 + 2 * wc + 2;*/
520 error = smb_t2_placedata(mdp->md_top, doff, dcount,
526 error = smb_t2_placedata(mdp->md_top, poff, pcount,
533 if (totpgot >= totpcount && totdgot >= totdcount) {
535 t2p->t2_flags |= SMBT2_ALLRECV;
539 * We're done with this reply, look for the next one.
542 md_next_record(&rqp->sr_rp);
544 error = smb_rq_reply(rqp);
552 * Perform a full round of TRANS2 request
555 smb_t2_request_int(struct smb_t2rq *t2p)
557 struct smb_vc *vcp = t2p->t2_vc;
558 struct smb_cred *scred = t2p->t2_cred;
560 struct mdchain *mdp, mbparam, mbdata;
563 int totpcount, leftpcount, totdcount, leftdcount, len, txmax, i;
564 int error, doff, poff, txdcount, txpcount, nmlen;
566 m = t2p->t2_tparam.mb_top;
568 md_initm(&mbparam, m); /* do not free it! */
569 totpcount = m_fixhdr(m);
570 if (totpcount > 0xffff) /* maxvalue for u_short */
574 m = t2p->t2_tdata.mb_top;
576 md_initm(&mbdata, m); /* do not free it! */
577 totdcount = m_fixhdr(m);
578 if (totdcount > 0xffff)
582 leftdcount = totdcount;
583 leftpcount = totpcount;
584 txmax = vcp->vc_txmax;
585 error = smb_rq_alloc(t2p->t2_source, t2p->t_name ?
586 SMB_COM_TRANSACTION : SMB_COM_TRANSACTION2, scred, &rqp);
589 rqp->sr_flags |= SMBR_MULTIPACKET;
594 mb_put_uint16le(mbp, totpcount);
595 mb_put_uint16le(mbp, totdcount);
596 mb_put_uint16le(mbp, t2p->t2_maxpcount);
597 mb_put_uint16le(mbp, t2p->t2_maxdcount);
598 mb_put_uint8(mbp, t2p->t2_maxscount);
599 mb_put_uint8(mbp, 0); /* reserved */
600 mb_put_uint16le(mbp, 0); /* flags */
601 mb_put_uint32le(mbp, 0); /* Timeout */
602 mb_put_uint16le(mbp, 0); /* reserved 2 */
603 len = mb_fixhdr(mbp);
605 * now we have known packet size as
606 * ALIGN4(len + 5 * 2 + setupcount * 2 + 2 + strlen(name) + 1),
607 * and need to decide which parts should go into the first request
609 nmlen = t2p->t_name ? strlen(t2p->t_name) : 0;
610 len = ALIGN4(len + 5 * 2 + t2p->t2_setupcount * 2 + 2 + nmlen + 1);
611 if (len + leftpcount > txmax) {
612 txpcount = min(leftpcount, txmax - len);
617 txpcount = leftpcount;
618 poff = txpcount ? len : 0;
619 len = ALIGN4(len + txpcount);
620 txdcount = min(leftdcount, txmax - len);
621 doff = txdcount ? len : 0;
623 leftpcount -= txpcount;
624 leftdcount -= txdcount;
625 mb_put_uint16le(mbp, txpcount);
626 mb_put_uint16le(mbp, poff);
627 mb_put_uint16le(mbp, txdcount);
628 mb_put_uint16le(mbp, doff);
629 mb_put_uint8(mbp, t2p->t2_setupcount);
630 mb_put_uint8(mbp, 0);
631 for (i = 0; i < t2p->t2_setupcount; i++)
632 mb_put_uint16le(mbp, t2p->t2_setupdata[i]);
637 mb_put_mem(mbp, t2p->t_name, nmlen, MB_MSYSTEM);
638 mb_put_uint8(mbp, 0); /* terminating zero */
639 len = mb_fixhdr(mbp);
641 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
642 error = md_get_mbuf(&mbparam, txpcount, &m);
643 SMBSDEBUG("%d:%d:%d\n", error, txpcount, txmax);
648 len = mb_fixhdr(mbp);
650 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
651 error = md_get_mbuf(&mbdata, txdcount, &m);
656 smb_rq_bend(rqp); /* incredible, but thats it... */
657 error = smb_rq_enqueue(rqp);
660 if (leftpcount == 0 && leftdcount == 0)
661 t2p->t2_flags |= SMBT2_ALLSENT;
662 error = smb_t2_reply(t2p);
665 while (leftpcount || leftdcount) {
666 t2p->t2_flags |= SMBT2_SECONDARY;
667 error = smb_rq_new(rqp, t2p->t_name ?
668 SMB_COM_TRANSACTION_SECONDARY : SMB_COM_TRANSACTION2_SECONDARY);
673 mb_put_uint16le(mbp, totpcount);
674 mb_put_uint16le(mbp, totdcount);
675 len = mb_fixhdr(mbp);
677 * now we have known packet size as
678 * ALIGN4(len + 7 * 2 + 2) for T2 request, and -2 for T one,
679 * and need to decide which parts should go into request
681 len = ALIGN4(len + 6 * 2 + 2);
682 if (t2p->t_name == NULL)
684 if (len + leftpcount > txmax) {
685 txpcount = min(leftpcount, txmax - len);
690 txpcount = leftpcount;
691 poff = txpcount ? len : 0;
692 len = ALIGN4(len + txpcount);
693 txdcount = min(leftdcount, txmax - len);
694 doff = txdcount ? len : 0;
696 mb_put_uint16le(mbp, txpcount);
697 mb_put_uint16le(mbp, poff);
698 mb_put_uint16le(mbp, totpcount - leftpcount);
699 mb_put_uint16le(mbp, txdcount);
700 mb_put_uint16le(mbp, doff);
701 mb_put_uint16le(mbp, totdcount - leftdcount);
702 leftpcount -= txpcount;
703 leftdcount -= txdcount;
704 if (t2p->t_name == NULL)
705 mb_put_uint16le(mbp, t2p->t2_fid);
708 mb_put_uint8(mbp, 0); /* name */
709 len = mb_fixhdr(mbp);
711 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
712 error = md_get_mbuf(&mbparam, txpcount, &m);
717 len = mb_fixhdr(mbp);
719 mb_put_mem(mbp, NULL, ALIGN4(len) - len, MB_MZERO);
720 error = md_get_mbuf(&mbdata, txdcount, &m);
726 rqp->sr_state = SMBRQ_NOTSENT;
727 error = smb_iod_request(vcp->vc_iod, SMBIOD_EV_NEWRQ, NULL);
730 } /* while left params or data */
731 t2p->t2_flags |= SMBT2_ALLSENT;
732 mdp = &t2p->t2_rdata;
734 m_fixhdr(mdp->md_top);
735 md_initm(mdp, mdp->md_top);
737 mdp = &t2p->t2_rparam;
739 m_fixhdr(mdp->md_top);
740 md_initm(mdp, mdp->md_top);
743 smb_iod_removerq(rqp);
747 if (rqp->sr_flags & SMBR_RESTART)
748 t2p->t2_flags |= SMBT2_RESTART;
749 md_done(&t2p->t2_rparam);
750 md_done(&t2p->t2_rdata);
756 smb_t2_request(struct smb_t2rq *t2p)
758 int error = EINVAL, i;
760 for (i = 0; i < SMB_MAXRCN; i++) {
761 t2p->t2_flags &= ~SMBR_RESTART;
762 error = smb_t2_request_int(t2p);
765 if ((t2p->t2_flags & (SMBT2_RESTART | SMBT2_NORESTART)) != SMBT2_RESTART)