redmine-http_basic_authentication 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 738727b792aebdcd321157a17af5444c1d8153fe
+  data.tar.gz: c2410be7c12b433d36ed424c2c5bd4866fa88e11
+SHA512:
+  metadata.gz: 722c264a48923851d77ab50ec42a3c9a2f1f81983a87aea2f1f13238f3e9b38c8617d19683094f5ce581139ff8febf3fcdb38420d7b6ea3285a064f14f13c4f2
+  data.tar.gz: c10593257a1619e169324c708cea3c814076b29102617d33188420b1b692d82b423fca609ca687c9f5d5b62a5faddfed762c8f4e7f1de32a7da0e598349dc083

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,8 @@
+StringLiterals:
+  EnforcedStyle: "double_quotes"
+
+Style/FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonas Thiel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# redmine-http_basic_authentication
+
+Use HTTP Basic Authentication for login and IMPLICIT registration for your Redmine application
+
+## Installation
+
+Ensure you have a `Gemfile.local` file in your Redmine installation. Add to your `Gemfile.local`:
+
+```ruby
+gem "redmine-http_basic_authentication"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Restart the Redmine application
+
+## Usage
+
+No further steps needed
+
+## Testing
+
+No automatic tests, sir! But this Redmine plugin is used in production.
+
+## TODO
+
+* Find a way to test this Redmine plugin
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redmine-http_basic_authentication/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

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop]

data/app/views/http_basic_authentication/_settings.html.erb

@@ -0,0 +1,5 @@
+<p>
+  <%= label_tag :settings_email_suffix, l(:http_basic_authentication_email_suffix) %>
+  <%= text_field_tag "settings[email_suffix]", @settings["email_suffix"] %>
+  <span class="hint"><%= l(:http_basic_authentication_email_suffix_hint) %></span>
+</p>

data/app/views/http_basic_authentication/logout.html.erb

@@ -0,0 +1,7 @@
+<h2><%= l(:http_basic_authentication_logout_title) %></h2>
+
+<div class="logout-message warning">
+  <p>
+    <%= l(:http_basic_authentication_logout_message) %>
+  </p>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  http_basic_authentication_email_suffix: "Email domain suffix"
+  http_basic_authentication_email_suffix_hint: "e.g. @neopoly.de"
+  http_basic_authentication_logout_title: "Logout"
+  http_basic_authentication_logout_message: "To end your session just close your browser!"

data/lib/http_basic_authentication/engine.rb

@@ -0,0 +1,10 @@
+require "http_basic_authentication/redmine_plugin"
+
+module HttpBasicAuthentication
+  # Simple engine to support the Redmine plugin
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      RedminePlugin.new
+    end
+  end
+end

data/lib/http_basic_authentication/infos.rb

@@ -0,0 +1,14 @@
+module HttpBasicAuthentication
+  # Module to share global gem / plugin information between
+  # the gem's specification and the Redmine plugin specification
+  module Infos
+    NAME        = "redmine-http_basic_authentication"
+    DESCRIPTION = "Use HTTP Basic Authentication for login and" \
+                  " IMPLICIT registration!"
+    LICENSE     = "MIT"
+    URL         = "https://github.com/neopoly/redmine-http_basic_authentication"
+    AUTHORS     = {
+      "Jonas Thiel" => "jt@neopoly.de"
+    }.freeze
+  end
+end

data/lib/http_basic_authentication/patches.rb

@@ -0,0 +1,19 @@
+require "http_basic_authentication/patches/application_controller_patch"
+require "http_basic_authentication/patches/account_controller_patch"
+
+module HttpBasicAuthentication
+  # This module holds all patches of a default Redmine application
+  module Patches
+    # Apply all patches
+    def self.apply!
+      apply_to(::ApplicationController, ApplicationControllerPatch)
+      apply_to(::AccountController, AccountControllerPatch)
+    end
+
+    private
+
+    def self.apply_to(target, mod)
+      target.send(:include, mod)
+    end
+  end
+end

data/lib/http_basic_authentication/patches/account_controller_patch.rb

@@ -0,0 +1,55 @@
+module HttpBasicAuthentication
+  module Patches
+    # This module overwrites the default behavior of the AccountController
+    # by disabling most of its methods as they make no sense in combination
+    # with the implicit user generation used by this plugin
+    module AccountControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :login, :http_basic
+        alias_method_chain :logout, :http_basic
+        alias_method_chain :lost_password, :http_basic
+        alias_method_chain :register, :http_basic
+        alias_method_chain :activate, :http_basic
+        alias_method_chain :activation_email, :http_basic
+      end
+
+      def login_with_http_basic
+        not_available!
+      end
+
+      # If the user was fully logged in only present a simple text
+      # stating to logout by closing the browser
+      def logout_with_http_basic
+        if User.current.anonymous?
+          redirect_to home_url
+        elsif request.post?
+          render "http_basic_authentication/logout"
+        end
+      end
+
+      def lost_password_with_http_basic
+        not_available!
+      end
+
+      def register_with_http_basic
+        not_available!
+      end
+
+      def activate_with_http_basic
+        not_available!
+      end
+
+      def activation_email_with_http_basic
+        not_available!
+      end
+
+      private
+
+      def not_available!
+        render text: "Method Not Allowed", status: 405
+      end
+    end
+  end
+end

data/lib/http_basic_authentication/patches/application_controller_patch.rb

@@ -0,0 +1,46 @@
+module HttpBasicAuthentication
+  module Patches
+    # This module patches the default authentication system
+    # by using HTTP Basic Authorization headers fields to login
+    # users or create them if necessary.
+    module ApplicationControllerPatch
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :try_to_autologin, :http_basic
+      end
+
+      # We hijack the autologin method as this the HTTP Basic authorization
+      # is a kind of auto login system which created users on the fly.
+      def try_to_autologin_with_http_basic
+        if http_authorization?
+          authenticate_with_http_basic do |username, _password|
+            logger.info "Successful authentication for '#{username}'" \
+              "from #{request.remote_ip} at #{Time.now.utc}"
+            self.logged_user = User.find_by_login(username) ||
+              create_http_authorization_user(username)
+          end
+        else
+          try_to_autologin_without_http_basic
+        end
+      end
+
+      private
+
+      def http_authorization?
+        request.authorization.present?
+      end
+
+      def create_http_authorization_user(username)
+        email = "#{username}#{email_suffix}"
+        user = User.new(mail: email, firstname: username, lastname: username)
+        user.login = username
+        user.save!
+      end
+
+      def email_suffix
+        Setting.plugin_http_basic_authorization["email_suffix"]
+      end
+    end
+  end
+end

data/lib/http_basic_authentication/redmine_plugin.rb

@@ -0,0 +1,33 @@
+require "http_basic_authentication/patches"
+
+module HttpBasicAuthentication
+  # Registers this gems a Redmine plugin and applies the needed patches
+  class RedminePlugin
+    include HttpBasicAuthentication::Infos
+
+    def initialize
+      register!
+      boot!
+    end
+
+    private
+
+    def register!
+      Redmine::Plugin.register :http_basic_authentication do
+        name NAME
+        author AUTHORS.keys.join(", ")
+        description DESCRIPTION
+        version VERSION
+        url URL
+        author_url URL
+
+        settings default: { "email_suffix" => "@neopoly.de" },
+                 partial: "http_basic_authentication/settings"
+      end
+    end
+
+    def boot!
+      Patches.apply!
+    end
+  end
+end

data/lib/http_basic_authentication/version.rb

@@ -0,0 +1,3 @@
+module HttpBasicAuthentication
+  VERSION = "0.0.1"
+end

data/lib/redmine-http_basic_authentication.rb

@@ -0,0 +1,8 @@
+require "http_basic_authentication/version"
+require "http_basic_authentication/infos"
+require "http_basic_authentication/engine"
+
+# Redmine plugin to support HTTP basic authentication based
+# authentication mechanism
+module HttpBasicAuthentication
+end

data/redmine-http_basic_authentication.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "http_basic_authentication/version"
+require "http_basic_authentication/infos"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redmine-http_basic_authentication"
+  spec.version       = HttpBasicAuthentication::VERSION
+  spec.authors       = HttpBasicAuthentication::Infos::AUTHORS.keys
+  spec.email         = HttpBasicAuthentication::Infos::AUTHORS.values
+  spec.summary       = HttpBasicAuthentication::Infos::DESCRIPTION
+  spec.description   = HttpBasicAuthentication::Infos::DESCRIPTION
+  spec.homepage      = HttpBasicAuthentication::Infos::URL
+  spec.license       = HttpBasicAuthentication::Infos::LICENSE
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 4.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: redmine-http_basic_authentication
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonas Thiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Use HTTP Basic Authentication for login and IMPLICIT registration!
+email:
+- jt@neopoly.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/http_basic_authentication/_settings.html.erb
+- app/views/http_basic_authentication/logout.html.erb
+- config/locales/en.yml
+- lib/http_basic_authentication/engine.rb
+- lib/http_basic_authentication/infos.rb
+- lib/http_basic_authentication/patches.rb
+- lib/http_basic_authentication/patches/account_controller_patch.rb
+- lib/http_basic_authentication/patches/application_controller_patch.rb
+- lib/http_basic_authentication/redmine_plugin.rb
+- lib/http_basic_authentication/version.rb
+- lib/redmine-http_basic_authentication.rb
+- redmine-http_basic_authentication.gemspec
+homepage: https://github.com/neopoly/redmine-http_basic_authentication
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Use HTTP Basic Authentication for login and IMPLICIT registration!
+test_files: []
+has_rdoc: