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"
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 timed_event *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 event_context *event_ctx;
98 struct smb_iconv_convenience *iconv_convenience;
100 /* a queue of requests pending to be sent */
101 struct nbt_name_request *send_queue;
104 struct fd_event *fde;
106 /* mapping from name_trn_id to pending event */
107 struct idr_context *idr;
109 /* how many requests are waiting for a reply */
110 uint16_t num_pending;
112 /* what to do with incoming request packets */
114 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
115 struct socket_address *);
119 /* what to do with unexpected replies */
121 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
122 struct socket_address *);
126 uint32_t wack_timeout;
130 /* a simple name query */
131 struct nbt_name_query {
133 struct nbt_name name;
134 const char *dest_addr;
138 int timeout; /* in seconds */
142 const char *reply_from;
143 struct nbt_name name;
145 const char **reply_addrs;
149 /* a simple name status query */
150 struct nbt_name_status {
152 struct nbt_name name;
153 const char *dest_addr;
155 int timeout; /* in seconds */
159 const char *reply_from;
160 struct nbt_name name;
161 struct nbt_rdata_status status;
165 /* a name registration request */
166 struct nbt_name_register {
168 struct nbt_name name;
169 const char *dest_addr;
173 bool register_demand;
177 int timeout; /* in seconds */
181 const char *reply_from;
182 struct nbt_name name;
183 const char *reply_addr;
188 /* a send 3 times then demand name broadcast name registration */
189 struct nbt_name_register_bcast {
191 struct nbt_name name;
192 const char *dest_addr;
201 /* wins name register with multiple wins servers to try and multiple
202 addresses to register */
203 struct nbt_name_register_wins {
205 struct nbt_name name;
206 const char **wins_servers;
208 const char **addresses;
213 const char *wins_server;
220 /* a name refresh request */
221 struct nbt_name_refresh {
223 struct nbt_name name;
224 const char *dest_addr;
230 int timeout; /* in seconds */
234 const char *reply_from;
235 struct nbt_name name;
236 const char *reply_addr;
241 /* wins name refresh with multiple wins servers to try and multiple
242 addresses to register */
243 struct nbt_name_refresh_wins {
245 struct nbt_name name;
246 const char **wins_servers;
248 const char **addresses;
253 const char *wins_server;
259 /* a name release request */
260 struct nbt_name_release {
262 struct nbt_name name;
263 const char *dest_addr;
268 int timeout; /* in seconds */
272 const char *reply_from;
273 struct nbt_name name;
274 const char *reply_addr;
279 struct nbt_name_socket *nbt_name_socket_init(TALLOC_CTX *mem_ctx,
280 struct event_context *event_ctx,
281 struct smb_iconv_convenience *iconv_convenience);
282 struct nbt_name_request *nbt_name_query_send(struct nbt_name_socket *nbtsock,
283 struct nbt_name_query *io);
284 NTSTATUS nbt_name_query_recv(struct nbt_name_request *req,
285 TALLOC_CTX *mem_ctx, struct nbt_name_query *io);
286 NTSTATUS nbt_name_query(struct nbt_name_socket *nbtsock,
287 TALLOC_CTX *mem_ctx, struct nbt_name_query *io);
288 struct nbt_name_request *nbt_name_status_send(struct nbt_name_socket *nbtsock,
289 struct nbt_name_status *io);
290 NTSTATUS nbt_name_status_recv(struct nbt_name_request *req,
291 TALLOC_CTX *mem_ctx, struct nbt_name_status *io);
292 NTSTATUS nbt_name_status(struct nbt_name_socket *nbtsock,
293 TALLOC_CTX *mem_ctx, struct nbt_name_status *io);
295 NTSTATUS nbt_name_dup(TALLOC_CTX *mem_ctx, struct nbt_name *name, struct nbt_name *newname);
296 NTSTATUS nbt_name_to_blob(TALLOC_CTX *mem_ctx, struct smb_iconv_convenience *iconv_convenience, DATA_BLOB *blob, struct nbt_name *name);
297 NTSTATUS nbt_name_from_blob(TALLOC_CTX *mem_ctx, const DATA_BLOB *blob, struct nbt_name *name);
298 void nbt_choose_called_name(TALLOC_CTX *mem_ctx, struct nbt_name *n, const char *name, int type);
299 char *nbt_name_string(TALLOC_CTX *mem_ctx, const struct nbt_name *name);
300 NTSTATUS nbt_name_register(struct nbt_name_socket *nbtsock,
301 TALLOC_CTX *mem_ctx, struct nbt_name_register *io);
302 NTSTATUS nbt_name_refresh(struct nbt_name_socket *nbtsock,
303 TALLOC_CTX *mem_ctx, struct nbt_name_refresh *io);
304 NTSTATUS nbt_name_release(struct nbt_name_socket *nbtsock,
305 TALLOC_CTX *mem_ctx, struct nbt_name_release *io);
306 NTSTATUS nbt_name_register_wins(struct nbt_name_socket *nbtsock,
308 struct nbt_name_register_wins *io);
309 NTSTATUS nbt_name_refresh_wins(struct nbt_name_socket *nbtsock,
311 struct nbt_name_refresh_wins *io);
312 NTSTATUS nbt_name_register_recv(struct nbt_name_request *req,
313 TALLOC_CTX *mem_ctx, struct nbt_name_register *io);
314 struct nbt_name_request *nbt_name_register_send(struct nbt_name_socket *nbtsock,
315 struct nbt_name_register *io);
316 NTSTATUS nbt_name_release_recv(struct nbt_name_request *req,
317 TALLOC_CTX *mem_ctx, struct nbt_name_release *io);
319 struct nbt_name_request *nbt_name_release_send(struct nbt_name_socket *nbtsock,
320 struct nbt_name_release *io);
322 NTSTATUS nbt_name_refresh_recv(struct nbt_name_request *req,
323 TALLOC_CTX *mem_ctx, struct nbt_name_refresh *io);
325 NTSTATUS nbt_set_incoming_handler(struct nbt_name_socket *nbtsock,
326 void (*handler)(struct nbt_name_socket *, struct nbt_name_packet *,
327 struct socket_address *),
329 NTSTATUS nbt_name_reply_send(struct nbt_name_socket *nbtsock,
330 struct socket_address *dest,
331 struct nbt_name_packet *request);
334 NDR_SCALAR_PROTO(wrepl_nbt_name, const struct nbt_name *);
335 NDR_SCALAR_PROTO(nbt_string, const char *);
336 NDR_BUFFER_PROTO(nbt_name, struct nbt_name);
337 NTSTATUS nbt_rcode_to_ntstatus(uint8_t rcode);
339 struct composite_context;
340 struct composite_context *nbt_name_register_bcast_send(struct nbt_name_socket *nbtsock,
341 struct nbt_name_register_bcast *io);
342 NTSTATUS nbt_name_register_bcast_recv(struct composite_context *c);
343 struct composite_context *nbt_name_register_wins_send(struct nbt_name_socket *nbtsock,
344 struct nbt_name_register_wins *io);
345 NTSTATUS nbt_name_refresh_wins_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
346 struct nbt_name_refresh_wins *io);
347 struct composite_context *nbt_name_refresh_wins_send(struct nbt_name_socket *nbtsock,
348 struct nbt_name_refresh_wins *io);
349 NTSTATUS nbt_name_register_wins_recv(struct composite_context *c, TALLOC_CTX *mem_ctx,
350 struct nbt_name_register_wins *io);
353 #endif /* __LIBNBT_H__ */