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