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