fradium 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ce71d5bd193a02708e7df237def67eaea5c5f9be61b550af5a65ca834ede942
+  data.tar.gz: 7d72e9d9c41dc3f96988a3bba3ae7474e4f783c318e7a65ffb6dc130d86aa947
+SHA512:
+  metadata.gz: 3fe0709bfb196128e913d4225967735bb67ae4c2763d4bc6137ed9ea30c0875edc11291a6168c42f5a9a9b1fa01590260e8f100fc8ab173f0cf01a00f7510122
+  data.tar.gz: 2f7c921c15bf3a55ab5f5f26a5786448de55c628c9d78c12689146919fcea32bf139e0fd8e39804a8bb5f593b3dbc882ccd75940d482c20ebc6c5595aca0537f

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# editor's temporary files
+*.sw?
+*~
+
+# built gem
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fradium.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    fradium (0.1.2)
+      mysql2 (~> 0.5)
+      sequel (~> 5.23)
+      sqlite3 (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    mysql2 (0.5.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    sequel (5.24.0)
+    sqlite3 (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fradium!
+  pry (~> 0.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (C) 2019 Koichiro Iwao <meta@vmeta.jp>
+Copyright (C) 2019 HAW International, Inc.
+
+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 INCONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Fradium - FreeRADIUS User Manager
+
+Fradium comes from **F**ree**RADIU**S **U**ser **M**anager. Quick and easy tool to manage user database of FreeRADIUS.
+
+## License
+This software is licensed under the MIT license.
+
+## Installation
+
+    $ gem install fradium
+
+## Usage
+
+### Configuration
+
+First of all, create a confiuration file called `.fradium.yaml` in your home directory and specify information needed to your RADIUS database. You can define multiple configuration sets called *profile*.
+
+Supported databases are MySQL and MariaDB via `mysql2` adapter so far. It should be work with SQLite or PostgreSQL but still experimental.
+
+```
+default: # default profile
+  adapter: mysql2
+  host: radius.mysql.example.com
+  username: root
+  password:
+  database: radius
+
+staging:
+  adapter: mysql2
+  host: radius.mysql.example.com
+  username: root
+  password:
+  database: radius_staging
+```
+
+Profiles can be choose by `--profile` option. Specify like `--profile=targetprofile`. If not specified, profile named `default` will be refered by default.
+
+### Further usage
+
+It would be easy to use. Running `fradium` without any options will show the usage.
+
+```
+usage:
+  exe/fradium [--profile=profile] subcommand ...
+
+subcommands as follows:
+  create <username>                   # create new user with password
+  show <username>                     # show password for username
+  showall                             # show all users
+  showvalid                           # show valid(not expired) users
+  showexpired                         # show expired users
+  expire <username>                   # expire the user right now
+  unexpire <username>                 # unexpire the user
+  setexpire <username> <expiry date>  # set expiry date (date must be parseable by Time#parse)
+  modify <username>                   # generate new password for username
+  dbconsole                           # enter database console
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/metalefty/fradium.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fradium"
+
+# 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__)

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/exe/fradium

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require_relative '../lib/fradium'
+
+def config_file_not_found
+  print <<"EOD"
+#{File.basename $0}: config file not found
+
+Put ~/.fradium.yaml to define MySQL database to connect.
+An Example of .fradium.yaml as follows.
+
+-------------------------------------------------------------------------------
+
+default: # default profile
+  adapter: mysql2
+  host: localhost
+  username: root
+  password: mysqlpassword
+  database: radius
+
+staging: # if you want to define another profile
+  adapter: mysql2
+  host: localhost
+  username: root
+  password: mysqlpassword
+  database: radius_staging
+
+-------------------------------------------------------------------------------
+EOD
+  exit
+end
+
+def show_help
+  print <<"EOD"
+usage:
+  #{File.basename $0} [--profile=profile] subcommand ...
+
+subcommands as follows:
+  create <username>                   # create new user with password
+  show <username>                     # show password for username
+  showall                             # show all users
+  showvalid                           # show valid(not expired) users
+  showexpired                         # show expired users
+  expire <username>                   # expire the user right now
+  unexpire <username>                 # unexpire the user
+  setexpire <username> <expiry date>  # set expiry date (date must be parseable by Time#parse)
+  modify <username>                   # generate new password for username
+  dbconsole                           # enter database console
+EOD
+  exit
+end
+
+def show_user(username)
+  user = @f.find_user(username).first
+  printf "%s  %s\n", user[:username], user[:value]
+end
+
+# main routine starts here:
+begin
+  @config = YAML.load_file(ENV['HOME'] + '/.fradium.yaml')
+rescue Errno::ENOENT, Errno::EACCESS
+  config_file_not_found
+end
+
+profile = 'default'
+if ARGV[0]&.start_with?('--profile')
+  profile = ARGV[0].split(/=/,2)[1]
+  ARGV.shift
+end
+
+@f = Fradium.new(@config[profile])
+
+case ARGV[0]
+
+when 'create'
+  show_help if ARGV[1]&.empty?
+  @f.create_user(ARGV[1])
+  show_user(ARGV[1])
+
+when 'dbconsole'
+  @f.dbconsole
+
+when 'show'
+  show_user(ARGV[1])
+
+when 'showall'
+  @f.all_users.map{|e| e[:username]}.each do |e|
+    puts e
+  end
+
+when 'showvalid'
+  (@f.all_users.map{|e| e[:username]} - @f.expired_users.map{|e| e[:username]}).each do |e|
+    puts e
+  end
+
+when 'showexpired'
+  @f.expired_users.map{|e| e[:username]}.each do |e|
+    puts e
+  end
+
+when 'expire'
+  @f.expire_user(ARGV[1])
+
+when 'unexpire'
+  @f.unexpire_user(ARGV[1])
+
+when 'setexpire'
+  show_help if ARGV[2].nil? || ARGV[2].empty?
+  expiry_date = Time.parse(ARGV[2])
+  @f.set_expiration(ARGV[1], expiry_date)
+
+when 'modify' # change user password
+  @f.modify_user(ARGV[1])
+  show_user(ARGV[1])
+
+else # unknown subcommand
+  show_help
+end

data/fradium.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fradium/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fradium"
+  spec.version       = Fradium::VERSION
+  spec.authors       = ["Koichiro IWAO"]
+  spec.email         = ["meta@vmeta.jp"]
+
+  spec.summary       = %q{fradium - FreeRADIUS User Manager}
+  spec.description   = %q{Quick User Management Tool for FreeRADIUS}
+  spec.homepage      = "https://github.com/metalefty/fradium"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry', '~> 0.12'
+
+  spec.add_dependency 'mysql2', '~> 0.5'
+  spec.add_dependency 'sqlite3', '~> 1.4'
+  spec.add_dependency 'sequel', '~> 5.23'
+end

data/lib/fradium/version.rb

@@ -0,0 +1,3 @@
+class Fradium
+  VERSION = "0.1.2"
+end

data/lib/fradium.rb

@@ -0,0 +1,132 @@
+require "fradium/version"
+require 'securerandom'
+require 'sequel'
+require 'time'
+
+class Fradium
+  class UserAlreadyExistsError < StandardError; end
+  class UserNotFoundError < StandardError; end
+  class UsernameEmptyError < StandardError; end
+  class CorruptedUserDatabaseError < StandardError; end
+
+  def initialize(params)
+    @params = params
+
+    case @params['adapter']
+    when 'sqlite'
+      @sequel = Sequel.connect("sqlite://#{@params['file']}")
+    else
+      @sequel = Sequel.connect(@params)
+    end
+  end
+
+  def user_exists?(username)
+    find_user(username).count > 0
+  end
+
+  def all_users
+    @sequel[:radcheck].where{attribute.like '%-Password'}
+  end
+
+  def create_user(username)
+    raise UsernameEmptyError if username&.empty?
+    raise UserAlreadyExistsError if user_exists?(username)
+    password = Fradium.generate_random_password
+
+    @sequel[:radcheck].insert(username: username,
+                              attribute: 'Cleartext-Password',
+                              op: ':=',
+                              value: password)
+  end
+
+  def find_user(username)
+    raise UsernameEmptyError if username&.empty?
+    reult = @sequel[:radcheck].where(username: username).where{attribute.like '%-Password'}
+  end
+
+  def modify_user(username)
+    raise UsernameEmptyError if username&.empty?
+    raise UserNotFoundError unless user_exists?(username)
+    password = Fradium.generate_random_password
+
+    target = find_user(username)
+    raise CorruptedUserDatabaseError if target.count > 1
+    target.update(value: password, attribute: 'Cleartext-Password')
+  end
+
+  def expired_users
+    now = Time.now
+    # a little bit redundant but for consistency
+    id = @sequel[:radcheck].where(attribute: 'Expiration').collect{|e| e[:id] if Time.now > Time.parse(e[:value])}
+    @sequel[:radcheck].where(id: id)
+  end
+
+  def expire_user(username)
+    set_expiration(username, Time.now)
+  end
+
+  def unexpire_user(username)
+    raise UsernameEmptyError if username&.empty?
+    raise UserNotFoundError unless user_exists?(username)
+    @sequel[:radcheck].where(username: username, attribute: 'Expiration').delete
+  end
+
+  def is_expired?(username)
+    expiration_date = query_expiration(username)&.fetch('value')
+    return false if expiration_date.nil? || expiration_date.empty? # if expiration info not found, not expired yet
+    Time.now > Time.parse(expiration_date)
+  end
+
+  def set_expiration(username, expiration_date)
+    expiration_info = query_expiration(username)
+
+    value = ''
+    if expiration_date.instance_of?(Time)
+      value = expiration_date.strftime("%d %b %Y %H:%M:%S")
+    else
+      value = Time.parse(expiration_date).strftime("%d %b %Y %H:%M:%S")
+    end
+
+    if expiration_info.nil? # add new entry
+      @sequel[:radcheck].insert(username: username,
+                                attribute: 'Expiration',
+                                op: ':=',
+                                value: value)
+    else # update existing entry
+      expiration_info.update(value: value)
+    end
+  end
+
+  def dbconsole
+    # I know this is not safe.
+    Kernel.exec({'MYSQL_PWD' => @params['password']},
+                'mysql',
+                "--pager=less -SF",
+                "--user=#{@params['username']}",
+                "--host=#{@params['host']}" ,
+                "#{@params['database']}")
+  end
+
+  def self.generate_random_password(length=10)
+    r = SecureRandom.urlsafe_base64.delete('-_')
+    while r.length < length
+      r << SecureRandom.urlsafe_base64.delete('-_')
+    end
+    r[0..length-1]
+  end
+
+  #private
+
+  def query_expiration(username)
+    raise UsernameEmptyError if username&.empty?
+    raise UserNotFoundError unless user_exists?(username)
+
+    r = @sequel[:radcheck].where(username: username, attribute: 'Expiration')
+
+    raise CorruptedUserDatabaseError if r.count > 1
+    return nil if r.count == 0 # if no expiration info found
+    return nil if r&.first[:value]&.empty?
+
+    r
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fradium
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Koichiro IWAO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.23'
+description: Quick User Management Tool for FreeRADIUS
+email:
+- meta@vmeta.jp
+executables:
+- fradium
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fradium
+- fradium.gemspec
+- lib/fradium.rb
+- lib/fradium/version.rb
+homepage: https://github.com/metalefty/fradium
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.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: fradium - FreeRADIUS User Manager
+test_files: []