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 * 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: releng/5.0/sys/netsmb/smb_conn.h 103396 2002-09-16 10:50:38Z bp $
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 int vc_rxmax; /* max readx data size */
268 int vc_wxmax; /* max writex data size */
269 struct smbiod * vc_iod;
270 struct smb_slock vc_stlock;
271 };
272
273 #define vc_maxmux vc_sopt.sv_maxmux
274 #define vc_flags obj.co_flags
275
276 #define SMB_UNICODE_STRINGS(vcp) ((vcp)->vc_hflags2 & SMB_FLAGS2_UNICODE)
277
278 /*
279 * smb_share structure describes connection to the given SMB share (tree).
280 * Connection to share is always built on top of the VC.
281 */
282
283 /*
284 * This lock protects ss_flags
285 */
286 #define SMBS_ST_LOCK(ssp) smb_sl_lock(&(ssp)->ss_stlock)
287 #define SMBS_ST_LOCKPTR(ssp) (&(ssp)->ss_stlock)
288 #define SMBS_ST_UNLOCK(ssp) smb_sl_unlock(&(ssp)->ss_stlock)
289
290 struct smb_share {
291 struct smb_connobj obj;
292 char * ss_name;
293 u_short ss_tid; /* TID */
294 int ss_type; /* share type */
295 uid_t ss_uid; /* user id of connection */
296 gid_t ss_grp; /* group of connection */
297 mode_t ss_mode; /* access mode */
298 int ss_vcgenid;
299 char * ss_pass; /* password to a share, can be null */
300 struct smb_slock ss_stlock;
301 };
302
303 #define ss_flags obj.co_flags
304
305 #define CPTOVC(cp) ((struct smb_vc*)(cp))
306 #define VCTOCP(vcp) (&(vcp)->obj)
307 #define CPTOSS(cp) ((struct smb_share*)(cp))
308 #define SSTOVC(ssp) CPTOVC(((ssp)->obj.co_parent))
309 #define SSTOCP(ssp) (&(ssp)->obj)
310
311 struct smb_vcspec {
312 char * srvname;
313 struct sockaddr*sap;
314 struct sockaddr*lap;
315 int flags;
316 char * username;
317 char * pass;
318 char * domain;
319 mode_t mode;
320 mode_t rights;
321 uid_t owner;
322 gid_t group;
323 char * localcs;
324 char * servercs;
325 struct smb_sharespec *shspec;
326 struct smb_share *ssp; /* returned */
327 /*
328 * The rest is an internal data
329 */
330 struct smb_cred *scred;
331 };
332
333 struct smb_sharespec {
334 char * name;
335 char * pass;
336 mode_t mode;
337 mode_t rights;
338 uid_t owner;
339 gid_t group;
340 int stype;
341 /*
342 * The rest is an internal data
343 */
344 struct smb_cred *scred;
345 };
346
347 /*
348 * Session level functions
349 */
350 int smb_sm_init(void);
351 int smb_sm_done(void);
352 int smb_sm_lookup(struct smb_vcspec *vcspec,
353 struct smb_sharespec *shspec, struct smb_cred *scred,
354 struct smb_vc **vcpp);
355
356 /*
357 * Connection object
358 */
359 void smb_co_ref(struct smb_connobj *cp);
360 void smb_co_rele(struct smb_connobj *cp, struct smb_cred *scred);
361 int smb_co_get(struct smb_connobj *cp, int flags, struct smb_cred *scred);
362 void smb_co_put(struct smb_connobj *cp, struct smb_cred *scred);
363 int smb_co_lock(struct smb_connobj *cp, int flags, struct thread *td);
364 void smb_co_unlock(struct smb_connobj *cp, int flags, struct thread *td);
365
366 /*
367 * session level functions
368 */
369 int smb_vc_create(struct smb_vcspec *vcspec,
370 struct smb_cred *scred, struct smb_vc **vcpp);
371 int smb_vc_connect(struct smb_vc *vcp, struct smb_cred *scred);
372 int smb_vc_access(struct smb_vc *vcp, struct smb_cred *scred, mode_t mode);
373 int smb_vc_get(struct smb_vc *vcp, int flags, struct smb_cred *scred);
374 void smb_vc_put(struct smb_vc *vcp, struct smb_cred *scred);
375 void smb_vc_ref(struct smb_vc *vcp);
376 void smb_vc_rele(struct smb_vc *vcp, struct smb_cred *scred);
377 int smb_vc_lock(struct smb_vc *vcp, int flags, struct thread *td);
378 void smb_vc_unlock(struct smb_vc *vcp, int flags, struct thread *td);
379 int smb_vc_lookupshare(struct smb_vc *vcp, struct smb_sharespec *shspec,
380 struct smb_cred *scred, struct smb_share **sspp);
381 const char * smb_vc_getpass(struct smb_vc *vcp);
382 u_short smb_vc_nextmid(struct smb_vc *vcp);
383
384 /*
385 * share level functions
386 */
387 int smb_share_create(struct smb_vc *vcp, struct smb_sharespec *shspec,
388 struct smb_cred *scred, struct smb_share **sspp);
389 int smb_share_access(struct smb_share *ssp, struct smb_cred *scred, mode_t mode);
390 void smb_share_ref(struct smb_share *ssp);
391 void smb_share_rele(struct smb_share *ssp, struct smb_cred *scred);
392 int smb_share_get(struct smb_share *ssp, int flags, struct smb_cred *scred);
393 void smb_share_put(struct smb_share *ssp, struct smb_cred *scred);
394 int smb_share_lock(struct smb_share *ssp, int flags, struct thread *td);
395 void smb_share_unlock(struct smb_share *ssp, int flags, struct thread *td);
396 void smb_share_invalidate(struct smb_share *ssp);
397 int smb_share_valid(struct smb_share *ssp);
398 const char * smb_share_getpass(struct smb_share *ssp);
399
400 /*
401 * SMB protocol level functions
402 */
403 int smb_smb_negotiate(struct smb_vc *vcp, struct smb_cred *scred);
404 int smb_smb_ssnsetup(struct smb_vc *vcp, struct smb_cred *scred);
405 int smb_smb_ssnclose(struct smb_vc *vcp, struct smb_cred *scred);
406 int smb_smb_treeconnect(struct smb_share *ssp, struct smb_cred *scred);
407 int smb_smb_treedisconnect(struct smb_share *ssp, struct smb_cred *scred);
408 int smb_read(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
409 struct smb_cred *scred);
410 int smb_write(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
411 struct smb_cred *scred);
412 int smb_smb_echo(struct smb_vc *vcp, struct smb_cred *scred);
413
414 /*
415 * smbiod thread
416 */
417
418 #define SMBIOD_EV_NEWRQ 0x0001
419 #define SMBIOD_EV_SHUTDOWN 0x0002
420 #define SMBIOD_EV_CONNECT 0x0003
421 #define SMBIOD_EV_DISCONNECT 0x0004
422 #define SMBIOD_EV_TREECONNECT 0x0005
423 #define SMBIOD_EV_MASK 0x00ff
424 #define SMBIOD_EV_SYNC 0x0100
425 #define SMBIOD_EV_PROCESSING 0x0200
426
427 struct smbiod_event {
428 int ev_type;
429 int ev_error;
430 void * ev_ident;
431 STAILQ_ENTRY(smbiod_event) ev_link;
432 };
433
434 #define SMBIOD_SHUTDOWN 0x0001
435
436 struct smbiod {
437 int iod_id;
438 int iod_flags;
439 enum smbiod_state iod_state;
440 int iod_muxcnt; /* number of active outstanding requests */
441 int iod_sleeptimo;
442 struct smb_vc * iod_vc;
443 struct smb_slock iod_rqlock; /* iod_rqlist, iod_muxwant */
444 struct smb_rqhead iod_rqlist; /* list of outstanding requests */
445 int iod_muxwant;
446 struct proc * iod_p;
447 struct thread * iod_td;
448 struct smb_cred iod_scred;
449 struct smb_slock iod_evlock; /* iod_evlist */
450 STAILQ_HEAD(,smbiod_event) iod_evlist;
451 struct timespec iod_lastrqsent;
452 struct timespec iod_pingtimo;
453 };
454
455 int smb_iod_init(void);
456 int smb_iod_done(void);
457 int smb_iod_create(struct smb_vc *vcp);
458 int smb_iod_destroy(struct smbiod *iod);
459 int smb_iod_request(struct smbiod *iod, int event, void *ident);
460 int smb_iod_addrq(struct smb_rq *rqp);
461 int smb_iod_waitrq(struct smb_rq *rqp);
462 int smb_iod_removerq(struct smb_rq *rqp);
463
464 #endif /* _KERNEL */
Cache object: 29a3b97e0d342712870fb6a2adc4290f
|