Skip to content

Commit

Permalink
Issue 991: Add CBOR Decode operation
Browse files Browse the repository at this point in the history
  • Loading branch information
Danh4 committed Mar 28, 2020
1 parent 4153afb commit 6856427
Show file tree
Hide file tree
Showing 4 changed files with 190 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/core/config/Categories.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@
"CSV to JSON",
"JSON to CSV",
"Avro to JSON",
"CBOR Encode"
"CBOR Encode",
"CBOR Decode"
]
},
{
Expand Down
42 changes: 42 additions & 0 deletions src/core/operations/CBORDecode.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* @author Danh4 [dan.h4@ncsc.gov.uk]
* @copyright Crown Copyright 2020
* @license Apache-2.0
*/

import Operation from "../Operation.mjs";
import Cbor from "cbor";

/**
* CBOR Decode operation
*/
class CBORDecode extends Operation {

/**
* CBORDecode constructor
*/
constructor() {
super();

this.name = "CBOR Decode";
this.module = "Default";
this.description = "Decode Concise Binary Object Representation (CBOR) data format (RFC7049) to JSON.";
this.infoURL = "https://cbor.io";
this.inputType = "ArrayBuffer";
this.outputType = "JSON";
this.args = [
];
}

/**
* @param {ArrayBuffer} input
* @param {Object[]} args
* @returns {JSON}
*/
run(input, args) {
return Cbor.decodeFirstSync(Buffer.from(input).toString("hex"));
}

}

export default CBORDecode;
1 change: 1 addition & 0 deletions tests/operations/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ import "./tests/CipherSaber2.mjs";
import "./tests/Colossus.mjs";
import "./tests/ParseObjectIDTimestamp.mjs";
import "./tests/CBOREncode.mjs";
import "./tests/CBORDecode.mjs";


// Cannot test operations that use the File type yet
Expand Down
145 changes: 145 additions & 0 deletions tests/operations/tests/CBORDecode.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/**
* From Hex Tests.
*
* @author Danh4 [dan.h4@ncsc.gov.uk]
*
* @copyright Crown Copyright 2019
* @license Apache-2.0
*/

import TestRegister from "../../lib/TestRegister.mjs";

TestRegister.addTests([
{
name: "CBOR Decode: Can decode integer",
input: "0f",
expectedOutput: "15",
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
}
]
},
{
name: "CBOR Decode: Can decode decimal",
input: "f9 3e 00",
expectedOutput: "1.5",
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
}
]
},
{
name: "From Hex: Can decode text",
input: "64 54 65 78 74",
expectedOutput: "\"Text\"",
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
}
]
},
{
name: "From Hex: Can decode boolean true",
input: "f5",
expectedOutput: "true",
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
}
]
},
{
name: "From Hex: Can decode boolean false",
input: "f4",
expectedOutput: "false",
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
}
]
},
{
name: "From Hex: Can decode map",
input: "a3 61 61 01 61 62 02 61 63 03",
expectedOutput: JSON.stringify({a: 1, b: 2, c: 3}),
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
},
{
op: "JSON Minify",
args: []
}
]
},
{
name: "From Hex: Can decode list",
input: "83 00 01 02",
expectedOutput: "[0,1,2]",
recipeConfig: [
{
op: "From Hex",
args: []
},
{
op: "CBOR Decode",
args: []
},
{
op: "JSON Minify",
args: []
}
]
},
{
name: "From Hex: Can round trip with encode",
input: JSON.stringify({a: 1, b: false, c: [1, 2, 3]}),
expectedOutput: JSON.stringify({a: 1, b: false, c: [1, 2, 3]}),
recipeConfig: [
{
op: "CBOR Encode",
args: []
},
{
op: "CBOR Decode",
args: []
},
{
op: "JSON Minify",
args: []
}
]
}
]);

0 comments on commit 6856427

Please sign in to comment.