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 * $Id: smb_subr.h,v 1.13 2004/09/14 22:59:08 lindak Exp $
33 */
34
35 /*
36 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
37 * Copyright 2018 Nexenta Systems, Inc. All rights reserved.
38 */
39
40 #ifndef _NETSMB_SMB_SUBR_H_
41 #define _NETSMB_SMB_SUBR_H_
42
43 #include <sys/cmn_err.h>
44 #include <sys/lock.h>
45 #include <sys/note.h>
46 #include <netsmb/mchain.h>
47 #include <netsmb/smb_conn.h>
48
49 /*
50 * Possible lock commands
51 */
52 #define SMB_LOCK_EXCL 0
53 #define SMB_LOCK_SHARED 1
54 #define SMB_LOCK_RELEASE 2
55
56 struct msgb; /* avoiding sys/stream.h here */
57
58 /* Helper function for SMBERROR */
59 /*PRINTFLIKE3*/
60 extern void smb_errmsg(int, const char *, const char *, ...)
61 __KPRINTFLIKE(3);
62 void m_dumpm(struct msgb *);
63
64 /*
65 * Let's use C99 standard variadic macros!
66 * Also the C99 __func__ (function name) feature.
67 */
68 #define SMBERROR(...) \
69 smb_errmsg(CE_NOTE, __func__, __VA_ARGS__)
70 #define SMBPANIC(...) \
71 smb_errmsg(CE_PANIC, __func__, __VA_ARGS__)
72 #define SMBSDEBUG(...) \
73 smb_errmsg(CE_CONT, __func__, __VA_ARGS__)
74 #define SMBIODEBUG(...) \
75 smb_errmsg(CE_CONT, __func__, __VA_ARGS__)
76 #define NBDEBUG(...) \
77 smb_errmsg(CE_CONT, __func__, __VA_ARGS__)
78
79 #if defined(DEBUG) || defined(lint)
80
81 #define DEBUG_ENTER(str) debug_enter(str)
82
83 #else /* DEBUG or lint */
84
85 #define DEBUG_ENTER(str) ((void)0)
86
87 #endif /* DEBUG or lint */
88
89 typedef uint16_t smb_unichar;
90 typedef smb_unichar *smb_uniptr;
91
92 extern smb_unichar smb_unieol;
93
94 struct mbchain;
95 struct smb_rq;
96 struct smb_vc;
97
98 /*
99 * These are the attributes we can get from the server via
100 * SMB commands such as TRANS2_QUERY_FILE_INFORMATION
101 * with info level SMB_QFILEINFO_ALL_INFO, and directory
102 * FindFirst/FindNext info. levels FIND_DIRECTORY_INFO
103 * and FIND_BOTH_DIRECTORY_INFO, etc.
104 *
105 * Values in this struct are always native endian,
106 * and times are converted converted to Unix form.
107 * Note: zero in any of the times means "unknown".
108 */
109 typedef struct smbfattr {
110 timespec_t fa_createtime; /* Note, != ctime */
111 timespec_t fa_atime; /* these 3 are like unix */
112 timespec_t fa_mtime;
113 timespec_t fa_ctime;
114 u_offset_t fa_size; /* EOF position */
115 u_offset_t fa_allocsz; /* Allocated size. */
116 uint32_t fa_attr; /* Ext. file (DOS) attr */
117 } smbfattr_t;
118
119 /*
120 * Tunable timeout values. See: smb_smb.c
121 */
122 extern int smb_timo_notice;
123 extern int smb_timo_default;
124 extern int smb_timo_open;
125 extern int smb_timo_read;
126 extern int smb_timo_write;
127 extern int smb_timo_append;
128 extern dev_t nsmb_dev_tcp;
129 extern dev_t nsmb_dev_tcp6;
130
131 /*
132 * Tunable timeout values. See: smb2_smb.c
133 */
134 extern int smb2_timo_notice;
135 extern int smb2_timo_default;
136 extern int smb2_timo_open;
137 extern int smb2_timo_read;
138 extern int smb2_timo_write;
139 extern int smb2_timo_append;
140
141 void smb_credinit(struct smb_cred *scred, cred_t *cr);
142 void smb_credrele(struct smb_cred *scred);
143
144 int smb_maperror(int eclass, int eno);
145 int smb_maperr32(uint32_t eno);
146 uint_t smb_doserr2status(int, int);
147 int smb_get_dstring(struct mdchain *mdc, struct smb_vc *vcp,
148 char *outbuf, size_t *outlen, int inlen);
149 int smb_put_dmem(struct mbchain *mbp, struct smb_vc *vcp,
150 const char *src, int len, int caseopt, int *lenp);
151 int smb_put_dstring(struct mbchain *mbp, struct smb_vc *vcp,
152 const char *src, int caseopt);
153 int smb_put_string(struct smb_rq *rqp, const char *src);
154 int smb_put_asunistring(struct smb_rq *rqp, const char *src);
155
156 int smb_smb_ntcreate(struct smb_share *ssp, struct mbchain *name_mb,
157 uint32_t crflag, uint32_t req_acc, uint32_t efa, uint32_t sh_acc,
158 uint32_t disp, uint32_t createopt, uint32_t impersonate,
159 struct smb_cred *scrp, smb_fh_t *fhp,
160 uint32_t *cr_act_p, struct smbfattr *fap);
161
162 int smb_smb_close(struct smb_share *ssp, smb_fh_t *fhp,
163 struct smb_cred *scrp);
164
165 int smb_rwuio(smb_fh_t *fhp, uio_rw_t rw,
166 uio_t *uiop, smb_cred_t *scred, int timo);
167
168 int smb_cmp_sockaddr(struct sockaddr *, struct sockaddr *);
169 struct sockaddr *smb_dup_sockaddr(struct sockaddr *sa);
170 void smb_free_sockaddr(struct sockaddr *sa);
171
172 int smb_sign_init(struct smb_vc *);
173 void smb_rq_sign(struct smb_rq *);
174 int smb_rq_verify(struct smb_rq *);
175 int smb_calcv2mackey(struct smb_vc *, const uchar_t *,
176 const uchar_t *, size_t);
177 int smb_calcmackey(struct smb_vc *, const uchar_t *,
178 const uchar_t *, size_t);
179
180 int smb2_sign_init(struct smb_vc *);
181 void smb2_rq_sign(struct smb_rq *);
182 int smb2_rq_verify(struct smb_rq *);
183
184 /*
185 * SMB protocol level functions
186 */
187 int smb_smb_negotiate(struct smb_vc *vcp, struct smb_cred *scred);
188 int smb_smb_ssnsetup(struct smb_vc *vcp, struct smb_cred *scred);
189 int smb_smb_logoff(struct smb_vc *vcp, struct smb_cred *scred);
190 int smb_smb_echo(smb_vc_t *vcp, smb_cred_t *scred, int timo);
191 int smb_smb_treeconnect(smb_share_t *ssp, smb_cred_t *scred);
192 int smb_smb_treedisconnect(smb_share_t *ssp, smb_cred_t *scred);
193
194 int smb1_smb_ntcreate(struct smb_share *ssp, struct mbchain *name_mb,
195 uint32_t crflag, uint32_t req_acc, uint32_t efa, uint32_t sh_acc,
196 uint32_t disp, uint32_t createopt, uint32_t impersonate,
197 struct smb_cred *scrp, uint16_t *fidp,
198 uint32_t *cr_act_p, struct smbfattr *fap);
199
200 int smb1_smb_close(struct smb_share *ssp, uint16_t fid,
201 struct timespec *mtime, struct smb_cred *scrp);
202
203 int smb_smb_open_prjob(struct smb_share *ssp, char *title,
204 uint16_t setuplen, uint16_t mode,
205 struct smb_cred *scrp, uint16_t *fidp);
206
207 int smb_smb_close_prjob(struct smb_share *ssp, uint16_t fid,
208 struct smb_cred *scrp);
209
210 int smb_smb_readx(smb_fh_t *fhp, uint32_t *lenp,
211 uio_t *uiop, smb_cred_t *scred, int timo);
212 int smb_smb_writex(smb_fh_t *fhp, uint32_t *lenp,
213 uio_t *uiop, smb_cred_t *scred, int timo);
214
215 /*
216 * SMB2 protocol level functions
217 */
218 int smb2_smb_negotiate(struct smb_vc *vcp, struct smb_cred *scred);
219 int smb2_smb_ssnsetup(struct smb_vc *vcp, struct smb_cred *scred);
220 int smb2_smb_logoff(struct smb_vc *vcp, struct smb_cred *scred);
221 int smb2_smb_echo(smb_vc_t *vcp, smb_cred_t *scred, int timo);
222 int smb2_smb_treeconnect(smb_share_t *ssp, smb_cred_t *scred);
223 int smb2_smb_treedisconnect(smb_share_t *ssp, smb_cred_t *scred);
224
225 int
226 smb2_smb_ntcreate(struct smb_share *ssp, struct mbchain *name_mb,
227 struct mbchain *cctx_in, struct mdchain *cctx_out,
228 uint32_t crflag, uint32_t req_acc, uint32_t efa, uint32_t sh_acc,
229 uint32_t disp, uint32_t createopt, uint32_t impersonate,
230 struct smb_cred *scrp, smb2fid_t *fidp,
231 uint32_t *cr_act_p, struct smbfattr *fap);
232
233 int smb2_smb_close(struct smb_share *ssp, smb2fid_t *fid,
234 struct smb_cred *scrp);
235
236 int smb2_smb_ioctl(struct smb_share *ssp, smb2fid_t *fid,
237 struct mbchain *data_in, struct mdchain *data_out,
238 uint32_t *data_out_sz, /* max / returned */
239 uint32_t ctl_code, struct smb_cred *scrp);
240
241 int smb2_smb_read(smb_fh_t *fhp, uint32_t *lenp,
242 uio_t *uiop, smb_cred_t *scred, int timo);
243 int smb2_smb_write(smb_fh_t *fhp, uint32_t *lenp,
244 uio_t *uiop, smb_cred_t *scred, int timo);
245
246 /*
247 * time conversions
248 */
249
250 void smb_time_local2server(struct timespec *tsp, int tzoff, long *seconds);
251 void smb_time_server2local(ulong_t seconds, int tzoff, struct timespec *tsp);
252 void smb_time_NT2local(uint64_t nsec, struct timespec *tsp);
253 void smb_time_local2NT(struct timespec *tsp, uint64_t *nsec);
254
255 #endif /* !_NETSMB_SMB_SUBR_H_ */