xref: /freebsd/sys/netsmb/smb_conn.h (revision 2c55fd74fc30595639bf83648af9b7d58d494556)
1 /*
2  * Copyright (c) 2000-2001 Boris Popov
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
19  *
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
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD$
33  */
34 
35 /*
36  * Two levels of connection hierarchy
37  */
38 #define	SMBL_SM		0
39 #define SMBL_VC		1
40 #define SMBL_SHARE	2
41 #define SMBL_NUM	3
42 #define SMBL_NONE	(-1)
43 
44 #define	SMB_CS_NONE	0x0000
45 #define	SMB_CS_UPPER	0x0001		/* convert passed string to upper case */
46 #define	SMB_CS_LOWER	0x0002		/* convert passed string to lower case */
47 
48 /*
49  * Common object flags
50  */
51 #define SMBO_GONE		0x1000000
52 
53 /*
54  * access modes
55  */
56 #define	SMBM_READ		0400	/* read conn attrs.(like list shares) */
57 #define	SMBM_WRITE		0200	/* modify conn attrs */
58 #define	SMBM_EXEC		0100	/* can send SMB requests */
59 #define	SMBM_READGRP		0040
60 #define	SMBM_WRITEGRP		0020
61 #define	SMBM_EXECGRP		0010
62 #define	SMBM_READOTH		0004
63 #define	SMBM_WRITEOTH		0002
64 #define	SMBM_EXECOTH		0001
65 #define	SMBM_MASK		0777
66 #define	SMBM_EXACT		010000	/* check for specified mode exactly */
67 #define	SMBM_ALL		(SMBM_READ | SMBM_WRITE | SMBM_EXEC)
68 #define	SMBM_DEFAULT		(SMBM_READ | SMBM_WRITE | SMBM_EXEC)
69 #define	SMBM_ANY_OWNER		((uid_t)-1)
70 #define	SMBM_ANY_GROUP		((gid_t)-1)
71 
72 /*
73  * VC flags
74  */
75 #define SMBV_PERMANENT		0x0002
76 #define SMBV_LONGNAMES		0x0004	/* connection is configured to use long names */
77 #define	SMBV_ENCRYPT		0x0008	/* server asked for encrypted password */
78 #define	SMBV_WIN95		0x0010	/* used to apply bugfixes for this OS */
79 #define	SMBV_PRIVATE		0x0020	/* connection can be used only by creator */
80 #define	SMBV_RECONNECTING	0x0040	/* conn is in the process of reconnection */
81 #define SMBV_SINGLESHARE	0x0080	/* only one share connecting should be allowed */
82 #define SMBV_CREATE		0x0100	/* lookup for create operation */
83 /*#define SMBV_FAILED		0x0200*/	/* last reconnect attempt has failed */
84 #define SMBV_UNICODE		0x0400	/* connection is configured to use Unicode */
85 
86 
87 /*
88  * smb_share flags
89  */
90 #define SMBS_PERMANENT		0x0001
91 #define SMBS_RECONNECTING	0x0002
92 #define SMBS_CONNECTED		0x0004
93 
94 /*
95  * share types
96  */
97 #define	SMB_ST_DISK		0x0	/* A: */
98 #define	SMB_ST_PRINTER		0x1	/* LPT: */
99 #define	SMB_ST_PIPE		0x2	/* IPC */
100 #define	SMB_ST_COMM		0x3	/* COMM */
101 #define	SMB_ST_ANY		0x4
102 #define	SMB_ST_MAX		0x4
103 #define SMB_ST_NONE		0xff	/* not a part of protocol */
104 
105 /*
106  * Negotiated protocol parameters
107  */
108 struct smb_sopt {
109 	int		sv_proto;
110 	int16_t		sv_tz;		/* offset in min relative to UTC */
111 	u_int32_t	sv_maxtx;	/* maximum transmit buf size */
112 	u_char		sv_sm;		/* security mode */
113 	u_int16_t	sv_maxmux;	/* max number of outstanding rq's */
114 	u_int16_t 	sv_maxvcs;	/* max number of VCs */
115 	u_int16_t	sv_rawmode;
116 	u_int32_t	sv_maxraw;	/* maximum raw-buffer size */
117 	u_int32_t	sv_skey;	/* session key */
118 	u_int32_t	sv_caps;	/* capabilities SMB_CAP_ */
119 };
120 
121 /*
122  * network IO daemon states
123  */
124 enum smbiod_state {
125 	SMBIOD_ST_NOTCONN,	/* no connect request was made */
126 	SMBIOD_ST_RECONNECT,	/* a [re]connect attempt is in progress */
127 	SMBIOD_ST_TRANACTIVE,	/* transport level is up */
128 	SMBIOD_ST_VCACTIVE,	/* session established */
129 	SMBIOD_ST_DEAD		/* connection broken, transport is down */
130 };
131 
132 
133 /*
134  * Info structures
135  */
136 #define	SMB_INFO_NONE		0
137 #define	SMB_INFO_VC		2
138 #define	SMB_INFO_SHARE		3
139 
140 struct smb_vc_info {
141 	int		itype;
142 	int		usecount;
143 	uid_t		uid;		/* user id of connection */
144 	gid_t		gid;		/* group of connection */
145 	mode_t		mode;		/* access mode */
146 	int		flags;
147 	enum smbiod_state iodstate;
148 	struct smb_sopt	sopt;
149 	char		srvname[SMB_MAXSRVNAMELEN];
150 	char		vcname[128];
151 };
152 
153 struct smb_share_info {
154 	int		itype;
155 	int		usecount;
156 	u_short		tid;		/* TID */
157 	int		type;		/* share type */
158 	uid_t		uid;		/* user id of connection */
159 	gid_t		gid;		/* group of connection */
160 	mode_t		mode;		/* access mode */
161 	int		flags;
162 	char		sname[128];
163 };
164 
165 #ifdef _KERNEL
166 
167 #include <sys/lockmgr.h>
168 #include <netsmb/smb_subr.h>
169 
170 #define CONNADDREQ(a1,a2)	((a1)->sa_len == (a2)->sa_len && \
171 				 bcmp(a1, a2, (a1)->sa_len) == 0)
172 
173 struct smb_vc;
174 struct smb_share;
175 struct smb_cred;
176 struct smb_rq;
177 struct mbdata;
178 struct smbioc_oshare;
179 struct smbioc_ossn;
180 struct uio;
181 
182 TAILQ_HEAD(smb_rqhead, smb_rq);
183 
184 #define SMB_DEFRQTIMO	5
185 
186 #define SMB_DIALECT(vcp)	((vcp)->vc_sopt.sv_proto)
187 
188 struct smb_tran_desc;
189 
190 /*
191  * Connection object
192  */
193 struct smb_connobj;
194 
195 typedef void smb_co_gone_t (struct smb_connobj *cp, struct smb_cred *scred);
196 typedef void smb_co_free_t (struct smb_connobj *cp);
197 
198 #define	SMB_CO_LOCK(cp)		smb_sl_lock(&(cp)->co_interlock)
199 #define	SMB_CO_UNLOCK(cp)	smb_sl_unlock(&(cp)->co_interlock)
200 
201 struct smb_connobj {
202 	int			co_level;	/* SMBL_ */
203 	int			co_flags;
204 	struct lock		co_lock;
205 	struct smb_slock	co_interlock;
206 	int			co_usecount;
207 	struct smb_connobj *	co_parent;
208 	SLIST_HEAD(,smb_connobj)co_children;
209 	SLIST_ENTRY(smb_connobj)co_next;
210 	smb_co_gone_t *		co_gone;
211 	smb_co_free_t *		co_free;
212 };
213 
214 #define	SMBCO_FOREACH(var, cp)	SLIST_FOREACH((var), &(cp)->co_children, co_next)
215 
216 /*
217  * Virtual Circuit (session) to a server.
218  * This is the most (over)complicated part of SMB protocol.
219  * For the user security level (usl), each session with different remote
220  * user name has its own VC.
221  * It is unclear however, should share security level (ssl) allow additional
222  * VCs, because user name is not used and can be the same. On other hand,
223  * multiple VCs allows us to create separate sessions to server on a per
224  * user basis.
225  */
226 
227 /*
228  * This lock protects vc_flags
229  */
230 #define	SMBC_ST_LOCK(vcp)	smb_sl_lock(&(vcp)->vc_stlock)
231 #define	SMBC_ST_UNLOCK(vcp)	smb_sl_unlock(&(vcp)->vc_stlock)
232 
233 
234 struct smb_vc {
235 	struct smb_connobj obj;
236 	char *		vc_srvname;
237 	struct sockaddr*vc_paddr;	/* server addr */
238 	struct sockaddr*vc_laddr;	/* local addr, if any */
239 	char *		vc_username;
240 	char *		vc_pass;	/* password for usl case */
241 	char *		vc_domain;	/* workgroup/primary domain */
242 
243 	u_int		vc_timo;	/* default request timeout */
244 	int		vc_maxvcs;	/* maximum number of VC per connection */
245 
246 	void *		vc_tolower;	/* local charset */
247 	void *		vc_toupper;	/* local charset */
248 	void *		vc_toserver;	/* local charset to server one */
249 	void *		vc_tolocal;	/* server charset to local one */
250 	int		vc_number;	/* number of this VC from the client side */
251 	int		vc_genid;
252 	uid_t		vc_uid;		/* user id of connection */
253 	gid_t		vc_grp;		/* group of connection */
254 	mode_t		vc_mode;	/* access mode */
255 	struct tnode *	vc_tnode;	/* backing object */
256 	u_short		vc_smbuid;	/* unique vc id assigned by server */
257 
258 	u_char		vc_hflags;	/* or'ed with flags in the smb header */
259 	u_short		vc_hflags2;	/* or'ed with flags in the smb header */
260 	void *		vc_tdata;	/* transport control block */
261 	struct smb_tran_desc *vc_tdesc;
262 	int		vc_chlen;	/* actual challenge length */
263 	u_char 		vc_ch[SMB_MAXCHALLENGELEN];
264 	u_short		vc_mid;		/* multiplex id */
265 	struct smb_sopt	vc_sopt;	/* server options */
266 	int		vc_txmax;	/* max tx/rx packet size */
267 	struct smbiod *	vc_iod;
268 	struct smb_slock vc_stlock;
269 };
270 
271 #define vc_maxmux	vc_sopt.sv_maxmux
272 #define	vc_flags	obj.co_flags
273 
274 
275 /*
276  * smb_share structure describes connection to the given SMB share (tree).
277  * Connection to share is always built on top of the VC.
278  */
279 
280 /*
281  * This lock protects ss_flags
282  */
283 #define	SMBS_ST_LOCK(ssp)	smb_sl_lock(&(ssp)->ss_stlock)
284 #define	SMBS_ST_LOCKPTR(ssp)	(&(ssp)->ss_stlock)
285 #define	SMBS_ST_UNLOCK(ssp)	smb_sl_unlock(&(ssp)->ss_stlock)
286 
287 struct smb_share {
288 	struct smb_connobj obj;
289 	char *		ss_name;
290 	u_short		ss_tid;		/* TID */
291 	int		ss_type;	/* share type */
292 	uid_t		ss_uid;		/* user id of connection */
293 	gid_t		ss_grp;		/* group of connection */
294 	mode_t		ss_mode;	/* access mode */
295 	int		ss_vcgenid;
296 	char *		ss_pass;	/* password to a share, can be null */
297 	struct smb_slock ss_stlock;
298 };
299 
300 #define	ss_flags	obj.co_flags
301 
302 #define CPTOVC(cp)	((struct smb_vc*)(cp))
303 #define VCTOCP(vcp)	(&(vcp)->obj)
304 #define CPTOSS(cp)	((struct smb_share*)(cp))
305 #define	SSTOVC(ssp)	CPTOVC(((ssp)->obj.co_parent))
306 #define SSTOCP(ssp)	(&(ssp)->obj)
307 
308 struct smb_vcspec {
309 	char *		srvname;
310 	struct sockaddr*sap;
311 	struct sockaddr*lap;
312 	int		flags;
313 	char *		username;
314 	char *		pass;
315 	char *		domain;
316 	mode_t		mode;
317 	mode_t		rights;
318 	uid_t		owner;
319 	gid_t		group;
320 	char *		localcs;
321 	char *		servercs;
322 	struct smb_sharespec *shspec;
323 	struct smb_share *ssp;		/* returned */
324 	/*
325 	 * The rest is an internal data
326 	 */
327 	struct smb_cred *scred;
328 };
329 
330 struct smb_sharespec {
331 	char *		name;
332 	char *		pass;
333 	mode_t		mode;
334 	mode_t		rights;
335 	uid_t		owner;
336 	gid_t		group;
337 	int		stype;
338 	/*
339 	 * The rest is an internal data
340 	 */
341 	struct smb_cred *scred;
342 };
343 
344 /*
345  * Session level functions
346  */
347 int  smb_sm_init(void);
348 int  smb_sm_done(void);
349 int  smb_sm_lookup(struct smb_vcspec *vcspec,
350 	struct smb_sharespec *shspec, struct smb_cred *scred,
351 	struct smb_vc **vcpp);
352 
353 /*
354  * Connection object
355  */
356 void smb_co_ref(struct smb_connobj *cp);
357 void smb_co_rele(struct smb_connobj *cp, struct smb_cred *scred);
358 int  smb_co_get(struct smb_connobj *cp, int flags, struct smb_cred *scred);
359 void smb_co_put(struct smb_connobj *cp, struct smb_cred *scred);
360 int  smb_co_lock(struct smb_connobj *cp, int flags, struct thread *td);
361 void smb_co_unlock(struct smb_connobj *cp, int flags, struct thread *td);
362 
363 /*
364  * session level functions
365  */
366 int  smb_vc_create(struct smb_vcspec *vcspec,
367 	struct smb_cred *scred, struct smb_vc **vcpp);
368 int  smb_vc_connect(struct smb_vc *vcp, struct smb_cred *scred);
369 int  smb_vc_access(struct smb_vc *vcp, struct smb_cred *scred, mode_t mode);
370 int  smb_vc_get(struct smb_vc *vcp, int flags, struct smb_cred *scred);
371 void smb_vc_put(struct smb_vc *vcp, struct smb_cred *scred);
372 void smb_vc_ref(struct smb_vc *vcp);
373 void smb_vc_rele(struct smb_vc *vcp, struct smb_cred *scred);
374 int  smb_vc_lock(struct smb_vc *vcp, int flags, struct thread *td);
375 void smb_vc_unlock(struct smb_vc *vcp, int flags, struct thread *td);
376 int  smb_vc_lookupshare(struct smb_vc *vcp, struct smb_sharespec *shspec,
377 	struct smb_cred *scred, struct smb_share **sspp);
378 const char * smb_vc_getpass(struct smb_vc *vcp);
379 u_short smb_vc_nextmid(struct smb_vc *vcp);
380 
381 /*
382  * share level functions
383  */
384 int  smb_share_create(struct smb_vc *vcp, struct smb_sharespec *shspec,
385 	struct smb_cred *scred, struct smb_share **sspp);
386 int  smb_share_access(struct smb_share *ssp, struct smb_cred *scred, mode_t mode);
387 void smb_share_ref(struct smb_share *ssp);
388 void smb_share_rele(struct smb_share *ssp, struct smb_cred *scred);
389 int  smb_share_get(struct smb_share *ssp, int flags, struct smb_cred *scred);
390 void smb_share_put(struct smb_share *ssp, struct smb_cred *scred);
391 int  smb_share_lock(struct smb_share *ssp, int flags, struct thread *td);
392 void smb_share_unlock(struct smb_share *ssp, int flags, struct thread *td);
393 void smb_share_invalidate(struct smb_share *ssp);
394 int  smb_share_valid(struct smb_share *ssp);
395 const char * smb_share_getpass(struct smb_share *ssp);
396 
397 /*
398  * SMB protocol level functions
399  */
400 int  smb_smb_negotiate(struct smb_vc *vcp, struct smb_cred *scred);
401 int  smb_smb_ssnsetup(struct smb_vc *vcp, struct smb_cred *scred);
402 int  smb_smb_ssnclose(struct smb_vc *vcp, struct smb_cred *scred);
403 int  smb_smb_treeconnect(struct smb_share *ssp, struct smb_cred *scred);
404 int  smb_smb_treedisconnect(struct smb_share *ssp, struct smb_cred *scred);
405 int  smb_read(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
406 	struct smb_cred *scred);
407 int  smb_write(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
408 	struct smb_cred *scred);
409 int  smb_smb_echo(struct smb_vc *vcp, struct smb_cred *scred);
410 
411 /*
412  * smbiod thread
413  */
414 
415 #define	SMBIOD_EV_NEWRQ		0x0001
416 #define	SMBIOD_EV_SHUTDOWN	0x0002
417 #define	SMBIOD_EV_CONNECT	0x0003
418 #define	SMBIOD_EV_DISCONNECT	0x0004
419 #define	SMBIOD_EV_TREECONNECT	0x0005
420 #define	SMBIOD_EV_MASK		0x00ff
421 #define	SMBIOD_EV_SYNC		0x0100
422 #define	SMBIOD_EV_PROCESSING	0x0200
423 
424 struct smbiod_event {
425 	int	ev_type;
426 	int	ev_error;
427 	void *	ev_ident;
428 	STAILQ_ENTRY(smbiod_event)	ev_link;
429 };
430 
431 #define	SMBIOD_SHUTDOWN		0x0001
432 
433 struct smbiod {
434 	int			iod_id;
435 	int			iod_flags;
436 	enum smbiod_state	iod_state;
437 	int			iod_muxcnt;	/* number of active outstanding requests */
438 	int			iod_sleeptimo;
439 	struct smb_vc *		iod_vc;
440 	struct smb_slock	iod_rqlock;	/* iod_rqlist, iod_muxwant */
441 	struct smb_rqhead	iod_rqlist;	/* list of outstanding requests */
442 	int			iod_muxwant;
443 	struct proc *		iod_p;
444 	struct thread *		iod_td;
445 	struct smb_cred		iod_scred;
446 	struct smb_slock	iod_evlock;	/* iod_evlist */
447 	STAILQ_HEAD(,smbiod_event) iod_evlist;
448 	struct timespec 	iod_lastrqsent;
449 	struct timespec 	iod_pingtimo;
450 };
451 
452 int  smb_iod_init(void);
453 int  smb_iod_done(void);
454 int  smb_iod_create(struct smb_vc *vcp);
455 int  smb_iod_destroy(struct smbiod *iod);
456 int  smb_iod_request(struct smbiod *iod, int event, void *ident);
457 int  smb_iod_addrq(struct smb_rq *rqp);
458 int  smb_iod_waitrq(struct smb_rq *rqp);
459 int  smb_iod_removerq(struct smb_rq *rqp);
460 
461 #endif /* _KERNEL */
462