YubiRuby 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e0f6d6e3bb774f4aa5b792afe36563e6dd55172
+  data.tar.gz: 594c95692490f2e64adbd6f9f97707b9e2844ba4
+SHA512:
+  metadata.gz: c3f2e3e12a5a75fab5434f2d3039695536dd6151f42fb39ee8b6235f83b3268cf8dcdc7e6c497f662cdf07e3094267e4505f8e5927531a654fc22afb4a589485
+  data.tar.gz: 27e4a5a517036bc3236c74aa8f163a40265fc86b03fede41061aa377f50a8703240bb4e98953131af1e077acf9d04add3d913684e292bc38b42f3d145cf12993

data/.hgignore

@@ -0,0 +1,30 @@
+syntax: glob
+*.orig
+*.rej
+*~
+*.o
+tests/*.err
+.DS_Store
+build
+.svn
+(*)
+*.perspectivev3
+*.mode1v3
+*.mode2v3
+*.mpkg
+*.framework
+*.pbxuser
+*.gem
+*.bundle
+Makefile
+Gemfile.lock
+lib/*.so
+
+syntax: regexp
+.*\#.*\#$
+^tmp/*$
+^script/*$
+^doc/*$
+^pkg/*$
+^meta/*$
+^\.yardoc/*$

data/.hgtags

@@ -0,0 +1,4 @@
+f5924ad9dd2468be630970716c72208034b5dc18 0.0.1
+ce7cd143ef150eb1826b16ec3c389527c38e5a34 0.1.0
+0c2ebe513c3224eb90438bb3543de639760755ad 1.0.0
+3471bc0588d0ab8becabdeb938b500fb568b1966 v1.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.1.0. updates to build under Ruby 2.0
+
 v1.0.0. broken api compatibility. TestCase. fixed some bugs in (mod)hex decoding. Exceptions. FakeYubikey generator. yubikey app for personal key management.
 
 v0.1.2. backported fixes from 1.0.0
@@ -6,4 +8,4 @@ v0.1.1. fixed some bugs in hex decoding.
 
 v0.1.0. modhex installed as binary.
 
-v0.0.1. First release
+v0.0.1. First release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yubyruby.gemspec
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-RubyRuby --- Ruby wrapper for low-level Yubikey OTP functions.
+YubiRuby --- Ruby wrapper for low-level Yubikey OTP functions.
 
 Written by Alessio Caiazza <nolith@abisso.org>.
 Copyright (c) 2010 Alessio Caiazza

data/README.developer.txt

@@ -0,0 +1,17 @@
+CONTRIBUTING
+
+Firstoff, any model to be used by people should consist of simple, consistent
+rules. Programming is complex enough without having to worry about elaborate
+branching directives. Therefore this model boils down to 3 simple rules:
+
+    (1) you do all the work on default - except for hotfixes.
+
+    (2) on stable you only do hotfixes, merges for release and tagging for
+        release. Only maintainers touch stable.
+
+    (3) you can use arbitrary feature-branches, as long as you don't call them
+        default or stable. They always start at default (since you do all the
+        work on default).
+
+A more detailed explaination can be found online at
+http://draketo.de/light/english/mercurial/complete-branching-strategy

data/README.md

@@ -0,0 +1,43 @@
+# YubiRuby
+
+Yubico Server wrapper in Ruby
+
+## Installation
+
+`$ gem install YubiRuby`
+
+## Some examples
+
+### Checking an OTP
+
+    require 'rubygems'
+    require 'YubiRuby'
+    
+    key = "6df89690b5f51bd9ac912c5004781e86" #use your AES key
+    y = YubiRuby::Yubikey.new(key);
+    puts y.key
+    otp = gets().strip
+    puts y.parse(otp)
+    puts "Ouput: #{y}"
+    puts "uid: #{y.uid}"
+    puts "session counter: #{y.session_counter}"
+    puts "capslock: #{y.triggered_by_capslock?}"
+    puts "timestamp low/high: #{y.timestamp_low}/#{y.timestamp_high}"
+    puts "session use: #{y.session_use}"
+    puts "random: #{y.random}"
+    puts "crc: #{y.crc}"
+    puts "crc residue: #{y.crc_residue}"
+    puts "crc residue ok?: #{y.crc?} (#{y.crc_residue} == #{YubiRuby::Yubikey::CRC_OK_RESIDUE})"
+
+### Generating a valid yubikey
+
+    key = YubiRuby::FakeYubikey.new
+    key.set_random_key
+    key.set_random_uid
+    key.public_id = "vvefeeccebek"
+    puts "Yubikey generated"
+    puts "public id:\t#{key.public_id}"
+    puts "key:\t\t#{key.key}"
+    puts "uid:\t\t#{key.uid}"
+    puts "And now 3 otp"
+    3.times { puts key.otp }

data/Rakefile

@@ -1,54 +1,68 @@
-# Rakefile
-require 'rubygems'
-require 'rake'
-require 'echoe'
-
-ENV['SPEC_OPTS'] ||= '-c'
-
-Echoe.new('YubiRuby') do |p|
-  p.description    = <<-EOF
-Yubikey integration - 
-
-Includes Prototypes for low-level Yubikey OTP functions 
-witten by Simon Josefsson <simon@josefsson.org>.
-Copyright (c) 2006, 2007, 2008, 2009 Yubico AB
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-     notice, this list of conditions and the following disclaimer.
-
-   * 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.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
-OWNER 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.
-EOF
-  p.url            = "http://bitbucket.org/nolith/yubiruby"
-  p.author         = "Alessio Caiazza"
-  p.email          = "nolith@abisso.org"
-  p.platform       = Gem::Platform::RUBY
-  p.ignore_pattern = ["tmp/**/*", "script/*", "meta/**/*"]
-  p.development_dependencies = ['yard', 'rspec']
-  p.runtime_dependencies << ['ruby-aes-normal', '~> 1.0']
-  p.runtime_dependencies << ['bit-struct'] #, '~> 0.13.6']
-  p.spec_pattern = ['test/**/*_spec.rb']
-  p.has_rdoc = true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rake/clean'
+CLEAN << 'lib/libyubikey.so'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = './test{,/*/**}/*_spec.rb'
+end
+
+task :default => :spec
+
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("libyubikey") do |ext|
+  ext.lib_dir = "lib"
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
 
