root/usr/src/uts/common/smbsrv/smb2_kproto.h
/*
 * This file and its contents are supplied under the terms of the
 * Common Development and Distribution License ("CDDL"), version 1.0.
 * You may only use this file in accordance with the terms of version
 * 1.0 of the CDDL.
 *
 * A full copy of the text of the CDDL should have accompanied this
 * source.  A copy of the CDDL is also available via the Internet at
 * http://www.illumos.org/license/CDDL.
 */

/*
 * Copyright 2014-2021 Tintri by DDN, Inc. All rights reserved.
 * Copyright 2020-2024 RackTop Systems, Inc.
 */

#ifndef _SMB2_KPROTO_H_
#define _SMB2_KPROTO_H_

#include <smbsrv/smb_kproto.h>
#include <smbsrv/smb2.h>

#ifdef  __cplusplus
extern "C" {
#endif

extern uint32_t smb2_tcp_rcvbuf;
extern uint32_t smb2_max_rwsize;
extern uint32_t smb2_max_trans;

extern int smb2_aapl_use_file_ids;
extern uint32_t smb2_dh_def_timeout;
extern uint32_t smb2_dh_max_timeout;
extern uint32_t smb2_res_def_timeout;
extern uint32_t smb2_res_max_timeout;
extern uint32_t smb2_persist_timeout;
extern int smb2_enable_dh;

#define SMB3_CLIENT_ENCRYPTS(sr) \
        ((sr->session->capabilities & SMB2_CAP_ENCRYPTION) != 0)

void    smb2_dispatch_stats_init(smb_server_t *);
void    smb2_dispatch_stats_fini(smb_server_t *);
void    smb2_dispatch_stats_update(smb_server_t *,
                smb_kstat_req_t *, int, int);
void    smb2_record_stats(smb_request_t *, smb_disp_stats_t *, boolean_t);

int     smb2sr_newrq(smb_request_t *);
void    smb2sr_work(smb_request_t *);
uint32_t smb2sr_go_async(smb_request_t *);
uint32_t smb2sr_go_async_indefinite(smb_request_t *);
void smb2sr_append_postwork(smb_request_t *, smb_request_t *);

int smb2_decode_header(smb_request_t *);
int smb2_encode_header(smb_request_t *, boolean_t);

void smb2_send_reply(smb_request_t *);
void smb2sr_put_error(smb_request_t *, uint32_t);
void smb2sr_put_error_data(smb_request_t *, uint32_t, mbuf_chain_t *);
void smb2sr_put_error_ctx(smb_request_t *, uint32_t, uint32_t, mbuf_chain_t *);
void smb2sr_put_error_ctx0(smb_request_t *, uint32_t, mbuf_chain_t *);
void smb2sr_put_errno(struct smb_request *, int);
uint32_t smb2sr_lookup_fid(smb_request_t *, smb2fid_t *);

/* SMB2 signing routines - smb2_signing.c */
int smb2_sign_check_request(smb_request_t *);
void smb2_sign_reply(smb_request_t *);
void smb2_sign_init_mech(smb_session_t *);
void smb31_preauth_init_mech(smb_session_t *);
void smb31_preauth_fini(smb_session_t *s);
int smb31_preauth_sha512_calc(smb_request_t *, struct mbuf_chain *,
    uint8_t *, uint8_t *);

int smb3_encrypt_sr(smb_request_t *, struct mbuf_chain *, struct mbuf_chain *);
int smb3_decrypt_sr(smb_request_t *, struct mbuf_chain *, struct mbuf_chain *);
int smb3_encrypt_init_mech(smb_session_t *s);

uint32_t smb2_fsctl_fs(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_netfs(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_copychunk(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_odx_read(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_odx_write(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_set_resilient(smb_request_t *, smb_fsctl_t *);

/* smb2_fsctl_sparse.c */
uint32_t smb2_fsctl_set_sparse(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_set_zero_data(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_query_alloc_ranges(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_fsctl_query_file_regions(smb_request_t *, smb_fsctl_t *);
uint32_t smb2_sparse_copy(smb_request_t *sr,
    smb_ofile_t *src_ofile, smb_ofile_t *dst_ofile,
    off64_t src_off, off64_t dst_off, uint32_t *residp,
    void *buffer, size_t bufsize);

uint32_t smb2_nego_validate(smb_request_t *, smb_fsctl_t *);

smb_sdrc_t smb2_negotiate(smb_request_t *);
smb_sdrc_t smb2_session_setup(smb_request_t *);
smb_sdrc_t smb2_logoff(smb_request_t *);
smb_sdrc_t smb2_tree_connect(smb_request_t *);
smb_sdrc_t smb2_tree_disconn(smb_request_t *);
smb_sdrc_t smb2_create(smb_request_t *);
smb_sdrc_t smb2_close(smb_request_t *);
smb_sdrc_t smb2_flush(smb_request_t *);
smb_sdrc_t smb2_read(smb_request_t *);
smb_sdrc_t smb2_write(smb_request_t *);
smb_sdrc_t smb2_lock(smb_request_t *);
smb_sdrc_t smb2_ioctl(smb_request_t *);
smb_sdrc_t smb2_cancel(smb_request_t *);
smb_sdrc_t smb2_echo(smb_request_t *);
smb_sdrc_t smb2_query_dir(smb_request_t *);
smb_sdrc_t smb2_change_notify(smb_request_t *);
smb_sdrc_t smb2_query_info(smb_request_t *);
smb_sdrc_t smb2_set_info(smb_request_t *);
smb_sdrc_t smb2_oplock_break_ack(smb_request_t *);
smb_sdrc_t smb2_lease_break_ack(smb_request_t *);

int smb2_newrq_negotiate(smb_request_t *);
int smb2_newrq_cancel(smb_request_t *);

uint32_t smb2_aapl_crctx(smb_request_t *,
        mbuf_chain_t *, mbuf_chain_t *);

uint32_t smb2_ofile_getattr(smb_request_t *, smb_ofile_t *, smb_attr_t *);
uint32_t smb2_ofile_getstd(smb_ofile_t *, smb_queryinfo_t *);
uint32_t smb2_ofile_getname(smb_ofile_t *, smb_queryinfo_t *);

uint32_t smb2_qinfo_file(smb_request_t *, smb_queryinfo_t *);
uint32_t smb2_qinfo_fs(smb_request_t *, smb_queryinfo_t *);
uint32_t smb2_qinfo_sec(smb_request_t *, smb_queryinfo_t *);
uint32_t smb2_qinfo_quota(smb_request_t *, smb_queryinfo_t *);
uint32_t smb2_qinfo_stream(smb_request_t *, smb_queryinfo_t *);

uint32_t smb2_setinfo_file(smb_request_t *, smb_setinfo_t *, int);
uint32_t smb2_setinfo_fs(smb_request_t *, smb_setinfo_t *, int);
uint32_t smb2_setinfo_sec(smb_request_t *, smb_setinfo_t *, uint32_t);
uint32_t smb2_setinfo_quota(smb_request_t *, smb_setinfo_t *);

void smb2_oplock_acquire(smb_request_t *sr);
void smb2_oplock_reconnect(smb_request_t *sr);
void smb2_lease_acquire(smb_request_t *sr);
uint32_t smb2_lease_create(smb_request_t *sr, uint8_t *);
void smb2_lease_rele(smb_lease_t *);
void smb2_lease_init(void);
void smb2_lease_fini(void);
void smb2_lease_ofile_close(smb_ofile_t *);

void smb2_durable_timers(smb_server_t *);

uint32_t smb2_dh_reconnect(smb_request_t *);
boolean_t smb_dh_should_save(smb_ofile_t *);
extern void smb2_dh_shutdown(smb_server_t *);
int smb2_dh_new_ca_share(smb_server_t *, smb_kshare_t *);
void smb2_dh_close_persistent(smb_ofile_t *);
void smb2_dh_close_my_orphans(smb_request_t *, smb_ofile_t *);
boolean_t smb_dh_create_allowed(smb_request_t *, smb_ofile_t *);
int smb2_dh_make_persistent(smb_request_t *, smb_ofile_t *);
void smb2_dh_setdoc_persistent(smb_ofile_t *);
void smb2_dh_update_nvfile(smb_request_t *);
void smb2_dh_update_oplock(smb_request_t *, smb_ofile_t *);
void smb2_dh_update_locks(smb_request_t *, smb_ofile_t *);
void smb2_dh_update_times(smb_request_t *, smb_ofile_t *, smb_attr_t *);

#ifdef  __cplusplus
}
#endif

#endif /* _SMB2_KPROTO_H_ */