kerberos_authenticator 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae668eaa13a5a760620f1c5fbe67ea57c48fb08f
-  data.tar.gz: 60eab79c31c8f11e858c782d3220a5e51db13a37
+  metadata.gz: d21f1ea20049f7cc581df957b1b2e738b4578cab
+  data.tar.gz: 74504aa9db7035a3935f346c2563b3ccfda586d2
 SHA512:
-  metadata.gz: 89e39afb2afe2ce6d2ffb0e7e39a108aa8f3b3747cc3154985655b1ba71b79773496e0f986a7aa7b7d44d1c1e622a0a357b63c4a12d0424903879afa3aa5f46d
-  data.tar.gz: 35cd393566e7818ea3c71b07b3e5980f9697b025f0ccef61199aa94b73b2d97ebadf9748517c64a1789a0eb85cba919bfa685c68e15221ff66907f7ace2fc191
+  metadata.gz: ec9e7e068cfb22395aab8865f03f8060bee9f1e5f66196518435963f13100d7953dc9013c6dd76dd9f349f6a994eba444baea344655dc3699e2c8f4717c0a666
+  data.tar.gz: 6a784a3b02dac99f4638d23da612918c89116eb55b79b88074176a99edeb826a523d5c0eb041ab1421227677743970fc0932708dabe052751cf49eaf6ef54ea8

data/lib/kerberos_authenticator.rb

@@ -1,10 +1,13 @@
 require 'base64'
 require 'tempfile'
 
+require 'kerberos_authenticator/version'
 require 'kerberos_authenticator/error'
 require 'kerberos_authenticator/krb5'
 
 module KerberosAuthenticator
+
+  # A convenience method to access the Krb5 module when using the setup method.
   # @return [Krb5]
   def self.krb5
     Krb5
@@ -34,17 +37,22 @@ module KerberosAuthenticator
     true
   end
 
+  # @!attribute [rw] keytab_base64
+  #   @!scope class
+  #   @return [String] the keytab to use when verifying the identity of the KDC represented as a Base64 encoded string (overrides keytab_path)
+
+  # @!attribute [rw] keytab_path
+  #   @!scope class
+  #   @return [String] the path to the keytab to use when verifying the identity of the KDC
+
   # @!attribute [rw] server
+  #   @!scope class
   #   @return [String] the server principal name to use when verifying the identity of the KDC
 
   # @!attribute [rw] service
+  #   @!scope class
   #   @return [String] the service principal name to request a ticket for when obtaining a user's credentials
 
-  # @!attribute [rw] keytab_base64
-  #   @return [String] the keytab to use when verifying the identity of the KDC represented as a Base64 encoded string (overrides keytab_path)
-
-  # @!attribute [rw] keytab_path
-  #   @return [String] the path to the keytab to use when verifying the identity of the KDC
 
   @service = nil
 

data/lib/kerberos_authenticator/error.rb

@@ -1,4 +1,4 @@
 module KerberosAuthenticator
-  class Error < StandardError; end
+  class Error < ::StandardError; end
   class StandardError < Error; end
 end

data/lib/kerberos_authenticator/krb5.rb

@@ -19,8 +19,10 @@ module KerberosAuthenticator
     end
 
     # @!attribute [rw] use_secure_context
+    #   @!scope class
     #   @return [Boolean] if Context.context should ignore environmental variables when returning a library context
 
+
     @use_secure_context = true
 
     def self.use_secure_context

data/lib/kerberos_authenticator/krb5/attach_function.rb

@@ -1,8 +1,11 @@
 module KerberosAuthenticator
   module Krb5
+    # Attaches a Kerberos library function to Krb5.
     # Extends FFI's built-in method to:
     # - drop the krb5_ prefix from function names
     # - wrap any call returning a krb5_error_code with Krb5::Error.raise_if_error
+    # @api private
+    # @see http://www.rubydoc.info/github/ffi/ffi/FFI/Library#attach_function-instance_method FFI::Library#attach_function
     def self.attach_function(c_name, params, returns, options = {})
       ruby_name = c_name.to_s.gsub(/^krb5_/, '').to_sym
 

data/lib/kerberos_authenticator/krb5/context.rb

@@ -41,11 +41,16 @@ module KerberosAuthenticator
         self
       end
 
+      # @return [FFI::Pointer] the pointer to the krb5_context structure
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/types/krb5_context.html krb5_context
       def ptr
         @buffer.get_pointer(0)
       end
 
+      # Builds a Proc to free the Context once its no longer in use.
       # @api private
+      # @return [Proc]
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/api/krb5_free_context.html krb5_free_context
       def self.finalize(buffer)
         proc { Krb5.free_context(buffer.get_pointer(0)) }
       end

data/lib/kerberos_authenticator/krb5/creds.rb

@@ -39,6 +39,10 @@ module KerberosAuthenticator
         new(context, ptr)
       end
 
+      # Initialize a new Keytab with a pointer to a krb5_keytab structure, and define its finalizer.
+      # @param context [Context]
+      # @param ptr [FFI::MemoryPointer]
+      # @return [Keytab]
       def initialize(context, ptr)
         @context = context
         @ptr = ptr
@@ -77,7 +81,10 @@ module KerberosAuthenticator
         true
       end
 
+      # Builds a Proc to free the credentials once they're no longer in use.
       # @api private
