xref: /illumos-gate/usr/src/lib/smbsrv/libsmb/common/libsmb.h (revision 8d7e41661dc4633488e93b13363137523ce59977)
1da6c28aaSamw /*
2da6c28aaSamw  * CDDL HEADER START
3da6c28aaSamw  *
4da6c28aaSamw  * The contents of this file are subject to the terms of the
5da6c28aaSamw  * Common Development and Distribution License (the "License").
6da6c28aaSamw  * You may not use this file except in compliance with the License.
7da6c28aaSamw  *
8da6c28aaSamw  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9da6c28aaSamw  * or http://www.opensolaris.org/os/licensing.
10da6c28aaSamw  * See the License for the specific language governing permissions
11da6c28aaSamw  * and limitations under the License.
12da6c28aaSamw  *
13da6c28aaSamw  * When distributing Covered Code, include this CDDL HEADER in each
14da6c28aaSamw  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15da6c28aaSamw  * If applicable, add the following below this CDDL HEADER, with the
16da6c28aaSamw  * fields enclosed by brackets "[]" replaced with your own identifying
17da6c28aaSamw  * information: Portions Copyright [yyyy] [name of copyright owner]
18da6c28aaSamw  *
19da6c28aaSamw  * CDDL HEADER END
20da6c28aaSamw  */
21da6c28aaSamw /*
22dc20a302Sas  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23da6c28aaSamw  * Use is subject to license terms.
24da6c28aaSamw  */
25da6c28aaSamw 
26da6c28aaSamw #ifndef	_LIBSMB_H
27da6c28aaSamw #define	_LIBSMB_H
28da6c28aaSamw 
29da6c28aaSamw #ifdef	__cplusplus
30da6c28aaSamw extern "C" {
31da6c28aaSamw #endif
32da6c28aaSamw 
33da6c28aaSamw #include <sys/types.h>
347b59d02dSjb #include <sys/list.h>
35da6c28aaSamw #include <arpa/inet.h>
367b59d02dSjb #include <net/if.h>
37dc20a302Sas #include <netdb.h>
38da6c28aaSamw #include <stdlib.h>
39da6c28aaSamw #include <libscf.h>
40da6c28aaSamw #include <libshare.h>
41dc20a302Sas #include <sqlite/sqlite.h>
42da6c28aaSamw 
43dc20a302Sas #include <smbsrv/string.h>
44da6c28aaSamw #include <smbsrv/smb_idmap.h>
457b59d02dSjb #include <smbsrv/netbios.h>
463db3f65cSamw #include <smbsrv/smb_share.h>
47da6c28aaSamw #include <smbsrv/ntstatus.h>
48da6c28aaSamw #include <smbsrv/smb_door_svc.h>
49da6c28aaSamw #include <smbsrv/alloc.h>
50da6c28aaSamw #include <smbsrv/codepage.h>
51da6c28aaSamw #include <smbsrv/ctype.h>
52da6c28aaSamw #include <smbsrv/hash_table.h>
53da6c28aaSamw #include <smbsrv/msgbuf.h>
54da6c28aaSamw #include <smbsrv/oem.h>
55da6c28aaSamw #include <smbsrv/smb_i18n.h>
56da6c28aaSamw #include <smbsrv/wintypes.h>
57da6c28aaSamw #include <smbsrv/smb_xdr.h>
58da6c28aaSamw #include <smbsrv/smbinfo.h>
59da6c28aaSamw 
60faa1795aSjb #define	SMB_VARRUN_DIR "/var/run/smb"
61faa1795aSjb #define	SMB_CCACHE_FILE "ccache"
62faa1795aSjb #define	SMB_CCACHE_PATH SMB_VARRUN_DIR "/" SMB_CCACHE_FILE
63faa1795aSjb 
64*8d7e4166Sjose borrego 
65*8d7e4166Sjose borrego 
66da6c28aaSamw /* Max value length of all SMB properties */
67da6c28aaSamw #define	MAX_VALUE_BUFLEN	512
68da6c28aaSamw 
69da6c28aaSamw #define	SMBD_FMRI_PREFIX		"network/smb/server"
70da6c28aaSamw #define	SMBD_DEFAULT_INSTANCE_FMRI	"svc:/network/smb/server:default"
71da6c28aaSamw #define	SMBD_PG_NAME			"smbd"
72da6c28aaSamw #define	SMBD_PROTECTED_PG_NAME		"read"
73da6c28aaSamw 
74da6c28aaSamw #define	SMBD_SMF_OK		0
75da6c28aaSamw #define	SMBD_SMF_NO_MEMORY	1	/* no memory for data structures */
76da6c28aaSamw #define	SMBD_SMF_SYSTEM_ERR	2	/* system error, use errno */
77da6c28aaSamw #define	SMBD_SMF_NO_PERMISSION	3	/* no permission for operation */
78dc20a302Sas #define	SMBD_SMF_INVALID_ARG	4
79da6c28aaSamw 
80da6c28aaSamw #define	SCH_STATE_UNINIT	0
81da6c28aaSamw #define	SCH_STATE_INITIALIZING	1
82da6c28aaSamw #define	SCH_STATE_INIT		2
83da6c28aaSamw 
84da6c28aaSamw typedef struct smb_scfhandle {
85da6c28aaSamw 	scf_handle_t		*scf_handle;
86da6c28aaSamw 	int			scf_state;
87da6c28aaSamw 	scf_service_t		*scf_service;
88da6c28aaSamw 	scf_scope_t		*scf_scope;
89da6c28aaSamw 	scf_transaction_t	*scf_trans;
90da6c28aaSamw 	scf_transaction_entry_t	*scf_entry;
91da6c28aaSamw 	scf_propertygroup_t	*scf_pg;
92da6c28aaSamw 	scf_instance_t		*scf_instance;
93da6c28aaSamw 	scf_iter_t		*scf_inst_iter;
94da6c28aaSamw 	scf_iter_t		*scf_pg_iter;
95da6c28aaSamw } smb_scfhandle_t;
96da6c28aaSamw 
97da6c28aaSamw /*
98da6c28aaSamw  * CIFS Configuration Management
99da6c28aaSamw  */
100da6c28aaSamw typedef enum {
101dc20a302Sas 	SMB_CI_OPLOCK_ENABLE = 0,
102da6c28aaSamw 
103da6c28aaSamw 	SMB_CI_AUTOHOME_MAP,
104da6c28aaSamw 
105da6c28aaSamw 	SMB_CI_DOMAIN_SID,
106da6c28aaSamw 	SMB_CI_DOMAIN_MEMB,
107da6c28aaSamw 	SMB_CI_DOMAIN_NAME,
108*8d7e4166Sjose borrego 	SMB_CI_DOMAIN_FQDN,
109*8d7e4166Sjose borrego 	SMB_CI_DOMAIN_FOREST,
110*8d7e4166Sjose borrego 	SMB_CI_DOMAIN_GUID,
111da6c28aaSamw 	SMB_CI_DOMAIN_SRV,
112da6c28aaSamw 
113da6c28aaSamw 	SMB_CI_WINS_SRV1,
114da6c28aaSamw 	SMB_CI_WINS_SRV2,
115da6c28aaSamw 	SMB_CI_WINS_EXCL,
116da6c28aaSamw 
117da6c28aaSamw 	SMB_CI_SRVSVC_SHRSET_ENABLE,
118da6c28aaSamw 
119da6c28aaSamw 	SMB_CI_MAX_WORKERS,
120da6c28aaSamw 	SMB_CI_MAX_CONNECTIONS,
121da6c28aaSamw 	SMB_CI_KEEPALIVE,
122da6c28aaSamw 	SMB_CI_RESTRICT_ANON,
123da6c28aaSamw 
124da6c28aaSamw 	SMB_CI_SIGNING_ENABLE,
125da6c28aaSamw 	SMB_CI_SIGNING_REQD,
126da6c28aaSamw 
127da6c28aaSamw 	SMB_CI_SYNC_ENABLE,
128da6c28aaSamw 
129da6c28aaSamw 	SMB_CI_SECURITY,
130da6c28aaSamw 	SMB_CI_NBSCOPE,
131da6c28aaSamw 	SMB_CI_SYS_CMNT,
132da6c28aaSamw 	SMB_CI_LM_LEVEL,
133da6c28aaSamw 
134da6c28aaSamw 	SMB_CI_ADS_SITE,
135da6c28aaSamw 
136da6c28aaSamw 	SMB_CI_DYNDNS_ENABLE,
137da6c28aaSamw 
138da6c28aaSamw 	SMB_CI_MACHINE_PASSWD,
139faa1795aSjb 	SMB_CI_KPASSWD_SRV,
140faa1795aSjb 	SMB_CI_KPASSWD_DOMAIN,
141faa1795aSjb 	SMB_CI_KPASSWD_SEQNUM,
142faa1795aSjb 	SMB_CI_NETLOGON_SEQNUM,
143da6c28aaSamw 	SMB_CI_MAX
144da6c28aaSamw } smb_cfg_id_t;
145da6c28aaSamw 
146da6c28aaSamw /* SMF helper functions */
147da6c28aaSamw extern smb_scfhandle_t *smb_smf_scf_init(char *);
148da6c28aaSamw extern void smb_smf_scf_fini(smb_scfhandle_t *);
149da6c28aaSamw extern int smb_smf_start_transaction(smb_scfhandle_t *);
150da6c28aaSamw extern int smb_smf_end_transaction(smb_scfhandle_t *);
151da6c28aaSamw extern int smb_smf_set_string_property(smb_scfhandle_t *, char *, char *);
152da6c28aaSamw extern int smb_smf_get_string_property(smb_scfhandle_t *, char *,
153da6c28aaSamw     char *, size_t);
154da6c28aaSamw extern int smb_smf_set_integer_property(smb_scfhandle_t *, char *, int64_t);
155da6c28aaSamw extern int smb_smf_get_integer_property(smb_scfhandle_t *, char *, int64_t *);
156da6c28aaSamw extern int smb_smf_set_boolean_property(smb_scfhandle_t *, char *, uint8_t);
157da6c28aaSamw extern int smb_smf_get_boolean_property(smb_scfhandle_t *, char *, uint8_t *);
158da6c28aaSamw extern int smb_smf_set_opaque_property(smb_scfhandle_t *, char *,
159da6c28aaSamw     void *, size_t);
160da6c28aaSamw extern int smb_smf_get_opaque_property(smb_scfhandle_t *, char *,
161da6c28aaSamw     void *, size_t);
162da6c28aaSamw extern int smb_smf_create_service_pgroup(smb_scfhandle_t *, char *);
163c8ec8eeaSjose borrego extern int smb_smf_restart_service(void);
164*8d7e4166Sjose borrego extern int smb_smf_maintenance_mode(void);
165da6c28aaSamw 
166da6c28aaSamw /* Configuration management functions  */
167dc20a302Sas extern int smb_config_get(smb_cfg_id_t, char *, int);
168dc20a302Sas extern char *smb_config_getname(smb_cfg_id_t);
169dc20a302Sas extern int smb_config_getstr(smb_cfg_id_t, char *, int);
170dc20a302Sas extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
171dc20a302Sas extern boolean_t smb_config_getbool(smb_cfg_id_t);
172da6c28aaSamw 
173da6c28aaSamw extern int smb_config_set(smb_cfg_id_t, char *);
174dc20a302Sas extern int smb_config_setstr(smb_cfg_id_t, char *);
175dc20a302Sas extern int smb_config_setnum(smb_cfg_id_t, int64_t);
176dc20a302Sas extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
177dc20a302Sas 
178da6c28aaSamw extern uint8_t smb_config_get_fg_flag(void);
179da6c28aaSamw extern char *smb_config_get_localsid(void);
180faa1795aSjb extern int smb_config_secmode_fromstr(char *);
181faa1795aSjb extern char *smb_config_secmode_tostr(int);
182da6c28aaSamw extern int smb_config_get_secmode(void);
183faa1795aSjb extern int smb_config_set_secmode(int);
184faa1795aSjb extern int smb_config_set_idmap_domain(char *);
185da6c28aaSamw extern int smb_config_refresh_idmap(void);
186faa1795aSjb 
187*8d7e4166Sjose borrego 
1883ad684d6Sjb extern void smb_load_kconfig(smb_kmod_cfg_t *kcfg);
18994fff790SAlan Wright extern uint32_t smb_crc_gen(uint8_t *, size_t);
1903ad684d6Sjb 
191faa1795aSjb extern boolean_t smb_match_netlogon_seqnum(void);
192faa1795aSjb extern int smb_setdomainprops(char *, char *, char *);
193faa1795aSjb extern void smb_update_netlogon_seqnum(void);
194da6c28aaSamw 
195b89a8333Snatalie li - Sun Microsystems - Irvine United States /* maximum password length on Windows 2000 and above */
196b89a8333Snatalie li - Sun Microsystems - Irvine United States #define	SMB_PASSWD_MAXLEN	127
197b89a8333Snatalie li - Sun Microsystems - Irvine United States #define	SMB_USERNAME_MAXLEN	40
198b89a8333Snatalie li - Sun Microsystems - Irvine United States 
199da6c28aaSamw typedef struct smb_joininfo {
200dc20a302Sas 	char domain_name[MAXHOSTNAMELEN];
201b89a8333Snatalie li - Sun Microsystems - Irvine United States 	char domain_username[SMB_USERNAME_MAXLEN + 1];
202b89a8333Snatalie li - Sun Microsystems - Irvine United States 	char domain_passwd[SMB_PASSWD_MAXLEN + 1];
203da6c28aaSamw 	uint32_t mode;
204da6c28aaSamw } smb_joininfo_t;
205da6c28aaSamw 
206da6c28aaSamw /* APIs to communicate with SMB daemon via door calls */
207da6c28aaSamw extern uint32_t smb_join(smb_joininfo_t *info);
208faa1795aSjb extern bool_t xdr_smb_dr_joininfo_t(XDR *, smb_joininfo_t *);
209da6c28aaSamw 
210da6c28aaSamw 
211da6c28aaSamw #define	SMB_DOMAIN_NOMACHINE_SID	-1
212da6c28aaSamw #define	SMB_DOMAIN_NODOMAIN_SID		-2
213da6c28aaSamw 
214c8ec8eeaSjose borrego extern int nt_domain_init(char *, uint32_t);
215da6c28aaSamw 
216*8d7e4166Sjose borrego extern void smb_config_getdomaininfo(char *domain, char *fqdn, char *forest,
217*8d7e4166Sjose borrego     char *guid);
218*8d7e4166Sjose borrego extern void smb_config_setdomaininfo(char *domain, char *fqdn, char *forest,
219*8d7e4166Sjose borrego     char *guid);
220*8d7e4166Sjose borrego extern uint32_t smb_get_dcinfo(char *, uint32_t, uint32_t *);
221da6c28aaSamw 
222da6c28aaSamw /*
223da6c28aaSamw  * buffer context structure. This is used to keep track of the buffer
224da6c28aaSamw  * context.
225da6c28aaSamw  *
226da6c28aaSamw  * basep:  points to the beginning of the buffer
227da6c28aaSamw  * curp:   points to the current offset
228da6c28aaSamw  * endp:   points to the limit of the buffer
229da6c28aaSamw  */
230da6c28aaSamw typedef struct {
231da6c28aaSamw 	unsigned char *basep;
232da6c28aaSamw 	unsigned char *curp;
233da6c28aaSamw 	unsigned char *endp;
234da6c28aaSamw } smb_ctxbuf_t;
235da6c28aaSamw 
236da6c28aaSamw extern int smb_ctxbuf_init(smb_ctxbuf_t *ctx, unsigned char *buf,
237da6c28aaSamw     size_t buflen);
238da6c28aaSamw extern int smb_ctxbuf_len(smb_ctxbuf_t *ctx);
239da6c28aaSamw extern int smb_ctxbuf_printf(smb_ctxbuf_t *ctx, const char *fmt, ...);
240da6c28aaSamw 
241da6c28aaSamw /* Functions to handle SMB daemon communications with idmap service */
242da6c28aaSamw extern int smb_idmap_start(void);
243da6c28aaSamw extern void smb_idmap_stop(void);
244da6c28aaSamw extern int smb_idmap_restart(void);
245da6c28aaSamw 
246da6c28aaSamw /* Miscellaneous functions */
247da6c28aaSamw extern void hexdump(unsigned char *, int);
248da6c28aaSamw extern size_t bintohex(const char *, size_t, char *, size_t);
249da6c28aaSamw extern size_t hextobin(const char *, size_t, char *, size_t);
250*8d7e4166Sjose borrego extern char *strstrip(char *, const char *);
251*8d7e4166Sjose borrego extern char *strtrim(char *, const char *);
252*8d7e4166Sjose borrego extern char *trim_whitespace(char *);
253da6c28aaSamw extern void randomize(char *, unsigned);
254da6c28aaSamw extern void rand_hash(unsigned char *, size_t, unsigned char *, size_t);
255da6c28aaSamw 
256da6c28aaSamw extern int smb_getdomainname(char *, size_t);
257dc20a302Sas extern int smb_getfqdomainname(char *, size_t);
258da6c28aaSamw extern int smb_gethostname(char *, size_t, int);
259dc20a302Sas extern int smb_getfqhostname(char *, size_t);
260da6c28aaSamw extern int smb_getnetbiosname(char *, size_t);
261*8d7e4166Sjose borrego extern struct hostent *smb_gethostbyname(const char *, int *);
262*8d7e4166Sjose borrego extern struct hostent *smb_gethostbyaddr(const char *, int, int, int *);
263b89a8333Snatalie li - Sun Microsystems - Irvine United States 
264b89a8333Snatalie li - Sun Microsystems - Irvine United States #define	SMB_SAMACCT_MAXLEN	(NETBIOS_NAME_SZ + 1)
265b89a8333Snatalie li - Sun Microsystems - Irvine United States extern int smb_getsamaccount(char *, size_t);
266b89a8333Snatalie li - Sun Microsystems - Irvine United States 
2676537f381Sas extern smb_sid_t *smb_getdomainsid(void);
268da6c28aaSamw 
2697b59d02dSjb extern int smb_get_nameservers(struct in_addr *, int);
2707b59d02dSjb extern void smb_tonetbiosname(char *, char *, char);
2717b59d02dSjb 
272b89a8333Snatalie li - Sun Microsystems - Irvine United States extern int smb_chk_hostaccess(ipaddr_t, char *);
2737b59d02dSjb 
274da6c28aaSamw void smb_trace(const char *s);
275da6c28aaSamw void smb_tracef(const char *fmt, ...);
276da6c28aaSamw 
277da6c28aaSamw /*
278da6c28aaSamw  * Authentication
279da6c28aaSamw  */
280da6c28aaSamw 
281da6c28aaSamw #define	SMBAUTH_LM_MAGIC_STR	"KGS!@#$%"
282da6c28aaSamw 
283da6c28aaSamw #define	SMBAUTH_HASH_SZ		16	/* also LM/NTLM/NTLMv2 Hash size */
284da6c28aaSamw #define	SMBAUTH_LM_RESP_SZ	24	/* also NTLM Response size */
285da6c28aaSamw #define	SMBAUTH_LM_PWD_SZ	14	/* LM password size */
286da6c28aaSamw #define	SMBAUTH_V2_CLNT_CHALLENGE_SZ 8	/* both LMv2 and NTLMv2 */
287da6c28aaSamw #define	SMBAUTH_SESSION_KEY_SZ	SMBAUTH_HASH_SZ
288da6c28aaSamw #define	SMBAUTH_HEXHASH_SZ	(SMBAUTH_HASH_SZ * 2)
289da6c28aaSamw 
290da6c28aaSamw #define	SMBAUTH_FAILURE		1
291da6c28aaSamw #define	SMBAUTH_SUCCESS		0
292da6c28aaSamw #define	MD_DIGEST_LEN		16
293da6c28aaSamw 
294da6c28aaSamw /*
295da6c28aaSamw  * Name Types
296da6c28aaSamw  *
297da6c28aaSamw  * The list of names near the end of the data blob (i.e. the ndb_names
298da6c28aaSamw  * field of the smb_auth_data_blob_t data structure) can be classify into
299da6c28aaSamw  * the following types:
300da6c28aaSamw  *
301da6c28aaSamw  * 0x0000 Indicates the end of the list.
302da6c28aaSamw  * 0x0001 The name is a NetBIOS machine name (e.g. server name)
303da6c28aaSamw  * 0x0002 The name is an NT Domain NetBIOS name.
304da6c28aaSamw  * 0x0003 The name is the server's DNS hostname.
305da6c28aaSamw  * 0x0004 The name is a W2K Domain name (a DNS name).
306da6c28aaSamw  */
307da6c28aaSamw #define	SMBAUTH_NAME_TYPE_LIST_END		0x0000
308da6c28aaSamw #define	SMBAUTH_NAME_TYPE_SERVER_NETBIOS 	0x0001
309da6c28aaSamw #define	SMBAUTH_NAME_TYPE_DOMAIN_NETBIOS 	0x0002
310da6c28aaSamw #define	SMBAUTH_NAME_TYPE_SERVER_DNS		0x0003
311da6c28aaSamw #define	SMBAUTH_NAME_TYPE_DOMAIN_DNS 		0x0004
312da6c28aaSamw 
313da6c28aaSamw /*
314da6c28aaSamw  * smb_auth_name_entry_t
315da6c28aaSamw  *
316da6c28aaSamw  * Each name entry in the data blob consists of the following 3 fields:
317da6c28aaSamw  *
318da6c28aaSamw  * nne_type - name type
319da6c28aaSamw  * nne_len  - the length of the name
320da6c28aaSamw  * nne_name - the name, in uppercase UCS-2LE Unicode format
321da6c28aaSamw  */
322da6c28aaSamw typedef struct smb_auth_name_entry {
323da6c28aaSamw 	unsigned short nne_type;
324da6c28aaSamw 	unsigned short nne_len;
325da6c28aaSamw 	mts_wchar_t nne_name[SMB_PI_MAX_DOMAIN * 2];
326da6c28aaSamw } smb_auth_name_entry_t;
327da6c28aaSamw 
328da6c28aaSamw /*
329da6c28aaSamw  * smb_auth_data_blob
330da6c28aaSamw  *
331da6c28aaSamw  * The format of this NTLMv2 data blob structure is as follow:
332da6c28aaSamw  *
333da6c28aaSamw  *	- Blob Signature 0x01010000 (4 bytes)
334da6c28aaSamw  * - Reserved (0x00000000) (4 bytes)
335da6c28aaSamw  * - Timestamp Little-endian, 64-bit signed value representing
336da6c28aaSamw  *   the number of tenths of a microsecond since January 1, 1601.
337da6c28aaSamw  *   (8 bytes)
338da6c28aaSamw  * - Client Challenge (8 bytes)
339da6c28aaSamw  * - Unknown1 (4 bytes)
340da6c28aaSamw  * - List of Target Information (variable length)
341da6c28aaSamw  * - Unknown2 (4 bytes)
342da6c28aaSamw  */
343da6c28aaSamw typedef struct smb_auth_data_blob {
344da6c28aaSamw 	unsigned char ndb_signature[4];
345da6c28aaSamw 	unsigned char ndb_reserved[4];
346da6c28aaSamw 	uint64_t ndb_timestamp;
347da6c28aaSamw 	unsigned char ndb_clnt_challenge[SMBAUTH_V2_CLNT_CHALLENGE_SZ];
348da6c28aaSamw 	unsigned char ndb_unknown[4];
349da6c28aaSamw 	smb_auth_name_entry_t ndb_names[2];
350da6c28aaSamw 	unsigned char ndb_unknown2[4];
351da6c28aaSamw } smb_auth_data_blob_t;
352da6c28aaSamw 
353da6c28aaSamw #define	SMBAUTH_BLOB_MAXLEN (sizeof (smb_auth_data_blob_t))
354da6c28aaSamw #define	SMBAUTH_CI_MAXLEN   SMBAUTH_LM_RESP_SZ
355da6c28aaSamw #define	SMBAUTH_CS_MAXLEN   (SMBAUTH_BLOB_MAXLEN + SMBAUTH_HASH_SZ)
356da6c28aaSamw 
357da6c28aaSamw /*
358da6c28aaSamw  * smb_auth_info_t
359da6c28aaSamw  *
360da6c28aaSamw  * The structure contains all the authentication information
361da6c28aaSamw  * needed for the preparaton of the SMBSessionSetupAndx request
362da6c28aaSamw  * and the user session key.
363da6c28aaSamw  *
364da6c28aaSamw  * hash      - NTLM hash
365da6c28aaSamw  * hash_v2   - NTLMv2 hash
366da6c28aaSamw  * ci_len    - the length of the case-insensitive password
367da6c28aaSamw  * ci        - case-insensitive password
368da6c28aaSamw  *             (If NTLMv2 authentication mechanism is used, it
369da6c28aaSamw  *              represents the LMv2 response. Otherwise, it
370da6c28aaSamw  *              is empty.)
371da6c28aaSamw  * cs_len    - the length of the case-sensitive password
372da6c28aaSamw  * cs        - case-sensitive password
373da6c28aaSamw  *             (If NTLMv2 authentication mechanism is used, it
374da6c28aaSamw  *              represents the NTLMv2 response. Otherwise, it
375da6c28aaSamw  *              represents the NTLM response.)
376da6c28aaSamw  * data_blob - NTLMv2 data blob
377da6c28aaSamw  */
378da6c28aaSamw typedef struct smb_auth_info {
379da6c28aaSamw 	unsigned char hash[SMBAUTH_HASH_SZ];
380da6c28aaSamw 	unsigned char hash_v2[SMBAUTH_HASH_SZ];
381da6c28aaSamw 	unsigned short ci_len;
382da6c28aaSamw 	unsigned char ci[SMBAUTH_CI_MAXLEN];
383da6c28aaSamw 	unsigned short cs_len;
384da6c28aaSamw 	unsigned char cs[SMBAUTH_CS_MAXLEN];
385da6c28aaSamw 	int lmcompatibility_lvl;
386da6c28aaSamw 	smb_auth_data_blob_t data_blob;
387da6c28aaSamw } smb_auth_info_t;
388da6c28aaSamw 
389da6c28aaSamw /*
390da6c28aaSamw  * SMB password management
391da6c28aaSamw  */
392da6c28aaSamw 
393da6c28aaSamw #define	SMB_PWF_LM	0x01	/* LM hash is present */
394da6c28aaSamw #define	SMB_PWF_NT	0x02	/* NT hash is present */
395da6c28aaSamw #define	SMB_PWF_DISABLE	0x04	/* Account is disabled */
396da6c28aaSamw 
397da6c28aaSamw typedef struct smb_passwd {
398da6c28aaSamw 	uid_t pw_uid;
399da6c28aaSamw 	uint32_t pw_flags;
400da6c28aaSamw 	unsigned char pw_lmhash[SMBAUTH_HASH_SZ];
401da6c28aaSamw 	unsigned char pw_nthash[SMBAUTH_HASH_SZ];
402da6c28aaSamw } smb_passwd_t;
403da6c28aaSamw 
404da6c28aaSamw /*
405da6c28aaSamw  * Control flags passed to smb_pwd_setcntl
406da6c28aaSamw  */
407da6c28aaSamw #define	SMB_PWC_DISABLE	0x01
408da6c28aaSamw #define	SMB_PWC_ENABLE	0x02
409da6c28aaSamw #define	SMB_PWC_NOLM	0x04
410da6c28aaSamw 
411da6c28aaSamw #define	SMB_PWE_SUCCESS		0
412da6c28aaSamw #define	SMB_PWE_USER_UNKNOWN	1
413da6c28aaSamw #define	SMB_PWE_USER_DISABLE	2
414da6c28aaSamw #define	SMB_PWE_CLOSE_FAILED	3
415da6c28aaSamw #define	SMB_PWE_OPEN_FAILED	4
416da6c28aaSamw #define	SMB_PWE_WRITE_FAILED	6
417da6c28aaSamw #define	SMB_PWE_UPDATE_FAILED	7
418da6c28aaSamw #define	SMB_PWE_STAT_FAILED	8
419da6c28aaSamw #define	SMB_PWE_BUSY		9
420da6c28aaSamw #define	SMB_PWE_DENIED		10
421da6c28aaSamw #define	SMB_PWE_SYSTEM_ERROR	11
4223db3f65cSamw #define	SMB_PWE_INVALID_PARAM	12
4233db3f65cSamw #define	SMB_PWE_NO_MEMORY	13
4243db3f65cSamw #define	SMB_PWE_MAX		14
4253db3f65cSamw 
4263db3f65cSamw typedef struct smb_pwditer {
4273db3f65cSamw 	void *spi_next;
4283db3f65cSamw } smb_pwditer_t;
4293db3f65cSamw 
4303db3f65cSamw typedef struct smb_luser {
4313db3f65cSamw 	char *su_name;
4323db3f65cSamw 	char *su_fullname;
4333db3f65cSamw 	char *su_desc;
4343db3f65cSamw 	uint32_t su_rid;
4353db3f65cSamw 	uint32_t su_ctrl;
4363db3f65cSamw } smb_luser_t;
4373db3f65cSamw 
4383db3f65cSamw extern void smb_pwd_init(boolean_t);
4397b59d02dSjb extern void smb_pwd_fini(void);
440da6c28aaSamw extern smb_passwd_t *smb_pwd_getpasswd(const char *, smb_passwd_t *);
441da6c28aaSamw extern int smb_pwd_setpasswd(const char *, const char *);
442da6c28aaSamw extern int smb_pwd_setcntl(const char *, int);
4433db3f65cSamw extern int smb_pwd_num(void);
4443db3f65cSamw 
4453db3f65cSamw extern int smb_pwd_iteropen(smb_pwditer_t *);
4463db3f65cSamw extern smb_luser_t *smb_pwd_iterate(smb_pwditer_t *);
4473db3f65cSamw extern void smb_pwd_iterclose(smb_pwditer_t *);
448da6c28aaSamw 
449da6c28aaSamw extern int smb_auth_qnd_unicode(mts_wchar_t *dst, char *src, int length);
450da6c28aaSamw extern int smb_auth_hmac_md5(unsigned char *data, int data_len,
451da6c28aaSamw     unsigned char *key, int key_len, unsigned char *digest);
452da6c28aaSamw 
453da6c28aaSamw /*
454da6c28aaSamw  * A variation on HMAC-MD5 known as HMACT64 is used by Windows systems.
455da6c28aaSamw  * The HMACT64() function is the same as the HMAC-MD5() except that
456da6c28aaSamw  * it truncates the input key to 64 bytes rather than hashing it down
457da6c28aaSamw  * to 16 bytes using the MD5() function.
458da6c28aaSamw  */
459da6c28aaSamw #define	SMBAUTH_HMACT64(D, Ds, K, Ks, digest) \
460da6c28aaSamw 	smb_auth_hmac_md5(D, Ds, K, (Ks > 64) ? 64 : Ks, digest)
461da6c28aaSamw 
462da6c28aaSamw extern int smb_auth_DES(unsigned char *, int, unsigned char *, int,
463da6c28aaSamw     unsigned char *, int);
464da6c28aaSamw 
465da6c28aaSamw extern int smb_auth_md4(unsigned char *, unsigned char *, int);
466da6c28aaSamw extern int smb_auth_lm_hash(char *, unsigned char *);
467da6c28aaSamw extern int smb_auth_ntlm_hash(char *, unsigned char *);
468da6c28aaSamw 
469da6c28aaSamw extern int smb_auth_set_info(char *, char *,
470da6c28aaSamw     unsigned char *, char *, unsigned char *,
471da6c28aaSamw     int, int, smb_auth_info_t *);
472da6c28aaSamw 
4738c10a865Sas extern int smb_auth_ntlmv2_hash(unsigned char *,
4748c10a865Sas 	char *, char *, unsigned char *);
4758c10a865Sas 
476da6c28aaSamw extern int smb_auth_gen_session_key(smb_auth_info_t *, unsigned char *);
477da6c28aaSamw 
478da6c28aaSamw boolean_t smb_auth_validate_lm(unsigned char *, uint32_t, smb_passwd_t *,
479dc20a302Sas     unsigned char *, int, char *, char *);
480da6c28aaSamw boolean_t smb_auth_validate_nt(unsigned char *, uint32_t, smb_passwd_t *,
481c8ec8eeaSjose borrego     unsigned char *, int, char *, char *, uchar_t *);
482da6c28aaSamw 
483da6c28aaSamw /*
484da6c28aaSamw  * SMB MAC Signing
485da6c28aaSamw  */
486da6c28aaSamw 
487da6c28aaSamw #define	SMB_MAC_KEY_SZ	(SMBAUTH_SESSION_KEY_SZ + SMBAUTH_CS_MAXLEN)
488da6c28aaSamw #define	SMB_SIG_OFFS	14	/* signature field offset within header */
489da6c28aaSamw #define	SMB_SIG_SIZE	8	/* SMB signature size */
490da6c28aaSamw 
491da6c28aaSamw /*
492da6c28aaSamw  * Signing flags:
493da6c28aaSamw  *
494da6c28aaSamw  * SMB_SCF_ENABLE                 Signing is enabled.
495da6c28aaSamw  *
496da6c28aaSamw  * SMB_SCF_REQUIRED               Signing is enabled and required.
497da6c28aaSamw  *                                This flag shouldn't be set if
498da6c28aaSamw  *                                SMB_SCF_ENABLE isn't set.
499da6c28aaSamw  *
500da6c28aaSamw  * SMB_SCF_STARTED                Signing will start after receiving
501da6c28aaSamw  *                                the first non-anonymous SessionSetup
502da6c28aaSamw  *                                request.
503da6c28aaSamw  *
504da6c28aaSamw  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
505da6c28aaSamw  *                                been set for this logon. (prior to
506da6c28aaSamw  *                                sending the SMBSessionSetup request)
507da6c28aaSamw  *
508da6c28aaSamw  */
509da6c28aaSamw #define	SMB_SCF_ENABLE		0x01
510da6c28aaSamw #define	SMB_SCF_REQUIRED	0x02
511da6c28aaSamw #define	SMB_SCF_STARTED		0x04
512da6c28aaSamw #define	SMB_SCF_KEY_ISSET_THIS_LOGON	0x08
513da6c28aaSamw 
514da6c28aaSamw /*
515da6c28aaSamw  * smb_sign_ctx
516da6c28aaSamw  *
517da6c28aaSamw  * SMB signing context.
518da6c28aaSamw  *
519da6c28aaSamw  *	ssc_seqnum				sequence number
520da6c28aaSamw  *	ssc_keylen				mac key length
521da6c28aaSamw  *	ssc_mid					multiplex id - reserved
522da6c28aaSamw  *	ssc_flags				flags
523da6c28aaSamw  *	ssc_mackey				mac key
524da6c28aaSamw  *	ssc_sign				mac signature
525da6c28aaSamw  *
526da6c28aaSamw  */
527da6c28aaSamw typedef struct smb_sign_ctx {
528da6c28aaSamw 	unsigned int ssc_seqnum;
529da6c28aaSamw 	unsigned short ssc_keylen;
530da6c28aaSamw 	unsigned short ssc_mid;
531da6c28aaSamw 	unsigned int ssc_flags;
532da6c28aaSamw 	unsigned char ssc_mackey[SMB_MAC_KEY_SZ];
533da6c28aaSamw 	unsigned char ssc_sign[SMB_SIG_SIZE];
534da6c28aaSamw } smb_sign_ctx_t;
535da6c28aaSamw 
536da6c28aaSamw extern int smb_mac_init(smb_sign_ctx_t *sign_ctx, smb_auth_info_t *auth);
537da6c28aaSamw extern int smb_mac_calc(smb_sign_ctx_t *sign_ctx,
538da6c28aaSamw     const unsigned char *buf, size_t buf_len, unsigned char *mac_sign);
539da6c28aaSamw extern int smb_mac_chk(smb_sign_ctx_t *sign_ctx,
540da6c28aaSamw     const unsigned char *buf, size_t buf_len);
541da6c28aaSamw extern int smb_mac_sign(smb_sign_ctx_t *sign_ctx,
542da6c28aaSamw     unsigned char *buf, size_t buf_len);
543da6c28aaSamw extern void smb_mac_inc_seqnum(smb_sign_ctx_t *sign_ctx);
544da6c28aaSamw extern void smb_mac_dec_seqnum(smb_sign_ctx_t *sign_ctx);
545da6c28aaSamw 
546da6c28aaSamw /*
547da6c28aaSamw  * Each domain is categorized using the enum values below.
548da6c28aaSamw  * The local domain refers to the local machine and is named
549da6c28aaSamw  * after the local hostname. The primary domain is the domain
550da6c28aaSamw  * that the system joined. All other domains are either
551da6c28aaSamw  * trusted or untrusted, as defined by the primary domain PDC.
552da6c28aaSamw  *
553da6c28aaSamw  * This enum must be kept in step with the table of strings
554da6c28aaSamw  * in ntdomain.c.
555da6c28aaSamw  */
556da6c28aaSamw typedef enum nt_domain_type {
557da6c28aaSamw 	NT_DOMAIN_NULL,
558da6c28aaSamw 	NT_DOMAIN_BUILTIN,
559da6c28aaSamw 	NT_DOMAIN_LOCAL,
560da6c28aaSamw 	NT_DOMAIN_PRIMARY,
561da6c28aaSamw 	NT_DOMAIN_ACCOUNT,
562da6c28aaSamw 	NT_DOMAIN_TRUSTED,
563da6c28aaSamw 	NT_DOMAIN_UNTRUSTED,
564da6c28aaSamw 	NT_DOMAIN_NUM_TYPES
565da6c28aaSamw } nt_domain_type_t;
566da6c28aaSamw 
567da6c28aaSamw 
568da6c28aaSamw /*
569da6c28aaSamw  * This is the information that is held about each domain. The database
570da6c28aaSamw  * is a linked list that is threaded through the domain structures. As
571da6c28aaSamw  * the number of domains in the database should be small (32 max), this
572da6c28aaSamw  * should be sufficient.
573da6c28aaSamw  */
574da6c28aaSamw typedef struct nt_domain {
575da6c28aaSamw 	struct nt_domain *next;
576da6c28aaSamw 	nt_domain_type_t type;
577da6c28aaSamw 	char *name;
5786537f381Sas 	smb_sid_t *sid;
579da6c28aaSamw } nt_domain_t;
580da6c28aaSamw 
5816537f381Sas nt_domain_t *nt_domain_new(nt_domain_type_t type, char *name, smb_sid_t *sid);
582da6c28aaSamw void nt_domain_delete(nt_domain_t *domain);
583da6c28aaSamw nt_domain_t *nt_domain_add(nt_domain_t *new_domain);
584da6c28aaSamw void nt_domain_remove(nt_domain_t *domain);
585da6c28aaSamw void nt_domain_flush(nt_domain_type_t domain_type);
586da6c28aaSamw void nt_domain_sync(void);
587da6c28aaSamw char *nt_domain_xlat_type(nt_domain_type_t domain_type);
588da6c28aaSamw nt_domain_type_t nt_domain_xlat_type_name(char *type_name);
589da6c28aaSamw nt_domain_t *nt_domain_lookup_name(char *domain_name);
5906537f381Sas nt_domain_t *nt_domain_lookup_sid(smb_sid_t *domain_sid);
591da6c28aaSamw nt_domain_t *nt_domain_lookupbytype(nt_domain_type_t type);
5926537f381Sas smb_sid_t *nt_domain_local_sid(void);
593da6c28aaSamw 
594dc20a302Sas typedef enum {
595dc20a302Sas 	SMB_LGRP_BUILTIN = 1,
596dc20a302Sas 	SMB_LGRP_LOCAL
597dc20a302Sas } smb_gdomain_t;
598dc20a302Sas 
599dc20a302Sas typedef struct smb_gsid {
6006537f381Sas 	smb_sid_t *gs_sid;
601dc20a302Sas 	uint16_t gs_type;
602dc20a302Sas } smb_gsid_t;
603dc20a302Sas 
604dc20a302Sas typedef struct smb_giter {
605dc20a302Sas 	sqlite_vm	*sgi_vm;
606dc20a302Sas 	sqlite		*sgi_db;
607dc20a302Sas } smb_giter_t;
608dc20a302Sas 
609dc20a302Sas typedef struct smb_group {
610dc20a302Sas 	char			*sg_name;
611dc20a302Sas 	char			*sg_cmnt;
612dc20a302Sas 	uint32_t		sg_attr;
613dc20a302Sas 	uint32_t		sg_rid;
614dc20a302Sas 	smb_gsid_t		sg_id;
615dc20a302Sas 	smb_gdomain_t		sg_domain;
616dc20a302Sas 	smb_privset_t		*sg_privs;
617dc20a302Sas 	uint32_t		sg_nmembers;
618dc20a302Sas 	smb_gsid_t		*sg_members;
619dc20a302Sas } smb_group_t;
620dc20a302Sas 
621dc20a302Sas int smb_lgrp_start(void);
622dc20a302Sas void smb_lgrp_stop(void);
623dc20a302Sas int smb_lgrp_add(char *, char *);
624dc20a302Sas int smb_lgrp_rename(char *, char *);
625dc20a302Sas int smb_lgrp_delete(char *);
626dc20a302Sas int smb_lgrp_setcmnt(char *, char *);
627dc20a302Sas int smb_lgrp_getcmnt(char *, char **);
628dc20a302Sas int smb_lgrp_getpriv(char *, uint8_t, boolean_t *);
629dc20a302Sas int smb_lgrp_setpriv(char *, uint8_t, boolean_t);
6306537f381Sas int smb_lgrp_add_member(char *, smb_sid_t *, uint16_t);
6316537f381Sas int smb_lgrp_del_member(char *, smb_sid_t *, uint16_t);
632dc20a302Sas int smb_lgrp_getbyname(char *, smb_group_t *);
633dc20a302Sas int smb_lgrp_getbyrid(uint32_t, smb_gdomain_t, smb_group_t *);
634dc20a302Sas int smb_lgrp_numbydomain(smb_gdomain_t, int *);
6356537f381Sas int smb_lgrp_numbymember(smb_sid_t *, int *);
636dc20a302Sas void smb_lgrp_free(smb_group_t *);
6376537f381Sas boolean_t smb_lgrp_is_member(smb_group_t *, smb_sid_t *);
638dc20a302Sas char *smb_lgrp_strerror(int);
639dc20a302Sas int smb_lgrp_iteropen(smb_giter_t *);
640dc20a302Sas void smb_lgrp_iterclose(smb_giter_t *);
641dc20a302Sas int smb_lgrp_iterate(smb_giter_t *, smb_group_t *);
642dc20a302Sas 
6436537f381Sas int smb_lookup_sid(smb_sid_t *, char *buf, int buflen);
644dc20a302Sas int smb_lookup_name(char *, smb_gsid_t *);
645dc20a302Sas 
646dc20a302Sas #define	SMB_LGRP_SUCCESS		0
647dc20a302Sas #define	SMB_LGRP_INVALID_ARG		1
648dc20a302Sas #define	SMB_LGRP_INVALID_MEMBER		2
649dc20a302Sas #define	SMB_LGRP_INVALID_NAME		3
650dc20a302Sas #define	SMB_LGRP_NOT_FOUND		4
651dc20a302Sas #define	SMB_LGRP_EXISTS			5
652dc20a302Sas #define	SMB_LGRP_NO_SID			6
653dc20a302Sas #define	SMB_LGRP_NO_LOCAL_SID		7
654dc20a302Sas #define	SMB_LGRP_SID_NOTLOCAL		8
655dc20a302Sas #define	SMB_LGRP_WKSID			9
656dc20a302Sas #define	SMB_LGRP_NO_MEMORY		10
657dc20a302Sas #define	SMB_LGRP_DB_ERROR		11
658dc20a302Sas #define	SMB_LGRP_DBINIT_ERROR		12
659dc20a302Sas #define	SMB_LGRP_INTERNAL_ERROR		13
660dc20a302Sas #define	SMB_LGRP_MEMBER_IN_GROUP	14
661dc20a302Sas #define	SMB_LGRP_MEMBER_NOT_IN_GROUP	15
662dc20a302Sas #define	SMB_LGRP_NO_SUCH_PRIV		16
663dc20a302Sas #define	SMB_LGRP_NO_SUCH_DOMAIN		17
664dc20a302Sas #define	SMB_LGRP_PRIV_HELD		18
665dc20a302Sas #define	SMB_LGRP_PRIV_NOT_HELD		19
666dc20a302Sas #define	SMB_LGRP_BAD_DATA		20
667dc20a302Sas #define	SMB_LGRP_NO_MORE		21
668dc20a302Sas #define	SMB_LGRP_DBOPEN_FAILED		22
669dc20a302Sas #define	SMB_LGRP_DBEXEC_FAILED		23
670dc20a302Sas #define	SMB_LGRP_DBINIT_FAILED		24
671dc20a302Sas #define	SMB_LGRP_DOMLKP_FAILED		25
672dc20a302Sas #define	SMB_LGRP_DOMINS_FAILED		26
673dc20a302Sas #define	SMB_LGRP_INSERT_FAILED		27
674dc20a302Sas #define	SMB_LGRP_DELETE_FAILED		28
675dc20a302Sas #define	SMB_LGRP_UPDATE_FAILED		29
676dc20a302Sas #define	SMB_LGRP_LOOKUP_FAILED		30
677dc20a302Sas #define	SMB_LGRP_NOT_SUPPORTED		31
678dc20a302Sas 
679dc20a302Sas #define	SMB_LGRP_NAME_CHAR_MAX	32
680dc20a302Sas #define	SMB_LGRP_COMMENT_MAX	256
681dc20a302Sas #define	SMB_LGRP_NAME_MAX	(SMB_LGRP_NAME_CHAR_MAX * MTS_MB_CHAR_MAX + 1)
682da6c28aaSamw 
6837b59d02dSjb /*
6847b59d02dSjb  * values for smb_nic_t.smbflags
6857b59d02dSjb  */
6867b59d02dSjb #define	SMB_NICF_NBEXCL		0x01	/* Excluded from Netbios activities */
6877b59d02dSjb #define	SMB_NICF_ALIAS		0x02	/* This is an alias */
6887b59d02dSjb 
6897b59d02dSjb /*
6907b59d02dSjb  * smb_nic_t
6917b59d02dSjb  *     nic_host		actual host name
6927b59d02dSjb  *     nic_nbname	16-byte NetBIOS host name
6937b59d02dSjb  */
6947b59d02dSjb typedef struct {
6957b59d02dSjb 	char		nic_host[MAXHOSTNAMELEN];
6967b59d02dSjb 	char		nic_nbname[NETBIOS_NAME_SZ];
6977b59d02dSjb 	char		nic_cmnt[SMB_PI_MAX_COMMENT];
6987b59d02dSjb 	char		nic_ifname[LIFNAMSIZ];
6997b59d02dSjb 	uint32_t	nic_ip;
7007b59d02dSjb 	uint32_t	nic_mask;
7017b59d02dSjb 	uint32_t	nic_bcast;
7027b59d02dSjb 	uint32_t	nic_smbflags;
7037b59d02dSjb 	uint64_t	nic_sysflags;
7047b59d02dSjb } smb_nic_t;
7057b59d02dSjb 
7067b59d02dSjb typedef struct smb_niciter {
7077b59d02dSjb 	smb_nic_t ni_nic;
7087b59d02dSjb 	int ni_cookie;
7097b59d02dSjb 	int ni_seqnum;
7107b59d02dSjb } smb_niciter_t;
7117b59d02dSjb 
7127b59d02dSjb /* NIC config functions */
7137b59d02dSjb int smb_nic_init(void);
7147b59d02dSjb void smb_nic_fini(void);
7157b59d02dSjb int smb_nic_getnum(char *);
7167b59d02dSjb int smb_nic_addhost(const char *, const char *, int, const char **);
7177b59d02dSjb int smb_nic_delhost(const char *);
7187b59d02dSjb int smb_nic_getfirst(smb_niciter_t *);
7197b59d02dSjb int smb_nic_getnext(smb_niciter_t *);
7207b59d02dSjb boolean_t smb_nic_exists(uint32_t, boolean_t);
7217b59d02dSjb 
7226537f381Sas /* NIC Monitoring functions */
7236537f381Sas int smb_nicmon_start(const char *);
7246537f381Sas void smb_nicmon_stop(void);
7256537f381Sas 
726da6c28aaSamw #ifdef	__cplusplus
727da6c28aaSamw }
728da6c28aaSamw #endif
729da6c28aaSamw 
730da6c28aaSamw #endif	/* _LIBSMB_H */
731