Tidied up Citrix CTX1 operations and updated CHANGELOG

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 All notable changes to CyberChef will be documented in this file.
 
+### [8.12.0] - 2018-11-21
+- 'Citrix CTX1 Encode' and 'Citrix CTX1 Decode' operations added [@bwhitn] | [#428]
+
 ### [8.11.0] - 2018-11-13
 - 'CSV to JSON' and 'JSON to CSV' operations added [@n1474335] | [#277]
 
@@ -87,6 +90,7 @@ All notable changes to CyberChef will be documented in this file.
 [@PenguinGeorge]: https://github.com/PenguinGeorge
 [@arnydo]: https://github.com/arnydo
 [@klaxon1]: https://github.com/klaxon1
+[@bwhitn]: https://github.com/bwhitn
 
 [#95]: https://github.com/gchq/CyberChef/pull/299
 [#173]: https://github.com/gchq/CyberChef/pull/173
@@ -109,3 +113,4 @@ All notable changes to CyberChef will be documented in this file.
 [#351]: https://github.com/gchq/CyberChef/pull/351
 [#387]: https://github.com/gchq/CyberChef/pull/387
 [#394]: https://github.com/gchq/CyberChef/pull/394
+[#428]: https://github.com/gchq/CyberChef/pull/428

src/core/config/Categories.json

@@ -68,8 +68,6 @@
             "Blowfish Decrypt",
             "DES Encrypt",
             "DES Decrypt",
-            "Citrix CTX1 Encode",
-            "Citrix CTX1 Decode",
             "Triple DES Encrypt",
             "Triple DES Decrypt",
             "RC2 Encrypt",
@@ -97,6 +95,8 @@
             "JWT Sign",
             "JWT Verify",
             "JWT Decode",
+            "Citrix CTX1 Encode",
+            "Citrix CTX1 Decode",
             "Pseudo-Random Number Generator"
         ]
     },

src/core/operations/CitrixCTX1Decode.mjs

@@ -1,25 +1,26 @@
 /**
  * @author bwhitn [brian.m.whitney@gmail.com]
- * @copyright Crown Copyright 2017
+ * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
 
 import Operation from "../Operation";
+import OperationError from "../errors/OperationError";
 import cptable from "../vendor/js-codepage/cptable.js";
 
 /**
- * Encode Citrix CTX1 class
+ * Citrix CTX1 Decode operation
  */
-class DecodeCitrixCTX1 extends Operation {
+class CitrixCTX1Decode extends Operation {
 
     /**
-     * EncodeCitrixCTX1 constructor
+     * CitrixCTX1Decode constructor
      */
     constructor() {
         super();
 
         this.name = "Citrix CTX1 Decode";
-        this.module = "Ciphers";
+        this.module = "Encodings";
         this.description = "Decodes strings in a Citrix CTX1 password format to plaintext.";
         this.infoURL = "https://www.reddit.com/r/AskNetsec/comments/1s3r6y/citrix_ctx1_hash_decoding/";
         this.inputType = "byteArray";
@@ -34,13 +35,13 @@ class DecodeCitrixCTX1 extends Operation {
      */
     run(input, args) {
         if (input.length % 4 !== 0) {
-            return "";
+            throw new OperationError("Incorrect hash length");
         }
         const revinput = input.reverse();
         const result = [];
         let temp = 0;
-        for (let i = 0; i < revinput.length; i+=2) {
+        for (let i = 0; i < revinput.length; i += 2) {
-            if (i+2 >= revinput.length) {
+            if (i + 2 >= revinput.length) {
                 temp = 0;
             } else {
                 temp = ((revinput[i + 2] - 0x41) & 0xf) ^ (((revinput[i + 3]- 0x41) << 4) & 0xf0);
@@ -54,4 +55,4 @@ class DecodeCitrixCTX1 extends Operation {
 
 }
 
-export default DecodeCitrixCTX1;
+export default CitrixCTX1Decode;

src/core/operations/CitrixCTX1Encode.mjs

@@ -1,6 +1,6 @@
 /**
  * @author bwhitn [brian.m.whitney@gmail.com]
- * @copyright Crown Copyright 2017
+ * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
 
@@ -8,18 +8,18 @@ import Operation from "../Operation";
 import cptable from "../vendor/js-codepage/cptable.js";
 
 /**
- * Encode Citrix CTX1 class
+ * Citrix CTX1 Encode operation
  */
-class EncodeCitrixCTX1 extends Operation {
+class CitrixCTX1Encode extends Operation {
 
     /**
-     * EncodeCitrixCTX1 constructor
+     * CitrixCTX1Encode constructor
      */
     constructor() {
         super();
 
         this.name = "Citrix CTX1 Encode";
-        this.module = "Ciphers";
+        this.module = "Encodings";
         this.description = "Encodes strings to Citrix CTX1 password format.";
         this.infoURL = "https://www.reddit.com/r/AskNetsec/comments/1s3r6y/citrix_ctx1_hash_decoding/";
         this.inputType = "string";
@@ -33,7 +33,7 @@ class EncodeCitrixCTX1 extends Operation {
      * @returns {byteArray}
      */
     run(input, args) {
-        const utf16pass = Buffer.from(cptable.utils.encode(1200, input));
+        const utf16pass = Array.from(cptable.utils.encode(1200, input));
         const result = [];
         let temp = 0;
         for (let i = 0; i < utf16pass.length; i++) {
@@ -47,4 +47,4 @@ class EncodeCitrixCTX1 extends Operation {
 
 }
 
-export default EncodeCitrixCTX1;
+export default CitrixCTX1Encode;

test/tests/operations/Ciphers.mjs

@@ -245,7 +245,7 @@ TestRegister.addTests([
     {
         name: "Citrix CTX1 Decode: invalid length",
         input: "PFFAJEDBOHECJEDBODEGIMCJPOFLJKDPKLA",
-        expectedOutput: "",
+        expectedOutput: "Incorrect hash length",
         recipeConfig: [
             {
                 "op": "Citrix CTX1 Decode",