+task :build => :compile
+task :spec => :compile
+
+#fast hack for mercurial
+module Bundler
+  class GemHelper
+
+    def git_push
+      perform_git_push ' -r tip'
+      Bundler.ui.confirm "Pushed hg commits and tags."
+    end
+
+    def perform_git_push(options = '')
+      cmd = "hg push #{options}"
+      out, code = sh_with_code(cmd)
+      raise "Couldn't hg push. `#{cmd}' failed with the following output:\n\n#{out}\n" unless code == 0
+    end
+
+    def already_tagged?
+      if sh('hg tags -q').split(/\n/).include?(version_tag)
+        Bundler.ui.confirm "Tag #{version_tag} has already been created."
+        true
+      end
+    end
+
+    def guard_clean
+      clean? && committed? or raise("There are files that need to be committed first.")
+    end
+
+    def clean?
+      true
+    end
+
+    def committed?
+      sh_with_code("hg sum -q | grep \"^commit:\"")[1] != 0
+    end
+
+    def tag_version
+      sh "hg tag -m \"Version #{version}\" #{version_tag}"
+      Bundler.ui.confirm "Tagged #{version_tag}."
+      yield if block_given?
+    rescue
+      Bundler.ui.error "Untagging #{version_tag} due to error."
+      sh_with_code "hg tag --remove #{version_tag}"
+      raise
+    end
+
+  end
+end

data/YubiRuby.gemspec

