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 struct GUID;
  27
  28 struct smbXcli_conn *smbXcli_conn_create(TALLOC_CTX *mem_ctx,
  29                                          int fd,
  30                                          const char *remote_name,
  31                                          enum smb_signing_setting signing_state,
  32                                          uint32_t smb1_capabilities,
  33                                          struct GUID *client_guid);
  34
  35 bool smbXcli_conn_is_connected(struct smbXcli_conn *conn);
  36 void smbXcli_conn_disconnect(struct smbXcli_conn *conn, NTSTATUS status);
  37
  38 bool smbXcli_conn_has_async_calls(struct smbXcli_conn *conn);
  39
  40 enum protocol_types smbXcli_conn_protocol(struct smbXcli_conn *conn);
  41 bool smbXcli_conn_use_unicode(struct smbXcli_conn *conn);
  42
  43 void smbXcli_conn_set_sockopt(struct smbXcli_conn *conn, const char *options);
  44 const struct sockaddr_storage *smbXcli_conn_local_sockaddr(struct smbXcli_conn *conn);
  45 const struct sockaddr_storage *smbXcli_conn_remote_sockaddr(struct smbXcli_conn *conn);
  46 const char *smbXcli_conn_remote_name(struct smbXcli_conn *conn);
  47
  48 uint16_t smbXcli_conn_max_requests(struct smbXcli_conn *conn);
  49 NTTIME smbXcli_conn_server_system_time(struct smbXcli_conn *conn);
  50 const DATA_BLOB *smbXcli_conn_server_gss_blob(struct smbXcli_conn *conn);
  51 const struct GUID *smbXcli_conn_server_guid(struct smbXcli_conn *conn);
  52
  53 void smbXcli_req_unset_pending(struct tevent_req *req);
  54 bool smbXcli_req_set_pending(struct tevent_req *req);
  55
  56 uint32_t smb1cli_conn_capabilities(struct smbXcli_conn *conn);
  57 uint32_t smb1cli_conn_max_xmit(struct smbXcli_conn *conn);
  58 uint32_t smb1cli_conn_server_session_key(struct smbXcli_conn *conn);
  59 const uint8_t *smb1cli_conn_server_challenge(struct smbXcli_conn *conn);
  60 uint16_t smb1cli_conn_server_security_mode(struct smbXcli_conn *conn);
  61 int smb1cli_conn_server_time_zone(struct smbXcli_conn *conn);
  62
  63 bool smb1cli_conn_activate_signing(struct smbXcli_conn *conn,
  64                                    const DATA_BLOB user_session_key,
  65                                    const DATA_BLOB response);
  66 bool smb1cli_conn_check_signing(struct smbXcli_conn *conn,
  67                                 const uint8_t *buf, uint32_t seqnum);
  68 bool smb1cli_conn_signing_is_active(struct smbXcli_conn *conn);
  69
  70 void smb1cli_conn_set_encryption(struct smbXcli_conn *conn,
  71                                  struct smb_trans_enc_state *es);
  72 bool smb1cli_conn_encryption_on(struct smbXcli_conn *conn);
  73
  74 bool smb1cli_is_andx_req(uint8_t cmd);
  75 size_t smb1cli_req_wct_ofs(struct tevent_req **reqs, int num_reqs);
  76
  77 uint16_t smb1cli_req_mid(struct tevent_req *req);
  78 void smb1cli_req_set_mid(struct tevent_req *req, uint16_t mid);
  79
  80 uint32_t smb1cli_req_seqnum(struct tevent_req *req);
  81 void smb1cli_req_set_seqnum(struct tevent_req *req, uint32_t seqnum);
  82
  83 struct smb1cli_req_expected_response {
  84         NTSTATUS status;
  85         uint8_t wct;
  86 };
  87
  88 struct tevent_req *smb1cli_req_create(TALLOC_CTX *mem_ctx,
  89                                       struct tevent_context *ev,
  90                                       struct smbXcli_conn *conn,
  91                                       uint8_t smb_command,
  92                                       uint8_t additional_flags,
  93                                       uint8_t clear_flags,
  94                                       uint16_t additional_flags2,
  95                                       uint16_t clear_flags2,
  96                                       uint32_t timeout_msec,
  97                                       uint32_t pid,
  98                                       uint16_t tid,
  99                                       uint16_t uid,
 100                                       uint8_t wct, uint16_t *vwv,
 101                                       int iov_count,
 102                                       struct iovec *bytes_iov);
 103 NTSTATUS smb1cli_req_chain_submit(struct tevent_req **reqs, int num_reqs);
 104
 105 struct tevent_req *smb1cli_req_send(TALLOC_CTX *mem_ctx,
 106                                     struct tevent_context *ev,
 107                                     struct smbXcli_conn *conn,
 108                                     uint8_t smb_command,
 109                                     uint8_t additional_flags,
 110                                     uint8_t clear_flags,
 111                                     uint16_t additional_flags2,
 112                                     uint16_t clear_flags2,
 113                                     uint32_t timeout_msec,
 114                                     uint32_t pid,
 115                                     uint16_t tid,
 116                                     uint16_t uid,
 117                                     uint8_t wct, uint16_t *vwv,
 118                                     uint32_t num_bytes,
 119                                     const uint8_t *bytes);
 120 NTSTATUS smb1cli_req_recv(struct tevent_req *req,
 121                           TALLOC_CTX *mem_ctx,
 122                           struct iovec **piov,
 123                           uint8_t **phdr,
 124                           uint8_t *pwct,
 125                           uint16_t **pvwv,
 126                           uint32_t *pvwv_offset,
 127                           uint32_t *pnum_bytes,
 128                           uint8_t **pbytes,
 129                           uint32_t *pbytes_offset,
 130                           uint8_t **pinbuf,
 131                           const struct smb1cli_req_expected_response *expected,
 132                           size_t num_expected);
 133
 134 uint32_t smb2cli_conn_server_capabilities(struct smbXcli_conn *conn);
 135 uint16_t smb2cli_conn_server_security_mode(struct smbXcli_conn *conn);
 136 uint32_t smb2cli_conn_max_trans_size(struct smbXcli_conn *conn);
 137 uint32_t smb2cli_conn_max_read_size(struct smbXcli_conn *conn);
 138 uint32_t smb2cli_conn_max_write_size(struct smbXcli_conn *conn);
 139
 140 struct tevent_req *smb2cli_req_create(TALLOC_CTX *mem_ctx,
 141                                       struct tevent_context *ev,
 142                                       struct smbXcli_conn *conn,
 143                                       uint16_t cmd,
 144                                       uint32_t additional_flags,
 145                                       uint32_t clear_flags,
 146                                       uint32_t timeout_msec,
 147                                       uint32_t pid,
 148                                       uint32_t tid,
 149                                       uint64_t uid,
 150                                       const uint8_t *fixed,
 151                                       uint16_t fixed_len,
 152                                       const uint8_t *dyn,
 153                                       uint32_t dyn_len);
 154 NTSTATUS smb2cli_req_compound_submit(struct tevent_req **reqs,
 155                                      int num_reqs);
 156
 157 struct smb2cli_req_expected_response {
 158         NTSTATUS status;
 159         uint16_t body_size;
 160 };
 161
 162 struct tevent_req *smb2cli_req_send(TALLOC_CTX *mem_ctx,
 163                                     struct tevent_context *ev,
 164                                     struct smbXcli_conn *conn,
 165                                     uint16_t cmd,
 166                                     uint32_t additional_flags,
 167                                     uint32_t clear_flags,
 168                                     uint32_t timeout_msec,
 169                                     uint32_t pid,
 170                                     uint32_t tid,
 171                                     uint64_t uid,
 172                                     const uint8_t *fixed,
 173                                     uint16_t fixed_len,
 174                                     const uint8_t *dyn,
 175                                     uint32_t dyn_len);
 176 NTSTATUS smb2cli_req_recv(struct tevent_req *req, TALLOC_CTX *mem_ctx,
 177                           struct iovec **piov,
 178                           const struct smb2cli_req_expected_response *expected,
 179                           size_t num_expected);
 180
 181 struct tevent_req *smbXcli_negprot_send(TALLOC_CTX *mem_ctx,
 182                                         struct tevent_context *ev,
 183                                         struct smbXcli_conn *conn,
 184                                         uint32_t timeout_msec,
 185                                         enum protocol_types min_protocol,
 186                                         enum protocol_types max_protocol);
 187 NTSTATUS smbXcli_negprot_recv(struct tevent_req *req);
 188 NTSTATUS smbXcli_negprot(struct smbXcli_conn *conn,
 189                          uint32_t timeout_msec,
 190                          enum protocol_types min_protocol,
 191                          enum protocol_types max_protocol);
 192
 193 #endif /* _SMBXCLI_BASE_H_ */