2 Unix SMB/CIFS implementation.
4 a raw async NBT library
6 Copyright (C) Andrew Tridgell 2005
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/>.
25 #include "librpc/gen_ndr/nbt.h"
26 #include "librpc/ndr/libndr.h"
27 #include "system/network.h"
29 possible states for pending requests
31 enum nbt_request_state {NBT_REQUEST_SEND,
40 struct nbt_name_request {
41 struct nbt_name_request *next, *prev;
43 enum nbt_request_state state;
47 /* the socket this was on */
48 struct nbt_name_socket *nbtsock;
50 /* where to send the request */
51 struct socket_address *dest;
53 /* timeout between retries */
56 /* how many retries to send on timeout */
59 /* whether we have received a WACK */
62 /* the timeout event */
63 struct tevent_timer *te;
65 /* the name transaction id */
71 /* the encoded request */
74 /* shall we allow multiple replies? */
75 bool allow_multiple_replies;
77 unsigned int num_replies;
78 struct nbt_name_reply {
79 struct nbt_name_packet *packet;
80 struct socket_address *dest;
83 /* information on what to do on completion */
85 void (*fn)(struct nbt_name_request *);
93 context structure for operations on name queries
95 struct nbt_name_socket {
96 struct socket_context *sock;
97 struct tevent_context *event_ctx;
99 /* a queue of requests pending to be sent */
100 struct nbt_name_request *send_queue;
103 struct tevent_fd *fde;
105 /* mapping from name_trn_id to pending event */
106 struct idr_context *idr;
108 /* how many requests are waiting for a reply */
109 uint16_t num_pending;
111 /* what to do with incoming request packets */
113 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
114 struct socket_address *);
118 /* what to do with unexpected replies */
120 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
121 struct socket_address *);
127 /* a simple name query */
128 struct nbt_name_query {
130 struct nbt_name name;
131 const char *dest_addr;
135 int timeout; /* in seconds */
139 const char *reply_from;
140 struct nbt_name name;
142 const char **reply_addrs;
146 /* a simple name status query */
147 struct nbt_name_status {
149 struct nbt_name name;
150 const char *dest_addr;
152 int timeout; /* in seconds */
156 const char *reply_from;
157 struct nbt_name name;
158 struct nbt_rdata_status status;
162 /* a name registration request */
163 struct nbt_name_register {
165 struct nbt_name name;
166 const char *dest_addr;
170 bool register_demand;
174 int timeout; /* in seconds */
178 const char *reply_from;
179 struct nbt_name name;
180 const char *reply_addr;
185 /* a send 3 times then demand name broadcast name registration */
186 struct nbt_name_register_bcast {
188 struct nbt_name name;
189 const char *dest_addr;
198 /* wins name register with multiple wins servers to try and multiple
199 addresses to register */
200 struct nbt_name_register_wins {
202 struct nbt_name name;
203 const char **wins_servers;
205 const char **addresses;
210 const char *wins_server;
217 /* a name refresh request */
218 struct nbt_name_refresh {
220 struct nbt_name name;
221 const char *dest_addr;
227 int timeout; /* in seconds */
231 const char *reply_from;
232 struct nbt_name name;
233 const char *reply_addr;
238 /* wins name refresh with multiple wins servers to try and multiple
239 addresses to register */
240 struct nbt_name_refresh_wins {
242 struct nbt_name name;
243 const char **wins_servers;
245 const char **addresses;
250 const char *wins_server;
256 /* a name release request */
257 struct nbt_name_release {
259 struct nbt_name name;
260 const char *dest_addr;
265 int timeout; /* in seconds */
269 const char *reply_from;
270 struct nbt_name name;
271 const char *reply_addr;
276 struct nbt_name_socket *nbt_name_socket_init(TALLOC_CTX *mem_ctx,
277 struct tevent_context *event_ctx);
278 void nbt_name_socket_handle_response_packet(struct nbt_name_request *req,
279 struct nbt_name_packet *packet,
280 struct socket_address *src);
281 struct nbt_name_request *nbt_name_query_send(struct nbt_name_socket *nbtsock,
282 struct nbt_name_query *io);
283 NTSTATUS nbt_name_query_recv(struct nbt_name_request *req,
284 TALLOC_CTX *mem_ctx, struct nbt_name_query *io);
285 NTSTATUS nbt_name_query(struct nbt_name_socket *nbtsock,
286 TALLOC_CTX *mem_ctx, struct nbt_name_query *io);
287 struct nbt_name_request *nbt_name_status_send(struct nbt_name_socket *nbtsock,
288 struct nbt_name_status *io);
289 NTSTATUS nbt_name_status_recv(struct nbt_name_request *req,
290 TALLOC_CTX *mem_ctx, struct nbt_name_status *io);
291 NTSTATUS nbt_name_status(struct nbt_name_socket *nbtsock,
292 TALLOC_CTX *mem_ctx, struct nbt_name_status *io);
294 NTSTATUS nbt_name_dup(TALLOC_CTX *mem_ctx, struct nbt_name *name, struct nbt_name *newname);
295 NTSTATUS nbt_name_to_blob(TALLOC_CTX *mem_ctx, DATA_BLOB *blob, struct nbt_name *name);
296 NTSTATUS nbt_name_from_blob(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob, struct nbt_name *name);
297 void nbt_choose_called_name(TALLOC_CTX *mem_ctx, struct nbt_name *n, const char *name, int type);
298 char *nbt_name_string(TALLOC_CTX *mem_ctx, const struct nbt_name *name);
299 NTSTATUS nbt_name_register(struct nbt_name_socket *nbtsock,
300 TALLOC_CTX *mem_ctx, struct nbt_name_register *io);
301 NTSTATUS nbt_name_refresh(struct nbt_name_socket *nbtsock,
302 TALLOC_CTX *mem_ctx, struct nbt_name_refresh *io);
303 NTSTATUS nbt_name_release(struct nbt_name_socket *nbtsock,
304 TALLOC_CTX *mem_ctx, struct nbt_name_release *io);
305 NTSTATUS nbt_name_register_wins(struct nbt_name_socket *nbtsock,
307 struct nbt_name_register_wins *io);
308 NTSTATUS nbt_name_refresh_wins(struct nbt_name_socket *nbtsock,
310 struct nbt_name_refresh_wins *io);
311 NTSTATUS nbt_name_register_recv(struct nbt_name_request *req,
312 TALLOC_CTX *mem_ctx, struct nbt_name_register *io);
313 struct nbt_name_request *nbt_name_register_send(struct nbt_name_socket *nbtsock,
314 struct nbt_name_register *io);
315 NTSTATUS nbt_name_release_recv(struct nbt_name_request *req,
316 TALLOC_CTX *mem_ctx, struct nbt_name_release *io);
318 struct nbt_name_request *nbt_name_release_send(struct nbt_name_socket *nbtsock,
319 struct nbt_name_release *io);
321 NTSTATUS nbt_name_refresh_recv(struct nbt_name_request *req,
322 TALLOC_CTX *mem_ctx, struct nbt_name_refresh *io);
324 NTSTATUS nbt_set_incoming_handler(struct nbt_name_socket *nbtsock,
325 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
326 struct socket_address *),
328 NTSTATUS nbt_set_unexpected_handler(struct nbt_name_socket *nbtsock,
329 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
330 struct socket_address *),
332 NTSTATUS nbt_name_reply_send(struct nbt_name_socket *nbtsock,
333 struct socket_address *dest,
334 struct nbt_name_packet *request);
337 NDR_SCALAR_PROTO(wrepl_nbt_name, const struct nbt_name *)
338 NDR_SCALAR_PROTO(nbt_string, const char *)
339 NDR_BUFFER_PROTO(nbt_name, struct nbt_name)
340 NTSTATUS nbt_rcode_to_ntstatus(uint8_t rcode);
342 struct tevent_context;
344 struct tevent_req *nbt_name_register_bcast_send(TALLOC_CTX *mem_ctx,
345 struct tevent_context *ev,
346 struct nbt_name_socket *nbtsock,
347 struct nbt_name_register_bcast *io);
348 NTSTATUS nbt_name_register_bcast_recv(struct tevent_req *req);
349 struct tevent_req *nbt_name_register_wins_send(TALLOC_CTX *mem_ctx,
350 struct tevent_context *ev,
351 struct nbt_name_socket *nbtsock,
352 struct nbt_name_register_wins *io);
353 NTSTATUS nbt_name_register_wins_recv(struct tevent_req *req,
355 struct nbt_name_register_wins *io);
356 struct tevent_req *nbt_name_refresh_wins_send(TALLOC_CTX *mem_ctx,
357 struct tevent_context *ev,
358 struct nbt_name_socket *nbtsock,
359 struct nbt_name_refresh_wins *io);
360 NTSTATUS nbt_name_refresh_wins_recv(struct tevent_req *req,
362 struct nbt_name_refresh_wins *io);
364 XFILE *startlmhosts(const char *fname);
365 bool getlmhostsent(TALLOC_CTX *ctx, XFILE *fp, char **pp_name, int *name_type,
366 struct sockaddr_storage *pss);
367 void endlmhosts(XFILE *fp);
369 NTSTATUS resolve_lmhosts_file_as_sockaddr(const char *lmhosts_file,
370 const char *name, int name_type,
372 struct sockaddr_storage **return_iplist,
375 NTSTATUS resolve_dns_hosts_file_as_sockaddr(const char *dns_hosts_file,
376 const char *name, bool srv_lookup,
378 struct sockaddr_storage **return_iplist,
381 #endif /* __LIBNBT_H__ */