irb_tracker 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 24a2d3e713f454ea93b72a89319a7a6ee6537a2546e45af0181a407aaaafc3c6
+  data.tar.gz: 9382ae60ac08b325c92a821cd2066a9e1db03a4bd5f72ecf905aeeb49051e025
+SHA512:
+  metadata.gz: 7caaa57d35f1c8260f4557af458652e463c22cabcc460c271166b983b8ae318ebc6034f19d871e0e46a464f2968f33d41f5c9a735ae416b0f2a0e0d45888c362
+  data.tar.gz: 2f0418dd1a4d7870f32b1988325d54a9c7444337e31601ab12429b872793f8db704211f32cfc79b578f4db0343deb5e61d2b8696d9e929d4913221ef0fd79b61

data/.github/workflows/prs-master.yml

@@ -0,0 +1,33 @@
+name: CI-PRS-MASTER
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+      with:
+        fetch-depth: 1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: '2.6'
+    - name: Install Dependencies
+      run: |
+        gem install bundler
+        bundle install
+    - name: Eexecute Unit Tests
+      run: |
+        bundle exec rspec
+    - name: Validate Code Style
+      run: |
+        bundle exec rubocop

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/log/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+Style/ModuleFunction:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 17
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/*
+    - spec/**/*spec.rb
+Metrics/BlockLength:
+  Exclude:
+    - spec/*
+    - spec/**/*spec.rb
+    - rabbitmq_client.gemspec

data/.ruby-gemset

