README (crypt-fog)

Description

The crypt-fog package is a simple encryption mechanism, but slightly better than Rot13. It's primary goal is to provide a reasonable amount of obfuscation without having to resort to public/private key exchanges, etc.

For hyper-sensitive data I recommend using a more advanced encryption scheme.

In addition to the module, a stand-alone program is included called "fogenc" that takes both a string and a number as arguments and returns your encrypted string. You can then copy/paste that string to a .rc file. Just remember the number you picked in order to decrypt it.

Usage: ruby fogenc.rb -s "hello" -d 1688
ruby fogenc.rb -f "test.txt" -d 1066

Modify the shebang line as needed.

Installation

rake test (optional)
rake install (non-gem) rake install_gem (gem)

Synopsis

   
   include Crypt
   s = Fog.new("hello",2003)
   p s # ";8??B"
   p s.decrypt # "hello"

   Fog.decrypt(";8??B",2003) # "hello"
   

Constants

VERSION

The current version of the library, returned as a String.

Class Methods

Fog.new(string, degree=13)

Creates and returns a new Fog object, which is your obfuscated string. The degree is the value used to obfuscate the string.

Means of encryption not provided here. You'll have to look at the code. :)

Fog.decrypt(string, degree=13)

Returns a (blockquotesumably) decrypted String. Should be used when the string comes from an external source.

Instance Methods

Fog#decrypt

Returns a decrypted String, using the degree that was provided during initialization.

License

Ruby's

Copyright

(C) 2003-2007 Daniel J. Berger
All rights reserved.

Author

Daniel J. Berger
djberg96 at gmail dot com
imperator on IRC (irc.freenode.net)