More comments; moved the encryption system to unstable.

12 files changed, 38 insertions, 0 deletions

diff --git a/src/experimental/blowfish.cpp b/src/unstable/blowfish.cpp
index 3da32a9..3da32a9 100644
--- a/src/experimental/blowfish.cpp
+++ b/src/unstable/blowfish.cpp
diff --git a/src/experimental/blowfish.h b/src/unstable/blowfish.h
index b287bd4..b287bd4 100644
--- a/src/experimental/blowfish.h
+++ b/src/unstable/blowfish.h
diff --git a/src/experimental/cipher.cpp b/src/unstable/cipher.cpp
index e1ed0e5..e1ed0e5 100644
--- a/src/experimental/cipher.cpp
+++ b/src/unstable/cipher.cpp
diff --git a/src/experimental/cipher.h b/src/unstable/cipher.h
index 6e58613..eed73af 100644
--- a/src/experimental/cipher.h
+++ b/src/unstable/cipher.h
@@ -13,6 +13,16 @@
 
 namespace Bu
 {
+    /**
+     * Represents a nice base class for a stream filter block encryption scheme.
+     * This class handles efficient caching during reading and writing,
+     * encrypting and decrypting for block ciphers.  For each individual cipher
+     * you only have to worry about the block encryption and decryption.  Cipher
+     * modes are handled with seperate classes, see Bu::CipherModeCbc,
+     * Bu::CipherModeCfb, Bu::CipherModeEcb, and Bu::CipherModeOfb.
+     *
+     *
+     */
     template<int iBlockSize>
     class Cipher : public Bu::Filter
     {
diff --git a/src/experimental/ciphermodecbc.cpp b/src/unstable/ciphermodecbc.cpp
index 169c1d3..169c1d3 100644
--- a/src/experimental/ciphermodecbc.cpp
+++ b/src/unstable/ciphermodecbc.cpp
diff --git a/src/experimental/ciphermodecbc.h b/src/unstable/ciphermodecbc.h
index b06a972..19fdd7d 100644
--- a/src/experimental/ciphermodecbc.h
+++ b/src/unstable/ciphermodecbc.h
@@ -6,6 +6,11 @@
 
 namespace Bu
 {
+    /**
+     * Cipher-block chaining mode.  The Initialization Vector (IV) is fed into
+     * the first block, then each subsequent block is fed into the next making
+     * each block dependant on all previous blocks.
+     */
     template<int iBlockSize, typename CipherType>
     class CipherModeCbc : public CipherType
     {
diff --git a/src/experimental/ciphermodecfb.cpp b/src/unstable/ciphermodecfb.cpp
index 271d371..271d371 100644
--- a/src/experimental/ciphermodecfb.cpp
+++ b/src/unstable/ciphermodecfb.cpp
diff --git a/src/experimental/ciphermodecfb.h b/src/unstable/ciphermodecfb.h
index 34c682f..1c9c5e9 100644
--- a/src/experimental/ciphermodecfb.h
+++ b/src/unstable/ciphermodecfb.h
@@ -6,6 +6,12 @@
 
 namespace Bu
 {
+    /**
+     * Cipher Feedback mode.  This is very similar to the Cipher-block chaining
+     * mode, with a slight tweak (Bu::CipherModeCbc).  Each block is still
+     * dependant on all previous blocks.  Any corruption and the entire stream
+     * will be corrupt.
+     */
     template<int iBlockSize, typename CipherType>
     class CipherModeCfb : public CipherType
     {
diff --git a/src/experimental/ciphermodeecb.cpp b/src/unstable/ciphermodeecb.cpp
index 8856304..8856304 100644
--- a/src/experimental/ciphermodeecb.cpp
+++ b/src/unstable/ciphermodeecb.cpp
diff --git a/src/experimental/ciphermodeecb.h b/src/unstable/ciphermodeecb.h
index cac2beb..c4a7f23 100644
--- a/src/experimental/ciphermodeecb.h
+++ b/src/unstable/ciphermodeecb.h
@@ -3,6 +3,14 @@
 
 namespace Bu
 {
+    /**
+     * Electronic Code Book mode.  This cipher mode is the simplest, it's
+     * effectively a pass-through mode.  It's the same as using the encryption
+     * scheme without a mode, but at least you absolutely know that you've got
+     * the correct mode.  I recommend using this instead of the raw mode if for
+     * no other reason than it makes your code more self-documenting, and with
+     * optomization shouldn't add any extra calls to your code.
+     */
     template<int iBlockSize, typename CipherType>
     class CipherModeEcb : public CipherType
     {
diff --git a/src/experimental/ciphermodeofb.cpp b/src/unstable/ciphermodeofb.cpp
index bebbce2..bebbce2 100644
--- a/src/experimental/ciphermodeofb.cpp
+++ b/src/unstable/ciphermodeofb.cpp
diff --git a/src/experimental/ciphermodeofb.h b/src/unstable/ciphermodeofb.h
index e1b5108..19d0f83 100644
--- a/src/experimental/ciphermodeofb.h
+++ b/src/unstable/ciphermodeofb.h
@@ -6,6 +6,15 @@
 
 namespace Bu
 {
+    /**
+     * Output Feedback Mode.  This cipher mode is one of the most resiliant.
+     * Instead of encrypting your data directly it encrypts a "key stream" using
+     * the initialization vector, and then XORs those blocks with your stream
+     * blocks.  This means that an error in your stream will still produce an
+     * error in the output, but it will not propegate.  Also, with most
+     * encryption schemes error correction codes on the source data will still
+     * work on the encrypted data or decrypted output.
+     */
     template<int iBlockSize, typename CipherType>
     class CipherModeOfb : public CipherType
     {