@@ -1,13 +1,17 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{YubiRuby}
-  s.version = "1.0.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Alessio Caiazza"]
-  s.date = %q{2010-03-21}
-  s.description = %q{Yubikey integration - 
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "YubiRuby"
+  spec.version       = YubiRuby::VERSION
+  spec.authors       = ["Alessio Caiazza"]
+  spec.email         = ["nolith@abisso.org"]
+  spec.extensions    = ["ext/libyubikey/extconf.rb"]
+  spec.summary       = %q{Yubico Server wrapper in Ruby}
+  spec.description   = <<-EOF
+Yubikey integration - 
 
 Includes Prototypes for low-level Yubikey OTP functions 
 witten by Simon Josefsson <simon@josefsson.org>.
@@ -37,39 +41,21 @@ 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.
-}
-  s.email = %q{nolith@abisso.org}
-  s.executables = ["modhex", "yubikey"]
-  s.extensions = ["ext/libyubikey/extconf.rb"]
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "bin/modhex", "bin/yubikey", "ext/libyubikey/extconf.rb", "ext/libyubikey/libyubikey.c", "ext/libyubikey/ykaes.c", "ext/libyubikey/ykcrc.c", "ext/libyubikey/ykhex.c", "ext/libyubikey/ykmodhex.c", "ext/libyubikey/ykparse.c", "ext/libyubikey/yubikey.h", "lib/exceptions.rb", "lib/fake_yubikey.rb", "lib/hex.rb", "lib/yubiruby.rb", "tasks/yard_doc.rake"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README", "Rakefile", "bin/modhex", "bin/yubikey", "ext/libyubikey/extconf.rb", "ext/libyubikey/libyubikey.c", "ext/libyubikey/ykaes.c", "ext/libyubikey/ykcrc.c", "ext/libyubikey/ykhex.c", "ext/libyubikey/ykmodhex.c", "ext/libyubikey/ykparse.c", "ext/libyubikey/yubikey.h", "lib/exceptions.rb", "lib/fake_yubikey.rb", "lib/hex.rb", "lib/yubiruby.rb", "tasks/yard_doc.rake", "test/fake_yubikey_spec.rb", "test/hex_spec.rb", "test/modhex_spec.rb", "test/path_loader.rb", "test/tc_crc16.rb", "test/tc_fake_yubikey.rb", "test/tc_hex.rb", "test/tc_modhex.rb", "test/test_helper.rb", "YubiRuby.gemspec"]
-  s.homepage = %q{http://bitbucket.org/nolith/yubiruby}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "YubiRuby", "--main", "README"]
-  s.require_paths = ["lib", "ext"]
-  s.rubyforge_project = %q{yubiruby}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Yubikey integration -   Includes Prototypes for low-level Yubikey OTP functions  witten by Simon Josefsson <simon@josefsson.org>. Copyright (c) 2006, 2007, 2008, 2009 Yubico AB All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  * 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.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.}
-  s.test_files = ["test/test_helper.rb"]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ruby-aes-normal>, ["~> 1.0"])
-      s.add_runtime_dependency(%q<bit-struct>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<ruby-aes-normal>, ["~> 1.0"])
-      s.add_dependency(%q<bit-struct>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<ruby-aes-normal>, ["~> 1.0"])
-    s.add_dependency(%q<bit-struct>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
+EOF
+  spec.homepage      = "http://bitbucket.org/nolith/yubiruby"
+  spec.license       = "AS IS"
+
+  spec.platform      = Gem::Platform::RUBY
+  spec.files         = `hg locate -0`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec", "~> 2"
+  spec.add_development_dependency "yard", "~> 0.8"
+
+  spec.add_dependency "bit-struct", "~> 0.15"
 end

data/bin/modhex

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -wKU
+#!/usr/bin/env ruby -wU
 
 require 'yubiruby'
 

data/bin/yubikey

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -wKU
+#!/usr/bin/env ruby -wU
 
 require 'yubiruby'
 

data/ext/libyubikey/libyubikey.c

@@ -58,13 +58,13 @@ static VALUE mCRC16;
 static VALUE modhex_sing_encode(VALUE self, VALUE obj) 
 {
 	VALUE str = StringValue(obj);
-	int src_size = RSTRING(str)->len;
+	int src_size = RSTRING_LEN(str);
 	char *dst = (char*) malloc((2*src_size+1)*sizeof(char));
 	/* ModHex encode input string SRC of length SRCSIZE and put the zero
 	   terminated output string in DST.  The size of the output string DST
 	   must be at least 2*SRCSIZE+1.  The output string is always
 	   2*SRCSIZE large plus the terminating zero.  */
-	yubikey_modhex_encode(dst, RSTRING(str)->ptr, src_size);
+	yubikey_modhex_encode(dst, RSTRING_PTR(str), src_size);
 	
 	return rb_str_new2(dst);
 }
@@ -94,14 +94,14 @@ static VALUE modhex_encode(VALUE self)
 static VALUE modhex_sing_decode(VALUE self, VALUE obj) 
 {
 	VALUE str = StringValue(obj);
-	int src_size = RSTRING(str)->len;
+	int src_size = RSTRING_LEN(str);
 	if (rb_funcall(str, rb_intern(MODHEX_VALID), 0) == Qfalse)
 		rb_raise(rb_eval_string("YubiRuby::NoModHexEncodedError"), "");
 	char *dst = (char*) malloc(((src_size/2)+1)*sizeof(char));
 	/* ModHex decode input string SRC of length DSTSIZE/2 into output
 	   string DST.  The output string DST is always DSTSIZE/2 large plus
 	   the terminating zero.  */
-	yubikey_modhex_decode(dst, RSTRING(str)->ptr, src_size);
+	yubikey_modhex_decode(dst, RSTRING_PTR(str), src_size);
 	
 	return rb_str_new(dst, src_size/2);
 }
@@ -128,7 +128,7 @@ static VALUE modhex_decode(VALUE self)
 static VALUE modhex_sing_is_modhex(VALUE self, VALUE obj) 
 {
 	VALUE str = StringValue(obj);
-	if (yubikey_modhex_p(RSTRING(str)->ptr) != 0)
+	if (yubikey_modhex_p(RSTRING_PTR(str)) != 0)
 		return Qtrue;
 	else
 		return Qfalse;
@@ -190,12 +190,12 @@ static VALUE yubikey_set_key(VALUE self, VALUE key)
 	if (sKey == Qnil)
 		rb_raise(rb_eTypeError, "wrong parameter type.");
 		
-	if (RSTRING(sKey)->len == YUBIKEY_KEY_SIZE*2) {
+	if (RSTRING_LEN(sKey) == YUBIKEY_KEY_SIZE*2) {
 		/* Hex */
-		if (yubikey_hex_p(RSTRING(sKey)->ptr) == 0)
+		if (yubikey_hex_p(RSTRING_PTR(sKey)) == 0)
 			rb_raise(rb_eTypeError, "not an HEX string."); //TODO:ArgumentError
 		char* buff = (char*) malloc(sizeof(char)*(YUBIKEY_KEY_SIZE +1));
-		yubikey_hex_decode( buff, RSTRING(sKey)->ptr, YUBIKEY_KEY_SIZE );
+		yubikey_hex_decode( buff, RSTRING_PTR(sKey), YUBIKEY_KEY_SIZE );
 		MEMCPY(&data->key, buff, uint8_t, YUBIKEY_KEY_SIZE);
 	}
 	
@@ -228,7 +228,7 @@ static VALUE yubikey_get_key(VALUE self)
  *
  * Creates a yubikey parser whith +aes_key+ ad AES key.
  *
- * +aes_key+ musb be encoded with YubiRuby::HEX.encode.
+ * +aes_key+ must be encoded with YubiRuby::HEX.encode.
  */
 static VALUE yubikey_initialize(VALUE self, VALUE key) 
 {
@@ -275,7 +275,7 @@ static VALUE yubikey_check(VALUE self, VALUE otp)
 	if (str == Qnil)
 		rb_raise(rb_eTypeError, "wrong argument type.");
 	
-	int start = RSTRING(str)->len - 32;
+	int start = RSTRING_LEN(str)- 32;
 	
 	if (start < 0)
 		rb_raise(rb_eTypeError, "OTP too short."); //Argument error
@@ -313,7 +313,7 @@ static VALUE yubikey_check(VALUE self, VALUE otp)
 	/* Decrypt TOKEN using KEY and store output in OUT structure.  Note
 	   that there is no error checking whether the output data is valid or
 	   not, use yubikey_check_* for that. */
-	yubikey_parse ((uint8_t*)(RSTRING(str)->ptr+start), data->key, data->token);	
+	yubikey_parse ((uint8_t*)(RSTRING_PTR(str)+start), data->key, data->token);	
 	
 #ifndef NDEBUG
 	printf ("Output:\n");
@@ -398,7 +398,7 @@ static VALUE yubikey_get_uid(VALUE self)
 	VALUE out = yubikey_to_str(self);
 	
 	// *2 becaouse of hex
-	return rb_str_new(RSTRING(out)->ptr, YUBIKEY_UID_SIZE*2 );
+	return rb_str_new(RSTRING_PTR(out), YUBIKEY_UID_SIZE*2 );
 }
 
 /* call-seq:
@@ -493,7 +493,7 @@ static VALUE yubikey_check_crc(VALUE self)
 static VALUE crc16_sing_calc(VALUE self, VALUE data) 
 {
 	VALUE str = StringValue(data);
-	return INT2NUM(yubikey_crc16(RSTRING(str)->ptr, RSTRING(str)->len));
+	return INT2NUM(yubikey_crc16( (uint8_t *)RSTRING_PTR(str), RSTRING_LEN(str)));
 }
 
 /* Implementation of Yubikey OTP functions.
@@ -551,4 +551,4 @@ void Init_libyubikey() {
 	
 	mCRC16 = rb_define_module_under(mYubiRuby, "CRC16");
 	rb_define_singleton_method(mCRC16, "calculate", crc16_sing_calc, 1);
-}
+}