rkerberos 0.1.0 → 0.1.1

data/CHANGES

@@ -1,3 +1,8 @@
+= 0.1.1 - 08-May-2013
+* Add credential cache argument to get_init_creds_keytab
+* Fixed invalid VALUE declarations affecting non-gcc compilers
+* Add OS X install instructions
+
 = 0.1.0 - 28-Apr-2011
 * Initial release. This is effectively a re-release of my own custom branch
   of the krb5-auth library, with some minor changes.

data/{README → README.md}

@@ -1,10 +1,24 @@
-= Description
+# Description
   The rkerberos library provides a Ruby interface for Kerberos.
 
-= Requirements
+# Requirements
   Kerberos 1.7.0 or later, including admin header and library files.
 
-= Synopsis
+# OSX
+  krb5 must be installed from source before installing the rkerberos gem:
+```
+  wget http://web.mit.edu/kerberos/dist/krb5/1.10/krb5-1.10.2-signed.tar
+  tar -xf krb5-1.10.2-signed.tar
+  tar -xf krb5-1.10.2-signed.tar.gz
+  cd krb5-1.10.2
+  ./configure
+  make
+  make install
+```
+  latest release is here: http://web.mit.edu/kerberos/dist/index.html
+
+# Synopsis
+```ruby
   require 'rkerberos'
 
   # Get the default realm name
@@ -27,25 +41,23 @@
     p kadm5.get_principal('someuser')
     kadm5.set_password('someuser', 'abc123')
   end
+```
 
-= Notes
+# Notes
   The rkerberos library is a repackaging of my custom branch of the krb5_auth
   library. Eventually the gem djberg96-krb5_auth will be removed from the gem
   index.
 
-= MIT vs Heimdal
+# MIT vs Heimdal
   This code was written for the MIT Kerberos library. It has not been tested
   with the Heimdal Kerberos library.
 
-= TODO
+# TODO
   Create a separate class for the replay cache.
   Better credentials cache support.
   Ability to add and delete keytab entries.
 
-= Known Issues
-  OS X users will probably need to install Kerberos manually and specify
-  the dir-config option because it ships with old Kerberos header files,
-  and none of the admin headers or libraries by default.
-
-= Author
+# Authors
   Daniel Berger
+  Dominic Cleal (maintainer)
+

data/Rakefile

@@ -14,6 +14,7 @@ CLEAN.include(
   '**/*.log',               # Ruby extension build log
   '**/Makefile',            # C Makefile
   '**/conftest.dSYM',       # OS X build directory
+  '**/tmp',                 # Temp directory
   "**/*.#{CONFIG['DLEXT']}" # C shared object
 )
 

data/ext/rkerberos/keytab.c

