xref: /freebsd/sys/netsmb/smb_subr.h (revision 51a9219f5780e61e1437d25220bf8750d9df7f8b)
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_SMB_SUBR_H_
35 #define _NETSMB_SMB_SUBR_H_
36 
37 #ifndef _KERNEL
38 #error "This file shouldn't be included from userland programs"
39 #endif
40 
41 #ifdef MALLOC_DECLARE
42 MALLOC_DECLARE(M_SMBTEMP);
43 #endif
44 
45 #define	FB_CURRENT
46 
47 #define SMBERROR(format, args...) printf("%s: "format, __func__ ,## args)
48 #define SMBPANIC(format, args...) printf("%s: "format, __func__ ,## args)
49 
50 #ifdef SMB_SOCKET_DEBUG
51 #define SMBSDEBUG(format, args...) printf("%s: "format, __func__ ,## args)
52 #else
53 #define SMBSDEBUG(format, args...)
54 #endif
55 
56 #ifdef SMB_IOD_DEBUG
57 #define SMBIODEBUG(format, args...) printf("%s: "format, __func__ ,## args)
58 #else
59 #define SMBIODEBUG(format, args...)
60 #endif
61 
62 #ifdef SMB_SOCKETDATA_DEBUG
63 void m_dumpm(struct mbuf *m);
64 #else
65 #define m_dumpm(m)
66 #endif
67 
68 #define	SMB_SIGMASK(set) 						\
69 	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
70 	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
71 	 SIGISMEMBER(set, SIGQUIT))
72 
73 #define	smb_suser(cred)	suser_cred(cred, 0)
74 
75 /*
76  * Compatibility wrappers for simple locks
77  */
78 
79 #include <sys/lock.h>
80 #include <sys/mutex.h>
81 
82 #define	smb_slock			mtx
83 #define	smb_sl_init(mtx, desc)		mtx_init(mtx, desc, NULL, MTX_DEF)
84 #define	smb_sl_destroy(mtx)		mtx_destroy(mtx)
85 #define	smb_sl_lock(mtx)		mtx_lock(mtx)
86 #define	smb_sl_unlock(mtx)		mtx_unlock(mtx)
87 
88 
89 #define SMB_STRFREE(p)	do { if (p) smb_strfree(p); } while(0)
90 
91 /*
92  * The simple try/catch/finally interface.
93  * With GCC it is possible to allow more than one try/finally block per
94  * function, but we'll avoid it to maintain portability.
95  */
96 #define itry		{						\
97 				__label__ _finlab, _catchlab;		\
98 				int _tval;				\
99 
100 #define icatch(var)							\
101 				goto _finlab;				\
102 				(void)&&_catchlab;			\
103 				_catchlab:				\
104 				var = _tval;
105 
106 #define ifinally		(void)&&_finlab;			\
107 				_finlab:
108 #define iendtry		}
109 
110 #define inocatch							\
111 				goto _finlab;				\
112 				(void)&&_catchlab;			\
113 				_catchlab:				\
114 
115 #define ithrow(t)	do {						\
116 				if ((_tval = (int)(t)) != 0)		\
117 					goto _catchlab;			\
118 			} while (0)
119 
120 #define ierror(t,e)	do {						\
121 				if (t) {				\
122 					_tval = e;			\
123 					goto _catchlab;			\
124 				}					\
125 			} while (0)
126 
127 typedef u_int16_t	smb_unichar;
128 typedef	smb_unichar	*smb_uniptr;
129 
130 /*
131  * Crediantials of user/process being processing in the connection procedures
132  */
133 struct smb_cred {
134 	struct thread *	scr_td;
135 	struct ucred *	scr_cred;
136 };
137 
138 extern smb_unichar smb_unieol;
139 
140 struct mbchain;
141 struct smb_vc;
142 struct smb_rq;
143 
144 void smb_makescred(struct smb_cred *scred, struct thread *td, struct ucred *cred);
145 int  smb_proc_intr(struct proc *);
146 char *smb_strdup(const char *s);
147 void *smb_memdup(const void *umem, int len);
148 char *smb_strdupin(char *s, int maxlen);
149 void *smb_memdupin(void *umem, int len);
150 void smb_strtouni(u_int16_t *dst, const char *src);
151 void smb_strfree(char *s);
152 void smb_memfree(void *s);
153 void *smb_zmalloc(unsigned long size, struct malloc_type *type, int flags);
154 
155 int  smb_encrypt(const u_char *apwd, u_char *C8, u_char *RN);
156 int  smb_ntencrypt(const u_char *apwd, u_char *C8, u_char *RN);
157 int  smb_maperror(int eclass, int eno);
158 int  smb_put_dmem(struct mbchain *mbp, struct smb_vc *vcp,
159 	const char *src, int len, int caseopt);
160 int  smb_put_dstring(struct mbchain *mbp, struct smb_vc *vcp,
161 	const char *src, int caseopt);
162 int  smb_put_string(struct smb_rq *rqp, const char *src);
163 int  smb_put_asunistring(struct smb_rq *rqp, const char *src);
164 
165 #endif /* !_NETSMB_SMB_SUBR_H_ */
166