Coverage Report

Created: 2026-05-24 06:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/samba/source4/libcli/dgram/dgramsocket.c
Line
Count
Source
1
/* 
2
   Unix SMB/CIFS implementation.
3
4
   low level socket handling for nbt dgram requests (UDP138)
5
6
   Copyright (C) Andrew Tridgell 2005
7
   
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.
12
   
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.
17
   
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/>.
20
*/
21
22
#include "includes.h"
23
#include "lib/events/events.h"
24
#include "../lib/util/dlinklist.h"
25
#include "libcli/dgram/libdgram.h"
26
#include "lib/socket/socket.h"
27
#include "librpc/gen_ndr/ndr_nbt.h"
28
29
30
/*
31
  handle recv events on a nbt dgram socket
32
*/
33
static void dgm_socket_recv(struct nbt_dgram_socket *dgmsock)
34
0
{
35
0
  TALLOC_CTX *tmp_ctx = talloc_new(dgmsock);
36
0
  NTSTATUS status;
37
0
  struct socket_address *src;
38
0
  DATA_BLOB blob;
39
0
  size_t nread, dsize;
40
0
  struct nbt_dgram_packet *packet;
41
0
  const char *mailslot_name;
42
0
  enum ndr_err_code ndr_err;
43
44
0
  status = socket_pending(dgmsock->sock, &dsize);
45
0
  if (!NT_STATUS_IS_OK(status)) {
46
0
    talloc_free(tmp_ctx);
47
0
    return;
48
0
  }
49
50
0
  blob = data_blob_talloc(tmp_ctx, NULL, dsize);
51
0
  if ((dsize != 0) && (blob.data == NULL)) {
52
0
    talloc_free(tmp_ctx);
53
0
    return;
54
0
  }
55
56
0
  status = socket_recvfrom(dgmsock->sock, blob.data, blob.length, &nread,
57
0
         tmp_ctx, &src);
58
0
  if (!NT_STATUS_IS_OK(status)) {
59
0
    talloc_free(tmp_ctx);
60
0
    return;
61
0
  }
62
0
  blob.length = nread;
63
64
0
  DEBUG(5,("Received dgram packet of length %d from %s:%d\n", 
65
0
     (int)blob.length, src->addr, src->port));
66
67
0
  packet = talloc(tmp_ctx, struct nbt_dgram_packet);
68
0
  if (packet == NULL) {
69
0
    talloc_free(tmp_ctx);
70
0
    return;
71
0
  }
72
73
  /* parse the request */
74
0
  ndr_err = ndr_pull_struct_blob(&blob, packet, packet,
75
0
              (ndr_pull_flags_fn_t)ndr_pull_nbt_dgram_packet);
76
0
  if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
77
0
    status = ndr_map_error2ntstatus(ndr_err);
78
0
    DEBUG(2,("Failed to parse incoming NBT DGRAM packet - %s\n",
79
0
       nt_errstr(status)));
80
0
    talloc_free(tmp_ctx);
81
0
    return;
82
0
  }
83
84
  /* if this is a mailslot message, then see if we can dispatch it to a handler */
85
0
  mailslot_name = dgram_mailslot_name(packet);
86
0
  if (mailslot_name) {
87
0
    struct dgram_mailslot_handler *dgmslot;
88
0
    dgmslot = dgram_mailslot_find(dgmsock, mailslot_name);
89
0
    if (dgmslot) {
90
0
      dgmslot->handler(dgmslot, packet, src);
91
0
    } else {
92
0
      DEBUG(2,("No mailslot handler for '%s'\n", mailslot_name));
93
      /* dispatch if there is a general handler */
94
0
      if (dgmsock->incoming.handler) {
95
0
        dgmsock->incoming.handler(dgmsock, packet, src);
96
0
      }
97
0
    }
98
0
  } else {
99
    /* dispatch if there is a general handler */
100
0
    if (dgmsock->incoming.handler) {
101
0
      dgmsock->incoming.handler(dgmsock, packet, src);
102
0
    }
103
0
  }
104
105
0
  talloc_free(tmp_ctx);
106
0
}
107
108
109
/*
110
  handle send events on a nbt dgram socket
111
*/
112
static void dgm_socket_send(struct nbt_dgram_socket *dgmsock)
113
0
{
114
0
  struct nbt_dgram_request *req;
115
0
  NTSTATUS status;
116
117
0
  while ((req = dgmsock->send_queue)) {
118
0
    size_t len;
119
    
120
0
    len = req->encoded.length;
121
0
    status = socket_sendto(dgmsock->sock, &req->encoded, &len,
122
0
               req->dest);
123
0
    if (NT_STATUS_IS_ERR(status)) {
124
0
      DEBUG(3,("Failed to send datagram of length %u to %s:%d: %s\n",
125
0
         (unsigned)req->encoded.length, req->dest->addr, req->dest->port, 
126
0
         nt_errstr(status)));
127
0
      DLIST_REMOVE(dgmsock->send_queue, req);
128
0
      talloc_free(req);
129
0
      continue;
130
0
    }
131
132
0
    if (!NT_STATUS_IS_OK(status)) return;
133
134
0
    DLIST_REMOVE(dgmsock->send_queue, req);
135
0
    talloc_free(req);
136
0
  }
137
138
0
  TEVENT_FD_NOT_WRITEABLE(dgmsock->fde);
139
0
  return;
140
0
}
141
142
143
/*
144
  handle fd events on a nbt_dgram_socket
145
*/
146
static void dgm_socket_handler(struct tevent_context *ev, struct tevent_fd *fde,
147
             uint16_t flags, void *private_data)
