omniauth-pam 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b8fbb686758b548b9cb92beff12b856f296917bd
-  data.tar.gz: 66eeb3d1ae5cfab7b1c081c5b5ef3512920fac2e
+SHA256:
+  metadata.gz: 3ad17e332ef7ec8d88db799e55709bd4a37c0f066c7dbf009ff9fd89aa4f3055
+  data.tar.gz: f2b8dc59720e592fc6e60171bc61b28e4d506475fd26be7269c2730ee49f57ae
 SHA512:
-  metadata.gz: 3db044f0ae0813b5bd3e43b803ebeb4dd74a5e2c32860f1968a6da423382ba01aedcf40a17bf01b1123ca95ab41f946152b1f6de72f78c93dd2f2a030037c592
-  data.tar.gz: 985c0e077c041bd3668a3f5beb85ace4fa31e1f16e5680af758148cf6b6f9432fd9a940ff2126a7023b08fe7d4d383a9070a8ac1909aedc66eca749d6c07bb64
+  metadata.gz: 5459da25741c89ec011f234cc4e634ccfffcf025ce94ee739eedcd86116a551e14810b7ddaa065ad55ef432c7fef8df9f5a85b31ccdac0c8895311dc9a123aa4
+  data.tar.gz: 911e2c60b64f08c52405b29991fcefc81555f2a0a9965b395ffe8ffa8dedd50d5b7e0ea9df446fe82ea583bb0e1304103939a274eb8c40f1fa4865bdcdc6ee57

data/.gitignore

@@ -1,4 +1,28 @@
-*.gem
-.bundle
 Gemfile.lock