+      # @return [Proc]
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/api/krb5_free_cred_contents.html krb5_free_cred_contents
       def self.finalize(context, ptr)
         proc { Krb5.free_cred_contents(context.ptr, ptr); ptr.free }
       end

data/lib/kerberos_authenticator/krb5/error.rb

@@ -6,8 +6,17 @@ module KerberosAuthenticator
 
     # A Kerberos library error
     class Error < StandardError
+      # @!attribute [r] error_code
+      #   @return [Integer] the krb5_error_code used to convey the status of a Kerberos library operation.
+      #   @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/types/krb5_error_code.html krb5_error_code 
+
+
       attr_reader :error_code
 
+      # Initializes a new Error using an error code and the relevant Context to provide a friendly error message.
+      # @param context_ptr [FFI::Pointer] A Context's pointer
+      # @param krb5_error_code [Integer] An integer used to convey a operation's status
+      # @return [Error]
       # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/api/krb5_get_error_message.html krb5_get_error_message
       def initialize(context_ptr, krb5_error_code)
         @error_code = krb5_error_code
@@ -16,10 +25,19 @@ module KerberosAuthenticator
         super(String.new(error_message))
       end
 
+      # Build a Proc to free the error message string once it's no longer in use.
+      # @api private
+      # @return [Proc]
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/api/krb5_free_error_message.html krb5_free_error_message
       def self.finalize(context_ptr)
         proc { |ptr| Krb5.free_error_message(context_ptr, ptr) }
       end
 
+      # Used to wrap Kerberos library functions that return a krb5_error_code.
+      # @return [Integer] always returns zero on success
+      # @yield [] A call to a Kerberos library function
+      # @yieldreturn [Integer] a krb5_error_code
+      # @raise [Error] if the krb5_error_code differed from zero
       def self.raise_if_error(context_ptr = nil)
         err = yield
         return 0 if err == 0

data/lib/kerberos_authenticator/krb5/keytab.rb

@@ -20,6 +20,10 @@ module KerberosAuthenticator
         new(context, buffer)
       end
 
+      # Initialize a new Keytab with a buffer containing a krb5_keytab structure, and define its finalizer.
+      # @param context [Context]
+      # @param buffer [FFI::Buffer]
+      # @return [Keytab]
       def initialize(context, buffer)
         @context = context
         @buffer = buffer
@@ -28,15 +32,22 @@ module KerberosAuthenticator
         self
       end
 
+      # @return [FFI::Pointer] the pointer to the krb5_keytab structure
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/types/krb5_keytab.html krb5_keytab
       def ptr
         @buffer.get_pointer(0)
       end
 
+      # @return [String] the type of the key table
+      # @see http://web.mit.edu/Kerberos/krb5-1.14/doc/appdev/refs/api/krb5_kt_get_type.html kt_get_type
       def type
         Krb5.kt_get_type(context.ptr, ptr)
       end
 
+      # Builds a Proc to close the Keytab once its no longer in use.
       # @api private
+      # @return [Proc]
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/api/krb5_kt_close.html krb5_kt_close
       def self.finalize(context, buffer)
         proc { Krb5.kt_close(context.ptr, buffer.get_pointer(0)) }
       end

data/lib/kerberos_authenticator/krb5/principal.rb

@@ -25,6 +25,10 @@ module KerberosAuthenticator
         new(context, buffer)
       end
 
+      # Initialize a new Principal with a buffer containing a krb5_principal structure, and define its finalizer.
+      # @param context [Context]
+      # @param buffer [FFI::Buffer]
+      # @return [Principal]
       def initialize(context, buffer)
         @context = context
         @buffer = buffer
@@ -42,6 +46,8 @@ module KerberosAuthenticator
         Creds.initial_creds_for_principal_with_a_password(self, password, service)
       end
 
+      # @return [FFI::Pointer] the pointer to the krb5_principal structure
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/types/krb5_principal.html krb5_principal
       def ptr
         @buffer.get_pointer(0)
       end
@@ -60,7 +66,10 @@ module KerberosAuthenticator
         copy
       end
 
+      # Builds a Proc to free the Principal once it's no longer in use.
       # @api private
+      # @return [Proc]
+      # @see http://web.mit.edu/kerberos/krb5-1.14/doc/appdev/refs/api/krb5_free_principal.html krb5_free_principal
       def self.finalize(context, buffer)
         proc { Krb5.free_principal(context.ptr, buffer.get_pointer(0)) }
       end

data/lib/kerberos_authenticator/version.rb

@@ -0,0 +1,3 @@
+module KerberosAuthenticator
+  VERSION = '0.0.6'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kerberos_authenticator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Adam Watkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -53,6 +53,7 @@ files:
 - lib/kerberos_authenticator/krb5/error.rb
 - lib/kerberos_authenticator/krb5/keytab.rb
 - lib/kerberos_authenticator/krb5/principal.rb
+- lib/kerberos_authenticator/version.rb
 homepage: https://github.com/stupidpupil/kerberos_authenticator
 licenses:
 - MIT
@@ -77,7 +78,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A Ruby library to authenticate a Kerberos user using their password. Uses
-  Ruby-FFI to interface with the Kerberos library.
+summary: Authenticate a Kerberos user using their password. Uses Ruby-FFI to interface
+  with the Kerberos library.
 test_files: []
 has_rdoc: