gatepass 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6adfbc31cccc12d1786457c468667bcba579db0db4639aae68a01bb61a570e64
-  data.tar.gz: 5e456e23ddcda822bc391601c88fb0286184abc9f164de6ad2cf35e1765b912d
+  metadata.gz: 22e7d410f8cc59147182ef88f8b78fee3f0801f8bef57aea3f469b655f77f294
+  data.tar.gz: 1988ca42cd43522a1261885a7b69bac2768435071c5e607bf5de864e8bb179c4
 SHA512:
-  metadata.gz: 10d45f2705514fbd230e72a336f13935e88d571b55d76431c1acedb942f47c34b84cb352c55c442842fe1df00d08641b21ac02444ded243149aba3a77f20e0c9
-  data.tar.gz: 200c1bf025039c8e889951d30afe355dc8b010087c8e66526d854ff38438887b6cb329ccefdb00f063baf4e3f5d4017346b45ba564160890ffc2b3e78a954304
+  metadata.gz: bbacc80c229ef6cf208bc16e9a9b769c5b38dbe40dd11220f5b8910669e69200c08c5cd1e7a102e2ab8e142518920707c532a4b001639f35ee8c23e5ccf8fa12
+  data.tar.gz: 9610a39b9bfd248cdf2db26317cef29e4bcb9618b4086b181189cbcdf94f3f32f82d0c346f3c9eae3572d68211863b74e892c145f16d497467f1c3a06dde94a4

data/README.md

@@ -2,7 +2,17 @@
 Short description and motivation.
 
 ## Usage
