support postprocessing steps and fix examples

Author: dem1fo

examples/file_based_usage.ts

@@ -13,7 +13,7 @@ const OUTPUT_PATH = join(__dirname, 'output', 'output_10.csv');
 const VALIDATION_ERRORS_PATH = join(__dirname, 'output', 'validation_errors.csv');
 
 // load configuration from file
-const configLoadResult = loadConfig(CONFIG_PATH, ALGORITHM_ID);
+const configLoadResult = loadConfig({ configPath: CONFIG_PATH, algorithmId: ALGORITHM_ID });
 if (!configLoadResult.success) throw new Error(`ERROR: Unable to load configuration file >> ${configLoadResult.error}`);
 
 // validate the input file against all configured validation rules.

package-lock.json

@@ -40,6 +40,7 @@
     "date-fns": "^4.1.0",
     "debug": "^4.3.7",
     "hi-base32": "^0.5.1",
+    "openpgp": "^6.2.2",
     "safe-stable-stringify": "^2.4.3",
     "toml": "^3.0.0",
     "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz"

package.json

@@ -14,10 +14,7 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-export {
-  generateHashesForDocument,
-  preprocessFile,
-  processFile,
-  validateDocument,
-} from './processing';
+export { preprocessFile, validateDocument } from './preprocess';
+export { generateHashesForDocument, processFile } from './process';
+export { postprocessFile, encryptFile } from './postprocess';
 export { keepOutputColumns } from './mapping';

src/processing/index.ts

@@ -0,0 +1,80 @@
+// Common Identifier Application
+// Copyright (C) 2024 World Food Programme
+
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import * as openpgp from 'openpgp';
+import { createReadStream, createWriteStream, readFileSync } from 'fs';
+import { pipeline } from 'stream/promises';
+import { Readable } from 'stream';
+
+import type { Config } from '../config/Config';
+
+import Debug from 'debug';
+const log = Debug('CID:postprocessFile');
+
+
+export interface PostprocessFileResult {
+  encryptedFilePath?: string
+}
+
+interface PostprocessFileInput {
+  config: Config.FileConfiguration,
+  filePath: string
+}
+
+export async function postprocessFile({ config, filePath }: PostprocessFileInput): Promise<PostprocessFileResult> {
+  log('------------ postprocessFile -----------------');
+  let encryptedFilePath: string | undefined;
+
+  if (!config.post_processing) return {}
+
+  if (config.post_processing.encryption) {
+    encryptedFilePath = await encryptFile({
+      filePath: filePath,
+      keyPath: config.post_processing.encryption.key_path
+    });
+  }
+
+  return {
+    encryptedFilePath
+  }
+}
+
+
+type EncryptFileInput = {
+  filePath: string;
+  keyPath: string;
+}
+export async function encryptFile({ filePath, keyPath }: EncryptFileInput) {
+  const publicKeyArmoured = readFileSync(keyPath, "utf-8");
+  const publicKey = await openpgp.readKey({ armoredKey: publicKeyArmoured });
+
+  const webStream  = Readable.toWeb(createReadStream(filePath));
+
+  const encryptionStream = await openpgp.encrypt({
+    message: await openpgp.createMessage({ binary: webStream }),
+    encryptionKeys: publicKey,
+    format: "binary"
+  });
+
+  const outputPath = `${filePath}.gpg`;
+
+  const nodeWritable = createWriteStream(outputPath);
+  const nodeReadable = Readable.fromWeb(encryptionStream);
+
+  await pipeline(nodeReadable, nodeWritable);
+
+  return outputPath;
+}