Skip to content

Commit

Permalink
Intial Commit
Browse files Browse the repository at this point in the history
Consolidated IP Regex's

Fixed Logic Error

Added Tests

Removed Changes Outside Of Operation

Added to category
  • Loading branch information
h345983745 committed May 12, 2019
1 parent 0c9e8fe commit 219469f
Show file tree
Hide file tree
Showing 4 changed files with 142 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 @@ -177,7 +177,8 @@
"Group IP addresses",
"Encode NetBIOS Name",
"Decode NetBIOS Name",
"Defang URL"
"Defang URL",
"Defang IP"
]
},
{
Expand Down
75 changes: 75 additions & 0 deletions src/core/operations/DefangIP.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/**
* @author h345983745
* @copyright Crown Copyright 2019
* @license Apache-2.0
*/

import Operation from "../Operation";


/**
* Defang IP operation
*/
class DefangIP extends Operation {

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

this.name = "Defang IP";
this.module = "Default";
this.description = "Takes a IPV4 or IPV6 address and 'Defangs' it; meaning the IP becomes invalid, removing the risk of accidentally utilising it as an IP address.";
this.infoURL = "https://isc.sans.edu/forums/diary/Defang+all+the+things/22744/";
this.inputType = "string";
this.outputType = "string";
this.args = [
{
name: "IPV4",
type: "boolean",
value: true
},
{
name: "IPV6",
type: "boolean",
value: true
}
];
}

/**
* @param {string} input
* @param {Object[]} args
* @returns {string}
*/
run(input, args) {
const [IPV4, IPV6] = args;

if (IPV4) {
input = input.replace(IPV4_REGEX, x => {
return x.replace(/\./g, "[.]");
});
}
if (IPV6) {
input = input.replace(IPV6_REGEX, x => {
return x.replace(/:/g, "[:]");
});
}
return input;
}
}

export default DefangIP;


/**
* IPV4 regular expression
*/
const IPV4_REGEX = new RegExp("(?:(?:\\d|[01]?\\d\\d|2[0-4]\\d|25[0-5])\\.){3}(?:25[0-5]|2[0-4]\\d|[01]?\\d\\d|\\d)(?:\\/\\d{1,2})?", "g");


/**
* IPV6 regular expression
*/
const IPV6_REGEX = new RegExp("((?=.*::)(?!.*::.+::)(::)?([\\dA-Fa-f]{1,4}:(:|\\b)|){5}|([\\dA-Fa-f]{1,4}:){6})((([\\dA-Fa-f]{1,4}((?!\\3)::|:\\b|(?![\\dA-Fa-f])))|(?!\\2\\3)){2}|(((2[0-4]|1\\d|[1-9])?\\d|25[0-5])\\.?\\b){4})", "g");
1 change: 1 addition & 0 deletions tests/operations/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ import "./tests/Typex";
import "./tests/BLAKE2b";
import "./tests/BLAKE2s";
import "./tests/Protobuf";
import "./tests/DefangIP";

// Cannot test operations that use the File type yet
//import "./tests/SplitColourChannels";
Expand Down
64 changes: 64 additions & 0 deletions tests/operations/tests/DefangIP.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/**
* DefangIP tests.
*
* @author h345983745
*
* @copyright Crown Copyright 2017
* @license Apache-2.0
*/
import TestRegister from "../TestRegister";

TestRegister.addTests([
{
name: "Defang IP: Valid IPV4",
input: "192.168.1.1",
expectedOutput: "192[.]168[.]1[.]1",
recipeConfig: [
{
op: "Defang IP",
args: [true, true],
},
],
}, {
name: "Defang IP: Valid IPV6",
input: "2001:0db8:85a3:0000:0000:8a2e:0370:7343",
expectedOutput: "2001[:]0db8[:]85a3[:]0000[:]0000[:]8a2e[:]0370[:]7343",
recipeConfig: [
{
op: "Defang IP",
args: [true, true],
},
],
}, {
name: "Defang IP: Valid IPV6 Shorthand",
input: "2001:db8:3c4d:15::1a2f:1a2b",
expectedOutput: "2001[:]db8[:]3c4d[:]15[:][:]1a2f[:]1a2b",
recipeConfig: [
{
op: "Defang IP",
args: [true, true],
},
],
},
{
name: "Defang IP: IPV4 Only",
input: "192.168.1.1 2001:0db8:85a3:0000:0000:8a2e:0370:7343",
expectedOutput: "192[.]168[.]1[.]1 2001:0db8:85a3:0000:0000:8a2e:0370:7343",
recipeConfig: [
{
op: "Defang IP",
args: [true, false],
},
],
}, {
name: "Defang IP: IPV6 Only",
input: "192.168.1.1 2001:0db8:85a3:0000:0000:8a2e:0370:7343",
expectedOutput: "192.168.1.1 2001[:]0db8[:]85a3[:]0000[:]0000[:]8a2e[:]0370[:]7343",
recipeConfig: [
{
op: "Defang IP",
args: [false, true],
},
],
}
]);

0 comments on commit 219469f

Please sign in to comment.