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