2 Unix SMB/CIFS implementation.
4 Copyright (C) Stefan Metzmacher 2004
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #ifndef _SAMBA_SOCKET_H
21 #define _SAMBA_SOCKET_H
23 struct tevent_context
;
25 struct socket_context
;
32 struct socket_address
{
36 struct sockaddr
*sockaddr
;
43 NTSTATUS (*fn_init
)(struct socket_context
*sock
);
46 NTSTATUS (*fn_connect
)(struct socket_context
*sock
,
47 const struct socket_address
*my_address
,
48 const struct socket_address
*server_address
,
51 /* complete a non-blocking connect */
52 NTSTATUS (*fn_connect_complete
)(struct socket_context
*sock
,
56 NTSTATUS (*fn_listen
)(struct socket_context
*sock
,
57 const struct socket_address
*my_address
,
58 int queue_size
, uint32_t flags
);
59 NTSTATUS (*fn_accept
)(struct socket_context
*sock
,
60 struct socket_context
**new_sock
);
63 NTSTATUS (*fn_recv
)(struct socket_context
*sock
, void *buf
,
64 size_t wantlen
, size_t *nread
);
65 NTSTATUS (*fn_send
)(struct socket_context
*sock
,
66 const DATA_BLOB
*blob
, size_t *sendlen
);
68 NTSTATUS (*fn_sendto
)(struct socket_context
*sock
,
69 const DATA_BLOB
*blob
, size_t *sendlen
,
70 const struct socket_address
*dest_addr
);
71 NTSTATUS (*fn_recvfrom
)(struct socket_context
*sock
,
72 void *buf
, size_t wantlen
, size_t *nread
,
73 TALLOC_CTX
*addr_ctx
, struct socket_address
**src_addr
);
74 NTSTATUS (*fn_pending
)(struct socket_context
*sock
, size_t *npending
);
76 void (*fn_close
)(struct socket_context
*sock
);
78 NTSTATUS (*fn_set_option
)(struct socket_context
*sock
, const char *option
, const char *val
);
80 char *(*fn_get_peer_name
)(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
81 struct socket_address
*(*fn_get_peer_addr
)(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
82 struct socket_address
*(*fn_get_my_addr
)(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
84 int (*fn_get_fd
)(struct socket_context
*sock
);
88 SOCKET_STATE_UNDEFINED
,
90 SOCKET_STATE_CLIENT_START
,
91 SOCKET_STATE_CLIENT_CONNECTED
,
92 SOCKET_STATE_CLIENT_STARTTLS
,
93 SOCKET_STATE_CLIENT_ERROR
,
95 SOCKET_STATE_SERVER_LISTEN
,
96 SOCKET_STATE_SERVER_CONNECTED
,
97 SOCKET_STATE_SERVER_STARTTLS
,
98 SOCKET_STATE_SERVER_ERROR
101 #define SOCKET_FLAG_BLOCK 0x00000001
102 #define SOCKET_FLAG_PEEK 0x00000002
103 #define SOCKET_FLAG_TESTNONBLOCK 0x00000004
104 #define SOCKET_FLAG_ENCRYPT 0x00000008 /* This socket
105 * implementation requires
107 * consistant, because it
108 * is encrypting data.
110 * TESTNONBLOCK case */
111 #define SOCKET_FLAG_NOCLOSE 0x00000010 /* don't auto-close on free */
114 struct socket_context
{
115 enum socket_type type
;
116 enum socket_state state
;
122 const struct socket_ops
*ops
;
123 const char *backend_name
;
125 /* specific to the ip backend */
129 struct resolve_context
;
130 struct tsocket_address
;
133 NTSTATUS
socket_create_with_ops(TALLOC_CTX
*mem_ctx
, const struct socket_ops
*ops
,
134 struct socket_context
**new_sock
,
135 enum socket_type type
, uint32_t flags
);
136 NTSTATUS
socket_create(const char *name
, enum socket_type type
,
137 struct socket_context
**new_sock
, uint32_t flags
);
138 NTSTATUS
socket_connect(struct socket_context
*sock
,
139 const struct socket_address
*my_address
,
140 const struct socket_address
*server_address
,
142 NTSTATUS
socket_connect_complete(struct socket_context
*sock
, uint32_t flags
);
143 NTSTATUS
socket_listen(struct socket_context
*sock
,
144 const struct socket_address
*my_address
,
145 int queue_size
, uint32_t flags
);
146 NTSTATUS
socket_accept(struct socket_context
*sock
, struct socket_context
**new_sock
);
147 NTSTATUS
socket_recv(struct socket_context
*sock
, void *buf
,
148 size_t wantlen
, size_t *nread
);
149 NTSTATUS
socket_recvfrom(struct socket_context
*sock
, void *buf
,
150 size_t wantlen
, size_t *nread
,
151 TALLOC_CTX
*addr_ctx
, struct socket_address
**src_addr
);
152 NTSTATUS
socket_send(struct socket_context
*sock
,
153 const DATA_BLOB
*blob
, size_t *sendlen
);
154 NTSTATUS
socket_sendto(struct socket_context
*sock
,
155 const DATA_BLOB
*blob
, size_t *sendlen
,
156 const struct socket_address
*dest_addr
);
157 NTSTATUS
socket_pending(struct socket_context
*sock
, size_t *npending
);
158 NTSTATUS
socket_set_option(struct socket_context
*sock
, const char *option
, const char *val
);
159 char *socket_get_peer_name(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
160 struct socket_address
*socket_get_peer_addr(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
161 struct socket_address
*socket_get_my_addr(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
162 struct tsocket_address
*socket_address_to_tsocket_address(TALLOC_CTX
*mem_ctx
,
163 const struct socket_address
*a
);
164 struct socket_address
*tsocket_address_to_socket_address(TALLOC_CTX
*mem_ctx
,
165 const struct tsocket_address
*a
);
166 struct tsocket_address
*socket_get_remote_addr(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
167 struct tsocket_address
*socket_get_local_addr(struct socket_context
*sock
, TALLOC_CTX
*mem_ctx
);
168 int socket_get_fd(struct socket_context
*sock
);
169 NTSTATUS
socket_dup(struct socket_context
*sock
);
170 struct socket_address
*socket_address_from_strings(TALLOC_CTX
*mem_ctx
,
174 struct socket_address
*socket_address_from_sockaddr(TALLOC_CTX
*mem_ctx
,
175 struct sockaddr
*sockaddr
,
177 struct sockaddr_storage
;
178 struct socket_address
*socket_address_from_sockaddr_storage(TALLOC_CTX
*mem_ctx
,
179 const struct sockaddr_storage
*sockaddr
,
181 _PUBLIC_
void socket_address_set_port(struct socket_address
*a
,
183 struct socket_address
*socket_address_copy(TALLOC_CTX
*mem_ctx
,
184 const struct socket_address
*oaddr
);
185 const struct socket_ops
*socket_getops_byname(const char *name
, enum socket_type type
);
186 bool socket_allow_access(TALLOC_CTX
*mem_ctx
,
187 const char **deny_list
, const char **allow_list
,
188 const char *cname
, const char *caddr
);
189 bool socket_check_access(struct socket_context
*sock
,
190 const char *service_name
,
191 const char **allow_list
, const char **deny_list
);
193 struct composite_context
*socket_connect_send(struct socket_context
*sock
,
194 struct socket_address
*my_address
,
195 struct socket_address
*server_address
,
197 struct tevent_context
*event_ctx
);
198 NTSTATUS
socket_connect_recv(struct composite_context
*ctx
);
199 NTSTATUS
socket_connect_ev(struct socket_context
*sock
,
200 struct socket_address
*my_address
,
201 struct socket_address
*server_address
,
203 struct tevent_context
*ev
);
205 struct socket_connect_multi_ex
{
207 struct tevent_req
*(*establish_send
)(TALLOC_CTX
*mem_ctx
,
208 struct tevent_context
*ev
,
209 struct socket_context
*sock
,
210 struct socket_address
*addr
,
212 NTSTATUS (*establish_recv
)(struct tevent_req
*req
);
214 struct composite_context
*socket_connect_multi_ex_send(TALLOC_CTX
*mem_ctx
,
215 const char *server_address
,
216 int num_server_ports
,
217 uint16_t *server_ports
,
218 struct resolve_context
*resolve_ctx
,
219 struct tevent_context
*event_ctx
,
220 struct socket_connect_multi_ex
*ex
);
221 NTSTATUS
socket_connect_multi_ex_recv(struct composite_context
*ctx
,
223 struct socket_context
**result
,
225 NTSTATUS
socket_connect_multi_ex(TALLOC_CTX
*mem_ctx
, const char *server_address
,
226 int num_server_ports
, uint16_t *server_ports
,
227 struct resolve_context
*resolve_ctx
,
228 struct tevent_context
*event_ctx
,
229 struct socket_connect_multi_ex
*ex
,
230 struct socket_context
**result
,
233 struct composite_context
*socket_connect_multi_send(TALLOC_CTX
*mem_ctx
,
234 const char *server_address
,
235 int num_server_ports
,
236 uint16_t *server_ports
,
237 struct resolve_context
*resolve_ctx
,
238 struct tevent_context
*event_ctx
);
239 NTSTATUS
socket_connect_multi_recv(struct composite_context
*ctx
,
241 struct socket_context
**result
,
243 NTSTATUS
socket_connect_multi(TALLOC_CTX
*mem_ctx
, const char *server_address
,
244 int num_server_ports
, uint16_t *server_ports
,
245 struct resolve_context
*resolve_ctx
,
246 struct tevent_context
*event_ctx
,
247 struct socket_context
**result
,
249 void set_socket_options(int fd
, const char *options
);
250 void socket_set_flags(struct socket_context
*sock
, unsigned flags
);
252 void socket_tevent_fd_close_fn(struct tevent_context
*ev
,
253 struct tevent_fd
*fde
,
257 extern bool testnonblock
;
259 #endif /* _SAMBA_SOCKET_H */