-pkg/*
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+rvm:
+  2.5.1
+addons:
+  apt:
+    packages:
+      - libpam0g-dev

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# CHANGELOG
+
+## 1.3.0 (2018-05-19)
+
+* Update the README.
+* Add this CHANGELOG.
+* Update the dependencies ([12][]).
+* List the correct port in the README ([10][]).
+* Add a more standard Ruby gitignore ([15][]).
+* Add Travis for CI ([14][]).
+* Add tests ([13][]).
+* Update Vagrantfile.
+* Handle cases where `gecos` data is missing.
+
+[13]: https://github.com/nickcharlton/omniauth-pam/pull/13
+[14]: https://github.com/nickcharlton/omniauth-pam/pull/14
+[15]: https://github.com/nickcharlton/omniauth-pam/pull/15
+[10]: https://github.com/nickcharlton/omniauth-pam/pull/10
+[12]: https://github.com/nickcharlton/omniauth-pam/pull/12
+
+## 1.2.1 (2012-11-15)
+
+* Adds a license file.
+* Improves the README.
+
+## 1.2.0 (2013-11-09)
+
+* Add missing OmniAuth interface requirements.
+* Add `etc` to fetch info fields.
+* Add a basic Sinatra example.
+* Add a Vagrantfile for testing.
+* Add a configurable `email` field.
+
+## 1.0.1 (2012-02-26)
+
+* Fix load path issues.
+* Specify `rpam-ruby19` version dependency.
+
+## 1.0.0 (2012-01-15)
+
+* Initial Release.

data/README.md

@@ -1,7 +1,7 @@
 # omniauth-pam
 
-An OmniAuth strategy to allow you to authentication against Pluggable Authentication
-Modules (PAM).
+An [OmniAuth][] strategy to allow you to authentication against
+[Pluggable Authentication Modules][pam] (PAM).
 
 ## Installation
 
@@ -13,33 +13,37 @@ gem install omniauth-pam
 
 ## Usage
 
-It has been tested under Ruby 1.9 and 2.0 on both Debian Wheezy (7.0) and Ubuntu
-Precise (12.04). [Ruby 1.8 can be made to work with small adjustments][oldruby].
-Under both Debian and Ubuntu you'll need the `libpam0g-dev` package to compile the
-`rpam` dependency.
+`libpam0g-dev` is needed to install on Debian and Ubuntu. An example
+`Vagrantfile` is provided to test this out.
 
-The included `Vagrantfile` provides a Debian Wheezy environment and the `example/`
-directory provides a working Sinatra example.
-
-### Simple Sinatra Example
-
-But, getting it working is as simple as this:
+### Sinatra Example
 
 ```ruby
-require 'omniauth'
-require 'omniauth-pam'
+require "omniauth"
+require "omniauth-pam"
 
-use Rack::Session::Cookie
+use Rack::Session::Cookie, secret: "a_random_hash"
 use OmniAuth::Strategies::PAM
 
-get '/auth/:provider/callback' do
-    puts request.env['omniauth.auth']
+get "/auth/:provider/callback" do
+  puts request.env['omniauth.auth']
 end
 ```
 
-## Author
+See the [example/][] directory.
 
-Copyright (c) 2013 Nick Charlton and contributors. MIT Licensed.
+## Contributing
+
+1. Fork it ( https://github.com/nickcharlton/omniauth-pam/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 a new Pull Request
+
+## Author
 
-[oldruby]: http://nickcharlton.net/post/pam-for-omniauth
+Copyright (c) 2018 Nick Charlton. MIT Licensed.
 
+[OmniAuth]: https://github.com/omniauth/omniauth
+[pam]: https://en.wikipedia.org/wiki/Pluggable_authentication_module<Paste>
+[example/]: /example

data/Rakefile

@@ -1 +1,14 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
 require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/Vagrantfile

@@ -1,15 +1,13 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-Vagrant.configure('2') do |config|
-  config.vm.hostname = 'omniauth-pam'
-  config.vm.box = 'boxes-wheezy64-chef'
-  config.vm.box_url = 'http://boxes.nickcharlton.net/wheezy64-chef-virtualbox.box'
+Vagrant.configure("2") do |config|
+  config.vm.hostname = "omniauth-pam"
+  config.vm.box = "boxesio/ruby"
 
-  # forward a port for testing
-  config.vm.network "forwarded_port", guest: 5000, host: 8080, auto_correct: true
+  config.vm.network "forwarded_port", guest: 5000,
+                                      host: 8080,
+                                      auto_correct: true
 
-  # ensure the basic packages exist to get it all working
-  config.vm.provision 'shell', inline: 'sudo apt-get -yqq install git libpam0g-dev;'\
-                                        'sudo gem install bundler foreman'
+  config.vm.provision "shell", inline: "sudo apt-get -yq install libpam0g-dev"
 end

data/example/Gemfile

@@ -1,6 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'sinatra', '~> 1.3.2', require: 'sinatra/base'
-gem 'omniauth', '~> 1.0.2'
-gem 'omniauth-pam', path: File.join(__FILE__, '../..')
-gem 'unicorn'
+gem "omniauth", "~> 1.5"
+gem "omniauth-pam", path: File.join(__FILE__, "../..")
+gem "sinatra", "~> 2.0", require: "sinatra/base"

data/example/README.md

@@ -6,17 +6,18 @@ primitive [Sinatra][] application.
 You can start it by doing:
 
 ```bash
-[sudo] gem install bundler foreman
-bundle install
-foreman start
+sudo apt-get install bundler # or: sudo gem install bundler
+bundle install --path vendor/bundle
+bundle exec rackup
 ```
 
 Preferably from within the Vagrantfile included in the root of the repository.
 
 ## Usage
 
-1. Go to http://localhost:5000
+1. Go to http://localhost:9292
 2. You'll be redirected to a login page.
 3. Enter a system user account (for example: vagrant/vagrant).
 4. Then, you'll be redirected to another page listing the auth hash details.
 
+[Sinatra]: http://www.sinatrarb.com

data/example/app.rb

@@ -1,6 +1,6 @@
 class App < Sinatra::Base
   use Rack::Session::Cookie
-  use OmniAuth::Strategies::PAM
+  use OmniAuth::Strategies::PAM, email_domain: "localhost.localdomain"
 
   helpers do
     def ensure_auth

data/lib/omniauth-pam.rb

@@ -1,7 +1,2 @@
-# depends upon rpam and etc
-require "rpam"
-require "etc"
-
-# then the rest of the strategy
 require "omniauth-pam/version"
-require "omniauth/strategies/pam"
+require "omniauth/pam"

data/lib/omniauth-pam/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module PAM
-    VERSION = "1.2.1"
+    VERSION = "1.3.0".freeze
   end
 end

data/lib/omniauth/pam.rb

@@ -0,0 +1,9 @@
+require "omniauth"
+require "rpam"
+require "etc"
+
+module OmniAuth
+  module Strategies
+    autoload :PAM, "omniauth/strategies/pam"
+  end
+end

data/lib/omniauth/strategies/pam.rb

@@ -9,6 +9,8 @@ module OmniAuth
 
       # this map is used to return gecos in info
       option :gecos_map, [:name, :location, :phone, :home_phone, :description]
+      # option :email_domain - if defined, info.email is build using uid@email_domain if not found from gecos
+      # option :service - pam service name passed to rpam (/etc/pam.d/service_name), if not given rpam uses 'rpam'
 
       def request_phase
         OmniAuth::Form.build(
@@ -31,27 +33,27 @@ module OmniAuth
         super
       end
 
+      uid do
+        request['username']
+      end
+
+      info do
+        info = { :nickname => uid, :name => uid }
+        info[:email] = "#{uid}@#{options[:email_domain]}" if options.has_key?(:email_domain)
+        info.merge!(parse_gecos || {})
+      end
+
+      private
+
       def parse_gecos
         if options[:gecos_map].kind_of?(Array)
           begin
             gecos = Etc.getpwnam(uid).gecos.split(',')
-            Hash[options[:gecos_map].zip(gecos)].delete_if { |k, v| v.nil? }
+            Hash[options[:gecos_map].zip(gecos)].delete_if { |k, v| v.nil? || v.empty? }
           rescue
           end
         end
       end
-
-      uid do
-        request['username']
-      end
-
-      info do
-        {
-          :nickname => uid,
-          :name => uid,
-          :email => "#{uid}#{ options.has_key?(:email) ? options[:email] : ''}"
-        }.merge!(parse_gecos)
-      end
     end
   end
 end

data/omniauth-pam.gemspec

@@ -1,25 +1,29 @@
-# encoding: UTF-8
-require File.expand_path('../lib/omniauth-pam/version', __FILE__)
+$:.push File.expand_path("lib", __dir__)
+
+require "omniauth-pam/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'omniauth-pam'
+  s.name        = "omniauth-pam"
   s.version     = OmniAuth::PAM::VERSION
-  s.authors     = ['Nick Charlton']
-  s.email       = ['hello@nickcharlton.net']
-  s.homepage    = 'https://github.com/nickcharlton/omniauth-pam'
-  s.license     = 'MIT'
-  s.summary     = 'A PAM strategy for OmniAuth.'
-  s.description = 'An OmniAuth strategy to allow you to authenticate '\
-                  'against Pluggable Authentication Modules (PAM).'
-
-  s.rubyforge_project = 'omniauth-pam'
+  s.authors     = ["Nick Charlton"]
+  s.email       = ["nick@nickcharlton.net"]
+  s.homepage    = "https://github.com/nickcharlton/omniauth-pam"
+  s.license     = "MIT"
+  s.summary     = "A PAM strategy for OmniAuth."
+  s.description = "An OmniAuth strategy to allow you to authenticate " \
+                  "against Pluggable Authentication Modules (PAM)."
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  s.files         = `git ls-files`.split($RS)
+  s.executables   = s.files.grep(/^exe/) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(/^(test|spec|features)/)
+  s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'omniauth', '~> 1.0'
+  s.add_runtime_dependency "omniauth", "~> 1.5"
   s.add_runtime_dependency 'rpam-ruby19', '~> 1.2.1'
   s.add_runtime_dependency 'etc'
+
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rack-test"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
 end

data/spec/omniauth/strategies/pam_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe OmniAuth::Strategies::PAM do
+  describe "#request_phase" do
+    it "displays a form" do
+      get "/auth/pam"
+
+      expect(last_response.body).to include("<form")
+    end
+  end
+
+  describe "#callback_phase" do
+    context "with valid credentials" do
+      it "populates the auth hash" do
+        mock_rpam(valid_credentials.merge(opts: {})).and_return(true)
+        mock_etc
+
+        post "/auth/pam/callback", valid_credentials
+
+        expect(auth_hash["provider"]).to eq("pam")
+        expect(auth_hash["uid"]).to eq("authur")
+        expect(auth_hash["info"]["name"]).to eq("Authur Dent")
+        expect_rpam_to_be_called(valid_credentials.merge(opts: {}))
+      end
+    end
+
+    context "with invalid credentials" do
+      it "redirects to /auth/failure" do
+        mock_rpam(invalid_credentials.merge(opts: {}))
+
+        post "/auth/pam/callback", invalid_credentials
+
+        expect(last_response).to be_redirect
+        expect(last_response.headers["Location"]).to eq(
+          "/auth/failure?message=invalid_credentials&strategy=pam",
+        )
+        expect_rpam_to_be_called(invalid_credentials.merge(opts: {}))
+      end
+    end
+  end
+
+  private
+
+  def app
+    Rack::Builder.new do
+      use Rack::Session::Cookie, secret: "xyz"
+      use OmniAuth::Strategies::PAM
+
+      run lambda { |env| [404, { "env" => env }, ["PAM Strategy App"]] }
+    end.to_app
+  end
+
+  def auth_hash
+    last_response.headers["env"]["omniauth.auth"]
+  end
+
+  def valid_credentials
+    { username: "authur", password: "a_password" }
+  end
+
+  def invalid_credentials
+    { username: "not_a_valid_user", password: "not_a_valid_password" }
+  end
+
+  def mock_rpam(username:, password:, opts:)
+    allow(Rpam).to receive(:auth).with(username, password, opts)
+  end
+
+  def expect_rpam_to_be_called(username:, password:, opts: {})
+    expect(Rpam).to have_received(:auth).with(username, password, opts)
+  end
+
+  def mock_etc
+    etc_struct = Etc::Passwd.new
+    etc_struct.gecos = "Authur Dent,,"
+
+    expect(Etc).to receive(:getpwnam).with("authur").and_return(etc_struct)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "bundler"
+Bundler.setup :default, :development, :test
+
+require "rack/test"
+require "omniauth/pam"
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end

metadata

@@ -1,66 +1,124 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-pam
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Nick Charlton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2018-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rpam-ruby19
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: etc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: An OmniAuth strategy to allow you to authenticate against Pluggable Authentication
   Modules (PAM).
 email:
-- hello@nickcharlton.net
+- nick@nickcharlton.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -73,8 +131,11 @@ files:
 - example/config.ru
 - lib/omniauth-pam.rb
 - lib/omniauth-pam/version.rb
+- lib/omniauth/pam.rb
 - lib/omniauth/strategies/pam.rb
 - omniauth-pam.gemspec
+- spec/omniauth/strategies/pam_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/nickcharlton/omniauth-pam
 licenses:
 - MIT
@@ -85,18 +146,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: omniauth-pam
-rubygems_version: 2.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A PAM strategy for OmniAuth.
-test_files: []
+test_files:
+- spec/omniauth/strategies/pam_spec.rb
+- spec/spec_helper.rb