@@ -35,7 +35,6 @@ static VALUE rkrb5_keytab_allocate(VALUE klass){
 static VALUE rkrb5_keytab_each(VALUE self){
   RUBY_KRB5_KEYTAB* ptr;
   VALUE v_kt_entry;
-  VALUE v_args[0];
   krb5_error_code kerror;
   krb5_kt_cursor cursor;
   krb5_keytab_entry entry;
@@ -55,7 +54,7 @@ static VALUE rkrb5_keytab_each(VALUE self){
   while((kerror = krb5_kt_next_entry(ptr->ctx, ptr->keytab, &entry, &cursor)) == 0){
     krb5_unparse_name(ptr->ctx, entry.principal, &principal);
 
-    v_kt_entry = rb_class_new_instance(0, v_args, cKrb5KtEntry);
+    v_kt_entry = rb_class_new_instance(0, NULL, cKrb5KtEntry);
 
     rb_iv_set(v_kt_entry, "@principal", rb_str_new2(principal));
     rb_iv_set(v_kt_entry, "@timestamp", rb_time_new(entry.timestamp, 0));
@@ -247,7 +246,6 @@ static VALUE rkrb5_keytab_get_entry(int argc, VALUE* argv, VALUE self){
   krb5_keytab_entry entry;
   char* name;
   VALUE v_principal, v_vno, v_enctype, v_entry;
-  VALUE v_args[0];
 
   Data_Get_Struct(self, RUBY_KRB5_KEYTAB, ptr); 
 
@@ -276,7 +274,7 @@ static VALUE rkrb5_keytab_get_entry(int argc, VALUE* argv, VALUE self){
   if(kerror)
     rb_raise(cKrb5Exception, "krb5_kt_get_entry: %s", error_message(kerror));
 
-  v_entry = rb_class_new_instance(0, v_args, cKrb5KtEntry);
+  v_entry = rb_class_new_instance(0, NULL, cKrb5KtEntry);
 
   rb_iv_set(v_entry, "@principal", rb_str_new2(name));
   rb_iv_set(v_entry, "@timestamp", rb_time_new(entry.timestamp, 0));
@@ -365,7 +363,6 @@ static VALUE rkrb5_keytab_initialize(int argc, VALUE* argv, VALUE self){
 static VALUE rkrb5_s_keytab_foreach(int argc, VALUE* argv, VALUE klass){
   VALUE v_kt_entry;
   VALUE v_keytab_name;
-  VALUE v_args[0];
   krb5_error_code kerror;
   krb5_kt_cursor cursor;
   krb5_keytab keytab;
@@ -429,7 +426,7 @@ static VALUE rkrb5_s_keytab_foreach(int argc, VALUE* argv, VALUE klass){
   while((kerror = krb5_kt_next_entry(context, keytab, &entry, &cursor)) == 0){
     krb5_unparse_name(context, entry.principal, &principal);
 
-    v_kt_entry = rb_class_new_instance(0, v_args, cKrb5KtEntry);
+    v_kt_entry = rb_class_new_instance(0, NULL, cKrb5KtEntry);
 
     rb_iv_set(v_kt_entry, "@principal", rb_str_new2(principal));
     rb_iv_set(v_kt_entry, "@timestamp", rb_time_new(entry.timestamp, 0));

data/ext/rkerberos/rkerberos.c

@@ -127,7 +127,7 @@ static VALUE rkrb5_set_default_realm(int argc, VALUE* argv, VALUE self){
 }
 
 /* call-seq:
- *   krb5.get_init_creds_keytab(principal = nil, keytab = nil, service = nil)
+ *   krb5.get_init_creds_keytab(principal = nil, keytab = nil, service = nil, ccache = nil)
  *
  * Acquire credentials for +principal+ from +keytab+ using +service+. If
  * no principal is specified, then a principal is derived from the service
@@ -135,16 +135,19 @@ static VALUE rkrb5_set_default_realm(int argc, VALUE* argv, VALUE self){
  *
  * If no keytab file is provided, the default keytab file is used. This is
  * typically /etc/krb5.keytab.
+ *
+ * If +ccache+ is supplied and is a Kerberos::Krb5::CredentialsCache, the
+ * resulting credentials will be stored in the credential cache.
  */
 static VALUE rkrb5_get_init_creds_keytab(int argc, VALUE* argv, VALUE self){
   RUBY_KRB5* ptr;
-  VALUE v_user, v_keytab_name, v_service;
+  VALUE v_user, v_keytab_name, v_service, v_ccache;
   char* user;
   char* service;
   char keytab_name[MAX_KEYTAB_NAME_LEN];
 
   krb5_error_code kerror;
-  krb5_get_init_creds_opt opt;
+  krb5_get_init_creds_opt* opt;
   krb5_creds cred;
 
   Data_Get_Struct(self, RUBY_KRB5, ptr); 
@@ -152,7 +155,11 @@ static VALUE rkrb5_get_init_creds_keytab(int argc, VALUE* argv, VALUE self){
   if(!ptr->ctx)
     rb_raise(cKrb5Exception, "no context has been established");
 
-  rb_scan_args(argc, argv, "03", &v_user, &v_keytab_name, &v_service);
+  kerror = krb5_get_init_creds_opt_alloc(ptr->ctx, &opt);
+  if(kerror)
+    rb_raise(cKrb5Exception, "krb5_get_init_creds_opt_alloc: %s", error_message(kerror));
+
+  rb_scan_args(argc, argv, "04", &v_user, &v_keytab_name, &v_service, &v_ccache);
 
   // We need the service information for later.
   if(NIL_P(v_service)){
@@ -173,8 +180,10 @@ static VALUE rkrb5_get_init_creds_keytab(int argc, VALUE* argv, VALUE self){
       &ptr->princ
     );
 
-    if(kerror)
+    if(kerror) {
+      krb5_get_init_creds_opt_free(ptr->ctx, opt);
       rb_raise(cKrb5Exception, "krb5_sname_to_principal: %s", error_message(kerror));
+    }
   }
   else{
     Check_Type(v_user, T_STRING);
@@ -182,16 +191,20 @@ static VALUE rkrb5_get_init_creds_keytab(int argc, VALUE* argv, VALUE self){
 
     kerror = krb5_parse_name(ptr->ctx, user, &ptr->princ); 
 
-    if(kerror)
+    if(kerror) {
+      krb5_get_init_creds_opt_free(ptr->ctx, opt);
       rb_raise(cKrb5Exception, "krb5_parse_name: %s", error_message(kerror));
+    }
   }
 
   // Use the default keytab if none is specified.
   if(NIL_P(v_keytab_name)){
     kerror = krb5_kt_default_name(ptr->ctx, keytab_name, MAX_KEYTAB_NAME_LEN);
 
-    if(kerror)
+    if(kerror) {
+      krb5_get_init_creds_opt_free(ptr->ctx, opt);
       rb_raise(cKrb5Exception, "krb5_kt_default_name: %s", error_message(kerror));
+    }
   }
   else{
     Check_Type(v_keytab_name, T_STRING);
@@ -204,10 +217,22 @@ static VALUE rkrb5_get_init_creds_keytab(int argc, VALUE* argv, VALUE self){
     &ptr->keytab
   );
 
-  if(kerror)
+  if(kerror) {
+    krb5_get_init_creds_opt_free(ptr->ctx, opt);
     rb_raise(cKrb5Exception, "krb5_kt_resolve: %s", error_message(kerror));
+  }
+
+  // Set the credential cache from the supplied Kerberos::Krb5::CredentialsCache
+  if(!NIL_P(v_ccache)){
+    RUBY_KRB5_CCACHE* ccptr;
+    Data_Get_Struct(v_ccache, RUBY_KRB5_CCACHE, ccptr);
 
-  krb5_get_init_creds_opt_init(&opt);
+    kerror = krb5_get_init_creds_opt_set_out_ccache(ptr->ctx, opt, ccptr->ccache);
+    if(kerror) {
+      krb5_get_init_creds_opt_free(ptr->ctx, opt);
+      rb_raise(cKrb5Exception, "krb5_get_init_creds_opt_set_out_ccache: %s", error_message(kerror));
+    }
+  }
 
   kerror = krb5_get_init_creds_keytab(
     ptr->ctx,
@@ -216,11 +241,15 @@ static VALUE rkrb5_get_init_creds_keytab(int argc, VALUE* argv, VALUE self){
     ptr->keytab,
     0,
     service,
-    &opt
+    opt
   );
 
-  if(kerror)
+  if(kerror) {
+    krb5_get_init_creds_opt_free(ptr->ctx, opt);
     rb_raise(cKrb5Exception, "krb5_get_init_creds_keytab: %s", error_message(kerror));
+  }
+
+  krb5_get_init_creds_opt_free(ptr->ctx, opt);
 
   return self; 
 }

data/rkerberos.gemspec

@@ -2,19 +2,17 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'rkerberos'
-  spec.version    = '0.1.0'
-  spec.author     = 'Daniel Berger'
+  spec.version    = '0.1.1'
+  spec.authors    = ['Daniel Berger', 'Dominic Cleal']
   spec.license    = 'Artistic 2.0'
-  spec.email      = 'djberg96@gmail.com'
-  spec.homepage   = 'http://github.com/djberg96/rkerberos'
-  spec.platform   = Gem::Platform::RUBY
+  spec.email      = ['djberg96@gmail.com', 'dcleal@redhat.com']
+  spec.homepage   = 'http://github.com/domcleal/rkerberos'
   spec.summary    = 'A Ruby interface for the the Kerberos library'
   spec.test_files = Dir['test/test*']
   spec.extensions = ['ext/rkerberos/extconf.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') || f.include?('tmp') }
   
-  spec.rubyforge_project = 'rkerberos'
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST'] + Dir['ext/rkerberos/*.c']
+  spec.extra_rdoc_files  = ['README.md', 'CHANGES', 'MANIFEST'] + Dir['ext/rkerberos/*.c']
 
   spec.add_dependency('rake-compiler')
   

data/test/test_krb5.rb

@@ -129,6 +129,18 @@ class TC_Krb5 < Test::Unit::TestCase
     assert_nothing_raised{ @krb5.get_init_creds_keytab(@user, @keytab, @service) }
   end
 
+  test "get_init_creds_keytab accepts a credential cache" do
+    omit_unless(File.exists?(@keytab), "keytab file not found, skipping")
+    assert_nothing_raised{ @krb5.get_init_creds_keytab(@user, @keytab, @service, @ccache) }
+  end
+
+  test "get_init_creds_keytab stores credentials in the credential cache" do
+    omit_unless(File.exists?(@keytab), "keytab file not found, skipping")
+    ccache = Kerberos::Krb5::CredentialsCache.new
+    assert_nothing_raised{ @krb5.get_init_creds_keytab(@user, @keytab, @service, @ccache) }
+    assert_equal @user, ccache.primary_principal
+  end
+
   test "get_init_creds_keytab requires string arguments" do
     assert_raise(TypeError){ @krb5.get_init_creds_keytab(1) }
     assert_raise(TypeError){ @krb5.get_init_creds_keytab(@user, 1) }

data/test/test_krb5_keytab.rb

@@ -21,6 +21,9 @@ class TC_Krb5_Keytab < Test::Unit::TestCase
   def self.startup
     file = Dir.tmpdir + "/test.keytab"
 
+    @@key_file = "FILE:" + file
+    @@home_dir = ENV['HOME'] || ENV['USER_PROFILE']
+
     PTY.spawn('kadmin.local') do |reader, writer, pid|
       reader.gets
       reader.expect(/local:\s+/)
@@ -31,9 +34,6 @@ class TC_Krb5_Keytab < Test::Unit::TestCase
       writer.puts("ktadd -k #{file} testuser2")
       reader.expect(/local:\s+/)
     end
-
-    @@key_file = "FILE:" + file
-    @@home_dir = ENV['HOME'] || ENV['USER_PROFILE']
   end
 
   def setup

metadata

@@ -1,155 +1,145 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rkerberos
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Daniel Berger
+- Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-28 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake-compiler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: dbi-dbrc
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: dbi-dbrc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 1
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.6
   type: :development
-  version_requirements: *id003
-description: "    The rkerberos library is an interface for the Kerberos 5 network\n    authentication protocol. It wraps the Kerberos C API.\n"
-email: djberg96@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+description: ! "    The rkerberos library is an interface for the Kerberos 5 network\n
+  \   authentication protocol. It wraps the Kerberos C API.\n"
+email:
+- djberg96@gmail.com
+- dcleal@redhat.com
 executables: []
-
-extensions: 
+extensions:
 - ext/rkerberos/extconf.rb
-extra_rdoc_files: 
-- README
+extra_rdoc_files:
+- README.md
 - CHANGES
 - MANIFEST
+- ext/rkerberos/context.c
+- ext/rkerberos/keytab.c
 - ext/rkerberos/principal.c
-- ext/rkerberos/rkerberos.c
 - ext/rkerberos/kadm5.c
 - ext/rkerberos/keytab_entry.c
-- ext/rkerberos/context.c
-- ext/rkerberos/keytab.c
+- ext/rkerberos/config.c
+- ext/rkerberos/rkerberos.c
 - ext/rkerberos/ccache.c
 - ext/rkerberos/policy.c
-- ext/rkerberos/config.c
-files: 
-- Rakefile
-- README
-- rkerberos.gemspec
-- CHANGES
+files:
+- MANIFEST
+- README.md
+- test/test_config.rb
+- test/test_krb5_keytab.rb
+- test/test_keytab_entry.rb
+- test/test_context.rb
 - test/test_principal.rb
 - test/test_credentials_cache.rb
-- test/test_config.rb
 - test/test_krb5.rb
-- test/test_context.rb
-- test/test_krb5_keytab.rb
 - test/test_kadm5.rb
-- test/test_keytab_entry.rb
 - test/test_policy.rb
-- MANIFEST
+- Rakefile
+- lib/rkerberos.so
 - ext/rkerberos/extconf.rb
+- ext/rkerberos/rkerberos.h
+- ext/rkerberos/context.c
+- ext/rkerberos/keytab.c
 - ext/rkerberos/principal.c
-- ext/rkerberos/rkerberos.c
 - ext/rkerberos/kadm5.c
 - ext/rkerberos/keytab_entry.c
-- ext/rkerberos/context.c
-- ext/rkerberos/keytab.c
+- ext/rkerberos/config.c
+- ext/rkerberos/rkerberos.c
 - ext/rkerberos/ccache.c
 - ext/rkerberos/policy.c
-- ext/rkerberos/rkerberos.h
-- ext/rkerberos/config.c
-has_rdoc: true
-homepage: http://github.com/djberg96/rkerberos
-licenses: 
+- rkerberos.gemspec
+- CHANGES
+homepage: http://github.com/domcleal/rkerberos
+licenses:
 - Artistic 2.0
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: rkerberos
-rubygems_version: 1.6.2
+rubyforge_project: 
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Ruby interface for the the Kerberos library
-test_files: 
+test_files:
+- test/test_config.rb
+- test/test_krb5_keytab.rb
+- test/test_keytab_entry.rb
+- test/test_context.rb
 - test/test_principal.rb
 - test/test_credentials_cache.rb
-- test/test_config.rb
 - test/test_krb5.rb
-- test/test_context.rb
-- test/test_krb5_keytab.rb
 - test/test_kadm5.rb
-- test/test_keytab_entry.rb
 - test/test_policy.rb