2 Unix SMB/CIFS implementation.
4 SMB client socket context management functions
6 Copyright (C) Andrew Tridgell 1994-2005
7 Copyright (C) James Myers 2003 <myersjj@samba.org>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "libcli/raw/libcliraw.h"
27 #include "libcli/composite/composite.h"
30 this private structure is used during async connection handling
32 struct clisocket_connect {
35 struct smbcli_socket *sock;
36 const char *dest_host;
41 create a smbcli_socket context
42 The event_ctx is optional - if not supplied one will be created
44 struct smbcli_socket *smbcli_sock_init(TALLOC_CTX *mem_ctx,
45 struct event_context *event_ctx)
47 struct smbcli_socket *sock;
49 sock = talloc_zero(mem_ctx, struct smbcli_socket);
55 sock->event.ctx = talloc_reference(sock, event_ctx);
57 sock->event.ctx = event_context_init(sock);
59 if (sock->event.ctx == NULL) {
67 static NTSTATUS smbcli_sock_connect_one(struct smbcli_socket *sock,
68 const char *hostaddr, int port);
71 handle socket write events during an async connect. These happen when the OS
72 has either completed the connect() or has returned an error
74 static void smbcli_sock_connect_handler(struct event_context *ev, struct fd_event *fde,
75 struct timeval t, uint16_t flags)
77 struct smbcli_composite *c = talloc_get_type(fde->private, struct smbcli_composite);
78 struct clisocket_connect *conn = talloc_get_type(c->private, struct clisocket_connect);
81 c->status = socket_connect_complete(conn->sock->sock, 0);
82 if (NT_STATUS_IS_OK(c->status)) {
83 socket_set_option(conn->sock->sock, lp_socket_options(), NULL);
84 conn->sock->hostname = talloc_strdup(conn->sock, conn->dest_host);
85 c->state = SMBCLI_REQUEST_DONE;
92 /* that port failed - try the next port */
93 for (i=conn->port_num+1;conn->iports[i];i++) {
95 c->status = smbcli_sock_connect_one(conn->sock,
98 if (NT_STATUS_IS_OK(c->status) ||
99 NT_STATUS_EQUAL(c->status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
100 conn->sock->event.fde->private = c;
105 c->state = SMBCLI_REQUEST_ERROR;
113 try to connect to the given address/port
115 static NTSTATUS smbcli_sock_connect_one(struct smbcli_socket *sock,
116 const char *hostaddr, int port)
122 talloc_free(sock->sock);
125 talloc_free(sock->event.fde);
127 status = socket_create("ip", SOCKET_TYPE_STREAM, &sock->sock, 0);
128 if (!NT_STATUS_IS_OK(status)) {
132 talloc_steal(sock, sock->sock);
134 /* we initially look for write - see the man page on
135 non-blocking connect */
136 fde.fd = socket_get_fd(sock->sock);
137 fde.flags = EVENT_FD_WRITE;
138 fde.handler = smbcli_sock_connect_handler;
141 sock->event.fde = event_add_fd(sock->event.ctx, &fde);
142 talloc_steal(sock, sock->event.fde);
145 set_blocking(fde.fd, False);
147 return socket_connect(sock->sock, NULL, 0, hostaddr, port, 0);
152 connect a smbcli_socket context to an IP/port pair
153 if port is 0 then choose 445 then 139
155 this is the async send side of the interface
157 struct smbcli_composite *smbcli_sock_connect_send(struct smbcli_socket *sock,
158 const char *host_addr, int port)
160 struct smbcli_composite *c;
161 struct clisocket_connect *conn;
164 c = talloc_zero(sock, struct smbcli_composite);
165 if (c == NULL) return NULL;
167 c->event_ctx = sock->event.ctx;
169 conn = talloc(c, struct clisocket_connect);
170 if (conn == NULL) goto failed;
174 /* work out what ports we will try */
176 const char **ports = lp_smb_ports();
177 for (i=0;ports[i];i++) /* noop */ ;
178 conn->iports = talloc_array(c, int, i+1);
179 if (conn->iports == NULL) goto failed;
180 for (i=0;ports[i];i++) {
181 conn->iports[i] = atoi(ports[i]);
185 conn->iports = talloc_array(c, int, 2);
186 if (conn->iports == NULL) goto failed;
187 conn->iports[0] = port;
191 conn->dest_host = talloc_strdup(c, host_addr);
192 if (conn->dest_host == NULL) goto failed;
195 c->state = SMBCLI_REQUEST_SEND;
197 /* startup the connect process for each port in turn until one
198 succeeds or tells us that it is pending */
199 for (i=0;conn->iports[i];i++) {
201 conn->sock->port = conn->iports[i];
202 c->status = smbcli_sock_connect_one(sock,
205 if (NT_STATUS_IS_OK(c->status) ||
206 NT_STATUS_EQUAL(c->status, NT_STATUS_MORE_PROCESSING_REQUIRED)) {
207 sock->event.fde->private = c;
212 c->state = SMBCLI_REQUEST_ERROR;
221 finish a smbcli_sock_connect_send() operation
223 NTSTATUS smbcli_sock_connect_recv(struct smbcli_composite *c)
226 status = smb_composite_wait(c);
232 connect a smbcli_socket context to an IP/port pair
233 if port is 0 then choose the ports listed in smb.conf (normally 445 then 139)
235 sync version of the function
237 NTSTATUS smbcli_sock_connect(struct smbcli_socket *sock, const char *host_addr, int port)
239 struct smbcli_composite *c;
241 c = smbcli_sock_connect_send(sock, host_addr, port);
243 return NT_STATUS_NO_MEMORY;
246 return smbcli_sock_connect_recv(c);
250 /****************************************************************************
251 mark the socket as dead
252 ****************************************************************************/
253 void smbcli_sock_dead(struct smbcli_socket *sock)
255 if (sock->sock != NULL) {
256 talloc_free(sock->sock);
261 /****************************************************************************
262 Set socket options on a open connection.
263 ****************************************************************************/
264 void smbcli_sock_set_options(struct smbcli_socket *sock, const char *options)
266 socket_set_option(sock->sock, options, NULL);
269 /****************************************************************************
270 Write to socket. Return amount written.
271 ****************************************************************************/
272 ssize_t smbcli_sock_write(struct smbcli_socket *sock, const uint8_t *data, size_t len)
278 if (sock->sock == NULL) {
283 blob.data = discard_const(data);
286 status = socket_send(sock->sock, &blob, &nsent, 0);
287 if (NT_STATUS_IS_ERR(status)) {
295 /****************************************************************************
296 Read from socket. return amount read
297 ****************************************************************************/
298 ssize_t smbcli_sock_read(struct smbcli_socket *sock, uint8_t *data, size_t len)
303 if (sock->sock == NULL) {
308 status = socket_recv(sock->sock, data, len, &nread, 0);
309 if (NT_STATUS_IS_ERR(status)) {
317 /****************************************************************************
318 resolve a hostname and connect
319 ****************************************************************************/
320 BOOL smbcli_sock_connect_byname(struct smbcli_socket *sock, const char *host, int port)
322 int name_type = NBT_NAME_SERVER;
325 struct nbt_name nbt_name;
328 name = talloc_strdup(sock, host);
330 /* allow hostnames of the form NAME#xx and do a netbios lookup */
331 if ((p = strchr(name, '#'))) {
332 name_type = strtol(p+1, NULL, 16);
336 nbt_name.name = name;
337 nbt_name.type = name_type;
338 nbt_name.scope = NULL;
340 status = resolve_name(&nbt_name, sock, &address);
341 if (!NT_STATUS_IS_OK(status)) {
345 sock->hostname = name;
347 status = smbcli_sock_connect(sock, address, port);
349 return NT_STATUS_IS_OK(status);