Added CTR mode

Author: Varbin

README.rst

@@ -21,8 +21,8 @@ Features
 
 Because it's build direct on top of the reference implementation, the python-camellia library provides direct 
 access to extreme low-level functions like *Camellia-Ekeygen* but also provides a nearly PEP-compliant 
-cryptographic interface. This semi low-level interface supports encryption (and decryption) in ECB and 
-CBC mode.
+cryptographic interface. This semi low-level interface supports encryption (and decryption) in ECB, 
+CBC and CTR mode.
 
 Installation
 ============
@@ -111,6 +111,7 @@ This software contains compiled encryption algorithms which is restricted by law
 Changelog
 =========
 
-Version 1.0, 2016-10-19:
+For Version 1.0:
     -   The "normal" camellia version is used instead of the mini or reference version.
-    -   Camellia is now loaded using CFFI. This improves speed and avoids shipped DLLs. It's better than the self-made-on-first-use compilation.
+    -   Camellia is now loaded using CFFI. This improves speed and avoids shipped DLLs. It's better than the self-made-on-first-use compilation.
+    -   Supports CTR mode

doc/_build/doctrees/API.doctree

@@ -1,4 +1,4 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c411847dc38334b72e6da1e42e416489
-tags: 645f666f9bcd5a90fca523b33c5a78b7
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a9bd01a32b8279da3f18ac4c36c111ab
+tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/_build/doctrees/environment.pickle

@@ -17,18 +17,19 @@
         VERSION:     '1.0',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
-        HAS_SOURCE:  true
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
       };
     </script>
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
     <script type="text/javascript" src="_static/doctools.js"></script>
-    <link rel="top" title="python-camellia 1.0 documentation" href="index.html" />
-    <link rel="prev" title="Welcome to python-camellia’s documentation!" href="index.html" />
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Licenses" href="license.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
-  
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
   </head>
@@ -46,7 +47,7 @@ <h1>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</
 <h2>The <em>new</em> constructor<a class="headerlink" href="#the-new-constructor" title="Permalink to this headline">¶</a></h2>
 <dl class="function">
 <dt id="camellia.new">
-<code class="descclassname">camellia.</code><code class="descname">new</code><span class="sig-paren">(</span><em>key</em>, <em>mode=1</em>, <em>IV=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#camellia.new" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">camellia.</code><code class="descname">new</code><span class="sig-paren">(</span><em>key</em>, <em>mode=1</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#camellia.new" title="Permalink to this definition">¶</a></dt>
 <dd><p>Create an &#8220;CamelliaCipher&#8221; object.
 It&#8217;s not fully PEP-272 comliant (yet).
 The default mode is ECB.</p>
@@ -56,9 +57,9 @@ <h2>The <em>new</em> constructor<a class="headerlink" href="#the-new-constructor
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>key</strong> (<em>bytestring</em>) &#8211; The key for encrytion/decryption. Must be 16/24/32 in length.</li>
-<li><strong>mode</strong> (<em>int, on of MODE_* constants</em>) &#8211; Mode of operation, only ECB (0) and CBC (1) are supported.</li>
+<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a><em>, </em><em>on of MODE_* constants</em>) &#8211; Mode of operation, only ECB (0) and CBC (1) are supported.</li>
 <li><strong>IV</strong> (<em>bytestring</em>) &#8211; Initialisation vector for CBC/CFB/OFB, must be 16 in length.</li>
-<li><strong>counter</strong> (<em>callable, must return bytestrings</em>) &#8211; Counter for CTR.</li>
+<li><strong>counter</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#callable" title="(in Python v2.7)"><em>callable</em></a><em>, </em><em>must return bytestrings</em>) &#8211; Counter for CTR.</li>
 </ul>
 </td>
 </tr>
@@ -102,7 +103,7 @@ <h2>Modes of operation<a class="headerlink" href="#modes-of-operation" title="Pe
 <dl class="data">
 <dt id="camellia.MODE_CTR">
 <code class="descclassname">camellia.</code><code class="descname">MODE_CTR</code><em class="property"> = 6</em><a class="headerlink" href="#camellia.MODE_CTR" title="Permalink to this definition">¶</a></dt>
-<dd><p>CTR mode of operation, currently not supported</p>
+<dd><p>CTR mode of operation</p>
 </dd></dl>
 
 </div>
@@ -211,14 +212,14 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="index.html" title="previous chapter">Welcome to python-camellia&#8217;s documentation!</a></li>
+      <li>Previous: <a href="license.html" title="previous chapter">Licenses</a></li>
   </ul></li>
 </ul>
 </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
-      <li><a href="_sources/API.txt"
+      <li><a href="_sources/API.rst.txt"
             rel="nofollow">Show Source</a></li>
     </ul>
    </div>
@@ -240,11 +241,11 @@ <h3>Quick search</h3>
       &copy;2016, Simon Biewald.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.6</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
 
       |
-      <a href="_sources/API.txt"
+      <a href="_sources/API.rst.txt"
           rel="nofollow">Page source</a>
     </div>
 

doc/_build/doctrees/index.doctree

@@ -0,0 +1,32 @@
+API
+===
+
+
+The *new* constructor
+---------------------
+
+.. autofunction:: camellia.new
+
+Modes of operation
+------------------
+
+.. autodata:: camellia.MODE_ECB
+.. autodata:: camellia.MODE_CBC
+.. autodata:: camellia.MODE_CFB
+.. autodata:: camellia.MODE_OFB
+.. autodata:: camellia.MODE_CTR
+
+The *CamelliaCipher* class
+--------------------------
+
+.. autoclass:: camellia.CamelliaCipher
+    :members:
+    
+    .. automethod:: camellia.CamelliaCipher.__init__
+    
+Low-level camellia functions
+----------------------------
+
+.. autofunction:: camellia.Camellia_Ekeygen
+.. autofunction:: camellia.Camellia_Encrypt
+.. autofunction:: camellia.Camellia_Decrypt

doc/_build/doctrees/install.doctree

@@ -0,0 +1,31 @@
+.. python-camellia documentation master file, created by
+   sphinx-quickstart on Sun Oct 30 00:20:11 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to python-camellia's documentation!
+===========================================
+
+This is the documentation of python-camellia, 
+a cryptographic library implementing the
+`Camellia <https://tools.ietf.org/html/rfc3713>`_ cipher in python.
+
+.. code:: python
+
+   >>> import camellia
+   >>> plain = b"This is a text. "
+   >>> c1 = camellia.CamelliaCipher(key=b'16 byte long key', IV=b'16 byte iv. xxxx', mode=camellia.MODE_CBC)
+   >>> encrypted = c1.encrypt(plain)
+   >>> c2 = camellia.CamelliaCipher(key=b'16 byte long key', IV=b'16 byte iv. xxxx', mode=camellia.MODE_CBC)
+   >>> c2.decrypt(encrypted)
+   b'This is a text. '
+
+
+.. toctree::
+   :maxdepth: 2
+
+   install
+   license
+   API
+
+