obfusc

Simple command line tool to obfuscate a recursive tree of files. Basically just rename a list of files using a random and reversible name. Probably no one will use it. It's something that I'd be interested in when I was a teenager and tried to hide inappropriate files on my PC.

Always preferer "copy" command over "move". Unless you know exactly what are you doing.

Installation

Just install this gem by running

gem install obfusc

After successfully installed a new bin obfusc will be available.

Configuration

First thing you will need to create a $HOME/.obfusc.cnf with with secret and token keys by executing the following command:

obfusct config generate

Here is an example of generated file:

$ cat ~/.obfusc.cnf
---
prefix: "obfusc"
suffix: "obfusc"
token: "@l(piZ3ynEz8tjs ,v7DUGP}SmrNMF:f=k4hbBc[dYWIo_uLJq|a9O]5gRK-T6AeXwQ);C{x1H02V"
secret: "-A:z0rH2Zc4Gb6L@;Cwyd3g)l7JRIa[x]hWsoUD_Epe5O}jifu QqM{89FT=SvVBn1t,|P(NmXKkY"

It's recommended to make a backup of this file before start using this script. All obfuscated depends on token and secret from this config file. All the obfuscated files can no longer be recovered if you overwrite .obfusc.cnf.

Usage

Use obfusc --help to show basic usage and all commands available.

obfusc <command> <arguments> <options>

Commands

• setup
• crypt
• decrypt

Options

-c, --config FILENAME            Using a different ".obfusc.cnf" filename (Default to $HOME/.obfusc.cnf)
-e, --extension STRING           Specify a custom file extension. (Default to "obfc")
-p, --prefix STRING              Specify a custom file prefix. (Default to "obfc")
-v, --[no-]verbose               Run verbosely
-s, --[no-]simulate              Do a simulate run without executing actions

Crypt command

crypt is the command used to obfuscated one or more files. Should always be followed by <move OR copy> and <source> and an optional <target>.

Example:

# Simulate what will happen by executing this command
$ obfusc crypt copy -v -s empty.gif
DEBUG: cp empty.gif ./obfusc__6GP5D.nHv.obfusc

# Obfuscate the "empty.gif" file with the `copy` mode.
$ obfusc crypt copy empty.gif

# Show obfuscated file
$ obfusc show ./
./obfusc__6GP5D.nHv.obfusc:
---> empty.gif

# `copy` always keep the original file
$ ls empty.gif
empty.gif

Decrypt command

decrypt is the command used to revert to original filename one or more obfuscated files. Should always be followed by <move OR copy> and <source> and an optional <target>.

Example:

# Simulate what will happen by executing this command
$ obfusc decrypt copy -s -v ./ /tmp/target
DEBUG: mkdir -p /tmp/target
DEBUG: cp ./obfusc__6GP5D.nHv.obfusc /tmp/target/empty.gif

# Rename obfuscated file to the original name and copy to the target directory
$ obfusc decrypt copy ./ /tmp/target

# Show un-obfuscated file
$ ls /tmp/target
empty.gif

# Original obfuscated file still existing with copy mode
$ ls ./obfusc__6GP5D.nHv.obfusc
./obfusc__6GP5D.nHv.obfusc