rack-simple_auth 1.0.0rc → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: ebfdad444b3dd93872a40ed95da0113777be8be7
-  data.tar.gz: 6dd2b76e1ef8e8916dc4870a4567f71e624ff8f1
-SHA512:
-  metadata.gz: 847a3ef324399d4bc6a9a1edc40046d200c0112997f55163cd71d6e1edb798faa163479ed046e5f49b7f57559f988549ad90ad3bc043357996ed1ecb38eacc85
-  data.tar.gz: 092eb1391821c56ae96a20cfb66053ccb5b4d83992c964e9d2369f72ecd7949064e0eb05b21b3de0e2454d21f532b9e8cadea92907d40d32e9ca0802e1f43613
+--- 
+SHA1: 
+  metadata.gz: 40096c8f67c41259b34e662419464350f2ccaea7
+  data.tar.gz: 1ee42ec21e3b7defd704872cb5752ed02451f7a6
+SHA512: 
+  metadata.gz: 8a87664b0113fcc0ec50bb4256c24bda3e04c19bc8ba9f1066f02623bf274878ee8df5ebed5038031da010c5c18c806c8c7788a882a4d58c0718980c44e0ba84
+  data.tar.gz: b1033d3210ceccaf16cce58fc5e89f8c97fe3457fd6349c82fd81ef52404382ccc7812bc81eaea274050cf669fcb9887dc7102df6ab54082fd5c0d4c8be7317f

data/MANIFEST

@@ -1,37 +1,37 @@
-.gitignore
-.rubocop.yml
-.travis.yml
-.yardopts
-Gemfile
 LICENSE.txt
 MANIFEST
-README.md
-Rakefile
+README.rdoc
 checksum/rack-simple_auth-0.0.9.gem.sha512
 checksum/rack-simple_auth-0.1.0.gem.sha512
 checksum/rack-simple_auth-0.1.1.gem.sha512
 checksum/rack-simple_auth-0.1.2.gem.sha512
+checksum/rack-simple_auth-1.0.0.gem.sha512
+checksum/rack-simple_auth-1.0.0rc.gem.sha512
+doc/Rack.html
+doc/Rack/SimpleAuth.html
+doc/Rack/SimpleAuth/HMAC.html
+doc/Rack/SimpleAuth/HMAC/Config.html
+doc/Rack/SimpleAuth/HMAC/Middleware.html
+doc/Rack/SimpleAuth/Logger.html
+doc/_index.html
+doc/class_list.html
+doc/css/common.css
+doc/css/full_list.css
+doc/css/style.css
+doc/examples/index.php
+doc/examples/rack_lobster.ru
+doc/file.README.html
+doc/file_list.html
+doc/frames.html
+doc/index.html
+doc/js/app.js
+doc/js/full_list.js
+doc/js/jquery.js
+doc/method_list.html
+doc/top-level-namespace.html
 lib/rack/simple_auth.rb
 lib/rack/simple_auth/hmac/config.rb
 lib/rack/simple_auth/hmac/middleware.rb
 lib/rack/simple_auth/logger.rb
 lib/rack/simple_auth/version.rb
-rack-simple_auth.gemspec
-rubocop-todo.yml
-task/build.rake
-task/checksum.rake
-task/console.rake
-task/default.rake
-task/floodtest.rake
-task/manifest.rake
-task/test.rake
-test/rack/simple_auth/hmac/config.ru
-test/rack/simple_auth/hmac/config_fail.ru
-test/rack/simple_auth/hmac/config_fail_option.ru
-test/rack/simple_auth/hmac/config_fail_run.ru
-test/rack/simple_auth/hmac/config_fail_step.ru
-test/rack/simple_auth/hmac/config_fail_tolerance.ru
-test/rack/simple_auth/hmac/hmac_fail_run_test.rb
-test/rack/simple_auth/hmac/hmac_fail_test.rb
-test/rack/simple_auth/hmac/hmac_test.rb
-test/test_helper.rb
+rack-simple_auth.gemspec

data/README.rdoc

