xref: /titanic_50/usr/src/lib/smbsrv/libmlsvc/common/libmlsvc.h (revision 12b65585e720714b31036daaa2b30eb76014048e)
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 2011 Nexenta Systems, Inc.  All rights reserved.
24  */
25 
26 #ifndef	_LIBMLSVC_H
27 #define	_LIBMLSVC_H
28 
29 #include <uuid/uuid.h>
30 #include <sys/param.h>
31 #include <sys/types.h>
32 #include <sys/uio.h>
33 #include <sys/ksynch.h>
34 #include <time.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <netdb.h>
38 #include <libuutil.h>
39 #include <smbsrv/wintypes.h>
40 #include <smbsrv/hash_table.h>
41 #include <smbsrv/smb_token.h>
42 #include <smbsrv/smb_privilege.h>
43 #include <smbsrv/smb_share.h>
44 #include <smbsrv/smb_xdr.h>
45 #include <smbsrv/smb_dfs.h>
46 #include <smbsrv/libsmb.h>
47 #include <smbsrv/libmlrpc.h>
48 #include <smbsrv/ndl/lsarpc.ndl>
49 
50 #ifdef	__cplusplus
51 extern "C" {
52 #endif
53 
54 uint32_t lsa_lookup_name(char *, uint16_t, smb_account_t *);
55 uint32_t lsa_lookup_sid(smb_sid_t *, smb_account_t *);
56 
57 /*
58  * SMB domain API to discover a domain controller and obtain domain
59  * information.
60  */
61 
62 extern boolean_t smb_locate_dc(char *, char *, smb_domainex_t *);
63 extern int smb_ddiscover_wait(void);
64 
65 extern int dssetup_check_service(void);
66 extern void dssetup_clear_domain_info(void);
67 extern void mlsvc_disconnect(const char *);
68 extern int mlsvc_init(void);
69 extern void mlsvc_fini(void);
70 extern DWORD mlsvc_netlogon(char *, char *);
71 extern DWORD mlsvc_join(smb_domainex_t *, char *, char *);
72 
73 extern void smb_logon_domain(smb_logon_t *, smb_token_t *);
74 extern uint32_t smb_decode_krb5_pac(smb_token_t *, char *, uint_t);
75 extern boolean_t smb_token_setup_common(smb_token_t *);
76 
77 
78 /*
79  * The maximum number of domains (NT limit).
80  */
81 #define	MLSVC_DOMAIN_MAX		32
82 
83 #define	MLSVC_ANON_USER			"IPC$"
84 
85 char *mlsvc_ipc_name(int ipc_type, char *username);
86 
87 /*
88  * Passthrough negotiation and authentication interface.
89  *
90  * NT supports two forms of password: a Lanman (case-insensitive)
91  * password and an NT (case-sensitive) password. If either of the
92  * passwords is not available its pointer and length should be set
93  * to zero. The session key and vc number are required to validate
94  * the encrypted passwords.
95  */
96 
97 void mlsvc_nt_password_hash(char *result, char *password);
98 int mlsvc_encrypt_nt_password(char *password, char *key, int keylen, char *out,
99     int outmax);
100 
101 #define	SMB_AUTOHOME_FILE	"smbautohome"
102 #define	SMB_AUTOHOME_PATH	"/etc"
103 
104 typedef struct smb_autohome {
105 	struct smb_autohome *ah_next;
106 	uint32_t ah_hits;
107 	time_t ah_timestamp;
108 	char *ah_name;		/* User account name */
109 	char *ah_path;		/* Home directory path */
110 	char *ah_container;	/* ADS container distinguished name */
111 } smb_autohome_t;
112 
113 extern void smb_autohome_add(const smb_token_t *);
114 extern void smb_autohome_remove(const char *);
115 
116 /*
117  * A local unique id (LUID) is an opaque id used by servers to identify
118  * local resources, such as privileges.  A client will use lookup
119  * functions to translate the LUID to a more general, machine independent
120  * form; such as a string.
121  */
122 typedef struct ms_luid {
123 	uint32_t low_part;
124 	uint32_t high_part;
125 } ms_luid_t;
126 
127 /*
128  * Information about a server as reported by NetServerGetInfo.
129  * The SV_PLATFORM and SV_TYPE definitions are in srvsvc.ndl.
130  */
131 typedef struct srvsvc_server_info {
132 	uint32_t	sv_platform_id;
133 	char		*sv_name;
134 	uint32_t	sv_version_major;
135 	uint32_t	sv_version_minor;
136 	uint32_t	sv_type;
137 	char		*sv_comment;
138 	uint32_t	sv_os;
139 } srvsvc_server_info_t;
140 
141 int srvsvc_net_server_getinfo(char *, char *, srvsvc_server_info_t *);
142 int srvsvc_net_remote_tod(char *, char *, struct timeval *, struct tm *);
143 
144 
145 /*
146  * A client_t is created while binding a client connection to hold the
147  * context for calls made using that connection.
148  *
149  * Handles are RPC call specific and we use an inheritance mechanism to
150  * ensure that each handle has a pointer to the client_t.  When the top
151  * level (bind) handle is released, we close the connection.
152  */
153 typedef struct mlsvc_handle {
154 	ndr_hdid_t			handle;
155 	ndr_client_t			*clnt;
156 	srvsvc_server_info_t		svinfo;
157 } mlsvc_handle_t;
158 
159 void ndr_rpc_init(void);
160 void ndr_rpc_fini(void);
161 int ndr_rpc_bind(mlsvc_handle_t *, char *, char *, char *, const char *);
162 void ndr_rpc_unbind(mlsvc_handle_t *);
163 int ndr_rpc_call(mlsvc_handle_t *, int, void *);
164 void ndr_rpc_set_nonull(mlsvc_handle_t *);
165 const srvsvc_server_info_t *ndr_rpc_server_info(mlsvc_handle_t *);
166 uint32_t ndr_rpc_server_os(mlsvc_handle_t *);
167 int ndr_rpc_get_ssnkey(mlsvc_handle_t *, unsigned char *, size_t);
168 void *ndr_rpc_malloc(mlsvc_handle_t *, size_t);
169 ndr_heap_t *ndr_rpc_get_heap(mlsvc_handle_t *);
170 void ndr_rpc_release(mlsvc_handle_t *);
171 boolean_t ndr_is_null_handle(mlsvc_handle_t *);
172 boolean_t ndr_is_bind_handle(mlsvc_handle_t *);
173 void ndr_inherit_handle(mlsvc_handle_t *, mlsvc_handle_t *);
174 void ndr_rpc_status(mlsvc_handle_t *, int, uint32_t);
175 
176 /* SVCCTL service */
177 /*
178  * Calculate the wide-char equivalent string length required to
179  * store a string - including the terminating null wide-char.
180  */
181 #define	SVCCTL_WNSTRLEN(S)	((strlen((S)) + 1) * sizeof (smb_wchar_t))
182 
183 /* An AVL-storable node representing each service in the SCM database. */
184 typedef struct svcctl_svc_node {
185 	uu_avl_node_t		sn_node;
186 	char			*sn_name;	/* Service Name (Key) */
187 	char			*sn_fmri;	/* Display Name (FMRI) */
188 	char			*sn_desc;	/* Description */
189 	char			*sn_state;	/* State */
190 } svcctl_svc_node_t;
191 
192 /* This structure provides context for each svcctl_s_OpenManager call. */
193 typedef struct svcctl_manager_context {
194 	scf_handle_t		*mc_scf_hdl;	  /* SCF handle */
195 	scf_propertygroup_t	*mc_scf_gpg;	  /* Property group */
196 	scf_property_t		*mc_scf_gprop;	  /* Property */
197 	scf_value_t		*mc_scf_gval;	  /* Value */
198 	uint32_t		mc_scf_numsvcs;   /* Number of SMF services */
199 	ssize_t			mc_scf_max_fmri_len;  /* Max FMRI length */
200 	ssize_t			mc_scf_max_value_len; /* Max Value length */
201 	uint32_t		mc_bytes_needed;  /* Number of bytes needed */
202 	uu_avl_pool_t		*mc_svcs_pool;	  /* AVL pool */
203 	uu_avl_t		*mc_svcs;	  /* AVL tree of SMF services */
204 } svcctl_manager_context_t;
205 
206 /* This structure provides context for each svcctl_s_OpenService call. */
207 typedef struct svcctl_service_context {
208 	ndr_hdid_t		*sc_mgrid;	/* Manager ID */
209 	char			*sc_svcname;    /* Service Name */
210 } svcctl_service_context_t;
211 
212 typedef enum {
213 	SVCCTL_MANAGER_CONTEXT = 0,
214 	SVCCTL_SERVICE_CONTEXT
215 } svcctl_context_type_t;
216 
217 /* This structure provides abstraction for service and manager context call. */
218 typedef struct svcctl_context {
219 	svcctl_context_type_t	c_type;
220 	union {
221 		svcctl_manager_context_t *uc_mgr;
222 		svcctl_service_context_t *uc_svc;
223 		void *uc_cp;
224 	} c_ctx;
225 } svcctl_context_t;
226 
227 /* Service Control Manager (SCM) functions */
228 void svcctl_init(void);
229 void svcctl_fini(void);
230 int svcctl_scm_init(svcctl_manager_context_t *);
231 void svcctl_scm_fini(svcctl_manager_context_t *);
232 int svcctl_scm_scf_handle_init(svcctl_manager_context_t *);
233 void svcctl_scm_scf_handle_fini(svcctl_manager_context_t *);
234 int svcctl_scm_refresh(svcctl_manager_context_t *);
235 uint32_t svcctl_scm_enum_services(svcctl_manager_context_t *, uint8_t *,
236     size_t, uint32_t *, boolean_t);
237 uint32_t svcctl_scm_validate_service(svcctl_manager_context_t *, char *);
238 svcctl_svc_node_t *svcctl_scm_find_service(svcctl_manager_context_t *, char *);
239 uint32_t svcctl_scm_map_status(const char *);
240 
241 /* LOGR service */
242 #define	LOGR_APPLICATION_LOG		"Application"
243 #define	LOGR_SECURITY_LOG		"Security"
244 #define	LOGR_SYSTEM_LOG			"System"
245 #define	LOGR_NMSGMASK			1023
246 #define	LOGR_MAXMSGLEN			800
247 
248 typedef struct logr_entry {
249 	struct timeval	le_timestamp;			/* Time of log entry */
250 	int		le_pri;				/* Message priority */
251 	char		le_hostname[MAXHOSTNAMELEN];	/* Log hostname */
252 	char		le_msg[LOGR_MAXMSGLEN];		/* Log message text */
253 } logr_entry_t;
254 
255 typedef struct logr_info {
256 	logr_entry_t	li_entry[LOGR_NMSGMASK+1];	/* Array of log entry */
257 	int		li_idx;				/* Index */
258 } logr_info_t;
259 
260 typedef struct logr_read_data {
261 	int		rd_tot_recnum;		/* Total no. of record read */
262 	int		rd_last_sentrec;	/* Last sentence read */
263 	char		rd_first_read;		/* First sentence read */
264 	logr_info_t	*rd_log;		/* Log information read */
265 } logr_read_data_t;
266 
267 /* This structure provides the context for eventlog calls from clients. */
268 typedef struct logr_context {
269 	logr_read_data_t *lc_cached_read_data;
270 	char *lc_source_name;
271 } logr_context_t;
272 
273 void logr_init(void);
274 void logr_fini(void);
275 boolean_t logr_is_supported(char *);
276 int logr_get_snapshot(logr_context_t *);
277 
278 /* User and Group quotas */
279 uint32_t smb_quota_query(smb_quota_query_t *, smb_quota_response_t *);
280 uint32_t smb_quota_set(smb_quota_set_t *);
281 void smb_quota_free(smb_quota_response_t *);
282 
283 uint32_t dfs_get_referrals(const char *, dfs_reftype_t, dfs_info_t *);
284 void dfs_info_free(dfs_info_t *);
285 
286 /*
287  * The spoolss installable copyfile API.
288  */
289 typedef void (*spoolss_copyfile_t)(smb_inaddr_t *, char *, char *, char *);
290 void spoolss_register_copyfile(spoolss_copyfile_t);
291 
292 #ifdef	__cplusplus
293 }
294 #endif
295 
296 #endif	/* _LIBMLSVC_H */
297