1 /* 2 Unix SMB/CIFS implementation. 3 Socket functions 4 Copyright (C) Stefan Metzmacher 2004 5 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. 10 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. 15 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/>. 18 */ 19 20 #ifndef _SAMBA_SOCKET_H 21 #define _SAMBA_SOCKET_H 22 23 struct tevent_context; 24 struct tevent_fd; 25 struct socket_context; 26 27 enum socket_type { 28 SOCKET_TYPE_STREAM, 29 SOCKET_TYPE_DGRAM 30 }; 31 32 struct socket_address { 33 const char *family; 34 char *addr; 35 int port; 36 struct sockaddr *sockaddr; 37 size_t sockaddrlen; 38 }; 39 40 struct socket_ops { 41 const char *name; 42 43 NTSTATUS (*fn_init)(struct socket_context *sock); 44 45 /* client ops */ 46 NTSTATUS (*fn_connect)(struct socket_context *sock, 47 const struct socket_address *my_address, 48 const struct socket_address *server_address, 49 uint32_t flags); 50 51 /* complete a non-blocking connect */ 52 NTSTATUS (*fn_connect_complete)(struct socket_context *sock, 53 uint32_t flags); 54 55 /* server ops */ 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); 61 62 /* general ops */ 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); 67 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); 75 76 void (*fn_close)(struct socket_context *sock); 77 78 NTSTATUS (*fn_set_option)(struct socket_context *sock, const char *option, const char *val); 79 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); 83 84 int (*fn_get_fd)(struct socket_context *sock); 85 }; 86 87 enum socket_state { 88 SOCKET_STATE_UNDEFINED, 89 90 SOCKET_STATE_CLIENT_START, 91 SOCKET_STATE_CLIENT_CONNECTED, 92 SOCKET_STATE_CLIENT_STARTTLS, 93 SOCKET_STATE_CLIENT_ERROR, 94 95 SOCKET_STATE_SERVER_LISTEN, 96 SOCKET_STATE_SERVER_CONNECTED, 97 SOCKET_STATE_SERVER_STARTTLS, 98 SOCKET_STATE_SERVER_ERROR 99 }; 100 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 106 * that re-sends be 107 * consistant, because it 108 * is encrypting data. 109 * This modifies the 110 * TESTNONBLOCK case */ 111 #define SOCKET_FLAG_NOCLOSE 0x00000010 /* don't auto-close on free */ 112 113 114 struct socket_context { 115 enum socket_type type; 116 enum socket_state state; 117 uint32_t flags; 118 119 int fd; 120 121 void *private_data; 122 const struct socket_ops *ops; 123 const char *backend_name; 124 125 /* specific to the ip backend */ 126 int family; 127 }; 128 129 struct resolve_context; 130 struct tsocket_address; 131 132 /* prototypes */ 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(TALLOC_CTX *mem_ctx, 137 const char *name, enum socket_type type, 138 struct socket_context **new_sock, uint32_t flags); 139 NTSTATUS socket_connect(struct socket_context *sock, 140 const struct socket_address *my_address, 141 const struct socket_address *server_address, 142 uint32_t flags); 143 NTSTATUS socket_connect_complete(struct socket_context *sock, uint32_t flags); 144 NTSTATUS socket_listen(struct socket_context *sock, 145 const struct socket_address *my_address, 146 int queue_size, uint32_t flags); 147 NTSTATUS socket_accept(struct socket_context *sock, struct socket_context **new_sock); 148 NTSTATUS socket_recv(struct socket_context *sock, void *buf, 149 size_t wantlen, size_t *nread); 150 NTSTATUS socket_recvfrom(struct socket_context *sock, void *buf, 151 size_t wantlen, size_t *nread, 152 TALLOC_CTX *addr_ctx, struct socket_address **src_addr); 153 NTSTATUS socket_send(struct socket_context *sock, 154 const DATA_BLOB *blob, size_t *sendlen); 155 NTSTATUS socket_sendto(struct socket_context *sock, 156 const DATA_BLOB *blob, size_t *sendlen, 157 const struct socket_address *dest_addr); 158 NTSTATUS socket_pending(struct socket_context *sock, size_t *npending); 159 NTSTATUS socket_set_option(struct socket_context *sock, const char *option, const char *val); 160 char *socket_get_peer_name(struct socket_context *sock, TALLOC_CTX *mem_ctx); 161 struct socket_address *socket_get_peer_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx); 162 struct socket_address *socket_get_my_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx); 163 struct tsocket_address *socket_address_to_tsocket_address(TALLOC_CTX *mem_ctx, 164 const struct socket_address *a); 165 struct socket_address *tsocket_address_to_socket_address(TALLOC_CTX *mem_ctx, 166 const struct tsocket_address *a); 167 struct tsocket_address *socket_get_remote_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx); 168 struct tsocket_address *socket_get_local_addr(struct socket_context *sock, TALLOC_CTX *mem_ctx); 169 int socket_get_fd(struct socket_context *sock); 170 NTSTATUS socket_dup(struct socket_context *sock); 171 struct socket_address *socket_address_from_strings(TALLOC_CTX *mem_ctx, 172 const char *type, 173 const char *host, 174 int port); 175 struct socket_address *socket_address_from_sockaddr(TALLOC_CTX *mem_ctx, 176 struct sockaddr *sockaddr, 177 size_t addrlen); 178 struct sockaddr_storage; 179 struct socket_address *socket_address_from_sockaddr_storage(TALLOC_CTX *mem_ctx, 180 const struct sockaddr_storage *sockaddr, 181 uint16_t port); 182 _PUBLIC_ void socket_address_set_port(struct socket_address *a, 183 uint16_t port); 184 struct socket_address *socket_address_copy(TALLOC_CTX *mem_ctx, 185 const struct socket_address *oaddr); 186 const struct socket_ops *socket_getops_byname(const char *name, enum socket_type type); 187 bool socket_check_access(struct socket_context *sock, 188 const char *service_name, 189 const char **allow_list, const char **deny_list); 190 191 struct composite_context *socket_connect_send(struct socket_context *sock, 192 struct socket_address *my_address, 193 struct socket_address *server_address, 194 uint32_t flags, 195 struct tevent_context *event_ctx); 196 NTSTATUS socket_connect_recv(struct composite_context *ctx); 197 NTSTATUS socket_connect_ev(struct socket_context *sock, 198 struct socket_address *my_address, 199 struct socket_address *server_address, 200 uint32_t flags, 201 struct tevent_context *ev); 202 203 struct socket_connect_multi_ex { 204 void *private_data; 205 struct tevent_req *(*establish_send)(TALLOC_CTX *mem_ctx, 206 struct tevent_context *ev, 207 struct socket_context *sock, 208 struct socket_address *addr, 209 void *private_data); 210 NTSTATUS (*establish_recv)(struct tevent_req *req); 211 }; 212 struct composite_context *socket_connect_multi_ex_send(TALLOC_CTX *mem_ctx, 213 const char *server_address, 214 int num_server_ports, 215 uint16_t *server_ports, 216 struct resolve_context *resolve_ctx, 217 struct tevent_context *event_ctx, 218 struct socket_connect_multi_ex *ex); 219 NTSTATUS socket_connect_multi_ex_recv(struct composite_context *ctx, 220 TALLOC_CTX *mem_ctx, 221 struct socket_context **result, 222 uint16_t *port); 223 NTSTATUS socket_connect_multi_ex(TALLOC_CTX *mem_ctx, const char *server_address, 224 int num_server_ports, uint16_t *server_ports, 225 struct resolve_context *resolve_ctx, 226 struct tevent_context *event_ctx, 227 struct socket_connect_multi_ex *ex, 228 struct socket_context **result, 229 uint16_t *port); 230 231 struct composite_context *socket_connect_multi_send(TALLOC_CTX *mem_ctx, 232 const char *server_address, 233 int num_server_ports, 234 uint16_t *server_ports, 235 struct resolve_context *resolve_ctx, 236 struct tevent_context *event_ctx); 237 NTSTATUS socket_connect_multi_recv(struct composite_context *ctx, 238 TALLOC_CTX *mem_ctx, 239 struct socket_context **result, 240 uint16_t *port); 241 NTSTATUS socket_connect_multi(TALLOC_CTX *mem_ctx, const char *server_address, 242 int num_server_ports, uint16_t *server_ports, 243 struct resolve_context *resolve_ctx, 244 struct tevent_context *event_ctx, 245 struct socket_context **result, 246 uint16_t *port); 247 void set_socket_options(int fd, const char *options); 248 void socket_set_flags(struct socket_context *sock, unsigned flags); 249 250 void socket_tevent_fd_close_fn(struct tevent_context *ev, 251 struct tevent_fd *fde, 252 int fd, 253 void *private_data); 254 255 extern bool testnonblock; 256 257 #endif /* _SAMBA_SOCKET_H */ 258