148
0
{
149
0
  struct nbt_dgram_socket *dgmsock = talloc_get_type(private_data,
150
0
                 struct nbt_dgram_socket);
151
0
  if (flags & TEVENT_FD_WRITE) {
152
0
    dgm_socket_send(dgmsock);
153
0
  } 
154
0
  if (flags & TEVENT_FD_READ) {
155
0
    dgm_socket_recv(dgmsock);
156
0
  }
157
0
}
158
159
/*
160
  initialise a nbt_dgram_socket. The event_ctx is optional, if provided
161
  then operations will use that event context
162
*/
163
struct nbt_dgram_socket *nbt_dgram_socket_init(TALLOC_CTX *mem_ctx, 
164
                struct tevent_context *event_ctx)
165
0
{
166
0
  struct nbt_dgram_socket *dgmsock;
167
0
  NTSTATUS status;
168
169
0
  dgmsock = talloc(mem_ctx, struct nbt_dgram_socket);
170
0
  if (dgmsock == NULL) goto failed;
171
172
0
  dgmsock->event_ctx = event_ctx;
173
0
  if (dgmsock->event_ctx == NULL) goto failed;
174
175
0
  status = socket_create(dgmsock, "ip", SOCKET_TYPE_DGRAM,
176
0
             &dgmsock->sock, 0);
177
0
  if (!NT_STATUS_IS_OK(status)) goto failed;
178
179
0
  socket_set_option(dgmsock->sock, "SO_BROADCAST", "1");
180
181
0
  dgmsock->fde = tevent_add_fd(dgmsock->event_ctx, dgmsock,
182
0
            socket_get_fd(dgmsock->sock), 0,
183
0
            dgm_socket_handler, dgmsock);
184
185
0
  dgmsock->send_queue = NULL;
186
0
  dgmsock->incoming.handler = NULL;
187
0
  dgmsock->mailslot_handlers = NULL;
188
  
189
0
  return dgmsock;
190
191
0
failed:
192
0
  talloc_free(dgmsock);
193
0
  return NULL;
194
0
}
195
196
197
/*
198
  setup a handler for generic incoming requests
199
*/
200
NTSTATUS dgram_set_incoming_handler(struct nbt_dgram_socket *dgmsock,
201
            void (*handler)(struct nbt_dgram_socket *, 
202
                struct nbt_dgram_packet *, 
203
                struct socket_address *),
204
            void *private_data)
205
0
{
206
0
  dgmsock->incoming.handler = handler;
207
0
  dgmsock->incoming.private_data = private_data;
208
0
  TEVENT_FD_READABLE(dgmsock->fde);
209
0
  return NT_STATUS_OK;
210
0
}
211
212
NTSTATUS nbt_dgram_send_raw(struct nbt_dgram_socket *dgmsock,
213
          struct socket_address *dest,
214
          const DATA_BLOB pkt_blob)
215
0
{
216
0
  struct nbt_dgram_request *req;
217
0
  NTSTATUS status = NT_STATUS_NO_MEMORY;
218
219
0
  req = talloc(dgmsock, struct nbt_dgram_request);
220
0
  if (req == NULL) {
221
0
    goto failed;
222
0
  }
223
224
0
  req->dest = socket_address_copy(req, dest);
225
0
  if (req->dest == NULL) {
226
0
    goto failed;
227
0
  }
228
229
0
  req->encoded = data_blob_dup_talloc(req, pkt_blob);
230
0
  if (req->encoded.length != pkt_blob.length) {
231
0
    goto failed;
232
0
  }
233
234
0
  DLIST_ADD_END(dgmsock->send_queue, req);
235
236
0
  TEVENT_FD_WRITEABLE(dgmsock->fde);
237
238
0
  return NT_STATUS_OK;
239
240
0
failed:
241
0
  talloc_free(req);
242
0
  return status;
243
0
}
244
245
/*
246
  queue a datagram for send
247
*/
248
NTSTATUS nbt_dgram_send(struct nbt_dgram_socket *dgmsock,
249
      struct nbt_dgram_packet *packet,
250
      struct socket_address *dest)
251
0
{
252
0
  struct nbt_dgram_request *req;
253
0
  NTSTATUS status = NT_STATUS_NO_MEMORY;
254
0
  enum ndr_err_code ndr_err;
255
256
0
  req = talloc(dgmsock, struct nbt_dgram_request);
257
0
  if (req == NULL) goto failed;
258
259
0
  req->dest = socket_address_copy(req, dest);
260
0
  if (req->dest == NULL) goto failed;
261
262
0
  ndr_err = ndr_push_struct_blob(&req->encoded, req, packet,
263
0
              (ndr_push_flags_fn_t)ndr_push_nbt_dgram_packet);
264
0
  if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
265
0
    status = ndr_map_error2ntstatus(ndr_err);
266
0
    goto failed;
267
0
  }
268
269
0
  DLIST_ADD_END(dgmsock->send_queue, req);
270
271
0
  TEVENT_FD_WRITEABLE(dgmsock->fde);
272
273
0
  return NT_STATUS_OK;
274
275
0
failed:
276
  talloc_free(req);
277
0
  return status;
278
0
}