-How to use my plugin.
+See the Installation section below.
+
+For setting up a DEV environment, clone the directory within a rails project and add to the Gemfile:
+```
+gem 'gatepass', path: 'gatepass'
+```
+OR
+```
+gem 'gatepass', git: 'https://github.com/pockettheories/gatepass'
+```
+See [Bundle Git Guide](https://bundler.io/guides/git.html) for more
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -20,6 +30,16 @@ Or install it yourself as:
 ```bash
 $ gem install gatepass
 ```
+OR
+```bash
+$ bundle add gatepass
+```
+
+Mount the engine with the following line in `config/routes.rb` :
+```
+mount Gatepass::Engine => '/gatepass'
+```
+Ensure you also have the root configured (Eg. `root 'home#index''`) for your Rails application.
 
 Modify the application controller to include the Gatepass module and add the authentication check:
 ```
@@ -29,7 +49,19 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-TODO - Configuration parameters
+In `config/application.rb` , define the following configuration parameters:
+```
+config.ldap_server_hostname = 'myldap.com'
+config.ldap_server_port = 636
+config.ldap_ca_cert = '/etc/path/ca.cert'
+config.ldap_base = 'DN=myldap,DN=com'
+```
+
+Run the migrations with:
+```
+rails gatepass:install:migrations
+rails db:migrate
+```
 
 Create an initial user account with:
 ```
@@ -41,18 +73,34 @@ u1.auth_type = 'local'
 u1.save
 ```
 
+Create an initial ActiveDirectory user account with:
+```
+$ rails c
+u1 = Gatepass::User.new
+u1.username = 'reddy'
+u1.password = 'dummy'
+u1.auth_type = 'activedirectory'
+u1.rolename = 'admin'
+u1.username_mapping = 'CN=reddy,CN=Users,DC=pockettheories,DC=com'
+u1.save
+```
+
 Login with the above account, and access the user account management page at:
 http://localhost:3000/gatepass/users
 
+The logout URL is:
+http://localhost:3000/gatepass/authentication/logout
+
 ## Other Notes
 The User model has the fields: username:string auth_type:string password_digest:string username_mapping:string
-
 auth_type is `local` or `activedirectory`.
-
 Use a dummy password for activedirectory users.
 
+If you get the error "SSL_CTX_load_verify_file: system lib" when attempting to login as an ActiveDirectory user, it's 
+Ruby complaining about your OpenSSL version. (On MacOS Ventura 13.4.1, rbenv with Ruby 3.1.0 works; Ruby 3.2.2 doesn't)
+
 ## Contributing
-Contribution directions go here.
+Create a pull request on GitHub.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/gatepass/authentication_controller.rb

@@ -1,13 +1,17 @@
 module Gatepass
+  # Provides the login/logout functionality
   class AuthenticationController < ApplicationController
+    # Display the login form
     def login
     end
 
+    # Remove the user from the session and redirect to the login form
     def logout
       session.delete :user
       redirect_to  :action => :login
     end
 
+    # Process the POST from the login form
     def authenticate
       username = params[:username]
       password = params[:password]
@@ -19,13 +23,13 @@ module Gatepass
         if user_obj === false
           redirect_to ({ controller: 'gatepass/authentication', action: 'login' })
         else
-          session[:user] = user_obj
+          session[:user] = user
           redirect_to main_app.root_url
         end
       elsif user.auth_type == 'activedirectory' # 'ldap'
         require 'net/ldap'
 
-        server_address = Rails.application.config.ldap_server_hostname  # 'ad.nitinkatkam.mdbrecruit.net'
+        server_address = Rails.application.config.ldap_server_hostname
         server_port = Rails.application.config.ldap_server_port
         ca_certificate = Rails.application.config.ldap_ca_cert
 
@@ -34,7 +38,7 @@ module Gatepass
                              :encryption => {
                                method: :simple_tls,
                                tls_options: {
-                                 ca_file: ca_certificate  # '/Users/nitin.katkam/Downloads/nitinkatkam-ad-ca.cer',
+                                 ca_file: ca_certificate
                                  # verify_mode: OpenSSL::SSL::VERIFY_NONE
                                }
                              },
@@ -45,18 +49,17 @@ module Gatepass
                              }
 
         filter = Net::LDAP::Filter.eq("distinguishedname", user.username_mapping)
-        treebase = Rails.application.config.ldap_base  # "dc=nitinkatkam, dc=mdbrecruit, dc=net"
+        treebase = Rails.application.config.ldap_base
 
         search_result_count = 0
         ldap.search(:base => treebase, :filter => filter) do |entry|
           search_result_count += 1
-          # puts "DN: #{entry.dn}" # CN=bindUser1,CN=Users,DC=nitinkatkam,DC=mdbrecruit,DC=net
-          # puts "memberOf: #{entry.memberof}" #["CN=peopleOfNitinKatkam,CN=Users,DC=nitinkatkam,DC=mdbrecruit,DC=net", "CN=Administrators,CN=Builtin,DC=nitinkatkam,DC=mdbrecruit,DC=net"]
 
           if ldap.get_operation_result.code == 49 or search_result_count == 0
             redirect_to({ controller: 'gatepass/authentication', action: 'login' })
           elsif search_result_count == 1
-            session[:user] = user # entry  # user_obj
+            session[:user] = user # entry
+            session[:user_ldap_info] = entry
             redirect_to main_app.root_url
           else
             redirect_to({ controller: 'gatepass/authentication', action: 'login' })

data/app/controllers/gatepass/users_controller.rb

@@ -1,3 +1,8 @@
+#
+#
+# Refactor the code to make it less repetitive
+#
+
 module Gatepass
   class UsersController < ApplicationController
     before_action :set_user, only: %i[ show edit update destroy ]
@@ -5,25 +10,50 @@ module Gatepass
     # GET /users
     def index
       @users = User.all
+
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin'
+        @users = @users.where(:id => @current_user[:id])
+      end
     end
 
     # GET /users/1
     def show
+
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin' and @user[:id] != @current_user[:id]
+        redirect_to  users_url, notice: "You must be an admin to view users"
+      end
     end
 
     # GET /users/new
     def new
       @user = User.new
+
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin'
+        redirect_to  users_url, notice: "You must be an admin to create a new user"
+      end
     end
 
     # GET /users/1/edit
     def edit
+
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin'
+        redirect_to  users_url, notice: "You must be an admin to edit a user"
+      end
     end
 
     # POST /users
     def create
       @user = User.new(user_params)
 
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin'
+        redirect_to  users_url, notice: "You must be an admin to create a new user"
+      end
+
       if @user.save
         redirect_to @user, notice: "User was successfully created."
       else
@@ -33,6 +63,12 @@ module Gatepass
 
     # PATCH/PUT /users/1
     def update
+
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin'
+        redirect_to  users_url, notice: "You must be an admin to update a new user"
+      end
+
       if @user.update(user_params)
         redirect_to @user, notice: "User was successfully updated."
       else
@@ -42,6 +78,12 @@ module Gatepass
 
     # DELETE /users/1
     def destroy
+
+      @current_user = session[:user]
+      if @current_user['rolename'] != 'admin'
+        redirect_to  users_url, notice: "You must be an admin to delete a new user"
+      end
+
       @user.destroy
       redirect_to users_url, notice: "User was successfully destroyed.", status: :see_other
     end
@@ -54,7 +96,7 @@ module Gatepass
 
       # Only allow a list of trusted parameters through.
       def user_params
-        params.require(:user).permit(:username, :auth_type, :password_digest, :username_mapping)
+        params.require(:user).permit(:username, :auth_type, :password_digest, :rolename, :username_mapping)
       end
   end
 end

data/app/views/gatepass/users/_form.html.erb

@@ -18,7 +18,8 @@
 
   <div>
     <%= form.label :auth_type, style: "display: block" %>
-    <%= form.text_field :auth_type %>
+    <%#= form.text_field :auth_type %>
+    <%= form.select :auth_type, ["local", "activedirectory"].map {|e| [e, e]} %>
   </div>
 
   <div>
@@ -26,6 +27,12 @@
     <%= form.text_field :password_digest %>
   </div>
 
+  <div>
+    <%= form.label :rolename, style: "display: block" %>
+    <%#= form.text_field :rolename %>
+    <%= form.select :rolename, ["user", "admin"].map {|e| [e, e]} %>
+  </div>
+
   <div>
     <%= form.label :username_mapping, style: "display: block" %>
     <%= form.text_field :username_mapping %>

data/app/views/gatepass/users/_user.html.erb

@@ -14,6 +14,11 @@
     <%= user.password_digest %>
   </p>
 
+  <p>
+    <strong>Role:</strong>
+    <%= user.rolename %>
+  </p>
+
   <p>
     <strong>Username mapping:</strong>
     <%= user.username_mapping %>

data/app/views/gatepass/users/index.html.erb

@@ -12,3 +12,8 @@
 </div>
 
 <%= link_to "New user", new_user_path %>
+
+<!--<div>-->
+<!--  <b>Current User:</b>-->
+  <%#= session[:user] %>
+<!--</div>-->

data/db/migrate/20230726110030_create_gatepass_users.rb

@@ -5,6 +5,7 @@ class CreateGatepassUsers < ActiveRecord::Migration[7.0]
       t.string :auth_type
       t.string :password_digest
       t.string :username_mapping
+      t.string :rolename
 
       t.timestamps
     end

data/lib/gatepass/version.rb

@@ -1,3 +1,3 @@
 module Gatepass
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/gatepass.rb

@@ -2,9 +2,10 @@ require "gatepass/version"
 require "gatepass/engine"
 
 module Gatepass
+  # Check if the user is defined in the session; if not, redirects to the login page
   def check_authenticated
     if session[:user].nil?
-      redirect_to user_auth.authentication_login_path ({ :controller => 'gatepass/authentication', :action => :login })
+      redirect_to gatepass.authentication_login_path ({ :controller => 'gatepass/authentication', :action => :login })
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gatepass
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Nitin Reddy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.19
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 description: This Rails plugin enables you to authenticate users against the local
   database as well as against an ActiveDirectory server
 email:
@@ -77,9 +91,11 @@ files:
 - lib/gatepass/engine.rb
 - lib/gatepass/version.rb
 - lib/tasks/gatepass_tasks.rake
-homepage:
+homepage: https://github.com/pockettheories/gatepass
 licenses: []
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/pockettheories/gatepass
+  source_code_uri: https://github.com/pockettheories/gatepass
 post_install_message:
 rdoc_options: []
 require_paths: