ppp 0.1.2.alpha

data/ext/ppp/sha2.h

@@ -0,0 +1,108 @@
+/*
+ * FIPS 180-2 SHA-224/256/384/512 implementation
+ * Last update: 02/02/2007
+ * Issue date:  04/30/2005
+ *
+ * Copyright (C) 2005, 2007 Olivier Gay <olivier.gay@a3.epfl.ch>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the project nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef SHA2_H
+#define SHA2_H
+
+#define SHA224_DIGEST_SIZE ( 224 / 8)
+#define SHA256_DIGEST_SIZE ( 256 / 8)
+#define SHA384_DIGEST_SIZE ( 384 / 8)
+#define SHA512_DIGEST_SIZE ( 512 / 8)
+
+#define SHA256_BLOCK_SIZE  ( 512 / 8)
+#define SHA512_BLOCK_SIZE  (1024 / 8)
+#define SHA384_BLOCK_SIZE  SHA512_BLOCK_SIZE
+#define SHA224_BLOCK_SIZE  SHA256_BLOCK_SIZE
+
+#ifndef SHA2_TYPES
+#define SHA2_TYPES
+typedef unsigned char uint8;
+typedef unsigned int  uint32;
+typedef unsigned long long uint64;
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct {
+    unsigned int tot_len;
+    unsigned int len;
+    unsigned char block[2 * SHA256_BLOCK_SIZE];
+    uint32 h[8];
+} sha256_ctx;
+
+typedef struct {
+    unsigned int tot_len;
+    unsigned int len;
+    unsigned char block[2 * SHA512_BLOCK_SIZE];
+    uint64 h[8];
+} sha512_ctx;
+
+typedef sha512_ctx sha384_ctx;
+typedef sha256_ctx sha224_ctx;
+
+void sha224_init(sha224_ctx *ctx);
+void sha224_update(sha224_ctx *ctx, const unsigned char *message,
+                   unsigned int len);
+void sha224_final(sha224_ctx *ctx, unsigned char *digest);
+void sha224(const unsigned char *message, unsigned int len,
+            unsigned char *digest);
+
+void sha256_init(sha256_ctx * ctx);
+void sha256_update(sha256_ctx *ctx, const unsigned char *message,
+                   unsigned int len);
+void sha256_final(sha256_ctx *ctx, unsigned char *digest);
+void sha256(const unsigned char *message, unsigned int len,
+            unsigned char *digest);
+
+void sha384_init(sha384_ctx *ctx);
+void sha384_update(sha384_ctx *ctx, const unsigned char *message,
+                   unsigned int len);
+void sha384_final(sha384_ctx *ctx, unsigned char *digest);
+void sha384(const unsigned char *message, unsigned int len,
+            unsigned char *digest);
+
+void sha512_init(sha512_ctx *ctx);
+void sha512_update(sha512_ctx *ctx, const unsigned char *message,
+                   unsigned int len);
+void sha512_final(sha512_ctx *ctx, unsigned char *digest);
+void sha512(const unsigned char *message, unsigned int len,
+            unsigned char *digest);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* !SHA2_H */
+

data/lib/ppp.rb

@@ -0,0 +1,41 @@
+require 'digest'
+require "ppp/version"
+require "ppp/generator"
+require 'ppp/Cppp'
+require 'ppp/card/base'
+require 'ppp/card/html'
+require 'ppp/card/plain'
+
+module Ppp
+  class << self
+    @@ALPHABETS   = { :conservative => '!#%+23456789:=?@ABCDEFGHJKLMNPRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
+                      :aggressive   => '!"#$%&\'()*+,-./23456789:;<=>?@ABCDEFGHJKLMNOPRSTUVWXYZ[\]^_abcdefghijkmnopqrstuvwxyz{|}~' }
+
+    # @return [Ppp::Generator] with the given SHA-256 key
+    def code_generator key, opts
+      Generator.new key, opts
+    end
+
+    # @return a SHA-256 digest of the given string
+    def key_from_string str
+      Digest::SHA256.new.update( str ).to_s
+    end
+
+    # @return a random SHA-256 key
+    def random_key
+      Cppp.random_key
+    end
+
+    def printer style, *args
+      case style
+      when :html  then return Card::Html.new  *args
+      when :plain then return Card::Plain.new *args
+      end
+      raise ArgumentError.new( "%s is not a valid printer style." % style )
+    end
+
+    def default_alphabets
+      @@ALPHABETS
+    end
+  end
+end

data/lib/ppp/card/base.rb

