phime42/rubin

View on GitHub
doc/CryptoBox.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>class CryptoBox - RDoc Documentation</title>

<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
</script>

<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>


<body id="top" class="class">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="./index.html">Home</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  

  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>classes.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    <nav id="parent-class-section" class="section">
  <h3 class="section-header">Parent</h3>
  
  <p class="link">Object
  
</nav>

    
    
    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li ><a href="#method-c-new">::new</a>
    
    <li ><a href="#method-i-encrypt_string">#encrypt_string</a>
    
    <li ><a href="#method-i-generate_a_keypair">#generate_a_keypair</a>
    
    <li ><a href="#method-i-generate_keypair">#generate_keypair</a>
    
    <li ><a href="#method-i-host_encrypt_string">#host_encrypt_string</a>
    
    <li ><a href="#method-i-testing_generate_receiving_keypair">#testing_generate_receiving_keypair</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="./Gemfile.html">Gemfile</a>
  
    <li class="file"><a href="./Gemfile_lock.html">Gemfile.lock</a>
  
    <li class="file"><a href="./README_md.html">README</a>
  
    <li class="file"><a href="./doc/created_rid.html">created.rid</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="./CryptoBox.html">CryptoBox</a>
  
    <li><a href="./DatabaseBox.html">DatabaseBox</a>
  
    <li><a href="./EncryptedAdapter.html">EncryptedAdapter</a>
  
    <li><a href="./RbNaCl.html">RbNaCl</a>
  
    <li><a href="./RelayChat.html">RelayChat</a>
  
    <li><a href="./RestApi.html">RestApi</a>
  
    <li><a href="./Starter.html">Starter</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="class">class CryptoBox</h1>

  <div id="description" class="description">
    
