xref: /freebsd/sys/netsmb/smb_dev.h (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
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 _NETSMB_DEV_H_
35 #define _NETSMB_DEV_H_
36 
37 #ifndef _KERNEL
38 #include <sys/types.h>
39 #endif
40 #include <sys/ioccom.h>
41 
42 #include <netsmb/smb.h>
43 
44 #define	NSMB_NAME		"nsmb"
45 
46 #define NSMB_VERMAJ	1
47 #define NSMB_VERMIN	3006
48 #define NSMB_VERSION	(NSMB_VERMAJ * 100000 + NSMB_VERMIN)
49 
50 #define NSMBFL_OPEN		0x0001
51 
52 #define	SMBVOPT_CREATE		0x0001	/* create object if necessary */
53 #define	SMBVOPT_PRIVATE		0x0002	/* connection should be private */
54 #define	SMBVOPT_SINGLESHARE	0x0004	/* keep only one share at this VC */
55 #define	SMBVOPT_PERMANENT	0x0010	/* object will keep last reference */
56 
57 #define	SMBSOPT_CREATE		0x0001	/* create object if necessary */
58 #define	SMBSOPT_PERMANENT	0x0010	/* object will keep last reference */
59 
60 /*
61  * SMBIOC_LOOKUP flags
62  */
63 #define SMBLK_CREATE		0x0001
64 
65 struct smbioc_ossn {
66 	int		ioc_opt;
67 	int		ioc_svlen;	/* size of ioc_server address */
68 	struct sockaddr*ioc_server;
69 	int		ioc_lolen;	/* size of ioc_local address */
70 	struct sockaddr*ioc_local;
71 	char		ioc_srvname[SMB_MAXSRVNAMELEN + 1];
72 	int		ioc_timeout;
73 	int		ioc_retrycount;	/* number of retries before giveup */
74 	char		ioc_localcs[16];/* local charset */
75 	char		ioc_servercs[16];/* server charset */
76 	char		ioc_user[SMB_MAXUSERNAMELEN + 1];
77 	char		ioc_workgroup[SMB_MAXUSERNAMELEN + 1];
78 	char		ioc_password[SMB_MAXPASSWORDLEN + 1];
79 	uid_t		ioc_owner;	/* proposed owner */
80 	gid_t		ioc_group;	/* proposed group */
81 	mode_t		ioc_mode;	/* desired access mode */
82 	mode_t		ioc_rights;	/* SMBM_* */
83 };
84 
85 struct smbioc_oshare {
86 	int		ioc_opt;
87 	int		ioc_stype;	/* share type */
88 	char		ioc_share[SMB_MAXSHARENAMELEN + 1];
89 	char		ioc_password[SMB_MAXPASSWORDLEN + 1];
90 	uid_t		ioc_owner;	/* proposed owner of share */
91 	gid_t		ioc_group;	/* proposed group of share */
92 	mode_t		ioc_mode;	/* desired access mode to share */
93 	mode_t		ioc_rights;	/* SMBM_* */
94 };
95 
96 struct smbioc_rq {
97 	u_char		ioc_cmd;
98 	u_char		ioc_twc;
99 	void *		ioc_twords;
100 	u_short		ioc_tbc;
101 	void *		ioc_tbytes;
102 	int		ioc_rpbufsz;
103 	char *		ioc_rpbuf;
104 	u_char		ioc_rwc;
105 	u_short		ioc_rbc;
106 	u_int8_t	ioc_errclass;
107 	u_int16_t	ioc_serror;
108 	u_int32_t	ioc_error;
109 };
110 
111 struct smbioc_t2rq {
112 	u_int16_t	ioc_setup[3];
113 	int		ioc_setupcnt;
114 	char *		ioc_name;
115 	u_short		ioc_tparamcnt;
116 	void *		ioc_tparam;
117 	u_short		ioc_tdatacnt;
118 	void *		ioc_tdata;
119 	u_short		ioc_rparamcnt;
120 	void *		ioc_rparam;
121 	u_short		ioc_rdatacnt;
122 	void *		ioc_rdata;
123 };
124 
125 struct smbioc_flags {
126 	int		ioc_level;	/* 0 - session, 1 - share */
127 	int		ioc_mask;
128 	int		ioc_flags;
129 };
130 
131 struct smbioc_lookup {
132 	int		ioc_level;
133 	int		ioc_flags;
134 	struct smbioc_ossn	ioc_ssn;
135 	struct smbioc_oshare	ioc_sh;
136 };
137 
138 struct smbioc_rw {
139 	smbfh	ioc_fh;
140 	char *	ioc_base;
141 	off_t	ioc_offset;
142 	int	ioc_cnt;
143 };
144 
145 /*
146  * Device IOCTLs
147  */
148 #define	SMBIOC_OPENSESSION	_IOW('n',  100, struct smbioc_ossn)
149 #define	SMBIOC_OPENSHARE	_IOW('n',  101, struct smbioc_oshare)
150 #define	SMBIOC_REQUEST		_IOWR('n', 102, struct smbioc_rq)
151 #define	SMBIOC_T2RQ		_IOWR('n', 103, struct smbioc_t2rq)
152 #define	SMBIOC_SETFLAGS		_IOW('n',  104, struct smbioc_flags)
153 #define	SMBIOC_LOOKUP		_IOW('n',  106, struct smbioc_lookup)
154 #define	SMBIOC_READ		_IOWR('n', 107, struct smbioc_rw)
155 #define	SMBIOC_WRITE		_IOWR('n', 108, struct smbioc_rw)
156 
157 #ifdef _KERNEL
158 
159 #define SMBST_CONNECTED	1
160 
161 STAILQ_HEAD(smbrqh, smb_rq);
162 
163 struct smb_dev {
164 	int		sd_opened;
165 	int		sd_level;
166 	struct smb_vc * sd_vc;		/* reference to VC */
167 	struct smb_share *sd_share;	/* reference to share if any */
168 	int		sd_poll;
169 	int		sd_seq;
170 /*	struct ifqueue	sd_rdqueue;
171 	struct ifqueue	sd_wrqueue;
172 	struct selinfo	sd_pollinfo;
173 	struct smbrqh	sd_rqlist;
174 	struct smbrqh	sd_rplist;
175 	struct ucred 	*sd_owner;*/
176 	int		sd_flags;
177 };
178 
179 struct smb_cred;
180 /*
181  * Compound user interface
182  */
183 int  smb_usr_lookup(struct smbioc_lookup *dp, struct smb_cred *scred,
184 	struct smb_vc **vcpp, struct smb_share **sspp);
185 int  smb_usr_opensession(struct smbioc_ossn *data,
186 	struct smb_cred *scred,	struct smb_vc **vcpp);
187 int  smb_usr_openshare(struct smb_vc *vcp, struct smbioc_oshare *data,
188 	struct smb_cred *scred, struct smb_share **sspp);
189 int  smb_usr_simplerequest(struct smb_share *ssp, struct smbioc_rq *data,
190 	struct smb_cred *scred);
191 int  smb_usr_t2request(struct smb_share *ssp, struct smbioc_t2rq *data,
192 	struct smb_cred *scred);
193 int  smb_dev2share(int fd, int mode, struct smb_cred *scred,
194 	struct smb_share **sspp);
195 
196 
197 #endif /* _KERNEL */
198 
199 #endif /* _NETSMB_DEV_H_ */
200