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
  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 + 1];
 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/lock.h>
 168 #include <sys/lockmgr.h>
 169 #include <netsmb/smb_subr.h>
 170
 171 #define CONNADDREQ(a1,a2)       ((a1)->sa_len == (a2)->sa_len && \
 172                                  bcmp(a1, a2, (a1)->sa_len) == 0)
 173
 174 struct smb_vc;
 175 struct smb_share;
 176 struct smb_cred;
 177 struct smb_rq;
 178 struct mbdata;
 179 struct smbioc_oshare;
 180 struct smbioc_ossn;
 181 struct uio;
 182
 183 TAILQ_HEAD(smb_rqhead, smb_rq);
 184
 185 #define SMB_DEFRQTIMO   5
 186
 187 #define SMB_DIALECT(vcp)        ((vcp)->vc_sopt.sv_proto)
 188
 189 struct smb_tran_desc;
 190
 191 /*
 192  * Connection object
 193  */
 194 struct smb_connobj;
 195
 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);
 198
 199 #define SMB_CO_LOCK(cp)         smb_sl_lock(&(cp)->co_interlock)
 200 #define SMB_CO_UNLOCK(cp)       smb_sl_unlock(&(cp)->co_interlock)
 201
 202 struct smb_connobj {
 203         int                     co_level;       /* SMBL_ */
 204         int                     co_flags;
 205         struct lock             co_lock;
 206         struct smb_slock        co_interlock;
 207         int                     co_usecount;
 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;
 213 };
 214
 215 #define SMBCO_FOREACH(var, cp)  SLIST_FOREACH((var), &(cp)->co_children, co_next)
 216
 217 /*
 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
 225  * user basis.
 226  */
 227
 228 /*
 229  * This lock protects vc_flags
 230  */
 231 #define SMBC_ST_LOCK(vcp)       smb_sl_lock(&(vcp)->vc_stlock)
 232 #define SMBC_ST_UNLOCK(vcp)     smb_sl_unlock(&(vcp)->vc_stlock)
 233
 234
 235 struct smb_vc {
 236         struct smb_connobj obj;
 237         char *          vc_srvname;
 238         struct sockaddr*vc_paddr;       /* server addr */
 239         struct sockaddr*vc_laddr;       /* local addr, if any */
 240         char *          vc_username;
 241         char *          vc_pass;        /* password for usl case */
 242         char *          vc_domain;      /* workgroup/primary domain */
 243
 244         u_int           vc_timo;        /* default request timeout */
 245         int             vc_maxvcs;      /* maximum number of VC per connection */
 246
 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         int             vc_number;      /* number of this VC from the client side */
 252         int             vc_genid;
 253         uid_t           vc_uid;         /* user id of connection */
 254         gid_t           vc_grp;         /* group of connection */
 255         mode_t          vc_mode;        /* access mode */
 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         u_int32_t       vc_seqno;       /* my next sequence number */
 272         u_int8_t        *vc_mackey;     /* MAC key */
 273         int             vc_mackeylen;   /* length of MAC key */
 274 };
 275
 276 #define vc_maxmux       vc_sopt.sv_maxmux
 277 #define vc_flags        obj.co_flags
 278
 279 #define SMB_UNICODE_STRINGS(vcp)        ((vcp)->vc_hflags2 & SMB_FLAGS2_UNICODE)
 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, int flags, 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, int flags);
 367 void smb_co_unlock(struct smb_connobj *cp, int flags);
 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, int flags, 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, int flags);
 381 void smb_vc_unlock(struct smb_vc *vcp, int flags);
 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, int flags, 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, int flags);
 398 void smb_share_unlock(struct smb_share *ssp, int flags);
 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 */