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 2 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, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #ifndef _SAMBA_SOCKET_H
22 #define _SAMBA_SOCKET_H
24 struct socket_context;
31 struct socket_address {
35 struct sockaddr *sockaddr;
42 NTSTATUS (*fn_init)(struct socket_context *sock);
45 NTSTATUS (*fn_connect)(struct socket_context *sock,
46 const struct socket_address *my_address,
47 const struct socket_address *server_address,
50 /* complete a non-blocking connect */
51 NTSTATUS (*fn_connect_complete)(struct socket_context *sock,
55 NTSTATUS (*fn_listen)(struct socket_context *sock,
56 const struct socket_address *my_address,
57 int queue_size, uint32_t flags);
58 NTSTATUS (*fn_accept)(struct socket_context *sock,
59 struct socket_context **new_sock);
62 NTSTATUS (*fn_recv)(struct socket_context *sock, void *buf,
63 size_t wantlen, size_t *nread, uint32_t flags);
64 NTSTATUS (*fn_send)(struct socket_context *sock,
65 const DATA_BLOB *blob, size_t *sendlen, uint32_t flags);
67 NTSTATUS (*fn_sendto)(struct socket_context *sock,
68 const DATA_BLOB *blob, size_t *sendlen, uint32_t flags,
69 const struct socket_address *dest_addr);
70 NTSTATUS (*fn_recvfrom)(struct socket_context *sock,
71 void *buf, size_t wantlen, size_t *nread, uint32_t flags,
72 TALLOC_CTX *addr_ctx, struct socket_address **src_addr);
73 NTSTATUS (*fn_pending)(struct socket_context *sock, size_t *npending);
75 void (*fn_close)(struct socket_context *sock);
77 NTSTATUS (*fn_set_option)(struct socket_context *sock, const char *option, const char *val);
79 char *(*fn_get_peer_name)(struct socket_context *sock, TALLOC_CTX *mem_ctx);
80 struct socket_address *(*fn_get_peer_addr)(struct socket_context *sock, TALLOC_CTX *mem_ctx);
81 struct socket_address *(*fn_get_my_addr)(struct socket_context *sock, TALLOC_CTX *mem_ctx);
83 int (*fn_get_fd)(struct socket_context *sock);
87 SOCKET_STATE_UNDEFINED,
89 SOCKET_STATE_CLIENT_START,
90 SOCKET_STATE_CLIENT_CONNECTED,
91 SOCKET_STATE_CLIENT_STARTTLS,
92 SOCKET_STATE_CLIENT_ERROR,
94 SOCKET_STATE_SERVER_LISTEN,
95 SOCKET_STATE_SERVER_CONNECTED,
96 SOCKET_STATE_SERVER_STARTTLS,
97 SOCKET_STATE_SERVER_ERROR
100 #define SOCKET_FLAG_BLOCK 0x00000001
101 #define SOCKET_FLAG_PEEK 0x00000002
102 #define SOCKET_FLAG_TESTNONBLOCK 0x00000004
104 struct socket_context {
105 enum socket_type type;
106 enum socket_state state;
112 const struct socket_ops *ops;
113 const char *backend_name;
118 NTSTATUS socket_create(const char *name, enum socket_type type,
119 struct socket_context **new_sock, uint32_t flags);
120 NTSTATUS socket_connect(struct socket_context *sock,
121 const struct socket_address *my_address,
122 const struct socket_address *server_address,
124 NTSTATUS socket_connect_complete(struct socket_context *sock, uint32_t flags);
125 NTSTATUS socket_listen(struct socket_context *sock,
126 const struct socket_address *my_address,
127 int queue_size, uint32_t flags);
128 NTSTATUS socket_accept(struct socket_context *sock, struct socket_context **new_sock);
129 NTSTATUS socket_recv(struct socket_context *sock, void *buf,
130 size_t wantlen, size_t *nread, uint32_t flags);
131 NTSTATUS socket_recvfrom(struct socket_context *sock, void *buf,
132 size_t wantlen, size_t *nread, uint32_t flags,
133 TALLOC_CTX *addr_ctx, struct socket_address **src_addr);
134 NTSTATUS socket_send(struct socket_context *sock,
135 const DATA_BLOB *blob, size_t *sendlen, uint32_t flags);
136 NTSTATUS socket_sendto(struct socket_context *sock,
137 const DATA_BLOB *blob, size_t *sendlen, uint32_t flags,
138 const struct socket_address *dest_addr);
139 NTSTATUS socket_pending(struct socket_context *sock, size_t *npending);
140 NTSTATUS socket_set_option(struct socket_context *sock, const char *option, const char *val);
141 char *socket_get_peer_name(struct socket_context *sock, TALLOC_CTX *mem_ctx);
142 struct socket_address *socket_get_peer_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx);
143 struct socket_address *socket_get_my_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx);
144 int socket_get_fd(struct socket_context *sock);
145 NTSTATUS socket_dup(struct socket_context *sock);
146 struct socket_address *socket_address_from_strings(TALLOC_CTX *mem_ctx,
150 struct socket_address *socket_address_from_sockaddr(TALLOC_CTX *mem_ctx,
151 struct sockaddr *sockaddr,
153 const struct socket_ops *socket_getops_byname(const char *name, enum socket_type type);
154 BOOL allow_access(TALLOC_CTX *mem_ctx,
155 const char **deny_list, const char **allow_list,
156 const char *cname, const char *caddr);
157 BOOL socket_check_access(struct socket_context *sock,
158 const char *service_name,
159 const char **allow_list, const char **deny_list);
161 struct composite_context *socket_connect_send(struct socket_context *sock,
162 struct socket_address *my_address,
163 struct socket_address *server_address,
165 struct event_context *event_ctx);
166 NTSTATUS socket_connect_recv(struct composite_context *ctx);
167 NTSTATUS socket_connect_ev(struct socket_context *sock,
168 struct socket_address *my_address,
169 struct socket_address *server_address,
170 uint32_t flags, struct event_context *ev);
172 struct composite_context *socket_connect_multi_send(TALLOC_CTX *mem_ctx,
173 const char *server_address,
174 int num_server_ports,
175 uint16_t *server_ports,
176 struct event_context *event_ctx);
177 NTSTATUS socket_connect_multi_recv(struct composite_context *ctx,
179 struct socket_context **result,
181 NTSTATUS socket_connect_multi(TALLOC_CTX *mem_ctx, const char *server_address,
182 int num_server_ports, uint16_t *server_ports,
183 struct event_context *event_ctx,
184 struct socket_context **result,
187 #endif /* _SAMBA_SOCKET_H */