Merge branch 'release/v1' into main

Author: warstrolo

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

README.md

@@ -1,2 +1,5 @@
 # secutilsfiles
 simple utils to crypt / decrypt files with AES
+
+
+# 

package-lock.json

@@ -0,0 +1,33 @@
+{
+  "name": "secutilsfiles",
+  "version": "1.0.0",
+  "description": "A simple package to crypt and decrypt files",
+  "main": "dist/index.js",
+  "scripts": {
+    "start": "tsc && node .",
+    "test": "node test"
+  },
+  "files": [
+    "./"
+  ],
+  "author": "Paul Millet <[email protected]>",
+  "license": "MIT",
+  "dependencies": {
+    "@types/node": "^16.7.2",
+    "aes256": "^1.1.0",
+    "cryptr": "^6.0.2",
+    "dotenv": "^10.0.0",
+    "typescript": "^4.4.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bigopenworld/secutilsfiles.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bigopenworld/secutilsfiles/issues"
+  },
+  "homepage": "https://github.com/bigopenworld/secutilsfiles/issues",
+  "devDependencies": {
+    "@types/cryptr": "^4.0.1"
+  }
+}

package.json

@@ -0,0 +1,79 @@
+// dependency import
+
+import Cryptr from "cryptr"
+import fs from "fs"
+import  { promisify } from "util"
+
+// Define const
+
+
+const readdir = promisify(fs.readdir) // promisify the fs.readdir 
+const readfile = promisify(fs.readFile) // promisify the fs.readFile
+const writefile = promisify(fs.writeFile) // promisify the fs.writeFile
+const randomChar = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
+const randomcharlengh = randomChar.length;
+
+/** Read dir function
+* @param {string} directory take the directory
+* @return {Promise<string[]>} return a promise of files path
+* Will be use when encrypt dir feature will be created
+*/
+async function readDir(directory : string) : Promise<string[]> {
+  let files = await readdir(directory)
+  return files.map(file => `${directory}/${file}`)
+}
+
+/** Read file function
+* @param {string} path take the path
+* @return {Promise<string>} return promise of data
+*/
+async function readFile(path : string) : Promise<string> {
+  let files : Buffer = await readfile(path)
+  return files.toString()
+}
+
+/** RandomString function 
+* @param {number} length take the number of element in your string
+* @return {string} Return the random string 
+*/
+function RandomString(length : number) : string {
+  var result : string
+  for ( var i = 0; i < length; i++ ) {
+    result += randomChar.charAt(Math.floor(Math.random() * randomcharlengh));
+  }
+  return result
+}
+
+/** CryptFile function 
+* @param {string} path take the path of the input file
+* @param {string} dest take the path of the destination file
+* @param {string | undefined} key take the key if none specified one will be generated 
+* @return {string} Return the key
+*/
+async function CryptFile(path : string, dest : string, key? : string) : Promise<string> {
+  let enckey = key
+  if (!enckey) {
+    enckey = RandomString(20)
+  }
+  let crypt = new Cryptr(enckey)
+  const data = await readFile(path)
+  const dataenc = crypt.encrypt(data)
+  await writefile(dest, dataenc)
+  return enckey
+}
+
+/** CryptFile function 
+* @param {string} path take the path of the input file
+* @param {string} dest take the path of the destination file
+* @param {string} key take the secret key
+* @return {string} Return the key
+*/
+async function DecryptFile(path : string, dest : string, key : string) : Promise<string> {
+  let enckey = key
+  let crypt = new Cryptr(enckey)
+  const data = await readFile(path)
+  const dataenc = crypt.decrypt(data)
+  await writefile(dest, dataenc)
+  return enckey
+}
+

src/index.ts

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "outDir": "dist"
+  },
+  "lib": ["es2015"]
+}