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
36 * Two levels of connection hierarchy
42 #define SMBL_NONE (-1)
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 */
51 #define SMBO_GONE 0x1000000
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)
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 */
90 #define SMBS_PERMANENT 0x0001
91 #define SMBS_RECONNECTING 0x0002
92 #define SMBS_CONNECTED 0x0004
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 */
106 * Negotiated protocol parameters
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_ */
122 * network IO daemon states
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 */
136 #define SMB_INFO_NONE 0
137 #define SMB_INFO_VC 2
138 #define SMB_INFO_SHARE 3
143 uid_t uid; /* user id of connection */
144 gid_t gid; /* group of connection */
145 mode_t mode; /* access mode */
147 enum smbiod_state iodstate;
148 struct smb_sopt sopt;
149 char srvname[SMB_MAXSRVNAMELEN + 1];
153 struct smb_share_info {
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 */
167 #include <sys/lock.h>
168 #include <sys/lockmgr.h>
169 #include <netsmb/smb_subr.h>
171 #define CONNADDREQ(a1,a2) ((a1)->sa_len == (a2)->sa_len && \
172 bcmp(a1, a2, (a1)->sa_len) == 0)
179 struct smbioc_oshare;
183 TAILQ_HEAD(smb_rqhead, smb_rq);
185 #define SMB_DEFRQTIMO 5
187 #define SMB_DIALECT(vcp) ((vcp)->vc_sopt.sv_proto)
189 struct smb_tran_desc;
196 typedef void smb_co_gone_t (struct smb_connobj *cp, struct smb_cred *scred);
197 typedef void smb_co_free_t (struct smb_connobj *cp);
199 #define SMB_CO_LOCK(cp) smb_sl_lock(&(cp)->co_interlock)
200 #define SMB_CO_UNLOCK(cp) smb_sl_unlock(&(cp)->co_interlock)
203 int co_level; /* SMBL_ */
206 struct smb_slock co_interlock;
208 struct smb_connobj * co_parent;
209 SLIST_HEAD(,smb_connobj)co_children;
210 SLIST_ENTRY(smb_connobj)co_next;
211 smb_co_gone_t * co_gone;
212 smb_co_free_t * co_free;
215 #define SMBCO_FOREACH(var, cp) SLIST_FOREACH((var), &(cp)->co_children, co_next)
218 * Virtual Circuit (session) to a server.
219 * This is the most (over)complicated part of SMB protocol.
220 * For the user security level (usl), each session with different remote
221 * user name has its own VC.
222 * It is unclear however, should share security level (ssl) allow additional
223 * VCs, because user name is not used and can be the same. On other hand,
224 * multiple VCs allows us to create separate sessions to server on a per
229 * This lock protects vc_flags
231 #define SMBC_ST_LOCK(vcp) smb_sl_lock(&(vcp)->vc_stlock)
232 #define SMBC_ST_UNLOCK(vcp) smb_sl_unlock(&(vcp)->vc_stlock)
236 struct smb_connobj obj;
238 struct sockaddr*vc_paddr; /* server addr */
239 struct sockaddr*vc_laddr; /* local addr, if any */
241 char * vc_pass; /* password for usl case */
242 char * vc_domain; /* workgroup/primary domain */
244 u_int vc_timo; /* default request timeout */
245 int vc_maxvcs; /* maximum number of VC per connection */
247 void * vc_tolower; /* local charset */
248 void * vc_toupper; /* local charset */
249 void * vc_toserver; /* local charset to server one */
250 void * vc_tolocal; /* server charset to local one */
251 void * vc_cp_toserver; /* local charset to server one (using CodePage) */
252 void * vc_cp_tolocal; /* server charset to local one (using CodePage) */
253 void * vc_ucs_toserver; /* local charset to server one (using UCS-2) */
254 void * vc_ucs_tolocal; /* server charset to local one (using UCS-2) */
255 int vc_number; /* number of this VC from the client side */
257 uid_t vc_uid; /* user id of connection */
258 gid_t vc_grp; /* group of connection */
259 mode_t vc_mode; /* access mode */
260 u_short vc_smbuid; /* unique vc id assigned by server */
262 u_char vc_hflags; /* or'ed with flags in the smb header */
263 u_short vc_hflags2; /* or'ed with flags in the smb header */
264 void * vc_tdata; /* transport control block */
265 struct smb_tran_desc *vc_tdesc;
266 int vc_chlen; /* actual challenge length */
267 u_char vc_ch[SMB_MAXCHALLENGELEN];
268 u_short vc_mid; /* multiplex id */
269 struct smb_sopt vc_sopt; /* server options */
270 int vc_txmax; /* max tx/rx packet size */
271 int vc_rxmax; /* max readx data size */
272 int vc_wxmax; /* max writex data size */
273 struct smbiod * vc_iod;
274 struct smb_slock vc_stlock;
275 u_int32_t vc_seqno; /* my next sequence number */
276 u_int8_t *vc_mackey; /* MAC key */
277 int vc_mackeylen; /* length of MAC key */
280 #define vc_maxmux vc_sopt.sv_maxmux
281 #define vc_flags obj.co_flags
283 #define SMB_UNICODE_STRINGS(vcp) ((vcp)->vc_hflags2 & SMB_FLAGS2_UNICODE)
285 #define SMB_UNICODE_NAME "UCS-2LE"
288 * smb_share structure describes connection to the given SMB share (tree).
289 * Connection to share is always built on top of the VC.
293 * This lock protects ss_flags
295 #define SMBS_ST_LOCK(ssp) smb_sl_lock(&(ssp)->ss_stlock)
296 #define SMBS_ST_LOCKPTR(ssp) (&(ssp)->ss_stlock)
297 #define SMBS_ST_UNLOCK(ssp) smb_sl_unlock(&(ssp)->ss_stlock)
300 struct smb_connobj obj;
302 u_short ss_tid; /* TID */
303 int ss_type; /* share type */
304 uid_t ss_uid; /* user id of connection */
305 gid_t ss_grp; /* group of connection */
306 mode_t ss_mode; /* access mode */
308 char * ss_pass; /* password to a share, can be null */
309 struct smb_slock ss_stlock;
312 #define ss_flags obj.co_flags
314 #define CPTOVC(cp) ((struct smb_vc*)(cp))
315 #define VCTOCP(vcp) (&(vcp)->obj)
316 #define CPTOSS(cp) ((struct smb_share*)(cp))
317 #define SSTOVC(ssp) CPTOVC(((ssp)->obj.co_parent))
318 #define SSTOCP(ssp) (&(ssp)->obj)
334 struct smb_sharespec *shspec;
335 struct smb_share *ssp; /* returned */
337 * The rest is an internal data
339 struct smb_cred *scred;
342 struct smb_sharespec {
351 * The rest is an internal data
353 struct smb_cred *scred;
357 * Session level functions
359 int smb_sm_init(void);
360 int smb_sm_done(void);
361 int smb_sm_lookup(struct smb_vcspec *vcspec,
362 struct smb_sharespec *shspec, struct smb_cred *scred,
363 struct smb_vc **vcpp);
368 void smb_co_ref(struct smb_connobj *cp);
369 void smb_co_rele(struct smb_connobj *cp, struct smb_cred *scred);
370 int smb_co_get(struct smb_connobj *cp, int flags, struct smb_cred *scred);
371 void smb_co_put(struct smb_connobj *cp, struct smb_cred *scred);
372 int smb_co_lock(struct smb_connobj *cp, int flags);
373 void smb_co_unlock(struct smb_connobj *cp, int flags);
376 * session level functions
378 int smb_vc_create(struct smb_vcspec *vcspec,
379 struct smb_cred *scred, struct smb_vc **vcpp);
380 int smb_vc_connect(struct smb_vc *vcp, struct smb_cred *scred);
381 int smb_vc_access(struct smb_vc *vcp, struct smb_cred *scred, mode_t mode);
382 int smb_vc_get(struct smb_vc *vcp, int flags, struct smb_cred *scred);
383 void smb_vc_put(struct smb_vc *vcp, struct smb_cred *scred);
384 void smb_vc_ref(struct smb_vc *vcp);
385 void smb_vc_rele(struct smb_vc *vcp, struct smb_cred *scred);
386 int smb_vc_lock(struct smb_vc *vcp, int flags);
387 void smb_vc_unlock(struct smb_vc *vcp, int flags);
388 int smb_vc_lookupshare(struct smb_vc *vcp, struct smb_sharespec *shspec,
389 struct smb_cred *scred, struct smb_share **sspp);
390 const char * smb_vc_getpass(struct smb_vc *vcp);
391 u_short smb_vc_nextmid(struct smb_vc *vcp);
394 * share level functions
396 int smb_share_create(struct smb_vc *vcp, struct smb_sharespec *shspec,
397 struct smb_cred *scred, struct smb_share **sspp);
398 int smb_share_access(struct smb_share *ssp, struct smb_cred *scred, mode_t mode);
399 void smb_share_ref(struct smb_share *ssp);
400 void smb_share_rele(struct smb_share *ssp, struct smb_cred *scred);
401 int smb_share_get(struct smb_share *ssp, int flags, struct smb_cred *scred);
402 void smb_share_put(struct smb_share *ssp, struct smb_cred *scred);
403 int smb_share_lock(struct smb_share *ssp, int flags);
404 void smb_share_unlock(struct smb_share *ssp, int flags);
405 void smb_share_invalidate(struct smb_share *ssp);
406 int smb_share_valid(struct smb_share *ssp);
407 const char * smb_share_getpass(struct smb_share *ssp);
410 * SMB protocol level functions
412 int smb_smb_negotiate(struct smb_vc *vcp, struct smb_cred *scred);
413 int smb_smb_ssnsetup(struct smb_vc *vcp, struct smb_cred *scred);
414 int smb_smb_ssnclose(struct smb_vc *vcp, struct smb_cred *scred);
415 int smb_smb_treeconnect(struct smb_share *ssp, struct smb_cred *scred);
416 int smb_smb_treedisconnect(struct smb_share *ssp, struct smb_cred *scred);
417 int smb_read(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
418 struct smb_cred *scred);
419 int smb_write(struct smb_share *ssp, u_int16_t fid, struct uio *uio,
420 struct smb_cred *scred);
421 int smb_smb_echo(struct smb_vc *vcp, struct smb_cred *scred);
427 #define SMBIOD_EV_NEWRQ 0x0001
428 #define SMBIOD_EV_SHUTDOWN 0x0002
429 #define SMBIOD_EV_CONNECT 0x0003
430 #define SMBIOD_EV_DISCONNECT 0x0004
431 #define SMBIOD_EV_TREECONNECT 0x0005
432 #define SMBIOD_EV_MASK 0x00ff
433 #define SMBIOD_EV_SYNC 0x0100
434 #define SMBIOD_EV_PROCESSING 0x0200
436 struct smbiod_event {
440 STAILQ_ENTRY(smbiod_event) ev_link;
443 #define SMBIOD_SHUTDOWN 0x0001
448 enum smbiod_state iod_state;
449 int iod_muxcnt; /* number of active outstanding requests */
451 struct smb_vc * iod_vc;
452 struct smb_slock iod_rqlock; /* iod_rqlist, iod_muxwant */
453 struct smb_rqhead iod_rqlist; /* list of outstanding requests */
456 struct thread * iod_td;
457 struct smb_cred iod_scred;
458 struct smb_slock iod_evlock; /* iod_evlist */
459 STAILQ_HEAD(,smbiod_event) iod_evlist;
460 struct timespec iod_lastrqsent;
461 struct timespec iod_pingtimo;
464 int smb_iod_init(void);
465 int smb_iod_done(void);
466 int smb_iod_create(struct smb_vc *vcp);
467 int smb_iod_destroy(struct smbiod *iod);
468 int smb_iod_request(struct smbiod *iod, int event, void *ident);
469 int smb_iod_addrq(struct smb_rq *rqp);
470 int smb_iod_waitrq(struct smb_rq *rqp);
471 int smb_iod_removerq(struct smb_rq *rqp);