@@ -0,0 +1,121 @@
+= What is Rack::SimpleAuth
+
+Rack::SimpleAuth will contain different Authentication Class Middlewares
+
+Until now only HMAC is implemented...
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    $ gem 'rack-simple_auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-simple_auth
+
+== Gem Status
+
+{<img src="https://travis-ci.org/Benny1992/rack-simple_auth.svg?branch=v1.0.0rc" alt="Build Status" />}[https://travis-ci.org/Benny1992/rack-simple_auth]
+{<img src="https://coveralls.io/repos/Benny1992/rack-simple_auth/badge.png" alt="Code Coverage" />}[https://coveralls.io/r/Benny1992/rack-simple_auth]
+{<img src="https://badge.fury.io/rb/rack-simple_auth.png" alt="Gem Version" />}[http://badge.fury.io/rb/rack-simple_auth]
+{<img src="https://gemnasium.com/Benny1992/rack-simple_auth.png" alt="Dependency Status" />}[https://gemnasium.com/Benny1992/rack-simple_auth]
+{<img src="https://www.codeship.io/projects/f2d9d790-b0fe-0131-3fd5-025f180094b5/status" alt="Build Status" />}[https://www.codeship.io/projects/f2d9d790-b0fe-0131-3fd5-025f180094b5/status]
+
+== Usage
+
+=== HMAC
+
+To use HMAC Authorization you have to use the Rack::SimpleAuth::HMAC::Middleware for your Rack App
+
+Basic Usage:
+
+    require 'rack/lobster'
+    require 'rack/simple_auth'
+
+    request_config = {
+      'GET' => 'path',
+      'POST' => 'params',
+      'DELETE' => 'path',
+      'PUT' => 'path',
+      'PATCH' => 'path'
+    }
+
+    use Rack::SimpleAuth::HMAC::Middleware do |options|
+      options.tolerance = 1500 # 1500ms -> 1.5s
+
+      options.secret = 'test_secret'
+      options.signature = 'test_signature'
+
+      options.logpath = "#{File.expand_path('..', __FILE__)}/logs"
+      options.request_config = request_config
+    end
+
+    run Rack::Lobster.new
+
+In general each request has a message (which is encrypted) in following format:
+
+    { 'method' => @request.request_method, 'date' => date, 'data' => request_data }.to_json
+
+For example accessing +GET /test+ with this configuration represents following message
+
+    { 'method' => 'GET', 'date' => 1398821451494, 'data' => '/test' }.to_json
+
+
+With the tolerance there is an adjustable amount of messages wich are built (Rack::SimpleAuth::HMAC::Middleware#allowed_messages)
+
+This means a request could have a certain latency (delay) and the request is still authorized
+
+
+==== Secure your REST Api:
+
+To secure your REST Api you have to send the HTTP_AUTHORIZATION Header with each request where the HMAC Middleware is used.
+
+For example +POST /form+ with params +{ name => benny1992 }+ is secured the following way:
+
+Uncrypted Message:
+
+  { 'method' => 'POST', 'date' => timestamp +- tolerance, 'data' => { 'name' => 'benny1992' } }.to_json
+
+Encryption Mechanism:
+
+  OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @config.secret, message(date, i))
+
+where @config.secret represents your secret which was set in the middleware dsl block and message represents the uncrypted message
+for the specific timestamp(date) and delay(i)
+
+===== Therefore you need following encryption mechanism on the client side (pseudocode):
+
+  encrypted_message = OpenSSL::HMAC.hexdigest(OpenSSL:Digest.new('sha256'), 'test_secret', message)
+
+  HTTP_AUTHORIZATION = encrypted_message:'test_signature'
+
+===== Time formats
+
+The timestamp and tolerance are in millisecond format:
+
+In Ruby land this means:
+
+  (Time.now.to_f * 1000).to_i
+
+For PHP you have to use +round()+ and +microtime()+ :
+
+  round(microtime(true) * 1000)
+
+===== General your timestamp should only contain 13 digits and NO floating part
+
+==== Examples
+
+Examples can be found in doc/examples
+
+== Contributing
+
+1. Fork it ( http://github.com/benny1992/rack-simple_auth/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/checksum/rack-simple_auth-1.0.0.gem.sha512

@@ -0,0 +1 @@
+b88704d60bd82de20893861f9d524a8a0d433c7af1b21501d9e69fc6da5a847455c86e01e83743439a5bd46fc9feb66a4371f9c9560f08f8d9de60fdf649dc2b

data/checksum/rack-simple_auth-1.0.0rc.gem.sha512

@@ -0,0 +1 @@
+4c0a5c5b86c0f88193dc9e343334737e709eb69397b6a2dd5a1e76a18d867a79db76cd7e205ad054d1580cdfd28ccb9a81a3f5a1969f77f988d3449f09ee296f

data/doc/Rack.html

@@ -0,0 +1,128 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Rack
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Rack.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (R)</a> &raquo;
+    
+    
+    <span class="title">Rack</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Rack
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/rack/simple_auth.rb<span class="defines">,<br />
+  lib/rack/simple_auth/logger.rb,<br /> lib/rack/simple_auth/version.rb,<br /> lib/rack/simple_auth/hmac/config.rb,<br /> lib/rack/simple_auth/hmac/middleware.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Rack Module</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Rack/SimpleAuth.html" title="Rack::SimpleAuth (module)">SimpleAuth</a></span>
+    
+  
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Wed Apr 30 09:50:21 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+
+  </body>
+</html>

data/doc/Rack/SimpleAuth.html

@@ -0,0 +1,252 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: Rack::SimpleAuth
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!Rack/SimpleAuth.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (S)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Rack.html" title="Rack (module)">Rack</a></span></span>
+     &raquo; 
+    <span class="title">SimpleAuth</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: Rack::SimpleAuth
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/rack/simple_auth.rb<span class="defines">,<br />
+  lib/rack/simple_auth/logger.rb,<br /> lib/rack/simple_auth/version.rb,<br /> lib/rack/simple_auth/hmac/config.rb,<br /> lib/rack/simple_auth/hmac/middleware.rb</span>
+</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Module which Contains different Authorization / Authentication Classes
+(HMAC, ..)</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="SimpleAuth/HMAC.html" title="Rack::SimpleAuth::HMAC (module)">HMAC</a></span>, <span class='object_link'><a href="SimpleAuth/Logger.html" title="Rack::SimpleAuth::Logger (module)">Logger</a></span>
+    
+  
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          <div class="docstring">
+  <div class="discussion">
+    
+<p>Current Gem Version</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+      
+    </dl>
+  
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#root-class_method" title="root (class method)">+ (String) <strong>root</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Method to return Gem Root Dir from everywhere in the gem.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="root-class_method">
+  
+    + (<tt>String</tt>) <strong>root</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Method to return Gem Root Dir from everywhere in the gem</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Gem Root Folder</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/rack/simple_auth.rb', line 19</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_root'>root</span>
+  <span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>..</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='kw'>__FILE__</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Wed Apr 30 09:50:21 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+
+  </body>
+</html>