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 2011 Nexenta Systems, Inc. All rights reserved.
37 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. 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/smb_conn.h>
47
48 struct msgb; /* avoiding sys/stream.h here */
49
50 /* Helper function for SMBERROR */
51 /*PRINTFLIKE3*/
52 extern void smb_errmsg(int, const char *, const char *, ...)
53 __KPRINTFLIKE(3);
54 void m_dumpm(struct msgb *);
55
56 /*
57 * Let's use C99 standard variadic macros!
58 * Also the C99 __func__ (function name) feature.
59 */
60 #define SMBERROR(...) \
61 smb_errmsg(CE_NOTE, __func__, __VA_ARGS__)
62 #define SMBPANIC(...) \
63 smb_errmsg(CE_PANIC, __func__, __VA_ARGS__)
64 #define SMBSDEBUG(...) \
65 smb_errmsg(CE_CONT, __func__, __VA_ARGS__)
66 #define SMBIODEBUG(...) \
67 smb_errmsg(CE_CONT, __func__, __VA_ARGS__)
68 #define NBDEBUG(...) \
69 smb_errmsg(CE_CONT, __func__, __VA_ARGS__)
70
71 #if defined(DEBUG) || defined(lint)
72
73 #define DEBUG_ENTER(str) debug_enter(str)
74
75 #else /* DEBUG or lint */
76
77 #define DEBUG_ENTER(str) ((void)0)
78
79 #endif /* DEBUG or lint */
80
81 typedef uint16_t smb_unichar;
82 typedef smb_unichar *smb_uniptr;
83
84 extern smb_unichar smb_unieol;
85
86 struct mbchain;
87 struct smb_rq;
88 struct smb_vc;
89
90 /*
91 * These are the attributes we can get from the server via
92 * SMB commands such as TRANS2_QUERY_FILE_INFORMATION
93 * with info level SMB_QFILEINFO_ALL_INFO, and directory
94 * FindFirst/FindNext info. levels FIND_DIRECTORY_INFO
95 * and FIND_BOTH_DIRECTORY_INFO, etc.
96 *
97 * Values in this struct are always native endian,
98 * and times are converted converted to Unix form.
99 * Note: zero in any of the times means "unknown".
100 */
101 typedef struct smbfattr {
102 timespec_t fa_createtime; /* Note, != ctime */
103 timespec_t fa_atime; /* these 3 are like unix */
104 timespec_t fa_mtime;
105 timespec_t fa_ctime;
106 u_offset_t fa_size; /* EOF position */
107 u_offset_t fa_allocsz; /* Allocated size. */
108 uint32_t fa_attr; /* Ext. file (DOS) attr */
109 } smbfattr_t;
110
111 /*
112 * Tunable timeout values. See: smb_smb.c
113 */
114 extern int smb_timo_notice;
115 extern int smb_timo_default;
116 extern int smb_timo_open;
117 extern int smb_timo_read;
118 extern int smb_timo_write;
119 extern int smb_timo_append;
120
121 #define EMOREDATA (0x7fff)
122
123 void smb_credinit(struct smb_cred *scred, cred_t *cr);
124 void smb_credrele(struct smb_cred *scred);
125
126 void smb_oldlm_hash(const char *apwd, uchar_t *hash);
127 void smb_ntlmv1hash(const char *apwd, uchar_t *hash);
128 void smb_ntlmv2hash(const uchar_t *v1hash, const char *user,
129 const char *destination, uchar_t *v2hash);
130
131 int smb_lmresponse(const uchar_t *hash, const uchar_t *C8, uchar_t *RN);
132 int smb_ntlmv2response(const uchar_t *hash, const uchar_t *C8,
133 const uchar_t *blob, size_t bloblen, uchar_t **RN, size_t *RNlen);
134 int smb_maperror(int eclass, int eno);
135 int smb_maperr32(uint32_t eno);
136 int smb_put_dmem(struct mbchain *mbp, struct smb_vc *vcp,
137 const char *src, int len, int caseopt, int *lenp);
138 int smb_put_dstring(struct mbchain *mbp, struct smb_vc *vcp,
139 const char *src, int caseopt);
140 int smb_put_string(struct smb_rq *rqp, const char *src);
141 int smb_put_asunistring(struct smb_rq *rqp, const char *src);
142 int smb_checksmp(void);
143
144 int smb_cmp_sockaddr(struct sockaddr *, struct sockaddr *);
145 struct sockaddr *smb_dup_sockaddr(struct sockaddr *sa);
146 void smb_free_sockaddr(struct sockaddr *sa);
147 int smb_toupper(const char *, char *, size_t);
148
149 void smb_rq_sign(struct smb_rq *);
150 int smb_rq_verify(struct smb_rq *);
151 int smb_calcv2mackey(struct smb_vc *, const uchar_t *,
152 const uchar_t *, size_t);
153 int smb_calcmackey(struct smb_vc *, const uchar_t *,
154 const uchar_t *, size_t);
155 void smb_crypto_mech_init(void);
156
157
158 /*
159 * SMB protocol level functions
160 */
161 int smb_smb_echo(smb_vc_t *vcp, smb_cred_t *scred, int timo);
162 int smb_smb_treeconnect(smb_share_t *ssp, smb_cred_t *scred);
163 int smb_smb_treedisconnect(smb_share_t *ssp, smb_cred_t *scred);
164
165 int
166 smb_smb_ntcreate(struct smb_share *ssp, struct mbchain *name_mb,
167 uint32_t crflag, uint32_t req_acc, uint32_t efa, uint32_t sh_acc,
168 uint32_t disp, uint32_t createopt, uint32_t impersonate,
169 struct smb_cred *scrp, uint16_t *fidp,
170 uint32_t *cr_act_p, struct smbfattr *fap);
171
172 int smb_smb_close(struct smb_share *ssp, uint16_t fid,
173 struct timespec *mtime, struct smb_cred *scrp);
174
175 int
176 smb_smb_open_prjob(struct smb_share *ssp, char *title,
177 uint16_t setuplen, uint16_t mode,
178 struct smb_cred *scrp, uint16_t *fidp);
179
180 int smb_smb_close_prjob(struct smb_share *ssp, uint16_t fid,
181 struct smb_cred *scrp);
182
183 int smb_rwuio(smb_share_t *ssp, uint16_t fid, uio_rw_t rw,
184 uio_t *uiop, smb_cred_t *scred, int timo);
185
186 /*
187 * time conversions
188 */
189
190 void smb_time_init(void);
191 void smb_time_fini(void);
192
193 void smb_time_local2server(struct timespec *tsp, int tzoff, long *seconds);
194 void smb_time_server2local(ulong_t seconds, int tzoff, struct timespec *tsp);
195 void smb_time_NT2local(uint64_t nsec, struct timespec *tsp);
196 void smb_time_local2NT(struct timespec *tsp, uint64_t *nsec);
197 void smb_time_unix2dos(struct timespec *tsp, int tzoff, uint16_t *ddp,
198 uint16_t *dtp, uint8_t *dhp);
199 void smb_dos2unixtime(uint_t dd, uint_t dt, uint_t dh, int tzoff,
200 struct timespec *tsp);
201
202 #endif /* !_NETSMB_SMB_SUBR_H_ */