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