first commit

Author: lsongdev

.gitignore

@@ -0,0 +1,5 @@
+
+*.log
+yarn.lock
+
+node_modules/

.npmignore

@@ -0,0 +1,4 @@
+
+*.log
+
+node_modules/

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - "stable"

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Lsong <[email protected]>
+
+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.

README.md

@@ -0,0 +1,81 @@
+## tftp2
+
+> simple tftp server and client in node.js
+
+![[email protected]](https://img.shields.io/npm/v/tftp2.svg)
+[![Build Status](https://travis-ci.org/song940/node-tftp.svg?branch=master)](https://travis-ci.org/song940/node-tftp)
+
+### Installation
+
+```bash
+$ npm i tftp2
+```
+
+### Example
+
+```js
+const tftp = require('tftp2');
+
+const { read, write } = tftp('127.0.0.1', 6969);
+
+read('remote.txt').pipe(fs.createWriteStream('/tmp/demo.txt'));
+
+```
+
+```js
+const fs = require('fs');
+const tftp = require('tftp2');
+
+const server = tftp.createServer();
+
+server.on('get', async (req, send) => {
+  const { filename, mode, address, port } = req;
+  console.log('get', filename, mode, address, port);
+  await send(fs.readFileSync(filename));
+});
+
+server.on('put', async (req, read) => {
+  const { filename, mode, address, port } = req;
+  console.log('put', filename, mode, address, port);
+  const buffer = [];
+  read(chunk => buffer.push(chunk), () => {
+    fs.writeFileSync(filename, Buffer.concat(buffer));
+  });
+});
+
+```
+
+### Contributing
+- Fork this Repo first
+- Clone your Repo
+- Install dependencies by `$ npm install`
+- Checkout a feature branch
+- Feel free to add your features
+- Make sure your features are fully tested
+- Publish your local branch, Open a pull request
+- Enjoy hacking <3
+
+### MIT
+
+Copyright (c) 2016 Lsong &lt;[email protected]&gt;
+
+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.
+
+
+---

connection.js

@@ -0,0 +1,65 @@
+const udp = require('dgram');
+const { debuglog } = require('util');
+const EventEmitter = require('events');
+const Packet = require('./packet');
+
+const debug = debuglog('tftp2:server');
+
+class Connection extends EventEmitter {
+  constructor(rinfo) {
+    super('udp4');
+    this.setRemoteDescription(rinfo);
+  }
+  setRemoteDescription(rinfo) {
+    return Object.assign(this, this.rinfo = rinfo);
+  }
+  send(data) {
+    const { rinfo } = this;
+    if (data instanceof Packet)
+      data = data.toBuffer();
+    return new Promise((resolve, reject) => {
+      this.socket.send(data, rinfo.port, rinfo.address, (err, length) => {
+        if (err) return reject(err);
+        resolve(length);
+      });
+    });
+  }
+  sendRequest(opcode, filename) {
+    const packet = Packet.createRequest(opcode, filename);
+    return this.send(packet);
+  };
+  sendAck(block) {
+    const { rinfo } = this;
+    const packet = Packet.createAck(block);
+    debug('send ack block %s to %s:%s', block, rinfo.address, rinfo.port);
+    return this.send(packet);
+  }
+  sendBlock(block, data) {
+    const { rinfo } = this;
+    const packet = Packet.createData(block, data);
+    debug('send block %s size %s, to %s:%s', block, data.length, rinfo.address, rinfo.port);
+    return this.send(packet);
+  }
+  wait(fn) {
+    return new Promise((resolve, reject) => {
+      const onMessage = (message, rinfo) => {
+        const packet = Packet.parse(message);
+        packet.rinfo = rinfo;
+        fn(packet) && (resolve(packet), removeListener());
+      };
+      const removeListener = () =>
+        this.socket.removeListener('message', onMessage);
+      this.socket.on('message', onMessage);
+    });
+  }
+  waitAck(block) {
+    return this.wait(message =>
+      message.opcode === Packet.OPCODE.ACK && message.block === block);
+  }
+  waitBlock(block) {
+    return this.wait(message =>
+      message.opcode === Packet.OPCODE.DATA && message.block === block);
+  }
+}
+
+module.exports = Connection;

example/index.js

@@ -0,0 +1,27 @@
+const tftp = require('..');
+const assert = require('assert');
+
+const { read, write } = tftp('127.0.0.1', '6969');
+
+const readChunk = filename =>
+  new Promise(async (resolve, reject) => {
+    const buffer = [];
+    await read(filename, chunk => buffer.push(chunk), () =>
+      resolve(Buffer.concat(buffer)));
+  });
+
+(async () => {
+
+  const filename = `node-tftp-test-data`;
+  await write(filename, Buffer.allocUnsafe(0xffffff));
+
+  console.log('write done');
+  const b = await readChunk(filename);
+
+  assert.equal(a.length, 0xffffff);
+  assert.equal(b.length, 0xffffff);
+  assert.deepEqual(a, b);
+
+  console.log('All Tests PASS');
+
+})();

example/server.js

@@ -0,0 +1,21 @@
+const fs = require('fs');
+const tftp = require('..');
+
+const server = tftp.createServer()
+
+server.on('get', async (req, send) => {
+  const { filename, mode, address, port } = req;
+  console.log('get', filename, mode, address, port);
+  await send(fs.readFileSync(filename));
+});
+
+server.on('put', async (req, read) => {
+  const { filename, mode, address, port } = req;
+  console.log('put', filename, mode, address, port);
+  const buffer = [];
+  read(chunk => buffer.push(chunk), () => {
+    fs.writeFileSync(filename, Buffer.concat(buffer));
+  });
+});
+
+server.listen(6969);

index.js

@@ -0,0 +1,55 @@
+const { debuglog } = require('util');
+const Packet = require('./packet');
+const Connection = require('./connection');
+
+const debug = debuglog('tftp2');
+
+/**
+ * [TFTP description]
+ * @param {[type]} options [description]
+ */
+const TFTP = (host, port, { BLOCK_SIZE = 512 } = {}) => {
+  const rinfo = { address: host, port };
+  const client = new Connection(rinfo);
+  const init = () => client.setRemoteDescription(rinfo);
+  return {
+    async read(filename, push, done) {
+      let block = 0, rinfo, data;
+      await init();
+      await client.sendRequest(Packet.OPCODE.RRQ, filename);
+      while (true) {
+        ({ rinfo, block, data } = await client.waitBlock(block + 1));
+        debug('received block(%s) size(%s), from %s:%s', block, data.length, rinfo.address, rinfo.port);
+        push(data);
+        await client.setRemoteDescription(rinfo);
+        await client.sendAck(block);
+        if (data.length < BLOCK_SIZE) {
+          done();
+          break;
+        }
+      }
+    },
+    async write(filename, data) {
+      let block, rinfo;
+      await init();
+      await client.sendRequest(Packet.OPCODE.WRQ, filename);
+      const blocks = Math.floor(data.length / BLOCK_SIZE | 0) + 1;
+      for (var i = 0; i < blocks; i++) {
+        ({ rinfo, block } = await client.waitAck(i));
+        await client.setRemoteDescription(rinfo);
+        debug('request block %s, from %s:%s', block, rinfo.address, rinfo.port);
+        const start = block * BLOCK_SIZE;
+        const end = Math.min(start + BLOCK_SIZE, data.length);
+        await client.sendBlock(block + 1, data.slice(start, end));
+      }
+      debug('done');
+    }
+  };
+};
+
+TFTP.Client = TFTP;
+TFTP.Packet = Packet;
+TFTP.Server = require('./server');
+TFTP.createServer = () => new TFTP.Server();
+
+module.exports = TFTP;

package.json

@@ -0,0 +1,29 @@
+{
+  "name": "tftp2",
+  "version": "0.0.0",
+  "description": "simple tftp server and client in node.js",
+  "main": "index.js",
+  "scripts": {
+    "test": "node test",
+    "start": "node server.js"
+  },
+  "repository": {
+    "url": "git+https://github.com/song940/node-tftp.git",
+    "type": "git"
+  },
+  "author": "Lsong <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/song940/node-tftp/issues"
+  },
+  "homepage": "https://github.com/song940/node-tftp#readme",
+  "directories": {
+    "example": "example",
+    "test": "test"
+  },
+  "keywords": [
+    "tftp",
+    "tftpd",
+    "ftp"
+  ]
+}