@@ -0,0 +1,50 @@
+require 'ppp/generator'
+
+module Ppp
+  module Card
+    class Base
+      @@CHARS_PER_LINE = 34
+      @@FIRST_COLUMN = ?A
+      @@ROW_COL_PATTERN = /[[:digit:]][[:alpha:]]/
+
+      @@ERROR_BAD_ROW_COL = %[Expected a string with exactly one digit and one letter, got "%s".]
+      @@ERROR_LONG_CODES  = %[Passcodes longer than 16 characters are too long for printing]
+
+      def initialize generator, opts={}
+        @generator = generator
+        raise ArgumentError.new( @@ERROR_LONG_CODES ) if code_length > 16
+
+        options = { :card_title => 'PPP Passcard', :first_card_index => 1 }.merge opts
+        @title      = options[ :card_title       ]
+        @card_index = options[ :first_card_index ]
+        @offset     = 0
+      end
+
+      def code_length
+        @generator.length
+      end
+
+      def passcodes_per_line
+        @passcodes_per_line ||= ( (@@CHARS_PER_LINE+1) / (code_length + 1) ).to_i
+      end
+
+      def next_code
+        code = @generator.passcode( @offset )
+        @offset += 1
+        code
+      end
+
+      def passcode row_col
+        raise ArgumentError.new( @@ERROR_BAD_ROW_COL % row_col ) unless row_col.size == 2 && @@ROW_COL_PATTERN.match( row_col.split('').sort.join )
+        passcode *row_col.split('')
+      end
+
+      def passcode row, col
+        col_offset = col.ord - @@FIRST_COLUMN.ord
+        row_offset = row - 1
+
+        @generator.passcode row_offset * passcodes_per_line + col_offset
+      end
+    end
+  end
+end

data/lib/ppp/card/html.rb

@@ -0,0 +1,126 @@
+require 'ppp/generator'
+require 'ppp/card/base'
+
+class Ppp::Card::Html < Ppp::Card::Base
+  @@SIZES = {:creditcard => %w[ 85.60mm 53.98mm ]}
+
+  def initialize generator, opts={}
+    super
+
+    options    = { :font_size => 14, :size => :creditcard }.merge opts
+    @font_size = options[ :font_size ]
+    @size      = process_size options[ :size ]
+  end
+
+  def css
+    %[
+      <style>
+        .card, .card .title, .card .card_index, .card .codes, .card .codes td {
+          font-family: monospace;
+          font-size: 3.5mm;
+        }
+        .card {
+          background-color: \#fff;
+          margin: 0 auto 0 auto;
+          width:  #{width};
+          height: #{height};
+          border: 1px solid \#000;
+          border-top: none;
+          border-spacing: 0;
+        }
+        .title {
+          border: 1px solid \#000;
+          border-bottom: 1px solid \#000;
+          background-color: \#eee;
+          text-align: left;
+          padding-left: 1ex;
+          font-weight: bold;
+        }
+        .title td:first-child {
+          width: 2.5em;
+        }
+        .card_index {
+          float: right;
+          margin-right: 1ex;
+        }
+        .card_index:before { content: '['; }
+        .card_index:after  { content: ']'; }
+
+        .codes_heading th {
+          text-align: center;
+          width: #{code_length}em;
+          border-bottom: 1px solid \#aaa;
+          background-color: \#eee;
+        }
+        .codes_heading th:first-child {
+          background-color: \#fff;
+          border-right: 1px solid \#aaa;
+        }
+        .codes_heading th:last-child  { border-right:  none; }
+        .codes td {
+          padding: 0;
+          margin: 0;
+          text-align: center;
+          border-right: 1px solid \#aaa;
+          border-bottom: 1px solid \#aaa;
+        }
+        .codes tr td:first-child {
+          text-align: right;
+          padding-right: 0.5em;
+          font-weight: bold;
+          background-color: \#eee;
+          border-right: 1px solid \#aaa;
+        }
+        .codes tr td:first-child { border-bottom: none; }
+        .codes tr td:last-child  { border-right:  none; }
+        .codes tr:last-child td  { border-bottom: none; }
+      </style>
+    ]
+  end
+
+  def html
+    %[
+      <table class="card">
+        <caption class="title">
+          #{@title}
+          <span class="card_index">#{@card_index}</span>
+        </caption>
+        <colgroup span="1">
+        <colgroup span="#{passcodes_per_line}">
+        <thead class="codes_heading">
+          <th>&nbsp;</th>
+          #{ (0..passcodes_per_line-1).collect { |i| %[<th>#{(@@FIRST_COLUMN.ord + i).chr}</th>] }.join ?\n }
+        </thead>
+        <tbody class="codes">
+          #{ (1..9).collect { |i| "<tr><td>#{i}</td>#{(1..passcodes_per_line).collect {%[<td>#{next_code}</td>]}.join(?\n) }</tr>" }.join(?\n) }
+        </tbody>
+      </table>
+    ]
+  end
+
+  def to_s
+    "#{css}\n\n#{html}"
+  end
+
+  protected # ----------------------------------------------
+
+  def width
+    @size[0]
+  end
+
+  def height
+    @size[1]
+  end
+
+  def process_size size
+    case size
+    when Symbol
+      return @@SIZES[ size ] if @@SIZES.include? size
+      raise ArgumentError.new( %[No card size for symbol "#{size}"] )
+    when Array
+      return [ size[0].to_s, size[1].to_s ]
+    else
+    raise ArgumentError.new( "Size must be a Symbol or Array" )
+    end
+  end
+end

data/lib/ppp/card/plain.rb

