diff --git a/README.md b/README.md index 299b5d87..c0996378 100755 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [![Build Status](https://travis-ci.org/gchq/CyberChef.svg?branch=master)](https://travis-ci.org/gchq/CyberChef) [![dependencies Status](https://david-dm.org/gchq/CyberChef/status.svg)](https://david-dm.org/gchq/CyberChef) [![npm](https://img.shields.io/npm/v/cyberchef.svg)](https://www.npmjs.com/package/cyberchef) -![](https://reposs.herokuapp.com/?path=gchq/CyberChef&color=blue) [![](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/gchq/CyberChef/blob/master/LICENSE) [![Gitter](https://badges.gitter.im/gchq/CyberChef.svg)](https://gitter.im/gchq/CyberChef?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) diff --git a/src/core/config/Categories.json b/src/core/config/Categories.json index f1a7b815..89b93b87 100755 --- a/src/core/config/Categories.json +++ b/src/core/config/Categories.json @@ -167,6 +167,7 @@ "Parse IP range", "Parse IPv6 address", "Parse IPv4 header", + "Parse UDP", "Parse SSH Host Key", "Parse URI", "URL Encode", diff --git a/src/core/operations/ParseUDP.mjs b/src/core/operations/ParseUDP.mjs new file mode 100644 index 00000000..0a88fd5d --- /dev/null +++ b/src/core/operations/ParseUDP.mjs @@ -0,0 +1,84 @@ +/** + * @author h345983745 [] + * @copyright Crown Copyright 2019 + * @license Apache-2.0 + */ + +import Operation from "../Operation.mjs"; +import Stream from "../lib/Stream.mjs"; +import {toHex} from "../lib/Hex.mjs"; +import OperationError from "../errors/OperationError.mjs"; + +/** + * Parse UDP operation + */ +class ParseUDP extends Operation { + + /** + * ParseUDP constructor + */ + constructor() { + super(); + + this.name = "Parse UDP"; + this.module = "Default"; + this.description = "Parses a UDP header and payload (if present)."; + this.infoURL = "https://wikipedia.org/wiki/User_Datagram_Protocol"; + this.inputType = "ArrayBuffer"; + this.outputType = "json"; + this.presentType = "html"; + this.args = []; + } + + /** + * @param {ArrayBuffer} input + * @returns {Object} + */ + run(input, args) { + if (input.byteLength < 8) { + throw new OperationError("Need 8 bytes for a UDP Header"); + } + + const s = new Stream(new Uint8Array(input)); + // Parse Header + const UDPPacket = { + "Source port": s.readInt(2), + "Destination port": s.readInt(2), + "Length": s.readInt(2), + "Checksum": toHex(s.getBytes(2), "") + }; + // Parse data if present + if (s.hasMore()) { + UDPPacket.Data = toHex(s.getBytes(UDPPacket.Length - 8), ""); + } + + return UDPPacket; + } + + /** + * Displays the UDP Packet in a table style + * @param {Object} data + * @returns {html} + */ + present(data) { + const html = []; + html.push(""); + html.push(""); + html.push(""); + html.push(""); + html.push(""); + + for (const key in data) { + html.push(""); + html.push(""); + html.push(""); + html.push(""); + } + html.push("
FieldValue
" + key + "" + data[key] + "
"); + return html.join(""); + } + +} + + +export default ParseUDP; diff --git a/tests/operations/index.mjs b/tests/operations/index.mjs index eac6ab9a..1ad69228 100644 --- a/tests/operations/index.mjs +++ b/tests/operations/index.mjs @@ -88,6 +88,7 @@ import "./tests/BLAKE2s"; import "./tests/Protobuf"; import "./tests/ParseSSHHostKey"; import "./tests/DefangIP"; +import "./tests/ParseUDP"; // Cannot test operations that use the File type yet //import "./tests/SplitColourChannels"; diff --git a/tests/operations/tests/ParseUDP.mjs b/tests/operations/tests/ParseUDP.mjs new file mode 100644 index 00000000..2c519232 --- /dev/null +++ b/tests/operations/tests/ParseUDP.mjs @@ -0,0 +1,68 @@ +/** + * Parse UDP tests. + * + * @author h345983745 + * + * @copyright Crown Copyright 2019 + * @license Apache-2.0 + */ +import TestRegister from "../../lib/TestRegister.mjs"; + +TestRegister.addTests([ + { + name: "Parse UDP: No Data - JSON", + input: "04 89 00 35 00 2c 01 01", + expectedOutput: "{\"Source port\":1161,\"Destination port\":53,\"Length\":44,\"Checksum\":\"0101\"}", + recipeConfig: [ + { + op: "From Hex", + args: ["Auto"], + }, + { + op: "Parse UDP", + args: [], + }, + { + op: "JSON Minify", + args: [], + }, + ], + }, { + name: "Parse UDP: With Data - JSON", + input: "04 89 00 35 00 2c 01 01 02 02", + expectedOutput: "{\"Source port\":1161,\"Destination port\":53,\"Length\":44,\"Checksum\":\"0101\",\"Data\":\"0202\"}", + recipeConfig: [ + { + op: "From Hex", + args: ["Auto"], + }, + { + op: "Parse UDP", + args: [], + }, + { + op: "JSON Minify", + args: [], + }, + ], + }, + { + name: "Parse UDP: Not Enough Bytes", + input: "04 89 00", + expectedOutput: "Need 8 bytes for a UDP Header", + recipeConfig: [ + { + op: "From Hex", + args: ["Auto"], + }, + { + op: "Parse UDP", + args: [], + }, + { + op: "JSON Minify", + args: [], + }, + ], + } +]);