xref: /illumos-gate/usr/src/lib/smbsrv/libsmb/common/libsmb.h (revision c8ec8eea9849cac239663c46be8a7f5d2ba7ca00)
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 
29*c8ec8eeaSjose borrego #pragma ident	"@(#)libsmb.h	1.12	08/07/30 SMI"
30da6c28aaSamw 
31da6c28aaSamw #ifdef	__cplusplus
32da6c28aaSamw extern "C" {
33da6c28aaSamw #endif
34da6c28aaSamw 
35da6c28aaSamw #include <sys/types.h>
367b59d02dSjb #include <sys/list.h>
37da6c28aaSamw #include <arpa/inet.h>
387b59d02dSjb #include <net/if.h>
39dc20a302Sas #include <netdb.h>
40da6c28aaSamw 
41da6c28aaSamw #include <stdlib.h>
42da6c28aaSamw #include <libscf.h>
43da6c28aaSamw #include <libshare.h>
44dc20a302Sas #include <sqlite/sqlite.h>
45da6c28aaSamw 
46dc20a302Sas #include <smbsrv/string.h>
47da6c28aaSamw #include <smbsrv/smb_idmap.h>
487b59d02dSjb #include <smbsrv/netbios.h>
493db3f65cSamw #include <smbsrv/smb_share.h>
50da6c28aaSamw #include <smbsrv/ntstatus.h>
51da6c28aaSamw #include <smbsrv/smb_door_svc.h>
52da6c28aaSamw #include <smbsrv/alloc.h>
53da6c28aaSamw #include <smbsrv/codepage.h>
54da6c28aaSamw #include <smbsrv/crypt.h>
55da6c28aaSamw #include <smbsrv/ctype.h>
56da6c28aaSamw #include <smbsrv/hash_table.h>
57da6c28aaSamw #include <smbsrv/msgbuf.h>
58da6c28aaSamw #include <smbsrv/oem.h>
59da6c28aaSamw #include <smbsrv/smb_i18n.h>
60da6c28aaSamw #include <smbsrv/wintypes.h>
61da6c28aaSamw #include <smbsrv/smb_xdr.h>
62da6c28aaSamw #include <smbsrv/smbinfo.h>
63da6c28aaSamw 
64faa1795aSjb #define	SMB_VARRUN_DIR "/var/run/smb"
65faa1795aSjb #define	SMB_CCACHE_FILE "ccache"
66faa1795aSjb #define	SMB_CCACHE_PATH SMB_VARRUN_DIR "/" SMB_CCACHE_FILE
67faa1795aSjb 
68da6c28aaSamw /* Max value length of all SMB properties */
69da6c28aaSamw #define	MAX_VALUE_BUFLEN	512
70da6c28aaSamw 
71da6c28aaSamw #define	SMBD_FMRI_PREFIX		"network/smb/server"
72da6c28aaSamw #define	SMBD_DEFAULT_INSTANCE_FMRI	"svc:/network/smb/server:default"
73da6c28aaSamw #define	SMBD_PG_NAME			"smbd"
74da6c28aaSamw #define	SMBD_PROTECTED_PG_NAME		"read"
75da6c28aaSamw 
76da6c28aaSamw #define	SMBD_SMF_OK		0
77da6c28aaSamw #define	SMBD_SMF_NO_MEMORY	1	/* no memory for data structures */
78da6c28aaSamw #define	SMBD_SMF_SYSTEM_ERR	2	/* system error, use errno */
79da6c28aaSamw #define	SMBD_SMF_NO_PERMISSION	3	/* no permission for operation */
80dc20a302Sas #define	SMBD_SMF_INVALID_ARG	4
81da6c28aaSamw 
82da6c28aaSamw #define	SCH_STATE_UNINIT	0
83da6c28aaSamw #define	SCH_STATE_INITIALIZING	1
84da6c28aaSamw #define	SCH_STATE_INIT		2
85da6c28aaSamw 
86da6c28aaSamw typedef struct smb_scfhandle {
87da6c28aaSamw 	scf_handle_t		*scf_handle;
88da6c28aaSamw 	int			scf_state;
89da6c28aaSamw 	scf_service_t		*scf_service;
90da6c28aaSamw 	scf_scope_t		*scf_scope;
91da6c28aaSamw 	scf_transaction_t	*scf_trans;
92da6c28aaSamw 	scf_transaction_entry_t	*scf_entry;
93da6c28aaSamw 	scf_propertygroup_t	*scf_pg;
94da6c28aaSamw 	scf_instance_t		*scf_instance;
95da6c28aaSamw 	scf_iter_t		*scf_inst_iter;
96da6c28aaSamw 	scf_iter_t		*scf_pg_iter;
97da6c28aaSamw } smb_scfhandle_t;
98da6c28aaSamw 
99da6c28aaSamw /*
100da6c28aaSamw  * CIFS Configuration Management
101da6c28aaSamw  */
102da6c28aaSamw typedef enum {
103dc20a302Sas 	SMB_CI_OPLOCK_ENABLE = 0,
104da6c28aaSamw 
105da6c28aaSamw 	SMB_CI_AUTOHOME_MAP,
106da6c28aaSamw 
107da6c28aaSamw 	SMB_CI_DOMAIN_SID,
108da6c28aaSamw 	SMB_CI_DOMAIN_MEMB,
109da6c28aaSamw 	SMB_CI_DOMAIN_NAME,
110da6c28aaSamw 	SMB_CI_DOMAIN_SRV,
111da6c28aaSamw 
112da6c28aaSamw 	SMB_CI_WINS_SRV1,
113da6c28aaSamw 	SMB_CI_WINS_SRV2,
114da6c28aaSamw 	SMB_CI_WINS_EXCL,
115da6c28aaSamw 
116da6c28aaSamw 	SMB_CI_SRVSVC_SHRSET_ENABLE,
117da6c28aaSamw 	SMB_CI_MLRPC_KALIVE,
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 *);
163*c8ec8eeaSjose borrego extern int smb_smf_restart_service(void);
164da6c28aaSamw 
165da6c28aaSamw /* Configuration management functions  */
166dc20a302Sas extern int smb_config_get(smb_cfg_id_t, char *, int);
167dc20a302Sas extern char *smb_config_getname(smb_cfg_id_t);
168dc20a302Sas extern int smb_config_getstr(smb_cfg_id_t, char *, int);
169dc20a302Sas extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
170dc20a302Sas extern boolean_t smb_config_getbool(smb_cfg_id_t);
171da6c28aaSamw 
172da6c28aaSamw extern int smb_config_set(smb_cfg_id_t, char *);
173dc20a302Sas extern int smb_config_setstr(smb_cfg_id_t, char *);
174dc20a302Sas extern int smb_config_setnum(smb_cfg_id_t, int64_t);
175dc20a302Sas extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
176dc20a302Sas 
177da6c28aaSamw extern uint8_t smb_config_get_fg_flag(void);
178da6c28aaSamw extern char *smb_config_get_localsid(void);
179faa1795aSjb extern int smb_config_secmode_fromstr(char *);
180faa1795aSjb extern char *smb_config_secmode_tostr(int);
181da6c28aaSamw extern int smb_config_get_secmode(void);
182faa1795aSjb extern int smb_config_set_secmode(int);
183faa1795aSjb extern int smb_config_set_idmap_domain(char *);
184da6c28aaSamw extern int smb_config_refresh_idmap(void);
185faa1795aSjb 
1863ad684d6Sjb extern void smb_load_kconfig(smb_kmod_cfg_t *kcfg);
1873ad684d6Sjb 
188faa1795aSjb extern boolean_t smb_match_netlogon_seqnum(void);
189faa1795aSjb extern int smb_setdomainprops(char *, char *, char *);
190faa1795aSjb extern void smb_update_netlogon_seqnum(void);
191da6c28aaSamw 
192da6c28aaSamw /* smb_door_client.c */
193da6c28aaSamw typedef struct smb_joininfo {
194dc20a302Sas 	char domain_name[MAXHOSTNAMELEN];
195da6c28aaSamw 	char domain_username[BUF_LEN + 1];
196da6c28aaSamw 	char domain_passwd[BUF_LEN + 1];
197da6c28aaSamw 	uint32_t mode;
198da6c28aaSamw } smb_joininfo_t;
199da6c28aaSamw 
200da6c28aaSamw /* APIs to communicate with SMB daemon via door calls */
201da6c28aaSamw extern uint32_t smb_join(smb_joininfo_t *info);
202faa1795aSjb extern bool_t xdr_smb_dr_joininfo_t(XDR *, smb_joininfo_t *);
203da6c28aaSamw 
204da6c28aaSamw 
205da6c28aaSamw #define	SMB_DOMAIN_NOMACHINE_SID	-1
206da6c28aaSamw #define	SMB_DOMAIN_NODOMAIN_SID		-2
207da6c28aaSamw 
208*c8ec8eeaSjose borrego extern int nt_domain_init(char *, uint32_t);
209da6c28aaSamw 
210da6c28aaSamw /* Following set of functions, manipulate WINS server configuration */
211da6c28aaSamw extern int smb_wins_allow_list(char *config_list, char *allow_list);
212da6c28aaSamw extern int smb_wins_exclude_list(char *config_list, char *exclude_list);
213da6c28aaSamw extern boolean_t smb_wins_is_excluded(in_addr_t ipaddr,
21455bf511dSas     ipaddr_t *exclude_list, int nexclude);
215da6c28aaSamw extern void smb_wins_build_list(char *buf, uint32_t iplist[], int max_naddr);
216da6c28aaSamw extern int smb_wins_iplist(char *list, uint32_t iplist[], int max_naddr);
217da6c28aaSamw 
218da6c28aaSamw /*
219da6c28aaSamw  * Information on a particular domain: the domain name, the
220da6c28aaSamw  * name of a controller (PDC or BDC) and it's ip address.
221da6c28aaSamw  */
222da6c28aaSamw typedef struct smb_ntdomain {
223dc20a302Sas 	char domain[SMB_PI_MAX_DOMAIN];
224dc20a302Sas 	char server[SMB_PI_MAX_DOMAIN];
225da6c28aaSamw 	uint32_t ipaddr;
226da6c28aaSamw } smb_ntdomain_t;
227da6c28aaSamw 
228da6c28aaSamw /* SMB domain information management functions */
229*c8ec8eeaSjose borrego extern smb_ntdomain_t *smb_getdomaininfo(uint32_t);
230*c8ec8eeaSjose borrego extern void smb_setdomaininfo(char *, char *, uint32_t);
231*c8ec8eeaSjose borrego extern void smb_logdomaininfo(smb_ntdomain_t *);
232*c8ec8eeaSjose borrego extern uint32_t smb_get_dcinfo(smb_ntdomain_t *);
233*c8ec8eeaSjose borrego extern bool_t xdr_smb_dr_domain_t(XDR *, smb_ntdomain_t *);
234da6c28aaSamw 
235da6c28aaSamw /*
236da6c28aaSamw  * Following set of function, handle calls to SMB Kernel driver, via
237da6c28aaSamw  * Kernel doors interface.
238da6c28aaSamw  */
239da6c28aaSamw extern uint64_t smb_dwncall_user_num(void);
240da6c28aaSamw extern int smb_dwncall_share(int, char *, char *);
241da6c28aaSamw 
242da6c28aaSamw /*
243da6c28aaSamw  * buffer context structure. This is used to keep track of the buffer
244da6c28aaSamw  * context.
245da6c28aaSamw  *
246da6c28aaSamw  * basep:  points to the beginning of the buffer
247da6c28aaSamw  * curp:   points to the current offset
248da6c28aaSamw  * endp:   points to the limit of the buffer
249da6c28aaSamw  */
250da6c28aaSamw typedef struct {
251da6c28aaSamw 	unsigned char *basep;
252da6c28aaSamw 	unsigned char *curp;
253da6c28aaSamw 	unsigned char *endp;
254da6c28aaSamw } smb_ctxbuf_t;
255da6c28aaSamw 
256da6c28aaSamw extern int smb_ctxbuf_init(smb_ctxbuf_t *ctx, unsigned char *buf,
257da6c28aaSamw     size_t buflen);
258da6c28aaSamw extern int smb_ctxbuf_len(smb_ctxbuf_t *ctx);
259da6c28aaSamw extern int smb_ctxbuf_printf(smb_ctxbuf_t *ctx, const char *fmt, ...);
260da6c28aaSamw 
261da6c28aaSamw /* Functions to handle SMB daemon communications with idmap service */
262da6c28aaSamw extern int smb_idmap_start(void);
263da6c28aaSamw extern void smb_idmap_stop(void);
264da6c28aaSamw extern int smb_idmap_restart(void);
265da6c28aaSamw 
266da6c28aaSamw /* Miscellaneous functions */
267da6c28aaSamw extern void hexdump(unsigned char *, int);
268da6c28aaSamw extern size_t bintohex(const char *, size_t, char *, size_t);
269da6c28aaSamw extern size_t hextobin(const char *, size_t, char *, size_t);
270da6c28aaSamw extern char *trim_whitespace(char *buf);
271da6c28aaSamw extern void randomize(char *, unsigned);
272da6c28aaSamw extern void rand_hash(unsigned char *, size_t, unsigned char *, size_t);
273da6c28aaSamw 
274dc20a302Sas extern int smb_resolve_netbiosname(char *, char *, size_t);
275dc20a302Sas extern int smb_resolve_fqdn(char *, char *, size_t);
276da6c28aaSamw extern int smb_getdomainname(char *, size_t);
277dc20a302Sas extern int smb_getfqdomainname(char *, size_t);
278da6c28aaSamw extern int smb_gethostname(char *, size_t, int);
279dc20a302Sas extern int smb_getfqhostname(char *, size_t);
280da6c28aaSamw extern int smb_getnetbiosname(char *, size_t);
2816537f381Sas extern smb_sid_t *smb_getdomainsid(void);
282da6c28aaSamw 
2837b59d02dSjb extern int smb_get_nameservers(struct in_addr *, int);
2847b59d02dSjb extern void smb_tonetbiosname(char *, char *, char);
2857b59d02dSjb 
2867b59d02dSjb 
287da6c28aaSamw void smb_trace(const char *s);
288da6c28aaSamw void smb_tracef(const char *fmt, ...);
289da6c28aaSamw 
290da6c28aaSamw /*
291da6c28aaSamw  * Authentication
292da6c28aaSamw  */
293da6c28aaSamw 
294da6c28aaSamw #define	SMBAUTH_LM_MAGIC_STR	"KGS!@#$%"
295da6c28aaSamw 
296da6c28aaSamw #define	SMBAUTH_HASH_SZ		16	/* also LM/NTLM/NTLMv2 Hash size */
297da6c28aaSamw #define	SMBAUTH_LM_RESP_SZ	24	/* also NTLM Response size */
298da6c28aaSamw #define	SMBAUTH_LM_PWD_SZ	14	/* LM password size */
299da6c28aaSamw #define	SMBAUTH_V2_CLNT_CHALLENGE_SZ 8	/* both LMv2 and NTLMv2 */
300da6c28aaSamw #define	SMBAUTH_SESSION_KEY_SZ	SMBAUTH_HASH_SZ
301da6c28aaSamw #define	SMBAUTH_HEXHASH_SZ	(SMBAUTH_HASH_SZ * 2)
302da6c28aaSamw 
303da6c28aaSamw #define	SMBAUTH_FAILURE		1
304da6c28aaSamw #define	SMBAUTH_SUCCESS		0
305da6c28aaSamw #define	MD_DIGEST_LEN		16
306da6c28aaSamw 
307da6c28aaSamw /*
308da6c28aaSamw  * Name Types
309da6c28aaSamw  *
310da6c28aaSamw  * The list of names near the end of the data blob (i.e. the ndb_names
311da6c28aaSamw  * field of the smb_auth_data_blob_t data structure) can be classify into
312da6c28aaSamw  * the following types:
313da6c28aaSamw  *
314da6c28aaSamw  * 0x0000 Indicates the end of the list.
315da6c28aaSamw  * 0x0001 The name is a NetBIOS machine name (e.g. server name)
316da6c28aaSamw  * 0x0002 The name is an NT Domain NetBIOS name.
317da6c28aaSamw  * 0x0003 The name is the server's DNS hostname.
318da6c28aaSamw  * 0x0004 The name is a W2K Domain name (a DNS name).
319da6c28aaSamw  */
320da6c28aaSamw #define	SMBAUTH_NAME_TYPE_LIST_END		0x0000
321da6c28aaSamw #define	SMBAUTH_NAME_TYPE_SERVER_NETBIOS 	0x0001
322da6c28aaSamw #define	SMBAUTH_NAME_TYPE_DOMAIN_NETBIOS 	0x0002
323da6c28aaSamw #define	SMBAUTH_NAME_TYPE_SERVER_DNS		0x0003
324da6c28aaSamw #define	SMBAUTH_NAME_TYPE_DOMAIN_DNS 		0x0004
325da6c28aaSamw 
326da6c28aaSamw /*
327da6c28aaSamw  * smb_auth_name_entry_t
328da6c28aaSamw  *
329da6c28aaSamw  * Each name entry in the data blob consists of the following 3 fields:
330da6c28aaSamw  *
331da6c28aaSamw  * nne_type - name type
332da6c28aaSamw  * nne_len  - the length of the name
333da6c28aaSamw  * nne_name - the name, in uppercase UCS-2LE Unicode format
334da6c28aaSamw  */
335da6c28aaSamw typedef struct smb_auth_name_entry {
336da6c28aaSamw 	unsigned short nne_type;
337da6c28aaSamw 	unsigned short nne_len;
338da6c28aaSamw 	mts_wchar_t nne_name[SMB_PI_MAX_DOMAIN * 2];
339da6c28aaSamw } smb_auth_name_entry_t;
340da6c28aaSamw 
341da6c28aaSamw /*
342da6c28aaSamw  * smb_auth_data_blob
343da6c28aaSamw  *
344da6c28aaSamw  * The format of this NTLMv2 data blob structure is as follow:
345da6c28aaSamw  *
346da6c28aaSamw  *	- Blob Signature 0x01010000 (4 bytes)
347da6c28aaSamw  * - Reserved (0x00000000) (4 bytes)
348da6c28aaSamw  * - Timestamp Little-endian, 64-bit signed value representing
349da6c28aaSamw  *   the number of tenths of a microsecond since January 1, 1601.
350da6c28aaSamw  *   (8 bytes)
351da6c28aaSamw  * - Client Challenge (8 bytes)
352da6c28aaSamw  * - Unknown1 (4 bytes)
353da6c28aaSamw  * - List of Target Information (variable length)
354da6c28aaSamw  * - Unknown2 (4 bytes)
355da6c28aaSamw  */
356da6c28aaSamw typedef struct smb_auth_data_blob {
357da6c28aaSamw 	unsigned char ndb_signature[4];
358da6c28aaSamw 	unsigned char ndb_reserved[4];
359da6c28aaSamw 	uint64_t ndb_timestamp;
360da6c28aaSamw 	unsigned char ndb_clnt_challenge[SMBAUTH_V2_CLNT_CHALLENGE_SZ];
361da6c28aaSamw 	unsigned char ndb_unknown[4];
362da6c28aaSamw 	smb_auth_name_entry_t ndb_names[2];
363da6c28aaSamw 	unsigned char ndb_unknown2[4];
364da6c28aaSamw } smb_auth_data_blob_t;
365da6c28aaSamw 
366da6c28aaSamw #define	SMBAUTH_BLOB_MAXLEN (sizeof (smb_auth_data_blob_t))
367da6c28aaSamw #define	SMBAUTH_CI_MAXLEN   SMBAUTH_LM_RESP_SZ
368da6c28aaSamw #define	SMBAUTH_CS_MAXLEN   (SMBAUTH_BLOB_MAXLEN + SMBAUTH_HASH_SZ)
369da6c28aaSamw 
370da6c28aaSamw /*
371da6c28aaSamw  * smb_auth_info_t
372da6c28aaSamw  *
373da6c28aaSamw  * The structure contains all the authentication information
374da6c28aaSamw  * needed for the preparaton of the SMBSessionSetupAndx request
375da6c28aaSamw  * and the user session key.
376da6c28aaSamw  *
377da6c28aaSamw  * hash      - NTLM hash
378da6c28aaSamw  * hash_v2   - NTLMv2 hash
379da6c28aaSamw  * ci_len    - the length of the case-insensitive password
380da6c28aaSamw  * ci        - case-insensitive password
381da6c28aaSamw  *             (If NTLMv2 authentication mechanism is used, it
382da6c28aaSamw  *              represents the LMv2 response. Otherwise, it
383da6c28aaSamw  *              is empty.)
384da6c28aaSamw  * cs_len    - the length of the case-sensitive password
385da6c28aaSamw  * cs        - case-sensitive password
386da6c28aaSamw  *             (If NTLMv2 authentication mechanism is used, it
387da6c28aaSamw  *              represents the NTLMv2 response. Otherwise, it
388da6c28aaSamw  *              represents the NTLM response.)
389da6c28aaSamw  * data_blob - NTLMv2 data blob
390da6c28aaSamw  */
391da6c28aaSamw typedef struct smb_auth_info {
392da6c28aaSamw 	unsigned char hash[SMBAUTH_HASH_SZ];
393da6c28aaSamw 	unsigned char hash_v2[SMBAUTH_HASH_SZ];
394da6c28aaSamw 	unsigned short ci_len;
395da6c28aaSamw 	unsigned char ci[SMBAUTH_CI_MAXLEN];
396da6c28aaSamw 	unsigned short cs_len;
397da6c28aaSamw 	unsigned char cs[SMBAUTH_CS_MAXLEN];
398da6c28aaSamw 	int lmcompatibility_lvl;
399da6c28aaSamw 	smb_auth_data_blob_t data_blob;
400da6c28aaSamw } smb_auth_info_t;
401da6c28aaSamw 
402da6c28aaSamw /*
403da6c28aaSamw  * SMB password management
404da6c28aaSamw  */
405da6c28aaSamw 
406da6c28aaSamw #define	SMB_PWF_LM	0x01	/* LM hash is present */
407da6c28aaSamw #define	SMB_PWF_NT	0x02	/* NT hash is present */
408da6c28aaSamw #define	SMB_PWF_DISABLE	0x04	/* Account is disabled */
409da6c28aaSamw 
410da6c28aaSamw typedef struct smb_passwd {
411da6c28aaSamw 	uid_t pw_uid;
412da6c28aaSamw 	uint32_t pw_flags;
413da6c28aaSamw 	unsigned char pw_lmhash[SMBAUTH_HASH_SZ];
414da6c28aaSamw 	unsigned char pw_nthash[SMBAUTH_HASH_SZ];
415da6c28aaSamw } smb_passwd_t;
416da6c28aaSamw 
417da6c28aaSamw /*
418da6c28aaSamw  * Control flags passed to smb_pwd_setcntl
419da6c28aaSamw  */
420da6c28aaSamw #define	SMB_PWC_DISABLE	0x01
421da6c28aaSamw #define	SMB_PWC_ENABLE	0x02
422da6c28aaSamw #define	SMB_PWC_NOLM	0x04
423da6c28aaSamw 
424da6c28aaSamw #define	SMB_PWE_SUCCESS		0
425da6c28aaSamw #define	SMB_PWE_USER_UNKNOWN	1
426da6c28aaSamw #define	SMB_PWE_USER_DISABLE	2
427da6c28aaSamw #define	SMB_PWE_CLOSE_FAILED	3
428da6c28aaSamw #define	SMB_PWE_OPEN_FAILED	4
429da6c28aaSamw #define	SMB_PWE_WRITE_FAILED	6
430da6c28aaSamw #define	SMB_PWE_UPDATE_FAILED	7
431da6c28aaSamw #define	SMB_PWE_STAT_FAILED	8
432da6c28aaSamw #define	SMB_PWE_BUSY		9
433da6c28aaSamw #define	SMB_PWE_DENIED		10
434da6c28aaSamw #define	SMB_PWE_SYSTEM_ERROR	11
4353db3f65cSamw #define	SMB_PWE_INVALID_PARAM	12
4363db3f65cSamw #define	SMB_PWE_NO_MEMORY	13
4373db3f65cSamw #define	SMB_PWE_MAX		14
4383db3f65cSamw 
4393db3f65cSamw typedef struct smb_pwditer {
4403db3f65cSamw 	void *spi_next;
4413db3f65cSamw } smb_pwditer_t;
4423db3f65cSamw 
4433db3f65cSamw typedef struct smb_luser {
4443db3f65cSamw 	char *su_name;
4453db3f65cSamw 	char *su_fullname;
4463db3f65cSamw 	char *su_desc;
4473db3f65cSamw 	uint32_t su_rid;
4483db3f65cSamw 	uint32_t su_ctrl;
4493db3f65cSamw } smb_luser_t;
4503db3f65cSamw 
4513db3f65cSamw extern void smb_pwd_init(boolean_t);
4527b59d02dSjb extern void smb_pwd_fini(void);
453da6c28aaSamw extern smb_passwd_t *smb_pwd_getpasswd(const char *, smb_passwd_t *);
454da6c28aaSamw extern int smb_pwd_setpasswd(const char *, const char *);
455da6c28aaSamw extern int smb_pwd_setcntl(const char *, int);
4563db3f65cSamw extern int smb_pwd_num(void);
4573db3f65cSamw 
4583db3f65cSamw extern int smb_pwd_iteropen(smb_pwditer_t *);
4593db3f65cSamw extern smb_luser_t *smb_pwd_iterate(smb_pwditer_t *);
4603db3f65cSamw extern void smb_pwd_iterclose(smb_pwditer_t *);
461da6c28aaSamw 
462da6c28aaSamw extern int smb_auth_qnd_unicode(mts_wchar_t *dst, char *src, int length);
463da6c28aaSamw extern int smb_auth_hmac_md5(unsigned char *data, int data_len,
464da6c28aaSamw     unsigned char *key, int key_len, unsigned char *digest);
465da6c28aaSamw 
466da6c28aaSamw /*
467da6c28aaSamw  * A variation on HMAC-MD5 known as HMACT64 is used by Windows systems.
468da6c28aaSamw  * The HMACT64() function is the same as the HMAC-MD5() except that
469da6c28aaSamw  * it truncates the input key to 64 bytes rather than hashing it down
470da6c28aaSamw  * to 16 bytes using the MD5() function.
471da6c28aaSamw  */
472da6c28aaSamw #define	SMBAUTH_HMACT64(D, Ds, K, Ks, digest) \
473da6c28aaSamw 	smb_auth_hmac_md5(D, Ds, K, (Ks > 64) ? 64 : Ks, digest)
474da6c28aaSamw 
475da6c28aaSamw extern int smb_auth_DES(unsigned char *, int, unsigned char *, int,
476da6c28aaSamw     unsigned char *, int);
477da6c28aaSamw 
478da6c28aaSamw extern int smb_auth_md4(unsigned char *, unsigned char *, int);
479da6c28aaSamw extern int smb_auth_lm_hash(char *, unsigned char *);
480da6c28aaSamw extern int smb_auth_ntlm_hash(char *, unsigned char *);
481da6c28aaSamw 
482da6c28aaSamw extern int smb_auth_set_info(char *, char *,
483da6c28aaSamw     unsigned char *, char *, unsigned char *,
484da6c28aaSamw     int, int, smb_auth_info_t *);
485da6c28aaSamw 
4868c10a865Sas extern int smb_auth_ntlmv2_hash(unsigned char *,
4878c10a865Sas 	char *, char *, unsigned char *);
4888c10a865Sas 
489da6c28aaSamw extern int smb_auth_gen_session_key(smb_auth_info_t *, unsigned char *);
490da6c28aaSamw 
491da6c28aaSamw boolean_t smb_auth_validate_lm(unsigned char *, uint32_t, smb_passwd_t *,
492dc20a302Sas     unsigned char *, int, char *, char *);
493da6c28aaSamw boolean_t smb_auth_validate_nt(unsigned char *, uint32_t, smb_passwd_t *,
494*c8ec8eeaSjose borrego     unsigned char *, int, char *, char *, uchar_t *);
495da6c28aaSamw 
496da6c28aaSamw /*
497da6c28aaSamw  * SMB MAC Signing
498da6c28aaSamw  */
499da6c28aaSamw 
500da6c28aaSamw #define	SMB_MAC_KEY_SZ	(SMBAUTH_SESSION_KEY_SZ + SMBAUTH_CS_MAXLEN)
501da6c28aaSamw #define	SMB_SIG_OFFS	14	/* signature field offset within header */
502da6c28aaSamw #define	SMB_SIG_SIZE	8	/* SMB signature size */
503da6c28aaSamw 
504da6c28aaSamw /*
505da6c28aaSamw  * Signing flags:
506da6c28aaSamw  *
507da6c28aaSamw  * SMB_SCF_ENABLE                 Signing is enabled.
508da6c28aaSamw  *
509da6c28aaSamw  * SMB_SCF_REQUIRED               Signing is enabled and required.
510da6c28aaSamw  *                                This flag shouldn't be set if
511da6c28aaSamw  *                                SMB_SCF_ENABLE isn't set.
512da6c28aaSamw  *
513da6c28aaSamw  * SMB_SCF_STARTED                Signing will start after receiving
514da6c28aaSamw  *                                the first non-anonymous SessionSetup
515da6c28aaSamw  *                                request.
516da6c28aaSamw  *
517da6c28aaSamw  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
518da6c28aaSamw  *                                been set for this logon. (prior to
519da6c28aaSamw  *                                sending the SMBSessionSetup request)
520da6c28aaSamw  *
521da6c28aaSamw  */
522da6c28aaSamw #define	SMB_SCF_ENABLE		0x01
523da6c28aaSamw #define	SMB_SCF_REQUIRED	0x02
524da6c28aaSamw #define	SMB_SCF_STARTED		0x04
525da6c28aaSamw #define	SMB_SCF_KEY_ISSET_THIS_LOGON	0x08
526da6c28aaSamw 
527da6c28aaSamw /*
528da6c28aaSamw  * smb_sign_ctx
529da6c28aaSamw  *
530da6c28aaSamw  * SMB signing context.
531da6c28aaSamw  *
532da6c28aaSamw  *	ssc_seqnum				sequence number
533da6c28aaSamw  *	ssc_keylen				mac key length
534da6c28aaSamw  *	ssc_mid					multiplex id - reserved
535da6c28aaSamw  *	ssc_flags				flags
536da6c28aaSamw  *	ssc_mackey				mac key
537da6c28aaSamw  *	ssc_sign				mac signature
538da6c28aaSamw  *
539da6c28aaSamw  */
540da6c28aaSamw typedef struct smb_sign_ctx {
541da6c28aaSamw 	unsigned int ssc_seqnum;
542da6c28aaSamw 	unsigned short ssc_keylen;
543da6c28aaSamw 	unsigned short ssc_mid;
544da6c28aaSamw 	unsigned int ssc_flags;
545da6c28aaSamw 	unsigned char ssc_mackey[SMB_MAC_KEY_SZ];
546da6c28aaSamw 	unsigned char ssc_sign[SMB_SIG_SIZE];
547da6c28aaSamw } smb_sign_ctx_t;
548da6c28aaSamw 
549da6c28aaSamw extern int smb_mac_init(smb_sign_ctx_t *sign_ctx, smb_auth_info_t *auth);
550da6c28aaSamw extern int smb_mac_calc(smb_sign_ctx_t *sign_ctx,
551da6c28aaSamw     const unsigned char *buf, size_t buf_len, unsigned char *mac_sign);
552da6c28aaSamw extern int smb_mac_chk(smb_sign_ctx_t *sign_ctx,
553da6c28aaSamw     const unsigned char *buf, size_t buf_len);
554da6c28aaSamw extern int smb_mac_sign(smb_sign_ctx_t *sign_ctx,
555da6c28aaSamw     unsigned char *buf, size_t buf_len);
556da6c28aaSamw extern void smb_mac_inc_seqnum(smb_sign_ctx_t *sign_ctx);
557da6c28aaSamw extern void smb_mac_dec_seqnum(smb_sign_ctx_t *sign_ctx);
558da6c28aaSamw 
559da6c28aaSamw /*
560da6c28aaSamw  * Each domain is categorized using the enum values below.
561da6c28aaSamw  * The local domain refers to the local machine and is named
562da6c28aaSamw  * after the local hostname. The primary domain is the domain
563da6c28aaSamw  * that the system joined. All other domains are either
564da6c28aaSamw  * trusted or untrusted, as defined by the primary domain PDC.
565da6c28aaSamw  *
566da6c28aaSamw  * This enum must be kept in step with the table of strings
567da6c28aaSamw  * in ntdomain.c.
568da6c28aaSamw  */
569da6c28aaSamw typedef enum nt_domain_type {
570da6c28aaSamw 	NT_DOMAIN_NULL,
571da6c28aaSamw 	NT_DOMAIN_BUILTIN,
572da6c28aaSamw 	NT_DOMAIN_LOCAL,
573da6c28aaSamw 	NT_DOMAIN_PRIMARY,
574da6c28aaSamw 	NT_DOMAIN_ACCOUNT,
575da6c28aaSamw 	NT_DOMAIN_TRUSTED,
576da6c28aaSamw 	NT_DOMAIN_UNTRUSTED,
577da6c28aaSamw 	NT_DOMAIN_NUM_TYPES
578da6c28aaSamw } nt_domain_type_t;
579da6c28aaSamw 
580da6c28aaSamw 
581da6c28aaSamw /*
582da6c28aaSamw  * This is the information that is held about each domain. The database
583da6c28aaSamw  * is a linked list that is threaded through the domain structures. As
584da6c28aaSamw  * the number of domains in the database should be small (32 max), this
585da6c28aaSamw  * should be sufficient.
586da6c28aaSamw  */
587da6c28aaSamw typedef struct nt_domain {
588da6c28aaSamw 	struct nt_domain *next;
589da6c28aaSamw 	nt_domain_type_t type;
590da6c28aaSamw 	char *name;
5916537f381Sas 	smb_sid_t *sid;
592da6c28aaSamw } nt_domain_t;
593da6c28aaSamw 
5946537f381Sas nt_domain_t *nt_domain_new(nt_domain_type_t type, char *name, smb_sid_t *sid);
595da6c28aaSamw void nt_domain_delete(nt_domain_t *domain);
596da6c28aaSamw nt_domain_t *nt_domain_add(nt_domain_t *new_domain);
597da6c28aaSamw void nt_domain_remove(nt_domain_t *domain);
598da6c28aaSamw void nt_domain_flush(nt_domain_type_t domain_type);
599da6c28aaSamw void nt_domain_sync(void);
600da6c28aaSamw char *nt_domain_xlat_type(nt_domain_type_t domain_type);
601da6c28aaSamw nt_domain_type_t nt_domain_xlat_type_name(char *type_name);
602da6c28aaSamw nt_domain_t *nt_domain_lookup_name(char *domain_name);
6036537f381Sas nt_domain_t *nt_domain_lookup_sid(smb_sid_t *domain_sid);
604da6c28aaSamw nt_domain_t *nt_domain_lookupbytype(nt_domain_type_t type);
6056537f381Sas smb_sid_t *nt_domain_local_sid(void);
606da6c28aaSamw 
607dc20a302Sas typedef enum {
608dc20a302Sas 	SMB_LGRP_BUILTIN = 1,
609dc20a302Sas 	SMB_LGRP_LOCAL
610dc20a302Sas } smb_gdomain_t;
611dc20a302Sas 
612dc20a302Sas typedef struct smb_gsid {
6136537f381Sas 	smb_sid_t *gs_sid;
614dc20a302Sas 	uint16_t gs_type;
615dc20a302Sas } smb_gsid_t;
616dc20a302Sas 
617dc20a302Sas typedef struct smb_giter {
618dc20a302Sas 	sqlite_vm	*sgi_vm;
619dc20a302Sas 	sqlite		*sgi_db;
620dc20a302Sas } smb_giter_t;
621dc20a302Sas 
622dc20a302Sas typedef struct smb_group {
623dc20a302Sas 	char			*sg_name;
624dc20a302Sas 	char			*sg_cmnt;
625dc20a302Sas 	uint32_t		sg_attr;
626dc20a302Sas 	uint32_t		sg_rid;
627dc20a302Sas 	smb_gsid_t		sg_id;
628dc20a302Sas 	smb_gdomain_t		sg_domain;
629dc20a302Sas 	smb_privset_t		*sg_privs;
630dc20a302Sas 	uint32_t		sg_nmembers;
631dc20a302Sas 	smb_gsid_t		*sg_members;
632dc20a302Sas } smb_group_t;
633dc20a302Sas 
634dc20a302Sas int smb_lgrp_start(void);
635dc20a302Sas void smb_lgrp_stop(void);
636dc20a302Sas int smb_lgrp_add(char *, char *);
637dc20a302Sas int smb_lgrp_rename(char *, char *);
638dc20a302Sas int smb_lgrp_delete(char *);
639dc20a302Sas int smb_lgrp_setcmnt(char *, char *);
640dc20a302Sas int smb_lgrp_getcmnt(char *, char **);
641dc20a302Sas int smb_lgrp_getpriv(char *, uint8_t, boolean_t *);
642dc20a302Sas int smb_lgrp_setpriv(char *, uint8_t, boolean_t);
6436537f381Sas int smb_lgrp_add_member(char *, smb_sid_t *, uint16_t);
6446537f381Sas int smb_lgrp_del_member(char *, smb_sid_t *, uint16_t);
645dc20a302Sas int smb_lgrp_getbyname(char *, smb_group_t *);
646dc20a302Sas int smb_lgrp_getbyrid(uint32_t, smb_gdomain_t, smb_group_t *);
647dc20a302Sas int smb_lgrp_numbydomain(smb_gdomain_t, int *);
6486537f381Sas int smb_lgrp_numbymember(smb_sid_t *, int *);
649dc20a302Sas void smb_lgrp_free(smb_group_t *);
6506537f381Sas boolean_t smb_lgrp_is_member(smb_group_t *, smb_sid_t *);
651dc20a302Sas char *smb_lgrp_strerror(int);
652dc20a302Sas int smb_lgrp_iteropen(smb_giter_t *);
653dc20a302Sas void smb_lgrp_iterclose(smb_giter_t *);
654dc20a302Sas int smb_lgrp_iterate(smb_giter_t *, smb_group_t *);
655dc20a302Sas 
6566537f381Sas int smb_lookup_sid(smb_sid_t *, char *buf, int buflen);
657dc20a302Sas int smb_lookup_name(char *, smb_gsid_t *);
658dc20a302Sas 
659dc20a302Sas #define	SMB_LGRP_SUCCESS		0
660dc20a302Sas #define	SMB_LGRP_INVALID_ARG		1
661dc20a302Sas #define	SMB_LGRP_INVALID_MEMBER		2
662dc20a302Sas #define	SMB_LGRP_INVALID_NAME		3
663dc20a302Sas #define	SMB_LGRP_NOT_FOUND		4
664dc20a302Sas #define	SMB_LGRP_EXISTS			5
665dc20a302Sas #define	SMB_LGRP_NO_SID			6
666dc20a302Sas #define	SMB_LGRP_NO_LOCAL_SID		7
667dc20a302Sas #define	SMB_LGRP_SID_NOTLOCAL		8
668dc20a302Sas #define	SMB_LGRP_WKSID			9
669dc20a302Sas #define	SMB_LGRP_NO_MEMORY		10
670dc20a302Sas #define	SMB_LGRP_DB_ERROR		11
671dc20a302Sas #define	SMB_LGRP_DBINIT_ERROR		12
672dc20a302Sas #define	SMB_LGRP_INTERNAL_ERROR		13
673dc20a302Sas #define	SMB_LGRP_MEMBER_IN_GROUP	14
674dc20a302Sas #define	SMB_LGRP_MEMBER_NOT_IN_GROUP	15
675dc20a302Sas #define	SMB_LGRP_NO_SUCH_PRIV		16
676dc20a302Sas #define	SMB_LGRP_NO_SUCH_DOMAIN		17
677dc20a302Sas #define	SMB_LGRP_PRIV_HELD		18
678dc20a302Sas #define	SMB_LGRP_PRIV_NOT_HELD		19
679dc20a302Sas #define	SMB_LGRP_BAD_DATA		20
680dc20a302Sas #define	SMB_LGRP_NO_MORE		21
681dc20a302Sas #define	SMB_LGRP_DBOPEN_FAILED		22
682dc20a302Sas #define	SMB_LGRP_DBEXEC_FAILED		23
683dc20a302Sas #define	SMB_LGRP_DBINIT_FAILED		24
684dc20a302Sas #define	SMB_LGRP_DOMLKP_FAILED		25
685dc20a302Sas #define	SMB_LGRP_DOMINS_FAILED		26
686dc20a302Sas #define	SMB_LGRP_INSERT_FAILED		27
687dc20a302Sas #define	SMB_LGRP_DELETE_FAILED		28
688dc20a302Sas #define	SMB_LGRP_UPDATE_FAILED		29
689dc20a302Sas #define	SMB_LGRP_LOOKUP_FAILED		30
690dc20a302Sas #define	SMB_LGRP_NOT_SUPPORTED		31
691dc20a302Sas 
692dc20a302Sas #define	SMB_LGRP_NAME_CHAR_MAX	32
693dc20a302Sas #define	SMB_LGRP_COMMENT_MAX	256
694dc20a302Sas #define	SMB_LGRP_NAME_MAX	(SMB_LGRP_NAME_CHAR_MAX * MTS_MB_CHAR_MAX + 1)
695da6c28aaSamw 
6967b59d02dSjb /*
6977b59d02dSjb  * values for smb_nic_t.smbflags
6987b59d02dSjb  */
6997b59d02dSjb #define	SMB_NICF_NBEXCL		0x01	/* Excluded from Netbios activities */
7007b59d02dSjb #define	SMB_NICF_ALIAS		0x02	/* This is an alias */
7017b59d02dSjb 
7027b59d02dSjb /*
7037b59d02dSjb  * smb_nic_t
7047b59d02dSjb  *     nic_host		actual host name
7057b59d02dSjb  *     nic_nbname	16-byte NetBIOS host name
7067b59d02dSjb  */
7077b59d02dSjb typedef struct {
7087b59d02dSjb 	char		nic_host[MAXHOSTNAMELEN];
7097b59d02dSjb 	char		nic_nbname[NETBIOS_NAME_SZ];
7107b59d02dSjb 	char		nic_cmnt[SMB_PI_MAX_COMMENT];
7117b59d02dSjb 	char		nic_ifname[LIFNAMSIZ];
7127b59d02dSjb 	uint32_t	nic_ip;
7137b59d02dSjb 	uint32_t	nic_mask;
7147b59d02dSjb 	uint32_t	nic_bcast;
7157b59d02dSjb 	uint32_t	nic_smbflags;
7167b59d02dSjb 	uint64_t	nic_sysflags;
7177b59d02dSjb } smb_nic_t;
7187b59d02dSjb 
7197b59d02dSjb typedef struct smb_niciter {
7207b59d02dSjb 	smb_nic_t ni_nic;
7217b59d02dSjb 	int ni_cookie;
7227b59d02dSjb 	int ni_seqnum;
7237b59d02dSjb } smb_niciter_t;
7247b59d02dSjb 
7257b59d02dSjb /* NIC config functions */
7267b59d02dSjb int smb_nic_init(void);
7277b59d02dSjb void smb_nic_fini(void);
7287b59d02dSjb int smb_nic_getnum(char *);
7297b59d02dSjb int smb_nic_addhost(const char *, const char *, int, const char **);
7307b59d02dSjb int smb_nic_delhost(const char *);
7317b59d02dSjb int smb_nic_getfirst(smb_niciter_t *);
7327b59d02dSjb int smb_nic_getnext(smb_niciter_t *);
7337b59d02dSjb boolean_t smb_nic_exists(uint32_t, boolean_t);
7347b59d02dSjb 
7356537f381Sas /* NIC Monitoring functions */
7366537f381Sas int smb_nicmon_start(const char *);
7376537f381Sas void smb_nicmon_stop(void);
7386537f381Sas 
739da6c28aaSamw #ifdef	__cplusplus
740da6c28aaSamw }
741da6c28aaSamw #endif
742da6c28aaSamw 
743da6c28aaSamw #endif	/* _LIBSMB_H */
744