[app][inetsrv] add tftp server.

app/inetsrv/tftp.c

Index: app/inetsrv/tftp.c
diff --git a/app/inetsrv/tftp.c b/app/inetsrv/tftp.c
new file mode 100644
index 0000000000000000000000000000000000000000..a64c0f2e94a21d2db9986967f59b4963d78d9d4a
--- /dev/null
+++ b/app/inetsrv/tftp.c
@@ -0,0 +1,273 @@
+/*
+ * Copyright (c) 2015 Carlos Pizano-Uribe <cpu@chromium.org>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files
+ * (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+ * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+ * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <err.h>
+#include <trace.h>
+#include <stdlib.h>
+#include <string.h>
+#include <list.h>
+#include <compiler.h>
+#include <endian.h>
+#include <lib/minip.h>
+#include <lib/cksum.h>
+#include <platform.h>
+
+#include "tftp.h"
+
+#define TFTP_BUFSIZE 512

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

remove

+
+// TFTP Opcodes:
+#define TFTP_OPCODE_RRQ   1UL
+#define TFTP_OPCODE_WRQ   2UL
+#define TFTP_OPCODE_DATA  3UL
+#define TFTP_OPCODE_ACK   4UL
+#define TFTP_OPCODE_ERROR 5UL
+
+// TFTP Errors:
+#define TFTP_ERROR_UNDEF        0UL
+#define TFTP_ERROR_NOT_FOUND    1UL
+#define TFTP_ERROR_ACCESS       2UL
+#define TFTP_ERROR_FULL         3UL
+#define TFTP_ERROR_ILLEGAL_OP   4UL
+#define TFTP_ERROR_UNKNOWN_XFER 4UL
+#define TFTP_ERROR_EXISTS       6UL
+#define TFTP_ERROR_NO_SUCH_USER 7UL
+
+#define TFTP_PORT 69
+
+#define	RD_U16(ptr)	\
+    (uint16_t)(((uint16_t)*((uint8_t*)(ptr)+1)<<8)|(uint16_t)*(uint8_t*)(ptr))
+
+static struct list_node tftp_list = LIST_INITIAL_VALUE(tftp_list);
+
+// Represents tftp jobs in progress or possible.

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

elaborate, confusing

+typedef struct {
+    struct list_node list;
+    // Registration info.
+    const char* file_name;
+    tftp_callback_t callback;
+    void *arg;
+    // Current job info.
+    udp_socket_t* socket;
+    uint32_t src_addr;
+    uint16_t src_port;
+    uint16_t pkt_count;
+} tftp_job_t;
+
+uint16_t next_port = 2224;
+
+static void send_ack(udp_socket_t* socket, uint16_t count) 
+{
+    status_t st;
+    uint16_t ack[] = {htons(TFTP_OPCODE_ACK), htons(count)};
+    st = udp_send(ack, sizeof(ack), socket);
+    if (st < 0)
+        TRACEF("send_ack failed: %d\n", st); 

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cja, 2015/09/16 21:19:41]

nit: inconsistent use of single line conditionals with and without braces.
Perhaps run the file through the astyle script?

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:30]

Acknowledged.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

Acknowledged.

+}
+
+static void end_transfer(tftp_job_t* job)
+{
+    udp_close(job->socket);
+    job->socket = NULL;
+    job->callback(NULL, 0UL, job->arg);
+}
+
+static void send_error(udp_socket_t* socket, uint16_t code)
+{

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

move send error next to send ack

+    status_t st;
+    uint16_t ncode = htons(code);
+    uint16_t err[] = {htons(TFTP_OPCODE_ERROR), ncode,
+                      0x7245, 0x2072, 0x3030 + ncode, 0 };
+    st = udp_send(err, sizeof(err), socket);

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

xplain magic numbers

+    if (st < 0)
+        TRACEF("send_err failed: %d\n", st); 

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

Acknowledged.

+}
+
+static void udp_wrq_callback(void *data, size_t len,
+                             uint32_t srcaddr, uint16_t srcport,
+                             void *arg)
+{ 

[cja, 2015/09/16 21:19:41]

What if data is NULL? It's dereferenced below with no check.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

it will come with len == 0 ?

[cja, 2015/09/17 18:11:56]

Perhaps it's a personal preference, but I'd still check that the pointer is
valid when passed in.

+    char* data_c = data;

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

in comment do the layout of the packet

+    tftp_job_t* job = arg;

[cja, 2015/09/16 21:19:41]

arg also needs a NULL check.

+    job->pkt_count++;
+
+    if (len < 4) {
+        // Not to spec. Ignore.
+        return;
+    }
+
+    if (!job->socket) {
+        // It is possible to have the client sent another packet
+        // after we called end_transfer().
+        return;
+    }
+
+    if ((srcaddr != job->src_addr) || (srcport != job->src_port)) {
+        TRACEF("invalid source\n");

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:30]

Acknowledged.

+        send_error(job->socket, TFTP_ERROR_UNKNOWN_XFER);
+        end_transfer(job);

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

not sure spec requires to abort job.

+        return;
+    }
+
+    if (RD_U16(data_c) != htons(TFTP_OPCODE_DATA)) {
+        TRACEF("invalid opcode\n");

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

Acknowledged.

+        send_error(job->socket, TFTP_ERROR_ILLEGAL_OP);
+        end_transfer(job);
+        return;
+    }
+
+    send_ack(job->socket, job->pkt_count);
+
+    if (job->callback(&data_c[4], len, job->arg) < 0) {

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

bug: len - 4

+      // The client wants to abort.
+      send_error(job->socket, TFTP_ERROR_FULL);
+      end_transfer(job);      
+    }
+    
+    if (len != 516) {

[cja, 2015/09/16 21:19:41]

What does 516 mean?

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

good point, added a comment.

+        end_transfer(job);
+    }
+}
+
+static tftp_job_t* get_job_by_name(const char* file_name) 
+{

[cja, 2015/09/16 21:19:41]

Need NULL check for file_name.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

Acknowledged.

+    tftp_job_t *entry;
+    list_for_every_entry(&tftp_list, entry, tftp_job_t, list) {
+        if (strcmp(entry->file_name, file_name) == 0) {
+            return entry;
+        }
+    }
+    return NULL;
+}
+
+static void udp_svc_callback(void *data, size_t len,
+                             uint32_t srcaddr, uint16_t srcport,
+                             void *arg)
+{
+    status_t st;
+    uint16_t opcode;
+    udp_socket_t* socket;
+    tftp_job_t* job;
+
+    st = udp_open(srcaddr, next_port, srcport, &socket);
+    if (st < 0) {
+        TRACEF("error opening send socket %d\n", st);

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:30]

Acknowledged.

+        return;
+    }
+
+    opcode = ntohs(RD_U16(data));
+
+    if (opcode != TFTP_OPCODE_WRQ)
+    {
+        // Operation not suported.
+        TRACEF("op not supported, opcode: %d\n", opcode);

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:30]

Acknowledged.

+        send_error(socket, TFTP_ERROR_ACCESS);
+        udp_close(socket);
+        return;
+    }
+

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

put in the comment the packet layout.

+    // Look for a client that can hadle the file. TODO: |data|
+    // needs to be null terminated. A malicious client can crash us.
+    job = get_job_by_name(((char*)data) + 2);
+
+    if (!job) {
+        // Nobody claims to handle that file.
+        TRACEF("no client registered for file\n");
+        send_error(socket, TFTP_ERROR_UNKNOWN_XFER);
+        udp_close(socket);
+        return;      
+    }
+
+    if (job->socket) {
+      // There is already an ongoing job.
+      // TODO: garbage collect the existing one if too long since the
+      // last packet was processed.

[cja, 2015/09/16 21:19:41]

is this todo a "nice to have" or required for operation?

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

It is is a very nice to have, but it works as-is today. But I will implement
this at some point.

+      TRACEF("existing job in progress\n");

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:31]

Acknowledged.

+      send_error(socket, TFTP_ERROR_EXISTS);
+      udp_close(socket);
+      return;      
+    }
+
+    TRACEF("write op accepted, port %d\n", srcport);

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

+    // Request accepted. The rest of the transfer happens between
+    // next_port <----> srcport via |udp_wrq_callback|.

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

remove || and put ()

+
+    job->socket = socket;
+    job->src_addr = srcaddr;
+    job->src_port = srcport;
+    job->pkt_count = 0UL;
+
+    st = udp_listen(next_port, &udp_wrq_callback, job);
+    if (st < 0) {
+        TRACEF("error listening on port\n");

[cja, 2015/09/16 21:19:41]

LTRACEF for code you're checking in.

+        return;
+    }
+
+    send_ack(socket, 0UL);
+    next_port++;
+}
+
+int tftp_set_write_client(const char* file_name, tftp_callback_t cb, void* arg)
+{

[cja, 2015/09/16 21:19:41]

Arg check.

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:30]

Acknowledged.

+    tftp_job_t *job;
+
+    list_for_every_entry(&tftp_list, job, tftp_job_t, list) {
+        if (strcmp(file_name, job->file_name) == 0) {
+            // TODO: un-registration.

[cja, 2015/09/16 21:19:41]

Important?

[cpu_(ooo_6.6-7.5), 2015/09/17 01:22:30]

In the next CL. I need to make sure I write the other side first.

+            return -1;
+        }
+    }
+
+    if ((job = malloc(sizeof(tftp_job_t))) == NULL) {
+        return -1;
+    }
+
+    memset(job, 0, sizeof(tftp_job_t));
+    job->file_name = file_name;
+    job->callback = cb;
+    job->arg = arg;
+
+    list_add_tail(&tftp_list, &job->list);
+    return 0;
+}
+
+static unsigned long test_crc = 0UL;
+
+int test_tftp_client(void* data, size_t len, void* arg) {
+    if (!data) {
+        TRACEF("--test transfer done-- crc32 = %lu\n", test_crc);
+        test_crc = 0UL;
+    }
+
+    test_crc = crc32(test_crc, data,len);
+    return 0;
+}
+
+int tftp_server_init(void *arg)
+{
+    tftp_set_write_client("tftp_test.txt", &test_tftp_client, NULL);

[cpu_(ooo_6.6-7.5), 2015/09/16 18:04:11]

268 is test code, it can be removed.

+
+    status_t st = udp_listen(TFTP_PORT, &udp_svc_callback, 0);
+    return st;
+}
+