xref: /freebsd/sys/netsmb/smb_subr.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2000-2001 Boris Popov
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 #ifndef _NETSMB_SMB_SUBR_H_
29 #define _NETSMB_SMB_SUBR_H_
30 
31 #ifndef _KERNEL
32 #error "This file shouldn't be included from userland programs"
33 #endif
34 
35 #ifdef MALLOC_DECLARE
36 MALLOC_DECLARE(M_SMBTEMP);
37 #endif
38 
39 #define SMBERROR(format, args...) printf("%s: "format, __func__ ,## args)
40 #define SMBPANIC(format, args...) printf("%s: "format, __func__ ,## args)
41 
42 #ifdef SMB_SOCKET_DEBUG
43 #define SMBSDEBUG(format, args...) printf("%s: "format, __func__ ,## args)
44 #else
45 #define SMBSDEBUG(format, args...)
46 #endif
47 
48 #ifdef SMB_IOD_DEBUG
49 #define SMBIODEBUG(format, args...) printf("%s: "format, __func__ ,## args)
50 #else
51 #define SMBIODEBUG(format, args...)
52 #endif
53 
54 #ifdef SMB_SOCKETDATA_DEBUG
55 void m_dumpm(struct mbuf *m);
56 #else
57 #define m_dumpm(m)
58 #endif
59 
60 #define	SMB_SIGMASK(set) 						\
61 	(SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) ||	\
62 	 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) ||	\
63 	 SIGISMEMBER(set, SIGQUIT))
64 
65 #define	smb_suser(cred)	priv_check_cred(cred, PRIV_NETSMB)
66 
67 /*
68  * Compatibility wrappers for simple locks
69  */
70 
71 #include <sys/lock.h>
72 #include <sys/mutex.h>
73 
74 #define	smb_slock			mtx
75 #define	smb_sl_init(mtx, desc)		mtx_init(mtx, desc, NULL, MTX_DEF)
76 #define	smb_sl_destroy(mtx)		mtx_destroy(mtx)
77 #define	smb_sl_lock(mtx)		mtx_lock(mtx)
78 #define	smb_sl_unlock(mtx)		mtx_unlock(mtx)
79 
80 #define SMB_STRFREE(p)	do { if (p) smb_strfree(p); } while(0)
81 
82 typedef u_int16_t	smb_unichar;
83 typedef	smb_unichar	*smb_uniptr;
84 
85 /*
86  * Crediantials of user/process being processing in the connection procedures
87  */
88 struct smb_cred {
89 	struct thread *	scr_td;
90 	struct ucred *	scr_cred;
91 };
92 
93 extern smb_unichar smb_unieol;
94 
95 struct mbchain;
96 struct smb_vc;
97 struct smb_rq;
98 
99 void smb_makescred(struct smb_cred *scred, struct thread *td, struct ucred *cred);
100 int  smb_td_intr(struct thread *);
101 char *smb_strdup(const char *s);
102 void *smb_memdup(const void *umem, int len);
103 char *smb_strdupin(char *s, size_t maxlen);
104 void *smb_memdupin(void *umem, size_t len);
105 void smb_strtouni(u_int16_t *dst, const char *src);
106 void smb_strfree(char *s);
107 void smb_memfree(void *s);
108 void *smb_zmalloc(size_t size, struct malloc_type *type, int flags);
109 
110 int  smb_calcmackey(struct smb_vc *vcp);
111 int  smb_encrypt(const u_char *apwd, u_char *C8, u_char *RN);
112 int  smb_ntencrypt(const u_char *apwd, u_char *C8, u_char *RN);
113 int  smb_maperror(int eclass, int eno);
114 int  smb_put_dmem(struct mbchain *mbp, struct smb_vc *vcp,
115 	const char *src, size_t len, int caseopt);
116 int  smb_put_dstring(struct mbchain *mbp, struct smb_vc *vcp,
117 	const char *src, int caseopt);
118 int  smb_put_string(struct smb_rq *rqp, const char *src);
119 int  smb_put_asunistring(struct smb_rq *rqp, const char *src);
120 int  smb_rq_sign(struct smb_rq *rqp);
121 int  smb_rq_verify(struct smb_rq *rqp);
122 
123 #endif /* !_NETSMB_SMB_SUBR_H_ */
124