@@ -0,0 +1 @@
+irb_tracker

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+# Specify your gem's dependencies in irb_tracker.gemspec
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# IRBTracker
+
+IRBTracker is a tool that helps in tracking and correlating all commands exected in the IRB console. the gem supports the following features. 
+
+- Authenticate IRB console users using LDAP.
+- Collect IRB command logs into a local file.
+- Forward Logs to a centralized server using fluent-logger.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'irb_tracker'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Console
+
+In your `bin/rails` file you should add following
+
+```ruby
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'irb_tracker'
+require 'irb'
+require 'io/console'
+
+RAILS_USER = STDIN.getpass("Email:")
+if (IRBTracker::LDAPLogin.authenticate(RAILS_USER, STDIN.getpass("Password:")))
+  IRB::Context.prepend(IRBTracker::IRBLoggable.new("MyRailsApp"))
+  require 'rails/commands'
+else
+  puts "Invalid email and user"
+end
+
+```
+
+## LDAP Environment Variables
+```
+LDAP_HOST
+LDAP_PORT
+LDAP_BASELDAP_ADMIN_USER
+LDAP_ADMIN_PASSWORD
+```
+
+## FluentD Environment Variables
+```
+FLUENTD_LOGGING_ENABLED
+FLUENTD_LOG_HOST
+FLUENTD_LOG_HOST_PORT
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'irb_tracker'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)
+
+require 'pry-byebug'
+Pry.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/irb_tracker.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'irb_tracker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'irb_tracker'
+  spec.version       = IRBTracker::VERSION
+  spec.authors       = ['Al-waleed Shihadeh']
+  spec.email         = ['wshihadeh dot dev at gmail dot com']
+
+  spec.summary       = 'Track and corrolate IRB activities to users.'
+  spec.description   = 'Track all commands exected in an IRB console and '\
+                       'correlate the actions to the users executed them.'
+  spec.homepage      = 'https://github.com/wshihadeh/irb_tracker'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'net-ldap', '~> 0.16.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'fluent-logger', '~> 0.8.1'
+  spec.add_development_dependency 'net-ldap', '~> 0.16.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.75.1'
+end

data/lib/fluentd.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'fluent-logger'
+
+#:nodoc:
+class Fluentd
+  def self.get_logger(**options)
+    service_name = options.delete(:service_name)
+    logger = Fluent::Logger::LevelFluentLogger.new(
+      service_name,
+      host: options.delete(:host),
+      port: options.delete(:port)
+    )
+
+    logger.formatter = build_formatter(service_name)
+    logger
+  end
+
+  def self.build_formatter(service_name)
+    proc do |severity, datetime, progname, message|
+      map = { level: severity }
+      map[:message] = message[:error] || message[:event] || message[:command]
+      %i[error error_trace command result event name args source].each do |item|
+        map[item] = message[item] if message[item] && !message[item].empty?
+      end
+      map[:progname] = progname if progname
+      if datetime
+        map['@timestamp'] = datetime.strftime('%Y-%m-%dT%H:%M:%S.%3NZ')
+      end
+      map[:environment] = ENV.fetch('FLUENTD_LOGGING_ENVIRONMENT', 'undefined')
+      map[:service_name] = service_name
+      map[:app_version] = ENV.fetch('APP_VERSION', 'undefined')
+      map
+    end
+  end
+  private_class_method :build_formatter
+end

data/lib/irb_tracker.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'irb_tracker/version'
+
+#:nodoc:
+module IRBTracker
+end
+
+require 'irb_tracker/irb_loggable'
+require 'irb_tracker/ldap_login'

data/lib/irb_tracker/irb_loggable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'irb_tracker/logger_factory'
+
+module IRBTracker
+  #:nodoc:
+  class IRBLoggable < Module
+    def initialize(service_name = 'undefined')
+      logger = LoggerFactory.create service_name
+      # rubocop:disable Style/RedundantBegin
+      define_method :evaluate do |*args, &block|
+        begin
+          result = super(*args, &block)
+          logger.info(source: 'irb_console',
+                      user: LDAPLogin.current_user,
+                      command: args.first.chomp,
+                      result: inspect_last_value.chomp)
+          result
+        rescue StandardError => e
+          logger.error(source: 'irb_console',
+                       user: LDAPLogin.current_user,
+                       command: args.first.chomp,
+                       error: e.message,
+                       error_trace: e.backtrace.inspect)
+          raise e
+        end
+      end
+      # rubocop:enable Style/RedundantBegin
+    end
+  end
+end

data/lib/irb_tracker/ldap_login.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'net/ldap'
+
+module IRBTracker
+  #:nodoc:
+  class LDAPLogin
+    class << self
+      attr_reader :current_user
+
+      def authenticate(username, password)
+        @current_user = username
+        conn = ldap_connection
+        filter = Net::LDAP::Filter.eq('mail', username)
+        conn.bind_as(filter: filter, password: password)
+      rescue StandardError
+        false
+      end
+
+      private
+
+      def ldap_connection
+        conn = Net::LDAP.new(
+          host: ENV['LDAP_HOST'],
+          port: ENV['LDAP_PORT'],
+          base: ENV['LDAP_BASE'],
+          encryption: nil
+        )
+        conn.auth ENV['LDAP_ADMIN_USER'], ENV['LDAP_ADMIN_PASSWORD']
+        return false unless conn.bind
+
+        conn
+      end
+    end
+  end
+end

data/lib/irb_tracker/logger_factory.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+#:nodoc:
+module LoggerFactory
+  def self.create(service_name)
+    if ENV['FLUENTD_LOGGING_ENABLED'] == 'true'
+      require_relative '../fluentd'
+      Fluentd.get_logger(
+        service_name: service_name,
+        host: ENV['FLUENTD_LOG_HOST'],
+        port: ENV.fetch('FLUENTD_LOG_HOST_PORT', '24224')
+      )
+    else
+      require 'logger'
+      log_folder = 'log'
+      Dir.mkdir(log_folder) unless Dir.exist?(log_folder)
+      Logger.new("./#{log_folder}/console.log")
+    end
+  end
+end

data/lib/irb_tracker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IRBTracker
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: irb_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Al-waleed Shihadeh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.75.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.75.1
+description: Track all commands exected in an IRB console and correlate the actions
+  to the users executed them.
+email:
+- wshihadeh dot dev at gmail dot com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/prs-master.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- irb_tracker.gemspec
+- lib/fluentd.rb
+- lib/irb_tracker.rb
+- lib/irb_tracker/irb_loggable.rb
+- lib/irb_tracker/ldap_login.rb
+- lib/irb_tracker/logger_factory.rb
+- lib/irb_tracker/version.rb
+homepage: https://github.com/wshihadeh/irb_tracker
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wshihadeh/irb_tracker
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Track and corrolate IRB activities to users.
+test_files: []