libcli/smb/smbXcli_base.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Infrastructure for async SMB client requests
   4    Copyright (C) Volker Lendecke 2008
   5    Copyright (C) Stefan Metzmacher 2011
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef _SMBXCLI_BASE_H_
  22 #define _SMBXCLI_BASE_H_
  23
  24 struct smbXcli_conn;
  25 struct smb_trans_enc_state;
  26
  27 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
  28                                          int fd,
  29                                          const char *remote_name,
  30                                          enum smb_signing_setting signing_state,
  31                                          uint32_t smb1_capabilities);
  32
  33 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
  34 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
  35
  36 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
  37
  38 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
  39 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
  40
  41 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
  42 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
  43 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
  44 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
  45
  46 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
  47 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
  48 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
  49 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
  50
  51 void smbXcli_req_unset_pending(struct tevent_req *req);
  52 bool smbXcli_req_set_pending(struct tevent_req *req);
  53
  54 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
  55 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
  56 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
  57 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
  58 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
  59 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
  60
  61 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
  62                                    const DATA_BLOB user_session_key,
  63                                    const DATA_BLOB response);
  64 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
  65                                 const uint8_t *buf, uint32_t seqnum);
  66 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
  67
  68 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
  69                                  struct smb_trans_enc_state *es);
  70 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
  71
  72 bool smb1cli_is_andx_req(uint8_t cmd);
  73 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
  74
  75 uint16_t smb1cli_req_mid(struct tevent_req *req);
  76 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
  77
  78 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
  79 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
  80
  81 struct smb1cli_req_expected_response {
  82         NTSTATUS status;
  83         uint8_t wct;
  84 };
  85
  86 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
  87                                       struct tevent_context *ev,
  88                                       struct smbXcli_conn *conn,
  89                                       uint8_t smb_command,
  90                                       uint8_t additional_flags,
  91                                       uint8_t clear_flags,
  92                                       uint16_t additional_flags2,
  93                                       uint16_t clear_flags2,
  94                                       uint32_t timeout_msec,
  95                                       uint32_t pid,
  96                                       uint16_t tid,
  97                                       uint16_t uid,
  98                                       uint8_t wct, uint16_t *vwv,
  99                                       int iov_count,
 100                                       struct iovec *bytes_iov);
 101 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
 102
 103 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
 104                                     struct tevent_context *ev,
 105                                     struct smbXcli_conn *conn,
 106                                     uint8_t smb_command,
 107                                     uint8_t additional_flags,
 108                                     uint8_t clear_flags,
 109                                     uint16_t additional_flags2,
 110                                     uint16_t clear_flags2,
 111                                     uint32_t timeout_msec,
 112                                     uint32_t pid,
 113                                     uint16_t tid,
 114                                     uint16_t uid,
 115                                     uint8_t wct, uint16_t *vwv,
 116                                     uint32_t num_bytes,
 117                                     const uint8_t *bytes);
 118 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
 119                           TALLOC_CTX *mem_ctx,
 120                           struct iovec **piov,
 121                           uint8_t **phdr,
 122                           uint8_t *pwct,
 123                           uint16_t **pvwv,
 124                           uint32_t *pvwv_offset,
 125                           uint32_t *pnum_bytes,
 126                           uint8_t **pbytes,
 127                           uint32_t *pbytes_offset,
 128                           uint8_t **pinbuf,
 129                           const struct smb1cli_req_expected_response *expected,
 130                           size_t num_expected);
 131
 132 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
 133 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
 134 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
 135 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
 136 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
 137
 138 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
 139                                       struct tevent_context *ev,
 140                                       struct smbXcli_conn *conn,
 141                                       uint16_t cmd,
 142                                       uint32_t additional_flags,
 143                                       uint32_t clear_flags,
 144                                       uint32_t timeout_msec,
 145                                       uint32_t pid,
 146                                       uint32_t tid,
 147                                       uint64_t uid,
 148                                       const uint8_t *fixed,
 149                                       uint16_t fixed_len,
 150                                       const uint8_t *dyn,
 151                                       uint32_t dyn_len);
 152 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
 153                                      int num_reqs);
 154
 155 struct smb2cli_req_expected_response {
 156         NTSTATUS status;
 157         uint16_t body_size;
 158 };
 159
 160 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
 161                                     struct tevent_context *ev,
 162                                     struct smbXcli_conn *conn,
 163                                     uint16_t cmd,
 164                                     uint32_t additional_flags,
 165                                     uint32_t clear_flags,
 166                                     uint32_t timeout_msec,
 167                                     uint32_t pid,
 168                                     uint32_t tid,
 169                                     uint64_t uid,
 170                                     const uint8_t *fixed,
 171                                     uint16_t fixed_len,
 172                                     const uint8_t *dyn,
 173                                     uint32_t dyn_len);
 174 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 175                           struct iovec **piov,
 176                           const struct smb2cli_req_expected_response *expected,
 177                           size_t num_expected);
 178
 179 #endif /* _SMBXCLI_BASE_H_ */