<p>The class <a href="CryptoBox.html">CryptoBox</a> poses as a generic adapter
for cryptographic services. It uses the NaCl library by djb as backend.
Ruby binding is provided by <a href="RbNaCl.html">RbNaCl</a> by Tony
Arcieri</p>

  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    <!-- Methods -->
    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Class Methods</h3>

    
      <div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File classes.rb, line 335</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>
  <span class="ruby-identifier">database</span> = <span class="ruby-constant">DatabaseBox</span>.<span class="ruby-identifier">new</span>
  <span class="ruby-identifier">pub</span>, <span class="ruby-identifier">priv</span> = <span class="ruby-identifier">database</span>.<span class="ruby-identifier">output_host_keypair</span>
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">pub</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">priv</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span>
    <span class="ruby-comment"># apparently, there is no host keypair available, so a new one has to be generated, but not without snitching</span>
    <span class="ruby-identifier">puts</span> <span class="ruby-string">&#39;No host keypair available, have to generate a new one! Possible temper alert!&#39;</span>
    <span class="ruby-identifier">new_pub</span>, <span class="ruby-identifier">new_priv</span> = <span class="ruby-identifier">generate_keypair</span>
    <span class="ruby-identifier">database</span>.<span class="ruby-identifier">register_key</span>(<span class="ruby-string">&#39;host&#39;</span>, <span class="ruby-string">&#39;127.0.0.1&#39;</span>, <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">new_priv</span>), <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">new_pub</span>))
  <span class="ruby-keyword">else</span>
    <span class="ruby-ivar">@public_key</span> = <span class="ruby-identifier">pub</span>
    <span class="ruby-ivar">@private_key</span> = <span class="ruby-identifier">priv</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- new-source -->
          
        </div>

        

        
      </div><!-- new-method -->

    
    </section><!-- public-class-method-details -->
  
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Instance Methods</h3>

    
      <div id="method-i-encrypt_string" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">encrypt_string</span><span
            class="method-args">(string_to_encrypt, sender_private_key, receiver_public_key)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Encrypts a given string with the given receiver public key and signs the
message with a given private key</p>
          
          

          
          <div class="method-source-code" id="encrypt_string-source">
            <pre><span class="ruby-comment"># File classes.rb, line 380</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">encrypt_string</span>(<span class="ruby-identifier">string_to_encrypt</span>, <span class="ruby-identifier">sender_private_key</span>, <span class="ruby-identifier">receiver_public_key</span>)
  <span class="ruby-constant">RbNaCl</span><span class="ruby-operator">::</span><span class="ruby-constant">SimpleBox</span>.<span class="ruby-identifier">from_keypair</span>(<span class="ruby-identifier">receiver_public_key</span>, <span class="ruby-identifier">sender_private_key</span>).<span class="ruby-identifier">encrypt</span>(<span class="ruby-identifier">string_to_encrypt</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- encrypt_string-source -->
          
        </div>

        

        
      </div><!-- encrypt_string-method -->

    
      <div id="method-i-generate_a_keypair" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">generate_a_keypair</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Generates a new NaCl keypair, but does not touch instance variables.</p>
          
          

          
          <div class="method-source-code" id="generate_a_keypair-source">
            <pre><span class="ruby-comment"># File classes.rb, line 367</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">generate_a_keypair</span>
  <span class="ruby-identifier">keypair</span> = <span class="ruby-constant">RbNaCl</span><span class="ruby-operator">::</span><span class="ruby-constant">PrivateKey</span>.<span class="ruby-identifier">generate</span>
  <span class="ruby-identifier">private_key</span> = <span class="ruby-identifier">keypair</span>
  <span class="ruby-identifier">public_key</span> = <span class="ruby-identifier">keypair</span>.<span class="ruby-identifier">public_key</span>
  <span class="ruby-keyword">return</span> <span class="ruby-identifier">public_key</span>, <span class="ruby-identifier">private_key</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- generate_a_keypair-source -->
          
        </div>

        

        
      </div><!-- generate_a_keypair-method -->

    
      <div id="method-i-generate_keypair" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">generate_keypair</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Generates a new NaCl keypair also sets the @public_key and @private_key
instance variables Due to the switch to <a href="RbNaCl.html">RbNaCl</a> a
seperate handling of the messenge&#39;s nonce is no longer needed!</p>
          
          

          
          <div class="method-source-code" id="generate_keypair-source">
            <pre><span class="ruby-comment"># File classes.rb, line 359</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">generate_keypair</span>
  <span class="ruby-identifier">keypair</span> = <span class="ruby-constant">RbNaCl</span><span class="ruby-operator">::</span><span class="ruby-constant">PrivateKey</span>.<span class="ruby-identifier">generate</span>
  <span class="ruby-ivar">@private_key</span> = <span class="ruby-identifier">keypair</span>
  <span class="ruby-ivar">@public_key</span> = <span class="ruby-identifier">keypair</span>.<span class="ruby-identifier">public_key</span>
  <span class="ruby-keyword">return</span> <span class="ruby-ivar">@public_key</span>, <span class="ruby-ivar">@private_key</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- generate_keypair-source -->
          
        </div>

        

        
      </div><!-- generate_keypair-method -->

    
      <div id="method-i-host_encrypt_string" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">host_encrypt_string</span><span
            class="method-args">(string_to_encrypt, receiver_public_key)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Encrypts a given string with the given pubkey, signed with the host keypair</p>
          
          

          
          <div class="method-source-code" id="host_encrypt_string-source">
            <pre><span class="ruby-comment"># File classes.rb, line 375</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">host_encrypt_string</span>(<span class="ruby-identifier">string_to_encrypt</span>, <span class="ruby-identifier">receiver_public_key</span>)
  <span class="ruby-constant">RbNaCl</span><span class="ruby-operator">::</span><span class="ruby-constant">SimpleBox</span>.<span class="ruby-identifier">from_keypair</span>(<span class="ruby-identifier">receiver_public_key</span>, <span class="ruby-ivar">@private_key</span>).<span class="ruby-identifier">encrypt</span>(<span class="ruby-identifier">string_to_encrypt</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- host_encrypt_string-source -->
          
        </div>

        

        
      </div><!-- host_encrypt_string-method -->

    
      <div id="method-i-testing_generate_receiving_keypair" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">testing_generate_receiving_keypair</span><span
            class="method-args">()</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          <p>Generates a keypair in order to receive messages. For testing only.</p>
          
          

          
          <div class="method-source-code" id="testing_generate_receiving_keypair-source">
            <pre><span class="ruby-comment"># File classes.rb, line 350</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">testing_generate_receiving_keypair</span>
  <span class="ruby-identifier">db</span> = <span class="ruby-constant">DatabaseBox</span>.<span class="ruby-identifier">new</span>
  <span class="ruby-identifier">pub</span>, <span class="ruby-identifier">priv</span> = <span class="ruby-identifier">generate_a_keypair</span>
  <span class="ruby-identifier">db</span>.<span class="ruby-identifier">register_key</span>(<span class="ruby-string">&#39;example description&#39;</span>, <span class="ruby-string">&#39;horst&#39;</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-constant">Base64</span>.<span class="ruby-identifier">encode64</span>(<span class="ruby-identifier">pub</span>))
<span class="ruby-keyword">end</span></pre>
          </div><!-- testing_generate_receiving_keypair-source -->
          
        </div>

        

        
      </div><!-- testing_generate_receiving_keypair-method -->

    
    </section><!-- public-instance-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>