@@ -0,0 +1,91 @@
+require 'ppp/card/base'
+
+class Ppp::Card::Plain < Ppp::Card::Base
+
+  def initialize generator, opts={}
+    super
+
+    options    = { :row_count => 10 }.merge opts
+    @row_count = options[ :row_count ]
+  end
+
+  def to_s
+    line( bar )             +
+    line( :pad, title_str ) +
+    line( split_bar )       +
+    line( :pad, header )    +
+    row_lines.join( '' )    +
+    line( split_bar )
+  end
+
+  private
+
+  def bar
+    @bar ||= '-' * (width + 2)
+  end
+
+  def width
+    @width ||= begin
+      return rows.first.join( ' ' ).size if rows.size >= 1
+      header.size
+    end
+  end
+
+  def rows
+    @rows ||= begin
+    (1..@row_count).collect do |i|
+        [ first_column( i ) ] + (1..passcodes_per_line).collect {next_code}
+      end
+    end
+  end
+
+  def header
+    @header ||= header_cells.join ' '
+  end
+
+  def header_cells
+    [' ' * first_column_width ] + (1..passcodes_per_line).collect do |i|
+    (@@FIRST_COLUMN.ord + i-1).chr.center code_length
+    end
+  end
+
+  def title_str
+    @title_str ||= begin
+      title = @title[0, width - card_label.size] # trim title if it's too long to fit
+
+      blank_space = width - (title.size + card_label.size)
+      title = title + (' ' * blank_space) + card_label
+    end
+  end
+
+  def card_label
+    @card_label ||= "[#{@card_index}]"
+  end
+
+  def split_bar
+    @split_bar ||= begin
+      parts = ['-' * first_column_width] + (1..passcodes_per_line).collect { '-' * code_length }
+      "-#{parts.join '+'}-"
+    end
+  end
+
+  def row_lines
+    @row_lines ||= rows.collect{ |r| line :pad, r.join( ' ' ) }
+  end
+
+  def line pad=:nopad, str
+    return "| #{str} |\n" if pad == :pad
+
+    "|#{str}|\n"
+  end
+
+  def first_column row_index
+    label = "#{row_index}:"
+    padding = ' ' * (first_column_width - label.size)
+    padding + label
+  end
+
+  def first_column_width
+    @first_column_width ||= @row_count.to_s.size + 1
+  end
+end

data/lib/ppp/generator.rb

@@ -0,0 +1,69 @@
+require 'ppp/Cppp'
+
+# Generates passcodes.
+class Ppp::Generator
+  attr_reader :seed, :length, :alphabet
+
+  @@HEX_PATTERN = /[a-fA-F0-9]{64}/
+
+  # @param [String] sha256_key a 64 hex-digit string representation of a
+  #   SHA-256 hash. This hash will seed all the generated passcodes.
+  # @param [Fixnum] length the number of characters in each generated passcode
+  # @param [String] alphabet a string containing the characters passcodes will
+  #   be comprised of. Cannot contain null characters and duplicate characters
+  #   will be removed.
+  def initialize sha256_key, opts={}
+    raise NotHexKey.new( sha256_key ) if @@HEX_PATTERN.match( sha256_key ).nil?
+
+    @seed     = sha256_key
+
+    options   = { :length => 4, :alphabet => :conservative }.merge opts
+    @length   = options[ :length ]
+    @alphabet = process_alphabet( options[ :alphabet ] ).split( '' ).uniq.join
+
+    raise ArgumentError.new( "alphabet cannot contain null character" ) if alphabet.include? ?\0
+  end
+
+  # Creates passcodes seeded off the SHA-256 key this object was created with.
+  #   Calling this method subsequent times with the same offset will return the
+  #   same passcodes, so you should increase the offset by count each time.
+  # @param [Fixnum] offset the number of passcodes to skip
+  # @param [Fixnum] count the number of passcodes to return
+  # @return [Array] an array of passcodes
+  def passcodes offset, count
+    Cppp.passcodes @seed, offset, count, @length, @alphabet
+  end
+
+  # (@see #passcodes)
+  def passcode offset
+    passcodes( offset, 1 ).first
+  end
+
+  # Check if a given passcode is correct
+  # @param [Fixnum] index the index of the passcode to check against
+  # @return [Boolean] if the given passcode matches the passcode at the given offset
+  def verify index, given_passcode
+    passcode( index ) == given_passcode
+  end
+
+  private
+
+  def process_alphabet alphabet
+    case alphabet
+    when Symbol
+      return Ppp.default_alphabets[ alphabet ] if Ppp.default_alphabets.include? alphabet
+      raise ArgumentError.new( %[No alphabet for for symbol "#{alphabet}"] )
+    when String
+      return alphabet
+    else
+    raise ArgumentError.new( "Alphabet must be a Symbol or String" )
+    end
+  end
+
+  class NotHexKey < ArgumentError
+    @@error = 'Expected a 64 digit hex-string, but got "%s". Use Ppp.key_from_string() to generate a useable hex-string from an arbitrary string.'
+    def initialize( key ) @key = key     end
+
+    def to_s()            @@error % @key end
+  end
+end