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