usr/src/lib/smbsrv/libsmb/common/libsmb.h

   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 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
  25  */
  26
  27 #ifndef _LIBSMB_H
  28 #define _LIBSMB_H
  29
  30 #ifdef  __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <sys/types.h>
  35 #include <sys/list.h>
  36 #include <sys/avl.h>
  37 #include <arpa/inet.h>
  38 #include <net/if.h>
  39 #include <inet/tcp.h>
  40 #include <uuid/uuid.h>
  41 #include <netdb.h>
  42 #include <stdlib.h>
  43 #include <libscf.h>
  44 #include <libshare.h>
  45 #include <uuid/uuid.h>
  46 #include <synch.h>
  47
  48 #include <smbsrv/string.h>
  49 #include <smbsrv/smb_idmap.h>
  50 #include <smbsrv/netbios.h>
  51 #include <smbsrv/smb_share.h>
  52 #include <smb/nterror.h>
  53 #include <smb/ntstatus.h>
  54 #include <smbsrv/smb_door.h>
  55 #include <smbsrv/alloc.h>
  56 #include <smbsrv/hash_table.h>
  57 #include <smbsrv/msgbuf.h>
  58 #include <smbsrv/wintypes.h>
  59 #include <smbsrv/smb_xdr.h>
  60 #include <smbsrv/smbinfo.h>
  61 #include <smbsrv/ntifs.h>
  62
  63 #define SMB_VARSMB_DIR "/var/smb"
  64 #define SMB_VARRUN_DIR "/var/run/smb"
  65 #define SMB_CCACHE_FILE "ccache"
  66 #define SMB_CCACHE_PATH SMB_VARRUN_DIR "/" SMB_CCACHE_FILE
  67
  68
  69 /* Max value length of all SMB properties */
  70 #define MAX_VALUE_BUFLEN        512
  71
  72 #define SMBD_FMRI_PREFIX                "network/smb/server"
  73 #define SMBD_DEFAULT_INSTANCE_FMRI      "svc:/network/smb/server:default"
  74 #define SMBD_PG_NAME                    "smbd"
  75 #define SMBD_PROTECTED_PG_NAME          "read"
  76 #define SMBD_EXEC_PG_NAME               "exec"
  77
  78 #define SMBD_SMF_OK             0
  79 #define SMBD_SMF_NO_MEMORY      1       /* no memory for data structures */
  80 #define SMBD_SMF_SYSTEM_ERR     2       /* system error, use errno */
  81 #define SMBD_SMF_NO_PERMISSION  3       /* no permission for operation */
  82 #define SMBD_SMF_INVALID_ARG    4
  83
  84 #define SCH_STATE_UNINIT        0
  85 #define SCH_STATE_INITIALIZING  1
  86 #define SCH_STATE_INIT          2
  87
  88 typedef struct smb_scfhandle {
  89         scf_handle_t            *scf_handle;
  90         int                     scf_state;
  91         scf_service_t           *scf_service;
  92         scf_scope_t             *scf_scope;
  93         scf_transaction_t       *scf_trans;
  94         scf_transaction_entry_t *scf_entry;
  95         scf_propertygroup_t     *scf_pg;
  96         scf_instance_t          *scf_instance;
  97         scf_iter_t              *scf_inst_iter;
  98         scf_iter_t              *scf_pg_iter;
  99 } smb_scfhandle_t;
 100
 101 /*
 102  * CIFS Configuration Management
 103  */
 104 typedef enum {
 105         SMB_CI_VERSION = 0,
 106         SMB_CI_OPLOCK_ENABLE,
 107
 108         SMB_CI_AUTOHOME_MAP,
 109
 110         SMB_CI_DOMAIN_SID,
 111         SMB_CI_DOMAIN_MEMB,
 112         SMB_CI_DOMAIN_NAME,
 113         SMB_CI_DOMAIN_FQDN,
 114         SMB_CI_DOMAIN_FOREST,
 115         SMB_CI_DOMAIN_GUID,
 116         SMB_CI_DOMAIN_SRV,
 117
 118         SMB_CI_WINS_SRV1,
 119         SMB_CI_WINS_SRV2,
 120         SMB_CI_WINS_EXCL,
 121
 122         SMB_CI_MAX_WORKERS,
 123         SMB_CI_MAX_CONNECTIONS,
 124         SMB_CI_KEEPALIVE,
 125         SMB_CI_RESTRICT_ANON,
 126
 127         SMB_CI_SIGNING_ENABLE,
 128         SMB_CI_SIGNING_REQD,
 129
 130         SMB_CI_SYNC_ENABLE,
 131
 132         SMB_CI_SECURITY,
 133         SMB_CI_NETBIOS_ENABLE,
 134         SMB_CI_NBSCOPE,
 135         SMB_CI_SYS_CMNT,
 136         SMB_CI_LM_LEVEL,
 137
 138         SMB_CI_ADS_SITE,
 139
 140         SMB_CI_DYNDNS_ENABLE,
 141
 142         SMB_CI_MACHINE_PASSWD,
 143         SMB_CI_KPASSWD_SRV,
 144         SMB_CI_KPASSWD_DOMAIN,
 145         SMB_CI_KPASSWD_SEQNUM,
 146         SMB_CI_NETLOGON_SEQNUM,
 147         SMB_CI_IPV6_ENABLE,
 148         SMB_CI_PRINT_ENABLE,
 149         SMB_CI_MAP,
 150         SMB_CI_UNMAP,
 151         SMB_CI_DISPOSITION,
 152         SMB_CI_DFS_STDROOT_NUM,
 153         SMB_CI_TRAVERSE_MOUNTS,
 154
 155         SMB_CI_MAX
 156 } smb_cfg_id_t;
 157
 158 /* SMF helper functions */
 159 extern smb_scfhandle_t *smb_smf_scf_init(char *);
 160 extern void smb_smf_scf_fini(smb_scfhandle_t *);
 161 extern int smb_smf_start_transaction(smb_scfhandle_t *);
 162 extern int smb_smf_end_transaction(smb_scfhandle_t *);
 163 extern int smb_smf_set_string_property(smb_scfhandle_t *, char *, char *);
 164 extern int smb_smf_get_string_property(smb_scfhandle_t *, char *,
 165     char *, size_t);
 166 extern int smb_smf_set_integer_property(smb_scfhandle_t *, char *, int64_t);
 167 extern int smb_smf_get_integer_property(smb_scfhandle_t *, char *, int64_t *);
 168 extern int smb_smf_set_boolean_property(smb_scfhandle_t *, char *, uint8_t);
 169 extern int smb_smf_get_boolean_property(smb_scfhandle_t *, char *, uint8_t *);
 170 extern int smb_smf_set_opaque_property(smb_scfhandle_t *, char *,
 171     void *, size_t);
 172 extern int smb_smf_get_opaque_property(smb_scfhandle_t *, char *,
 173     void *, size_t);
 174 extern int smb_smf_create_service_pgroup(smb_scfhandle_t *, char *);
 175 extern int smb_smf_restart_service(void);
 176 extern int smb_smf_maintenance_mode(void);
 177
 178 /* ZFS interface */
 179 int smb_getdataset(const char *, char *, size_t);
 180
 181 /* Configuration management functions  */
 182 extern int smb_config_get(smb_cfg_id_t, char *, int);
 183 extern char *smb_config_getname(smb_cfg_id_t);
 184 extern int smb_config_getstr(smb_cfg_id_t, char *, int);
 185 extern int smb_config_getnum(smb_cfg_id_t, int64_t *);
 186 extern boolean_t smb_config_getbool(smb_cfg_id_t);
 187
 188 extern int smb_config_set(smb_cfg_id_t, char *);
 189 extern int smb_config_setstr(smb_cfg_id_t, char *);
 190 extern int smb_config_setnum(smb_cfg_id_t, int64_t);
 191 extern int smb_config_setbool(smb_cfg_id_t, boolean_t);
 192
 193 extern boolean_t smb_config_get_ads_enable(void);
 194 extern uint8_t smb_config_get_fg_flag(void);
 195 extern char *smb_config_get_localsid(void);
 196 extern int smb_config_secmode_fromstr(char *);
 197 extern char *smb_config_secmode_tostr(int);
 198 extern int smb_config_get_secmode(void);
 199 extern int smb_config_set_secmode(int);
 200 extern int smb_config_set_idmap_domain(char *);
 201 extern int smb_config_refresh_idmap(void);
 202 extern int smb_config_getip(smb_cfg_id_t, smb_inaddr_t *);
 203 extern void smb_config_get_version(smb_version_t *);
 204 uint32_t smb_config_get_execinfo(char *, char *, size_t);
 205
 206
 207 extern void smb_load_kconfig(smb_kmod_cfg_t *kcfg);
 208 extern uint32_t smb_crc_gen(uint8_t *, size_t);
 209
 210 extern boolean_t smb_match_netlogon_seqnum(void);
 211 extern int smb_setdomainprops(char *, char *, char *);
 212 extern void smb_update_netlogon_seqnum(void);
 213
 214 /* maximum password length on Windows 2000 and above */
 215 #define SMB_PASSWD_MAXLEN       127
 216 #define SMB_USERNAME_MAXLEN     40
 217
 218 typedef struct smb_joininfo {
 219         char domain_name[MAXHOSTNAMELEN];
 220         char domain_username[SMB_USERNAME_MAXLEN + 1];
 221         char domain_passwd[SMB_PASSWD_MAXLEN + 1];
 222         uint32_t mode;
 223 } smb_joininfo_t;
 224
 225 /* APIs to communicate with SMB daemon via door calls */
 226 uint32_t smb_join(smb_joininfo_t *info);
 227 bool_t smb_joininfo_xdr(XDR *, smb_joininfo_t *);
 228 boolean_t smb_find_ads_server(char *, char *, int);
 229
 230 extern void smb_config_getdomaininfo(char *, char *, char *, char *, char *);
 231 extern void smb_config_setdomaininfo(char *, char *, char *, char *, char *);
 232 extern uint32_t smb_get_dcinfo(char *, uint32_t, smb_inaddr_t *);
 233
 234 /*
 235  * buffer context structure. This is used to keep track of the buffer
 236  * context.
 237  *
 238  * basep:  points to the beginning of the buffer
 239  * curp:   points to the current offset
 240  * endp:   points to the limit of the buffer
 241  */
 242 typedef struct {
 243         unsigned char *basep;
 244         unsigned char *curp;
 245         unsigned char *endp;
 246 } smb_ctxbuf_t;
 247
 248 extern int smb_ctxbuf_init(smb_ctxbuf_t *ctx, unsigned char *buf,
 249     size_t buflen);
 250 extern int smb_ctxbuf_len(smb_ctxbuf_t *ctx);
 251 extern int smb_ctxbuf_printf(smb_ctxbuf_t *ctx, const char *fmt, ...);
 252
 253 void smb_idmap_check(const char *, idmap_stat);
 254
 255 /* Miscellaneous functions */
 256 extern void hexdump(unsigned char *, int);
 257 extern size_t bintohex(const char *, size_t, char *, size_t);
 258 extern size_t hextobin(const char *, size_t, char *, size_t);
 259 extern char *strstrip(char *, const char *);
 260 extern char *strtrim(char *, const char *);
 261 extern char *trim_whitespace(char *);
 262 extern void randomize(char *, unsigned);
 263 extern void rand_hash(unsigned char *, size_t, unsigned char *, size_t);
 264
 265 extern int smb_getdomainname(char *, size_t);
 266 extern int smb_getfqdomainname(char *, size_t);
 267
 268 typedef enum smb_caseconv {
 269         SMB_CASE_PRESERVE = 0,
 270         SMB_CASE_UPPER,
 271         SMB_CASE_LOWER
 272 } smb_caseconv_t;
 273
 274 extern int smb_gethostname(char *, size_t, smb_caseconv_t);
 275 extern int smb_getfqhostname(char *, size_t);
 276 extern int smb_getnetbiosname(char *, size_t);
 277 extern struct hostent *smb_gethostbyname(const char *, int *);
 278 extern struct hostent *smb_gethostbyaddr(const char *, int, int, int *);
 279
 280 #define SMB_SAMACCT_MAXLEN      (NETBIOS_NAME_SZ + 1)
 281 extern int smb_getsamaccount(char *, size_t);
 282
 283 extern int smb_get_nameservers(smb_inaddr_t *, int);
 284 extern void smb_tonetbiosname(char *, char *, char);
 285
 286 extern int smb_chk_hostaccess(smb_inaddr_t *, char *);
 287
 288 extern int smb_getnameinfo(smb_inaddr_t *, char *, int, int);
 289
 290 void smb_trace(const char *s);
 291 void smb_tracef(const char *fmt, ...);
 292
 293 const char *xlate_nt_status(unsigned int);
 294
 295 /*
 296  * Authentication
 297  */
 298
 299 #define SMBAUTH_LM_MAGIC_STR    "KGS!@#$%"
 300
 301 #define SMBAUTH_HASH_SZ         16      /* also LM/NTLM/NTLMv2 Hash size */
 302 #define SMBAUTH_LM_RESP_SZ      24      /* also NTLM Response size */
 303 #define SMBAUTH_LM_PWD_SZ       14      /* LM password size */
 304 #define SMBAUTH_V2_CLNT_CHALLENGE_SZ 8  /* both LMv2 and NTLMv2 */
 305 #define SMBAUTH_SESSION_KEY_SZ  SMBAUTH_HASH_SZ
 306 #define SMBAUTH_HEXHASH_SZ      (SMBAUTH_HASH_SZ * 2)
 307
 308 #define SMBAUTH_FAILURE         1
 309 #define SMBAUTH_SUCCESS         0
 310 #define MD_DIGEST_LEN           16
 311
 312 /*
 313  * Name Types
 314  *
 315  * The list of names near the end of the data blob (i.e. the ndb_names
 316  * field of the smb_auth_data_blob_t data structure) can be classify into
 317  * the following types:
 318  *
 319  * 0x0000 Indicates the end of the list.
 320  * 0x0001 The name is a NetBIOS machine name (e.g. server name)
 321  * 0x0002 The name is an NT Domain NetBIOS name.
 322  * 0x0003 The name is the server's DNS hostname.
 323  * 0x0004 The name is a W2K Domain name (a DNS name).
 324  */
 325 #define SMBAUTH_NAME_TYPE_LIST_END              0x0000
 326 #define SMBAUTH_NAME_TYPE_SERVER_NETBIOS        0x0001
 327 #define SMBAUTH_NAME_TYPE_DOMAIN_NETBIOS        0x0002
 328 #define SMBAUTH_NAME_TYPE_SERVER_DNS            0x0003
 329 #define SMBAUTH_NAME_TYPE_DOMAIN_DNS            0x0004
 330
 331 /*
 332  * smb_auth_name_entry_t
 333  *
 334  * Each name entry in the data blob consists of the following 3 fields:
 335  *
 336  * nne_type - name type
 337  * nne_len  - the length of the name
 338  * nne_name - the name, in uppercase UCS-2LE Unicode format
 339  */
 340 typedef struct smb_auth_name_entry {
 341         unsigned short nne_type;
 342         unsigned short nne_len;
 343         smb_wchar_t nne_name[SMB_PI_MAX_DOMAIN * 2];
 344 } smb_auth_name_entry_t;
 345
 346 /*
 347  * smb_auth_data_blob
 348  *
 349  * The format of this NTLMv2 data blob structure is as follow:
 350  *
 351  *      - Blob Signature 0x01010000 (4 bytes)
 352  * - Reserved (0x00000000) (4 bytes)
 353  * - Timestamp Little-endian, 64-bit signed value representing
 354  *   the number of tenths of a microsecond since January 1, 1601.
 355  *   (8 bytes)
 356  * - Client Challenge (8 bytes)
 357  * - Unknown1 (4 bytes)
 358  * - List of Target Information (variable length)
 359  * - Unknown2 (4 bytes)
 360  */
 361 typedef struct smb_auth_data_blob {
 362         unsigned char ndb_signature[4];
 363         unsigned char ndb_reserved[4];
 364         uint64_t ndb_timestamp;
 365         unsigned char ndb_clnt_challenge[SMBAUTH_V2_CLNT_CHALLENGE_SZ];
 366         unsigned char ndb_unknown[4];
 367         smb_auth_name_entry_t ndb_names[2];
 368         unsigned char ndb_unknown2[4];
 369 } smb_auth_data_blob_t;
 370
 371 #define SMBAUTH_BLOB_MAXLEN (sizeof (smb_auth_data_blob_t))
 372 #define SMBAUTH_CI_MAXLEN   SMBAUTH_LM_RESP_SZ
 373 #define SMBAUTH_CS_MAXLEN   (SMBAUTH_BLOB_MAXLEN + SMBAUTH_HASH_SZ)
 374
 375 /*
 376  * smb_auth_info_t
 377  *
 378  * The structure contains all the authentication information
 379  * needed for the preparaton of the SMBSessionSetupAndx request
 380  * and the user session key.
 381  *
 382  * hash      - NTLM hash
 383  * hash_v2   - NTLMv2 hash
 384  * ci_len    - the length of the case-insensitive password
 385  * ci        - case-insensitive password
 386  *             (If NTLMv2 authentication mechanism is used, it
 387  *              represents the LMv2 response. Otherwise, it
 388  *              is empty.)
 389  * cs_len    - the length of the case-sensitive password
 390  * cs        - case-sensitive password
 391  *             (If NTLMv2 authentication mechanism is used, it
 392  *              represents the NTLMv2 response. Otherwise, it
 393  *              represents the NTLM response.)
 394  * data_blob - NTLMv2 data blob
 395  */
 396 typedef struct smb_auth_info {
 397         unsigned char hash[SMBAUTH_HASH_SZ];
 398         unsigned char hash_v2[SMBAUTH_HASH_SZ];
 399         unsigned short ci_len;
 400         unsigned char ci[SMBAUTH_CI_MAXLEN];
 401         unsigned short cs_len;
 402         unsigned char cs[SMBAUTH_CS_MAXLEN];
 403         int lmcompatibility_lvl;
 404         smb_auth_data_blob_t data_blob;
 405 } smb_auth_info_t;
 406
 407 /*
 408  * SMB password management
 409  */
 410
 411 #define SMB_PWF_LM      0x01    /* LM hash is present */
 412 #define SMB_PWF_NT      0x02    /* NT hash is present */
 413 #define SMB_PWF_DISABLE 0x04    /* Account is disabled */
 414
 415 typedef struct smb_passwd {
 416         uid_t           pw_uid;
 417         uint32_t        pw_flags;
 418         char            pw_name[SMB_USERNAME_MAXLEN];
 419         uint8_t         pw_lmhash[SMBAUTH_HASH_SZ];
 420         uint8_t         pw_nthash[SMBAUTH_HASH_SZ];
 421 } smb_passwd_t;
 422
 423 /*
 424  * Control flags passed to smb_pwd_setcntl
 425  */
 426 #define SMB_PWC_DISABLE 0x01
 427 #define SMB_PWC_ENABLE  0x02
 428 #define SMB_PWC_NOLM    0x04
 429
 430 #define SMB_PWE_SUCCESS         0
 431 #define SMB_PWE_USER_UNKNOWN    1
 432 #define SMB_PWE_USER_DISABLE    2
 433 #define SMB_PWE_CLOSE_FAILED    3
 434 #define SMB_PWE_OPEN_FAILED     4
 435 #define SMB_PWE_WRITE_FAILED    6
 436 #define SMB_PWE_UPDATE_FAILED   7
 437 #define SMB_PWE_STAT_FAILED     8
 438 #define SMB_PWE_BUSY            9
 439 #define SMB_PWE_DENIED          10
 440 #define SMB_PWE_SYSTEM_ERROR    11
 441 #define SMB_PWE_INVALID_PARAM   12
 442 #define SMB_PWE_NO_MEMORY       13
 443 #define SMB_PWE_MAX             14
 444
 445 typedef struct smb_pwditer {
 446         void *spi_next;
 447 } smb_pwditer_t;
 448
 449 typedef struct smb_luser {
 450         char *su_name;
 451         char *su_fullname;
 452         char *su_desc;
 453         uint32_t su_rid;
 454         uint32_t su_ctrl;
 455 } smb_luser_t;
 456
 457 extern void smb_pwd_init(boolean_t);
 458 extern void smb_pwd_fini(void);
 459 extern smb_passwd_t *smb_pwd_getpwnam(const char *, smb_passwd_t *);
 460 extern smb_passwd_t *smb_pwd_getpwuid(uid_t, smb_passwd_t *);
 461 extern int smb_pwd_setpasswd(const char *, const char *);
 462 extern int smb_pwd_setcntl(const char *, int);
 463
 464 extern int smb_pwd_iteropen(smb_pwditer_t *);
 465 extern smb_luser_t *smb_pwd_iterate(smb_pwditer_t *);
 466 extern void smb_pwd_iterclose(smb_pwditer_t *);
 467
 468 extern int smb_auth_qnd_unicode(smb_wchar_t *, const char *, int);
 469 extern int smb_auth_hmac_md5(unsigned char *, int, unsigned char *, int,
 470     unsigned char *);
 471
 472 /*
 473  * A variation on HMAC-MD5 known as HMACT64 is used by Windows systems.
 474  * The HMACT64() function is the same as the HMAC-MD5() except that
 475  * it truncates the input key to 64 bytes rather than hashing it down
 476  * to 16 bytes using the MD5() function.
 477  */
 478 #define SMBAUTH_HMACT64(D, Ds, K, Ks, digest) \
 479         smb_auth_hmac_md5(D, Ds, K, (Ks > 64) ? 64 : Ks, digest)
 480
 481 extern int smb_auth_DES(unsigned char *, int, unsigned char *, int,
 482     unsigned char *, int);
 483 extern int smb_auth_RC4(unsigned char *, int, unsigned char *, int,
 484     unsigned char *, int);
 485
 486 extern int smb_auth_md4(unsigned char *, unsigned char *, int);
 487 extern int smb_auth_lm_hash(const char *, unsigned char *);
 488 extern int smb_auth_ntlm_hash(const char *, unsigned char *);
 489
 490 extern int smb_auth_set_info(char *, char *,
 491     unsigned char *, char *, unsigned char *,
 492     int, int, smb_auth_info_t *);
 493
 494 extern int smb_auth_ntlmv2_hash(unsigned char *,
 495         char *, char *, unsigned char *);
 496
 497 extern int smb_auth_gen_session_key(smb_auth_info_t *, unsigned char *);
 498
 499 boolean_t smb_auth_validate_lm(unsigned char *, uint32_t, smb_passwd_t *,
 500     unsigned char *, int, char *, char *);
 501 boolean_t smb_auth_validate_nt(unsigned char *, uint32_t, smb_passwd_t *,
 502     unsigned char *, int, char *, char *, uchar_t *);
 503
 504 int smb_gen_random_passwd(char *passwd, size_t bufsz);
 505
 506 /*
 507  * SMB authenticated IPC
 508  */
 509 extern void smb_ipc_commit(void);
 510 extern void smb_ipc_get_user(char *, size_t);
 511 extern void smb_ipc_get_passwd(uint8_t *, size_t);
 512 extern void smb_ipc_init(void);
 513 extern void smb_ipc_rollback(void);
 514 extern void smb_ipc_set(char *, uint8_t *);
 515
 516 /*
 517  * SMB MAC Signing
 518  */
 519
 520 #define SMB_MAC_KEY_SZ  (SMBAUTH_SESSION_KEY_SZ + SMBAUTH_CS_MAXLEN)
 521 #define SMB_SIG_OFFS    14      /* signature field offset within header */
 522 #define SMB_SIG_SIZE    8       /* SMB signature size */
 523
 524 /*
 525  * Signing flags:
 526  *
 527  * SMB_SCF_ENABLE                 Signing is enabled.
 528  *
 529  * SMB_SCF_REQUIRED               Signing is enabled and required.
 530  *                                This flag shouldn't be set if
 531  *                                SMB_SCF_ENABLE isn't set.
 532  *
 533  * SMB_SCF_STARTED                Signing will start after receiving
 534  *                                the first non-anonymous SessionSetup
 535  *                                request.
 536  *
 537  * SMB_SCF_KEY_ISSET_THIS_LOGON   Indicates whether the MAC key has just
 538  *                                been set for this logon. (prior to
 539  *                                sending the SMBSessionSetup request)
 540  *
 541  */
 542 #define SMB_SCF_ENABLE          0x01
 543 #define SMB_SCF_REQUIRED        0x02
 544 #define SMB_SCF_STARTED         0x04
 545 #define SMB_SCF_KEY_ISSET_THIS_LOGON    0x08
 546
 547 /*
 548  * smb_sign_ctx
 549  *
 550  * SMB signing context.
 551  *
 552  *      ssc_seqnum                              sequence number
 553  *      ssc_keylen                              mac key length
 554  *      ssc_mid                                 multiplex id - reserved
 555  *      ssc_flags                               flags
 556  *      ssc_mackey                              mac key
 557  *      ssc_sign                                mac signature
 558  *
 559  */
 560 typedef struct smb_sign_ctx {
 561         unsigned int ssc_seqnum;
 562         unsigned short ssc_keylen;
 563         unsigned short ssc_mid;
 564         unsigned int ssc_flags;
 565         unsigned char ssc_mackey[SMB_MAC_KEY_SZ];
 566         unsigned char ssc_sign[SMB_SIG_SIZE];
 567 } smb_sign_ctx_t;
 568
 569 extern int smb_mac_init(smb_sign_ctx_t *sign_ctx, smb_auth_info_t *auth);
 570 extern int smb_mac_calc(smb_sign_ctx_t *sign_ctx,
 571     const unsigned char *buf, size_t buf_len, unsigned char *mac_sign);
 572 extern int smb_mac_chk(smb_sign_ctx_t *sign_ctx,
 573     const unsigned char *buf, size_t buf_len);
 574 extern int smb_mac_sign(smb_sign_ctx_t *sign_ctx,
 575     unsigned char *buf, size_t buf_len);
 576 extern void smb_mac_inc_seqnum(smb_sign_ctx_t *sign_ctx);
 577 extern void smb_mac_dec_seqnum(smb_sign_ctx_t *sign_ctx);
 578
 579 /*
 580  * Each domain is categorized using the enum values below.
 581  * The local domain refers to the local machine and is named
 582  * after the local hostname. The primary domain is the domain
 583  * that the system joined. All other domains are either
 584  * trusted or untrusted, as defined by the primary domain PDC.
 585  */
 586 typedef enum smb_domain_type {
 587         SMB_DOMAIN_NULL,
 588         SMB_DOMAIN_BUILTIN,
 589         SMB_DOMAIN_LOCAL,
 590         SMB_DOMAIN_PRIMARY,
 591         SMB_DOMAIN_ACCOUNT,
 592         SMB_DOMAIN_TRUSTED,
 593         SMB_DOMAIN_UNTRUSTED,
 594         SMB_DOMAIN_NUM_TYPES
 595 } smb_domain_type_t;
 596
 597 /*
 598  * Information specific to trusted domains
 599  */
 600 typedef struct smb_domain_trust {
 601         uint32_t                dti_trust_direction;
 602         uint32_t                dti_trust_type;
 603         uint32_t                dti_trust_attrs;
 604 } smb_domain_trust_t;
 605
 606 /*
 607  * DNS information for domain types that this info is
 608  * obtained/available. Currently this is only obtained
 609  * for the primary domain.
 610  */
 611 typedef struct smb_domain_dns {
 612         char                    ddi_forest[MAXHOSTNAMELEN];
 613         char                    ddi_guid[UUID_PRINTABLE_STRING_LENGTH];
 614 } smb_domain_dns_t;
 615
 616 /*
 617  * This is the information that is held about each domain.
 618  */
 619 typedef struct smb_domain {
 620         list_node_t             di_lnd;
 621         smb_domain_type_t       di_type;
 622         char                    di_sid[SMB_SID_STRSZ];
 623         char                    di_nbname[NETBIOS_NAME_SZ];
 624         char                    di_fqname[MAXHOSTNAMELEN];
 625         smb_sid_t               *di_binsid;
 626         union {
 627                 smb_domain_dns_t        di_dns;
 628                 smb_domain_trust_t      di_trust;
 629         } di_u;
 630 } smb_domain_t;
 631
 632 typedef struct smb_trusted_domains {
 633         uint32_t        td_num;
 634         smb_domain_t    *td_domains;
 635 } smb_trusted_domains_t;
 636
 637 #define SMB_DOMAIN_SUCCESS              0
 638 #define SMB_DOMAIN_NOMACHINE_SID        1
 639 #define SMB_DOMAIN_NODOMAIN_SID         2
 640 #define SMB_DOMAIN_NODOMAIN_NAME        3
 641 #define SMB_DOMAIN_INTERNAL_ERR         4
 642 #define SMB_DOMAIN_INVALID_ARG          5
 643 #define SMB_DOMAIN_NO_MEMORY            6
 644 #define SMB_DOMAIN_NO_CACHE             7
 645
 646 /*
 647  * This structure could contain information about
 648  * the primary domain the name of selected domain controller
 649  * for the primary domain and a list of trusted domains if
 650  * any. The "ex" in the structure name stands for extended.
 651  * This is to differentiate this structure from smb_domain_t
 652  * which only contains information about a single domain.
 653  */
 654 typedef struct smb_domainex {
 655         char                    d_dc[MAXHOSTNAMELEN];
 656         smb_domain_t            d_primary;
 657         smb_trusted_domains_t   d_trusted;
 658 } smb_domainex_t;
 659
 660 int smb_domain_init(uint32_t);
 661 void smb_domain_fini(void);
 662 void smb_domain_show(void);
 663 void smb_domain_save(void);
 664 boolean_t smb_domain_lookup_name(char *, smb_domain_t *);
 665 boolean_t smb_domain_lookup_sid(smb_sid_t *, smb_domain_t *);
 666 boolean_t smb_domain_lookup_type(smb_domain_type_t, smb_domain_t *);
 667 boolean_t smb_domain_getinfo(smb_domainex_t *);
 668 void smb_domain_update(smb_domainex_t *);
 669 uint32_t smb_domain_start_update(void);
 670 void smb_domain_end_update(void);
 671 void smb_domain_set_basic_info(char *, char *, char *, smb_domain_t *);
 672 void smb_domain_set_dns_info(char *, char *, char *, char *, char *,
 673     smb_domain_t *);
 674 void smb_domain_set_trust_info(char *, char *, char *,
 675     uint32_t, uint32_t, uint32_t, smb_domain_t *);
 676 void smb_domain_current_dc(char *buf, size_t len);
 677
 678 typedef struct smb_gsid {
 679         smb_sid_t *gs_sid;
 680         uint16_t gs_type;
 681 } smb_gsid_t;
 682
 683 struct sqlite_vm;
 684 struct sqlite;
 685
 686 typedef struct smb_giter {
 687         struct sqlite_vm        *sgi_vm;
 688         struct sqlite           *sgi_db;
 689         uint32_t                sgi_nerr;
 690 } smb_giter_t;
 691
 692 typedef struct smb_group {
 693         char                    *sg_name;
 694         char                    *sg_cmnt;
 695         uint32_t                sg_attr;
 696         uint32_t                sg_rid;
 697         smb_gsid_t              sg_id;
 698         smb_domain_type_t       sg_domain;
 699         smb_privset_t           *sg_privs;
 700         uint32_t                sg_nmembers;
 701         smb_gsid_t              *sg_members;
 702 } smb_group_t;
 703
 704 int smb_lgrp_start(void);
 705 void smb_lgrp_stop(void);
 706 int smb_lgrp_add(char *, char *);
 707 int smb_lgrp_rename(char *, char *);
 708 int smb_lgrp_delete(char *);
 709 int smb_lgrp_setcmnt(char *, char *);
 710 int smb_lgrp_getcmnt(char *, char **);
 711 int smb_lgrp_getpriv(char *, uint8_t, boolean_t *);
 712 int smb_lgrp_setpriv(char *, uint8_t, boolean_t);
 713 int smb_lgrp_add_member(char *, smb_sid_t *, uint16_t);
 714 int smb_lgrp_del_member(char *, smb_sid_t *, uint16_t);
 715 int smb_lgrp_getbyname(char *, smb_group_t *);
 716 int smb_lgrp_getbyrid(uint32_t, smb_domain_type_t, smb_group_t *);
 717 void smb_lgrp_free(smb_group_t *);
 718 uint32_t smb_lgrp_err_to_ntstatus(uint32_t);
 719 boolean_t smb_lgrp_is_member(smb_group_t *, smb_sid_t *);
 720 char *smb_lgrp_strerror(int);
 721 int smb_lgrp_iteropen(smb_giter_t *);
 722 void smb_lgrp_iterclose(smb_giter_t *);
 723 boolean_t smb_lgrp_itererror(smb_giter_t *);
 724 int smb_lgrp_iterate(smb_giter_t *, smb_group_t *);
 725
 726 int smb_lookup_sid(const char *, lsa_account_t *);
 727 int smb_lookup_name(const char *, sid_type_t, lsa_account_t *);
 728
 729 #define SMB_LGRP_SUCCESS                0
 730 #define SMB_LGRP_INVALID_ARG            1
 731 #define SMB_LGRP_INVALID_MEMBER         2
 732 #define SMB_LGRP_INVALID_NAME           3
 733 #define SMB_LGRP_NOT_FOUND              4
 734 #define SMB_LGRP_EXISTS                 5
 735 #define SMB_LGRP_NO_SID                 6
 736 #define SMB_LGRP_NO_LOCAL_SID           7
 737 #define SMB_LGRP_SID_NOTLOCAL           8
 738 #define SMB_LGRP_WKSID                  9
 739 #define SMB_LGRP_NO_MEMORY              10
 740 #define SMB_LGRP_DB_ERROR               11
 741 #define SMB_LGRP_DBINIT_ERROR           12
 742 #define SMB_LGRP_INTERNAL_ERROR         13
 743 #define SMB_LGRP_MEMBER_IN_GROUP        14
 744 #define SMB_LGRP_MEMBER_NOT_IN_GROUP    15
 745 #define SMB_LGRP_NO_SUCH_PRIV           16
 746 #define SMB_LGRP_NO_SUCH_DOMAIN         17
 747 #define SMB_LGRP_PRIV_HELD              18
 748 #define SMB_LGRP_PRIV_NOT_HELD          19
 749 #define SMB_LGRP_BAD_DATA               20
 750 #define SMB_LGRP_NO_MORE                21
 751 #define SMB_LGRP_DBOPEN_FAILED          22
 752 #define SMB_LGRP_DBEXEC_FAILED          23
 753 #define SMB_LGRP_DBINIT_FAILED          24
 754 #define SMB_LGRP_DOMLKP_FAILED          25
 755 #define SMB_LGRP_DOMINS_FAILED          26
 756 #define SMB_LGRP_INSERT_FAILED          27
 757 #define SMB_LGRP_DELETE_FAILED          28
 758 #define SMB_LGRP_UPDATE_FAILED          29
 759 #define SMB_LGRP_LOOKUP_FAILED          30
 760 #define SMB_LGRP_NOT_SUPPORTED          31
 761 #define SMB_LGRP_OFFLINE                32
 762 #define SMB_LGRP_POSIXCREATE_FAILED     33
 763
 764 #define SMB_LGRP_COMMENT_MAX    256
 765
 766 /*
 767  * values for smb_nic_t.smbflags
 768  */
 769 #define SMB_NICF_NBEXCL         0x01    /* Excluded from Netbios activities */
 770 #define SMB_NICF_ALIAS          0x02    /* This is an alias */
 771
 772 /*
 773  * smb_nic_t
 774  *     nic_host         actual host name
 775  *     nic_nbname       16-byte NetBIOS host name
 776  */
 777 typedef struct {
 778         char            nic_host[MAXHOSTNAMELEN];
 779         char            nic_nbname[NETBIOS_NAME_SZ];
 780         char            nic_cmnt[SMB_PI_MAX_COMMENT];
 781         char            nic_ifname[LIFNAMSIZ];
 782         smb_inaddr_t    nic_ip;
 783         uint32_t        nic_mask;
 784         uint32_t        nic_bcast;
 785         uint32_t        nic_smbflags;
 786         uint64_t        nic_sysflags;
 787 } smb_nic_t;
 788
 789 typedef struct smb_niciter {
 790         smb_nic_t ni_nic;
 791         int ni_cookie;
 792         int ni_seqnum;
 793 } smb_niciter_t;
 794
 795 /* NIC config functions */
 796 int smb_nic_init(void);
 797 void smb_nic_fini(void);
 798 int smb_nic_getnum(char *);
 799 int smb_nic_addhost(const char *, const char *, int, const char **);
 800 int smb_nic_delhost(const char *);
 801 int smb_nic_getfirst(smb_niciter_t *);
 802 int smb_nic_getnext(smb_niciter_t *);
 803 boolean_t smb_nic_is_local(smb_inaddr_t *);
 804 boolean_t smb_nic_is_same_subnet(smb_inaddr_t *);
 805
 806 #define SMB_NIC_SUCCESS                 0
 807 #define SMB_NIC_INVALID_ARG             1
 808 #define SMB_NIC_NOT_FOUND               2
 809 #define SMB_NIC_NO_HOST                 3
 810 #define SMB_NIC_NO_MEMORY               4
 811 #define SMB_NIC_DB_ERROR                5
 812 #define SMB_NIC_DBINIT_ERROR            6
 813 #define SMB_NIC_BAD_DATA                7
 814 #define SMB_NIC_NO_MORE                 8
 815 #define SMB_NIC_DBOPEN_FAILED           9
 816 #define SMB_NIC_DBEXEC_FAILED           10
 817 #define SMB_NIC_DBINIT_FAILED           11
 818 #define SMB_NIC_INSERT_FAILED           12
 819 #define SMB_NIC_DELETE_FAILED           13
 820 #define SMB_NIC_SOCK                    14
 821 #define SMB_NIC_IOCTL                   15
 822 #define SMB_NIC_CHANGED                 16
 823
 824 /*
 825  * Well-known account structure
 826  *
 827  * A security identifier (SID) is a unique value of variable length that
 828  * is used to identify a security principal or security group in
 829  * Windows. Well-known SIDs are a group of SIDs that identify generic
 830  * users or generic groups. Their values remain constant across all
 831  * operating systems.
 832  *
 833  * This structure is defined to store these SIDs and other related
 834  * information about them (e.g. account and domain names) in a
 835  * predefined table.
 836  */
 837 typedef struct smb_wka {
 838         uint8_t         wka_domidx;
 839         char            *wka_sid;
 840         char            *wka_name;
 841         uint16_t        wka_type;
 842         uint16_t        wka_flags;
 843         char            *wka_desc;
 844         smb_sid_t       *wka_binsid;
 845 } smb_wka_t;
 846
 847 /*
 848  * Defined values for smb_wka.wka_flags
 849  *
 850  * SMB_WKAFLG_LGRP_ENABLE               Can be added as local group
 851  */
 852 #define SMB_WKAFLG_LGRP_ENABLE  0x1
 853
 854 /*
 855  * Well-known account interfaces
 856  */
 857 smb_wka_t *smb_wka_lookup_builtin(const char *);
 858 smb_wka_t *smb_wka_lookup_name(const char *);
 859 smb_wka_t *smb_wka_lookup_sid(smb_sid_t *);
 860 smb_sid_t *smb_wka_get_sid(const char *);
 861 char *smb_wka_get_domain(int);
 862 uint32_t smb_wka_token_groups(uint32_t, smb_ids_t *);
 863
 864 /*
 865  * In memory account representation
 866  */
 867 typedef struct smb_account {
 868         char            *a_name;
 869         char            *a_domain;
 870         uint16_t        a_type;
 871         smb_sid_t       *a_sid;
 872         smb_sid_t       *a_domsid;
 873         uint32_t        a_rid;
 874 } smb_account_t;
 875
 876 uint32_t smb_sam_lookup_name(char *, char *, uint16_t, smb_account_t *);
 877 uint32_t smb_sam_lookup_sid(smb_sid_t *, smb_account_t *);
 878 int smb_sam_usr_cnt(void);
 879 uint32_t smb_sam_usr_groups(smb_sid_t *, smb_ids_t *);
 880 int smb_sam_grp_cnt(smb_domain_type_t);
 881 void smb_account_free(smb_account_t *);
 882 boolean_t smb_account_validate(smb_account_t *);
 883
 884 /*
 885  * Security Descriptor functions.
 886  */
 887 uint32_t smb_sd_read(char *path, smb_sd_t *, uint32_t);
 888 uint32_t smb_sd_write(char *path, smb_sd_t *, uint32_t);
 889 uint32_t smb_sd_fromfs(smb_fssd_t *, smb_sd_t *);
 890
 891 /* Kernel Module Interface */
 892 int smb_kmod_bind(void);
 893 boolean_t smb_kmod_isbound(void);
 894 int smb_kmod_setcfg(smb_kmod_cfg_t *);
 895 int smb_kmod_setgmtoff(int32_t);
 896 int smb_kmod_start(int, int, int);
 897 void smb_kmod_stop(void);
 898 int smb_kmod_event_notify(uint32_t);
 899 void smb_kmod_unbind(void);
 900 int smb_kmod_share(nvlist_t *);
 901 int smb_kmod_unshare(nvlist_t *);
 902 int smb_kmod_shareinfo(char *, boolean_t *);
 903 int smb_kmod_get_open_num(smb_opennum_t *);
 904 int smb_kmod_enum(smb_netsvc_t *);
 905 smb_netsvc_t *smb_kmod_enum_init(smb_svcenum_t *);
 906 void smb_kmod_enum_fini(smb_netsvc_t *);
 907 int smb_kmod_session_close(const char *, const char *);
 908 int smb_kmod_file_close(uint32_t);
 909 int smb_kmod_get_spool_doc(uint32_t *, char *, char *, smb_inaddr_t *);
 910
 911 void smb_name_parse(char *, char **, char **);
 912 uint32_t smb_name_validate_share(const char *);
 913 uint32_t smb_name_validate_account(const char *);
 914 uint32_t smb_name_validate_domain(const char *);
 915 uint32_t smb_name_validate_nbdomain(const char *);
 916 uint32_t smb_name_validate_workgroup(const char *);
 917 uint32_t smb_name_validate_rpath(const char *);
 918
 919 /*
 920  * Interposer library validation
 921  */
 922 #define SMBEX_VERSION   1
 923 #define SMBEX_KEY       "82273fdc-e32a-18c3-3f78-827929dc23ea"
 924 typedef struct smbex_version {
 925         uint32_t v_version;
 926         uuid_t v_uuid;
 927 } smbex_version_t;
 928 void *smb_dlopen(void);
 929 void smb_dlclose(void *);
 930
 931 /*
 932  * General purpose multi-thread safe cache based on
 933  * AVL tree
 934  */
 935 typedef struct smb_cache {
 936         avl_tree_t      ch_cache;
 937         rwlock_t        ch_cache_lck;
 938         uint32_t        ch_state;
 939         uint32_t        ch_nops;
 940         uint32_t        ch_wait;
 941         uint32_t        ch_sequence;
 942         size_t          ch_datasz;
 943         mutex_t         ch_mtx;
 944         cond_t          ch_cv;
 945         void            (*ch_free)(void *);
 946         void            (*ch_copy)(const void *, void *, size_t);
 947 } smb_cache_t;
 948
 949 typedef struct smb_cache_node {
 950         avl_node_t      cn_link;
 951         void            *cn_data;
 952 } smb_cache_node_t;
 953
 954 typedef struct smb_cache_cursor {
 955         void            *cc_next;
 956         uint32_t        cc_sequence;
 957 } smb_cache_cursor_t;
 958
 959 /*
 960  * flags used with smb_cache_add()
 961  *
 962  * SMB_CACHE_ADD        If object doesn't exist add, otherwise fail
 963  * SMB_CACHE_REPLACE    If object doesn't exist add, otherwise replace
 964  */
 965 #define SMB_CACHE_ADD           1
 966 #define SMB_CACHE_REPLACE       2
 967
 968 void smb_cache_create(smb_cache_t *, uint32_t,
 969     int (*cmpfn) (const void *, const void *), void (*freefn)(void *),
 970     void (*copyfn)(const void *, void *, size_t), size_t);
 971 void smb_cache_destroy(smb_cache_t *);
 972 void smb_cache_flush(smb_cache_t *);
 973 uint32_t smb_cache_num(smb_cache_t *);
 974 int smb_cache_refreshing(smb_cache_t *);
 975 void smb_cache_ready(smb_cache_t *);
 976 int smb_cache_add(smb_cache_t *, const void *, int);
 977 void smb_cache_remove(smb_cache_t *, const void *);
 978 void smb_cache_iterinit(smb_cache_t *, smb_cache_cursor_t *);
 979 boolean_t smb_cache_iterate(smb_cache_t *, smb_cache_cursor_t *, void *);
 980
 981 /*
 982  * Values returned by smb_reparse_stat()
 983  */
 984 #define SMB_REPARSE_NOTFOUND    1       /* object does not exist */
 985 #define SMB_REPARSE_NOTREPARSE  2       /* object is NOT a reparse point */
 986 #define SMB_REPARSE_ISREPARSE   3       /* object is a reparse point */
 987
 988 /*
 989  * Reparse Point API
 990  */
 991 int smb_reparse_stat(const char *, uint32_t *);
 992 int smb_reparse_svcadd(const char *, const char *, const char *);
 993 int smb_reparse_svcdel(const char *, const char *);
 994 int smb_reparse_svcget(const char *, const char *, char **);
 995
 996 uint32_t smb_get_txid(void);
 997
 998 #define SMB_LOG_LINE_SZ         256
 999
1000 typedef uint32_t        smb_log_hdl_t;
1001
1002 typedef struct smb_log_item {
1003         list_node_t     li_lnd;
1004         char            li_msg[SMB_LOG_LINE_SZ];
1005 } smb_log_item_t;
1006
1007 typedef struct smb_log {
1008         smb_log_hdl_t   l_handle;
1009         int             l_cnt;
1010         int             l_max_cnt;
1011         mutex_t         l_mtx;
1012         list_t          l_list;
1013         char            l_file[MAXPATHLEN];
1014 } smb_log_t;
1015
1016 typedef struct smb_loglist_item {
1017         list_node_t     lli_lnd;
1018         smb_log_t       lli_log;
1019 } smb_loglist_item_t;
1020
1021 typedef struct smb_loglist {
1022         mutex_t         ll_mtx;
1023         list_t          ll_list;
1024 } smb_loglist_t;
1025
1026 smb_log_hdl_t smb_log_create(int, char *);
1027 void smb_log(smb_log_hdl_t, int, const char *, ...);
1028 void smb_log_dumpall(void);
1029
1030 #ifdef  __cplusplus
1031 }
1032 #endif
1033
1034 #endif  /* _LIBSMB_H */