xref: /illumos-gate/usr/src/lib/smbsrv/libmlsvc/common/libmlsvc.h (revision b1e2e3fb17324e9ddf43db264a0c64da7756d9e6)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2017 Nexenta Systems, Inc.  All rights reserved.
24  */
25 
26 #ifndef	_LIBMLSVC_H
27 #define	_LIBMLSVC_H
28 
29 #include <sys/param.h>
30 #include <sys/types.h>
31 #include <sys/uio.h>
32 #include <sys/ksynch.h>
33 #include <uuid/uuid.h>
34 
35 #include <time.h>
36 #include <stdio.h>
37 #include <string.h>
38 #include <syslog.h>
39 #include <netdb.h>
40 #include <libuutil.h>
41 
42 #include <smb/wintypes.h>
43 #include <libmlrpc/libmlrpc.h>
44 
45 #include <smbsrv/hash_table.h>
46 #include <smbsrv/smb_token.h>
47 #include <smbsrv/smb_privilege.h>
48 #include <smbsrv/smb_share.h>
49 #include <smbsrv/smb_xdr.h>
50 #include <smbsrv/smb_dfs.h>
51 #include <smbsrv/libsmb.h>
52 
53 /*
54  * XXX: Some temporary left-overs from the old ntstatus.h
55  * Should eliminate uses of these macros when convenient.
56  */
57 /* This used to OR in the severity bits. */
58 #define	NT_SC_ERROR(S)		(S)
59 /* This used to mask off the severity bits. */
60 #define	NT_SC_VALUE(S)		(S)
61 /* XXX end of temporary left-overs. */
62 
63 #ifdef	__cplusplus
64 extern "C" {
65 #endif
66 
67 uint32_t lsa_lookup_name(char *, uint16_t, smb_account_t *);
68 uint32_t lsa_lookup_sid(smb_sid_t *, smb_account_t *);
69 
70 /*
71  * SMB domain API to discover a domain controller and obtain domain
72  * information.
73  */
74 
75 extern boolean_t smb_locate_dc(char *, smb_domainex_t *);
76 uint32_t smb_ddiscover_dns(char *, smb_domainex_t *);
77 extern void smb_ddiscover_bad_dc(char *);
78 extern void smb_ddiscover_refresh(void);
79 
80 extern int dssetup_check_service(void);
81 extern void dssetup_clear_domain_info(void);
82 extern void mlsvc_disconnect(const char *);
83 extern int mlsvc_init(void);
84 extern void mlsvc_fini(void);
85 extern DWORD mlsvc_netlogon(char *, char *);
86 extern void mlsvc_join(smb_joininfo_t *, smb_joinres_t *);
87 
88 extern void smb_logon_domain(smb_logon_t *, smb_token_t *);
89 extern uint32_t smb_decode_krb5_pac(smb_token_t *, char *, uint_t);
90 extern boolean_t smb_token_setup_common(smb_token_t *);
91 
92 
93 /*
94  * The maximum number of domains (NT limit).
95  */
96 #define	MLSVC_DOMAIN_MAX		32
97 
98 #define	MLSVC_ANON_USER			"IPC$"
99 
100 char *mlsvc_ipc_name(int ipc_type, char *username);
101 
102 /*
103  * Passthrough negotiation and authentication interface.
104  *
105  * NT supports two forms of password: a Lanman (case-insensitive)
106  * password and an NT (case-sensitive) password. If either of the
107  * passwords is not available its pointer and length should be set
108  * to zero. The session key and vc number are required to validate
109  * the encrypted passwords.
110  */
111 
112 void mlsvc_nt_password_hash(char *result, char *password);
113 int mlsvc_encrypt_nt_password(char *password, char *key, int keylen, char *out,
114     int outmax);
115 
116 #define	SMB_AUTOHOME_FILE	"smbautohome"
117 #define	SMB_AUTOHOME_PATH	"/etc"
118 
119 typedef struct smb_autohome {
120 	struct smb_autohome *ah_next;
121 	uint32_t ah_hits;
122 	time_t ah_timestamp;
123 	char *ah_name;		/* User account name */
124 	char *ah_path;		/* Home directory path */
125 	char *ah_container;	/* ADS container distinguished name */
126 } smb_autohome_t;
127 
128 extern void smb_autohome_add(const smb_token_t *);
129 extern void smb_autohome_remove(const char *);
130 
131 /*
132  * A local unique id (LUID) is an opaque id used by servers to identify
133  * local resources, such as privileges.  A client will use lookup
134  * functions to translate the LUID to a more general, machine independent
135  * form; such as a string.
136  */
137 typedef struct ms_luid {
138 	uint32_t low_part;
139 	uint32_t high_part;
140 } ms_luid_t;
141 
142 /*
143  * A client_t is created while binding a client connection to hold the
144  * context for calls made using that connection.
145  *
146  * Handles are RPC call specific and we use an inheritance mechanism to
147  * ensure that each handle has a pointer to the client_t.  When the top
148  * level (bind) handle is released, we close the connection.
149  */
150 typedef struct mlrpc_handle mlsvc_handle_t;
151 
152 /* mlsvc_client.c */
153 void ndr_rpc_init(void);
154 void ndr_rpc_fini(void);
155 uint32_t ndr_rpc_bind(mlsvc_handle_t *, char *, char *, char *, const char *);
156 void ndr_rpc_unbind(mlsvc_handle_t *);
157 void ndr_rpc_status(mlsvc_handle_t *, int, uint32_t);
158 
159 /* These three get info about the connected client. */
160 boolean_t ndr_is_admin(ndr_xa_t *);
161 boolean_t ndr_is_poweruser(ndr_xa_t *);
162 int32_t ndr_native_os(ndr_xa_t *);
163 
164 /* SRVSVC */
165 int srvsvc_net_remote_tod(char *, char *, struct timeval *, struct tm *);
166 
167 /* SVCCTL service */
168 /*
169  * Calculate the wide-char equivalent string length required to
170  * store a string - including the terminating null wide-char.
171  */
172 #define	SVCCTL_WNSTRLEN(S)	((strlen((S)) + 1) * sizeof (smb_wchar_t))
173 
174 /* An AVL-storable node representing each service in the SCM database. */
175 typedef struct svcctl_svc_node {
176 	uu_avl_node_t		sn_node;
177 	char			*sn_name;	/* Service Name (Key) */
178 	char			*sn_fmri;	/* Display Name (FMRI) */
179 	char			*sn_desc;	/* Description */
180 	char			*sn_state;	/* State */
181 } svcctl_svc_node_t;
182 
183 /* This structure provides context for each svcctl_s_OpenManager call. */
184 typedef struct svcctl_manager_context {
185 	scf_handle_t		*mc_scf_hdl;	  /* SCF handle */
186 	scf_propertygroup_t	*mc_scf_gpg;	  /* Property group */
187 	scf_property_t		*mc_scf_gprop;	  /* Property */
188 	scf_value_t		*mc_scf_gval;	  /* Value */
189 	uint32_t		mc_scf_numsvcs;   /* Number of SMF services */
190 	ssize_t			mc_scf_max_fmri_len;  /* Max FMRI length */
191 	ssize_t			mc_scf_max_value_len; /* Max Value length */
192 	uint32_t		mc_bytes_needed;  /* Number of bytes needed */
193 	uu_avl_pool_t		*mc_svcs_pool;	  /* AVL pool */
194 	uu_avl_t		*mc_svcs;	  /* AVL tree of SMF services */
195 } svcctl_manager_context_t;
196 
197 /* This structure provides context for each svcctl_s_OpenService call. */
198 typedef struct svcctl_service_context {
199 	ndr_hdid_t		*sc_mgrid;	/* Manager ID */
200 	char			*sc_svcname;    /* Service Name */
201 } svcctl_service_context_t;
202 
203 typedef enum {
204 	SVCCTL_MANAGER_CONTEXT = 0,
205 	SVCCTL_SERVICE_CONTEXT
206 } svcctl_context_type_t;
207 
208 /* This structure provides abstraction for service and manager context call. */
209 typedef struct svcctl_context {
210 	svcctl_context_type_t	c_type;
211 	union {
212 		svcctl_manager_context_t *uc_mgr;
213 		svcctl_service_context_t *uc_svc;
214 		void *uc_cp;
215 	} c_ctx;
216 } svcctl_context_t;
217 
218 /* Service Control Manager (SCM) functions */
219 void svcctl_init(void);
220 void svcctl_fini(void);
221 int svcctl_scm_init(svcctl_manager_context_t *);
222 void svcctl_scm_fini(svcctl_manager_context_t *);
223 int svcctl_scm_scf_handle_init(svcctl_manager_context_t *);
224 void svcctl_scm_scf_handle_fini(svcctl_manager_context_t *);
225 int svcctl_scm_refresh(svcctl_manager_context_t *);
226 uint32_t svcctl_scm_enum_services(svcctl_manager_context_t *, uint8_t *,
227     size_t, uint32_t *, boolean_t);
228 uint32_t svcctl_scm_validate_service(svcctl_manager_context_t *, char *);
229 svcctl_svc_node_t *svcctl_scm_find_service(svcctl_manager_context_t *, char *);
230 uint32_t svcctl_scm_map_status(const char *);
231 
232 /* LOGR service */
233 #define	LOGR_APPLICATION_LOG		"Application"
234 #define	LOGR_SECURITY_LOG		"Security"
235 #define	LOGR_SYSTEM_LOG			"System"
236 #define	LOGR_NMSGMASK			1023
237 #define	LOGR_MAXMSGLEN			800
238 
239 typedef struct logr_entry {
240 	struct timeval	le_timestamp;			/* Time of log entry */
241 	int		le_pri;				/* Message priority */
242 	char		le_hostname[MAXHOSTNAMELEN];	/* Log hostname */
243 	char		le_msg[LOGR_MAXMSGLEN];		/* Log message text */
244 } logr_entry_t;
245 
246 typedef struct logr_info {
247 	logr_entry_t	li_entry[LOGR_NMSGMASK+1];	/* Array of log entry */
248 	int		li_idx;				/* Index */
249 } logr_info_t;
250 
251 typedef struct logr_read_data {
252 	int		rd_tot_recnum;		/* Total no. of record read */
253 	int		rd_last_sentrec;	/* Last sentence read */
254 	char		rd_first_read;		/* First sentence read */
255 	logr_info_t	*rd_log;		/* Log information read */
256 } logr_read_data_t;
257 
258 /* This structure provides the context for eventlog calls from clients. */
259 typedef struct logr_context {
260 	logr_read_data_t *lc_cached_read_data;
261 	char *lc_source_name;
262 } logr_context_t;
263 
264 void logr_init(void);
265 void logr_fini(void);
266 boolean_t logr_is_supported(char *);
267 int logr_get_snapshot(logr_context_t *);
268 
269 /* User and Group quotas */
270 uint32_t smb_quota_query(smb_quota_query_t *, smb_quota_response_t *);
271 uint32_t smb_quota_set(smb_quota_set_t *);
272 void smb_quota_free(smb_quota_response_t *);
273 
274 uint32_t dfs_get_referrals(const char *, dfs_reftype_t, dfs_info_t *);
275 void dfs_info_free(dfs_info_t *);
276 
277 /*
278  * The spoolss installable copyfile API.
279  */
280 typedef void (*spoolss_copyfile_t)(smb_inaddr_t *, char *, char *, char *);
281 void spoolss_register_copyfile(spoolss_copyfile_t);
282 
283 #ifdef	__cplusplus
284 }
285 #endif
286 
287 #endif	/* _LIBMLSVC_H */
288