2 Unix SMB/CIFS implementation.
3 SMB parameters and setup
5 Copyright (C) Andrew Tridgell 2002-2004
6 Copyright (C) James Myers 2003 <myersjj@samba.org>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef __LIBCLI_RAW_H__
23 #define __LIBCLI_RAW_H__
25 #include "libcli/raw/request.h"
26 #include "librpc/gen_ndr/nbt.h"
28 struct smbcli_tree; /* forward declare */
29 struct smbcli_request; /* forward declare */
30 struct smbcli_session; /* forward declare */
31 struct smbcli_transport; /* forward declare */
33 struct resolve_context;
34 struct cli_credentials;
36 /* default timeout for all smb requests */
37 #define SMB_REQUEST_TIMEOUT 60
39 /* context that will be and has been negotiated between the client and server */
40 struct smbcli_negotiate {
42 * negotiated maximum transmit size - this is given to us by the server
46 /* maximum number of requests that can be multiplexed */
49 /* the negotiatiated protocol */
50 enum protocol_types protocol;
52 uint8_t sec_mode; /* security mode returned by negprot */
54 DATA_BLOB server_guid; /* server_guid */
55 DATA_BLOB secblob; /* cryptkey or negTokenInit blob */
58 struct smb_signing_context sign_info;
60 /* capabilities that the server reported */
61 uint32_t capabilities;
65 uint_t readbraw_supported:1;
66 uint_t writebraw_supported:1;
71 /* this is the context for a SMB socket associated with the socket itself */
72 struct smbcli_socket {
73 struct socket_context *sock;
75 /* what port we ended up connected to */
78 /* the hostname we connected to */
81 /* the event handle for waiting for socket IO */
83 struct event_context *ctx;
85 struct timed_event *te;
90 this structure allows applications to control the behaviour of the
93 struct smbcli_options {
95 uint_t use_level2_oplocks:1;
98 uint_t ntstatus_support:1;
103 enum smb_signing_state signing;
106 /* this is the context for the client transport layer */
107 struct smbcli_transport {
108 /* socket level info */
109 struct smbcli_socket *socket;
111 /* the next mid to be allocated - needed for signing and
115 /* negotiated protocol information */
116 struct smbcli_negotiate negotiate;
118 /* options to control the behaviour of the client code */
119 struct smbcli_options options;
121 /* is a readbraw pending? we need to handle that case
122 specially on receiving packets */
123 uint_t readbraw_pending:1;
125 /* an idle function - if this is defined then it will be
126 called once every period microseconds while we are waiting
129 void (*func)(struct smbcli_transport *, void *);
134 /* the error fields from the last message */
136 enum {ETYPE_NONE, ETYPE_SMB, ETYPE_SOCKET, ETYPE_NBT} etype;
139 enum {SOCKET_READ_TIMEOUT,
143 SOCKET_READ_BAD_SIG} socket_error;
149 /* a oplock break request handler */
150 bool (*handler)(struct smbcli_transport *transport,
151 uint16_t tid, uint16_t fnum, uint8_t level, void *private);
152 /* private data passed to the oplock handler */
156 /* a list of async requests that are pending for receive on this connection */
157 struct smbcli_request *pending_recv;
159 /* remember the called name - some sub-protocols require us to
160 know the server name */
161 struct nbt_name called;
163 /* context of the stream -> packet parser */
164 struct packet_context *packet;
167 /* this is the context for the user */
169 /* this is the context for the session layer */
170 struct smbcli_session {
171 /* transport layer info */
172 struct smbcli_transport *transport;
174 /* after a session setup the server provides us with
175 a vuid identifying the security context */
178 /* default pid for this session */
181 /* the flags2 for each packet - this allows
182 the user to control these for torture testing */
185 DATA_BLOB user_session_key;
187 /* the spnego context if we use extented security */
188 struct gensec_security *gensec;
192 smbcli_tree context: internal state for a tree connection.
195 /* session layer info */
196 struct smbcli_session *session;
198 uint16_t tid; /* tree id, aka cnum */
205 a client request moves between the following 4 states.
207 enum smbcli_request_state {SMBCLI_REQUEST_INIT, /* we are creating the request */
208 SMBCLI_REQUEST_RECV, /* we are waiting for a matching reply */
209 SMBCLI_REQUEST_DONE, /* the request is finished */
210 SMBCLI_REQUEST_ERROR}; /* a packet or transport level error has occurred */
212 /* the context for a single SMB request. This is passed to any request-context
213 * functions (similar to context.h, the server version).
214 * This will allow requests to be multi-threaded. */
215 struct smbcli_request {
216 /* allow a request to be part of a list of requests */
217 struct smbcli_request *next, *prev;
219 /* each request is in one of 4 possible states */
220 enum smbcli_request_state state;
222 /* a request always has a transport context, nearly always has
223 a session context and usually has a tree context */
224 struct smbcli_transport *transport;
225 struct smbcli_session *session;
226 struct smbcli_tree *tree;
228 /* the flags2 from the SMB request, in raw form (host byte
229 order). Used to parse strings */
232 /* the NT status for this request. Set by packet receive code
233 or code detecting error. */
236 /* the sequence number of this packet - used for signing */
239 /* list of ntcancel request for this requests */
240 struct smbcli_request *ntcancel;
242 /* set if this is a one-way request, meaning we are not
243 expecting a reply from the server. */
244 uint_t one_way_request:1;
246 /* set this when the request should only increment the signing
248 uint_t sign_single_increment:1;
250 /* the mid of this packet - used to match replies */
253 struct smb_request_buffer in;
254 struct smb_request_buffer out;
256 /* information on what to do with a reply when it is received
257 asyncronously. If this is not setup when a reply is received then
258 the reply is discarded
260 The private pointer is private to the caller of the client
261 library (the application), not private to the library
264 void (*fn)(struct smbcli_request *);
269 /* useful way of catching wct errors with file and line number */
270 #define SMBCLI_CHECK_MIN_WCT(req, wcount) if ((req)->in.wct < (wcount)) { \
271 DEBUG(1,("Unexpected WCT %d at %s(%d) - expected min %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
272 req->status = NT_STATUS_INVALID_PARAMETER; \
276 #define SMBCLI_CHECK_WCT(req, wcount) if ((req)->in.wct != (wcount)) { \
277 DEBUG(1,("Unexpected WCT %d at %s(%d) - expected %d\n", (req)->in.wct, __FILE__, __LINE__, wcount)); \
278 req->status = NT_STATUS_INVALID_PARAMETER; \
282 #include "libcli/raw/interfaces.h"
283 #include "libcli/raw/raw_proto.h"
285 #endif /* __LIBCLI_RAW__H__ */